test: fix test setup (#2749)

* test: fail prepare fixtures script if fixtures fail to install deps or build a fixture

* test: intentionally break deps installation / fixture build to test prepare script changes

* Revert "test: intentionally break deps installation / fixture build to test prepare script changes"

This reverts commit 0d9c1f4.

* ci: upgrade corepack

* test: don't prepare e2e-only fixtures ahead of time

.github/workflows/run-tests.yml

@@ -60,7 +60,9 @@ jobs:
           cache-dependency-path: '**/package-lock.json'
       - uses: oven-sh/setup-bun@v1
       - name: setup pnpm/yarn
-        run: corepack enable
+        run: |
+          npm install -g corepack
+          corepack enable
         shell: bash
       - name: Install Deno
         uses: denoland/setup-deno@v1
@@ -127,8 +129,18 @@ jobs:
           node-version: '18.x'
           cache: 'npm'
           cache-dependency-path: '**/package-lock.json'
+      - name: Prefer npm global on windows
+        if: runner.os == 'Windows'
+        # On Windows by default PATH prefers corepack bundled with Node.js
+        # This prepends npm global to PATH to ensure that npm installed global corepack is used instead
+        run: |
+          echo "$(npm config get prefix)" >> "$GITHUB_PATH"
+        shell: bash
       - name: setup pnpm/yarn
-        run: corepack enable
+        run: |
+          # global corepack installation requires --force on Windows, otherwise EEXIST errors occur
+          npm install -g corepack --force
+          corepack enable
         shell: bash
       - name: Install Deno
         uses: denoland/setup-deno@v1

tests/prepare.mjs

@@ -18,12 +18,30 @@ const NEXT_VERSION = process.env.NEXT_VERSION ?? 'latest'
 const fixturesDir = fileURLToPath(new URL(`./fixtures`, import.meta.url))
 const fixtureFilter = argv[2] ?? ''
 
+// E2E tests run next builds, so we don't need to prepare those ahead of time for integration tests
+const e2eOnlyFixtures = new Set([
+  'after',
+  'cli-before-regional-blobs-support',
+  'dist-dir',
+  // There is also a bug on Windows on Node.js 18.20.6, that cause build failures on this fixture
+  // see https://github.com/opennextjs/opennextjs-netlify/actions/runs/13268839161/job/37043172448?pr=2749#step:12:78
+  'middleware-og',
+  'middleware-single-matcher',
+  'nx-integrated',
+  'turborepo',
+  'turborepo-npm',
+  'unstable-cache',
+])
+
 const limit = pLimit(Math.max(2, cpus().length / 2))
 const fixtures = readdirSync(fixturesDir)
   // Ignoring things like `.DS_Store`.
   .filter((fixture) => !fixture.startsWith('.'))
   // Applying the filter, if one is set.
   .filter((fixture) => !fixtureFilter || fixture.startsWith(fixtureFilter))
+  // Filter out fixtures that are only needed for E2E tests
+  .filter((fixture) => !e2eOnlyFixtures.has(fixture))
+
 console.log(`🧪 Preparing fixtures: ${fixtures.join(', ')}`)
 const fixtureList = new Set(fixtures)
 const fixtureCount = fixtures.length
@@ -62,7 +80,15 @@ const promises = fixtures.map((fixture) =>
         this.push(chunk.toString().replace(/\n/gm, `\n[${fixture}] `))
         callback()
       },
+      flush(callback) {
+        // final transform might create non-terminated line with a prefix
+        // so this is just to make sure we end with a newline so further writes
+        // to same destination stream start on a new line for better readability
+        this.push('\n')
+        callback()
+      },
     })
+
     console.log(`[${fixture}] Running \`${cmd}\`...`)
     const output = execaCommand(cmd, {
       cwd,
@@ -80,6 +106,11 @@ const promises = fixtures.map((fixture) =>
           operation: 'revert',
         })
       }
+      if (output.exitCode !== 0) {
+        const errorMessage = `[${fixture}] 🚨 Failed to install dependencies or build a fixture`
+        console.error(errorMessage)
+        throw new Error(errorMessage)
+      }
       fixtureList.delete(fixture)
     })
   }).finally(() => {
@@ -91,5 +122,22 @@ const promises = fixtures.map((fixture) =>
     }
   }),
 )
-await Promise.allSettled(promises)
+const prepareFixturesResults = await Promise.allSettled(promises)
+const failedFixturesErrors = prepareFixturesResults
+  .map((promise) => {
+    if (promise.status === 'rejected') {
+      return promise.reason
+    }
+    return null
+  })
+  .filter(Boolean)
+
+if (failedFixturesErrors.length > 0) {
+  console.error('Some fixtures failed to prepare:')
+  for (const error of failedFixturesErrors) {
+    console.error(error.message)
+  }
+  process.exit(1)
+}
+
 console.log('🎉 All fixtures prepared')