Pass client_sha and client_sha_url as pytest metadata (#288)

* Pass client_sha and client_sha_url as pytest metadata

* Do the same for workflow_run

* Inject environment variables directly into JSON report

* Drop pytest-metadata as a top level dep

Author: di

.github/scripts/generate_client_report.py

@@ -29,17 +29,18 @@ def __init__(self, report_path: Path):
             data = json.load(f)
 
         self.name = report_path.name.replace(".json", "")
-        self.client_sha = os.getenv("GHA_SIGSTORE_CONFORMANCE_CLIENT_SHA", "")
-        self.client_sha_url = os.getenv("GHA_SIGSTORE_CONFORMANCE_CLIENT_SHA_URL", "")
-        self.workflow_run = os.getenv("GHA_SIGSTORE_CONFORMANCE_WORKFLOW_RUN", "")
 
         if data == {}:
             return  # no results found
         self.results_found = True
 
-        self.conformance_action_version = data.get("environment", {}).get(
+        environment = data.get("environment", {})
+        self.conformance_action_version = environment.get(
             "conformance_action_version", "unknown"
         )
+        self.client_sha = environment.get("client_sha", "")
+        self.client_sha_url = environment.get("client_sha_url", "")
+        self.workflow_run = environment.get("workflow_run", "")
 
         summary = data["summary"]
         self.total = summary["total"]

action.py

@@ -30,8 +30,7 @@ def _debug(msg):
 def _sigstore_conformance(environment: str) -> int:
     args = ["--json-report", "--json-report-file=conformance-report.json", "--durations=0"]
 
-    version = os.getenv("GHA_SIGSTORE_CONFORMANCE_ACTION_VERSION", "unknown")
-    args.extend(["--metadata", "conformance_action_version", version])
+
 
     if _DEBUG:
         args.extend(["-s", "-vv", "--showlocals"])
@@ -52,7 +51,30 @@ def _sigstore_conformance(environment: str) -> int:
     print(f"running sigstore-conformance against Sigstore {environment} infrastructure")
     _debug(f"running: sigstore-conformance {[str(a) for a in args]}")
 
-    return pytest.main([str(_ACTION_PATH / "test"), *args])
+    status = pytest.main([str(_ACTION_PATH / "test"), *args])
+
+    # Inject the action version into the report
+    with open("conformance-report.json", "r+") as f:
+        report_data = json.load(f)
+        if "environment" not in report_data:
+            report_data["environment"] = {}
+        report_data["environment"]["conformance_action_version"] = os.getenv(
+            "GHA_SIGSTORE_CONFORMANCE_ACTION_VERSION", "unknown"
+        )
+        client_sha = os.getenv("GHA_SIGSTORE_CONFORMANCE_CLIENT_SHA")
+        if client_sha:
+            report_data["environment"]["client_sha"] = client_sha
+        client_sha_url = os.getenv("GHA_SIGSTORE_CONFORMANCE_CLIENT_SHA_URL")
+        if client_sha_url:
+            report_data["environment"]["client_sha_url"] = client_sha_url
+        workflow_run = os.getenv("GHA_SIGSTORE_CONFORMANCE_WORKFLOW_RUN")
+        if workflow_run:
+            report_data["environment"]["workflow_run"] = workflow_run
+        f.seek(0)
+        json.dump(report_data, f, indent=4)
+        f.truncate()
+
+    return status
 
 
 # Run against chosen environment

requirements.in

@@ -1,6 +1,5 @@
 pytest==9.0.0
 pytest-json-report==1.5.0
-pytest-metadata==3.1.1
 pytest-subtests==0.15.0
 requests==2.32.5
 cryptography==46.0.3

requirements.txt

@@ -607,9 +607,7 @@ pytest-json-report==1.5.0 \
 pytest-metadata==3.1.1 \
     --hash=sha256:c8e0844db684ee1c798cfa38908d20d67d0463ecb6137c72e91f418558dd5f4b \
     --hash=sha256:d2a29b0355fbc03f168aa96d41ff88b1a3b44a3b02acbe491801c98a048017c8
-    # via
-    #   -r requirements.in
-    #   pytest-json-report
+    # via pytest-json-report
 pytest-subtests==0.15.0 \
     --hash=sha256:cb495bde05551b784b8f0b8adfaa27edb4131469a27c339b80fd8d6ba33f887c \
     --hash=sha256:da2d0ce348e1f8d831d5a40d81e3aeac439fec50bd5251cbb7791402696a9493