test: refactor backwards compatibility test (#600)

Author: dianjuar

.github/workflows/backwards-compatibility-test.yml

@@ -1,14 +1,12 @@
 name: Backwards Compatibility Test
-on:
-  workflow_dispatch:
-  schedule:
-    - cron: '0 0 * * *' # daily at 00:00
+
+on: workflow_call
 
 jobs:
   backwards-compatibility-test:
     strategy:
       matrix:
-        nx-version: [latest, '16.10.0']
-    uses: ./.github/workflows/integration-test.yml
+        nx-version: ['', '16.10.0'] # '' means current workspace version
+    uses: ./.github/workflows/integration-test-nx-workspace.yml
     with:
       nx-version: ${{matrix.nx-version}}

.github/workflows/compatibility-observability.yml

@@ -0,0 +1,14 @@
+name: Incoming Versions Compatibility Test
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *' # daily at 00:00
+
+jobs:
+  backwards-compatibility-test:
+    strategy:
+      matrix:
+        nx-version: [latest]
+    uses: ./.github/workflows/integration-test-nx-workspace.yml
+    with:
+      nx-version: ${{matrix.nx-version}}

.github/workflows/integration-test.yml renamed to .github/workflows/integration-test-nx-workspace.yml

@@ -1,4 +1,12 @@
-name: Integration Test
+# This can be seen as a automated simple manual test
+# It test the plugin with a real Nx workspace using a specific workspace version
+#
+# This integration test does:
+# 1. Creates a Nx workspace with the provided version
+# 2. Creates a node lib
+# 3. Adds ngx-deploy-npm plugin, test `install` generator
+# 4. Publish the lib suing --dry-run, test `deploy` executor
+name: Integration Test (Nx Workspace)
 
 on:
   workflow_call:
@@ -18,13 +26,14 @@ jobs:
       - name: Read package.json Nx and set default parameter
         id: set-default-param
         run: |
-          version=$(jq -r '.devDependencies.nx'package.json)
-          if [ -z "${{ github.event.inputs.nx-version }}" ]; then
+
+          if [ -z "${{ inputs.nx-version }}" ]; then
+            version=$(jq -r '.devDependencies.nx' package.json)
             echo "Setting default value for nx-version parameter: $version"
             echo "NX_VERSION=$version" >> $GITHUB_ENV
           else
-            echo "Using provided value for nx-version parameter: ${{ github.event.inputs.nx-version }}"
-            echo "NX_VERSION=${{ github.event.inputs.nx-version }}" >> $GITHUB_ENV
+            echo "Using provided value for nx-version parameter: ${{ inputs.nx-version }}"
+            echo "NX_VERSION=${{ inputs.nx-version }}" >> $GITHUB_ENV
           fi
 
       - name: Integration Test

.github/workflows/pr.yml

@@ -36,8 +36,8 @@ jobs:
       - name: Check if Prettier was run
         run: npx pretty-quick --check
 
-  automated-manual-test:
-    uses: ./.github/workflows/integration-test.yml
+  backwards-compatibility-test:
+    uses: ./.github/workflows/backwards-compatibility-test.yml
 
   pr-analysis:
     name: SonarCloud Pr Analysis

.github/workflows/publishment.yml

@@ -17,8 +17,8 @@ jobs:
     if: ${{ !contains(github.event.head_commit.message, 'chore(release)') }}
     uses: ./.github/workflows/integration-test-plugins.yml
 
-  automated-manual-test:
-    uses: ./.github/workflows/integration-test.yml
+  backwards-compatibility-test:
+    uses: ./.github/workflows/backwards-compatibility-test.yml
 
   analysis:
     name: SonarCloud Main Analysis
@@ -51,7 +51,7 @@ jobs:
   release:
     environment: production
     runs-on: ubuntu-latest
-    needs: [release-preliminar, e2e-test, test, automated-manual-test]
+    needs: [release-preliminar, e2e-test, test, backwards-compatibility-test]
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/setup

packages/ngx-deploy-npm/project.json

@@ -113,7 +113,7 @@
       "executor": "nx:run-commands",
       "outputs": ["{workspaceRoot}/tmp/nx-workspace"],
       "options": {
-        "command": "./tools/create-nx-workspace.sh"
+        "command": "node ./tools/create-nx-workspace.js"
       },
       "dependsOn": ["yalc-it"]
     }

tools/create-nx-workspace.js

@@ -0,0 +1,67 @@
+const { spawnSync } = require('child_process');
+const fs = require('fs');
+const path = require('path');
+
+const version = process.argv[2] || 'latest';
+
+const tmpDir = path.join(__dirname, '..', 'tmp');
+fs.mkdirSync(tmpDir, { recursive: true });
+process.chdir(tmpDir);
+
+// Delete the previous workspace
+if (fs.existsSync('nx-workspace')) {
+  fs.rmSync('nx-workspace', { recursive: true, force: true });
+}
+
+console.log('Creating Nx Workspace with version:', version);
+executeCommand(`npx --yes create-nx-workspace@${version} --version`);
+console.log('☝️');
+
+console.log('----- Create Nx Workspace -----');
+executeCommand(
+  `npx create-nx-workspace@${version} --name nx-workspace --preset npm ${
+    version === '16.10.0' ? '--nxCloud=false' : '--nxCloud=skip'
+  }`
+);
+process.chdir('nx-workspace');
+
+fs.writeFileSync('.env', `NX_WORKSPACE_ROOT_PATH=${process.cwd()}`);
+
+console.log('----- Generate lib -----');
+executeCommand(`npm add -D @nx/node@${version}`);
+executeCommand('npx nx generate @nx/node:init');
+executeCommand(
+  'npx nx generate @nx/node:library nx-lib --publishable --importPath nx-lib'
+);
+
+console.log('----- Link ngx-deploy-npm -----');
+executeCommand('npx --yes yalc add ngx-deploy-npm');
+
+console.log('----- Add ngx-deploy-npm to the workspace -----');
+executeCommand(
+  'npx nx generate ngx-deploy-npm:install --project nx-lib --distFolderPath dist/nx-lib'
+);
+
+console.log('----- Test the build -----');
+executeCommand('npx nx deploy nx-lib --dry-run');
+
+function executeCommand(command) {
+  if (process.env.CI !== 'true') {
+    console.log(`\x1b[32mExecuting command:\x1b[0m '${command}'`);
+  }
+  const commandArr = command.split(' ');
+
+  spawnSync(
+    commandArr[0],
+    commandArr
+      .slice(1)
+      .map(arg => arg.split(' '))
+      .flat(),
+    {
+      stdio: 'inherit',
+    },
+    {
+      stdio: 'inherit',
+    }
+  );
+}