test: create smoke test (#653)

dianjuar · web-flow · commit a389ea5999eb · 2024-10-27T17:58:23.000-05:00
diff --git a/.github/workflows/backwards-compatibility-test.yml b/.github/workflows/backwards-compatibility-test.yml
@@ -38,7 +38,7 @@ jobs:
             node-version: 16 # This node's version is deprecated
 
     name: Backwards Compatibility Test
-    uses: ./.github/workflows/integration-test-nx-workspace.yml
+    uses: ./.github/workflows/smoke-test-nx-workspace.yml
     with:
       nx-version: ${{matrix.nx-version}}
       node-version: ${{matrix.node-version}}
diff --git a/.github/workflows/compatibility-observability.yml b/.github/workflows/compatibility-observability.yml
@@ -5,10 +5,24 @@ on:
     - cron: '0 0 * * *' # daily at 00:00
 
 jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/setup
+
+      - run: npx nx build ngx-deploy-npm
+
+      - name: Archive build result
+        uses: actions/upload-artifact@v4
+        with:
+          name: library-dist-${{ github.sha }}
+          path: dist
+
   backwards-compatibility-test:
     strategy:
       matrix:
         nx-version: [latest]
-    uses: ./.github/workflows/integration-test-nx-workspace.yml
+    uses: ./.github/workflows/smoke-test-nx-workspace.yml
     with:
       nx-version: ${{matrix.nx-version}}
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -34,6 +34,7 @@ jobs:
         run: npx pretty-quick --check
 
   backwards-compatibility-test:
+    needs: [pr-test]
     uses: ./.github/workflows/backwards-compatibility-test.yml
 
   pr-analysis:
diff --git a/.github/workflows/publishment.yml b/.github/workflows/publishment.yml
@@ -12,6 +12,7 @@ jobs:
     uses: ./.github/workflows/e2e-test.yml
 
   backwards-compatibility-test:
+    needs: [test]
     uses: ./.github/workflows/backwards-compatibility-test.yml
 
   analysis:
diff --git a/.github/workflows/smoke-test-nx-workspace.yml b/.github/workflows/smoke-test-nx-workspace.yml
@@ -1,27 +1,21 @@
 # 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)
+name: Smoketest Nx Workspace
 
 on:
   workflow_call:
     inputs:
       nx-version:
         type: string
-        description: The Nx Workspace version to run the integration test
+        description: The Nx Workspace version to run the smoke test
         required: false
       node-version:
         type: string
-        description: The Node version to run the integration test
+        description: The Node version to run the smoke test
         required: false
 
 jobs:
-  integration-test:
+  smoke-test:
     runs-on: ubuntu-latest
     steps:
       - name: Indicate versions
@@ -44,18 +38,19 @@ jobs:
         with:
           node-version: ${{ inputs.node-version }}
 
+      - uses: ./.github/actions/download-build
+
       - name: Read package.json Nx and set default parameter
         id: set-default-param
         run: |
           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
+            echo "NGX_DEPLOY_NPM_E2E__NX_VERSION=$version" >> $GITHUB_ENV
           else
             echo "Using provided value for nx-version parameter: ${{ inputs.nx-version }}"
-            echo "NX_VERSION=${{ inputs.nx-version }}" >> $GITHUB_ENV
+            echo "NGX_DEPLOY_NPM_E2E__NX_VERSION=${{ inputs.nx-version }}" >> $GITHUB_ENV
           fi
-          echo $NX_VERSION
 
-      - name: Integration Test
-        run: npx nx create-nx-workspace ngx-deploy-npm -- $NX_VERSION
+      - name: Smoke Test
+        run: npx nx smoke ngx-deploy-npm-e2e
diff --git a/.gitignore b/.gitignore
@@ -59,3 +59,5 @@ reports/*
 .sonarlint/
 
 # End of https://www.toptal.com/developers/gitignore/api/sonarqube
+
+.env
diff --git a/docs/README_contributors.md b/docs/README_contributors.md
@@ -9,6 +9,7 @@
   - [Option B), the traditional one](#option-b-the-traditional-one)
 - [Making a Contribution](#making-a-contribution)
 - [E2E test](#e2e-test)
+- [Smoke test](#smoke-test)
 - [Continuous Inspection (SonarQube)](#continuous-inspection-sonarqube)
 - [Test different node versions](#test-different-node-versions)
 - [When are my changes going to be public?](#when-are-my-changes-going-to-be-public)
@@ -110,6 +111,18 @@ On VsCode, create a [_JavaScript Debug Terminal_](https://code.visualstudio.com/
 
 We at this project have E2E tests. They are handy to test production-like scenarios and to have confidence in your changes.
 
+## Smoke test
+
+We conduct a series of small and pragmatic e2e tests called the **smoke test**. This test is essential for testing the package's core functionality.
+
+Using the smoke tests, we composed a series of more elaborate tests. Such as:
+
+- **Compatibility Observability Test**: Scheduled test to verify daily if our package is working with the `latest` version of nx
+- **Backwards Compatibility Test**: To verify if the current changes work correctly with the supported versions of nx that we are committed to maintaining (see [Compatibility overview with Nx
+  ](https://github.com/bikecoders/ngx-deploy-npm?tab=readme-ov-file#compatibility-overview-with-nx)).
+
+It's essential to handle the libraries' build before running these tests. These tests will use whatever is in the dist folder. This is done using the build closest to the actual build on the NPM registry.
+
 ## Continuous Inspection (SonarQube)
 
 We have continuous inspection for each PR that is made; we use SonarQube for this. It will suggest some changes, detect code smells in your changes and, security recommendations. We encourage implementing the changes that Sonar offers.
diff --git a/packages/ngx-deploy-npm-e2e/.env.example b/packages/ngx-deploy-npm-e2e/.env.example
@@ -0,0 +1,3 @@
+NGX_DEPLOY_NPM_E2E__NX_VERSION=previous
+NGX_DEPLOY_NPM_E2E__PROJECT_NAME=test-project
+NGX_DEPLOY_NPM_E2E__NO_TEAR_DOWN=true
diff --git a/packages/ngx-deploy-npm-e2e/project.json b/packages/ngx-deploy-npm-e2e/project.json
@@ -14,6 +14,16 @@
       },
       "dependsOn": ["^build"]
     },
+    "smoke": {
+      "cache": false,
+      "executor": "@nx/jest:jest",
+      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
+      "options": {
+        "testPathPattern": [".*smoke.*\\.spec\\.ts$"],
+        "jestConfig": "packages/ngx-deploy-npm-e2e/jest.config.ts",
+        "runInBand": true
+      }
+    },
     "lint": {
       "executor": "@nx/eslint:lint"
     }
diff --git a/packages/ngx-deploy-npm-e2e/src/publish-minimal-lib.smoke.spec.ts b/packages/ngx-deploy-npm-e2e/src/publish-minimal-lib.smoke.spec.ts
diff --git a/packages/ngx-deploy-npm-e2e/src/utils/basic-setup.ts b/packages/ngx-deploy-npm-e2e/src/utils/basic-setup.ts
@@ -5,7 +5,7 @@ import { execSync } from 'child_process';
 import { ProjectConfiguration } from '@nx/devkit';
 import { readJson } from '@nx/plugin/testing';
 
-import { currentNxVersion } from './get-nx-current-version';
+import { getNxWorkspaceVersion } from './get-nx-workspace-version';
 import { InstallGeneratorOptions } from 'bikecoders/ngx-deploy-npm';
 import {
   generateLib,
@@ -125,10 +125,12 @@ export const setup = async (
     processedLibs,
     projectDirectory,
     tearDown: async () => {
-      await fs.promises.rm(projectDirectory, {
-        recursive: true,
-        force: true,
-      });
+      if (process.env.NGX_DEPLOY_NPM_E2E__NO_TEAR_DOWN !== 'true') {
+        await fs.promises.rm(projectDirectory, {
+          recursive: true,
+          force: true,
+        });
+      }
 
       return Promise.resolve();
     },
@@ -199,7 +201,8 @@ async function createMinimalLib(projectDirectory: string, libName: string) {
  * @returns The directory where the test project was created
  */
 async function createTestProject() {
-  const projectName = 'test-project';
+  const projectName =
+    process.env.NGX_DEPLOY_NPM_E2E__PROJECT_NAME || 'test-project';
   const projectDirectory = join(process.cwd(), 'tmp', projectName);
 
   // Ensure projectDirectory is empty
@@ -211,7 +214,7 @@ async function createTestProject() {
     recursive: true,
   });
 
-  const command = `npx --yes create-nx-workspace@${currentNxVersion} ${projectName} --preset npm --nxCloud=skip --no-interactive`;
+  const command = `npx --yes create-nx-workspace@${getNxWorkspaceVersion()} ${projectName} --preset npm --nxCloud=skip --no-interactive`;
   executeCommandFactory(dirname(projectDirectory))(command);
 
   return projectDirectory;
diff --git a/packages/ngx-deploy-npm-e2e/src/utils/get-nx-current-version.ts b/packages/ngx-deploy-npm-e2e/src/utils/get-nx-current-version.ts
diff --git a/packages/ngx-deploy-npm-e2e/src/utils/get-nx-workspace-version.ts b/packages/ngx-deploy-npm-e2e/src/utils/get-nx-workspace-version.ts
@@ -0,0 +1,13 @@
+import { readJson } from '@nx/plugin/testing';
+
+export const getNxWorkspaceVersion = () => {
+  const nxVersion = process.env.NGX_DEPLOY_NPM_E2E__NX_VERSION;
+
+  if (nxVersion) {
+    return nxVersion;
+  } else {
+    return readJson(`${process.cwd()}/package.json`).devDependencies[
+      '@nx/workspace'
+    ];
+  }
+};
diff --git a/packages/ngx-deploy-npm-e2e/src/utils/index.ts b/packages/ngx-deploy-npm-e2e/src/utils/index.ts
@@ -1,5 +1,5 @@
 export * from './generate-lib';
 export * from './install-deps';
 export * from './utils-ngx-deploy-npm';
-export * from './get-nx-current-version';
+export * from './get-nx-workspace-version';
 export * from './basic-setup';
diff --git a/packages/ngx-deploy-npm-e2e/src/utils/install-deps.ts b/packages/ngx-deploy-npm-e2e/src/utils/install-deps.ts
@@ -1,10 +1,10 @@
-import { currentNxVersion } from './get-nx-current-version';
+import { getNxWorkspaceVersion } from './get-nx-workspace-version';
 
 export function installDependencies(
   executeCommand: (command: string) => string,
   nxPlugin: string
 ) {
-  const packageToInstall = `${nxPlugin}@${currentNxVersion}`;
+  const packageToInstall = `${nxPlugin}@${getNxWorkspaceVersion()}`;
 
   executeCommand(`npm add -D ${packageToInstall}`);
   executeCommand(`npx nx g ${nxPlugin}:init`);
diff --git a/packages/ngx-deploy-npm-e2e/src/utils/utils-ngx-deploy-npm.ts b/packages/ngx-deploy-npm-e2e/src/utils/utils-ngx-deploy-npm.ts
@@ -1,9 +1,11 @@
 import { InstallGeneratorOptions } from 'bikecoders/ngx-deploy-npm';
+import { getNxWorkspaceVersion } from './get-nx-workspace-version';
 
 export function initNgxDeployNPMProject(
   executeCommand: (command: string) => void
 ) {
-  executeCommand(`npm install ngx-deploy-npm@e2e`);
+  executeCommand(`npm install -D @nx/devkit@${getNxWorkspaceVersion()}`);
+  executeCommand(`npm install -D ngx-deploy-npm@e2e`);
 }
 
 export function installNgxDeployNPMProject(
diff --git a/packages/ngx-deploy-npm/project.json b/packages/ngx-deploy-npm/project.json
@@ -73,6 +73,13 @@
       },
       "dependsOn": ["build"]
     },
+    "deploy:without-build": {
+      "executor": "./dist/packages/ngx-deploy-npm:deploy",
+      "options": {
+        "distFolderPath": "dist/packages/ngx-deploy-npm",
+        "access": "public"
+      }
+    },
     "github": {
       "executor": "@jscutlery/semver:github",
       "options": {
@@ -86,35 +93,6 @@
         "postTargets": ["build", "deploy"],
         "versionTagPrefix": "v"
       }
-    },
-    "yalc-it": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "cd dist/packages/ngx-deploy-npm && npx --yes yalc publish"
-      },
-      "dependsOn": ["build"]
-    },
-    "yarn-link-it": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "cd dist/packages/ngx-deploy-npm && npx --yes yarn link"
-      },
-      "dependsOn": ["build"]
-    },
-    "yarn-unlink-it": {
-      "executor": "nx:run-commands",
-      "options": {
-        "command": "cd dist/packages/ngx-deploy-npm && npx --yes yarn unlink"
-      },
-      "dependsOn": ["build"]
-    },
-    "create-nx-workspace": {
-      "executor": "nx:run-commands",
-      "outputs": ["{workspaceRoot}/tmp/nx-workspace"],
-      "options": {
-        "command": "node ./tools/create-nx-workspace.js"
-      },
-      "dependsOn": ["yalc-it"]
     }
   }
 }
diff --git a/tools/create-nx-workspace.js b/tools/create-nx-workspace.js
diff --git a/tools/scripts/start-local-registry.ts b/tools/scripts/start-local-registry.ts
@@ -18,6 +18,6 @@ export default async () => {
   });
 
   execSync(
-    'npx nx deploy ngx-deploy-npm --registry=http://localhost:4873 --packageVersion=0.0.0 --tag e2e'
+    'npx nx deploy:without-build ngx-deploy-npm --registry=http://localhost:4873 --packageVersion=0.0.0 --tag e2e'
   );
 };

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+NGX_DEPLOY_NPM_E2E__NX_VERSION=previous`
	`2`	`+NGX_DEPLOY_NPM_E2E__PROJECT_NAME=test-project`
	`3`	`+NGX_DEPLOY_NPM_E2E__NO_TEAR_DOWN=true`