このセクションでは、要件とファイルを関連付ける方法について説明します。要件とファイルを関連付けると、 Parasoft トレーサビリティ レポートを使用して、解析したソース ファイルのコンテキストでの静的解析違反およびビルド レビューを表示できます。
ビルド ID ごとに有効化が必要
以下で説明するワークフローは、特定の単一のビルド ID に対する要件トレーサビリティを有効化する方法です。要件トレーサビリティ情報を取得したいビルド ID ごとに操作を繰り返す必要があります。
- 要件トラッキング システムで要件 (たとえば Jira ストーリー) を作成します。
ALM システムによって生成された要件 ID にプロジェクトのソース コード ファイルをマッピングする CSV ファイルを作成します。例:
ファイル 関連付けられた要件 ID Project-A/src/foo/goo.java
reqA Project-A/src/foo2/goo.c
reqA, reqB, reqC ファイルと要件のマッピング ファイルの作成
この CSV ファイルは、チーム メンバーが手動で用意するほかに、スクリプトで自動生成することもできます。たとえば、ソース管理リポジトリをスキャンし、開発者が追加した要件マーカーを利用して CSV ファイルを生成できます。
- ソース コード ファイルをソース管理にチェックインし、Parasoft ツールを実行して、ファイルと要件の関連付け情報を DTP データベースに追加します。ツールの実行は、特定のビルド ID とプロジェクトを使って実行する必要があります (このメタ データの指定方法については、使用するツールのドキュメントを参照してください)。
- また、DTP REST API
/artifactsTypes
エンドポイントに POST を送信して、DTP データベースに要件を追加することもできます。詳細については、DTPの ヘルプ メニューから [APIドキュメント] を選択してください。
- また、DTP REST API
以下の引数を使って、<DTP_INSTALL>/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 データベースに送ります。スクリプトの実行方法については README.txt ファイルを参照してください。
スクリプトが完了すると、特定のフィルター ID およびビルド ID のトレーサビリティ データがデータベースに保存されます。以下のいずれかの方法でデータを参照できます。
- artifactTraceability REST API エンドポイントを呼び出す
- Jira Report との統合
- VersionOne Traceability レポート
- Polarion Traceability レポート
- CodeBeamer Traceability レポート