.properties ファイルの設定を変更することで、レポートをカスタマイズできます (「設定の概要」を参照)。このセクションでは、レポート設定の例を説明します。レポートをカスタマイズするための完全な設定の一覧については「レポート設定」を参照してください。
レポートの出力場所の指定
解析時にレポートの出力ディレクトリを指定するには、report.location プロパティを使用します。例:
report.location=[path/to/location]
-report をスイッチを使用して HTML レポートの場所を変更することもできます。例:
cpptestcli -report /home/reports/html
レポートのフォーマットの指定
デフォルトでは、HTML レポートが生成されます。report.format プロパティを設定すると、指定されたディレクトリに PDF レポートやカスタム拡張を使用したレポートを生成できます。例:
report.format=pdf
.csv レポートの生成
- プロジェクトが C/C++test によって解析済みであり、cpptest.bdf ファイル (前述を参照) が存在することを確認します。
空の構成ファイル (csv.properties) を作成し、次の行を追加します。
cpptest.report.csv.enabled=true
コード解析を実行し、
-settingsスイッチを使用して構成ファイルを指定します。cpptestcli -config "builtin://Recommended Rules" -compiler gcc_9-64 -settings csv.properties -input cpptest.bdf
C/C++test は以下のタスクを実行します。
- 解析を実行します。
- 結果を出力コンソールにレポートします
- 追加で report.csv 結果ファイルを作成します。
カスタム レポート フォーマットのサポート
結果のフォーマットを指定するカスタム XSL トランスフォーマーを構築することで、ローカルで生成されるレポートおよび E-mail で送信されるレポートをカスタマイズできます。たとえば、カスタム トランスフォーマーを使用すると、内部的なセキュリティ ポリシーへの準拠を証明するのに必要な書式にデータをマッピングできます。
カスタム レポート フォーマットを指定するには、次の操作を行います。
- 1.XML データを変換する方法を指定する XSL ファイルを作成します。
- XSL ファイルの場所を指定します。また、.property ファイルで以下を設定し、結果ファイルに割り当てる拡張子を指定します。
report.format=customreport.custom.xsl.file=<path to the XSL file>report.custom.extension=<extension of the resulting file>
IDE から解析を行う場合、XSL ファイルの場所および結果ファイルの拡張子は、レポート設定ページで指定できます (「レポートの生成」を参照)。
利用可能なパラメーター
カスタム XSL ファイルで以下のパラメーターを使用できます。
| パラメーター | 説明 |
|---|---|
| report_type=disk_report|email_report | 生成されるレポートを E-mail で送信するか、ローカル ディスク ドライブに保存するかを指定します。 |
| test_params | このレポートを生成する製品の起動時に使用されたコマンド ライン例: cpptestcli: -config dtp://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] | レポートが作成されるディレクトリ。このパラメーターは、開発者レポートの作成に使用できます。 例: <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 | report.suppressed_msgs オプションの値。詳細は「レポート設定」を参照してください。 |
| dev_errors=true|false | report.developer_errors オプションの値。詳細は「レポート設定」を参照してください。 |
| dev_reports=true|false | report.developer_report オプションの値。詳細は「レポート設定」を参照してください。 |
| show_active_rules=true|false | report.active_rules オプションの値。詳細は「レポート設定」を参照してください。 |
| associations=true|false | report.associations オプションの値。詳細は「レポート設定」を参照してください。 |
| dev_reports_prefix=[prefix] | 開発者レポート名を作成するための接頭辞 例: <xsl:value-of select="concat($output_dir,$dev_reports_prefix,$authid,'.csv')"/> |
| attachments=true|false | report.mail.attachments オプションの値。詳細は「レポート設定」を参照してください。 |
| authors_details=true|false | report.authors_details オプションの値。詳細は「レポート設定」を参照してください。 |
| contexts_details=true|false | report.contexts_details オプションの値。詳細は「レポート設定」を参照してください。 |
