test(cli-e2e): move helper functions, clean up tests and setup

.eslintrc.json

@@ -33,6 +33,7 @@
                 "onlyDependOnLibsWithTags": [
                   "type:app",
                   "type:feature",
+                  "type:util",
                   "type:testing-util"
                 ]
               },

e2e/cli-e2e/.eslintrc.json

@@ -0,0 +1,12 @@
+{
+  "extends": ["../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*", "code-pushup.config.ts"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parserOptions": {
+        "project": ["e2e/cli-e2e/tsconfig.*?.json"]
+      }
+    }
+  ]
+}

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

@@ -0,0 +1,27 @@
+import eslintPlugin from '@code-pushup/eslint-plugin';
+
+export default {
+  upload: {
+    organization: 'code-pushup',
+    project: 'cli-js',
+    apiKey: 'e2e-api-key',
+    server: 'https://e2e.com/api',
+  },
+  categories: [
+    {
+      slug: 'bug-prevention',
+      title: 'Bug prevention',
+      refs: [{ type: 'group', plugin: 'eslint', slug: 'problems', weight: 1 }],
+    },
+    {
+      slug: 'code-style',
+      title: 'Code style',
+      refs: [
+        { type: 'group', plugin: 'eslint', slug: 'suggestions', weight: 1 },
+      ],
+    },
+  ],
+  plugins: [
+    await eslintPlugin({ eslintrc: '.eslintrc.json', patterns: '**/*.ts' }),
+  ],
+};

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

@@ -0,0 +1,27 @@
+import eslintPlugin from '@code-pushup/eslint-plugin';
+
+export default {
+  upload: {
+    organization: 'code-pushup',
+    project: 'cli-mjs',
+    apiKey: 'e2e-api-key',
+    server: 'https://e2e.com/api',
+  },
+  categories: [
+    {
+      slug: 'bug-prevention',
+      title: 'Bug prevention',
+      refs: [{ type: 'group', plugin: 'eslint', slug: 'problems', weight: 1 }],
+    },
+    {
+      slug: 'code-style',
+      title: 'Code style',
+      refs: [
+        { type: 'group', plugin: 'eslint', slug: 'suggestions', weight: 1 },
+      ],
+    },
+  ],
+  plugins: [
+    await eslintPlugin({ eslintrc: '.eslintrc.json', patterns: '**/*.ts' }),
+  ],
+};

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

@@ -0,0 +1,28 @@
+import eslintPlugin from '@code-pushup/eslint-plugin';
+import { CoreConfig } from '@code-pushup/models';
+
+export default {
+  upload: {
+    organization: 'code-pushup',
+    project: 'cli-ts',
+    apiKey: 'e2e-api-key',
+    server: 'https://e2e.com/api',
+  },
+  categories: [
+    {
+      slug: 'bug-prevention',
+      title: 'Bug prevention',
+      refs: [{ type: 'group', plugin: 'eslint', slug: 'problems', weight: 1 }],
+    },
+    {
+      slug: 'code-style',
+      title: 'Code style',
+      refs: [
+        { type: 'group', plugin: 'eslint', slug: 'suggestions', weight: 1 },
+      ],
+    },
+  ],
+  plugins: [
+    await eslintPlugin({ eslintrc: '.eslintrc.json', patterns: '**/*.ts' }),
+  ],
+} satisfies CoreConfig;

e2e/cli-e2e/project.json

@@ -4,6 +4,13 @@
   "sourceRoot": "examples/cli-e2e/src",
   "projectType": "application",
   "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": ["e2e/cli-e2e/**/*.ts"]
+      }
+    },
     "e2e": {
       "executor": "@nx/vite:test",
       "outputs": ["{options.reportsDirectory}"],

e2e/cli-e2e/tests/collect.e2e.test.ts

@@ -1,34 +1,25 @@
-import { afterEach, beforeEach, vi } from 'vitest';
 import { PluginReport, Report, reportSchema } from '@code-pushup/models';
 import { executeProcess, readJsonFile, readTextFile } from '@code-pushup/utils';
-import { cleanFolderPutGitKeep } from '../mocks/fs.mock';
 
 describe('CLI collect', () => {
   const exampleCategoryTitle = 'Code style';
   const exampleAuditTitle = 'Require `const` declarations for variables';
 
+  /* eslint-disable @typescript-eslint/no-unused-vars */
   const omitVariableData = ({
     date,
     duration,
     version,
     ...report
   }: Report | PluginReport) => report;
+  /* eslint-enable @typescript-eslint/no-unused-vars */
 
   const omitVariableReportData = (report: Report) =>
     omitVariableData({
       ...report,
       plugins: report.plugins.map(omitVariableData) as PluginReport[],
     });
 
-  beforeEach(async () => {
-    vi.clearAllMocks();
-    cleanFolderPutGitKeep();
-  });
-
-  afterEach(() => {
-    cleanFolderPutGitKeep();
-  });
-
   it('should run ESLint plugin and create report.json', async () => {
     const { code, stderr } = await executeProcess({
       command: 'code-pushup',
@@ -43,7 +34,7 @@ describe('CLI collect', () => {
 
     expect(() => reportSchema.parse(report)).not.toThrow();
     expect(omitVariableReportData(report as Report)).toMatchSnapshot();
-  }, 120000);
+  });
 
   it('should create report.md', async () => {
     const { code, stderr } = await executeProcess({
@@ -60,7 +51,7 @@ describe('CLI collect', () => {
     expect(md).toContain('# Code PushUp Report');
     expect(md).toContain(exampleCategoryTitle);
     expect(md).toContain(exampleAuditTitle);
-  }, 120000);
+  });
 
   it('should print report summary to stdout', async () => {
     const { code, stdout, stderr } = await executeProcess({
@@ -76,5 +67,5 @@ describe('CLI collect', () => {
     expect(stdout).not.toContain('Generated reports');
     expect(stdout).toContain(exampleCategoryTitle);
     expect(stdout).toContain(exampleAuditTitle);
-  }, 120000);
+  });
 });

e2e/cli-e2e/tests/help.e2e.test.ts

@@ -9,7 +9,19 @@ describe('CLI help', () => {
     expect(code).toBe(0);
     expect(stderr).toBe('');
     expect(stdout).toMatchSnapshot();
-  }, 120000);
+  });
 
-  // @TODO 'should print help with help command'
+  it('should produce the same output to stdout for both help argument and help command', async () => {
+    const helpArgResult = await executeProcess({
+      command: 'code-pushup',
+      args: ['help'],
+    });
+    const helpCommandResult = await executeProcess({
+      command: 'code-pushup',
+      args: ['--help'],
+    });
+    expect(helpArgResult.code).toBe(0);
+    expect(helpCommandResult.code).toBe(0);
+    expect(helpArgResult.stdout).toBe(helpCommandResult.stdout);
+  });
 });