サーバーでの Polyspace Bug Finder の実行と Web インターフェイスへの結果のアップロード

Polyspace^® Bug Finder™ Server™ は、C/C++ コードで欠陥とコーディング規約違反をチェックしてから、コードレビューのために調査結果を Web インターフェイスにアップロードします。

継続的インテグレーションの一環として Bug Finder を実行できます。Bug Finder 解析を定期的に実行するか、新しいコード送信に基づいて実行するスクリプトを設定します。これらのスクリプトは、Polyspace Access Web インターフェイスでのレビューのために解析結果をアップロードし、オプションでソースファイルのオーナーに Polyspace の調査結果を記載したメールを送信します。オーナーは Web インターフェイスを開いて、送信された新しい調査結果のみをレビューし、問題を修正したり正当化したりできます。

一般的なプロジェクトまたはチームでは、Polyspace Bug Finder Server がいくつかのテストサーバーで定期的に実行され、レビューのために結果をアップロードします。チームの開発者と品質エンジニアの各々が Polyspace Access™ のライセンスを所有し、Web インターフェイスで結果を表示して調査とバグ修正を行います。

前提条件

サーバーで Bug Finder 解析を実行し、Polyspace Access Web インターフェイスで結果を確認するには、次の 1 回限りの設定を実行します。

解析を実行するには、Polyspace Bug Finder Server 製品のインスタンスを 1 つインストールします。
結果をアップロードするには、Polyspace Access の Web インターフェイスをホストするために必要なコンポーネントを設定します。
アップロードされた結果を表示するには、結果をレビューする開発者の各々が Polyspace Access のライセンスを所有していなければなりません。

Polyspace Server および Access 製品のインストールを参照してください。

Polyspace インストールのチェック

Polyspace Bug Finder Server がインストールされているかどうかを確認するには、次のようにします。

コマンドウィンドウを開きます。polyspaceserverroot\polyspace\bin に移動します。ここで、polyspaceserverroot は Polyspace Bug Finder Server インストールフォルダーです。たとえば、C:\Program Files\Polyspace Server\R2025a です。インストールフォルダーも参照してください。
以下を入力します。
polyspace-bug-finder-server -help

Bug Finder 解析で使用できるオプションのリストが表示されます。

Polyspace Access Web インターフェイスがアップロード用に設定されているかどうかをチェックするには、次のようにします。

再度 polyspaceserverroot\polyspace\bin に移動します。
以下を入力します。
polyspace-access -host hostName -port portNumber -create-project testProject
ここで、hostName は Polyspace Access Web サーバーをホストしているサーバーの名前です。ローカルでホストされているサーバーの場合は localhost を使用します。portNumber は、サーバーのポート番号 (オプション) です。ポート番号を省略した場合、9443 が使用されます。
設定が完了すると、testProject という名前のプロジェクトが Polyspace Access Web インターフェイスで作成されます。
polyspace-access コマンドを使用するたびに、ログイン名とパスワードの入力を求められます。毎回ログイン情報を入力しないようにするには、ログイン名とパスワードの暗号化バージョンをコマンドで提供します。暗号化されたパスワードを作成するには、次のように入力します。
polyspace-access -encrypt-password
ログイン名とパスワードを入力します。暗号化されたパスワードをコピーし、polyspace-access コマンドを使用するときに -encrypted-password オプションとこの暗号化パスワードを指定します。
Web ブラウザーで、次の URL を開きます。
```
https://hostName:portNumber/metrics/index.html
```
ここで、hostName と portNumber は、前の手順で使用したホスト名とポート番号です。

Polyspace Access Web インターフェイスの [プロジェクトエクスプローラー] ペインに、新しく作成されたプロジェクト testProject が表示されます。

サンプルファイルに対する Bug Finder の実行

Bug Finder を実行するには、オペレーティングシステムでコマンドウィンドウを開きます。

Bug Finder 解析を実行するには、polyspace-bug-finder-server コマンドを使用します。
結果を Polyspace Access Web インターフェイスにアップロードするには、polyspace-access -upload (Polyspace Access) コマンドを使用します。

コマンドへの絶対パスの入力を省略するには、パス polyspaceserverroot\polyspace\bin をオペレーティングシステムの Path 環境変数に追加します。

Polyspace インストールで提供されるサンプルファイルのコマンドを試します。

サンプルソースファイルを polyspaceserverroot\polyspace\examples\cxx\Bug_Finder_Example\sources から書き込み権限のある別のフォルダーにコピーします。コマンドラインでこのフォルダーに移動します。

以下を入力します。

polyspace-bug-finder-server -sources numerical.c,dataflow.c -I . -checkers numerical,data_flow -results-dir .
polyspace-access -host hostName -port portNumber -login username -encrypted-password pwd -create-project testProject
polyspace-access -host hostName -port portNumber -login username -encrypted-password pwd -upload . -project myFirstProject -parent-project testProject

ここで、username はログイン名、pwd は以前に作成した暗号化パスワードです。Polyspace インストールのチェックを参照してください。

Polyspace Access Web インターフェイスを更新します。[プロジェクトエクスプローラー] ペインに testProject フォルダーが表示されます。このフォルダーには、myFirstProject という 1 つのプロジェクトが含まれています。

プロジェクトの結果を確認するには、[レビュー] をクリックします。詳細は、Web ブラウザーでの Polyspace Bug Finder の結果のレビューを参照してください。Polyspace Access インターフェイスの右上にあるボタンを使用してドキュメントにアクセスすることもできます。

polyspace-bug-finder-server コマンドで使用される解析オプションは次のとおりです。

-sourcesコンマ区切りのソースファイルを指定します。
-Iインクルードフォルダーのパスを指定します。別のインクルードフォルダーを追加するたびに -I フラグを使用します。
欠陥の検出 (-checkers):チェックする欠陥 (バグ) を指定します。
-results-dir: Polyspace Bug Finder の結果を保存するフォルダーへのパスを指定します。
実行されるたびに結果フォルダーがクリーンアップされて再設定されることに注意してください。クリーンアップ中にファイルが誤って削除されないようにするには、他のファイルを含む既存のフォルダーを使用するのではなく、Polyspace の結果専用のフォルダーを指定します。

Bug Finder の解析で使用できるすべてのオプションのリストについては、Polyspace Bug Finder 解析エンジンのすべてのオプションのリストを参照してください。システムの Web ブラウザーで Bug Finder ドキュメンテーションを開くには、次のように入力します。

polyspace-bug-finder-server -doc

サーバーでの Bug Finder 解析用のサンプルスクリプト

解析を実行するために、コマンドラインでコマンドを入力する代わりにスクリプトを使用できます。スクリプトは、ソースファイルを追加または変更するたびに実行します。

Windows^® バッチファイルのサンプルを以下に示します。ここでは、Polyspace インストールへのパスをスクリプトで指定しています。このスクリプトを使用するには、polyspaceserverroot をインストールへのパスに置き換えます。スクリプトで使用する暗号化パスワードは生成済みでなければなければなりません。Polyspace インストールのチェックを参照してください。

echo off
set POLYSPACE_PATH=polyspaceserverroot\polyspace\bin
set LOGIN=-host hostName -port portNumber -login username -encrypted-password pwd
"%POLYSPACE_PATH%\polyspace-bug-finder-server" -sources numerical.c,dataflow.c -I .^
 -checkers numerical,data_flow -results-dir .
"%POLYSPACE_PATH%\polyspace-access" %LOGIN% -create-project testProject
"%POLYSPACE_PATH%\polyspace-access" %LOGIN% -upload . -project myFirstProject -parent-project testProject
pause

Linux^® シェルスクリプトのサンプルを以下に示します。

POLYSPACE_PATH=polyspaceserverroot/polyspace/bin
LOGIN=-host hostName -port portNumber -login username -encrypted-password pwd
${POLYSPACE_PATH}/polyspace-bug-finder-server -sources numerical.c,dataflow.c -I .\
 -checkers numberical,data_flow -results-dir .
${POLYSPACE_PATH}/polyspace-access $LOGIN -create-project testProject
${POLYSPACE_PATH}/polyspace-access $LOGIN -upload . -project myFirstProject -parent-project testProject

起動スクリプトとは別のファイルでのソースおよびオプションの指定

ソースファイルと解析オプションを起動スクリプト内でリスト指定する代わりに、それらを個別のテキストファイルでリスト指定できます。

オプション [-sources-list-file] を使用して、ソースをリストしたテキストファイルを指定します。
オプション [-options-file] を使用して、解析オプションをリストしたテキストファイルを指定します。

起動スクリプトからソースファイルと解析オプションの指定を削除することにより、起動スクリプトを変更せずに、新しいコード送信で必要に応じてこれらの指定を変更できます。

前の例のスクリプトについて考えてみます。polyspace-bug-finder-server コマンドを変更して、ソースとオプションを指定するテキストファイルを使用できます。以下のようにはしません。

polyspace-bug-finder-server -sources numerical.c,dataflow.c -I . -checkers numerical,data_flow -results-dir .

以下を使用します。

polyspace-bug-finder-server -sources-list-file sources.txt -options-file polyspace_opts.txt -results-dir .

ここで:

sources.txt には、以下のソースファイルが別々の行にリストされています。
```
numerical.c
dataflow.c
```
polyspace_opts.txt には、解析オプションが別々の行にリストされています。
```
-I .
-checkers numerical,data_flow
```

通常、ソースファイルはビルドコマンド (makefile) で指定されます。ソースファイルを直接指定する代わりに、ビルドコマンドをトレースしてソース指定のリストを作成できます。polyspace-configureを参照してください。

全体のワークフロー

一般的な継続的インテグレーションワークフローでは、次の手順を実行するスクリプトを実行します。

ビルドコマンドから Polyspace オプションを抽出します。
たとえば、makefile を使用してソースコードをビルドする場合、makefile から解析オプションを抽出できます。以下のコマンドは、まず make を実行し、実行されたプロセスから解析オプションを判別します。
polyspace-configure -output-options-file compile_opts make
参考:
- polyspace-configure
- ビルドコマンド (Makefile) からの Polyspace 解析構成の作成
前に作成したオプションファイルを使用して解析を実行します。解析に必要な残りのオプションが含まれた 2 番目のオプションファイルを追加します。
polyspace-bug-finder-server -options-file compile_opts -options-file run_opts
Polyspace 解析のオプションファイルを参照してください。
結果を Polyspace Access にアップロードします。
polyspace-access login -upload resultsFolder -project projName -parent-project parentProjName
ここで、login は、Polyspace Access をホストしている Web サーバーと通信するために必要なオプションの組み合わせです。
-host hostName -port portNumber -login username -encrypted-password pwd
resultsFolder は、Polyspace の結果を含むフォルダーです。projName と parentProjName は、Polyspace Access Web インターフェイスに表示されるプロジェクト名と親フォルダー名です。
必要に応じて、コード送信の新しい結果を含む電子メール通知を開発者に送信します。電子メールには、添付ファイルと Polyspace Access Web インターフェイスでの結果へのリンクが含まれます。
Polyspace Bug Finder Server の結果を含む電子メール通知の送信を参照してください。

これらの手順を実行するスクリプトの例については、Jenkins を使用した Polyspace 解析のサンプルスクリプトを参照してください。

参考

polyspace-access -create-project (Polyspace Access) | polyspace-access -upload (Polyspace Access) | polyspace-bug-finder-server