Update test scripts to match MetaMask/core (#2745)

This updates the test scripts to match the scripts in `MetaMask/core`.
Primarily, it introduces a couple new test scripts:

- `test`: Runs Jest with `jest-silent-reporter` to only show failed
tests.
- `test:clean`: Clears the Jest cache before running tests.
- `test:verbose`: Runs Jest with verbose logging.
- `test:watch`: Runs Jest in watch mode.

Author: Mrtenz

.github/workflows/build-lint-test.yml

@@ -217,7 +217,7 @@ jobs:
         run: yarn install-chrome
       - run: yarn workspace @metamask/snaps-sdk run build
         if: ${{ matrix.package-name == '@metamask/snaps-cli' }}
-      - run: yarn workspace ${{ matrix.package-name }} run test:ci
+      - run: yarn workspace ${{ matrix.package-name }} run test
       - name: Get coverage folder
         id: get-coverage-folder
         run: |
@@ -296,7 +296,7 @@ jobs:
       - name: Build snap
         run: yarn workspace ${{ matrix.package-name }} run build
       - name: Run E2E test
-        run: yarn workspace ${{ matrix.package-name }} run test:e2e
+        run: yarn workspace ${{ matrix.package-name }} run test
       - name: Require clean working directory
         shell: bash
         run: |

.yarn/plugins/local/plugin-lifecycle-scripts.js

@@ -0,0 +1,77 @@
+// @ts-check
+
+/**
+ * Run an array of tasks in sequence.
+ *
+ * @param tasks {Array<() => Promise<number>>} - An array of functions that
+ * return a promise that resolves to an exit code.
+ * @returns {Promise<number>} - The exit code of the first task that returns a
+ * non-zero exit code, or 0 if all tasks return 0.
+ */
+async function sequence(tasks) {
+  for (const task of tasks) {
+    const exitCode = await task();
+
+    if (exitCode !== 0) {
+      return exitCode;
+    }
+  }
+
+  return 0;
+}
+
+/**
+ * Run a lifecycle script.
+ *
+ * @param {import('@yarnpkg/core').Workspace} workspace - The workspace to run
+ * the script in.
+ * @param {string} scriptName - The name of the script to run.
+ * @param {Record<string, *>} extra - Extra options to pass to the execute
+ * function.
+ * @param {Function} require - The require function to use.
+ */
+function getLifecycleTask(workspace, scriptName, { stderr, stdin, stdout }, require) {
+  const { scriptUtils } = require('@yarnpkg/core');
+
+  return async () => {
+    if (scriptUtils.hasWorkspaceScript(workspace, scriptName)) {
+      return scriptUtils.executeWorkspaceScript(workspace, scriptName, [], {
+        cwd: workspace.cwd,
+        stderr,
+        stdin,
+        stdout,
+      });
+    }
+
+    return 0;
+  };
+}
+
+/**
+ * A Yarn plugin that calls lifecycle scripts before and after running a script.
+ * The scripts are expected to be named `${scriptName}:pre` and
+ * `${scriptName}:post`.
+ *
+ * @type {import('@yarnpkg/core').PluginConfiguration}
+ */
+module.exports = {
+  name: 'plugin-lifecycle-scripts',
+  factory: (require) => {
+    return {
+      default: {
+        hooks: {
+          wrapScriptExecution: async (script, project, locator, scriptName, extra) => {
+            return async () => {
+              const workspace = project.getWorkspaceByLocator(locator);
+              return await sequence([
+                getLifecycleTask(workspace, `${scriptName}:pre`, extra, require),
+                script,
+                getLifecycleTask(workspace, `${scriptName}:post`, extra, require),
+              ])
+            };
+          }
+        }
+      }
+    }
+  }
+};

.yarnrc.yml

@@ -21,5 +21,6 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-allow-scripts.cjs
     spec: 'https://raw.githubusercontent.com/LavaMoat/LavaMoat/main/packages/yarn-plugin-allow-scripts/bundles/@yarnpkg/plugin-allow-scripts.js'
   - path: .yarn/plugins/local/plugin-workspaces-filter.js
+  - path: .yarn/plugins/local/plugin-lifecycle-scripts.js
 
 yarnPath: .yarn/releases/yarn-4.4.1.cjs

constraints.pro

@@ -255,6 +255,41 @@ gen_enforced_field(WorkspaceCwd, 'scripts.changelog:update', ChangelogUpdateScri
 gen_enforced_field(WorkspaceCwd, 'scripts.lint:dependencies', 'depcheck') :-
   WorkspaceCwd \= '.'.
 
+% The test scripts must be the same for all packages.
+gen_enforced_field(WorkspaceCwd, 'scripts.test', 'jest --reporters=jest-silent-reporter') :-
+  WorkspaceCwd \= '.',
+  WorkspaceCwd \= 'packages/snaps-controllers',
+  WorkspaceCwd \= 'packages/snaps-execution-environments',
+  WorkspaceCwd \= 'packages/snaps-utils',
+  \+ is_example(WorkspaceCwd).
+gen_enforced_field(WorkspaceCwd, 'scripts.test', 'jest --reporters=jest-silent-reporter && yarn test:browser') :-
+  WorkspaceCwd == 'packages/snaps-controllers'.
+gen_enforced_field(WorkspaceCwd, 'scripts.test', 'jest --reporters=jest-silent-reporter && yarn test:browser') :-
+  WorkspaceCwd == 'packages/snaps-execution-environments'.
+gen_enforced_field(WorkspaceCwd, 'scripts.test', 'jest --reporters=jest-silent-reporter && yarn test:browser') :-
+  WorkspaceCwd == 'packages/snaps-utils'.
+gen_enforced_field(WorkspaceCwd, 'scripts.test:clean', 'jest --clearCache') :-
+  WorkspaceCwd \= '.',
+  \+ is_example(WorkspaceCwd).
+gen_enforced_field(WorkspaceCwd, 'scripts.test:verbose', 'jest --verbose') :-
+  WorkspaceCwd \= '.',
+  \+ is_example(WorkspaceCwd).
+gen_enforced_field(WorkspaceCwd, 'scripts.test:watch', 'jest --watch') :-
+  WorkspaceCwd \= '.',
+  \+ is_example(WorkspaceCwd).
+gen_enforced_field(WorkspaceCwd, 'scripts.test:post', 'jest-it-up') :-
+  WorkspaceCwd \= '.',
+  WorkspaceCwd \= 'packages/snaps-controllers',
+  WorkspaceCwd \= 'packages/snaps-execution-environments',
+  WorkspaceCwd \= 'packages/snaps-utils',
+  \+ is_example(WorkspaceCwd).
+gen_enforced_field(WorkspaceCwd, 'scripts.test:post', 'ts-node scripts/coverage.ts && rimraf coverage/jest coverage/wdio') :-
+  WorkspaceCwd == 'packages/snaps-controllers'.
+gen_enforced_field(WorkspaceCwd, 'scripts.test:post', 'ts-node scripts/coverage.ts && rimraf coverage/jest coverage/wdio') :-
+  WorkspaceCwd == 'packages/snaps-execution-environments'.
+gen_enforced_field(WorkspaceCwd, 'scripts.test:post', 'ts-node scripts/coverage.ts && rimraf coverage/jest coverage/wdio') :-
+  WorkspaceCwd == 'packages/snaps-utils'.
+
 % The "engines.node" field must be the same for all packages.
 gen_enforced_field(WorkspaceCwd, 'engines.node', '^18.16 || >=20').
 
@@ -276,9 +311,13 @@ gen_enforced_field(WorkspaceCwd, 'scripts.start', 'mm-snap watch') :-
   WorkspaceCwd \= 'packages/examples/packages/webpack-plugin'.
 gen_enforced_field(WorkspaceCwd, 'scripts.clean', 'rimraf "dist"') :-
   is_example(WorkspaceCwd).
-gen_enforced_field(WorkspaceCwd, 'scripts.test', 'yarn test:e2e') :-
+gen_enforced_field(WorkspaceCwd, 'scripts.test', 'jest --reporters=jest-silent-reporter') :-
+  is_example(WorkspaceCwd).
+gen_enforced_field(WorkspaceCwd, 'scripts.test:clean', 'jest --clearCache') :-
+  is_example(WorkspaceCwd).
+gen_enforced_field(WorkspaceCwd, 'scripts.test:verbose', 'jest --verbose') :-
   is_example(WorkspaceCwd).
-gen_enforced_field(WorkspaceCwd, 'scripts.test:e2e', 'jest') :-
+gen_enforced_field(WorkspaceCwd, 'scripts.test:watch', 'jest --watch') :-
   is_example(WorkspaceCwd).
 gen_enforced_field(WorkspaceCwd, 'scripts.lint', 'yarn lint:eslint && yarn lint:misc --check && yarn changelog:validate && yarn lint:dependencies') :-
   is_example(WorkspaceCwd).

package.json

@@ -31,7 +31,9 @@
     "publish-previews": "yarn workspaces foreach --all --parallel --verbose run publish:preview",
     "test": "yarn workspaces foreach --all --parallel --verbose run test",
     "test:browser": "yarn workspaces foreach --all --verbose run test:browser",
-    "test:e2e": "yarn workspaces foreach --all --verbose --exclude root run test:e2e",
+    "test:clean": "yarn workspaces foreach --all --parallel --verbose run test:clean",
+    "test:verbose": "yarn workspaces foreach --all --parallel --verbose run test:verbose",
+    "test:watch": "yarn workspaces foreach --all --parallel --verbose run test:watch",
     "update-readme-content": "tsx ./scripts/update-readme-content.mts"
   },
   "simple-git-hooks": {
@@ -95,6 +97,7 @@
     "favicons": "^7.1.2",
     "geckodriver": "^4.2.0",
     "jest": "^29.0.2",
+    "jest-silent-reporter": "^0.6.0",
     "lint-staged": "^12.4.1",
     "minimatch": "^7.4.1",
     "prettier": "^2.8.8",

packages/create-snap/.depcheckrc.json

@@ -10,6 +10,7 @@
     "@typescript-eslint/*",
     "eslint-config-*",
     "eslint-plugin-*",
+    "jest-silent-reporter",
     "prettier-plugin-packagejson",
     "ts-node",
     "typedoc",

packages/create-snap/package.json

@@ -43,10 +43,11 @@
     "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" --ignore-path ../../.gitignore",
     "publish:package": "../../scripts/publish-package.sh",
     "publish:preview": "yarn npm publish --tag preview",
-    "test": "jest && yarn posttest",
-    "posttest": "jest-it-up",
-    "test:ci": "yarn test",
-    "test:watch": "yarn test --watch"
+    "test": "jest --reporters=jest-silent-reporter",
+    "test:clean": "jest --clearCache",
+    "test:post": "jest-it-up",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
   },
   "dependencies": {
     "@metamask/snaps-utils": "workspace:^",
@@ -80,6 +81,7 @@
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.0.2",
     "jest-it-up": "^2.0.0",
+    "jest-silent-reporter": "^0.6.0",
     "memfs": "^3.4.13",
     "prettier": "^2.8.8",
     "prettier-plugin-packagejson": "^2.5.2",

packages/examples/.depcheckrc.json

@@ -9,6 +9,7 @@
     "@typescript-eslint/*",
     "eslint-config-*",
     "eslint-plugin-*",
+    "jest-silent-reporter",
     "prettier-plugin-packagejson",
     "ts-node",
     "typedoc",

packages/examples/package.json

@@ -24,7 +24,11 @@
     "lint:misc": "prettier --no-error-on-unmatched-pattern --loglevel warn \"**/*.json\" \"**/*.md\" \"**/*.html\" \"!CHANGELOG.md\" \"!packages/**\" --ignore-path ../../.gitignore",
     "start": "yarn workspaces foreach --worktree --parallel --verbose --interlaced --no-private --jobs unlimited run start",
     "start:test": "yarn start",
-    "test": "yarn workspaces foreach --worktree --parallel --verbose --interlaced --no-private run test"
+    "test": "jest --reporters=jest-silent-reporter",
+    "test:clean": "jest --clearCache",
+    "test:post": "jest-it-up",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
   },
   "devDependencies": {
     "@lavamoat/allow-scripts": "^3.0.4",
@@ -44,6 +48,7 @@
     "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-promise": "^6.1.1",
+    "jest-silent-reporter": "^0.6.0",
     "prettier": "^2.8.8",
     "prettier-plugin-packagejson": "^2.5.2",
     "ts-node": "^10.9.1",

packages/examples/packages/bip32/.depcheckrc.json

@@ -9,6 +9,7 @@
     "@typescript-eslint/*",
     "eslint-config-*",
     "eslint-plugin-*",
+    "jest-silent-reporter",
     "prettier-plugin-packagejson",
     "ts-node",
     "typedoc",