この章ではレポート設定を構成する方法を説明します。レポート設定は GUI から、またはローカル 設定を使用してコマンドラインインターフェイスから指定できます。
このセクションの内容:
GUI からの設定
用意されている GUI コントロールを使用して任意のテストのレポート設定を指定できます。テスト はコマンドラインインターフェイスまたは GUI のどちらからでも実行できます。
レポート設定を指定する前に、[ 設定] ウィンドウの以下の設定を参照して、タスクの作成者が正し く計算されるか、結果が適切な Team Server に送信されるか、正しい電子メールホストを使用し ているかなどを確認する必要があります。
- Report Center
- ライセンス
- スコープと作成者
- ソース管理
- Team Server
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 つのアドレスまたはセミコロンで区切った複数のアドレスを指定できます。
- ' 不明な' 開発者レポートの送信先 "unknown" に割り当てられたタスク ( 特定の開発者に関連付けられなかったタスク) の開発者レポートの送信先を指定します。これらのレポートは、1 つのユーザー/ アドレスにだけ送信できます。セミコロンで区切った複数のアドレスの指定は有効ではありません。
レポート構成の設定
レポートの内容
| 設定 | 説明 |
|---|---|
| 詳細な開発者レポート | マネージャー向けの概要レポートに加えて、カスタマイズされた詳細なレポートを個々のチームメンバー向けに生成するかどうかを指定します。開発者レポートには、そのチームメンバーに割り当てられたタスクだけが含まれます。 |
| 作成者ごとのタスクの概要 | 各開発者に割り当てられたタスクの種類と数の概要をレポートに含めるかどうかを指定します。 |
| チェックされたファイルおよび実行されたテストの概要 | チェックされたファイルおよび実行されたテストに関する情報をレポートに含めるかどうかを指定します。 静的解析の場合、このオプションをオンに設定すると、チェックされたファイルの一覧がレポートに含まれます。また各ファイルのルール違反の数と抑制された違反の数が表示されます。ファイルに違反がある場合、違反の行番号、ルール名、ルール ID が表示されます。 単体テスト実行の場合、このオプションをオンに設定すると、実行されたテストケースと結果 ( 成功または失敗) の一覧がレポートに含まれます。また各テストスイートのテストケースの総数と成功したテストケースの数が表示されます。テストケースに対してタスクがレポートされた場合、スタックトレースや結果など、より詳細な情報が表示されます。 コードレビューの場合、すべての保留された課題と作成者-レビューアー-監督者間のメッセージがレポートに含まれます (デフォルトでセッションタグによってフィルターされます)。 |
| タスクの詳細 | レポートされたすべてのタスクの詳細をレポートに含めるかどうかを指定します。 |
| テスト ケースの詳細 | 実行されたすべてのテスト ケースの詳細をレポートに含めるかどうかを指定します。 |
| 抑制の詳細抑制 | 抑制されたメッセージの一覧をレポートに含めるかどうかを指定します。 |
| 要求/ 欠陥の詳細 | テストに関連付けられた要求、欠陥、タスク、および機能要求をレポートに含めるかどうかを指定します。この設定を有効にするには、下記の [ 最上位のテストスイートのみ] オプションをオフにする必要があります。 |
| 最上位のテストスイートのみ | (SOAtest のみ) このオプションをオンにすると、テストスイートサマリーレポートセクションに .tst ファイルだけが表示されます。オフの場合、各 .tst ファイル中の個々のテストがツリー形式に似た形式で表示されます。 |
| アクティブな静的解析ルール | 有効に設定された静的解析ルールの一覧をレポートに含めるかどうかを指定します。 |
| 詳細レポート | 指定のカバレッジメトリクスについて詳細情報をレポートに含めるかどうかを指定します。ドロップダウンリストからカバレッジの種類を選択します。 重要 詳細カバレッジレポートを生成するには、テストを実行する「前」にこのオプションを有効にしてカバレッジメトリクスを選択するする必要があります。 |
| 失敗したテストのみ | 失敗したテストだけを表示するかどうかを指定します。 |
| コマンドラインモードでフォーマット済みのレポートを生成 | テストをコマンドラインモードで実行した場合に、フォーマットされたレポートを生成するかどうかを指定します。 |
| グラフの締め切り日付 | トレンドグラフの開始日付を指定します。トレンドグラフは、ある期間にわたってさまざまなカテゴリのタスクを追跡します。 |
要求/ 欠陥の詳細情報へのハイパーリンク
成果物の URL を ( 例えば C++test のテストプロパティとして) 指定している場合、その URL はハイパーリンクとして HTML レポートに表示されます。
ハイパーリンクを作成したい場合で、269 ページの「単体テストケースの関連付け」にあるように成果物 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%]
レポートのフォーマット
| 設定 | 説明 |
|---|---|
| フォーマット | レポートのフォーマットを指定します。
|
| XSL ファイル | レポートのフォーマットとして [XSL カスタム] を選択した場合、カスタムフォーマットを定義した XSL ファイルへのパスを入力します。 |
| レポートファイルの拡張子 | デフォルトの .html 以外のファイル拡張子を使用する場合、[ レポートファイルの拡張子] フィールドに拡張子を入力します。 |
| レポート全体のコンテンツを含む追加のアーカイブを生成 | このオプションを有効にすると、指定されたレポートの場所に追加の圧縮ファイル (.zip) が生成されます。ZIP にはレポートをビルドするために生成されたすべてのファイルが含まれます。 このオプションは任意のレポート フォーマット (HTML、CSV、PDF など) に対してアーカイブを生成できます。 アーカイブを生成する際、レポートのカスタム変換を行うこともできます。なぜなら、すべての要素はそれぞれ指定された出力先に出力されるからです。 |
詳細設定
| 設定 | 説明 |
|---|---|
| XML データにファイルの絶対パスを追加する | XML データにファイルの絶対パスを追加するかどうかを指定します。インポート時にデスクトップ上の C++testにタスクを再配置したい場合、サーバーでこのオプションをオンにする必要があります (「インポート時のタスクの再配置－要件と制限事項」を参照)。 |
| XML データにメトリクスの詳細を追加する | デフォルトで含まれる、プロジェクトおよびパッケージ/ 名前空間レベルの詳細に加えて、型レベルおよびメソッドレベルのメトリクスの詳細を XML レポートに追加するかどうかを指定します。メトリクスの詳細は HTML レポートおよび PDF レポートで表示されます。 |
| セッションタグ | このレポートのためのタグを指定します。この値はTeam Server に結果の概要をアップロードするときに使用されます。チームの通常のテスト実行ごとに、そのテスト結果に固有のタグを付けるべきです。「コマンドライン実行での設定の使用」で説明されている変数を使用できます。例えば、チームが静的解析、単体テスト、コードレビューをクリックする場合、セッションタグとしてStatic、Execution、およびCode Review を使用します。あるいは、session.tag=${config_name} または session.tag=${analysis_type} といった変数を使用します。 |
ローカル設定
レポートのオプションは、ローカル設定で指定することもできます。例えば、DTP を使ってチーム全体で設定を共有したり、コマンドラインでオプションを指定することができます。詳細については「ローカル設定の指定」を参照してください。
カスタムレポート フォーマットのサポート
結果のフォーマットを指定するカスタム XSLT トランスフォーマーを作成することによって、ローカルに生成されて電子メールで送付されるレポートをカスタマイズすることができます。カスタム XSLT トランスフォーマーを使って、例えば、内部のセキュリティポリシーへの準拠を示すために必要なフォーマットにデータをマッピングすることができます。
カスタムレポートフォーマットを指定するには、次の操作が必要です。
- XML データの変換方法を指定する XSL ファイルを作成します。
- [ 設定] ウィンドウの [Parasoft] > [ レポート] で、[ フォーマット] として [XSL カスタム] を選択します。ステップ 1 で作成した XSL ファイルの場所およびレポートファイルの拡張子を指定します。
別の方法として、ローカル設定ファイルの
(results.)report.custom.extension および (results.)report.custom.xsl.file でこの情報を指定できます。
利用できるパラメーター
次のパラメーターをカスタム XSL ファイルで使用できます。
| パラメーター | 説明 |
|---|---|
| report_type=disk_report|email_report | 生成されたレポートを電子メールで送信するか、ローカルディスクドライブに保存するかを決定します。 |
| test_params | このレポートを生成した製品を起動するために使用されたコマンドライン。 cpptestcli: -config team://xtest-static.properties -localsettings /home/nightly/localsettings.properties -publish -report /home/nightly/reports/report.html -resource myproject -dtp.autoconfig [email protected]:8080 |
| test_config_name | このレポートを生成するために使用されたテストコンフィギュレーションの名前。 |
| output_dir=[dir] | レポートが作成されるディレクトリ。このパラメーターを使って開発者レポートを生成できます。 |
| rules_dir_path=[path] | ルールドキュメントが保存されるディレクトリ。このパラメーターを使ってルールのポップアップ/ リンクを生成できます。 |
| suppr_msgs=true|false | [抑制の詳細] オプションの値。「レポート構成の設定」を参照。 |
| dev_errors=true|false | [タスクの詳細] オプションの値。「レポート構成の設定」を参照。 |
| dev_reports=true|false | [詳細な開発者レポート] オプションの値。「レポート構成の設定」を参照。 |
| show_active_rules=true|false | [アクティブな静的解析ルール] オプションの値。「レポート構成の設定」を参照。 |
| associations=true|false | [要求/ 欠陥の詳細] オプションの値。「レポート構成の設定」を参照。 |
| dev_reports_prefix=[prefix] | 開発者レポートのファイル名に使用する接頭辞。 |
| exec_cvg_details=true|false | [詳細レポート] オプションの値。「レポート構成の設定」を参照。 |
| attachments=true|false | ローカル設定キー report.mail.attachments の値。「ローカル設定の指定」を参照。 |
| test_suites_only=true|false | ローカル設定キー report.test_suites_only の値。「ローカル設定の指定」を参照。 |
| 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
- Note that this report is used by all transformations below
- 単純な 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
