Create and set up a Jenkins project | Ranorex
Help CenterUser GuideInterfaces and connectivity

Jenkins プロジェクトの作成とセットアップ

Jenkins でビルド ステップとして Ranorex Studio のテストを実行するには、Jenkins でプロジェクトを作成する必要があります。このセクションでは、Ranorex Test Execution Plugin の設定を含む、Jenkins プロジェクトの作成および設定方法について説明します。

Jenkins プロジェクトの作成

Jenkins プロジェクトの作成は以下の手順でおこないます。

以下をクリックします。

New Item をクリックします。
Create new jobs をクリックします。

プロジェクト名を入力します。
テンプレートとして Freestyle project を選択し、OK をクリックします。

プロジェクトの作成が完了すると、設定画面が表示されます。

Jenkins プロジェクトの設定

Jenkins プロジェクトに関する設定は数多くありますが、ここでは、Ranorex Studio との連携に関する設定を中心に説明します。

プロジェクトの設定は、プロジェクトを作成した後に自動的に表示されます。また、以下の手順でいつでも表示することができます。

プロジェクトを開いた状態で、Configure をクリックします。

Source Code Management

ここは、ファイルをバージョン管理しているリポジトリに、Jenkins がアクセスする方法について設定する場所です。

今回の例では、GitHubを使用します。以下の設定をおこないます。

Repository URL に、GitHub リポジトリの URL を入力します。
リポジトリへのアクセスに認証情報が必要な場合には、Credentials を入力します。

MSBuild step

Jenkins が Ranorex Studio ソリューションを正しくビルドできるように、MSBuild ステップを追加および設定する必要があります。

Add build step をクリックします。
Build a Visual Studio project or solution using MSBuild をクリックします。
⇢ プラグインの設定 で定義した、MSBuild のバージョンを選択します。
Ranorex Studio ソリューション (.rxsln) の Visual Studio 版 (.sln) へのパスを入力します。このパスは、バージョン管理リポジトリのルート フォルダーからの相対パスである必要があります。今回の例では、.sln ファイルはルート フォルダー直下に配置されているため、ファイル名のみの入力で問題ありません。

Ranorex test suite build step の実行

最後に、Ranorex Studio テストを実行するビルド ステップを追加する必要があります。以下の基本的な設定が必要です。追加の設定については、後で説明します。

Add build step をクリックします。
Run a Ranorex test suite をクリックします。
テスト スイート ファイル (.rxtst) への、ソリューション フォルダーからの相対パスを入力します。デフォルトでは、テスト スイート ファイルは出力フォルダーに配置されています。(<ソリューション フォルダー>/bin/Debug/<テスト スイート ファイル>.rxtst)

高度な設定

上記で説明した基本的な設定とは別に、Ranorex test suite build step には、さまざまな高度な設定があります。これらの設定は、テスト実行をカスタマイズするために使用することができ、ビルド ステップの Advanced… ボタンから設定することができます。

Ranorex run configuration

ここでは、TestRun を指定することができます。指定しない場合、Ranorex Studio ソリューションが最後に保存されたときにアクティブだった TestRun が使用されます。

Ranorex Studio のテスト スイート ビューに表示された、利用可能な TestRun の一覧
実行したい TestRun の名前を正確に入力

Change report directory, name, and file extension

Jenkins 上で、デフォルトのレポート名とディレクトリを変更できます。これらのフィールドを入力していない状態の場合、各フィールドの下に、デフォルトのレポート名とディレクトリが黄色の文字で表示されます。

カスタム レポート ディレクトリ。Ranorex Studio プロジェクトの出力フォルダー (bin/Debug) からの相対パスである必要があります。
Jenkins で利用可能な変数を使用した、カスタム レポート名。⇢ Ranorex Studio のレポート名のプレースホルダー を使用することもできます。
ファイル拡張子の選択。rxlog または xml が選択できます。
上記の設定でプロジェクトをビルドした場合のコンソール出力

Note icon

メモ

Jenkins には、Jenkins パラメーターのプレースホルダーとして機能する、さまざまな変数が用意されています。これらをファイル名などに使用することができます。利用可能な変数については、Jenkins の公式ドキュメント を参照してください。

JUnit-compatible report

JUnit データ形式は、多くのCIシステムで、テスト結果データを処理するために使用されます。この設定を有効にすると、JUnit 形式の Ranorex レポートが生成されます。

⇢ プラグインのインストールと設定 で説明している手順に従って、Jenkins JUnit プラグインがインストールおよび有効化されていることを確認してください。
JUnit-compatible report を有効化します。

Jenkins プロジェクトで、Add post build action をクリックします。
Publish JUnit test result report をクリックします。
Test report XMLs に、Ranorex Studio レポート XML ファイルへのパスを入力します。

ビルドを実行すると、ビルド サマリーに JUnit レポートへのリンクが表示されます。

Compressed copy of Ranorex report

アーカイブ レポートの生成は以下の手順でおこないます。

Compressed copy of Ranorex report を有効化します。
必要に応じて、カスタム レポート ディレクトリを指定します。Ranorex Studio プロジェクトの出力フォルダー (bin/Debug) からの相対パスである必要があります。空の場合、デフォルトのレポート ディレクトリが使用されます。
必要に応じて、アーカイブ レポート名を入力します。Jenkins および Ranorex Studio の変数が利用できます。

Note icon

メモ

Jenkins には、Jenkins パラメーターのプレースホルダーとして機能する、さまざまな変数が用意されています。これらをファイル名などに使用することができます。利用可能な変数については、Jenkins の公式ドキュメント を参照してください。

Ranorex TestRail integration

これらの設定により、テスト結果を TestRail に渡すことができます。TestRail との連携で説明しているコマンドライン パラメーターを使用します。

参照

TestRail 連携のコマンドライン パラメーターについては、Ranorex Studio エキスパート > ランタイム/リモート実行 > ⇢ コマンドライン実行 を参照してください。

TestRail との連携については、各種システムとの接続 > ⇢ TestRail との連携 を参照してください。

Global parameters

テスト スイートにグローバル パラメーターが含まれている場合、ここでその値を定義することができます。ビルドの実行時に、これらのパラメーターの既存の値が上書きされます。

値の定義は以下の手順でおこないます。

変数とその値を、”パラメーター名=値” のパターンで入力します。各パラメーターは、セミコロンで区切ります。

Command line arguments

このフィールドで、Ranorex Studio で利用可能なコマンドライン引数を渡すことができます。

参照

利用可能なコマンドライン引数については、Ranorex Studio エキスパート > ランタイム/リモート実行 > ⇢ コマンドライン実行 を参照してください。

ビルド成果物のアーカイブ

ビルド成果物 (Build artifact) とは、ビルドの結果として生成されるファイルであり、テスト実行ビルドやレポート ファイルを指します。これらの成果物を Jenkins からダウンロードできるようにすることで、それぞれのファイルを各ディレクトリから探すよりも便利になります。

以下の手順でおこないます。

Jenkins プロジェクトで、Add post build action をクリックします。
Archive the artifacts をクリックします。
アーカイブしたいファイルを指定します。

上記の図では、/myReports/ ディレクトリにある、Jenkins ビルド名とビルド番号を含み、”rx” で終わるすべてのファイルを、Post-build step でアーカイブしています。

ビルドが実行されると、成果物が以下のようにダウンロードできるようになります。