-
Notifications
You must be signed in to change notification settings - Fork 34
/
bard.js
704 lines (648 loc) · 23.8 KB
/
bard.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
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
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
/**
* bardjs - Spec helpers for testing angular v.1.x apps with Mocha, Jasmine or QUnit
* @authors John Papa,Ward Bell
* @version v0.1.10
* @link https://github.com/wardbell/bardjs
* @license MIT
*/
/*jshint -W079, -W117 */
(function() {
var bard = {
$httpBackend: $httpBackendReal,
$q: $qReal,
addGlobals: addGlobals,
appModule: appModule,
assertFail: assertFail,
asyncModule: asyncModule,
debugging: bardDebugging,
fakeLogger: fakeLogger,
fakeRouteHelperProvider: fakeRouteHelperProvider,
fakeRouteProvider: fakeRouteProvider,
fakeStateProvider: fakeStateProvider,
fakeToastr: fakeToastr,
inject: bardInject,
log: bardLog,
mochaRunnerListener: mochaRunnerListener,
mockService: mockService,
replaceAccentChars: replaceAccentChars,
verifyNoOutstandingHttpRequests: verifyNoOutstandingHttpRequests,
wrapWithDone: wrapWithDone
};
var global = (function() { return this; })();
// mocha/jasmine/QUnit fns
var afterEach = global.afterEach || global.teardown;
var beforeEach = global.beforeEach || global.setup;
var clearInject = [];
var currentSpec = null;
var debugging = false;
var logCounter = 0;
var okGlobals = [];
addBindPolyfill();
beforeEach(function bardTopBeforeEach() {
currentSpec = this;
});
afterEach(function bardTopAfterEach() {
currentSpec = null;
bard.log('clearing injected globals: ' + clearInject);
angular.forEach(clearInject, function(name) {
delete global[name];
});
clearInject.length = 0;
okGlobals.length = 0;
});
global.bard = angular.extend(global.bard || {}, bard);
////////////////////////
/*jshint -W101 */
/**
* Replaces the ngMock'ed $httpBackend with the real one from ng thus
* restoring the ability to issue AJAX calls to the backend with $http.
*
* Note that $q remains ngMocked so you must flush $http calls ($rootScope.$digest).
* Use $rootScope.$apply() for this purpose.
*
* Could restore $q with $qReal in which case don't need to flush.
*
* Inspired by this StackOverflow answer:
* http://stackoverflow.com/questions/20864764/e2e-mock-httpbackend-doesnt-actually-passthrough-for-me/26992327?iemail=1&noredirect=1#26992327
*
* Usage:
*
* var myService;
*
* beforeEach(module(bard.$httpBackend, 'app');
*
* beforeEach(inject(function(_myService_) {
* myService = _myService_;
* }));
*
* it('should return valid data', function(done) {
* myService.remoteCall()
* .then(function(data) {
* expect(data).toBeDefined();
* })
* .then(done, done);
*
* // because not using $qReal, must flush the $http and $q queues
* $rootScope.$apply;
* });
*/
/*jshint +W101 */
function $httpBackendReal($provide) {
$provide.provider('$httpBackend', function() {
/*jshint validthis:true */
this.$get = function() {
return angular.injector(['ng']).get('$httpBackend');
};
});
}
/**
* Replaces the ngMock'ed $q with the real one from ng thus
* obviating the need to flush $http and $q queues
* at the expense of ability to control $q timing.
*
* Usage:
*
* var myService;
*
* // Consider: beforeEach(bard.asyncModule('app'));
*
* beforeEach(module(bard.$q, bard.$httpBackend, 'app');
*
* beforeEach(inject(function(_myService_) {
* myService = _myService_;
* }));
*
* it('should return valid data', function(done) {
* myService.remoteCall()
* .then(function(data) {
* expect(data).toBeDefined();
* })
* .then(done, done);
*
* // not need to flush
* });
*/
function $qReal($provide) {
$provide.provider('$q', function() {
/*jshint validthis:true */
this.$get = function() {
return angular.injector(['ng']).get('$q');
};
});
}
/**
* Add names of globals to list of OK globals for this mocha spec
* NB: Call this method ONLY if you're using mocha!
* NB: Turn off browser-sync else mocha detects the browser-sync globals
* like ` ___browserSync___`
*
* usage:
* addGlobals(this, 'foo'); // where `this` is the spec context
* addGlobals(this, 'foo', bar);
* addGlobals.bind(this)('foo', 'bar');
* addGlobals(ctx, ['foo', 'bar']) // where ctx is the spec context
*/
function addGlobals() {
var args = Array.prototype.slice.call(arguments);
var ctx = getCtxFromArgs.bind(this)(args);
var globs = angular.isArray(args[0]) ? args[0] : args;
angular.forEach(globs, function(g) {
if (okGlobals.indexOf(g) === -1) {
okGlobals.push(g);
}
});
// if a mocha test, add the ok globals to it
ctx && ctx.test && ctx.test.globals && ctx.test.globals(okGlobals);
}
/**
* Prepare ngMocked application feature module
* along with faked toastr, routehelper,
* and faked router services.
* Especially useful for controller testing
* Use it as you would the ngMocks#module method
*
* DO NOT USE IF YOU NEED THE REAL ROUTER SERVICES!
* Fall back to `angular.mock.module(...)` or just `module(...)`
*
* Useage:
* beforeEach(bard.appModule('app.avengers'));
*
* Equivalent to:
* beforeEach(angular.mock.module(
* 'app.avengers',
* bard.fakeToastr,
* bard.fakeRouteHelperProvider,
* bard.fakeRouteProvider,
* bard.fakeStateProvider)
* );
*/
function appModule() {
var args = Array.prototype.slice.call(arguments, 0);
args = args.concat(fakeRouteHelperProvider, fakeRouteProvider,
fakeStateProvider, fakeToastr);
return angular.mock.module.apply(angular.mock, args);
}
/**
* Assert a failure in mocha, without condition
*
* Useage:
* assertFail('you are hosed')
*
* Responds:
* AssertionError: you are hosed
* at Object.assertFail (..../test/lib/bard.js:153:15)
* at Context.<anonymous> (.../....spec.js:329:15)
*
* OR JUST THROW the chai.AssertionError and treat this
* as a reminder of how to do it.
*/
function assertFail(message) {
throw new chai.AssertionError(message);
}
/**
* Prepare ngMocked module definition that makes real $http and $q calls
* Also adds fakeLogger to the end of the definition
* Use it as you would the ngMocks#module method
*
* Useage:
* beforeEach(bard.asyncModule('app'));
*
* Equivalent to:
* beforeEach(module('app', bard.$httpBackend, bard.$q, bard.fakeToastr));
*/
function asyncModule() {
var args = Array.prototype.slice.call(arguments, 0);
args = args.concat($httpBackendReal, $qReal, fakeToastr);
// build and return the ngMocked test module
return angular.mock.module.apply(angular.mock, args);
}
/**
* get/set bard debugging flag
*/
function bardDebugging(x) {
if (typeof x !== 'undefined') { debugging = !!x; }
return debugging;
}
/**
* Write to console if bard debugging flag is on
*/
function bardLog(msg) {
if (debugging) {
console.log('---bard (' + (logCounter += 1) + ') ' + msg);
}
}
/**
* inject selected services into the windows object during test
* then remove them when test ends with an `afterEach`.
*
* spares us the repetition of creating common service vars and injecting them
*
* Option: the first argument may be the mocha spec context object (`this`)
* It MUST be `this` if you what to check for mocha global leaks.
* Do NOT supply `this` as the first arg if you're not running mocha specs.
*
* remaining inject arguments may take one of 3 forms :
*
* function - This fn will be passed to ngMocks.inject.
* Annotations extracted after inject does its thing.
* [strings] - same string array you'd use to set fn.$inject
* (...string) - string arguments turned into a string array
*
* usage:
*
* bard.inject(this, ...); // `this` === the spec context
*
* bard.inject(this, '$log', 'dataservice');
* bard.inject(this, ['$log', 'dataservice']);
* bard.inject(this, function($log, dataservice) { ... });
*
*/
function bardInject () {
var args = Array.prototype.slice.call(arguments);
var ctx = getCtxFromArgs.bind(this)(args);
var first = args[0];
if (typeof first === 'function') {
// use ngMocks.inject to execute the func in the arg
angular.mock.inject(first);
args = first.$inject;
if (!args) {
// unfortunately ngMocks.inject only prepares inject.$inject for us
// if using strictDi as of v.1.3.8
// therefore, apply its annotation extraction logic manually
args = getinjectargs(first);
}
}
else if (angular.isArray(first)) {
args = first; // assume is an array of strings
}
// else assume all args are strings
var $injector = currentSpec.$injector;
if (!$injector) {
angular.mock.inject(); // create the injector
$injector = currentSpec.$injector;
}
var names = [];
angular.forEach(args, function(name, ix) {
if (typeof name !== 'string') {
return; // WAT? Only strings allowed. Let's skip it and move on.
}
var value = $injector.get(name);
if (value == null) { return; }
var pathName = name.split('.');
if (pathName.length > 1) {
// name is a path like 'block.foo'. Can't use as identifier
// assume last segment should be identifier name, e.g. 'foo'
name = pathName[pathName.length - 1];
// todo: tolerate component names that are invalid JS identifiers, e.g. 'burning man'
}
global[name] = value;
clearInject.push(name);
names.push(name);
});
bard.addGlobals.bind(ctx)(names);
}
function fakeLogger($provide) {
$provide.value('logger', sinon.stub({
info: function() {},
error: function() {},
warning: function() {},
success: function() {}
}));
}
function fakeToastr($provide) {
$provide.constant('toastr', sinon.stub({
info: function() {},
error: function() {},
warning: function() {},
success: function() {}
}));
}
function fakeRouteHelperProvider($provide) {
$provide.provider('routehelper', function() {
/* jshint validthis:true */
this.config = {
$routeProvider: undefined,
docTitle: 'Testing'
};
this.$get = function() {
return {
configureRoutes: sinon.stub(),
getRoutes: sinon.stub().returns([]),
routeCounts: {
errors: 0,
changes: 0
}
};
};
});
}
function fakeRouteProvider($provide) {
/**
* Stub out the $routeProvider so we avoid
* all routing calls, including the default route
* which runs on every test otherwise.
* Make sure this goes before the inject in the spec.
*
* Optionally set up the fake behavior in your tests by monkey patching
* the faked $route router. For example:
*
* beforeEach(function() {
* // get fake $route router service
* bard.inject(this, '$route');
*
* // plug in fake $route router values for this set of tests
* $route.current = { ... fake values here ... };
* $route.routes = { ... fake values here ... };
* })
*/
$provide.provider('$route', function() {
/* jshint validthis:true */
this.when = sinon.stub();
this.otherwise = sinon.stub();
this.$get = function() {
return {
// current: {}, // fake before each test as needed
// routes: {} // fake before each test as needed
// more? You'll know when it fails :-)
_faked: 'this is the faked $route service'
};
};
});
}
function fakeStateProvider($provide) {
/**
* Stub out the $stateProvider so we avoid
* all routing calls, including the default state
* which runs on every test otherwise.
* Make sure this goes before the inject in the spec.
*
* Optionally set up the fake behavior in your tests by monkey patching
* the faked $state router. For example:
*
* beforeEach(function() {
* // get fake $state router service
* bard.inject(this, '$state');
*
* // plug in fake $state router values for this set of tests
* $state.current = { ... fake values here ... };
* $state.state = { ... fake values here ... };
* })
*/
$provide.provider('$state', function() {
/* jshint validthis:true */
this.state = sinon.stub();
this.$get = function() {
return {
// current: {}, // fake before each test as needed
// state: {} // fake before each test as needed
// more? You'll know when it fails :-)
_faked: 'this is the faked $state service'
};
};
});
$provide.provider('$urlRouter', function() {
/* jshint validthis:true */
this.otherwise = sinon.stub();
this.$get = function() {
return {
// current: {}, // fake before each test as needed
// states: {} // fake before each test as needed
// more? You'll know when it fails :-)
_faked: 'this is the faked $urlRouter service'
};
};
});
}
/**
* Get the spec context from parameters (if there)
* or from `this` (if it is the ctx as a result of `bind`)
*/
function getCtxFromArgs(args) {
var ctx;
var first = args[0];
// heuristic to discover if the first arg is the mocha spec context (`this`)
if (first && first.test) {
// The first arg was the mocha spec context (`this`)
// Get it and strip it from args
ctx = args.shift();
} else if (this.test) {
// alternative: caller can bind bardInject to the spec context
ctx = this;
}
return ctx;
}
/**
* Inspired by Angular; that's how they get the parms for injection
* Todo: no longer used by `injector`. Remove?
*/
function getFnParams(fn) {
var fnText;
var argDecl;
var FN_ARGS = /^function\s*[^\(]*\(\s*([^\)]*)\)/m;
var FN_ARG_SPLIT = /,/;
var FN_ARG = /^\s*(_?)(\S+?)\1\s*$/;
var STRIP_COMMENTS = /((\/\/.*$)|(\/\*[\s\S]*?\*\/))/mg;
var params = [];
if (fn.length) {
fnText = fn.toString().replace(STRIP_COMMENTS, '');
argDecl = fnText.match(FN_ARGS);
angular.forEach(argDecl[1].split(FN_ARG_SPLIT), function(arg) {
arg.replace(FN_ARG, function(all, underscore, name) {
params.push(name);
});
});
}
return params;
}
function isSpecRunning() { return !!currentSpec; }
/**
* Mocks out a service with sinon stubbed functions
* that return the values specified in the config
*
* If the config value is `undefined`,
* stub the service method with a dummy that doesn't return a value
*
* If the config value is a function, set service property with it
*
* If a service member is a property, not a function,
* set it with the config value
* If a service member name is not a key in config,
* follow the same logic as above to set its members
* using the config._default value (which is `undefined` if omitted)
*
* If there is a config entry that is NOT a member of the service
* add mocked function to the service using the config value
*
* Usage:
* Given this DoWork service:
* {
* doWork1: an async function,
* doWork2: a function,
* doWork3: an async function,
* doWork4: a function,
* isActive: true
* }
*
* Given this config:
* {
* doWork1: $q.when([{name: 'Bob'}, {name: 'Sally'}]),
* doWork2: undefined,
* //doWork3: not in config therefore will get _default value
* doWork4: an alternate doWork4 function
* doWork5: $q.reject('bad boy!')
* isActive: false,
* _default: $q.when([])
* }
*
* Service becomes
* {
* doWork1: a stub returning $q.when([{name: 'Bob'}, {name: 'Sally'}]),
* doWork2: do-nothing stub,
* doWork3: a stub returning $q.when([]),
* doWork4: an alternate doWork4 function,
* doWork5: a stub returning $q.reject('bad boy!'),
* isActive: false,
* }
*/
function mockService(service, config) {
var serviceKeys = [];
for (var key in service) {
serviceKeys.push(key);
}
var configKeys = [];
for (var key in config) {
configKeys.push(key);
}
angular.forEach(serviceKeys, function(key) {
var value = configKeys.indexOf(key) > -1 ?
config[key] : config._default;
if (typeof service[key] === 'function') {
if (typeof value === 'function') {
service[key] = value;
} else {
sinon.stub(service, key, function() {
return value;
});
}
} else {
service[key] = value;
}
});
// for all unused config entries add a sinon stubbed
// async method that returns the config value
angular.forEach(configKeys, function(key) {
if (serviceKeys.indexOf(key) === -1) {
var value = config[key];
if (typeof value === 'function') {
service[key] = value;
} else {
service[key] = sinon.spy(function() {
return value;
});
}
}
});
return service;
}
/**
* Listen to mocha test runner events
* Usage in browser:
* var runner = mocha.run();
* bard.mochaRunnerListener(runner);
*/
function mochaRunnerListener(runner) {
if (!global.mocha) { return; }
if (!runner.ignoreLeaks) {
runner.on('hook end', addOkGlobals);
};
// When checking global leaks with mocha.checkLeaks()
// make sure mocha is aware of bard's okGlobals
function addOkGlobals(hook) {
// HACK: only way I've found so far to ensure that bard added globals
// are always inspected. Using private mocha _allowedGlobals (shhhh!)
if (okGlobals.length && !hook._allowedGlobals) {
hook._allowedGlobals = okGlobals;
}
}
}
// Replaces the accented characters of many European languages w/ unaccented chars
// Use it in JavaScript string sorts where such characters may be encountered
// Matches the default string comparers of most databases.
// Ex: replaceAccentChars(a.Name) < replaceAccentChars(b.Name)
// instead of: a.Name < b.Name
function replaceAccentChars(s) {
var r = s.toLowerCase();
r = r.replace(new RegExp(/[àáâãäå]/g), 'a');
r = r.replace(new RegExp(/æ/g), 'ae');
r = r.replace(new RegExp(/ç/g), 'c');
r = r.replace(new RegExp(/[èéêë]/g), 'e');
r = r.replace(new RegExp(/[ìíîï]/g), 'i');
r = r.replace(new RegExp(/ñ/g), 'n');
r = r.replace(new RegExp(/[òóôõö]/g), 'o');
r = r.replace(new RegExp(/œ/g), 'oe');
r = r.replace(new RegExp(/[ùúûü]/g), 'u');
r = r.replace(new RegExp(/[ýÿ]/g), 'y');
return r;
}
/**
* Assert that there are no outstanding HTTP requests after test is complete
* For use with ngMocks; doesn't work for async server integration tests
*/
function verifyNoOutstandingHttpRequests () {
afterEach(angular.mock.inject(function($httpBackend) {
$httpBackend.verifyNoOutstandingExpectation();
$httpBackend.verifyNoOutstandingRequest();
}));
}
/**
* Returns a function that execute a callback function
* (typically a fn making asserts) within a try/catch
* The try/catch then calls the ambient "done" function
* in the appropriate way for both success and failure
*
* Useage:
* bard.inject('ngRouteTester', ...); // see bard-ngRouteTester.js
* ...
* // When the DOM is ready, assert got the dashboard view
* ngRouteTester.until(elemIsReady, wrap(hasDashboardView, done));
*/
function wrapWithDone(callback, done) {
return function() {
try {
callback();
done();
} catch (err) {
done(err);
}
};
}
/*
* Phantom.js does not support Function.prototype.bind (at least not before v.2.0
* That's just crazy. Everybody supports bind.
* Read about it here: https://groups.google.com/forum/#!msg/phantomjs/r0hPOmnCUpc/uxusqsl2LNoJ
* This polyfill is copied directly from MDN
* https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function/bind#Compatibility
*/
function addBindPolyfill() {
if (Function.prototype.bind) { return; } // already defined
/*jshint freeze: false */
Function.prototype.bind = function (oThis) {
if (typeof this !== 'function') {
// closest thing possible to the ECMAScript 5
// internal IsCallable function
throw new TypeError(
'Function.prototype.bind - what is trying to be bound is not callable');
}
var aArgs = Array.prototype.slice.call(arguments, 1),
fToBind = this,
FuncNoOp = function () {},
fBound = function () {
return fToBind.apply(this instanceof FuncNoOp && oThis ? this : oThis,
aArgs.concat(Array.prototype.slice.call(arguments)));
};
FuncNoOp.prototype = this.prototype;
fBound.prototype = new FuncNoOp();
return fBound;
};
}
})();