Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use Vitest for snaps-execution-environments browser tests #3236

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Use Vitest for snaps-execution-environments browser tests #3236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e67fbe
Use Vitest for `snaps-execution-environments` browser tests
Mrtenz Mar 14, 2025
bc151a3
Update LavaMoat policy
Mrtenz Mar 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/build-lint-test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,11 @@ jobs:
with:
name: build-source-${{ runner.os }}-${{ github.sha }}
- name: Install Google Chrome
if: ${{ matrix.package-name == '@metamask/snaps-controllers' || matrix.package-name == '@metamask/snaps-execution-environments' || matrix.package-name == '@metamask/snaps-utils' }}
if: ${{ matrix.package-name == '@metamask/snaps-controllers' || matrix.package-name == '@metamask/snaps-utils' }}
run: yarn install-chrome
- name: Install Chromium
if: ${{ matrix.package-name == '@metamask/snaps-execution-environments' }}
run: yarn playwright install --with-deps
- run: yarn workspace ${{ matrix.package-name }} run test
- name: Get coverage folder
id: get-coverage-folder
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@
"lint-staged": "^12.4.1",
"lodash": "^4.17.21",
"minimatch": "^7.4.1",
"playwright": "^1.51.0",
"prettier": "^3.3.3",
"prettier-2": "npm:prettier@^2.8.8",
"prettier-plugin-packagejson": "^2.5.8",
Expand Down
1 change: 0 additions & 1 deletion packages/snaps-controllers/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,6 @@
"@wdio/static-server-service": "^8.19.0",
"deepmerge": "^4.2.2",
"depcheck": "^1.4.7",
"esbuild": "^0.18.10",
"eslint": "^9.11.0",
"expect-webdriverio": "^4.4.1",
"istanbul-lib-coverage": "^3.2.0",
Expand Down
8 changes: 4 additions & 4 deletions packages/snaps-execution-environments/coverage.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"branches": 80.53,
"functions": 88.96,
"lines": 90.69,
"statements": 89.74
"branches": 88.88,
"functions": 83.94,
"lines": 80.27,
"statements": 79.98
}
32 changes: 16 additions & 16 deletions packages/snaps-execution-environments/lavamoat/browserify/node-process/policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,21 +143,6 @@
"TextEncoder": true
}
},
"@wdio/mocha-framework>mocha>supports-color": {
"builtin": {
"os.release": true,
"tty.isatty": true
},
"globals": {
"process.env": true,
"process.platform": true
},
"packages": {
"istanbul-lib-report>supports-color>has-flag": true,
"os": true,
"tty": true
}
},
"browserify>browser-pack>safe-buffer": {
"builtin": {
"buffer": true
Expand Down Expand Up @@ -200,8 +185,8 @@
"process": true
},
"packages": {
"@wdio/mocha-framework>mocha>supports-color": true,
"eslint>debug>ms": true,
"jest>@jest/core>jest-runner>jest-worker>supports-color": true,
"tty": true,
"util": true
}
Expand All @@ -211,6 +196,21 @@
"process.argv": true
}
},
"jest>@jest/core>jest-runner>jest-worker>supports-color": {
"builtin": {
"os.release": true,
"tty.isatty": true
},
"globals": {
"process.env": true,
"process.platform": true
},
"packages": {
"istanbul-lib-report>supports-color>has-flag": true,
"os": true,
"tty": true
}
},
"readable-stream": {
"builtin": {
"buffer.Buffer": true,
Expand Down
32 changes: 16 additions & 16 deletions packages/snaps-execution-environments/lavamoat/browserify/node-thread/policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,21 +143,6 @@
"TextEncoder": true
}
},
"@wdio/mocha-framework>mocha>supports-color": {
"builtin": {
"os.release": true,
"tty.isatty": true
},
"globals": {
"process.env": true,
"process.platform": true
},
"packages": {
"istanbul-lib-report>supports-color>has-flag": true,
"os": true,
"tty": true
}
},
"browserify>browser-pack>safe-buffer": {
"builtin": {
"buffer": true
Expand Down Expand Up @@ -200,8 +185,8 @@
"process": true
},
"packages": {
"@wdio/mocha-framework>mocha>supports-color": true,
"eslint>debug>ms": true,
"jest>@jest/core>jest-runner>jest-worker>supports-color": true,
"tty": true,
"util": true
}
Expand All @@ -211,6 +196,21 @@
"process.argv": true
}
},
"jest>@jest/core>jest-runner>jest-worker>supports-color": {
"builtin": {
"os.release": true,
"tty.isatty": true
},
"globals": {
"process.env": true,
"process.platform": true
},
"packages": {
"istanbul-lib-report>supports-color>has-flag": true,
"os": true,
"tty": true
}
},
"readable-stream": {
"builtin": {
"buffer.Buffer": true,
Expand Down
72 changes: 31 additions & 41 deletions packages/snaps-execution-environments/lavamoat/build-system/policy.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,10 @@
"define": true
},
"packages": {
"@babel/core>@ampproject/remapping>@jridgewell/gen-mapping": true,
"terser>@jridgewell/source-map>@jridgewell/gen-mapping": true,
"terser>@jridgewell/source-map>@jridgewell/trace-mapping": true
}
},
"@babel/core>@ampproject/remapping>@jridgewell/gen-mapping": {
"globals": {
"define": true
},
"packages": {
"terser>@jridgewell/source-map>@jridgewell/gen-mapping>@jridgewell/set-array": true,
"terser>@jridgewell/source-map>@jridgewell/gen-mapping>@jridgewell/sourcemap-codec": true
}
},
"@babel/core>@babel/code-frame": {
"globals": {
"console.warn": true,
Expand Down Expand Up @@ -227,11 +218,10 @@
"@babel/core>@babel/types": {
"globals": {
"console.warn": true,
"process.env.BABEL_TYPES_8_BREAKING": true
"process.env": true
},
"packages": {
"@babel/core>@babel/types>@babel/helper-string-parser": true,
"@babel/core>@babel/types>to-fast-properties": true,
"lavamoat>@babel/highlight>@babel/helper-validator-identifier": true
}
},
Expand Down Expand Up @@ -830,7 +820,7 @@
"util.inherits": true
},
"packages": {
"@babel/preset-env>@babel/plugin-transform-regenerator>regenerator-transform>@babel/runtime": true
"@vitest/browser>@testing-library/user-event>@testing-library/dom>@babel/runtime": true
}
},
"@babel/preset-env>@babel/plugin-transform-reserved-words": {
Expand Down Expand Up @@ -1104,19 +1094,6 @@
"TextEncoder": true
}
},
"@wdio/mocha-framework>mocha>supports-color": {
"builtin": {
"os.release": true,
"tty.isatty": true
},
"globals": {
"process.env": true,
"process.platform": true
},
"packages": {
"istanbul-lib-report>supports-color>has-flag": true
}
},
"babel-plugin-tsconfig-paths-module-resolver": {
"builtin": {
"path": true
Expand Down Expand Up @@ -2040,8 +2017,8 @@
"process": true
},
"packages": {
"@wdio/mocha-framework>mocha>supports-color": true,
"eslint>debug>ms": true
"eslint>debug>ms": true,
"jest>@jest/core>jest-runner>jest-worker>supports-color": true
}
},
"eslint>espree>acorn-jsx": {
Expand All @@ -2061,6 +2038,19 @@
"process.argv": true
}
},
"jest>@jest/core>jest-runner>jest-worker>supports-color": {
"builtin": {
"os.release": true,
"tty.isatty": true
},
"globals": {
"process.env": true,
"process.platform": true
},
"packages": {
"istanbul-lib-report>supports-color>has-flag": true
}
},
"jest>@jest/core>strip-ansi": {
"packages": {
"@types/jest>pretty-format>ansi-regex": true
Expand Down Expand Up @@ -2339,8 +2329,8 @@
"console.log": true
},
"packages": {
"depcheck>@babel/parser": true,
"depcheck>@babel/traverse": true
"depcheck>@babel/traverse": true,
"lavamoat>lavamoat-tofu>@babel/parser": true
}
},
"readable-stream": {
Expand Down Expand Up @@ -2395,29 +2385,22 @@
},
"packages": {
"terser>@jridgewell/source-map>@jridgewell/gen-mapping>@jridgewell/set-array": true,
"terser>@jridgewell/source-map>@jridgewell/gen-mapping>@jridgewell/sourcemap-codec": true,
"terser>@jridgewell/source-map>@jridgewell/trace-mapping": true
"terser>@jridgewell/source-map>@jridgewell/trace-mapping": true,
"vitest>magic-string>@jridgewell/sourcemap-codec": true
}
},
"terser>@jridgewell/source-map>@jridgewell/gen-mapping>@jridgewell/set-array": {
"globals": {
"define": true
}
},
"terser>@jridgewell/source-map>@jridgewell/gen-mapping>@jridgewell/sourcemap-codec": {
"globals": {
"Buffer": true,
"TextDecoder": true,
"define": true
}
},
"terser>@jridgewell/source-map>@jridgewell/trace-mapping": {
"globals": {
"define": true
},
"packages": {
"terser>@jridgewell/source-map>@jridgewell/gen-mapping>@jridgewell/sourcemap-codec": true,
"terser>@jridgewell/source-map>@jridgewell/trace-mapping>@jridgewell/resolve-uri": true
"terser>@jridgewell/source-map>@jridgewell/trace-mapping>@jridgewell/resolve-uri": true,
"vitest>magic-string>@jridgewell/sourcemap-codec": true
}
},
"terser>@jridgewell/source-map>@jridgewell/trace-mapping>@jridgewell/resolve-uri": {
Expand All @@ -2441,6 +2424,13 @@
"process": true
}
},
"vitest>magic-string>@jridgewell/sourcemap-codec": {
"globals": {
"Buffer": true,
"TextDecoder": true,
"define": true
}
},
"yargs": {
"builtin": {
"assert.notStrictEqual": true,
Expand Down
18 changes: 6 additions & 12 deletions packages/snaps-execution-environments/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
"since-latest-release": "../../scripts/since-latest-release.sh",
"start": "node scripts/start.js",
"test": "jest --reporters=jest-silent-reporter && yarn test:browser",
"test:browser": "wdio run wdio.config.js",
"test:browser": "vitest",
"test:clean": "jest --clearCache",
"test:post": "ts-node scripts/coverage.ts && rimraf coverage/jest coverage/wdio",
"test:verbose": "jest --verbose",
Expand Down Expand Up @@ -92,20 +92,15 @@
"@types/express": "^4.17.17",
"@types/jest": "^27.5.1",
"@types/node": "18.14.2",
"@wdio/browser-runner": "^8.19.0",
"@wdio/cli": "^8.19.0",
"@wdio/globals": "^8.19.0",
"@wdio/mocha-framework": "^8.19.0",
"@wdio/spec-reporter": "^8.19.0",
"@wdio/static-server-service": "^8.19.0",
"@vitest/browser": "^3.0.8",
"@vitest/coverage-istanbul": "3.0.8",
"@vitest/coverage-v8": "^3.0.8",
"babel-plugin-tsconfig-paths-module-resolver": "^1.0.4",
"babelify": "^10.0.0",
"browserify": "^17.0.0",
"deepmerge": "^4.2.2",
"depcheck": "^1.4.7",
"esbuild": "^0.18.10",
"eslint": "^9.11.0",
"expect-webdriverio": "^4.4.1",
"istanbul-lib-coverage": "^3.2.0",
"istanbul-lib-report": "^3.0.0",
"istanbul-reports": "^3.1.5",
Expand All @@ -115,6 +110,7 @@
"jest-silent-reporter": "^0.6.0",
"lavamoat": "^8.0.4",
"lavamoat-browserify": "^17.0.5",
"playwright": "^1.51.0",
"prettier": "^3.3.3",
"rimraf": "^4.1.2",
"serve-handler": "^6.1.5",
Expand All @@ -124,9 +120,7 @@
"typescript": "~5.3.3",
"vite": "^4.5.6",
"vite-tsconfig-paths": "^4.0.5",
"wdio-chromedriver-service": "^8.1.1",
"wdio-geckodriver-service": "^5.0.2",
"webdriverio": "^8.19.0",
"vitest": "^3.0.8",
"yargs": "^17.7.1"
},
"engines": {
Expand Down
17 changes: 9 additions & 8 deletions packages/snaps-execution-environments/scripts/coverage.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ const JEST_COVERAGE_FILE = resolve(
'coverage-final.json',
);

const WDIO_COVERAGE_FILE = resolve(
const VITE_COVERAGE_FILE = resolve(
COVERAGE_PATH,
'wdio',
'vite',
'coverage-final.json',
);

Expand Down Expand Up @@ -54,23 +54,24 @@ function generateSummaryReport<Report extends ReportType>(
}

/**
* Merge the coverage reports from Jest and WebdriverIO. This checks if the
* coverage for a given file is higher in WebdriverIO than in Jest. If it is,
* it replaces the Jest coverage with the WebdriverIO coverage.
* Merge the coverage reports from Jest and Vite. This checks if the coverage
* for a given file is higher in Vite than in Jest. If it is, it replaces the
* Jest coverage with the Vite coverage.
*
* This is a workaround for WebdriverIO's coverage reporting having inaccurate
* line numbers.
* This is a workaround for Vite's coverage reporting having inaccurate line
* numbers.
*
* @returns The summary of the merged coverage.
*/
// TODO: Check if Vite's coverage is actually inaccurate.
async function mergeReports() {
const jestMap = await fs
.readFile(JEST_COVERAGE_FILE, 'utf8')
.then(JSON.parse)
.then(createCoverageMap);

const wdioMap = await fs
.readFile(WDIO_COVERAGE_FILE, 'utf8')
.readFile(VITE_COVERAGE_FILE, 'utf8')
.then(JSON.parse)
.then(createCoverageMap);

Expand Down
Loading
Loading