tests: Use 'Filing' (and 'Result') instead of 'Finding' in tests

Author: smockle

.github/workflows/test.yml

@@ -61,7 +61,7 @@ jobs:
         id: cache_key
         shell: bash
         run: |
-          echo "cache_key=$(printf 'cached_findings-%s-%s.json' "${{ github.ref_name }}" "${{ matrix.site }}" | tr -cs 'A-Za-z0-9._-' '_')" >> $GITHUB_OUTPUT
+          echo "cache_key=$(printf 'cached_filings-%s-%s.json' "${{ matrix.site }}" "${{ github.ref_name }}" | tr -cs 'A-Za-z0-9._-' '_')" >> $GITHUB_OUTPUT
 
       - name: Scan site (${{ matrix.site }})
         uses: ./
@@ -78,28 +78,28 @@ jobs:
           token: ${{ secrets.GH_TOKEN }}
           cache_key: ${{ steps.cache_key.outputs.cache_key }}
 
-      - name: Retrieve cached findings
+      - name: Retrieve cached filings
         uses: ./.github/actions/gh-cache/restore
         with:
           path: ${{ steps.cache_key.outputs.cache_key }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Add PR URLs to findings
+      - name: Add PR URLs to filings
         uses: actions/github-script@v8
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           script: |
             const fs = require('fs');
-            if (!process.env.FINDINGS_PATH || !fs.existsSync(process.env.FINDINGS_PATH)) {
-              core.info("Skipping 'Add PR URLs to findings' (no cached findings).");
+            if (!process.env.CACHE_PATH || !fs.existsSync(process.env.CACHE_PATH)) {
+              core.info("Skipping 'Add PR URLs to filings' (no cached filings).");
               return;
             }
-            const findings = JSON.parse(fs.readFileSync(process.env.FINDINGS_PATH, 'utf-8'));
-            for (const finding of findings) {
-              if (!finding.issueUrl) {
+            const filings = JSON.parse(fs.readFileSync(process.env.CACHE_PATH, 'utf-8'));
+            for (const filing of filings) {
+              if (!filing?.issue.url) {
                 continue;
               }
-              const { owner, repo, issueNumber } = /https:\/\/github\.com\/(?<owner>[^/]+)\/(?<repo>[^/]+)\/issues\/(?<issueNumber>\d+)/.exec(finding.issueUrl).groups;
+              const { owner, repo, issueNumber } = /https:\/\/github\.com\/(?<owner>[^/]+)\/(?<repo>[^/]+)\/issues\/(?<issueNumber>\d+)/.exec(filing.issue.url).groups;
               const query = `query($owner: String!, $repo: String!, $issueNumber: Int!) {
                 repository(owner: $owner, name: $repo) {
                   issue(number: $issueNumber) {
@@ -117,35 +117,35 @@ jobs:
               const timelineNodes = result?.repository?.issue?.timelineItems?.nodes || [];
               const pullRequestNode = timelineNodes.find(n => n?.source?.url || n?.subject?.url);
               if (pullRequestNode) {
-                finding.pullRequestUrl = pullRequestNode.source?.url || pullRequestNode.subject?.url;
+                filing.pullRequest = { url: pullRequestNode.source?.url || pullRequestNode.subject?.url };
               } else {
-                core.info(`No pull request found for issue: ${finding.issueUrl}`);
+                core.info(`No pull request found for issue: ${filing.issue.url}`);
               }
             }
-            fs.writeFileSync(process.env.FINDINGS_PATH, JSON.stringify(findings));
+            fs.writeFileSync(process.env.CACHE_PATH, JSON.stringify(filings));
         env:
-          FINDINGS_PATH: ${{ steps.cache_key.outputs.cache_key }}
+          CACHE_PATH: ${{ steps.cache_key.outputs.cache_key }}
 
       - name: Validate scan results (${{ matrix.site }})
         run: |
           npm ci
           npm run test
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          FINDINGS_PATH: ${{ steps.cache_key.outputs.cache_key }}
+          CACHE_PATH: ${{ steps.cache_key.outputs.cache_key }}
 
       - name: Clean up issues and pull requests
         if: ${{ always() }}
         shell: bash
         run: |
           set -euo pipefail
           if [[ ! -f "${{ steps.cache_key.outputs.cache_key }}" ]]; then
-            echo "Skipping 'Clean up issues and pull requests' (no cached findings)."
+            echo "Skipping 'Clean up issues and pull requests' (no cached filings)."
             exit 0
           fi
           jq -r '
             (if type=="string" then fromjson else . end)
-            | .[] | .issueUrl, .pullRequestUrl
+            | .[] | .issue.url, .pullRequest.url
             | select(. != null)
           ' "${{ steps.cache_key.outputs.cache_key }}" \
             | while read -r URL; do
@@ -162,7 +162,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Clean up cached findings
+      - name: Clean up cached filings
         if: ${{ always() }}
         uses: ./.github/actions/gh-cache/delete
         with:

README.md

@@ -96,7 +96,7 @@ Trigger the workflow manually or automatically based on your configuration. The
 | `urls` | Yes | Newline-delimited list of URLs to scan | `https://primer.style`<br>`https://primer.style/octicons` |
 | `repository` | Yes | Repository (with owner) for issues and PRs | `primer/primer-docs` |
 | `token` | Yes | PAT with write permissions (see above) | `${{ secrets.GH_TOKEN }}` |
-| `cache_key` | Yes | Key for caching findings across runs<br>Allowed: `A-Za-z0-9._/-` | `cached_findings-main-primer.style.json` |
+| `cache_key` | Yes | Key for caching findings across runs<br>Allowed: `A-Za-z0-9._/-` | `cached_filings-main-primer.style.json` |
 | `login_url` | No | If scanned pages require authentication, the URL of the login page | `https://github.com/login` |
 | `username` | No | If scanned pages require authentication, the username to use for login | `some-user` |
 | `password` | No | If scanned pages require authentication, the password to use for login | `correct-horse-battery-staple` |

tests/site-with-errors.test.ts

@@ -1,22 +1,23 @@
 import type { Endpoints } from "@octokit/types"
-import type { Finding } from "./types.d.js";
+import type { Result } from "./types.d.js";
 import fs from "node:fs";
 import { describe, it, expect, beforeAll } from "vitest";
 import { Octokit } from "@octokit/core";
 import { throttling } from "@octokit/plugin-throttling";
 const OctokitWithThrottling = Octokit.plugin(throttling);
 
 describe("site-with-errors", () => {
-  let findings: Finding[];
+  let results: Result[];
 
   beforeAll(() => {
-    expect(process.env.FINDINGS_PATH).toBeDefined();
-    expect(fs.existsSync(process.env.FINDINGS_PATH!)).toBe(true);
-    findings = JSON.parse(fs.readFileSync(process.env.FINDINGS_PATH!, "utf-8"));
+    expect(process.env.CACHE_PATH).toBeDefined();
+    expect(fs.existsSync(process.env.CACHE_PATH!)).toBe(true);
+    results = JSON.parse(fs.readFileSync(process.env.CACHE_PATH!, "utf-8"));
   });
 
-  it("cache has expected findings", () => {
-    const actual = findings.map(({ issueUrl, pullRequestUrl, solutionLong, ...finding }) => {
+  it("cache has expected results", () => {
+    const actual = results.map(({ issue: { url: issueUrl }, pullRequest: { url: pullRequestUrl }, findings }) => {
+      const { solutionLong, ...finding } = findings[0];
       // Check volatile fields for existence only
       expect(issueUrl).toBeDefined();
       expect(pullRequestUrl).toBeDefined();
@@ -113,8 +114,8 @@ describe("site-with-errors", () => {
           },
         }
       });
-      // Fetch issues referenced in the findings file
-      issues = await Promise.all(findings.map(async ({ issueUrl }) => {
+      // Fetch issues referenced in the cache file
+      issues = await Promise.all(results.map(async ({ issue: { url: issueUrl } }) => {
         expect(issueUrl).toBeDefined();
         const { owner, repo, issueNumber } =
           /https:\/\/github\.com\/(?<owner>[^/]+)\/(?<repo>[^/]+)\/issues\/(?<issueNumber>\d+)/.exec(issueUrl!)!.groups!;
@@ -127,7 +128,7 @@ describe("site-with-errors", () => {
         return issue;
       }));
       // Fetch pull requests referenced in the findings file
-      pullRequests = await Promise.all(findings.map(async ({ pullRequestUrl }) => {
+      pullRequests = await Promise.all(results.map(async ({ pullRequest: { url: pullRequestUrl } }) => {
         expect(pullRequestUrl).toBeDefined();
         const { owner, repo, pullNumber } =
           /https:\/\/github\.com\/(?<owner>[^/]+)\/(?<repo>[^/]+)\/pull\/(?<pullNumber>\d+)/.exec(pullRequestUrl!)!.groups!;

tests/types.d.ts

@@ -7,6 +7,22 @@ export type Finding = {
   problemUrl: string;
   solutionShort: string;
   solutionLong?: string;
-  issueUrl?: string;
-  pullRequestUrl?: string;
-}
+};
+
+export type Issue = {
+  id: number;
+  nodeId: string;
+  url: string;
+  title: string;
+  state?: "open" | "reopened" | "closed";
+};
+
+export type PullRequest = {
+  url: string;
+};
+
+export type Result = {
+  findings: Finding[];
+  issue: Issue;
+  pullRequest: PullRequest;
+};