@lullabot/playwright-testing 1.0.0 → 1.1.0

package/src/github/index.test.ts

@@ -1,4 +1,4 @@
-import { describe, expect, it } from 'vitest'
+import { describe, expect, it } from "vitest";
 import {
   AttachmentUploader,
   createPathResolver,
@@ -8,17 +8,17 @@ import {
   generateFailureSummary,
   parseA11yResults,
   parseFailures,
-} from './index'
+} from "./index";
 
-describe('GitHub package entry point', () => {
-  it('exports the reporting, attachment, and path-remapping APIs', () => {
-    expect(parseA11yResults).toBeTypeOf('function')
-    expect(generateA11ySummary).toBeTypeOf('function')
-    expect(generateA11yAnnotations).toBeTypeOf('function')
-    expect(parseFailures).toBeTypeOf('function')
-    expect(generateFailureSummary).toBeTypeOf('function')
-    expect(generateFailureComment).toBeTypeOf('function')
-    expect(AttachmentUploader).toBeTypeOf('function')
-    expect(createPathResolver).toBeTypeOf('function')
-  })
-})
+describe("GitHub package entry point", () => {
+  it("exports the reporting, attachment, and path-remapping APIs", () => {
+    expect(parseA11yResults).toBeTypeOf("function");
+    expect(generateA11ySummary).toBeTypeOf("function");
+    expect(generateA11yAnnotations).toBeTypeOf("function");
+    expect(parseFailures).toBeTypeOf("function");
+    expect(generateFailureSummary).toBeTypeOf("function");
+    expect(generateFailureComment).toBeTypeOf("function");
+    expect(AttachmentUploader).toBeTypeOf("function");
+    expect(createPathResolver).toBeTypeOf("function");
+  });
+});

package/src/github/index.ts

@@ -3,10 +3,10 @@ export {
   generateSummary as generateA11ySummary,
   main as runA11ySummary,
   parseA11yResults,
-} from './a11y-summary'
-export type { A11yReport, A11yTestResult } from './a11y-summary'
+} from "./a11y-summary";
+export type { A11yReport, A11yTestResult } from "./a11y-summary";
 
-export * from './attachments'
+export * from "./attachments";
 
 export {
   FAILURE_MARKER_PREFIX,
@@ -19,7 +19,7 @@ export {
   resolveImagePaths,
   uploaderFromEnvironment,
   uploadImages,
-} from './failure-summary'
+} from "./failure-summary";
 export type {
   FailedTest,
   FailureImage,
@@ -30,6 +30,6 @@ export type {
   IncludeMode,
   PathResolutionSummary,
   SummaryOptions,
-} from './failure-summary'
+} from "./failure-summary";
 
-export * from './report-paths'
+export * from "./report-paths";

package/src/github/report-paths.test.ts

@@ -1,222 +1,277 @@
-import { describe, it, expect, beforeEach, afterEach } from 'vitest'
-import * as fs from 'fs'
-import * as os from 'os'
-import * as path from 'path'
-import { createPathResolver, parsePathPrefix } from './report-paths'
+import { describe, it, expect, beforeEach, afterEach } from "vitest";
+import * as fs from "fs";
+import * as os from "os";
+import * as path from "path";
+import { createPathResolver, parsePathPrefix } from "./report-paths";
 
-let tmpDir: string
+let tmpDir: string;
 
 beforeEach(() => {
-  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'report-paths-test-'))
-})
+  tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "report-paths-test-"));
+});
 
 afterEach(() => {
-  fs.rmSync(tmpDir, { recursive: true, force: true })
-})
+  fs.rmSync(tmpDir, { recursive: true, force: true });
+});
 
 /** Create a file, and every directory above it, under the temporary directory. */
 function touch(relativePath: string): string {
-  const filePath = path.join(tmpDir, relativePath)
-  fs.mkdirSync(path.dirname(filePath), { recursive: true })
-  fs.writeFileSync(filePath, 'png')
-  return filePath
+  const filePath = path.join(tmpDir, relativePath);
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+  fs.writeFileSync(filePath, "png");
+  return filePath;
 }
 
-describe('parsePathPrefix', () => {
-  it('splits on the first colon', () => {
-    expect(parsePathPrefix('/var/www/html:/home/runner/work/site/site')).toEqual({
-      from: '/var/www/html',
-      to: '/home/runner/work/site/site',
-    })
-  })
-
-  it('keeps a colon in the local path, as Windows drives have', () => {
-    expect(parsePathPrefix('/var/www/html:C:/checkout')).toEqual({
-      from: '/var/www/html',
-      to: 'C:/checkout',
-    })
-  })
-
-  it('rejects a value that is not a pair', () => {
-    expect(parsePathPrefix('/var/www/html')).toBeNull()
-    expect(parsePathPrefix(':/home/runner')).toBeNull()
-    expect(parsePathPrefix('/var/www/html:')).toBeNull()
-  })
-})
-
-describe('createPathResolver', () => {
-  it('leaves a path that already resolves alone', () => {
-    const filePath = touch('test/playwright/test-results/diff.png')
-    const resolve = createPathResolver({ reportPath: path.join(tmpDir, 'results.json') })
-
-    expect(resolve(filePath)).toEqual({ path: filePath, found: true })
-  })
-
-  it('re-roots a container path onto the checkout', () => {
-    touch('test/playwright/test-results/home-chromium/home-1-diff.png')
+describe("parsePathPrefix", () => {
+  it("splits on the first colon", () => {
+    expect(
+      parsePathPrefix("/var/www/html:/home/runner/work/site/site"),
+    ).toEqual({
+      from: "/var/www/html",
+      to: "/home/runner/work/site/site",
+    });
+  });
+
+  it("keeps a colon in the local path, as Windows drives have", () => {
+    expect(parsePathPrefix("/var/www/html:C:/checkout")).toEqual({
+      from: "/var/www/html",
+      to: "C:/checkout",
+    });
+  });
+
+  it("rejects a value that is not a pair", () => {
+    expect(parsePathPrefix("/var/www/html")).toBeNull();
+    expect(parsePathPrefix(":/home/runner")).toBeNull();
+    expect(parsePathPrefix("/var/www/html:")).toBeNull();
+  });
+});
+
+describe("createPathResolver", () => {
+  it("leaves a path that already resolves alone", () => {
+    const filePath = touch("test/playwright/test-results/diff.png");
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'test/playwright/test-results/results.json'),
-    })
+      reportPath: path.join(tmpDir, "results.json"),
+    });
 
-    const resolution = resolve(
-      '/var/www/html/test/playwright/test-results/home-chromium/home-1-diff.png',
-    )
+    expect(resolve(filePath)).toEqual({ path: filePath, found: true });
+  });
 
-    expect(resolution.found).toBe(true)
-    expect(resolution.path)
-      .toBe(path.join(tmpDir, 'test/playwright/test-results/home-chromium/home-1-diff.png'))
-    expect(resolution.prefix).toEqual({ from: '/var/www/html', to: tmpDir })
-  })
+  it("re-roots a container path onto the checkout", () => {
+    touch("test/playwright/test-results/home-chromium/home-1-diff.png");
+    const resolve = createPathResolver({
+      reportPath: path.join(
+        tmpDir,
+        "test/playwright/test-results/results.json",
+      ),
+    });
 
-  it('finds the files when the report sits outside the output directory', () => {
+    const resolution = resolve(
+      "/var/www/html/test/playwright/test-results/home-chromium/home-1-diff.png",
+    );
+
+    expect(resolution.found).toBe(true);
+    expect(resolution.path).toBe(
+      path.join(
+        tmpDir,
+        "test/playwright/test-results/home-chromium/home-1-diff.png",
+      ),
+    );
+    expect(resolution.prefix).toEqual({ from: "/var/www/html", to: tmpDir });
+  });
+
+  it("finds the files when the report sits outside the output directory", () => {
     // The arrangement the integration test produces: the report is written
     // beside the Playwright config while the images go to a separate output
     // directory, so the two share nothing but the mount point.
-    touch('test/playwright/test-results-visual/fixture-chromium/fixture-diff.png')
+    touch(
+      "test/playwright/test-results-visual/fixture-chromium/fixture-diff.png",
+    );
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'test/playwright/visual-diff-results.json'),
-    })
+      reportPath: path.join(tmpDir, "test/playwright/visual-diff-results.json"),
+    });
 
     const resolution = resolve(
-      '/var/www/html/test/playwright/test-results-visual/fixture-chromium/fixture-diff.png',
-    )
-
-    expect(resolution.found).toBe(true)
-    expect(resolution.path)
-      .toBe(path.join(tmpDir, 'test/playwright/test-results-visual/fixture-chromium/fixture-diff.png'))
-  })
-
-  it('does not assume a fixed offset between the report and the mount point', () => {
+      "/var/www/html/test/playwright/test-results-visual/fixture-chromium/fixture-diff.png",
+    );
+
+    expect(resolution.found).toBe(true);
+    expect(resolution.path).toBe(
+      path.join(
+        tmpDir,
+        "test/playwright/test-results-visual/fixture-chromium/fixture-diff.png",
+      ),
+    );
+  });
+
+  it("does not assume a fixed offset between the report and the mount point", () => {
     // This repository's own CI creates the project under a generated directory,
     // so its depth below the workspace differs from the container's.
-    touch('tmp/pwtest-abc123/test/playwright/test-results/home-chromium/home-1-diff.png')
+    touch(
+      "tmp/pwtest-abc123/test/playwright/test-results/home-chromium/home-1-diff.png",
+    );
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'tmp/pwtest-abc123/test/playwright/test-results/results.json'),
-    })
+      reportPath: path.join(
+        tmpDir,
+        "tmp/pwtest-abc123/test/playwright/test-results/results.json",
+      ),
+    });
 
     const resolution = resolve(
-      '/var/www/html/test/playwright/test-results/home-chromium/home-1-diff.png',
-    )
+      "/var/www/html/test/playwright/test-results/home-chromium/home-1-diff.png",
+    );
 
-    expect(resolution.found).toBe(true)
+    expect(resolution.found).toBe(true);
     expect(resolution.prefix).toEqual({
-      from: '/var/www/html',
-      to: path.join(tmpDir, 'tmp/pwtest-abc123'),
-    })
-  })
+      from: "/var/www/html",
+      to: path.join(tmpDir, "tmp/pwtest-abc123"),
+    });
+  });
 
-  it('prefers the longest tail, so the most specific match wins', () => {
+  it("prefers the longest tail, so the most specific match wins", () => {
     // A shallow decoy sharing the last two components must not beat the real
     // file, which shares many more.
-    touch('decoy/fixture-chromium/fixture-diff.png')
-    touch('test/playwright/test-results/fixture-chromium/fixture-diff.png')
+    touch("decoy/fixture-chromium/fixture-diff.png");
+    touch("test/playwright/test-results/fixture-chromium/fixture-diff.png");
 
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'test/playwright/test-results/results.json'),
-    })
-
-    expect(resolve('/var/www/html/test/playwright/test-results/fixture-chromium/fixture-diff.png').path)
-      .toBe(path.join(tmpDir, 'test/playwright/test-results/fixture-chromium/fixture-diff.png'))
-  })
-
-  it('will not identify a file by its name alone', () => {
+      reportPath: path.join(
+        tmpDir,
+        "test/playwright/test-results/results.json",
+      ),
+    });
+
+    expect(
+      resolve(
+        "/var/www/html/test/playwright/test-results/fixture-chromium/fixture-diff.png",
+      ).path,
+    ).toBe(
+      path.join(
+        tmpDir,
+        "test/playwright/test-results/fixture-chromium/fixture-diff.png",
+      ),
+    );
+  });
+
+  it("will not identify a file by its name alone", () => {
     // One component of tail is a coincidence waiting to happen: some unrelated
     // fixture-diff.png must not be served up as the failure's diff image.
-    touch('fixture-diff.png')
-    const resolve = createPathResolver({ reportPath: path.join(tmpDir, 'results.json') })
+    touch("fixture-diff.png");
+    const resolve = createPathResolver({
+      reportPath: path.join(tmpDir, "results.json"),
+    });
 
-    expect(resolve('/var/www/html/somewhere/else/fixture-diff.png').found).toBe(false)
-  })
+    expect(resolve("/var/www/html/somewhere/else/fixture-diff.png").found).toBe(
+      false,
+    );
+  });
 
-  it('reports a path it cannot find rather than inventing one', () => {
+  it("reports a path it cannot find rather than inventing one", () => {
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'test/playwright/test-results/results.json'),
-    })
+      reportPath: path.join(
+        tmpDir,
+        "test/playwright/test-results/results.json",
+      ),
+    });
 
-    const resolution = resolve('/var/www/html/test/playwright/test-results/missing-diff.png')
+    const resolution = resolve(
+      "/var/www/html/test/playwright/test-results/missing-diff.png",
+    );
 
     expect(resolution).toEqual({
-      path: '/var/www/html/test/playwright/test-results/missing-diff.png',
+      path: "/var/www/html/test/playwright/test-results/missing-diff.png",
       found: false,
-    })
-  })
+    });
+  });
 
-  it('reuses a mapping it has already worked out', () => {
-    touch('test-results/one/a-diff.png')
-    touch('test-results/two/b-diff.png')
+  it("reuses a mapping it has already worked out", () => {
+    touch("test-results/one/a-diff.png");
+    touch("test-results/two/b-diff.png");
 
-    const looked: string[] = []
+    const looked: string[] = [];
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'results.json'),
-      exists: filePath => {
-        looked.push(filePath)
-        return fs.existsSync(filePath)
+      reportPath: path.join(tmpDir, "results.json"),
+      exists: (filePath) => {
+        looked.push(filePath);
+        return fs.existsSync(filePath);
       },
-    })
+    });
 
-    resolve('/var/www/html/test-results/one/a-diff.png')
-    const afterFirst = looked.length
-    looked.length = 0
+    resolve("/var/www/html/test-results/one/a-diff.png");
+    const afterFirst = looked.length;
+    looked.length = 0;
 
-    expect(resolve('/var/www/html/test-results/two/b-diff.png').found).toBe(true)
+    expect(resolve("/var/www/html/test-results/two/b-diff.png").found).toBe(
+      true,
+    );
     // The learned mapping is tried straight after the original path, rather
     // than searching the tree again.
-    expect(looked.length).toBeLessThan(afterFirst)
+    expect(looked.length).toBeLessThan(afterFirst);
     expect(looked).toEqual([
-      '/var/www/html/test-results/two/b-diff.png',
-      path.join(tmpDir, 'test-results/two/b-diff.png'),
-    ])
-  })
+      "/var/www/html/test-results/two/b-diff.png",
+      path.join(tmpDir, "test-results/two/b-diff.png"),
+    ]);
+  });
 
-  it('prefers an explicit prefix over anything it would work out', () => {
-    touch('elsewhere/test-results/home-1-diff.png')
-    touch('test/playwright/test-results/home-1-diff.png')
+  it("prefers an explicit prefix over anything it would work out", () => {
+    touch("elsewhere/test-results/home-1-diff.png");
+    touch("test/playwright/test-results/home-1-diff.png");
 
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'test/playwright/test-results/results.json'),
-      prefixes: [{ from: '/var/www/html/test/playwright', to: path.join(tmpDir, 'elsewhere') }],
-    })
-
-    expect(resolve('/var/www/html/test/playwright/test-results/home-1-diff.png').path)
-      .toBe(path.join(tmpDir, 'elsewhere/test-results/home-1-diff.png'))
-  })
-
-  it('ignores a prefix the path is not under', () => {
-    touch('test-results/diff.png')
+      reportPath: path.join(
+        tmpDir,
+        "test/playwright/test-results/results.json",
+      ),
+      prefixes: [
+        {
+          from: "/var/www/html/test/playwright",
+          to: path.join(tmpDir, "elsewhere"),
+        },
+      ],
+    });
+
+    expect(
+      resolve("/var/www/html/test/playwright/test-results/home-1-diff.png")
+        .path,
+    ).toBe(path.join(tmpDir, "elsewhere/test-results/home-1-diff.png"));
+  });
+
+  it("ignores a prefix the path is not under", () => {
+    touch("test-results/diff.png");
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'results.json'),
-      prefixes: [{ from: '/somewhere/else', to: tmpDir }],
-    })
+      reportPath: path.join(tmpDir, "results.json"),
+      prefixes: [{ from: "/somewhere/else", to: tmpDir }],
+    });
 
     // The explicit prefix does not apply, and one component of tail is too
     // little to search on.
-    expect(resolve('/var/www/html/diff.png').found).toBe(false)
-  })
+    expect(resolve("/var/www/html/diff.png").found).toBe(false);
+  });
 
-  it('does not match a prefix part way through a directory name', () => {
-    touch('results/diff.png')
+  it("does not match a prefix part way through a directory name", () => {
+    touch("results/diff.png");
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'results.json'),
-      prefixes: [{ from: '/var/www/ht', to: tmpDir }],
-    })
+      reportPath: path.join(tmpDir, "results.json"),
+      prefixes: [{ from: "/var/www/ht", to: tmpDir }],
+    });
 
     // /var/www/html starts with the string /var/www/ht but is not under it,
     // so the explicit mapping must not fire. The search still finds the file.
-    const resolution = resolve('/var/www/html/results/diff.png')
-    expect(resolution.path).toBe(path.join(tmpDir, 'results/diff.png'))
-    expect(resolution.prefix).toEqual({ from: '/var/www/html', to: tmpDir })
-  })
+    const resolution = resolve("/var/www/html/results/diff.png");
+    expect(resolution.path).toBe(path.join(tmpDir, "results/diff.png"));
+    expect(resolution.prefix).toEqual({ from: "/var/www/html", to: tmpDir });
+  });
 
-  it('tolerates trailing slashes on the local side', () => {
-    touch('test-results/diff.png')
+  it("tolerates trailing slashes on the local side", () => {
+    touch("test-results/diff.png");
     const resolve = createPathResolver({
-      reportPath: path.join(tmpDir, 'results.json'),
+      reportPath: path.join(tmpDir, "results.json"),
       // A run of them, not just one: the trim is an index scan rather than a
       // regex, because `/[\\/]+$/` backtracks quadratically over exactly this.
-      prefixes: [{ from: '/var/www/html', to: `${tmpDir}///` }],
-    })
-
-    expect(resolve('/var/www/html/test-results/diff.png').path)
-      .toBe(`${tmpDir}/test-results/diff.png`)
-  })
-})
+      prefixes: [{ from: "/var/www/html", to: `${tmpDir}///` }],
+    });
+
+    expect(resolve("/var/www/html/test-results/diff.png").path).toBe(
+      `${tmpDir}/test-results/diff.png`,
+    );
+  });
+});