Jenkinsのインストール#
Jenkinsは、ソフトウェア開発プロセスにおいて、ビルド、テスト、アプリケーションのデプロイを自動化するためのツールです。以下は、Linux環境でのインストール手順:2.
JenkinsのソースをAPTソフトウェアソースリストに追加します:
インストール後、Webブラウザを開き、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
を設定します。
Jenkinsホストにapidog-cliがインストールされており、Node環境で直接タスクを実行したい場合は、以下の図のNode設定を参考にして、ホストのNodeパスを入力します。JenkinsでApidogの自動テストを実行するには、以下の2つの方法があります:1.
ビジュアルパイプライン(Freestyle Project)に設定を追加する
2.
パイプラインに組み込みコードを統合する(Pipeline)
CLIコマンドの実行#
パイプラインの視覚的設定#
Apidogを開き、継続的インテグレーションの詳細ページからCLIコマンドを取得します。Jenkins環境がインターネットに接続されている場合は、リアルタイムで「オンラインデータを実行」コマンドを使用できます。インターネット接続がない場合、まずCLI JSONデータファイルを環境にエクスポートし、CLI経由で実行する必要があります。プロジェクト設定ページで、ビルド環境セクションを見つけ、「Node & npm bin/フォルダをPATHに提供」オプションをチェックし、グローバルツール設定(Tools) セクションで設定したNodeJSバージョン(例:nodejs18
)を選択します。ビルド環境を設定した後、ビルドStepsセクションに移動し、ビルドStepの追加をクリックして、シェルの実行を選択します(Windowsシステムを使用している場合はWindowsバッチコマンドの実行を選択)。Apidog CLIコマンドをコマンド入力ボックスに貼り付け、設定を保存します。プロジェクトで今すぐビルドをクリックして実行を開始します。「ビルド履歴」でビルドの進行状況と結果を確認できます。パイプラインへのコード埋め込み#
CI/CDタブに移動し、埋め込みコードスニペットをコピーして、Jenkins設定ファイルに貼り付けます。コードを直接Jenkinsパイプライン設定に貼り付けるだけで、既存のCI/CDワークフローに組み込まれます。ここで言及されているnodejs18
は、前に設定したNodeJSの エイリアスです。実際のエイリアスに置き換えてください。また、コード内の変数$APIDOG_ACCESS_TOKEN
を実際のAccess Tokenに置き換える必要があります。または、Jenkinsのダッシュボード → Jenkinsの管理 → システムでAPIDOG_ACCESS_TOKEN
という環境変数を追加し、その値をAccess Tokenに設定することもできます。これにより、パイプライン実行時にAccess Tokenを読み取ることができます。上記のコードからApidog CLIのインストールスクリプトを削除することで簡略化できます。これにより、ビルド実行時に毎回apidog-cli
を再インストールする必要がなくなり、ビルド時間とリソース消費を削減できます。これは、グローバルツール設定(Tools) でNodeJSとグローバルnpmパッケージ(apidog-cli
)が事前に設定されているため、ビルドプロセス中に必要なツールがすぐに利用可能になるからです。プロジェクトで今すぐビルドをクリックして実行を開始します。Jenkinsでのレポート公開#
コマンドで生成されるレポート名を ${JOB_NAME}_${BUILD_NUMBER}
(Jenkinsの組み込み変数)として指定します。HTML Publisher
プラグインを使用して レポートを表示します。