test: fix nx-plugin tests and inline custom dummy plugin

Author: vmasek

e2e/nx-plugin-e2e/tests/executor-cli.e2e.test.ts

@@ -1,5 +1,5 @@
 import { type Tree, updateProjectConfiguration } from '@nx/devkit';
-import { join, relative } from 'node:path';
+import { join } from 'node:path';
 import { readProjectConfiguration } from 'nx/src/generators/utils/project-configuration';
 import { afterEach, expect } from 'vitest';
 import { generateCodePushupConfig } from '@code-pushup/nx-plugin';
@@ -12,21 +12,16 @@ import { teardownTestFolder } from '@code-pushup/test-setup';
 import {
   E2E_ENVIRONMENTS_DIR,
   TEST_OUTPUT_DIR,
-  osAgnosticPath,
   removeColorCodes,
 } from '@code-pushup/test-utils';
 import { executeProcess, readJsonFile } from '@code-pushup/utils';
-
-function relativePathToCwd(testDir: string): string {
-  return relative(join(process.cwd(), testDir), process.cwd());
-}
+import { INLINE_PLUGIN } from './inline-plugin.js';
 
 async function addTargetToWorkspace(
   tree: Tree,
   options: { cwd: string; project: string },
 ) {
   const { cwd, project } = options;
-  const pathRelativeToPackage = relative(join(cwd, 'libs', project), cwd);
   const projectCfg = readProjectConfiguration(tree, project);
   updateProjectConfiguration(tree, project, {
     ...projectCfg,
@@ -39,18 +34,10 @@ async function addTargetToWorkspace(
   });
   const { root } = projectCfg;
   generateCodePushupConfig(tree, root, {
-    fileImports: `import type {CoreConfig} from "@code-pushup/models";`,
     plugins: [
       {
-        // @TODO replace with inline plugin
-        fileImports: `import {customPlugin} from "${osAgnosticPath(
-          join(
-            relativePathToCwd(cwd),
-            pathRelativeToPackage,
-            'dist/testing/test-utils',
-          ),
-        )}";`,
-        codeStrings: 'customPlugin()',
+        fileImports: '',
+        codeStrings: INLINE_PLUGIN,
       },
     ],
   });

e2e/nx-plugin-e2e/tests/inline-plugin.ts

@@ -0,0 +1,21 @@
+export const INLINE_PLUGIN = `
+  {
+    slug: 'good-feels',
+    title: 'Good feels',
+    icon: 'javascript',
+    audits: [
+      {
+        slug: 'always-perfect',
+        title: 'Always perfect',
+      },
+    ],
+    runner: () => [
+      {
+        slug: 'always-perfect',
+        score: 1,
+        value: 100,
+        displayValue: '✅ Perfect! 👌',
+      },
+    ],
+  }
+`;

e2e/nx-plugin-e2e/tests/plugin-create-nodes.e2e.test.ts

@@ -1,5 +1,5 @@
 import type { Tree } from '@nx/devkit';
-import { join, relative } from 'node:path';
+import { join } from 'node:path';
 import { readProjectConfiguration } from 'nx/src/generators/utils/project-configuration';
 import { afterEach, expect } from 'vitest';
 import { generateCodePushupConfig } from '@code-pushup/nx-plugin';
@@ -17,6 +17,7 @@ import {
   removeColorCodes,
 } from '@code-pushup/test-utils';
 import { executeProcess, readTextFile } from '@code-pushup/utils';
+import { INLINE_PLUGIN } from './inline-plugin.js';
 
 describe('nx-plugin', () => {
   let tree: Tree;
@@ -45,7 +46,7 @@ describe('nx-plugin', () => {
     const { code, projectJson } = await nxShowProjectJson(cwd, project);
     expect(code).toBe(0);
 
-    expect(projectJson.targets).toStrictEqual({
+    expect(projectJson.targets).toEqual({
       ['code-pushup--configuration']: {
         configurations: {},
         executor: 'nx:run-commands',
@@ -168,28 +169,21 @@ describe('nx-plugin', () => {
 
   it('should execute dynamic executor target', async () => {
     const cwd = join(testFileDir, 'execute-dynamic-executor');
-    const pathRelativeToPackage = relative(join(cwd, 'libs', project), cwd);
     registerPluginInWorkspace(tree, {
       plugin: '@code-pushup/nx-plugin',
     });
     const { root } = readProjectConfiguration(tree, project);
     generateCodePushupConfig(tree, root, {
-      fileImports: `import type {CoreConfig} from "@code-pushup/models";`,
       plugins: [
         {
-          // @TODO replace with inline plugin
-          fileImports: `import {customPlugin} from "${join(
-            relative(join(process.cwd(), cwd), process.cwd()),
-            pathRelativeToPackage,
-            'dist/testing/test-utils',
-          )}";`,
-          codeStrings: 'customPlugin()',
+          fileImports: '',
+          codeStrings: INLINE_PLUGIN,
         },
       ],
       upload: {
         server: 'https://api.staging.code-pushup.dev/graphql',
         organization: 'code-pushup',
-        apiKey: '12345678',
+        apiKey: 'cp_12345678',
       },
     });
 

packages/nx-plugin/src/generators/configuration/code-pushup-config.ts

@@ -58,14 +58,10 @@ export function generateCodePushupConfig(
       fileImports: formatArrayToLinesOfJsString(configFileImports),
       persist: formatObjectToFormattedJsString(persist),
       upload: formatObjectToFormattedJsString(upload),
-      plugins: formatArrayToJSArray(
-        plugins.flatMap(({ codeStrings }) => codeStrings),
-      ),
+      plugins: `[${plugins.map(({ codeStrings }) => codeStrings).join(',')}]`,
       categories:
         categories &&
-        formatArrayToJSArray(
-          categories.flatMap(({ codeStrings }) => codeStrings),
-        ),
+        `[${categories.map(({ codeStrings }) => codeStrings).join(',')}]`,
     });
   }
 }

packages/nx-plugin/src/generators/configuration/code-pushup-config.unit.test.ts

@@ -168,8 +168,8 @@ describe('generateCodePushupConfig options', () => {
       upload: {
         organization: 'code-pushup',
         project: 'cli',
-        server: 'https://code-pushup.dev/portal',
-        apiKey: '12345678',
+        server: 'https://api.staging.code-pushup.dev/graphql',
+        apiKey: 'cp_12345678',
       },
     });
     expect(generateFilesSpy).toHaveBeenCalledWith(
@@ -180,8 +180,8 @@ describe('generateCodePushupConfig options', () => {
         upload: formatObjectToFormattedJsString({
           organization: 'code-pushup',
           project: 'cli',
-          server: 'https://code-pushup.dev/portal',
-          apiKey: '12345678',
+          server: 'https://api.staging.code-pushup.dev/graphql',
+          apiKey: 'cp_12345678',
         }),
       }),
     );

testing/test-nx-utils/src/lib/utils/nx.ts

@@ -8,6 +8,7 @@ import {
 } from '@nx/devkit';
 import { libraryGenerator } from '@nx/js';
 import type { LibraryGeneratorSchema } from '@nx/js/src/utils/schema';
+import { join } from 'node:path';
 import { createTreeWithEmptyWorkspace } from 'nx/src/generators/testing-utils/create-tree-with-empty-workspace';
 import { executeProcess } from '@code-pushup/utils';
 
@@ -45,14 +46,14 @@ export async function generateWorkspaceAndProject(
     typeof options === 'string' ? { name: options } : options;
   await libraryGenerator(tree, {
     name,
-    directory: 'libs',
+    directory: join('libs', name),
     tags: 'scope:plugin',
     linter: 'none',
     unitTestRunner: 'none',
     testEnvironment: 'node',
     buildable: false,
     publishable: false,
-    projectNameAndRootFormat: 'derived',
+    projectNameAndRootFormat: 'as-provided',
     ...normalizedOptions,
   });