test: fix e2e tests

inspiration from #810 Signed-off-by: Vojtech Masek <[email protected]>
code-pushup · Sep 6, 2024 · cd2ca75 · cd2ca75
1 parent 60fe192
commit cd2ca75
Show file tree

Hide file tree

Showing 12 changed files with 29 additions and 26 deletions.
diff --git a/e2e/cli-e2e/tests/collect.e2e.test.ts b/e2e/cli-e2e/tests/collect.e2e.test.ts
@@ -160,7 +160,7 @@ describe('CLI collect', () => {
     expect(code).toBe(0);
     const md = await readTextFile('tmp/e2e/react-todos-app/report.md');
 
-    expect(md).toContain('# Code PushUp Report');
+    expect(md).toContain('# Code PushUp report');
     expect(md).toContain(exampleCategoryTitle);
     expect(md).toContain(exampleAuditTitle);
   });
@@ -174,7 +174,7 @@ describe('CLI collect', () => {
 
     expect(code).toBe(0);
 
-    expect(stdout).toContain('Code PushUp Report');
+    expect(stdout).toContain('Code PushUp report');
     expect(stdout).not.toContain('Generated reports');
     expect(stdout).toContain(exampleCategoryTitle);
     expect(stdout).toContain(exampleAuditTitle);

diff --git a/e2e/nx-plugin-e2e/tests/executor-cli.e2e.test.ts b/e2e/nx-plugin-e2e/tests/executor-cli.e2e.test.ts
@@ -26,7 +26,7 @@ async function addTargetToWorkspace(
     ...projectCfg,
     targets: {
       ...projectCfg.targets,
-      ['code-pushup']: {
+      'code-pushup': {
         executor: '@code-pushup/nx-plugin:autorun',
       },
     },

diff --git a/e2e/nx-plugin-e2e/tests/plugin-create-nodes.e2e.test.ts b/e2e/nx-plugin-e2e/tests/plugin-create-nodes.e2e.test.ts
@@ -107,10 +107,12 @@ describe('nx-plugin', () => {
     expect(code).toBe(0);
 
     expect(projectJson.targets).toEqual({
-      'code-pushup': expect.objectContaining({
-        executor: 'XYZ:autorun',
-        options: expect.any(Object),
-        configurations: expect.any(Object),
+      'code-pushup--configuration': expect.objectContaining({
+        executor: 'nx:run-commands',
+        options: {
+          command:
+            'nx g XYZ:configuration --skipTarget --targetName="code-pushup" --project="my-lib"',
+        },
         parallelism: true,
       }),
     });
@@ -146,7 +148,7 @@ describe('nx-plugin', () => {
     expect(code).toBe(0);
 
     expect(projectJson.targets).toStrictEqual({
-      ['code-pushup']: expect.objectContaining({
+      'code-pushup': expect.objectContaining({
         configurations: {},
         executor: `@code-pushup/nx-plugin:autorun`,
         options: {},
@@ -208,9 +210,12 @@ describe('nx-plugin', () => {
 
     expect(code).toBe(0);
 
-    expect(projectJson.targets).toStrictEqual({
-      ['code-pushup']: expect.objectContaining({
+    // FIXME: output has empty configurations object so this passes
+    expect(projectJson.targets).toEqual({
+      'code-pushup': expect.objectContaining({
         executor: 'XYZ:autorun',
+        options: expect.any(Object),
+        configurations: expect.any(Object),
       }),
     });
   });
@@ -232,7 +237,7 @@ describe('nx-plugin', () => {
     expect(code).toBe(0);
 
     expect(projectJson.targets).toStrictEqual({
-      ['code-pushup']: expect.objectContaining({
+      'code-pushup': expect.objectContaining({
         executor: `@code-pushup/nx-plugin:autorun`,
         options: {
           projectPrefix: 'cli',

diff --git a/packages/cli/docs/custom-plugins.md b/packages/cli/docs/custom-plugins.md
@@ -92,7 +92,7 @@ Execute the CLI with `npx code-pushup collect` and you should the following outp
 <summary> <b>stdout of CLI for the above code</b> (collapsed for brevity) </summary>
 
 ```sh
-Code PushUp Report - @code-pushup/[email protected]
+Code PushUp report - @code-pushup/[email protected]
 
 My plugin audits
 ● My audit                                                            0
@@ -240,7 +240,7 @@ Now we can execute the CLI with `npx code-pushup collect` and see a similar outp
 <summary> <b>stdout of CLI for the above code</b> (collapsed for brevity) </summary>
 
 ```sh
-Code PushUp Report - @code-pushup/[email protected]
+Code PushUp report - @code-pushup/[email protected]
 
 File size plugin audits
 ● File size audit                                                            2 files
@@ -371,7 +371,7 @@ Now we can execute the CLI with `npx code-pushup collect --no-progress` and see
 <summary> <b>stdout of CLI for the above code</b> (collapsed for brevity) </summary>
 
 ```sh
-Code PushUp Report - @code-pushup/[email protected]
+Code PushUp report - @code-pushup/[email protected]
 
 Chrome Lighthosue audits
 ● Largest Contentful Paint                                                0
@@ -656,7 +656,7 @@ Test the output by running `npx code-pushup collect`.
 <summary> <b>stdout of basic lighthouse plugin</b> (collapsed for brevity) </summary>
 
 ```sh
-Code PushUp Report - @code-pushup/[email protected]
+Code PushUp report - @code-pushup/[email protected]
 
 Chrome Lighthouse audits
 ● Largest Contentful Paint                                                1,3 s

diff --git a/packages/cli/src/lib/yargs-cli.ts b/packages/cli/src/lib/yargs-cli.ts
@@ -71,9 +71,8 @@ export function yargsCli<T = unknown>(
     // take minimum of TERMINAL_WIDTH or full width of the terminal
     .wrap(Math.max(TERMINAL_WIDTH, cli.terminalWidth()))
     .help('help', descriptionStyle('Show help'))
-    .alias('h', 'help')
-    .showHelpOnFail(false)
     .version('version', dim`Show version`, version)
+    .alias('h', 'help')
     .check(args => {
       const persist = args['persist'] as PersistConfig | undefined;
       return persist == null || validatePersistFormat(persist);

diff --git a/packages/core/src/lib/implementation/persist.unit.test.ts b/packages/core/src/lib/implementation/persist.unit.test.ts
@@ -67,7 +67,7 @@ describe('persistReport', () => {
     });
 
     const mdReport = await readFile(join(MEMFS_VOLUME, 'report.md'), 'utf8');
-    expect(mdReport).toContain('Code PushUp Report');
+    expect(mdReport).toContain('Code PushUp report');
 
     await expect(() =>
       readFile(join(MEMFS_VOLUME, 'report.json'), 'utf8'),
@@ -82,7 +82,7 @@ describe('persistReport', () => {
     });
 
     const mdReport = await readFile(join(MEMFS_VOLUME, 'report.md'), 'utf8');
-    expect(mdReport).toContain('Code PushUp Report');
+    expect(mdReport).toContain('Code PushUp report');
     expect(mdReport).toMatch(
       /\|\s*🏷 Category\s*\|\s*⭐ Score\s*\|\s*🛡 Audits\s*\|/,
     );

diff --git a/packages/utils/src/lib/reports/__snapshots__/generate-md-report.unit.test.ts.snap b/packages/utils/src/lib/reports/__snapshots__/generate-md-report.unit.test.ts.snap
@@ -68,7 +68,7 @@ No unsafe any assignment [📖 Docs](https://web.dev/lcp)
 `;
 
 exports[`generateMdReport > should render complete md report 1`] = `
-"# Code PushUp Report
+"# Code PushUp report
 
 | 🏷 Category                 |   ⭐ Score    | 🛡 Audits |
 | :-------------------------- | :----------: | :-------: |

diff --git a/packages/utils/src/lib/reports/__snapshots__/report-stdout-no-categories.txt b/packages/utils/src/lib/reports/__snapshots__/report-stdout-no-categories.txt
@@ -1,4 +1,4 @@
-Code PushUp Report - @code-pushup/[email protected]
+Code PushUp report - @code-pushup/[email protected]
 
 
 ESLint audits

diff --git a/packages/utils/src/lib/reports/__snapshots__/report-stdout.txt b/packages/utils/src/lib/reports/__snapshots__/report-stdout.txt
@@ -1,4 +1,4 @@
-Code PushUp Report - @code-pushup/[email protected]
+Code PushUp report - @code-pushup/[email protected]
 
 
 ESLint audits

diff --git a/packages/utils/src/lib/reports/__snapshots__/report.md b/packages/utils/src/lib/reports/__snapshots__/report.md
@@ -1,4 +1,4 @@
-# Code PushUp Report
+# Code PushUp report
 
 | 🏷 Category                       |  ⭐ Score  | 🛡 Audits |
 | :-------------------------------- | :-------: | :-------: |

diff --git a/packages/utils/src/lib/reports/generate-md-report.unit.test.ts b/packages/utils/src/lib/reports/generate-md-report.unit.test.ts
@@ -524,7 +524,7 @@ describe('generateMdReport', () => {
   it('should render all sections of the report', () => {
     const md = generateMdReport(baseScoredReport);
     // report title
-    expect(md).toMatch('# Code PushUp Report');
+    expect(md).toMatch('# Code PushUp report');
     // categories section heading
     expect(md).toMatch(/\|\s*🏷 Category\s*\|\s*⭐ Score\s*\|\s*🛡 Audits\s*\|/);
     // categories section heading
@@ -544,7 +544,7 @@ describe('generateMdReport', () => {
   it('should skip categories section if empty', () => {
     const md = generateMdReport({ ...baseScoredReport, categories: [] });
     expect(md).not.toMatch('## 🏷 Categories');
-    expect(md).toMatch('# Code PushUp Report\n\n## 🛡️ Audits');
+    expect(md).toMatch('# Code PushUp report\n\n## 🛡️ Audits');
   });
 
   it('should render complete md report', () => {

diff --git a/testing/test-setup/src/lib/test-folder.setup.ts b/testing/test-setup/src/lib/test-folder.setup.ts
@@ -18,7 +18,6 @@ export async function teardownTestFolder(dirName: string) {
       force: true,
       // eslint-disable-next-line no-magic-numbers
       maxRetries: 3,
-      // eslint-disable-next-line no-magic-numbers
       retryDelay: 100,
     });
   } catch (error: unknown) {