Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avrelian/jasmine2-custom-message
custom failure message on any jasmine v2 assertion
https://github.com/avrelian/jasmine2-custom-message
assertions custom-message jasmine jasmine2
Last synced: 3 days ago
JSON representation
custom failure message on any jasmine v2 assertion
- Host: GitHub
- URL: https://github.com/avrelian/jasmine2-custom-message
- Owner: avrelian
- License: mit
- Created: 2015-07-27T10:11:59.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T16:27:08.000Z (over 1 year ago)
- Last Synced: 2024-12-16T18:11:50.504Z (6 days ago)
- Topics: assertions, custom-message, jasmine, jasmine2
- Language: JavaScript
- Homepage:
- Size: 267 KB
- Stars: 27
- Watchers: 3
- Forks: 6
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
jasmine2-custom-message
======================
> **works with `jasmine v2`** (for work with `jasmine v1.3` see [jasmine-custom-message](https://github.com/avrelian/jasmine-custom-message))
This script makes it possible to use your own failure message on any jasmine assertion.
#### Example
```js
describe('the story', function() {
it('should finish ok', function() {
since('all cats are grey in the dark').
expect('tiger').toEqual('kitty'); // => 'all cats are grey in the dark'
});
});
```
## Simple
All the magic happens in `since` function. That returns an object with a property `expect`. That contains no more than a wrapped jasmine `expect` function. That returns jasmine `expectation` object with a wrapped `addExpectationResult` function. That can replace an ordinary jasmine failure message with a newly generated one. That is generating based on a custom message you have supplied to `since` function as the first argument. That can be a primitive (except `null` and `undefined`), a function, or any other object. That is it.
#### Example
```js
describe('test', function() {
it('should be ok', function() {
since(function() {
return {'tiger': 'kitty'};
}).
expect(3).toEqual(4); // => '{"tiger":"kitty"}'
});
});
```
## Unobtrusive
You can use jasmine as you did before, since `jasmine2-custom-message` does not replace global jasmine `expect` function.
#### Example
```js
describe('test', function() {
it('should be ok', function() {
expect(3).toEqual(4); // => ordinary jasmine message
});
});
```
## Powerful
You can use expected and actual values of the assertion in your custom message by:
* Passing a function, and using `this.actual` and `this.expected`
* Passing a string, and using `#{actual}` and `#{expected}`
You can include the full original message from Jasmine by:
* Passing a function, and using `this.message`
* Passing a string, and using `#{message}`
#### Examples using a function
```js
describe('test', function() {
it('should be ok', function() {
since(function() {
return this.actual + ' =/= ' + this.expected;
}).
expect(3).toEqual(4); // => '3 =/= 4'
});
});
```
```js
describe('multiple tests that need some context added to the message', function() {
it('should be ok for all options', function() {
// passes the 1st loop iteration, fails the 2nd
[1, 2, 3, 4, 5].forEach(testOptionIndex => {
since(function() {
return 'for test option ' + testOptionIndex + ': ' + this.message;
}).
expect(testOptionIndex).toEqual(1); // => for test option 2: Expected 2 to equal 1.
});
});
});
```
#### Example using a string
```js
describe('test', function() {
it('should be ok', function() {
since('#{actual} =/= #{expected}').
expect(3).toEqual(4); // => '3 =/= 4'
});
});
```
```js
describe('multiple tests that need some context added to the message', function() {
it('should be ok for all options', function() {
// passes the 1st loop iteration, fails the 2nd
[1, 2, 3, 4, 5].forEach(testOptionIndex => {
since('for test option ' + testOptionIndex + ': #{message}').
expect(testOptionIndex).toEqual(1); // => for test option 2: Expected 2 to equal 1.
});
});
});
```
## Front-end usage
* install the bower package from github
```
bower install jasmine2-custom-message --save-dev
```
* include `jasmine2-custom-message.js` into your HTML file next to `jasmine` script
```html
```
## Node.js usage
* install the bower package from github
```
$ bower install jasmine2-custom-message --save-dev
```
or
```
$ npm install jasmine2-custom-message --save-dev
```
* require it in your spec file before your tests
```js
require('jasmine2-custom-message');
```
* or be explicit in any functional scope
```js
var since = require('jasmine2-custom-message');
```
## Change log
v0.9.0 - 2018.03.01
* improved "format string" functionality: `#{message}` added for the original jasmine2 error message (kudos to Keith Zimmerman)
* corrected output for `toHaveBeenCalled` matcher (kudos to Holger Jeromin)
* updated `protractor` environment (kudos to Keith Zimmerman)
* added `typescript` definitions (kudos to Holger Jeromin and Andrew N Marshall)
* updated specs
v0.8.0 - 2015.08.05
* implemented "format string" functionality: `#{actual}` and `#{expected}`
* configured `protractor` environment
* corrected displaying of colors in tests running through `protractor`
* updated specs
v0.7.0 - 2014.10.23
* fixed issue with custom failure messages on inverse assertions
* updated specs
`v0.6.0` - 2014.01.18 - **BROKEN COMPATIBILITY!**
* all the magic moved into newly introduced `since` function
* restored automatic initiation of the script upon inclusion (browser) or require (Node.js)
* cleaned specs
`v0.5.0` - 2014.01.15
* added support for nested message functions
* dropped automatic wrapping of jasmine `it` and `expect` functions in browsers
* added specs for Node.js
* added specs for browsers
* registered bower package
* made disambiguation and readability improvements
`v0.2.0` - 2014.01.10
* BROKEN COMPATIBILITY: custom messages is supplied as the third argument for jasmine `it` function
`v0.1.0` - 2014.01.08
* the first functional version
## Release plan
`v1.0.0` - some new features and updates (based on requests from Issues)