このセクションでは、要件とファイルを関連付ける方法について説明します。要件とファイルを関連付けると、Traceability Report または JIRA Traceability Report を使用して、解析したソース ファイルのコンテキストでの静的解析違反およびビルド レビューを表示できます。
ビルド ID ごとに有効化が必要
以下で説明するワークフローは、特定の単一のビルド ID に対する要件トレーサビリティを有効化する方法です。要件トレーサビリティ情報を取得したいビルド ID ごとに操作を繰り返す必要があります。
- ソース コード ファイルを編集し、ソース管理システムにコミットします。
要件にファイルをマッピングする特別な CSV ファイルを用意します。例:
ファイル 関連付けられた要件 ID Project-A/src/foo/goo.java
reqA Project-A/src/foo2/goo.c
reqA, reqB, reqC ファイルと要件のマッピング ファイルの作成
この CSV ファイルは、チーム メンバーが手動で用意するほかに、スクリプトで自動生成することもできます。たとえば、ソース管理リポジトリをスキャンし、開発者が追加した要件マーカーを利用して CSV ファイルを生成できます。
- Parasoft 静的解析/テスト ツールは、静的解析またはメトリクス解析でソース コードを解析します。解析は、特定のビルド ID および フィルター ID を使って実行する必要があります (これらの ID の指定方法については、使用するツールのドキュメントを参照してください)。この実行の目的は、ソース管理システムにコミットされた、特定ビルド ID のファイル情報を DTP データベースに保存することです (ステップ 1 を参照)。
以下の引数を使って、DTP_HOME\grs\extras\traceability ディレクトリにある、DTP 付属の CSV スキャン スクリプトを実行します。
groovy fileReqAssoc.groovy -csv <CSV_FILE_NAME> -build <BUILD_ID> -dtp <DTP_HOST_INC_PROTOCOL> -user <DTP_USERNAME> -password <DTP_PASSWORD>
これは、DTP のアーティファクトとファイルを関連付けるために実行する一連の API 呼び出しのサンプル スクリプトです。さらに高度なソリューションを実装するための開始点として使用できます。
このスクリプトは Groovy で作成されていますが、同じ引数で実行できる JAR ファイルも同じディレクトリに用意されています。
スクリプトは ステップ 2 で用意した CSV ファイルをスキャンし、マッピングするファイルの要件についての情報を DTP データベースに渡します。
スクリプトが完了すると、特定のフィルター ID およびビルド ID のトレーサビリティ データがデータベースに保存されます。以下のいずれかの方法でデータを参照できます。
- artifactTraceability REST API エンドポイントを呼び出す
- Traceability Report DTP Enterprise Pack 拡張で参照する
- JIRA Traceability Report DTP Enterprise Pack 拡張で参照する