[cpp] Fix all-jobs-are-green-job

Author: cbeauchesne

Diff for: .github/workflows/ci.yml

@@ -166,7 +166,7 @@ jobs:
       with:
         python-version: '3.11'
     - run: pip install requests
-    - run: python utils/scripts/get-workflow-summary.py ${{ github.run_id }} >> $GITHUB_STEP_SUMMARY
+    - run: python utils/scripts/get-workflow-summary.py DataDog/system-tests ${{ github.run_id }} -o $GITHUB_STEP_SUMMARY
       env:
         GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

Diff for: utils/scripts/get-workflow-summary.py

@@ -1,4 +1,6 @@
+import argparse
 from collections import defaultdict
+import logging
 import os
 import sys
 
@@ -34,11 +36,14 @@ def get_jobs(session, repo_slug: str, run_id: int) -> list:
     return jobs
 
 
-def main(repo_slug: str, run_id: int) -> None:
+def main(repo_slug: str, run_id: int, output: str) -> None:
+    logging.info(f"Getting workflow summary for https://github.com/{repo_slug}/actions/runs/{run_id}")
     environ = get_environ()
 
     has_failure = False
 
+    result: list[str] = []
+
     with requests.Session() as session:
         if "GH_TOKEN" in environ:
             session.headers["Authorization"] = environ["GH_TOKEN"]
@@ -49,9 +54,11 @@ def main(repo_slug: str, run_id: int) -> None:
 
         for job in jobs:
             if job["name"] in ("all-jobs-are-green", "fancy-report"):
+                logging.info(f"Skipping job {job['name']}")
                 continue
 
             if job["conclusion"] not in ["skipped", "success"]:
+                logging.info(f"Job {job['name']} conclusion: {job['conclusion']}")
                 has_failure = True
 
             if job["conclusion"] != "failure":
@@ -62,16 +69,48 @@ def main(repo_slug: str, run_id: int) -> None:
                     failing_steps[step["name"]].append((job, step))
 
         for step_name, items in failing_steps.items():
-            print(f"❌ **Failures for `{step_name}`**\n")
+            result.append(f"❌ **Failures for `{step_name}`**\n")
             for job, step in sorted(items, key=lambda x: x[0]["name"]):
                 url = job["html_url"]
-                print(f"* [{job['name']}]({url}#step:{step['number']})")
+                result.append(f"* [{job['name']}]({url}#step:{step['number']})")
+
+            result.append("")
 
+        if output:
+            logging.info(f"Writing output to {output}")
+            with open(output, "w") as f:
+                f.write("\n".join(result))
+        else:
+            logging.info("Writing output to stdout")
+            print("\n".join(result))
             print()
 
     if has_failure:
         sys.exit(1)
 
 
 if __name__ == "__main__":
-    main("DataDog/system-tests", int(sys.argv[1]))
+    parser = argparse.ArgumentParser(
+        prog="get-workflow-summary", description="List all failing step of a github workflow, and pretty print them"
+    )
+
+    parser.add_argument("repo_slug", type=str, help="Repo slug of the workflow")
+
+    parser.add_argument("run_id", type=int, help="Run Id of the workflow")
+
+    parser.add_argument(
+        "--output",
+        "-o",
+        type=str,
+        default="",
+        help="Output file. If not provided, output to stdout",
+    )
+    args = parser.parse_args()
+
+    logging.basicConfig(level=logging.INFO, format="%(levelname)s: %(message)s", stream=sys.stderr)
+
+    main(
+        repo_slug=args.repo_slug,
+        run_id=args.run_id,
+        output=args.output,
+    )