|
| 1 | +import os |
| 2 | +import sys |
| 3 | + |
| 4 | +class EnvVarError(Exception): |
| 5 | + """Custom exception for environment variable comparison errors.""" |
| 6 | + def __init__(self, message): |
| 7 | + super().__init__(f"ENV VALIDATION ERROR: {message}") |
| 8 | + |
| 9 | +def get_env_vars(var1, var2): |
| 10 | + val1 = os.environ.get(var1) |
| 11 | + val2 = os.environ.get(var2) |
| 12 | + |
| 13 | + if val1 is None: |
| 14 | + raise EnvVarError(f"Missing environment variable: '{var1}'") |
| 15 | + if val2 is None: |
| 16 | + raise EnvVarError(f"Missing environment variable: '{var2}'") |
| 17 | + |
| 18 | + return val1, val2 |
| 19 | + |
| 20 | +def check_env_equals(var1, var2): |
| 21 | + val1, val2 = get_env_vars(var1, var2) |
| 22 | + if val1 != val2: |
| 23 | + raise EnvVarError(f"'{var1}' must equal '{var2}':\n{var1}='{val1}'\n{var2}='{val2}'") |
| 24 | + |
| 25 | +def check_env_contains(var1, var2): |
| 26 | + val1, val2 = get_env_vars(var1, var2) |
| 27 | + if val2 not in val1: |
| 28 | + raise EnvVarError(f"'{var1}' must contain '{var2}':\n{var1}='{val1}'\n{var2}='{val2}'") |
| 29 | + |
| 30 | +def check_env_endswith(var1, var2): |
| 31 | + val1, val2 = get_env_vars(var1, var2) |
| 32 | + if not val1.endswith(val2): |
| 33 | + raise EnvVarError(f"'{var1}' must end with '{var2}':\n{var1}='{val1}'\n{var2}='{val2}'") |
| 34 | + |
| 35 | +if __name__ == "__main__": |
| 36 | + try: |
| 37 | + # accelerator stuff is not guaranteed to exist |
| 38 | + expected_eessi_accel_arch = os.getenv("EESSI_ACCELERATOR_TARGET_OVERRIDE", default=None) |
| 39 | + |
| 40 | + # Verify the software and accelerator targets are set correctly |
| 41 | + if os.getenv("EESSI_SOFTWARE_SUBDIR_OVERRIDE", default=None): |
| 42 | + check_env_equals("EESSI_SOFTWARE_SUBDIR_OVERRIDE", "EESSI_SOFTWARE_SUBDIR") |
| 43 | + if expected_eessi_accel_arch: |
| 44 | + # EESSI_ACCEL_SUBDIR is what is detected by archdetect (or respects EESSI_ACCELERATOR_TARGET_OVERRIDE) |
| 45 | + check_env_equals("EESSI_ACCELERATOR_TARGET_OVERRIDE", "EESSI_ACCEL_SUBDIR") |
| 46 | + # special case is where EESSI_ACCELERATOR_TARGET_OVERRIDE may not match the final |
| 47 | + # accelerator architecture chosen. |
| 48 | + # In CI we set FINAL_ACCELERATOR_PATH_EXPECTED to allow us to compare against an expected value. |
| 49 | + check_env_equals("EESSI_ACCELERATOR_TARGET", "FINAL_ACCELERATOR_PATH_EXPECTED") |
| 50 | + # verify the software paths that should exist |
| 51 | + check_env_endswith("EESSI_SOFTWARE_PATH", "EESSI_SOFTWARE_SUBDIR") |
| 52 | + check_env_endswith("EESSI_SITE_SOFTWARE_PATH", "EESSI_SOFTWARE_SUBDIR") |
| 53 | + # verify the module paths that should exist |
| 54 | + check_env_contains("EESSI_MODULEPATH", "EESSI_SOFTWARE_SUBDIR") |
| 55 | + check_env_contains("EESSI_SITE_MODULEPATH", "EESSI_SOFTWARE_SUBDIR") |
| 56 | + if expected_eessi_accel_arch: |
| 57 | + check_env_contains("EESSI_MODULEPATH_ACCEL", "EESSI_SOFTWARE_SUBDIR") |
| 58 | + check_env_contains("EESSI_SITE_MODULEPATH_ACCEL", "EESSI_SOFTWARE_SUBDIR") |
| 59 | + check_env_contains("EESSI_MODULEPATH_ACCEL", "EESSI_ACCELERATOR_TARGET") |
| 60 | + check_env_contains("EESSI_SITE_MODULEPATH_ACCEL", "EESSI_ACCELERATOR_TARGET") |
| 61 | + # Finally, verify that all the expected module path are included |
| 62 | + check_env_contains("MODULEPATH", "EESSI_MODULEPATH") |
| 63 | + check_env_contains("MODULEPATH", "EESSI_SITE_MODULEPATH") |
| 64 | + if expected_eessi_accel_arch: |
| 65 | + check_env_contains("MODULEPATH", "EESSI_MODULEPATH_ACCEL") |
| 66 | + check_env_contains("MODULEPATH", "EESSI_SITE_MODULEPATH_ACCEL") |
| 67 | + |
| 68 | + # We are done |
| 69 | + print("Environment variable check passed.") |
| 70 | + except EnvVarError as e: |
| 71 | + print(str(e), file=sys.stderr) |
| 72 | + sys.exit(1) |
0 commit comments