Prepare select-testcases.py for multiple commands

Signed-off-by: Matthias Büchse <matthias.buechse@alasca.cloud>

Author: mbuechse

Tests/iaas/openstack_test.py

@@ -309,7 +309,9 @@ def main(argv):
         },
         'log': log,
     }
-    yaml.safe_dump(report, sys.stdout, default_flow_style=False, sort_keys=False, explicit_start=True)
+    # don't do explicit_start here because that can easily be done by the caller using "echo ---",
+    # and then the caller can even add fields such as uuid, subject, and scope
+    yaml.safe_dump(report, sys.stdout, default_flow_style=False, sort_keys=False, explicit_start=False)
     return 0
 
 

Tests/select-testcases.py

@@ -2,10 +2,10 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import re
-import sys
-import getopt
 import datetime
 import logging
+
+import click
 import yaml
 
 from scs_cert_lib import load_spec, annotate_validity
@@ -14,91 +14,47 @@
 logger = logging.getLogger(__name__)
 
 
-def usage(file=sys.stdout):
-    """Output usage information"""
-    print("""Usage: select-testcases.py [options] SPEC_YAML
-
-Arguments:
-  SPEC_YAML: yaml file specifying the certificate scope
-
-Options:
-  -d/--date YYYY-MM-DD: Check standards valid on specified date instead of today
-  -V/--version VERS: Force version VERS of the standard (instead of deriving from date)
-  -S/--sections SECTION_LIST: comma-separated list of sections to test (default: all sections)
-  -t/--tests REGEX: regular expression to select individual testcases based on their ids
-""", file=file)
-
-
-class Config:
-    def __init__(self):
-        self.arg0 = None
-        self.checkdate = datetime.date.today()
-        self.version = None
-        self.sections = None
-        self.tests = None
-
-    def apply_argv(self, argv):
-        """Parse options. May exit the program."""
-        try:
-            opts, args = getopt.gnu_getopt(argv, "hd:V:S:t:", (
-                "help", "date=", "version=", "sections=", "tests=",
-            ))
-        except getopt.GetoptError:
-            usage(file=sys.stderr)
-            raise
-        for opt in opts:
-            if opt[0] == "-h" or opt[0] == "--help":
-                usage()
-                sys.exit(0)
-            elif opt[0] == "-d" or opt[0] == "--date":
-                self.checkdate = datetime.date.fromisoformat(opt[1])
-            elif opt[0] == "-V" or opt[0] == "--version":
-                self.version = opt[1]
-            elif opt[0] == "-S" or opt[0] == "--sections":
-                self.sections = [x.strip() for x in opt[1].split(",")]
-            elif opt[0] == "-t" or opt[0] == "--tests":
-                self.tests = re.compile(opt[1])
-            else:
-                logger.error(f"Unknown argument {opt[0]}")
-        if len(args) != 1:
-            usage(file=sys.stderr)
-            raise RuntimeError("need precisely one argument")
-        self.arg0 = args[0]
-
-
 def select_valid(versions: list) -> list:
     return [version for version in versions if version['_explicit_validity']]
 
 
-def main(argv):
-    """Entry point for the checker"""
-    logging.basicConfig(format='%(levelname)s: %(message)s', level=logging.INFO)
-    config = Config()
-    config.apply_argv(argv)
-    with open(config.arg0, "r", encoding="UTF-8") as specfile:
+@click.group()
+def cli():
+    return
+
+
+@cli.command()
+@click.option('--version', '-V', 'version', type=str, default=None)
+@click.option('--tests', '-t', 'tests', type=str, default=None)
+@click.option('--section', '-S', 'sections', type=str, multiple=True)
+@click.argument('specpath', type=click.Path(exists=True))
+def select(specpath, version, sections, tests):
+    with open(specpath, "r", encoding="UTF-8") as specfile:
         spec = load_spec(yaml.load(specfile, Loader=yaml.SafeLoader))
-    annotate_validity(spec['timeline'], spec['versions'], config.checkdate)
-    if config.version is None:
+    checkdate = datetime.date.today()
+    annotate_validity(spec['timeline'], spec['versions'], checkdate)
+    if version is None:
         versions = select_valid(spec['versions'].values())
     else:
-        versions = [spec['versions'].get(config.version)]
+        versions = [spec['versions'].get(version)]
         if versions[0] is None:
-            raise RuntimeError(f"Requested version '{config.version}' not found")
+            raise RuntimeError(f"Requested version '{version}' not found")
     if not versions:
-        raise RuntimeError(f"No valid version found for {config.checkdate}")
+        raise RuntimeError(f"No valid version found for {checkdate}")
     title = spec['name']
-    if config.sections:
-        title += f" [sections: {', '.join(config.sections)}]"
-    if config.tests:
-        title += f" [tests: '{config.tests.pattern}']"
+    if sections:
+        title += f" [sections: {', '.join(sections)}]"
+    if tests:
+        title += f" [tests: '{tests}']"
+        tests_re = re.compile(tests)
     # collect all testcases we need
     testcase_lookup = spec['testcases']
     all_testcase_ids = set()
     for version in versions:
         for tc_id in version['testcase_ids']:
-            if config.sections and testcase_lookup.get(tc_id, {}).get('section') not in config.sections:
+            if sections and testcase_lookup.get(tc_id, {}).get('section') not in sections:
                 continue
-            if config.tests and not config.tests.match(tc_id):
+            if tests and not tests_re.match(tc_id):
                 continue
             all_testcase_ids.add(tc_id)
     logger.info(f"{title}: {len(all_testcase_ids)} testcases")
@@ -107,10 +63,5 @@ def main(argv):
 
 
 if __name__ == "__main__":
-    try:
-        sys.exit(main(sys.argv[1:]))
-    except SystemExit:
-        raise
-    except BaseException as exc:
-        logger.critical(f"{str(exc) or repr(exc)}")
-        raise
+    logging.basicConfig(format='%(levelname)s: %(message)s', level=logging.INFO)
+    cli()