このセクションでは、ソースコードまたは抑制ファイルで Parasoft 製品の指摘事項を手動で抑制する方法を説明します。IDE の UI を使って指摘事項を抑制する方法については「GUI での指摘事項の抑制」を参照してください。

はじめに

違反を抑制すると、 C/C++test は特定の静的解析タスクをそれ以降レポートしなくなります。全般的にコーディング規約に従いつつ、レポートされた指摘のうちの一部だけをあえて無視する場合、抑制機能が便利です。特定のルールのすべての違反メッセージを受け取りたくない場合は、テストコンフィギュレーションでルールを無効にします。

MISRA 標準へのコンプライアンスを達成するためにワークフローを構築している場合、DTP で作成される MISRA コンプライアンスレポートから誤検出された違反を除くことができます。違反を抑制し、抑制の理由として「false positive」で始まる文字列を指定すると、違反は MISRA コンプライアンスレポートに載りません。Parasoft コンプライアンスソリューションの詳細については、DTP ユーザーガイドを参照してください。

ソースコードでの抑制の定義

次の構文を使用してソースコード内に抑制を定義します。

行単位の抑制

行単位の抑制を使用すると、単一行の違反を抑制できます。次の構文を使用して、違反がある行の行末に抑制コメントを指定します。

// parasoft-suppress <rule-id>|<rule-category>|ALL "<suppression comment>"

例:

int proc1(bool a, bool b, int i)
{
	if (a | b) // parasoft-suppress CERT_C "suppress all rules in category CERT_C"
	if (b = a)// parasoft-suppress CERT_C-EXP45 "suppress rule CERT_C-EXP45"
	{
		std::string emptyString1 = ""; // parasoft-suppress JSF-3 "suppress all rules in category Joint Strike Fighter with severity level 3 and lower"
	}
	else
	{
		std::string emptyString2 = ""; // parasoft-suppress CERT_C-DCL00 JSF-043 JSF-051 "suppress multiple rules"
	}
	return i++;                // parasoft-suppress ALL "suppress all rules"
}

次行の抑制

次行の抑制を使用すると、単一行の違反を抑制できます。次の構文を使用して、違反がある行の直前に抑制コメントを指定します。

// parasoft-suppress-next-line <rule-id>|<rule-category>|ALL "<suppression comment>"

抑制コメントと抑制対象の指摘事項を含む行の間に他のコメントまたは空の行があってはいけません。唯一の例外は、次行の抑制が複数指定されている場合です。

// parasoft-suppress-next-line AUTOSAR-A7_1_1-a "reason for suppression AUTOSAR-A7_1_1-a"
// parasoft-suppress-next-line AUTOSAR-A7_1_1-b "reason for suppression AUTOSAR-A7_1_1-b"
// parasoft-suppress-next-line AUTOSAR-A8_5_2-a "reason for suppression AUTOSAR-A8_5_2-a"
... code line ...

この場合、最後の抑制コメントの次の行にすべての抑制が適用されます。

例:

int proc1(bool a, bool b, int i)
{
	// parasoft-suppress-next-line CERT_C "suppress all rules in category CERT_C"
	if (a | b)
 	// parasoft-suppress-next-line CERT_C-EXP45 "suppress rule CERT_C-EXP45"
	if (b = a)
	{
		// parasoft-suppress-next-line JSF-3 "suppress all rules in category Joint Strike Fighter with severity level 3 and lower" 
		std::string emptyString1 = "";
	}
	// parasoft-suppress-next-line ALL "suppress all rules" 
	return i++;
}

ブロック単位の抑制

ブロック単位の抑制を使用すると、コードブロックの違反を抑制できます。次の構文を使用して、違反があるコードブロックの前後に開始/終了コメントを指定します。

// parasoft-begin-suppress <rule-id>|<rule-category>|ALL "<suppression comment>"
... code block ...
// parasoft-end-suppress   <rule-id>|<rule-category>|ALL "<suppression comment>"

'parasoft-begin-suppress' および 'parasoft-end-suppress' コメントは別個の行になければなりません。

例:

int proc2(bool a, bool b, int i)
{  
    // parasoft-begin-suppress CERT_C "begin suppress all rules in category CERT_C"
    if (a | b)                         
        if(b = a)
    // parasoft-end-suppress CERT_C "end suppress all rules in category CERT_C"
        {
            std::string emptyString1 = "";   
        }
    return i++;                        
}
 
int proc3(bool a, bool b, int i)
{  
    if (a | b)
        // parasoft-begin-suppress CERT_C-EXP45 "begin suppress rule CERT_C-EXP45"
        if(b = a)
        // parasoft-end-suppress CERT_C-EXP45 "end suppress rule CERT_C-EXP45"
        {
            std::string emptyString1 = "";   
        }
    return i++;                        
}
 
int proc4(bool a, bool b, int i)
{  
    // parasoft-begin-suppress JSF-3 "begin suppress all rules in category Joint Strike Fighter with severity level 3 and lower"
    if (a | b)
        if(b = a)
        {
            std::string emptyString1 = "";   
        }
    return i++;
    // parasoft-end-suppress JSF-3 "end suppress all rules in category Joint Strike Fighter with severity level 3 and lower"
}
 
// parasoft-begin-suppress ALL "begin suppress all rules"
int proc5(bool a, bool b, int i)
{
    if (a | b)
        if(b = a)
        {
            std::string emptyString1 = "";   
        }
    return i++;
}
// parasoft-end-suppress ALL "end suppress all rules"

ファイルで複数のルールを抑制するには、ファイルの先頭/末尾に次を含めます。

// parasoft-begin-suppress CERT_C-DCL00 JSF-043 JSF-051 "begin suppress multiple rules"
.....
// parasoft-end-suppress CERT_C-DCL00 JSF-043 JSF-051 "end suppress multiple rules"

注意点

抑制の理由を記述するのは良いプラクティスです。
次のルールパターンがサポートされています。
<rule-id>|<rule-category>|ALL
例 (次の例は、単一行の違反を抑制するものです)。
- PB.TYPO.TLS ルールの抑制:
  // parasoft-suppress PB.TYPO.TLS
- CODSTA カテゴリのすべてのルールを抑制:
  // parasoft-suppress CODSTA
- CODSTA カテゴリの重要度レベルが 4 以下のすべてのルールを抑制:
  // parasoft-suppress CODSTA-4
- 複数のルールの抑制:
  // parasoft-suppress CERT_C-DCL00 JSF-043 JSF-051
- すべてのルールの抑制:
  // parasoft-suppress ALL

抑制ファイルでの抑制の定義

抑制する指摘事項の属性を指定した parasoft.suppress ファイルを作成することで、特定の指摘事項のレポートを抑制できます。抑制ファイルは、指摘事項を含むソースファイルと同じディレクトリに置くか、[その他の設定] ウィンドウ (「高度な設定のカスタマイズ」を参照) で suppression.infile.location オプションを使用して指定する必要があります。このオプションは、CLI および IDE の両方で違反の抑制に使用される抑制ファイルの場所を指定します。場所は次のように指定できます。

ファイルへの絶対パス
次の属性を使用: ${file_name}、${file_loc} および ${project_loc}。例: ${file_loc}/parasoft.suppress

例: suppression.infile.location=C:/parasoft/suppression/storage/parasoft.suppress

抑制ファイルをソース管理システムにチェックインすることを推奨します。そうすると、抑制に関する情報を他のチームメンバーと共有でき、master、trunk などのメインの開発ストリームにコードをマージする前に SCM リポジトリのブランチで容易に抑制をレビューできます。

次のフォーマットを使用して parasoft.suppress ファイルに抑制エントリを追加します。

suppression-begin
file: Account.cpp                 (required)
line: 12                          (optional)
rule-id: CODSTA-4                 (optional)
message: Exact violation message  (optional)
reason: Approved                  (optional)
author: devel                     (optional)
date: 2020-09-21                  (optional)
suppression-end

例:

最低でも、問題が検出されたソースファイルを指定する必要があります。ソースファイルだけを指定すると、指定されたファイルに対してレポートされたすべての指摘事項が抑制されます。次のサンプルでは、Account ファイルで検出されたすべての違反が抑制されます。

suppression-begin
file: Account.cpp
reason: false positive
suppression-end

次のワイルドカードおよびその他のパラメーターを使用してファイルパスを指定できます (この機能は、[その他の設定] ウィンドウで parasoft.suppress ファイルの場所がデフォルトの場所以外に設定されている場合に特に便利です)。

パラメーター	説明
`?`	パス区切り文字以外の任意の 1 文字に一致するワイルドカード
`*`	パス区切り文字以外の任意の 0 文字以上に一致するワイルドカード
`**`	0 個以上のパスセグメントに一致するワイルドカード
`/`	すべてのオペレーティングシステムの区切り文字
`"[non-alphanumeric characters]"`	パスに空白またはその他の非英数文字が含まれる場合、引用符を使用します。

他の属性は任意であり、抑制を細かく制御するのに利用できます。次のサンプルでは、Account ファイルで検出された PB.TYPO.TLS ルールのすべての違反が、違反が発生した行にかかわらず抑制されます。

suppression-begin
file: Account.cpp
rule-id: PB.TYPO.TLS
suppression-end

注意点

抑制の理由を記述するのは良いプラクティスです。
line 属性の使用には注意が必要です。ソースファイルが変更され、コードが別の行に移動すると、抑制が無効になる可能性があります。

rule-id 属性では、次の値がサポートされます。

<rule-id>|<rule-category>|ALL

例:

PB.TYPO.TLS ルールの抑制:

suppression-begin
file: **/autogenerated/*
rule-id: PB.TYPO.TLS
suppression-end

CODSTA カテゴリのすべてのルールを抑制:

suppression-begin
file: **/autogenerated/*
rule-id: CODSTA
suppression-end

CODSTA カテゴリの重要度レベルが 4 以下のすべてのルールを抑制:
suppression-begin file: **/autogenerated/* rule-id: CODSTA-4 suppression-end

すべてのルールの抑制:

suppression-begin
file: **/autogenerated/*
rule-id: ALL
suppression-end

message 属性では、次のワイルドカードがサポートされます。
- ? - 任意の 1 文字
- * - 任意の文字の連続

正規表現パターンに基づく行抑制の定義

正規表現パターンに一致する行で検出された静的ルール違反を自動的に抑制するよう設定できます。これは、Qt マクロなど、行内またはコード内抑制を使用して抑制するのが難しい指摘を抑制したい場合に便利です。

.properties ファイルまたはコマンドラインで次のオプションを設定し、正規表現パターンを指定します (「設定の概要」を参照)。

cpptest.result.line.suppressions.enabled=true          // Enables creating regex-based suppressions.
cpptest.result.line.suppressions.pattern=[regex<rule-id|rule-category|ALL>;regex<rule-id|rule-category|ALL>] // Specifies a semicolon-separated list of regex patterns.

注意: <> 括弧は、ルールを指定する場合にだけ必要です。カンマ区切りのリストでルールを指定することもできます。

指定された正規表現パターンに一致する行で発生した静的ルール違反が抑制されます。たとえば、次のように指定すると、任意の個所に "Q_" を含むコード行で検出されたすべての違反が抑制されます。

cpptest.result.line.suppressions.enabled=true
cpptest.result.line.suppressions.pattern=.*Q_.*<OPT>