非常教程

AngularJS参考手册

测试

测试

该指南提供了对 Angular 应用进行单元测试和集成测试的技巧和提示。

该指南中的测试面向的是一个很像《英雄指南》教程的 CLI 范例应用。 这个范例应用及其所有测试都可以在下面的链接中进行查看和试用:

  • 范例应用 / 下载范例
  • 测试 / 下载范例

准备工作

Angular CLI 会下载并安装试用 Jasmine 测试框架 测试 Angular 应用时所需的一切。

你使用 CLI 创建的项目是可以立即用于测试的。 运行下列 CLI 命令即可:

content_copyng test

ng test 命令在监视模式下构建应用,并启动 karma 测试运行器。

它的控制台输出一般是这样的:

content_copy10% 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)

最后一行很重要。它表示 Karma 运行了三个测试,而且这些测试都通过了。

它还会打开 Chrome 浏览器并在“ Jasmine HTML 报告器”中显示测试输出,就像这样:

测试

大多数人都会觉得浏览器中的报告比控制台中的日志更容易阅读。 你可以点击一行测试,来单独重跑这个测试,或者点击一行描述信息来重跑所选测试组(“测试套件”)中的那些测试。

同时,ng test 命令还会监听这些变化。

要查看它的实际效果,就对 app.component.ts 做一个小修改,并保存它。 这些测试就会重新运行,浏览器也会刷新,然后新的测试结果就出现了。

配置

CLI 会为你生成 Jasmine 和 Karma 的配置文件。

不过你也可以通过编辑 src/ 目录下的 karma.conf.jstest.ts 文件来微调很多选项。

karma.conf.js 文件是 karma 配置文件的一部分。 CLI 会基于 angular.json 文件中指定的项目结构和 karma.conf.js 文件,来在内存中构建出完整的运行时配置。

要进一步了解 Jasmine 和 Karma 的配置项,请搜索网络。

其它测试框架

你还可以使用其它的测试库和测试运行器来对 Angular 应用进行单元测试。 每个库和运行器都有自己特有的安装过程、配置项和语法。

要了解更多,请搜索网络。

测试文件名及其位置

查看 src/app 文件夹。

CLI 为 AppComponent 生成了一个名叫 app.component.spec.ts 的测试文件。

测试文件的扩展名必须是 .spec.ts,这样工具才能识别出它是一个测试文件,也叫规约(spec)文件。

app.component.tsapp.component.spec.ts 文件位于同一个文件夹中,而且相邻。 其根文件名部分(app.component)都是一样的。

请在你的项目中对任意类型的测试文件都坚持这两条约定。

对服务的测试

服务通常是单元测试中最简单的文件类型。 下面是一些针对 ValueService 的同步和异步单元测试, 编写它们时没有借助来自 Angular 测试工具集的任何协助。

app/demo/demo.spec.ts

content_copy// Straight Jasmine testing without Angular's testing supportdescribe('ValueService', () => {  let service: ValueService;  beforeEach(() => { service = new ValueService(); });   it('#getValue should return real value', () => {    expect(service.getValue()).toBe('real value');  });   it('#getObservableValue should return value from observable',    (done: DoneFn) => {    service.getObservableValue().subscribe(value => {      expect(value).toBe('observable value');      done();    });  });   it('#getPromiseValue should return value from a promise',    (done: DoneFn) => {    service.getPromiseValue().then(value => {      expect(value).toBe('promise value');      done();    });  });});

带有依赖的服务

服务通常会依赖于一些 Angular 注入到其构造函数中的其它服务。 多数情况下,创建并在调用该服务的构造函数时,手工创建并注入这些依赖也是很容易的。

MasterService 就是一个简单的例子:

app/demo/demo.ts

content_copy@Injectable()
export class MasterService {
  constructor(private valueService: ValueService) { }
  getValue() { return this.valueService.getValue(); }
}

MasterService 把它唯一的方法 getValue 委托给了注入进来的 ValueService

这里是几种测试它的方法。

app/demo/demo.spec.ts

content_copydescribe('MasterService without Angular testing support', () => {  let masterService: MasterService;   it('#getValue should return real value from the real service', () => {    masterService = new MasterService(new ValueService());    expect(masterService.getValue()).toBe('real value');  });   it('#getValue should return faked value from a fakeService', () => {    masterService = new MasterService(new FakeValueService());    expect(masterService.getValue()).toBe('faked service value');  });   it('#getValue should return faked value from a fake object', () => {    const fake =  { getValue: () => 'fake value' };    masterService = new MasterService(fake as ValueService);    expect(masterService.getValue()).toBe('fake value');  });   it('#getValue should return stubbed value from a spy', () => {    // create `getValue` spy on an object representing the ValueService    const valueServiceSpy =      jasmine.createSpyObj('ValueService', ['getValue']);     // set the value to return when the `getValue` spy is called.    const stubValue = 'stub value';    valueServiceSpy.getValue.and.returnValue(stubValue);     masterService = new MasterService(valueServiceSpy);     expect(masterService.getValue())      .toBe(stubValue, 'service returned stub value');    expect(valueServiceSpy.getValue.calls.count())      .toBe(1, 'spy method was called once');    expect(valueServiceSpy.getValue.calls.mostRecent().returnValue)      .toBe(stubValue);  });});

第一个测试使用 new 创建了 ValueService,然后把它传给了 MasterService 的构造函数。

不过,对于大多数没这么容易创建和控制的依赖项来说,注入真实的服务很容易出问题。

你可以改用模拟依赖的方式,你可以使用虚值或在相关的服务方法上创建一个间谍(spy)。

优先使用间谍,因为它们通常是 Mock 服务时最简单的方式。

这些标准的测试技巧对于在隔离的环境下对服务进行单元测试非常重要。

不过,你几乎迟早要用 Angular 的依赖注入机制来把服务注入到应用类中去,而且你应该已经有了这类测试。 Angular 的测试工具集可以让你轻松探查这种注入服务的工作方式。

使用 TestBed(测试机床)测试服务

你的应用中会依赖 Angular 的依赖注入 (DI) 来创建服务。 当某个服务依赖另一个服务时,DI 就会找到或创建那个被依赖的服务。 如果那个被依赖的服务还有它自己的依赖,DI 也同样会找到或创建它们。

作为服务的消费方,你不需要关心这些细节。 你不用关心构造函数中的参数顺序或如何创建它们。

但对于服务的测试方来说,你就至少要考虑服务的第一级依赖了。 不过你可以让 Angular DI 来负责服务的创建工作,但当你使用 TestBed 测试工具来提供和创建服务时,你仍然需要关心构造函数中的参数顺序。

Angular TestBed

TestBed 是 Angular 测试工具中最重要的部分。 TestBed 会动态创建一个用来模拟 @NgModule 的 Angular 测试模块。

TestBed.configureTestingModule() 方法接收一个元数据对象,其中具有 @NgModule 中的绝大多数属性。

要测试某个服务,就要在元数据的 providers 属性中指定一个将要进行测试或模拟的相关服务的数组。

app/demo/demo.testbed.spec.ts (provide ValueService in beforeEach

content_copylet service: ValueService;

beforeEach(() => {
  TestBed.configureTestingModule({ providers: [ValueService] });
});

然后通过调用 TestBed.get()(参数为该服务类)把它注入到一个测试中。

content_copyit('should use ValueService', () => {
  service = TestBed.get(ValueService);
  expect(service.getValue()).toBe('real value');
});

或者,如果你更倾向于把该服务作为环境准备过程的一部分,就把它放在 beforeEach() 中。

content_copybeforeEach(() => {
  TestBed.configureTestingModule({ providers: [ValueService] });
  service = TestBed.get(ValueService);
});

如果要测试一个带有依赖项的服务,那就把模拟对象放在 providers 数组中。

在下面的例子中,模拟对象是一个间谍(spy)对象。

content_copylet masterService: MasterService;
let valueServiceSpy: jasmine.SpyObj<ValueService>;

beforeEach(() => {
  const spy = jasmine.createSpyObj('ValueService', ['getValue']);

  TestBed.configureTestingModule({
    // Provide both the service-to-test and its (spy) dependency
    providers: [
      MasterService,
      { provide: ValueService, useValue: spy }
    ]
  });
  // Inject both the service-to-test and its (spy) dependency
  masterService = TestBed.get(MasterService);
  valueServiceSpy = TestBed.get(ValueService);
});

该测试会像以前一样消费这个间谍对象。

content_copyit('#getValue should return stubbed value from a spy', () => {
  const stubValue = 'stub value';
  valueServiceSpy.getValue.and.returnValue(stubValue);

  expect(masterService.getValue())
    .toBe(stubValue, 'service returned stub value');
  expect(valueServiceSpy.getValue.calls.count())
    .toBe(1, 'spy method was called once');
  expect(valueServiceSpy.getValue.calls.mostRecent().returnValue)
    .toBe(stubValue);
});

不使用 beforeEach 进行测试

本指南中的大多数的测试套件都会调用 beforeEach() 来为每个 it() 测试准备前置条件,并依赖 TestBed 来创建类和注入服务。

另一些测试教程中也可能让你不要调用 beforeEach(),并且更倾向于显式创建类,而不要借助 TestBed

下面的例子教你如何把 MasterService 的测试改写成那种风格。

通过把可复用的准备代码放进一个单独的 setup 函数来代替 beforeEach()

app/demo/demo.spec.ts (setup)

content_copyfunction setup() {
  const valueServiceSpy =
    jasmine.createSpyObj('ValueService', ['getValue']);
  const stubValue = 'stub value';
  const masterService = new MasterService(valueServiceSpy);

  valueServiceSpy.getValue.and.returnValue(stubValue);
  return { masterService, stubValue, valueServiceSpy };
}

setup() 函数返回一个带有一些变量的对象字面量,比如 masterService,测试中可以引用它。 这样你就不用在 describe() 中定义一些半全局性的变量了(比如 let masterService: MasterService)。

然后,每个测试都会在第一行调用 setup(),然后再操纵被测主体以及对期望值进行断言。

content_copyit('#getValue should return stubbed value from a spy', () => {
  const { masterService, stubValue, valueServiceSpy } = setup();
  expect(masterService.getValue())
    .toBe(stubValue, 'service returned stub value');
  expect(valueServiceSpy.getValue.calls.count())
    .toBe(1, 'spy method was called once');
  expect(valueServiceSpy.getValue.calls.mostRecent().returnValue)
    .toBe(stubValue);
});

注意这些测试是如何使用 解构赋值 来提取出所需变量的。

content_copyconst { masterService, stubValue, valueServiceSpy } = setup();

很多开发者觉得这种方式相比传统的 beforeEach() 风格更加干净、更加明确。

虽然本章会遵循传统的风格,并且 CLI 生成的默认测试文件也用的是beforeEach()TestBed,不过你可以在自己的项目中自由选择这种可选方式

测试 HTTP 服务

那些会向远端服务器发起 HTTP 调用的数据服务,通常会注入 Angular 的 HttpClient 服务并委托它进行 XHR 调用。

你可以像测试其它带依赖的服务那样,通过注入一个 HttpClient 间谍来测试这种数据服务。

app/model/hero.service.spec.ts (tests with spies)

content_copylet httpClientSpy: { get: jasmine.Spy };let heroService: HeroService; beforeEach(() => {  // TODO: spy on other methods too  httpClientSpy = jasmine.createSpyObj('HttpClient', ['get']);  heroService = new HeroService(<any> httpClientSpy);}); it('should return expected heroes (HttpClient called once)', () => {  const expectedHeroes: Hero[] =    [{ id: 1, name: 'A' }, { id: 2, name: 'B' }];   httpClientSpy.get.and.returnValue(asyncData(expectedHeroes));   heroService.getHeroes().subscribe(    heroes => expect(heroes).toEqual(expectedHeroes, 'expected heroes'),    fail  );  expect(httpClientSpy.get.calls.count()).toBe(1, 'one call');}); it('should return an error when the server returns a 404', () => {  const errorResponse = new HttpErrorResponse({    error: 'test 404 error',    status: 404, statusText: 'Not Found'  });   httpClientSpy.get.and.returnValue(asyncError(errorResponse));   heroService.getHeroes().subscribe(    heroes => fail('expected an error, not heroes'),    error  => expect(error.message).toContain('test 404 error')  );});

HttpService 中的方法会返回 Observables订阅这些方法返回的可观察对象会让它开始执行,并且断言这些方法是成功了还是失败了。

subscribe() 方法接受一个成功回调 (next) 和一个失败 (error) 回调。 你要确保同时提供了这两个回调,以便捕获错误。 如果忽略这些异步调用中未捕获的错误,测试运行器可能会得出截然不同的测试结论。

HttpClientTestingModule

如果将来 HttpClient 和数据服务之间有更多的交互,则可能会变得复杂,而且难以使用间谍进行模拟。

HttpClientTestingModule 可以让这些测试场景变得更加可控。

本章的代码范例要示范的是 HttpClientTestingModule,所以把部分内容移到了 HttpClient 中,那里会详细讲解如何用 HttpClientTestingModule 进行测试。

本章范例代码中的 app/model/http-hero.service.spec.ts还示范了如何使用传统的 HttpModule 进行验证。

组件测试基础

组件与 Angular 应用中的其它部分不同,它是由 HTML 模板和 TypeScript 类组成的。 组件其实是指模板加上与其合作的类。 要想对组件进行充分的测试,就要测试它们能否如预期的那样协作。

这些测试需要在浏览器的 DOM 中创建组件的宿主元素(就像 Angular 所做的那样),然后检查组件类和 DOM 的交互是否如同它在模板中所描述的那样。

Angular 的 TestBed 为所有这些类型的测试提供了基础设施。 但是很多情况下,可以单独测试组件类本身而不必涉及 DOM,就已经可以用一种更加简单、清晰的方式来验证该组件的大多数行为了。

单独测试组件类

你可以像测试服务类一样测试组件类。

考虑下面这个 LightswitchComponent,当用户点击按钮时,它会切换灯的开关状态(用屏幕上的消息展现出来)。

app/demo/demo.ts (LightswitchComp)

content_copy@Component({
  selector: 'lightswitch-comp',
  template: `
    <button (click)="clicked()">Click me!</button>
    <span>{{message}}</span>`
})
export class LightswitchComponent {
  isOn = false;
  clicked() { this.isOn = !this.isOn; }
  get message() { return `The light is ${this.isOn ? 'On' : 'Off'}`; }
}

你可能要测试 clicked() 方法能否正确切换灯的开关状态。

该组件类没有依赖。 要测试一个没有依赖的服务,你会用 new 来创建它,调用它的 API,然后对它的公开状态进行断言。 组件类也可以这么做。

app/demo/demo.spec.ts (Lightswitch tests)

content_copydescribe('LightswitchComp', () => {
  it('#clicked() should toggle #isOn', () => {
    const comp = new LightswitchComponent();
    expect(comp.isOn).toBe(false, 'off at first');
    comp.clicked();
    expect(comp.isOn).toBe(true, 'on after click');
    comp.clicked();
    expect(comp.isOn).toBe(false, 'off after second click');
  });

  it('#clicked() should set #message to "is on"', () => {
    const comp = new LightswitchComponent();
    expect(comp.message).toMatch(/is off/i, 'off at first');
    comp.clicked();
    expect(comp.message).toMatch(/is on/i, 'on after clicked');
  });
});

下面这段代码是来自《英雄指南》教程的 DashboardHeroComponent

app/dashboard/dashboard-hero.component.ts (component)

content_copyexport class DashboardHeroComponent {
  @Input() hero: Hero;
  @Output() selected = new EventEmitter<Hero>();
  click() { this.selected.emit(this.hero); }
}

它呈现在父组件的模板中,那里把一个英雄绑定到了 @Input 属性上,并且通过 @Output 属性监听选中英雄时的事件。

你可以测试 DashboardHeroComponent 类,而不用完整创建它或其父组件。

app/dashboard/dashboard-hero.component.spec.ts (class tests)

content_copyit('raises the selected event when clicked', () => {
  const comp = new DashboardHeroComponent();
  const hero: Hero = { id: 42, name: 'Test' };
  comp.hero = hero;

  comp.selected.subscribe(selectedHero => expect(selectedHero).toBe(hero));
  comp.click();
});

当组件有依赖时,你可能要使用 TestBed 来同时创建该组件及其依赖。

下面的 WelcomeComponent 依赖于 UserService,并通过它知道要打招呼的那位用户的名字。

app/welcome/welcome.component.ts

content_copyexport class WelcomeComponent  implements OnInit {
  welcome: string;
  constructor(private userService: UserService) { }

  ngOnInit(): void {
    this.welcome = this.userService.isLoggedIn ?
      'Welcome, ' + this.userService.user.name : 'Please log in.';
  }
}

你可能要先创建一个满足本组件最小需求的模拟板 UserService

app/welcome/welcome.component.spec.ts (MockUserService)

content_copyclass MockUserService {
  isLoggedIn = true;
  user = { name: 'Test User'};
};

然后在 TestBed 的配置中提供并注入该组件和该服务

app/welcome/welcome.component.spec.ts (class-only setup)

content_copybeforeEach(() => {
  TestBed.configureTestingModule({
    // provide the component-under-test and dependent service
    providers: [
      WelcomeComponent,
      { provide: UserService, useClass: MockUserService }
    ]
  });
  // inject both the component and the dependent service.
  comp = TestBed.get(WelcomeComponent);
  userService = TestBed.get(UserService);
});

然后使用这个组件类,别忘了像 Angular 运行本应用时那样调用它的生命周期钩子方法。

app/welcome/welcome.component.spec.ts (class-only tests)

content_copyit('should not have welcome message after construction', () => {
  expect(comp.welcome).toBeUndefined();
});

it('should welcome logged in user after Angular calls ngOnInit', () => {
  comp.ngOnInit();
  expect(comp.welcome).toContain(userService.user.name);
});

it('should ask user to log in if not logged in after ngOnInit', () => {
  userService.isLoggedIn = false;
  comp.ngOnInit();
  expect(comp.welcome).not.toContain(userService.user.name);
  expect(comp.welcome).toContain('log in');
});

组件 DOM 的测试

测试组件就像测试服务那样简单。

但组件不仅是这个类。 组件还要和 DOM 以及其它组件进行交互。 只涉及类的测试可以告诉你组件类的行为是否正常, 但是不能告诉你组件是否能正常渲染出来、响应用户的输入和查询或与它的父组件和子组件相集成。

上述只涉及类的测试没办法回答这些组件在屏幕上的行为之类的关键性问题:

  • Lightswitch.clicked() 是否真的绑定到了某些用户可以接触到的东西?
  • Lightswitch.message 是否真的显示出来了?
  • 用户真的可以选择 DashboardHeroComponent 中显示的某个英雄吗?
  • 英雄的名字是否如预期般显示出来了?(比如是否大写)
  • WelcomeComponent 的模板是否显示了欢迎信息?

这些问题对于上面这种简单的组件来说当然没有问题, 不过很多组件和它们模板中所描述的 DOM 元素之间会有复杂的交互,当组件的状态发生变化时,会导致一些 HTML 出现和消失。

要回答这类问题,你就不得不创建那些与组件相关的 DOM 元素了,你必须检查 DOM 来确认组件的状态能在恰当的时机正常显示出来,并且必须通过屏幕来仿真用户的交互,以判断这些交互是否如预期的那般工作。

要想写这类测试,你就要用到 TestBed 的附加功能以及其它测试助手了。

CLI 生成的测试

当你用 CLI 生成新的组件时,它也会默认创建最初的测试文件。

比如,下列 CLI 命令会在 app/banner 文件夹中创建带有内联模板和内联样式的 BannerComponent

content_copyng generate component banner --inline-template --inline-style --module app

它也会为组件生成最初的测试文件 banner-external.component.spec.ts,代码如下:

app/banner/banner-external.component.spec.ts (initial)

content_copyimport { async, ComponentFixture, TestBed } from '@angular/core/testing';
import { BannerComponent } from './banner.component';

describe('BannerComponent', () => {
  let component: BannerComponent;
  let fixture: ComponentFixture<BannerComponent>;

  beforeEach(async(() => {
    TestBed.configureTestingModule({
      declarations: [ BannerComponent ]
    })
    .compileComponents();
  }));

  beforeEach(() => {
    fixture = TestBed.createComponent(BannerComponent);
    component = fixture.componentInstance;
    fixture.detectChanges();
  });

  it('should create', () => {
    expect(component).toBeDefined();
  });
});

缩减环境准备代码

这个文件中只有最后三行是真正测试组件的,它们用来断言 Angular 可以创建该组件。

文件的其它部分都是为更高级的测试二准备的样板代码,当组件逐渐演变成更加实质性的东西时,它们才可能变成必备的。

稍后你将学到这些高级的测试特性。 不过目前,你可以先把这些测试文件缩减成更加可控的大小,以便理解:

app/banner/banner-initial.component.spec.ts (minimal)

content_copydescribe('BannerComponent (minimal)', () => {
  it('should create', () => {
    TestBed.configureTestingModule({
      declarations: [ BannerComponent ]
    });
    const fixture = TestBed.createComponent(BannerComponent);
    const component = fixture.componentInstance;
    expect(component).toBeDefined();
  });
});

在这个例子中,传给 TestBed.configureTestingModule 的元数据对象中只声明了 BannerComponent —— 待测试的组件。

content_copyTestBed.configureTestingModule({
  declarations: [ BannerComponent ]
});

不用声明或导入任何其它的东西。 默认的测试模块中已经预先配置好了一些东西,比如来自 @angular/platform-browserBrowserModule

稍后你将会调用带有导入模块、服务提供商和更多可声明对象的 TestBed.configureTestingModule() 来满足测试所需。 将来还可以用可选的 override 方法对这些配置进行微调。

createComponent()

在配置好 TestBed 之后,你还可以调用它的 createComponent() 方法。

content_copyconst fixture = TestBed.createComponent(BannerComponent);

TestBed.createComponent() 会创建一个 BannerComponent 的实例,把相应的元素添加到测试运行器的 DOM 中,然后返回一个 ComponentFixture 对象。

在调用了 createComponent 之后就不能再重新配置 TestBed了。

createComponent 方法冻结了当前的 TestBed 定义,关闭它才能再进行后续配置。

你不能再调用任何 TestBed 的后续配置方法了,不能调 configureTestingModule()、不能调 get(), 也不能调用任何 override... 方法。 如果试图这么做,TestBed 就会抛出错误。

ComponentFixture

ComponentFixture 是一个测试挽具(就像马车缰绳),用来与所创建的组件及其 DOM 元素进行交互。

可以通过测试夹具(fixture)来访问该组件的实例,并用 Jasmine 的 expect 语句来确保其存在。

content_copyconst component = fixture.componentInstance;
expect(component).toBeDefined();

beforeEach()

随着该组件的成长,你将会添加更多测试。 除了为每个测试都复制一份 TestBed 测试之外,你还可以把它们重构成 Jasmine 的 beforeEach() 中的准备语句以及一些支持性变量:

content_copydescribe('BannerComponent (with beforeEach)', () => {
  let component: BannerComponent;
  let fixture: ComponentFixture<BannerComponent>;

  beforeEach(() => {
    TestBed.configureTestingModule({
      declarations: [ BannerComponent ]
    });
    fixture = TestBed.createComponent(BannerComponent);
    component = fixture.componentInstance;
  });

  it('should create', () => {
    expect(component).toBeDefined();
  });
});

现在,添加一个测试,用它从 fixture.nativeElement 中获取组件的元素,并查找是否存在所预期的文本内容。

content_copyit('should contain "banner works!"', () => {
  const bannerElement: HTMLElement = fixture.nativeElement;
  expect(bannerElement.textContent).toContain('banner works!');
});

nativeElement

ComponentFixture.nativeElement 的值是 any 类型的。 稍后你将遇到的 DebugElement.nativeElement 也同样是 any 类型的。

Angular 在编译期间没办法知道 nativeElement 是哪种 HTML 元素,甚至是否 HTML 元素(译注:比如可能是 SVG 元素)。 本应用还可能运行在非浏览器平台上,比如服务端渲染或 Web Worker 那里的元素可能只有一些缩水过的 API,甚至根本不存在。

本指南中的例子都是为运行在浏览器中而设计的,因此 nativeElement 的值一定会是 HTMLElement 及其派生类。

如果知道了它是某种 HTMLElement,你就可以用标准的 querySelector 在元素树中进行深挖了。

下面这个测试就会调用 HTMLElement.querySelector 来获取 <p> 元素,并在其中查找 Banner 文本:

content_copyit('should have <p> with "banner works!"', () => {
  const bannerElement: HTMLElement = fixture.nativeElement;
  const p = bannerElement.querySelector('p');
  expect(p.textContent).toEqual('banner works!');
});

DebugElement

Angular 的夹具可以通过 fixture.nativeElement 直接提供组件的元素。

content_copyconst bannerElement: HTMLElement = fixture.nativeElement;

它实际上是 fixture.debugElement.nativeElement 的一个便利方法。

content_copyconst bannerDe: DebugElement = fixture.debugElement;
const bannerEl: HTMLElement = bannerDe.nativeElement;

这种访问元素的迂回方式有很好的理由。

nativeElement 的属性取决于运行环境。 你可以在没有 DOM,或者其 DOM 模拟器无法支持全部 HTMLElement API 的平台上运行这些测试。

Angular 依赖于 DebugElement 这个抽象层,就可以安全的横跨其支持的所有平台。 Angular 不再创建 HTML 元素树,而是创建 DebugElement树,其中包裹着相应运行平台上的原生元素nativeElement 属性会解开 DebugElement,并返回平台相关的元素对象。

因为本章的这些测试都设计为只运行在浏览器中,因此这些测试中的 nativeElement 总是 HTMLElement, 你可以在测试中使用那些熟悉的方法和属性进行浏览。

下面是对上一个测试改用 fixture.debugElement.nativeElement 进行的重新实现:

content_copyit('should find the <p> with fixture.debugElement.nativeElement)', () => {
  const bannerDe: DebugElement = fixture.debugElement;
  const bannerEl: HTMLElement = bannerDe.nativeElement;
  const p = bannerEl.querySelector('p');
  expect(p.textContent).toEqual('banner works!');
});

DebugElement 还有其它的方法和属性,它们在测试中也很有用,你将在本章的其它测试中看到它们。

你要从 Angular 核心库中导入 DebugElement 符号。

content_copyimport { DebugElement } from '@angular/core';

By.css()

虽然本章中的测试都是运行在浏览器中的,不过有些应用可能会运行在其它平台上(至少一部分时间是这样)。

比如,作为加快慢速网络设备上应用启动速度的一种策略,组件可能要先在服务器上渲染。服务端渲染可能无法支持完全的 HTML API。 如果它不支持 querySelector,那么前一个测试就会失败。

DebugElement 提供了可以工作在所有受支持的平台上的查询方法。 这些查询方法接受一个谓词(predicate)函数,如果 DebugElement 树中的节点满足某个筛选条件,它就返回 true

你可以在从库中导入的 By 类的帮助下为该运行平台创建谓词函数。下面这个 By 是从浏览器平台导入的:

content_copyimport { By } from '@angular/platform-browser';

下面这个例子使用 DebugElement.query() 和浏览器的 By.css 方法重新实现了前一个测试。

content_copyit('should find the <p> with fixture.debugElement.query(By.css)', () => {
  const bannerDe: DebugElement = fixture.debugElement;
  const paragraphDe = bannerDe.query(By.css('p'));
  const p: HTMLElement = paragraphDe.nativeElement;
  expect(p.textContent).toEqual('banner works!');
});

值得注意的地方有:

  • By.css() 静态方法使用标准 CSS 选择器选择了一些 DebugElement 节点。
  • 这次查询返回了 <p> 元素的一个 DebugElement
  • 你必须解包此结果,以获取这个 <p> 元素。

当你要通过 CSS 选择器过滤,并且只打算测试浏览器的原生元素的属性时,By.css 这种方法就有点多余了。

使用标准的 HTMLElement 方法,比如 querySelector()querySelectorAll() 通常会更简单、更清晰。 你在下一组测试中就会体会到这一点。


组件测试场景

下面这些部分构成了本指南的大部分内容,它们将探讨一些常见的组件测试场景。

组件绑定

当前的 BannerComponent 在 HTML 模板中展示了静态标题内容。

稍作修改之后,BannerComponent 也可以通过绑定到组件的 title 属性来展示动态标题。就像这样:

app/banner/banner.component.ts

content_copy@Component({
  selector: 'app-banner',
  template: '<h1>{{title}}</h1>',
  styles: ['h1 { color: green; font-size: 350%}']
})
export class BannerComponent {
  title = 'Test Tour of Heroes';
}

很简单,你决定添加一个测试来确定这个组件真的像你预期的那样显示出了正确的内容。

查询 <h1>

你将会写一系列测试来探查 <h1> 元素的值,这个值包含在了带有 title属性的插值表达式绑定中。

你要修改 beforeEach 来使用标准的 HTML querySelector 来找到该元素,并把它赋值给 h1 变量。

app/banner/banner.component.spec.ts (setup)

content_copylet component: BannerComponent;
let fixture:   ComponentFixture<BannerComponent>;
let h1:        HTMLElement;

beforeEach(() => {
  TestBed.configureTestingModule({
    declarations: [ BannerComponent ],
  });
  fixture = TestBed.createComponent(BannerComponent);
  component = fixture.componentInstance; // BannerComponent test instance
  h1 = fixture.nativeElement.querySelector('h1');
});

createComponent() 函数不会绑定数据

你的第一个测试希望看到屏幕显示出了默认的 title。 你本能的写出如下测试来立即审查这个 <h1> 元素:

content_copyit('should display original title', () => {
  expect(h1.textContent).toContain(component.title);
});

测试失败了,给出如下信息:

content_copyexpected '' to contain 'Test Tour of Heroes'.

因为绑定是在 Angular 执行变更检测时才发生的。

在产品阶段,当 Angular 创建组件、用户输入或者异步动作(比如 AJAX)完成时,会自动触发变更检测。

TestBed.createComponent 不能触发变更检测。 可以在这个修改后的测试中确定这一点:

content_copyit('no title in the DOM after createComponent()', () => {
  expect(h1.textContent).toEqual('');
});

detectChanges()

你必须通过调用 fixture.detectChanges() 来要求 TestBed 执行数据绑定。 然后 <h1> 中才会具有所期望的标题。

content_copyit('should display original title after detectChanges()', () => {
  fixture.detectChanges();
  expect(h1.textContent).toContain(component.title);
});

这种迟到的变更检测是故意设计的,而且很有用。 它给了测试者一个机会,在 Angular 初始化数据绑定以及调用生命周期钩子之前探查并改变组件的状态。

下面这个测试中,会在调用 fixture.detectChanges() 之前修改组件的 title 属性。

content_copyit('should display a different test title', () => {
  component.title = 'Test Title';
  fixture.detectChanges();
  expect(h1.textContent).toContain('Test Title');
});

自动变更检测

BannerComponent 的这些测试需要频繁调用 detectChanges。 有些测试者更喜欢让 Angular 测试环境自动运行变更检测。

使用 ComponentFixtureAutoDetect 服务提供商来配置 TestBed 就可以做到这一点。 首先从测试工具库中导入它:

app/banner/banner.component.detect-changes.spec.ts (import)

content_copyimport { ComponentFixtureAutoDetect } from '@angular/core/testing';

然后把它添加到测试模块配置的 providers 数组中:

app/banner/banner.component.detect-changes.spec.ts (AutoDetect)

content_copyTestBed.configureTestingModule({
  declarations: [ BannerComponent ],
  providers: [
    { provide: ComponentFixtureAutoDetect, useValue: true }
  ]
});

下列测试阐明了自动变更检测的工作原理。

app/banner/banner.component.detect-changes.spec.ts (AutoDetect Tests)

content_copyit('should display original title', () => {
  // Hooray! No `fixture.detectChanges()` needed
  expect(h1.textContent).toContain(comp.title);
});

it('should still see original title after comp.title change', () => {
  const oldTitle = comp.title;
  comp.title = 'Test Title';
  // Displayed title is old because Angular didn't hear the change :(
  expect(h1.textContent).toContain(oldTitle);
});

it('should display updated title after detectChanges', () => {
  comp.title = 'Test Title';
  fixture.detectChanges(); // detect changes explicitly
  expect(h1.textContent).toContain(comp.title);
});

第一个测试程序展示了自动检测的好处。

第二和第三个测试程序显示了它重要的局限性。 Angular 测试环境不会知道测试程序改变了组件的 title 属性。 自动检测只对异步行为比如承诺的解析、计时器和 DOM 事件作出反应。 但是直接修改组件属性值的这种同步更新是不会触发自动检测的。 测试程序必须手动调用 fixture.detectChange(),来触发新一轮的变更检测周期。

相比于受测试工具有没有执行变更检测的困扰,本章中的例子更愿意总是显式调用 detectChanges()。 即使是在不需要的时候,频繁调用 detectChanges() 也没有任何坏处。


使用 dispatchEvent() 修改输入值

要想模拟用户输入,你就要找到 <input> 元素并设置它的 value 属性。

你要调用 fixture.detectChanges() 来触发 Angular 的变更检测。 但那只是一个基本的中间步骤。

Angular 不知道你设置了这个 <input> 元素的 value 属性。 在你通过调用 dispatchEvent() 触发了该输入框的 input 事件之前,它不能读到那个值。 调用完之后你再调用 detectChanges()

下面的例子演示了这个调用顺序。

app/hero/hero-detail.component.spec.ts (pipe test)

content_copyit('should convert hero name to Title Case', () => {  // get the name's input and display elements from the DOM  const hostElement = fixture.nativeElement;  const nameInput: HTMLInputElement = hostElement.querySelector('input');  const nameDisplay: HTMLElement = hostElement.querySelector('span');   // simulate user entering a new name into the input box  nameInput.value = 'quick BROWN  fOx';   // dispatch a DOM event so that Angular learns of input value change.  nameInput.dispatchEvent(newEvent('input'));   // Tell Angular to update the display binding through the title pipe  fixture.detectChanges();   expect(nameDisplay.textContent).toBe('Quick Brown  Fox');});

带有外部文件的组件

上面的 BannerComponent 定义了一个内联模板内联 CSS,分别是在 @Component.template@Component.styles 属性中指定的。

很多组件会分别用 @Component.templateUrl@Component.styleUrls属性来指定外部模板外部 CSS,就像下面这个 BannerComponent 的变体中所做的一样:

app/banner/banner-external.component.ts (metadata)

content_copy@Component({
  selector: 'app-banner',
  templateUrl: './banner-external.component.html',
  styleUrls:  ['./banner-external.component.css']
})

这个语法告诉 Angular 编译器在编译期间读取外部文件。

当你运行 CLI 的 ng test 命令的时候这毫无问题,因为它会在运行测试之前先编译该应用

不过,如果你在非 CLI 环境下运行这些测试,那么对该组件的测试就可能失败。 比如,如果你在像 plunker 这样的 Web 编程环境下运行 BannerComponent 的测试,就会看到如下信息:

content_copyError: 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.

如果在测试自身期间,运行环境试图编译源码,就会出现这个测试错误信息。

要解决这个问题,可以像稍后解释的那样调用一次 compileComponents()

带依赖的组件

组件经常依赖其他服务。

WelcomeComponent 为登陆的用户显示一条欢迎信息。它从注入的 UserService 的属性得知用户的身份:

app/welcome/welcome.component.ts

content_copyimport { Component, OnInit } from '@angular/core';
import { UserService }       from '../model/user.service';

@Component({
  selector: 'app-welcome',
  template: '<h3 class="welcome"><i>{{welcome}}</i></h3>'
})
export class WelcomeComponent  implements OnInit {
  welcome: string;
  constructor(private userService: UserService) { }

  ngOnInit(): void {
    this.welcome = this.userService.isLoggedIn ?
      'Welcome, ' + this.userService.user.name : 'Please log in.';
  }
}

WelcomeComponent 带有与服务交互的决策逻辑,这些逻辑让该组件值得测试。 下面是 app/welcome/welcome.component.spec.ts 中的测试模块配置:

app/welcome/welcome.component.spec.ts

content_copyTestBed.configureTestingModule({
   declarations: [ WelcomeComponent ],
// providers:    [ UserService ]  // NO! Don't provide the real service!
                                  // Provide a test-double instead
   providers:    [ {provide: UserService, useValue: userServiceStub } ]
});

这次,在测试配置里不但声明了被测试的组件,而且在 providers 数组中添加了 UserService 依赖。但不是真实的 UserService

提供服务的测试替身

被测试的组件不一定要注入真正的服务。实际上,服务的替身(Stub - 桩, Fake - 假冒品, Spy - 间谍或者 Mock - 模拟对象)通常会更加合适。 spec 的主要目的是测试组件,而不是服务。真实的服务可能连自身都有问题,不应该让它干扰对组件的测试。

注入真实的 UserService 有可能很麻烦。真实的服务可能询问用户登录凭据,也可能试图连接认证服务器。 可能很难处理这些行为。所以在真实的 UserService 的位置创建和注册 UserService 替身,会让测试更加容易和安全。

这个测试套件提供了 UserService 的一个最小化模拟对象,它能满足 WelcomeComponent 及其测试的需求:

app/welcome/welcome.component.spec.ts

content_copylet userServiceStub: Partial<UserService>;

userServiceStub = {
  isLoggedIn: true,
  user: { name: 'Test User'}
};

获取注入的服务

测试程序需要访问被注入到 WelcomeComponent 中的 UserService(stub 类)。

Angular 的注入系统是层次化的。 可以有很多层注入器,从根 TestBed创建的注入器下来贯穿整个组件树。

最安全并总是有效的获取注入服务的方法,是从被测组件的注入器获取。 组件注入器是 fixture 的 DebugElement 的属性之一。

WelcomeComponent's injector

content_copy// UserService actually injected into the component
userService = fixture.debugElement.injector.get(UserService);

TestBed.get()

你也可能通过 TestBed.get() 来使用根注入器获取该服务。 这样更容易记住而且不那么啰嗦。 不过这只有当 Angular 组件需要的恰好是该测试的根注入器时才能正常工作。

在这个测试套件中,UserService 唯一的提供商就是根测试模块中的,因此调用 TestBed.get() 就是安全的,代码如下:

TestBed injector

content_copy// UserService from the root injector
userService = TestBed.get(UserService);

对于那些不能用 TestBed.get() 的测试用例,请参见改写组件的提供商一节,那里解释了何时以及为何必须改从组件自身的注入器中获取服务。

总是从注入其中获取服务

请不要引用测试代码里提供给测试模块的 userServiceStub 对象。这样不行! 被注入组件的 userService 实例是完全不一样的对象,它提供的是 userServiceStub 的克隆。

app/welcome/welcome.component.spec.ts

content_copyit('stub object and injected UserService should not be the same', () => {
  expect(userServiceStub === userService).toBe(false);

  // Changing the stub object has no effect on the injected service
  userServiceStub.isLoggedIn = false;
  expect(userService.isLoggedIn).toBe(true);
});

最终的准备及测试代码

下面是使用 TestBed.get() 的完整的 beforeEach()

app/welcome/welcome.component.spec.ts

content_copylet userServiceStub: Partial<UserService>;

beforeEach(() => {
  // stub UserService for test purposes
  userServiceStub = {
    isLoggedIn: true,
    user: { name: 'Test User'}
  };

  TestBed.configureTestingModule({
     declarations: [ WelcomeComponent ],
     providers:    [ {provide: UserService, useValue: userServiceStub } ]
  });

  fixture = TestBed.createComponent(WelcomeComponent);
  comp    = fixture.componentInstance;

  // UserService from the root injector
  userService = TestBed.get(UserService);

  //  get the "welcome" element by CSS selector (e.g., by class name)
  el = fixture.nativeElement.querySelector('.welcome');
});

下面是一些测试程序:

app/welcome/welcome.component.spec.ts

content_copyit('should welcome the user', () => {
  fixture.detectChanges();
  const content = el.textContent;
  expect(content).toContain('Welcome', '"Welcome ..."');
  expect(content).toContain('Test User', 'expected name');
});

it('should welcome "Bubba"', () => {
  userService.user.name = 'Bubba'; // welcome message hasn't been shown yet
  fixture.detectChanges();
  expect(el.textContent).toContain('Bubba');
});

it('should request login if not logged in', () => {
  userService.isLoggedIn = false; // welcome message hasn't been shown yet
  fixture.detectChanges();
  const content = el.textContent;
  expect(content).not.toContain('Welcome', 'not welcomed');
  expect(content).toMatch(/log in/i, '"log in"');
});

第一个测试程序是合法测试程序,它确认这个被模拟的 UserService 是否被调用和工作正常。

Jasmine 匹配器的第二个参数(比如 'expected name')是一个可选的失败标签。 如果这个期待语句失败了,Jasmine 就会把这个标签追加到这条个期待语句的失败信息后面。 对于具有多个期待语句的规约,它可以帮助澄清到底什么出错了,以及哪个期待语句失败了。

接下来的测试程序确认当服务返回不同的值时组件的逻辑是否工作正常。 第二个测试程序验证变换用户名字的效果。 第三个测试程序检查如果用户没有登录,组件是否显示正确消息。


带有异步服务的组件

在这个例子中,AboutComponent 的模板中还有一个 TwainComponentTwainComponent 用于显示引自马克·吐温的话。

app/twain/twain.component.ts (template)

content_copytemplate: `
  <p class="twain"><i>{{quote | async}}</i></p>
  <button (click)="getQuote()">Next quote</button>
  <p class="error" *ngIf="errorMessage">{{ errorMessage }}</p>`,

注意该组件的 quote 属性的值是通过 AsyncPipe 传进来的。 这意味着该属性或者返回 Promise 或者返回 Observable

在这个例子中,TwainComponent.getQuote() 方法告诉你 quote 方法返回的是 Observable

app/twain/twain.component.ts (getQuote)

content_copygetQuote() {
  this.errorMessage = '';
  this.quote = this.twainService.getQuote().pipe(
    startWith('...'),
    catchError( (err: any) => {
      // Wait a turn because errorMessage already set once this turn
      setTimeout(() => this.errorMessage = err.message || err.toString());
      return of('...'); // reset message to placeholder
    })
  );

TwainComponent 会从一个注入进来的 TwainService 来获取这些引文。 在服务返回第一条引文之前,该组件会先返回一个占位值('...')的 Observable

catchError 会拦截服务中的错误,准备错误信息,并在成功分支中返回占位值。 它必须等一拍(tick)才能设置 errorMessage,以免在同一个变更检测周期中两次修改这个消息而导致报错。

这就是你要测试的全部特性。

使用间谍(Spy)进行测试

当测试组件时,只应该关心服务的公共 API。 通常来说,测试不应该自己向远端服务器发起调用。 它们应该对这些调用进行仿真。app/twain/twain.component.spec.ts 中的准备代码展示了实现方式之一:

app/twain/twain.component.spec.ts (setup)

content_copybeforeEach(() => {
  testQuote = 'Test Quote';

  // Create a fake TwainService object with a `getQuote()` spy
  const twainService = jasmine.createSpyObj('TwainService', ['getQuote']);
  // Make the spy return a synchronous Observable with the test data
  getQuoteSpy = twainService.getQuote.and.returnValue( of(testQuote) );

  TestBed.configureTestingModule({
    declarations: [ TwainComponent ],
    providers:    [
      { provide: TwainService, useValue: twainService }
    ]
  });

  fixture = TestBed.createComponent(TwainComponent);
  component = fixture.componentInstance;
  quoteEl = fixture.nativeElement.querySelector('.twain');
});

重点看这个间谍对象(spy)。

content_copy// Create a fake TwainService object with a `getQuote()` spy
const twainService = jasmine.createSpyObj('TwainService', ['getQuote']);
// Make the spy return a synchronous Observable with the test data
getQuoteSpy = twainService.getQuote.and.returnValue( of(testQuote) );

这个间谍的设计是:任何对 getQuote 的调用都会收到一个包含测试引文的可观察对象。 和真正的 getQuote() 方法不同,这个间谍跳过了服务器,直接返回了一个能立即解析出值的同步型可观察对象。

虽然它的 Observable 是同步的,不过你仍然可以使用这个间谍对象写出很多有用的测试。

同步测试

同步 Observable 的一大优点就是你可以把那些异步的流程转换成同步测试。

content_copyit('should show quote after component initialized', () => {
  fixture.detectChanges(); // onInit()

  // sync spy result shows testQuote immediately after init
  expect(quoteEl.textContent).toBe(testQuote);
  expect(getQuoteSpy.calls.any()).toBe(true, 'getQuote called');
});

因为间谍对象的结果是同步返回的,所以 getQuote() 方法会在 Angular 调用 ngOnInit 时触发的首次变更检测周期后立即修改屏幕上的消息。

但测试出错路径的时候就没这么幸运了。 虽然该服务的间谍也会返回一个同步的错误对象,但是组件的那个方法中调用了 setTimeout()。 这个测试必须至少等待 JavaScript 引擎的一个周期,那个值才会变成可用状态。因此这个测试变成了异步的

使用 fakeAsync() 进行异步测试

下列测试用于确保当服务返回 ErrorObservable 的时候也能有符合预期的行为。

content_copyit('should display error when TwainService fails', fakeAsync(() => {  // tell spy to return an error observable  getQuoteSpy.and.returnValue(    throwError('TwainService test failure'));   fixture.detectChanges(); // onInit()  // sync spy errors immediately after init   tick(); // flush the component's setTimeout()   fixture.detectChanges(); // update errorMessage within setTimeout()   expect(errorMessage()).toMatch(/test failure/, 'should display error');  expect(quoteEl.textContent).toBe('...', 'should show placeholder');}));

注意这个 it() 函数接收了一个如下形式的参数。

content_copyfakeAsync(() => { /* test body */ })`

fakeAsync 函数通过在一个特殊的fakeAsync 测试区域(zone)中运行测试体来启用线性代码风格。 测试体看上去是同步的。 这里没有嵌套式语法(如 Promise.then())来打断控制流。

tick() 函数

你必须调用 tick() 函数来向前推动(虚拟)时钟。

调用 tick() 会模拟时光的流逝,直到所有未决的异步活动都结束为止。 在这个例子中,它会等待错误处理器中的 setTimeout()

tick 函数是你通过 TestBed 中引入的 Angular 测试工具集之一。 它总是和 fakeAsync 一起使用,你也只能在 fakeAsync 的函数体中调用它。

异步的可观察对象

你可能对这些测试的覆盖率已经很满足了。

不过你可能会因为真实的服务没有按这种方式工作而困扰。 真实的服务器会把请求发送给远端服务器。 服务需要花一些时间来作出响应,它的响应当然也不会真的像前面两个测试中那样立即可用。

如果你在 getQuote() 间谍中返回一个异步可观察对象,那它就能更忠诚的反映出真实的世界了。

content_copy// Simulate delayed observable values with the `asyncData()` helper
getQuoteSpy.and.returnValue(asyncData(testQuote));

可观察对象的异步助手

这个异步的可观察对象是用 asyncData 辅助函数生成的。 asyncData 助手是一个工具函数,你可以自己写一个,也可以从下面的范例代码中复制一份。

testing/async-observable-helpers.ts

content_copy/** Create async observable that emits-once and completes
 *  after a JS engine turn */
export function asyncData<T>(data: T) {
  return defer(() => Promise.resolve(data));
}

这个辅助函数的可观察对象会在 JavaScript 引擎的下一个工作周期中发出 data 的值。

RxJS 的 defer() (延期)操作符 会返回一个可观察对象。 它获取一个工厂函数,这个工厂函数或者返回 Promise 或者返回 Observable。 当有人订阅了这个 defer 的可观察对象时,它就会把这个订阅者添加到由那个工厂函数创建的新的可观察对象中。

defer() 操作符会把 Promise.resolve() 转换成一个新的可观察对象,然后像 HttpClient 那样的发出一个值,然后结束。 订阅者将会在接收到这个数据值之后自动被取消订阅。

下面是一个类似的用于产生异步错误的辅助函数。

content_copy/** Create async observable error that errors
 *  after a JS engine turn */
export function asyncError<T>(errorObject: any) {
  return defer(() => Promise.reject(errorObject));
}

更多异步测试

现在,getQuote() 间谍会返回一个异步的可观察对象,你的大多数测试也同样要变成异步的。

下面这个 fakeAsync() 测试演示了你所期待的和真实世界中一样的数据流。

content_copyit('should show quote after getQuote (fakeAsync)', fakeAsync(() => {
  fixture.detectChanges(); // ngOnInit()
  expect(quoteEl.textContent).toBe('...', 'should show placeholder');

  tick(); // flush the observable to get the quote
  fixture.detectChanges(); // update view

  expect(quoteEl.textContent).toBe(testQuote, 'should show quote');
  expect(errorMessage()).toBeNull('should not show error');
}));

注意,这个 <quote> 元素应该在 ngOnInit() 之后显示占位值('...'), 但第一个引文却没有出现。

要刷出可观察对象中的第一个引文,你就要先调用 tick(),然后调用 detectChanges() 来要求 Angular 刷新屏幕。

然后你就可以断言这个 <quote> 元素应该显示所预期的文字了。

使用 async() 进行异步测试

fakeAsync() 工具函数有一些限制。 特别是,如果测试中发起了 XHR 调用,它就没用了。

测试中的 XHR 调用比较罕见,所以你通常会使用 fakeAsync()。 不过你可能迟早会需要调用 XHR,那就来了解一些 async() 的知识吧。

TestBed.compileComponents() 方法(参见稍后)就会在 JIT 编译期间调用 XHR 来读取外部模板和 CSS 文件。 如果写调用了 compileComponents() 的测试,就要用到 async() 工具函数了。

下面是用 async() 工具函数重写的以前的 fakeAsync() 测试。

content_copyit('should show quote after getQuote (async)', async(() => {
  fixture.detectChanges(); // ngOnInit()
  expect(quoteEl.textContent).toBe('...', 'should show placeholder');

  fixture.whenStable().then(() => { // wait for async getQuote
    fixture.detectChanges();        // update view with quote
    expect(quoteEl.textContent).toBe(testQuote);
    expect(errorMessage()).toBeNull('should not show error');
  });
}));

async() 工具函数通过把测试人员的代码放进在一个特殊的async 测试区域中,节省了一些用于异步调用的样板代码。 你不必把 Jasmine 的 done() 传给这个测试,并在承诺(Promise)或可观察对象的回调中调用 done()

但是对 fixture.whenStable() 的调用揭示了该测试的异步本性,它将会打破线性的控制流。

whenStable

该测试必须等待 getQuote() 的可观察对象发出下一条引言。 它不再调用 tick(),而是调用 fixture.whenStable()

fixture.whenStable() 返回一个承诺,这个承诺会在 JavaScript 引擎的任务队列变为空白时被解析。 在这个例子中,一旦这个可观察对象发出了第一条引言,这个任务队列就会变为空。

该测试在这个承诺的回调中继续执行,它会调用 detectChanges() 来用预期的文本内容修改 <quote> 元素。

Jasmine done()

虽然 asyncfakeAsync 函数极大地简化了 Angular 的异步测试,不过你仍然可以回退到传统的技术中。 也就是说给 it 额外传入一个函数型参数,这个函数接受一个 done 回调。

现在,你就要负责对 Promise 进行链接、处理错误,并在适当的时机调用 done() 了。

写带有 done() 的测试函数会比 asyncfakeAsync 方式更加冗长。 不过有些时候它是必要的。 比如,你不能在那些涉及到 intervalTimer()或 RxJS 的 delay() 操作符时调用 asyncfakeAsync 函数。

下面是对前面的测试用 done() 重写后的两个版本。 第一个会订阅由组件的 quote 属性暴露给模板的那个 Observable

content_copyit('should show last quote (quote done)', (done: DoneFn) => {
  fixture.detectChanges();

  component.quote.pipe( last() ).subscribe(() => {
    fixture.detectChanges(); // update view with quote
    expect(quoteEl.textContent).toBe(testQuote);
    expect(errorMessage()).toBeNull('should not show error');
    done();
  });
});

RxJS 的 last() 操作符会在结束之前发出这个可观察对象的最后一个值,也就是那条测试引文。 subscribe 回调中会像以前一样调用 detectChanges() 用这条测试引文更新 <quote> 元素。

有些测试中,相对于在屏幕上展示了什么,你可能会更关心所注入服务的某个方法是如何被调用的,以及它的返回值是什么。

服务的间谍,比如假冒服务 TwainServicegetQuote() 间谍,可以给你那些信息,并且对视图的状态做出断言。

content_copyit('should show quote after getQuote (spy done)', (done: DoneFn) => {
  fixture.detectChanges();

  // the spy's most recent call returns the observable with the test quote
  getQuoteSpy.calls.mostRecent().returnValue.subscribe(() => {
    fixture.detectChanges(); // update view with quote
    expect(quoteEl.textContent).toBe(testQuote);
    expect(errorMessage()).toBeNull('should not show error');
    done();
  });
});

组件的宝石测试

前面的 TwainComponent 测试中使用 TwainService 中的 asyncDataasyncError 工具函数仿真了可观察对象的异步响应。

那些都是你自己写的简短函数。 很不幸,它们对于很多常见场景来说都太过简单了。 可观察对象通常会发出很多次值,还可能会在显著的延迟之后。 组件可能要协调多个由正常值和错误值组成的重叠序列的可观察对象。

RxJS 的宝石测试是测试各种可观察对象场景的最佳方式 —— 无论简单还是复杂。 你可以看看宝石图,它揭示了可观察对象的工作原理。 宝石测试使用类似的宝石语言来在你的测试中指定可观察对象流和对它们的期待。

下面的例子使用宝石测试重写了 TwainComponent 的两个测试。

首先安装 jasmine-marbles 这个 npm 包,然后倒入所需的符号。

app/twain/twain.component.marbles.spec.ts (import marbles)

content_copyimport { cold, getTestScheduler } from 'jasmine-marbles';

下面是对获取引文功能的完整测试:

content_copyit('should show quote after getQuote (marbles)', () => {
  // observable test quote value and complete(), after delay
  const q$ = cold('---x|', { x: testQuote });
  getQuoteSpy.and.returnValue( q$ );

  fixture.detectChanges(); // ngOnInit()
  expect(quoteEl.textContent).toBe('...', 'should show placeholder');

  getTestScheduler().flush(); // flush the observables

  fixture.detectChanges(); // update view

  expect(quoteEl.textContent).toBe(testQuote, 'should show quote');
  expect(errorMessage()).toBeNull('should not show error');
});

注意,这个 Jasmine 测试是同步的。没有调用 fakeAsync()。 宝石测试使用了一个测试调度程序来用同步的方式模拟时间的流逝。

宝石测试的美妙之处在于它给出了可观察对象流的可视化定义。 这个测试定义了一个冷的可观察对象,它等待三帧 (---),然后发出一个值(x),然后结束(|)。 在第二个参数中,你把值标记(x)换成了实际发出的值(testQuote)。

content_copyconst q$ = cold('---x|', { x: testQuote });

这个宝石库会构造出相应的可观察对象,测试代码会把它当做 getQuote间谍的返回值。

当你已经准备好激活这个宝石库构造出的可观察对象时,只要让 TestScheduler刷新准备好的任务队列就可以了。代码如下:

content_copygetTestScheduler().flush(); // flush the observables

这个步骤的目的类似于前面的 fakeAsync()async() 范例中的 tick()whenStable()。 这种测试的权衡方式也和那些例子中是一样的。

宝石错误测试

下面是 getQuote() 错误测试的宝石测试版本。

content_copyit('should display error when TwainService fails', fakeAsync(() => {
  // observable error after delay
  const q$ = cold('---#|', null, new Error('TwainService test failure'));
  getQuoteSpy.and.returnValue( q$ );

  fixture.detectChanges(); // ngOnInit()
  expect(quoteEl.textContent).toBe('...', 'should show placeholder');

  getTestScheduler().flush(); // flush the observables
  tick();                     // component shows error after a setTimeout()
  fixture.detectChanges();    // update error message

  expect(errorMessage()).toMatch(/test failure/, 'should display error');
  expect(quoteEl.textContent).toBe('...', 'should show placeholder');
}));

它仍然是异步测试,要调用 fakeAsync()tick(),这是因为组件自身在处理错误的时候调用 setTimeout()

看看宝石库生成的可观察对象的定义。

content_copyconst q$ = cold('---#|', null, new Error('TwainService test failure'));

它是一个冷的可观察对象,它等待三帧,然后发出一个错误。 井号(#)标记出了发出错误的时间点,这个错误是在第三个参数中指定的。 第二个参数是空的,因为这个可观察对象永远不会发出正常值。

深入学习宝石测试

宝石帧是测试时序中的虚拟单元。 每个符号(-x|#)都表示一帧过去了。

冷的可观察对象不会生成值,除非你订阅它。 应用中的大多数可观察对象都是冷的。 所有 HttpClient的方法返回的都是冷的可观察对象。

热的可观察对象在你订阅它之前就会生成值。 Router.events 可观察对象会主动汇报路由器的活动,它就是个热的可观察对象。

RxJS 的宝石测试是一个内容丰富的主题,超出了本章的范围。 要想在网络上进一步学习它,可以从 official documentation 开始。


带有输入输出参数的组件

带有导入和导出的组件通常出现在宿主组件的视图模板中。 宿主使用属性绑定来设置输入属性,使用事件绑定来监听输出属性触发的事件。

测试的目的是验证这样的绑定和期待的那样正常工作。 测试程序应该设置导入值并监听导出事件。

DashboardHeroComponent 是非常小的这种类型的例子组件。 它显示由 DashboardCompoent 提供的英雄个体。 点击英雄告诉 DashbaordComponent 用户已经选择了这个英雄。

DashboardHeroComponent 是这样内嵌在 DashboardCompoent 的模板中的:

app/dashboard/dashboard.component.html (excerpt)

content_copy<dashboard-hero *ngFor="let hero of heroes"  class="col-1-4"
  [hero]=hero  (selected)="gotoDetail($event)" >
</dashboard-hero>

DashboardHeroComponent*ngFor 循环中出现,把每个组件的 heroinput 属性设置为迭代的值,并监听组件的 selected 事件。

下面是该组件的完整定义:

app/dashboard/dashboard-hero.component.ts (component)

content_copy@Component({
  selector: 'dashboard-hero',
  template: `
    <div (click)="click()" class="hero">
      {{hero.name | uppercase}}
    </div>`,
  styleUrls: [ './dashboard-hero.component.css' ]
})
export class DashboardHeroComponent {
  @Input() hero: Hero;
  @Output() selected = new EventEmitter<Hero>();
  click() { this.selected.emit(this.hero); }
}

虽然测试这么简单的组件没有什么内在价值,但是它的测试程序是值得学习的。 有下列候选测试方案:

  • 把它当作被 DashbaordComponent 使用的组件来测试
  • 把它当作独立的组件来测试
  • 把它当作被 DashbaordComponent 的替代组件使用的组件来测试

简单看看 DashbaordComponent 的构造函数就否决了第一种方案:

app/dashboard/dashboard.component.ts (constructor)

content_copyconstructor(
  private router: Router,
  private heroService: HeroService) {
}

DashbaordComponent 依赖 Angular 路由器和 HeroService 服务。 你必须使用测试替身替换它们两个,似乎过于复杂了。 路由器尤其具有挑战性。

稍后的讨论涵盖了那些需要路由器的测试组件。

当前的任务是测试 DashboardHeroComponent 组件,而非 DashbaordComponent,所以无需做不必要的努力。 那就试试第二和第三种方案。

单独测试 DashboardHeroComponent

下面是 spec 文件的准备语句中的重点部分。

app/dashboard/dashboard-hero.component.spec.ts (setup)

content_copyTestBed.configureTestingModule({
  declarations: [ DashboardHeroComponent ]
})
fixture = TestBed.createComponent(DashboardHeroComponent);
comp    = fixture.componentInstance;

// find the hero's DebugElement and element
heroDe  = fixture.debugElement.query(By.css('.hero'));
heroEl = heroDe.nativeElement;

// mock the hero supplied by the parent component
expectedHero = { id: 42, name: 'Test Name' };

// simulate the parent setting the input property with that hero
comp.hero = expectedHero;

// trigger initial data binding
fixture.detectChanges();

注意代码是如何将模拟英雄(expectedHero)赋值给组件的 hero 属性的,模拟了 DashbaordComponent 在它的迭代器中通过属性绑定的赋值方式。

下面的测试会验证英雄的名字已经通过绑定的方式传播到模板中了。

content_copyit('should display hero name in uppercase', () => {
  const expectedPipedName = expectedHero.name.toUpperCase();
  expect(heroEl.textContent).toContain(expectedPipedName);
});

因为模板通过 Angular 的 UpperCasePipe 传入了英雄的名字,所以这个测试必须匹配该元素的值中包含了大写形式的名字。

这个小测试示范了 Angular 的测试如何以较低的成本验证组件的视觉表现(它们不能通过组件类测试进行验证)。 而不用借助那些更慢、更复杂的端到端测试。

点击

点击这个英雄将会发出一个 selected 事件,而宿主元素(可能是 DashboardComponent)可能会听到它:

content_copyit('should raise selected event when clicked (triggerEventHandler)', () => {
  let selectedHero: Hero;
  comp.selected.subscribe((hero: Hero) => selectedHero = hero);

  heroDe.triggerEventHandler('click', null);
  expect(selectedHero).toBe(expectedHero);
});

该组件的 selected 属性返回一个 EventEmitter,对消费者来说它和 RxJS 的同步 Observable 很像。 该测试会显式订阅它,而宿主组件会隐式订阅它。

如果该组件的行为符合预期,点击英雄所在的元素就会告诉组件的 selected 属性发出这个 hero 对象。

这个测试会通过订阅 selected 来检测是否确实如此。

triggerEventHandler

前面测试中的 heroDe 是一个指向英雄条目 <div>DebugElement

它有一些用于抽象与原生元素交互的 Angular 属性和方法。 这个测试会使用事件名称 click 来调用 DebugElement.triggerEventHandlerclick的事件绑定到了 DashboardHeroComponent.click()

Angular 的 DebugElement.triggerEventHandler 可以用事件的名字触发任何数据绑定事件。 第二个参数是传递给事件处理器的事件对象。

该测试使用事件对象 null 触发了一次 click 事件。

content_copyheroDe.triggerEventHandler('click', null);

测试程序假设(在这里应该这样)运行时间的事件处理器(组件的 click()方法)不关心事件对象。

其它处理器的要求比较严格。比如,RouterLink 指令期望一个带有 button 属性的对象,该属性用于指出点击时按下的是哪个鼠标按钮。 如果不给出这个事件对象,RouterLink 指令就会抛出一个错误。

点击该元素

下面这个测试改为调用原生元素自己的 click() 方法,它对于这个组件来说相当完美。

content_copyit('should raise selected event when clicked (element.click)', () => {
  let selectedHero: Hero;
  comp.selected.subscribe((hero: Hero) => selectedHero = hero);

  heroEl.click();
  expect(selectedHero).toBe(expectedHero);
});

click() 辅助函数

点击按钮、链接或者任意 HTML 元素是很常见的测试任务。

点击事件的处理过程包装到如下的 click() 辅助函数中,可以让这项任务更一致、更简单:

testing/index.ts (click helper)

content_copy/** Button events to pass to `DebugElement.triggerEventHandler` for RouterLink event handler */
export const ButtonClickEvents = {
   left:  { button: 0 },
   right: { button: 2 }
};

/** Simulate element click. Defaults to mouse left-button click event. */
export function click(el: DebugElement | HTMLElement, eventObj: any = ButtonClickEvents.left): void {
  if (el instanceof HTMLElement) {
    el.click();
  } else {
    el.triggerEventHandler('click', eventObj);
  }
}

第一个参数是用来点击的元素。如果你愿意,可以将自定义的事件对象传递给第二个参数。 默认的是(局部的)鼠标左键事件对象, 它被许多事件处理器接受,包括 RouterLink 指令。

click() 辅助函数不是Angular 测试工具之一。 它是在本章的例子代码中定义的函数方法,被所有测试例子所用。 如果你喜欢它,将它添加到你自己的辅助函数集。

下面是把前面的测试用 click 辅助函数重写后的版本。

app/dashboard/dashboard-hero.component.spec.ts (test with click helper)

content_copyit('should raise selected event when clicked (click helper)', () => {
  let selectedHero: Hero;
  comp.selected.subscribe(hero => selectedHero = hero);

  click(heroDe); // click helper with DebugElement
  click(heroEl); // click helper with native element

  expect(selectedHero).toBe(expectedHero);
});

位于测试宿主中的组件

前面的这些测试都是自己扮演宿主元素 DashboardComponent 的角色。 但是当 DashboardHeroComponent 真的绑定到某个宿主元素时还能正常工作吗?

固然,你也可以测试真实的 DashboardComponent。 但要想这么做需要做很多准备工作,特别是它的模板中使用了某些特性,如 *ngFor、 其它组件、布局 HTML、附加绑定、注入了多个服务的构造函数、如何用正确的方式与那些服务交互等。

想出这么多需要努力排除的干扰,只是为了证明一点 —— 可以像这样造出一个令人满意的测试宿主

app/dashboard/dashboard-hero.component.spec.ts (test host)

content_copy@Component({
  template: `
    <dashboard-hero
      [hero]="hero" (selected)="onSelected($event)">
    </dashboard-hero>`
})
class TestHostComponent {
  hero: Hero = {id: 42, name: 'Test Name' };
  selectedHero: Hero;
  onSelected(hero: Hero) { this.selectedHero = hero; }
}

这个测试宿主像 DashboardComponent 那样绑定了 DashboardHeroComponent,但是没有 Router、 没有 HeroService,也没有 *ngFor

这个测试宿主使用其测试用的英雄设置了组件的输入属性 hero。 它使用 onSelected 事件处理器绑定了组件的 selected 事件,其中把事件中发出的英雄记录到了 selectedHero 属性中。

稍后,这个测试就可以轻松检查 selectedHero 以验证 DashboardHeroComponent.selected 事件确实发出了所期望的英雄。

这个测试宿主中的准备代码和独立测试中的准备过程类似:

app/dashboard/dashboard-hero.component.spec.ts (test host setup)

content_copyTestBed.configureTestingModule({
  declarations: [ DashboardHeroComponent, TestHostComponent ]
})
// create TestHostComponent instead of DashboardHeroComponent
fixture  = TestBed.createComponent(TestHostComponent);
testHost = fixture.componentInstance;
heroEl   = fixture.nativeElement.querySelector('.hero');
fixture.detectChanges(); // trigger initial data binding

这个测试模块的配置信息有三个重要的不同点:

  1. 它同时声明DashboardHeroComponentTestHostComponent
  2. 创建TestHostComponent,而非 DashboardHeroComponent
  3. TestHostComponent 通过绑定机制设置了 DashboardHeroComponent.hero

createComponent 返回的 fixture 里有 TestHostComponent 实例,而非 DashboardHeroComponent 组件实例。

当然,创建 TestHostComponent 有创建 DashboardHeroComponent 的副作用,因为后者出现在前者的模板中。 英雄元素(heroEl)的查询语句仍然可以在测试 DOM 中找到它,尽管元素树比以前更深。

这些测试本身和它们的孤立版本几乎相同:

app/dashboard/dashboard-hero.component.spec.ts (test-host)

content_copyit('should display hero name', () => {
  const expectedPipedName = testHost.hero.name.toUpperCase();
  expect(heroEl.textContent).toContain(expectedPipedName);
});

it('should raise selected event when clicked', () => {
  click(heroEl);
  // selected hero should be the same data bound hero
  expect(testHost.selectedHero).toBe(testHost.hero);
});

只有 selected 事件的测试不一样。它确保被选择的 DashboardHeroComponent 英雄确实通过事件绑定被传递到宿主组件。


路由组件

所谓路由组件就是指会要求 Router 导航到其它组件的组件。DashboardComponent 就是一个路由组件,因为用户可以通过点击仪表盘中的某个英雄按钮来导航到 HeroDetailComponent

路由确实很复杂。 测试 DashboardComponent 看上去有点令人生畏,因为它牵扯到和 HeroService 一起注入进来的 Router

app/dashboard/dashboard.component.ts (constructor)

content_copyconstructor(
  private router: Router,
  private heroService: HeroService) {
}

使用间谍来 Mock HeroService 是一个熟悉的故事。 但是 Router 的 API 很复杂,并且与其它服务和应用的前置条件纠缠在一起。它应该很难进行 Mock 吧?

庆幸的是,在这个例子中不会,因为 DashboardComponent 并没有深度使用 Router

app/dashboard/dashboard.component.ts (goToDetail)

content_copygotoDetail(hero: Hero) {
  let url = `/heroes/${hero.id}`;
  this.router.navigateByUrl(url);
}

这是路由组件中的通例。 一般来说,你应该测试组件而不是路由器,应该只关心组件有没有根据给定的条件导航到正确的地址。

这个组件的测试套件提供路由器的间谍就像它提供 HeroService 的间谍一样简单。

app/dashboard/dashboard.component.spec.ts (spies)

content_copyconst routerSpy = jasmine.createSpyObj('Router', ['navigateByUrl']);
const heroServiceSpy = jasmine.createSpyObj('HeroService', ['getHeroes']);

TestBed.configureTestingModule({
  providers: [
    { provide: HeroService, useValue: heroServiceSpy },
    { provide: Router,      useValue: routerSpy }
  ]
})

下面这个测试会点击正在显示的英雄,并确认 Router.navigateByUrl 曾用所期待的 URL 调用过。

app/dashboard/dashboard.component.spec.ts (navigate test)

content_copyit('should tell ROUTER to navigate when hero clicked', () => {

  heroClick(); // trigger click on first inner <div class="hero">

  // args passed to router.navigateByUrl() spy
  const spy = router.navigateByUrl as jasmine.Spy;
  const navArgs = spy.calls.first().args[0];

  // expecting to navigate to id of the component's first hero
  const id = comp.heroes[0].id;
  expect(navArgs).toBe('/heroes/' + id,
    'should nav to HeroDetail for first hero');
});

路由目标组件

路由目标组件是指 Router 导航到的目标。 它测试起来可能很复杂,特别是当路由到的这个组件包含参数的时候。 HeroDetailComponent 就是一个路由目标组件,它是某个路由定义指向的目标。

当用户点击仪表盘中的英雄时,DashboardComponent 会要求 Router 导航到 heroes/:id:id 是一个路由参数,它的值就是所要编辑的英雄的 id

Router 会根据那个 URL 匹配到一个指向 HeroDetailComponent 的路由。 它会创建一个带有路由信息的 ActivatedRoute 对象,并把它注入到一个 HeroDetailComponent 的新实例中。

下面是 HeroDetailComponent 的构造函数:

app/hero/hero-detail.component.ts (constructor)

content_copyconstructor(
  private heroDetailService: HeroDetailService,
  private route:  ActivatedRoute,
  private router: Router) {
}

HeroDetailComponent 组件需要一个 id 参数,以便通过 HeroDetailService 获取相应的英雄。 该组件只能从 ActivatedRoute.paramMap 属性中获取这个 id,这个属性是一个 Observable

它不能仅仅引用 ActivatedRoute.paramMapid 属性。 该组件不得不订阅 ActivatedRoute.paramMap 这个可观察对象,要做好它在生命周期中随时会发生变化的准备。

app/hero/hero-detail.component.ts (ngOnInit)

content_copyngOnInit(): void {
  // get hero when `id` param changes
  this.route.paramMap.subscribe(pmap => this.getHero(pmap.get('id')));
}

路由与导航一章中详细讲解了 ActivatedRoute.paramMap

通过操纵注入到组件构造函数中的这个 ActivatedRoute,测试可以探查 HeroDetailComponent 是如何对不同的 id 参数值做出响应的。

你已经知道了如何给 Router 和数据服务安插间谍。

不过对于 ActivatedRoute,你要采用另一种方式,因为:

  • 在测试期间,paramMap 会返回一个能发出多个值的 Observable
  • 你需要路由器的辅助函数 convertToParamMap() 来创建 ParamMap
  • 针对路由目标组件的其它测试需要一个 ActivatedRoute 的测试替身。

这些差异表明你需要一个可复用的桩类(stub)。

ActivatedRouteStub

下面的 ActivatedRouteStub 类就是作为 ActivatedRoute 类的测试替身使用的。

testing/activated-route-stub.ts (ActivatedRouteStub)

content_copyimport { convertToParamMap, ParamMap, Params } from '@angular/router';
import { ReplaySubject } from 'rxjs';

/**
 * An ActivateRoute test double with a `paramMap` observable.
 * Use the `setParamMap()` method to add the next `paramMap` value.
 */
export class ActivatedRouteStub {
  // Use a ReplaySubject to share previous values with subscribers
  // and pump new values into the `paramMap` observable
  private subject = new ReplaySubject<ParamMap>();

  constructor(initialParams?: Params) {
    this.setParamMap(initialParams);
  }

  /** The mock paramMap observable */
  readonly paramMap = this.subject.asObservable();

  /** Set the paramMap observables's next value */
  setParamMap(params?: Params) {
    this.subject.next(convertToParamMap(params));
  };
}

考虑把这类辅助函数放进一个紧邻 app 文件夹的 testing 文件夹。 这个例子把 ActivatedRouteStub 放在了 testing/activated-route-stub.ts中。

可以考虑使用宝石测试库来为此测试桩编写一个更强力的版本。

使用 ActivatedRouteStub 进行测试

下面的测试程序是演示组件在被观察的 id 指向现有英雄时的行为:

app/hero/hero-detail.component.spec.ts (existing id)

content_copydescribe('when navigate to existing hero', () => {
  let expectedHero: Hero;

  beforeEach(async(() => {
    expectedHero = firstHero;
    activatedRoute.setParamMap({ id: expectedHero.id });
    createComponent();
  }));

  it('should display that hero\'s name', () => {
    expect(page.nameDisplay.textContent).toBe(expectedHero.name);
  });
});

createComponent() 方法和 page 对象会在稍后进行讨论。 不过目前,你只要凭直觉来理解就行了。

当找不到 id 的时候,组件应该重新路由到 HeroListComponent

测试套件的准备代码提供了一个和前面一样的路由器间谍,它会充当路由器的角色,而不用发起实际的导航。

这个测试中会期待该组件尝试导航到 HeroListComponent

app/hero/hero-detail.component.spec.ts (bad id)

content_copydescribe('when navigate to non-existent hero id', () => {
  beforeEach(async(() => {
    activatedRoute.setParamMap({ id: 99999 });
    createComponent();
  }));

  it('should try to navigate back to hero list', () => {
    expect(page.gotoListSpy.calls.any()).toBe(true, 'comp.gotoList called');
    expect(page.navigateSpy.calls.any()).toBe(true, 'router.navigate called');
  });
});

虽然本应用没有在缺少 id 参数的时候,继续导航到 HeroDetailComponent 的路由,但是,将来它可能会添加这样的路由。 当没有 id 时,该组件应该作出合理的反应。

在本例中,组件应该创建和显示新英雄。 新英雄的 id 为零,name 为空。本测试程序确认组件是按照预期的这样做的:

app/hero/hero-detail.component.spec.ts (no id)

content_copydescribe('when navigate with no hero id', () => {
  beforeEach(async( createComponent ));

  it('should have hero.id === 0', () => {
    expect(component.hero.id).toBe(0);
  });

  it('should display empty hero name', () => {
    expect(page.nameDisplay.textContent).toBe('');
  });
});

对嵌套组件的测试

组件的模板中通常还会有嵌套组件,嵌套组件的模板还可能包含更多组件。

这棵组件树可能非常深,并且大多数时候在测试这棵树顶部的组件时,这些嵌套的组件都无关紧要。

比如,AppComponent 会显示一个带有链接及其 RouterLink 指令的导航条。

app/app.component.html

content_copy<app-banner></app-banner>
<app-welcome></app-welcome>
<nav>
  <a routerLink="/dashboard">Dashboard</a>
  <a routerLink="/heroes">Heroes</a>
  <a routerLink="/about">About</a>
</nav>
<router-outlet></router-outlet>

虽然 AppComponent 是空的,不过,由于稍后解释的原因,你可能会希望写个单元测试来确认这些链接是否正确使用了 RouterLink 指令。

要想验证这些链接,你不必用 Router 进行导航,也不必使用 <router-outlet> 来指出 Router 应该把路由目标组件插入到什么地方。

BannerComponentWelcomeComponent(写作 <app-banner><app-welcome>)也同样风马牛不相及。

然而,任何测试,只要能在 DOM 中创建 AppComponent,也就同样能创建这三个组件的实例。如果要创建它们,你就要配置 TestBed

如果你忘了声明它们,Angular 编译器就无法在 AppComponent 模板中识别出 <app-banner><app-welcome><router-outlet> 标记,并抛出一个错误。

如果你声明的这些都是真实的组件,那么也同样要声明它们的嵌套组件,并要为这棵组件树中的任何组件提供要注入的所有服务。

如果只是想回答有关链接的一些简单问题,做这些显然就太多了。

本节会讲减少此类准备工作的两项技术。 单独使用或组合使用它们,可以让这些测试聚焦于要测试的主要组件上。

对不需要的组件提供桩(stub)

这项技术中,你要为那些在测试中无关紧要的组件或指令创建和声明一些测试桩。

app/app.component.spec.ts (stub declaration)

content_copy@Component({selector: 'app-banner', template: ''})
class BannerStubComponent {}

@Component({selector: 'router-outlet', template: ''})
class RouterOutletStubComponent { }

@Component({selector: 'app-welcome', template: ''})
class WelcomeStubComponent {}

这些测试桩的选择器要和其对应的真实组件一致,但其模板和类是空的。

然后在 TestBed 的配置中那些真正有用的组件、指令、管道之后声明它们。

app/app.component.spec.ts (TestBed stubs)

content_copyTestBed.configureTestingModule({
  declarations: [
    AppComponent,
    RouterLinkDirectiveStub,
    BannerStubComponent,
    RouterOutletStubComponent,
    WelcomeStubComponent
  ]
})

AppComponent 是该测试的主角,因此当然要用它的真实版本。

RouterLinkDirectiveStub(稍后讲解)是一个真实的 RouterLink 的测试版,它能帮你对链接进行测试。

其它都是测试桩。

NO_ERRORS_SCHEMA

第二种办法就是把 NO_ERRORS_SCHEMA 添加到 TestBed.schemas 的元数据中。

app/app.component.spec.ts (NO_ERRORS_SCHEMA)

content_copyTestBed.configureTestingModule({
  declarations: [
    AppComponent,
    RouterLinkDirectiveStub
  ],
  schemas: [ NO_ERRORS_SCHEMA ]
})

NO_ERRORS_SCHEMA 会要求 Angular 编译器忽略不认识的那些元素和属性。

编译器将会识别出 <app-root> 元素和 RouterLink 属性,因为你在 TestBed 的配置中声明了相应的 AppComponentRouterLinkDirectiveStub

但编译器在遇到 <app-banner><app-welcome><router-outlet> 时不会报错。 它只会把它们渲染成空白标签,而浏览器会忽略这些标签。

你不用再提供桩组件了。

同时使用这两项技术

这些是进行浅层测试要用到的技术,之所以叫浅层测试是因为只包含本测试所关心的这个组件模板中的元素。

NO_ERRORS_SCHEMA 方法在这两者中比较简单,但也不要过度使用它。

NO_ERRORS_SCHEMA 还会阻止编译器告诉你因为的疏忽或拼写错误而缺失的组件和属性。 你如果人工找出这些 bug 可能要浪费几个小时,但编译器可以立即捕获它们。

桩组件方式还有其它优点。 虽然这个例子中的桩是空的,但你如果想要和它们用某种形式互动,也可以给它们一些裁剪过的模板和类。

在实践中,你可以在准备代码中组合使用这两种技术,例子如下:

app/app.component.spec.ts (mixed setup)

content_copyTestBed.configureTestingModule({
  declarations: [
    AppComponent,
    BannerStubComponent,
    RouterLinkDirectiveStub
  ],
  schemas: [ NO_ERRORS_SCHEMA ]
})

Angular 编译器会为 <app-banner> 元素创建 BannerComponentStub,并把 RouterLinkStubDirective 应用到带有 routerLink 属性的链接上,不过它会忽略 <app-welcome><router-outlet> 标签。


带有 RouterLink 的组件

真实的 RouterLinkDirective 太复杂了,而且与 RouterModule 中的其它组件和指令有着千丝万缕的联系。 要在准备阶段 Mock 它以及在测试中使用它具有一定的挑战性。

这段范例代码中的 RouterLinkDirectiveStub 用一个代用品替换了真实的指令,这个代用品用来验证 AppComponent 中所用链接的类型。

testing/router-link-directive-stub.ts (RouterLinkDirectiveStub)

content_copy@Directive({
  selector: '[routerLink]',
  host: { '(click)': 'onClick()' }
})
export class RouterLinkDirectiveStub {
  @Input('routerLink') linkParams: any;
  navigatedTo: any = null;

  onClick() {
    this.navigatedTo = this.linkParams;
  }
}

这个 URL 被绑定到了 [routerLink] 属性,它的值流入了该指令的 linkParams 属性。

它的元数据中的 host 属性把宿主元素(即 AppComponent 中的 <a> 元素)的 click 事件关联到了这个桩指令的 onClick 方法。

点击这个链接应该触发 onClick() 方法,其中会设置该桩指令中的警示器属性 navigatedTo。 测试中检查 navigatedTo 以确认点击该链接确实如预期的那样根据路由定义设置了该属性。

路由器的配置是否正确和是否能按照那些路由定义进行导航,是测试中一组独立的问题。

By.directive 与注入的指令

再一步配置触发了数据绑定的初始化,获取导航链接的引用:

app/app.component.spec.ts (test setup)

content_copybeforeEach(() => {
  fixture.detectChanges(); // trigger initial data binding

  // find DebugElements with an attached RouterLinkStubDirective
  linkDes = fixture.debugElement
    .queryAll(By.directive(RouterLinkDirectiveStub));

  // get attached link directive instances
  // using each DebugElement's injector
  routerLinks = linkDes.map(de => de.injector.get(RouterLinkDirectiveStub));
});

有三点特别重要:

  1. 你可以使用 By.directive 来定位一个带附属指令的链接元素。
  2. 该查询返回包含了匹配元素的 DebugElement 包装器。
  3. 每个 DebugElement 都会导出该元素中的一个依赖注入器,其中带有指定的指令实例。

AppComponent 中要验证的链接如下:

app/app.component.html (navigation links)

content_copy<nav>
  <a routerLink="/dashboard">Dashboard</a>
  <a routerLink="/heroes">Heroes</a>
  <a routerLink="/about">About</a>
</nav>

下面这些测试用来确认那些链接是否如预期般连接到了 RouterLink 指令中:

app/app.component.spec.ts (selected tests)

content_copyit('can get RouterLinks from template', () => {
  expect(routerLinks.length).toBe(3, 'should have 3 routerLinks');
  expect(routerLinks[0].linkParams).toBe('/dashboard');
  expect(routerLinks[1].linkParams).toBe('/heroes');
  expect(routerLinks[2].linkParams).toBe('/about');
});

it('can click Heroes link in template', () => {
  const heroesLinkDe = linkDes[1];   // heroes link DebugElement
  const heroesLink = routerLinks[1]; // heroes link directive

  expect(heroesLink.navigatedTo).toBeNull('should not have navigated yet');

  heroesLinkDe.triggerEventHandler('click', null);
  fixture.detectChanges();

  expect(heroesLink.navigatedTo).toBe('/heroes');
});

其实这个例子中的“click”测试误入歧途了。 它测试的重点其实是 RouterLinkDirectiveStub ,而不是该组件。 这是写桩指令时常见的错误。

在本章中,它有存在的必要。 它演示了如何在不涉及完整路由器机制的情况下,如何找到 RouterLink 元素、点击它并检查结果。 要测试更复杂的组件,你可能需要具备这样的能力,能改变视图和重新计算参数,或者当用户点击链接时,有能力重新安排导航选项。

这些测试有什么优点?

RouterLink 的桩指令进行测试可以确认带有链接和 outlet 的组件的设置的正确性,确认组件有应该有的链接,确认它们都指向了正确的方向。 这些测试程序不关心用户点击链接时,也不关心应用是否会成功的导航到目标组件。

对于这些有限的测试目标,使用 RouterLink 桩指令和 RouterOutlet 桩组件 是最佳选择。 依靠真正的路由器会让它们很脆弱。 它们可能因为与组件无关的原因而失败。 例如,一个导航守卫可能防止没有授权的用户访问 HeroListComponent。 这并不是 AppComponent 的过错,并且无论该组件怎么改变都无法修复这个失败的测试程序。

不同的测试程序可以探索在不同条件下(比如像检查用户是否认证),该应用是否和期望的那样导航。

未来对本章的更新将介绍如何使用 RouterTestingModule 来编写这样的测试程序。


使用页面(page)对象

HeroDetailComponent 是带有标题、两个英雄字段和两个按钮的简单视图。

测试

但即使是这么简单的表单,其模板中也涉及到不少复杂性。

app/hero/hero-detail.component.html

content_copy<div *ngIf="hero">
  <h2><span>{{hero.name | titlecase}}</span> Details</h2>
  <div>
    <label>id: </label>{{hero.id}}</div>
  <div>
    <label for="name">name: </label>
    <input id="name" [(ngModel)]="hero.name" placeholder="name" />
  </div>
  <button (click)="save()">Save</button>
  <button (click)="cancel()">Cancel</button>
</div>

这些供练习用的组件需要 ……

  • 等获取到英雄之后才能让元素出现在 DOM 中。
  • 一个对标题文本的引用。
  • 一个对 name 输入框的引用,以便对它进行探查和修改。
  • 引用两个按钮,以便点击它们。
  • 为组件和路由器的方法安插间谍。

即使是像这样一个很小的表单,也能产生令人疯狂的错综复杂的条件设置和 CSS 元素选择。

可以使用 Page 类来征服这种复杂性。Page 类可以处理对组件属性的访问,并对设置这些属性的逻辑进行封装。

下面是一个供 hero-detail.component.spec.ts 使用的 Page

app/hero/hero-detail.component.spec.ts (Page)

content_copyclass Page {
  // getter properties wait to query the DOM until called.
  get buttons()     { return this.queryAll<HTMLButtonElement>('button'); }
  get saveBtn()     { return this.buttons[0]; }
  get cancelBtn()   { return this.buttons[1]; }
  get nameDisplay() { return this.query<HTMLElement>('span'); }
  get nameInput()   { return this.query<HTMLInputElement>('input'); }

  gotoListSpy: jasmine.Spy;
  navigateSpy:  jasmine.Spy;

  constructor(fixture: ComponentFixture<HeroDetailComponent>) {
    // get the navigate spy from the injected router spy object
    const routerSpy = <any> fixture.debugElement.injector.get(Router);
    this.navigateSpy = routerSpy.navigate;

    // spy on component's `gotoList()` method
    const component = fixture.componentInstance;
    this.gotoListSpy = spyOn(component, 'gotoList').and.callThrough();
  }

  //// query helpers ////
  private query<T>(selector: string): T {
    return fixture.nativeElement.querySelector(selector);
  }

  private queryAll<T>(selector: string): T[] {
    return fixture.nativeElement.querySelectorAll(selector);
  }
}

现在,用来操作和检查组件的重要钩子都被井然有序的组织起来了,可以通过 page 实例来使用它们。

createComponent 方法创建 page,在 hero 到来时,自动填补空白。

app/hero/hero-detail.component.spec.ts (createComponent)

content_copy/** Create the HeroDetailComponent, initialize it, set test variables  */
function createComponent() {
  fixture = TestBed.createComponent(HeroDetailComponent);
  component = fixture.componentInstance;
  page = new Page(fixture);

  // 1st change detection triggers ngOnInit which gets a hero
  fixture.detectChanges();
  return fixture.whenStable().then(() => {
    // 2nd change detection displays the async-fetched hero
    fixture.detectChanges();
  });
}

前面小节中的 HeroDetailComponent 测试示范了如何 createComponent,而 page 让这些测试保持简短而富有表达力。 而且还不用分心:不用等待承诺被解析,不必在 DOM 中找出元素的值才能进行比较。

还有更多的 HeroDetailComponent 测试可以证明这一点。

app/hero/hero-detail.component.spec.ts (selected tests)

content_copyit('should display that hero\'s name', () => {
  expect(page.nameDisplay.textContent).toBe(expectedHero.name);
});

it('should navigate when click cancel', () => {
  click(page.cancelBtn);
  expect(page.navigateSpy.calls.any()).toBe(true, 'router.navigate called');
});

it('should save when click save but not navigate immediately', () => {
  // Get service injected into component and spy on its`saveHero` method.
  // It delegates to fake `HeroService.updateHero` which delivers a safe test result.
  const hds = fixture.debugElement.injector.get(HeroDetailService);
  const saveSpy = spyOn(hds, 'saveHero').and.callThrough();

  click(page.saveBtn);
  expect(saveSpy.calls.any()).toBe(true, 'HeroDetailService.save called');
  expect(page.navigateSpy.calls.any()).toBe(false, 'router.navigate not called');
});

it('should navigate when click save and save resolves', fakeAsync(() => {
  click(page.saveBtn);
  tick(); // wait for async save to complete
  expect(page.navigateSpy.calls.any()).toBe(true, 'router.navigate called');
}));

it('should convert hero name to Title Case', () => {
  // get the name's input and display elements from the DOM
  const hostElement = fixture.nativeElement;
  const nameInput: HTMLInputElement = hostElement.querySelector('input');
  const nameDisplay: HTMLElement = hostElement.querySelector('span');

  // simulate user entering a new name into the input box
  nameInput.value = 'quick BROWN  fOx';

  // dispatch a DOM event so that Angular learns of input value change.
  nameInput.dispatchEvent(newEvent('input'));

  // Tell Angular to update the display binding through the title pipe
  fixture.detectChanges();

  expect(nameDisplay.textContent).toBe('Quick Brown  Fox');
});

调用 compileComponents()

如果你只想使用 CLI 的 ng test 命令来运行测试,那么可以忽略这一节。

如果你在非 CLI 环境中运行测试,这些测试可能会报错,错误信息如下:

content_copyError: 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.

问题的根源在于这个测试中至少有一个组件引用了外部模板或外部 CSS 文件,就像下面这个 BannerComponent 所示:

app/banner/banner-external.component.ts (external template & css)

content_copyimport { Component } from '@angular/core';

@Component({
  selector: 'app-banner',
  templateUrl: './banner-external.component.html',
  styleUrls:  ['./banner-external.component.css']
})
export class BannerComponent {
  title = 'Test Tour of Heroes';
}

TestBed 视图创建组件时,这个测试失败了:

app/banner/banner.component.spec.ts (setup that fails)

content_copybeforeEach(() => {
  TestBed.configureTestingModule({
    declarations: [ BannerComponent ],
  });
  fixture = TestBed.createComponent(BannerComponent);
});

回想一下,这个应用从未编译过。 所以当你调用 createComponent() 的时候,TestBed 就会进行隐式编译。

当它的源码都在内存中的时候,这样做没问题。 不过 BannerComponent需要一些外部文件,编译时必须从文件系统中读取它,而这是一个天生的异步操作。

如果 TestBed 继续执行,这些测试就会继续运行,并在编译器完成这些异步工作之前导致莫名其妙的失败。

这些错误信息告诉你要使用 compileComponents() 进行显式的编译。

compileComponents() 是异步的

你必须在异步测试函数中调用 compileComponents()

如果你忘了把测试函数标为异步的(比如忘了像稍后的代码中那样使用 async()),就会看到下列错误。

content_copyError: ViewDestroyedError: Attempt to use a destroyed view

典型的做法是把准备逻辑拆成两个独立的 beforeEach() 函数:

  1. 异步的 beforeEach() 负责编译组件
  2. 同步的 beforeEach() 负责执行其余的准备代码。

要想使用这种模式,就要和其它符号一起从测试库中导入 async() 辅助函数。

content_copyimport { async, ComponentFixture, TestBed } from '@angular/core/testing';

异步的 beforeEach

像下面这样编写第一个异步的 beforeEach

app/banner/banner-external.component.spec.ts (async beforeEach)

content_copybeforeEach(async(() => {
  TestBed.configureTestingModule({
    declarations: [ BannerComponent ],
  })
  .compileComponents();  // compile template and css
}));

async() 辅助函数接受一个无参函数,其内容是准备代码。

TestBed.configureTestingModule() 方法返回 TestBed 类,所以你可以链式调用其它 TestBed 中的静态方法,比如 compileComponents()

在这个例子中,BannerComponent 是仅有的待编译组件。 其它例子中可能会使用多个组件来配置测试模块,并且可能引入某些具有其它组件的应用模块。 它们中的任何一个都可能需要外部文件。

TestBed.compileComponents 方法会异步编译测试模块中配置过的所有组件。

在调用了 compileComponents() 之后就不能再重新配置 TestBed 了。

调用 compileComponents() 会关闭当前的 TestBed 实例,不再允许进行配置。 你不能再调用任何 TestBed 中的配置方法,既不能调 configureTestingModule(),也不能调用任何 override... 方法。如果你试图这么做,TestBed 就会抛出错误。

确保 compileComponents() 是调用 TestBed.createComponent() 之前的最后一步。

同步的 beforeEach

第二个同步 beforeEach() 的例子包含剩下的准备步骤, 包括创建组件和查询那些要检查的元素。

app/banner/banner-external.component.spec.ts (synchronous beforeEach)

content_copybeforeEach(() => {
  fixture = TestBed.createComponent(BannerComponent);
  component = fixture.componentInstance; // BannerComponent test instance
  h1 = fixture.nativeElement.querySelector('h1');
});

测试运行器(runner)会先等待第一个异步 beforeEach 函数执行完再调用第二个。

整理过的准备代码

你可以把这两个 beforeEach() 函数重整成一个异步的 beforeEach()

compileComponents() 方法返回一个承诺,所以你可以通过把同步代码移到 then(...) 回调中, 以便在编译完成之后 执行那些同步准备任务。

app/banner/banner-external.component.spec.ts (one beforeEach)

content_copybeforeEach(async(() => {
  TestBed.configureTestingModule({
    declarations: [ BannerComponent ],
  })
  .compileComponents()
  .then(() => {
    fixture = TestBed.createComponent(BannerComponent);
    component = fixture.componentInstance;
    h1 = fixture.nativeElement.querySelector('h1');
  });
}));

compileComponents() 是无害的

在不需要 compileComponents() 的时候调用它也不会有害处。

虽然在运行 ng test 时永远都不需要调用 compileComponents(),但 CLI 生成的组件测试文件还是会调用它。

但这篇指南中的这些测试只会在必要时才调用 compileComponents


准备模块的 imports

此前的组件测试程序使用了一些 declarations 来配置模块,就像这样:

app/dashboard/dashboard-hero.component.spec.ts (configure TestBed)

content_copyTestBed.configureTestingModule({
  declarations: [ DashboardHeroComponent ]
})

DashbaordComponent 非常简单。它不需要帮助。 但是更加复杂的组件通常依赖其它组件、指令、管道和提供商, 所以这些必须也被添加到测试模块中。

幸运的是,TestBed.configureTestingModule 参数与传入 @NgModule 装饰器的元数据一样,也就是所你也可以指定 providersimports.

虽然 HeroDetailComponent 很小,结构也很简单,但是它需要很多帮助。 除了从默认测试模块 CommonModule 中获得的支持,它还需要:

  • FormsModule 里的 NgModel 和其它,来进行双向数据绑定
  • shared 目录里的 TitleCasePipe
  • 一些路由器服务(测试程序将 stub 伪造它们)
  • 英雄数据访问服务(同样被 stub 伪造了)

一种方法是在测试模块中一一配置,就像这样:

app/hero/hero-detail.component.spec.ts (FormsModule setup)

content_copybeforeEach(async(() => {
  const routerSpy = createRouterSpy();

  TestBed.configureTestingModule({
    imports:      [ FormsModule ],
    declarations: [ HeroDetailComponent, TitleCasePipe ],
    providers: [
      { provide: ActivatedRoute, useValue: activatedRoute },
      { provide: HeroService,    useClass: TestHeroService },
      { provide: Router,         useValue: routerSpy},
    ]
  })
  .compileComponents();
}));

注意,beforeEach() 是异步的,它调用 TestBed.compileComponents 是因为 HeroDetailComponent 有外部模板和 CSS 文件。

如前面的调用 compileComponents() 中所解释的那样,这些测试可以运行在非 CLI 环境下,那里 Angular 并不会在浏览器中编译它们。

导入共享模块

因为很多应用组件都需要 FormsModuleTitleCasePipe,所以开发者创建了 SharedModule 来把它们及其它常用的部分组合在一起。

这些测试配置也可以使用 SharedModule,如下所示:

app/hero/hero-detail.component.spec.ts (SharedModule setup)

content_copybeforeEach(async(() => {
  const routerSpy = createRouterSpy();

  TestBed.configureTestingModule({
    imports:      [ SharedModule ],
    declarations: [ HeroDetailComponent ],
    providers: [
      { provide: ActivatedRoute, useValue: activatedRoute },
      { provide: HeroService,    useClass: TestHeroService },
      { provide: Router,         useValue: routerSpy},
    ]
  })
  .compileComponents();
}));

它的导入声明少一些(未显示),稍微干净一些,小一些。

导入特性模块

HeroDetailComponentHeroModule 这个特性模块的一部分,它聚合了更多相互依赖的片段,包括 SharedModule。 试试下面这个导入了 HeroModule 的测试配置:

app/hero/hero-detail.component.spec.ts (HeroModule setup)

content_copybeforeEach(async(() => {
  const routerSpy = createRouterSpy();

  TestBed.configureTestingModule({
    imports:   [ HeroModule ],
    providers: [
      { provide: ActivatedRoute, useValue: activatedRoute },
      { provide: HeroService,    useClass: TestHeroService },
      { provide: Router,         useValue: routerSpy},
    ]
  })
  .compileComponents();
}));

这样特别清爽。只有 providers 里面的测试替身被保留。连 HeroDetailComponent 声明都消失了。

事实上,如果你试图声明它,Angular 就会抛出一个错误,因为 HeroDetailComponent 同时声明在了 HeroModuleTestBed 创建的 DynamicTestModule 中。

如果模块中有很多共同依赖,并且该模块很小(这也是特性模块的应有形态),那么直接导入组件的特性模块可以成为配置这些测试的简易方式。


改写组件的服务提供商

HeroDetailComponent 提供自己的 HeroDetailService 服务。

app/hero/hero-detail.component.ts (prototype)

content_copy@Component({
  selector:    'app-hero-detail',
  templateUrl: './hero-detail.component.html',
  styleUrls:  ['./hero-detail.component.css' ],
  providers:  [ HeroDetailService ]
})
export class HeroDetailComponent implements OnInit {
  constructor(
    private heroDetailService: HeroDetailService,
    private route:  ActivatedRoute,
    private router: Router) {
  }
}

TestBed.configureTestingModuleproviders 中 stub 伪造组件的 HeroDetailService 是不可行的。 这些是测试模块的提供商,而非组件的。组件级别的供应商应该在fixture 级别准备的依赖注入器。

Angular 会使用自己的注入器来创建这些组件,这个注入器是夹具的注入器的子注入器。 它使用这个子注入器注册了该组件服务提供商(这里是 HeroDetailService )。

测试没办法从测试夹具的注入器中获取子注入器中的服务,而 TestBed.configureTestingModule 也没法配置它们。

Angular 始终都在创建真实 HeroDetailService 的实例。

如果 HeroDetailService 向远程服务器发出自己的 XHR 请求,这些测试可能会失败或者超时。 这个远程服务器可能根本不存在。

幸运的是,HeroDetailService 将远程数据访问的责任交给了注入进来的 HeroService

app/hero/hero-detail.service.ts (prototype)

content_copy@Injectable()
export class HeroDetailService {
  constructor(private heroService: HeroService) {  }
/* . . . */
}

前面的测试配置使用 TestHeroService 替换了真实的 HeroService,它拦截了发往服务器的请求,并伪造了服务器的响应。

如果你没有这么幸运怎么办?如果伪造 HeroService 很难怎么办?如果 HeroDetailService 自己发出服务器请求怎么办?

TestBed.overrideComponent 方法可以将组件的 providers 替换为容易管理的测试替身,参见下面的变体准备代码:

app/hero/hero-detail.component.spec.ts (Override setup)

content_copybeforeEach(async(() => {
  const routerSpy = createRouterSpy();

  TestBed.configureTestingModule({
    imports:   [ HeroModule ],
    providers: [
      { provide: ActivatedRoute, useValue: activatedRoute },
      { provide: Router,         useValue: routerSpy},
    ]
  })

  // Override component's own provider
  .overrideComponent(HeroDetailComponent, {
    set: {
      providers: [
        { provide: HeroDetailService, useClass: HeroDetailServiceSpy }
      ]
    }
  })

  .compileComponents();
}));

注意,TestBed.configureTestingModule 不再提供(伪造的)HeroService,因为并不需要。

overrideComponent 方法

注意这个 overrideComponent 方法。

app/hero/hero-detail.component.spec.ts (overrideComponent)

content_copy.overrideComponent(HeroDetailComponent, {
  set: {
    providers: [
      { provide: HeroDetailService, useClass: HeroDetailServiceSpy }
    ]
  }
})

它接受两个参数:要改写的组件类型(HeroDetailComponent),以及用于改写的元数据对象。 用于改写的元数据对象是一个泛型,其定义如下:

content_copytype MetadataOverride = {
    add?: Partial;
    remove?: Partial;
    set?: Partial;
  };

元数据重载对象可以添加和删除元数据属性的项目,也可以彻底重设这些属性。 这个例子重新设置了组件的 providers 元数据。

这个类型参数,T,是你会传递给 @Component 装饰器的元数据的类型。

content_copyselector?: string;
template?: string;
templateUrl?: string;
providers?: any[];
...

提供 间谍桩 (HeroDetailServiceSpy)

这个例子把组件的 providers 数组完全替换成了一个包含 HeroDetailServiceSpy 的新数组。

HeroDetailServiceSpy 是实际 HeroDetailService 服务的桩版本,它伪造了该服务的所有必要特性。 但它既不需要注入也不会委托给低层的 HeroService 服务,因此不用为 HeroService 提供测试替身。

通过对该服务的方法进行刺探,HeroDetailComponent 的关联测试将会对 HeroDetailService 是否被调用过进行断言。 因此,这个桩类会把它的方法实现为刺探方法:

app/hero/hero-detail.component.spec.ts (HeroDetailServiceSpy)

content_copyclass HeroDetailServiceSpy {
  testHero: Hero = {id: 42, name: 'Test Hero' };

  /* emit cloned test hero */
  getHero = jasmine.createSpy('getHero').and.callFake(
    () => asyncData(Object.assign({}, this.testHero))
  );

  /* emit clone of test hero, with changes merged in */
  saveHero = jasmine.createSpy('saveHero').and.callFake(
    (hero: Hero) => asyncData(Object.assign(this.testHero, hero))
  );
}

改写测试

现在,测试程序可以通过操控 stub 的 testHero,直接控制组件的英雄,并确保服务的方法被调用过。

app/hero/hero-detail.component.spec.ts (override tests)

content_copylet hdsSpy: HeroDetailServiceSpy;

beforeEach(async(() => {
  createComponent();
  // get the component's injected HeroDetailServiceSpy
  hdsSpy = fixture.debugElement.injector.get(HeroDetailService) as any;
}));

it('should have called `getHero`', () => {
  expect(hdsSpy.getHero.calls.count()).toBe(1, 'getHero called once');
});

it('should display stub hero\'s name', () => {
  expect(page.nameDisplay.textContent).toBe(hdsSpy.testHero.name);
});

it('should save stub hero change', fakeAsync(() => {
  const origName = hdsSpy.testHero.name;
  const newName = 'New Name';

  page.nameInput.value = newName;
  page.nameInput.dispatchEvent(newEvent('input')); // tell Angular

  expect(component.hero.name).toBe(newName, 'component hero has new name');
  expect(hdsSpy.testHero.name).toBe(origName, 'service hero unchanged before save');

  click(page.saveBtn);
  expect(hdsSpy.saveHero.calls.count()).toBe(1, 'saveHero called once');

  tick(); // wait for async save to complete
  expect(hdsSpy.testHero.name).toBe(newName, 'service hero has new name after save');
  expect(page.navigateSpy.calls.any()).toBe(true, 'router.navigate called');
}));

更多的改写

TestBed.overrideComponent 方法可以在相同或不同的组件中被反复调用。 TestBed 还提供了类似的 overrideDirectiveoverrideModuleoverridePipe 方法,用来深入并重载这些其它类的部件。

自己探索这些选项和组合。


属性型指令的测试

属性指令修改元素、组件和其它指令的行为。正如它们的名字所示,它们是作为宿主元素的属性来被使用的。

本例子应用的 HighlightDirective 使用数据绑定的颜色或者默认颜色来设置元素的背景色。 它同时设置元素的 customProperty 属性为 true,这里仅仅是为了显示它能这么做而已,并无其它原因。

app/shared/highlight.directive.ts

content_copyimport { Directive, ElementRef, Input, OnChanges } from '@angular/core';

@Directive({ selector: '[highlight]' })
/** Set backgroundColor for the attached element to highlight color
 *  and set the element's customProperty to true */
export class HighlightDirective implements OnChanges {

  defaultColor =  'rgb(211, 211, 211)'; // lightgray

  @Input('highlight') bgColor: string;

  constructor(private el: ElementRef) {
    el.nativeElement.style.customProperty = true;
  }

  ngOnChanges() {
    this.el.nativeElement.style.backgroundColor = this.bgColor || this.defaultColor;
  }
}

它的使用贯穿整个应用,也许最简单的使用在 AboutComponent 里:

app/about/about.component.ts

content_copyimport { Component } from '@angular/core';
@Component({
  template: `
  <h2 highlight="skyblue">About</h2>
  <h3>Quote of the day:</h3>
  <twain-quote></twain-quote>
  `
})
export class AboutComponent { }

要想在 AboutComponent 中测试 HighlightDirective 的具体用法,只要使用在“浅层测试”部分用过的技术即可。

app/about/about.component.spec.ts

content_copybeforeEach(() => {
  fixture = TestBed.configureTestingModule({
    declarations: [ AboutComponent, HighlightDirective],
    schemas:      [ NO_ERRORS_SCHEMA ]
  })
  .createComponent(AboutComponent);
  fixture.detectChanges(); // initial binding
});

it('should have skyblue <h2>', () => {
  const h2: HTMLElement = fixture.nativeElement.querySelector('h2');
  const bgColor = h2.style.backgroundColor;
  expect(bgColor).toBe('skyblue');
});

但是,测试单一的用例一般无法探索该指令的全部能力。 查找和测试所有使用该指令的组件非常繁琐和脆弱,并且通常无法覆盖所有组件。

只针对类的测试可能很有用, 但是像这个一样的属性型指令肯定要操纵 DOM。 隔离出的单元测试不能接触 DOM,因此也就没办法证明该指令的有效性。

更好的方法是创建一个能展示该指令所有用法的人造测试组件。

app/shared/highlight.directive.spec.ts (TestComponent)

content_copy@Component({
  template: `
  <h2 highlight="yellow">Something Yellow</h2>
  <h2 highlight>The Default (Gray)</h2>
  <h2>No Highlight</h2>
  <input #box [highlight]="box.value" value="cyan"/>`
})
class TestComponent { }

测试

<input> 用例将 HighlightDirective 绑定到输入框里输入的颜色名字。 初始只是单词“cyan”,所以输入框的背景色应该是 cyan。

下面是一些该组件的测试程序:

app/shared/highlight.directive.spec.ts (selected tests)

content_copybeforeEach(() => {  fixture = TestBed.configureTestingModule({    declarations: [ HighlightDirective, TestComponent ]  })  .createComponent(TestComponent);   fixture.detectChanges(); // initial binding   // all elements with an attached HighlightDirective  des = fixture.debugElement.queryAll(By.directive(HighlightDirective));   // the h2 without the HighlightDirective  bareH2 = fixture.debugElement.query(By.css('h2:not([highlight])'));}); // color testsit('should have three highlighted elements', () => {  expect(des.length).toBe(3);}); it('should color 1st <h2> background "yellow"', () => {  const bgColor = des[0].nativeElement.style.backgroundColor;  expect(bgColor).toBe('yellow');}); it('should color 2nd <h2> background w/ default color', () => {  const dir = des[1].injector.get(HighlightDirective) as HighlightDirective;  const bgColor = des[1].nativeElement.style.backgroundColor;  expect(bgColor).toBe(dir.defaultColor);}); it('should bind <input> background to value color', () => {  // easier to work with nativeElement  const input = des[2].nativeElement as HTMLInputElement;  expect(input.style.backgroundColor).toBe('cyan', 'initial backgroundColor');   // dispatch a DOM event so that Angular responds to the input value change.  input.value = 'green';  input.dispatchEvent(newEvent('input'));  fixture.detectChanges();   expect(input.style.backgroundColor).toBe('green', 'changed backgroundColor');});  it('bare <h2> should not have a customProperty', () => {  expect(bareH2.properties['customProperty']).toBeUndefined();});

一些技巧值得注意:

  • 已知元素类型时,By.directive 是一种获取拥有这个指令的元素的好方法。
  • By.css('h2:not([highlight])') 里的:not 伪类(pseudo-class)帮助查找不带该指令的 <h2> 元素。By.css('*:not([highlight])') 查找所有不带该指令的元素。
  • DebugElement.styles 甚至不用借助真实的浏览器也可以访问元素的样式,感谢 DebugElement 提供的这层抽象! 但是如果直接使用 nativeElement 会比这层抽象更简单、更清晰,也可以放心大胆的使用它。
  • Angular 将指令添加到它的元素的注入器中。默认颜色的测试程序使用第二个 <h2> 的注入器来获取它的 HighlightDirective 实例以及它的 defaultColor
  • DebugElement.properties 让你可以访问由指令设置的自定义属性。

管道测试

管道很容易测试,无需 Angular 测试工具。

管道类有一个方法,transform,用来转换输入值到输出值。 transform的实现很少与 DOM 交互。 除了 @Pipe 元数据和一个接口外,大部分管道不依赖 Angular。

假设 TitleCasePipe 将每个单词的第一个字母变成大写。 下面是使用正则表达式实现的简单代码:

app/shared/title-case.pipe.ts

content_copyimport { Pipe, PipeTransform } from '@angular/core';

@Pipe({name: 'titlecase', pure: true})
/** Transform to Title Case: uppercase the first letter of the words in a string.*/
export class TitleCasePipe implements PipeTransform {
  transform(input: string): string {
    return input.length === 0 ? '' :
      input.replace(/\w\S*/g, (txt => txt[0].toUpperCase() + txt.substr(1).toLowerCase() ));
  }
}

任何使用正则表达式的类都值得彻底的进行测试。 使用 Jasmine 来探索预期的用例和极端的用例。

app/shared/title-case.pipe.spec.ts

content_copydescribe('TitleCasePipe', () => {  // This pipe is a pure, stateless function so no need for BeforeEach  let pipe = new TitleCasePipe();   it('transforms "abc" to "Abc"', () => {    expect(pipe.transform('abc')).toBe('Abc');  });   it('transforms "abc def" to "Abc Def"', () => {    expect(pipe.transform('abc def')).toBe('Abc Def');  });   // ... more tests ...});

也能编写 DOM 测试

有些管道的测试程序是孤立的。 它们不能验证 TitleCasePipe 是否在应用到组件上时是否工作正常。

考虑像这样添加组件测试程序:

app/hero/hero-detail.component.spec.ts (pipe test)

content_copyit('should convert hero name to Title Case', () => {  // get the name's input and display elements from the DOM  const hostElement = fixture.nativeElement;  const nameInput: HTMLInputElement = hostElement.querySelector('input');  const nameDisplay: HTMLElement = hostElement.querySelector('span');   // simulate user entering a new name into the input box  nameInput.value = 'quick BROWN  fOx';   // dispatch a DOM event so that Angular learns of input value change.  nameInput.dispatchEvent(newEvent('input'));   // Tell Angular to update the display binding through the title pipe  fixture.detectChanges();   expect(nameDisplay.textContent).toBe('Quick Brown  Fox');});

测试程序的调试

在浏览器中,像调试应用一样调试测试程序 spec。

  1. 显示 Karma 的浏览器窗口(之前被隐藏了)。
  2. 点击“DEBUG”按钮;它打开一页新浏览器标签并重新开始运行测试程序
  3. 打开浏览器的“Developer Tools”(Windows 上的 Ctrl-Shift-I 或者 OSX 上的 `Command-Option-I)。
  4. 选择“sources”页
  5. 打开 1st.spec.ts 测试文件(Control/Command-P, 然后输入文件名字)。
  6. 在测试程序中设置断点。
  7. 刷新浏览器...然后它就会停在断点上。

测试


测试工具 API

本节将最有用的 Angular 测试功能提取出来,并总结了它们的作用。

Angular 的测试工具集包括 TestBedComponentFixture 和一些用来控制测试环境的便捷函数。 TestBedComponentFixture 部分单独讲过它们。

下面是一些独立函数的总结,以使用频率排序:

函数

说明

async

在一个特殊的 async 测试区域中运行测试(it)的函数体或准备函数(beforeEach)。 参见前面的讨论。

fakeAsync

在一个特殊的 fakeAsync 测试区域中运行测试(it)的函数体,以便启用线性风格的控制流。 参见前面的讨论。

tick

通过在 fakeAsync 测试区域中刷新定时器和微任务(micro-task)队列来仿真时间的流逝以及异步活动的完成。好奇和执着的读者可能会喜欢这篇长博客: "Tasks, microtasks, queues and schedules".接受一个可选参数,它可以把虚拟时钟往前推进特定的微秒数。 清除调度到那个时间帧中的异步活动。 参见前面的讨论。

inject

从当前的 TestBed 注入器中把一个或多个服务注入到一个测试函数中。 它不能用于注入组件自身提供的服务。 参见 debugElement.injector 部分的讨论。

discardPeriodicTasks

当 fakeAsync 测试程序以正在运行的计时器事件任务(排队中的 setTimeOut 和 setInterval的回调)结束时, 测试会失败,并显示一条明确的错误信息。一般来讲,测试程序应该以无排队任务结束。 当待执行计时器任务存在时,调用 discardPeriodicTasks 来触发任务队列,防止该错误发生。

flushMicrotasks

当 fakeAsync 测试程序以待执行微任务(比如未解析的承诺)结束时,测试会失败并显示明确的错误信息。一般来说,测试应该等待微任务结束。 当待执行微任务存在时,调用 flushMicrotasks 来触发微任务队列,防止该错误发生。

ComponentFixtureAutoDetect

一个服务提供商令牌,用于开启自动变更检测。

getTestBed

获取当前 TestBed 实例。 通常用不上,因为 TestBed 的静态类方法已经够用。 TestBed 实例有一些很少需要用到的方法,它们没有对应的静态方法。


TestBed 类小结

TestBed 类是 Angular 测试工具的主要类之一。它的 API 很庞大,可能有点过于复杂,直到你一点一点的探索它们。 阅读本章前面的部分,了解了基本的知识以后,再试着了解完整 API。

传递给 configureTestingModule 的模块定义是 @NgModule 元数据属性的子集。

content_copytype TestModuleMetadata = {
  providers?: any[];
  declarations?: any[];
  imports?: any[];
  schemas?: Array<SchemaMetadata | any[]>;
};

每一个重载方法接受一个 MetadataOverride<T>,这里 T 是适合这个方法的元数据类型,也就是 @NgModule@Component@Directive 或者 @Pipe 的参数。

content_copytype MetadataOverride = {
    add?: Partial;
    remove?: Partial;
    set?: Partial;
  };

TestBed 的 API 包含了一系列静态类方法,它们更新或者引用全局TestBed 实例。

在内部,所有静态方法在 getTestBed() 函数返回的当前运行时间的 TestBed 实例上都有对应的方法。

BeforeEach() 内调用 TestBed 方法,这样确保在运行每个单独测试时,都有崭新的开始。

这里列出了最重要的静态方法,以使用频率排序:

方法

说明

configureTestingModule

测试垫片(karma-test-shim, browser-test-shim)创建了初始测试环境和默认测试模块。 默认测试模块是使用基本声明和一些 Angular 服务替代品,它们是所有测试程序都需要的。调用 configureTestingModule 来为一套特定的测试定义测试模块配置,添加和删除导入、(组件、指令和管道的)声明和服务提供商。

compileComponents

在配置好测试模块之后,异步编译它。 如果测试模块中的任何一个组件具有 templateUrl 或 styleUrls,那么你必须调用这个方法,因为获取组件的模板或样式文件必须是异步的。 参见前面的讨论。调用完 compileComponents 之后,TestBed的配置就会在当前测试期间被冻结。

createComponent

基于当前 TestBed 的配置创建一个类型为 T 的组件实例。 一旦调用,TestBed 的配置就会在当前测试期间被冻结。

overrideModule

替换指定的 NgModule 的元数据。回想一下,模块可以导入其他模块。overrideModule 方法可以深入到当前测试模块深处,修改其中一个内部模块。

overrideComponent

替换指定组件类的元数据,该组件类可能嵌套在一个很深的内部模块中。

overrideDirective

替换指定指令类的元数据,该指令可能嵌套在一个很深的内部模块中。

overridePipe

替换指定管道类的元数据,该管道可能嵌套在一个很深的内部模块中。

get

从当前 TestBed 注入器获取一个服务。inject 函数通常都能胜任这项工作,但是如果它没法提供该服务时就会抛出一个异常。如果该服务是可选的呢?TestBed.get() 方法可以接受可选的第二参数,当 Angular 找不到指定的服务提供商时,就会返回该对象(下面这个例子中是 null ):app/demo/demo.testbed.spec.tscontent_copyservice = TestBed.get(NotProvided, null); // service is null一旦调用,TestBed 的配置就会在当前测试期间被冻结。

initTestEnvironment

为整套测试的运行初始化测试环境。测试垫片(karma-test-shim, browser-test-shim)会为你调用它,所以你很少需要自己调用它。这个方法只能被调用一次。如果确实需要在测试程序运行期间改变这个默认设置,那么先调用 resetTestEnvironment。指定 Angular 编译器工厂,PlatformRef,和默认 Angular 测试模块。 以 @angular/platform-<platform_name>/testing/<platform_name>的形式提供非浏览器平台的替代品。

resetTestEnvironment

重设初始测试环境,包括默认测试模块在内。

少数 TestBed 实例方法没有对应的静态方法。它们很少被使用。

ComponentFixture

TestBed.createComponent<T> 会创建一个组件 T 的实例,并为该组件返回一个强类型的 ComponentFixture

ComponentFixture 的属性和方法提供了对组件、它的 DOM 和它的 Angular 环境方面的访问。

ComponentFixture 的属性

下面是对测试最重要的属性,以使用频率排序:

属性

说明

componentInstance

被 TestBed.createComponent 创建的组件类实例。

debugElement

与组件根元素关联的 DebugElement。debugElement 提供了在测试和调试期间深入探查组件及其 DOM 元素的功能。 它对于测试者是一个极其重要的属性。它的大多数主要成员在后面都有讲解。

nativeElement

组件的原生根 DOM 元素。

changeDetectorRef

组件的 ChangeDetectorRef。在测试一个拥有 ChangeDetectionStrategy.OnPush 的组件,或者在组件的变化测试在你的程序控制下时,ChangeDetectorRef 是最重要的。

ComponentFixture 的方法

fixture 方法使 Angular 对组件树执行某些任务。 在触发 Angular 行为来模拟的用户行为时,调用这些方法。

下面是对测试最有用的方法。

方法

说明

detectChanges

为组件触发一轮变化检查。调用它来初始化组件(它调用 ngOnInit)。或者在你的测试代码改变了组件的数据绑定属性值后调用它。 Angular 不能检测到你已经改变了 personComponent.name 属性,也不会更新 name 的绑定,直到你调用了 detectChanges。之后,运行 checkNoChanges,来确认没有循环更新,除非它被这样调用:detectChanges(false)。

autoDetectChanges

设置 fixture 是否应该自动试图检测变化。当自动检测打开时,测试 fixture 监听 zone事件,并调用 detectChanges。 当你的测试代码直接修改了组件属性值时,你还是要调用 fixture.detectChanges 来触发数据绑定更新。默认值是 false,喜欢对测试行为进行精细控制的测试者一般保持它为 false。

checkNoChanges

运行一次变更检测来确认没有待处理的变化。如果有未处理的变化,它将抛出一个错误。

isStable

如果 fixture 当前是稳定的,则返回 true。 如果有异步任务没有完成,则返回 false。

whenStable

返回一个承诺,在 fixture 稳定时解析。要想在完成了异步活动或异步变更检测之后再继续测试,可以对那个承诺对象进行挂钩。 参见 前面。

destroy

触发组件的销毁。

DebugElement

DebugElement 提供了对组件的 DOM 的访问。

fixture.debugElement 返回测试根组件的 DebugElement,通过它你可以访问(查询)fixture 的整个元素和组件子树。

下面是 DebugElement 最有用的成员,以使用频率排序。

成员

说明

nativeElement

与浏览器中 DOM 元素对应(WebWorkers 时,值为 null)。

query

调用 query(predicate:Predicate<DebugElement>) 会在子树的任意深度中查找能和谓词函数匹配的第一个 DebugElement。

queryAll

调用 queryAll(predicate:Predicate<DebugElement>) 会在子树的任意深度中查找能和谓词函数匹配的所有 DebugElement。

injector

宿主依赖注入器。 比如,根元素的组件实例注入器。

componentInstance

元素自己的组件实例(如果有)。

context

为元素提供父级上下文的对象。 通常是控制该元素的祖级组件实例。当一个元素被 *ngFor 重复,它的上下文为 NgForRow,它的 $implicit 属性值是该行的实例值。 比如,*ngFor="let hero of heroes" 里的 hero。

children

DebugElement 的直接子元素。可以通过继续深入 children 来遍历这棵树。DebugElement 还有 childNodes,即 DebugNode 对象列表。DebugElement 从 DebugNode 对象衍生,而且通常节点(node)比元素多。测试者通常忽略赤裸节点。

parent

DebugElement 的父级。如果 DebugElement 是根元素,parent 为 null。

name

元素的标签名字,如果它是一个元素的话。

triggerEventHandler

如果在该元素的 listeners 集合中有相应的监听器,就根据名字触发这个事件。如果事件缺乏监听器,或者有其它问题,考虑调用 nativeElement.dispatchEvent(eventObject)。

listeners

元素的 @Output 属性以及/或者元素的事件属性所附带的回调函数。

providerTokens

组件注入器的查询令牌。 包括组件自己的令牌和组件的 providers 元数据中列出来的令牌。

source

source 是在源组件模板中查询这个元素的处所。

references

与模板本地变量(比如 #foo)关联的词典对象,关键字与本地变量名字配对。

DebugElement.query(predicate)DebugElement.queryAll(predicate)方法接受一个条件方法, 它过滤源元素的子树,返回匹配的 DebugElement

这个条件方法是任何接受一个 DebugElement 并返回真值的方法。 下面的例子查询所有拥有名为 content 的模块本地变量的所有 DebugElement

app/demo/demo.testbed.spec.ts

content_copy// Filter for DebugElements with a #content reference
const contentRefs = el.queryAll( de => de.references['content']);

Angular 的 By 类为常用条件方法提供了三个静态方法:

  • By.all - 返回所有元素
  • By.css(selector) - 返回符合 CSS 选择器的元素。
  • By.directive(directive) - 返回 Angular 能匹配一个指令类实例的所有元素。

app/hero/hero-list.component.spec.ts

content_copy// Can find DebugElement either by css selector or by directive
const h2        = fixture.debugElement.query(By.css('h2'));
const directive = fixture.debugElement.query(By.directive(HighlightDirective));

常见问题

为什么要把测试文件和被测文件放在一起?

将单元测试的 spec 配置文件放到与应用程序源代码文件所在的同一个文件夹中是个好主意,因为:

  • 这样的测试程序很容易被找到
  • 你可以一眼看出应用程序的哪些部分缺乏测试程序。
  • 临近的测试程序可以展示代码是如何在上下文中工作的
  • 当你移动代码(无可避免)时,你记得一起移动测试程序
  • 当你重命名源代码文件(无可避免),你记得重命名测试程序文件。

什么时候我该把测试文件放进单独的 test 文件夹中?

应用程序的整合测试 spec 文件可以测试横跨多个目录和模块的多个部分之间的互动。 它们不属于任何部分,很自然,没有特别的地方存放它们。

通常,在 test 目录中为它们创建一个合适的目录比较好。

当然,测试助手对象的测试 spec 文件也属于 test 目录,与它们对应的助手文件相邻。

为什么不依赖 E2E 测试来保障 DOM 集成后的正确性?

本指南中讲的组件 DOM 测试通常需要大量的准备工作以及高级技巧,不像只针对类的测试那样简单。

为什么不等到端到端(E2E)测试阶段再对 DOM 进行集成测试呢?

E2E 测试对于整个系统的高层验证非常好用。 但是它们没法给你像单元测试这样全面的测试覆盖率。

E2E 测试很难写,并且执行性能也赶不上单元测试。 它们很容易被破坏,而且经常是因为某些远离故障点的修改或不当行为而导致的。

当出错时,E2E 测试不能轻松揭露你的组件出了什么问题, 比如丢失或错误的数据、网络失去连接或远端服务器挂了。

如果 E2E 的测试对象要更新数据库、发送发票或收取信用卡,就需要一些特殊的技巧和后门来防止远程资源被意外破坏。 它甚至可能都难以导航到你要测试的组件。

由于存在这么多障碍,你应该尽可能使用单元测试技术来测试 DOM 交互。

测试
AngularJS

Angular 是一个开发平台。它能帮你更轻松的构建 Web 应用。Angular 集声明式模板、依赖注入、端到端工具和一些最佳实践于一身,为你解决开发方面的各种挑战。

AngularJS目录

1.快速上手 | quick start
2.语言服务
3.安全
4.环境准备与部署
5.Service Worker
6.保持最新
7.从 AngularJS 升级
8.服务端渲染
9.Visual Studio 2015 快速上手
10.风格指南
11.国际化
12.测试
13.路由与导航
14. 教程 | Tutorial
15.架构
16.组件与模板
17.表单
18.可观察对象与RxJS
19.引导启动
20.Angular 模块
21.依赖注入
22.HttpClient
23.词汇表
24.AngularJS 应用
25.AngularJS 模块
26.AngularJS 事件
27.AngularJS HTML DOM
28.AngularJS 过滤器
29.AngularJS 控制器
30.AngularJS 指令
31.AngularJS 表达式
32.AngularJS 简介
33.AngularJS 参考手册
34.AngularJS 实例
35.AngularJS 输入验证
36.AngularJS 表单
37.AngularJS SQL
38.AngularJS 表格
39.AngularJS Http
40.AngularJS 包含
41.AngularJS Bootstrap
42.AngularJS API
43.AngularJS ng-checked 指令
44.AngularJS ng-change 指令
45.AngularJS ng-blur 指令
46.AngularJS ng-bind-template 指令
47.AngularJS ng-bind-html 指令
48.AngularJS ng-bind 指令
49.AngularJS ng-app 指令
50.AngularJS Scope(作用域)
51.AngularJS ng-model 指令
52.AngularJS ng-dblclick 指令
53.AngularJS ng-cut 指令
54.AngularJS ng-csp 指令
55.AngularJS ng-copy 指令
56.AngularJS ng-controller 指令
57.AngularJS ng-cloak 指令
58.AngularJS ng-click 指令
59.AngularJS ng-class-odd 指令
60.AngularJS ng-class-even 指令
61.AngularJS ng-class 指令
62.AngularJS ng-keyup 指令
63.AngularJS ng-keypress 指令
64.AngularJS ng-keydown 指令
65.AngularJS ng-init 指令
66.AngularJS ng-include 指令
67.AngularJS ng-if 指令
68.AngularJS ng-href 指令
69.AngularJS ng-hide 指令
70.AngularJS ng-focus 指令
71.AngularJS ng-disabled 指令
72.AngularJS ng-non-bindable 指令
73.AngularJS ng-mouseup 指令
74.AngularJS ng-mouseover 指令
75.AngularJS ng-mousemove 指令
76.AngularJS ng-mouseleave 指令
77.AngularJS ng-mouseenter 指令
78.AngularJS ng-mousedown 指令
79.AngularJS ng-model-options 指令
80.AngularJS ng-model 指令
81.AngularJS ng-list 指令
82.AngularJS ng-style 指令
83.AngularJS ng-srcset 指令
84.AngularJS ng-src 指令
85.AngularJS ng-show 指令
86.AngularJS ng-selected 指令
87.AngularJS ng-repeat 指令
88.AngularJS ng-readonly 指令
89.AngularJS ng-paste 指令
90.AngularJS ng-options 指令
91.AngularJS ng-open 指令
92.AngularJS ng-value 指令
93.AngularJS ng-switch 指令
94.AngularJS ng-submit 指令
95.AngularJS 服务(Service)
96.AngularJS Select(选择框)
97.AngularJS 动画
98.AngularJS 依赖注入