以下是我假定那些極少或壓根沒寫單元測試的人準備的,因此,會白話解釋諸多概念性問題,同時會結合 Jasmine 與之對應的方法進行講解。
一、概念
Test Suite
測試套件,哪怕一個簡單的類,也會有若干的測試用例,因此將這些測試用例集合在一個分類下就叫Test Suite。
而在 Jasmine 就是使用 describe 全局函數來表示,它的第一個字符串參數用來表示Suite的名稱或標題,第二個方法參數就是實現Suite代碼了。
describe('test suite name', () => {
});
Specs
一個Specs相當于一個測試用例,也就是我們實現測試具體代碼體。
Jasmine 就是使用 it 全局函數來表示,和 describe 類似,字符串和方法兩個參數。
而每個 Spec 內包括多個 expectation 來測試需要測試的代碼,只要任何一個 expectation 結果為 false 就表示該測試用例為失敗狀態(tài)。
describe('demo test', () => {
const VALUE = true;
it('should be true', () => {
expect(VALUE).toBe(VALUE);
})
});
Expectations
斷言,使用 expect 全局函數來表示,只接收一個代表要測試的實際值,并且需要與 Matcher 代表期望值。
二、常用方法
Matchers
斷言匹配操作,在實際值與期望值之間進行比較,并將結果通知Jasmine,最終Jasmine會判斷此 Spec 成功還是失敗。
Jasmine 提供非常豐富的API,一些常用的Matchers:
-
toBe()等同=== - toNotBe() 等同
!== - toBeDefined() 等同
!== undefined - toBeUndefined() 等同
=== undefined - toBeNull() 等同
=== null - toBeTruthy() 等同
!!obj - toBeFalsy() 等同
!obj - toBeLessThan() 等同
< - toBeGreaterThan() 等同
> - toEqual() 相當于
== - toNotEqual() 相當于
!= - toContain() 相當于
indexOf - toBeCloseTo() 數值比較時定義精度,先四舍五入后再比較。
- toHaveBeenCalled() 檢查function是否被調用過
- toHaveBeenCalledWith() 檢查傳入參數是否被作為參數調用過
- toMatch() 等同
new RegExp().test() - toNotMatch() 等同
!new RegExp().test() - toThrow() 檢查function是否會拋出一個錯誤
而這些API之前用 not 來表示負值的判斷。
expect(true).not.toBe(false);
這些Matchers幾乎可以滿足我們日常需求,當然你也可以定制自己的Matcher來實現特殊需求。
Setup 與 Teardown
一份干將的測試代碼很重要,因此我們可以將這些重復的 setup 與 teardown 代碼,放在與之相對應的 beforeEach 與 afterEach 全局函數里面。
beforeEach 表示每個 Spec 執(zhí)行之前,反之。
describe('demo test', () => {
let val: number = 0;
beforeEach(() => {
val = 1;
});
it('should be true', () => {
expect(val).toBe(1);
});
it('should be false', () => {
expect(val).not.toBe(0);
});
});
數據共享
如同上面示例中,我們可以在每個測試文件開頭、describe 來定義相應的變量,這樣每個 it 內部可以共享它們。
當然,每個 Spec 的執(zhí)行周期間也會伴隨著一個空的 this 對象,直至 Spec 執(zhí)行結束后被清空,利用 this 也可以做數據共享。
嵌套代碼
有時候當我們對某個組件進行測試時,而這個組件會有不同狀態(tài)來展示不同的結果,這個時候如果只用一個 describe 會顯得不過優(yōu)雅。
因此,嵌套 describe,會讓測試代碼、測試報告看起來更漂亮。
describe('AppComponent', () => {
describe('Show User', () => {
it('should be show panel.', () => {});
it('should be show avatar.', () => {});
});
describe('Hidden User', () => {
it('should be hidden panel.', () => {});
});
});
跳過測試代碼塊
需求總是三心二意的,但好不容易寫好的測試代碼,難道要刪除嗎?非也……
Suites 和 Specs 分別可以用 xdescribe 和 xit 全局函數來跳過這些測試代碼塊。
三、配合Angular工具集
Spy
Angular的自定義事件實在太普遍了,但為了測試這些自定義事件,因此監(jiān)控事件是否正常被調用是非常重要。好在,Spy 可以用于監(jiān)測函數是否被調用,這簡直就是我們的好伙伴。
以下示例暫時無須理會,暫且體驗一下:
describe('AppComponent', () => {
let fixture: ComponentFixture<TestComponent>;
let context: TestComponent;
beforeEach(() => {
TestBed.configureTestingModule({
declarations: [TestComponent]
});
fixture = TestBed.createComponent(TestComponent);
context = fixture.componentInstance;
// 監(jiān)聽onSelected方法
spyOn(context, 'onSelected');
fixture.detectChanges();
});
it('should be called [selected] event.', () => {
// 觸發(fā)selected操作
// 斷言是否被調用過
expect(context.onSelected).toHaveBeenCalled();
});
});
異步支持
首先,這里的異步是指帶有 Observable 或 Promise 的異步行為,因此對于組件在調用某個 Service 來異步獲取數據時的測試狀態(tài)。
假設我們的待測試組件代碼:
export class AppComponent {
constructor(private _user: UserService) {}
query() {
this._user.quer().subscribe(() => {});
}
}
async
async 無任何參數與返回值,所有包裹代碼塊里的測試代碼,可以通過調用 whenStable() 讓所有待處理異步行為都完成后再進行回調;最后,再進行斷言操作。
it('should be get user list (async)', async(() => {
// call component.query();
fixture.whenStable().then(() => {
fixture.detectChanges();
expect(true).toBe(true);
});
}));
fakeAsync
如果說 async 還需要回調才能進行斷點讓你受不了的話,那么 fakeAsync 可以解決這一點。
it('should be get user list (async)', fakeAsync(() => {
// call component.query();
tick();
fixture.detectChanges();
expect(true).toBe(true);
}));
這里只是將回調換成 tick(),怎么樣,是不是很酷。
Jasmine自帶異步
如前面所說的異步是指帶有 Observable 或 Promise 的異步行為,而有時候我們有些東西是依賴 setTimeout 或者可能是需要外部訂閱結果以后才能觸發(fā)時怎么辦呢?
可以使用 done() 方法。
it('async demo', (done: () => void) => {
context.show().subscribe(res => {
expect(true).toBe(true);
done();
});
el.querySelected('xxx').click();
});
四、結論
本章幾乎所有的內容在Angular單元測試經常使用到的東西;特別是異步部分,三種不同異步方式并非共存的,而是需要根據具體業(yè)務而采用。否則,你會發(fā)現真TM難寫單元測試。畢竟這是一個異步的世界。
自此,我們算是為Angular寫單元測試打下了基礎。后續(xù),將不會再對這類基礎進行解釋。
那么下一篇,我們將介紹Component、Directive、Pipe 以及Service單元測試。
happy coding!