Testing
This guide offers tips and techniques for unit and integration testing Angular applications.
The guide presents tests of a sample application created with the Angular CLI. This sample application is much like the one created in the Tour of Heroes tutorial. The sample application and all tests in this guide are available for inspection and experimentation:
- Sample app
- Tests
Setup
The Angular CLI downloads and install everything you need to test an Angular application with the Jasmine test framework.
The project you create with the CLI is immediately ready to test. Just run the ng test CLI command:
ng test
The ng test command builds the app in watch mode, and launches the Karma test runner.
The console output looks a bit like this:
10% building modules 1/1 modules 0 active ...INFO [karma]: Karma v1.7.1 server started at http://0.0.0.0:9876/ ...INFO [launcher]: Launching browser Chrome ... ...INFO [launcher]: Starting browser Chrome ...INFO [Chrome ...]: Connected on socket ... Chrome ...: Executed 3 of 3 SUCCESS (0.135 secs / 0.205 secs)
The last line of the log is the most important. It shows that Karma ran three tests that all passed.
A chrome browser also opens and displays the test output in the "Jasmine HTML Reporter" like this.
Most people find this browser output easier to read than the console log. You can click on a test row to re-run just that test or click on a description to re-run the tests in the selected test group ("test suite").
Meanwhile, the ng test command is watching for changes.
To see this in action, make a small change to app.component.ts and save. The tests run again, the browser refreshes, and the new test results appear.
Configuration
The CLI takes care of Jasmine and Karma configuration for you.
You can fine-tune many options by editing the karma.conf.js and the test.ts files in the src/ folder.
The karma.conf.js file is a partial Karma configuration file. The CLI constructs the full runtime configuration in memory, based on application structure specified in the angular.json file, supplemented by karma.conf.js.
Search the web for more details about Jasmine and Karma configuration.
Other test frameworks
You can also unit test an Angular app with other testing libraries and test runners. Each library and runner has its own distinctive installation procedures, configuration, and syntax.
Search the web to learn more.
Test file name and location
Look inside the src/app folder.
The CLI generated a test file for the AppComponent named app.component.spec.ts.
The test file extension must be
.spec.tsso that tooling can identify it as a file with tests (AKA, a spec file).
The app.component.ts and app.component.spec.ts files are siblings in the same folder. The root file names (app.component) are the same for both files.
Adopt these two conventions in your own projects for every kind of test file.
Set up continuous integration
One of the best ways to keep your project bug free is through a test suite, but it's easy to forget to run tests all the time. Continuous integration (CI) servers let you set up your project repository so that your tests run on every commit and pull request.
There are paid CI services like Circle CI and Travis CI, and you can also host your own for free using Jenkins and others. Although Circle CI and Travis CI are paid services, they are provided free for open source projects. You can create a public project on GitHub and add these services without paying. Contributions to the Angular repo are automatically run through a whole suite of Circle CI tests.
This article explains how to configure your project to run Circle CI and Travis CI, and also update your test configuration to be able to run tests in the Chrome browser in either environment.
Configure project for Circle CI
Step 1: Create a folder called .circleci at the project root.
Step 2: In the new folder, create a file called config.yml with the following content:
version: 2
jobs:
build:
working_directory: ~/my-project
docker:
- image: circleci/node:8-browsers
steps:
- checkout
- restore_cache:
key: my-project-{{ .Branch }}-{{ checksum "package-lock.json" }}
- run: npm install
- save_cache:
key: my-project-{{ .Branch }}-{{ checksum "package-lock.json" }}
paths:
- "node_modules"
- run: npm run test -- --no-watch --no-progress --browsers=ChromeHeadlessCI
- run: npm run e2e -- --protractor-config=e2e/protractor-ci.conf.js This configuration caches node_modules/ and uses npm run to run CLI commands, because @angular/cli is not installed globally. The double dash (--) is needed to pass arguments into the npm script.
Step 3: Commit your changes and push them to your repository.
Step 4: Sign up for Circle CI and add your project. Your project should start building.
- Learn more about Circle CI from Circle CI documentation.
Configure project for Travis CI
Step 1: Create a file called .travis.yml at the project root, with the following content:
dist: trusty
sudo: false
language: node_js
node_js:
- "8"
addons:
apt:
sources:
- google-chrome
packages:
- google-chrome-stable
cache:
directories:
- ./node_modules
install:
- npm install
script:
- npm run test -- --no-watch --no-progress --browsers=ChromeHeadlessCI
- npm run e2e -- --protractor-config=e2e/protractor-ci.conf.js This does the same things as the Circle CI configuration, except that Travis doesn't come with Chrome, so we use Chromium instead.
Step 2: Commit your changes and push them to your repository.
Step 3: Sign up for Travis CI and add your project. You'll need to push a new commit to trigger a build.
- Learn more about Travis CI testing from Travis CI documentation.
Configure CLI for CI testing in Chrome
When the CLI commands ng test and ng e2e are generally running the CI tests in your environment, you might still need to adjust your configuration to run the Chrome browser tests.
There are configuration files for both the Karma JavaScript test runner and Protractor end-to-end testing tool, which you must adjust to start Chrome without sandboxing.
We'll be using Headless Chrome in these examples.
- In the Karma configuration file,
karma.conf.js, add a custom launcher called ChromeHeadlessCI below browsers:
browsers: ['Chrome'],
customLaunchers: {
ChromeHeadlessCI: {
base: 'ChromeHeadless',
flags: ['--no-sandbox']
}
}, - In the root folder of your e2e tests project, create a new file named
protractor-ci.conf.js. This new file extends the originalprotractor.conf.js.
const config = require('./protractor.conf').config;
config.capabilities = {
browserName: 'chrome',
chromeOptions: {
args: ['--headless', '--no-sandbox']
}
};
exports.config = config; Now you can run the following commands to use the --no-sandbox flag:
ng test -- --no-watch --no-progress --browsers=ChromeHeadlessCI ng e2e -- --protractor-config=e2e/protractor-ci.conf.js
Note: Right now, you'll also want to include the
--disable-gpuflag if you're running on Windows. See crbug.com/737678.
Enable code coverage reports
The CLI can run unit tests and create code coverage reports. Code coverage reports show you any parts of our code base that may not be properly tested by your unit tests.
To generate a coverage report run the following command in the root of your project.
ng test --no-watch --code-coverage
When the tests are complete, the command creates a new /coverage folder in the project. Open the index.html file to see a report with your source code and code coverage values.
If you want to create code-coverage reports every time you test, you can set the following option in the CLI configuration file, angular.json:
"test": {
"options": {
"codeCoverage": true
}
} Code coverage enforcement
The code coverage percentages let you estimate how much of your code is tested. If your team decides on a set minimum amount to be unit tested, you can enforce this minimum with the Angular CLI.
For example, suppose you want the code base to have a minimum of 80% code coverage. To enable this, open the Karma test platform configuration file, karma.conf.js, and add the following in the coverageIstanbulReporter: key.
coverageIstanbulReporter: {
reports: [ 'html', 'lcovonly' ],
fixWebpackSourcePaths: true,
thresholds: {
statements: 80,
lines: 80,
branches: 80,
functions: 80
}
} The thresholds property causes the tool to enforce a minimum of 80% code coverage when the unit tests are run in the project.
Service Tests
Services are often the easiest files to unit test. Here are some synchronous and asynchronous unit tests of the ValueService written without assistance from Angular testing utilities.
// Straight Jasmine testing without Angular's testing support
describe('ValueService', () => {
let service: ValueService;
beforeEach(() => { service = new ValueService(); });
it('#getValue should return real value', () => {
expect(service.getValue()).toBe('real value');
});
it('#getObservableValue should return value from observable',
(done: DoneFn) => {
service.getObservableValue().subscribe(value => {
expect(value).toBe('observable value');
done();
});
});
it('#getPromiseValue should return value from a promise',
(done: DoneFn) => {
service.getPromiseValue().then(value => {
expect(value).toBe('promise value');
done();
});
});
}); Services with dependencies
Services often depend on other services that Angular injects into the constructor. In many cases, it's easy to create and inject these dependencies by hand while calling the service's constructor.
The MasterService is a simple example:
@Injectable()
export class MasterService {
constructor(private valueService: ValueService) { }
getValue() { return this.valueService.getValue(); }
} MasterService delegates its only method, getValue, to the injected ValueService.
Here are several ways to test it.
describe('MasterService without Angular testing support', () => {
let masterService: MasterService;
it('#getValue should return real value from the real service', () => {
masterService = new MasterService(new ValueService());
expect(masterService.getValue()).toBe('real value');
});
it('#getValue should return faked value from a fakeService', () => {
masterService = new MasterService(new FakeValueService());
expect(masterService.getValue()).toBe('faked service value');
});
it('#getValue should return faked value from a fake object', () => {
const fake = { getValue: () => 'fake value' };
masterService = new MasterService(fake as ValueService);
expect(masterService.getValue()).toBe('fake value');
});
it('#getValue should return stubbed value from a spy', () => {
// create `getValue` spy on an object representing the ValueService
const valueServiceSpy =
jasmine.createSpyObj('ValueService', ['getValue']);
// set the value to return when the `getValue` spy is called.
const stubValue = 'stub value';
valueServiceSpy.getValue.and.returnValue(stubValue);
masterService = new MasterService(valueServiceSpy);
expect(masterService.getValue())
.toBe(stubValue, 'service returned stub value');
expect(valueServiceSpy.getValue.calls.count())
.toBe(1, 'spy method was called once');
expect(valueServiceSpy.getValue.calls.mostRecent().returnValue)
.toBe(stubValue);
});
}); The first test creates a ValueService with new and passes it to the MasterService constructor.
However, injecting the real service rarely works well as most dependent services are difficult to create and control.
Instead you can mock the dependency, use a dummy value, or create a spy on the pertinent service method.
Prefer spies as they are usually the easiest way to mock services.
These standard testing techniques are great for unit testing services in isolation.
However, you almost always inject services into application classes using Angular dependency injection and you should have tests that reflect that usage pattern. Angular testing utilities make it easy to investigate how injected services behave.
Testing services with the TestBed
Your app relies on Angular dependency injection (DI) to create services. When a service has a dependent service, DI finds or creates that dependent service. And if that dependent service has its own dependencies, DI finds-or-creates them as well.
As service consumer, you don't worry about any of this. You don't worry about the order of constructor arguments or how they're created.
As a service tester, you must at least think about the first level of service dependencies but you can let Angular DI do the service creation and deal with constructor argument order when you use the TestBed testing utility to provide and create services.
Angular TestBed
The TestBed is the most important of the Angular testing utilities. The TestBed creates a dynamically-constructed Angular test module that emulates an Angular @NgModule.
The TestBed.configureTestingModule() method takes a metadata object that can have most of the properties of an @NgModule.
To test a service, you set the providers metadata property with an array of the services that you'll test or mock.
let service: ValueService;
beforeEach(() => {
TestBed.configureTestingModule({ providers: [ValueService] });
}); Then inject it inside a test by calling TestBed.get() with the service class as the argument.
it('should use ValueService', () => {
service = TestBed.get(ValueService);
expect(service.getValue()).toBe('real value');
}); Or inside the beforeEach() if you prefer to inject the service as part of your setup.
beforeEach(() => {
TestBed.configureTestingModule({ providers: [ValueService] });
service = TestBed.get(ValueService);
}); When testing a service with a dependency, provide the mock in the providers array.
In the following example, the mock is a spy object.
let masterService: MasterService;
let valueServiceSpy: jasmine.SpyObj<ValueService>;
beforeEach(() => {
const spy = jasmine.createSpyObj('ValueService', ['getValue']);
TestBed.configureTestingModule({
// Provide both the service-to-test and its (spy) dependency
providers: [
MasterService,
{ provide: ValueService, useValue: spy }
]
});
// Inject both the service-to-test and its (spy) dependency
masterService = TestBed.get(MasterService);
valueServiceSpy = TestBed.get(ValueService);
}); The test consumes that spy in the same way it did earlier.
it('#getValue should return stubbed value from a spy', () => {
const stubValue = 'stub value';
valueServiceSpy.getValue.and.returnValue(stubValue);
expect(masterService.getValue())
.toBe(stubValue, 'service returned stub value');
expect(valueServiceSpy.getValue.calls.count())
.toBe(1, 'spy method was called once');
expect(valueServiceSpy.getValue.calls.mostRecent().returnValue)
.toBe(stubValue);
}); Testing without beforeEach()
Most test suites in this guide call beforeEach() to set the preconditions for each it() test and rely on the TestBed to create classes and inject services.
There's another school of testing that never calls beforeEach() and prefers to create classes explicitly rather than use the TestBed.
Here's how you might rewrite one of the MasterService tests in that style.
Begin by putting re-usable, preparatory code in a setup function instead of beforeEach().
function setup() {
const valueServiceSpy =
jasmine.createSpyObj('ValueService', ['getValue']);
const stubValue = 'stub value';
const masterService = new MasterService(valueServiceSpy);
valueServiceSpy.getValue.and.returnValue(stubValue);
return { masterService, stubValue, valueServiceSpy };
} The setup() function returns an object literal with the variables, such as masterService, that a test might reference. You don't define semi-global variables (e.g., let masterService: MasterService) in the body of the describe().
Then each test invokes setup() in its first line, before continuing with steps that manipulate the test subject and assert expectations.
it('#getValue should return stubbed value from a spy', () => {
const { masterService, stubValue, valueServiceSpy } = setup();
expect(masterService.getValue())
.toBe(stubValue, 'service returned stub value');
expect(valueServiceSpy.getValue.calls.count())
.toBe(1, 'spy method was called once');
expect(valueServiceSpy.getValue.calls.mostRecent().returnValue)
.toBe(stubValue);
}); Notice how the test uses destructuring assignment to extract the setup variables that it needs.
const { masterService, stubValue, valueServiceSpy } = setup(); Many developers feel this approach is cleaner and more explicit than the traditional beforeEach() style.
Although this testing guide follows the traditional style and the default CLI schematics generate test files with beforeEach() and TestBed, feel free to adopt this alternative approach in your own projects.
Testing HTTP services
Data services that make HTTP calls to remote servers typically inject and delegate to the Angular HttpClient service for XHR calls.
You can test a data service with an injected HttpClient spy as you would test any service with a dependency.
let httpClientSpy: { get: jasmine.Spy };
let heroService: HeroService;
beforeEach(() => {
// TODO: spy on other methods too
httpClientSpy = jasmine.createSpyObj('HttpClient', ['get']);
heroService = new HeroService(<any> httpClientSpy);
});
it('should return expected heroes (HttpClient called once)', () => {
const expectedHeroes: Hero[] =
[{ id: 1, name: 'A' }, { id: 2, name: 'B' }];
httpClientSpy.get.and.returnValue(asyncData(expectedHeroes));
heroService.getHeroes().subscribe(
heroes => expect(heroes).toEqual(expectedHeroes, 'expected heroes'),
fail
);
expect(httpClientSpy.get.calls.count()).toBe(1, 'one call');
});
it('should return an error when the server returns a 404', () => {
const errorResponse = new HttpErrorResponse({
error: 'test 404 error',
status: 404, statusText: 'Not Found'
});
httpClientSpy.get.and.returnValue(asyncError(errorResponse));
heroService.getHeroes().subscribe(
heroes => fail('expected an error, not heroes'),
error => expect(error.message).toContain('test 404 error')
);
}); The
HeroServicemethods returnObservables. You must subscribe to an observable to (a) cause it to execute and (b) assert that the method succeeds or fails.The
subscribe()method takes a success (next) and fail (error) callback. Make sure you provide both callbacks so that you capture errors. Neglecting to do so produces an asynchronous uncaught observable error that the test runner will likely attribute to a completely different test.
HttpClientTestingModule
Extended interactions between a data service and the HttpClient can be complex and difficult to mock with spies.
The HttpClientTestingModule can make these testing scenarios more manageable.
While the code sample accompanying this guide demonstrates HttpClientTestingModule, this page defers to the Http guide, which covers testing with the HttpClientTestingModule in detail.
This guide's sample code also demonstrates testing of the legacy
HttpModuleinapp/model/http-hero.service.spec.ts.
Component Test Basics
A component, unlike all other parts of an Angular application, combines an HTML template and a TypeScript class. The component truly is the template and the class working together. and to adequately test a component, you should test that they work together as intended.
Such tests require creating the component's host element in the browser DOM, as Angular does, and investigating the component class's interaction with the DOM as described by its template.
The Angular TestBed facilitates this kind of testing as you'll see in the sections below. But in many cases, testing the component class alone, without DOM involvement, can validate much of the component's behavior in an easier, more obvious way.
Component class testing
Test a component class on its own as you would test a service class.
Consider this LightswitchComponent which toggles a light on and off (represented by an on-screen message) when the user clicks the button.
@Component({
selector: 'lightswitch-comp',
template: `
<button (click)="clicked()">Click me!</button>
<span>{{message}}</span>`
})
export class LightswitchComponent {
isOn = false;
clicked() { this.isOn = !this.isOn; }
get message() { return `The light is ${this.isOn ? 'On' : 'Off'}`; }
} You might decide only to test that the clicked() method toggles the light's on/off state and sets the message appropriately.
This component class has no dependencies. To test a service with no dependencies, you create it with new, poke at its API, and assert expectations on its public state. Do the same with the component class.
describe('LightswitchComp', () => {
it('#clicked() should toggle #isOn', () => {
const comp = new LightswitchComponent();
expect(comp.isOn).toBe(false, 'off at first');
comp.clicked();
expect(comp.isOn).toBe(true, 'on after click');
comp.clicked();
expect(comp.isOn).toBe(false, 'off after second click');
});
it('#clicked() should set #message to "is on"', () => {
const comp = new LightswitchComponent();
expect(comp.message).toMatch(/is off/i, 'off at first');
comp.clicked();
expect(comp.message).toMatch(/is on/i, 'on after clicked');
});
}); Here is the DashboardHeroComponent from the Tour of Heroes tutorial.
export class DashboardHeroComponent {
@Input() hero: Hero;
@Output() selected = new EventEmitter<Hero>();
click() { this.selected.emit(this.hero); }
} It appears within the template of a parent component, which binds a hero to the @Input property and listens for an event raised through the selected @Output property.
You can test that the class code works without creating the DashboardHeroComponent or its parent component.
it('raises the selected event when clicked', () => {
const comp = new DashboardHeroComponent();
const hero: Hero = { id: 42, name: 'Test' };
comp.hero = hero;
comp.selected.subscribe(selectedHero => expect(selectedHero).toBe(hero));
comp.click();
}); When a component has dependencies, you may wish to use the TestBed to both create the component and its dependencies.
The following WelcomeComponent depends on the UserService to know the name of the user to greet.
export class WelcomeComponent implements OnInit {
welcome: string;
constructor(private userService: UserService) { }
ngOnInit(): void {
this.welcome = this.userService.isLoggedIn ?
'Welcome, ' + this.userService.user.name : 'Please log in.';
}
} You might start by creating a mock of the UserService that meets the minimum needs of this component.
class MockUserService {
isLoggedIn = true;
user = { name: 'Test User'};
}; Then provide and inject both the component and the service in the TestBed configuration.
beforeEach(() => {
TestBed.configureTestingModule({
// provide the component-under-test and dependent service
providers: [
WelcomeComponent,
{ provide: UserService, useClass: MockUserService }
]
});
// inject both the component and the dependent service.
comp = TestBed.get(WelcomeComponent);
userService = TestBed.get(UserService);
}); Then exercise the component class, remembering to call the lifecycle hook methods as Angular does when running the app.
it('should not have welcome message after construction', () => {
expect(comp.welcome).toBeUndefined();
});
it('should welcome logged in user after Angular calls ngOnInit', () => {
comp.ngOnInit();
expect(comp.welcome).toContain(userService.user.name);
});
it('should ask user to log in if not logged in after ngOnInit', () => {
userService.isLoggedIn = false;
comp.ngOnInit();
expect(comp.welcome).not.toContain(userService.user.name);
expect(comp.welcome).toContain('log in');
}); Component DOM testing
Testing the component class is as easy as testing a service.
But a component is more than just its class. A component interacts with the DOM and with other components. The class-only tests can tell you about class behavior. They cannot tell you if the component is going to render properly, respond to user input and gestures, or integrate with its parent and child components.
None of the class-only tests above can answer key questions about how the components actually behave on screen.
- Is
Lightswitch.clicked()bound to anything such that the user can invoke it? - Is the
Lightswitch.messagedisplayed? - Can the user actually select the hero displayed by
DashboardHeroComponent? - Is the hero name displayed as expected (i.e, in uppercase)?
- Is the welcome message displayed by the template of
WelcomeComponent?
These may not be troubling questions for the simple components illustrated above. But many components have complex interactions with the DOM elements described in their templates, causing HTML to appear and disappear as the component state changes.
To answer these kinds of questions, you have to create the DOM elements associated with the components, you must examine the DOM to confirm that component state displays properly at the appropriate times, and you must simulate user interaction with the screen to determine whether those interactions cause the component to behave as expected.
To write these kinds of test, you'll use additional features of the TestBed as well as other testing helpers.
CLI-generated tests
The CLI creates an initial test file for you by default when you ask it to generate a new component.
For example, the following CLI command generates a BannerComponent in the app/banner folder (with inline template and styles):
ng generate component banner --inline-template --inline-style --module app
It also generates an initial test file for the component, banner-external.component.spec.ts, that looks like this:
import { async, ComponentFixture, TestBed } from '@angular/core/testing';
import { BannerComponent } from './banner.component';
describe('BannerComponent', () => {
let component: BannerComponent;
let fixture: ComponentFixture<BannerComponent>;
beforeEach(async(() => {
TestBed.configureTestingModule({
declarations: [ BannerComponent ]
})
.compileComponents();
}));
beforeEach(() => {
fixture = TestBed.createComponent(BannerComponent);
component = fixture.componentInstance;
fixture.detectChanges();
});
it('should create', () => {
expect(component).toBeDefined();
});
}); Reduce the setup
Only the last three lines of this file actually test the component and all they do is assert that Angular can create the component.
The rest of the file is boilerplate setup code anticipating more advanced tests that might become necessary if the component evolves into something substantial.
You'll learn about these advanced test features below. For now, you can radically reduce this test file to a more manageable size:
describe('BannerComponent (minimal)', () => {
it('should create', () => {
TestBed.configureTestingModule({
declarations: [ BannerComponent ]
});
const fixture = TestBed.createComponent(BannerComponent);
const component = fixture.componentInstance;
expect(component).toBeDefined();
});
}); In this example, the metadata object passed to TestBed.configureTestingModule simply declares BannerComponent, the component to test.
TestBed.configureTestingModule({
declarations: [ BannerComponent ]
}); There's no need to declare or import anything else. The default test module is pre-configured with something like the
BrowserModulefrom@angular/platform-browser.Later you'll call
TestBed.configureTestingModule()with imports, providers, and more declarations to suit your testing needs. Optionaloverridemethods can further fine-tune aspects of the configuration.
createComponent()
After configuring TestBed, you call its createComponent() method.
const fixture = TestBed.createComponent(BannerComponent);
TestBed.createComponent() creates an instance of the BannerComponent, adds a corresponding element to the test-runner DOM, and returns a ComponentFixture.
Do not re-configure
TestBedafter callingcreateComponent.The
createComponentmethod freezes the currentTestBeddefinition, closing it to further configuration.You cannot call any more
TestBedconfiguration methods, notconfigureTestingModule(), norget(), nor any of theoverride...methods. If you try,TestBedthrows an error.
ComponentFixture
The ComponentFixture is a test harness for interacting with the created component and its corresponding element.
Access the component instance through the fixture and confirm it exists with a Jasmine expectation:
const component = fixture.componentInstance; expect(component).toBeDefined();
beforeEach()
You will add more tests as this component evolves. Rather than duplicate the TestBed configuration for each test, you refactor to pull the setup into a Jasmine beforeEach() and some supporting variables:
describe('BannerComponent (with beforeEach)', () => {
let component: BannerComponent;
let fixture: ComponentFixture<BannerComponent>;
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [ BannerComponent ]
});
fixture = TestBed.createComponent(BannerComponent);
component = fixture.componentInstance;
});
it('should create', () => {
expect(component).toBeDefined();
});
}); Now add a test that gets the component's element from fixture.nativeElement and looks for the expected text.
it('should contain "banner works!"', () => {
const bannerElement: HTMLElement = fixture.nativeElement;
expect(bannerElement.textContent).toContain('banner works!');
}); nativeElement
The value of ComponentFixture.nativeElement has the any type. Later you'll encounter the DebugElement.nativeElement and it too has the any type.
Angular can't know at compile time what kind of HTML element the nativeElement is or if it even is an HTML element. The app might be running on a non-browser platform, such as the server or a Web Worker, where the element may have a diminished API or not exist at all.
The tests in this guide are designed to run in a browser so a nativeElement value will always be an HTMLElement or one of its derived classes.
Knowing that it is an HTMLElement of some sort, you can use the standard HTML querySelector to dive deeper into the element tree.
Here's another test that calls HTMLElement.querySelector to get the paragraph element and look for the banner text:
it('should have <p> with "banner works!"', () => {
const bannerElement: HTMLElement = fixture.nativeElement;
const p = bannerElement.querySelector('p');
expect(p.textContent).toEqual('banner works!');
}); DebugElement
The Angular fixture provides the component's element directly through the fixture.nativeElement.
const bannerElement: HTMLElement = fixture.nativeElement;
This is actually a convenience method, implemented as fixture.debugElement.nativeElement.
const bannerDe: DebugElement = fixture.debugElement; const bannerEl: HTMLElement = bannerDe.nativeElement;
There's a good reason for this circuitous path to the element.
The properties of the nativeElement depend upon the runtime environment. You could be running these tests on a non-browser platform that doesn't have a DOM or whose DOM-emulation doesn't support the full HTMLElement API.
Angular relies on the DebugElement abstraction to work safely across all supported platforms. Instead of creating an HTML element tree, Angular creates a DebugElement tree that wraps the native elements for the runtime platform. The nativeElement property unwraps the DebugElement and returns the platform-specific element object.
Because the sample tests for this guide are designed to run only in a browser, a nativeElement in these tests is always an HTMLElement whose familiar methods and properties you can explore within a test.
Here's the previous test, re-implemented with fixture.debugElement.nativeElement:
it('should find the <p> with fixture.debugElement.nativeElement)', () => {
const bannerDe: DebugElement = fixture.debugElement;
const bannerEl: HTMLElement = bannerDe.nativeElement;
const p = bannerEl.querySelector('p');
expect(p.textContent).toEqual('banner works!');
}); The DebugElement has other methods and properties that are useful in tests, as you'll see elsewhere in this guide.
You import the DebugElement symbol from the Angular core library.
import { DebugElement } from '@angular/core'; By.css()
Although the tests in this guide all run in the browser, some apps might run on a different platform at least some of the time.
For example, the component might render first on the server as part of a strategy to make the application launch faster on poorly connected devices. The server-side renderer might not support the full HTML element API. If it doesn't support querySelector, the previous test could fail.
The DebugElement offers query methods that work for all supported platforms. These query methods take a predicate function that returns true when a node in the DebugElement tree matches the selection criteria.
You create a predicate with the help of a By class imported from a library for the runtime platform. Here's the By import for the browser platform:
import { By } from '@angular/platform-browser'; The following example re-implements the previous test with DebugElement.query() and the browser's By.css method.
it('should find the <p> with fixture.debugElement.query(By.css)', () => {
const bannerDe: DebugElement = fixture.debugElement;
const paragraphDe = bannerDe.query(By.css('p'));
const p: HTMLElement = paragraphDe.nativeElement;
expect(p.textContent).toEqual('banner works!');
}); Some noteworthy observations:
- The
By.css()static method selectsDebugElementnodes with a standard CSS selector. - The query returns a
DebugElementfor the paragraph. - You must unwrap that result to get the paragraph element.
When you're filtering by CSS selector and only testing properties of a browser's native element, the By.css approach may be overkill.
It's often easier and more clear to filter with a standard HTMLElement method such as querySelector() or querySelectorAll(), as you'll see in the next set of tests.
Component Test Scenarios
The following sections, comprising most of this guide, explore common component testing scenarios
Component binding
The current BannerComponent presents static title text in the HTML template.
After a few changes, the BannerComponent presents a dynamic title by binding to the component's title property like this.
@Component({
selector: 'app-banner',
template: '<h1>{{title}}</h1>',
styles: ['h1 { color: green; font-size: 350%}']
})
export class BannerComponent {
title = 'Test Tour of Heroes';
} Simple as this is, you decide to add a test to confirm that component actually displays the right content where you think it should.
Query for the <h1>
You'll write a sequence of tests that inspect the value of the <h1> element that wraps the title property interpolation binding.
You update the beforeEach to find that element with a standard HTML querySelector and assign it to the h1 variable.
let component: BannerComponent;
let fixture: ComponentFixture<BannerComponent>;
let h1: HTMLElement;
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [ BannerComponent ],
});
fixture = TestBed.createComponent(BannerComponent);
component = fixture.componentInstance; // BannerComponent test instance
h1 = fixture.nativeElement.querySelector('h1');
}); createComponent() does not bind data
For your first test you'd like to see that the screen displays the default title. Your instinct is to write a test that immediately inspects the <h1> like this:
it('should display original title', () => {
expect(h1.textContent).toContain(component.title);
}); That test fails with the message:
expected '' to contain 'Test Tour of Heroes'.
Binding happens when Angular performs change detection.
In production, change detection kicks in automatically when Angular creates a component or the user enters a keystroke or an asynchronous activity (e.g., AJAX) completes.
The TestBed.createComponent does not trigger change detection. a fact confirmed in the revised test:
it('no title in the DOM after createComponent()', () => {
expect(h1.textContent).toEqual('');
}); detectChanges()
You must tell the TestBed to perform data binding by calling fixture.detectChanges(). Only then does the <h1> have the expected title.
it('should display original title after detectChanges()', () => {
fixture.detectChanges();
expect(h1.textContent).toContain(component.title);
}); Delayed change detection is intentional and useful. It gives the tester an opportunity to inspect and change the state of the component before Angular initiates data binding and calls lifecycle hooks.
Here's another test that changes the component's title property before calling fixture.detectChanges().
it('should display a different test title', () => {
component.title = 'Test Title';
fixture.detectChanges();
expect(h1.textContent).toContain('Test Title');
}); Automatic change detection
The BannerComponent tests frequently call detectChanges. Some testers prefer that the Angular test environment run change detection automatically.
That's possible by configuring the TestBed with the ComponentFixtureAutoDetect provider. First import it from the testing utility library:
import { ComponentFixtureAutoDetect } from '@angular/core/testing'; Then add it to the providers array of the testing module configuration:
TestBed.configureTestingModule({
declarations: [ BannerComponent ],
providers: [
{ provide: ComponentFixtureAutoDetect, useValue: true }
]
}); Here are three tests that illustrate how automatic change detection works.
it('should display original title', () => {
// Hooray! No `fixture.detectChanges()` needed
expect(h1.textContent).toContain(comp.title);
});
it('should still see original title after comp.title change', () => {
const oldTitle = comp.title;
comp.title = 'Test Title';
// Displayed title is old because Angular didn't hear the change :(
expect(h1.textContent).toContain(oldTitle);
});
it('should display updated title after detectChanges', () => {
comp.title = 'Test Title';
fixture.detectChanges(); // detect changes explicitly
expect(h1.textContent).toContain(comp.title);
}); The first test shows the benefit of automatic change detection.
The second and third test reveal an important limitation. The Angular testing environment does not know that the test changed the component's title. The ComponentFixtureAutoDetect service responds to asynchronous activities such as promise resolution, timers, and DOM events. But a direct, synchronous update of the component property is invisible. The test must call fixture.detectChanges() manually to trigger another cycle of change detection.
Rather than wonder when the test fixture will or won't perform change detection, the samples in this guide always call
detectChanges()explicitly. There is no harm in callingdetectChanges()more often than is strictly necessary.
Change an input value with dispatchEvent()
To simulate user input, you can find the input element and set its value property.
You will call fixture.detectChanges() to trigger Angular's change detection. But there is an essential, intermediate step.
Angular doesn't know that you set the input element's value property. It won't read that property until you raise the element's input event by calling dispatchEvent(). Then you call detectChanges().
The following example demonstrates the proper sequence.
it('should convert hero name to Title Case', () => {
// get the name's input and display elements from the DOM
const hostElement = fixture.nativeElement;
const nameInput: HTMLInputElement = hostElement.querySelector('input');
const nameDisplay: HTMLElement = hostElement.querySelector('span');
// simulate user entering a new name into the input box
nameInput.value = 'quick BROWN fOx';
// dispatch a DOM event so that Angular learns of input value change.
nameInput.dispatchEvent(newEvent('input'));
// Tell Angular to update the display binding through the title pipe
fixture.detectChanges();
expect(nameDisplay.textContent).toBe('Quick Brown Fox');
}); Component with external files
The BannerComponent above is defined with an inline template and inline css, specified in the @Component.template and @Component.styles properties respectively.
Many components specify external templates and external css with the @Component.templateUrl and @Component.styleUrls properties respectively, as the following variant of BannerComponent does.
@Component({
selector: 'app-banner',
templateUrl: './banner-external.component.html',
styleUrls: ['./banner-external.component.css']
}) This syntax tells the Angular compiler to read the external files during component compilation.
That's not a problem when you run the CLI ng test command because it compiles the app before running the tests.
However, if you run the tests in a non-CLI environment, tests of this component may fail. For example, if you run the BannerComponent tests in a web coding environment such as plunker, you'll see a message like this one:
Error: This test module uses the component BannerComponent which is using a "templateUrl" or "styleUrls", but they were never compiled. Please call "TestBed.compileComponents" before your test.
You get this test failure message when the runtime environment compiles the source code during the tests themselves.
To correct the problem, call compileComponents() as explained below.
Component with a dependency
Components often have service dependencies.
The WelcomeComponent displays a welcome message to the logged in user. It knows who the user is based on a property of the injected UserService:
import { Component, OnInit } from '@angular/core';
import { UserService } from '../model/user.service';
@Component({
selector: 'app-welcome',
template: '<h3 class="welcome"><i>{{welcome}}</i></h3>'
})
export class WelcomeComponent implements OnInit {
welcome: string;
constructor(private userService: UserService) { }
ngOnInit(): void {
this.welcome = this.userService.isLoggedIn ?
'Welcome, ' + this.userService.user.name : 'Please log in.';
}
} The WelcomeComponent has decision logic that interacts with the service, logic that makes this component worth testing. Here's the testing module configuration for the spec file, app/welcome/welcome.component.spec.ts:
TestBed.configureTestingModule({
declarations: [ WelcomeComponent ],
// providers: [ UserService ] // NO! Don't provide the real service!
// Provide a test-double instead
providers: [ {provide: UserService, useValue: userServiceStub } ]
}); This time, in addition to declaring the component-under-test, the configuration adds a UserService provider to the providers list. But not the real UserService.
Provide service test doubles
A component-under-test doesn't have to be injected with real services. In fact, it is usually better if they are test doubles (stubs, fakes, spies, or mocks). The purpose of the spec is to test the component, not the service, and real services can be trouble.
Injecting the real UserService could be a nightmare. The real service might ask the user for login credentials and attempt to reach an authentication server. These behaviors can be hard to intercept. It is far easier and safer to create and register a test double in place of the real UserService.
This particular test suite supplies a minimal mock of the UserService that satisfies the needs of the WelcomeComponent and its tests:
let userServiceStub: Partial<UserService>;
userServiceStub = {
isLoggedIn: true,
user: { name: 'Test User'}
}; Get injected services
The tests need access to the (stub) UserService injected into the WelcomeComponent.
Angular has a hierarchical injection system. There can be injectors at multiple levels, from the root injector created by the TestBed down through the component tree.
The safest way to get the injected service, the way that always works, is to get it from the injector of the component-under-test. The component injector is a property of the fixture's DebugElement.
// UserService actually injected into the component userService = fixture.debugElement.injector.get(UserService);
TestBed.get()
You may also be able to get the service from the root injector via TestBed.get(). This is easier to remember and less verbose. But it only works when Angular injects the component with the service instance in the test's root injector.
In this test suite, the only provider of UserService is the root testing module, so it is safe to call TestBed.get() as follows:
// UserService from the root injector userService = TestBed.get(UserService);
For a use case in which
TestBed.get()does not work, see the Override component providers section that explains when and why you must get the service from the component's injector instead.
Always get the service from an injector
Do not reference the userServiceStub object that's provided to the testing module in the body of your test. It does not work! The userService instance injected into the component is a completely different object, a clone of the provided userServiceStub.
it('stub object and injected UserService should not be the same', () => {
expect(userServiceStub === userService).toBe(false);
// Changing the stub object has no effect on the injected service
userServiceStub.isLoggedIn = false;
expect(userService.isLoggedIn).toBe(true);
}); Final setup and tests
Here's the complete beforeEach(), using TestBed.get():
let userServiceStub: Partial<UserService>;
beforeEach(() => {
// stub UserService for test purposes
userServiceStub = {
isLoggedIn: true,
user: { name: 'Test User'}
};
TestBed.configureTestingModule({
declarations: [ WelcomeComponent ],
providers: [ {provide: UserService, useValue: userServiceStub } ]
});
fixture = TestBed.createComponent(WelcomeComponent);
comp = fixture.componentInstance;
// UserService from the root injector
userService = TestBed.get(UserService);
// get the "welcome" element by CSS selector (e.g., by class name)
el = fixture.nativeElement.querySelector('.welcome');
}); And here are some tests:
it('should welcome the user', () => {
fixture.detectChanges();
const content = el.textContent;
expect(content).toContain('Welcome', '"Welcome ..."');
expect(content).toContain('Test User', 'expected name');
});
it('should welcome "Bubba"', () => {
userService.user.name = 'Bubba'; // welcome message hasn't been shown yet
fixture.detectChanges();
expect(el.textContent).toContain('Bubba');
});
it('should request login if not logged in', () => {
userService.isLoggedIn = false; // welcome message hasn't been shown yet
fixture.detectChanges();
const content = el.textContent;
expect(content).not.toContain('Welcome', 'not welcomed');
expect(content).toMatch(/log in/i, '"log in"');
}); The first is a sanity test; it confirms that the stubbed UserService is called and working.
The second parameter to the Jasmine matcher (e.g.,
'expected name') is an optional failure label. If the expectation fails, Jasmine displays appends this label to the expectation failure message. In a spec with multiple expectations, it can help clarify what went wrong and which expectation failed.
The remaining tests confirm the logic of the component when the service returns different values. The second test validates the effect of changing the user name. The third test checks that the component displays the proper message when there is no logged-in user.
Component with async service
In this sample, the AboutComponent template hosts a TwainComponent. The TwainComponent displays Mark Twain quotes.
template: `
<p class="twain"><i>{{quote | async}}</i></p>
<button (click)="getQuote()">Next quote</button>
<p class="error" *ngIf="errorMessage">{{ errorMessage }}</p>`, Note that value of the component's quote property passes through an AsyncPipe. That means the property returns either a Promise or an Observable.
In this example, the TwainComponent.getQuote() method tells you that the quote property returns an Observable.
getQuote() {
this.errorMessage = '';
this.quote = this.twainService.getQuote().pipe(
startWith('...'),
catchError( (err: any) => {
// Wait a turn because errorMessage already set once this turn
setTimeout(() => this.errorMessage = err.message || err.toString());
return of('...'); // reset message to placeholder
})
); The TwainComponent gets quotes from an injected TwainService. The component starts the returned Observable with a placeholder value ('...'), before the service can returns its first quote.
The catchError intercepts service errors, prepares an error message, and returns the placeholder value on the success channel. It must wait a tick to set the errorMessage in order to avoid updating that message twice in the same change detection cycle.
These are all features you'll want to test.
Testing with a spy
When testing a component, only the service's public API should matter. In general, tests themselves should not make calls to remote servers. They should emulate such calls. The setup in this app/twain/twain.component.spec.ts shows one way to do that:
beforeEach(() => {
testQuote = 'Test Quote';
// Create a fake TwainService object with a `getQuote()` spy
const twainService = jasmine.createSpyObj('TwainService', ['getQuote']);
// Make the spy return a synchronous Observable with the test data
getQuoteSpy = twainService.getQuote.and.returnValue( of(testQuote) );
TestBed.configureTestingModule({
declarations: [ TwainComponent ],
providers: [
{ provide: TwainService, useValue: twainService }
]
});
fixture = TestBed.createComponent(TwainComponent);
component = fixture.componentInstance;
quoteEl = fixture.nativeElement.querySelector('.twain');
}); Focus on the spy.
// Create a fake TwainService object with a `getQuote()` spy
const twainService = jasmine.createSpyObj('TwainService', ['getQuote']);
// Make the spy return a synchronous Observable with the test data
getQuoteSpy = twainService.getQuote.and.returnValue( of(testQuote) ); The spy is designed such that any call to getQuote receives an observable with a test quote. Unlike the real getQuote() method, this spy bypasses the server and returns a synchronous observable whose value is available immediately.
You can write many useful tests with this spy, even though its Observable is synchronous.
Synchronous tests
A key advantage of a synchronous Observable is that you can often turn asynchronous processes into synchronous tests.
it('should show quote after component initialized', () => {
fixture.detectChanges(); // onInit()
// sync spy result shows testQuote immediately after init
expect(quoteEl.textContent).toBe(testQuote);
expect(getQuoteSpy.calls.any()).toBe(true, 'getQuote called');
}); Because the spy result returns synchronously, the getQuote() method updates the message on screen immediately after the first change detection cycle during which Angular calls ngOnInit.
You're not so lucky when testing the error path. Although the service spy will return an error synchronously, the component method calls setTimeout(). The test must wait at least one full turn of the JavaScript engine before the value becomes available. The test must become asynchronous.
Async test with fakeAsync()
To use fakeAsync() functionality, you need to import zone-testing, for details, please read setup guide.
The following test confirms the expected behavior when the service returns an ErrorObservable.
it('should display error when TwainService fails', fakeAsync(() => {
// tell spy to return an error observable
getQuoteSpy.and.returnValue(
throwError('TwainService test failure'));
fixture.detectChanges(); // onInit()
// sync spy errors immediately after init
tick(); // flush the component's setTimeout()
fixture.detectChanges(); // update errorMessage within setTimeout()
expect(errorMessage()).toMatch(/test failure/, 'should display error');
expect(quoteEl.textContent).toBe('...', 'should show placeholder');
})); Note that the it() function receives an argument of the following form.
fakeAsync(() => { /* test body */ })` The fakeAsync() function enables a linear coding style by running the test body in a special fakeAsync test zone. The test body appears to be synchronous. There is no nested syntax (like a Promise.then()) to disrupt the flow of control.
The tick() function
You do have to call tick() to advance the (virtual) clock.
Calling tick() simulates the passage of time until all pending asynchronous activities finish. In this case, it waits for the error handler's setTimeout();
The tick() function accepts milliseconds as parameter (defaults to 0 if not provided). The parameter represents how much the virtual clock advances. For example, if you have a setTimeout(fn, 100) in a fakeAsync() test, you need to use tick(100) to trigger the fn callback.
it('should run timeout callback with delay after call tick with millis', fakeAsync(() => {
let called = false;
setTimeout(() => { called = true; }, 100);
tick(100);
expect(called).toBe(true);
})); The tick() function is one of the Angular testing utilities that you import with TestBed. It's a companion to fakeAsync() and you can only call it within a fakeAsync() body.
Comparing dates inside fakeAsync()
fakeAsync() simulates passage of time, which allows you to calculate the difference between dates inside fakeAsync().
it('should get Date diff correctly in fakeAsync', fakeAsync(() => {
const start = Date.now();
tick(100);
const end = Date.now();
expect(end - start).toBe(100);
})); jasmine.clock with fakeAsync()
Jasmine also provides a clock feature to mock dates. Angular automatically runs tests that are run after jasmine.clock().install() is called inside a fakeAsync() method until jasmine.clock().uninstall() is called. fakeAsync() is not needed and throws an error if nested.
By default, this feature is disabled. To enable it, set a global flag before import zone-testing.
If you use the Angular CLI, configure this flag in src/test.ts.
(window as any)['__zone_symbol__fakeAsyncPatchLock'] = true; import 'zone.js/dist/zone-testing';
describe('use jasmine.clock()', () => {
// need to config __zone_symbol__fakeAsyncPatchLock flag
// before loading zone.js/dist/zone-testing
beforeEach(() => { jasmine.clock().install(); });
afterEach(() => { jasmine.clock().uninstall(); });
it('should auto enter fakeAsync', () => {
// is in fakeAsync now, don't need to call fakeAsync(testFn)
let called = false;
setTimeout(() => { called = true; }, 100);
jasmine.clock().tick(100);
expect(called).toBe(true);
});
}); Using the RxJS scheduler inside fakeAsync()
You can also use RxJS scheduler in fakeAsync() just like using setTimeout() or setInterval(), but you need to import zone.js/dist/zone-patch-rxjs-fake-async to patch RxJS scheduler.
it('should get Date diff correctly in fakeAsync with rxjs scheduler', fakeAsync(() => {
// need to add `import 'zone.js/dist/zone-patch-rxjs-fake-async'
// to patch rxjs scheduler
let result = null;
of ('hello').pipe(delay(1000)).subscribe(v => { result = v; });
expect(result).toBeNull();
tick(1000);
expect(result).toBe('hello');
const start = new Date().getTime();
let dateDiff = 0;
interval(1000).pipe(take(2)).subscribe(() => dateDiff = (new Date().getTime() - start));
tick(1000);
expect(dateDiff).toBe(1000);
tick(1000);
expect(dateDiff).toBe(2000);
})); Support more macroTasks
By default fakeAsync() supports the following macroTasks.
- setTimeout
- setInterval
- requestAnimationFrame
- webkitRequestAnimationFrame
- mozRequestAnimationFrame
If you run other macroTask such as HTMLCanvasElement.toBlob(), Unknown macroTask scheduled in fake async test error will be thrown.
import { TestBed, async, tick, fakeAsync } from '@angular/core/testing';
import { CanvasComponent } from './canvas.component';
describe('CanvasComponent', () => {
beforeEach(async(() => {
TestBed.configureTestingModule({
declarations: [
CanvasComponent
],
}).compileComponents();
}));
beforeEach(() => {
window['__zone_symbol__FakeAsyncTestMacroTask'] = [
{
source: 'HTMLCanvasElement.toBlob',
callbackArgs: [{ size: 200 }]
}
];
});
it('should be able to generate blob data from canvas', fakeAsync(() => {
const fixture = TestBed.createComponent(CanvasComponent);
fixture.detectChanges();
tick();
const app = fixture.debugElement.componentInstance;
expect(app.blobSize).toBeGreaterThan(0);
}));
}); import { Component, AfterViewInit, ViewChild } from '@angular/core';
@Component({
selector: 'sample-canvas',
template: '<canvas #sampleCanvas width="200" height="200"></canvas>'
})
export class CanvasComponent implements AfterViewInit {
blobSize: number;
@ViewChild('sampleCanvas') sampleCanvas;
constructor() { }
ngAfterViewInit() {
const canvas = this.sampleCanvas.nativeElement;
const context = canvas.getContext('2d');
if (context) {
context.clearRect(0, 0, 200, 200);
context.fillStyle = '#FF1122';
context.fillRect(0, 0, 200, 200);
canvas.toBlob((blob: any) => {
this.blobSize = blob.size;
});
}
}
} If you want to support such case, you need to define the macroTask you want to support in beforeEach(). For example:
beforeEach(() => {
window['__zone_symbol__FakeAsyncTestMacroTask'] = [
{
source: 'HTMLCanvasElement.toBlob',
callbackArgs: [{ size: 200 }]
}
];
});
it('toBlob should be able to run in fakeAsync', fakeAsync(() => {
const canvas: HTMLCanvasElement = document.getElementById('canvas') as HTMLCanvasElement;
let blob = null;
canvas.toBlob(function(b) {
blob = b;
});
tick();
expect(blob.size).toBe(200);
})
); Async observables
You might be satisfied with the test coverage of these tests.
But you might be troubled by the fact that the real service doesn't quite behave this way. The real service sends requests to a remote server. A server takes time to respond and the response certainly won't be available immediately as in the previous two tests.
Your tests will reflect the real world more faithfully if you return an asynchronous observable from the getQuote() spy like this.
// Simulate delayed observable values with the `asyncData()` helper getQuoteSpy.and.returnValue(asyncData(testQuote));
Async observable helpers
The async observable was produced by an asyncData helper The asyncData helper is a utility function that you'll have to write yourself. Or you can copy this one from the sample code.
/** Create async observable that emits-once and completes
* after a JS engine turn */
export function asyncData<T>(data: T) {
return defer(() => Promise.resolve(data));
} This helper's observable emits the data value in the next turn of the JavaScript engine.
The RxJS defer() operator returns an observable. It takes a factory function that returns either a promise or an observable. When something subscribes to defer's observable, it adds the subscriber to a new observable created with that factory.
The defer() operator transforms the Promise.resolve() into a new observable that, like HttpClient, emits once and completes. Subscribers are unsubscribed after they receive the data value.
There's a similar helper for producing an async error.
/** Create async observable error that errors
* after a JS engine turn */
export function asyncError<T>(errorObject: any) {
return defer(() => Promise.reject(errorObject));
} More async tests
Now that the getQuote() spy is returning async observables, most of your tests will have to be async as well.
Here's a fakeAsync() test that demonstrates the data flow you'd expect in the real world.
it('should show quote after getQuote (fakeAsync)', fakeAsync(() => {
fixture.detectChanges(); // ngOnInit()
expect(quoteEl.textContent).toBe('...', 'should show placeholder');
tick(); // flush the observable to get the quote
fixture.detectChanges(); // update view
expect(quoteEl.textContent).toBe(testQuote, 'should show quote');
expect(errorMessage()).toBeNull('should not show error');
})); Notice that the quote element displays the placeholder value ('...') after ngOnInit(). The first quote hasn't arrived yet.
To flush the first quote from the observable, you call tick(). Then call detectChanges() to tell Angular to update the screen.
Then you can assert that the quote element displays the expected text.
Async test with async()
To use async() functionality, you need to import zone-testing, for details, please read setup guide.
The fakeAsync() utility function has a few limitations. In particular, it won't work if the test body makes an XHR call.
XHR calls within a test are rare so you can generally stick with fakeAsync(). But if you ever do need to call XHR, you'll want to know about async().
The
TestBed.compileComponents()method (see below) callsXHRto read external template and css files during "just-in-time" compilation. Write tests that callcompileComponents()with theasync()utility.
Here's the previous fakeAsync() test, re-written with the async() utility.
it('should show quote after getQuote (async)', async(() => {
fixture.detectChanges(); // ngOnInit()
expect(quoteEl.textContent).toBe('...', 'should show placeholder');
fixture.whenStable().then(() => { // wait for async getQuote
fixture.detectChanges(); // update view with quote
expect(quoteEl.textContent).toBe(testQuote);
expect(errorMessage()).toBeNull('should not show error');
});
})); The async() utility hides some asynchronous boilerplate by arranging for the tester's code to run in a special async test zone. You don't need to pass Jasmine's done() into the test and call done() because it is undefined in promise or observable callbacks.
But the test's asynchronous nature is revealed by the call to fixture.whenStable(), which breaks the linear flow of control.
When using an intervalTimer() such as setInterval() in async(), remember to cancel the timer with clearInterval() after the test, otherwise the async() never ends.
whenStable
The test must wait for the getQuote() observable to emit the next quote. Instead of calling tick(), it calls fixture.whenStable().
The fixture.whenStable() returns a promise that resolves when the JavaScript engine's task queue becomes empty. In this example, the task queue becomes empty when the observable emits the first quote.
The test resumes within the promise callback, which calls detectChanges() to update the quote element with the expected text.
Jasmine done()
While the async() and fakeAsync() functions greatly simplify Angular asynchronous testing, you can still fall back to the traditional technique and pass it a function that takes a done callback.
You can't call done() in async() or fakeAsync() functions, because the done parameter is undefined.
Now you are responsible for chaining promises, handling errors, and calling done() at the appropriate moments.
Writing test functions with done(), is more cumbersome than async()and fakeAsync(). But it is occasionally necessary when code involves the intervalTimer() like setInterval.
Here are two more versions of the previous test, written with done(). The first one subscribes to the Observable exposed to the template by the component's quote property.
it('should show last quote (quote done)', (done: DoneFn) => {
fixture.detectChanges();
component.quote.pipe( last() ).subscribe(() => {
fixture.detectChanges(); // update view with quote
expect(quoteEl.textContent).toBe(testQuote);
expect(errorMessage()).toBeNull('should not show error');
done();
});
}); The RxJS last() operator emits the observable's last value before completing, which will be the test quote. The subscribe callback calls detectChanges() to update the quote element with the test quote, in the same manner as the earlier tests.
In some tests, you're more interested in how an injected service method was called and what values it returned, than what appears on screen.
A service spy, such as the qetQuote() spy of the fake TwainService, can give you that information and make assertions about the state of the view.
it('should show quote after getQuote (spy done)', (done: DoneFn) => {
fixture.detectChanges();
// the spy's most recent call returns the observable with the test quote
getQuoteSpy.calls.mostRecent().returnValue.subscribe(() => {
fixture.detectChanges(); // update view with quote
expect(quoteEl.textContent).toBe(testQuote);
expect(errorMessage()).toBeNull('should not show error');
done();
});
}); Component marble tests
The previous TwainComponent tests simulated an asynchronous observable response from the TwainService with the asyncData and asyncError utilities.
These are short, simple functions that you can write yourself. Unfortunately, they're too simple for many common scenarios. An observable often emits multiple times, perhaps after a significant delay. A component may coordinate multiple observables with overlapping sequences of values and errors.
RxJS marble testing is a great way to test observable scenarios, both simple and complex. You've likely seen the marble diagrams that illustrate how observables work. Marble testing uses a similar marble language to specify the observable streams and expectations in your tests.
The following examples revisit two of the TwainComponent tests with marble testing.
Start by installing the jasmine-marbles npm package. Then import the symbols you need.
import { cold, getTestScheduler } from 'jasmine-marbles'; Here's the complete test for getting a quote:
it('should show quote after getQuote (marbles)', () => {
// observable test quote value and complete(), after delay
const q$ = cold('---x|', { x: testQuote });
getQuoteSpy.and.returnValue( q$ );
fixture.detectChanges(); // ngOnInit()
expect(quoteEl.textContent).toBe('...', 'should show placeholder');
getTestScheduler().flush(); // flush the observables
fixture.detectChanges(); // update view
expect(quoteEl.textContent).toBe(testQuote, 'should show quote');
expect(errorMessage()).toBeNull('should not show error');
}); Notice that the Jasmine test is synchronous. There's no fakeAsync(). Marble testing uses a test scheduler to simulate the passage of time in a synchronous test.
The beauty of marble testing is in the visual definition of the observable streams. This test defines a cold observable that waits three frames (---), emits a value (x), and completes (|). In the second argument you map the value marker (x) to the emitted value (testQuote).
const q$ = cold('---x|', { x: testQuote }); The marble library constructs the corresponding observable, which the test sets as the getQuote spy's return value.
When you're ready to activate the marble observables, you tell the TestScheduler to flush its queue of prepared tasks like this.
getTestScheduler().flush(); // flush the observables
This step serves a purpose analogous to tick() and whenStable() in the earlier fakeAsync() and async() examples. The balance of the test is the same as those examples.
Marble error testing
Here's the marble testing version of the getQuote() error test.
it('should display error when TwainService fails', fakeAsync(() => {
// observable error after delay
const q$ = cold('---#|', null, new Error('TwainService test failure'));
getQuoteSpy.and.returnValue( q$ );
fixture.detectChanges(); // ngOnInit()
expect(quoteEl.textContent).toBe('...', 'should show placeholder');
getTestScheduler().flush(); // flush the observables
tick(); // component shows error after a setTimeout()
fixture.detectChanges(); // update error message
expect(errorMessage()).toMatch(/test failure/, 'should display error');
expect(quoteEl.textContent).toBe('...', 'should show placeholder');
})); It's still an async test, calling fakeAsync() and tick(), because the component itself calls setTimeout() when processing errors.
Look at the marble observable definition.
const q$ = cold('---#|', null, new Error('TwainService test failure')); This is a cold observable that waits three frames and then emits an error, The hash (#) indicates the timing of the error that is specified in the third argument. The second argument is null because the observable never emits a value.
Learn about marble testing
A marble frame is a virtual unit of testing time. Each symbol (-, x, |, #) marks the passing of one frame.
A cold observable doesn't produce values until you subscribe to it. Most of your application observables are cold. All HttpClient methods return cold observables.
A hot observable is already producing values before you subscribe to it. The Router.events observable, which reports router activity, is a hot observable.
RxJS marble testing is a rich subject, beyond the scope of this guide. Learn about it on the web, starting with the official documentation.
Component with inputs and outputs
A component with inputs and outputs typically appears inside the view template of a host component. The host uses a property binding to set the input property and an event binding to listen to events raised by the output property.
The testing goal is to verify that such bindings work as expected. The tests should set input values and listen for output events.
The DashboardHeroComponent is a tiny example of a component in this role. It displays an individual hero provided by the DashboardComponent. Clicking that hero tells the DashboardComponent that the user has selected the hero.
The DashboardHeroComponent is embedded in the DashboardComponent template like this:
<dashboard-hero *ngFor="let hero of heroes" class="col-1-4" [hero]=hero (selected)="gotoDetail($event)" > </dashboard-hero>
The DashboardHeroComponent appears in an *ngFor repeater, which sets each component's hero input property to the looping value and listens for the component's selected event.
Here's the component's full definition:
@Component({
selector: 'dashboard-hero',
template: `
<div (click)="click()" class="hero">
{{hero.name | uppercase}}
</div>`,
styleUrls: [ './dashboard-hero.component.css' ]
})
export class DashboardHeroComponent {
@Input() hero: Hero;
@Output() selected = new EventEmitter<Hero>();
click() { this.selected.emit(this.hero); }
} While testing a component this simple has little intrinsic value, it's worth knowing how. You can use one of these approaches:
- Test it as used by
DashboardComponent. - Test it as a stand-alone component.
- Test it as used by a substitute for
DashboardComponent.
A quick look at the DashboardComponent constructor discourages the first approach:
constructor(
private router: Router,
private heroService: HeroService) {
} The DashboardComponent depends on the Angular router and the HeroService. You'd probably have to replace them both with test doubles, which is a lot of work. The router seems particularly challenging.
The discussion below covers testing components that require the router.
The immediate goal is to test the DashboardHeroComponent, not the DashboardComponent, so, try the second and third options.
Test DashboardHeroComponent stand-alone
Here's the meat of the spec file setup.
TestBed.configureTestingModule({
declarations: [ DashboardHeroComponent ]
})
fixture = TestBed.createComponent(DashboardHeroComponent);
comp = fixture.componentInstance;
// find the hero's DebugElement and element
heroDe = fixture.debugElement.query(By.css('.hero'));
heroEl = heroDe.nativeElement;
// mock the hero supplied by the parent component
expectedHero = { id: 42, name: 'Test Name' };
// simulate the parent setting the input property with that hero
comp.hero = expectedHero;
// trigger initial data binding
fixture.detectChanges(); Note how the setup code assigns a test hero (expectedHero) to the component's hero property, emulating the way the DashboardComponent would set it via the property binding in its repeater.
The following test verifies that the hero name is propagated to the template via a binding.
it('should display hero name in uppercase', () => {
const expectedPipedName = expectedHero.name.toUpperCase();
expect(heroEl.textContent).toContain(expectedPipedName);
}); Because the template passes the hero name through the Angular UpperCasePipe, the test must match the element value with the upper-cased name.
This small test demonstrates how Angular tests can verify a component's visual representation—something not possible with component class tests—at low cost and without resorting to much slower and more complicated end-to-end tests.
Clicking
Clicking the hero should raise a selected event that the host component (DashboardComponent presumably) can hear:
it('should raise selected event when clicked (triggerEventHandler)', () => {
let selectedHero: Hero;
comp.selected.subscribe((hero: Hero) => selectedHero = hero);
heroDe.triggerEventHandler('click', null);
expect(selectedHero).toBe(expectedHero);
}); The component's selected property returns an EventEmitter, which looks like an RxJS synchronous Observable to consumers. The test subscribes to it explicitly just as the host component does implicitly.
If the component behaves as expected, clicking the hero's element should tell the component's selected property to emit the hero object.
The test detects that event through its subscription to selected.
triggerEventHandler
The heroDe in the previous test is a DebugElement that represents the hero <div>.
It has Angular properties and methods that abstract interaction with the native element. This test calls the DebugElement.triggerEventHandler with the "click" event name. The "click" event binding responds by calling DashboardHeroComponent.click().
The Angular DebugElement.triggerEventHandler can raise any data-bound event by its event name. The second parameter is the event object passed to the handler.
The test triggered a "click" event with a null event object.
heroDe.triggerEventHandler('click', null); The test assumes (correctly in this case) that the runtime event handler—the component's click() method—doesn't care about the event object.
Other handlers are less forgiving. For example, the
RouterLinkdirective expects an object with abuttonproperty that identifies which mouse button (if any) was pressed during the click. TheRouterLinkdirective throws an error if the event object is missing.
Click the element
The following test alternative calls the native element's own click() method, which is perfectly fine for this component.
it('should raise selected event when clicked (element.click)', () => {
let selectedHero: Hero;
comp.selected.subscribe((hero: Hero) => selectedHero = hero);
heroEl.click();
expect(selectedHero).toBe(expectedHero);
}); click() helper
Clicking a button, an anchor, or an arbitrary HTML element is a common test task.
Make that consistent and easy by encapsulating the click-triggering process in a helper such as the click() function below:
/** Button events to pass to `DebugElement.triggerEventHandler` for RouterLink event handler */
export const ButtonClickEvents = {
left: { button: 0 },
right: { button: 2 }
};
/** Simulate element click. Defaults to mouse left-button click event. */
export function click(el: DebugElement | HTMLElement, eventObj: any = ButtonClickEvents.left): void {
if (el instanceof HTMLElement) {
el.click();
} else {
el.triggerEventHandler('click', eventObj);
}
} The first parameter is the element-to-click. If you wish, you can pass a custom event object as the second parameter. The default is a (partial) left-button mouse event object accepted by many handlers including the RouterLink directive.
The
click()helper function is not one of the Angular testing utilities. It's a function defined in this guide's sample code. All of the sample tests use it. If you like it, add it to your own collection of helpers.
Here's the previous test, rewritten using the click helper.
it('should raise selected event when clicked (click helper)', () => {
let selectedHero: Hero;
comp.selected.subscribe(hero => selectedHero = hero);
click(heroDe); // click helper with DebugElement
click(heroEl); // click helper with native element
expect(selectedHero).toBe(expectedHero);
}); Component inside a test host
The previous tests played the role of the host DashboardComponent themselves. But does the DashboardHeroComponent work correctly when properly data-bound to a host component?
You could test with the actual DashboardComponent. But doing so could require a lot of setup, especially when its template features an *ngFor repeater, other components, layout HTML, additional bindings, a constructor that injects multiple services, and it starts interacting with those services right away.
Imagine the effort to disable these distractions, just to prove a point that can be made satisfactorily with a test host like this one:
@Component({
template: `
<dashboard-hero
[hero]="hero" (selected)="onSelected($event)">
</dashboard-hero>`
})
class TestHostComponent {
hero: Hero = {id: 42, name: 'Test Name' };
selectedHero: Hero;
onSelected(hero: Hero) { this.selectedHero = hero; }
} This test host binds to DashboardHeroComponent as the DashboardComponent would but without the noise of the Router, the HeroService, or the *ngFor repeater.
The test host sets the component's hero input property with its test hero. It binds the component's selected event with its onSelected handler, which records the emitted hero in its selectedHero property.
Later, the tests will be able to easily check selectedHero to verify that the DashboardHeroComponent.selected event emitted the expected hero.
The setup for the test-host tests is similar to the setup for the stand-alone tests:
TestBed.configureTestingModule({
declarations: [ DashboardHeroComponent, TestHostComponent ]
})
// create TestHostComponent instead of DashboardHeroComponent
fixture = TestBed.createComponent(TestHostComponent);
testHost = fixture.componentInstance;
heroEl = fixture.nativeElement.querySelector('.hero');
fixture.detectChanges(); // trigger initial data binding This testing module configuration shows three important differences:
- It declares both the
DashboardHeroComponentand theTestHostComponent. - It creates the
TestHostComponentinstead of theDashboardHeroComponent. - The
TestHostComponentsets theDashboardHeroComponent.herowith a binding.
The createComponent returns a fixture that holds an instance of TestHostComponent instead of an instance of DashboardHeroComponent.
Creating the TestHostComponent has the side-effect of creating a DashboardHeroComponent because the latter appears within the template of the former. The query for the hero element (heroEl) still finds it in the test DOM, albeit at greater depth in the element tree than before.
The tests themselves are almost identical to the stand-alone version:
it('should display hero name', () => {
const expectedPipedName = testHost.hero.name.toUpperCase();
expect(heroEl.textContent).toContain(expectedPipedName);
});
it('should raise selected event when clicked', () => {
click(heroEl);
// selected hero should be the same data bound hero
expect(testHost.selectedHero).toBe(testHost.hero);
}); Only the selected event test differs. It confirms that the selected DashboardHeroComponent hero really does find its way up through the event binding to the host component.
Routing component
A routing component is a component that tells the Router to navigate to another component. The DashboardComponent is a routing component because the user can navigate to the HeroDetailComponent by clicking on one of the hero buttons on the dashboard.
Routing is pretty complicated. Testing the DashboardComponent seemed daunting in part because it involves the Router, which it injects together with the HeroService.
constructor(
private router: Router,
private heroService: HeroService) {
} Mocking the HeroService with a spy is a familiar story. But the Router has a complicated API and is entwined with other services and application preconditions. Might it be difficult to mock?
Fortunately, not in this case because the DashboardComponent isn't doing much with the Router
gotoDetail(hero: Hero) {
let url = `/heroes/${hero.id}`;
this.router.navigateByUrl(url);
} This is often the case with routing components. As a rule you test the component, not the router, and care only if the component navigates with the right address under the given conditions.
Providing a router spy for this component test suite happens to be as easy as providing a HeroService spy.
const routerSpy = jasmine.createSpyObj('Router', ['navigateByUrl']);
const heroServiceSpy = jasmine.createSpyObj('HeroService', ['getHeroes']);
TestBed.configureTestingModule({
providers: [
{ provide: HeroService, useValue: heroServiceSpy },
{ provide: Router, useValue: routerSpy }
]
}) The following test clicks the displayed hero and confirms that Router.navigateByUrl is called with the expected url.
it('should tell ROUTER to navigate when hero clicked', () => {
heroClick(); // trigger click on first inner <div class="hero">
// args passed to router.navigateByUrl() spy
const spy = router.navigateByUrl as jasmine.Spy;
const navArgs = spy.calls.first().args[0];
// expecting to navigate to id of the component's first hero
const id = comp.heroes[0].id;
expect(navArgs).toBe('/heroes/' + id,
'should nav to HeroDetail for first hero');
}); Routed components
A routed component is the destination of a Router navigation. It can be trickier to test, especially when the route to the component includes parameters. The HeroDetailComponent is a routed component that is the destination of such a route.
When a user clicks a Dashboard hero, the DashboardComponent tells the Router to navigate to heroes/:id. The :id is a route parameter whose value is the id of the hero to edit.
The Router matches that URL to a route to the HeroDetailComponent. It creates an ActivatedRoute object with the routing information and injects it into a new instance of the HeroDetailComponent.
Here's the HeroDetailComponent constructor:
constructor(
private heroDetailService: HeroDetailService,
private route: ActivatedRoute,
private router: Router) {
} The HeroDetail component needs the id parameter so it can fetch the corresponding hero via the HeroDetailService. The component has to get the id from the ActivatedRoute.paramMap property which is an Observable.
It can't just reference the id property of the ActivatedRoute.paramMap. The component has to subscribe to the ActivatedRoute.paramMap observable and be prepared for the id to change during its lifetime.
ngOnInit(): void {
// get hero when `id` param changes
this.route.paramMap.subscribe(pmap => this.getHero(pmap.get('id')));
} The Router guide covers
ActivatedRoute.paramMapin more detail.
Tests can explore how the HeroDetailComponent responds to different id parameter values by manipulating the ActivatedRoute injected into the component's constructor.
You know how to spy on the Router and a data service.
You'll take a different approach with ActivatedRoute because
-
paramMapreturns anObservablethat can emit more than one value during a test. - You need the router helper function,
convertToParamMap(), to create aParamMap. - Other routed components tests need a test double for
ActivatedRoute.
These differences argue for a re-usable stub class.
ActivatedRouteStub
The following ActivatedRouteStub class serves as a test double for ActivatedRoute.
import { convertToParamMap, ParamMap, Params } from '@angular/router';
import { ReplaySubject } from 'rxjs';
/**
* An ActivateRoute test double with a `paramMap` observable.
* Use the `setParamMap()` method to add the next `paramMap` value.
*/
export class ActivatedRouteStub {
// Use a ReplaySubject to share previous values with subscribers
// and pump new values into the `paramMap` observable
private subject = new ReplaySubject<ParamMap>();
constructor(initialParams?: Params) {
this.setParamMap(initialParams);
}
/** The mock paramMap observable */
readonly paramMap = this.subject.asObservable();
/** Set the paramMap observables's next value */
setParamMap(params?: Params) {
this.subject.next(convertToParamMap(params));
};
} Consider placing such helpers in a testing folder sibling to the app folder. This sample puts ActivatedRouteStub in testing/activated-route-stub.ts.
Consider writing a more capable version of this stub class with the marble testing library.
Testing with ActivatedRouteStub
Here's a test demonstrating the component's behavior when the observed id refers to an existing hero:
describe('when navigate to existing hero', () => {
let expectedHero: Hero;
beforeEach(async(() => {
expectedHero = firstHero;
activatedRoute.setParamMap({ id: expectedHero.id });
createComponent();
}));
it('should display that hero\'s name', () => {
expect(page.nameDisplay.textContent).toBe(expectedHero.name);
});
}); The
createComponent()method andpageobject are discussed below. Rely on your intuition for now.
When the id cannot be found, the component should re-route to the HeroListComponent.
The test suite setup provided the same router spy described above which spies on the router without actually navigating.
This test expects the component to try to navigate to the HeroListComponent.
describe('when navigate to non-existent hero id', () => {
beforeEach(async(() => {
activatedRoute.setParamMap({ id: 99999 });
createComponent();
}));
it('should try to navigate back to hero list', () => {
expect(page.gotoListSpy.calls.any()).toBe(true, 'comp.gotoList called');
expect(page.navigateSpy.calls.any()).toBe(true, 'router.navigate called');
});
}); While this app doesn't have a route to the HeroDetailComponent that omits the id parameter, it might add such a route someday. The component should do something reasonable when there is no id.
In this implementation, the component should create and display a new hero. New heroes have id=0 and a blank name. This test confirms that the component behaves as expected:
describe('when navigate with no hero id', () => {
beforeEach(async( createComponent ));
it('should have hero.id === 0', () => {
expect(component.hero.id).toBe(0);
});
it('should display empty hero name', () => {
expect(page.nameDisplay.textContent).toBe('');
});
}); Nested component tests
Component templates often have nested components, whose templates may contain more components.
The component tree can be very deep and, most of the time, the nested components play no role in testing the component at the top of the tree.
The AppComponent, for example, displays a navigation bar with anchors and their RouterLink directives.
<app-banner></app-banner> <app-welcome></app-welcome> <nav> <a routerLink="/dashboard">Dashboard</a> <a routerLink="/heroes">Heroes</a> <a routerLink="/about">About</a> </nav> <router-outlet></router-outlet>
While the AppComponent class is empty, you may want to write unit tests to confirm that the links are wired properly to the RouterLink directives, perhaps for the reasons explained below.
To validate the links, you don't need the Router to navigate and you don't need the <router-outlet> to mark where the Router inserts routed components.
The BannerComponent and WelcomeComponent (indicated by <app-banner> and <app-welcome>) are also irrelevant.
Yet any test that creates the AppComponent in the DOM will also create instances of these three components and, if you let that happen, you'll have to configure the TestBed to create them.
If you neglect to declare them, the Angular compiler won't recognize the <app-banner>, <app-welcome>, and <router-outlet> tags in the AppComponent template and will throw an error.
If you declare the real components, you'll also have to declare their nested components and provide for all services injected in any component in the tree.
That's too much effort just to answer a few simple questions about links.
This section describes two techniques for minimizing the setup. Use them, alone or in combination, to stay focused on the testing the primary component.
Stubbing unneeded components
In the first technique, you create and declare stub versions of the components and directive that play little or no role in the tests.
@Component({selector: 'app-banner', template: ''})
class BannerStubComponent {}
@Component({selector: 'router-outlet', template: ''})
class RouterOutletStubComponent { }
@Component({selector: 'app-welcome', template: ''})
class WelcomeStubComponent {} The stub selectors match the selectors for the corresponding real components. But their templates and classes are empty.
Then declare them in the TestBed configuration next to the components, directives, and pipes that need to be real.
TestBed.configureTestingModule({
declarations: [
AppComponent,
RouterLinkDirectiveStub,
BannerStubComponent,
RouterOutletStubComponent,
WelcomeStubComponent
]
}) The AppComponent is the test subject, so of course you declare the real version.
The RouterLinkDirectiveStub, described later, is a test version of the real RouterLink that helps with the link tests.
The rest are stubs.
NO_ERRORS_SCHEMA
In the second approach, add NO_ERRORS_SCHEMA to the TestBed.schemas metadata.
TestBed.configureTestingModule({
declarations: [
AppComponent,
RouterLinkDirectiveStub
],
schemas: [ NO_ERRORS_SCHEMA ]
}) The NO_ERRORS_SCHEMA tells the Angular compiler to ignore unrecognized elements and attributes.
The compiler will recognize the <app-root> element and the routerLink attribute because you declared a corresponding AppComponent and RouterLinkDirectiveStub in the TestBed configuration.
But the compiler won't throw an error when it encounters <app-banner>, <app-welcome>, or <router-outlet>. It simply renders them as empty tags and the browser ignores them.
You no longer need the stub components.
Use both techniques together
These are techniques for Shallow Component Testing , so-named because they reduce the visual surface of the component to just those elements in the component's template that matter for tests.
The NO_ERRORS_SCHEMA approach is the easier of the two but don't overuse it.
The NO_ERRORS_SCHEMA also prevents the compiler from telling you about the missing components and attributes that you omitted inadvertently or misspelled. You could waste hours chasing phantom bugs that the compiler would have caught in an instant.
The stub component approach has another advantage. While the stubs in this example were empty, you could give them stripped-down templates and classes if your tests need to interact with them in some way.
In practice you will combine the two techniques in the same setup, as seen in this example.
TestBed.configureTestingModule({
declarations: [
AppComponent,
BannerStubComponent,
RouterLinkDirectiveStub
],
schemas: [ NO_ERRORS_SCHEMA ]
}) The Angular compiler creates the BannerComponentStub for the <app-banner> element and applies the RouterLinkStubDirective to the anchors with the routerLink attribute, but it ignores the <app-welcome> and <router-outlet> tags.
Components with RouterLink
The real RouterLinkDirective is quite complicated and entangled with other components and directives of the RouterModule. It requires challenging setup to mock and use in tests.
The RouterLinkDirectiveStub in this sample code replaces the real directive with an alternative version designed to validate the kind of anchor tag wiring seen in the AppComponent template.
@Directive({
selector: '[routerLink]'
})
export class RouterLinkDirectiveStub {
@Input('routerLink') linkParams: any;
navigatedTo: any = null;
@HostListener('click')
onClick() {
this.navigatedTo = this.linkParams;
}
} The URL bound to the [routerLink] attribute flows in to the directive's linkParams property.
The HostListener wires the click event of the host element (the <a> anchor elements in AppComponent) to the stub directive's onClick method.
Clicking the anchor should trigger the onClick() method, which sets the stub's telltale navigatedTo property. Tests inspect navigatedTo to confirm that clicking the anchor set the expected route definition.
Whether the router is configured properly to navigate with that route definition is a question for a separate set of tests.
By.directive and injected directives
A little more setup triggers the initial data binding and gets references to the navigation links:
beforeEach(() => {
fixture.detectChanges(); // trigger initial data binding
// find DebugElements with an attached RouterLinkStubDirective
linkDes = fixture.debugElement
.queryAll(By.directive(RouterLinkDirectiveStub));
// get attached link directive instances
// using each DebugElement's injector
routerLinks = linkDes.map(de => de.injector.get(RouterLinkDirectiveStub));
}); Three points of special interest:
-
You can locate the anchor elements with an attached directive using
By.directive. -
The query returns
DebugElementwrappers around the matching elements. -
Each
DebugElementexposes a dependency injector with the specific instance of the directive attached to that element.
The AppComponent links to validate are as follows:
<nav> <a routerLink="/dashboard">Dashboard</a> <a routerLink="/heroes">Heroes</a> <a routerLink="/about">About</a> </nav>
Here are some tests that confirm those links are wired to the routerLink directives as expected:
it('can get RouterLinks from template', () => {
expect(routerLinks.length).toBe(3, 'should have 3 routerLinks');
expect(routerLinks[0].linkParams).toBe('/dashboard');
expect(routerLinks[1].linkParams).toBe('/heroes');
expect(routerLinks[2].linkParams).toBe('/about');
});
it('can click Heroes link in template', () => {
const heroesLinkDe = linkDes[1]; // heroes link DebugElement
const heroesLink = routerLinks[1]; // heroes link directive
expect(heroesLink.navigatedTo).toBeNull('should not have navigated yet');
heroesLinkDe.triggerEventHandler('click', null);
fixture.detectChanges();
expect(heroesLink.navigatedTo).toBe('/heroes');
}); The "click" test in this example is misleading. It tests the
RouterLinkDirectiveStubrather than the component. This is a common failing of directive stubs.It has a legitimate purpose in this guide. It demonstrates how to find a
RouterLinkelement, click it, and inspect a result, without engaging the full router machinery. This is a skill you may need to test a more sophisticated component, one that changes the display, re-calculates parameters, or re-arranges navigation options when the user clicks the link.
What good are these tests?
Stubbed RouterLink tests can confirm that a component with links and an outlet is setup properly, that the component has the links it should have, and that they are all pointing in the expected direction. These tests do not concern whether the app will succeed in navigating to the target component when the user clicks a link.
Stubbing the RouterLink and RouterOutlet is the best option for such limited testing goals. Relying on the real router would make them brittle. They could fail for reasons unrelated to the component. For example, a navigation guard could prevent an unauthorized user from visiting the HeroListComponent. That's not the fault of the AppComponent and no change to that component could cure the failed test.
A different battery of tests can explore whether the application navigates as expected in the presence of conditions that influence guards such as whether the user is authenticated and authorized.
A future guide update will explain how to write such tests with the
RouterTestingModule.
Use a page object
The HeroDetailComponent is a simple view with a title, two hero fields, and two buttons.
But there's plenty of template complexity even in this simple form.
<div *ngIf="hero">
<h2><span>{{hero.name | titlecase}}</span> Details</h2>
<div>
<label>id: </label>{{hero.id}}</div>
<div>
<label for="name">name: </label>
<input id="name" [(ngModel)]="hero.name" placeholder="name" />
</div>
<button (click)="save()">Save</button>
<button (click)="cancel()">Cancel</button>
</div> Tests that exercise the component need ...
- to wait until a hero arrives before elements appear in the DOM.
- a reference to the title text.
- a reference to the name input box to inspect and set it.
- references to the two buttons so they can click them.
- spies for some of the component and router methods.
Even a small form such as this one can produce a mess of tortured conditional setup and CSS element selection.
Tame the complexity with a Page class that handles access to component properties and encapsulates the logic that sets them.
Here is such a Page class for the hero-detail.component.spec.ts
class Page {
// getter properties wait to query the DOM until called.
get buttons() { return this.queryAll<HTMLButtonElement>('button'); }
get saveBtn() { return this.buttons[0]; }
get cancelBtn() { return this.buttons[1]; }
get nameDisplay() { return this.query<HTMLElement>('span'); }
get nameInput() { return this.query<HTMLInputElement>('input'); }
gotoListSpy: jasmine.Spy;
navigateSpy: jasmine.Spy;
constructor(fixture: ComponentFixture<HeroDetailComponent>) {
// get the navigate spy from the injected router spy object
const routerSpy = <any> fixture.debugElement.injector.get(Router);
this.navigateSpy = routerSpy.navigate;
// spy on component's `gotoList()` method
const component = fixture.componentInstance;
this.gotoListSpy = spyOn(component, 'gotoList').and.callThrough();
}
//// query helpers ////
private query<T>(selector: string): T {
return fixture.nativeElement.querySelector(selector);
}
private queryAll<T>(selector: string): T[] {
return fixture.nativeElement.querySelectorAll(selector);
}
} Now the important hooks for component manipulation and inspection are neatly organized and accessible from an instance of Page.
A createComponent method creates a page object and fills in the blanks once the hero arrives.
/** Create the HeroDetailComponent, initialize it, set test variables */
function createComponent() {
fixture = TestBed.createComponent(HeroDetailComponent);
component = fixture.componentInstance;
page = new Page(fixture);
// 1st change detection triggers ngOnInit which gets a hero
fixture.detectChanges();
return fixture.whenStable().then(() => {
// 2nd change detection displays the async-fetched hero
fixture.detectChanges();
});
} The HeroDetailComponent tests in an earlier section demonstrate how createComponent and page keep the tests short and on message. There are no distractions: no waiting for promises to resolve and no searching the DOM for element values to compare.
Here are a few more HeroDetailComponent tests to reinforce the point.
it('should display that hero\'s name', () => {
expect(page.nameDisplay.textContent).toBe(expectedHero.name);
});
it('should navigate when click cancel', () => {
click(page.cancelBtn);
expect(page.navigateSpy.calls.any()).toBe(true, 'router.navigate called');
});
it('should save when click save but not navigate immediately', () => {
// Get service injected into component and spy on its`saveHero` method.
// It delegates to fake `HeroService.updateHero` which delivers a safe test result.
const hds = fixture.debugElement.injector.get(HeroDetailService);
const saveSpy = spyOn(hds, 'saveHero').and.callThrough();
click(page.saveBtn);
expect(saveSpy.calls.any()).toBe(true, 'HeroDetailService.save called');
expect(page.navigateSpy.calls.any()).toBe(false, 'router.navigate not called');
});
it('should navigate when click save and save resolves', fakeAsync(() => {
click(page.saveBtn);
tick(); // wait for async save to complete
expect(page.navigateSpy.calls.any()).toBe(true, 'router.navigate called');
}));
it('should convert hero name to Title Case', () => {
// get the name's input and display elements from the DOM
const hostElement = fixture.nativeElement;
const nameInput: HTMLInputElement = hostElement.querySelector('input');
const nameDisplay: HTMLElement = hostElement.querySelector('span');
// simulate user entering a new name into the input box
nameInput.value = 'quick BROWN fOx';
// dispatch a DOM event so that Angular learns of input value change.
nameInput.dispatchEvent(newEvent('input'));
// Tell Angular to update the display binding through the title pipe
fixture.detectChanges();
expect(nameDisplay.textContent).toBe('Quick Brown Fox');
}); Calling compileComponents()
You can ignore this section if you only run tests with the CLI
ng testcommand because the CLI compiles the application before running the tests.
If you run tests in a non-CLI environment, the tests may fail with a message like this one:
Error: This test module uses the component BannerComponent which is using a "templateUrl" or "styleUrls", but they were never compiled. Please call "TestBed.compileComponents" before your test.
The root of the problem is at least one of the components involved in the test specifies an external template or CSS file as the following version of the BannerComponent does.
import { Component } from '@angular/core';
@Component({
selector: 'app-banner',
templateUrl: './banner-external.component.html',
styleUrls: ['./banner-external.component.css']
})
export class BannerComponent {
title = 'Test Tour of Heroes';
} The test fails when the TestBed tries to create the component.
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [ BannerComponent ],
});
fixture = TestBed.createComponent(BannerComponent);
}); Recall that the app hasn't been compiled. So when you call createComponent(), the TestBed compiles implicitly.
That's not a problem when the source code is in memory. But the BannerComponent requires external files that the compiler must read from the file system, an inherently asynchronous operation.
If the TestBed were allowed to continue, the tests would run and fail mysteriously before the compiler could finished.
The preemptive error message tells you to compile explicitly with compileComponents().
compileComponents() is async
You must call compileComponents() within an asynchronous test function.
If you neglect to make the test function async (e.g., forget to use
async()as described below), you'll see this error messageError: ViewDestroyedError: Attempt to use a destroyed view
A typical approach is to divide the setup logic into two separate beforeEach() functions:
- An async
beforeEach()that compiles the components - A synchronous
beforeEach()that performs the remaining setup.
To follow this pattern, import the async() helper with the other testing symbols.
import { async, ComponentFixture, TestBed } from '@angular/core/testing'; The async beforeEach
Write the first async beforeEach like this.
beforeEach(async(() => {
TestBed.configureTestingModule({
declarations: [ BannerComponent ],
})
.compileComponents(); // compile template and css
})); The async() helper function takes a parameterless function with the body of the setup.
The TestBed.configureTestingModule() method returns the TestBed class so you can chain calls to other TestBed static methods such as compileComponents().
In this example, the BannerComponent is the only component to compile. Other examples configure the testing module with multiple components and may import application modules that hold yet more components. Any of them could be require external files.
The TestBed.compileComponents method asynchronously compiles all components configured in the testing module.
Do not re-configure the
TestBedafter callingcompileComponents().
Calling compileComponents() closes the current TestBed instance to further configuration. You cannot call any more TestBed configuration methods, not configureTestingModule() nor any of the override... methods. The TestBed throws an error if you try.
Make compileComponents() the last step before calling TestBed.createComponent().
The synchronous beforeEach
The second, synchronous beforeEach() contains the remaining setup steps, which include creating the component and querying for elements to inspect.
beforeEach(() => {
fixture = TestBed.createComponent(BannerComponent);
component = fixture.componentInstance; // BannerComponent test instance
h1 = fixture.nativeElement.querySelector('h1');
}); You can count on the test runner to wait for the first asynchronous beforeEach to finish before calling the second.
Consolidated setup
You can consolidate the two beforeEach() functions into a single, async beforeEach().
The compileComponents() method returns a promise so you can perform the synchronous setup tasks after compilation by moving the synchronous code into a then(...) callback.
beforeEach(async(() => {
TestBed.configureTestingModule({
declarations: [ BannerComponent ],
})
.compileComponents()
.then(() => {
fixture = TestBed.createComponent(BannerComponent);
component = fixture.componentInstance;
h1 = fixture.nativeElement.querySelector('h1');
});
})); compileComponents() is harmless
There's no harm in calling compileComponents() when it's not required.
The component test file generated by the CLI calls compileComponents() even though it is never required when running ng test.
The tests in this guide only call compileComponents when necessary.
Setup with module imports
Earlier component tests configured the testing module with a few declarations like this:
TestBed.configureTestingModule({
declarations: [ DashboardHeroComponent ]
}) The DashboardComponent is simple. It needs no help. But more complex components often depend on other components, directives, pipes, and providers and these must be added to the testing module too.
Fortunately, the TestBed.configureTestingModule parameter parallels the metadata passed to the @NgModule decorator which means you can also specify providers and imports.
The HeroDetailComponent requires a lot of help despite its small size and simple construction. In addition to the support it receives from the default testing module CommonModule, it needs:
-
NgModeland friends in theFormsModuleto enable two-way data binding. - The
TitleCasePipefrom thesharedfolder. - Router services (which these tests are stubbing).
- Hero data access services (also stubbed).
One approach is to configure the testing module from the individual pieces as in this example:
beforeEach(async(() => {
const routerSpy = createRouterSpy();
TestBed.configureTestingModule({
imports: [ FormsModule ],
declarations: [ HeroDetailComponent, TitleCasePipe ],
providers: [
{ provide: ActivatedRoute, useValue: activatedRoute },
{ provide: HeroService, useClass: TestHeroService },
{ provide: Router, useValue: routerSpy},
]
})
.compileComponents();
})); Notice that the
beforeEach()is asynchronous and callsTestBed.compileComponentsbecause theHeroDetailComponenthas an external template and css file.As explained in Calling compileComponents() above, these tests could be run in a non-CLI environment where Angular would have to compile them in the browser.
Import a shared module
Because many app components need the FormsModule and the TitleCasePipe, the developer created a SharedModule to combine these and other frequently requested parts.
The test configuration can use the SharedModule too as seen in this alternative setup:
beforeEach(async(() => {
const routerSpy = createRouterSpy();
TestBed.configureTestingModule({
imports: [ SharedModule ],
declarations: [ HeroDetailComponent ],
providers: [
{ provide: ActivatedRoute, useValue: activatedRoute },
{ provide: HeroService, useClass: TestHeroService },
{ provide: Router, useValue: routerSpy},
]
})
.compileComponents();
})); It's a bit tighter and smaller, with fewer import statements (not shown).
Import a feature module
The HeroDetailComponent is part of the HeroModule Feature Module that aggregates more of the interdependent pieces including the SharedModule. Try a test configuration that imports the HeroModule like this one:
beforeEach(async(() => {
const routerSpy = createRouterSpy();
TestBed.configureTestingModule({
imports: [ HeroModule ],
providers: [
{ provide: ActivatedRoute, useValue: activatedRoute },
{ provide: HeroService, useClass: TestHeroService },
{ provide: Router, useValue: routerSpy},
]
})
.compileComponents();
})); That's really crisp. Only the test doubles in the providers remain. Even the HeroDetailComponent declaration is gone.
In fact, if you try to declare it, Angular will throw an error because HeroDetailComponent is declared in both the HeroModule and the DynamicTestModule created by the TestBed.
Importing the component's feature module can be the easiest way to configure tests when there are many mutual dependencies within the module and the module is small, as feature modules tend to be.
Override component providers
The HeroDetailComponent provides its own HeroDetailService.
@Component({
selector: 'app-hero-detail',
templateUrl: './hero-detail.component.html',
styleUrls: ['./hero-detail.component.css' ],
providers: [ HeroDetailService ]
})
export class HeroDetailComponent implements OnInit {
constructor(
private heroDetailService: HeroDetailService,
private route: ActivatedRoute,
private router: Router) {
}
} It's not possible to stub the component's HeroDetailService in the providers of the TestBed.configureTestingModule. Those are providers for the testing module, not the component. They prepare the dependency injector at the fixture level.
Angular creates the component with its own injector, which is a child of the fixture injector. It registers the component's providers (the HeroDetailService in this case) with the child injector.
A test cannot get to child injector services from the fixture injector. And TestBed.configureTestingModule can't configure them either.
Angular has been creating new instances of the real HeroDetailService all along!
These tests could fail or timeout if the
HeroDetailServicemade its own XHR calls to a remote server. There might not be a remote server to call.Fortunately, the
HeroDetailServicedelegates responsibility for remote data access to an injectedHeroService.@Injectable() export class HeroDetailService { constructor(private heroService: HeroService) { } /* . . . */ }The previous test configuration replaces the real
HeroServicewith aTestHeroServicethat intercepts server requests and fakes their responses.
What if you aren't so lucky. What if faking the HeroService is hard? What if HeroDetailService makes its own server requests?
The TestBed.overrideComponent method can replace the component's providers with easy-to-manage test doubles as seen in the following setup variation:
beforeEach(async(() => {
const routerSpy = createRouterSpy();
TestBed.configureTestingModule({
imports: [ HeroModule ],
providers: [
{ provide: ActivatedRoute, useValue: activatedRoute },
{ provide: Router, useValue: routerSpy},
]
})
// Override component's own provider
.overrideComponent(HeroDetailComponent, {
set: {
providers: [
{ provide: HeroDetailService, useClass: HeroDetailServiceSpy }
]
}
})
.compileComponents();
})); Notice that TestBed.configureTestingModule no longer provides a (fake) HeroService because it's not needed.
The overrideComponent method
Focus on the overrideComponent method.
.overrideComponent(HeroDetailComponent, {
set: {
providers: [
{ provide: HeroDetailService, useClass: HeroDetailServiceSpy }
]
}
}) It takes two arguments: the component type to override (HeroDetailComponent) and an override metadata object. The override metadata object is a generic defined as follows:
type MetadataOverride<T> = {
add?: Partial<T>;
remove?: Partial<T>;
set?: Partial<T>;
}; A metadata override object can either add-and-remove elements in metadata properties or completely reset those properties. This example resets the component's providers metadata.
The type parameter, T, is the kind of metadata you'd pass to the @Component decorator:
selector?: string; template?: string; templateUrl?: string; providers?: any[]; ...
Provide a spy stub (HeroDetailServiceSpy)
This example completely replaces the component's providers array with a new array containing a HeroDetailServiceSpy.
The HeroDetailServiceSpy is a stubbed version of the real HeroDetailService that fakes all necessary features of that service. It neither injects nor delegates to the lower level HeroService so there's no need to provide a test double for that.
The related HeroDetailComponent tests will assert that methods of the HeroDetailService were called by spying on the service methods. Accordingly, the stub implements its methods as spies:
class HeroDetailServiceSpy {
testHero: Hero = {id: 42, name: 'Test Hero' };
/* emit cloned test hero */
getHero = jasmine.createSpy('getHero').and.callFake(
() => asyncData(Object.assign({}, this.testHero))
);
/* emit clone of test hero, with changes merged in */
saveHero = jasmine.createSpy('saveHero').and.callFake(
(hero: Hero) => asyncData(Object.assign(this.testHero, hero))
);
} The override tests
Now the tests can control the component's hero directly by manipulating the spy-stub's testHero and confirm that service methods were called.
let hdsSpy: HeroDetailServiceSpy;
beforeEach(async(() => {
createComponent();
// get the component's injected HeroDetailServiceSpy
hdsSpy = fixture.debugElement.injector.get(HeroDetailService) as any;
}));
it('should have called `getHero`', () => {
expect(hdsSpy.getHero.calls.count()).toBe(1, 'getHero called once');
});
it('should display stub hero\'s name', () => {
expect(page.nameDisplay.textContent).toBe(hdsSpy.testHero.name);
});
it('should save stub hero change', fakeAsync(() => {
const origName = hdsSpy.testHero.name;
const newName = 'New Name';
page.nameInput.value = newName;
page.nameInput.dispatchEvent(newEvent('input')); // tell Angular
expect(component.hero.name).toBe(newName, 'component hero has new name');
expect(hdsSpy.testHero.name).toBe(origName, 'service hero unchanged before save');
click(page.saveBtn);
expect(hdsSpy.saveHero.calls.count()).toBe(1, 'saveHero called once');
tick(); // wait for async save to complete
expect(hdsSpy.testHero.name).toBe(newName, 'service hero has new name after save');
expect(page.navigateSpy.calls.any()).toBe(true, 'router.navigate called');
})); More overrides
The TestBed.overrideComponent method can be called multiple times for the same or different components. The TestBed offers similar overrideDirective, overrideModule, and overridePipe methods for digging into and replacing parts of these other classes.
Explore the options and combinations on your own.
Attribute Directive Testing
An attribute directive modifies the behavior of an element, component or another directive. Its name reflects the way the directive is applied: as an attribute on a host element.
The sample application's HighlightDirective sets the background color of an element based on either a data bound color or a default color (lightgray). It also sets a custom property of the element (customProperty) to true for no reason other than to show that it can.
import { Directive, ElementRef, Input, OnChanges } from '@angular/core';
@Directive({ selector: '[highlight]' })
/** Set backgroundColor for the attached element to highlight color
* and set the element's customProperty to true */
export class HighlightDirective implements OnChanges {
defaultColor = 'rgb(211, 211, 211)'; // lightgray
@Input('highlight') bgColor: string;
constructor(private el: ElementRef) {
el.nativeElement.style.customProperty = true;
}
ngOnChanges() {
this.el.nativeElement.style.backgroundColor = this.bgColor || this.defaultColor;
}
} It's used throughout the application, perhaps most simply in the AboutComponent:
import { Component } from '@angular/core';
@Component({
template: `
<h2 highlight="skyblue">About</h2>
<h3>Quote of the day:</h3>
<twain-quote></twain-quote>
`
})
export class AboutComponent { } Testing the specific use of the HighlightDirective within the AboutComponent requires only the techniques explored above (in particular the "Shallow test" approach).
beforeEach(() => {
fixture = TestBed.configureTestingModule({
declarations: [ AboutComponent, HighlightDirective],
schemas: [ NO_ERRORS_SCHEMA ]
})
.createComponent(AboutComponent);
fixture.detectChanges(); // initial binding
});
it('should have skyblue <h2>', () => {
const h2: HTMLElement = fixture.nativeElement.querySelector('h2');
const bgColor = h2.style.backgroundColor;
expect(bgColor).toBe('skyblue');
}); However, testing a single use case is unlikely to explore the full range of a directive's capabilities. Finding and testing all components that use the directive is tedious, brittle, and almost as unlikely to afford full coverage.
Class-only tests might be helpful, but attribute directives like this one tend to manipulate the DOM. Isolated unit tests don't touch the DOM and, therefore, do not inspire confidence in the directive's efficacy.
A better solution is to create an artificial test component that demonstrates all ways to apply the directive.
@Component({
template: `
<h2 highlight="yellow">Something Yellow</h2>
<h2 highlight>The Default (Gray)</h2>
<h2>No Highlight</h2>
<input #box [highlight]="box.value" value="cyan"/>`
})
class TestComponent { } 
The
<input>case binds theHighlightDirectiveto the name of a color value in the input box. The initial value is the word "cyan" which should be the background color of the input box.
Here are some tests of this component:
beforeEach(() => {
fixture = TestBed.configureTestingModule({
declarations: [ HighlightDirective, TestComponent ]
})
.createComponent(TestComponent);
fixture.detectChanges(); // initial binding
// all elements with an attached HighlightDirective
des = fixture.debugElement.queryAll(By.directive(HighlightDirective));
// the h2 without the HighlightDirective
bareH2 = fixture.debugElement.query(By.css('h2:not([highlight])'));
});
// color tests
it('should have three highlighted elements', () => {
expect(des.length).toBe(3);
});
it('should color 1st <h2> background "yellow"', () => {
const bgColor = des[0].nativeElement.style.backgroundColor;
expect(bgColor).toBe('yellow');
});
it('should color 2nd <h2> background w/ default color', () => {
const dir = des[1].injector.get(HighlightDirective) as HighlightDirective;
const bgColor = des[1].nativeElement.style.backgroundColor;
expect(bgColor).toBe(dir.defaultColor);
});
it('should bind <input> background to value color', () => {
// easier to work with nativeElement
const input = des[2].nativeElement as HTMLInputElement;
expect(input.style.backgroundColor).toBe('cyan', 'initial backgroundColor');
// dispatch a DOM event so that Angular responds to the input value change.
input.value = 'green';
input.dispatchEvent(newEvent('input'));
fixture.detectChanges();
expect(input.style.backgroundColor).toBe('green', 'changed backgroundColor');
});
it('bare <h2> should not have a customProperty', () => {
expect(bareH2.properties['customProperty']).toBeUndefined();
}); A few techniques are noteworthy:
-
The
By.directivepredicate is a great way to get the elements that have this directive when their element types are unknown. -
The
:notpseudo-class inBy.css('h2:not([highlight])')helps find<h2>elements that do not have the directive.By.css('*:not([highlight])')finds any element that does not have the directive. -
DebugElement.stylesaffords access to element styles even in the absence of a real browser, thanks to theDebugElementabstraction. But feel free to exploit thenativeElementwhen that seems easier or more clear than the abstraction. -
Angular adds a directive to the injector of the element to which it is applied. The test for the default color uses the injector of the second
<h2>to get itsHighlightDirectiveinstance and itsdefaultColor. -
DebugElement.propertiesaffords access to the artificial custom property that is set by the directive.
Pipe Testing
Pipes are easy to test without the Angular testing utilities.
A pipe class has one method, transform, that manipulates the input value into a transformed output value. The transform implementation rarely interacts with the DOM. Most pipes have no dependence on Angular other than the @Pipe metadata and an interface.
Consider a TitleCasePipe that capitalizes the first letter of each word. Here's a naive implementation with a regular expression.
import { Pipe, PipeTransform } from '@angular/core';
@Pipe({name: 'titlecase', pure: true})
/** Transform to Title Case: uppercase the first letter of the words in a string.*/
export class TitleCasePipe implements PipeTransform {
transform(input: string): string {
return input.length === 0 ? '' :
input.replace(/\w\S*/g, (txt => txt[0].toUpperCase() + txt.substr(1).toLowerCase() ));
}
} Anything that uses a regular expression is worth testing thoroughly. Use simple Jasmine to explore the expected cases and the edge cases.
describe('TitleCasePipe', () => {
// This pipe is a pure, stateless function so no need for BeforeEach
let pipe = new TitleCasePipe();
it('transforms "abc" to "Abc"', () => {
expect(pipe.transform('abc')).toBe('Abc');
});
it('transforms "abc def" to "Abc Def"', () => {
expect(pipe.transform('abc def')).toBe('Abc Def');
});
// ... more tests ...
}); Write DOM tests too
These are tests of the pipe in isolation. They can't tell if the TitleCasePipe is working properly as applied in the application components.
Consider adding component tests such as this one:
it('should convert hero name to Title Case', () => {
// get the name's input and display elements from the DOM
const hostElement = fixture.nativeElement;
const nameInput: HTMLInputElement = hostElement.querySelector('input');
const nameDisplay: HTMLElement = hostElement.querySelector('span');
// simulate user entering a new name into the input box
nameInput.value = 'quick BROWN fOx';
// dispatch a DOM event so that Angular learns of input value change.
nameInput.dispatchEvent(newEvent('input'));
// Tell Angular to update the display binding through the title pipe
fixture.detectChanges();
expect(nameDisplay.textContent).toBe('Quick Brown Fox');
}); Test debugging
Debug specs in the browser in the same way that you debug an application.
- Reveal the Karma browser window (hidden earlier).
- Click the DEBUG button; it opens a new browser tab and re-runs the tests.
- Open the browser's “Developer Tools” (
Ctrl-Shift-Ion windows;Command-Option-Iin OSX). - Pick the "sources" section.
- Open the
1st.spec.tstest file (Control/Command-P, then start typing the name of the file). - Set a breakpoint in the test.
- Refresh the browser, and it stops at the breakpoint.
Testing Utility APIs
This section takes inventory of the most useful Angular testing features and summarizes what they do.
The Angular testing utilities include the TestBed, the ComponentFixture, and a handful of functions that control the test environment. The TestBed and ComponentFixture classes are covered separately.
Here's a summary of the stand-alone functions, in order of likely utility:
| Function | Description |
|---|---|
async | Runs the body of a test ( |
fakeAsync | Runs the body of a test ( |
tick | Simulates the passage of time and the completion of pending asynchronous activities by flushing both timer and micro-task queues within the fakeAsync test zone.
Accepts an optional argument that moves the virtual clock forward by the specified number of milliseconds, clearing asynchronous activities scheduled within that timeframe. See discussion above. |
inject | Injects one or more services from the current |
discardPeriodicTasks | When a In general, a test should end with no queued tasks. When pending timer tasks are expected, call |
flushMicrotasks | When a In general, a test should wait for micro-tasks to finish. When pending microtasks are expected, call |
ComponentFixtureAutoDetect | A provider token for a service that turns on automatic change detection. |
getTestBed | Gets the current instance of the |
TestBed class summary
The TestBed class is one of the principal Angular testing utilities. Its API is quite large and can be overwhelming until you've explored it, a little at a time. Read the early part of this guide first to get the basics before trying to absorb the full API.
The module definition passed to configureTestingModule is a subset of the @NgModule metadata properties.
type TestModuleMetadata = {
providers?: any[];
declarations?: any[];
imports?: any[];
schemas?: Array<SchemaMetadata | any[]>;
}; Each override method takes a MetadataOverride<T> where T is the kind of metadata appropriate to the method, that is, the parameter of an @NgModule, @Component, @Directive, or @Pipe.
type MetadataOverride<T> = {
add?: Partial<T>;
remove?: Partial<T>;
set?: Partial<T>;
}; The TestBed API consists of static class methods that either update or reference a global instance of theTestBed.
Internally, all static methods cover methods of the current runtime TestBed instance, which is also returned by the getTestBed() function.
Call TestBed methods within a beforeEach() to ensure a fresh start before each individual test.
Here are the most important static methods, in order of likely utility.
| Methods | Description |
|---|---|
configureTestingModule | The testing shims ( Call |
compileComponents | Compile the testing module asynchronously after you've finished configuring it. You must call this method if any of the testing module components have a After calling |
createComponent | Create an instance of a component of type |
overrideModule | Replace metadata for the given |
overrideComponent | Replace metadata for the given component class, which could be nested deeply within an inner module. |
overrideDirective | Replace metadata for the given directive class, which could be nested deeply within an inner module. |
overridePipe | Replace metadata for the given pipe class, which could be nested deeply within an inner module. |
get | Retrieve a service from the current The What if the service is optional? The service = TestBed.get(NotProvided, null); // service is null After calling |
initTestEnvironment | Initialize the testing environment for the entire test run. The testing shims ( You may call this method exactly once. If you must change this default in the middle of your test run, call Specify the Angular compiler factory, a |
resetTestEnvironment | Reset the initial test environment, including the default testing module. |
TestBed instance methods are not covered by static TestBed class methods. These are rarely needed. The ComponentFixture
The TestBed.createComponent<T> creates an instance of the component T and returns a strongly typed ComponentFixture for that component.
The ComponentFixture properties and methods provide access to the component, its DOM representation, and aspects of its Angular environment.
ComponentFixture properties
Here are the most important properties for testers, in order of likely utility.
| Properties | Description |
|---|---|
componentInstance | The instance of the component class created by |
debugElement | The The |
nativeElement | The native DOM element at the root of the component. |
changeDetectorRef | The The |
ComponentFixture methods
The fixture methods cause Angular to perform certain tasks on the component tree. Call these method to trigger Angular behavior in response to simulated user action.
Here are the most useful methods for testers.
| Methods | Description |
|---|---|
detectChanges | Trigger a change detection cycle for the component. Call it to initialize the component (it calls Runs |
autoDetectChanges | Set this to When autodetect is The default is |
checkNoChanges | Do a change detection run to make sure there are no pending changes. Throws an exceptions if there are. |
isStable | If the fixture is currently stable, returns |
whenStable | Returns a promise that resolves when the fixture is stable. To resume testing after completion of asynchronous activity or asynchronous change detection, hook that promise. See above. |
destroy | Trigger component destruction. |
DebugElement
The DebugElement provides crucial insights into the component's DOM representation.
From the test root component's DebugElement returned by fixture.debugElement, you can walk (and query) the fixture's entire element and component subtrees.
Here are the most useful DebugElement members for testers, in approximate order of utility:
| Member | Description |
|---|---|
nativeElement | The corresponding DOM element in the browser (null for WebWorkers). |
query | Calling |
queryAll | Calling |
injector | The host dependency injector. For example, the root element's component instance injector. |
componentInstance | The element's own component instance, if it has one. |
context | An object that provides parent context for this element. Often an ancestor component instance that governs this element. When an element is repeated within |
children | The immediate
|
parent | The |
name | The element tag name, if it is an element. |
triggerEventHandler | Triggers the event by its name if there is a corresponding listener in the element's If the event lacks a listener or there's some other problem, consider calling |
listeners | The callbacks attached to the component's |
providerTokens | This component's injector lookup tokens. Includes the component itself plus the tokens that the component lists in its |
source | Where to find this element in the source component template. |
references | Dictionary of objects associated with template local variables (e.g. |
The DebugElement.query(predicate) and DebugElement.queryAll(predicate) methods take a predicate that filters the source element's subtree for matching DebugElement.
The predicate is any method that takes a DebugElement and returns a truthy value. The following example finds all DebugElements with a reference to a template local variable named "content":
// Filter for DebugElements with a #content reference const contentRefs = el.queryAll( de => de.references['content']);
The Angular By class has three static methods for common predicates:
-
By.all- return all elements. -
By.css(selector)- return elements with matching CSS selectors. -
By.directive(directive)- return elements that Angular matched to an instance of the directive class.
// Can find DebugElement either by css selector or by directive
const h2 = fixture.debugElement.query(By.css('h2'));
const directive = fixture.debugElement.query(By.directive(HighlightDirective)); Frequently Asked Questions
Why put spec file next to the file it tests?
It's a good idea to put unit test spec files in the same folder as the application source code files that they test:
- Such tests are easy to find.
- You see at a glance if a part of your application lacks tests.
- Nearby tests can reveal how a part works in context.
- When you move the source (inevitable), you remember to move the test.
- When you rename the source file (inevitable), you remember to rename the test file.
When would I put specs in a test folder?
Application integration specs can test the interactions of multiple parts spread across folders and modules. They don't really belong to any part in particular, so they don't have a natural home next to any one file.
It's often better to create an appropriate folder for them in the tests directory.
Of course specs that test the test helpers belong in the test folder, next to their corresponding helper files.
Why not rely on E2E tests of DOM integration?
The component DOM tests described in this guide often require extensive setup and advanced techniques whereas the unit tests are comparatively simple.
Why not defer DOM integration tests to end-to-end (E2E) testing?
E2E tests are great for high-level validation of the entire system. But they can't give you the comprehensive test coverage that you'd expect from unit tests.
E2E tests are difficult to write and perform poorly compared to unit tests. They break easily, often due to changes or misbehavior far removed from the site of breakage.
E2E tests can't easily reveal how your components behave when things go wrong, such as missing or bad data, lost connectivity, and remote service failures.
E2E tests for apps that update a database, send an invoice, or charge a credit card require special tricks and back-doors to prevent accidental corruption of remote resources. It can even be hard to navigate to the component you want to test.
Because of these many obstacles, you should test DOM interaction with unit testing techniques as much as possible.
© 2010–2019 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v7.angular.io/guide/testing