/
resttests.ts
535 lines (468 loc) · 21.7 KB
/
resttests.ts
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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
import assert = require('assert');
import nock = require('nock');
import * as ifm from 'typed-rest-client/Interfaces';
import * as restm from 'typed-rest-client/RestClient';
import * as util from 'typed-rest-client/Util';
export interface HttpData {
url: string;
data: any;
json: any;
args?: any
}
describe('Rest Tests', function () {
let _rest: restm.RestClient;
let _restBin: restm.RestClient;
let _restMic: restm.RestClient;
let _queryParams: ifm.IRequestQueryParams;
before(() => {
_rest = new restm.RestClient('typed-rest-client-tests');
_restBin = new restm.RestClient('typed-rest-client-tests', 'https://httpbin.org');
_restMic = new restm.RestClient('typed-rest-client-tests', 'http://microsoft.com');
_queryParams = {
params: {
id: 1,
foo: 'bar'
}
};
});
after(() => {
});
afterEach(() => {
nock.cleanAll();
})
it('constructs', () => {
this.timeout(1000);
let rest: restm.RestClient = new restm.RestClient('typed-rest-client-tests');
assert(rest, 'rest client should not be null');
})
it('gets a resource', async() => {
nock('http://microsoft.com')
.get('/')
.reply(200, {
url: 'http://microsoft.com',
data: null,
json: null
}, {
'my-header': 'my-header-val'
});
let restRes: restm.IRestResponse<HttpData> = await _rest.get<HttpData>('http://microsoft.com');
assert(restRes.headers['my-header'] === 'my-header-val', 'Response should include headers');
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com');
});
it('gets a resource with baseUrl', async() => {
nock('http://microsoft.com')
.get('/')
.reply(200, {
url: 'http://microsoft.com',
data: null,
json: null
});
let restRes: restm.IRestResponse<HttpData> = await _restMic.get<HttpData>('');
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com');
});
it('gets a resource and correctly deserializes its Date property', async() => {
//Arrange
const dateObject: Date = new Date(2018, 9, 24, 10, 54, 11, 1);
nock('http://microsoft.com')
.get('/date')
.reply(200, {
json: {dateProperty: dateObject.toDateString()}
});
//Act
const restRes: restm.IRestResponse<HttpData> = await _rest.get<HttpData>('http://microsoft.com/date', {deserializeDates: true});
//Assert
assert(restRes.result);
const dateProperty: Date = restRes.result.json.dateProperty;
assert(dateProperty.getTime, 'dateProperty should have a getTime method');
assert.equal(dateProperty.getFullYear(), 2018);
assert.equal(dateProperty.getMonth(), 9);
assert.equal(dateProperty.getDate(), 24);
});
it('gets a resource and doesn\'t deserialize its non-Date property', async() => {
//Arrange
const nonDateObject: string = 'stringObject';
nock('http://microsoft.com')
.get('/date')
.reply(200, {
json: {nonDateProperty: nonDateObject}
});
//Act
const restRes: restm.IRestResponse<HttpData> = await _rest.get<HttpData>('http://microsoft.com/date', {deserializeDates: true});
//Assert
assert(restRes.result);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert.equal(typeof(restRes.result.json.nonDateProperty), 'string');
assert.equal(restRes.result.json.nonDateProperty, 'stringObject');
});
it('creates a resource', async() => {
nock('http://microsoft.com')
.post('/')
.reply(200, function(uri, requestBody) {
let body = JSON.parse(requestBody);
return {
url: 'http://microsoft.com/post',
data: null,
json: body.name
};
});
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpData> = await _rest.create<HttpData>('http://microsoft.com', res);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/post');
assert(restRes.result && restRes.result.json === 'foo');
});
it('creates a resource with a baseUrl', async() => {
nock('http://microsoft.com')
.post('/')
.reply(200, function(uri, requestBody) {
let body = JSON.parse(requestBody);
return {
url: 'http://microsoft.com/post',
data: null,
json: body.name
};
});
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpData> = await _restMic.create<HttpData>('', res);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/post');
assert(restRes.result && restRes.result.json === 'foo');
});
it('replaces a resource', async() => {
nock('http://microsoft.com')
.put('/')
.reply(200, function(uri, requestBody) {
let body = JSON.parse(requestBody);
return {
url: 'http://microsoft.com/put',
data: null,
json: body.name
};
});
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpData> = await _rest.replace<HttpData>('http://microsoft.com', res);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/put');
assert(restRes.result && restRes.result.json === 'foo');
});
it('replaces a resource with a baseUrl', async() => {
nock('http://microsoft.com')
.put('/')
.reply(200, function(uri, requestBody) {
let body = JSON.parse(requestBody);
return {
url: 'http://microsoft.com/put',
data: null,
json: body.name
};
});
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpData> = await _restMic.replace<HttpData>('', res);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/put');
assert(restRes.result && restRes.result.json === 'foo');
});
it('updates a resource', async() => {
nock('http://microsoft.com')
.put('/')
.reply(200, function(uri, requestBody) {
let body = JSON.parse(requestBody);
return {
url: 'http://microsoft.com/put',
data: null,
json: body.name
};
});
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpData> = await _rest.replace<HttpData>('http://microsoft.com', res);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/put');
assert(restRes.result && restRes.result.json === 'foo');
});
it('updates a resource with a baseUrl', async() => {
nock('http://microsoft.com')
.put('/')
.reply(200, function(uri, requestBody) {
let body = JSON.parse(requestBody);
return {
url: 'http://microsoft.com/put',
data: null,
json: body.name
};
});
let res: any = { name: 'foo' };
let restRes: restm.IRestResponse<HttpData> = await _restMic.replace<HttpData>('', res);
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/put');
assert(restRes.result && restRes.result.json === 'foo');
});
it('deletes a resource', async() => {
nock('http://microsoft.com')
.delete('/')
.reply(200, {
url: 'http://microsoft.com/delete',
data: null,
json: null
});
let restRes: restm.IRestResponse<HttpData> = await _rest.del<HttpData>('http://microsoft.com');
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/delete');
});
it('deletes a resource with a baseUrl', async() => {
nock('http://microsoft.com')
.delete('/')
.reply(200, {
url: 'http://microsoft.com/delete',
data: null,
json: null
});
let restRes: restm.IRestResponse<HttpData> = await _restMic.del<HttpData>('');
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/delete');
});
it('does an options request', async() => {
nock('http://microsoft.com')
.options('/')
.reply(200, {
url: 'http://microsoft.com/options',
data: null,
json: null
});
let restRes: restm.IRestResponse<HttpData> = await _rest.options<HttpData>('http://microsoft.com');
assert(restRes.statusCode == 200, "statusCode should be 200");
});
it('does an options request with baseUrl', async() => {
nock('http://microsoft.com')
.options('/')
.reply(200, {
url: 'http://microsoft.com/options',
data: null,
json: null
});
let restRes: restm.IRestResponse<HttpData> = await _restMic.options<HttpData>('');
assert(restRes.statusCode == 200, "statusCode should be 200");
});
//----------------------------------------------
// Get Error Cases
//----------------------------------------------
//
// Resource not found (404)
// should return a null resource, 404 status, and should not throw
//
it('gets a non-existant resource (404)', async() => {
nock('http://microsoft.com')
.get('/status/404')
.reply(404);
let restRes: restm.IRestResponse<HttpData>;
try {
restRes= await _rest.get<HttpData>('http://microsoft.com/status/404');
}
catch(err) {
console.log(err);
assert(false, "Request should succeed, should not throw");
}
assert(restRes.statusCode == 404, "statusCode should be 404");
assert(restRes.result === null, "object should be null");
});
//
// Unauthorized (401)
// should throw and attach statusCode to the Error object
// err.message is message proerty of resourceful error object or if not supplied, a generic error message
//
it('gets and handles unauthorized (401)', async() => {
nock('http://microsoft.com')
.get('/status/401')
.reply(401, {'message': 'something awful happened', 'statusCode': 401});
try {
let restRes: restm.IRestResponse<HttpData> = await _rest.get<HttpData>('http://microsoft.com/status/401');
assert(false, "should throw");
}
catch(err) {
assert(err['statusCode'] == 401, "statusCode should be 401");
assert(err.result && err.result['message'] === 'something awful happened', "should have error message with the response");
}
});
//
// Internal Server Error
// should throw and attach statusCode to the Error object
// err.message is message proerty of resourceful error object or if not supplied, a generic error message
//
it('gets and handles a server error (500)', async() => {
nock('http://microsoft.com')
.get('/status/500')
.reply(500, {'message': 'something awful happened', 'statusCode': 500});
try {
let restRes: restm.IRestResponse<HttpData> = await _rest.get<HttpData>('http://microsoft.com/status/500');
assert(false, "should throw");
}
catch(err) {
assert(err['statusCode'] == 500, "statusCode should be 500");
assert(err.result && err.result['message'] === 'something awful happened', "should have error message with the response");
}
});
//--------------------------------------------------------
// Path in baseUrl tests
//--------------------------------------------------------
it('maintains the path from the base url with no slashes', async() => {
nock('http://microsoft.com')
.get('/anything/anythingextra')
.reply(200, {
url: 'http://microsoft.com/anything/anythingextra',
data: null,
json: null
});
// Arrange
let rest = new restm.RestClient('typed-rest-client-tests', 'http://microsoft.com/anything');
// Act
let restRes: restm.IRestResponse<HttpData> = await rest.get<HttpData>('anythingextra');
// Assert
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/anything/anythingextra');
});
it('maintains the path from the base url with double slashes', async() => {
nock('http://microsoft.com')
.get('/anything/anythingextra')
.reply(200, {
url: 'http://microsoft.com/anything/anythingextra',
data: null,
json: null
});
// Arrange
let rest = new restm.RestClient('typed-rest-client-tests', 'http://microsoft.com/anything/');
// Act
let restRes: restm.IRestResponse<HttpData> = await rest.get<HttpData>('anythingextra');
// Assert
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/anything/anythingextra');
});
it('maintains the path from the base url with multiple parts', async() => {
nock('http://microsoft.com')
.get('/anything/extrapart/anythingextra')
.reply(200, {
url: 'http://microsoft.com/anything/extrapart/anythingextra',
data: null,
json: null
});
// Arrange
let rest = new restm.RestClient('typed-rest-client-tests', 'http://microsoft.com/anything/extrapart');
// Act
let restRes: restm.IRestResponse<HttpData> = await rest.get<HttpData>('anythingextra');
// Assert
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/anything/extrapart/anythingextra');
});
it('maintains the path from the base url where request has multiple parts', async() => {
nock('http://microsoft.com')
.get('/anything/anythingextra/moreparts')
.reply(200, {
url: 'http://microsoft.com/anything/anythingextra/moreparts',
data: null,
json: null
});
// Arrange
let rest = new restm.RestClient('typed-rest-client-tests', 'http://microsoft.com/anything');
// Act
let restRes: restm.IRestResponse<HttpData> = await rest.get<HttpData>('anythingextra/moreparts');
// Assert
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/anything/anythingextra/moreparts');
});
it('maintains the path from the base url where both have multiple parts', async() => {
nock('http://microsoft.com')
.get('/anything/multiple/anythingextra/moreparts')
.reply(200, {
url: 'http://microsoft.com/anything/multiple/anythingextra/moreparts',
data: null,
json: null
});
// Arrange
let rest = new restm.RestClient('typed-rest-client-tests', 'http://microsoft.com/anything/multiple');
// Act
let restRes: restm.IRestResponse<HttpData> = await rest.get<HttpData>('anythingextra/moreparts');
// Assert
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/anything/multiple/anythingextra/moreparts');
});
it('maintains the path from the base url where request has query parameters', async() => {
nock('http://microsoft.com')
.get('/anything/multiple/anythingextra/moreparts')
.query({
foo: 'bar',
baz: 'top'
})
.reply(200, {
url: 'http://microsoft.com/anything/multiple/anythingextra/moreparts?foo=bar&baz=top',
data: null,
json: null,
args: {foo: 'bar', baz: 'top'}
});
// Arrange
let rest = new restm.RestClient('typed-rest-client-tests', 'http://microsoft.com/anything/multiple');
// Act
let restRes: restm.IRestResponse<HttpData> = await rest.get<HttpData>('anythingextra/moreparts?foo=bar&baz=top');
// Assert
assert(restRes.statusCode == 200, "statusCode should be 200");
assert(restRes.result && restRes.result.url === 'http://microsoft.com/anything/multiple/anythingextra/moreparts?foo=bar&baz=top');
assert(restRes.result && restRes.result.args.foo === 'bar');
assert(restRes.result && restRes.result.args.baz === 'top');
});
//
// getUrl path tests
//
it('resolves a just host resource and no baseUrl', async() => {
let res: string = util.getUrl('http://microsoft.com');
assert(res === 'http://microsoft.com', "should be http://microsoft.com");
});
it('resolves a empty resource with baseUrl', async() => {
let res: string = util.getUrl('', 'http://microsoft.com');
assert(res === 'http://microsoft.com', "should be http://microsoft.com");
});
it('resolves a null resource with baseUrl', async() => {
let res: string = util.getUrl(null, 'http://microsoft.com');
assert(res === 'http://microsoft.com', "should be http://microsoft.com");
});
it('resolves a host resource with empty baseUrl and passing query parameters', async() => {
const res: string = util.getUrl('http://microsoft.com', '', _queryParams);
assert(res === 'http://microsoft.com?id=1&foo=bar', `should be http://microsoft.com?id=1&foo=bar but is ${res}`);
});
it('resolves an empty resource with baseUrl and passing query parameters', async() => {
const res: string = util.getUrl('', 'http://microsoft.com', _queryParams);
assert(res === 'http://microsoft.com?id=1&foo=bar', `should be http://microsoft.com?id=1&foo=bar but is ${res}`);
});
it('resolves a null resource with baseUrl and passing query parameters', async() => {
const res: string = util.getUrl(null, 'http://microsoft.com', _queryParams);
assert(res === 'http://microsoft.com?id=1&foo=bar', `should be http://microsoft.com?id=1&foo=bar but is ${res}`);
});
it('resolves a full resource and no baseUrl', async() => {
let res: string = util.getUrl('http://microsoft.com/get?x=y&a=b');
assert(res === 'http://microsoft.com/get?x=y&a=b', `should be http://microsoft.com/get?x=y&a=b but is ${res}`);
});
it('resolves a rooted path resource with host baseUrl', async() => {
let res: string = util.getUrl('/get/foo', 'http://microsoft.com');
assert(res === 'http://microsoft.com/get/foo', `should be http://microsoft.com/get/foo but is ${res}`);
});
it('resolves a relative path resource with host baseUrl', async() => {
let res: string = util.getUrl('get/foo', 'http://microsoft.com');
assert(res === 'http://microsoft.com/get/foo', `should be http://microsoft.com/get/foo but is ${res}`);
});
it('resolves a rooted path resource with host baseUrl and passing query parameters', async() => {
const res: string = util.getUrl('/get/foo', 'http://microsoft.com', _queryParams);
assert(res === 'http://microsoft.com/get/foo?id=1&foo=bar', `should be http://microsoft.com/get/foo?id=1&foo=bar but is ${res}`)
});
it('resolves a relative path resource with host baseUrl and passing query parameters', async() => {
const res: string = util.getUrl('get/foo', 'http://microsoft.com', _queryParams);
assert(res === 'http://microsoft.com/get/foo?id=1&foo=bar', `should be http://microsoft.com/get/foo?id=1&foo=bar but is ${res}`);
});
it('resolves a rooted path resource with pathed baseUrl', async() => {
let res: string = util.getUrl('/get/foo', 'http://microsoft.com/bar');
assert(res === 'http://microsoft.com/get/foo', "should be http://microsoft.com/get/foo");
});
it('resolves a relative path resource with pathed baseUrl', async() => {
let res: string = util.getUrl('get/foo', 'http://microsoft.com/bar');
assert(res === 'http://microsoft.com/bar/get/foo', `should be http://microsoft.com/bar/get/foo but is ${res}`);
});
});