mukla
Small, parallel and fast test framework with suppport for async/await, promises, callbacks, streams and observables. Targets and works at node.js v0.10 and above.
Hightlights
- Extremely lightweight and fast
- Small to download and install
- No implicit globals,
- No CLI, use plain
node test.js
- Powered by always-done
- And so supports async/await, promises, observables streams and callbacks
- Enforces writing atomic tests
- Simple test syntax - just a single
test()
function - Works seamlessly with istanbul for code coverage
- Stops after first failing test (also known as "fail fast" or "bail")
- Built-in core-assert assertion library
- Targets and works at node.js v0.10 and above
- No need for build/transpilation/compilation step
- Backward-compatible with assertit and so testit
- Easy to porting of mocha-style tests
- Clean stack traces by default, using stacktrace-metadata
- Custom reporters, one built-in
Table of Contents
(TOC generated by verb using markdown-toc)
Install
Install with npm
$ npm install mukla --save
or install using yarn
$ yarn add mukla
Usage
For more use-cases see the tests
Write tests in ES2015
// or without `done`, returning Promise// stream, observerable and so on
The old way
var fs = var test = // or without `done`, returning Promise// stream, observerable and so on
API
mukla
Runs
fn
test and outputs thename
of the test. If only function is given and it is anonymous, the name of the test isanonymous
, otherwise the name of thefn
function.
Params
name
{String|Function}: the title of the test orfn
[fn]
{Function}: test function, wrapped in always-doneshowStack
{Boolean}: if booleantrue
, will print stack when has error
Example
var test = // failing regular callbacks test // passing test with anonymous title
Supports
Handles completion and errors of async/await, synchronous and asynchronous (callback) functions, also tests that returns streams, promises, child process and observables.
Async/await function support
var test =
Promise support
Returning a resolved Promise
var test =
Returning a rejected Promise
var test =
Observable support
Using
.subscribe
method of the observable
Empty observable
var test = var Observable = Observable
Successful test wtih observable
var test = var Observable = Observable
Failing observable
var test = var Observable = Observable
Regular callbacks support
var test = var fs =
Synchronous functions support
Passing sync test
var fs = var test =
Failing test with title
var test =
Support functions that returns streams
Handles completion of tests using on-stream-end and stream-exhaust, behind the scenes, using always-done
Passing test with unpiped streams
var fs = var test =
Failing test unpiped streams
var fs = var test =
Failing test with piped streams
var fs = var test = var through2 =
Support functions that returns Child Process
Basically, they are streams, so completion is handled using on-stream-end which is drop-in replacement for end-of-stream
Successful exec
var test = var cp = var isChildProcess =
Failing exec
var test = var cp =
Failing spawn
var test = var cp =
Handles any errors
uncaught exceptions
var test =
if test throws
var test =
Related
- always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync functions. A drop-in replacement… more | homepage
- core-assert: Node.js
assert
as a standalone module | homepage - each-promise: Iterate over promises, promise-returning or async/await functions in series or parallel. Support settle (fail-fast), concurrency (limiting) and hooks system (start… more | homepage
- gruu: Modern, small and powerful testing with TAP output and support for async/await, promises, callbacks, streams and observables, built on always-done. | homepage
- minibase-is-registered: Plugin for minibase and base, that adds
isRegistered
method to your application to detect if plugin is already registered and… more | homepage - minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
- try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions, using once and dezalgo libs. Useful for and… more | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.
In short: If you want to contribute to that project, please follow these things
- Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
- Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
- Always use
npm run commit
to commit changes instead ofgit commit
, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy. - Do NOT bump the version in package.json. For that we use
npm run release
, which is standard-version and follows Conventional Changelog idealogy.
Thanks a lot! :)
Building docs
Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb
command like that
$ npm install verbose/verb#dev verb-generate-readme --global && verb
Please don't edit the README directly. Any changes to the readme must be made in .verb.md.
Running tests
Clone repository and run the following in that cloned directory
$ npm install && npm test
Author
Charlike Mike Reagent
License
Copyright © 2015, 2017, Charlike Mike Reagent. Released under the MIT License.
This file was generated by verb-generate-readme, v0.4.3, on March 17, 2017.
Project scaffolded using charlike cli.