Accept shorthands for specfile

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

Author: mbuechse

Tests/cli.py

@@ -13,17 +13,24 @@
 import click
 import yaml
 
-from scs_cert_lib import load_spec, annotate_validity, add_period
+from scs_cert_lib import load_spec, annotate_validity, add_period, normalize_scope
 
 
+HERE = os.path.dirname(__file__)
 DEFAULT_SPECPATH = {
-    '50393e6f-2ae1-4c5c-a62c-3b75f2abef3f': './scs-compatible-iaas.yaml',
-    '1fffebe6-fd4b-44d3-a36c-fc58b4bb0180': './scs-compatible-kaas.yaml',
+    '50393e6f-2ae1-4c5c-a62c-3b75f2abef3f': os.path.join(HERE, 'scs-compatible-iaas.yaml'),
+    '1fffebe6-fd4b-44d3-a36c-fc58b4bb0180': os.path.join(HERE, 'scs-compatible-kaas.yaml'),
 }
 
 logger = logging.getLogger(__name__)
 
 
+def _load_spec(specpath):
+    specpath = DEFAULT_SPECPATH.get(normalize_scope(specpath), specpath)
+    with open(specpath, "r", encoding="UTF-8") as fileobj:
+        return load_spec(yaml.load(fileobj, Loader=yaml.SafeLoader))
+
+
 def select_valid(versions: list) -> list:
     return [version for version in versions if version['_explicit_validity']]
 
@@ -37,10 +44,9 @@ def cli():
 @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))
+@click.argument('specpath', type=str)
 def select(specpath, version, sections, tests):
-    with open(specpath, "r", encoding="UTF-8") as specfile:
-        spec = load_spec(yaml.load(specfile, Loader=yaml.SafeLoader))
+    spec = _load_spec(specpath)
     checkdate = datetime.date.today()
     annotate_validity(spec['timeline'], spec['versions'], checkdate)
     if version is None:
@@ -121,13 +127,12 @@ def score(specpath, subject, score_yaml, report_yaml):
         if not subject:
             subject = scorecard['subject']
         if not specpath:
-            specpath = DEFAULT_SPECPATH[scorecard['scope']]
+            specpath = scorecard['scope']
     elif not subject:
         raise click.UsageError('need to supply at least one of -s or -S')
     elif not specpath:
         raise click.UsageError('need to supply at least one of --spec or -S')
-    with open(specpath, "r", encoding="UTF-8") as specfile:
-        spec = load_spec(yaml.load(specfile, Loader=yaml.SafeLoader))
+    spec = _load_spec(specpath)
     scopeuuid = spec['uuid']
     snippet = yaml.load(sys.stdin.read(), Loader=yaml.SafeLoader)
     if not snippet:
@@ -161,8 +166,7 @@ def score(specpath, subject, score_yaml, report_yaml):
 @click.option('--spec', 'specpath', type=click.Path(exists=True))
 @click.argument('score_yaml', type=click.Path(exists=False))
 def init(specpath, subject, score_yaml):
-    with open(specpath, "r", encoding="UTF-8") as specfile:
-        spec = load_spec(yaml.load(specfile, Loader=yaml.SafeLoader))
+    spec = _load_spec(specpath)
     scorecard = {
         'subject': subject,
         'scope': spec['uuid'],

Tests/scs_cert_lib.py

@@ -15,6 +15,12 @@
 logger = logging.getLogger(__name__)
 __VERSION__ = "20260623"
 
+SCOPE_ALIASES = {
+    'sci': '50393e6f-2ae1-4c5c-a62c-3b75f2abef3f',
+    'scs-compatible-iaas': '50393e6f-2ae1-4c5c-a62c-3b75f2abef3f',
+    'sck': '1fffebe6-fd4b-44d3-a36c-fc58b4bb0180',
+    'scs-compatible-kaas': '1fffebe6-fd4b-44d3-a36c-fc58b4bb0180',
+}
 # valid keywords for various parts of the spec, to be checked using `check_keywords`
 KEYWORDS = {
     'spec': ('uuid', 'name', 'url', 'versions', 'prerequisite', 'variables', 'scripts', 'groups', 'timeline'),
@@ -241,3 +247,7 @@ def make_report(scopeuuid, subject, results, log, creator=None, checked_at=None)
         },
         "log": log,
     }
+
+
+def normalize_scope(ident):
+    return SCOPE_ALIASES.get(ident, ident)

compliance-monitor/monitor.py

@@ -51,14 +51,14 @@
 
 
 try:
-    from scs_cert_lib import load_spec, annotate_validity, add_period, eval_buckets, evaluate
+    from scs_cert_lib import load_spec, annotate_validity, add_period, eval_buckets, evaluate, normalize_scope
 except ImportError:
     # the following course of action is not unproblematic because the Tests directory will be
     # mounted to the Docker instance, hence it's hard to tell what version we are gonna get;
     # however, unlike the reloading of the config, the import only happens once, and at that point
     # in time, both monitor.py and scs_cert_lib.py should come from the same git checkout
     import sys; sys.path.insert(0, os.path.abspath('../Tests'))  # noqa: E702
-    from scs_cert_lib import load_spec, annotate_validity, add_period, eval_buckets, evaluate
+    from scs_cert_lib import load_spec, annotate_validity, add_period, eval_buckets, evaluate, normalize_scope
 
 
 class Settings:
@@ -634,7 +634,7 @@ def _scope_name(uuid):
 
 
 def _scope_url(uuid):
-    scope = get_scopes().get(_resolve_scope(uuid))
+    scope = get_scopes().get(normalize_scope(uuid))
     return scope['url'] if scope else '(n/a)'
 
 
@@ -696,10 +696,6 @@ def _resolve_group_locally(groups, subject, prefix=GROUP_PREFIX):
     return None, [subject]
 
 
-def _resolve_scope(scopeuuid):
-    return SCOPE_ALIASES.get(scopeuuid, scopeuuid)
-
-
 @app.get("/{view_type}/detail/{subject}/{scopeuuid}")
 async def get_detail(
     request: Request,
@@ -712,7 +708,7 @@ async def get_detail(
 
 
 def _make_detail_view(conn, view_type, subject, scopeuuid, include_drafts=False):
-    scopeuuid = _resolve_scope(scopeuuid)
+    scopeuuid = normalize_scope(scopeuuid)
     with conn.cursor() as cur:
         group, subjects = _resolve_group(cur, subject)
         rows2 = []
@@ -825,7 +821,7 @@ async def get_healthz(request: Request):
 @pass_context
 def pick_filter(ctx, results, scopeuuid, *subjects):
     """Jinja filter to pick scope results from `results` for given `subject` and `scope`"""
-    scopeuuid = _resolve_scope(scopeuuid)
+    scopeuuid = normalize_scope(scopeuuid)
     # simple case (backwards compatible): precisely one subject
     if len(subjects) == 1:
         group, subjects = _resolve_group_locally(ctx['groups'], subjects[0])