Better reporting workflow (#3)

* enhance PDK workflow with validation results annotation

* switch to inline command for run property in pdk_tests.yaml

* replacing shell script by python script to parse xml formatted result of `pdk validate`

* setting up pdk manually, rather than having to install python in container

* piping the output of `pdk validate` to pdk-validate annotation script

* using job environment variable to define directory targeted by scan

Author: Scirelgar

.github/scripts/pdk_validate

@@ -0,0 +1,54 @@
+#!/usr/bin/env python3
+
+import xml.etree.ElementTree as et
+import sys
+
+PUPPET_MODULE=""
+
+def parse_pdk_validate_results() -> et.ElementTree:
+    """
+    Parse the xml file and return the tree
+
+    Returns:
+        et.ElementTree: The parsed tree
+    """
+    tree = et.parse(sys.stdin)
+    return tree
+
+def add_annotation(testcase:et.Element):
+    """
+    Writes Github commands to stdout to add annotations to the Github Actions
+
+    Args:
+        testcase (et.Element): The testcase to add the annotation for
+    """
+    check=testcase[0].get("classname")
+    file,line,column=testcase[0].get("name").split(":")
+    kind="error" if testcase[1].get("type")=="error" else "warning"
+    message=testcase[1].get("message")
+    print(f"::{kind} file={PUPPET_MODULE}/{file},line={line},col={column},title={check}::{message}")
+
+def scan_testcases(only_errors:bool):
+    """
+    Scan the test cases
+
+    Args:
+        only_errors (bool): Only scan for errors
+    """
+    root = parse_pdk_validate_results().getroot()
+    
+    for testcase in root.iter("testcase"):
+        failure = testcase.find("failure")
+        if failure is None:
+            continue
+        if only_errors and failure.get("type")!="error":
+            continue
+        add_annotation([testcase, failure])
+
+def main(only_errors):
+    scan_testcases(only_errors)
+
+if __name__ == "__main__":
+    if "--module" in sys.argv:
+        PUPPET_MODULE=sys.argv[sys.argv.index("--module")+1]
+    main(sys.argv[1]=="--only-errors")

.github/workflows/pdk_tests.yaml

@@ -6,23 +6,25 @@ jobs:
   run-pdk-tests:
     name: Run PDK tests
     runs-on: ubuntu-latest
-    container:
-      image: puppet/pdk:latest
+    env:
+      PUPPET_MODULE: site/profile
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
-      - name: Run PDK version
-        run: pdk --version
-        continue-on-error: false
+      - name: Setup PDK
+        run: |
+          wget https://apt.puppet.com/puppet-tools-release-jammy.deb
+          sudo dpkg -i puppet-tools-release-jammy.deb
+          sudo apt-get update
+          sudo apt-get install pdk
 
       - name: Run PDK validate
-        run: pdk validate
-        working-directory: site/profile
-        continue-on-error: true
+        run: pdk validate --format=junit | "${{github.workspace}}/.github/scripts/pdk_validate" --only-errors --module ${{env.PUPPET_MODULE}}
+        working-directory: "${{env.PUPPET_MODULE}}"
 
       - name: Run PDK unit test
         run: pdk test unit
-        working-directory: site/profile
         continue-on-error: true
+        working-directory: "${{env.PUPPET_MODULE}}"