This repository has been archived by the owner on Nov 4, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 131
/
promise.js
278 lines (250 loc) · 7.76 KB
/
promise.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
/*
* Should
* Copyright(c) 2010-2015 TJ Holowaychuk <tj@vision-media.ca>
* MIT Licensed
*/
var util = require('../util');
var PromisedAssertion = require('../assertion').PromisedAssertion;
var Assertion = require('../assertion');
module.exports = function(should) {
/**
* Assert given object is a Promise
*
* @name Promise
* @memberOf Assertion
* @category assertion promises
* @example
*
* promise.should.be.Promise()
* (new Promise(function(resolve, reject) { resolve(10); })).should.be.a.Promise()
* (10).should.not.be.a.Promise()
*/
Assertion.add('Promise', function() {
this.params = {operator: 'to be promise'};
var obj = this.obj;
should(obj).have.property('then')
.which.is.a.Function();
});
/**
* Assert given promise will be fulfilled. Result of assertion is still .thenable and should be handled accordingly.
*
* @name fulfilled
* @memberOf Assertion
* @returns {Promise}
* @category assertion promises
* @example
*
* // don't forget to handle async nature
* (new Promise(function(resolve, reject) { resolve(10); })).should.be.fulfilled();
*
* // test example with mocha it is possible to return promise
* it('is async', () => {
* return new Promise(resolve => resolve(10))
* .should.be.fulfilled();
* });
*/
Assertion.prototype.fulfilled = function Assertion$fulfilled() {
this.params = {operator: 'to be fulfilled'};
should(this.obj).be.a.Promise();
var that = this;
return this.obj.then(function next$onResolve(value) {
if (that.negate) {
that.fail();
}
return value;
}, function next$onReject(err) {
if (!that.negate) {
that.fail();
}
return err;
});
};
/**
* Assert given promise will be rejected. Result of assertion is still .thenable and should be handled accordingly.
*
* @name rejected
* @memberOf Assertion
* @category assertion promises
* @returns {Promise}
* @example
*
* // don't forget to handle async nature
* (new Promise(function(resolve, reject) { resolve(10); }))
* .should.not.be.rejected();
*
* // test example with mocha it is possible to return promise
* it('is async', () => {
* return new Promise((resolve, reject) => reject(new Error('boom')))
* .should.be.rejected();
* });
*/
Assertion.prototype.rejected = function() {
this.params = {operator: 'to be rejected'};
should(this.obj).be.a.Promise();
var that = this;
return this.obj.then(function(value) {
if (!that.negate) {
that.fail();
}
return value;
}, function next$onError(err) {
if (that.negate) {
that.fail();
}
return err;
});
};
/**
* Assert given promise will be fulfilled with some expected value (value compared using .eql).
* Result of assertion is still .thenable and should be handled accordingly.
*
* @name fulfilledWith
* @memberOf Assertion
* @category assertion promises
* @returns {Promise}
* @example
*
* // don't forget to handle async nature
* (new Promise(function(resolve, reject) { resolve(10); }))
* .should.be.fulfilledWith(10);
*
* // test example with mocha it is possible to return promise
* it('is async', () => {
* return new Promise((resolve, reject) => resolve(10))
* .should.be.fulfilledWith(10);
* });
*/
Assertion.prototype.fulfilledWith = function(expectedValue) {
this.params = {operator: 'to be fulfilled'};
should(this.obj).be.a.Promise();
var that = this;
return this.obj.then(function(value) {
if (that.negate) {
that.fail();
}
should(value).eql(expectedValue);
return value;
}, function next$onError(err) {
if (!that.negate) {
that.fail();
}
return err;
});
};
/**
* Assert given promise will be rejected with some sort of error. Arguments is the same for Assertion#throw.
* Result of assertion is still .thenable and should be handled accordingly.
*
* @name rejectedWith
* @memberOf Assertion
* @category assertion promises
* @returns {Promise}
* @example
*
* function failedPromise() {
* return new Promise(function(resolve, reject) {
* reject(new Error('boom'))
* })
* }
* failedPromise().should.be.rejectedWith(Error);
* failedPromise().should.be.rejectedWith('boom');
* failedPromise().should.be.rejectedWith(/boom/);
* failedPromise().should.be.rejectedWith(Error, { message: 'boom' });
* failedPromise().should.be.rejectedWith({ message: 'boom' });
*
* // test example with mocha it is possible to return promise
* it('is async', () => {
* return failedPromise().should.be.rejectedWith({ message: 'boom' });
* });
*/
Assertion.prototype.rejectedWith = function(message, properties) {
this.params = {operator: 'to be rejected'};
should(this.obj).be.a.Promise();
var that = this;
return this.obj.then(function(value) {
if (!that.negate) {
that.fail();
}
return value;
}, function next$onError(err) {
if (that.negate) {
that.fail();
}
var errorMatched = true;
var errorInfo = '';
if ('string' === typeof message) {
errorMatched = message === err.message;
} else if (message instanceof RegExp) {
errorMatched = message.test(err.message);
} else if ('function' === typeof message) {
errorMatched = err instanceof message;
} else if (message !== null && typeof message === 'object') {
try {
should(err).match(message);
} catch (e) {
if (e instanceof should.AssertionError) {
errorInfo = ': ' + e.message;
errorMatched = false;
} else {
throw e;
}
}
}
if (!errorMatched) {
if ( typeof message === 'string' || message instanceof RegExp) {
errorInfo = ' with a message matching ' + should.format(message) + ", but got '" + err.message + "'";
} else if ('function' === typeof message) {
errorInfo = ' of type ' + util.functionName(message) + ', but got ' + util.functionName(err.constructor);
}
} else if ('function' === typeof message && properties) {
try {
should(err).match(properties);
} catch (e) {
if (e instanceof should.AssertionError) {
errorInfo = ': ' + e.message;
errorMatched = false;
} else {
throw e;
}
}
}
that.params.operator += errorInfo;
that.assert(errorMatched);
return err;
});
};
/**
* Assert given object is promise and wrap it in PromisedAssertion, which has all properties of Assertion.
* That means you can chain as with usual Assertion.
* Result of assertion is still .thenable and should be handled accordingly.
*
* @name finally
* @memberOf Assertion
* @alias Assertion#eventually
* @category assertion promises
* @returns {PromisedAssertion} Like Assertion, but .then this.obj in Assertion
* @example
*
* (new Promise(function(resolve, reject) { resolve(10); }))
* .should.be.eventually.equal(10);
*
* // test example with mocha it is possible to return promise
* it('is async', () => {
* return new Promise(resolve => resolve(10))
* .should.be.finally.equal(10);
* });
*/
Object.defineProperty(Assertion.prototype, 'finally', {
get: function() {
should(this.obj).be.a.Promise();
var that = this;
return new PromisedAssertion(this.obj.then(function(obj) {
var a = should(obj);
a.negate = that.negate;
a.anyOne = that.anyOne;
return a;
}));
}
});
Assertion.alias('finally', 'eventually');
};