test: refactor old tests and cleanup test helpers (#873)

Author: BioPhoton

.github/workflows/ci.yml

@@ -120,9 +120,7 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: E2E test affected projects
-        run: npx nx affected -t nxv-e2e --exclude cli-e2e --parallel=1
-      - name: E2E test cli-e2e project (due to bugs in the setup it has to run last :( )
-        run: npx nx run cli-e2e:e2e-old
+        run: npx nx affected -t nxv-e2e --parallel=1
 
   build:
     runs-on: ubuntu-latest

code-pushup.config.ts

@@ -37,7 +37,7 @@ const config: CoreConfig = {
 
   plugins: [
     fileSizePlugin({
-      directory: './dist/examples/react-todos-app',
+      directory: './dist/packages',
       pattern: /\.js$/,
       budget: 174_080, // 170 kB
     }),

…e2e/mocks/fixtures/code-pushup.config.ts …tures/ci-test-repo/code-pushup.config.tse2e/ci-e2e/mocks/fixtures/code-pushup.config.ts renamed to e2e/ci-e2e/mocks/fixtures/ci-test-repo/code-pushup.config.ts e2e/ci-e2e/mocks/fixtures/code-pushup.config.ts renamed to e2e/ci-e2e/mocks/fixtures/ci-test-repo/code-pushup.config.ts

@@ -0,0 +1 @@
+console.log("Hello, world!")

e2e/ci-e2e/mocks/fixtures/ci-test-repo/index.js

@@ -1,11 +1,4 @@
-import {
-  copyFile,
-  mkdir,
-  readFile,
-  rename,
-  rm,
-  writeFile,
-} from 'node:fs/promises';
+import { cp, readFile, rename } from 'node:fs/promises';
 import { dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 import {
@@ -14,6 +7,7 @@ import {
   type SimpleGit,
   simpleGit,
 } from 'simple-git';
+import { afterEach } from 'vitest';
 import {
   type Comment,
   type GitRefs,
@@ -22,41 +16,42 @@ import {
   type RunResult,
   runInCI,
 } from '@code-pushup/ci';
-import { initGitRepo } from '@code-pushup/test-utils';
+import { nxTargetProject } from '@code-pushup/test-nx-utils';
+import { teardownTestFolder } from '@code-pushup/test-setup';
+import {
+  E2E_ENVIRONMENTS_DIR,
+  TEST_OUTPUT_DIR,
+  TEST_SNAPSHOTS_DIR,
+  initGitRepo,
+} from '@code-pushup/test-utils';
 
 describe('CI package', () => {
   const fixturesDir = join(
     fileURLToPath(dirname(import.meta.url)),
     '..',
     'mocks',
     'fixtures',
+    'ci-test-repo',
   );
-  const workDir = join(
+  const ciSetupRepoDir = join(
     process.cwd(),
-    'tmp',
-    'e2e',
-    'ci-e2e',
-    '__test__',
+    E2E_ENVIRONMENTS_DIR,
+    nxTargetProject(),
+    TEST_OUTPUT_DIR,
     'ci-test-repo',
   );
-  const outputDir = join(workDir, '.code-pushup');
+  const outputDir = join(ciSetupRepoDir, '.code-pushup');
 
   const options = {
-    directory: workDir,
+    directory: ciSetupRepoDir,
   } satisfies Options;
 
   let git: SimpleGit;
 
   beforeEach(async () => {
-    await rm(workDir, { recursive: true, force: true });
-    await mkdir(workDir, { recursive: true });
-    await copyFile(
-      join(fixturesDir, 'code-pushup.config.ts'),
-      join(workDir, 'code-pushup.config.ts'),
-    );
-    await writeFile(join(workDir, 'index.js'), 'console.log("Hello, world!")');
+    await cp(fixturesDir, ciSetupRepoDir, { recursive: true });
 
-    git = await initGitRepo(simpleGit, { baseDir: workDir });
+    git = await initGitRepo(simpleGit, { baseDir: ciSetupRepoDir });
 
     vi.spyOn(git, 'fetch').mockResolvedValue({} as FetchResult);
     vi.spyOn(git, 'diffSummary').mockResolvedValue({
@@ -69,8 +64,12 @@ describe('CI package', () => {
     await git.commit('Initial commit');
   });
 
+  afterEach(async () => {
+    await teardownTestFolder(ciSetupRepoDir);
+  });
+
   afterAll(async () => {
-    await rm(workDir, { recursive: true, force: true });
+    await teardownTestFolder(ciSetupRepoDir);
   });
 
   describe('push event', () => {
@@ -138,7 +137,10 @@ describe('CI package', () => {
     beforeEach(async () => {
       await git.checkoutLocalBranch('feature-1');
 
-      await rename(join(workDir, 'index.js'), join(workDir, 'index.ts'));
+      await rename(
+        join(ciSetupRepoDir, 'index.js'),
+        join(ciSetupRepoDir, 'index.ts'),
+      );
 
       await git.add('index.ts');
       await git.commit('Convert JS file to TS');
@@ -177,7 +179,7 @@ describe('CI package', () => {
       const md = await mdPromise;
       await expect(
         md.replace(/[\da-f]{40}/g, '`<commit-sha>`'),
-      ).toMatchFileSnapshot('__snapshots__/report-diff.md');
+      ).toMatchFileSnapshot(join(TEST_SNAPSHOTS_DIR, 'report-diff.md'));
     });
   });
 });

e2e/ci-e2e/tests/ci.e2e.test.ts

@@ -0,0 +1,6 @@
+import dummyPlugin, { dummyCategory } from './dummy.plugin';
+
+export default {
+  plugins: [dummyPlugin()],
+  categories: [dummyCategory],
+};

e2e/cli-e2e/mocks/fixtures/code-pushup.config.js

@@ -0,0 +1,6 @@
+import dummyPlugin, { dummyCategory } from './dummy.plugin';
+
+export default {
+  plugins: [dummyPlugin()],
+  categories: [dummyCategory],
+};