Skip to content

Commit

Permalink
refactor(testing): reenable injectAsync checking for return value
Browse files Browse the repository at this point in the history 
Before angular#5375, injectAsync would check the return value and fail
if it was not a promise, to help users remember that they need to
return a promise from an async test. angular#5375 removed that with the
introduction of the testing zone.

This un-deprecates `injectAsync` until we can resolve
angular#5515.

To be clear, this means that `inject` and `injectAsync` are now
identical except that `injectAsync` will fail if the test
does not return a promise, and `inject` will fail if the test
returns any value.
  • Loading branch information
@juliemr
juliemr committed Dec 15, 2015
1 parent 2aaef81 commit 4804da5
Show file tree
Hide file tree
Showing 3 changed files with 144 additions and 39 deletions.
26 changes: 19 additions & 7 deletions modules/angular2/src/testing/test_injector.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,9 +142,7 @@ export function createTestInjectorWithRuntimeCompiler(
}

/**
* Allows injecting dependencies in `beforeEach()` and `it()`. When using with the
* `angular2/testing` library, the test function will be run within a zone and will
* automatically complete when all asynchronous tests have finished.
* Allows injecting dependencies in `beforeEach()` and `it()`.
*
* Example:
*
Expand All @@ -155,9 +153,8 @@ export function createTestInjectorWithRuntimeCompiler(
* }));
*
* it('...', inject([AClass], (object) => {
* object.doSomething().then(() => {
* expect(...);
* });
* object.doSomething();
* expect(...);
* })
* ```
*
Expand All @@ -174,7 +171,22 @@ export function inject(tokens: any[], fn: Function): FunctionWithParamTokens {
}

/**
* @deprecated Use inject instead, which now supports both synchronous and asynchronous tests.
* Allows injecting dependencies in `beforeEach()` and `it()`. The test must return
* a promise which will resolve when all asynchronous activity is complete.
*
* Example:
*
* ```
* it('...', injectAsync([AClass], (object) => {
* return object.doSomething().then(() => {
* expect(...);
* });
* })
* ```
*
* @param {Array} tokens
* @param {Function} fn
* @return {FunctionWithParamTokens}
*/
export function injectAsync(tokens: any[], fn: Function): FunctionWithParamTokens {
return new FunctionWithParamTokens(tokens, fn, true);
Expand Down
44 changes: 39 additions & 5 deletions modules/angular2/src/testing/testing.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -192,9 +192,26 @@ function _it(jsmFn: Function, name: string, testFn: FunctionWithParamTokens | An
injector = createTestInjectorWithRuntimeCompiler(testProviders);
}

var returnedTestValue = runInTestZone(() => testFn.execute(injector), done, done.fail);
if (_isPromiseLike(returnedTestValue)) {
(<Promise<any>>returnedTestValue).then(null, (err) => { done.fail(err); });
var finishCallback = () => {
// Wait one more event loop to make sure we catch unreturned promises and
// promise rejections.
setTimeout(done, 0);
};
var returnedTestValue =
runInTestZone(() => testFn.execute(injector), finishCallback, done.fail);

if (testFn.isAsync) {
if (_isPromiseLike(returnedTestValue)) {
(<Promise<any>>returnedTestValue).then(null, (err) => { done.fail(err); });
} else {
done.fail('Error: injectAsync was expected to return a promise, but the ' +
' returned value was: ' + returnedTestValue);
}
} else {
if (!(returnedTestValue === undefined)) {
done.fail('Error: inject returned a value. Did you mean to use injectAsync? Returned ' +
'value was: ' + returnedTestValue);
}
}
}, timeOut);
} else {
Expand All @@ -220,13 +237,30 @@ export function beforeEach(fn: FunctionWithParamTokens | AnyTestFn): void {
if (fn instanceof FunctionWithParamTokens) {
// The test case uses inject(). ie `beforeEach(inject([ClassA], (a) => { ...
// }));`

jsmBeforeEach((done) => {
var finishCallback = () => {
// Wait one more event loop to make sure we catch unreturned promises and
// promise rejections.
setTimeout(done, 0);
};
if (!injector) {
injector = createTestInjectorWithRuntimeCompiler(testProviders);
}

runInTestZone(() => fn.execute(injector), done, done.fail);
var returnedTestValue = runInTestZone(() => fn.execute(injector), finishCallback, done.fail);
if (fn.isAsync) {
if (_isPromiseLike(returnedTestValue)) {
(<Promise<any>>returnedTestValue).then(null, (err) => { done.fail(err); });
} else {
done.fail('Error: injectAsync was expected to return a promise, but the ' +
' returned value was: ' + returnedTestValue);
}
} else {
if (!(returnedTestValue === undefined)) {
done.fail('Error: inject returned a value. Did you mean to use injectAsync? Returned ' +
'value was: ' + returnedTestValue);
}
}
});
} else {
// The test case doesn't use inject(). ie `beforeEach((done) => { ... }));`
Expand Down
113 changes: 86 additions & 27 deletions modules/angular2/test/testing/testing_public_spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
tick,
beforeEach,
inject,
injectAsync,
beforeEachProviders,
TestComponentBuilder
} from 'angular2/testing';
Expand Down Expand Up @@ -153,8 +154,9 @@ export function main() {
it('should use set up providers',
inject([FancyService], (service) => { expect(service.value).toEqual('real value'); }));

it('should wait until returned promises', inject([FancyService], (service) => {
service.getAsyncValue().then((value) => { expect(value).toEqual('async value'); });
it('should wait until returned promises', injectAsync([FancyService], (service) => {
return service.getAsyncValue().then(
(value) => { expect(value).toEqual('async value'); });
}));

describe('using beforeEach', () => {
Expand All @@ -167,8 +169,8 @@ export function main() {
});

describe('using async beforeEach', () => {
beforeEach(inject([FancyService], (service) => {
service.getAsyncValue().then((value) => { service.value = value; });
beforeEach(injectAsync([FancyService], (service) => {
return service.getAsyncValue().then((value) => { service.value = value; });
}));

it('should use asynchronously modified value',
Expand Down Expand Up @@ -196,18 +198,70 @@ export function main() {
var restoreJasmineIt = () => { jasmine.getEnv().it = originalJasmineIt; };

var patchJasmineBeforeEach = () => {
var deferred = PromiseWrapper.completer();
originalJasmineBeforeEach = jasmine.getEnv().beforeEach;
jasmine.getEnv().beforeEach = (fn: any) => {
var done = () => {};
(<any>done).fail = (err) => { throw new Error(err) };
var done = () => { deferred.resolve() };
(<any>done).fail = (err) => { deferred.reject(err) };
fn(done);
return null;
}
};
return deferred.promise;
};

var restoreJasmineBeforeEach =
() => { jasmine.getEnv().beforeEach = originalJasmineBeforeEach; }

it('injectAsync should fail when return was forgotten in it', (done) => {
var itPromise = patchJasmineIt();
it('forgets to return a proimse', injectAsync([], () => { return true; }));

itPromise.then(() => { done.fail('Expected function to throw, but it did not'); }, (err) => {
expect(err).toEqual(
'Error: injectAsync was expected to return a promise, but the returned value was: true');
done();
});
restoreJasmineIt();
});

it('inject should fail if a value was returned', (done) => {
var itPromise = patchJasmineIt();
it('returns a value', inject([], () => { return true; }));

itPromise.then(() => { done.fail('Expected function to throw, but it did not'); }, (err) => {
expect(err).toEqual(
'Error: inject returned a value. Did you mean to use injectAsync? Returned value was: true');
done();
});
restoreJasmineIt();
});

it('injectAsync should fail when return was forgotten in beforeEach', (done) => {
var beforeEachPromise = patchJasmineBeforeEach();
beforeEach(injectAsync([], () => { return true; }));

beforeEachPromise.then(
() => { done.fail('Expected function to throw, but it did not'); }, (err) => {
expect(err).toEqual(
'Error: injectAsync was expected to return a promise, but the returned value was: true');
done();
});
restoreJasmineBeforeEach();
});

it('inject should fail if a value was returned in beforeEach', (done) => {
var beforeEachPromise = patchJasmineBeforeEach();
beforeEach(inject([], () => { return true; }));

beforeEachPromise.then(
() => { done.fail('Expected function to throw, but it did not'); }, (err) => {
expect(err).toEqual(
'Error: inject returned a value. Did you mean to use injectAsync? Returned value was: true');
done();
});
restoreJasmineBeforeEach();
});

it('should fail when an error occurs inside inject', (done) => {
var itPromise = patchJasmineIt();
it('throws an error', inject([], () => { throw new Error('foo'); }));
Expand Down Expand Up @@ -235,7 +289,7 @@ export function main() {
it('should fail when a returned promise is rejected', (done) => {
var itPromise = patchJasmineIt();

it('should fail with an error from a promise', inject([], () => {
it('should fail with an error from a promise', injectAsync([], () => {
var deferred = PromiseWrapper.completer();
var p = deferred.promise.then(() => { expect(1).toEqual(2); });

Expand All @@ -259,8 +313,8 @@ export function main() {
describe('nested beforeEachProviders', () => {

it('should fail when the injector has already been used', () => {
patchJasmineBeforeEach();
expect(() => {
patchJasmineBeforeEach();
beforeEachProviders(() => [bind(FancyService).toValue(new FancyService())]);
})
.toThrowError('beforeEachProviders was called after the injector had been used ' +
Expand All @@ -273,19 +327,19 @@ export function main() {

describe('test component builder', function() {
it('should instantiate a component with valid DOM',
inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
injectAsync([TestComponentBuilder], (tcb: TestComponentBuilder) => {

tcb.createAsync(ChildComp).then((componentFixture) => {
return tcb.createAsync(ChildComp).then((componentFixture) => {
componentFixture.detectChanges();

expect(componentFixture.debugElement.nativeElement).toHaveText('Original Child');
});
}));

it('should allow changing members of the component',
inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
injectAsync([TestComponentBuilder], (tcb: TestComponentBuilder) => {

tcb.createAsync(MyIfComp).then((componentFixture) => {
return tcb.createAsync(MyIfComp).then((componentFixture) => {
componentFixture.detectChanges();
expect(componentFixture.debugElement.nativeElement).toHaveText('MyIf()');

Expand All @@ -295,9 +349,10 @@ export function main() {
});
}));

it('should override a template', inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
it('should override a template',
injectAsync([TestComponentBuilder], (tcb: TestComponentBuilder) => {

tcb.overrideTemplate(MockChildComp, '<span>Mock</span>')
return tcb.overrideTemplate(MockChildComp, '<span>Mock</span>')
.createAsync(MockChildComp)
.then((componentFixture) => {
componentFixture.detectChanges();
Expand All @@ -306,10 +361,12 @@ export function main() {
});
}));

it('should override a view', inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
it('should override a view',
injectAsync([TestComponentBuilder], (tcb: TestComponentBuilder) => {

tcb.overrideView(ChildComp,
new ViewMetadata({template: '<span>Modified {{childBinding}}</span>'}))
return tcb.overrideView(
ChildComp,
new ViewMetadata({template: '<span>Modified {{childBinding}}</span>'}))
.createAsync(ChildComp)
.then((componentFixture) => {
componentFixture.detectChanges();
Expand All @@ -319,9 +376,9 @@ export function main() {
}));

it('should override component dependencies',
inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
injectAsync([TestComponentBuilder], (tcb: TestComponentBuilder) => {

tcb.overrideDirective(ParentComp, ChildComp, MockChildComp)
return tcb.overrideDirective(ParentComp, ChildComp, MockChildComp)
.createAsync(ParentComp)
.then((componentFixture) => {
componentFixture.detectChanges();
Expand All @@ -332,9 +389,9 @@ export function main() {


it("should override child component's dependencies",
inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
injectAsync([TestComponentBuilder], (tcb: TestComponentBuilder) => {

tcb.overrideDirective(ParentComp, ChildComp, ChildWithChildComp)
return tcb.overrideDirective(ParentComp, ChildComp, ChildWithChildComp)
.overrideDirective(ChildWithChildComp, ChildChildComp, MockChildChildComp)
.createAsync(ParentComp)
.then((componentFixture) => {
Expand All @@ -345,9 +402,11 @@ export function main() {
});
}));

it('should override a provider', inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
it('should override a provider',
injectAsync([TestComponentBuilder], (tcb: TestComponentBuilder) => {

tcb.overrideProviders(TestProvidersComp, [bind(FancyService).toClass(MockFancyService)])
return tcb.overrideProviders(TestProvidersComp,
[bind(FancyService).toClass(MockFancyService)])
.createAsync(TestProvidersComp)
.then((componentFixture) => {
componentFixture.detectChanges();
Expand All @@ -358,10 +417,10 @@ export function main() {


it('should override a viewProvider',
inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
injectAsync([TestComponentBuilder], (tcb: TestComponentBuilder) => {

tcb.overrideViewProviders(TestViewProvidersComp,
[bind(FancyService).toClass(MockFancyService)])
return tcb.overrideViewProviders(TestViewProvidersComp,
[bind(FancyService).toClass(MockFancyService)])
.createAsync(TestViewProvidersComp)
.then((componentFixture) => {
componentFixture.detectChanges();
Expand Down

0 comments on commit 4804da5

Please sign in to comment.