このセクションの内容:
DTP を Jira に接続する
- 設定メニュー (歯車のアイコン) から [Report Center 設定] を選択します。
- [External System] を選択して [設定の編集] をクリックし、[システム タイプ] メニューから Jira を選択します。
- [Enabled] オプションを有効化します。
- [名前] フィールドにサーバー名を入力します。名前は必須ですが、接続設定に影響したり、他のインターフェイスで表示されたりすることはありません。
- [アプリケーション URL] フィールドに Jira システムの URL を入力します。URL には、例えば
http://jira.yourcompany.com:8080
のように、プロトコル、ホスト、およびポート番号を含める必要があります。パスまたはパラメーターは含めないでください。 - [表示 URL] フィールドは、Jira システムへのリンクが Web ブラウザーに表示されるときに Parasoft DTP ページに表示される URL を定義します。通常、これは上記のアプリケーション URL フィールドと同じである必要があります。ただし、たとえば、リバース プロキシ環境で作業していて、Parasoft DTP を使用するユーザーのローカル Web ブラウザーから Jira へのリンクが Parasoft DTP サーバーとは異なる場合は (例:http://jira.yourcompany.com)、違うことがあります。
- ユーザー名とパスワード (自己管理 Jira サーバー) または API トークン (Jira Cloud) を適切なフィールドに入力します。ログインには、[プロジェクトの関連付け] セクションで指定されたプロジェクトで Jira の課題を作成するのに十分な権限が必要です。
- (任意) JQL クエリーを入力し、Parasoft IDE プラグインおよび Jira トレーサビリティ レポートに表示される Jira 要件をフィルターできます。JQL クエリーは、DTP プロジェクトに関連付けられた Jira プロジェクトの要件 (「Associating Parasoft Projects with Jira」を参照) および
jira.issueType.requirement
設定でカスタマイズされた要件 (「Advanced Configuration」を参照) に適用されます。このクエリーは、Jira ダッシュボード ウィジェットで定義された JQL クエリーによって上書きされます (「ウィジェットの追加と設定」を参照)。 - [接続のテスト] をクリックして設定を確認し、[確認] をクリックします。
Xray Cloud への接続
Xray は、テストを管理する Jira の拡張機能です。Xray は、ホスト型またはクラウドベースのアプリケーションとして利用できます。DTP は、「Jira と DTP との接続」で説明するように、接続を介して、Xray のホストされたインスタンスにデータを送信できます。Xray のクラウド ベースのインスタンスの場合、[Xray (Cloud) 有効] オプションを有効にし、Xray クライアント ID とシークレットを指定して、「DTP から Jira/Xray への結果の送信」で説明した機能を活用できるようにします。
クライアント ID とシークレットの生成については、Xray のドキュメントを参照してください: https://docs.getxray.app/display/XRAYCLOUD/Global+Settings%3A+API+Keys
Parasoft プロジェクトと Jira プロジェクトを関連付ける
Parasoft プロジェクトと Jira プロジェクトを関連付けると、違反エクスプローラーまたはテスト エクスプローラー ビューから欠陥を作成し、Jira の適切なプロジェクトにリンクすることができます。Parasoft から Jira のトレーサビリティ設定 を使用する場合も関連付けは重要です。DTP の複数のプロジェクトを 1 つの Jira プロジェクトと関連付けることはできますが、同じ DTP プロジェクトを複数の Jira プロジェクトと関連付けることはできません。
- [プロジェクトの関連付けを作成] をクリックし、[DTP プロジェクト] メニューからプロジェクトを選択します。
- [外部プロジェクト] フィールドに Jira プロジェクトの名前を入力して [Create] をクリックし、関連付けを保存します。
プロジェクトの関連付けを削除するには、ゴミ箱のアイコンをクリックします。プロジェクトの関連付けを削除しても、Jira の欠陥へのリンクは DTP のエクスプローラー ビューで削除されません。関連付けを削除してから再作成すると、違反と Jira の課題との既存リンクが再び有効になります。
DTP と Jira プロジェクトの既存の関連付けの設定を変更できます。
- 鉛筆アイコンをクリックし、メニューから別の DTP プロジェクトを選択するか、[外部プロジェクト] フィールドに別の Jira プロジェクトの名前を指定します。
- [保存] をクリックします。
詳細設定
<DTP_DATA_DIR>/conf
ディレクトリにある ExternalSystemSettings.properties 構成ファイルを変更して、統合のデフォルトの動作を変更できます。すぐに利用できる DTP と Jira/Xray の統合は、デフォルトまたは一般的に使用されるフィールドとタイプを使用するように構成されています。ただし、Jira/Xray システムをカスタマイズしている場合は、下記で説明する設定を行って、DTP のデータをカスタムの Jira/Xray 構成に合わせることができます。
ExternalSystemSettings.properties は ISO 8859-1 (Latin1) 文字エンコーディングを使用することに注意してください。ISO 8859-1 でサポートされていない文字は、Unicode エスケープ シーケンス、つまりバックスラッシュ (\) と小文字の u の後に、その文字の 4 桁の 16 進コードが続くものを使用して、キーと要素で表現する必要があります。たとえば、ダッシュ (-) (ハイフン - マイナス ”-” と混同しないでください) は ISO 8859-1 ではサポートされていないため、Unicode エスケープ シーケンス \u2013
で表す必要があります。これにより、example.property.value=Foo – Bar
のようなものは、example.property.value=Foo \u2013 Bar
と入力する必要があります。
jiraIssueUrl | DTP の違反エクスプローラーとテスト エクスプローラーで作成された作業アイテムを Jira/Xray の作業アイテムにリンクするための URL テンプレートを指定します。 デフォルト:
URL パスの <JIRA_URL> セグメントの値は、DTP を Jira に接続するときに指定されます。「DTP を Jira に接続する」を参照してください。 |
---|---|
jira.issueType.bug | DTP の違反エクスプローラーとテスト エクスプローラーから作業アイテムを作成するときにバグの役割を担う Jira の課題タイプの名前を指定します。 デフォルトでは、このプロパティは設定されていません。その結果、DTP で作成されたバグ作業アイテムは、Jira のバグ作業アイテムに関連付けられます。 |
jira.issueType.task | DTP の違反エクスプローラーとテスト エクスプローラーから作業アイテムを作成するときにタスクの役割を担う Jira の課題タイプの名前を指定します。 デフォルトでは、このプロパティは設定されていません。その結果、DTP で作成された欠陥作業アイテムは、Jira のタスク作業アイテムに関連付けられます。 |
jira.issueType.test | テストの役割を担う Jira の課題タイプの名前を指定します。テスト結果が DTP から Jira/Xray に送信されると、テストはこの設定で指定された課題タイプとしてラベル付けされます。 デフォルト:
この設定は、Jira/Xray のオンプレミスおよびクラウド ベースのインスタンスで使用できます。 |
jira.issueType.requirement | DTP が要件とみなす Jira のエンティティ タイプを指定します。DTP はこの設定で指定された Jira エンティティをトレーサビリティ ウィジェットおよびレポートに表示します。DTP から Jira/Xray にテスト結果を送信する際、DTP はこの設定で指定されたエンティティのテスト ケースで デフォルト:
この設定は、Jira/Xray のオンプレミスおよびクラウド ベースのインスタンスで使用できます。 |
jira.testDone.transitionId | DTP から Jira/Xray に送信されるテストのカスタム ステータスを指定します。指定しない場合、完了したテストのデフォルトのシステム ステータスが使用されます。 システムで使用されるデフォルトのテスト ステータス名の取得については、「テストとテスト実行のデフォルト ステータスを取得する」を参照してください。 |
jira.testExecutionDone.transitionId | DTP から Jira/Xray に送信されるテスト実行のカスタム ステータスを指定します。指定しない場合、テスト実行のデフォルトのシステム ステータスが使用されます。 システムで使用されているテスト実行ステータス名の取得については、「テストとテスト実行のデフォルト ステータスを取得する」を参照してください。 |
jira.testType.customfieldId | Jira/Xray システムのテスト タイプ カスタム フィールドの ID を指定します。値は既存のカスタム フィールドと一致する必要があります。テストは、jira.testType.customfieldValue 設定で指定されたタイプに従ってラベル付けされます。 カスタム値を指定するには、 デフォルトでは、 詳細については「Getting Values for Custom Test Type Fields」を参照してください。 この設定は、Jira/Xray のオンプレミスおよびクラウド ベースのインスタンスで使用できます。 |
jira.testType.customfieldValue | 結果が DTP から Jira/Xray に送信されるときに作成されるテストに割り当てるテスト タイプを指定します。値は、Jira/Xray システムの既存のカスタム フィールドに一致する必要があります。カスタム値は、 カスタム値を指定するには、 デフォルトでは、 詳細については「カスタム テスト タイプ フィールドの値を取得する」を参照してください。 この設定は、Jira/Xray のオンプレミスおよびクラウド ベースのインスタンスで使用できます。 |
jira.xrayOnPremises.testCaseFindingStatus.pass | Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。 デフォルト:
この設定は、Jira/Xray のオンプレミスのインスタンスで使用できます。 |
jira.xrayOnPremises.testCaseFindingStatus.fail | Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、失敗したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。 デフォルト:
この設定は、Jira/Xray のオンプレミスのインスタンスで使用できます。 |
jira.xrayOnPremises.testCaseFindingStatus.incomplete | Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。 デフォルト:
この設定は、Jira/Xray のオンプレミスのインスタンスで使用できます。 |
jira.xrayOnPremises.testToRequirementRelationName | DTP から送信されたテストの Jira での要件タイプの名前を指定します。これにより、Jira で構成したカスタム名を使用して、テストを要件に関連付けることができます。 デフォルト:
この設定は、Jira/Xray のオンプレミスのインスタンスで使用できます。 |
jira.xrayCloud.testCaseFindingStatus.pass | Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。 デフォルト:
この設定は、Jira/Xray のクラウドのインスタンスで使用できます。 |
jira.xrayCloud.testCaseFindingStatus.fail | Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。 デフォルト:
この設定は、Jira/Xray のクラウドのインスタンスで使用できます。 |
jira.xrayCloud.testCaseFindingStatus.incomplete | Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。 デフォルト:
この設定は、Jira/Xray のクラウドのインスタンスで使用できます。 |
jira.xrayCloud.testToRequirementRelationName | DTP から送信されたテストの Jira での要件タイプの名前を指定します。これにより、Jira で構成したカスタム名を使用して、テストを要件に関連付けることができます。 デフォルト:
この設定は、Jira/Xray のクラウドのインスタンスで使用できます。 |
カスタム テスト タイプ フィールドの値を取得する
jira.testType.customfieldId
および jira.testType.customfieldValue
の設定は、DTP から Jira/Xray に送信されるテストのカスタム タイプを指定するために使用されます。jira.testType.customfieldId
はカスタム タイプのフィールドの名前を識別し、jira.testType.customfieldValue
は特定の値を識別します。両方の値が Jira/Xray システムに存在している必要があります。
jira.testType.customfieldId
設定の値を取得するには:
GET リクエストを次のエンドポイントに送信して、カスタム フィールドの値を取得します。
curl -X GET "http(s)://<jira-host>/rest/api/2/field"
- レスポンスで
Test Type
プロパティを含むカスタム フィールド オブジェクトを見つけます。 jira.testType.customfieldId
にid
プロパティを設定します。
jira.testType.customfieldId=customfield_10800
jira.testType.customfieldValue
設定の値を取得するには:
- Jira システムにログインし、Jira ツールバーの [Create] をクリックします。
- [Issue Type] メニューから [Test] (または相当するもの) を選択し、[Test Details] をクリックします。
- [Test Type] メニューを開き、DTP から送信されるテストに使用するタイプをコピーします。
jira.testType.customfieldValue
プロパティにテスト タイプ値を設定します。
jira.testType.customfieldValue=Automated[Generic]
ExternalAppsSettings.properties 構成ファイルを保存して、変更を適用します。
テストとテスト実行のデフォルト ステータスを取得する
jira.testDone.transitiondId
と jira.testExecutionDone.transitionId
の設定は、DTP から Jira/Xray に送信されるテストとテスト実行のカスタム ステータスを指定するために使用されます。Jira REST API を使用して、ExternalAppsSettings.properties ファイルで使用するステータス名を取得し、DTP から送信されたデータが Jira の既存のエンティティと一致するようにすることができます。
次の Jira transitions
エンドポイントにリクエストを送信し、Jira テスト ID を指定して、jira.testDone.transitiondId
設定の正しい値を判断します。
curl -X GET "http(s)://<jira_host>/rest/api/2/issue/<testId>/transitions"
ID とステータス名がレスポンスに表示されます。
ExternalAppsSettings.properties ファイルで ID を指定します。
jira.testDone.transitiondId=41
次の Jira transitions
エンドポイントにリクエストを送信し、Jira テスト実行 ID を指定して、jira.testExecutionDone.transitiondId
設定の正しい値を判断します。
curl -X GET "http(s)://<jira_host>/rest/api/2/issue/<testExecutionId>/transitions"
ID とステータス名がレスポンスに表示されます。
ExternalAppsSettings.properties ファイルで ID を指定します。
jira.testExecutionDone.transitiondId=31