wip: improve testing, delegate to schema, remove postcheck in favour of a separate setter for modulepath

Author: albestro

stackinator/recipe.py

@@ -69,7 +69,14 @@ def __init__(self, args):
         if modules_path.is_file():
             with modules_path.open() as fid:
                 self.modules = yaml.load(fid, Loader=yaml.Loader)
-                schema.ModulesValidator(pathlib.Path(self.mount)).validate(self.modules)
+                schema.ModulesValidator.validate(self.modules)
+
+                # Note:
+                # modules root should match MODULEPATH set by envvars and used by uenv view "modules"
+                # so we enforce that the user does not override it in modules.yaml
+                self.modules["modules"].setdefault("default", {}).setdefault("roots", {}).setdefault(
+                    "tcl", (self.mount / "modules").as_posix()
+                )
 
         # DEPRECATED field `config:modules`
         if "modules" in self.config:

stackinator/schema.py

@@ -64,11 +64,9 @@ def __init__(self, name: str, errors: list[jsonschema.ValidationError]):
 
 
 class SchemaValidator:
-    def __init__(self, schema_filepath: pathlib.Path, precheck=None, postcheck=None, postcheck_args=()):
+    def __init__(self, schema_filepath: pathlib.Path, precheck=None):
         self._validator = validator(json.load(open(schema_filepath)))
         self._precheck = precheck
-        self._postcheck = postcheck
-        self._postcheck_args = postcheck_args
 
     def validate(self, instance: dict):
         if self._precheck:
@@ -79,9 +77,6 @@ def validate(self, instance: dict):
         if len(errors) != 0:
             raise ValidationError(self._validator.schema.get("title", "no-title"), errors)
 
-        if self._postcheck:
-            self._postcheck(instance, *self._postcheck_args)
-
 
 def check_config_version(instance):
     rversion = instance.get("version", 1)
@@ -117,18 +112,4 @@ def check_config_version(instance):
 CompilersValidator = SchemaValidator(prefix / "schema/compilers.json")
 EnvironmentsValidator = SchemaValidator(prefix / "schema/environments.json")
 CacheValidator = SchemaValidator(prefix / "schema/cache.json")
-
-
-def modules_constraints(instance: dict, mount: pathlib.Path):
-    # Note:
-    # modules root should match MODULEPATH set by envvars and used by uenv view "modules"
-    # so we enforce that the user does not override it in modules.yaml
-    instance["modules"].setdefault("default", {}).setdefault("roots", {}).setdefault(
-        "tcl", (mount / "modules").as_posix()
-    )
-
-
-def ModulesValidator(mountpoint):
-    return SchemaValidator(
-        prefix / "schema/modules.json", None, postcheck=modules_constraints, postcheck_args=(mountpoint,)
-    )
+ModulesValidator = SchemaValidator(prefix / "schema/modules.json")

unittests/test_schema.py

@@ -201,49 +201,74 @@ def test_recipe_environments_yaml(recipe_paths):
             schema.EnvironmentsValidator.validate(raw)
 
 
-def test_modules_yaml():
-    instance = yaml.load(
+@pytest.mark.parametrize(
+    "recipe",
+    [
         dedent(
             """
             modules: {}
             """
         ),
-        Loader=yaml.Loader,
-    )
-    schema.ModulesValidator(pathlib.Path("/my/mount/point")).validate(
-        instance,
-    )
-
-    assert instance["modules"]["default"]["roots"]["tcl"] == "/my/mount/point/modules"
-    assert not instance["modules"]["default"]["arch_folder"]
-
-    instance = yaml.load(
         dedent(
             """
             modules:
               default:
                 arch_folder: false
             """
         ),
-        Loader=yaml.Loader,
-    )
-    schema.ModulesValidator(pathlib.Path("/my/mount/point")).validate(
-        instance,
-    )
+        dedent(
+            """
+            modules:
+              # Paths tomodules: check when creating modules for all module sets
+              prefix_insmodules:pections:
+                bin:
+                  - PATH
+                lib:
+                  - LD_LIBRARY_PATH
+                lib64:
+                  - LD_LIBRARY_PATH
 
-    assert instance["modules"]["default"]["roots"]["tcl"] == "/my/mount/point/modules"
+              default:
+                arch_folder: false
+                # Where to install modules
+                tcl:
+                  all:
+                    autoload: none
+                  hash_length: 0
+                  exclude_implicits: true
+                  exclude: []
+                  projections:
+                    all: '{name}/{version}'
+            """
+        ),
+    ],
+)
+def test_valid_modules_yaml(recipe):
+    instance = yaml.load(recipe, Loader=yaml.Loader)
+    schema.ModulesValidator.validate(instance)
     assert not instance["modules"]["default"]["arch_folder"]
 
+
+@pytest.mark.parametrize(
+    "recipe",
+    [
+        dedent(
+            """
+            modules:
+              default:
+                arch_folder: true
+            """
+        ),
+        dedent(
+            """
+            modules:
+              default:
+                roots:
+                  tcl: /user/path/modules
+            """
+        ),
+    ],
+)
+def test_invalid_modules_yaml(recipe):
     with pytest.raises(Exception):
-        schema.ModulesValidator(pathlib.Path("/my/mount/point")).validate(
-            yaml.load(
-                dedent(
-                    """
-                    modules:
-                      default:
-                        arch_folder: true
-                    """
-                ),
-                Loader=yaml.Loader,
-            ),
-        )
+        schema.ModulesValidator.validate(yaml.load(recipe, Loader=yaml.Loader))