前端測試框架Jest系列教程 -- Global Functions(全域性函式)
寫在前面:
Jest中定義了很多全域性性的Function供我們使用,我們不必再去引用別的包來去實現類似的功能,下面將列舉Jest中實現的全域性函式。
Jest Global Functions
afterAll(fn, timeout)
從字面意思就可以理解到它是在所有測試執行完之後才會執行的,如果你的測試中包含promise,則將會等待promise被驗證之後被執行。
你還可以提供一個timeout的引數(以毫秒為單位),用於指定在終止前等待的時間。注意:預設的超時是5秒。
如果您想要清理一些跨測試共享的全域性設定狀態,這通常是有用的。
const globalDatabase = makeGlobalDatabase();function cleanUpDatabase(db) { db.cleanUp(); } afterAll(() => { cleanUpDatabase(globalDatabase); }); test('can find things', () => { return globalDatabase.find('thing', {}, results => { expect(results.length).toBeGreaterThan(0); }); }); test('can insert a thing', () => {return globalDatabase.insert('thing', makeThing(), response => { expect(response.success).toBeTruthy(); }); });
在這裡,afterAll確保在所有測試執行後呼叫cleanUpDatabase。
如果在描述塊內部,它在描述塊的末尾執行。
如果你想在每次測試之後執行一些清理,而不是在所有測試之後,使用afterEach代替。
afterEach(fn, timeout)
在該檔案中的每一個測試完成後執行一個函式。如果函式返回一個promise,Jest會等待該promise在繼續之前解決。
你還可以提供一個超時(以毫秒為單位),用於指定在終止前等待的時間。注意:預設的超時是5秒。
如果您想清除每個測試建立的臨時狀態,這通常是有用的。
const globalDatabase = makeGlobalDatabase(); function cleanUpDatabase(db) { db.cleanUp(); } afterEach(() => { cleanUpDatabase(globalDatabase); }); test('can find things', () => { return globalDatabase.find('thing', {}, results => { expect(results.length).toBeGreaterThan(0); }); }); test('can insert a thing', () => { return globalDatabase.insert('thing', makeThing(), response => { expect(response.success).toBeTruthy(); }); });
在這裡,afterEach確保在每次測試執行後呼叫cleanUpDatabase。
如果每個都在一個描述塊內,它只在這個描述塊內的測試之後執行。
如果你只想在執行完所有測試之後執行一些清理工作,那麼使用afterAll代替。
beforeAll(fn, timeout)
在該檔案執行的任何測試之前執行一個函式。如果函式返回一個承諾,則Jest會等待在執行測試之前解決這個問題。
你還可以提供一個超時(以毫秒為單位),用於指定在終止前等待的時間。注意:預設的超時是5秒。
如果你想設定一些將被許多測試使用的全域性狀態,這通常是有用的。
const globalDatabase = makeGlobalDatabase(); beforeAll(() => { // Clears the database and adds some testing data. // Jest will wait for this promise to resolve before running tests. return globalDatabase.clear().then(() => { return globalDatabase.insert({testData: 'foo'}); }); }); // Since we only set up the database once in this example, it's important // that our tests don't modify it. test('can find things', () => { return globalDatabase.find('thing', {}, results => { expect(results.length).toBeGreaterThan(0); }); });
在這裡,beforeAll確保在測試執行之前建立資料庫。
如果設定是同步的,那麼你可以在沒有以前的情況下這樣做。關鍵是Jest將等待一個promise來解決,因此你也可以擁有非同步設定。
如果beforeAll在一個描述塊中,它在描述塊的開始處執行。 如果你想在每次測試之前執行一些東西,而不是在任何測試之前執行,那麼請在每個測試之前使用。
beforeEach(fn, timeout)
在該檔案執行的每個測試之前執行一個函式。如果函式返回一個promise,Jest將等待該承諾在執行測試之前解決。
你還可以提供一個超時(以毫秒為單位),用於指定在終止前等待的時間。注意:預設的超時是5秒。
如果你想要重置一些將被許多測試所使用的全域性狀態,這通常是有用的。
const globalDatabase = makeGlobalDatabase(); beforeEach(() => { // Clears the database and adds some testing data. // Jest will wait for this promise to resolve before running tests. return globalDatabase.clear().then(() => { return globalDatabase.insert({testData: 'foo'}); }); }); test('can find things', () => { return globalDatabase.find('thing', {}, results => { expect(results.length).toBeGreaterThan(0); }); }); test('can insert a thing', () => { return globalDatabase.insert('thing', makeThing(), response => { expect(response.success).toBeTruthy(); }); });
在此之前,每個測試都要重置資料庫。
如果在一個描述塊內部,它執行在描述塊中的每個測試。
如果你只需要執行一些設定程式碼,在任何測試執行之前,就使用之前的所有程式碼。
describe(name, fn)
describe(name, fn)建立一個塊,在一個“測試套件”中,將幾個相關的測試組合在一起。
const myBeverage = { delicious: true, sour: false, }; describe('my beverage', () => { test('is delicious', () => { expect(myBeverage.delicious).toBeTruthy(); }); test('is not sour', () => { expect(myBeverage.sour).toBeFalsy(); }); });
這不是必需的——你可以直接在頂層編寫測試塊。但是,如果您希望將測試組織成組,那麼這就很方便了。
const binaryStringToNumber = binString => { if (!/^[01]+$/.test(binString)) { throw new CustomError('Not a binary number.'); } return parseInt(binString, 2); }; describe('binaryStringToNumber', () => { describe('given an invalid binary string', () => { test('composed of non-numbers throws CustomError', () => { expect(() => binaryStringToNumber('abc')).toThrowError(CustomError); }); test('with extra whitespace throws CustomError', () => { expect(() => binaryStringToNumber(' 100')).toThrowError(CustomError); }); }); describe('given a valid binary string', () => { test('returns the correct number', () => { expect(binaryStringToNumber('100')).toBe(4); }); }); });
describe.only(name, fn)
如果你只想執行一次模組測試的話你可以使用 only
describe.only('my beverage', () => { test('is delicious', () => { expect(myBeverage.delicious).toBeTruthy(); }); test('is not sour', () => { expect(myBeverage.sour).toBeFalsy(); }); }); describe('my other beverage', () => { // ... will be skipped });
describe.skip(name, fn) describe 等價於 xdescribe
你可以使用skip 跳過某一個測試
describe('my beverage', () => { test('is delicious', () => { expect(myBeverage.delicious).toBeTruthy(); }); test('is not sour', () => { expect(myBeverage.sour).toBeFalsy(); }); }); describe.skip('my other beverage', () => { // ... will be skipped });
使用跳過通常只是一種比較簡單的替代方法,如果不想執行則可以暫時將大量的測試註釋掉。
require.requireActual(moduleName)
返回實際的模組而不是模擬,繞過所有檢查模組是否應該接收模擬實現。
require.requireMock(moduleName)
返回一個模擬模組,而不是實際的模組,繞過所有檢查模組是否正常。
test(name, fn, timeout) 等價於 it(name, fn, timeout)
在測試檔案中,您所需要的是執行測試的測試方法。例如,假設有一個函式inchesOfRain()應該是零。你的整個測試可以是:
test('did not rain', () => { expect(inchesOfRain()).toBe(0); });
第一個引數是測試名稱;第二個引數是包含測試期望的函式。第三個引數(可選)是超時(以毫秒為單位),用於指定在中止前等待多長時間。注意:預設的超時是5秒。
注意:如果測試返回了一個promise,Jest會在測試完成之前等待promise。Jest還將等待,如果你為測試函式提供一個引數,通常稱為done。當你想要測試回撥時,這將非常方便。請參見如何在此測試非同步程式碼。
例如,假設fetchBeverageList()返回一個承諾,該承諾將解析到其中有lemon的列表。你可以用:
test('has lemon in it', () => { return fetchBeverageList().then(list => { expect(list).toContain('lemon'); }); });
即使對測試的呼叫會立即返回,測試也不會完成,直到promise解決。
test.only(name, fn, timeout)等同於
it.only(name, fn, timeout)
or fit(name, fn, timeout)
在除錯大型程式碼庫時,通常只希望執行一個子集的測試。您可以使用。只指定哪些測試是您想要執行的。
您還可以提供一個超時(以毫秒為單位),用於指定在終止前等待的時間。注意:預設的超時是5秒。
test.only('it is raining', () => { expect(inchesOfRain()).toBeGreaterThan(0); }); test('it is not snowing', () => { expect(inchesOfSnow()).toBe(0); });
只有“it is raining”測試才會執行,因為它是用test執行的。
通常你不會使用測試來檢查程式碼。只有在原始碼控制中——您將僅用於除錯,並在修復了故障測試後刪除它。
test.skip(name, fn)等同於
it.skip(name, fn)
or xit(name, fn)
or xtest(name, fn)
當您維護一個大型的程式碼庫時,您可能有時會發現由於某種原因而臨時中斷的測試。
如果您想跳過這個測試,但是您不想僅僅刪除這個程式碼,您可以使用skip指定一些測試來跳過。
test('it is raining', () => { expect(inchesOfRain()).toBeGreaterThan(0); }); test.skip('it is not snowing', () => { expect(inchesOfSnow()).toBe(0); });
只有“it is raining”測試執行,因為另一個測試執行test . skip。 您可以簡單地對測試進行註釋,但是使用skip會更好一些,因為它將保持縮排和語法突出。
寫在最後:
本文介紹了一些Jest中的全域性函式,可以在任意地方方便的使用。