Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scalvert/ember-sinon-sinoff
An Ember addon that automatically restores sinon after each test.
https://github.com/scalvert/ember-sinon-sinoff
addon ember restore sinon
Last synced: 8 days ago
JSON representation
An Ember addon that automatically restores sinon after each test.
- Host: GitHub
- URL: https://github.com/scalvert/ember-sinon-sinoff
- Owner: scalvert
- License: mit
- Created: 2019-02-16T21:39:50.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-06T22:45:28.000Z (over 5 years ago)
- Last Synced: 2024-10-19T17:57:37.519Z (3 months ago)
- Topics: addon, ember, restore, sinon
- Language: JavaScript
- Size: 733 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-sinon-sinoff
| **This package has been deprecated**: Please use [ember-sinon-qunit](https://jhawk.co/ember-sinon-qunit). |
| --- |
[](https://travis-ci.org/scalvert/ember-sinon-sinoff)
[](https://badge.fury.io/js/ember-sinon-sinoff)
This addon adds automatic sandboxing of sinon to your QUnit tests. This ensures that sinon is correctly isolated and doesn't leak state between test executions.
## Installation
Run:
```
ember install ember-sinon-sinoff
```
## Usage
The `ember-sinon-sinoff` addon supports two different API versions:
1. The classic API, which automatically wires up sandbox creation and restoration to `QUnit.testStart` and `QUnit.testDone` respectively
1. The new QUnit hooks API, which takes a `hooks` object and wires up sandbox creation and restoration to `beforeEach` and `afterEach` of the module.
### Classic API
To use, import the setup method from within your `tests/test-helper.js` file and execute it.
```js
import setupSinonSinoff from 'ember-sinon-sinoff/test-support/setup-global-sinon-sinoff';
...
setupSinonSinoff();
```
This will automatically wire-up the sandbox `sinon.sandbox.create` and `sandbox.restore` methods to QUnit `testStart` and `testDone` respectively.
### QUnit `hooks` API
To use, import the setup method from within your test file and execute it.
```js
import { setupSinonSinoff } from 'ember-sinon-sinoff/test-support';
...
module('my module', function(hooks) {
setupSinonSinoff(hooks);
test('my test', function(assert) {
...
})
})
```
This will automatically wire-up the sandbox `sinon.createSandbox` and `sandbox.restore` methods to the module's `beforeEach` and `afterEach` respectively.
### Accessing Sinon from Within Tests
In each test you will be able to access the same sandboxed version of sinon via the `this.sandbox` property available within the test's scope:
```js
test('very important test happening here', function(assert) {
const spy = this.sandbox.spy();
...
});
```
Both the global sinon object and the `this.sandbox` convenience property point to the same, test-specific instance of a sinon sandbox.
### Incremental Migration
To ease the path to migrate to using `ember-sinon-sinoff`'s version of a fully sandboxed sinon, the sandbox that's provided includes a `create` method, which returns the same instance of the sandbox referenced by `this.sandbox`. This allows you to incrementally remove usages of sandboxing within your application.
```js
test('another equally important test', function(assert) {
// sandbox === this.sandbox
const sandbox = sinon.sandbox.create();
...
});
```
## Contributing
### Installation
- `git clone [email protected]:scalvert/ember-sinon-sinoff.git`
- `cd ember-sinon-sinoff`
- `yarn`
### Running Tests
- `yarn test`
- `ember test`
- `ember test --server`