Testee Client Quickstart

{"id":15856,"library":"testee-client","title":"Testee Client Adapters","description":"testee-client is a client-side library providing adapters for popular JavaScript testing frameworks such as Mocha, QUnit (versions 1 and 2), and Jasmine (versions 1 and 2). It functions by converting test results from these frameworks into Feathers service calls for `runs`, `suites`, `tests`, and `coverages`, which are then reported to a `testee` runner server. The current stable version is 0.5.6. The package appears to be in a maintenance phase, with releases addressing specific environment conflicts or improving existing integrations rather than introducing major new features. Its primary role is to bridge the gap between in-browser test execution and a centralized reporting server, allowing for custom configuration of the base URL, communication provider (sockets or REST), and even custom socket instances. It requires manual initialization (`window.Testee.init()`) in environments where test files are loaded asynchronously to prevent test runners from executing prematurely.","status":"maintenance","version":"0.5.6","language":"javascript","source_language":"en","source_url":"https://github.com/bitovi/testee-client","tags":["javascript","testing","qunit","mocha","jasmine","testee"],"install":[{"cmd":"npm install testee-client","lang":"bash","label":"npm"},{"cmd":"yarn add testee-client","lang":"bash","label":"yarn"},{"cmd":"pnpm add testee-client","lang":"bash","label":"pnpm"}],"dependencies":[],"imports":[{"note":"The library is primarily consumed as a global `window.Testee` object after being loaded via a \n"},{"note":"This method is called to initialize the client adapters, especially crucial when test files are loaded asynchronously to prevent test frameworks from running prematurely. Ensure `window.Testee` exists before calling.","wrong":"Testee.init() // Called before testee-client.js is loaded or if Testee is not on window","symbol":"Testee.init","correct":"\n"},{"note":"Direct API calls like `Testee.start`, `Testee.suite`, `Testee.pass`, and `Testee.fail` are exposed globally for manual test flow reporting. These are typically used internally by framework adapters or for implementing custom test runners, and require `testee-client.js` to be loaded.","wrong":"const { start } = require('testee-client'); start(...)","symbol":"Testee.start","correct":"Testee.start({\n id: 'some-unique-run-id',\n environment: navigator.userAgent,\n runner: 'Mocha',\n framework: 'mocha'\n});"}],"quickstart":{"code":"\n\n\n\n Testee Client Quickstart\n \n \n \n \n \n\n\n

\n \n\n","lang":"javascript","description":"This quickstart demonstrates how to include `testee-client.js` in an HTML page, configure `window.Testee` options, and manually initialize it within a Mocha test setup that simulates asynchronous test loading. It includes basic manual reporting via the `Testee` API."},"warnings":[{"fix":"Upgrade to `testee-client@0.5.3` or a later version to ensure all necessary distribution files are present.","message":"Version 0.5.2 was a faulty release distributed without the required `dist/` folder, rendering the package unusable if installed. Users attempting to use this specific version will encounter file not found errors.","severity":"breaking","affected_versions":"=0.5.2"},{"fix":"Upgrade to `testee-client@0.5.6` which includes a rebuilt distribution specifically addressing and resolving this conflicting `steal-tools` process shim.","message":"In version 0.5.6, a conflict was identified where `steal-tools`'s process shim could inadvertently override `testee-client`'s intended process shim. This led to incorrect `process.cwd()` results (e.g., returning an empty string instead of `/`) in certain build environments, specifically affecting projects using StealJS.","severity":"gotcha","affected_versions":"<=0.5.5"},{"fix":"For QUnit, set `QUnit.config.autorun = false;`. For other frameworks, ensure the framework's `run` method is called only after your test files are ready and `window.Testee.init()` has been explicitly invoked. Refer to framework-specific asynchronous loading examples in the documentation.","message":"When integrating `testee-client` with test frameworks that load test files asynchronously (e.g., using `define` with RequireJS or StealJS), it is critical to prevent the test framework from running automatically. `window.Testee.init()` must then be called manually *after* all test files are loaded and before the framework's `run` method is invoked.","severity":"gotcha","affected_versions":">=0.0.1"}],"env_vars":null,"last_verified":"2026-04-21T00:00:00.000Z","next_check":"2026-07-20T00:00:00.000Z","problems":[{"fix":"Ensure you are using `testee-client@0.5.3` or a later version, as version 0.5.2 was a faulty release and is missing critical files.","cause":"This error most commonly occurs when attempting to use `testee-client@0.5.2`, which was released without the necessary distribution files in its `dist/` folder, making the package effectively unusable.","error":"Error: Cannot find module 'testee-client/dist/testee-client.js' (or similar file not found errors for dist/ files)"},{"fix":"Upgrade `testee-client` to version 0.5.6 or higher. This version includes a fix that rebuilds the distribution without the conflicting `steal-tools` process shim.","cause":"A specific conflict between the `steal-tools` process shim and `testee-client`'s internal shim in versions prior to 0.5.6 caused `process.cwd()` to return an incorrect or empty value, affecting tests relying on it.","error":"process.cwd() returns an empty string or an unexpected path in StealJS/steal-tools environments"},{"fix":"Ensure that the `` tag is correctly placed in your HTML and executed before any code that attempts to access `window.Testee` or call `window.Testee.init()`.","cause":"The `testee-client.js` script was not loaded in the browser, or `window.Testee` was accessed before the script had fully executed and populated the global object.","error":"Uncaught ReferenceError: Testee is not defined"}],"ecosystem":"npm"}