Datadog で開発者のワークフローを強化する

概要

選択したサイト () では現在 CI Visibility は利用できません。

CI Test Visibility は、他の開発者向け Datadog 製品や GitHub などの外部パートナーとインテグレーションし、開発者のワークフローを効率化します。以下の機能が含まれています。

これらの機能は、Test Visibility を利用しているすべてのユーザーが利用可能で、Datadog GitHub インテグレーションを利用する必要はありません。

GitHub イシューを作成し、開く

Test Visibility を使用すると、テストに関連するコンテキストや Datadog へのディープリンクを含む GitHub イシューを作成して開くことができ、デバッグ作業をより効率的に行えます。Test Visibility から直接イシューを作成することで、テストの失敗や不安定なテストの追跡と説明責任を維持することができます。

アプリ内エントリポイント

Test Visibility 内の 3 つのエリアから、事前に入力された GitHub イシューを作成できます。

コミットの概要

コミットの概要ページは、特定のブランチやテストからアクセスできます。

Datadog の GitHub イシューのプレビュー

Commit Overview ページから、Failed Tests または New Flaky Tests テーブルの任意の行をクリックし、Open issue in GitHub を選択します。

ブランチの概要

このページから、Flaky Tests テーブルの任意の行をクリックし、Open issue in GitHub を選択します。

Datadog の GitHub イシューの不安定なテストテーブルのプレビュー

テストの詳細表示

特定のテスト実行から、Actions ボタンをクリックし、Open issue in GitHub を選択します。

Datadog の GitHub イシューのテスト詳細ビューのプレビュー

また、イシューの説明を Markdown にコピーして、テストの詳細を別の場所に貼り付けることもできます。Markdown 説明文には、テストの実行リンク、サービス、ブランチ、コミット、作成者、エラーなどの情報が含まれます。

GitHub イシューの Markdown 形式でのイシュー説明のコピー

GitHub イシューのサンプル

以下は、事前入力された GitHub イシューの例です。

GitHub イシューの事前入力

GitHub と IDE でテストを開く

アプリ内エントリポイント

Datadog 内でテストの失敗や不安定を検出したら、そのテストを GitHub や IDE で開いてすぐに修正することができます。

テスト実行の Overview タブの Error Message セクションで、View Code ボタンをクリックすると、Visual Studio Code、IntelliJ、または GitHub でそのテストに関連するコード行を表示できます。

IDE でテストを開く

このドロップダウンのオプションの並び順は、テストが記述された言語によって変わります。

  • IntelliJ は Java ベースのテストで優先されます
  • Visual Studio Code は、JavaScript および Python ベースのテストで優先されます

IDE プラグインのインストール

IDE でテストを表示するには、IDE プラグインと拡張機能が必要です。

  • VS Code 拡張機能がインストールされていない場合は、View in VS Code をクリックして、VS Code で直接拡張機能を開き、インストールします。
  • IntelliJ プラグインがインストールされていない場合は、 View in IntelliJ をクリックして、拡張機能をインストールします。互換性のある Datadog のバージョンは Plugin Versions ページで確認できます。

GitHub プルリクエストのテストサマリー

Datadog は GitHub とインテグレーションしており、プルリクエストに直接テスト結果のサマリーを表示することができます。このサマリーには、テストの実行概要、不安定性の情報、プルリクエストコメント内の失敗したテストのエラーメッセージが含まれます。

Datadog GitHub プルリクエストコメントプレビュー

このレポートにより、開発者はプルリクエストのビューから離れずに、テストの結果について即座にフィードバックを受け、失敗や不安定なテストをデバッグできます。

このインテグレーションは `github.com` でホストされているテストサービスでのみ利用可能です。

テストサマリーの有効化

以下の手順で、プルリクエストでテストサマリーを有効にすることができます。

  1. GitHub インテグレーションをインストールします。
    1. GitHub インテグレーションタイルの Configuration タブに移動し、+ Create GitHub App をクリックします。
    2. アプリケーションにプルリクエストの読み取り権限と書き込み権限を与えます。
  2. 1 つまたは複数のテストサービスに対して、テストサマリーを有効にします。テストサービス設定ページまたはコミット/ブランチページから行うことができます。

テストサービス設定ページ

  1.  Test Service Settings ページに移動し、リポジトリまたはテストサービスを検索します。
  2. 希望するサービスの GitHub Comments 列にあるトグルをクリックします。
Datadog の Test Service Settings タブで GitHub のコメントを有効にしたテストサービス

コミットまたはブランチページ

  1. GitHub コメントを有効にしたいテストサービスのコミットまたはブランチページに移動します。
  2. Settings アイコンをクリックし、View Test Service Settings をクリックします。
  3. 新しいプルリクエストにコメントが表示されるように、Enable GitHub Comments を選択します。この変更には数分かかる場合があります。
GitHub コメントのドロップダウンを有効にする

コメントは、テスト実行前に開かれ、かつ有効なテストサービスに対して少なくとも 1 回のテストを実行したプルリクエストにのみ表示されます。

その他の参考資料

お役に立つドキュメント、リンクや記事:

Datadog CI Visibility で GitHub Actions のワークフローを監視するブログ more more ソースコードインテグレーションについてドキュメント more more