シャーディング

WebdriverIOはデフォルトでテストを並行して実行し、マシンのCPUコアを最適に活用することを目指しています。さらに並列化を高めるために、複数のマシンで同時にテストを実行することでWebdriverIOのテスト実行をスケールすることができます。この操作モードを「シャーディング」と呼んでいます。

複数のマシン間でテストをシャーディングする

テストスイートをシャーディングするには、コマンドラインに--shard=x/yを渡します。例えば、テストスイートを4つのシャードに分割し、それぞれが4分の1のテストを実行する場合：

npx wdio run wdio.conf.js --shard=1/4
npx wdio run wdio.conf.js --shard=2/4
npx wdio run wdio.conf.js --shard=3/4
npx wdio run wdio.conf.js --shard=4/4

これらのシャードを異なるコンピューター上で並行して実行すると、テストスイートの完了が4倍速くなります。

GitHub Actionsの例

GitHub Actionsはjobs.<job_id>.strategy.matrixオプションを使用して複数のジョブ間でテストをシャーディングすることをサポートしています。matrixオプションは、提供されたオプションのすべての可能な組み合わせに対して個別のジョブを実行します。

以下の例では、4台のマシンで並行してテストを実行するようにジョブを設定する方法を示しています。パイプライン全体のセットアップはCucumber Boilerplateプロジェクトで確認できます。

• まず、作成したいシャードの数を含むシャードオプションを持つmatrixオプションをジョブ設定に追加します。shard: [1, 2, 3, 4]は4つのシャードを作成し、それぞれ異なるシャード番号を持ちます。
• 次に、--shard ${{ matrix.shard }}/${{ strategy.job-total }}オプションでWebdriverIOテストを実行します。これが各シャードのテストコマンドになります。
• 最後に、wdioログレポートをGitHub Actions Artifactsにアップロードします。これにより、シャードが失敗した場合にログが利用可能になります。

テストパイプラインは次のように定義されています：

name: Test

on: [push, pull_request]

jobs:
    lint:
        # ...
    unit:
        # ...
    e2e:
        name: 🧪 Test (${{ matrix.shard }}/${{ strategy.job-total }})
        runs-on: ubuntu-latest
        needs: [lint, unit]
        strategy:
            matrix:
                shard: [1, 2, 3, 4]
        steps:
            - uses: actions/checkout@v4
            - uses: ./.github/workflows/actions/setup
            - name: E2E Test
              run: npm run test:features -- --shard ${{ matrix.shard }}/${{ strategy.job-total }}
            - uses: actions/upload-artifact@v1
              if: failure()
              with:
                  name: logs-${{ matrix.shard }}
                  path: logs

これによりすべてのシャードが並行して実行され、テストの実行時間が4分の1に短縮されます：

Cucumber Boilerplateプロジェクトのコミット96d444eでシャーディングをテストパイプラインに導入したことで、全体の実行時間が2:23分から1:30分に短縮され、__37%__の削減を達成しました 🎉。