fix(verdaccio): e2e pipeline, nx-cmake still needs fixing

clemenscodes · clemenscodes · commit 13e0d6b87383 · 2024-03-15T19:44:54.000+01:00
diff --git a/.commitlintrc.js b/.commitlintrc.js
@@ -10,10 +10,10 @@ module.exports = {
             2,
             'always',
             [
-                ...(await getProjects(
+                ...getProjects(
                     ctx,
                     ({ name }) => !name.includes('e2e') && !name.includes('sb'),
-                )),
+                ),
             ],
         ],
     },
diff --git a/e2e/e2e-create-nx-cmake/project.json b/e2e/e2e-create-nx-cmake/project.json
@@ -5,21 +5,17 @@
     "sourceRoot": "e2e/e2e-create-nx-cmake/tests",
     "targets": {
         "run-e2e": {
-            "dependsOn": ["^start-local-registry", "^publish"],
+            "dependsOn": ["^publish"],
             "executor": "@nx/jest:jest",
             "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
             "options": {
                 "jestConfig": "e2e/{projectName}/jest.config.ts",
                 "runInBand": true
             }
         },
-        "finish-e2e": {
-            "dependsOn": ["run-e2e"],
-            "command": "nx stop-local-registry verdaccio"
-        },
         "e2e": {
-            "dependsOn": ["finish-e2e"],
-            "executor": "nx:noop"
+            "dependsOn": ["^e2e"],
+            "command": "nx single-e2e verdaccio --e2e={projectName}"
         },
         "lint": {
             "executor": "@nx/eslint:lint",
@@ -34,5 +30,5 @@
             }
         }
     },
-    "implicitDependencies": ["verdaccio", "create-nx-cmake"]
+    "implicitDependencies": ["verdaccio", "create-nx-cmake", "e2e-nx-cmake"]
 }
diff --git a/e2e/e2e-create-nx-cmake/tests/create-nx-cmake.spec.ts b/e2e/e2e-create-nx-cmake/tests/create-nx-cmake.spec.ts
@@ -43,7 +43,7 @@ function createTestProject(extraArgs = '') {
         recursive: true,
     });
 
-    execSync(`npx --yes create-nx-cmake@e2e ${projectName} ${extraArgs}`, {
+    execSync(`npx create-nx-cmake@e2e ${projectName} ${extraArgs}`, {
         cwd: dirname(projectDirectory),
         stdio: 'inherit',
         env: process.env,
diff --git a/e2e/e2e-nx-cmake/project.json b/e2e/e2e-nx-cmake/project.json
@@ -5,21 +5,17 @@
     "sourceRoot": "e2e/e2e-nx-cmake/tests",
     "targets": {
         "run-e2e": {
-            "dependsOn": ["^start-local-registry", "^publish"],
+            "dependsOn": ["^publish"],
             "executor": "@nx/jest:jest",
             "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
             "options": {
                 "jestConfig": "e2e/{projectName}/jest.config.ts",
                 "runInBand": true
             }
         },
-        "finish-e2e": {
-            "dependsOn": ["run-e2e"],
-            "command": "nx stop-local-registry verdaccio"
-        },
         "e2e": {
-            "dependsOn": ["finish-e2e"],
-            "executor": "nx:noop"
+            "dependsOn": ["^e2e"],
+            "command": "nx single-e2e verdaccio --e2e={projectName}"
         },
         "lint": {
             "executor": "@nx/eslint:lint",
@@ -34,5 +30,5 @@
             }
         }
     },
-    "implicitDependencies": ["verdaccio", "nx-cmake"]
+    "implicitDependencies": ["nx-cmake"]
 }
diff --git a/e2e/e2e-nx-cmake/tests/nx-cmake.spec.ts b/e2e/e2e-nx-cmake/tests/nx-cmake.spec.ts
@@ -367,7 +367,7 @@ function createTestProject() {
     });
 
     execSync(
-        `npx --yes create-nx-workspace@latest ${projectName} --preset=${plugin} --nxCloud=skip --no-interactive`,
+        `npx create-nx-workspace@latest ${projectName} --preset=${plugin} --ci=skip --interactive=false --verbose`,
         {
             cwd: dirname(projectDirectory),
             stdio: 'inherit',
diff --git a/package.json b/package.json
@@ -38,6 +38,7 @@
         "@types/node": "20.11.25",
         "@typescript-eslint/eslint-plugin": "7.1.1",
         "@typescript-eslint/parser": "7.1.1",
+        "@verdaccio/types": "^10.8.0",
         "commitizen": "^4.3.0",
         "commitlint": "^19.0.3",
         "cz-git": "^1.9.0",
diff --git a/packages/verdaccio/config.yml b/packages/verdaccio/config.yml
@@ -1,5 +1,5 @@
 # path to a directory with all packages
-storage: ../tmp/local-registry/storage
+storage: ../../tmp/local-registry/storage
 
 # a list of other known repositories we can talk to
 uplinks:
@@ -34,3 +34,5 @@ server:
 
 listen:
     - 0.0.0.0:4873
+
+_debug: true
diff --git a/packages/verdaccio/project.json b/packages/verdaccio/project.json
@@ -52,6 +52,13 @@
                 "command": "ts-node {projectRoot}/src/bin/publish.ts {args.name} {args.ver} {args.tag}"
             }
         },
+        "single-e2e": {
+            "executor": "nx:run-commands",
+            "options": {
+                "color": true,
+                "command": "ts-node {projectRoot}/src/bin/single-e2e.ts {args.e2e}"
+            }
+        },
         "run-many-e2e": {
             "executor": "nx:run-commands",
             "options": {
diff --git a/packages/verdaccio/src/bin/publish.ts b/packages/verdaccio/src/bin/publish.ts
@@ -9,6 +9,8 @@ function invariant(condition: boolean, message: string) {
     }
 }
 
+const registry = 'http://localhost:4873';
+
 // Executing publish script: node path/to/publish.mjs {name} --version {version} --tag {tag}
 // Default "tag" to "next" so we won't publish the "latest" tag by accident.
 const [, , name, version, tag = 'next'] = process.argv;
@@ -36,7 +38,6 @@ invariant(
 
 process.chdir(outputPath);
 
-// Updating the version in "package.json" before publishing
 try {
     const json = JSON.parse(readFileSync(`package.json`).toString());
     json.version = version;
@@ -45,21 +46,14 @@ try {
     console.error(`Error reading package.json file from library build output.`);
 }
 
-const host = 'localhost';
-const port = 4873;
-const registry = `http://${host}:${port}`;
-
-execSync(
-    `npm config set //${host}:${port}/:_authToken "secretVerdaccioToken"`,
-    {
-        encoding: 'utf-8',
-        stdio: 'inherit',
-        env: {
-            ...process.env,
-            npm_config_registry: registry,
-        },
+execSync(`npm config set //localhost:4873/:_authToken "secretVerdaccioToken"`, {
+    encoding: 'utf-8',
+    stdio: 'inherit',
+    env: {
+        ...process.env,
+        npm_config_registry: registry,
     },
-);
+});
 
 // Execute "npm publish" to publish
 execSync(`npm publish --access public --tag ${tag} --registry ${registry}`, {
diff --git a/packages/verdaccio/src/bin/single-e2e.ts b/packages/verdaccio/src/bin/single-e2e.ts
@@ -0,0 +1,3 @@
+import { e2eSingle } from '../lib/single-e2e';
+const [, , target] = process.argv;
+e2eSingle(target);
diff --git a/packages/verdaccio/src/bin/start-local-registry.ts b/packages/verdaccio/src/bin/start-local-registry.ts
@@ -1,3 +1,7 @@
 import { startLocalRegistry } from '../lib/startLocalRegistry';
 
-startLocalRegistry();
+const registryProcess = startLocalRegistry();
+if (registryProcess) {
+    console.log('Local registry started on port 4873');
+    registryProcess.unref();
+}
diff --git a/packages/verdaccio/src/bin/stop-local-registry.ts b/packages/verdaccio/src/bin/stop-local-registry.ts
@@ -1,3 +1,7 @@
+import { exit } from 'node:process';
 import { stopLocalRegistry } from '../lib/stopLocalRegistry';
 
 stopLocalRegistry(null);
+if (!process.env['SKIP']) {
+    exit(0);
+}
diff --git a/packages/verdaccio/src/config/hostname.ts b/packages/verdaccio/src/config/hostname.ts
diff --git a/packages/verdaccio/src/config/port.ts b/packages/verdaccio/src/config/port.ts
diff --git a/packages/verdaccio/src/config/project.ts b/packages/verdaccio/src/config/project.ts
diff --git a/packages/verdaccio/src/config/registry.ts b/packages/verdaccio/src/config/registry.ts
diff --git a/packages/verdaccio/src/config/storage.ts b/packages/verdaccio/src/config/storage.ts
diff --git a/packages/verdaccio/src/index.ts b/packages/verdaccio/src/index.ts
@@ -1 +1,2 @@
 export { e2e } from './lib/e2e';
+export { e2eSingle } from './lib/single-e2e';
diff --git a/packages/verdaccio/src/lib/localRegistryTarget.ts b/packages/verdaccio/src/lib/localRegistryTarget.ts
diff --git a/packages/verdaccio/src/lib/setLocalRegistry.ts b/packages/verdaccio/src/lib/setLocalRegistry.ts
@@ -1,11 +1,8 @@
 import { execSync } from 'child_process';
-import { port } from '../config/port';
-import { registry } from '../config/registry';
-import { hostname } from '../config/hostname';
 
 export const setLocalRegistry = () => {
-    process.env['npm_config_registry'] = registry;
-    const cmd = `npm config set //${hostname}:${port}/:_authToken "secretVerdaccioToken"`;
+    process.env['npm_config_registry'] = 'http://localhost:4873';
+    const cmd = `npm config set //localhost:4873/:_authToken "secretVerdaccioToken"`;
     execSync(cmd);
-    console.log('Set npm config registry to ' + registry);
+    console.log('Set npm config registry to ' + 'http://localhost:4873');
 };
diff --git a/packages/verdaccio/src/lib/single-e2e.ts b/packages/verdaccio/src/lib/single-e2e.ts
@@ -0,0 +1,24 @@
+import { execSync } from 'node:child_process';
+import { exit } from 'node:process';
+import { startLocalRegistry } from './startLocalRegistry';
+import { stopLocalRegistry } from './stopLocalRegistry';
+
+export const e2eSingle = (target: string) => {
+    const registryProcess = startLocalRegistry();
+    const head = process.env['NX_HEAD']
+        ? `--head=${process.env['NX_HEAD']}`
+        : '';
+    const base = process.env['NX_BASE']
+        ? `--base=${process.env['NX_BASE']}`
+        : '';
+    const cmd = `nx run-e2e ${target} --nx-bail --output-style=stream --configuration=ci ${base} ${head}`;
+    execSync(cmd, {
+        stdio: 'inherit',
+        env: {
+            ...process.env,
+            SKIP: 'true',
+        },
+    });
+    stopLocalRegistry(registryProcess);
+    exit(0);
+};
diff --git a/packages/verdaccio/src/lib/startLocalRegistry.ts b/packages/verdaccio/src/lib/startLocalRegistry.ts
@@ -1,23 +1,18 @@
 import { ChildProcess, spawn } from 'child_process';
-import { localRegistryTarget } from './localRegistryTarget';
-import { port } from '../config/port';
-import { project } from '../config/project';
 import { setLocalRegistry } from './setLocalRegistry';
 
 export const startLocalRegistry = (): ChildProcess | null => {
     if (process.env['SKIP']) {
         console.log('Skipping start');
         return null;
     }
-    const childProcess = spawn('nx', [localRegistryTarget, project], {
-        stdio: 'inherit',
+    setLocalRegistry();
+    const childProcess = spawn('nx', ['local-registry', 'verdaccio'], {
+        stdio: 'pipe',
         detached: true,
         env: {
             ...process.env,
         },
     });
-    childProcess.unref();
-    console.log('Local registry started on port ' + port);
-    setLocalRegistry();
     return childProcess;
 };
diff --git a/packages/verdaccio/src/lib/stopLocalRegistry.ts b/packages/verdaccio/src/lib/stopLocalRegistry.ts
@@ -1,5 +1,4 @@
 import { ChildProcess, execSync } from 'child_process';
-import { port } from '../config/port';
 import { unsetLocalRegistry } from './unsetLocalRegistry';
 
 export const stopLocalRegistry = (childProcess: ChildProcess | null) => {
@@ -12,7 +11,7 @@ export const stopLocalRegistry = (childProcess: ChildProcess | null) => {
         childProcess.kill();
         return;
     }
-    execSync(`npx kill-port ${port}`, {
+    execSync(`npx kill-port 4873`, {
         env: {
             ...process.env,
             npm_config_registry: 'https://registry.npmjs.org',
diff --git a/packages/verdaccio/src/lib/unsetLocalRegistry.ts b/packages/verdaccio/src/lib/unsetLocalRegistry.ts
@@ -1,7 +1,5 @@
 import { execSync } from 'child_process';
-import { port } from '../config/port';
-import { hostname } from '../config/hostname';
 
 export const unsetLocalRegistry = () => {
-    execSync(`npm config delete //${hostname}:${port}/:_authToken`);
+    execSync(`npm config delete //localhost:4873/:_authToken`);
 };
diff --git a/plugins/create-nx-cmake/bin/index.ts b/plugins/create-nx-cmake/bin/index.ts
@@ -10,13 +10,11 @@ async function main() {
 
     console.log(`Creating the workspace: ${name}`);
 
-    // This assumes "nx-cmake" and "create-nx-cmake" are at the same version
-    const { version } = await import('../package.json');
-
     // TODO: update below to customize the workspace
-    const { directory } = await createWorkspace(`nx-cmake@${version}`, {
+    const { directory } = await createWorkspace(`nx-cmake`, {
         name,
         nxCloud: 'skip',
+        interactive: false,
         packageManager: 'npm',
     });
 
diff --git a/plugins/create-nx-cmake/package.json b/plugins/create-nx-cmake/package.json
@@ -1,13 +1,14 @@
 {
     "name": "create-nx-cmake",
     "version": "0.6.0",
+    "bin": {
+        "create-nx-cmake": "./bin/index.js"
+    },
+    "typings": "./bin/index.d.ts",
     "dependencies": {
         "create-nx-workspace": "18.0.8",
         "tslib": "^2.6.2"
     },
-    "type": "commonjs",
-    "main": "./src/index.js",
-    "typings": "./src/index.d.ts",
     "author": {
         "email": "me@clemenshorn.com",
         "name": "Clemens Horn",
@@ -31,8 +32,5 @@
     "bugs": {
         "url": "https://github.com/clemenscodes/nx-plugins/issues/new",
         "email": "me@clemenshorn.com"
-    },
-    "bin": {
-        "create-nx-cmake": "./bin/index.js"
     }
 }
diff --git a/plugins/nx-cmake/package.json b/plugins/nx-cmake/package.json
@@ -3,7 +3,6 @@
     "description": "An Nx plugin to add CMake, C and C++ support for Nx workspaces",
     "version": "0.6.0",
     "license": "MIT",
-    "type": "commonjs",
     "main": "./src/index.js",
     "typings": "./src/index.d.ts",
     "generators": "./generators.json",
diff --git a/plugins/nx-cmake/project.json b/plugins/nx-cmake/project.json
@@ -77,5 +77,6 @@
             "command": "nx upload verdaccio --name={projectName} --ver=1.0.0 --tag=e2e"
         }
     },
+    "implicitDependencies": ["verdaccio"],
     "tags": []
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -367,7 +367,7 @@ function createTestProject() {`
`367`	`367`	`});`
`368`	`368`
`369`	`369`	`execSync(`
`370`		- `npx --yes create-nx-workspace@latest ${projectName} --preset=${plugin} --nxCloud=skip --no-interactive`,
	`370`	+ `npx create-nx-workspace@latest ${projectName} --preset=${plugin} --ci=skip --interactive=false --verbose`,
`371`	`371`	`{`
`372`	`372`	`cwd: dirname(projectDirectory),`
`373`	`373`	`stdio: 'inherit',`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import { e2eSingle } from '../lib/single-e2e';`
	`2`	`+const [, , target] = process.argv;`
	`3`	`+e2eSingle(target);`