Perforce Helix Swarm との統合

前提条件

TeamCity と Helix Swarm の統合は、 コミットステータスパブリッシャー ビルド機能に基づいています。 パブリッシャーは スウォームテスト(英語)を利用して、次の 2 つのタスクを解決します。

• Helix Swarm レビューが作成または編集されるたびにトラックし、その際に新しいビルドを開始するリクエストを TeamCity に送信します；

• TeamCity ビルドのステータスを Helix Swarm レビューに投稿します。

Helix Swarm のセットアップに、ユーザーがレビューを作成または編集したときに TeamCity ビルドを起動するテストがすでにあるかどうかに応じて、二つのオプションのいずれかを選択できます：

• TeamCity に新しい Swarm テストの作成を許可します。 既存の Helix Swarm ワークフローとテストがない場合は、このアプローチを使用します。 このオプションは、管理者ユーザーの資格情報を Commit Status Publisher に渡す場合にのみ使用できます。 このオプションを選択する場合は、Swarm 側で追加のセットアップが必要ないため、 コミットステータスパブリッシャーの設定 セクションに進んでください。

• TeamCity に既存のワークフローとテストを検索して利用するよう強制します。 このアプローチでは、TeamCity が Swarm エンティティを作成しないため、管理者ユーザーの資格情報は必要ありません。 ただし、これらのエンティティを Swarm 側で手動で設定する必要があります。

Helix Swarm のセットアップ

このセクションで説明する手順は Helix Swarm UI で実行し、TeamCity が管理者以外のユーザーの資格情報を使用して新しい Swarm コメントを投稿する場合にのみ必要です。

テストの作成

Helix Swarm テストは、レビューが作成または編集されたときに TeamCity REST API エンドポイントにリクエストを送信できます。

1. サイドナビゲーションペインで「テスト 」をクリックします。

2. テスト定義を追加 ボタンをクリックしてください。

3. 新しいブラウザータブで TeamCity UI を開き、 管理 | <ビルド構成> に移動します。

4. TeamCity から ビルド構成 ID の値をコピーします。

5. Swarm テスト設定に戻り、コピーした値をテスト名として貼り付けます。

6. URL フィールドに次の値を入力します。

   <TeamCity_server_URL>/app/perforce/runBuildForShelve

   この値は、Helix Swarm がビルド構成と通信するために使用する TeamCity REST API エンドポイントです。

7. 本文 フィールドに次の文字列を入力します。

   buildTypeId=<X>&vcsRootId=<Y>&shelvedChangelist={change}&swarmUpdateUrl={update}

   • X — テスト名と同じ値。 TeamCity の ビルド構成 ID からコピーします。

   • Y - TeamCity で Administration | <Your_Build_Configuration> | Version Control Settings | <Your_VCS_Root> に移動し、 VCS ルート ID の値をコピーします。

   • {change} — 変更番号(英語)。

   • {update} — 更新コールバック URL(英語)。

   この文字列により、Helix Swarm テストは特定の TeamCity 構成を特定し、その新しいビルドをスケジュールできます。 例:

   buildTypeId=P4-Remote_MyBuildConfig&vcsRootId=MainP4Root&shelvedChangelist={change}&swarmUpdateUrl={update}

8. Swarm の TeamCity へのリクエストを承認するには、 ヘッダーを追加 をクリックして次の値を指定します。

   • ヘッダー — 「承認」

   • 値 - "Bearer ABC"。ABC は TeamCity ユーザーアクセストークンです。

9. タイムアウト 設定を 10 秒に設定します。

10. 保存 をクリックして新しいテストを保存します。

ワークフローの設定

Helix Swarm ワークフロー(英語)は、ユーザーが Swarm レビューを作成または編集するときにテストを実行します。

1. サイドナビゲーションペインで「ワークフローングワークフロー 」をクリックします。

2. 新しいワークフローを作成するか、 グローバルワークフロー を編集します。

3. ワークフロー設定で、 テストを追加 をクリックし、前の手順で作成したテストを選択します。

4. 更新時 トリガータイプを選択します。

5. ブロック 値は「なし」のままにします。

6. 「保存 」をクリックしてワークフロー設定を終了します。

コミットステータスパブリッシャーの設定

1. TeamCity UI で 管理 | <ビルド構成> に移動します。

2. ビルド機能 タブに切り替えます。

3. ビルド機能を追加 をクリックし、 コミットステータスパブリッシャー を選択します。

4. パブリッシャーとして Perforce ヘリックススウォーム を選択します。

5. Helix Swarm インスタンスの URL を入力します。

6. ユーザー名と チケット(英語)を入力します。 認証情報を指定するユーザーは、Helix Swarm レビューにコメントを投稿する権限を持っている必要があります。 さらに、Commit Status Publisher が Swarm インスタンスにアクセスできなくなるのを防ぐために、ユーザーのチケットが期限切れになっていないことを確認してください。

7. 新しい TeamCity ビルドをトリガーする既存のワークフローやテストがなく、必要に応じて TeamCity に自動的に作成させたい場合は、 Swarm テストを作成 オプションをオンにします。 この設定では、手順 6 で管理者のユーザー名とチケットを渡す必要があります。

   Commit Status Publisher が使用できるワークフローがすでにある場合 (または、管理者の資格情報をビルド機能に渡さないようにワークフローを作成することを選択した場合)、このチェックボックスは空のままにしておきます。

8. Commit Status Publisher は、レビューの コメント タブにビルド結果 (成功/失敗) を投稿し、 テスト セクションを更新することで、現在の TeamCity ビルドステータスを Swarm ユーザーに通知できます。

   

   

   コードレビューコメント チェックボックスを使用して、Commit Status Publisher がこれらのコメントを対応する Swarm レビュータブに投稿するかどうかを指定します。

9. 接続をテスト をクリックして、Commit Status Publisher が Swarm インスタンスにアクセスできることを確認します。 「指定された資格情報には管理者権限がありません」というエラーが表示される場合は、管理者以外のユーザーの資格情報に対して Swarm テストを作成 オプションを有効にしようとしていないことを確認してください。

10. 「保存 」をクリックして、構成にビルド機能を追加します。

統合機能

Commit Status Publisher を設定したら、ディポファイルを変更してシェルブします。 Helix Swarm でこの保留された変更を開き、 レビューをリクエスト をクリックします。 これにより、新しいビルドを開始するリクエストを TeamCity に送信する Helix Swarm テストがトリガーされます。 統合で手動で構成されたワークフローとテストを使用している場合、レビューには現在のテスト / ビルドステータスを示す テスト セクションが表示されます。

TeamCity は、Helix Swarm でレビューをリクエストしたユーザーと同じユーザー名を持つユーザーを検索し、そのユーザーの新しいパーソナルビルドを開始しようとします。 ビルドの Swarm レビュー セクションのリンクをクリックすると、シェルブされた変更と関連する Swarm レビューを開くことができます。

ビルドの 変更 タブから関連する変更を表示することもできます。

TeamCity ビルドが完了すると、Commit Status Publisher は Helix Swarm レビューの コメント セクションに結果を新しいコメントとして投稿できます。

コミットステータスパブリッシャーの設定ダイアログで Swarm テストを作成 オプションのチェックを外すと、これらのコメントを無効にすることができます。 この場合、ビルド機能は Swarm レビューの テスト セクションのみを更新します。