dec67bd535
This makes it easier to write high quality matchers and asymmetric equality
testers, and is also a step toward supporting custom object formatters.
Previously, Jasmine passed custom object formatters as the second argument
to matcher factories and as and the second argument to asymmetric equality
testers' `asymmetricMatch` method. Matchers and asymmetric equality testers
were responsible for passing the custom object formatters to methods like
`matchersUtil#equals`:
function toEqual(util, customEqualityTesters) {
return {
compare: function(actual, expected) {
// ...
result.pass = util.equals(actual, expected, customEqualityTesters, diffBuilder);
And:
ArrayContaining.prototype.asymmetricMatch = function(other, customTesters) {
// ...
for (var i = 0; i < this.sample.length; i++) {
var item = this.sample[i];
if (!j$.matchersUtil.contains(other, item, customTesters)) {
return false;
}
}
With this change, that is no longer necessary. Matchers and asymmetric
equality testers can ignore the existence of custom equality testers and
still fully support them:
function toEqual(util) {
return {
compare: function(actual, expected) {
// ...
result.pass = util.equals(actual, expected, diffBuilder);
And:
ArrayContaining.prototype.asymmetricMatch = function(other, matchersUtil) {
// ...
for (var i = 0; i < this.sample.length; i++) {
var item = this.sample[i];
if (!matchersUtil.contains(other, item)) {
return false;
}
}
The old interfaces are still supported, for now, but will be deprecated
in a future commit and removed in the next major release after that.
In addition to making matchers and custom equality testers simpler,
this change sets the stage for adding support for custom object
formatters. Those will be architecturally similar to custom equality
testers, and by injecting a `MatchersUtil` instance everywhere we can
add them without requiring user code to pass them around as used to be
the case with custom object formatters.
86 lines
3.0 KiB
JavaScript
86 lines
3.0 KiB
JavaScript
describe('#toBeResolvedTo', function() {
|
|
it('passes if the promise is resolved to the expected value', function() {
|
|
jasmine.getEnv().requirePromises();
|
|
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil(),
|
|
matcher = jasmineUnderTest.asyncMatchers.toBeResolvedTo(matchersUtil),
|
|
actual = Promise.resolve({foo: 42});
|
|
|
|
return matcher.compare(actual, {foo: 42}).then(function(result) {
|
|
expect(result).toEqual(jasmine.objectContaining({pass: true}));
|
|
});
|
|
});
|
|
|
|
it('fails if the promise is rejected', function() {
|
|
jasmine.getEnv().requirePromises();
|
|
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil(),
|
|
matcher = jasmineUnderTest.asyncMatchers.toBeResolvedTo(matchersUtil),
|
|
actual = Promise.reject('AsyncExpectationSpec error');
|
|
|
|
return matcher.compare(actual, '').then(function(result) {
|
|
expect(result).toEqual(jasmine.objectContaining({
|
|
pass: false,
|
|
message: "Expected a promise to be resolved to '' but it was rejected.",
|
|
}));
|
|
});
|
|
});
|
|
|
|
it('fails if the promise is resolved to a different value', function() {
|
|
jasmine.getEnv().requirePromises();
|
|
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil(),
|
|
matcher = jasmineUnderTest.asyncMatchers.toBeResolvedTo(matchersUtil),
|
|
actual = Promise.resolve({foo: 17});
|
|
|
|
return matcher.compare(actual, {foo: 42}).then(function(result) {
|
|
expect(result).toEqual(jasmine.objectContaining({
|
|
pass: false,
|
|
message: 'Expected a promise to be resolved to Object({ foo: 42 }) but it was resolved to Object({ foo: 17 }).',
|
|
}));
|
|
});
|
|
});
|
|
|
|
it('builds its message correctly when negated', function() {
|
|
jasmine.getEnv().requirePromises();
|
|
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil(),
|
|
matcher = jasmineUnderTest.asyncMatchers.toBeResolvedTo(matchersUtil),
|
|
actual = Promise.resolve(true);
|
|
|
|
return matcher.compare(actual, true).then(function(result) {
|
|
expect(result).toEqual(jasmine.objectContaining({
|
|
pass: true,
|
|
message: 'Expected a promise not to be resolved to true.'
|
|
}));
|
|
});
|
|
});
|
|
|
|
it('supports custom equality testers', function() {
|
|
jasmine.getEnv().requirePromises();
|
|
|
|
var customEqualityTesters = [function() { return true; }],
|
|
matchersUtil = new jasmineUnderTest.MatchersUtil({customTesters: customEqualityTesters}),
|
|
matcher = jasmineUnderTest.asyncMatchers.toBeResolvedTo(matchersUtil),
|
|
actual = Promise.resolve('actual');
|
|
|
|
return matcher.compare(actual, 'expected').then(function(result) {
|
|
expect(result).toEqual(jasmine.objectContaining({pass: true}));
|
|
});
|
|
});
|
|
|
|
it('fails if actual is not a promise', function() {
|
|
var matchersUtil = new jasmineUnderTest.MatchersUtil(),
|
|
matcher = jasmineUnderTest.asyncMatchers.toBeResolvedTo(matchersUtil),
|
|
actual = 'not a promise';
|
|
|
|
function f() {
|
|
return matcher.compare(actual);
|
|
}
|
|
|
|
expect(f).toThrowError(
|
|
'Expected toBeResolvedTo to be called on a promise.'
|
|
);
|
|
});
|
|
});
|