ci(check-licenses): add licence value checker

.github/workflows/ci.yml

@@ -118,3 +118,19 @@ jobs:
           pip install --upgrade pip
           pip install isort
           ./run-tests.sh --check-isort
+
+  check-licenses:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+
+      - name: Check licenses
+        run: |
+          pip install --upgrade pip
+          ./run-tests.sh --check-licenses

run-tests.sh

@@ -99,13 +99,18 @@ check_isort () {
     isort -rc -c -df --profile black -- **/*.py
 }
 
+check_licenses () {
+    scripts/check_licenses.py
+}
+
 check_all () {
     check_script
     check_fixtures
     check_pycodestyle
     check_black
     check_pydocstyle
     check_isort
+    check_licenses
 }
 
 if [ $# -eq 0 ]; then
@@ -121,6 +126,7 @@ do
         --check-pycodestyle) check_pycodestyle;;
         --check-pydocstyle) check_pydocstyle;;
         --check-isort) check_isort;;
+        --check-licenses) check_licenses;;
         *)
     esac
 done

scripts/check_licenses.py

@@ -0,0 +1,104 @@
+#!/usr/bin/env python
+
+"""Check if license fields are valid in all records."""
+
+import asyncio
+import json
+import logging
+import os
+import pathlib
+import time
+
+VALID_LICENSE_IDENTIFIERS = [
+    "CC0-1.0",
+    "GPL-3.0-only",
+    "MIT",
+    "Apache-2.0",
+    "BSD-3-Clause",
+]
+
+logging.basicConfig(level=logging.INFO, format="[%(levelname)s] %(message)s")
+
+
+async def validate_file(path: pathlib.Path) -> int:
+    """Validate a single file."""
+    checks = 0
+    errors = 0
+    records = await asyncio.get_event_loop().run_in_executor(
+        None, lambda p: json.loads(open(p, "rb").read()), path
+    )
+
+    for record in records:
+        if rec_licenses := record.get("license"):
+            try:
+                attr = rec_licenses["attribution"]
+            except KeyError:
+                recid = record.get("recid", "UNSET")
+                message = f"License field set but without attribution in file {path.name} with recid {recid}!"
+
+                logging.error(message)
+                errors += 1
+                continue
+
+            if attr not in VALID_LICENSE_IDENTIFIERS:
+                recid = record.get("recid", "UNSET")
+                message = f"Invalid license identifier `{attr}` in file {path.name} for recid {recid}! "
+
+                logging.error(message)
+                errors += 1
+            else:
+                checks += 1
+
+    if errors:
+        raise ValueError(errors)
+
+    logging.info(f"Successfully validated file {path.name}")
+    return checks
+
+
+async def check_all_paths():
+    """Execute checks on all found files."""
+    start_time = time.perf_counter()
+
+    loop = asyncio.get_event_loop()
+
+    root_path = pathlib.Path(os.getcwd()) / "data" / "records"
+    all_paths = list(root_path.glob("*.json"))
+
+    tasks = [loop.create_task(validate_file(file_path)) for file_path in all_paths]
+    results = await asyncio.gather(*tasks, return_exceptions=True)
+
+    finish_time = time.perf_counter() - start_time
+    logging.info(f"Processed {len(all_paths)} files within {finish_time:.2f} seconds.")
+
+    if any(isinstance(result, Exception) for result in results):
+        errors = sum(
+            [
+                int(str(result)) if str(result).isdigit() else 1
+                for result in results
+                if isinstance(result, Exception)
+            ]
+        )
+        logging.error(
+            f"Validation completed with {errors} errors!\n"
+            f"\tPlease ensure the licenses are one of the following: {VALID_LICENSE_IDENTIFIERS}.\n"
+            f"\tIf you are using a valid SPDX license string that is not in the above list, "
+            f"please contact `[email protected]`."
+        )
+        exit(1)
+
+    else:
+        logging.info(f"Successfully validated {sum(results)} records. No errors found.")
+
+
+def main():
+    """Test to validate all license fields."""
+    loop = asyncio.new_event_loop()
+    try:
+        loop.run_until_complete(check_all_paths())
+    finally:
+        loop.close()
+
+
+if __name__ == "__main__":
+    main()