Jira integration | Ranorex
Help CenterUser GuideJira integration

Jira 連携

Jira は、Atlassian が提供する課題管理システムです。テスト管理を含む、アジャイルなプロジェクト管理のために利用されます。Jira 連携機能により、Ranorex Studio と Jira を接続できます。これにより、失敗したテスト ケースの課題を、テスト プロジェクトから直接手動で作成したり、Ranorex Studio で自動で作成することができます。

このセクションでは、ウィザードを使用した Jira 連携のセットアップ方法、手動と自動での課題の作成方法、連携の設定方法について説明します。

Jira ウィザードによるセットアップ

Ranorex Studio の Jira ウィザードを使用して、Jira 連携のセットアップをおこないます。

ウィザードは以下の手順で起動します。

Ranorex Studio でソリューションを開き、ツール > Jira 連携 > Jira ウィザードの開始 をクリックします。
Jira への接続画面が表示されます。認証情報を入力し、サインイン をクリックします。

Note icon

メモ

認証情報は、マシンの 資格情報マネージャー (Windows Credential Manager) に保存されます。資格情報の削除方法については、あとで説明します。

サインインに成功したら、続行 をクリックします。

Note icon

メモ

Jira could instance への URL を指定した場合には、email および API token の入力が必要になります。

ドロップダウン メニューから、ソリューションとリンクしたい Jira プロジェクトを選択し、続行 をクリックします。

続く画面で、課題の手動処理、および自動処理の方法を設定できます。設定については、以降で詳しく説明します。

課題の手動処理を有効にしたい場合には、レポートに Create issue ボタンを表示 オプションを有効にし、デフォルトの課題タイプを選択し、続行 をクリックします。

課題の自動処理を有効にしたい場合には、自動処理の有効化 を有効にし、デフォルトの課題タイプと、デフォルトのオープン/完了ステータスを選択し、完了 をクリックします。

課題の手動処理と自動処理

先に説明したように、テスト ケース失敗についての課題を、レポートから手動で作成したり、テスト実行時に自動で作成/更新できます。両方を同時に使用することもできます。

課題の手動処理

課題の手動処理を有効にした場合、テスト レポート上の失敗したテスト ケースの横に、Create Jira issue ボタンが表示されます。

レポートの失敗したテスト ケースの横にある Create Jira issue ボタン
このボタンをクリックすると、ソリューションにリンクされている Jira プロジェクトが開かれ、新しい課題を作成するためのダイアログが表示されます。デフォルトの課題タイプ (タスク、ストーリーなど) は、Jira ウィザード、または、Jira 連携の設定ファイル (以降で説明します) で指定できます。また、課題の他のフィールドのデフォルト値を設定することもできます。

課題の自動処理

課題の自動処理を有効にした場合、Jira ウィザード、または Jira 連携の設定ファイルの設定に基づいて、テスト実行ごとに Ranorex Studio が自動で課題を作成します。

課題の自動処理は、以下に従って処理されます。ここでは、課題タイプを Bug に、オープン ステータスを To do に、完了ステータスを Done と設定したとして説明します。

テスト ケース失敗時:

  • 課題タイプ Bug、ステータス To do の課題を作成します。Ranorex Studio およびテスト レポートでの識別のため、デフォルトでは、要約としてテスト ケース名が、説明としてテスト ケース タグが設定されます。
  • 同名のテスト ケース タグを持つ、オープン ステータスの課題が既に存在する場合、何もおこないません。
  • 同名のテスト ケース タグを持つ、完了ステータスの課題が既に存在する場合、ステータスを To do に変更します。

テスト ケース成功時:

  • 同名のテスト ケース タグを持つ課題が存在しない場合、何もおこないません。
  • 同名のテスト ケース タグを持つ課題が存在する場合、ステータスを Done に変更します。
Note icon

メモ

上記の説明からも分かるように、自動処理は、テスト ケース タグで課題を識別します。手動で作成した課題にテスト ケース タグを設定した場合にも、同じように機能します。あとで自動処理に切り替えた場合でも、Ranorex Studio はこの課題のステータスを自動的に更新します。

設定ファイル

Jira ウィザードでのセットアップが完了すると、テスト実行時に Jira での課題の作成がおこなえるようになります。しかしながら、設定ファイルで設定できるいくつかのオプションがあります。

設定ファイル Jira.jsd は、Solution Items フォルダーに格納されており、Jira 連携の動作に必要なすべての設定が記述されています。

設定ファイルは以下の手順で開きます。

Ranorex Studio で、以下いずれかをおこないます。

ツール > Jira 連携 > Jira 連携の設定 をクリック
プロジェクト ビューで Jira.jsd をダブルクリック

設定画面が開かれます。この画面では、各フィールドのデフォルト値を指定できます。これらの値は、課題の手動処理、および課題の自動処理で使用されます。

Note icon

メモ

課題の手動処理/自動処理の切り替え、課題タイプおよびステータスは、Jira ウィザードで設定するものと同一です。詳しくは、上述の説明を参照ください。

必須フィールドとオプション フィールドにある項目は、Jira 上で作成する課題の項目に対応します。

変数エディター
このボタンをクリックすると、変数エディターが起動します。フィールドに入力できる変数とその説明が表示されます。

一部のフィールド タイプは、自動的に指定できないため、レポート上の Create Jira issue ボタンから課題を作成する際に手動で入力する必要があります。自動処理の場合、課題の作成後に手動で更新していない限り、これらのフィールドは空になります。

tipp icon

注意

課題の自動処理の場合、最低でも 1 つの string タイプのフィールド (例: 説明) に、変数 $TestCaseTag を含める必要があります。この変数がない場合、Ranorex Studio は課題を自動で識別できません。フィールドのタイプは、マウス オーバーで確認できます。

サインアウト

サインアウトは、マシン、つまり、資格情報マネージャー (Windows Credential Manager) から、Jira の認証情報を削除することを意味します。

認証情報の削除は、以下の手順でおこないます。

Ranorex Studio から ツール > Jira 連携 > サインアウト (<ユーザー名>) をクリックし、確認ダイアログで はい をクリックします。

Jira との接続の解除

Jira との接続の解除は、Jira.jsd ファイルの削除を意味します。Jira 連携のすべての設定情報が失われます。

接続の解除は、以下の手順でおこないます。

Ranorex Studio から、ツール > Jira 連携 > Jira との接続の解除 をクリックし、確認ダイアログで はい をクリックします。