Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/airbnb/jest-wrap
Fluent pluggable interface for easily wrapping `describe` and `it` blocks in Jest tests.
https://github.com/airbnb/jest-wrap
javascript javascript-tests jest jest-tests mocha mocha-wrap testing testing-tools
Last synced: 26 days ago
JSON representation
Fluent pluggable interface for easily wrapping `describe` and `it` blocks in Jest tests.
- Host: GitHub
- URL: https://github.com/airbnb/jest-wrap
- Owner: airbnb
- License: mit
- Created: 2017-02-11T08:14:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T02:02:18.000Z (over 1 year ago)
- Last Synced: 2024-05-02T01:15:53.595Z (6 months ago)
- Topics: javascript, javascript-tests, jest, jest-tests, mocha, mocha-wrap, testing, testing-tools
- Language: JavaScript
- Size: 72.3 KB
- Stars: 39
- Watchers: 11
- Forks: 14
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# jest-wrap [![Version Badge][2]][1]
[![Build Status][3]][4]
[![dependency status][5]][6]
[![dev dependency status][7]][8]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[![npm badge][11]][1]
Fluent pluggable interface for easily wrapping `describe`, `it`, and `test` blocks in Jest tests.
## Example
```js
var wrap = require('jest-wrap');
var expect = require('chai').expect;
var mockWindow = {
location: {
href: 'test/url'
}
};
wrap().withGlobal('window', () => mockWindow).describe('mocked window', function () {
it('is mocked', function () {
expect(window).to.equal(mockWindow);
});
it('has the right URL', function () {
expect(window.location.href).to.equal('test/url');
});
});
var obj = { a: 1 };
wrap().withOverrides(() => obj, () => ({ a: 2, b: 3 })).describe('overridden object keys', function () {
it('has "b"', function () {
expect(obj.b).to.equal(3);
});
it('has overridden "a"', function () {
expect(obj.a).to.equal(2);
});
});
wrap().withOverride(() => obj, 'a', () => 4).skip().describe('this test is skipped', function () {
it('also supports .only()!', function () {
expect(true).to.equal(false); // skipped
});
});
```
## Plugins
A `jest-wrap` **plugin** is a named function that returns a JestWrapper instance or a descriptor object.
- A plugin’s function `name` must begin with the string “with”.
- Plugins can be globally registered, or `.use`d ad-hoc.
- `.use` requires a plugin function as its first argument; further arguments are passed through to the plugin.
- `.extend` requires a non-empty description string, and a descriptor object which may contain a value that is a function, or an array of functions, whose keys correspond to any or all of the supported jest methods.
- Globally registered plugins, `.use` calls, and `.extend` calls can be chained, stored, and reused - each link in the chain creates a new instance of a JestWrapper.
- A descriptor object may contain any or all of these 5 keys:
- a `description` string, for use in “describe” and/or “it” (this is required when returning an object)
- `beforeEach`: a function, or array of functions, for use in a `jest` `beforeEach` function
- `afterEach`: a function, or array of functions, for use in a `jest` `afterEach` function
- `beforeAll`: a function, or array of functions, for use in a `jest` `beforeAll` function
- `afterAll`: a function, or array of functions, for use in a `jest` `afterAll` function
The most common approach will be for a plugin function to return `this.extend(description, descriptor)`.
A plugin function must have a `name` that starts with “with”, and will be invoked with a receiver (”this” value) of a JestWrapper instance.
To register a plugin, call the `register` function on `jest-wrap` with the plugin function. This should not be done in a reusable module.
```js
module.exports = function withFoo(any, args, you, want) {
return this.extend('with some foo stuff', {
beforeEach: function () {
// setup ran before each test
},
afterEach: [
function () {
// teardown ran after each test
},
function () {
// more teardown
}
],
beforeAll: function () {
// setup ran once before all tests
},
afterAll: function () {
// teardown ran once after all tests
}
});
};
```
## Usage
```js
var wrap = require('jest-wrap');
wrap.register(require('jest-wrap-with-foo'));
wrap().withFoo().describe…
```
## skip/only
Although jest has `describe.skip`, `describe.only`, `it.skip`, `it.only`, `test.skip`, and `test.only`, it is not possible to implement these in jest-wrap without using ES5 property accessors. Since this project supports ES3, we decided to use `.skip().describe` etc rather than forfeit the ability to have skip/only.
## Tests
Simply clone the repo, `npm install`, and run `npm test`
[1]: https://npmjs.org/package/jest-wrap
[2]: http://versionbadg.es/airbnb/jest-wrap.svg
[3]: https://travis-ci.org/airbnb/jest-wrap.svg
[4]: https://travis-ci.org/airbnb/jest-wrap
[5]: https://david-dm.org/airbnb/jest-wrap.svg
[6]: https://david-dm.org/airbnb/jest-wrap
[7]: https://david-dm.org/airbnb/jest-wrap/dev-status.svg
[8]: https://david-dm.org/airbnb/jest-wrap#info=devDependencies
[11]: https://nodei.co/npm/jest-wrap.png?downloads=true&stars=true
[license-image]: http://img.shields.io/npm/l/jest-wrap.svg
[license-url]: LICENSE
[downloads-image]: http://img.shields.io/npm/dm/jest-wrap.svg
[downloads-url]: http://npm-stat.com/charts.html?package=jest-wrap