Jest(測試框架)
1、什么是Jest
官方文檔:https://jestjs.io/docs/en/getting-started
- Jest是 Facebook 的一套開源的 JavaScript 測試框架
- 它對同樣是 Facebook 的開源前端框架 React 的測試十分友好。
- 它適用但不局限于使用以下技術的項目:Babel, TypeScript, Node, React, Angular, Vue;
2、安裝Jest
-
安裝Jest及相關依賴
yarn add --dev jest npm install --save-dev jest babel-jest babel-core babel-preset-env regenerator-runtimebabel-jest、 babel-core、 regenerator-runtime、babel-preset-env這幾個依賴是為了可以使用ES6的語法特性進行單元測試
ES6提供的 import 來導入模塊的方式,Jest本身是不支持的 -
添加babel.config.js文件
module.exports = function (api) { api.cache(false); if (process.env.NODE_ENV === "test") { console.log("env: " + process.env.NODE_ENV); return { presets: [ "@babel/preset-react", [ "@babel/preset-env", { targets: { "node": process.versions.node }, "modules": "auto", }, "jest", ] ], "plugins": [ ["@babel/plugin-proposal-decorators", {legacy: true}], [ "@babel/plugin-proposal-class-properties", {loose: true} ], "@babel/plugin-proposal-object-rest-spread", //*對象rest、spread語法處理 "@babel/plugin-transform-object-assign", //* "@babel/plugin-syntax-dynamic-import", //import()語法處理 "@babel/plugin-transform-runtime", //自動引入輔助函數 "@babel/plugin-transform-modules-commonjs" //* ] }; } ..... }Babel的配置取決于具體的項目使用場景, 這里根據 NODE_ENV 參數做了區(qū)分
-
修改package.json中的test腳本
"scripts": { ... "test": "jest", "test:watch": "npm test -- --watch", "test:coverage": "jest --coverage", } -
開始編寫測試用例
demo:test('測試1+2=3', () => { expect(1+2).toBe(3) }) -
測試
npm run test npm run test:watch npm run test -- src/static/js/__tests__/demo.test.js npm run test -- src/static/js/__tests__/demo.test.js -u //--updateSnapshot(更新快照)
3、斷言(matchers)
Jest提供了expect函數用來包裝被測試的方法并返回一個對象,該對象中包含了一系列的匹配器來讓我們更方便的進行斷言
- 使用expect及 "matcher" 函數來斷言某個值
expect({a:1}).toBe({a:1}) //判斷兩個對象是否相等 expect(1).not.toBe(2) //判斷不等 expect(n).toBeNull(); //判斷是否為null expect(n).toBeUndefined(); //判斷是否為undefined expect(n).toBeDefined(); //判斷結果與toBeUndefined相反 expect(n).toBeTruthy(); //判斷結果為true expect(n).toBeFalsy(); //判斷結果為false expect(value).toBeGreaterThan(3); //大于3 expect(value).toBeGreaterThanOrEqual(3.5); //大于等于3.5 expect(value).toBeLessThan(5); //小于5 expect(value).toBeLessThanOrEqual(4.5); //小于等于4.5 expect(value).toBeCloseTo(0.3); // 浮點數判斷相等 expect('Christoph').toMatch(/stop/); //正則表達式判斷 expect(['one','two']).toContain('one'); //數組中是否含有某個元素 expect(fn).toHaveBeenCalled(); expect([1, 2, 3]).toHaveLength(3); expect('grapefruit111').toMatch(/grapefruit/); expect(drinkOctopus).toThrowError('yuck, octopus flavor'); /判斷函數拋出的錯誤 - expect可以擴展,使用expect.extend
expect.extend({ toNaN(received, argument) { if (isNaN(received)) { return { message: () => ( `expected ${received} is NaN` ), pass: true, }; } else { return { message: () => ( `expected ${received} not NaN` ), pass: false, }; } }, }); test('even and odd numbers', () => { expect('d').toNaN(); });
4、Mock功能
在單元測試中,我們可能并不需要關心內部調用的方法的執(zhí)行過程和結果,只想知道它是否被正確調用即可,甚至會指定該函數的返回值。此時,使用Mock函數是十分有必要。
demo:
// 函數
function callback() {
......
}
function forEach(items, callback) {
for (let index = 0; index < items.length; index++) {
callback(items[index]);
}
}
//函數 測試用例
const mockCallback = jest.fn();
forEach([0, 1], mockCallback);
expect(mockCallback.mock.calls.length).toBe(2); // 此模擬函數被調用了兩次
expect(mockCallback.mock.calls[0][0]).toBe(0); // 第一次調用函數時的第一個參數是 0
expect(mockCallback.mock.calls[1][0]).toBe(1); //第二次調用函數時的第一個參數是 1
參考鏈接:https://testerhome.com/topics/15149
5、JSDom
Jest在nod環(huán)境下運行,node不具備dom,jest在node環(huán)境下自己模擬了一套dom
- 安裝jquery, 執(zhí)行 npm i jquery ,并引入.
- 寫測試用例時,可以追溯dom節(jié)點來進行測試.
import addDivToBody from './demo';
import $ from 'jquery';
test('測試 addDivToBody', () => {
addDivToBody();
addDivToBody();
expect($('body').find('div').length).toBe(2);
})
6、快照測試 Snapshot Testing
快照是什么
通常涉及UI的自動化測試,思路是把某一時刻的標準狀態(tài)拍個快照,在測試回歸的時候進行pixel to pixel的對比
Jest對React組件的快照有所不同
- 把一個組件給序列化成純文本, 純文本的比較
- 對于一個React組件而言, 傳入相同的props,我們是期望得到相同的輸出, 這樣一來,通過構造不同的props, 我們即有了不同的測試用例
- 理想狀態(tài)中,組件若是無內部狀態(tài)變化,測試用例覆蓋率應該可以達到100%了
Jest 可以在首次執(zhí)行時可以自動生成快照樣本,當測試代碼有變化時,還可以通過 jest -u 來更新樣本。 生成的樣本會放在測試文件同級目錄下的 __snapshots__ 文件夾中。
Demo
// Link.react-test.js
import React from 'react';
import Link from '../Link.react';
import renderer from 'react-test-renderer';
it('renders correctly', () => {
const tree = renderer.create(
<Link page="http://www.facebook.com">Facebook</Link>
).toJSON();
expect(tree).toMatchSnapshot();
});
首次執(zhí)行,就會生成一個快照文件,在snapshots目錄下,在之后的toMatchSnapshot()調用就會與之比較,如有不同,則是用例失敗,會打印出具體差異
參考鏈接:https://imweb.io/topic/592aab6eff03ef1a4ef15c51
7、配置Jest
jest幾乎是零配置的,但是接入到項目時需要加幾個配置
- 生成一個基礎配置文件 jest.config.js
jest --init ./node_modules/.bin/jest --init - 配置項介紹
module.exports = {
"globals": { "NODE_ENV": "test" }, //變量設置
roots: ["<rootDir>"], //默認路徑
moduleDirectories:[], //從需要的位置開始遞歸搜索的目錄名
moduleFileExtensions:["js", "json", "jsx", "scss", "css"], //模塊使用到的擴展名
moduleNameMapper:[], //需要手動mock的模塊名映射表,我理解為別名
modulePathIgnorePatterns: [], //列出的模塊忽略
setupFilesAfterEnv: [], //所有用例之前執(zhí)行的js,初始化操作
testEnvironment:'node', //測試環(huán)境 node
testPathIgnorePatterns: [], //測試需要忽略的文件 (好像沒起作用)
testMatch:[], //測試文件的格式
transform: [],
transformIgnorePatterns: [],
verbose:true, //是否每一個測試都需要報告
// snapshotSerializers: 快照序列化,enzyme-to-json包需要安裝依賴
}
- 配置過程中遇到的問題
8、覆蓋率報告
https://stackoverflow.com/questions/26618243/how-do-i-read-an-istanbul-coverage-report
- Statement coverage (每條語名)
- Branch coverage(控制結構的分支)
- Function coverage (每個函數)
- Line coverage(每個可執(zhí)行行)
9、特點
- 測試用例并行執(zhí)行,更高效
- 強大的 Mock 功能
- 內置的代碼覆蓋率檢查,不需要在引入額外的工具
- 集成 JSDOM,可以直接進行 DOM 相關的測試
- 配置簡單
- 有快照測試功能,可對 React 等框架進行 UI 測試
- 它自動集成了斷言、JSDom、覆蓋率報告等開發(fā)者所需要的所有測試工具
Enzyme(React的測試類庫)
1、介紹
工具函數庫的封裝,可以處理淺渲染(shallow),靜態(tài)渲染標記(render)以及DOM渲染(mount),jQuery 風格的API
2、Enzyme配置
npm install --save-dev react-test-renderer enzyme enzyme-adapter-react-16.2 enzyme-to-json
3、淺渲染 Shallow
將一個組件渲染成虛擬 DOM 對象,但是只渲染第一層,不渲染所有子組件,淺渲染是不依賴 DOM 環(huán)境的
import { shallow } from 'enzyme';
describe('Enzyme Shallow', function () {
it('test1', function () {
let app = shallow(<App/>);
expect(app.find('h1').text()).to.equal('Todos');
});
};
4、靜態(tài)渲染 render
將React組件渲染成靜態(tài)的HTML字符串,然后分析這段HTML代碼的結構,返回一個對象。它跟shallow方法非常像,主要的不同是采用了第三方HTML解析庫Cheerio,它返回的是一個Cheerio實例對象。
Cheerio:實現(xiàn)了jQuery的一個子集,去掉了jQuery中所有與DOM不一致或者是用來填瀏覽器的坑的東西,重現(xiàn)了jQueryAPI
import {render} from 'enzyme';
describe('Enzyme Render', function () {
it('test2', function () {
let app = render(<App/>);
expect(app.find('.todo-done').length).to.equal(0);
});
});
Enzyme的設計就是,讓不同的底層處理引擎,都具有同樣的API(比如find方法)
5、DOM渲染 mount
mount方法用于將React組件加載為真實DOM節(jié)點
6、API
.get(index):返回指定位置的子組件的DOM節(jié)點
.at(index):返回指定位置的子組件
.first():返回第一個子組件
.last():返回最后一個子組件
.type():返回當前組件的類型
.text():返回當前組件的文本內容
.html():返回當前組件的HTML代碼形式
.props():返回根組件的所有屬性
.prop(key):返回根組件的指定屬性
.state([key]):返回根組件的狀態(tài)
.setState(nextState):設置根組件的狀態(tài)
.setProps(nextProps):設置根組件的屬性
參考鏈接
- 介紹和基本使用
https://juejin.im/post/5de5fdd3e51d452515148083 - react測試用例編寫包括 action/reducer/components
https://www.redux.org.cn/docs/recipes/WritingTests.html - 覆蓋率報告
https://stackoverflow.com/questions/26618243/how-do-i-read-an-istanbul-coverage-report - Mock的使用
https://testerhome.com/topics/15149 - 快照
https://imweb.io/topic/592aab6eff03ef1a4ef15c51