Test against the production GitHub caching server in CI

Author: aomarks

.github/workflows/tests.yml

@@ -68,6 +68,7 @@ jobs:
           WIREIT_PARALLEL: 1
       - run: xvfb-run -a npm test
         if: runner.os == 'Linux'
+      - run: npm run test:cache-github-real
 
   lint-and-format:
     timeout-minutes: 5

package.json

@@ -33,7 +33,8 @@
     "test:local": "wireit",
     "test:analysis": "wireit",
     "test:basic": "wireit",
-    "test:cache-github": "wireit",
+    "test:cache-github-fake": "wireit",
+    "test:cache-github-real": "wireit",
     "test:cache-local": "wireit",
     "test:clean": "wireit",
     "test:cli-options": "wireit",
@@ -78,7 +79,7 @@
     },
     "test:headless": {
       "dependencies": [
-        "test:cache-github",
+        "test:cache-github-fake",
         "test:local"
       ]
     },
@@ -146,8 +147,20 @@
       "files": [],
       "output": []
     },
-    "test:cache-github": {
-      "command": "uvu lib/test \"^cache-github\\.test\\.js$\"",
+    "test:cache-github-fake": {
+      "command": "uvu lib/test \"^cache-github-fake\\.test\\.js$\"",
+      "env": {
+        "NODE_OPTIONS": "--enable-source-maps"
+      },
+      "dependencies": [
+        "build"
+      ],
+      "files": [],
+      "output": []
+    },
+    "test:cache-github-real": {
+      "#comment": "Only works on GitHub CI",
+      "command": "uvu lib/test \"^cache-github-real\\.test\\.js$\"",
       "env": {
         "NODE_OPTIONS": "--enable-source-maps"
       },

src/test/cache-github.test.ts src/test/cache-github-fake.test.tssrc/test/cache-github.test.ts renamed to src/test/cache-github-fake.test.ts

@@ -0,0 +1,47 @@
+/**
+ * @license
+ * Copyright 2025 Google LLC
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import {suite} from 'uvu';
+import {registerCommonCacheTests} from './cache-common.js';
+import {WireitTestRig} from './util/test-rig.js';
+
+const test = suite<{rig: WireitTestRig}>();
+
+test.before.each(async (ctx) => {
+  try {
+    ctx.rig = new WireitTestRig();
+    ctx.rig.env = {
+      ...ctx.rig.env,
+      WIREIT_CACHE: 'github',
+      // We're testing against the actual production GitHub API, so we must pass
+      // down access to the real credentials (normally our test rig removes any
+      // WIREIT_ variables from being inherited).
+      WIREIT_CACHE_GITHUB_CUSTODIAN_PORT:
+        process.env.WIREIT_CACHE_GITHUB_CUSTODIAN_PORT,
+    };
+    await ctx.rig.setup();
+  } catch (error) {
+    // Uvu has a bug where it silently ignores failures in before and after,
+    // see https://github.com/lukeed/uvu/issues/191.
+    console.error('uvu before error', error);
+    process.exit(1);
+  }
+});
+
+test.after.each(async (ctx) => {
+  try {
+    await ctx.rig.cleanup();
+  } catch (error) {
+    // Uvu has a bug where it silently ignores failures in before and after,
+    // see https://github.com/lukeed/uvu/issues/191.
+    console.error('uvu after error', error);
+    process.exit(1);
+  }
+});
+
+registerCommonCacheTests(test, 'github');
+
+test.run();