Angular 4 个单元测试 (TestBed) 非常慢
Angular 4 Unit Tests (TestBed) extremely slow
我使用 Angular TestBed 进行了一些单元测试。即使测试非常简单,它们 运行 也非常慢(平均每秒 1 个测试资产)。
即使重新阅读 Angular 文档,我也找不到性能如此差的原因。
孤立测试,不使用 TestBed,运行 瞬间完成。
单元测试
import { Component } from "@angular/core";
import { ComponentFixture, TestBed, async } from "@angular/core/testing";
import { By } from "@angular/platform-browser";
import { DebugElement } from "@angular/core";
import { DynamicFormDropdownComponent } from "./dynamicFormDropdown.component";
import { NgbModule } from "@ng-bootstrap/ng-bootstrap";
import { FormsModule } from "@angular/forms";
import { DropdownQuestion } from "../../element/question/questionDropdown";
import { TranslateService } from "@ngx-translate/core";
import { TranslatePipeMock } from "../../../../tests-container/translate-pipe-mock";
describe("Component: dynamic drop down", () => {
let component: DynamicFormDropdownComponent;
let fixture: ComponentFixture<DynamicFormDropdownComponent>;
let expectedInputQuestion: DropdownQuestion;
const emptySelectedObj = { key: "", value: ""};
const expectedOptions = {
key: "testDropDown",
value: "",
label: "testLabel",
disabled: false,
selectedObj: { key: "", value: ""},
options: [
{ key: "key_1", value: "value_1" },
{ key: "key_2", value: "value_2" },
{ key: "key_3", value: "value_3" },
],
};
beforeEach(async(() => {
TestBed.configureTestingModule({
imports: [NgbModule.forRoot(), FormsModule],
declarations: [DynamicFormDropdownComponent, TranslatePipeMock],
providers: [TranslateService],
})
.compileComponents();
}));
beforeEach(() => {
fixture = TestBed.createComponent(DynamicFormDropdownComponent);
component = fixture.componentInstance;
expectedInputQuestion = new DropdownQuestion(expectedOptions);
component.question = expectedInputQuestion;
});
it("should have a defined component", () => {
expect(component).toBeDefined();
});
it("Must have options collapsed by default", () => {
expect(component.optionsOpen).toBeFalsy();
});
it("Must toggle the optionsOpen variable calling openChange() method", () => {
component.optionsOpen = false;
expect(component.optionsOpen).toBeFalsy();
component.openChange();
expect(component.optionsOpen).toBeTruthy();
});
it("Must have options available once initialized", () => {
expect(component.question.options.length).toEqual(expectedInputQuestion.options.length);
});
it("On option button click, the relative value must be set", () => {
spyOn(component, "propagateChange");
const expectedItem = expectedInputQuestion.options[0];
fixture.detectChanges();
const actionButtons = fixture.debugElement.queryAll(By.css(".dropdown-item"));
actionButtons[0].nativeElement.click();
expect(component.question.selectedObj).toEqual(expectedItem);
expect(component.propagateChange).toHaveBeenCalledWith(expectedItem.key);
});
it("writeValue should set the selectedObj once called (pass string)", () => {
expect(component.question.selectedObj).toEqual(emptySelectedObj);
const expectedItem = component.question.options[0];
component.writeValue(expectedItem.key);
expect(component.question.selectedObj).toEqual(expectedItem);
});
it("writeValue should set the selectedObj once called (pass object)", () => {
expect(component.question.selectedObj).toEqual(emptySelectedObj);
const expectedItem = component.question.options[0];
component.writeValue(expectedItem);
expect(component.question.selectedObj).toEqual(expectedItem);
});
});
目标组件(带模板)
import { Component, Input, OnInit, ViewChild, ElementRef, forwardRef } from "@angular/core";
import { FormGroup, ControlValueAccessor, NG_VALUE_ACCESSOR } from "@angular/forms";
import { DropdownQuestion } from "../../element/question/questionDropdown";
@Component({
selector: "df-dropdown",
templateUrl: "./dynamicFormDropdown.component.html",
styleUrls: ["./dynamicFormDropdown.styles.scss"],
providers: [
{
provide: NG_VALUE_ACCESSOR,
useExisting: forwardRef(() => DynamicFormDropdownComponent),
multi: true,
},
],
})
export class DynamicFormDropdownComponent implements ControlValueAccessor {
@Input()
public question: DropdownQuestion;
public optionsOpen: boolean = false;
public selectItem(key: string, value: string): void {
this.question.selectedObj = { key, value };
this.propagateChange(this.question.selectedObj.key);
}
public writeValue(object: any): void {
if (object) {
if (typeof object === "string") {
this.question.selectedObj = this.question.options.find((item) => item.key === object) || { key: "", value: "" };
} else {
this.question.selectedObj = object;
}
}
}
public registerOnChange(fn: any) {
this.propagateChange = fn;
}
public propagateChange = (_: any) => { };
public registerOnTouched() {
}
public openChange() {
if (!this.question.disabled) {
this.optionsOpen = !this.optionsOpen;
}
}
private toggle(dd: any) {
if (!this.question.disabled) {
dd.toggle();
}
}
}
-----------------------------------------------------------------------
<div>
<div (openChange)="openChange();" #dropDown="ngbDropdown" ngbDropdown class="wrapper" [ngClass]="{'disabled-item': question.disabled}">
<input type="text"
[disabled]="question.disabled"
[name]="controlName"
class="select btn btn-outline-primary"
[ngModel]="question.selectedObj.value | translate"
[title]="question.selectedObj.value"
readonly ngbDropdownToggle #selectDiv/>
<i (click)="toggle(dropDown);" [ngClass]="optionsOpen ? 'arrow-down' : 'arrow-up'" class="rchicons rch-003-button-icon-referenzen-pfeil-akkordon"></i>
<div ngbDropdownMenu aria-labelledby="dropdownBasic1" class="option-wrapper">
<button *ngFor="let opt of question.options; trackBy: opt?.key" (click)="selectItem(opt.key, opt.value); dropDown.close();"
class="dropdown-item option" [disabled]="question.disabled">{{opt.value | translate}}</button>
</div>
</div>
</div>
业力配置
var webpackConfig = require('./webpack/webpack.dev.js');
module.exports = function (config) {
config.set({
basePath: '',
frameworks: ['jasmine'],
plugins: [
require('karma-webpack'),
require('karma-jasmine'),
require('karma-phantomjs-launcher'),
require('karma-sourcemap-loader'),
require('karma-tfs-reporter'),
require('karma-junit-reporter'),
],
files: [
'./app/polyfills.ts',
'./tests-container/test-bundle.spec.ts',
],
exclude: [],
preprocessors: {
'./app/polyfills.ts': ['webpack', 'sourcemap'],
'./tests-container/test-bundle.spec.ts': ['webpack', 'sourcemap'],
'./app/**/!(*.spec.*).(ts|js)': ['sourcemap'],
},
webpack: {
entry: './tests-container/test-bundle.spec.ts',
devtool: 'inline-source-map',
module: webpackConfig.module,
resolve: webpackConfig.resolve
},
mime: {
'text/x-typescript': ['ts', 'tsx']
},
reporters: ['progress', 'junit', 'tfs'],
port: 9876,
colors: true,
logLevel: config.LOG_INFO,
autoWatch: true,
browsers: ['PhantomJS'],
singleRun: false,
concurrency: Infinity
})
}
原来问题出在 Angular,如 Github
中所述
下面是 Github 讨论中的解决方法,即 将 运行 测试的时间从 40 多秒减少到仅 1 秒 (!)在我们的项目中。
const oldResetTestingModule = TestBed.resetTestingModule;
beforeAll((done) => (async () => {
TestBed.resetTestingModule();
TestBed.configureTestingModule({
// ...
});
function HttpLoaderFactory(http: Http) {
return new TranslateHttpLoader(http, "/api/translations/", "");
}
await TestBed.compileComponents();
// prevent Angular from resetting testing module
TestBed.resetTestingModule = () => TestBed;
})()
.then(done)
.catch(done.fail));
describe('Test name', () => {
configureTestSuite();
beforeAll(done => (async () => {
TestBed.configureTestingModule({
imports: [HttpClientTestingModule, NgReduxTestingModule],
providers: []
});
await TestBed.compileComponents();
})().then(done).catch(done.fail));
it(‘your test', (done: DoneFn) => {
});
});
创建新文件:
import { getTestBed, TestBed, ComponentFixture } from '@angular/core/testing';
import { } from 'jasmine';
export const configureTestSuite = () => {
const testBedApi: any = getTestBed();
const originReset = TestBed.resetTestingModule;
beforeAll(() => {
TestBed.resetTestingModule();
TestBed.resetTestingModule = () => TestBed;
});
afterEach(() => {
testBedApi._activeFixtures.forEach((fixture: ComponentFixture<any>) => fixture.destroy());
testBedApi._instantiated = false;
});
afterAll(() => {
TestBed.resetTestingModule = originReset;
TestBed.resetTestingModule();
});
};
上面 Francesco 的回答很好,但最后需要这段代码。否则其他测试套件将失败。
afterAll(() => {
TestBed.resetTestingModule = oldResetTestingModule;
TestBed.resetTestingModule();
});
您可能想尝试一下 ng-bullet。
它大大提高了 Angular 单元测试的执行速度。
还建议在官方 angular 回购问题中使用有关 Test Bed 单元测试性能的问题:https://github.com/angular/angular/issues/12409#issuecomment-425635583
重点是把每个测试文件的header中原来的beforeEach替换掉
beforeEach(async(() => {
// a really simplified example of TestBed configuration
TestBed.configureTestingModule({
declarations: [ /*list of components goes here*/ ],
imports: [ /* list of providers goes here*/ ]
})
.compileComponents();
}));
与configureTestSuite:
import { configureTestSuite } from 'ng-bullet';
...
configureTestSuite(() => {
TestBed.configureTestingModule({
declarations: [ /*list of components goes here*/ ],
imports: [ /* list of providers goes here*/ ]
})
});
我做了一个小函数,你可以用它来加快速度。它的效果类似于其他答案中提到的 ng-bullet
,但仍然会在测试之间清理服务,以便它们不会泄漏状态。函数是precompileForTests
, available in n-ng-dev-utils
.
像这样使用它(来自它的文档):
// let's assume `AppModule` declares or imports a `HelloWorldComponent`
precompileForTests([AppModule]);
// Everything below here is the same as normal. Just add the line above.
describe("AppComponent", () => {
it("says hello", async () => {
TestBed.configureTestingModule({ declarations: [HelloWorldComponent] });
await TestBed.compileComponents(); // <- this line is faster
const fixture = TestBed.createComponent(HelloWorldComponent);
expect(fixture.nativeElement.textContent).toContain("Hello, world!");
});
});
回答对我很有帮助。要添加,我们需要清理 <head>
标签中的 <style>
,因为它们还负责内存 leak.Cleaning afterAll()
中的所有样式也大大提高了性能。
请阅读original post以供参考
2020 年 10 月更新
正在将 angular 应用程序升级到 Angular 9 进行了 大规模测试 运行 时间改进 ,
如果您想继续使用当前版本,以下软件包帮助我提高了测试性能:
Ng-bullet link
Ng-Bullet 是一个库,它增强了您使用 Angular TestBed 进行单元测试的体验,大大提高了测试的执行速度。
它会做的是它不会一直创建测试套件,而是会使用以前创建的套件,通过使用它,我已经看到 300% 改进的测试 运行s 然后之前。
在我的具体情况下,它会延迟,因为我们在我们的组件样式 'component.component.scss' 中导入我们的 styles.scss(这也导入其他巨大的样式),这会为每个组件模板生成递归样式。
为避免这种情况,请仅在您的组件中导入 scss 变量、mixin 和类似内容。
如果你正在使用 Angular 12.1+
(如果不是,那么最好迁移到新版本)那么最好的方法就是引入 teardown
属性 这将出人意料地提高单元测试的执行速度,因为以下原因:
- 主机元素已从 DOM
中删除
- 已从 DOM
中删除组件样式
- 应用程序范围的服务被破坏
- 使用任何提供程序范围的功能级服务被销毁
- Angular 模块被摧毁
- 组件被销毁
- 组件级服务被销毁
以上所有事情都会在每次单元测试执行后发生。
只需打开您的 test-main.ts
文件并输入以下代码:
getTestBed().initTestEnvironment(
BrowserDynamicTestingModule,
platformBrowserDynamicTesting(),
{ teardown: { destroyAfterEach: true } },
);
我使用 Angular TestBed 进行了一些单元测试。即使测试非常简单,它们 运行 也非常慢(平均每秒 1 个测试资产)。
即使重新阅读 Angular 文档,我也找不到性能如此差的原因。
孤立测试,不使用 TestBed,运行 瞬间完成。
单元测试
import { Component } from "@angular/core";
import { ComponentFixture, TestBed, async } from "@angular/core/testing";
import { By } from "@angular/platform-browser";
import { DebugElement } from "@angular/core";
import { DynamicFormDropdownComponent } from "./dynamicFormDropdown.component";
import { NgbModule } from "@ng-bootstrap/ng-bootstrap";
import { FormsModule } from "@angular/forms";
import { DropdownQuestion } from "../../element/question/questionDropdown";
import { TranslateService } from "@ngx-translate/core";
import { TranslatePipeMock } from "../../../../tests-container/translate-pipe-mock";
describe("Component: dynamic drop down", () => {
let component: DynamicFormDropdownComponent;
let fixture: ComponentFixture<DynamicFormDropdownComponent>;
let expectedInputQuestion: DropdownQuestion;
const emptySelectedObj = { key: "", value: ""};
const expectedOptions = {
key: "testDropDown",
value: "",
label: "testLabel",
disabled: false,
selectedObj: { key: "", value: ""},
options: [
{ key: "key_1", value: "value_1" },
{ key: "key_2", value: "value_2" },
{ key: "key_3", value: "value_3" },
],
};
beforeEach(async(() => {
TestBed.configureTestingModule({
imports: [NgbModule.forRoot(), FormsModule],
declarations: [DynamicFormDropdownComponent, TranslatePipeMock],
providers: [TranslateService],
})
.compileComponents();
}));
beforeEach(() => {
fixture = TestBed.createComponent(DynamicFormDropdownComponent);
component = fixture.componentInstance;
expectedInputQuestion = new DropdownQuestion(expectedOptions);
component.question = expectedInputQuestion;
});
it("should have a defined component", () => {
expect(component).toBeDefined();
});
it("Must have options collapsed by default", () => {
expect(component.optionsOpen).toBeFalsy();
});
it("Must toggle the optionsOpen variable calling openChange() method", () => {
component.optionsOpen = false;
expect(component.optionsOpen).toBeFalsy();
component.openChange();
expect(component.optionsOpen).toBeTruthy();
});
it("Must have options available once initialized", () => {
expect(component.question.options.length).toEqual(expectedInputQuestion.options.length);
});
it("On option button click, the relative value must be set", () => {
spyOn(component, "propagateChange");
const expectedItem = expectedInputQuestion.options[0];
fixture.detectChanges();
const actionButtons = fixture.debugElement.queryAll(By.css(".dropdown-item"));
actionButtons[0].nativeElement.click();
expect(component.question.selectedObj).toEqual(expectedItem);
expect(component.propagateChange).toHaveBeenCalledWith(expectedItem.key);
});
it("writeValue should set the selectedObj once called (pass string)", () => {
expect(component.question.selectedObj).toEqual(emptySelectedObj);
const expectedItem = component.question.options[0];
component.writeValue(expectedItem.key);
expect(component.question.selectedObj).toEqual(expectedItem);
});
it("writeValue should set the selectedObj once called (pass object)", () => {
expect(component.question.selectedObj).toEqual(emptySelectedObj);
const expectedItem = component.question.options[0];
component.writeValue(expectedItem);
expect(component.question.selectedObj).toEqual(expectedItem);
});
});
目标组件(带模板)
import { Component, Input, OnInit, ViewChild, ElementRef, forwardRef } from "@angular/core";
import { FormGroup, ControlValueAccessor, NG_VALUE_ACCESSOR } from "@angular/forms";
import { DropdownQuestion } from "../../element/question/questionDropdown";
@Component({
selector: "df-dropdown",
templateUrl: "./dynamicFormDropdown.component.html",
styleUrls: ["./dynamicFormDropdown.styles.scss"],
providers: [
{
provide: NG_VALUE_ACCESSOR,
useExisting: forwardRef(() => DynamicFormDropdownComponent),
multi: true,
},
],
})
export class DynamicFormDropdownComponent implements ControlValueAccessor {
@Input()
public question: DropdownQuestion;
public optionsOpen: boolean = false;
public selectItem(key: string, value: string): void {
this.question.selectedObj = { key, value };
this.propagateChange(this.question.selectedObj.key);
}
public writeValue(object: any): void {
if (object) {
if (typeof object === "string") {
this.question.selectedObj = this.question.options.find((item) => item.key === object) || { key: "", value: "" };
} else {
this.question.selectedObj = object;
}
}
}
public registerOnChange(fn: any) {
this.propagateChange = fn;
}
public propagateChange = (_: any) => { };
public registerOnTouched() {
}
public openChange() {
if (!this.question.disabled) {
this.optionsOpen = !this.optionsOpen;
}
}
private toggle(dd: any) {
if (!this.question.disabled) {
dd.toggle();
}
}
}
-----------------------------------------------------------------------
<div>
<div (openChange)="openChange();" #dropDown="ngbDropdown" ngbDropdown class="wrapper" [ngClass]="{'disabled-item': question.disabled}">
<input type="text"
[disabled]="question.disabled"
[name]="controlName"
class="select btn btn-outline-primary"
[ngModel]="question.selectedObj.value | translate"
[title]="question.selectedObj.value"
readonly ngbDropdownToggle #selectDiv/>
<i (click)="toggle(dropDown);" [ngClass]="optionsOpen ? 'arrow-down' : 'arrow-up'" class="rchicons rch-003-button-icon-referenzen-pfeil-akkordon"></i>
<div ngbDropdownMenu aria-labelledby="dropdownBasic1" class="option-wrapper">
<button *ngFor="let opt of question.options; trackBy: opt?.key" (click)="selectItem(opt.key, opt.value); dropDown.close();"
class="dropdown-item option" [disabled]="question.disabled">{{opt.value | translate}}</button>
</div>
</div>
</div>
业力配置
var webpackConfig = require('./webpack/webpack.dev.js');
module.exports = function (config) {
config.set({
basePath: '',
frameworks: ['jasmine'],
plugins: [
require('karma-webpack'),
require('karma-jasmine'),
require('karma-phantomjs-launcher'),
require('karma-sourcemap-loader'),
require('karma-tfs-reporter'),
require('karma-junit-reporter'),
],
files: [
'./app/polyfills.ts',
'./tests-container/test-bundle.spec.ts',
],
exclude: [],
preprocessors: {
'./app/polyfills.ts': ['webpack', 'sourcemap'],
'./tests-container/test-bundle.spec.ts': ['webpack', 'sourcemap'],
'./app/**/!(*.spec.*).(ts|js)': ['sourcemap'],
},
webpack: {
entry: './tests-container/test-bundle.spec.ts',
devtool: 'inline-source-map',
module: webpackConfig.module,
resolve: webpackConfig.resolve
},
mime: {
'text/x-typescript': ['ts', 'tsx']
},
reporters: ['progress', 'junit', 'tfs'],
port: 9876,
colors: true,
logLevel: config.LOG_INFO,
autoWatch: true,
browsers: ['PhantomJS'],
singleRun: false,
concurrency: Infinity
})
}
原来问题出在 Angular,如 Github
中所述下面是 Github 讨论中的解决方法,即 将 运行 测试的时间从 40 多秒减少到仅 1 秒 (!)在我们的项目中。
const oldResetTestingModule = TestBed.resetTestingModule;
beforeAll((done) => (async () => {
TestBed.resetTestingModule();
TestBed.configureTestingModule({
// ...
});
function HttpLoaderFactory(http: Http) {
return new TranslateHttpLoader(http, "/api/translations/", "");
}
await TestBed.compileComponents();
// prevent Angular from resetting testing module
TestBed.resetTestingModule = () => TestBed;
})()
.then(done)
.catch(done.fail));
describe('Test name', () => {
configureTestSuite();
beforeAll(done => (async () => {
TestBed.configureTestingModule({
imports: [HttpClientTestingModule, NgReduxTestingModule],
providers: []
});
await TestBed.compileComponents();
})().then(done).catch(done.fail));
it(‘your test', (done: DoneFn) => {
});
});
创建新文件:
import { getTestBed, TestBed, ComponentFixture } from '@angular/core/testing';
import { } from 'jasmine';
export const configureTestSuite = () => {
const testBedApi: any = getTestBed();
const originReset = TestBed.resetTestingModule;
beforeAll(() => {
TestBed.resetTestingModule();
TestBed.resetTestingModule = () => TestBed;
});
afterEach(() => {
testBedApi._activeFixtures.forEach((fixture: ComponentFixture<any>) => fixture.destroy());
testBedApi._instantiated = false;
});
afterAll(() => {
TestBed.resetTestingModule = originReset;
TestBed.resetTestingModule();
});
};
上面 Francesco 的回答很好,但最后需要这段代码。否则其他测试套件将失败。
afterAll(() => {
TestBed.resetTestingModule = oldResetTestingModule;
TestBed.resetTestingModule();
});
您可能想尝试一下 ng-bullet。 它大大提高了 Angular 单元测试的执行速度。 还建议在官方 angular 回购问题中使用有关 Test Bed 单元测试性能的问题:https://github.com/angular/angular/issues/12409#issuecomment-425635583
重点是把每个测试文件的header中原来的beforeEach替换掉
beforeEach(async(() => {
// a really simplified example of TestBed configuration
TestBed.configureTestingModule({
declarations: [ /*list of components goes here*/ ],
imports: [ /* list of providers goes here*/ ]
})
.compileComponents();
}));
与configureTestSuite:
import { configureTestSuite } from 'ng-bullet';
...
configureTestSuite(() => {
TestBed.configureTestingModule({
declarations: [ /*list of components goes here*/ ],
imports: [ /* list of providers goes here*/ ]
})
});
我做了一个小函数,你可以用它来加快速度。它的效果类似于其他答案中提到的 ng-bullet
,但仍然会在测试之间清理服务,以便它们不会泄漏状态。函数是precompileForTests
, available in n-ng-dev-utils
.
像这样使用它(来自它的文档):
// let's assume `AppModule` declares or imports a `HelloWorldComponent`
precompileForTests([AppModule]);
// Everything below here is the same as normal. Just add the line above.
describe("AppComponent", () => {
it("says hello", async () => {
TestBed.configureTestingModule({ declarations: [HelloWorldComponent] });
await TestBed.compileComponents(); // <- this line is faster
const fixture = TestBed.createComponent(HelloWorldComponent);
expect(fixture.nativeElement.textContent).toContain("Hello, world!");
});
});
<head>
标签中的 <style>
,因为它们还负责内存 leak.Cleaning afterAll()
中的所有样式也大大提高了性能。
请阅读original post以供参考
2020 年 10 月更新
正在将 angular 应用程序升级到 Angular 9 进行了 大规模测试 运行 时间改进 ,
如果您想继续使用当前版本,以下软件包帮助我提高了测试性能:
Ng-bullet link
Ng-Bullet 是一个库,它增强了您使用 Angular TestBed 进行单元测试的体验,大大提高了测试的执行速度。
它会做的是它不会一直创建测试套件,而是会使用以前创建的套件,通过使用它,我已经看到 300% 改进的测试 运行s 然后之前。
在我的具体情况下,它会延迟,因为我们在我们的组件样式 'component.component.scss' 中导入我们的 styles.scss(这也导入其他巨大的样式),这会为每个组件模板生成递归样式。
为避免这种情况,请仅在您的组件中导入 scss 变量、mixin 和类似内容。
如果你正在使用 Angular 12.1+
(如果不是,那么最好迁移到新版本)那么最好的方法就是引入 teardown
属性 这将出人意料地提高单元测试的执行速度,因为以下原因:
- 主机元素已从 DOM 中删除
- 已从 DOM 中删除组件样式
- 应用程序范围的服务被破坏
- 使用任何提供程序范围的功能级服务被销毁
- Angular 模块被摧毁
- 组件被销毁
- 组件级服务被销毁
以上所有事情都会在每次单元测试执行后发生。
只需打开您的 test-main.ts
文件并输入以下代码:
getTestBed().initTestEnvironment(
BrowserDynamicTestingModule,
platformBrowserDynamicTesting(),
{ teardown: { destroyAfterEach: true } },
);