Added configuration to skip modules

docs/tools-instructions.md

@@ -69,15 +69,40 @@ optional arguments:
 ```
 <!-- (Missing example with local and path) -->
 
-### Example configuration file
 
-Example of YAML configuration file provided with the `--configfile` option that will omit `myunits.MyUnitCategory1` and `myunits.MyUnitCategory1` from the *unit dimensions test*.
+### Configuration file
+The `--configfile` options expects a YAML configuration file that specifies what tests to skip or enable.
+
+The following keywords are recognised in the YAML file:
+
+  - `skip`: List of tests to skip
+  - `enable`: List of tests to enable
+  - `<test_name>`: A name of a test. Recognised nested keywords are:
+    - `exceptions`: List of entities in the ontology to skip. Should be written
+      as `<ns0>.<name>`, where `<ns0>` is the last component of the base IRI
+      and `<name>` is the name of the entity.
+    - `skipmodules`: List of module names to skip the test for. The module
+      names may be written either as the full module IRI or as the last
+      component of the module IRI.
+
+Example configuration file:
 
 ```console
+test_description:
+  skipmodules:
+    - manufacturing
+    - conformityassessment
+
 test_unit_dimensions:
   exceptions:
     - myunits.MyUnitCategory1
     - myunits.MyUnitCategory2
+
+skip:
+  - name_of_test_to_skip
+
+enable:
+  - name_of_test_to_enable
 ```
 
 ---

emmopy/emmocheck.py

@@ -5,8 +5,25 @@
 
 A YAML file can be provided with additional test configurations.
 
+Toplevel keywords in the YAML file:
+
+  - `skip`: List of tests to skip
+  - `enable`: List of tests to enable
+  - `<test_name>`: A name of a test. Recognised nested keywords are:
+    - `exceptions`: List of entities in the ontology to skip. Should be written
+      as `<ns0>.<name>`, where `<ns0>` is the last component of the base IRI
+      and `<name>` is the name of the entity.
+    - `skipmodules`: List of module names to skip the test for. The module
+      names may be written either as the full module IRI or as the last
+      component of the module IRI.
+
 Example configuration file:
 
+    test_description:
+      skipmodules:
+        - manufacturing
+        - conformityassessment
+
     test_unit_dimensions:
       exceptions:
         - myunits.MyUnitCategory1
@@ -195,12 +212,12 @@ def test_description(self):
         Exceptions include entities from standard w3c vocabularies.
 
         """
+        # pylint: disable=invalid-name
         MeasurementUnit = (
             self.onto.MeasurementUnit
             if "MeasurementUnit" in self.onto
             else None
         )
-        # pylint: disable=invalid-name
         exceptions = set()
         exceptions.update(self.get_config("test_description.exceptions", ()))
         props = self.onto.world._props  # pylint: disable=protected-access
@@ -234,6 +251,10 @@ def test_description(self):
             ):
                 continue
 
+            # Check skipmodules
+            if skipmodule(self, "test_description", entity):
+                continue
+
             label = str(get_label(entity))
             with self.subTest(entity=entity, label=label):
                 self.assertTrue(
@@ -797,6 +818,32 @@ def checker(onto, ignore_namespace):
         checker(self.onto, self.ignore_namespace)
 
 
+def skipmodule(testobj, testname, entity):
+    """Return true if `entity` is in a module that should be skipped."""
+    skipmodules = testobj.get_config(f"{testname}.skipmodules")
+
+    if not skipmodules:
+        return False
+
+    # Infer base iri
+    if entity.namespace.ontology.base_iri != "https://w3id.org/emmo#":
+        base_iri = entity.namespace.ontology.base_iri.rstrip("/#")
+    elif hasattr(entity, "isDefinedBy") and entity.isDefinedBy:
+        base_iri = entity.isDefinedBy.first().rstrip("/#")
+    else:
+        base_iri = entity.namespace.ontology.base_iri.rstrip("/#")
+
+    for module in skipmodules:
+        module = module.rstrip("/#")
+        if "/" in module:
+            if module == base_iri:
+                return True
+        elif module == base_iri.rsplit("/", 1)[-1]:
+            return True
+
+    return False
+
+
 def main(
     argv: list = None,
 ):  # pylint: disable=too-many-locals,too-many-branches,too-many-statements