このセクションの内容:

はじめに

Jira でソフトウェア開発プロジェクトを追跡および管理している場合、管理ページで DTP を Jira システムに接続できます。DTP と Jira の接続は、次の機能を実現します。

• 違反エクスプローラー から手動で Jira の課題を作成する機能。
• テスト エクスプローラー から手動で Jira の課題を作成する機能。
• Jira の Xray プラグインを使用している場合は、Jira で Parasoft Test の結果を送信、表示、更新することもできます (「Jira/Xray へのテスト データの送信」を参照)。
• テスト、静的解析結果、コード レビューを Jira の要件から追跡する機能 (「Traceability Report の表示」を参照)。 

要件

この機能は、Jira Project Management Software v8.0.2＃800010 および Jira Cloud でテストされています。この機能は、Jira の他のバージョンでは期待どおりに機能しない可能性があります。 

次の要件は、テスト結果を Jira に送信する場合にのみ適用されます。

• 次の Parasoft ツールが実行するテストがサポートされていること:
  • C/C++test Professional、dotTEST、Jtest 10.4.3 以降
  • Selenic 2020.1 以降
  • SOAtest 9.10.8 以降
• Xray プラグイン

設定

この設定は、Parasoft 管理者が一度だけ行う必要があります。開発者、テスター、およびその他の DTP エンドユーザーは、Parasoft ツールを Jira と連携して使用する方法について、「使用 」を参照してください。

DTP を Jira に接続する

1. 設定ドロップダウン メニュー (歯車のアイコン) から [Report Center 設定] を選択します。
2. [External System] を選択し、[システム タイプ] ドロップダウンメニューから Jira を選択します。
3. [Enabled] オプションを有効化します。
4. [名前] フィールドにサーバー名を入力します。名前は必須ですが、接続設定に影響したり、他のインターフェイスで表示されたりすることはありません。
5. [アプリケーション URL] フィールドに Jira システムの URL を入力します。URL には、プロトコル、ホスト、およびポート番号を含める必要があります。例:http://jira.yourcompany.com:8080パスまたはパラメーターは含めないでください。
6. [表示 URL] フィールドに、DTP から Jira システムへのリンクをレンダリングするための URL を入力します。この URL には、ブラウザーで Jira にアクセスするために必要な追加のパスを含める必要があります (たとえば http://jira.yourcompany.com)。
7. ユーザー名とパスワード (自己管理 Jira サーバー) または API トークン (Jira Cloud) を適切なフィールドに入力します。ログインには、[プロジェクトの関連付け] セクションで指定されたプロジェクトで Jira の課題を作成するのに十分な権限が必要です。 
8. (任意) JQL クエリーを入力し、Parasoft IDE プラグインおよび Jira トレーサビリティ レポートに表示される Jira 要件をフィルターできます。JQL クエリーは、DTP プロジェクトに関連付けられた Jira プロジェクトの要件 (「Parasoft プロジェクトと Jira プロジェクトを関連付ける」を参照) および jira.issueType.requirement 設定でカスタマイズされた要件 (「詳細設定」を参照) に適用されます。   
9. [接続のテスト] をクリックして設定を確認し、[保存] をクリックします。

Xray Cloud への接続

Xray は、テストを管理する Jira の拡張機能です。Xray は、ホスト型またはクラウドベースのアプリケーションとして利用できます。DTP は、「DTP を Jira に接続する」で説明するように、接続を介して、Xray のホストされたインスタンスにデータを送信できます。Xray のクラウド ベースのインスタンスの場合、[Xray (Cloud) 有効] オプションを有効にし、Xray クライアント ID とシークレットを指定して、「DTP から Jira/Xray への結果の送信」セクションで説明した機能を活用できるようにします。

クライアント ID とシークレットの生成については、Xray のドキュメントを参照してください: https://confluence.xpand-it.com/display/XRAYCLOUD/Global+Settings%3A+API+Keys

Parasoft プロジェクトと Jira プロジェクトを関連付ける

Parasoft プロジェクトと Jira プロジェクトを関連付けると、違反エクスプローラーまたはテスト エクスプローラー ビューから欠陥を作成し、Jira の適切なプロジェクトにリンクすることができます。Sending Test Data to External System フロー を使用する場合、関連付けも重要です。DTP の複数のプロジェクトを 1 つの Jira プロジェクトと関連付けることはできますが、同じ DTP プロジェクトを複数の Jira プロジェクトと関連付けることはできません。

1. [プロジェクトの関連付けを作成] をクリックし、[DTP プロジェクト] ドロップダウン メニューからプロジェクトを選択します。 
2. [外部プロジェクト] フィールドに Jira プロジェクトの名前を入力して [Create] をクリックし、関連付けを保存します。

プロジェクトの関連付けを削除するには、ゴミ箱のアイコンをクリックします。プロジェクトの関連付けを削除しても、Jira の欠陥へのリンクは DTP のエクスプローラー ビューで削除されません。関連付けを削除してから再作成すると、違反と Jira の課題との既存リンクが再び有効になります。 

DTP と Jira プロジェクトの既存の関連付けの設定を変更できます。

1. 鉛筆アイコンをクリックし、ドロップダウン メニューから別の DTP プロジェクトを選択するか、[外部プロジェクト] フィールドに別の Jira プロジェクトの名前を指定します。
2. [保存] をクリックします。 

Requirements Traceability Report の有効化

Jira に保存された要件、および Parasoft ツール (C/C++test、dotTEST、Jtest、SOAtest) から DTP に送信されたテスト データ、静的解析データ、ビルド レビュー データとの間のトレーサビリティを実証するのに役立つウィジェットとレポートを生成するように、DTP を構成できます。

Traceability Report にコード レビューと静的解析情報を含める場合は、ソース コード ファイルを Jira のストーリーに関連付ける必要があります。この機能を有効化する方法については「ファイルと要件の関連付け」を参照してください。

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 フローを環境にデプロイします。アーティファクトを展開する前に、「DTP を Jira に接続する」で説明されているように、DTP が Jira に接続されていることを確認します。 

Traceability Pack をインストールする

最初のステップは、 Traceability Pack アーティファクトをインストールすることです。このアーティファクトは、トレーサビリティを可能にする構成ファイルとアセットの集合です。

1. 設定メニュー (歯車のアイコン) から [Extension Designer] を選択します。 
   
2. [構成] タブをクリックしてアーティファクト マネージャーを開きます。
3. [アーティファクトの追加] をクリックし、traceability-pack-<version>.zip アーカイブを参照します (「アーティファクトのダウンロードとインストール」も参照)。
4. [インストール] をクリックすると、トレーサビリティを有効にするためのアセットと構成ファイルの集合がインストールされます。

Traceability Report をデプロイする

External System Traceability Report アーティファクトをインストールした後、レポート コンポーネントを DTP 環境にデプロイします。

1. Extension Designer を開き、[サービス] タブをクリックします。
2. 既存のサービスを選択してアーティファクトを展開するか、[DTP ワークフロー] カテゴリで新しいサービスを作成します。サービスとアーティファクトの編成に関する追加情報については、「サービスの使用 」を参照してください。
   
3. 既存のサービスにアーティファクトを追加する場合は、新しい [フロー] タブを追加し (「フローの使用」を参照)、縦の三点メニューから [読み込み] を選択します。
4. [ライブラリ] > [Workflows] > [Traceability Pack] > [External System Traceability Report] を選択し、[読み込み] をクリックします。
   
5. [フロー] タブの中をクリックしてサービスにノードをドロップし、[デプロイ] をクリックします。 

External System Traceability Report をデプロイすると、Report Center にドリルダウン レポートと新しいウィジェットが追加されます。ウィジェットを追加してレポートを参照する方法については「Traceability Report の表示」を参照してください。

Sending Test Data to External System フローのデプロイ

このアーティファクトは、DTP Data Collector が Parasoft ツールからテスト結果を取得するときに、テスト データを Jira に送信します。このアーティファクトは Traceability Pack に同梱されており、「Traceability Pack をインストールする」の説明にあるように、フローをデプロイする前にインストールする必要があります。 

1. Extension Designer を開き、[サービス] タブをクリックします。
2. 既存のサービスを選択してアーティファクトを展開するか、[DTP ワークフロー] カテゴリで新しいサービスを作成します。サービスとアーティファクトの編成に関する追加情報については、「サービスの使用 」を参照してください。
3. 既存のサービスにアーティファクトを追加する場合は、新しい [フロー] タブを追加し (「フローの使用」を参照)、縦の三点メニューから [読み込み] を選択します。
4. [Library] > [Workflows] > [Traceability Pack] > [Sending Test Data to External System] を選択し、[インポート] をクリックします。
   
5. [フロー] タブの中をクリックしてサービスにノードをドロップし、[デプロイ] をクリックします。 

詳細設定

<DTP_DATA_DIR>/conf ディレクトリにある ExternalSystemSettings.properties 構成ファイルを変更して、統合のデフォルトの動作を変更できます。すぐに利用できる DTP と Jira/Xray の統合は、デフォルトまたは一般的に使用されるフィールドとタイプを使用するように構成されています。ただし、Jira/Xray システムをカスタマイズしている場合は、次の設定を行って、DTP のデータをカスタムの Jira/Xray 構成に合わせることができます。  

カスタム テスト タイプ フィールドの値を取得する

jira.testType.customfieldId  および jira.testType.customfieldValue の設定は、DTP から Jira/Xray に送信されるテストのカスタム タイプを指定するために使用されます。jira.testType.customfieldId はカスタム タイプのフィールドの名前を識別し、jira.testType.customfieldValue は特定の値を識別します。両方の値が Jira/Xray システムに存在している必要があります。

jira.testType.customfieldId  設定の値を取得するには:

1. GET リクエストを次のエンドポイントに送信して、カスタム フィールドの値を取得します。 

   curl -X GET "http(s)://<jira-host>/rest/api/2/field"

2. レスポンスで Test Type プロパティを含むカスタム フィールド オブジェクトを見つけます。
   
3. jira.testType.customfieldId に id プロパティを設定します。

jira.testType.customfieldId=customfield_10800

jira.testType.customfieldValue  設定の値を取得するには:

1. Jira システムにログインし、Jira ツールバーの [Create] をクリックします。
   
2. [Issue Type] ドロップダウン メニューから [Test] (または相当するもの) を選択し、[Test Details] をクリックします。
3. [Test Type] ドロップダウン メニューを開き、DTP から送信されるテストに使用するタイプをコピーします。
   
    
4. 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

使用

Jira ALM との統合を設定した後、開発者、テスター、およびその他のユーザーは、統合によって実現される機能を活用できます。

Jira ALM でのバグとタスクの手動作成

テスト エクスプローラーと違反エクスプローラーを使用すると、ステータスに関係なく、テストと違反に対してそれぞれバグとタスクを作成できます。テスト エクスプローラーまたは違反エクスプローラーで Jira アセットを作成する方法については、以下のセクションを参照してください。

• 違反エクスプローラーから Jira のバグとタスクを手動で作成する方法については、「サードパーティ システムでの課題の作成」を参照してください。
• テスト エクスプローラーから Jira のバグとタスクを手動で作成する方法については、「サードパーティ システムでの課題の作成」を参照してください。

Jira/Xray へのテスト データの送信 

次の図は、Jira 環境に Parasoft DTP および Parasoft テスト実行ツールを統合するための自動インフラストラクチャの実装方法を示しています。

1. Jira でテストやストーリーを作成します。アイテムは、Parasoft C/C++test、dotTEST、または Jtest によって実行されるテストに関連付けられます。 
2. テスト ファイルで、@test または @req アノテーションを使用して Jira のテスト ケースまたは要件 ID を追加します。アノテーションの追加の詳細については、C/C++test、dotTEST、または Jtest のドキュメントを参照してください。 
   • @test <Jira Test ID> アノテーションを使用して、テストを Jira のテスト実行に関連付けます。
   • @req <Jira Story ID> アノテーションを使用して、テストを Jira のストーリーに関連付けます。 
   • Jira の作業アイテム ID は、URL などのいくつかの Jira インターフェイスで使用できます。
     
3. CI プロセスの一部としてテストを実行します。IDE からテストを手動で実行することもできます。
4. テスト実行の一環として、Parasoft テスト実行ツールはフィルターとビルド ID でテスト結果をタグ付けし、データを DTP に送信します。DTP ダッシュボードに テスト ウィジェット を追加し、フィルターとビルド ID を設定することにより、DTP で結果を確認できます。開発者は、テスト実行データを DTP から IDE にダウンロードして、失敗したテストに対処できます。
   

5. Sending Test Data to External System フローをデプロイした場合 (「Sending Test Data to External System フローのデプロイ」を参照)、Data Collector が Parasoft ツールからデータを受信すると、単体テストと機能テストの結果が Jira に自動的に送信されます。 デフォルトでは、フローは Data Collector が受信した任意のプロジェクトの単体テストおよび機能テストの結果をフォワードしますが、特定のプロジェクトのデータだけを送信するようフローを設定できます。また、DTP REST API エンドポイントに POST リクエストを手動で送信して、DTP データベースから Jira に結果を送信することもできます (「DTP REST API エンドポイントへ POST リクエストを手動送信する」を参照)。

6. 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 に送信した後、以下のような応答があります。

{
   "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 にデータを自動的に送信します (「Sending Test Data to External System フローのデプロイ」を参照)。または、POST リクエストを DTP REST API エンドポイントに送信して、このアクションを開始することもできます。

API 呼び出しの DTP フィルターとビルド ID を URL パラメーターとして渡します。

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 から送信されたテスト データが Jira で新しいテスト実行エンティティを作成するとき、デフォルトではこのフィールドは空ですが、API 呼び出しに fixVersions パラメーターを追加することで、1 つまたは複数の値を指定できます。

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 のドキュメントを参照してください。

特定の DTP プロジェクトから結果を送信する

Sending Test Data to External System フローを使用して単体テストおよび機能テストの結果を送信している場合、デフォルトでは、すべての DTP プロジェクトのデータが Jira に送信されます。結果として、Jira ID に一致するアノテーションを含むすべての DTP プロジェクトで収集されたテストを含むよう、作業アイテムが更新されます。ただし、特定のプロジェクトのデータだけを送信するよう、フローを設定することもできます。 

1. Extension Designer を開き、Sending Test Data がデプロイされたサービスを開きます。
2. ワークスペースに新しいスイッチ ノードをドラッグします。
   
3. "DataCollectorProcessedEvent" ノードと "Is dynamic analysis" ノードの間の接続線を選択して削除します。
4. "DataCollectorProcessedEvent" ノードからスイッチ ノード、またスイッチ ノードから "Is dynamic analysis" ノードに新しい接続をドラッグします。
    

5. ノードをダブルクリックし、Property フィールドに次の文字列を指定します。

    event.message.resultsSession.project

6. 文字列フィールドに DTP プロジェクトの名前を指定します。
7. (任意) ノードのわかりやすい名前を指定します。
   
8. [終了] をクリックしてノードの設定を終了し、[デプロイ] をクリックします。

フローを実行すると、指定した DTP プロジェクトのテスト結果だけが Jira に送信されます。 

Jira/Xray での結果の表示

テスト データを送信した後、Jira で結果を表示できます。次の図は、いくつかのテストを含む Jira ストーリーを示しています。

ストーリーに関連付けられているテストをクリックして、詳細情報を表示できます。

また、テストに関連付けられたテスト実行を表示することもできます。

Traceability Report の表示 

ご使用のシステムに External System Traceability Report がデプロイされている場合 (「 Requirements Traceability Report の有効化」を参照)、ウィジェットをダッシュボードに追加して、要件からプロジェクトのテスト/静的解析/コードレビューまでのトレーサビリティをモニタリングできます。ウィジェットから、さらに詳細な情報を含むレポートを表示できます。

ウィジェットの追加と構成

DTP ダッシュボード追加されたウィジェットは、個別のトレーサビリティ カテゴリに表示されます。ウィジェットを追加する方法については「ウィジェットの追加」を参照してください。

以下の設定を行うことができます。

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] 列にデータがあるのは、要件がソース ファイルにマッピングされている場合だけです (「Requirements Traceability Report の有効化」を参照)。この画面で [Files] 列および [Reviews] 列を無効にすると、関連するタブが Requirement Details レポート で非表示になります。  
• [Key] 列のリンクをクリックして、その要件に対する Requirement Details レポート を表示します。
• [Summary] 列または [Test] 列のリンクをクリックして、 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] 列にデータがあるのは、要件がソース ファイルにマッピングされている場合だけです (「Requirements Traceability Report の有効化」を参照)。この画面で [Files] 列および [Reviews] 列を無効にすると、関連するタブが Requirement Details レポート で非表示になります。 

Requirement Details Report とは

Requirement Details レポートは、Jira の要件に関連したファイルとテストについての情報を表示します。このレポートは、Requirement Traceability レポートで要件をクリックすることで表示されます。

最初のタブには、作業アイテムを検証するために実行されたテストの結果が表示されます。

[View results in Test Explorer] リンクをクリックすると、要件に関連付けられたすべてのテストをテスト エクスプローラーで参照できます。 

テーブルの個々のテスト名をクリックし、テスト エクスプローラーで個々のテストを参照することもできます。

2 番目のタブには、要件に関連付けられたファイルと、ファイルで検出された静的解析違反が表示されます。[違反] 列のリンクをクリックして、違反エクスプローラー で違反を確認できます。違反に関する詳細が表示されます。

このタブにデータがあるのは、要件がソース ファイルにマッピングされている場合だけです (「Requirements Traceability Report の有効化」を参照)。要件をソース ファイルにマッピングしなかった場合は、メインの Traceability レポート ページで [ファイル/レビューを表示] オプションを無効にし、詳細レポートを再読み込みすることで、このタブを非表示にできます。

ファイルに変更レビューまたはレビュー指摘事項が含まれる場合、それらは 3 番目のタブに表示されます。リンクをクリックすると、変更エクスプローラー で確認できます。

このタブにデータがあるのは、要件がソース ファイルにマッピングされている場合だけです (「Requirements Traceability Report の有効化」を参照)。要件をソース ファイルにマッピングしなかった場合は、メインの Traceability レポート ページで [ファイル/レビューを表示] オプションを無効にし、詳細レポートを再読み込みすることで、このタブを非表示にできます。