前提条件#
Jenkins がインストールされ、実行中であること（v2.0 以降を推奨）
Jenkins ホストに Node.js v16 以降がインストールされていること
テストシナリオが作成済みの Apidog アカウントがあること
Apidog アクセストークンを生成する権限があること
Jenkins のインストール#
Jenkins は自動ビルドツールであり、ソフトウェア開発プロセスにおいて、開発者がアプリケーションのビルド、テスト、デプロイを自動化するのに役立ちます。Linux システムに Jenkins をインストールする方法は次のとおりです。2.
Jenkins のソースを APT ソフトウェアソースのリストに追加します。
http://localhost:8080 または http://{your_public_IP}:8080 を入力して Jenkins ダッシュボードにアクセスします。コンソールには、Jenkins サービスを管理および設定するための Web API が用意されています。Jenkins 用 Node.js 環境の設定#
Apidog CLI を実行する前に、Node.js のバージョン番号が v16 以降であることを確認する必要があります。そのため、まず Jenkins 環境で NodeJS の依存関係を設定する必要があります。
1.
Jenkins のプラグイン管理を開き、NodeJS プラグインを見つけてインストールし、再起動します。
2.
グローバルツール設定で新しい NodeJS を作成し、バージョン番号（v16 以降が必要）とパッケージ名 apidog-cli を設定します。
1.
ビジュアルパイプライン（Freestyle Project）で設定を追加する
2.
埋め込みコードをパイプライン（Pipeline）に統合する
CLI コマンドの実行#
パイプラインを視覚的に設定する#
Apidog を開き、継続的インテグレーションの詳細ページから CLI コマンドを取得します。Jenkins 環境がインターネットにアクセスできる場 合は、「オンラインデータをリアルタイムで実行」コマンドの使用を選択できます。インターネットアクセスが利用できない場合は、まず CLI JSON データファイルを環境にエクスポートし、その後 CLI 経由で実行する必要があります。プロジェクト設定ページで、Build Environment セクションを見つけ、"Provide Node & npm bin/ folder to PATH" オプションにチェックを入れ、Global Tool Configuration (Tools) セクションで設定した NodeJS バージョン（例：nodejs18）を選択します。ビルド環境を設定した後、Build Steps セクションに移動し、Add build step をクリックして、Execute Shell を選択します（Windows システムを使用している場合は、Execute Windows Batch Command を選択してください）。Apidog CLI コマンドを Command 入力ボックスに貼り付け、設定を保存します。プロジェクトで Build Now をクリックして実行を開始します。ビルドの進行状況と結果は「Build History」で確認できます。埋め込みコードをパイプラインに統合する#
CI/CD タブに移動して埋め込みコードスニペットをコピーし、Jenkins 設定ファイルに貼り付けます。コードを Jenkins パイプライン設定に直接貼り付けるだけで、既存の CI/CD ワークフローに埋め込むことができます。ここで言及されている nodejs18 は、先ほど設定した NodeJS エイリアスを指します。実際のエイリアスに置き換えてください。また、コード内の変数 $APIDOG_ACCESS_TOKEN を実際の Access Token に置き換えてください。あるいは、Jenkins の Dashboard → Manage Jenkins → System で APIDOG_ACCESS_TOKEN という名前の環境変数を追加し、その値を Access Token に設定できます。これにより、パイプラインは実行時に Access Token を読み取れるようになります。Apidog CLI をインストールするスクリプトを削除することで、上記のコードを簡略化できます。これにより、ビルドを実行するたびに apidog-cli を再インストールする必要がなくなり、ビルド時間とリソース消費の両方を削減できます。これは、NodeJS とグローバル npm パッケージ（つまり apidog-cli）が Global Tool Configuration (Tools) で事前に設定されており、ビルドプロセス中に必要なツールをすぐに利用できるようになっているためです。プロジェクトで Build Now をクリックして実行を開始します。Jenkins でレポートを公開する#
コマンドで生成されるレポート名 ${JOB_NAME}_${BUILD_NUMBER}（Jenkins 組み込み変数） を指定します。レポートを表示するには、HTML Publisher プラグインを使用します。