Jira との連携
Jira は、Altassian が提供する課題管理システムです。テスト管理を含む、アジャイルなプロジェクト管理のために利用されます。
Jira との連携機能により、Ranorex Studio と Jira を接続できます。これにより、失敗したテストケースの課題を、テストプロジェクトから直接手動で作成したり、Ranorex Studio で自動で作成することができます。
このセクションでは、ウィザードを使用した Jira 連携のセットアップ方法、手動と自動での課題の作成方法、連携の設定方法について説明します。
Jira ウィザードによるセットアップ
Ranorex Studio の Jira ウィザードを使用して、Jira 連携のセットアップをおこないます。
ウィザードは以下の手順で起動します。
Ranorex Studio でソリューションを開き、ツール > Jira 連携 > Jira ウィザードの開始 をクリックします。
Jira への接続画面が表示されます。認証情報を入力し、サインイン をクリックします。
メモ
認証情報は、マシンの資格情報マネージャー (Windows Credential Manager) に保存されます。資格情報の削除方法については、後ほど説明します。
サインインに成功したら、続行 をクリックします。
ドロップダウンメニューから、ソリューションとリンクしたい Jira プロジェクトを選択し、続行 をクリックします。
続く画面で、課題の手動処理、および自動処理の方法を設定できます。設定については、以降で詳しく説明します。
課題の手動処理を有効にしたい場合には、レポートに Create issue ボタンを表示 オプションを有効にし、デフォルトの課題タイプを選択し、続行 をクリックします。
課題の自動処理を有効にしたい場合には、自動処理の有効化 を有効にし、デフォルトの課題タイプと、デフォルトのオープン/完了ステータスを選択し、完了 をクリックします。
Jira 設定ファイル
Jira ウィザードでのセットアップが完了すると、テスト実行時に Jira での課題作成がおこなえるようになります。まず最初に、ユーザーが設定できるいくつかのオプションがあります。
これらのオプションは、Jira.jsd というファイルに保存されます。Jira.jsd は Solution Items フォルダーに格納されており、Jira 連携の動作に必要なすべての設定が記述されています。
Ranorex Studio からの Jira 連携の設定は以下の手順でおこないます。
ツール > Jira 連携 > Jira 連携の設定 をクリックします。
プロジェクトビューにある Jira.jsd が開かれ、Jira 連携の設定画面が開かれます。
課題の手動処理
課題の手動処理タブでは、レポートから手動で作成する課題の設定がおこなえます。
変数エディター
このボタンをクリックすると、変数エディターが起動します。フィールドに入力できる変数とその説明が表示されます。
課題の手動処理を有効にすると、失敗したテストケースの箇所に、Create Jira issue ボタンが表示されるようになります。
レポートの失敗したテストケースに表示された Create Jira issue ボタン
このボタンをクリックすると、連携された Jira プロジェクトが開かれ、新しい課題を作成するためのダイアログボックスが表示されます。デフォルトの課題タイプ (タスク、ストーリーなど) は、Jira ウィザード、または連携の設定オプション (前項で説明) で設定します。新しい課題の作成ダイアログボックスで、他の Jira 課題フィールドの値を設定することもできます。
課題の自動処理
課題の自動作成/更新は、以下のような動作をおこないます。説明のために、課題のタイプを Bug、オープン状態を To do、クローズ状態を Done に設定したとします。
テストケース失敗時:
以下のいずれかのアクションが実行されます。
- 課題タイプ Bug、ステータスTo do の課題を作成します。Ranorex Studio およびテスト レポートでの識別のため、デフォルトでは、要約としてテスト ケース名が、説明としてテスト ケースタグが設定されます。
- 同名のテストケースタグを持つ、オープンステータスの課題が既に存在する場合、何もおこないません。
- 同名のテストケースタグを持つ、完了ステータスの課題が既に存在する場合、ステータスを To do に変更します。
テストケース成功時:
- 何もおこないません。
- 同名のテストケースタグを持つ課題が既に存在する場合、ステータスを Done に変更します。
メモ
上記の説明からも分かるように、自動処理は、テストケースタグで課題を識別します。手動で作成した課題にテストケースタグを設定した場合にも、同じように機能します。あとで自動処理に切り替えた場合でも、Ranorex Studio はこの課題のステータスを自動的に更新します。
課題の自動処理を有効にすると、Ranorex Studio が各テストで Jira の課題を自動で作成するようになります。
注意
課題を自動的に処理するためには、最低でも 1 つのフィールド (例: 説明) に、変数 $TestCaseTag を含める必要があります。この変数がない場合、Ranorex Studio は課題を自動で識別できません。フィールドのタイプは、マウス オーバーで確認できます。
添付ファイルのアップロード
課題にファイルを添付するには、追加 をクリックします。ファイル選択ウィンドウで、添付したいファイルを指定します。
選択したファイルが、添付リストに表示されます。ファイル名の右横にあるごみ箱アイコンをクリックすることで、添付リストから削除できます。
一部のフィールド タイプは、自動的に設定できないため、レポート上の Create Jira issue ボタンから課題を作成する際に手動で入力する必要があります。自動処理の場合、課題の作成後に手動で更新していない限り、これらのフィールドは空になります。
Jira カスタムフィールド
Ranorex は、Jira カスタムフィールドをサポートします。Jira プロジェクトにカスタムフィールドが含まれる場合、Jira 連携のセットアップ画面で表示されます。これらのカスタムフィールドにドロップダウン値が含まれる場合、Ranorex から使用することができます。
ドロップダウンではないカスタムフィールドも表示されますが、Ranorex からはこれらの値を変更することはできません。
サインアウト
サインアウトは、マシン、つまり、資格情報マネージャー (Windows Credential Manager) から、Jira の認証情報を削除することを意味します。
認証情報の削除は以下の手順でおこないます。
Ranorex Studio から、ツール > Jira 連携 > サインアウト (<メールアドレス>) をクリックし、確認ダイアログで はい をクリックします。
Jira との接続の解除
Jira との接続の解除は、Jira.jsd ファイルの削除を意味します。Jira 連携に関するすべての設定情報が失われます。
接続の解除は、以下の手順でおこないます。
Ranorex Studioから、ツール > Jira 連携 > Jira との接続の解除 をクリックし、確認ダイアログで はい をクリックします。
メモ
Jira と接続されていれば、同じ接続を使用してプロジェクトを切り替えることができます。サインアウトや接続の解除をおこなう必要はありません。
Jira と接続されている状態で、Jira との接続の解除 を実行すると、Jira.jsd ファイルに記述されている設定情報が削除されますが、Jira へはサインインしたままの状態となります。