test: use jest global setup/teardown to manage the registry mock (#6813)

close #6787
pnpm · Jul 15, 2023 · a70c77a · a70c77a
1 parent 7567305
commit a70c77a
Show file tree

Hide file tree

Showing 38 changed files with 124 additions and 132 deletions.
diff --git a/.meta-updater/src/index.ts b/.meta-updater/src/index.ts
@@ -150,12 +150,9 @@ async function updateManifest (workspaceDir: string, manifest: ProjectManifest,
     scripts = {
       ...(manifest.scripts as Record<string, string>),
       'registry-mock': 'registry-mock',
-      'test:jest': 'jest',
-
-      'test:e2e': 'registry-mock prepare && run-p -r registry-mock test:jest',
     }
     scripts.test = 'pnpm run compile && pnpm run _test'
-    scripts._test = `cross-env PNPM_REGISTRY_MOCK_PORT=${port} pnpm run test:e2e`
+    scripts._test = `cross-env PNPM_REGISTRY_MOCK_PORT=${port} jest`
     break
   }
   default:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,6 +3,7 @@
 ## Table of contents
 
 - [Setting Up the Environment](#setting-up-the-environment)
+- [Running Tests](#running-tests)
 - [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)
   - [After your pull request is merged](#after-your-pull-request-is-merged)
 - [Coding Style Guidelines](#coding-style-guidelines)
@@ -30,6 +31,26 @@ Some of the e2e tests run node-gyp, so you might need to install some build-esse
 sudo dnf install make automake gcc gcc-c++ kernel-devel
 ```
 
+## Running Tests
+
+You can run the tests of the project that you modified by going to the project's directory and running:
+
+```shell
+pnpm test
+```
+
+Alternatively, you can run it from anywhere by specifying the name of the project using the `--filter` option:
+
+```shell
+pnpm --filter=core test
+```
+
+If you want to pass options to Jest, use the `pnpm run test` command and append any needed options. For instance, if you want to run a single test in a single file, run:
+
+```shell
+pnpm --filter=core run test --testPathPattern="test/lockfile.ts" --testNamePattern="lockfile has dev deps even when installing for prod only"
+```
+
 ## Submitting a Pull Request (PR)
 
 Before you submit your Pull Request (PR) consider the following guidelines:

diff --git a/__utils__/assert-project/package.json b/__utils__/assert-project/package.json
@@ -44,7 +44,7 @@
     "@pnpm/constants": "workspace:*",
     "@pnpm/lockfile-types": "workspace:*",
     "@pnpm/modules-yaml": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@pnpm/types": "workspace:*",
     "is-windows": "^1.0.2",
     "isexe": "2.0.0",

diff --git a/__utils__/assert-store/package.json b/__utils__/assert-store/package.json
@@ -41,7 +41,7 @@
   },
   "dependencies": {
     "@pnpm/cafs": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "path-exists": "^4.0.0"
   },
   "devDependencies": {

diff --git a/exec/plugin-commands-rebuild/jest.config.js b/exec/plugin-commands-rebuild/jest.config.js
@@ -1 +1 @@
-module.exports = require('../../jest.config.js')
+module.exports = require('../../jest-with-registry.config.js')
diff --git a/exec/plugin-commands-rebuild/package.json b/exec/plugin-commands-rebuild/package.json
@@ -14,9 +14,7 @@
   "scripts": {
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
     "registry-mock": "registry-mock",
-    "test:jest": "jest",
-    "test:e2e": "registry-mock prepare && run-p -r registry-mock test:jest",
-    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7770 pnpm run test:e2e",
+    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7770 jest",
     "test": "pnpm run compile && pnpm run _test",
     "prepublishOnly": "pnpm run compile",
     "compile": "tsc --build && pnpm run lint --fix"
@@ -37,7 +35,7 @@
     "@pnpm/filter-workspace-packages": "workspace:*",
     "@pnpm/plugin-commands-rebuild": "workspace:*",
     "@pnpm/prepare": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@pnpm/test-fixtures": "workspace:*",
     "@types/ramda": "0.28.20",
     "@types/semver": "7.3.13",

diff --git a/exec/plugin-commands-script-runners/jest.config.js b/exec/plugin-commands-script-runners/jest.config.js
@@ -1 +1 @@
-module.exports = require('../../jest.config.js')
+module.exports = require('../../jest-with-registry.config.js')
diff --git a/exec/plugin-commands-script-runners/package.json b/exec/plugin-commands-script-runners/package.json
@@ -14,9 +14,7 @@
   "scripts": {
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
     "registry-mock": "registry-mock",
-    "test:jest": "jest",
-    "test:e2e": "registry-mock prepare && run-p -r registry-mock test:jest",
-    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7771 pnpm run test:e2e",
+    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7771 jest",
     "test": "pnpm run compile && pnpm run _test",
     "prepublishOnly": "pnpm run compile",
     "start": "tsc --watch",
@@ -37,7 +35,7 @@
     "@pnpm/filter-workspace-packages": "workspace:*",
     "@pnpm/plugin-commands-script-runners": "workspace:*",
     "@pnpm/prepare": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@types/is-windows": "^1.0.0",
     "@types/ramda": "0.28.20",
     "@types/which": "^2.0.2",

diff --git a/jest-with-registry.config.js b/jest-with-registry.config.js
@@ -0,0 +1,7 @@
+const path = require("path");
+
+module.exports = {
+  ...require('./jest.config'),
+  globalSetup: path.join(__dirname, 'jest.globalSetup.js'),
+  globalTeardown: path.join(__dirname, 'jest.globalTeardown.js'),
+}
diff --git a/jest.globalSetup.js b/jest.globalSetup.js
@@ -0,0 +1,6 @@
+const { start, prepare } = require('@pnpm/registry-mock')
+
+module.exports = () => {
+  prepare()
+  global.__SERVER__ = start()
+}
diff --git a/jest.globalTeardown.js b/jest.globalTeardown.js
@@ -0,0 +1,3 @@
+module.exports = () => {
+  global.__SERVER__.kill()
+}
diff --git a/package.json b/package.json
@@ -39,7 +39,7 @@
     "@commitlint/prompt-cli": "^17.6.6",
     "@pnpm/eslint-config": "workspace:*",
     "@pnpm/meta-updater": "0.2.3",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@pnpm/tsconfig": "workspace:*",
     "@types/jest": "^29.5.3",
     "@types/node": "^14.18.53",

diff --git a/patching/plugin-commands-patching/jest.config.js b/patching/plugin-commands-patching/jest.config.js
@@ -1,4 +1,2 @@
-const config = require('../../jest.config.js')
-
-module.exports = config
+module.exports = require('../../jest-with-registry.config.js')
 
diff --git a/patching/plugin-commands-patching/package.json b/patching/plugin-commands-patching/package.json
@@ -14,9 +14,7 @@
   "scripts": {
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
     "registry-mock": "registry-mock",
-    "test:jest": "jest",
-    "test:e2e": "registry-mock prepare && run-p -r registry-mock test:jest",
-    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7772 pnpm run test:e2e",
+    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7772 jest",
     "test": "pnpm run compile && pnpm run _test",
     "prepublishOnly": "pnpm run compile",
     "compile": "tsc --build && pnpm run lint --fix"
@@ -36,7 +34,7 @@
     "@pnpm/filter-workspace-packages": "workspace:*",
     "@pnpm/plugin-commands-patching": "workspace:*",
     "@pnpm/prepare": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@pnpm/test-fixtures": "workspace:*",
     "@types/normalize-path": "^3.0.0",
     "@types/npm-packlist": "^3.0.0",

diff --git a/pkg-manager/core/jest.config.js b/pkg-manager/core/jest.config.js
@@ -1 +1 @@
-module.exports = require('../../jest.config.js')
+module.exports = require('../../jest-with-registry.config.js')
diff --git a/pkg-manager/core/package.json b/pkg-manager/core/package.json
@@ -79,7 +79,7 @@
     "@pnpm/lockfile-types": "workspace:*",
     "@pnpm/package-store": "workspace:*",
     "@pnpm/prepare": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@pnpm/store-path": "workspace:*",
     "@pnpm/test-fixtures": "workspace:*",
     "@types/fs-extra": "^9.0.13",
@@ -142,10 +142,8 @@
     "commitmsg": "commitlint -e",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
     "registry-mock": "registry-mock",
-    "test:jest": "jest",
-    "test:e2e": "registry-mock prepare && run-p -r registry-mock test:jest",
     "test-with-preview": "preview && pnpm run test:e2e",
-    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=4873 pnpm run test:e2e",
+    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=4873 jest",
     "test": "pnpm run compile && pnpm run _test",
     "prepublishOnly": "pnpm run compile",
     "compile": "tsc --build && pnpm run lint --fix"

diff --git a/pkg-manager/headless/jest.config.js b/pkg-manager/headless/jest.config.js
@@ -1 +1 @@
-module.exports = require('../../jest.config.js')
+module.exports = require('../../jest-with-registry.config.js')
diff --git a/pkg-manager/headless/package.json b/pkg-manager/headless/package.json
@@ -22,7 +22,7 @@
     "@pnpm/package-store": "workspace:*",
     "@pnpm/prepare": "workspace:*",
     "@pnpm/read-projects-context": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@pnpm/store-path": "workspace:*",
     "@pnpm/test-fixtures": "workspace:*",
     "@types/fs-extra": "^9.0.13",
@@ -57,9 +57,7 @@
     "commitmsg": "commitlint -e",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
     "registry-mock": "registry-mock",
-    "test:jest": "jest",
-    "test:e2e": "registry-mock prepare && run-p -r registry-mock test:jest",
-    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7773 pnpm run test:e2e",
+    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7773 jest",
     "test": "pnpm run compile && pnpm run _test",
     "prepublishOnly": "pnpm run compile",
     "runPrepareFixtures": "node ../../pnpm/bin/pnpm.cjs i -r -C test/fixtures --no-shared-workspace-lockfile --no-link-workspace-packages --lockfile-only --registry http://localhost:4873/ --ignore-scripts --force --no-strict-peer-dependencies",
@@ -71,8 +69,8 @@
     "@pnpm/calc-dep-state": "workspace:*",
     "@pnpm/constants": "workspace:*",
     "@pnpm/core-loggers": "workspace:*",
-    "@pnpm/deps.graph-builder": "workspace:*",
     "@pnpm/dependency-path": "workspace:*",
+    "@pnpm/deps.graph-builder": "workspace:*",
     "@pnpm/error": "workspace:*",
     "@pnpm/filter-lockfile": "workspace:*",
     "@pnpm/hoist": "workspace:*",

diff --git a/pkg-manager/package-requester/jest.config.js b/pkg-manager/package-requester/jest.config.js
@@ -1 +1 @@
-module.exports = require('../../jest.config')
+module.exports = require('../../jest-with-registry.config.js')
diff --git a/pkg-manager/package-requester/package.json b/pkg-manager/package-requester/package.json
@@ -14,13 +14,11 @@
   "scripts": {
     "start": "tsc --watch",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
-    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7774 pnpm run test:e2e",
+    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7774 jest",
     "test": "pnpm run compile && pnpm run _test",
     "prepublishOnly": "pnpm run compile",
     "compile": "tsc --build && pnpm run lint --fix",
-    "registry-mock": "registry-mock",
-    "test:jest": "jest",
-    "test:e2e": "registry-mock prepare && run-p -r registry-mock test:jest"
+    "registry-mock": "registry-mock"
   },
   "repository": "https://github.com/pnpm/pnpm/blob/main/pkg-manager/package-requester",
   "keywords": [
@@ -68,7 +66,7 @@
     "@pnpm/client": "workspace:*",
     "@pnpm/create-cafs-store": "workspace:*",
     "@pnpm/package-requester": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@pnpm/test-fixtures": "workspace:*",
     "@types/normalize-path": "^3.0.0",
     "@types/ramda": "0.28.20",

diff --git a/pkg-manager/plugin-commands-installation/jest.config.js b/pkg-manager/plugin-commands-installation/jest.config.js
@@ -1 +1 @@
-module.exports = require('../../jest.config.js')
+module.exports = require('../../jest-with-registry.config.js')
diff --git a/pkg-manager/plugin-commands-installation/package.json b/pkg-manager/plugin-commands-installation/package.json
@@ -15,9 +15,7 @@
     "start": "tsc --watch",
     "lint": "eslint \"src/**/*.ts\" \"test/**/*.ts\"",
     "registry-mock": "registry-mock",
-    "test:jest": "jest",
-    "test:e2e": "registry-mock prepare && run-p -r registry-mock test:jest",
-    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7775 pnpm run test:e2e",
+    "_test": "cross-env PNPM_REGISTRY_MOCK_PORT=7775 jest",
     "test": "pnpm run compile && pnpm run _test",
     "prepublishOnly": "pnpm run compile",
     "compile": "tsc --build && pnpm run lint --fix"
@@ -37,7 +35,7 @@
     "@pnpm/modules-yaml": "workspace:*",
     "@pnpm/plugin-commands-installation": "workspace:*",
     "@pnpm/prepare": "workspace:*",
-    "@pnpm/registry-mock": "3.8.0",
+    "@pnpm/registry-mock": "3.10.2",
     "@pnpm/test-fixtures": "workspace:*",
     "@types/proxyquire": "^1.3.28",
     "@types/ramda": "0.28.20",