Package description
The uvu npm package is a highly performant and lightweight test runner/framework for JavaScript, designed to execute tests quickly and support both Node.js and browser environments. It provides a simple API for defining and running tests, as well as assertions to validate code.
Test Definition and Execution
This feature allows you to define and run tests. The code sample demonstrates how to define a simple test suite with uvu to test the Math.sqrt function.
const { test } = require('uvu');
const assert = require('uvu/assert');
test('Math.sqrt()', () => {
assert.is(Math.sqrt(4), 2);
assert.is(Math.sqrt(144), 12);
assert.is(Math.sqrt(2), Math.SQRT2);
});
test.run();Asynchronous Test Support
uvu supports asynchronous tests, allowing you to test asynchronous operations like fetching data from an API. The code sample shows an asynchronous test that awaits the resolution of a fetchData function.
const { test } = require('uvu');
const assert = require('uvu/assert');
test('async test', async () => {
const data = await fetchData();
assert.is(data, expectedData);
});
test.run();Hooks
uvu provides hooks like before, after, before.each, and after.each to set up preconditions and clean up after tests. The code sample illustrates how to use before.each and after.each hooks in a test suite.
const { test, suite } = require('uvu');
const assert = require('uvu/assert');
const mathSuite = suite('math');
mathSuite.before.each(() => {
// setup code before each test
});
mathSuite.after.each(() => {
// cleanup code after each test
});
mathSuite('Math.pow()', () => {
assert.is(Math.pow(2, 3), 8);
});
mathSuite.run();Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple. It's more heavyweight compared to uvu and offers a wider range of built-in features like test retries and flexible reporting.
Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It works out of the box for any React project and provides a more integrated testing solution with features like snapshot testing, global setup/teardown, and a built-in coverage reporter. Jest is more opinionated and comprehensive than uvu, which is minimalistic and focused on performance.
AVA is a test runner for Node.js with a concise API, detailed error output, and process isolation that lets you develop with confidence. AVA is similar to uvu in its minimalism and focus on performance, but it also offers unique features like concurrent test execution and built-in support for TypeScript.
Tape is a tap-producing test harness for Node.js and browsers. It's minimal and flexible, with only a small set of core methods. Tape is similar to uvu in its simplicity and ease of use, but it produces TAP output, which can be consumed by any TAP reporter for more detailed results.
Readme
async/await tests$ npm install --save-dev uvu
Check out
/examplesfor a list of working demos!
// tests/demo.js
import { test } from 'uvu';
import * as assert from 'uvu/assert';
test('Math.sqrt()', () => {
assert.is(Math.sqrt(4), 2);
assert.is(Math.sqrt(144), 12);
assert.is(Math.sqrt(2), Math.SQRT2);
});
test('JSON', () => {
const input = {
foo: 'hello',
bar: 'world'
};
const output = JSON.stringify(input);
assert.snapshot(output, `{"foo":"hello","bar":"world"}`);
assert.equal(JSON.parse(output), input, 'matches original');
});
test.run();
Then execute this test file:
# via `uvu` cli, for all `/tests/**` files
$ uvu -r esm tests
# via `node` directly, for file isolation
$ node -r esm tests/demo.js
Note: The
-r esmis for legacy Node.js versions. Learn More
The uvu/assert module is completely optional.
In fact, you may use any assertion library, including Node's native assert module! This works because uvu relies on thrown Errors to detect failures. Implicitly, this also means that any uncaught exceptions and/or unhandled Promise rejections will result in a failure, which is what you want!
uvuThe main entry from which you will import the test or suite methods.
uvu/assertA collection of assertion methods to use within your tests. Please note that:
via the
/benchdirectory with Node v10.21.0
Below you'll find each test runner with two timing values:
took ___ value is the total process execution time – from startup to termination(___)) is the self-reported execution time, if knownEach test runner's stdout is printed to the console to verify all assertions pass.
Said output is excluded below for brevity.
~> "ava" took 594ms ( ??? )
~> "jest" took 962ms (356 ms)
~> "mocha" took 209ms ( 4 ms)
~> "tape" took 122ms ( ??? )
~> "uvu" took 72ms ( 1.3ms)
MIT © Luke Edwards
FAQs
uvu is an extremely fast and lightweight test runner for Node.js and the browser
The npm package uvu receives a total of 2,304,053 weekly downloads. As such, uvu popularity was classified as popular.
We found that uvu demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.