|
| 1 | +#!/usr/bin/env node |
| 2 | + |
| 3 | +/* |
| 4 | + * Run a WASI-compatible test program in the browser. |
| 5 | + * |
| 6 | + * This script behaves like `wasmtime` but runs given WASI-compatible test |
| 7 | + * program in the browser. |
| 8 | + * |
| 9 | + * Example: |
| 10 | + * $ ./harness.mjs check.wasm |
| 11 | + */ |
| 12 | + |
| 13 | +import { parseArgs } from 'node:util'; |
| 14 | +import { createServer } from 'node:http'; |
| 15 | +import { fileURLToPath } from 'node:url'; |
| 16 | +import { dirname, join } from 'node:path'; |
| 17 | +import { readFileSync } from 'node:fs'; |
| 18 | +import url from "node:url"; |
| 19 | +import { chromium } from 'playwright'; |
| 20 | + |
| 21 | +const SKIP_TESTS = [ |
| 22 | + // "poll_oneoff" can't be implemented in the browser |
| 23 | + "libc-test/functional/pthread_cond", |
| 24 | + // atomic.wait32 can't be executed on the main thread |
| 25 | + "libc-test/functional/pthread_mutex", |
| 26 | + "libc-test/functional/pthread_tsd", |
| 27 | + // XFAIL: https://github.com/bjorn3/browser_wasi_shim/pull/86 |
| 28 | + "misc/fts", |
| 29 | +]; |
| 30 | + |
| 31 | +/** |
| 32 | + * @param {{wasmPath: string, port: number}} |
| 33 | + * @returns {Promise<{server: import('node:http').Server, port: number}>} |
| 34 | + */ |
| 35 | +async function startServer({ wasmPath, port }) { |
| 36 | + const server = createServer((req, res) => { |
| 37 | + // Set required headers for SharedArrayBuffer |
| 38 | + res.setHeader('Cross-Origin-Opener-Policy', 'same-origin'); |
| 39 | + res.setHeader('Cross-Origin-Embedder-Policy', 'require-corp'); |
| 40 | + |
| 41 | + let filePath; |
| 42 | + const parsed = url.parse(req.url, true); |
| 43 | + const pathname = parsed.pathname; |
| 44 | + if (pathname === "/target.wasm") { |
| 45 | + // Serve the test target Wasm file |
| 46 | + filePath = wasmPath; |
| 47 | + res.setHeader('Content-Type', 'application/wasm'); |
| 48 | + } else { |
| 49 | + // Serve other resources |
| 50 | + const __dirname = dirname(fileURLToPath(import.meta.url)); |
| 51 | + filePath = join(__dirname, pathname); |
| 52 | + const contentTypes = { |
| 53 | + "mjs": "text/javascript", |
| 54 | + "js": "text/javascript", |
| 55 | + "html": "text/html", |
| 56 | + } |
| 57 | + res.setHeader('Content-Type', contentTypes[pathname.split('.').pop()] || 'text/plain'); |
| 58 | + } |
| 59 | + |
| 60 | + try { |
| 61 | + const content = readFileSync(filePath); |
| 62 | + res.end(content); |
| 63 | + } catch (error) { |
| 64 | + res.statusCode = 404; |
| 65 | + res.end('Not found'); |
| 66 | + } |
| 67 | + }); |
| 68 | + |
| 69 | + return new Promise((resolve) => { |
| 70 | + server.listen(port, () => { |
| 71 | + const port = server.address().port; |
| 72 | + resolve({ server, port }); |
| 73 | + }); |
| 74 | + }); |
| 75 | +} |
| 76 | + |
| 77 | +/** @param {number} port */ |
| 78 | +function buildUrl(port) { |
| 79 | + return `http://localhost:${port}/run-test.html`; |
| 80 | +} |
| 81 | + |
| 82 | +/** @param {import('playwright').Page} page */ |
| 83 | +/** @param {number} port */ |
| 84 | +/** @returns {Promise<{passed: boolean, error?: string}>} */ |
| 85 | +async function runTest(page, port) { |
| 86 | + const url = buildUrl(port); |
| 87 | + const onExit = new Promise((resolve) => { |
| 88 | + page.exposeFunction("exitTest", resolve); |
| 89 | + }); |
| 90 | + await page.goto(url); |
| 91 | + return onExit; |
| 92 | +} |
| 93 | + |
| 94 | +async function main() { |
| 95 | + // Parse and interpret a subset of the wasmtime CLI options used by the tests |
| 96 | + const args = parseArgs({ |
| 97 | + args: process.argv.slice(2), |
| 98 | + allowPositionals: true, |
| 99 | + options: { |
| 100 | + // MARK: wasmtime CLI options |
| 101 | + wasi: { |
| 102 | + type: "string", |
| 103 | + multiple: true, |
| 104 | + }, |
| 105 | + dir: { |
| 106 | + type: "string", |
| 107 | + multiple: true, |
| 108 | + }, |
| 109 | + // MARK: For debugging purposes |
| 110 | + headful: { |
| 111 | + type: "boolean", |
| 112 | + default: false, |
| 113 | + }, |
| 114 | + port: { |
| 115 | + type: "string", |
| 116 | + default: "0", |
| 117 | + } |
| 118 | + } |
| 119 | + }); |
| 120 | + |
| 121 | + const wasmPath = args.positionals[0]; |
| 122 | + if (!wasmPath) { |
| 123 | + console.error('Test path not specified'); |
| 124 | + return 1; |
| 125 | + } |
| 126 | + |
| 127 | + if (SKIP_TESTS.some(test => wasmPath.includes(test + "."))) { |
| 128 | + // Silently skip tests that are known to fail in the browser |
| 129 | + return 0; |
| 130 | + } |
| 131 | + |
| 132 | + // Start a HTTP server to serve the test files |
| 133 | + const { server, port } = await startServer({ wasmPath, port: parseInt(args.values.port) }); |
| 134 | + |
| 135 | + const browser = await chromium.launch(); |
| 136 | + const page = await browser.newPage(); |
| 137 | + |
| 138 | + try { |
| 139 | + if (args.values.headful) { |
| 140 | + // Run in headful mode to allow manual testing |
| 141 | + console.log(`Please visit ${buildUrl(port)}`); |
| 142 | + console.log('Press Ctrl+C to stop'); |
| 143 | + await new Promise(resolve => process.on('SIGINT', resolve)); |
| 144 | + return 0; |
| 145 | + } |
| 146 | + |
| 147 | + // Run in headless mode |
| 148 | + const result = await runTest(page, port); |
| 149 | + if (!result.passed) { |
| 150 | + console.error('Test failed:', result.error); |
| 151 | + console.error(`Hint: You can debug the test by running it in headful mode by passing --headful |
| 152 | +$ ${process.argv.join(' ')} --headful`); |
| 153 | + return 1; |
| 154 | + } |
| 155 | + return 0; |
| 156 | + } catch (error) { |
| 157 | + console.error('Test failed:', error); |
| 158 | + return 1; |
| 159 | + } finally { |
| 160 | + await browser.close(); |
| 161 | + server.close(); |
| 162 | + } |
| 163 | +} |
| 164 | + |
| 165 | +process.exit(await main()); |
0 commit comments