refactor(nx-plugin): rename autorun to cli executor

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

@@ -18,21 +18,17 @@ Commands:
 
 
 Global Options:
-      --progress        Show progress bar in stdout.
+      --progress     Show progress bar in stdout.
                                              [boolean] [default: true]
-      --verbose         When true creates more verbose output. This is helpful w
-                        hen debugging. [boolean] [default: false]
-      --config          Path to config file. By default it loads code-pushup.con
-                        fig.(ts|mjs|js).                 [string]
-      --tsconfig        Path to a TypeScript config, to be used when loading con
-                        fig file.                        [string]
-      --skipCategories  List of categories to skip. If not set all categories ar
-                        e run.              [array] [default: []]
-      --onlyCategories  List of categories to run. If not set all categories are
-                         run.               [array] [default: []]
-  -P, --skipPlugins     List of plugins to skip. If not set all plugins are run.
+      --verbose      When true creates more verbose output. This is helpful when
+                      debugging.       [boolean] [default: false]
+      --config       Path to config file. By default it loads code-pushup.config
+                     .(ts|mjs|js).                       [string]
+      --tsconfig     Path to a TypeScript config, to be used when loading config
+                      file.                              [string]
+  -p, --onlyPlugins  List of plugins to run. If not set all plugins are run.
                                                  [array] [default: []]
-  -p, --onlyPlugins     List of plugins to run. If not set all plugins are run.
+  -P, --skipPlugins  List of plugins to skip. If not set all plugins are run.
                                                  [array] [default: []]
 
 Persist Options:

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

@@ -4,7 +4,7 @@ exports[`nx-plugin > should NOT add config targets dynamically if the project is
 {
   "code-pushup": {
     "configurations": {},
-    "executor": "@code-pushup/nx-plugin:autorun",
+    "executor": "@code-pushup/nx-plugin:cli",
     "options": {},
   },
 }
@@ -26,7 +26,7 @@ exports[`nx-plugin > should add executor target dynamically if the project is co
 {
   "code-pushup": {
     "configurations": {},
-    "executor": "@code-pushup/nx-plugin:autorun",
+    "executor": "@code-pushup/nx-plugin:cli",
     "options": {},
   },
 }

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

@@ -8,8 +8,8 @@ import {
   materializeTree,
 } from '@code-pushup/test-nx-utils';
 import { teardownTestFolder } from '@code-pushup/test-setup';
-import { removeColorCodes } from '@code-pushup/test-utils';
-import { executeProcess } from '@code-pushup/utils';
+import { 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());
@@ -27,7 +27,7 @@ async function addTargetToWorkspace(
     targets: {
       ...projectCfg.targets,
       ['code-pushup']: {
-        executor: '@code-pushup/nx-plugin:autorun',
+        executor: '@code-pushup/nx-plugin:cli',
       },
     },
   });
@@ -37,19 +37,27 @@ async function addTargetToWorkspace(
     plugins: [
       {
         // @TODO replace with inline plugin
-        fileImports: `import {customPlugin} from "${join(
-          relativePathToCwd(cwd),
-          pathRelativeToPackage,
-          'dist/testing/test-utils',
+        fileImports: `import {customPlugin} from "${osAgnosticPath(
+          join(
+            relativePathToCwd(cwd),
+            pathRelativeToPackage,
+            'dist/testing/test-utils',
+          ),
         )}";`,
         codeStrings: 'customPlugin()',
       },
     ],
+    upload: {
+      server: 'https://dummy-server.dev',
+      organization: 'dummy-organization',
+      apiKey: 'dummy-api-key',
+      project: 'dummy-project',
+    },
   });
   await materializeTree(tree, cwd);
 }
 
-describe('executor autorun', () => {
+describe('executor command', () => {
   let tree: Tree;
   const project = 'my-lib';
   const baseDir = 'tmp/e2e/nx-plugin-e2e/__test__/executor/cli';
@@ -62,10 +70,9 @@ describe('executor autorun', () => {
     await teardownTestFolder(baseDir);
   });
 
-  it('should execute autorun executor', async () => {
-    const cwd = join(baseDir, 'execute-dynamic-executor');
+  it('should execute no specific command by default', async () => {
+    const cwd = join(baseDir, 'execute-default-command');
     await addTargetToWorkspace(tree, { cwd, project });
-
     const { stdout, code } = await executeProcess({
       command: 'npx',
       args: ['nx', 'run', `${project}:code-pushup`, '--dryRun'],
@@ -74,6 +81,72 @@ describe('executor autorun', () => {
 
     expect(code).toBe(0);
     const cleanStdout = removeColorCodes(stdout);
-    expect(cleanStdout).toContain('nx run my-lib:code-pushup --dryRun');
+    expect(cleanStdout).toContain('nx run my-lib:code-pushup');
+  });
+
+  it('should execute print-config executor', async () => {
+    const cwd = join(baseDir, 'execute-print-config-command');
+    await addTargetToWorkspace(tree, { cwd, project });
+
+    const { stdout, code } = await executeProcess({
+      command: 'npx',
+      args: ['nx', 'run', `${project}:code-pushup`, 'print-config'],
+      cwd,
+    });
+
+    expect(code).toBe(0);
+    const cleanStdout = removeColorCodes(stdout);
+    expect(cleanStdout).toContain('nx run my-lib:code-pushup print-config');
+
+    await expect(() =>
+      readJsonFile(join(cwd, '.code-pushup', project, 'report.json')),
+    ).rejects.toThrow('');
+  });
+
+  it('should execute collect executor and add report to sub folder named by project', async () => {
+    const cwd = join(baseDir, 'execute-collect-command');
+    await addTargetToWorkspace(tree, { cwd, project });
+
+    const { stdout, code } = await executeProcess({
+      command: 'nx',
+      args: ['run', `${project}:code-pushup`, 'collect'],
+      cwd,
+    });
+
+    expect(code).toBe(0);
+    const cleanStdout = removeColorCodes(stdout);
+    expect(cleanStdout).toContain('nx run my-lib:code-pushup collect');
+
+    const report = await readJsonFile(
+      join(cwd, '.code-pushup', project, 'report.json'),
+    );
+    expect(report).toStrictEqual(
+      expect.objectContaining({
+        plugins: [
+          expect.objectContaining({
+            slug: 'good-feels',
+            audits: [
+              expect.objectContaining({
+                displayValue: '✅ Perfect! 👌',
+                slug: 'always-perfect',
+              }),
+            ],
+          }),
+        ],
+      }),
+    );
+  });
+
+  it('should execute upload executor to throw if no report is present', async () => {
+    const cwd = join(baseDir, 'execute-upload-command');
+    await addTargetToWorkspace(tree, { cwd, project });
+
+    await expect(
+      executeProcess({
+        command: 'npx',
+        args: ['nx', 'run', `${project}:code-pushup`, 'upload'],
+        cwd,
+      }),
+    ).rejects.toThrow(/report.json/);
   });
 });

e2e/nx-plugin-e2e/tests/generator-configuration.e2e.test.ts

@@ -65,7 +65,7 @@ describe('nx-plugin g configuration', () => {
       expect.objectContaining({
         targets: expect.objectContaining({
           'code-pushup': {
-            executor: '@code-pushup/nx-plugin:autorun',
+            executor: '@code-pushup/nx-plugin:cli',
           },
         }),
       }),
@@ -108,7 +108,7 @@ describe('nx-plugin g configuration', () => {
       expect.objectContaining({
         targets: expect.objectContaining({
           'code-pushup': {
-            executor: '@code-pushup/nx-plugin:autorun',
+            executor: '@code-pushup/nx-plugin:cli',
           },
         }),
       }),
@@ -149,7 +149,7 @@ describe('nx-plugin g configuration', () => {
       expect.objectContaining({
         targets: expect.objectContaining({
           'code-pushup': {
-            executor: '@code-pushup/nx-plugin:autorun',
+            executor: '@code-pushup/nx-plugin:cli',
           },
         }),
       }),
@@ -193,7 +193,7 @@ describe('nx-plugin g configuration', () => {
       expect.objectContaining({
         targets: expect.not.objectContaining({
           'code-pushup': {
-            executor: '@code-pushup/nx-plugin:autorun',
+            executor: '@code-pushup/nx-plugin:cli',
           },
         }),
       }),

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

@@ -146,7 +146,7 @@ describe('nx-plugin', () => {
     expect(projectJson.targets).toStrictEqual({
       ['code-pushup']: {
         configurations: {},
-        executor: `@code-pushup/nx-plugin:autorun`,
+        executor: `@code-pushup/nx-plugin:cli`,
         options: {},
       },
     });
@@ -174,16 +174,25 @@ describe('nx-plugin', () => {
           codeStrings: 'customPlugin()',
         },
       ],
+      upload: {
+        server: 'http://staging.code-pushup.dev',
+        organization: 'code-pushup',
+        apiKey: '12345678',
+      },
     });
 
     await materializeTree(tree, cwd);
 
-    const { stdout } = await executeProcess({
+    const { stdout, stderr } = await executeProcess({
       command: 'npx',
       args: ['nx', 'run', `${project}:code-pushup`, '--dryRun'],
       cwd,
     });
 
+    const cleanStderr = removeColorCodes(stderr);
+    // @TODO create test environment for working plugin. This here misses package-lock.json to execute correctly
+    expect(cleanStderr).toContain('DryRun execution of: npx @code-pushup/cli');
+
     const cleanStdout = removeColorCodes(stdout);
     expect(cleanStdout).toContain(
       'NX   Successfully ran target code-pushup for project my-lib',
@@ -208,7 +217,7 @@ describe('nx-plugin', () => {
 
     expect(projectJson.targets).toStrictEqual({
       ['code-pushup']: expect.objectContaining({
-        executor: 'XYZ:autorun',
+        executor: 'XYZ:cli',
       }),
     });
   });
@@ -231,7 +240,7 @@ describe('nx-plugin', () => {
 
     expect(projectJson.targets).toStrictEqual({
       ['code-pushup']: expect.objectContaining({
-        executor: `@code-pushup/nx-plugin:autorun`,
+        executor: `@code-pushup/nx-plugin:cli`,
         options: {
           projectPrefix: 'cli',
         },

e2e/nx-plugin-e2e/vite.config.e2e.ts

@@ -6,7 +6,7 @@ export default defineConfig({
   cacheDir: '../../node_modules/.vite/nx-plugin-e2e',
   test: {
     reporters: ['basic'],
-    testTimeout: 60_000,
+    testTimeout: 160_000,
     globals: true,
     alias: tsconfigPathAliases(),
     pool: 'threads',

global-setup.verdaccio.ts

@@ -38,6 +38,6 @@ export async function setup() {
 export async function teardown() {
   // NOTICE - Time saving optimization
   // We skip uninstalling packages as the folder is deleted anyway
-  // comment out to see the folder and web interface
-  // await nxStopVerdaccioAndTeardownEnv(activeRegistry);
+
+  await nxStopVerdaccioAndTeardownEnv(activeRegistry);
 }

packages/nx-plugin/README.md

@@ -1,11 +1,30 @@
 # @code-pushup/nx-plugin
 
+### Plugin
+
+Register this plugin in your `nx.json` to leverage a set of generators and executors to integrate Code PushUp into a Nx workspace.
+
+#### Registration
+
+```jsonc
+// nx.json
+{
+  //...
+  "plugins": ["@code-pushup/nx-plugin"]
+}
+```
+
+Resulting targets:
+
+- `nx run <project-name>:code-pushup--configuration` (no config file present)
+- `nx run <project-name>:code-pushup` (`code-pushup.config.{ts,mjs,js}` is present)
+
 ### Generators
 
 #### Init
 
 Install JS packages and register plugin.
-See [init docs](./src/generators/init/README.md) for details
+See [init generator docs](./src/generators/init/README.md) for details
 
 Examples:
 
@@ -15,9 +34,35 @@ Examples:
 #### Configuration
 
 Adds a `code-pushup` target to your `project.json`.
-See [configuration docs](./src/generators/configuration/README.md) for details
+See [configuration generator docs](./src/generators/configuration/README.md) for details
 
 Examples:
 
 - `nx g @code-pushup/nx-plugin:configuration --project=<project-name>`
 - `nx g @code-pushup/nx-plugin:configuration --project=<project-name> --targetName=cp`
+
+### Executor
+
+#### CLI
+
+Install JS packages configure a target in your project json.
+See [CLI executor docs](./src/executor/cli/README.md) for details
+
+Examples:
+
+```json
+{
+  "name": "my-project",
+  "targets": {
+    "code-pushup": {
+      "executor": "@code-pushup/nx-plugin:cli",
+      "options": {
+        "projectPrefix": "workspace-name"
+      }
+    }
+  }
+}
+```
+
+- `nx run <project-name>:code-pushup`
+- `nx run <project-name>:code-pushup print-config --persist.filename=custom-report`

packages/nx-plugin/executors.json

@@ -1,9 +1,9 @@
 {
   "executors": {
-    "autorun": {
-      "implementation": "./src/executors/autorun/executor",
-      "schema": "./src/executors/autorun/schema.json",
-      "description": "CodePushup CLI autorun command executor. Executes the @code-pushup/cli autorun command See: https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#autorun-command"
+    "cli": {
+      "implementation": "./src/executors/cli/executor",
+      "schema": "./src/executors/cli/schema.json",
+      "description": "CodePushup CLI executor. Executes the @code-pushup/cli command's See: https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#commands"
     }
   }
 }

packages/nx-plugin/package.json

@@ -17,7 +17,7 @@
   },
   "dependencies": {
     "@nx/devkit": "^17.1.3",
-    "tslib": "^2.6.2",
+    "tslib": "2.6.3",
     "nx": "^17.1.3",
     "@code-pushup/models": "0.51.0",
     "zod": "^3.22.4",