Jenkins

概要

Jenkins 環境に Synthetic テストを追加します。

Datadog では、既存の Jenkins アーキテクチャーをモデル化し、ビジネス要件に合ったインストールをカスタマイズするソリューションを決定するために、SRE およびインフラストラクチャーチームと話し合うことを推奨しています。

セットアップ

Jenkins 環境で Docker を使用するには、Docker と Pipeline の併用をご覧ください。

前提条件

  • Node.js v10.24.1+
  • Config File Provider を介して Jenkins インスタンスにアップロードされたグローバル JSON コンフィギュレーションファイルです。このファイルは、Synthetics のテストセットアップのグローバルプロパティを定義するために必要です。

環境変数は、グローバルコンフィギュレーションファイル内に直接保存するか、認証情報を使用することができます。テストの構成について詳しくは、テストの構成 を参照してください。

@datadog/datadog-ci パッケージの実行

Jenkins Node.js プラグインを使用して、Jenkins 環境内に Node.js および npm パッケージをインストールし、実行します。

既存の Datadog と Jenkins のインテグレーションについては、Jenkins パイプラインにトレースを設定するを参照してください。

NodeJS のインストールを追加する

Jenkins のグローバルなコンフィギュレーションパネルに移動し、Node.js のインストールを追加します。

Jenkins の NodeJS インストール

Node.js に関連するすべてのインストールに対して、@datadog/datadog-ci をグローバルにインストールします。

タグ

Jenkins の Declarative パイプラインでタグを使った Synthetic テストを実行するには

pipeline {
   agent any
   stages {
       stage('Run e2e tests') {
           steps {
               withCredentials([string(credentialsId: 'datadog-api-key', variable: 'DATADOG_API_KEY'), string(credentialsId: 'datadog-app-key', variable: 'DATADOG_APP_KEY')]) {
                   nodejs(nodeJSInstallationName: 'Node 10.24.x') {
                       configFileProvider(
                           [configFile(fileId: 'config-file-id', variable: 'DATADOG_CI_CONFIG')]) {
                           sh 'datadog-ci synthetics run-tests -s "tag:e2e" --config $DATADOG_CI_CONFIG'
                       }
                   }
               }  
           }
       }
   }

カスタムテストファイル

Jenkins の Declarative パイプラインでカスタムテストファイルを使った Synthetic テストを実行するには

pipeline {
   agent any
   stages {
       stage('Run e2e tests') {
           steps {
               withCredentials([string(credentialsId: 'datadog-api-key', variable: 'DATADOG_API_KEY'), string(credentialsId: 'datadog-app-key', variable: 'DATADOG_APP_KEY')]) {
                   nodejs(nodeJSInstallationName: 'Node 10.24.x') {
                       configFileProvider(
                           [configFile(fileId: 'config-file-id', variable: 'DATADOG_CI_CONFIG'), configFile(fileId: 'test-file-id', variable: 'DATADOG_CI_TEST_FILE')]) {
                           sh 'datadog-ci synthetics run-tests -f $DATADOG_CI_TEST_FILE --config $DATADOG_CI_CONFIG'
                       }
                   }
               }  
           }
       }
   }
}

以下のような出力が期待できます。

Jenkins でのテスト実行例

その他の参考資料