Skip to content

The ultimate harness for coding agents and beyond. All your agents. All your machines. One command center. Start with code, then follow your curiosity and build across disciplines: CAD, circuits, robots, games and music.

mujoco-viewer: doctor checks for node; setup runs the smoke checks, npm test the whole suite

dee1b16fb727fad
diff --git a/store/viewers/mujoco-viewer/README.md b/store/viewers/mujoco-viewer/README.md
index 541189d8d..9ff9f1843 100644
--- a/store/viewers/mujoco-viewer/README.md
+++ b/store/viewers/mujoco-viewer/README.md
@@ -86,7 +86,8 @@ Menagerie robots step 20–70× faster than real time in WASM), replay, the chro
so is the scene.
```bash
-npm test # the WASM API the pane depends on, and the server against scratch workspaces
+npm run smoke # what setup.sh runs at install: the WASM API the pane depends on, and the server
+npm test # that, plus every route, start-up variant and script (test/*.test.mjs), on scratch workspaces
./doctor.sh # what is installed
HARNESS_VIEWER_PORT=18997 HARNESS_WORKSPACE=/path/to/workspace \
HARNESS_DSH_DIR=/path/to/autonomous-mujoco ./viewer.sh
diff --git a/store/viewers/mujoco-viewer/doctor.sh b/store/viewers/mujoco-viewer/doctor.sh
index d3173c5da..587fe6c7f 100755
--- a/store/viewers/mujoco-viewer/doctor.sh
+++ b/store/viewers/mujoco-viewer/doctor.sh
@@ -1,6 +1,7 @@
#!/usr/bin/env bash
set -u; cd "$(dirname "$0")"
fail=0
+if command -v node >/dev/null 2>&1 && node -e 'process.exit(Number(process.versions.node.split(".")[0]) >= 18 ? 0 : 1)'; then echo "ok node $(node --version)"; else echo "miss node >= 18 on PATH"; fail=1; fi
if [ -f node_modules/@mujoco/mujoco/mujoco.wasm ]; then echo "ok mujoco $(node -p "require('./node_modules/@mujoco/mujoco/package.json').version") (wasm)"; else echo "miss node_modules/@mujoco/mujoco — run ./setup.sh"; fail=1; fi
if [ -f node_modules/three/build/three.module.js ]; then echo "ok three $(node -p "require('./node_modules/three/package.json').version")"; else echo "miss node_modules/three — run ./setup.sh"; fail=1; fi
if [ -f public/main.js ] && [ -f public/index.html ]; then echo "ok pane (public/)"; else echo "miss public/ — this package is incomplete"; fail=1; fi
diff --git a/store/viewers/mujoco-viewer/package.json b/store/viewers/mujoco-viewer/package.json
index 8be59cdfe..84dc2e74d 100644
--- a/store/viewers/mujoco-viewer/package.json
+++ b/store/viewers/mujoco-viewer/package.json
@@ -4,7 +4,8 @@
"description": "MuJoCo Viewer for Harness: MuJoCo's simulate in the pane — MuJoCo's official WASM build and three.js served from this package",
"license": "MIT",
"scripts": {
- "test": "node test/smoke.mjs && node test/server.mjs"
+ "smoke": "node test/smoke.mjs && node test/server.mjs",
+ "test": "npm run smoke --silent && node --test test/*.test.mjs"
},
"dependencies": {
"@mujoco/mujoco": "3.13.0",
diff --git a/store/viewers/mujoco-viewer/setup.sh b/store/viewers/mujoco-viewer/setup.sh
index 7cf483e2d..a5c10cb31 100755
--- a/store/viewers/mujoco-viewer/setup.sh
+++ b/store/viewers/mujoco-viewer/setup.sh
@@ -8,5 +8,5 @@ command -v npm >/dev/null 2>&1 || { echo "miss npm on PATH"; exit 1; }
npm ci --silent --no-audit --no-fund
[ -f node_modules/@mujoco/mujoco/mujoco.wasm ] || { echo "miss mujoco.wasm after npm ci"; exit 1; }
[ -f node_modules/three/build/three.module.js ] || { echo "miss three after npm ci"; exit 1; }
-npm test --silent
+npm run smoke --silent
echo "ok mujoco $(node -p "require('./node_modules/@mujoco/mujoco/package.json').version") (wasm) · three $(node -p "require('./node_modules/three/package.json').version")"
diff --git a/store/viewers/mujoco-viewer/test/scripts.test.mjs b/store/viewers/mujoco-viewer/test/scripts.test.mjs
new file mode 100644
index 000000000..ffce018fc
--- /dev/null
+++ b/store/viewers/mujoco-viewer/test/scripts.test.mjs
@@ -0,0 +1,120 @@
+// setup.sh, doctor.sh and viewer.sh, each run from a copy of the package in a scratch folder with a
+// PATH that holds only what the case gives it: bash, dirname, and a real, old or missing node and npm.
+// Every line they can print, and the exit code that goes with it.
+//
+// npm test
+import assert from 'node:assert/strict'
+import { spawnSync } from 'node:child_process'
+import { chmodSync, copyFileSync, existsSync, mkdirSync, mkdtempSync, readFileSync, realpathSync, symlinkSync, writeFileSync } from 'node:fs'
+import { tmpdir } from 'node:os'
+import { isAbsolute, join } from 'node:path'
+import { after, test } from 'node:test'
+import { PACKAGE, removeTree, write } from './helpers.mjs'
+
+const root = mkdtempSync(join(tmpdir(), 'mujoco-viewer-scripts-'))
+after(() => removeTree(root))
+
+const which = (tool) => ['/bin', '/usr/bin'].map((dir) => join(dir, tool)).find((path) => existsSync(path))
+const INSTALLED = {
+ 'node_modules/@mujoco/mujoco/mujoco.wasm': 'wasm',
+ 'node_modules/@mujoco/mujoco/package.json': JSON.stringify({ version: '3.13.0' }),
+ 'node_modules/three/build/three.module.js': 'export {}',
+ 'node_modules/three/package.json': JSON.stringify({ version: '0.186.0' }),
+}
+const PANE = { 'public/main.js': '', 'public/index.html': '' }
+
+let cases = 0
+/**
+ * A package copy and its PATH. node: 'real' | 'old' | null. npm: null, or the exit codes of `npm ci`
+ * and `npm run smoke`; the stub logs what it was asked to npm.log in the package.
+ */
+function sandbox({ node = 'real', npm = null, files = {} } = {}) {
+ const dir = join(root, `case-${++cases}`)
+ const pkg = join(dir, 'pkg')
+ const bin = join(dir, 'bin')
+ mkdirSync(pkg, { recursive: true })
+ mkdirSync(bin)
+ for (const script of ['setup.sh', 'doctor.sh', 'viewer.sh']) {
+ copyFileSync(join(PACKAGE, script), join(pkg, script))
+ chmodSync(join(pkg, script), 0o755)
+ }
+ for (const tool of ['bash', 'dirname']) symlinkSync(which(tool), join(bin, tool))
+ if (node === 'real') symlinkSync(process.execPath, join(bin, 'node'))
+ if (node === 'old') writeFileSync(join(bin, 'node'), '#!/bin/sh\nexit 1\n', { mode: 0o755 })
+ if (npm) {
+ writeFileSync(join(bin, 'npm'), `#!/bin/sh\necho "$*" >> npm.log\ncase "$1" in\n ci) exit ${npm.ci} ;;\n run) exit ${npm.smoke} ;;\nesac\nexit 99\n`, { mode: 0o755 })
+ }
+ for (const [rel, body] of Object.entries(files)) write(join(pkg, rel), body)
+ const run = (script, env = {}, cwd = pkg) => {
+ const r = spawnSync(script, [], { cwd, env: { PATH: bin, ...env }, encoding: 'utf8' })
+ return { code: r.status, stdout: r.stdout, stderr: r.stderr, npm: existsSync(join(pkg, 'npm.log')) ? readFileSync(join(pkg, 'npm.log'), 'utf8') : null }
+ }
+ return { dir, pkg, bin, run }
+}
+
+test('setup.sh needs node 18 or newer and npm, before it installs anything', () => {
+ for (const node of [null, 'old']) {
+ const r = sandbox({ node, npm: { ci: 0, smoke: 0 } }).run('./setup.sh')
+ assert.deepEqual([r.code, r.stdout, r.npm], [1, 'miss node >= 18 on PATH\n', null], `node: ${node}`)
+ }
+ const r = sandbox({ npm: null }).run('./setup.sh')
+ assert.deepEqual([r.code, r.stdout], [1, 'miss npm on PATH\n'])
+})
+
+test('setup.sh stops when npm ci fails, and says which dependency npm ci did not deliver', () => {
+ let r = sandbox({ npm: { ci: 3, smoke: 0 } }).run('./setup.sh')
+ assert.deepEqual([r.code, r.stdout, r.npm], [3, '', 'ci --silent --no-audit --no-fund\n'])
+ r = sandbox({ npm: { ci: 0, smoke: 0 } }).run('./setup.sh')
+ assert.deepEqual([r.code, r.stdout], [1, 'miss mujoco.wasm after npm ci\n'])
+ r = sandbox({ npm: { ci: 0, smoke: 0 }, files: { 'node_modules/@mujoco/mujoco/mujoco.wasm': 'wasm' } }).run('./setup.sh')
+ assert.deepEqual([r.code, r.stdout], [1, 'miss three after npm ci\n'])
+})
+
+test('setup.sh runs the install-time smoke checks, not the whole suite, and reports the versions', () => {
+ let r = sandbox({ npm: { ci: 0, smoke: 4 }, files: INSTALLED }).run('./setup.sh')
+ assert.deepEqual([r.code, r.stdout, r.npm], [4, '', 'ci --silent --no-audit --no-fund\nrun smoke --silent\n'])
+ r = sandbox({ npm: { ci: 0, smoke: 0 }, files: INSTALLED }).run('./setup.sh')
+ assert.deepEqual([r.code, r.stdout, r.npm], [0, 'ok mujoco 3.13.0 (wasm) · three 0.186.0\n', 'ci --silent --no-audit --no-fund\nrun smoke --silent\n'])
+ const pkg = JSON.parse(readFileSync(join(PACKAGE, 'package.json'), 'utf8'))
+ assert.equal(pkg.scripts.smoke, 'node test/smoke.mjs && node test/server.mjs', 'what setup runs: the WASM API and the server')
+ assert.match(pkg.scripts.test, /npm run smoke/)
+})
+
+test('doctor.sh: one line per check, exit 0 only when everything is there', () => {
+ let r = sandbox({ files: { ...INSTALLED, ...PANE } }).run('./doctor.sh')
+ assert.equal(r.code, 0)
+ assert.equal(r.stdout, `ok node ${process.version}\nok mujoco 3.13.0 (wasm)\nok three 0.186.0\nok pane (public/)\n`)
+
+ r = sandbox().run('./doctor.sh')
+ assert.equal(r.code, 1)
+ assert.equal(r.stdout, `ok node ${process.version}\nmiss node_modules/@mujoco/mujoco — run ./setup.sh\nmiss node_modules/three — run ./setup.sh\nmiss public/ — this package is incomplete\n`)
+
+ r = sandbox({ files: { ...INSTALLED, 'public/main.js': '' } }).run('./doctor.sh')
+ assert.equal(r.code, 1)
+ assert.match(r.stdout, /\nmiss public\/ — this package is incomplete\n$/)
+
+ // Before the fix the doctor never asked for node, and said ready on a machine the viewer cannot run on.
+ for (const node of [null, 'old']) {
+ r = sandbox({ node, files: { ...INSTALLED, ...PANE } }).run('./doctor.sh')
+ assert.equal(r.code, 1, `node: ${node}`)
+ assert.match(r.stdout, /^miss node >= 18 on PATH\n/, `node: ${node}`)
+ }
+})
+
+test('viewer.sh insists on the port and the workspace, then execs node on the viewer beside it', () => {
+ const box = sandbox()
+ let r = box.run('./viewer.sh', { HARNESS_WORKSPACE: '/tmp' })
+ assert.equal(r.code, 1)
+ assert.match(r.stderr, /HARNESS_VIEWER_PORT: parameter null or not set/)
+ r = box.run('./viewer.sh', { HARNESS_VIEWER_PORT: '18997' })
+ assert.equal(r.code, 1)
+ assert.match(r.stderr, /HARNESS_WORKSPACE: parameter null or not set/)
+
+ writeFileSync(join(box.pkg, 'viewer.mjs'), 'console.log(JSON.stringify({ script: process.argv[1], port: process.env.HARNESS_VIEWER_PORT, workspace: process.env.HARNESS_WORKSPACE }))\n')
+ r = box.run('pkg/viewer.sh', { HARNESS_VIEWER_PORT: '18997', HARNESS_WORKSPACE: '/tmp/ws' }, box.dir)
+ assert.equal(r.code, 0, r.stderr)
+ const seen = JSON.parse(r.stdout)
+ assert.ok(isAbsolute(seen.script), 'the viewer is named by its absolute path, whatever the caller\'s directory')
+ assert.equal(realpathSync(seen.script), realpathSync(join(box.pkg, 'viewer.mjs')))
+ assert.deepEqual([seen.port, seen.workspace], ['18997', '/tmp/ws'])
+})