Instead, the async function now determines whether it should return a promise
or instead call a done function parameter. Importing Jasmine functions
from `@angular/core/testing` is no longer necessary and is now deprecated.
Additionally, beforeEachProviders is also deprecated, as it is specific
to the testing framework. Instead, use the new addProviders method directly.
Before:
```js
import {beforeEachProviders, it, describe, inject} from 'angular2/testing/core';
describe('my code', () => {
  beforeEachProviders(() => [MyService]);
  it('does stuff', inject([MyService], (service) => {
    // actual test
  });
});
```
After:
```js
import {addProviders, inject} from 'angular2/testing/core';
describe('my code', () => {
  beforeEach(() => {
    addProviders([MyService]);
  });
  it('does stuff', inject([MyService], (service) => {
    // actual test
  });
});
```
		
	
			
		
			
				
	
	
		
			403 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
			
		
		
	
	
			403 lines
		
	
	
		
			14 KiB
		
	
	
	
		
			TypeScript
		
	
	
	
	
	
| /**
 | |
|  * @license
 | |
|  * Copyright Google Inc. All Rights Reserved.
 | |
|  *
 | |
|  * Use of this source code is governed by an MIT-style license that can be
 | |
|  * found in the LICENSE file at https://angular.io/license
 | |
|  */
 | |
| 
 | |
| import {addProviders, inject, fakeAsync, async, withProviders, tick,} from '@angular/core/testing';
 | |
| import {TestComponentBuilder} from '@angular/compiler/testing';
 | |
| import {expect} from '@angular/platform-browser/testing/matchers';
 | |
| import {Injectable, provide, Component, ViewMetadata} from '@angular/core';
 | |
| import {NgIf} from '@angular/common';
 | |
| import {PromiseWrapper} from '../../http/src/facade/promise';
 | |
| 
 | |
| // Services, and components for the tests.
 | |
| 
 | |
| @Component(
 | |
|     {selector: 'child-comp', template: `<span>Original {{childBinding}}</span>`, directives: []})
 | |
| @Injectable()
 | |
| class ChildComp {
 | |
|   childBinding: string;
 | |
|   constructor() { this.childBinding = 'Child'; }
 | |
| }
 | |
| 
 | |
| @Component({selector: 'child-comp', template: `<span>Mock</span>`})
 | |
| @Injectable()
 | |
| class MockChildComp {
 | |
| }
 | |
| 
 | |
| @Component({
 | |
|   selector: 'parent-comp',
 | |
|   template: `Parent(<child-comp></child-comp>)`,
 | |
|   directives: [ChildComp]
 | |
| })
 | |
| @Injectable()
 | |
| class ParentComp {
 | |
| }
 | |
| 
 | |
| @Component({
 | |
|   selector: 'my-if-comp',
 | |
|   template: `MyIf(<span *ngIf="showMore">More</span>)`,
 | |
|   directives: [NgIf]
 | |
| })
 | |
| @Injectable()
 | |
| class MyIfComp {
 | |
|   showMore: boolean = false;
 | |
| }
 | |
| 
 | |
| @Component({selector: 'child-child-comp', template: `<span>ChildChild</span>`})
 | |
| @Injectable()
 | |
| class ChildChildComp {
 | |
| }
 | |
| 
 | |
| @Component({
 | |
|   selector: 'child-comp',
 | |
|   template: `<span>Original {{childBinding}}(<child-child-comp></child-child-comp>)</span>`,
 | |
|   directives: [ChildChildComp]
 | |
| })
 | |
| @Injectable()
 | |
| class ChildWithChildComp {
 | |
|   childBinding: string;
 | |
|   constructor() { this.childBinding = 'Child'; }
 | |
| }
 | |
| 
 | |
| @Component({selector: 'child-child-comp', template: `<span>ChildChild Mock</span>`})
 | |
| @Injectable()
 | |
| class MockChildChildComp {
 | |
| }
 | |
| 
 | |
| class FancyService {
 | |
|   value: string = 'real value';
 | |
|   getAsyncValue() { return Promise.resolve('async value'); }
 | |
|   getTimeoutValue() {
 | |
|     return new Promise((resolve, reject) => { setTimeout(() => {resolve('timeout value')}, 10); })
 | |
|   }
 | |
| }
 | |
| 
 | |
| class MockFancyService extends FancyService {
 | |
|   value: string = 'mocked out value';
 | |
| }
 | |
| 
 | |
| @Component({
 | |
|   selector: 'my-service-comp',
 | |
|   providers: [FancyService],
 | |
|   template: `injected value: {{fancyService.value}}`
 | |
| })
 | |
| class TestProvidersComp {
 | |
|   constructor(private fancyService: FancyService) {}
 | |
| }
 | |
| 
 | |
| @Component({
 | |
|   selector: 'my-service-comp',
 | |
|   viewProviders: [FancyService],
 | |
|   template: `injected value: {{fancyService.value}}`
 | |
| })
 | |
| class TestViewProvidersComp {
 | |
|   constructor(private fancyService: FancyService) {}
 | |
| }
 | |
| 
 | |
| export function main() {
 | |
|   describe('using the async helper', () => {
 | |
|     var actuallyDone: boolean;
 | |
| 
 | |
|     beforeEach(() => { actuallyDone = false; });
 | |
| 
 | |
|     afterEach(() => { expect(actuallyDone).toEqual(true); });
 | |
| 
 | |
|     it('should run normal tests', () => { actuallyDone = true; });
 | |
| 
 | |
|     it('should run normal async tests', (done: any /** TODO #9100 */) => {
 | |
|       setTimeout(() => {
 | |
|         actuallyDone = true;
 | |
|         done();
 | |
|       }, 0);
 | |
|     });
 | |
| 
 | |
|     it('should run async tests with tasks',
 | |
|        async(() => { setTimeout(() => { actuallyDone = true; }, 0); }));
 | |
| 
 | |
|     it('should run async tests with promises', async(() => {
 | |
|          var p = new Promise((resolve, reject) => { setTimeout(resolve, 10); });
 | |
|          p.then(() => { actuallyDone = true; });
 | |
|        }));
 | |
|   });
 | |
| 
 | |
|   describe('using the test injector with the inject helper', () => {
 | |
|     describe('setting up Providers', () => {
 | |
|       beforeEach(() => addProviders([{provide: FancyService, useValue: new FancyService()}]));
 | |
| 
 | |
|       it('should use set up providers', inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|            expect(service.value).toEqual('real value');
 | |
|          }));
 | |
| 
 | |
|       it('should wait until returned promises',
 | |
|          async(inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|            service.getAsyncValue().then(
 | |
|                (value: any /** TODO #9100 */) => { expect(value).toEqual('async value'); });
 | |
|            service.getTimeoutValue().then(
 | |
|                (value: any /** TODO #9100 */) => { expect(value).toEqual('timeout value'); });
 | |
|          })));
 | |
| 
 | |
|       it('should allow the use of fakeAsync',
 | |
|          fakeAsync(inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|            var value: any /** TODO #9100 */;
 | |
|            service.getAsyncValue().then(function(val: any /** TODO #9100 */) { value = val; });
 | |
|            tick();
 | |
|            expect(value).toEqual('async value');
 | |
|          })));
 | |
| 
 | |
|       it('should allow use of "done"', (done: any /** TODO #9100 */) => {
 | |
|         inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|           let count = 0;
 | |
|           let id = setInterval(() => {
 | |
|             count++;
 | |
|             if (count > 2) {
 | |
|               clearInterval(id);
 | |
|               done();
 | |
|             }
 | |
|           }, 5);
 | |
|         })();  // inject needs to be invoked explicitly with ().
 | |
|       });
 | |
| 
 | |
|       describe('using beforeEach', () => {
 | |
|         beforeEach(inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|           service.value = 'value modified in beforeEach';
 | |
|         }));
 | |
| 
 | |
|         it('should use modified providers',
 | |
|            inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|              expect(service.value).toEqual('value modified in beforeEach');
 | |
|            }));
 | |
|       });
 | |
| 
 | |
|       describe('using async beforeEach', () => {
 | |
|         beforeEach(async(inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|           service.getAsyncValue().then(
 | |
|               (value: any /** TODO #9100 */) => { service.value = value; });
 | |
|         })));
 | |
| 
 | |
|         it('should use asynchronously modified value',
 | |
|            inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|              expect(service.value).toEqual('async value');
 | |
|            }));
 | |
|       });
 | |
|     });
 | |
| 
 | |
|     describe('per test providers', () => {
 | |
|       it('should allow per test providers',
 | |
|          withProviders(() => [{provide: FancyService, useValue: new FancyService()}])
 | |
|              .inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|                expect(service.value).toEqual('real value');
 | |
|              }));
 | |
| 
 | |
|       it('should return value from inject', () => {
 | |
|         let retval = withProviders(() => [{provide: FancyService, useValue: new FancyService()}])
 | |
|                          .inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|                            expect(service.value).toEqual('real value');
 | |
|                            return 10;
 | |
|                          })();
 | |
|         expect(retval).toBe(10);
 | |
|       });
 | |
|     });
 | |
|   });
 | |
| 
 | |
|   describe('errors', () => {
 | |
|     var originalJasmineIt: any;
 | |
|     var originalJasmineBeforeEach: any;
 | |
| 
 | |
|     var patchJasmineIt = () => {
 | |
|       var deferred = PromiseWrapper.completer();
 | |
|       originalJasmineIt = jasmine.getEnv().it;
 | |
|       jasmine.getEnv().it = (description: string, fn: any /** TODO #9100 */) => {
 | |
|         var done = () => { deferred.resolve() };
 | |
|         (<any>done).fail = (err: any /** TODO #9100 */) => { deferred.reject(err) };
 | |
|         fn(done);
 | |
|         return null;
 | |
|       };
 | |
|       return deferred.promise;
 | |
|     };
 | |
| 
 | |
|     var restoreJasmineIt = () => { jasmine.getEnv().it = originalJasmineIt; };
 | |
| 
 | |
|     var patchJasmineBeforeEach = () => {
 | |
|       var deferred = PromiseWrapper.completer();
 | |
|       originalJasmineBeforeEach = jasmine.getEnv().beforeEach;
 | |
|       jasmine.getEnv().beforeEach = (fn: any) => {
 | |
|         var done = () => { deferred.resolve() };
 | |
|         (<any>done).fail = (err: any /** TODO #9100 */) => { deferred.reject(err) };
 | |
|         fn(done);
 | |
|         return null;
 | |
|       };
 | |
|       return deferred.promise;
 | |
|     };
 | |
| 
 | |
|     var restoreJasmineBeforeEach =
 | |
|         () => { jasmine.getEnv().beforeEach = originalJasmineBeforeEach; };
 | |
| 
 | |
|     it('should fail when an asynchronous error is thrown', (done: any /** TODO #9100 */) => {
 | |
|       var itPromise = patchJasmineIt();
 | |
|       var barError = new Error('bar');
 | |
| 
 | |
|       it('throws an async error',
 | |
|          async(inject([], () => { setTimeout(() => { throw barError; }, 0); })));
 | |
| 
 | |
|       itPromise.then(
 | |
|           () => { done.fail('Expected test to fail, but it did not'); },
 | |
|           (err) => {
 | |
|             expect(err).toEqual(barError);
 | |
|             done();
 | |
|           });
 | |
|       restoreJasmineIt();
 | |
|     });
 | |
| 
 | |
|     it('should fail when a returned promise is rejected', (done: any /** TODO #9100 */) => {
 | |
|       var itPromise = patchJasmineIt();
 | |
| 
 | |
|       it('should fail with an error from a promise', async(inject([], () => {
 | |
|            var deferred = PromiseWrapper.completer();
 | |
|            var p = deferred.promise.then(() => { expect(1).toEqual(2); });
 | |
| 
 | |
|            deferred.reject('baz');
 | |
|            return p;
 | |
|          })));
 | |
| 
 | |
|       itPromise.then(
 | |
|           () => { done.fail('Expected test to fail, but it did not'); },
 | |
|           (err) => {
 | |
|             expect(err.message).toEqual('Uncaught (in promise): baz');
 | |
|             done();
 | |
|           });
 | |
|       restoreJasmineIt();
 | |
|     });
 | |
| 
 | |
|     describe('using addProviders', () => {
 | |
|       beforeEach(() => addProviders([{provide: FancyService, useValue: new FancyService()}]));
 | |
| 
 | |
|       beforeEach(inject([FancyService], (service: any /** TODO #9100 */) => {
 | |
|         expect(service.value).toEqual('real value');
 | |
|       }));
 | |
| 
 | |
|       describe('nested addProviders', () => {
 | |
| 
 | |
|         it('should fail when the injector has already been used', () => {
 | |
|           patchJasmineBeforeEach();
 | |
|           expect(() => {
 | |
|             beforeEach(() => addProviders([{provide: FancyService, useValue: new FancyService()}]));
 | |
|           })
 | |
|               .toThrowError(
 | |
|                   'addProviders can\'t be called after the injector has been already created for this test. ' +
 | |
|                   'This is most likely because you\'ve already used the injector to inject a beforeEach or the ' +
 | |
|                   'current `it` function.');
 | |
|           restoreJasmineBeforeEach();
 | |
|         });
 | |
|       });
 | |
|     });
 | |
|   });
 | |
| 
 | |
|   describe('test component builder', function() {
 | |
|     it('should instantiate a component with valid DOM',
 | |
|        async(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
 | |
| 
 | |
|          tcb.createAsync(ChildComp).then((componentFixture) => {
 | |
|            componentFixture.detectChanges();
 | |
| 
 | |
|            expect(componentFixture.debugElement.nativeElement).toHaveText('Original Child');
 | |
|          });
 | |
|        })));
 | |
| 
 | |
|     it('should allow changing members of the component',
 | |
|        async(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
 | |
| 
 | |
|          tcb.createAsync(MyIfComp).then((componentFixture) => {
 | |
|            componentFixture.detectChanges();
 | |
|            expect(componentFixture.debugElement.nativeElement).toHaveText('MyIf()');
 | |
| 
 | |
|            componentFixture.debugElement.componentInstance.showMore = true;
 | |
|            componentFixture.detectChanges();
 | |
|            expect(componentFixture.debugElement.nativeElement).toHaveText('MyIf(More)');
 | |
|          });
 | |
|        })));
 | |
| 
 | |
|     it('should override a template',
 | |
|        async(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
 | |
| 
 | |
|          tcb.overrideTemplate(MockChildComp, '<span>Mock</span>')
 | |
|              .createAsync(MockChildComp)
 | |
|              .then((componentFixture) => {
 | |
|                componentFixture.detectChanges();
 | |
|                expect(componentFixture.debugElement.nativeElement).toHaveText('Mock');
 | |
| 
 | |
|              });
 | |
|        })));
 | |
| 
 | |
|     it('should override a view',
 | |
|        async(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
 | |
| 
 | |
|          tcb.overrideView(
 | |
|                 ChildComp, new ViewMetadata({template: '<span>Modified {{childBinding}}</span>'}))
 | |
|              .createAsync(ChildComp)
 | |
|              .then((componentFixture) => {
 | |
|                componentFixture.detectChanges();
 | |
|                expect(componentFixture.debugElement.nativeElement).toHaveText('Modified Child');
 | |
| 
 | |
|              });
 | |
|        })));
 | |
| 
 | |
|     it('should override component dependencies',
 | |
|        async(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
 | |
| 
 | |
|          tcb.overrideDirective(ParentComp, ChildComp, MockChildComp)
 | |
|              .createAsync(ParentComp)
 | |
|              .then((componentFixture) => {
 | |
|                componentFixture.detectChanges();
 | |
|                expect(componentFixture.debugElement.nativeElement).toHaveText('Parent(Mock)');
 | |
| 
 | |
|              });
 | |
|        })));
 | |
| 
 | |
| 
 | |
|     it('should override child component\'s dependencies',
 | |
|        async(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
 | |
| 
 | |
|          tcb.overrideDirective(ParentComp, ChildComp, ChildWithChildComp)
 | |
|              .overrideDirective(ChildWithChildComp, ChildChildComp, MockChildChildComp)
 | |
|              .createAsync(ParentComp)
 | |
|              .then((componentFixture) => {
 | |
|                componentFixture.detectChanges();
 | |
|                expect(componentFixture.debugElement.nativeElement)
 | |
|                    .toHaveText('Parent(Original Child(ChildChild Mock))');
 | |
| 
 | |
|              });
 | |
|        })));
 | |
| 
 | |
|     it('should override a provider',
 | |
|        async(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
 | |
| 
 | |
|          tcb.overrideProviders(
 | |
|                 TestProvidersComp, [{provide: FancyService, useClass: MockFancyService}])
 | |
|              .createAsync(TestProvidersComp)
 | |
|              .then((componentFixture) => {
 | |
|                componentFixture.detectChanges();
 | |
|                expect(componentFixture.debugElement.nativeElement)
 | |
|                    .toHaveText('injected value: mocked out value');
 | |
|              });
 | |
|        })));
 | |
| 
 | |
| 
 | |
|     it('should override a viewProvider',
 | |
|        async(inject([TestComponentBuilder], (tcb: TestComponentBuilder) => {
 | |
| 
 | |
|          tcb.overrideViewProviders(
 | |
|                 TestViewProvidersComp, [{provide: FancyService, useClass: MockFancyService}])
 | |
|              .createAsync(TestViewProvidersComp)
 | |
|              .then((componentFixture) => {
 | |
|                componentFixture.detectChanges();
 | |
|                expect(componentFixture.debugElement.nativeElement)
 | |
|                    .toHaveText('injected value: mocked out value');
 | |
|              });
 | |
|        })));
 | |
|   });
 | |
| }
 |