Readable tests.
- Purpose
- Installation
- Integration
- Available Matchers
- toBeArray, toHaveArray, toBeArrayOfBooleans, toHaveArrayOfBooleans, toBeArrayOfNumbers, toHaveArrayOfNumbers, toBeArrayOfObjects, toHaveArrayOfObjects, toBeArrayOfSize, toHaveArrayOfSize, toBeArrayOfStrings, toHaveArrayOfStrings, toBeEmptyArray, toHaveEmptyArray, toBeNonEmptyArray, toHaveNonEmptyArray, toBeBoolean, toHaveBoolean, toBeFalse, toHaveFalse, toBeTrue, toHaveTrue, toBeAfter, toHaveDateAfter, toBeBefore, toHaveDateBefore, toBeDate, toHaveDate, toBeIso8601, toHaveIso8601, toBeFunction, toHaveMethod, toThrowAnyError, toThrowErrorOfType, toBeCalculable, toHaveCalculable, toBeEvenNumber, toHaveEvenNumber, toBeNumber, toHaveNumber, toBeOddNumber, toHaveOddNumber, toBeWholeNumber, toHaveWholeNumber, toBeWithinRange, toHaveNumberWithinRange, toBeEmptyObject, toHaveEmptyObject, toBeNonEmptyObject, toHaveNonEmptyObject, toBeObject, toHaveObject, toHaveMember, toImplement, toBeEmptyString, toHaveEmptyString, toBeHtmlString, toHaveHtmlString, toBeJsonString, toHaveJsonString, toBeLongerThan, toHaveStringLongerThan, toBeNonEmptyString, toHaveNonEmptyString, toBeSameLengthAs, toHaveStringSameLengthAs, toBeShorterThan, toHaveStringShorterThan, toBeString, toHaveString, toBeWhitespace, toEndWith, toStartWith, toHaveWhitespaceString
- Known Supported Devices
The Jasmine testing framework from Pivotal Labs comes with this default set of matchers;
expect(fn).toThrow(e);
expect(instance).toBe(instance);
expect(mixed).toBeDefined();
expect(mixed).toBeFalsy();
expect(number).toBeGreaterThan(number);
expect(number).toBeLessThan(number);
expect(mixed).toBeNull();
expect(mixed).toBeTruthy();
expect(mixed).toBeUndefined();
expect(array).toContain(member);
expect(string).toContain(substring);
expect(mixed).toEqual(mixed);
expect(mixed).toMatch(pattern);Using the default Matchers your tests and failure output might look something like this;
it('should expose the expected API', function() {
expect(typeof record.save).toEqual('function');
});Expected "undefined" to equal "function"
it('should distribute evenly', function() {
expect(basket.items % 2 === 0).toEqual(true);
});Expected false to equal true
Using Jasmine-Matchers the same tests and failure output can be written like this;
it('should expose the expected API', function() {
expect(record).toHaveMethod('save');
});Expected member "save" of { save : undefined } to be function.
it('should distribute evenly', function() {
expect(basket).toHaveEvenNumber('items');
});Expected member "items" of { items : 25 } to be even number.
npm install jasmine-expect --save-devbower install jasmine-expect --save-devDownloads are available on the releases page.
Include Jasmine Matchers after Jasmine but before your tests.
<script src="/path/to/jasmine-matchers.js"></script>Integration is easy with the karma-jasmine-matchers plugin.
When using jasmine-node 1.x, provide the path to where Jasmine Matchers is installed as the value for --requireJsSetup.
jasmine-node --requireJsSetup node_modules/jasmine-expect/index.js testjasmine-node 2.x has no such hooks that I'm aware of for loading helpers, in this case the following call is needed before the first test in your suite.
require('jasmine-expect');Jasmine-Matchers-Snippets can be installed with Package Control to ease development with Jasmine Matchers in Sublime Text.
expect([]).toBeArray();expect({
memberName: []
}).toHaveArray('memberName');expect([true, false, true]).toBeArrayOfBooleans();expect({
memberName: [true, false, true]
}).toHaveArrayOfBooleans('memberName');expect([12, 82, 7]).toBeArrayOfNumbers();expect({
memberName: [12, 82, 7]
}).toHaveArrayOfNumbers('memberName');expect([{}, {}]).toBeArrayOfObjects();expect({
memberName: [{}, {}]
}).toHaveArrayOfObjects('memberName');expect([null, 31, 'hi']).toBeArrayOfSize(3);expect({
memberName: [null, 31, 'hi']).toBeArrayOfSi
}).toHaveArrayOfSize('memberName', size);expect(['foo', 'bar']).toBeArrayOfStrings();expect({
memberName: ['foo', 'bar']
}).toHaveArrayOfStrings('memberName');expect([]).toBeEmptyArray();expect({
memberName: []
}).toHaveEmptyArray('memberName');expect([98, 'banana']).toBeNonEmptyArray();expect({
memberName: [98, 'banana']
}).toHaveNonEmptyArray('memberName');expect(false).toBeBoolean();expect({
memberName: false
}).toHaveBoolean('memberName');expect(false).toBeFalse();expect({
memberName: false
}).toHaveFalse('memberName');expect(true).toBeTrue();expect({
memberName: true
}).toHaveTrue('memberName');expect(new Date('2014-01-01')).toBeAfter(new Date('1975-01-01'));expect({
memberName: new Date('2014-01-01')
}).toHaveDateAfter('memberName', new Date('1975-01-01'));expect(new Date('1975-01-01')).toBeBefore(new Date('2014-01-01'));expect({
memberName: new Date('1975-01-01')
}).toHaveDateBefore('memberName', new Date('2014-01-01'));expect(new Date()).toBeDate();expect({
memberName: new Date()
}).toHaveDate('memberName');expect('2013-07-08T07:29:15').toBeIso8601();expect({
memberName: '2013-07-08T07:29:15'
}).toHaveIso8601('memberName');expect(function() {}).toBeFunction();expect({
memberName: function() {}
}).toHaveMethod('memberName');expect(function() {
return badReference.unreachable;
}).toThrowAnyError();expect(function() {
return badReference.unreachable;
}).toThrowErrorOfType(ReferenceError);expect('12').toBeCalculable();expect({
memberName: '14'
}).toHaveCalculable('memberName');expect(4).toBeEvenNumber();expect({
memberName: 4
}).toHaveEvenNumber('memberName');expect(66).toBeNumber();expect({
memberName: 66
}).toHaveNumber('memberName');expect(3).toBeOddNumber();expect({
memberName: 3
}).toHaveOddNumber('memberName');expect(10).toBeWholeNumber();expect({
memberName: 10
}).toHaveWholeNumber('memberName');expect(6).toBeWithinRange(0, 10);expect({
memberName: 6
}).toHaveNumberWithinRange('memberName', 0, 10);expect({}).toBeEmptyObject();expect({
memberName: {}
}).toHaveEmptyObject('memberName');expect({
some: 'data'
}).toBeNonEmptyObject();expect({
memberName: {
some: 'data'
}
}).toHaveNonEmptyObject('memberName');expect({}).toBeObject();expect({
memberName: {}
}).toHaveObject('memberName');expect({
memberName: undefined
}).toHaveMember('memberName');expect({
name: 'Clive',
age: 72
}).toImplement({
name: String,
age: Number
});expect('').toBeEmptyString();expect({
memberName: ''
}).toHaveEmptyString('memberName');expect('<div></div>').toBeHtmlString();expect({
memberName: '<div></div>'
}).toHaveHtmlString('memberName');expect('{"name":"Winston"}').toBeJsonString();expect({
memberName: '{"name":"Winston"}'
}).toHaveJsonString('memberName');expect('Antidisestablishmentarianism').toBeLongerThan('No');expect({
memberName: 'Antidisestablishmentarianism'
}).toHaveStringLongerThan('memberName', 'No');expect('filled up').toBeNonEmptyString();expect({
memberName: 'filled up'
}).toHaveNonEmptyString('memberName');expect('Paul').toBeSameLengthAs('Jean');expect({
memberName: 'Paul'
}).toHaveStringSameLengthAs('memberName', 'Jean');expect('No').toBeShorterThan('Antidisestablishmentarianism');expect({
memberName: 'No'
}).toHaveStringShorterThan('memberName', 'Antidisestablishmentarianism');expect('').toBeString();expect({
memberName: ''
}).toHaveString('memberName');expect(' ').toBeWhitespace();expect('grandmother').toEndWith('mother');expect('physiotherapy').toStartWith('physio');expect({
memberName: ' '
}).toHaveWhitespaceString('memberName');During development, Jasmine-Matchers is tested against the following environments.
- Chrome 40.0.2214 (Mac OS X 10.10.1)
- Firefox 33.0.0 (Mac OS X 10.10)
- IE 7 (Windows XP on VirtualBox)
- IE 8 (Windows XP on VirtualBox)
- IE 9 (Windows 7 on VirtualBox)
- IE 10 (Windows 7 on VirtualBox)
- IE 11 (Windows 8.1 on SauceLabs)
- Opera 27.0.1689 (Mac OS X 10.10.1)
- Opera Mobile (Amazon Kindle Fire HD 8.9 on Opera Mobile Emulator)
- PhantomJS 1.9.8 (Mac OS X)
- Safari 8.0.2 (Mac OS X 10.10.1)