このセクションではレポート設定を構成する方法を説明します。レポート設定は GUI から、または設定ファイルを使用してコマンドラインインターフェイスから指定できます。
このセクションの内容
GUI からの設定
用意されている GUI コントロールを使用して任意のテストのレポート設定を指定できます。テストはコマンドラインインターフェイスまたは GUI のどちらからでも実行できます。
レポート設定を指定する前に、[設定] ウィンドウの以下の設定を参照して、タスクの作成者が正しく計算されるか、結果が適切な DTP Server に送信されるか、正しい電子メールホストを使用しているかなどを確認する必要があります。
- DTP
- ライセンス
- スコープと作成者
- ソース管理
GUI で指定した設定のすべてまたは一部を設定ファイルで上書きできます。
GUI からレポート設定を指定するには、次の操作を行います。
- [Parasoft] メニューの [設定] をクリックして[設定] ウィンドウを表示します。
- [Parasoft] > [ レポート] をクリックします。
- 設定を適切に指定します。利用できる設定については下記のレポート構成の設定を参照してください。
- 宛先やホスト名などの電子メールの設定を GUI からもコマンドラインからもまだ行ってい ない場合、[Parasoft] > [E-mail] で設定します。
- [Parasoft] > [ レポート] > [E-mail 通知] を選択します。
- 適切な E-mail 通知設定を指定します。次の設定を利用できます。
- レポートを E-mail で送信する: レポートを電子メールで送信するかどうかを指定します。
- E-mail の件名: レポートを含む電子メールの件名を指定します。送信する電子メールの件名を指定します。デフォルトの件名 は "[product_name] Report" です。例えば件名を「Functional Testing Report for Project A」に変更するには、「
Functional Testing Report for Project A」と入力します。 - マネージャーレポートの送信先: マネージャーレポートの送信先を指定します。1 つのアドレスまたはセミコロンで区切った複数のアドレスを指定できます。
- タスクのないレポートを送信する: レポートされたタスクが 0 件の場合にレポートを送信するかどうかを指定します。1 つのアドレスまたはセミコロンで区切った複数のアドレスを指定できます。
- 開発者レポートの送信先: 開発者レポートの送信先を指定します。1 つのアドレスまたはセミコロンで区切った複数のアドレスを指定できます。
- ' 不明な' 開発者レポートの送信先: "unknown" に割り当てられたタスク ( 特定の開発者に関連付けられなかったタスク) の開発者レポートの送信先を指定します。これらのレポートは、1 つのユーザー/ アドレスにだけ送信できます。セミコロンで区切った複数のアドレスの指定は有効ではありません。
レポート構成の設定
レポートの内容
| 設定 | 説明 |
|---|---|
| 詳細な開発者レポート | マネージャー向けの概要レポートに加えて、カスタマイズされた詳細なレポートを個々のチームメンバー向けに生成するかどうかを指定します。開発者レポートには、そのチームメンバーに割り当てられたタスクだけが含まれます。 |
| 作成者ごとのタスクの概要 | 各開発者に割り当てられたタスクの種類と数の概要をレポートに含めるかどうかを指定します。 |
| チェックされたファイルおよび実行されたテストの概要 | チェックされたファイルおよび実行されたテストに関する情報をレポートに含めるかどうかを指定します。 静的解析の場合、このオプションをオンに設定すると、チェックされたファイルの一覧がレポートに含まれます。また各ファイルのルール違反の数と抑制された違反の数が表示されます。ファイルに違反がある場合、違反の行番号、ルール名、ルール ID が表示されます。 単体テスト実行の場合、このオプションをオンに設定すると、実行されたテストケースと結果 (成功または失敗) の一覧がレポートに含まれます。また各テストスイートのテストケースの総数と成功したテストケースの数が表示されます。テストケースに対してタスクがレポートされた場合、スタックトレースや結果など、より詳細な情報が表示されます。 |
| タスクの詳細 | レポートされたすべてのタスクの詳細をレポートに含めるかどうかを指定します。 |
| テスト ケースの詳細 | 実行されたすべてのテスト ケースの詳細をレポートに含めるかどうかを指定します。 |
| 抑制の詳細 | 抑制されたメッセージの一覧をレポートに含めるかどうかを指定します。 |
| 要求/欠陥の詳細 | テストに関連付けられた要求、欠陥、タスク、および機能要求をレポートに含めるかどうかを指定します。 |
| アクティブな静的解析ルール | 有効に設定された静的解析ルールの一覧をレポートに含めるかどうかを指定します。 |
要求/ 欠陥の詳細情報へのハイパーリンク
成果物の URL を (例えば C/C++test のテストプロパティとして) 指定している場合、その URL はハイパーリンクとして HTML レポートに表示されます。
ハイパーリンクを作成したい場合で、「テストと開発成果物の関連付け」にあるように成果物 ID だけを使って成果物の関連付けを指定している場合、ローカルプロパティを使って成果物 ID と URL のマッピングを指定することができます。
例:
- report.assoc.url.pr=https://bugzilla.parasoft.com/show_bug.cgi?id=[%ID%]
- report.assoc.url.jira=https://jira.parasoft.com/browse/[%ID%]
- report.assoc.url.fr=https://bugzilla.parasoft.com/show_bug.cgi?id=[%ID%]
- report.assoc.url.task=http://concerto.parasoft.com.pl:8080/grs/jsf/planning/task/edit_task.jsf?entityId=[%ID%]
レポートのフォーマット
| 設定 | 説明 |
|---|---|
| フォーマット | レポートのフォーマットを指定します。
複数のフォーマットを選択し、1 回の実行で複数のレポートを生成するには、.properties ファイルで report.format を設定します。 |
| XSL ファイル | レポートのフォーマットとして [XSL カスタム] を選択した場合、カスタムフォーマットを定義した XSL ファイルへのパスを入力します。 |
| レポートファイルの拡張子 | カスタム レポートでデフォルトの .html 以外のファイル拡張子を使用する場合、[ レポートファイルの拡張子] フィールドに拡張子を入力します。 |
| レポート全体のコンテンツを含む追加のアーカイブを生成 | このオプションを有効にすると、指定されたレポートの場所に追加の圧縮ファイル (.zip) が生成されます。ZIP にはレポートをビルドするために生成されたすべてのファイルが含まれます。 このオプションは任意のレポート フォーマット (HTML、PDF、SARIF など) に対してアーカイブを生成できます。 アーカイブを生成する際、レポートのカスタム変換を行うこともできます。なぜなら、すべての要素はそれぞれ指定された出力先に出力されるからです。 |
詳細設定
| 設定 | 説明 |
|---|---|
| XML データにメトリクスの詳細を追加する | デフォルトで含まれる、プロジェクトおよびパッケージ/ 名前空間レベルの詳細に加えて、型レベルおよびメソッドレベルのメトリクスの詳細を XML レポートに追加するかどうかを指定します。メトリクスの詳細は HTML レポートおよび PDF レポートで表示されます。 |
| セッション タグ | このレポートのためのタグを指定します。この値は DTP に結果の概要をアップロードするときに使用されます。チームの通常のテスト実行ごとに、そのテスト結果に固有のタグを付けるべきです。「コマンドライン実行での設定の使用」で説明されている変数を使用できます。例えば、チームが静的解析と単体テストを実行する場合、セッションタグとして Static または Execution を使用します。あるいは、session.tag=${config_name} または session.tag=${analysis_type} といった変数を使用します。 |
| ビルド ID | 結果をラベル付けするビルド識別子を指定します。ビルド識別子は、各ビルドに対して付ける場合もあれば、指定のビルドで実行された複数のテ ストセッションに対して付ける場合もあります。 デフォルト値は |
設定ファイルから
レポートのオプションは、設定ファイルで指定することもできます。例えば、DTP を使ってチーム全体で設定を共有したり、コマンドラインでオプションを指定することができます。詳細については「設定ファイルでの指定」を参照してください。
カスタム レポート フォーマットのサポート
結果のフォーマットを指定するカスタム XSL トランスフォーマーを構築することで、ローカルで生成されるレポートおよび E-mail で送信されるレポートをカスタマイズできます。たとえば、カスタム トランスフォーマーを使用すると、内部的なセキュリティ ポリシーへの準拠を証明するのに必要な書式にデータをマッピングできます。
カスタム レポート フォーマットを指定するには、次の操作を行います。
- XML データを変換する方法を指定する XSL ファイルを作成します。
- [設定] ウィンドウの [Parasoft] > [レポート] で、[フォーマット] として [XSL カスタム] を選択し、 XSL ファイルの場所およびレポートファイルの拡張子を指定します。
別の方法として、設定ファイルの
(results.)report.custom.extension および (results.)report.custom.xsl.fileでこの情報を指定できます。
利用可能なパラメーター
カスタム XSL ファイルで以下のパラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| report_type=disk_report|email_report | 生成されるレポートを E-mail で送信するか、ローカル ディスク ドライブに保存するかを指定します。 |
| test_params | このレポートを生成する製品の起動時に使用されたコマンド ライン 例: cpptestcli: -config "builtin://Recommended Rules" -settings /home/nightly/settings.properties -publish -report /home/nightly/reports/report.html -resource myproject -dtp.autoconfig [email protected]:8080 |
| test_config_name | レポート生成時に実行されたテスト コンフィギュレーション名 |
| output_dir=[dir] | レポートが作成されるディレクトリ。このパラメーターは、開発者レポートの作成に使用できます。 例: <xsl:value-of select="concat($output_dir,$dev_reports_prefix,$authid,'.csv')"/> |
| rules_dir_path=[path] | ルール ドキュメントが保存されているディレクトリ。ルール ポップアップ/リンクの生成に使用できます。 例: <xsl:value-of select="concat('javascript:openWin(',$qt,$rules_dir_path,$id,'.html',$qt,')')"/> |
| suppr_msgs=true|false | [抑制の詳細] オプションの値。「レポート構成の設定」を参照。 |
| dev_errors=true|false | [タスクの詳細] オプションの値。「レポート構成の設定」を参照。 |
| dev_reports=true|false | [詳細な開発者レポート] オプションの値。「レポート構成の設定」を参照。 |
| show_active_rules=true|false | [アクティブな静的解析ルール] オプションの値。「レポート構成の設定」を参照。 |
| associations=true|false | [要求/ 欠陥の詳細] オプションの値。「レポート構成の設定」を参照。 |
| dev_reports_prefix=[prefix] | 開発者レポート名を作成するための接頭辞 例: <xsl:value-of select="concat($output_dir,$dev_reports_prefix,$authid,'.csv')"/> |
| exec_cvg_details=true|false | [詳細レポート] オプションの値。「レポート構成の設定」を参照。 |
| attachments=true|false | 設定キー report.mail.attachments の値。「設定ファイルでの指定」を参照。 |
| test_cases_details=true|false | [テストケースの詳細] オプションの値。「レポート構成の設定」を参照。 |
| failed_tests_only=true|false | 設定キー report.failed_tests_only の値。詳細については「設定ファイルでの指定」を参照してください。 |
| authors_details=true|false | [作成者ごとのタスクの概要] オプションの値。「レポート構成の設定」を参照。 |
| contexts_details=true|false | [チェックされたファイルおよび実行されたテストの概要] オプションの値。「レポート構成の設定」を参照。 |
サンプル ファイル
さらに参考として次のサンプルファイルも参照してください。
ローカル レポート
- XML スキーマ: reports.xsd
- さまざまな結果を含むサンプル XML ファイル: rep_example.xml
- このレポートは下記のすべての変換で使用されることに注意してください。
- 単純な CSV プレーンテキストファイルへの変換サンプル
- XSL ファイル: csv.xsl
- 結果: csv.txt
- 違反リストがある HTML の表への変換サンプル
- XSL ファイル: html_table.xsl
- 結果: html_table.html
- 作成者/ 違反の統計がある HTML の表への変換サンプル
- XSL ファイル: stats_table.xsl
- 結果: stats_table.html
- 開発者レポートの CSV ファイルへの変換サンプル
- XSL ファイル: csv_dev.xsl
- 結果: csv_dev.csv
- 開発者レポートの HTML ファイルへの変換サンプル
- XSL ファイル: html_dev.xsl
- 結果: html_dev.html
