Merge pull request #59 from happo/test-runner

lencioni · web-flow · commit 384d46d0997d · 2025-02-03T08:48:21.000-06:00
Use node's built-in test runner
diff --git a/.node-version b/.node-version
@@ -1 +1 @@
-20.10.0
+22.11.0
diff --git a/run-tests.sh b/run-tests.sh
@@ -4,12 +4,8 @@ set -euo pipefail
 export HAPPO_ENABLED=true
 export HAPPO_E2E_PORT=3000
 
-for file in ./test/*
-do
-  echo ""
-  echo "Running test $file"
-
-  node "$file"
-
-  echo "✅ Test $file passed!"
-done
+if [[ $(node -v | cut -d. -f1 | tr -d 'v') -ge 22 ]]; then
+  node --test "./test/*"
+else
+  node --test test
+fi
diff --git a/test/controller-test.js b/test/controller-test.js
@@ -1,3 +1,4 @@
+const { it, before, after } = require('node:test');
 const fs = require('fs');
 const path = require('path');
 const assert = require('assert');
@@ -14,8 +15,22 @@ const mockHappoConfig = {
   },
 };
 
-async function runTest() {
-  // Test for init
+const mockHappoConfigPath = path.join(__dirname, '..', '.happo.js');
+
+before(() => {
+  // Create a mock happo.js file
+  fs.writeFileSync(
+    mockHappoConfigPath,
+    `module.exports = ${JSON.stringify(mockHappoConfig)}`,
+  );
+});
+
+after(() => {
+  // Clean up the mock config
+  fs.unlinkSync(mockHappoConfigPath);
+});
+
+it('initializes with the correct happo config', async () => {
   const controller = new Controller();
   await controller.init();
   assert.strictEqual(controller.happoConfig.apiKey, mockHappoConfig.apiKey);
@@ -24,27 +39,4 @@ async function runTest() {
   assert.deepStrictEqual(controller.snapshots, []);
   assert.deepStrictEqual(controller.snapshotAssetUrls, []);
   assert.deepStrictEqual(controller.allCssBlocks, []);
-}
-
-async function main() {
-  const mockHappoConfigPath = path.join(__dirname, '..', '.happo.js');
-  try {
-    // Create a mock happo.js file
-    fs.writeFileSync(
-      mockHappoConfigPath,
-      `module.exports = ${JSON.stringify(mockHappoConfig)}`,
-    );
-
-    await runTest();
-
-    console.log('All Controller tests passed');
-  } catch (error) {
-    console.error('Controller tests failed:', error);
-    process.exitCode = 1;
-  } finally {
-    // Clean up the mock config
-    fs.unlinkSync(mockHappoConfigPath);
-  }
-}
-
-main();
+});
diff --git a/test/createAssetPackage-test.js b/test/createAssetPackage-test.js
@@ -1,3 +1,4 @@
+const { it } = require('node:test');
 const assert = require('assert');
 const fs = require('fs');
 
@@ -32,7 +33,7 @@ async function wrap(func) {
   }
 }
 
-async function runTest() {
+it('creates an asset package', async () => {
   await wrap(async () => {
     const pkg = await createAssetPackage([
       {
@@ -51,11 +52,4 @@ async function runTest() {
     assert.equal(pkg.hash, '898862aad00d429b73f57256332a6ee1');
     return pkg;
   });
-}
-
-runTest()
-  .then(() => process.exit(0))
-  .catch((e) => {
-    console.error(e);
-    process.exit(1);
-  });
+});
diff --git a/test/findCSSAssetUrls-test.js b/test/findCSSAssetUrls-test.js
@@ -1,8 +1,9 @@
+const { it } = require('node:test');
 const assert = require('assert');
 
 const findCSSAssetUrls = require('../src/findCSSAssetUrls');
 
-function runTest() {
+it('finds asset urls in CSS', () => {
   assert.deepEqual(
     findCSSAssetUrls(
       `
@@ -21,7 +22,4 @@ function runTest() {
     ),
     ['/bar.png', '/fonts/myfont.woff2', '/fonts/myfont.woff'],
   );
-}
-
-runTest();
-console.log('All findCSSAssetUrls tests passed');
+});
diff --git a/test/makeAbsolute-test.js b/test/makeAbsolute-test.js
@@ -1,19 +1,12 @@
-const assert = require('assert');
+const { it } = require('node:test');
+const assert = require('node:assert');
 
 const makeAbsolute = require('../src/makeAbsolute');
 
 const baseUrl = 'https://base.url';
 
-function runTest() {
+it('prepends baseUrl if protocol is missing', () => {
   assert.equal(makeAbsolute('/foo.png', baseUrl), 'https://base.url/foo.png');
-  assert.equal(
-    makeAbsolute('http://elsewhere.com/bar.png', baseUrl),
-    'http://elsewhere.com/bar.png',
-  );
-  assert.equal(
-    makeAbsolute('//elsewhere.com/bar.png', baseUrl),
-    'https://elsewhere.com/bar.png',
-  );
   assert.equal(
     makeAbsolute('/bar/foo.png', baseUrl),
     'https://base.url/bar/foo.png',
@@ -43,7 +36,22 @@ function runTest() {
     makeAbsolute('foo/bar/baz.png', 'http://goo.bar/car/'),
     'http://goo.bar/car/foo/bar/baz.png',
   );
-}
+});
+
+it('returns absolute URL if protocol is present', () => {
+  assert.equal(
+    makeAbsolute('http://elsewhere.com/bar.png', baseUrl),
+    'http://elsewhere.com/bar.png',
+  );
+  assert.equal(
+    makeAbsolute('https://elsewhere.com/bar.png', baseUrl),
+    'https://elsewhere.com/bar.png',
+  );
+});
 
-runTest();
-console.log('All makeAbsolute tests passed');
+it('handles relative protocol URLs', () => {
+  assert.equal(
+    makeAbsolute('//elsewhere.com/bar.png', baseUrl),
+    'https://elsewhere.com/bar.png',
+  );
+});
diff --git a/test/makeExternalUrlsAbsolute-test.js b/test/makeExternalUrlsAbsolute-test.js
@@ -1,53 +1,52 @@
+const { it } = require('node:test');
 const assert = require('assert');
 
 const makeExternalUrlsAbsolute = require('../src/makeExternalUrlsAbsolute');
 
 const resourceUrl = 'https://base.url/styles/styles.min.css';
 
-function runTest() {
-  // updates urls
+it('updates urls', () => {
   assert.equal(
     makeExternalUrlsAbsolute(
       `
-    .foo {
-      background-image: url("/bar.png");
-    }
-    @font-face {
-      font-family: "MyFont";
-      src: url('/fonts/myfont.woff2') format("woff2"),
-             url(/fonts/myfont.woff) format("woff");
-    }
-    .ignore {
-      background: url(data:image/png;base64,asdf);
-    }
-    .relative {
-      background: url(../one.png);
-      background-image: url(two.png);
-    }
-  `.trim(),
+          .foo {
+            background-image: url("/bar.png");
+          }
+          @font-face {
+            font-family: "MyFont";
+            src: url('/fonts/myfont.woff2') format("woff2"),
+                  url(/fonts/myfont.woff) format("woff");
+          }
+          .ignore {
+            background: url(data:image/png;base64,asdf);
+          }
+          .relative {
+            background: url(../one.png);
+            background-image: url(two.png);
+          }
+        `.trim(),
       resourceUrl,
     ),
     `
-    .foo {
-      background-image: url("https://base.url/bar.png");
-    }
-    @font-face {
-      font-family: "MyFont";
-      src: url('https://base.url/fonts/myfont.woff2') format("woff2"),
-             url(https://base.url/fonts/myfont.woff) format("woff");
-    }
-    .ignore {
-      background: url(data:image/png;base64,asdf);
-    }
-    .relative {
-      background: url(https://base.url/one.png);
-      background-image: url(https://base.url/styles/two.png);
-    }
-  `.trim(),
+          .foo {
+            background-image: url("https://base.url/bar.png");
+          }
+          @font-face {
+            font-family: "MyFont";
+            src: url('https://base.url/fonts/myfont.woff2') format("woff2"),
+                  url(https://base.url/fonts/myfont.woff) format("woff");
+          }
+          .ignore {
+            background: url(data:image/png;base64,asdf);
+          }
+          .relative {
+            background: url(https://base.url/one.png);
+            background-image: url(https://base.url/styles/two.png);
+          }
+        `.trim(),
   );
-  // can deal with empty input
-  assert.equal(makeExternalUrlsAbsolute('', resourceUrl), '');
-}
+});
 
-runTest();
-console.log('All makeExternalUrlsAbsolute tests passed');
+it('can deal with empty input', () => {
+  assert.equal(makeExternalUrlsAbsolute('', resourceUrl), '');
+});
diff --git a/test/resolveEnvironment-test.js b/test/resolveEnvironment-test.js
@@ -1,16 +1,17 @@
+const { it } = require('node:test');
 const path = require('path');
 const assert = require('assert');
 const resolveEnvironment = require('../src/resolveEnvironment');
 
-function testDevEnv() {
+it('resolves the dev environment', () => {
   const result = resolveEnvironment({});
   assert.equal(result.beforeSha, '__LATEST__');
   assert.ok(/^dev-[a-z0-9]+$/.test(result.afterSha));
   assert.equal(result.link, undefined);
   assert.equal(result.message, undefined);
-}
+});
 
-function testCircleCIEnv() {
+it('resolves the CircleCI environment', () => {
   const circleEnv = {
     CI_PULL_REQUEST: 'https://ghe.com/foo/bar/pull/12',
     CIRCLE_PROJECT_USERNAME: 'happo',
@@ -43,9 +44,9 @@ function testCircleCIEnv() {
   assert.equal(result.afterSha, 'abcdef');
   assert.equal(result.link, 'https://github.com/happo/happo-view/commit/abcdef');
   assert.ok(result.message !== undefined);
-}
+});
 
-function testAzureEnv() {
+it('resolves the Azure environment', () => {
   const azureEnv = {
     BUILD_SOURCEVERSION: '25826448f15ebcb939804ca769a00ee1df08e10d',
     BUILD_REPOSITORY_URI:
@@ -89,9 +90,9 @@ function testAzureEnv() {
   //   'https://github.com/happo/happo-view/commit/abcdef',
   // );
   // assert.ok(result.message !== undefined);
-}
+});
 
-function testTagMatchingEnv() {
+it('resolves the tag matching environment', () => {
   const azureEnv = {
     BUILD_SOURCEVERSION: '25826448f15ebcb939804ca769a00ee1df08e10d',
     BUILD_REPOSITORY_URI:
@@ -110,9 +111,9 @@ function testTagMatchingEnv() {
 
   assert.equal(result.afterSha, '25826448f15ebcb939804ca769a00ee1df08e10d');
   assert.equal(result.beforeSha, '25826448f15ebcb939804ca769a00ee1df08e10d');
-}
+});
 
-function testGithubActionsEnvironment() {
+it('resolves the GitHub Actions environment', () => {
   const githubEnv = {
     GITHUB_SHA: 'ccddffddccffdd',
     GITHUB_EVENT_PATH: path.resolve(__dirname, 'github_pull_request_event.json'),
@@ -163,9 +164,9 @@ function testGithubActionsEnvironment() {
     caughtError.message,
     'Failed to load GitHub event from the GITHUB_EVENT_PATH environment variable: "non-existing-path"',
   );
-}
+});
 
-function testGithubMergeGroupEnvironment() {
+it('resolves the GitHub merge group environment', () => {
   const githubEnv = {
     GITHUB_SHA: 'ccddffddccffdd',
     GITHUB_EVENT_PATH: path.resolve(__dirname, 'github_merge_group_event.json'),
@@ -178,9 +179,9 @@ function testGithubMergeGroupEnvironment() {
     'https://github.com/Codertocat/Hello-World/commit/ec26c3e57ca3a959ca5aad62de7213c562f8c821',
   );
   assert.ok(result.message !== undefined);
-}
+});
 
-function testTravisEnv() {
+it('resolves the Travis environment', () => {
   const travisEnv = {
     HAPPO_GITHUB_BASE: 'http://git.hub',
     TRAVIS_REPO_SLUG: 'owner/repo',
@@ -226,9 +227,9 @@ bdac2595db20ad2a6bf335b59510aa771125526a
   );
   assert.ok(result.message !== undefined);
   */
-}
+});
 
-function testHappoEnv() {
+it('resolves the happo environment', () => {
   const happoEnv = {
     HAPPO_CURRENT_SHA: 'bdac2595db20ad2a6bf335b59510aa771125526a',
     HAPPO_PREVIOUS_SHA: 'hhhggg',
@@ -267,17 +268,4 @@ function testHappoEnv() {
   assert.equal(result.afterSha, 'bdac2595db20ad2a6bf335b59510aa771125526a');
   assert.equal(result.link, 'link://link');
   assert.ok(result.message !== undefined);
-}
-
-function runTest() {
-  testGithubActionsEnvironment();
-  testGithubMergeGroupEnvironment();
-  testDevEnv();
-  testCircleCIEnv();
-  testTravisEnv();
-  testAzureEnv();
-  testHappoEnv();
-  testTagMatchingEnv();
-}
-runTest();
-console.log('All tests passed');
+});
diff --git a/test/takeDOMSnapshot-test.js b/test/takeDOMSnapshot-test.js
