テスト分割によるパイプラインの高速化

GitHub で リポジトリをフォーク、またはリポジトリをダウンロードして、プロジェクトコードを任意の VCS プロバイダーにプッシュします。

CircleCI Web アプリ を開きます。 お客様個人の組織であることを確認し (https://app.circleci.com/pipelines/<vcs-provider><your-vcs-username>)、 Projects に移動します。

プロジェクトの一覧からサンプルアプリを見つけ、Set Up Project をクリックします。

config.yml ファイルを選択するよに求められます。 そのウィンドウで、"Fast: Take me to a config.yml template that I can edit" オプションを選択します。 Set Up Project をクリックします。

サンプルの設定ファイルの一覧が表示されます。 ウィンドウ内でスクロールダウンすると、Node (Advanced) が表示されるので、Select をクリックします。

すると、設定ファイルに移動します。 プロジェクトでは実際には Yarn を使うため、npm の代わりに yarn を使うように下記ステップを編集する必要があります。

steps:
# Checkout the code as the first step.
  - checkout
# Next, the node orb's install-packages step will install the dependencies from a package.json.
# The orb install-packages step will also automatically cache them for faster future runs.
  - node/install-packages:
    # If you are using yarn, change the line below from "npm" to "yarn"
    pkg-manager: yarn
  - run:
    name: Run tests
    command: yarn test

変更が完了したら、 Commit and Run ボタンをクリックします。 circleci-project-setup と呼ばれる新しい新しい機能のブランチでこの変更をコミットし、新しいパイプラインをトリガーします。

build-and-test ジョブで、docker キーの後に parallelism キーと 値 5 を追加します。

parallelism: 5

build-and-test ジョブの steps キー内で以下の更新を行います。

先程よりも早くパイプラインが実行されたことに気づくでしょう。 Node Orb がデフォルトで自動的に Node パッケージをキャッシュするため、先程のパイプライン実行時のキャッシュが存在しています。 これにより、インストールステップが高速化します。

また、並列実行 が 5 つ表示されているはずです。これは parallelism キーで設定された実行環境の数によって決まります。 各 Docker 環境 (Node) にインデックス番号によりラベリングされます (0 から 4 までの番号があります)。 Node をクリックすると、各並列実行で実行された各ステップを確認できます。 閲覧中の環境が緑色でハイライトされます。

任意の並列実行で、 Test application ステップを開きます。 この特定の実行で実行されたテストスイートと、個々のテストの数が表示されます。 出力には以下のメッセージも表示されます。

    Error reading historical timing data: file does not exist
Requested weighting by historical based timing, but they are not present. Falling back to weighting by name.

ジョブの Timing タブを開きます。 このタブにより各並列実行がお互いにどのように相関しているかを見ることができます。

プロジェクトで変更をコミットし、パイプラインを再びトリガーします。

Web アプリでパイプラインを開き、Test application ステップを表示します。 今回は、出力に Autodetected filename timings. があるはずです。 これは CircleCI が前の実行によるタイミングデータに基づいてテストを分割していることを意味します。

最後に、Timing タブを開きます。 この例では、テストステップが完了するまでの時間が、先程のテストを名前で分割した場合とさほど変わらないことにお気づきになるでしょう。 しかし、各実行間のアイドルタイムが先程の 11 秒からたった 5 秒に短縮されています。