Jira は、要件を管理するための一般的なブラウザー ベースのプラットフォームです。一方、Parasoft テスト ツールと DTP は、ソフトウェア プロジェクトで品質上の問題を検出したりテストを実行したりする包括的な自動テスト ツールを提供します。Jira を Parasoft DTP と統合することで、2 つの重要なシステム要素間のトレーサビリティを強化し、プロジェクトのワークフローを強化できます。
- Jira は、要件、欠陥、テストの定義を担当します。
- Parasoft テストツールは、自動テストを実行し、ソフトウェアの欠陥や違反を検出します。Parasoft DTP は、レポートと解析のダッシュボードです。
Parasoft ツールを Jira と統合すると、以下の機能が提供されます。
Parasoft DTP の違反エクスプローラーおよびテスト エクスプローラーからの Jira での欠陥の作成
Parasoft テスト ツールが静的解析違反を検出した場合、または自動テストの失敗が DTP でレポートされた場合、Parasoft DTP インターフェイスから直接、統合された Jira で欠陥レポートを簡単に作成できます。「Manually Creating Bugs and Tasks in Jira」を参照してください。
Parasoft テスト結果の Jira 要件およびテスト定義への送信
ソフトウェア要件は Jira で定義され、Parasoft ツールと DTP はこれらの要件の実装をテストするために使用されます。Parasoft DTP から Jira にテスト結果を送信することで、Jira のトレーサビリティ レポートを使用して、Jira のこれらの要件と Parasoft DTP のテスト結果の間のトレーサビリティを追跡できます。「Sending Test Data to Jira and Viewing Results」を参照してください。
Anchor Monitoring Monitoring
Parasoft DTP レポートのテスト結果に対する Jira 要件のトレーサビリティの監視
Monitoring | |
Monitoring |
このユースケースは前述の機能と似ています。Jira 要件から Parasoft テスト結果までのトレーサビリティを監視することを目的とします。しかし、違いはレポートのソースにあります。前述の機能では Jira でのレポートが容易になりましたが、この機能では Parasoft DTP のレポートを利用します。「Parasoft to Jira Traceability Reports」を参照してください。
設定
これらの機能を利用するには、事前にいくつかの設定が必要です。「Configuring Integration with Jira」を参照してください。
さらに、前述の「Parasoft DTP レポートのテスト結果に対する Jira 要件のトレーサビリティの監視」機能を使用する場合は、いくつかの追加構成が必要です。「Configuring Parasoft to Jira Traceability」を参照してください。
このセクションの内容:
Table of Contents | ||
---|---|---|
|
はじめに
Jira でソフトウェア開発プロジェクトを追跡および管理している場合、管理ページで DTP を Jira システムに接続できます。DTP と Jira の接続は、次の機能を実現します。
- Violations Explorer から手動で Jira の課題を作成する機能。
- Test Explorer から手動で Jira の課題を作成する機能。
- Jira の Xray プラグインを使用している場合は、Jira で Parasoft Test の結果を送信、表示、更新することもできます (「Jira/Xray へのテスト データの送信」を参照)。
- Jira のトレーサビリティ レポートを使用してトレーサビリティを追跡することを計画しているユーザー向け。これを行うには、最初に Parasoft DTP から Jira にテスト結果を送信する必要があります。
- テスト、静的解析結果、コード レビューを Jira の要件から追跡する機能 (「Viewing the Traceability Report」を参照)。
- Parasoft DTP のトレーサビリティ レポートを使用してトレーサビリティを追跡することを計画しているユーザー向け。これを行うには、@req を使用して、Parasoft の自動テストを Jira 要件に関連付けます。
要件
次の要件は、テスト結果を Jira に送信する場合にのみ適用されます。
- 次の Parasoft ツールが実行するテストがサポートされていること:
- C/C++test Professional、dotTEST、Jtest 10.4.3 以降
- Selenic 2020.1 以降
- SOAtest 9.10.8 以降
- Xray プラグイン
設定
この設定は、Parasoft 管理者が一度だけ行う必要があります。開発者、テスター、およびその他の DTP エンドユーザーは、Parasoft ツールを Jira と連携して使用する方法について、「Usage 」を参照してください。
...
- 設定ドロップダウン メニュー (歯車のアイコン) から [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 クエリーによって上書きされます (「Adding and Configuring the Widgets」を参照)。 - [接続のテスト] をクリックして設定を確認し、[確認] をクリックします。
...
Xray は、テストを管理する Jira の拡張機能です。Xray は、ホスト型またはクラウドベースのアプリケーションとして利用できます。DTP は、「Connecting DTP to Jira」で説明するように、接続を介して、Xray のホストされたインスタンスにデータを送信できます。Xray のクラウド ベースのインスタンスの場合、[Xray (Cloud) 有効] オプションを有効にし、Xray クライアント ID とシークレットを指定して、「DTP から Jira/Xray への結果の送信」セクションで説明した機能を活用できるようにします。
クライアント ID とシークレットの生成については、Xray のドキュメントを参照してください: https://docs.getxray.app/display/XRAYCLOUD/Global+Settings%3A+API+Keys
...
Parasoft プロジェクトと Jira プロジェクトを関連付けると、違反エクスプローラーまたはテスト エクスプローラー ビューから欠陥を作成し、Jira の適切なプロジェクトにリンクすることができます。Sending Test Data to External System フロー を使用する場合、関連付けも重要です。DTP の複数のプロジェクトを 1 つの Jira プロジェクトと関連付けることはできますが、同じ DTP プロジェクトを複数の Jira プロジェクトと関連付けることはできません。
- [プロジェクトの関連付けを作成] をクリックし、[DTP プロジェクト] ドロップダウン メニューからプロジェクトを選択します。
- [外部プロジェクト] フィールドに Jira プロジェクトの名前を入力して [Create] をクリックし、関連付けを保存します。
プロジェクトの関連付けを削除するには、ゴミ箱のアイコンをクリックします。プロジェクトの関連付けを削除しても、Jira の欠陥へのリンクは DTP のエクスプローラー ビューで削除されません。関連付けを削除してから再作成すると、違反と Jira の課題との既存リンクが再び有効になります。
DTP と Jira プロジェクトの既存の関連付けの設定を変更できます。
- 鉛筆アイコンをクリックし、ドロップダウン メニューから別の DTP プロジェクトを選択するか、[外部プロジェクト] フィールドに別の Jira プロジェクトの名前を指定します。
- [保存] をクリックします。
...
Jira に保存された要件、および Parasoft ツール (C/C++test、dotTEST、Jtest、SOAtest) から DTP に送信されたテスト データ、静的解析データ、ビルド レビュー データとの間のトレーサビリティを実証するのに役立つウィジェットとレポートを生成するように、DTP を構成できます。
Traceability Report にコード レビューと静的解析情報を含める場合は、ソース コード ファイルを Jira のストーリーに関連付ける必要があります。この機能を有効化する方法については「Associating Requirements with Files」を参照してください。
Traceability Pack に同梱されている External System Traceability Report アーティファクトをデプロイすることで、トレーサビリティを表示および追跡する DTP インターフェイスが有効になります。Traceability Pack には、要件のトレーサビリティ ワークフローの一部を自動化する Sending Test Data to External System フ ローも含まれています。Traceability Pack の詳細については、Traceability Pack のドキュメントを参照してください。
DTP Extension Designer を使用して、External System Traceability Report および Sending Test Data to External System フローを環境にデプロイします。アーティファクトを展開する前に、「Connecting DTP to Jira」で説明されているように、DTP が Jira に接続されていることを確認します。
...
最初のステップは、 Traceability Pack アーティファクトをインストールすることです。このアーティファクトは、トレーサビリティを可能にする構成ファイルとアセットの集合です。
- 設定メニュー (歯車のアイコン) から [Extension Designer] を選択します。
- [構成] タブをクリックしてアーティファクト マネージャーを開きます。
- [アーティファクトの追加] をクリックし、traceability-pack-<version>.zip アーカイブを参照します (「Downloading and Installing Artifacts」も参照)。
- [インストール] をクリックすると、トレーサビリティを有効にするためのアセットと構成ファイルの集合がインストールされます。
...
External System Traceability Report アーティファクトをインストールした後、レポート コンポーネントを DTP 環境にデプロイします。
...
External System Traceability Report をデプロイすると、Report Center にドリルダウン レポートと新しいウィジェットが追加されます。ウィジェットを追加してレポートを参照する方法については「Viewing the Traceability Report」を参照してください。
...
このアーティファクトは、DTP Data Collector が Parasoft ツールからテスト結果を取得するときに、テスト データを Jira に送信します。このアーティファクトは Traceability Pack に同梱されており、「Installing the Traceability Pack」の説明にあるように、フローをデプロイする前にインストールする必要があります。
...
<DTP_DATA_DIR>/conf ディレクトリにある ExternalSystemSettings.properties 構成ファイルを変更して、統合のデフォルトの動作を変更できます。すぐに利用できる DTP と Jira/Xray の統合は、デフォルトまたは一般的に使用されるフィールドとタイプを使用するように構成されています。ただし、Jira/Xray システムをカスタマイズしている場合は、次の設定を行って、DTP のデータをカスタムの Jira/Xray 構成に合わせることができます。
Scroll Table Layout | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
DTP の違反エクスプローラーとテスト エクスプローラーで作成された作業アイテムを Jira/Xray の作業アイテムにリンクするための URL テンプレートを指定します。
デフォルト:
JiraIssueUrl=<JIRA_URL>/browse/<ID>
URL パスの <JIRA_URL> セグメントの値は、DTP を Jira に接続するときに指定されます。「Connecting DTP to Jira」を参照してください。
...
DTP の違反エクスプローラーとテスト エクスプローラーから作業アイテムを作成するときにバグの役割を担う Jira の課題タイプの名前を指定します。
デフォルトでは、このプロパティは設定されていません。その結果、DTP で作成されたバグ作業アイテムは、Jira のバグ作業アイテムに関連付けられます。
...
DTP の違反エクスプローラーとテスト エクスプローラーから作業アイテムを作成するときにタスクの役割を担う Jira の課題タイプの名前を指定します。
デフォルトでは、このプロパティは設定されていません。その結果、DTP で作成された欠陥作業アイテムは、Jira のタスク作業アイテムに関連付けられます。
...
テストの役割を担う Jira の課題タイプの名前を指定します。テスト結果が DTP から Jira/Xray に送信されると、テストはこの設定で指定された課題タイプとしてラベル付けされます。
デフォルト:
jira.issueType.test=Test
この設定は、Jira/Xray のオンプレミスおよびクラウド ベースのインスタンスで使用できます。
...
DTP が要件とみなす Jira のエンティティ タイプを指定します。DTP はこの設定で指定された Jira エンティティをトレーサビリティ ウィジェットおよびレポートに表示します。DTP から Jira/Xray にテスト結果を送信する際、DTP はこの設定で指定されたエンティティのテスト ケースで @req
アノテーションで指定された ID と一致するものを更新または作成します。
デフォルト:
jira.issueType.requirement=Story
この設定は、Jira/Xray のオンプレミスおよびクラウド ベースのインスタンスで使用できます。
...
DTP から Jira/Xray に送信されるテストのカスタム ステータスを指定します。指定しない場合、完了したテストのデフォルトのシステム ステータスが使用されます。
システムで使用されるデフォルトのテスト ステータス名の取得については、「Getting Default Test and Test Execution Statuses」を参照してください。
...
DTP から Jira/Xray に送信されるテスト実行のカスタム ステータスを指定します。指定しない場合、テスト実行のデフォルトのシステム ステータスが使用されます。
システムで使用されているテスト実行ステータス名の取得については、「Getting Default Test and Test Execution Statuses」を参照してください。
...
Jira/Xray システムのテスト タイプ カスタム フィールドの ID を指定します。値は既存のカスタム フィールドと一致する必要があります。テストは、jira.testType.customfieldValue 設定で指定されたタイプに従ってラベル付けされます。
カスタム値を指定するには、jira.testType.customfieldId
と jira.testType.customfieldValue
の両方を設定する必要があります。
デフォルトでは、jira.testType.customfieldId
と jira.testType.customfieldValue
の両方の設定が構成されていません。結果として、デフォルトのテスト タイプ値が使用されます。
詳細については「Getting Values for Custom Test Type Fields」を参照してください。
この設定は、Jira/Xray のオンプレミスおよびクラウド ベースのインスタンスで使用できます。
...
結果が DTP から Jira/Xray に送信されるときに作成されるテストに割り当てるテスト タイプを指定します。値は、Jira/Xray システムの既存のカスタム フィールドに一致する必要があります。カスタム値は、 jira.testType.customfieldId
設定で指定された ID によって識別されます。
カスタム値を指定するには、jira.testType.customfieldId
と jira.testType.customfieldValue
の両方を設定する必要があります。jira.testType.customfieldId
または jira.testType.customfieldValue
設定のみが構成されている場合は、エラーになります。
デフォルトでは、jira.testType.customfieldId
と jira.testType.customfieldValue
の両方の設定が構成されていません。結果として、デフォルトのテスト タイプ値が使用されます。
詳細については「Getting Values for Custom Test Type Fields」を参照してください。
この設定は、Jira/Xray のオンプレミスおよびクラウド ベースのインスタンスで使用できます。
...
Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。
デフォルト:
jira.xrayOnPremises.testCaseFindingStatus.pass=PASS
この設定は、Jira/Xray のオンプレミスのインスタンスで使用できます。
...
Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、失敗したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。
デフォルト:
jira.xrayOnPremises.testCaseFindingStatus.fail=FAIL
この設定は、Jira/Xray のオンプレミスのインスタンスで使用できます。
...
Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。
デフォルト:
jira.xrayOnPremises.testCaseFindingStatus.incomplete=ABORTED
この設定は、Jira/Xray のオンプレミスのインスタンスで使用できます。
...
DTP から送信されたテストの Jira での要件タイプの名前を指定します。これにより、Jira で構成したカスタム名を使用して、テストを要件に関連付けることができます。
デフォルト:
jira.xrayOnPremises.testToRequirementRelationName=Tests
この設定は、Jira/Xray のオンプレミスのインスタンスで使用できます。
...
Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。
デフォルト:
jira.xrayCloud.testCaseFindingStatus.pass=PASS
この設定は、Jira/Xray のクラウドのインスタンスで使用できます。
...
Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。
デフォルト:
jira.xrayCloud.testCaseFindingStatus.fail=FAIL
この設定は、Jira/Xray のクラウドのインスタンスで使用できます。
...
Jira/Xray のテスト実行ステータス名を指定して、DTP から送信された、成功したテスト結果に割り当てます。これにより、Jira/Xray で構成したカスタムのステータスを DTP でのテスト結果に設定することができます。
デフォルト:
jira.xrayCloud.testCaseFindingStatus.incomplete=ABORTED
この設定は、Jira/Xray のクラウドのインスタンスで使用できます。
...
DTP から送信されたテストの Jira での要件タイプの名前を指定します。これにより、Jira で構成したカスタム名を使用して、テストを要件に関連付けることができます。
デフォルト:
jira.xrayCloud.testToRequirementRelationName=Test
この設定は、Jira/Xray のクラウドのインスタンスで使用できます。
カスタム テスト タイプ フィールドの値を取得する
jira.testType.customfieldId
および jira.testType.customfieldValue
の設定は、DTP から Jira/Xray に送信されるテストのカスタム タイプを指定するために使用されます。jira.testType.customfieldId
はカスタム タイプのフィールドの名前を識別し、jira.testType.customfieldValue
は特定の値を識別します。両方の値が Jira/Xray システムに存在している必要があります。
jira.testType.customfieldId
設定の値を取得するには:
GET リクエストを次のエンドポイントに送信して、カスタム フィールドの値を取得します。
No Format curl -X GET "http(s)://<jira-host>/rest/api/2/field"
- レスポンスで
Test Type
プロパティを含むカスタム フィールド オブジェクトを見つけます。 jira.testType.customfieldId
にid
プロパティを設定します。
No Format |
---|
jira.testType.customfieldId=customfield_10800 |
jira.testType.customfieldValue
設定の値を取得するには:
- Jira システムにログインし、Jira ツールバーの [Create] をクリックします。
- [Issue Type] ドロップダウン メニューから [Test] (または相当するもの) を選択し、[Test Details] をクリックします。
- [Test Type] ドロップダウン メニューを開き、DTP から送信されるテストに使用するタイプをコピーします。
jira.testType.customfieldValue
プロパティにテスト タイプ値を設定します。
No Format |
---|
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
設定の正しい値を判断します。
No Format |
---|
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
設定の正しい値を判断します。
No Format |
---|
curl -X GET "http(s)://<jira_host>/rest/api/2/issue/<testExecutionId>/transitions" |
ID とステータス名がレスポンスに表示されます。
ExternalAppsSettings.properties ファイルで ID を指定します。
jira.testExecutionDone.transitiondId=31
使用
Jira ALM との統合を設定した後、開発者、テスター、およびその他のユーザーは、統合によって実現される機能を活用できます。
Jira ALM でのバグとタスクの手動作成
テスト エクスプローラーと違反エクスプローラーを使用すると、ステータスに関係なく、テストと違反に対してそれぞれバグとタスクを作成できます。テスト エクスプローラーまたは違反エクスプローラーで Jira アセットを作成する方法については、以下のセクションを参照してください。
- 違反エクスプローラーから Jira のバグとタスクを手動で作成する方法については、「サードパーティ システムでの課題の作成」を参照してください。
- テスト エクスプローラーから Jira のバグとタスクを手動で作成する方法については、「サードパーティ システムでの課題の作成」を参照してください。
...
次の図は、Jira 環境に Parasoft DTP および Parasoft テスト実行ツールを統合するための自動インフラストラクチャの実装方法を示しています。
- Jira でテストやストーリーを作成します。アイテムは、Parasoft C/C++test、dotTEST、または Jtest によって実行されるテストに関連付けられます。
- テスト ファイルで、
@test
または@req
アノテーションを使用して Jira のテスト ケースまたは要件 ID を追加します。アノテーションの追加の詳細については、C/C++test、dotTEST、または Jtest のドキュメントを参照してください。@test <Jira Test ID>
アノテーションを使用して、テストを Jira のテスト実行に関連付けます。@req <Jira Story ID>
アノテーションを使用して、テストを Jira のストーリーに関連付けます。- Jira の作業アイテム ID は、URL などのいくつかの Jira インターフェイスで使用できます。
- CI プロセスの一部としてテストを実行します。IDE からテストを手動で実行することもできます。
- テスト実行の一環として、Parasoft テスト実行ツールはフィルターとビルド ID でテスト結果をタグ付けし、データを DTP に送信します。DTP ダッシュボードに テスト ウィジェット を追加し、フィルターとビルド ID を設定することにより、DTP で結果を確認できます。開発者は、テスト実行データを DTP から IDE にダウンロードして、失敗したテストに対処できます。
Sending Test Data to External System フローをデプロイした場合 (「Deploying the Sending Test Data to External System Flow」を参照)、Data Collector が Parasoft ツールからデータを受信すると、単体テストと機能テストの結果が Jira に自動的に送信されます。 デフォルトでは、フローは Data Collector が受信した任意のプロジェクトの単体テストおよび機能テストの結果をフォワードしますが、特定のプロジェクトのデータだけを送信するようフローを設定できます (「Sending Results from a Specific DTP Project」を参照)。また、DTP REST API エンドポイントに POST リクエストを手動で送信して、DTP データベースから Jira に結果を送信することもできます (「Manually Send a POST Request to the DTP REST API Endpoint」を参照)。
- DTP は、filterId パラメーターと buildId パラメーターに一致するテスト結果を見つけ、そのデータを Jira のアイテムに送信します。
- DTP は、@test <ID> で結果を見つけると、Jira で一致する ID を持つテストを検索して更新します。Jira に ID が存在しない場合、アクションは実行されません。
- DTP は、@req <ID> で結果を見つけると、一致する ID を持つ Jira のストーリーを検索し、ストーリーにテスト実行を追加します。ID が存在しない場合、新しいテスト実行が Jira に追加されます。
- external-app-sync.log ファイルも <DTP_INSTALL>/logs ディレクトリに書き込まれます。このログ ファイルには、DTP から Jira へのテスト結果の送信に関する進捗情報が含まれています。
DTP がレポートを処理し、結果を Jira に送信した後、以下のような応答があります。
No Format |
---|
{
"createdTestSession": "DTPP-521",
"created": [
"DTPP-519, testName = testBagSumAdd"
],
"updated": [
"DTPP-519, testName = testBagSumAdd",
"DTPP-518, testName = testBagSimpleAdd"
],
"ignored": [
"MAGD-567, testName = testBagNegate",
"QAP-512, testName = testTryThis3",
"QAP-512, testName = testTryThis4",
"MAGD-567, testName = testBagMultiply"
]
} |
DTP REST API エンドポイントへ POST リクエストを手動送信する
Traceability Pack に同梱されている Sending Test Data to External System Flow は、DTP で新しい結果が収集されると、DTP から Jira にデータを自動的に送信します (「Deploying the Sending Test Data to External System Flow」を参照)。または、POST リクエストを DTP REST API エンドポイントに送信して、このアクションを開始することもできます (このエンドポイントの詳細については「syncTestCases Endpoint Reference」を参照)。
API 呼び出しの DTP フィルターとビルド ID を URL パラメーターとして渡します。
No Format |
---|
curl -X POST -u <username>:<password> "http://<host>:<port>/grs/api/v1.7/linkedApps/configurations/1/syncTestCases?filterId=<filterID>&buildId=<buildID>" |
フィルターおよびビルド ID は、テスト エクスプローラーの URL で利用できます。
Parasoft トレーサビリティ レポートに加えて、または Parasoft トレーサビリティ レポートの代わりに Jira の Xray トレーサビリティ レポートを使用している場合、Jira に送信されるテスト情報には Fix Version フィールドが含まれていなければなりません。デフォルトでは、DTP API は Jira でテスト実行エンティティを作成するときに FixVersion フィールドに入力しませんが、fixVersions
パラメーターを API に追加し、1 つ以上の値を指定してフィールドに入力できます。
No Format |
---|
curl -X POST "https://<host>:<port>/grs/api/v1.7/linkedApps/configurations/1/syncTestCases?filterId=<filterID>&buildId=<buildID>&fixVersions=<version1>,<version2>" |
fixVersions
パラメーターを使用するには、まず Jira プロジェクトで Version フィールドを有効化する必要があります。パラメーターの値は、Jira プロジェクトで指定されたバージョンに一致している必要があります。次の例では、fixVersions=1.0
のテストが更新されます。
バージョンの設定については、Jira のドキュメントを参照してください。
syncTestCases エンドポイント リファレンス
syncTestCases エンドポイントは、DTP にレポートされたテスト データを統合 ALM システムに送信します。
Scroll Table Layout | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
メソッド
...
以下の表でエンドポイントのパラメーターについて説明します。
Scroll Table Layout | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
true
に設定すると、SOAtest の結果が .tst ファイルでグループ化されます。その結果、1 つの .tst ファイルが 1 つの Xray テストに関連付けられます。
false
に設定すると、SOAtest.tst 内の各テストステップが Xray テストに関連付けられます。
デフォルトは false
です。
詳細については「Changing Test Granularity for SOAtest Results」を参照してください。
...
SOAtest 結果のテスト粒度の変更
SOAtest は、次のようないくつかのテスト戦略を柔軟に実行することができます。
- 多くのテストステップを含む、限られた .tst ファイルのセットを作成する
- 限られた数のテストステップで多くの .tst ファイルを作成する
- 上記の戦略の組み合わせ/バランス
デフォルトでは、SOAtest .tst ファイルの各テスト ステップは、Xray テストに関連付けられます。しかし、機能テストが多くの .tst ファイルに分散している場合、この構成は組織にとって粒度が大きすぎるかもしれません。syncTestCases エンドポイント呼び出しに groupResultsBySOAtestTST=true
を追加することで、デフォルトの動作を変更することができます。例:
No Format |
---|
curl -X POST "https://<host>:<port>/grs/api/v1.7/linkedApps/configurations/1/syncTestCases?filterId=<filterID>&buildId=<buildID>&groupResultsBySOAtestTST=true" |
Sending Test Data to External Systems フローをデプロイした場合、linkedApps - syncTestCases ノードにパラメーターを追加すると、.tst ファイルによるグループ化を有効にすることができます。
特定の DTP プロジェクトの結果を送信する
Sending Test Data to External System フローを使用して単体テストおよび機能テストの結果を送信している場合、デフォルトでは、すべての DTP プロジェクトのデータが Jira に送信されます。結果として、Jira ID に一致するアノテーションを含むすべての DTP プロジェクトで収集されたテストを含むよう、作業アイテムが更新されます。ただし、特定のプロジェクトのデータだけを送信するよう、フローを設定することもできます。
- Extension Designer を開き、Sending Test Data がデプロイされたサービスを開きます。
- ワークスペースに新しいスイッチ ノードをドラッグします。
- "DataCollectorProcessedEvent" ノードと "Is dynamic analysis" ノードの間の接続線を選択して削除します。
- "DataCollectorProcessedEvent" ノードからスイッチ ノード、またスイッチ ノードから "Is dynamic analysis" ノードに新しい接続をドラッグします。
ノードをダブルクリックし、Property フィールドに次の文字列を指定します。
No Format event.message.resultsSession.project
- 文字列フィールドに DTP プロジェクトの名前を指定します。
- (任意) ノードのわかりやすい名前を指定します。
- [終了] をクリックしてノードの設定を終了し、[デプロイ] をクリックします。
フローを実行すると、指定した DTP プロジェクトのテスト結果だけが Jira に送信されます。
Jira/Xray での結果の表示
テスト データを送信した後、Jira で結果を表示できます。次の図は、いくつかのテストを含む Jira ストーリーを示しています。
ストーリーに関連付けられているテストをクリックして、詳細情報を表示できます。
また、テストに関連付けられたテスト実行を表示することもできます。
...
ご使用のシステムに External System Traceability Report がデプロイされている場合 (「Enabling the Requirements Traceability Report」を参照)、ウィジェットをダッシュボードに追加して、要件からプロジェクトのテスト/静的解析/コードレビューまでのトレーサビリティをモニタリングできます。ウィジェットから、さらに詳細な情報を含むレポートを表示できます。
ウィジェットの追加と構成
DTP ダッシュボード追加されたウィジェットは、個別のトレーサビリティ カテゴリに表示されます。ウィジェットを追加する方法については「Adding Widgets」を参照してください。
以下の設定を行うことができます。
...
クエリーを指定して、ウィジェットに表示する作業アイテムを定義します。空白のままにすると、統合設定で指定された JQL が適用されます (「Connecting DTP to Jira」を参照)。このフィールドで定義されたクエリーは、統合設定で構成された JQL を上書きします。
JQL が指定されている場合、その JQL が Requirement Traceability レポート のヘッダーに表示されます。
Requirements Widget
このウィジェットには、指定された Jira プロジェクトの要件の数が表示されます。
ウィジェットをクリックすると、Requirement Traceability レポート が表示されます。
Test Coverage Widget
このウィジェットは、プロジェクトのすべての要件に対する、テストでカバーされた要件の割合を示します。
ウィジェットの中央をクリックすると、Requirement Traceability レポート が表示されます。
色付きのセグメントは、テストの対象となる要件を表しています。ウィジェットをクリックすると、With Tests カテゴリにフィルタリングされた Requirement Traceability レポート が表示されます。
Pie Widget
単体テスト、機能テスト、静的解析、およびピア レビューは、要件が適切かつ徹底的に実装されているかを検証するための一般的なアクティビティです。このウィジェットは、それらのソフトウェア品質アクティビティのコンテキストにおけるプロジェクト要件の全般的なステータスを表示します。品質アクティビティの種類 (テスト、静的解析違反、レビュー) ごとにウィジェットを追加して、プロジェクトの要件実装の進捗をモニタリングすることができます。
グラフ上のセクションにマウス ポインタを置くと、品質アクティビティ タイプのステータスについて詳細情報が表示されます。ウィジェットをクリックすると、そのタイプでフィルタリングされた Requirement Traceability レポートが表示されます。
Requirements Implementation Status by Tests
Requirements Implementation Status by Violations
Requirements Implementation by Reviews
Requirements Traceability Report とは
このレポートは、JIRA の要件とそれに関連するデータを表示します。
以下の操作を行うことができます。
- レポートの [Files] 列と [Reviews] 列を非表示にする場合は、[Show files/reviews] オプションを無効にします。[Files] 列と [Reviews] 列にデータがあるのは、要件がソース ファイルにマッピングされている場合だけです (「Enabling the Requirements Traceability Report」を参照)。この画面で [Files] 列および [Reviews] 列を無効にすると、関連するタブが Requirement Details レポート で非表示になります。
- [Key] 列のリンクをクリックして、その要件に対する Requirement Details レポート を表示します。
- [Summary] 列または [Test] 列のリンクをクリックして、 Requirement Details Report の要件に関係するテスト関連情報を表示します。
- the Requirement Details report.
- [Files] 列のリンクをクリックして、 Requirement Details Report の要件に関係する静的解析関連の情報を表示します。
- [Reviews] 列のリンクをクリックして、 Requirement Details Report の要件に関係する変更レビュー関連の情報を表示します。
Requirement Traceability Report by Type
Requirements - Pie ウィジェットのセクションをクリックすると、ウィジェットで選択した品質アクティビティ タイプだけを含むレポートが表示されます。ドロップダウン メニューを使ってタイプとステータスを切り替えることができます。[Show files/reviews] オプションを無効にして、レポートの [Files] 列と [Reviews] 列を非表示にすることもできます。[Files] 列と [Reviews] 列にデータがあるのは、要件がソース ファイルにマッピングされている場合だけです (「Enabling the Requirements Traceability Report」を参照)。この画面で [Files] 列および [Reviews] 列を無効にすると、関連するタブが Requirement Details レポート で非表示になります。
Requirement Details Report とは
Requirement Details レポートは、Jira の要件に関連したファイルとテストについての情報を表示します。このレポートは、Requirement Traceability レポートで要件をクリックすることで表示されます。
最初のタブには、作業アイテムを検証するために実行されたテストの結果が表示されます。
[View results in Test Explorer] リンクをクリックすると、要件に関連付けられたすべてのテストを Test Explorer で参照できます。
テーブルの個々のテスト名をクリックし、テスト エクスプローラーで個々のテストを参照することもできます。
2 番目のタブには、要件に関連付けられたファイルと、ファイルで検出された静的解析違反が表示されます。[違反] 列のリンクをクリックして、Violations Explorer で違反を確認できます。違反に関する詳細が表示されます。
このタブにデータがあるのは、要件がソース ファイルにマッピングされている場合だけです (「Enabling the Requirements Traceability Report」を参照)。要件をソース ファイルにマッピングしなかった場合は、メインの Traceability レポート ページで [ファイル/レビューを表示] オプションを無効にし、詳細レポートを再読み込みすることで、このタブを非表示にできます。
ファイルに変更レビューまたはレビュー指摘事項が含まれる場合、それらは 3 番目のタブに表示されます。リンクをクリックすると、Change Explorer で確認できます。
このタブにデータがあるのは、要件がソース ファイルにマッピングされている場合だけです (「Enabling the Requirements Traceability Report」を参照)。要件をソース ファイルにマッピングしなかった場合は、メインの Traceability レポート ページで [ファイル/レビューを表示] オプションを無効にし、詳細レポートを再読み込みすることで、このタブを非表示にできます。