.properties ファイルの設定を変更することで、レポートをカスタマイズできます (「設定の概要」を参照)。このセクションでは、レポート設定の例を説明します。レポートをカスタマイズするための完全な設定の一覧については「レポート設定」を参照してください。

レポートの出力場所の指定

解析時にレポートの出力ディレクトリを指定するには、report.location プロパティを使用します。例:

report.location=[path/to/location]

-report をスイッチを使用して HTML レポートの場所を変更することもできます。例:

jtestcli -report [path/to/location]

Ant および Maven のパターン

Ant または Maven で場所を指定するには、次のパターンを使用します。

<report>location</report>

レポートのフォーマットの指定

デフォルトでは、HTML レポートが生成されます。report.format プロパティを設定すると、指定されたディレクトリに PDF レポートやカスタム拡張を使用したレポートを生成できます。例:

report.format=pdf

カスタム レポート フォーマットのサポート

結果のフォーマットを指定するカスタム XSL 変換を構築することで、ローカルで生成されるレポートおよび E-mail で送信されるレポートをカスタマイズできます。たとえば、カスタム変換を使用すると、内部的なセキュリティ ポリシーへの準拠を証明するのに必要な書式にデータをマッピングできます。

カスタム レポート フォーマットを指定するには、次の操作を行います。

  1. 1.XML データを変換する方法を指定する XSL ファイルを作成します。
  2. XSL ファイルの場所を指定します。また、.properties ファイルで以下を設定し、結果ファイルに割り当てる拡張子を指定します。
    report.format=custom
    report.custom.xsl.file=<full 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

このレポートを生成する製品の起動時に使用されたコマンド ライン例:

jtestcli: -config dtp://xtest-static.properties -settings /home/nightly/localsettings.properties -publish -report /home/nightly/reports/report.html -resource myproject -dtp.autoconfig [email protected]:8443
test_config_name

レポート生成時に実行されたテスト コンフィギュレーション名
例: Recommended Rules

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|falsereport.suppressed_msgs オプションの値。詳細は「レポート設定」を参照してください。
dev_errors=true|falsereport.developer_errors オプションの値。詳細は「レポート設定」を参照してください。
dev_reports=true|falsereport.developer_report オプションの値。詳細は「レポート設定」を参照してください。
show_active_rules=true|falsereport.active_rules オプションの値。詳細は「レポート設定」を参照してください。
associations=true|falsereport.associations オプションの値。詳細は「レポート設定」を参照してください。
dev_reports_prefix=[prefix]

開発者レポート名を作成するための接頭辞

例: 

<xsl:value-of select="concat($output_dir,$dev_reports_prefix,$authid,'.csv')"/>
attachments=true|falsereport.mail.attachments オプションの値。詳細は「レポート設定」を参照してください。
authors_details=true|falsereport.authors_details オプションの値。詳細は「レポート設定」を参照してください。
contexts_details=true|falsereport.contexts_details オプションの値。詳細は「レポート設定」を参照してください。

レポート生成に使用する XSL ファイルのカスタマイズ

カスタム XSL 変換ファイルを一から作成するのではなく、任意の中間 XSL 変換ファイルをカスタマイズし、利用可能なすべてのフォーマットでレポートを生成するのに利用できます。XSL ファイルはインストール ディレクトリの etc/xsl ディレクトリにあります。2 つの方法があります。

  • デフォルト ディレクトリ etc/xsl で直接ファイルをカスタマイズします。
  • カスタマイズするファイルを別のディレクトリにコピーし、そちらを変更します。レポート生成時にデフォルトのディレクトリを探す前に別のディレクトリを使用するには、report.xsl.dir.user オプションを使用してディレクトリのパスを指定します。

レポートのフォーマット

次の表は、サポート対象のレポート フォーマットおよび各フォーマットで生成されるレポート ファイル名の一覧です。

レポートのフォーマット説明ファイル名

HTML

(デフォルト) Jtest がサポートするすべての結果を含む HTML フォーマットのレポートです。

report.html

PDF

Jtest がサポートするすべての結果を含む PDF フォーマットのレポートです。このレポートは HTML レポートを基に生成されます。

report.pdf

CSV

静的解析結果を含む CSV フォーマットのレポートです。report.csv

XSL カスタム

カスタム ユーザー XSL 変換によって処理された結果を含むカスタム フォーマットのレポートです。Jtest がサポートするすべての結果を含めることができます。詳細については「カスタム レポート フォーマットのサポート」を参照してください。

report_custom.xml

report_custom.html

JSON SARIF (Static Analysis Results Interchange Format)

静的解析結果を含む SARIF 仕様に従ったレポートです。詳細については https://sarifweb.azurewebsites.net/ を参照してください。report.sarif

JSON SARIF for Azure DevOps

静的解析結果を含む SARIF 仕様に従った Azure DevOps 固有のレポートです。詳細については https://sarifweb.azurewebsites.net/ を参照してください。

report_azure.sarif

JSON SAST for GitLab

静的解析結果を含む SAST 仕様に従った GitLab 固有のレポートです。詳細については https://docs.gitlab.com/user/application_security/sast/ を参照してください。report.sast

XML SATE (Static Analysis Tool Exposition)

静的解析結果を含む SATE 仕様に従ったレポートです。詳細については https://samate.nist.gov/SATE4.html を参照してください。report_sate.xml
XML xUnit単体テストの結果を含む xUnit フォーマットのレポートです。report_xunit.xml

report.file.name 設定を使用してレポート ファイル名をカスタマイズできます。

  • No labels