パーフェクトなテストのソリューションはありません。とはいえ、jestは優れたTypeScriptサポートを提供する素晴らしいユニットテストのオプションです。
注意：単純なノードのpackage.json setupで始めることを前提としています。また、すべてのTypeScriptファイルはsrcフォルダに置かれていなければなりません。このフォルダは、きれいなプロジェクト設定のために(Jestを使わなくても)常に推奨されます。
ステップ1：インストール
npmを使用して次をインストールします。
npm i jest @types/jest ts-jest -D
説明：
jestフレームワーク(jest)をインストールします
jestの型(@types/jest)をインストールします
Jest用のTypeScriptプリプロセッサ(ts-jest)をインストールします。これにより、Jestはその場でTypeScriptをトランスパイルすることができ、source-mapをサポートします
これらのすべてを、あなたのdevの依存関係に保存してください(テストはほとんど常にnpmのdev-dependencyです)
ステップ2：Jestを設定する
次のjest.config.jsファイルをプロジェクトのルートに追加します：
module.exports = {
"roots": [
"<rootDir>/src"
],
"testMatch": [
"**/__tests__/**/*.+(ts|tsx|js)",
"**/?(*.)+(spec|test).+(ts|tsx|js)"
],
"transform": {
"^.+\\.(ts|tsx)$": "ts-jest"
},
}
説明：
私達は_すべての_TypeScriptファイルをプロジェクトのsrcフォルダに入れることを常にお勧めします。また、これに倣いroots設定ではsrcフォルダを指定します。
testMatch設定は、ts/tsx/jsフォーマットで書かれた.test/.specファイルを発見するためのglobのパターンマッチャーです。
transform設定は、ts/tsxファイルに対してts-jestを使うようjestに指示します。
手順3：テストを実行する
あなたのプロジェクトのルートからnpx jestを実行すると、jestはあなたのテストを実行します。
オプション：npmスクリプトのスクリプトターゲットを追加する
package.jsonに追加してください：
これにより、簡単なnpm tでテストを実行できます。
また、npm t --watchのwatchモードでも。
オプション：watchモードでjestを実行する
例
export const sum
= (...a: number[]) =>
a.reduce((acc, val) => acc + val, 0);
import { sum } from '../foo';
test('basic', () => {
expect(sum()).toBe(0);
});
test('basic again', () => {
expect(sum(1, 2)).toBe(3);
});
ノート：
Jestは、グローバルなtest関数を提供します。
Jestには、グローバルなexpectの形でアサーションがあらかじめ組み込まれています。
Example async
Jestには、async/awaitサポートが組み込まれています。例えば:
test('basic', async () => {
expect(sum()).toBe(0);
});
test('basic again', async () => {
expect(sum(1, 2)).toBe(3);
}, 1000 /* optional timeout */);
enzymeの例
enzymeのDOMサポートは、Reactコンポーネントをテストすることができます。enzymeを設定するには3つのステップがあります：
enzyme、enzymeの型、より良いenzymeのスナップショットシリアライザ、あなたのreactバージョンのためのenzyme-adapter-reactをインストールします。npm i enzyme @types/enzyme enzyme-to-json enzyme-adapter-react-16 -D
"snapshotSerializers"と"setupTestFrameworkScriptFile"をjest.config.jsに追加します：
module.exports = {
// OTHER PORTIONS AS MENTIONED BEFORE
// Setup Enzyme
"snapshotSerializers": ["enzyme-to-json/serializer"],
"setupFilesAfterEnv": ["<rootDir>/src/setupEnzyme.ts"],
}
src/setupEnzyme.tsファイルを作成します。
import { configure } from 'enzyme';
import EnzymeAdapter from 'enzyme-adapter-react-16';
configure({ adapter: new EnzymeAdapter() });
次に、reactコンポーネントとテストの例を示します:
import * as React from 'react';
export class CheckboxWithLabel extends React.Component<{
labelOn: string,
labelOff: string
}, {
isChecked: boolean
}> {
constructor(props) {
super(props);
this.state = { isChecked: false };
}
onChange = () => {
this.setState({ isChecked: !this.state.isChecked });
}
render() {
return (
<label>
<input
type="checkbox"
checked={this.state.isChecked}
onChange={this.onChange}
/>
{this.state.isChecked ? this.props.labelOn : this.props.labelOff}
</label>
);
}
}
checkboxWithLabel.test.tsx：
import * as React from 'react';
import { shallow } from 'enzyme';
import { CheckboxWithLabel } from './checkboxWithLabel';
test('CheckboxWithLabel changes the text after click', () => {
const checkbox = shallow(<CheckboxWithLabel labelOn="On" labelOff="Off" />);
// Interaction demo
expect(checkbox.text()).toEqual('Off');
checkbox.find('input').simulate('change');
expect(checkbox.text()).toEqual('On');
// Snapshot demo
expect(checkbox).toMatchSnapshot();
});
私たちがjestを好きな理由
