Add feature: Supplements are checked in CI pipeline

Signed-off-by: Matthias Büchse <[email protected]>

Author: mbuechse

Tests/chk_adrs.py

@@ -96,7 +96,21 @@ def check_names(self, mds):
             if len(fns) > 1:
                 self.emit(f"duplicate stable: {fns}")
 
-    def check_front_matter(self, fn, front):
+    def _check_front_matter_supplement(self, fn, front, filenames):
+        typ = front.get('type')
+        if typ != "Supplement":
+            self.emit(f"in {fn}: type must be Supplement, is {typ}")
+        if 'status' in front:
+            self.emit(f"in {fn}: Supplement shouldn't have status field")
+        supplements = front.get("supplements")
+        if not isinstance(supplements, list):
+            self.emit(f"in {fn}: field 'supplements' must be a list")
+        # NOTE could check that each entry refers to a file that exists
+        for fn2 in supplements:
+            if fn2 not in filenames:
+                self.emit("in {fn}: field 'supplements' refers to unknown {fn2}")
+
+    def check_front_matter(self, fn, front, filenames):
         """Check the dict `front` of front matter
 
         The argument `fn` is mainly for context in error messages, but also to distinguish document types.
@@ -105,6 +119,8 @@ def check_front_matter(self, fn, front):
             self.emit(f"in {fn}: is missing front matter altogether")
             return
         # so far, only check primary documents, not supplemental ones
+        if fn[9] == 'w':
+            return self._check_front_matter_supplement(fn, front, filenames)
         if fn[9] != 'v':
             print(f"skipping non-primary {fn}", file=sys.stderr)
             return
@@ -151,7 +167,7 @@ def main(argv):
     checker = Checker()
     for fn in mds:
         checker.check_name(fn)
-        checker.check_front_matter(fn, _load_front_matter(os.path.join(path, fn)))
+        checker.check_front_matter(fn, _load_front_matter(os.path.join(path, fn)), mds)
     checker.check_names(mds)
     return checker.errors