Badges: compute a fake 'all' tag, containing all tests

Author: mr-c

cwltest/argparser.py

@@ -107,7 +107,8 @@ def arg_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "--badgedir",
         type=str,
-        help="Create JSON badges and store them in this directory.",
+        help="Create JSON badges, one for each tag (plus a computed 'all' tag) "
+        " and store them in this directory.",
     )
 
     try:

cwltest/plugin.py

@@ -325,7 +325,8 @@ def collect(self) -> Iterator[CWLItem]:
         "--cwl-badgedir",
         {
             "type": str,
-            "help": "Create badge JSON files and store them in this directory.",
+            "help": "Create badge JSON files, one for each tag (plus a computed "
+            "'all' tag), and store them in this directory.",
         },
     ),
     (

cwltest/utils.py

@@ -313,6 +313,9 @@ def parse_results(
     """
     Parse the results and return statistics and an optional report.
 
+    An additional tag named "all" will be computed, containing all the test
+    results.
+
     Returns the total number of tests, dictionary of test counts
     (total, passed, failed, unsupported) by tag, and a jUnit XML report.
     """
@@ -334,7 +337,7 @@ def parse_results(
             else "cwltest:#{i + 1}"
         )
         total += 1
-        tags = tests[i].get("tags", [])
+        tags = tests[i].get("tags", []) + ["all"]
         for t in tags:
             ntotal[t] += 1
 

tests/test_badgedir.py

@@ -53,6 +53,15 @@ def test_badgedir(tmp_path: Path) -> None:
         assert obj.get("color", "") == "yellow"
     assert (badgedir / "command_line_tool.md").exists()
 
+    all_tests = badgedir / "all.json"
+    assert all_tests.exists()
+    with open(all_tests) as file:
+        obj = json.load(file)
+        assert obj.get("subject", "") == "all"
+        assert obj.get("status", "") == "0%"
+        assert obj.get("color", "") == "yellow"
+    assert (badgedir / "all.md").exists()
+
 
 def test_badgedir_report_with_baseuri(tmp_path: Path) -> None:
     badgedir = tmp_path / "badgedir"