Kwciagent

kwciagent は、C/C++、C#、および Java 開発者向けの継続的インテグレーション (CI) 解析ツールです。

ベースプロジェクトまたはそのいずれかのストリームに接続しているときに、ローカル解析を実行すると、プロジェクトのベースプロジェクトとそのすべてのストリームで、すべての欠陥が同期されます。また、欠陥を引用すると、ベースプロジェクトとそのすべてのストリームにローカルに適用されます。

一般的な使用方法

サブコマンドは常に、コマンドラインの kwciagent コマンドの直後に置きます。

kwciagent <subcommand> [<options>]

Kwciagent サブコマンドで引数ファイルを使用できます。引数ファイルを作成して、コマンドライン引数を指定することができます。各引数は、独立した行に指定する必要があります。引数ファイルにマルチバイト文字が含まれる場合、ファイルは UTF-8 でエンコードされている必要があります。使用方法は以下のとおりです。

kwciagent <subcommand> @<arguments-file> 

kwciagent create

CI プロジェクト用のローカルプロジェクトおよびプロジェクト設定ディレクトリを作成します。新規作成されるプロジェクトには、解析されるまで、またはサーバープロジェクトと同期化されるまで、データは含まれません。

使用方法

kwciagent create --url http://<klocwork_server_host>:<klocwork_server_port>/<project> [-pd <local_project_dir>] [-sd <local_settings_dir>]

例

kwciagent create --url http://acme:8074/bigproject

詳細

デフォルトでは、ローカルプロジェクトおよび Klocwork プロジェクト設定ディレクトリは作業ディレクトリに作成され、.kwlp および .kwps の名前が付けられます。-pd と -sd オプションを使用すると、これらのディレクトリに独自の名前と場所を指定することができます。ただし、デフォルトの名前と場所を使用すると、kwciagentlist で解析またはフィルターの範囲をプロジェクト全体ではなく現在のサブディレクトリに制限することができます。

• .kwlp は、一時作業ファイルと build specification (ビルドスペック) ファイルを保存します。
• .kwps は、build specification (ビルドスペック) テンプレート (該当する場合) と構成ファイルを保存します

解析の結果と設定を削除するには、.kwlp ディレクトリを削除し、kwciagent create を再度実行します。

オプション

kwciagent disable

指定されたチェッカーを無効にします。ローカル構成を変更するパーミッションが必要です。チェッカーを有効または無効にすると、ユーザープロファイル (.pconf.xml) と呼ばれるファイルが作成され、デフォルト以外の設定がそれに保存されます。kwciagent export でこのファイルをエクスポートして、他のユーザーと共有することができます。Configuration Editor でチェッカーを無効にすることもできます。

使用方法

kwciagent disable <issue_code_1> [<issue_code_2>] [...]

例

kwciagent disable cl.mlk cwarn.signedbit

詳細

指摘コードをスペースで区切ります。指摘コードでは大文字と小文字は区別されません。ヘッダー解析チェッカーを無効にしても、kwciagent には何の影響も及ぼさないことに注意してください。

オプション

kwciagent discard

指定された構成ファイルをプロジェクトから削除します。ローカル構成を変更するパーミッションが必要です。

使用方法

kwciagent discard [options] <config_file>

例

kwciagent discard user_metrics.mconf

詳細

削除できる構成ファイルのタイプは、次のとおりです。

• build specification (ビルドスペック) (buildspec.txt)
• build specification template (ビルドスペックテンプレート) (.tpl)
• ユーザープロファイル (.pconf.xml)
• knowledge base (ナレッジベース) (.kb (C/C++ の場合) または .jkb (Java の場合))
• メトリックしきい値 (.mconf)
• マクロオーバーライドファイル (kw_override.h)

Important: ユーザープロファイルが削除されると、Klocwork はデフォルトのチェッカー設定に戻ります。

オプション

kwciagent enable

指定されたチェッカーを有効にします。ローカル構成を変更するパーミッションが必要です。チェッカーを有効または無効にすると、ユーザープロファイル (.pconf.xml) と呼ばれるファイルが作成され、デフォルト以外の設定がそれに保存されます。kwciagent export でこのファイルをエクスポートして、他のユーザーと共有することができます。Configuration Editor でチェッカーを有効にすることもできます。

使用方法

kwciagent enable [options] <issue_code_1> [issue_code_2][...]

例

kwciagent enable cl.assign.void cwarn.signedbit

詳細

指摘コードをスペースで区切ります。指摘コードでは大文字と小文字は区別されません。ヘッダー解析チェッカーを無効にしても、kwciagent には何の影響も及ぼさないことに注意してください。

オプション

kwciagent export

指定された構成ファイルをプロジェクトからエクスポートし、他のユーザーと共有できるようにします。ローカル構成を変更するパーミッションが必要です。connected desktop (コネクテッドデスクトップ) を使用すると、構成設定はすべてサーバーからデスクトップにプッシュされます。ローカル構成を変更するパーミッションがある場合、ローカル設定をエクスポートして他のユーザーがそれをインポートできるようにすることが可能です。ローカル設定が優先されます。

使用方法

kwciagent export [options] <config_file>

例

kwciagent export user_metrics.mconf -o /shared/jlee_metrics.mconf

詳細

次の構成ファイルをエクスポートすることができます。

• ユーザープロファイル (.pconf.)
• knowledge base (ナレッジベース) (.kb (C/C++ の場合)、.jkb (Java の場合))
• メトリックしきい値 (.mconf)
• マクロオーバーライドファイル (kw_override.h)

オプション

kwciagent import

指定された構成ファイルをローカルプロジェクトにインポートします。ローカル構成を変更するパーミッションが必要です。connected desktop (コネクテッドデスクトップ) を使用すると、構成設定はすべてサーバーからデスクトップにプッシュされます。ローカル構成を変更するパーミッションがある場合、ローカル設定をエクスポートして他のユーザーがそれをインポートできるようにすることが可能です。ローカル設定が優先されます。

使用方法

kwciagent import [options] <file>

例

kwciagent import /shared/jlee_metrics.mconf

詳細

knowledge base (ナレッジベース) を除き、ローカルプロジェクトに含めることができるのは、次のファイルタイプについてそれぞれ 1 つずつだけです。

拡張子がデフォルト以外のファイルをインポートするには、--type オプションを指定します。

指摘の除外

特定の制約に関する特定の指摘タイプまたはすべての指摘タイプをフィルター処理するための、外部構成ファイルを指定できます。フィルター処理するマクロの直接名を指定する必要があります。正規表現を使用してマクロ名を指定することはできません。詳細については、指摘の除外を参照してください。

オプション

kwciagent info

ローカルプロジェクト設定を表示します。

使用方法

kwciagent info [options] 

例

kwciagent info -pd new_project

詳細

表示される設定は、次のとおりです。

• status.permission: 指摘ステータスを変更するときに使用できるステータス。*\:* は、報告された指摘のステータスを任意のステータスに変更できる、または任意のステータスから変更できることを意味します。
• klocwork.host: 接続されたプロジェクトのみ。
• klocwork.project: 接続されたプロジェクトのみ。
• license.host: すべてのプロジェクトについて、接続されているかどうか。
• license.port: すべてのプロジェクトについて、接続されているかどうか。
• useconf.permission: チェッカーの有効/無効の切り替えなど、ローカル構成を変更するパーミッションがあるかどうか。

オプション

kwciagent list

指摘番号、指摘コード、ステータス、重要度、およびファイルで指摘リストをフィルタリングします。

使用方法

kwciagent list [options] [<file_1>] [<file_2>] [...] 

例

kwciagent list --id 4-9,16-22,77 --issue abr,abv.stack foo.c foo2.cpp

詳細

ファイルはスペースで区切る必要があるのに対し、ステータスなどのフィルタリングオプションは、カンマで区切る必要があります。重要度または指摘 ID の範囲は、ハイフンで表現します。

デフォルトでは、kwciagent は次のような指摘を表示します。

• 検知 (Analyze) と要修正 (Fix) ステータスにある
• すべての重要度の指摘
• プロジェクトまたはサブディレクトリのすべてのソースファイル内の、
• 原点が「ローカル」

.kwlp があるディレクトリから kwciagent list を実行すると、プロジェクト全体で検出された指摘が一覧表示されます。ローカルプロジェクトディレクトリが、デフォルト名 (.kwlp) を持ち、ソースツリーにある場合、プロジェクト全体ではなく現在のサブディレクトリ内の指摘をフィルタリングすることができます。目的のサブディレクトリから kwciagent list を実行するだけです。所定ディレクトリ外のヘッダーファイル内の指摘は、一覧表示されません。

ストリームを含むプロジェクトで kwciagent list を実行すると、次のように、出力にいくつかの追加フラグが表示されます。

JSON:

"inConnected": true/false、

"inOtherStreams": true/false、

XML:

<inOtherStreams>true/false</inOtherStreams>

<inConnected>true/false</inConnected>

inConnected は、接続されたストリームまたはプロジェクトに指摘が直接存在し、それが "Fixed" 状態でない場合に true になります。inOtherStreams は、接続されたストリームを除くファミリーツリー内のいずれかのストリームに指摘が存在する場合に true になります。どちらのフラグも true になる可能性があります (たとえば、指摘は接続されたストリームと追加ストリームの両方に存在します)。

フィルターオプション

その他のオプション

kwciagent list-conf

ローカルプロジェクトで使用される構成ファイルをリストします。

使用方法

kwciagent list-conf

例

kwciagent list-conf -pd my_project

説明

サポートされている構成ファイル:

• build specification (ビルドスペック) (buildspec.txt)
• build specification template (ビルドスペックテンプレート) (.tpl)
• ユーザープロファイル (.pconf.xml)
• knowledge base (ナレッジベース) (.kb (C/C++ の場合) または .jkb (Java の場合))
• メトリックしきい値 (.mconf)
• マクロオーバーライドファイル (kw_override.h)

オプション

kwciagent list-projects

Klocwork サーバー上のプロジェクトをリストします。

使用方法

kwciagent list-projects

例

kwciagent list-projects --url http://server1.acme.com:8080

オプション

kwciagent list-statuses

検出された指摘が取り得るステータスをリストします。

使用方法

kwciagent list-statuses 

kwciagent list-vars

kwciagent set-var を使用して設定された build specification template (ビルドスペックテンプレート) 内の変数をリストします。

使用方法

kwciagent list-vars [options]

オプション

kwciagent remove-var

build specification template (ビルドスペックテンプレート) に対して設定された変数を削除します。

使用方法

kwciagent remove-var [options] <var1> [var2] [...]

オプション

kwciagent run

プロジェクト、サブディレクトリ、またはファイル上で解析を実行します。

使用方法

kwciagent run [options]

例

kwciagent run --issue ABR,MLK.MUST --severity 1-3 -F detailed --report project.txt foo.c foo2.cpp

詳細

ファイルはスペースで区切る必要があるのに対し、ステータスなどのフィルタリングオプションは、カンマで区切る必要があります。重要度または指摘 ID の範囲は、ハイフンで表現します。.kwlp があるディレクトリから kwciagent run を実行すると、プロジェクトのソースファイルすべてが解析されます。C/C++ プロジェクトの場合、ローカルプロジェクトディレクトリが、デフォルト名 (.kwlp) を持ち、ソースツリーにある場合、解析のコンテキストを現在のサブディレクトリに制限することができます。そのサブディレクトリ (および子ディレクトリ) にあるファイルが解析されます。Java プロジェクトの場合、個別のファイルを解析する Klocwork は推奨できません。これは、解析範囲の制限によって結果が不正確になることがあるからです。

オプション

kwciagent set

ローカルプロジェクト設定を変更します。

使用方法

kwciagent set [options] <property_name>=<property_value> [...]

例

kwciagent set klocwork.host=acmedev klocwork.port=1108

説明

取り得るプロパティ/値ペア:

オプション

kwciagent set-status

指摘ステータスを変更し、コメントを追加します。

使用方法

kwciagent set-status [options] <issue_ID> [<issue_ID> <issue_ID>-<issue_ID> [...]

例

kwciagent set-status 22 7 30-32 --status fix -c "top priority"

説明

複数の指摘 ID はスペースで区切るか、ハイフンで範囲を表現します。

オプション

kwciagent set-var

build specification template (ビルドスペックテンプレート) 内の変数をローカルプロジェクトのローカルパスにマッピングします。1 つ以上の変数を定義する必要があることを示すエラーメッセージが表示されたら、kwciagent set-var を使用して変数をマッピングするだけで十分です。

使用方法

kwciagent set-var [options] <var1>=<pathname> [<var2>=<pathname>] [...]

例

kwciagent set-var SCROOT=/builds/nightly/foosystem

オプション

kwciagent sync

結果とステータス変更をサーバープロジェクトに送信し、サーバープロジェクト解析結果、ステータス変更、および構成設定をローカルプロジェクトに取り込みます。

使用方法

kwciagent sync

例

kwciagent sync foo.c

説明

Klocwork サーバー上の connected desktop (コネクテッドデスクトップ) とプロジェクトの間で、同期が自動的に行われます。しかし、kwciagent sync では手動で同期することができます。

オプション