{@a top} # Testing # 测试 This guide offers tips and techniques for unit and integration testing Angular applications. The guide presents tests of a sample CLI application that is much like the [_Tour of Heroes_ tutorial](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](http://jasmine.github.io/2.4/introduction.html). The project you create with the CLI is immediately ready to test. Just run this one CLI command: ng test The `ng test` command builds the app in _watch mode_, and launches the [karma test runner](https://karma-runner.github.io/1.0/index.html). 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.
Jasmine HTML Reporter in the browser
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` file in the project root folder and the `test.ts` file 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-cli.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.ts`** so 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. ## 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. {@a services-with-dependencies} #### Services with dependencies Services often depend on other services that Angular injects into the constructor. In many cases, it easy to create and _inject_ these dependencies by hand while calling the service's constructor. The `MasterService` is a simple example: `MasterService` delegates its only method, `getValue`, to the injected `ValueService`. Here are several ways to test it. 这里是几种测试它的方法。 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](https://jasmine.github.io/2.0/introduction.html#section-Spies) 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 service 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)](guide/dependency-injection) 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. {@a testbed} #### 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](guide/ngmodules). The `TestBed.configureTestingModule()` method takes a metadata object that can have most of the properties of an [@NgModule](guide/ngmodules). To test a service, you set the `providers` metadata property with an array of the services that you'll test or mock. Then inject it inside a test by calling `TestBed.get()` with the service class as the argument. Or inside the `beforeEach()` if you prefer to inject the service as part of your setup. When testing a service with a dependency, provide the mock in the `providers` array. In the following example, the mock is a spy object. The test consumes that spy in the same way it did earlier. {@a no-before-each} #### 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 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()`. 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. Notice how the test uses [_destructuring assignment_](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment) to extract the setup variables that it needs. Many developers feel this approach is cleaner and more explicit than the traditional `beforeEach()` style. Although this testing guide follows the tradition style and the default [CLI schematics](https://github.com/angular/devkit) 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`](guide/http) service for XHR calls. You can test a data service with an injected `HttpClient` spy as you would test any service with a dependency.
The `HeroService` methods return _Observables_. _Subscribe_ to the method observable to (a) cause it to execute and (b) assert that the method succeeds or fails. The `subscribe()` method takes a success and fail 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](guide/http#testing-http-requests), which covers testing with the `HttpClientTestingModule` in detail.
This guide's sample code also demonstrates testing of the _legacy_ `HttpModule` in `app/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. 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. Here is the `DashboardHeroComponent` from the _Tour of Heroes_ tutorial. 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 the `DashboardHeroComponent` or its parent component. 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. You might start by creating a mock of the `UserService` that meets the minimum needs of this component. Then provide and inject _both the_ **component** _and the service_ in the `TestBed` configuration. Then exercise the component class, remembering to call the [lifecycle hook methods](guide/lifecycle-hooks) as Angular does when running the app. ### 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 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.message` displayed? * 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: #### 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: In this example, the metadata object passed to `TestBed.configureTestingModule` simply declares `BannerComponent`, the component to test.
There's no need to declare or import anything else. The default test module is pre-configured with something like the `BrowserModule` from `@angular/platform-browser`. Later you'll call `TestBed.configureTestingModule()` with imports, providers, and more declarations to suit your testing needs. Optional `override` methods can further fine-tune aspects of the configuration.
{@a create-component} #### _createComponent()_ After configuring `TestBed`, you call its `createComponent()` method. `TestBed.createComponent()` creates an instance of the `BannerComponent`, adds a corresponding element to the test-runner DOM, and returns a [`ComponentFixture`](#component-fixture).
Do not re-configure `TestBed` after calling `createComponent`. 在调用了`createComponent`之后就不要再重新配置`TestBed`了。 The `createComponent` method freezes the current `TestBed`definition, closing it to further configuration. You cannot call any more `TestBed` configuration methods, not `configureTestingModule()`, nor `get()`, nor any of the `override...` methods. If you try, `TestBed` throws an error.
{@a component-fixture} #### _ComponentFixture_ The [ComponentFixture](api/core/testing/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: #### _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: Now add a test that gets the component's element from `fixture.nativeElement` and looks for the expected text. {@a native-element} #### _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](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API), 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: {@a debug-element} #### _DebugElement_ The Angular _fixture_ provides the component's element directly through the `fixture.nativeElement`. This is actually a convenience method, implemented as `fixture.debugElement.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`: 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. {@a by-css} #### _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: The following example re-implements the previous test with `DebugElement.query()` and the browser's `By.css` method. Some noteworthy observations: * The `By.css()` static method selects `DebugElement` nodes with a [standard CSS selector](https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Getting_started/Selectors "CSS selectors"). * The query returns a `DebugElement` for 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. 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 `

` 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. {@a detect-changes} #### _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 `

` like this: _That test fails_ with the message: ```javascript 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. 在产品阶段,当Angular创建组件、用户输入或者异步动作(比如AJAX)完成时,自动触发变更检测。 The `TestBed.createComponent` does _not_ trigger change detection. a fact confirmed in the revised test: #### _detectChanges()_ You must tell the `TestBed` to perform data binding by calling `fixture.detectChanges()`. Only then does the `

` have the expected 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](guide/lifecycle-hooks)_. Here's another test that changes the component's `title` property _before_ calling `fixture.detectChanges()`. {@a auto-detect-changes} #### 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: Then add it to the `providers` array of the testing module configuration: 然后把它添加到测试模块配置的`providers`数组中: Here are three tests that illustrate how automatic change detection works. 下列测试阐明了自动变更检测的工作原理。 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. 第二和第三个测试程序显示了一个重要的局限性。 Angular测试环境**不会**知道测试程序改变了组件的`title`属性。 自动检测只对异步行为比如承诺的解析、计时器和DOM事件作出反应。 但是直接修改组件属性值的这种同步更新是不会触发**自动检测**的。 测试程序必须手动调用`fixture.detectChange()`,来触发新一轮的变更检测周期。
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 calling `detectChanges()` more often than is strictly necessary. 与其怀疑测试工具会不会执行变更检测,本章中的例子**总是显式**调用`detectChanges()`。 即使是在不需要的时候,频繁调用`detectChanges()`没有任何什么坏处。

### 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. 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](http://plnkr.co/), 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](#compile-components). {@a component-with-dependency} ### 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`: `WelcomeComponent`为登陆的用户显示一条欢迎信息。它从注入的`UserService`的属性得知用户的身份: 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`: 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`. 这次,在测试配置里不但声明了被测试的组件,而且在`providers`数组中添加了`UserService`依赖。但不是真实的`UserService`。 {@a service-test-doubles} #### 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. 被测试的组件不一定要注入真正的服务。实际上,服务的替身(stubs, fakes, spies或者mocks)通常会更加合适。 spec的主要目的是测试组件,而不是服务。真实的服务可能自身有问题。 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`. 注入真实的`UserService`有可能很麻烦。真实的服务可能询问用户登录凭据,也可能试图连接认证服务器。 可能很难处理这些行为。所以在真实的`UserService`的位置创建和注册`UserService`替身,会让测试更加容易和安全。 This particular test suite supplies a minimal mock of the `UserService` that satisfies the needs of the `WelcomeComponent` and its tests: {@a get-injected-service} #### Get injected services The tests need access to the (stub) `UserService` injected into the `WelcomeComponent`. 测试程序需要访问被注入到`WelcomeComponent`中的`UserService`(stub类)。 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. Angular的注入系统是层次化的。 可以有很多层注入器,从根`TestBed`创建的注入器下来贯穿整个组件树。 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`. 最安全并总是有效的获取注入服务的方法,是从被测试的组件的注入器获取。 组件注入器是fixture的`DebugElement`的属性。 {@a testbed-get} #### _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:
For a use case in which `TestBed.get()` does not work, see the section [_Override a component's providers_](#component-override), which explains when and why you must get the service from the component's injector instead.
{@a service-from-injector} #### 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`. 请不要引用测试代码里提供给测试模块的`userServiceStub`对象。**这样不行!** 被注入组件的`userService`实例是完全**不一样**的对象,它提供的是`userServiceStub`的克隆。 {@a welcome-spec-setup} #### Final setup and tests Here's the complete `beforeEach()`, using `TestBed.get()`: And here are some tests: 下面是一些测试程序: The first is a sanity test; it confirms that the stubbed `UserService` is called and working. 第一个测试程序是合法测试程序,它确认这个被模拟的`UserService`是否被调用和工作正常。
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. 接下来的测试程序确认当服务返回不同的值时组件的逻辑是否工作正常。 第二个测试程序验证变换用户名字的效果。 第三个测试程序检查如果用户没有登录,组件是否显示正确消息。
{@a component-with-async-service} ### Component with async service In this sample, the `AboutComponent` template hosts a `TwainComponent`. The `TwainComponent` displays Mark Twain quotes. 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`. 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: {@a service-spy} Focus on the spy. 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. {@a sync-tests} #### Synchronous tests A key advantage of a synchronous `Observable` is that you can often turn asynchronous processes into synchronous tests. 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_. {@a fake-async} #### Async test with _fakeAsync()_ The following test confirms the expected behavior when the service returns an `ErrorObservable`. Note that the `it()` function receives an argument of the following form. ```javascript 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. {@a tick} #### 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 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. #### 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. #### 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. This helper's observable emits the `data` value in the next turn of the JavaScript engine. [RxJS `defer()`](http://reactivex.io/documentation/operators/defer.html) 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. RxJS `defer()` transform the `Promise.resolve()` into a new observable that, like `HttpClient`, emits once and completes. Subscribers will be unsubscribed after they receive the data value. There's a similar helper for producing an async error. #### 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. 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. {@a async} #### Async test with _async()_ 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](#compile-components)) calls `XHR` to read external template and css files during "just-in-time" compilation. Write tests that call `compileComponents()` with the `async()` utility.
Here's the previous `fakeAsync()` test, re-written with the `async()` utility. 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 have to pass Jasmine's `done()` into the test and call `done()` 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. {@a when-stable} #### _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. {@a jasmine-done} #### 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](http://jasmine.github.io/2.0/introduction.html#section-Asynchronous_Support). 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. For example, you can't call `async` or `fakeAsync` when testing code that involves the `intervalTimer()` or the RxJS `delay()` operator. Here are two mover 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. 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.
{@a marble-testing} ### 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](http://rxmarbles.com/) 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. Here's the complete test for getting a quote: 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](#cold-observable) that waits three [frames](#marble-frame) (`---`), emits a value (`x`), and completes (`|`). In the second argument you map the value marker (`x`) to the emitted value (`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. 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's still an async test, calling `fakeAsync()` and `tick()`, because the component itself calls `setTimeout()` when processing errors. Look at the marble observable definition. 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} A _marble frame_ is a virtual unit of testing time. Each symbol (`-`, `x`, `|`, `#`) marks the passing of one frame. {@a cold-observable} A _cold_ observable doesn't produce values until you subscribe to it. Most of your application observables are cold. All [_HttpClient_](guide/http) methods return cold observables. A _hot_ observable is already producing values _before_ you subscribe to it. The [_Router.events_](api/router/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](https://github.com/ReactiveX/rxjs/blob/master/doc/writing-marble-tests.md).
{@a component-with-input-output} ### 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. `DashboardHeroComponent`是非常小的这种类型的例子组件。 它显示由`DashboardCompoent`提供的英雄个体。 点击英雄告诉`DashbaordComponent`用户已经选择了这个英雄。 The `DashboardHeroComponent` is embedded in the `DashboardComponent` template like this: `DashboardHeroComponent`是这样内嵌在`DashboardCompoent`的模板中的: 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. `DashboardHeroComponent`在`*ngFor`循环中出现,设置每个组件的`hero`input属性到迭代的值,并监听组件的`selected`事件。 Here's the component's full definition: {@a dashboard-hero-component} 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`. 把它当作被`DashbaordComponent`使用的组件来测试 * Test it as a stand-alone component. 把它当作独立的组件来测试 * Test it as used by a substitute for `DashboardComponent`. 把它当作被`DashbaordComponent`的替代组件使用的组件来测试 A quick look at the `DashboardComponent` constructor discourages the first approach: 简单看看`DashbaordComponent`的构造函数就否决了第一种方案: 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. `DashbaordComponent`依赖Angular路由器和`HeroService`服务。 你必须使用测试替身替换它们两个,似乎过于复杂了。 路由器尤其具有挑战性。
The [discussion below](#routing-component) 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. 当前的任务是测试`DashboardHeroComponent`组件,而非`DashbaordComponent`,所以无需做不必要的努力。 让我们尝试第二和第三种方案。 {@a dashboard-standalone} #### Test _DashboardHeroComponent_ stand-alone Here's the meat of the spec file setup. 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. 注意代码是如何将模拟英雄(`expectedHero`)赋值给组件的`hero`属性的,模拟了`DashbaordComponent`在它的迭代器中通过属性绑定的赋值方式。 The following test verifies that the hero name is propagated to the template via a binding. Because the [template](#dashboard-hero-component) 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](#component-class-testing)—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: 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`. {@a trigger-event-handler} #### _triggerEventHandler_ The `heroDe` in the previous test is a `DebugElement` that represents the hero `
`. 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. Angular的`DebugElement.triggerEventHandler`可以用**事件的名字**触发**任何数据绑定事件**。 第二个参数是传递给事件处理器的事件对象。 The test triggered a "click" event with a `null` event object. The test assumes (correctly in this case) that the runtime event handler—the component's `click()` method—doesn't care about the event object. 测试程序假设(在这里应该这样)运行时间的事件处理器——组件的`click()`方法——不关心事件对象。
Other handlers are less forgiving. For example, the `RouterLink` directive expects an object with a `button` property that identifies which mouse button (if any) was pressed during the click. The `RouterLink` directive 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_. {@a click-helper} #### _click()_ helper Clicking a button, an anchor, or an arbitrary HTML element is a common test task. 点击按钮、链接或者任意HTML元素是很常见的测试任务。 Make that consistent and easy by encapsulating the _click-triggering_ process in a helper such as the `click()` function below: 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. 第一个参数是**用来点击的元素**。如果你愿意,可以将自定义的事件对象传递给第二个参数。 默认的是(局部的)鼠标左键事件对象, 它被许多事件处理器接受,包括`RouterLink`指令。
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. `click()`辅助函数**不是**Angular测试工具之一。 它是在**本章的例子代码**中定义的函数方法,被所有测试例子所用。 如果你喜欢它,将它添加到你自己的辅助函数集。
Here's the previous test, rewritten using the click helper.
{@a component-inside-test-host} ### 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: 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: This testing module configuration shows three important differences: 1. It _declares_ both the `DashboardHeroComponent` and the `TestHostComponent`. 它同时**声明**了`DashboardHeroComponent`和`TestHostComponent`。 1. It _creates_ the `TestHostComponent` instead of the `DashboardHeroComponent`. 它**创建**了`TestHostComponent`,而非`DashboardHeroComponent`。 1. The `TestHostComponent` sets the `DashboardHeroComponent.hero` with a binding. The `createComponent` returns a `fixture` that holds an instance of `TestHostComponent` instead of an instance of `DashboardHeroComponent`. `createComponent`返回的`fixture`里有`TestHostComponent`实例,而非`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. 当然,创建`TestHostComponent`有创建`DashboardHeroComponent`的副作用,因为后者出现在前者的模板中。 英雄元素(`heroEl`)的查询语句仍然可以在测试DOM中找到它,尽管元素树比以前更深。 The tests themselves are almost identical to the stand-alone version: 这些测试本身和它们的孤立版本几乎相同: 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. 只有selected事件的测试不一样。它确保被选择的`DashboardHeroComponent`英雄确实通过事件绑定被传递到宿主组件。
{@a routing-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`. Mocking the `HeroService` with a spy is a [familiar story](#component-with-async-service). 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` 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. The following test clicks the displayed hero and confirms that `Router.navigateByUrl` is called with the expected url. {@a routed-component-w-param} ### 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: 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.
The [Router](guide/router#route-parameters) guide covers `ActivatedRoute.paramMap` in 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 * `paramMap` returns an `Observable` that can emit more than one value during a test. * You need the router helper function, `convertToParamMap()`, to create a `ParamMap`. * 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`. 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_](#marble-testing).
{@a tests-w-test-double} #### Testing with _ActivatedRouteStub_ Here's a test demonstrating the component's behavior when the observed `id` refers to an existing hero: 下面的测试程序是演示组件在被观察的`id`指向现有英雄时的行为:
The `createComponent()` method and `page` object are discussed [below](#page-object). 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](#routing-component) which spies on the router without actually navigating. This test expects the component to try to navigate to the `HeroListComponent`. 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`. 虽然本应用没有在缺少`id`参数的时候,继续导航到`HeroDetailComponent`的路由,但是,将来它可能会添加这样的路由。 当没有`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: 在本例中,组件应该创建和显示新英雄。 新英雄的`id`为零,`name`为空。本测试程序确认组件是按照预期的这样做的:
### 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. 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](#why-stubbed-routerlink-tests). To validate the links, you don't need the `Router` to navigate and you don't need the `` to mark where the `Router` inserts _routed components_. The `BannerComponent` and `WelcomeComponent` (indicated by `` and ``) 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 ``, ``, and `` 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. {@a stub-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. 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. The `AppComponent` is the test subject, so of course you declare the real version. The `RouterLinkDirectiveStub`, [described later](#routerlink), is a test version of the real `RouterLink` that helps with the link tests. The rest are stubs. {@a no-errors-schema} #### *NO\_ERRORS\_SCHEMA* In the second approach, add `NO_ERRORS_SCHEMA` to the `TestBed.schemas` metadata. The `NO_ERRORS_SCHEMA` tells the Angular compiler to ignore unrecognized elements and attributes. The compiler will recognize the `` 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 ``, ``, or ``. 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. The Angular compiler creates the `BannerComponentStub` for the `` element and applies the `RouterLinkStubDirective` to the anchors with the `routerLink` attribute, but it ignores the `` and `` tags.
{@a routerlink} ### 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. The URL bound to the `[routerLink]` attribute flows in to the directive's `linkParams` property. The `host` metadata property wires the click event of the host element (the `` 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.
{@a by-directive} {@a inject-directive} #### _By.directive_ and injected directives A little more setup triggers the initial data binding and gets references to the navigation links: 再一步配置触发了数据绑定的初始化,获取导航链接的引用: Three points of special interest: 1. You can locate the anchor elements with an attached directive using `By.directive`. 1. The query returns `DebugElement` wrappers around the matching elements. 1. Each `DebugElement` exposes a dependency injector with the specific instance of the directive attached to that element. The `AppComponent` links to validate are as follows: {@a app-component-tests} Here are some tests that confirm those links are wired to the `routerLink` directives as expected:
The "click" test _in this example_ is misleading. It tests the `RouterLinkDirectiveStub` rather 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 `RouterLink` element, 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. 在本章中,它有存在的必要。 它演示了如何在不涉及完整路由器机制的情况下,如何找到`RouterLink`元素、点击它并检查结果。 要测试更复杂的组件,你可能需要具备这样的能力,能改变视图和重新计算参数,或者当用户点击链接时,有能力重新安排导航选项。
{@a why-stubbed-routerlink-tests} #### 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. stub伪造的`RouterLink`测试可以确认带有链接和outlet的组件的设置的正确性,确认组件有应该有的链接,确认它们都指向了正确的方向。 这些测试程序不关心用户点击链接时,应用是否会成功的导航到目标组件。 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. 对于这样局限的测试目标,stub伪造RouterLink和RouterOutlet是最佳选择。 依靠真正的路由器会让它们很脆弱。 它们可能因为与组件无关的原因而失败。 例如,一个导航守卫可能防止没有授权的用户访问`HeroListComponent`。 这并不是`AppComponent`的过错,并且无论该组件怎么改变都无法修复这个失败的测试程序。 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`. 未来本章的更新将介绍如何使用`RouterTestingModule`来编写这样的测试程序。

{@a page-object} ### Use a _page_ object The `HeroDetailComponent` is a simple view with a title, two hero fields, and two buttons. `HeroDetailComponent`是带有标题、两个英雄字段和两个按钮的简单视图。
HeroDetailComponent in action
But there's plenty of template complexity even in this simple form. 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. 即使是像这样一个很小的表单,也能产生令人疯狂的错综复杂的条件设置和CSS元素选择。 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` Now the important hooks for component manipulation and inspection are neatly organized and accessible from an instance of `Page`. 现在,用来操作和检查组件的重要钩子都被井然有序的组织起来了,可以通过`page`实例来使用它们。 A `createComponent` method creates a `page` object and fills in the blanks once the `hero` arrives. `createComponent`方法创建`page`,在`hero`到来时,自动填补空白。 The [_HeroDetailComponent_ tests](#tests-w-test-double) 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.
{@a compile-components} ### Calling _compileComponents()_
You can ignore this section if you _only_ run tests with the CLI `ng test` command 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. The test fails when the `TestBed` tries to create the component. 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 compile 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 message Error: ViewDestroyedError: Attempt to use a destroyed view
A typical approach is to divide the setup logic into two separate `beforeEach()` functions: 1. An async `beforeEach()` that compiles the components 1. A synchronous `beforeEach()` that performs the remaining setup. To follow this pattern, import the `async()` helper with the other testing symbols. #### The async _beforeEach_ Write the first async `beforeEach` like this. 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 `TestBed` after calling `compileComponents()`.
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. You can count on the test runner to wait for the first asynchronous `beforeEach` to finish before calling the second. 测试运行器(runner)会先等待第一个异步`beforeEach`函数执行完再调用第二个。 #### 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. #### _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.
{@a import-module} ### Setup with module imports Earlier component tests configured the testing module with a few `declarations` like this: 此前的组件测试程序使用了一些`declarations`来配置模块,就像这样: 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. `DashbaordComponent`非常简单。它不需要帮助。 但是更加复杂的组件通常依赖其它组件、指令、管道和提供商, 所以这些必须也被添加到测试模块中。 Fortunately, the `TestBed.configureTestingModule` parameter parallels the metadata passed to the `@NgModule` decorator which means you can also specify `providers` and `imports`. 幸运的是,`TestBed.configureTestingModule`参数与传入`@NgModule`装饰器的元数据一样,也就是所你也可以指定`providers`和`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: 虽然`HeroDetailComponent`很小,结构也很简单,但是它需要很多帮助。 除了从默认测试模块`CommonModule`中获得的支持,它还需要: * `NgModel` and friends in the `FormsModule` to enable two-way data binding. `FormsModule`里的`NgModel`和其它,来进行双向数据绑定 * The `TitleCasePipe` from the `shared` folder. `shared`目录里的`TitleCasePipe` * Router services (which these tests are stubbing). 一些路由器服务(测试程序将stub伪造它们) * Hero data access services (also stubbed). 英雄数据访问服务(同样被stub伪造了) One approach is to configure the testing module from the individual pieces as in this example: 一种方法是在测试模块中一一配置,就像这样:
Notice that the `beforeEach()` is asynchronous and calls `TestBed.compileComponents` because the `HeroDetailComponent` has an external template and css file. As explained in [_Calling compileComponents()_](#compile-components) 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: It's a bit tighter and smaller, with fewer import statements (not shown). 它的导入声明少一些(未显示),稍微干净一些,小一些。 {@a feature-module-import} #### Import a feature module The `HeroDetailComponent` is part of the `HeroModule` [Feature Module](guide/feature-modules) that aggregates more of the interdependent pieces including the `SharedModule`. Try a test configuration that imports the `HeroModule` like this one: That's _really_ crisp. Only the _test doubles_ in the `providers` remain. Even the `HeroDetailComponent` declaration is gone. 这样特别清爽。只有`providers`里面的测试替身被保留。连`HeroDetailComponent`声明都消失了。 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.

{@a component-override} ### Override component providers The `HeroDetailComponent` provides its own `HeroDetailService`. `HeroDetailComponent`提供自己的`HeroDetailService`服务。 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_. 在`TestBed.configureTestingModule`的`providers`中stub伪造组件的`HeroDetailService`是不可行的。 这些是**测试模块**的提供商,而非组件的。组件级别的供应商应该在**fixture级别**准备的依赖注入器。 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! Angular始终都在创建真实`HeroDetailService`的实例。
These tests could fail or timeout if the `HeroDetailService` made its own XHR calls to a remote server. There might not be a remote server to call. 如果`HeroDetailService`向远程服务器发出自己的XHR请求,这些测试可能会失败或者超时。 这个远程服务器可能根本不存在。 Fortunately, the `HeroDetailService` delegates responsibility for remote data access to an injected `HeroService`. 幸运的是,`HeroDetailService`将远程数据访问的责任交给了注入进来的`HeroService`。 The [previous test configuration](#feature-module-import) replaces the real `HeroService` with a `TestHeroService` that 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? 如果我们没有这么幸运怎么办?如果伪造`HeroService`很难怎么办?如果`HeroDetailService`自己发出服务器请求怎么办? The `TestBed.overrideComponent` method can replace the component's `providers` with easy-to-manage _test doubles_ as seen in the following setup variation: `TestBed.overrideComponent`方法可以将组件的`providers`替换为容易管理的**测试替身**,参见下面的设置变化: Notice that `TestBed.configureTestingModule` no longer provides a (fake) `HeroService` because it's [not needed](#spy-stub). {@a override-component-method} #### The _overrideComponent_ method Focus on the `overrideComponent` method. 注意这个`overrideComponent`方法。 It takes two arguments: the component type to override (`HeroDetailComponent`) and an override metadata object. The [overide metadata object](#metadata-override-object) is a generic defined as follows: type MetadataOverride = { add?: T; remove?: T; set?: 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. 元数据重载对象可以添加和删除元数据属性的项目,也可以彻底重设这些属性。 这个例子重新设置了组件的`providers`元数据。 The type parameter, `T`, is the kind of metadata you'd pass to the `@Component` decorator: 这个类型参数,`T`,是你会传递给`@Component`装饰器的元数据的类型。 selector?: string; template?: string; templateUrl?: string; providers?: any[]; ... {@a spy-stub} #### Provide a _spy stub_ (_HeroDetailServiceSpy_) This example completely replaces the component's `providers` array with a new array containing a `HeroDetailServiceSpy`. 这个例子把组件的`providers`数组完全替换成了一个包含`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. `HeroDetailServiceSpy`是实际`HeroDetailService`服务的桩版本,它伪造了该服务的所有必要特性。 但它既不需要注入也不会委托给低层的`HeroService`服务,因此我们不用为`HeroService`提供测试替身。 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: 通过对该服务的方法进行刺探,`HeroDetailComponent`的关联测试将会对`HeroDetailService`是否被调用过进行断言。 因此,这个桩类会把它的方法实现为刺探方法: {@a override-tests} #### 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. 现在,测试程序可以通过操控stub的`testHero`,直接控制组件的英雄,并确保服务的方法被调用过。 {@a more-overrides} #### 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. `TestBed.overrideComponent`方法可以在相同或不同的组件中被反复调用。 `TestBed`还提供了类似的`overrideDirective`、`overrideModule`和`overridePipe`方法,用来深入并重载这些其它类的部件。 Explore the options and combinations on your own. 自己探索这些选项和组合。
{@a attribute-directive} ## 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. 本例子应用的`HighlightDirective`使用数据绑定的颜色或者默认颜色来设置元素的背景色。 它同时设置元素的`customProperty`属性为`true`,这里仅仅是为了显示它能这么做而已,并无其它原因。 It's used throughout the application, perhaps most simply in the `AboutComponent`: 它的使用贯穿整个应用,也许最简单的使用在`AboutComponent`里: Testing the specific use of the `HighlightDirective` within the `AboutComponent` requires only the techniques explored above (in particular the ["Shallow test"](#nested-component-tests) approach). 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. 更好的方法是创建一个展示所有使用该组件的方法的人工测试组件。
HighlightDirective spec in action
The `` case binds the `HighlightDirective` to 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. ``用例将`HighlightDirective`绑定到输入框里输入的颜色名字。 初始只是单词“cyan”,所以输入框的背景色应该是cyan。
Here are some tests of this component: 下面是一些该组件的测试程序: A few techniques are noteworthy: 一些技巧值得注意: * The `By.directive` predicate is a great way to get the elements that have this directive _when their element types are unknown_. 当**已知元素类型**时,`By.directive`是一种获取拥有这个指令的元素的好方法。 * The
`:not` pseudo-class in `By.css('h2:not([highlight])')` helps find `

` elements that _do not_ have the directive. `By.css('*:not([highlight])')` finds _any_ element that does not have the directive. `By.css('h2:not([highlight])')`里的`:not`伪类(pseudo-class)帮助查找**不带**该指令的`

`元素。`By.css('*:not([highlight])')`查找**所有**不带该指令的元素。 * `DebugElement.styles` affords access to element styles even in the absence of a real browser, thanks to the `DebugElement` abstraction. But feel free to exploit the `nativeElement` when that seems easier or more clear than the abstraction. `DebugElement.styles`让我们不借助真实的浏览器也可以访问元素的样式,感谢`DebugElement`提供的这层抽象! 但是如果直接使用`nativeElement`会比这层抽象更简单、更清晰,也可以放心大胆的使用它。 * 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 `

` to get its `HighlightDirective` instance and its `defaultColor`. Angular将指令添加到它的元素的注入器中。默认颜色的测试程序使用第二个`

`的注入器来获取它的`HighlightDirective`实例以及它的`defaultColor`。 * `DebugElement.properties` affords access to the artificial custom property that is set by the directive. `DebugElement.properties`让我们可以访问由指令设置的自定义属性。
## Pipe Testing Pipes are easy to test without the Angular testing utilities. 管道很容易测试,无需Angular测试工具。 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. 管道类有一个方法,`transform`,用来转换输入值到输出值。 `transform`的实现很少与DOM交互。 除了`@Pipe`元数据和一个接口外,大部分管道不依赖Angular。 Consider a `TitleCasePipe` that capitalizes the first letter of each word. Here's a naive implementation with a regular expression. 假设`TitleCasePipe`将每个单词的第一个字母变成大写。 下面是使用正则表达式实现的简单代码: Anything that uses a regular expression is worth testing thoroughly. Use simple Jasmine to explore the expected cases and the edge cases. 任何使用正则表达式的类都值得彻底的进行测试。 使用Jasmine来探索预期的用例和极端的用例。 {@a write-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. 有些管道的测试程序是**孤立的**。 它们不能验证`TitleCasePipe`是否在应用到组件上时是否工作正常。 Consider adding component tests such as this one: 考虑像这样添加组件测试程序:
{@a test-debugging} ## Test debugging Debug specs in the browser in the same way that you debug an application. 在浏览器中,像调试应用一样调试测试程序spec。 1. Reveal the karma browser window (hidden earlier). 显示`Karma`的浏览器窗口(之前被隐藏了)。 1. Click the **DEBUG** button; it opens a new browser tab and re-runs the tests. 点击“DEBUG”按钮;它打开一页新浏览器标签并重新开始运行测试程序 1. Open the browser's “Developer Tools” (`Ctrl-Shift-I` on windows; `Command-Option-I` in OSX). 打开浏览器的“Developer Tools”(Windows上的Ctrl-Shift-I或者OSX上的`Command-Option-I)。 1. Pick the "sources" section. 选择“sources”页 1. Open the `1st.spec.ts` test file (Control/Command-P, then start typing the name of the file). 打开`1st.spec.ts`测试文件(Control/Command-P, 然后输入文件名字)。 1. Set a breakpoint in the test. 在测试程序中设置断点。 1. Refresh the browser, and it stops at the breakpoint. 刷新浏览器...然后它就会停在断点上。
Karma debugging

{@a atu-apis} ## Testing Utility APIs This section takes inventory of the most useful Angular testing features and summarizes what they do. 本节将最有用的Angular测试功能提取出来,并总结了它们的作用。 The Angular testing utilities include the `TestBed`, the `ComponentFixture`, and a handful of functions that control the test environment. The [_TestBed_](#testbed-api-summary) and [_ComponentFixture_](#component-fixture-api-summary) 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 (`it`) or setup (`beforeEach`) function within a special _async test zone_. See [discussion above](#async).
fakeAsync Runs the body of a test (`it`) within a special _fakeAsync test zone_, enabling a linear control flow coding style. See [discussion above](#fake-async).
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_.
The curious, dedicated reader might enjoy this lengthy blog post, ["_Tasks, microtasks, queues and schedules_"](https://jakearchibald.com/2015/tasks-microtasks-queues-and-schedules/). 好奇和执着的读者可能会喜欢这篇长博客: "_Tasks, microtasks, queues and schedules_".
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](#tick).
inject Injects one or more services from the current `TestBed` injector into a test function. It cannot inject a service provided by the component itself. See discussion of the [debugElement.injector](#get-injected-services).
discardPeriodicTasks When a `fakeAsync` test ends with pending timer event _tasks_ (queued `setTimeOut` and `setInterval` callbacks), the test fails with a clear error message. 当`fakeAsync`测试程序以正在运行的计时器事件**任务**(排队中的`setTimeOut`和`setInterval`的回调)结束时, 测试会失败,并显示一条明确的错误信息。 In general, a test should end with no queued tasks. When pending timer tasks are expected, call `discardPeriodicTasks` to flush the _task_ queue and avoid the error. 一般来讲,测试程序应该以无排队任务结束。 当待执行计时器任务存在时,调用`discardPeriodicTasks`来触发**任务**队列,防止该错误发生。
flushMicrotasks When a `fakeAsync` test ends with pending _micro-tasks_ such as unresolved promises, the test fails with a clear error message. 当`fakeAsync`测试程序以待执行**微任务**(比如未解析的承诺)结束时,测试会失败并显示明确的错误信息。 In general, a test should wait for micro-tasks to finish. When pending microtasks are expected, call `flushMicrotasks` to flush the _micro-task_ queue and avoid the error. 一般来说,测试应该等待微任务结束。 当待执行微任务存在时,调用`flushMicrotasks`来触发**微任务**队列,防止该错误发生。
ComponentFixtureAutoDetect A provider token for a service that turns on [automatic change detection](#automatic-change-detection).
getTestBed Gets the current instance of the `TestBed`. Usually unnecessary because the static class methods of the `TestBed` class are typically sufficient. The `TestBed` instance exposes a few rarely used members that are not available as static methods. 获取当前`TestBed`实例。 通常用不上,因为`TestBed`的静态类方法已经够用。 `TestBed`实例有一些很少需要用到的方法,它们没有对应的静态方法。

{@a testbed-class-summary} #### _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. `TestBed`类是Angular测试工具的主要类之一。它的API很庞大,可能有点过于复杂,直到你一点一点的探索它们。 阅读本章前面的部分,了解了基本的知识以后,再试着了解完整API。 The module definition passed to `configureTestingModule` is a subset of the `@NgModule` metadata properties. 传递给`configureTestingModule`的模块定义是`@NgModule`元数据属性的子集。 type TestModuleMetadata = { providers?: any[]; declarations?: any[]; imports?: any[]; schemas?: Array<SchemaMetadata | any[]>; }; {@a metadata-override-object} Each override method takes a `MetadataOverride` where `T` is the kind of metadata appropriate to the method, that is, the parameter of an `@NgModule`, `@Component`, `@Directive`, or `@Pipe`. 每一个重载方法接受一个`MetadataOverride`,这里`T`是适合这个方法的元数据类型,也就是`@NgModule`、`@Component`、`@Directive`或者`@Pipe`的参数。 type MetadataOverride = { add?: T; remove?: T; set?: T; }; {@a testbed-methods} {@a testbed-api-summary} The `TestBed` API consists of static class methods that either update or reference a _global_ instance of the`TestBed`. `TestBed`的API包含了一系列静态类方法,它们更新或者引用**全局**的`TestBed`实例。 Internally, all static methods cover methods of the current runtime `TestBed` instance, which is also returned by the `getTestBed()` function. 在内部,所有静态方法在`getTestBed()`函数返回的当前运行时间的`TestBed`实例上都有对应的方法。 Call `TestBed` methods _within_ a `beforeEach()` to ensure a fresh start before each individual test. 在`BeforeEach()`内调用`TestBed`方法,这样确保在运行每个单独测试时,都有崭新的开始。 Here are the most important static methods, in order of likely utility. 这里列出了最重要的静态方法,以使用频率排序:
Methods 方法 Description 说明
configureTestingModule The testing shims (`karma-test-shim`, `browser-test-shim`) establish the [initial test environment](guide/testing) and a default testing module. The default testing module is configured with basic declaratives and some Angular service substitutes that every tester needs. 测试垫片(`karma-test-shim`, `browser-test-shim`)创建了[初始测试环境](guide/testing)和默认测试模块。 默认测试模块是使用基本声明和一些Angular服务替代品,它们是所有测试程序都需要的。 Call `configureTestingModule` to refine the testing module configuration for a particular set of tests by adding and removing imports, declarations (of components, directives, and pipes), and providers. 调用`configureTestingModule`来为一套特定的测试定义测试模块配置,添加和删除导入、(组件、指令和管道的)声明和服务提供商。
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 `templateUrl` or `styleUrls` because fetching component template and style files is necessarily asynchronous. See [above](#compile-components). After calling `compileComponents`, the `TestBed` configuration is frozen for the duration of the current spec. 调用完`compileComponents`之后,`TestBed`的配置就会在当前测试期间被冻结。
createComponent Create an instance of a component of type `T` based on the current `TestBed` configuration. After calling `compileComponent`, the `TestBed` configuration is frozen for the duration of the current spec. 基于当前`TestBed`的配置创建一个类型为T的组件实例。 一旦调用,`TestBed`的配置就会在当前测试期间被冻结。
overrideModule Replace metadata for the given `NgModule`. Recall that modules can import other modules. The `overrideModule` method can reach deeply into the current testing module to modify one of these inner modules. 替换指定的`NgModule`的元数据。回想一下,模块可以导入其他模块。 `overrideModule`方法可以深入到当前测试模块深处,修改其中一个内部模块。
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. 替换指定管道类的元数据,该管道可能嵌套在一个很深的内部模块中。
{@a testbed-get} get Retrieve a service from the current `TestBed` injector. 从当前`TestBed`注入器获取一个服务。 The `inject` function is often adequate for this purpose. But `inject` throws an error if it can't provide the service. What if the service is optional? The `TestBed.get()` method takes an optional second parameter, the object to return if Angular can't find the provider (`null` in this example): After calling `get`, the `TestBed` configuration is frozen for the duration of the current spec. 一旦调用,`TestBed`的配置就会在当前测试期间被冻结。
{@a testbed-initTestEnvironment} initTestEnvironment Initialize the testing environment for the entire test run. 为整套测试的运行初始化测试环境。 The testing shims (`karma-test-shim`, `browser-test-shim`) call it for you so there is rarely a reason for you to call it yourself. 测试垫片(`karma-test-shim`, `browser-test-shim`)会为你调用它,所以你很少需要自己调用它。 You may call this method _exactly once_. If you must change this default in the middle of your test run, call `resetTestEnvironment` first. 这个方法只能被调用**一次**。如果确实需要在测试程序运行期间变换这个默认设置,那么先调用`resetTestEnvironment`。 Specify the Angular compiler factory, a `PlatformRef`, and a default Angular testing module. Alternatives for non-browser platforms are available in the general form `@angular/platform-/testing/`. 指定Angular编译器工厂,`PlatformRef`,和默认Angular测试模块。 以`@angular/platform-/testing/`的形式提供非浏览器平台的替代品。
resetTestEnvironment Reset the initial test environment, including the default testing module. 重设初始测试环境,包括默认测试模块在内。
` creates an instance of the component `T` and returns a strongly typed `ComponentFixture` for that component. `TestBed.createComponent`创建一个组件`T`的实例,并为该组件返回一个强类型的`ComponentFixture`。 The `ComponentFixture` properties and methods provide access to the component, its DOM representation, and aspects of its Angular environment. `ComponentFixture`的属性和方法提供了对组件、它的DOM和它的Angular环境方面的访问。 {@a component-fixture-properties} #### _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 `TestBed.createComponent`. 被`TestBed.createComponent`创建的组件类实例。
debugElement The `DebugElement` associated with the root element of the component. 与组件根元素关联的`DebugElement`。 The `debugElement` provides insight into the component and its DOM element during test and debugging. It's a critical property for testers. The most interesting members are covered [below](#debug-element-details).
nativeElement The native DOM element at the root of the component. 组件的原生根DOM元素。
changeDetectorRef The `ChangeDetectorRef` for the component. 组件的`ChangeDetectorRef`。 The `ChangeDetectorRef` is most valuable when testing a component that has the `ChangeDetectionStrategy.OnPush` method or the component's change detection is under your programmatic control. 在测试一个拥有`ChangeDetectionStrategy.OnPush`的组件,或者在组件的变化测试在你的程序控制下时,`ChangeDetectorRef`是最重要的。
{@a component-fixture-methods} #### _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. **fixture**方法使Angular对组件树执行某些任务。 在触发Angular行为来模拟的用户行为时,调用这些方法。 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 `ngOnInit`) and after your test code, change the component's data bound property values. Angular can't see that you've changed `personComponent.name` and won't update the `name` binding until you call `detectChanges`. 调用它来初始化组件(它调用`ngOnInit`)。或者在你的测试代码改变了组件的数据绑定属性值后调用它。 Angular不能检测到你已经改变了`personComponent.name`属性,也不会更新`name`的绑定,直到你调用了`detectChanges`。 Runs `checkNoChanges`afterwards to confirm that there are no circular updates unless called as `detectChanges(false)`; 之后,运行`checkNoChanges`,来确认没有循环更新,除非它被这样调用:`detectChanges(false)`。
autoDetectChanges Set this to `true` when you want the fixture to detect changes automatically. 设置fixture是否应该自动试图检测变化。 When autodetect is `true`, the test fixture calls `detectChanges` immediately after creating the component. Then it listens for pertinent zone events and calls `detectChanges` accordingly. When your test code modifies component property values directly, you probably still have to call `fixture.detectChanges` to trigger data binding updates. 当自动检测打开时,测试fixture监听**zone**事件,并调用`detectChanges`。 当你的测试代码直接修改了组件属性值时,你还是要调用`fixture.detectChanges`来触发数据绑定更新。 The default is `false`. Testers who prefer fine control over test behavior tend to keep it `false`. 默认值是`false`,喜欢对测试行为进行精细控制的测试者一般保持它为`false`。
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 `true`. If there are async tasks that have not completed, returns `false`. 如果fixture当前是**稳定的**,则返回`true`。 如果有异步任务没有完成,则返回`false`。
whenStable Returns a promise that resolves when the fixture is stable. 返回一个承诺,在fixture稳定时解析。 To resume testing after completion of asynchronous activity or asynchronous change detection, hook that promise. See [above](#when-stable).
destroy Trigger component destruction. 触发组件的销毁。
{@a debug-element-details} #### _DebugElement_ The `DebugElement` provides crucial insights into the component's DOM representation. `DebugElement`提供了对组件的DOM的访问。 From the test root component's `DebugElement` returned by `fixture.debugElement`, you can walk (and query) the fixture's entire element and component subtrees. `fixture.debugElement`返回测试根组件的`DebugElement`,通过它你可以访问(查询)fixture的整个元素和组件子树。 Here are the most useful `DebugElement` members for testers, in approximate order of utility: 下面是`DebugElement`最有用的成员,以使用频率排序。
Member 成员 Description 说明
nativeElement The corresponding DOM element in the browser (null for WebWorkers). 与浏览器中DOM元素对应(WebWorkers时,值为null)。
query Calling `query(predicate: Predicate)` returns the first `DebugElement` that matches the [predicate](#query-predicate) at any depth in the subtree.
queryAll Calling `queryAll(predicate: Predicate)` returns all `DebugElements` that matches the [predicate](#query-predicate) at any depth in subtree.
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 `*ngFor`, the context is an `NgForRow` whose `$implicit` property is the value of the row instance value. For example, the `hero` in `*ngFor="let hero of heroes"`. 当一个元素被`*ngFor`重复,它的上下文为`NgForRow`,它的`$implicit`属性值是该行的实例值。 比如,`*ngFor="let hero of heroes"`里的`hero`。
children The immediate `DebugElement` children. Walk the tree by descending through `children`.
`DebugElement` also has `childNodes`, a list of `DebugNode` objects. `DebugElement` derives from `DebugNode` objects and there are often more nodes than elements. Testers can usually ignore plain nodes. `DebugElement`还有`childNodes`,即`DebugNode`对象列表。 `DebugElement`从`DebugNode`对象衍生,而且通常节点(node)比元素多。测试者通常忽略赤裸节点。
parent The `DebugElement` parent. Null if this is the root element. `DebugElement`的父级。如果`DebugElement`是根元素,`parent`为null。
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 `listeners` collection. The second parameter is the _event object_ expected by the handler. See [above](#trigger-event-handler). If the event lacks a listener or there's some other problem, consider calling `nativeElement.dispatchEvent(eventObject)`. 如果事件缺乏监听器,或者有其它问题,考虑调用`nativeElement.dispatchEvent(eventObject)`。
listeners The callbacks attached to the component's `@Output` properties and/or the element's event properties. 元素的`@Output`属性以及/或者元素的事件属性所附带的回调函数。
providerTokens This component's injector lookup tokens. Includes the component itself plus the tokens that the component lists in its `providers` metadata. 组件注入器的查询令牌。 包括组件自己的令牌和组件的`providers`元数据中列出来的令牌。
source Where to find this element in the source component template. source是在源组件模板中查询这个元素的处所。
references Dictionary of objects associated with template local variables (e.g. `#foo`), keyed by the local variable name. 与模板本地变量(比如`#foo`)关联的词典对象,关键字与本地变量名字配对。
{@a query-predicate} The `DebugElement.query(predicate)` and `DebugElement.queryAll(predicate)` methods take a predicate that filters the source element's subtree for matching `DebugElement`. `DebugElement.query(predicate)`和`DebugElement.queryAll(predicate)`方法接受一个条件方法, 它过滤源元素的子树,返回匹配的`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": 这个条件方法是任何接受一个`DebugElement`并返回真值的方法。 下面的例子查询所有拥有名为`content`的模块本地变量的所有`DebugElement`: The Angular `By` class has three static methods for common predicates: Angular的`By`类为常用条件方法提供了三个静态方法: * `By.all` - return all elements. `By.all` - 返回所有元素 * `By.css(selector)` - return elements with matching CSS selectors. `By.css(selector)` - 返回符合CSS选择器的元素。 * `By.directive(directive)` - return elements that Angular matched to an instance of the directive class. `By.directive(directive)` - 返回Angular能匹配一个指令类实例的所有元素。
{@a faq} ## Frequently Asked Questions {@a q-spec-file-location} #### 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: 我们推荐将单元测试的spec配置文件放到与应用程序源代码文件所在的同一个文件夹中,因为: * 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. 当你重命名源代码文件(无可避免),你记得重命名测试程序文件。
{@a q-specs-in-test-folder} #### 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. 应用程序的整合测试spec文件可以测试横跨多个目录和模块的多个部分之间的互动。 它们不属于任何部分,很自然,没有特别的地方存放它们。 It's often better to create an appropriate folder for them in the `tests` directory. 通常,在`test`目录中为它们创建一个合适的目录比较好。 Of course specs that test the test helpers belong in the `test` folder, next to their corresponding helper files. 当然,**测试助手对象**的测试spec文件也属于`test`目录,与它们对应的助手文件相邻。 {@a q-e2e} #### Why not rely on E2E tests of DOM integration? The component DOM tests describe in this guide often require extensive setup and advanced techniques where as the [class-only test](#component-class-testing) were 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.