fix(tests): slightly refactor the fixture sandbox in a way that makes pw-test e2e tests work

Author: sorccu

packages/cli/e2e/__tests__/fixtures/test-pwt-native/checkly.config.original.ts

@@ -2,6 +2,7 @@
   "name": "test-pwt-native",
   "version": "0.0.1",
   "devDependencies": {
-    "@playwright/test": "1.53.1"
+    "@playwright/test": "1.53.1",
+    "jiti": "^2.6.1"
   }
 }

packages/cli/e2e/__tests__/fixtures/test-pwt-native/package-lock.json

@@ -1,58 +1,67 @@
 import path from 'node:path'
-import fs from 'node:fs'
 
-import config from 'config'
-import { describe, it, expect, afterEach, beforeAll } from 'vitest'
+import { describe, it, expect, beforeAll, afterAll } from 'vitest'
 
-import { runChecklyCli } from '../run-checkly'
 import { loadChecklyConfig } from '../../src/services/checkly-config-loader'
+import { FixtureSandbox } from '../../src/testing/fixture-sandbox'
 
-const FIXTURE_TEST_PWT_NATIVE = path.join(__dirname, 'fixtures', 'test-pwt-native')
+async function runTest (fixt: FixtureSandbox, args: string[]) {
+  const result = await fixt.run('npx', [
+    'checkly',
+    'pw-test',
+    ...args,
+  ], {
+    timeout: 120_000,
+  })
+
+  if (result.exitCode !== 0) {
+    // eslint-disable-next-line no-console
+    console.error('stderr', result.stderr)
+    // eslint-disable-next-line no-console
+    console.error('stdout', result.stdout)
+  }
+
+  expect(result.exitCode).toBe(0)
+
+  return result
+}
 
 describe('pw-test', { timeout: 45000 }, () => {
-  afterEach(() => {
-    fs.copyFileSync(
-      path.join(FIXTURE_TEST_PWT_NATIVE, 'checkly.config.original.ts'),
-      path.join(FIXTURE_TEST_PWT_NATIVE, 'checkly.config.ts'),
-    )
-  })
+  let fixt: FixtureSandbox
 
   beforeAll(async () => {
-    // Install fixture dependencies or they will not resolve correctly.
-    const { execa } = await import('execa')
-    await execa('npm', ['install'], { cwd: FIXTURE_TEST_PWT_NATIVE })
+    fixt = await FixtureSandbox.create({
+      source: path.join(__dirname, 'fixtures', 'test-pwt-native'),
+    })
+  })
+
+  afterAll(async () => {
+    await fixt.destroy()
   })
 
   it('Playwright test should run successfully', async () => {
-    const result = await runChecklyCli({
-      args: ['pw-test', '--', `--grep`, '@TAG-B'],
-      apiKey: config.get('apiKey'),
-      accountId: config.get('accountId'),
-      directory: FIXTURE_TEST_PWT_NATIVE,
-      timeout: 120000, // 2 minutes
-    })
-    if (result.status !== 0) {
-      // eslint-disable-next-line no-console
-      console.log(result)
-    }
-    expect(result.status).toBe(0)
+    await runTest(fixt, [
+      '--',
+      '--grep',
+      '@TAG-B',
+    ])
   }, 130000)
 
   it('Should add a Playwright test to the config', async () => {
-    const result = await runChecklyCli({
-      args: ['pw-test', '--create-check', '--', `--grep`, '@TAG-B'],
-      apiKey: config.get('apiKey'),
-      accountId: config.get('accountId'),
-      directory: FIXTURE_TEST_PWT_NATIVE,
-      timeout: 120000, // 2 minutes
-    })
-    expect(result.status).toBe(0)
-    const checklyConfig = await loadChecklyConfig(FIXTURE_TEST_PWT_NATIVE)
+    await runTest(fixt, [
+      '--create-check',
+      '--',
+      '--grep',
+      '@TAG-B',
+    ])
+
+    const checklyConfig = await loadChecklyConfig(fixt.root)
+
     expect(checklyConfig.config?.checks).toBeDefined()
     expect(checklyConfig.config?.checks?.playwrightConfigPath).toBe('./playwright.config.ts')
     expect(checklyConfig.config?.checks?.playwrightChecks).toBeDefined()
-    expect(checklyConfig.config?.checks?.playwrightChecks.length).toBe(1)
-    expect(checklyConfig.config?.checks?.playwrightChecks[0].name).toBe('Playwright Test: --grep @TAG-B')
-    expect(checklyConfig.config?.checks?.playwrightChecks[0].testCommand).toBe('npx playwright test --grep @TAG-B')
+    expect(checklyConfig.config?.checks?.playwrightChecks?.length).toBe(1)
+    expect(checklyConfig.config?.checks?.playwrightChecks?.[0]?.name).toBe('Playwright Test: --grep @TAG-B')
+    expect(checklyConfig.config?.checks?.playwrightChecks?.[0]?.testCommand).toBe('npx playwright test --grep @TAG-B')
   })
 })

packages/cli/e2e/__tests__/fixtures/test-pwt-native/package.json

@@ -22,7 +22,7 @@
     "prepare:dist": "tsc --build",
     "prepare": "npm run clean && npm run prepare:dist && npm run generate:rules",
     "test": "npm pack && vitest --run",
-    "test:e2e": "npm run prepare && cross-env NODE_CONFIG_DIR=./e2e/config vitest -c ./vitest.config.e2e.mts",
+    "test:e2e": "npm pack && cross-env NODE_CONFIG_DIR=./e2e/config vitest -c ./vitest.config.e2e.mts",
     "test:e2e:local": "cross-env CHECKLY_BASE_URL=http://localhost:3000  CHECKLY_ENV=local npm run test:e2e",
     "watch": "tsc --watch"
   },

packages/cli/e2e/__tests__/pw-test.spec.ts

@@ -1,7 +1,5 @@
 {
   "name": "api-check-fixture",
   "type": "module",
-  "devDependencies": {
-    "checkly": "file:./checkly.tgz"
-  }
+  "devDependencies": {}
 }

packages/cli/package.json

@@ -1,7 +1,5 @@
 {
   "name": "api-check-fixture",
   "type": "module",
-  "devDependencies": {
-    "checkly": "file:./checkly.tgz"
-  }
+  "devDependencies": {}
 }

packages/cli/src/constructs/__tests__/fixtures/api-check/package.json

@@ -3,7 +3,6 @@
   "version": "1.0.0",
   "dependencies": {
     "@playwright/test": "^1.55.1",
-    "jiti": "^2.6.1",
-    "checkly": "file:./checkly.tgz"
+    "jiti": "^2.6.1"
   }
 }

packages/cli/src/constructs/__tests__/fixtures/browser-check/package.json

@@ -2,7 +2,6 @@
   "name": "playwright-check-fixture",
   "devDependencies": {
     "@playwright/test": "^1.55.1",
-    "jiti": "^2.6.1",
-    "checkly": "file:./checkly.tgz"
+    "jiti": "^2.6.1"
   }
 }

packages/cli/src/constructs/__tests__/fixtures/playwright-check/test-cases/test-bundling/package.json

@@ -2,7 +2,6 @@
   "name": "playwright-check-fixture",
   "devDependencies": {
     "@playwright/test": "^1.55.1",
-    "jiti": "^2.6.1",
-    "checkly": "file:./checkly.tgz"
+    "jiti": "^2.6.1"
   }
 }