Kwadmin
kwadmin コマンドで、統合プロジェクトとビルドを管理します。以下のコマンドオプションを使用するには、特定のパーミッションレベルが必要になる場合があります。詳細については、Klocwork プロジェクトへのアクセスの有効化を参照してください。
使用方法
kwadmin [<common_options>] <subcommand> [<subcommand_options>]
フィールド
- <common_options> は、すべての kwadmin サブコマンドに適用されるオプションに一覧表示されているオプションのいずれかです。
- <subcommand> は以下のセクションで説明される kwadmin サブコマンドのいずれかです。
- <subcommand_options> は特定のサブコマンド用のオプションのいずれかです。
次のように、kwadmin 用または kwadmin サブコマンド用の引数ファイルも指定できます。
kwadmin @<arguments_file>
kwadmin <subcommand> @<arguments_file>
引数ファイルを作成して、コマンドライン引数を指定することができます。各引数は、独立した行に指定する必要があります。(引数ファイルにマルチバイト文字が含まれる場合、ファイルは UTF-8 でエンコードされている必要があります。)
例
kwadmin --url http://server01.acme.com:8080 list-projects
すべての kwadmin サブコマンドに適用されるオプション
以下のテーブルに示すオプションは、すべてのサブコマンドに適用されます。以下のセクションで、kwadmin サブコマンドと各サブコマンドに適用されるオプションに関する情報を説明します。以下のオプションはサブコマンドの前に配置します。
| 名前 | 説明 |
|---|---|
| @<arguments_file> | kwadmin サブコマンドとオプションを含むテキストファイルを指定します。非常に長いコマンドラインが使用できます（kwadmin set-project-property 用の jar ファイルのリストを指定する必要がある場合など）。 |
| --help | ソフトウェアのバージョン、著作権情報、およびコマンドのヘルプを表示します |
| --url http(s)://<validate_server_host>:<validate_server_port>/ | Validate サーバーの URL。セキュアな Validate サーバー接続が構成されている場合は、https:// を使用します。
|
| --verbose | プログラム実行についての詳細情報を表示します。これは、エラーのトラブルシューティングに役立ちます |
| --version | バージョン情報を取得します |
kwadmin create-project
kwadmin create-project を使用して、指定した名前の新しいプロジェクトを作成します。新しく作成されるプロジェクトには、解析 (ビルド) されるまでデータは含まれません。
kwadmin create-project <project_name> [options]
フィールド
- <project_name> は作成するプロジェクトの名前です。プロジェクト名とビルド名は文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。
例
kwadmin create-project Toolbus
kwadmin create-project を使用したストリームの作成
kwadmin create-project を使用して、既存プロジェクトのストリームを新規作成することもできます。子ストリームを作成する前に、親プロジェクトと指定された親ストリームが既に存在している必要があることに注意してください。プロジェクトやストリームの現在の名前を、Validate に表示されているとおりに、正確に指定する必要があります。
例
kwadmin create-project myProj/stream1
オプション
| 名前 | 説明 |
|---|---|
| --encoding <arg> | プロジェクトで使用するソースファイルのエンコードを指定します。デフォルトは、お使いのシステムのエンコーディングです。許容される値のリストを検索するには、kwconv の --list オプションを使用します。詳細については、kwbuildproject の --encoding オプションを参照してください。 |
kwadmin delete-build
このコマンドを使用して、プロジェクトビルドをビルドリストとデータベースから削除します。
kwadmin delete-build <project_name> <build_name>
フィールド
- <project_name> はビルドを削除するプロジェクトの名前です。
- <build_name> は削除するビルドの名前です。
例
kwadmin delete-build Toolbus build_9
kwadmin delete-ci-build
このコマンドを使用して、継続的インテグレーションビルドを CI ビルドリストとデータベースから削除します。
kwadmin delete-ci-build <project_name> <ci_build_name>
フィールド
- <project_name> はビルドを削除するプロジェクトの名前です。
- <ci_build_name> は削除するビルドの名前です。
例
kwadmin delete-ci-build demothenes ci_build_2
kwadmin delete-config
このコマンドを使用して、プロジェクトレベルまたはシステムの構成ファイルを削除します。構成ファイルの管理の詳細については、kwadmin import-config を参照してください。
kwadmin delete-config <project_name> <config-file_name>
フィールド
- <project_name> は構成ファイルを削除するプロジェクトの名前です。
プロジェクト名として "workspace" を指定すると、プロジェクトの構成ファイルのデフォルトのリストから構成ファイルを削除する必要があります。
- <config-file_name> は削除する構成ファイルの名前です。ファイルへのパスを指定するのではなく、ファイル名を指定します。
例
kwadmin delete-config Toolbus metrics_custom.mconf
kwadmin delete-config workspace OurMetrics.mconf
kwadmin delete-project
このコマンドを使用して、指定したプロジェクトとそのすべてのビルドをプロジェクトリストとデータベースから削除します。
kwadmin delete-project <project_name>
フィールド
- <project_name> は削除するプロジェクトの名前です。
例
kwadmin delete-project Toolbus --force
kwadmin delete-project Toolbus_2 --delete-inactive-project
オプション
| 名前 (および短い名前) | 説明 |
|---|---|
| --delete-inactive-project | このフラグを使用して、非アクティブなプロジェクトを削除します |
| --force | このオプションを使用して、プロジェクトおよび関連するストリームを強制的に削除します。 |
kwadmin duplicate-project
このコマンドは新しいプロジェクトを作成するときのショートカットとして使用します。これにより、プロジェクトの設定、表示、モジュール、プロジェクトに関連付けられたユーザーと権限、ソースタイプの場所へのポインター、および構成ファイルが複製されます。当初のプロジェクトのビルドは複製されません。
kwadmin duplicate-project <existing_project_name> <new_project_name>
フィールド
- <existing_project_name> は複製する既存のプロジェクトの名前です。
- <new_project_name> は作成するプロジェクトの名前です。プロジェクト名とビルド名は文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。
例
kwadmin duplicate-project Toolbus New_Toolbus
複製するプロジェクトの .conf ファイルに手動で構成されたプロパティや設定が含まれている場合、duplicate-project 操作の際にそのプロパティおよび値を確実にコピーするには、プロジェクトの Klocwork サーバーを再起動（または元の変更を構成した後に再起動）する必要があります。
kwadmin get-build-properties
このコマンドを使用して、指定したプロジェクトビルドのプロパティを表示します。ビルドプロパティの完全なリストは、統合プロジェクトとビルドプロパティのリファレンスを参照してください。
特定のプロジェクトビルドのプロパティを表示するには、次のコマンドを入力します。
kwadmin [--url http(s)://<host>:<port>/] get-build-properties <project_name> <build_name>
フィールド
- <host>:<port> には、Validate サーバーを実行するホストマシン (デフォルトは localhost) とポート (デフォルトは 8080) を指定します。
- <project_name> はビルドプロパティを表示するプロジェクトの名前です。
- <build_name> はプロパティを表示するビルドの名前です。
例
kwadmin get-build-properties Toolbus build_2
kwadmin get-project-properties
このコマンドを使用して、指定したプロジェクトのプロパティを表示します。これらのプロパティの一部は編集可能です。プロジェクトプロパティの完全なリストは、統合プロジェクトとビルドプロパティのリファレンスを参照してください。
既存のプロジェクトのプロパティを表示するには、次のコマンドを入力します。
kwadmin [--url http(s)://<host>:<port>/] get-project-properties <project_name>
フィールド
- <host>:<port> には、Validate サーバーを実行するホストマシン (デフォルトは localhost) とポート (デフォルトは 8080) を指定します。
- <project_name> はプロパティを表示するプロジェクトの名前です。
例
kwadmin get-project-properties Toolbus
kwadmin get-projects-root
このコマンドを使用して、現在の projects_root (つまり、Validate サーバーを起動した projects_root) を表示します。
kwadmin get-projects-root
例
kwadmin --url http://ServerXZY.acme.com:8080 get-projects-root
kwadmin import-config
kwadmin import-config を使用して、構成ファイルを単一のプロジェクトまたは projects_root 全体にインポートします。
kwadmin import-config <project_name> <file>
フィールド
- <project_name> は構成ファイルをインポートするプロジェクトの名前です。
プロジェクト名として "workspace" を指定すると、(projects_root ディレクトリにある) プロジェクトの構成ファイルのデフォルトのリストに構成ファイルをインポートする必要があります。
- <file> はインポートする構成ファイルへのフルパスです。構成ファイルのタイプは、拡張子または名前で判断されます。
例
kwadmin import-config Toolbus C:\Klocwork\OurMetrics.mconf
kwadmin import-config Toolbus C:\Klocwork\Toolbus_ownership.sow
kwadmin import-config workspace C:\Klocwork\OurMetrics.mconf
詳細については、統合プロジェクト用構成ファイルの管理を参照してください。
kwadmin export-config
構成ファイルをサーバーまたはプロジェクトからローカルマシンにダウンロードするには、kwadmin export-config を使用します。
kwadmin export-config [options] <project-name> <server-file> <local-file>
フィールド
- <project_name> はプロジェクトの名前であり、そこから構成ファイルをダウンロードします。
- <server-file> は、ダウンロードするサーバーファイルの名前です。
- <local-file> は、ローカルマシンに保存される、フォルダーまたはファイルの名前です。
例
kwadmin export-config Toolbus ExportedOurMetrics.mconf C:\Klocwork\OurMetrics.mconf
kwadmin export-config Toolbus ExportedOurMetrics.mconf C:\Klocwork\
kwadmin list-builds
このコマンドを使用して、指定したプロジェクトの既存のビルドを一覧表示します。
kwadmin list-builds <project_name>
フィールド
- <project_name> はビルドを表示するプロジェクトの名前です。
例
kwadmin list-builds Toolbus --detail
--detail オプションを追加すると、次のように、ビルドの日付、ビルドの自動削除の有無、およびビルドタグのリストが出力されます。
date=<date of build> keep=<true/false> tags=<list of build tags>
kwadmin list-ci-builds
このコマンドを使用して、指定したプロジェクトの既存の CI ビルドを一覧表示します。
kwadmin list-ci-builds <project_name>
フィールド
- <project_name> は、CI ビルドを表示したいプロジェクトの名前です。
例
kwadmin list-ci-builds demosthenes --detail
--detail オプションを追加すると、次のように、ビルドの日付、ビルドの自動削除の有無、およびビルドタグのリストが出力されます。
date=<date of build> keep=<true/false> tags=<list of build tags>
kwadmin list-config-files
kwadmin list-config-files を使用して、指定したプロジェクトで使用される構成ファイルを一覧表示します。「Klocwork プロジェクト用構成ファイル」も参照してください。
kwadmin list-config-files <project_name>
フィールド
- <project_name> は構成ファイルを表示するプロジェクトの名前です。
例
kwadmin list-config-files Toolbus
kwadmin list-config-types
kwadmin list-config-types を使用して、有効なタイプの構成ファイルの名前と拡張子を一覧表示します。編集可能な構成ファイルを参照してください。
kwadmin list-config-types
例
kwadmin --url http://myhost.acme.com:8080 list-config-types
kwadmin list-projects
このコマンドを使用して、現在の projects_root ディレクトリにある既存のプロジェクトのリストを表示します。
kwadmin list-projects
例
kwadmin --url http://myserver.acme.com:8080 list-projects
オプション
| 名前 (および短い名前) | 説明 |
|---|---|
| --include-streams (-s) | 結果にストリームを含める |
| --prefix-filter (-x) <string> | 指定された接頭辞で始まるプロジェクトとストリームに結果を制限する |
| --include-inactive (-i) | 非アクティブ状態のプロジェクトを含む、すべてのプロジェクトをリストする |
| --format-json (-f) | すべてのプロジェクトとその詳細を JSON 形式でリストする |
kwadmin load
このコマンドを使用して、kwbuildproject によって作成された Klocwork テーブルを Validate サーバーにロードします。
kwadmin load <project_name | path_to_stream> [<tables-directory>]
フィールド
-
<project_name | path_to_stream> は、ビルドをロードするプロジェクトの名前またはストリームへのパスです。
- <tables-directory> は、kwbuildproject によって生成された Klocwork テーブルへのパスです。テーブルディレクトリを projects_root ディレクトリに配置しないでください。このディレクトリの読み取り権限と作成権限を所有している必要があります。
例 1: プロジェクト名
kwadmin load Toolbus /my/tables/directory
例 2: ストリームへのパス
kwadmin load Toolbus/variant1 /my/tables/directory
オプション
| 名前 (および短い名前) | 説明 |
|---|---|
| --file-overrides <file> | ファイルを追加、削除、または名前変更するためのオーバーライドファイルを指定します。このオプションを使用すると、複雑なシナリオをより適切に制御して、ファイルの不一致を減らすことができます。ファイルオーバーライドファイルの使用の詳細については、ビルドのロードで推奨される手法を参照してください。 |
| --force | 前の解析がまだ進行中でも、新しい解析を開始します。このオプションは、解析は中止されたが、ビルド状態として「進行中」と表示されている場合にのみ使用します。新しい解析が正常に終了した場合は、--force オプションは必要ありません。 |
| --ignore-defect-threshold |
プロジェクトに設定された欠陥しきい値制限を無視し、それを超えた場合でもビルドを強制的にロードします。 |
| --name <build_name> | デフォルト以外のビルドの名前を設定します。デフォルトは "build#," で、フィールド # は 1、または最後に作成されたビルドよりも大きくします。削除されたビルドの番号は再利用できません。ビルド名では、数字 (0 ～ 9)、アルファベット (A ～ Z、a ～ z)、ピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコア文字のみ使用できます。<build_name> は 64 文字を超えることはできません。 |
| --tags | ビルドタグのカンマ区切りリストを指定します。 |
kwadmin lock-project-version
このコマンドは、以前のバージョンの Klocwork から、それ以降のバージョンの Validate サーバーにビルドをロードする場合に使用します。Klocwork の以前のバージョンが実行されるビルドマシンにこのコマンドを実行すると、このコマンドは、ビルドマシン上のエンジンおよびチェッカー設定に関する情報を格納するファイルを作成します。これにはすべてのカスタムチェッカーも含まれており、また有効なチェッカーも無効なチェッカーも含まれています。サーバーはこの情報をプロジェクトの基本設定として使用します。
kwadmin lock-project-version <project_name> --url http(s)://<host>:<port>/
フィールド
- <project_name> は、(新しい) Validate サーバーでのプロジェクト名です
- <host>:<port> には、(新しい) Validate サーバーを実行しているホストマシン (デフォルトは localhost) とポート (デフォルトは 8080) を指定します。
例
kwadmin lock-project-version myproject --url http://my2018server.acme.com:8084
詳細については、ビルドのクロスバージョンサポートを参照してください。
kwadmin rename-build
このコマンドを使用して、ビルドの名前を変更します。
kwadmin rename-build <project_name> <build_name> <new_build_name>
フィールド
- <project_name> は名前を変更するプロジェクトの名前です。
- <build_name> は名前を変更するビルドの名前です。
- <new_build_name> はビルドに付ける名前です。
プロジェクト名とビルド名は文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。
ホワイトスペースまたはピリオドを使用する場合は、名前を二重引用符で囲みます。
例
kwadmin rename-build demosthenes buidl_6 build_6
kwadmin rename-ci-build
このコマンドを使用して、CI ビルドの名前を変更します。
kwadmin rename-ci-build <project_name> <ci_build_name> <new_ci_build_name>
フィールド
- <project_name> は名前を変更するプロジェクトの名前です。
- <ci_build_name> は変更する CI ビルドの名前です。
- <new_ci_build_name> は CI ビルドに付ける名前です。
プロジェクト名とビルド名は文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。
ホワイトスペースまたはピリオドを使用する場合は、名前を二重引用符で囲みます。
例
kwadmin rename-ci-build demosthenes buidl_2 build_2
kwadmin rename-project
このコマンドを使用して、プロジェクトの名前を変更します。
kwadmin rename-project <path-to-project-or-stream> <new-project-or-stream-name>
フィールド
-
<path-to-project-or-stream> は、名前を変更するプロジェクトまたはストリームへのフルパスです
-
<new-project-or-stream-name> は、プロジェクトまたはストリームに付ける名前です
プロジェクト名、ストリーム名、ビルド名は、文字または数字で始まる必要があります。プロジェクト名とビルド名ではピリオド (.)、マイナス記号 (-)、ホワイトスペース、およびアンダースコアも使用できます。名前はそれぞれ 64 文字を超えることはできません。
ホワイトスペースまたはピリオドを使用する場合は、名前を二重引用符で囲みます。
例
kwadmin rename-project myProj/demosthenes demosthenes-new
kwadmin set-project-property
このコマンドを使用して、既存のプロジェクトのプロパティを設定します。変更内容は後続のすべての解析実行に適用されます。
前提条件: すべての Validate サーバーが実行している。Validate サーバーの管理を参照してください。
kwadmin --url http(s)://<server>:<port> set-project-property <project_name> <property> <value>
フィールド
- <project_name> は、既存のプロジェクトの名前です。
- <property> は、kwadmin で表示されるプロジェクトプロパティに示されているプロパティのいずれかです。
- <value> はプロジェクトプロパティの値です
例
常時グループ化オフでサーバーの指摘が表示されるように、指摘グループ化のデフォルト設定を変更します:
kwadmin --url http://myserver:8080/ set-project-property Toolbus grouping_on_default false
アップロードされたファイルが単一ファイル内の同じ種類の欠陥数の上限を超えた場合に、ビルドを失敗させるしきい値を設定します:
kwadmin set-project-property Toolbus same_kind_defect_per_file_threshold 5000
workspace を使用します。例:kwadmin --url http://myserver:8080/ set-project-property workspace grouping_on_default false
kwadmin set-project-property workspace same_kind_defect_per_file_threshold 5000
Notes
値がカンマで区切られたリストで構成されるプロパティに値を追加する場合は、追加する値 (値と値の間にスペース不要) だけでなく、すべての既存の値も指定する必要があります。そうしないと、既存の値は指定した値で上作成されます。
指定された値は Klocwork によって検証されません。このため、プロパティ値の設定によっては解析が失敗する可能性があります。無効なオプションが設定されている場合、そのコマンドを再度実行し、オプションの設定を元に戻します。無効なプロパティ以外のすべてのプロパティについては現在値を指定します。
以下の条件が当てはまる場合、プロパティ値全体を一重引用符で囲みます。
- 値にスペースが含まれる。
- 値がカンマで区切られたリストである。
- 値にダッシュ 2 個で始まるコマンドラインスイッチが含まれる。
詳細については、統合プロジェクトとビルドプロパティのリファレンスを参照してください。
kwadmin set-project-state
このコマンドを使用して、既存のプロジェクトの状態を設定します。
kwadmin set-project-state <project_name> <value>
フィールド
- <project_name> は、既存のプロジェクトの名前です。
- <value> はプロジェクトの状態の値 (active または inactive) です。
例
kwadmin set-project-state project_1 active
kwadmin unlock-project-version
お客様のプロジェクトに、Klocwork の前バージョンからのチェッカー設定をもはや使用しない場合は、このコマンドを使用して lock-project-version を元に戻します。このコマンドの実行後は、Klocwork はビルドがロードされた Validate サーバー用のチェッカー構成を使用します (ビルドマシンで実行された解析とは異なる一連のチェッカーにすることができます)。
kwadmin unlock-project-version <project_name> --url http(s)://<host>:<port>/
フィールド
- <project_name> は、(新しい) Validate サーバーでのプロジェクト名です
- <host>:<port> には、(新しい) Validate サーバーを実行しているホストマシン (デフォルトは localhost) とポート (デフォルトは 8080) を指定します。
例
kwadmin unlock-project-version myproject --url http://my2018server.acme.com:8084
詳細については、ビルドのクロスバージョンサポートを参照してください。
終了コード
- 終了コードは 1 です。
- サブコマンドは --help または --version