feat: Upload signed test PDFs as artifacts and refine PDF validation workflow.

vanbroup · vanbroup · commit 823f96f4b3dc · 2026-01-02T11:09:03.000+01:00
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -10,29 +10,34 @@ permissions:
   contents: read
 
 jobs:
-
   build:
     name: Build
     runs-on: ubuntu-latest
     steps:
-
-    - name: Set up Go 1.x
-      uses: actions/setup-go@v5
-      with:
-        go-version: ^1.20
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v4
-
-    - name: Build
-      run: go build -v ./...
-
-    - name: Test
-      run: go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...
-
-    - name: Upload coverage report
-      uses: codecov/codecov-action@v4
-      with:
-        file: ./coverage.txt
-        flags: unittests
-        name: codecov-umbrella
+      - name: Set up Go 1.x
+        uses: actions/setup-go@v5
+        with:
+          go-version: ^1.23
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v4
+
+      - name: Build
+        run: go build -v ./...
+
+      - name: Test
+        run: go test -v -race -coverprofile=coverage.txt -covermode=atomic ./...
+
+      - name: Upload test PDF files
+        uses: actions/upload-artifact@v6
+        with:
+          name: test-pdf-artifacts
+          path: testfiles/success/
+          retention-days: 7
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.txt
+          flags: unittests
+          name: codecov-umbrella
diff --git a/.github/workflows/validation.yml b/.github/workflows/validation.yml
@@ -14,7 +14,9 @@ permissions:
 
 jobs:
   validation:
+    name: PDF Validation
     runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.workflow_run.conclusion == 'success' }}
     steps:
       - name: Set up Go 1.x
         uses: actions/setup-go@v5
@@ -30,69 +32,57 @@ jobs:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           name: test-pdf-artifacts
           path: test_pdf_files
+          run-id: ${{ github.event.workflow_run.id }}
 
       - name: Check for PDF files
         id: check_files
         run: |
           if [ -d "test_pdf_files" ] && [ -n "$(ls -A test_pdf_files 2>/dev/null)" ]; then
              echo "exists=true" >> $GITHUB_OUTPUT
-             echo "Files found."
           else
              echo "exists=false" >> $GITHUB_OUTPUT
-             echo "No files found."
           fi
 
       - name: Run pdfcpu validation
         id: pdfcpu-validate
         if: steps.check_files.outputs.exists == 'true'
         run: |
-          echo "::group::PDF pdfcpu Validation Results"
-          # Create a temporary file to store validation results
           PDFCPU_RESULT_FILE=$(mktemp)
+          VALIDATION_REPORT="validation_results.md"
+          VALIDATION_PASSED="true"
 
           {
             echo "## PDF Validation Results"
             echo ""
-            
             for file in test_pdf_files/*; do
-              echo "### Validating $file with pdfcpu"
+              echo "### Validating \`$(basename $file)\`"
               echo '```'
-              
-              # pdfcpu validation
-              pdfcpu validate -mode strict "$file" 2>&1 | tee -a $PDFCPU_RESULT_FILE
-              PDFCPU_STATUS=$?
-              
-              if [ $PDFCPU_STATUS -eq 0 ]; then
-                echo "✅ pdfcpu validation passed for $file" | tee -a $PDFCPU_RESULT_FILE
+              if pdfcpu validate -mode strict "$file" 2>&1; then
+                echo "✅ Passed"
               else
-                echo "❌ pdfcpu validation failed for $file" | tee -a $PDFCPU_RESULT_FILE
+                echo "❌ Failed"
+                VALIDATION_PASSED="false"
               fi
               echo '```'
-              echo "" | tee -a $PDFCPU_RESULT_FILE
+              echo ""
             done
-            
-            # Determine pdfcpu status
-            if grep -q "❌" $PDFCPU_RESULT_FILE; then
-              echo "### ❌ Some pdfcpu validations failed"
-              echo "See details above for specific failures."
-              VALIDATION_PASSED="false"
+
+            if [ "$VALIDATION_PASSED" == "true" ]; then
+              echo "### ✅ All validations passed"
             else
-              echo "### ✅ All pdfcpu validations passed"
-              VALIDATION_PASSED="true"  
+              echo "### ❌ Some validations failed"
             fi
-            echo "validation_passed=$VALIDATION_PASSED" >> $GITHUB_OUTPUT
-          } > validation_results.md
+          } > $VALIDATION_REPORT
 
-          cat validation_results.md
-          echo "::endgroup::"
+          cat $VALIDATION_REPORT
+          echo "validation_passed=$VALIDATION_PASSED" >> $GITHUB_OUTPUT
 
       - name: Create skipped report
         if: steps.check_files.outputs.exists != 'true'
         run: |
           echo "## PDF Validation Results" > validation_results.md
           echo "" >> validation_results.md
-          echo "### ⏭️ Validation Skipped: No PDF files found to validate" >> validation_results.md
-          echo "validation_passed=skipped" >> $GITHUB_OUTPUT
+          echo "### ⏭️ Skipped: No PDF files found" >> validation_results.md
 
       - name: Upload validation results
         uses: actions/upload-artifact@v4
@@ -101,27 +91,10 @@ jobs:
           path: validation_results.md
           retention-days: 7
 
-      - name: Find PR comment
-        if: github.event_name == 'pull_request'
-        id: find-comment
-        uses: peter-evans/find-comment@v4
-        with:
-          issue-number: ${{ github.event.pull_request.number }}
-          comment-author: "github-actions[bot]"
-          body-includes: "## PDF Validation Results"
-
-      - name: Create or update comment
-        if: github.event_name == 'pull_request'
-        uses: peter-evans/create-or-update-comment@v5
-        with:
-          comment-id: ${{ steps.find-comment.outputs.comment-id }}
-          issue-number: ${{ github.event.pull_request.number }}
-          body-file: validation_results.md
-          edit-mode: replace
-
       - name: Check validation status
+        if: steps.check_files.outputs.exists == 'true'
         run: |
           if [[ "${{ steps.pdfcpu-validate.outputs.validation_passed }}" == "false" ]]; then
-            echo "Validation failed! Check the PR comment for details."
+            echo "Validation failed!"
             exit 1
-          fi
+          fi
diff --git a/sign/sign_test.go b/sign/sign_test.go
@@ -128,6 +128,8 @@ func TestReaderCanReadPDF(t *testing.T) {
 func TestSignPDF(t *testing.T) {
 	_ = os.RemoveAll("../testfiles/failed/")
 	_ = os.MkdirAll("../testfiles/failed/", 0o777)
+	_ = os.RemoveAll("../testfiles/success/")
+	_ = os.MkdirAll("../testfiles/success/", 0o777)
 
 	files, err := os.ReadDir("../testfiles/")
 	if err != nil {
@@ -143,13 +145,29 @@ func TestSignPDF(t *testing.T) {
 		}
 
 		t.Run(f.Name(), func(st *testing.T) {
-			outputFile, err := os.CreateTemp("", fmt.Sprintf("%s_%s_", t.Name(), f.Name()))
+			var outputFile *os.File
+			var err error
+
+			if st.Verbose() {
+				// In verbose mode, write directly to the success directory in testfiles
+				outputFile, err = os.Create(filepath.Join("../testfiles/success", f.Name()))
+			} else {
+				// In normal mode, use a temporary file
+				outputFile, err = os.CreateTemp("", fmt.Sprintf("%s_%s_", t.Name(), f.Name()))
+			}
+
 			if err != nil {
 				st.Fatalf("%s", err.Error())
 			}
+			
+			// Only remove the file if we are NOT in verbose mode
 			defer func() {
-				if err := os.Remove(outputFile.Name()); err != nil {
-					st.Errorf("Failed to remove output file: %v", err)
+				if !st.Verbose() {
+					if err := os.Remove(outputFile.Name()); err != nil {
+						st.Errorf("Failed to remove output file: %v", err)
+					}
+				} else {
+					st.Logf("Preserving test file in success folder: %s", outputFile.Name())
 				}
 			}()
 
