EN JP CN

kwconan

kwconan

kwconan コマンドは、CI システムによる解析を実行できるツールです。

kwconan は、Klocwork サーバーパッケージの一部としてインストールされます。

概要

kwconan <subcommand> [<common_options>] 

フィールド

  • <subcommand> は 'run'、'promote'、'import' です。run は前のベースラインからの継続ビルド解析を実行します。promote は最後のビルド解析の結果でベースラインを更新することができます。import は、連続的なインテグレーション分析で既存のシステムテーブルを使用することができます。
  • <common_options> は、次の 'Options' 表に示す任意のオプションです。
次のようにして、kwconan 用の引数ファイルも指定できます。
kwconan <subcommand> @<arguments_file>

'kwconan run' 向けオプション

名前 短い名前 説明
--help コマンドラインヘルプを表示します。
--version バージョンを表示します。
--tables-directory-tkwbuildproject によって作成されたテーブルディレクトリで、これは入力義務のあるオプションです。
--url http(s)://<host>:<port>/<project> Klocwork サーバー用 URL。Klocwork Server セキュア接続が構成されている場合は、https:// を使用してください。 これは入力義務のあるオプションです。
  • <host> には、接続する Klocwork サーバーを実行するホストマシンを指定します。
  • <port> には、接続する Klocwork サーバーが使用するポートを指定します。デフォルトは 8080 です
  • <project> には、使用するプロジェクト名を指定します。
--license-host 接続するライセンスサーバーを実行するホストマシンを指定します。
--license-port 接続するライセンスサーバーが使用するポートを指定します。
--reset-baseline 欠陥レポートベースラインをリセットします。
--agent <string> ビルドを実行したカスタムエージェントを示すために使用されるエージェント名です。指定しない場合、認証済みのユーザー名が使用されます。
--json 指定された場合、JSON 形式で全解析結果を出力します。このオプションでは、'kwconan'ライセンスが利用可能であることが必要です。
--output-file-o結果を、標準出力場所ではなく、指定されたファイルに出力します。

'kwconan promote' 向けオプション

名前 短い名前 説明
--help コマンドラインヘルプを表示します。
--version show version
--tables-directory-tkwbuildproject によって作成されたテーブルディレクトリで、これは入力義務のあるオプションです。
--url http(s)://<host>:<port>/<project> Klocwork サーバー用 URL。Klocwork Server セキュア接続が構成されている場合は、https:// を使用してください。 これは入力義務のあるオプションです。
  • <host> には、接続する Klocwork サーバーを実行するホストマシンを指定します。
  • <port> には、接続する Klocwork サーバーが使用するポートを指定します。デフォルトは 8080 です
  • <project> には、使用するプロジェクト名を指定します。
--license-host 接続するライセンスサーバーを実行するホストマシンを指定します。
--license-port 接続するライセンスサーバーが使用するポートを指定します。

'kwconan import' 向けオプション

名前 短い名前 説明
--help コマンドラインヘルプを表示します。
--tables-directory-tkwbuildproject によって作成されたテーブルディレクトリで、これは入力義務のあるオプションです。
--url http(s)://<host>:<port>/<project> Klocwork サーバー用 URL。Klocwork Server セキュア接続が構成されている場合は、https:// を使用してください。 これは入力義務のあるオプションです。
  • <host> には、接続する Klocwork サーバーを実行するホストマシンを指定します。
  • <port> には、接続する Klocwork サーバーが使用するポートを指定します。デフォルトは 8080 です
  • <project> には、使用するプロジェクト名を指定します。
--license-host 接続するライセンスサーバーを実行するホストマシンを指定します。
--license-port 接続するライセンスサーバーが使用するポートを指定します。
注: kwconan の実行時、'promote'、'run'、または 'import' のいずれかの指定は必須です。

例 1

'run' コマンドの例を以下に示します。

kwconan run --tables-directory mytables --url http://jsmith02:8080/myproject

この例では、

  • mytables は、kwbuildproject によって作成されたテーブルディレクトリへのパスです。
  • http://jsmith02:8080/myproject は、Klocwork サーバーおよびプロジェクト名へのパスです。

'kwconan' は、ベースラインビルドに関係する新しい問題および修正された問題を検出します。

例 2

'promote' コマンドの例を以下に示します。

kwconan promote --tables-directory mytables --url http://jsmith02:8080/my_project

この例では、

  • mytables は、kwbuildproject によって作成されたテーブルディレクトリへのパスです。

'kwconan promote' は、最近検出され修正された問題をベースラインに追加します (これらの問題は他のコミットで再導入されたり修正されたりしないかぎり、再び報告されません)

例 3

'import' コマンドの例を以下に示します。

kwconan import --tables-directory mytables --url http://jsmith02:8080/my_project
注: 既存のテーブルをインポートするために、ソースおよびビルド環境の位置は、元のシステムビルドと継続的インテグレーションビルドの間で完全に同一にする必要があります。

この例では、

  • mytables は、kwbuildproject によって作成されたテーブルディレクトリへのパスです。

いったんインポートを実行したら、システムテーブルは継続的インテグレーションモードテーブルに変換されます。'kwconan promote' が実行されて新しいベースラインが設定されるまで、インポート後に追加された欠陥が新しいものとみなされてJSON レポートで表示されるように、このステップではベースラインビルドも設定されます。

詳細については継続的インテグレーションに使用するビルドテーブルをインポートするを参照してください。