Get wrangle results displayed well (enough) (#1)

Creates markdown with the tool results and displays that as a summary of the run.

Author: TomHennen

.github/workflows/check_source.yml

@@ -27,7 +27,7 @@ jobs:
       id: scan
       run: ./run.sh osv zizmor
     - name: Display results
-      run: find ./
+      run: cat ./metadata/summary.md >> $GITHUB_STEP_SUMMARY 
     - name: Upload SARIFs
       if: ${{ false }} # We're still a private repo so we can't enable code scanning. :(
       uses: github/codeql-action/upload-sarif@v3

run.sh

@@ -4,19 +4,38 @@ set -e
 # Pass tools to run as arguments.
 # e.g. run.sh foo bar
 
+mkdir ./metadata
+SUMMARY_FILE=./metadata/summary.md
+echo "# Wrangle results" >> $SUMMARY_FILE
+echo "| Tool | Status | Results |" >> $SUMMARY_FILE
+echo "| ---- | ------ | ------- |" >> $SUMMARY_FILE
 WRANGLE_EXIT_STATUS=0
 for tool in $@;
 do
     echo "Running $tool..."
     mkdir -p ./metadata/$tool
     mkdir -p ./dist/$tool
+    TOOL_STATUS="Success"
     docker run \
        --quiet \
        --mount type=bind,source=./dist/$tool,target=/dist \
 	   --mount type=bind,source=./metadata/$tool,target=/metadata \
 	   --mount type=bind,source=./,target=/src,readonly \
        -v /var/run/docker.sock:/var/run/docker.sock \
-	   ghcr.io/tomhennen/wrangle/$tool:main || (echo "$tool failed" && WRANGLE_EXIT_STATUS=1)
-    echo "$tool done"
+	   ghcr.io/tomhennen/wrangle/$tool:main | tee ./metadata/$tool/output.txt || WRANGLE_EXIT_STATUS=1; TOOL_STATUS="Failed"
+    echo "$tool $TOOL_STATUS"
+    echo "| $tool | $TOOL_STATUS | [Details](#$tool-details) |" >> $SUMMARY_FILE
 done
+
+echo "" >> $SUMMARY_FILE
+
+# Add in the details
+for tool in $@;
+do
+    echo "## $tool Details" >> $SUMMARY_FILE
+    printf "\n\n<pre><code>" >> $SUMMARY_FILE
+    cat ./metadata/$tool/output.txt >> $SUMMARY_FILE
+    printf "</code></pre>\n" >> $SUMMARY_FILE
+done
+echo "Done with all tools. Exiting with $WRANGLE_EXIT_STATUS"
 exit $WRANGLE_EXIT_STATUS

tools/osv/run.sh

@@ -7,8 +7,8 @@ WRANGLE_EXIT_STATUS=0
 
 # Run a scan over all of source and ignore errors, because OSV likes to fail
 # too often. :) (Maybe it generates an error code when it finds problems?)
-/osv-scanner --format sarif --output /metadata/osv.sarif -r /src || (echo "osv failure when generating sarif" && WRANGLE_EXIT_STATUS=1)
+/osv-scanner --format sarif --output /metadata/osv.sarif -r /src || echo "osv failure when generating sarif"; WRANGLE_EXIT_STATUS=1
 # Run it again for the markdown. (if only we could output in multiple formats from one run...)
-/osv-scanner --format markdown --output /metadata/osv.md -r /src || (echo`"osv failure when generating markdown" && WRANGLE_EXIT_STATUS=1)
+/osv-scanner --format markdown --output /metadata/osv.md -r /src || echo "osv failure when generating markdown"; WRANGLE_EXIT_STATUS=1
 cat /metadata/osv.md
 exit $WRANGLE_EXIT_STATUS

tools/zizmor/run.sh

@@ -5,9 +5,9 @@ echo "zizmor"
 WRANGLE_EXIT_STATUS=0
 NO_COLOR=1
 echo "zizmor sarif"
-/usr/local/cargo/bin/zizmor --format sarif -o `find /src/.github/workflows -name "*.yml"` > /metadata/zizmor.sarif || (echo "zizmor failure when generating sarif" && WRANGLE_EXIT_STATUS=1)
+/usr/local/cargo/bin/zizmor --format sarif -o `find /src/.github/workflows -name "*.yml"` > /metadata/zizmor.sarif || echo "zizmor failure when generating sarif"; WRANGLE_EXIT_STATUS=1
 # Run it again for the plain output. (if only we could output in multiple formats from one run...)
 echo "zizmor plain"
-/usr/local/cargo/bin/zizmor --format plain -o `find /src/.github/workflows -name "*.yml"` > /metadata/zizmor.txt || (echo "zizmor failure when generating text" && WRANGLE_EXIT_STATUS=1)
+/usr/local/cargo/bin/zizmor --format plain -o `find /src/.github/workflows -name "*.yml"` > /metadata/zizmor.txt || echo "zizmor failure when generating text"; WRANGLE_EXIT_STATUS=1
 cat /metadata/zizmor.txt
 exit $WRANGLE_EXIT_STATUS