なぜテストするのか?
テストがあなたの生活にもたらす喜びを除けば、テストは私たちのアプリケーションが期待通りに動作することを保証するだけでなく、コードの使い方の簡潔な例を提供するためにも重要です。
テストは私たちのコードベースの一部でもあるため、私たちはそれらに対してアプリケーションコード全体に適用するのと同じ基準を適用します。
すべてのコードと同様に、テストもメンテナンスが必要です。テストを持つためだけにテストを書くことが目的ではありません。むしろ、期待される動作と予期しない動作をカバーし、迅速な実行とコードのメンテナンスの間で適切なバランスを取ることを目指すべきです。
テストを書く際には、次の点を考慮してください:
- どの動作をテストしていますか?
- このコードを実行したときに発生する可能性のあるエラーは何ですか?
- テストは私たちが考えていることをテストしていますか?それとも偽のポジティブ/ネガティブを導入していますか?
- 読みやすいですか?他の貢献者は、対応するテストを見て私たちのコードがどのように動作するかを理解できますか?
JavaScriptのテスト
JavaScriptのテストは、テストランナーとしてJestを使用し、グローバルのAPI(describe
、test
、beforeEach
など)アサーション、モック、スパイ、およびモック関数を使用します。必要に応じて、ReactコンポーネントのテストにはReact Testing Libraryを使用することもできます。
過去には、ReactコンポーネントはEnzymeでユニットテストされていましたが、現在はすべての既存および新しいテストにReact Testing Library (RTL)が使用されています。
Nodeとプロジェクトの依存関係をインストールするための指示に従ったと仮定すると、テストはNPMを使用してコマンドラインから実行できます:
npm test
リントは、コーディング標準を強制し、潜在的なエラーを回避するために使用される静的コード分析です。このプロジェクトでは、ESLintとTypeScriptのJavaScript型チェックを使用してこれらの問題をキャッチします。上記のnpm test
はユニットテストとコードリントの両方を実行しますが、コードリントはnpm run lint
を実行することで独立して確認できます。一部のJavaScriptの問題は、npm run lint:js:fix
を実行することで自動的に修正できます。
開発者のワークフローを改善するために、エディタのリント統合を設定するべきです。詳細については、はじめにのドキュメントを参照してください。
リントなしでユニットテストのみを実行するには、npm run test:unit
を使用してください。
フォルダ構造
テストは作業ディレクトリのtest
フォルダに保管してください。テストファイルはテスト対象ファイルと同じ名前であるべきです。
+-- test
| +-- bar.js
+-- bar.js
テストファイル(少なくとも1つのテストケースを含む)は/test
の直下にのみ存在する必要があります。外部モックやフィクスチャを追加する必要がある場合は、サブフォルダに配置してください。例えば:
テストのインポート
前述のフォルダ構造を考慮して、テストしているコードをインポートする際には、プロジェクトパスを使用するのではなく、相対パスを使用するようにしてください。
良い例
import { bar } from '../bar';
あまり良くない例
import { bar } from 'components/foo/bar';
アプリケーションディレクトリ内の別の位置にコードを移動することにした場合、これによりあなたの生活が楽になります。
テストの説明
テストケースでは、期待される動作を平易な言葉で説明するようにしてください。UIコンポーネントの場合、これはユーザーの視点から期待される動作を説明することを含むかもしれません。
**良い例**
``````bash
describe( 'CheckboxWithLabel', () => {
test( 'checking checkbox should disable the form submit button', () => {
...
} );
} );
`
あまり良くない例
describe( 'CheckboxWithLabel', () => {
test( 'checking checkbox should set this.state.disableButton to `true`', () => {
...
} );
} );
セットアップとティアダウンメソッド
Jest APIには、各テストまたはすべてのテスト、または特定のdescribe
ブロック内のテストの前と後にタスクを実行できる便利なセットアップとティアダウンメソッドが含まれています。
これらのメソッドは、通常インラインで行うことができないセットアップを可能にするために非同期コードを処理できます。個別のテストケースと同様に、Promiseを返すことができ、Jestはそれが解決されるのを待ちます:
// one-time setup for *all* tests
beforeAll( () =>
someAsyncAction().then( ( resp ) => {
window.someGlobal = resp;
} )
);
// one-time teardown for *all* tests
afterAll( () => {
window.someGlobal = null;
} );
アサーションの後にクリーンアップコードを配置することは避けてください。なぜなら、もしそれらのテストのいずれかが失敗した場合、クリーンアップは行われず、無関係なテストで失敗を引き起こす可能性があるからです。
<a name="mocking-dependencies"></a>
### 依存関係のモック
#### 依存性注入
関数に引数として依存関係を渡すことで、コードをテストしやすくすることができます。可能な限り、高いスコープで依存関係を参照することは避けてください。
**あまり良くない例**
``````bash
import VALID_VALUES_LIST from './constants';
function isValueValid( value ) {
return VALID_VALUES_LIST.includes( value );
}
`
ここでは、VALID_VALUES_LIST
から値をインポートして使用する必要があります。
expect( isValueValid( VALID_VALUES_LIST[ 0 ] ) ).toBe( true );
上記のアサーションは、2つの動作をテストしています:1)関数がリスト内のアイテムを検出できること、2)VALID_VALUES_LIST
内のアイテムを検出できることです。
しかし、VALID_VALUES_LIST
に何が保存されているか、またはリストがHTTPリクエストを介して取得される場合、isValueValid
がリスト内のアイテムを検出できるかどうかだけをテストしたい場合はどうでしょうか?
良い例
function isValueValid( value, validValuesList = [] ) {
return validValuesList.includes( value );
}
リストを引数として渡すことで、テスト内でモックvalidValuesList
値を渡すことができ、さらにいくつかのシナリオをテストできます:
expect( isValueValid( 'hulk', [ 'batman', 'superman' ] ) ).toBe( false );
expect( isValueValid( 'hulk', null ) ).toBe( false );
expect( isValueValid( 'hulk', [] ) ).toBe( false );
expect( isValueValid( 'hulk', [ 'iron man', 'hulk' ] ) ).toBe( true );
インポートされた依存関係
私たちのコードは、インポートされた外部および内部ライブラリのメソッドやプロパティを複数の場所で使用することが多く、引数を渡すのが煩雑で実用的ではありません。これらのケースでは、jest.mock
がこれらの依存関係をスタブするための便利な方法を提供します。
例えば、config
モジュールが多くの機能をフィーチャーフラグを介して制御することを想定しましょう。
// bilbo.js
import config from 'config';
export const isBilboVisible = () =>
config.isEnabled( 'the-ring' ) ? false : true;
各条件下での動作をテストするために、設定オブジェクトをスタブし、isEnabled
の戻り値を制御するためにjestモッキング関数を使用します。
// test/bilbo.js
import { isEnabled } from 'config';
import { isBilboVisible } from '../bilbo';
jest.mock( 'config', () => ( {
// bilbo is visible by default
isEnabled: jest.fn( () => false ),
} ) );
describe( 'The bilbo module', () => {
test( 'bilbo should be visible by default', () => {
expect( isBilboVisible() ).toBe( true );
} );
test( 'bilbo should be invisible when the `the-ring` config feature flag is enabled', () => {
isEnabled.mockImplementationOnce( ( name ) => name === 'the-ring' );
expect( isBilboVisible() ).toBe( false );
} );
} );
グローバルのテスト
グローバルメソッドを呼び出すコードをテストするためにJestスパイを使用できます。
import { myModuleFunctionThatOpensANewWindow } from '../my-module';
describe( 'my module', () => {
beforeAll( () => {
jest.spyOn( global, 'open' ).mockImplementation( () => true );
} );
test( 'something', () => {
myModuleFunctionThatOpensANewWindow();
expect( global.open ).toHaveBeenCalled();
} );
} );
ユーザーインタラクション
ユーザーインタラクションをシミュレートすることは、ユーザーの視点からテストを書く素晴らしい方法であり、したがって実装の詳細をテストすることを避けることができます。
Testing Libraryを使用してテストを書く際には、ユーザーインタラクションをシミュレートするための2つの主な代替手段があります:
- 1.
fireEvent
API、Testing LibraryのコアAPIの一部であるDOMイベントを発火させるためのユーティリティ。 - 2.
user-event
ライブラリ、ブラウザでインタラクションが行われた場合に発生するイベントをディスパッチすることによってユーザーインタラクションをシミュレートするTesting Libraryの補助ライブラリ。
組み込みのfireEvent
は、DOMイベントをディスパッチするためのユーティリティです。これは、テスト仕様で説明されているイベントを正確にディスパッチします。実際のブラウザでのインタラクションでその正確なイベントがディスパッチされなかった場合でもです。
一方、user-event
ライブラリは、ユーザーがドキュメントと対話した場合に発生するようにイベントをディスパッチする高レベルのメソッド(例:type
、selectOptions
、clear
、doubleClick
…)を公開し、React特有の特異性に対処します。
上記の理由から、ユーザーインタラクションのテストを書く際にはuser-event
ライブラリが推奨されます。
あまり良くない例:fireEvent
を使用してDOMイベントをディスパッチすること。
import { render, screen } from '@testing-library/react';
test( 'fires onChange when a new value is typed', () => {
const spyOnChange = jest.fn();
// A component with one `input` and one `select`.
render( <MyComponent onChange={ spyOnChange } /> );
const input = screen.getByRole( 'textbox' );
input.focus();
// No clicks, no key events.
fireEvent.change( input, { target: { value: 62 } } );
// The `onChange` callback gets called once with '62' as the argument.
expect( spyOnChange ).toHaveBeenCalledTimes( 1 );
const select = screen.getByRole( 'listbox' );
select.focus();
// No pointer events dispatched.
fireEvent.change( select, { target: { value: 'optionValue' } } );
// ...
良い例:user-event
を使用してユーザーイベントをシミュレートすること。
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
test( 'fires onChange when a new value is typed', async () => {
const user = userEvent.setup();
const spyOnChange = jest.fn();
// A component with one `input` and one `select`.
render( <MyComponent onChange={ spyOnChange } /> );
const input = screen.getByRole( 'textbox' );
// Focus the element, select and delete all its contents.
await user.clear( input );
// Click the element, type each character separately (generating keydown,
// keypress and keyup events).
await user.type( input, '62' );
// The `onChange` callback gets called 3 times with the following arguments:
// - 1: clear ('')
// - 2: '6'
// - 3: '62'
expect( spyOnChange ).toHaveBeenCalledTimes( 3 );
const select = screen.getByRole( 'listbox' );
// Dispatches events for focus, pointer, mouse, click and change.
await user.selectOptions( select, [ 'optionValue' ] );
// ...
} );
ブロックUIの統合テスト
統合テストは、異なる部分がグループとしてテストされるテストの一種として定義されます。この場合、テストしたい部分は、特定のブロックまたはエディターロジックのためにレンダリングされる必要がある異なるコンポーネントです。最終的には、これらはユニットテストと非常に似ており、Jestライブラリを使用して同じコマンドで実行されます。主な違いは、統合テストではブロックがspecial instance of the block editor
内で実行されることです。
このアプローチの利点は、ブロックエディタの機能の大部分(ブロックツールバーやインスペクターパネルのインタラクションなど)を、完全なe2eテストフレームワークを起動することなくテストできることです。これにより、テストははるかに迅速かつ信頼性高く実行できます。ブロックのUI機能の可能な限り多くを統合テストでカバーし、完全なブラウザ環境を必要とするインタラクションにはe2eテストを使用することが推奨されます。例:ファイルのアップロード、ドラッグアンドドロップなど。
The Cover block
は、このレベルのテストを使用してエディタのインタラクションの大部分をカバーするブロックの例です。
統合テスト用のjestファイルを設定するには:
import { initializeEditor } from 'test/integration/helpers/integration-test-editor';
async function setup( attributes ) {
const testBlock = { name: 'core/cover', attributes };
return initializeEditor( testBlock );
}
initializeEditor
関数は、@testing-library/react
render
メソッドの出力を返します。また、複数のブロックでエディタを設定できるように、ブロックメタデータオブジェクトの配列も受け入れます。
統合テストエディタモジュールは、ブロックラッパーのaria-labelによってテストされるブロックを選択するために使用できるselectBlock
もエクスポートします。例:「ブロック:カバー」。
スナップショットテスト
スナップショットテストの概要と、スナップショットテストを最大限に活用する方法について説明します。
TL;DR 壊れたスナップショット
スナップショットテストが失敗した場合、それはコンポーネントのレンダリングが変更されたことを意味します。それが意図しないものであれば、スナップショットテストはバグを防いだことになります!
ただし、変更が意図的であった場合は、スナップショットを更新するために次の手順に従ってください。スナップショットを更新するには、次のコマンドを実行します:
# --testPathPatternはオプションですが、一致するテストのみを実行することではるかに高速になります
npm run test:unit -- --updateSnapshot --testPathPattern path/to/tests
# e2eテストのスナップショットを更新
npm run test:e2e -- --update-snapshots path/to/spec
- 1. 差分を確認し、変更が予期されるものであることを確認します。
- 2. コミットします。
スナップショットとは何ですか?
スナップショットは、テストによって生成されたデータ構造の表現に過ぎません。スナップショットはファイルに保存され、テストと一緒にコミットされます。テストが実行されると、生成されたデータ構造がファイル上のスナップショットと比較されます。
スナップショットを作成するのは非常に簡単です:
test( 'foobar test', () => {
const foobar = { foo: 'bar' };
expect( foobar ).toMatchSnapshot();
} );
これが生成されたスナップショットです:
exports[ `test foobar test 1` ] = `
Object {
"foo": "bar",
}
スナップショットを直接作成または変更することは決して行わないでください。スナップショットはテストによって生成および更新されます。
利点
- テストを追加するのが簡単で簡潔です。
- 意図しない変更から保護します。
- 簡単に扱えます。
- アプリケーションを実行せずに内部構造を明らかにします。
欠点
- 表現力がありません。
- 変更が導入されたときにのみ問題をキャッチします。
- 非決定的なものには問題があります。
ユースケース
スナップショットは主にコンポーネントテストを対象としています。コンポーネントの構造の変更に気づかせてくれるため、リファクタリングに理想的です。スナップショットが一連のコミットの過程で最新の状態に保たれている場合、スナップショットの差分はコンポーネントの構造の進化を記録します。素晴らしいですね!
import { render, screen } from '@testing-library/react';
import SolarSystem from 'solar-system';
describe( 'SolarSystem', () => {
test( 'should render', () => {
const { container } = render( <SolarSystem /> );
expect( container ).toMatchSnapshot();
} );
test( 'should contain mars if planets is true', () => {
const { container } = render( <SolarSystem planets /> );
expect( container ).toMatchSnapshot();
expect( screen.getByText( /mars/i ) ).toBeInTheDocument();
} );
} );
リデューサーテストもスナップショットに非常に適しています。リデューサーは、予期せずに変更されるべきではない大きく複雑なデータ構造であり、まさにスナップショットが得意とするものです!
スナップショットの操作
スナップショットが一致しないとCIテストが失敗することに驚くかもしれません。変更が予期される場合は、スナップショットを更新する必要があります。迅速かつ簡単な解決策は、--updateSnapshot
を使用してJestを呼び出すことです。これは次のように行うことができます:
npm run test:unit -- --updateSnapshot --testPathPattern path/to/tests
作業中は`````npm run test:unit:watch`````をバックグラウンドで実行しておくのが良いアイデアです。Jestは変更されたファイルに対してのみ関連するテストを実行し、スナップショットテストが失敗した場合は、`````u`````を押してスナップショットを更新してください!
#### 痛点
非決定的なテストは一貫したスナップショットを作成しない可能性があるため、注意が必要です。ランダムなもの、時間に基づくもの、またはその他の非決定的なものを扱う場合、スナップショットは問題を引き起こす可能性があります。
接続されたコンポーネントは扱いが難しいです。接続されたコンポーネントをスナップショットするには、接続されていないコンポーネントをエクスポートする必要があります:
``````bash
// my-component.js
export { MyComponent };
export default connect( mapStateToProps )( MyComponent );
// test/my-component.js
import { MyComponent } from '..';
// run those MyComponent tests…
`
接続されたプロパティは手動で提供する必要があります。これは、接続された状態を監査する良い機会です。
ベストプラクティス
リファクタリングを開始する場合、スナップショットは非常に便利です。ブランチの最初のコミットとして追加し、進化を見守ることができます。
スナップショット自体は、私たちが期待することについて何も表現しません。スナップショットは、上記の例のように、私たちの期待を説明する他のテストと組み合わせて使用するのが最適です。
もう1つの良い手法は、[toMatchDiffSnapshot
]関数(snapshot-diff
パッケージによって提供される)を使用することで、DOMの2つの異なる状態間の差分のみをスナップショットすることができます。このアプローチは、プロパティの変更が結果のDOMに与える影響をテストするのに役立ち、はるかに小さなスナップショットを生成します。次の例のように:
test( 'should render a darker background when isShady is true', () => {
const { container } = render( <CardBody>Body</CardBody> );
const { container: containerShady } = render(
<CardBody isShady>Body</CardBody>
);
expect( container ).toMatchDiffSnapshot( containerShady );
} );
同様に、toMatchStyleDiffSnapshot
関数は、コンポーネントの2つの異なる状態に関連するスタイルの差分のみをスナップショットすることを可能にします。次の例のように:
test( 'should render margin', () => {
const { container: spacer } = render( <Spacer /> );
const { container: spacerWithMargin } = render( <Spacer margin={ 5 } /> );
expect( spacerWithMargin ).toMatchStyleDiffSnapshot( spacer );
} );
トラブルシューティング
時々、いくつかのストーリーで使用されるrefsをモックする必要があります。詳細を学ぶには、次のドキュメントを確認してください:
- Reactでのスナップショットテストのためのモックリファレンスが必要な理由。
その場合、TypeError
からプロパティにアクセスしようとする行で、Jestによってテストの失敗とTypeError
が報告されることがあります。
Jestユニットテストのデバッグ
npm run test:unit:debug
を実行すると、デバッグモードでテストが開始され、ノードインスペクタクライアントがプロセスに接続して実行を検査できます。Google ChromeまたはVisual Studio Codeをインスペクタクライアントとして使用するための手順は、wp-scriptsドキュメントに記載されています。
ネイティブモバイルテスト
ユニットテストスイートの一部は、React Nativeで開発されたネイティブモバイルコードパスを実行する一連のJestテストです。これらのテストはNode上で実行されるため、特定のネイティブAndroidまたはiOS開発ツールやSDKなしで、開発マシン上でローカルに起動できます。また、通常の開発ツールを使用してデバッグすることもできます。デバッグ方法については、以下をお読みください。
ネイティブモバイルユニットテストのデバッグ
ローカルでテストをデバッグモードで実行するには、次の手順に従ってください:
- 1. すべてのパッケージをインストールするために
npm ci
を実行したことを確認してください。 - 2. CLIでGutenbergのルートフォルダ内で
npm run test:native:debug
を実行します。Nodeはデバッガーの接続を待っています。 - 3. Chromeで
chrome://inspect
を開きます。 - 4. 「リモートターゲット」セクションで、
../../node_modules/.bin/jest
ターゲットを探し、「検査」リンクをクリックします。これにより、新しいウィンドウが開き、Chrome DevToolsデバッガーがプロセスに接続され、jest.js
ファイルの先頭で停止します。ターゲットが表示されない場合は、同じページのOpen dedicated DevTools for Node
リンクをクリックしてください。 - 5. コード全体、テストコードを含めて、ブレークポイントや
debugger;
ステートメントを配置して停止し、検査します。 - 6. 「再生」ボタンをクリックして実行を再開します。
- 7. ネイティブモバイルユニットテストのデバッグを楽しんでください!
ネイティブモバイルのエンドツーエンドテスト
Gutenbergの貢献者は、PRにネイティブモバイルのE2Eテストを実行する継続的インテグレーションE2Eテストが含まれていることに気付くでしょう。失敗したテストのトラブルシューティングについては、継続的インテグレーションにおけるネイティブモバイルテストに関するガイドを確認してください。これらのテストをローカルで実行する方法についての詳細は、こちらにあります。
ネイティブモバイル統合テスト
ネイティブモバイルプロジェクトに統合テストを追加するための取り組みが進行中で、react-native-testing-library
ライブラリを使用しています。統合テストの作成に関するガイドはこちらにあります。
エンドツーエンドテスト
現在存在するほとんどのエンドツーエンドテストは、PuppeteerをヘッドレスChromiumドライバーとして使用してpackages/e2e-tests
でテストを実行し、その他はJestテストランナーによって実行されます。
PuppeteerからPlaywrightへの移行プロジェクトが進行中です。可能な限り新しいe2eテストはPlaywrightで作成することをお勧めします。以下のセクションは、主に古いJest + Puppeteerフレームワークに適用されます。Playwrightでテストを書く場合は、専用のガイドを参照してください。
wp-envの使用
組み込みのローカル環境を使用している場合、次のコマンドを使用してローカルでe2eテストを実行できます:
npm run test:e2e
またはインタラクティブに
npm run test:e2e:watch
テストを実行している間にブラウザを観察することが便利な場合があります。その場合は、このコマンドを使用します:
npm run test:e2e:watch -- --puppeteer-interactive
``````bash
npm run test:e2e:watch -- --puppeteer-interactive --puppeteer-slowmo=200
`
さらに、ブラウザでインタラクティブデバッグのためにdevtoolsを自動的に開くこともできます:
npm run test:e2e:watch -- --puppeteer-devtools
代替環境の使用
``````bash
ln -s gutenberg/packages/e2e-tests/plugins/* .
`
その後、テストを実行するには、サイトのベースURL、ユーザー名、およびパスワードを指定します。たとえば、テストサイトがhttp://wp.test
の場合、次のようにします:
WP_BASE_URL=http://wp.test npm run test:e2e -- --wordpress-username=admin --wordpress-password=password
シナリオテスト
エンドツーエンドテストがローカルで成功するが、GitHub Actionsで失敗する場合、遅いCPUまたはネットワークをシミュレートすることでCPUまたはネットワークに依存するレース条件を特定できるかもしれません:
THROTTLE_CPU=4 npm run test:e2e
[Chromeドキュメント:setCPUThrottlingRate](https://chromedevtools.github.io/devtools-protocol/tot/Emulation#method-setCPUThrottlingRate)を参照してください。
``````bash
SLOW_NETWORK=true npm run test:e2e
`
SLOW_NETWORK
は、Chrome devtoolsで「Fast 3G」に相当するネットワーク速度をエミュレートします。
Chromeドキュメント:emulateNetworkConditionsおよびNetworkManager.jsを参照してください。
OFFLINE=true npm run test:e2e
[Chromeドキュメント:emulateNetworkConditions](https://chromedevtools.github.io/devtools-protocol/tot/Network#method-emulateNetworkConditions)を参照してください。
<a name="core-block-testing"></a>
### コアブロックテスト
すべてのコアブロックには、主要な保存機能のための少なくとも1セットのフィクスチャファイルと、各非推奨のための1セットのフィクスチャファイルが必要です。これらのフィクスチャは、ブロックの解析とシリアル化をテストします。詳細と手順については、[統合テストフィクスチャのREADME](https://github.com/wordpress/gutenberg/blob/HEAD/test/integration/fixtures/blocks/README.md)を参照してください。
<a name="flaky-tests"></a>
### フレキテスト
テストが**フレキ**であると見なされるのは、コードの変更なしに複数の再試行で合格したり失敗したりする場合です。CIでは、失敗したテストを自動的に**2回**再試行して、GitHubの問題に自動的に報告します。[`````[Type] Flaky Test`````](https://github.com/WordPress/gutenberg/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22%5BType%5D+Flaky+Test%22)ラベルを介して[`````report-flaky-tests`````](https://github.com/WordPress/gutenberg/tree/trunk/packages/report-flaky-tests)GitHubアクションを使用します。連続して3回失敗したテストはフレキテストとしてカウントされず、問題として報告されません。
<a name="php-testing"></a>
## PHPテスト
PHPのテストは、テストフレームワークとして[PHPUnit](https://phpunit.de/)を使用します。組み込みの[ローカル環境](9a8e7ea323b8b66b.md#local-environment)を使用している場合、次のコマンドを使用してローカルでPHPテストを実行できます:
``````bash
npm run test:php
`
ファイルが変更されたときに自動的にテストを再実行するには(Jestに似て)、次のコマンドを実行します:
npm run test:php:watch
注:phpunitコマンドはwp-env
が実行中であり、composer依存関係がインストールされている必要があります。パッケージスクリプトは、実行中でない場合はwp-envを開始します。
他の環境では、composer run test
およびcomposer run test:watch
を実行します。
PHPのコードスタイルは、PHP_CodeSnifferを使用して強制されます。PHP_CodeSnifferとWordPress Coding Standards for PHP_CodeSnifferルールセットをComposerを使用してインストールすることをお勧めします。Composerがインストールされている場合、プロジェクトディレクトリからcomposer install
を実行して依存関係をインストールします。上記のnpm run test:php
は、ユニットテストとコードリントの両方を実行します。コードリントは、npm run lint:php
を実行することで独立して確認できます。
リントなしでユニットテストのみを実行するには、npm run test:unit:php
を使用してください。
パフォーマンステスト
機能を追加するにつれてエディタがパフォーマンスを維持することを確認するために、プルリクエストやリリースがいくつかの重要な指標に与える影響を監視します。これには、
- エディタの読み込みにかかる時間。
- タイピング時にブラウザが応答するまでの時間。
- ブロックを選択するのにかかる時間。
パフォーマンステストは、エディタを実行し、これらの測定値をキャプチャするエンドツーエンドテストです。e2eテスト環境が準備されていることを確認してください。
e2eテスト環境を設定するには、Gutenbergリポジトリをチェックアウトし、テストしたいブランチに切り替えます。次のコマンドを実行して環境を準備します。
nvm use && npm install
npm run build:packages
テストを実行するには、次のコマンドを実行します:
npm run test:performance
これにより、実行環境の現在のブランチ/コードの結果が得られます。
さらに、次のコマンドを実行することで、ブランチ(またはタグやコミット)間のメトリックを比較することもできます。./bin/plugin/cli.js perf [branches]
、例:
./bin/plugin/cli.js perf trunk v8.1.0 v8.0.0
最後に、追加の--tests-branch
引数を渡して、どのブランチのパフォーマンステストファイルを実行するかを指定できます。これは、パフォーマンステストを変更/拡張する際に特に便利です:
./bin/plugin/cli.js perf trunk v8.1.0 v8.0.0 --tests-branch add/perf-tests-coverage
注 このコマンドはベンチマークを実行するのに時間がかかる場合があります。実行中は、コンピュータを使用したり、多くのバックグラウンドプロセスを実行したりして、ブランチ間の結果に影響を与える外部要因を最小限に抑えるようにしてください。