このセクションの内容

build.id

結果をラベル付けするためのビルド識別子を指定します。ビルドごとに固有の識別子を使用することも、特定のビルド中に実行された複数のテスト セッションを同じタグでラベル付けすることもできます。

ビルド ID は最大で 128 文字です。

設定可能な値

[id]結果をラベル付けするための ID です。デフォルト値は ${dtp_project}-${time:yyyy-MM-dd} です。

使用例

デフォルトのビルド ID には、DTP のプロジェクト名およびビルド日付が含まれます。たとえば ATM プロジェクトの場合、レポートに記載されるビルド ID は ATM-2017-07-07 のようになります。 

次の設定は、プロジェクト名と環境変数 BUILD で渡されたビルド番号からなるカスタム ビルド ID を指定します。

build.id=${dtp_project}-${env_var:BUILD}

プロジェクトが ABC で CI サーバー上のビルド番号が 114 の場合、ABC-114 に解決されます。


dupcode.sorting.mode

重複コードの指摘での要素のソート順を指定します。 

設定可能な値

oldest一番古い結果が一番上に表示されます。
newests一番新しい結果が一番上に表示されます。
paths(デフォルト値)フル パス名のアルファベット昇順 (A から Z) で表示されます。

exec.env

実行された環境を説明するタグのリストを指定します。タグを使用すると、サービス API 経由でセッション全体、テスト スイート、テスト、またはテスト ケースにタグを付加できます。 デフォルトでは、タグはオペレーティング システム名 (Windows、Linux など) と アーキテクチャ (x86、x86_64 など) を組み合わせたものです。

設定可能な値

[tag]実行環境を説明するタグのリストをセミコロン区切りで指定します。デフォルトは ${os}${arch} です。

使用例

次の設定は、テスト ランが 64-bit Linux マシンで GCC 5.4 コンパイラを使用して実行されたことを指定します。

exec.env=linux_x86_64_gcc5.4


goal{n}.name

ゴール (特定の条件を満たす指摘事項のサブセット) の名前を指定します ( goal.severitiesgoal.projectsgoal.max.to.recommend、 goal.rulesgoal.deadline を参照)。各開発者に対する推奨事項として、HTML レポートの「ゴール」セクションに指摘事項が表示されます。

「goal」接頭辞の後に数字を付加することで、複数のゴールを設定できます。

設定可能な値

[goal name]ゴールの名前です。

使用例

次の設定は、"Priorities1" と  "Priorities2" という 2 つのゴールを有効化します。

goal1.name=Priorities1

goal2.name=Priorities2

goal{n}.severities

ゴールに関してレポートされる指摘事項の重要度レベルを指定します。goal.name を設定する必要があります。

複数の重要度を指定できます。

設定可能な値

[severity level]重要度レベル (1-5) または重要度レベルのカンマ区切りのリストです。

使用例

次の設定は、重要度レベル 1 または 2 の識別子のサブセットである "Priorities1" ゴールを有効化します。

goal1.name=Priorities1

goal1.severities=1,2

goal{n}.max.to.recommend

HTML レポートの「ゴール」セクションにレポートされる開発者 1 人あたりの指摘事項の最大数を指定します。goal.name を設定する必要があります。

設定可能な値

[number]各開発者にレポートされる指摘事項の最大数です。

使用例

次の設定は、"Priorities1" ゴールのレポート制限を 20 に指定します。

goal1.name=Priorities1

goal1.severities=1,2

goal1.max.to.recommend=20

goal{n}.projects

ゴールに特定のプロジェクトの指摘事項だけを含めるよう指定します。goal.name を設定する必要があります。

設定可能な値

[project name]指摘事項がレポートされるプロジェクトの名前

使用例

次の設定は、"Priorities1" ゴールには、"examples" プロジェクトに対してレポートされた重要度 1 および 2 の指摘事項だけが含まれるよう指定します。

goal1.name=Priorities1

goal1.severities=1,2

goal1.projects=examples

goal{n}.rules

ゴールに関して指摘事項をレポートするルールを指定します。goal.name を設定する必要があります。

設定可能な値

[rule ID]単一のルール ID、またはルール ID のカンマ区切りのリストです。

使用例

次の設定は、"Priorities1" ゴールには、ルール BD_SECURITY_VPPD  および BD_PB_VALRANGE でレポートされた指摘事項だけが含まれるよう指定します。

goal1.name=Priorities1

goal.rules=BD_SECURITY_VPPD,BD_PB_VALRANGE

goal{n}.deadline

指摘事項の修正期限を指定します。ゴールに関してレポートされる指摘事項の数は、期限までの残り日数に依存します。指摘事項の合計を残り日数で割った件数がレポートされます。goal.name を設定する必要があります。

設定可能な値

[YYY-MM-DD]修正期限です。

使用例

次の設定は、BD_SECURITY_VPPD  および BD_PB_VALRANGE ルールによってレポートされたすべての指摘事項を 2019 年 5 月 10 日までに修正する必要があることを指定します。

goal1.name=Priorities1

goal.rules=BD_SECURITY_VPPD,BD_PB_VALRANGE

goal1.deadline=2019-05-10


goal.ref.report.file

参照 report.xml ファイルへのパスを指定します。このファイルは、現在の解析時に新しい指摘事項を検出するためのベースラインとして使用されます。現在の解析で検出された指摘事項は、このオプションで指定された参照ファイルに存在しなければ 'new' としてマークされます。

設定可能な値

[path または URL]参照 report.xml ファイルへのパスまたは URL です。

使用例

次の設定は、現在の解析で検出された指摘事項を 'baseline' ディレクトリの report.xml ファイルと比較します。

goal.ref.report.file=C:/parasoft/baseline/report.xml

goal.ref.report.findings.exclude

既存の指摘事項をレポートから除外するかどうかを指定します。現在の解析で検出された指摘事項と goal.ref.report.file で指定された参照 report.xml ファイルのレポートを比較することで既存の指摘事項を検出します。オプションが有効な場合、参照ファイルにも存在する現在の指摘事項はレポートから除外されます。

設定可能な値

true新しい指摘事項だけをレポートに含めます。
false(デフォルト値)新規および既存の指摘事項をレポートに含めます。

使用例

次の設定は、既存の指摘事項をレポートから除外します。

goal.ref.report.file=http://mycompany.com/sa/baseline/report.xml

goal.ref.report.findings.exclude=true

issue.tracking.tags

課題トラッキング タグのリストを指定します。report.associations オプションを有効にする必要があります。

設定可能な値

[tag]

カンマ区切りのタグのリストです。デフォルトでは、次のタグがサポートされています: asset, fr, pr, req, task, test

使用例

次の設定は、デフォルトのタグ asset を無効にし、カスタム タグ high を有効にします。

report.associations=true

issue.tracking.tags=fr,pr,req,task,high,test


project.module

プロジェクト モジュールのカスタム名を指定します。個別の実行を説明するために使用できます。指定されていない場合、解析対象として指定されたコードに基づいて、自動的にテスト対象モジュールが検出されます。

設定可能な値

[name]

プロジェクト モジュール名です。

使用例

次の設定は、カスタム モジュール名 XTests を指定します。

project.module=xTests



report.active_rules

テストで有効に設定されているルールのリストをレポートに含めるかどうかを指定します。  

設定可能な値

true(デフォルト値)アクティブなルールのリストをレポートに含めます。
falseアクティブなルールのリストをレポートに含めません。

使用例

次の設定は、テストで有効に設定されているルールのリストをレポートに含めません。

report.active_rules=false


report.archive

レポートを zip ファイルにアーカイブ化するかどうかを指定します。

設定可能な値

trueレポートを zip ファイルにアーカイブ化します。
falseレポートを zip ファイルにアーカイブ化しません。

report.associations

テストに関連付けられた要求、欠陥、タスク、および機能要求をレポートに含めるかどうかを指定します。

設定可能な値

true(デフォルト値)要求、タスク、および機能要求がレポートに含まれます。
false要求、タスク、および機能要求はレポートに含まれません。

使用例

次の設定は、要求、タスク、および機能要求をレポートに含めません。

report.associations=false


report.assoc.url.[tag]

HTML レポートに関連成果物へのリンクを生成します。URL は PropertyAttribute 値のプレースホルダー [%ID%] を含むクエリー文字列です。関連付けられるタグは、issue.tracking.tags オプションで設定する必要があります。

設定可能な値

[URL]

HTML レポートに含める関連成果物へのリンクです。

使用例

次の設定は、カスタム タグ high を有効化して HTML レポートへのリンクを生成します。

report.associations=true

issue.tracking.tags=high

report.assoc.url.high=http://bugzilla.company.com/workitem?id=[%ID%]


report.authors_details

チーム メンバーごとに割り当てられたタスクの数とタイプの概要をレポートに含めるかどうかを指定します。

設定可能な値

true(デフォルト値)各開発者に割り当てられたタスクのタイプと数をレポートに含めます。
false各開発者に割り当てられたタスクのタイプと数をレポートに含めません。

使用例

次の設定は、各開発者に割り当てられたタスクのタイプと数をレポートに含めません。

report.authors_details=false



report.contexts_details

テスト中にチェックまたは実行されたファイルの概要をレポートに含めるかどうかを指定します。

設定可能な値

true(デフォルト値)チェックされたファイルのリストをレポートに含めます。
falseチェックされたファイルのリストをレポートに含めません。

使用例

次の設定は、チェックされたファイルのリストをレポートに含めません。

report.contexts_details=false


report.coverage.images

DTP でカバレッジ イメージを作成する際に使用されるタグのセットを指定します。DTP は、レポートごとに最大 3 つのカバレッジ イメージをサポートします。  

設定可能な値

[tag]

DTP でカバレッジ イメージを作成する際に使用されるタグのリストをセミコロン区切りで指定します。

report.coverage.limit

カバレッジの閾値の下限を指定します。この値よりカバレッジが低い場合、レポートで強調表示されます。

設定可能な値

[value]

カバレッジの下限を表す値です。デフォルト値は 40 です。

使用例

次の設定は、カバレッジの下限に 50 を設定します。

report.coverage.limit=50

report.coverage.line.hashes

この設定は、XML カバレッジ レポートに行ハッシュを含めるかどうかを指定します。

設定可能な値

true(デフォルト値)行ハッシュがカバレッジ レポートに含まれます。
false行ハッシュはカバレッジ レポートに含まれません。



report.custom.extension

カスタム レポート形式のための XSL ファイルの拡張子を指定します。report.formatcustom が設定されている場合に、report.custom.xsl.file と共に使用します。

設定可能な値

[extension]XSL ファイルのカスタム拡張子です。

report.custom.xsl.file

カスタム レポート形式のための XSL ファイルの場所を指定しま す。

設定可能な値

[path]XSL ファイルへのパスです。

(info) Windows のファイル パスを指定する際、2 つのバックスラッシュを使用してください。


report.developer_errors

マネージャー レポートに開発者エラーについての詳細を含めるかどうかを指定します。 

設定可能な値

true開発者のエラーの詳細がレポートに含まれます。
false(デフォルト値)開発者のエラーの詳細はレポートに含まれません。

使用例

次の設定は、開発者のエラーの詳細をレポートに含めます。

report.developer_errors=true



report.developer_reports

管理者に対して HTML サマリー レポートを生成するのに加えて、チーム メンバー全員に対して詳細な HTML レポートを生成するかどうかを指定します。

設定可能な値

true開発者向けに詳細レポートを生成します。
false(デフォルト値)開発者向けに詳細レポートを生成しません。

使用例

次の設定は、開発者向け詳細レポートの生成を有効化します。

report.developer_reports=true



report.dtp.publish

ローカル解析の結果を DTP Server にレポートするかどうかを指定します。

設定可能な値

true

結果は DTP にパブリッシュされます。

false(デフォルト値)結果は DTP にパブリッシュされません。

使用例

次の設定は、ローカル解析の結果を DTP Server に送信します。

report.dtp.publish=true

関連情報


report.dtp.publish.src

テスト対象のソース コードをDTP Server にパブリッシュするかどうかを指定します。  

設定可能な値

offコードは DTP Server にパブリッシュされません。
minソースの最小限の部分をパブリッシュします。多くの場合、ソース管理システムへの参照がないソース コード (自動生成されたコードなど) がパブリッシュされます。
full

指定されたスコープに関連するすべてのソース コードがパブリッシュされます。report.dtp.publish オプションが有効な場合のデフォルト値です。

使用例

次の設定は、ソース コードを DTP に部分的にパブリッシュします。

report.dtp.publish.src=min

関連情報


report.file.name

レポート ファイルのカスタム名を指定します。

この設定はファイル拡張子を指定しないことに注意してください。report.format設定を使用してレポートのフォーマットを指定できます。

設定可能な値

[file_name] 

レポート ファイル名です。デフォルト値は report です。

使用例

次の設定では、結果は report-cwe.pdf ファイルに保存されます。

report.file.name=report-cwe

report.format=pdf


report.format

レポートの形式を指定します。複数の形式のレポートを生成するには、カンマで区切った形式のリストを指定します。

設定可能な値

xml(デフォルト値)XML 形式のレポートを生成します。
html(デフォルト値)HTML 形式のレポートを生成します。
pdfPDF 形式のレポートを生成します。
csvCSV 形式のレポートを生成します。
sarifSARIF 形式のレポートを生成します。
sarif-azureAzure DevOps 独自の SARIF 形式のレポートを生成します。
sateSATE 形式のレポートを生成します (詳細については https://samate.nist.gov/SATE4.html を参照してください)。
sast-gitlabGitLab 独自の SAST 形式のレポートを生成します。
xunitxUnit 形式のレポートを生成します。
customカスタム形式のレポートを生成します。report.custom.extension および report.custom.xsl.file を参照。
sast-gitlab-v14GitLab 独自の SAST v14 形式のレポートを生成します。
cppunitCppUnit 形式のレポートを生成します。

使用例

次の設定は、PDF レポート形式を指定します。

report.format=pdf


report.graph.start_date

ある期間にわたって静的解析タスク、テスト実行、カバレッジを記録するトレンド グラフの開始日を指定します。report.graph.period オプションも指定する必要があります。

設定可能な値

[MM/dd/yy]

month-day-year 書式の日付です。

report.graph.period

ある期間にわたって静的解析タスク、テスト実行、カバレッジを記録するトレンド グラフの終了日を指定します。report.graph.start_date オプションも指定する必要があります。

設定可能な値

[?d|?m|?y] 

days-months-years 書式で期間を指定します。


report.location

レポートが生成される場所を指定します。

設定可能な値

[path]レポートが作成されるディレクトリへのパスです。

使用例

次の設定は、new_reports ディレクトリへのパスを指定します。

report.location=C:\\Users\\user1\\new_reports



report.mail.enabled

開発者と report.mail.cc で指定した送付先に、レポートをメールするかどうかを指定します。 

設定可能な値

true開発者および追加の受信者には、開発者に関連するエラー/結果のレポートが自動的に送信されます。  
false(デフォルト値)  開発者および追加の受信者には、レポートが送信されません。

report.mail.server

レポートの送信に使用するメール サーバーを指定します。

設定可能な値

[host_name] 

レポートが送信されるサーバーのホスト名です。

report.mail.port

SMTP サーバーのポートを指定します。

設定可能な値

[port_number] 

ポート番号です。デフォルトは 25 です。

report.mail.security

SMTP サーバー接続セキュリティを指定します。 

設定可能な値

STARTTLS(デフォルト値)STARTTLS 接続セキュリティを使用します。
SSLSSL 接続セキュリティを使用します。


report.mail.subject

送信する電子メールの件名を指定します。

設定可能な値

[subject] 

電子メールの件名です。

使用例

report.mail.subject=ABC Project Results

report.mail.username

report.mail.password

report.mail.realm

SMTP サーバー認証の設定を指定します。realm の設定は、SASL レルムを使って認証するサーバーにだけ必要です。

使用例

report.mail.username=user1
report.mail.password=Psm#3P!

report.mail.domain

レポートの送信に使用されるメール ドメインを指定します。

設定可能な値

[domain] 

レポートが送信されるドメインです。

report.mail.time_delay

迷惑メールの制限を避けるために、電子メールによるレポート送信間の時間の遅延を指定します。

設定可能な値

[time] 

レポートは指定された遅延時間の後にメール送信されます。

report.mail.from

送信されるメールの from フィールドの内容を指定します。

設定可能な値

[email]"from" フィールドに電子メールアドレスを含めます。
[user]"from" フィールドにユーザー名を含めます。

report.mail.attachments

レポートを添付ファイルとして送信するかどうかを指定します。すべてのコンポーネントは添付ファイルとして含まれます。画像のあるレポートを参照するには、すべての添付ファイルをディスクに保存する必要があります。

設定可能な値

true電子メールを添付ファイル付きで送信します。
false電子メールを添付ファイルなしで送信します。

report.mail.compact

メールで送信する情報を指定します。デフォルトでは設定されません。

設定可能な値

trendsトレンド グラフ、概要の表、および他のコンパクト データが電子メールに含まれます。詳細データは含まれません。
linksDTP Server 上にあるレポートへのリンクだけが電子メールに含まれます。

report.mail.format

電子メールのコンテント タイプを指定します。 

設定可能な値

html電子メールのコンテントは HTML フォーマットです。
ascii電子メールのコンテントは ASCII フォーマットです。

report.mail.cc

包括的なマネージャー レポートのメール送信先を指定します。複数のアドレスを指定するには、メール アドレスをセミコロン (;) で区切って指定する必要があります。この設定は通常、マネージャー、アーキテクト、選択された開発者にレポートを送信するのに使用します。

設定可能な値

[email_address] 

セミコロンで区切った電子メールアドレスのリストです。

使用例

[email protected];[email protected]

report.mail.include

開発者レポートを受け取るチーム メンバーのアドレスを指定します。  複数のアドレスを指定するには、メール アドレスをセミコロン (;) で区切って指定します。  この設定は通常、開発者に自動的にレポートが送信されない場合に、開発者にレポートを送信するために使用します (たとえば、チームがソース管理システムを使用していない場合などです)。  

このオプションは、exclude オプションの指定を上書きします。

設定可能な値

[email_address] 

セミコロンで区切った電子メールアドレスのリストです。

report.mail.exclude

レポートの自動送信から除外する電子メール アドレスを指定します。

設定可能な値

[email_address] 

セミコロンで区切った電子メールアドレスのリストです。

report.mail.exclude.developers

report.mail.cc 設定で明示的に指定されていないチーム メンバーに、レポートを送信するかどうかを指定します。個々のチーム メンバーにレポートを送信しないようにすることができます。

設定可能な値

true明示的に指定されていない開発者には電子メールが送信されません。
false(デフォルト値)開発者はメーリング リストから除外されません。

report.mail.unknown

"unknown" に割り当てられたエラー レポートの送信先を指定します。

設定可能な値

[email]"unknown" に割り当てられたエラー レポートは、指定された電子メール アドレスに送信されます。
[user]"unknown" に割り当てられたエラー レポートは、指定されたユーザーに送信されます。

report.mail.on.error.only

エラーが見つかった場合または致命的な例外が発生した場合にだけ管理者にレポートを送信するかどうかを指定します。この設定は開発者への送信には影響しません。レポートされたタスクに責任があるチーム メンバーにだけメールは送信されます。

設定可能な値

trueエラーまたは致命的な例外に関する特定の情報がある電子メールが管理者に送信されます。
false(デフォルト値)エラーまたは致命的な例外に関する特定の情報がある電子メールが管理者に送信されません。

report.metadata

指摘事項に関する追加のメタデータを DTP からダウンロードするかどうかを指定します。既に DTP に存在する指摘事項だけが影響を受けます。また、この設定が効果を持つには、DTP サーバーはがメタデータ サービスをサポートしている必要があります。

設定可能な値

true(デフォルト値)指摘事項に関するメタデータを DTP からダウンロードします。
false指摘事項に関するメタデータを DTP からダウンロードしません。

使用例

次の設定は、指摘事項に関する追加のメタデータを DTP からダウンロードしません。

report.metadata=false



report.metrics.attributes

メトリクス結果に対する追加属性のリストを指定します。

次の属性は常に有効であり、この設定で指定する必要はありません: module, namespace, type, method

設定可能な値

[attribute]

属性のカンマ区切りのリストです。



report.rules

静的解析ルールの HTML ファイルを保存するディレクトリを指定します。 

設定可能な値

[URL]

静的解析ルールの HTML ファイルが保存される場所です。

使用例

例 1:

report.rules=file:///C:/parasoft/gendoc/

例 2:

report.rules=../gendoc/



report.scontrol

ソース管理システムからの追加情報を含めるかどうかを指定します。また、含める情報を指定することもできます。

設定可能な値

off(デフォルト値)ソース管理システムからの情報をレポートに含めません。
minリポジトリ、ファイル パス、およびリビジョン情報をレポートに含めます。
fullリポジトリ、ファイル パス、リビジョン、タスクのリビジョンおよびコメント情報をレポートに含めます。

使用例

次の設定は、リポジトリ、ファイル パス、およびリビジョン情報をレポートに含めます。

report.scontrol=min



report.suppressed_msgs

抑制されたメッセージをレポートに含めるかどうかを指定します。

設定可能な値

true抑制されたメッセージをレポートに含めます。
false(デフォルト値)抑制されたメッセージをレポートに含めません。

使用例

次の設定は、抑制されたメッセージをレポートに含めます。

report.suppressed_msgs=true



report.setup.problems

セットアップの問題に関するセクションをレポートのどこに表示するかを指定します。

topセットアップの問題セクションはレポートの先頭に表示されます。
bottom(デフォルト値)セットアップの問題セクションはレポートの末尾に表示されます。
hiddenセットアップの問題セクションはレポートに表示されません。

report.setup.problems.category_limit

1 つのセットアップの問題カテゴリに表示されるメッセージ数の上限を指定します。

設定可能な値

[number] 

1 つのセットアップの問題カテゴリに表示されるメッセージの最大数です。デフォルト値は 10 です。

report.setup.problems.display_limit

HTML レポートのセットアップの問題カテゴリに表示される合計メッセージ数の上限を指定します。

設定可能な値

[number] 

1 つのセットアップの問題カテゴリに表示されるメッセージの最大数です。デフォルト値は 100 です。

report.setup.problems.console

セットアップの問題をコンソールに出力するかどうかを指定します。

設定可能な値

true(デフォルト値)セットアップの問題はコンソールに出力されます。
falseセットアップの問題はコンソールに出力されません。

report.separate_vm.xmx

レポートの生成に使用されるメモリの量を指定します。 

設定可能な値

[memory_size] 

レポート生成に割り当てられるメモリの最大量です。デフォルト値は 120M です。

report.separate_vm

レポート生成を別の仮想マシンとして実行するかどうかを指定します。

設定可能な値

trueレポート生成を別の仮想マシンとして実行します。
false(デフォルト値)レポート生成を別の仮想マシンとして実行しません。

report.separate_vm.launch.file

レポート生成時に使用する起動ファイルへのパスを指定します。

設定可能な値

[path] 

起動ファイルへのパスです。

(info) Windows のファイル パスを指定する際、2 つのバックスラッシュを使用してください。


report.test_params

レポートにパラメーターの詳細情報を含めるかどうかを指定します。 

設定可能な値

true(デフォルト値)レポートにパラメーターの詳細情報を含めます。
falseレポートにパラメーターの詳細情報を含めません。



session.tag

テスト セッションの結果をタグ付けするためのタグを指定します。タグは、特定のモジュールに対して実行された特定の解析プロセス固有の識別子です。異なるテスト セッションのレポートには、異なるセッション タグを付けるべきです。

文字列と変数を使用してタグを作成できます (「変数の使用」を参照)。

設定可能な値

[tag name]異なるセッションの結果を表す固有のタグ識別子です。デフォルトは ${scontrol_branch}-${exec_env} です。

使用例

デフォルトのセッション タグには、ソース管理システムのブランチ名および実行環境を表す変数が含まれます。たとえば、ソース管理システムとの統合が設定されておらず、64 ビット版 Windows でテスト セッションが実行された場合、レポートのセッション タグは次のようになります: ${scontrol_branch}-win32_x86_64

次の設定は、デフォルト以外のタグを指定します。

session.tag=ut_win


  • No labels