EN JP CN

カスタムチェッカーの展開

カスタムチェッカーの展開

カスタムチェッカーを展開するには、次のいずれかを行うことができます:

  • サーバーへのチェッカー展開パッケージの配置カスタムチェッカーをサーバープロジェクトに展開するには、kwdeploy コマンドを使用して、同期によって接続されたどのデスクトップでも使用できるようにします。
  • 通常、チェッカー テストの目的で、デスクトップにパッケージを展開しますデスクトップのみの展開では、kwdeploy コマンドは使用せず、チェッカー展開パッケージを適切なフォルダーに置くだけで達成されます。カスタム関数付き KAST チェッカー、および、C/C++ Path チェッカーは、デスクトップに手動でインストールする必要があります。これは、同期によってサーバーからデスクトップに .dll または .so ファイルがプッシュされることがなく、また、その逆もないからです。

チェッカー展開パッケージ

チェッカーの展開は、チェッカー展開パッケージを使用して開始します。チェッカー展開パッケージは、カスタム チェッカーをビルドしたときに作成されたファイルを含む、jar または zip ファイル アーカイブです。チェッカー展開パッケージには、以下のために必要なファイルが含まれています:

  • チェッカーを、統合プロジェクトのために Configuration Editor に表示し、また、接続されたあらゆるデスクトップのために Configuration Editor に表示して、ユーザーが新しいチェッカーと有効または無効にできるようにします
  • 特定の C/C++、C# または Java 指摘タイプを検出します
  • Klocwork Review にチェッカー用の指摘ヘルプを表示します
  • チェッカー用指摘ヘルプを、http://<klocwork_server_host>:<klocwork_server_port>/documentation の C/C++、C# または Java チェッカーリファレンスに表示します。Klocwork ドキュメンテーションは、所属組織に Klocwork のサーバーインストールがある場合のみ使用可能です。
  • Klocwork Review および Klocwork プラグインの解析結果に、適切なメッセージとチェッカーのタイトルを表示します。

カスタムチェッカーを展開する場合は、それが Java、C/C++、C# チェッカーのいずれであるかが分かっている必要があり、C/C++ チェッカーであれば、それがフォーム固有であるかどうか判定します。通常、C/C++ チェッカーはプラットフォーム固有ですが、カスタム関数と使用しない C/C++ KAST チェッカーはプラットフォーム非依存型です。チェッカー展開パッケージ (ZIP ファイル) の内容を確認し、最上位にプラットフォームサブディレクトリがあるかを調べます。最上位のプラットフォームサブディレクトリがパッケージに含まれる場合は、チェッカーはプラットフォーム固有です。また、展開前に、チェッカーを無効にできるようにするか決定することも必要です。

チェッカー展開パッケージの内容

チェッカー展開パッケージの内容は、KAST チェッカーであるか、Path チェッカーであるかにより、また、C/C++ チェッカーであるか Java チェッカーであるかによって異なります。C/C++ チェッカーは ZIP ファイルに格納され、Java チェッカーは JAR ファイルに格納されます。

Java Path または KAST チェッカー用の JAR には次のファイルおよびフォルダーが含まれます:

ファイル名またはフォルダー説明
<CHECKER.CODE>.jkbJava Path チェッカー用のみ、チェッカーの動作を定義するナレッジベースファイルが含まれます。
checkers.xmlチェッカー構成であり、デフォルトではチェッカーは解析に有効になります。展開前に、チェッカーを無効にできるようにする場合に、アクセスする必要があるファイルです。
toc.xml、<CHECKER.CODE>.htm、などKlocwork Review が読み取れるフォーマットに変換した、チェッカーのヘルプファイルが含まれ、また、http://<klocwork_server_host>:<klocwork_server_port>/documentation の Klocwork ドキュメンテーションも同様です。

C/C++ KAST または Path チェッカー用の ZIP ファイルには次のファイルおよびフォルダーが含まれます:

ファイル名またはフォルダー説明
<CHECKER.NAME>.xmlチェッカー構成であり、デフォルトではチェッカーは解析に有効になります。展開前に、チェッカーを無効にできるようにする場合に、アクセスする必要があるファイルです。
<CHECKER.NAME>.jarKlocwork Review が読み取れるフォーマットに変換した、チェッカーのヘルプファイルが含まれ、また、http://<klocwork_server_host>:<klocwork_server_port>/documentation の Klocwork ドキュメンテーションも同様です。
<platform directory>チェッカーが Path チェッカーまたはカスタム関数を使用する KAST チェッカーである場合の、プラットフォームディレクトリです。プラットフォームディレクトリーには、プラグインライブラリー (.so または .dll) が含まれる筈です。可能性があるサブディレクトリーは:
  • ix86-pc-win32
  • ix86-pc-linux
  • sparc-sun-solaris2
  • powerpc-ibm-aix
  • ix86-apple-macosx

C# KAST チェッカー用の ZIP ファイルには次のファイルおよびフォルダーが含まれます:

ファイル名またはフォルダー説明
<CHECKER.NAME>.xmlチェッカー構成であり、デフォルトではチェッカーは解析に有効になります。展開前に、チェッカーを無効にできるようにする場合に、アクセスする必要があるファイルです。
<CHECKER.NAME>.jarKlocwork Review が読み取れるフォーマットに変換した、チェッカーのヘルプファイルが含まれ、また、http://<klocwork_server_host>:<klocwork_server_port>/documentation の Klocwork ドキュメンテーションも同様です。