このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

polyspace-report-generator

(システム コマンド) ローカルで、または Polyspace Access に保存される Polyspace 解析結果のレポートの生成

ページ内をすべて折りたたむ

構文

polyspace-report-generator -template outputTemplate [reporting options]
polyspace-report-generator -generate-results-list-file [-results-dir resultsFolder] [-set-language-english]
polyspace-report-generator -generate-variable-access-file [-results-dir resultsFolder] [-set-language-english]
polyspace-report-generator -configure-keystore
polyspace-report-generator -template outputTemplate -host hostName -run-id runID [polyspace access options] [reporting options]
polyspace-report-generator -generate-results-list-file -host hostName -run-id runID [polyspace access options] [-set-language-english]
polyspace-report-generator -generate-variable-access-file -host hostName -run-id runID [polyspace access options] [-set-language-english]

説明

polyspace-report-generator システム コマンドは、事前定義テンプレートまたはカスタム テンプレートを使用して、PDF、Word、または HTML のレポートを Polyspace® 静的解析結果から生成します。

ローカル結果からのレポートの生成

メモ

この Polyspace コマンドは polyspaceroot\polyspace\bin にあります。ここで、polyspaceroot は Polyspace インストール フォルダー (C:\Program Files\Polyspace\R2025a など) です (デスクトップ製品の場合はインストール フォルダー、サーバー製品の場合はインストール フォルダーも参照してください)。コマンドの絶対パスの入力を省略するには、この場所をオペレーティング システムの PATH 環境変数に追加します。

polyspace-report-generator -template outputTemplate [reporting options] は、reporting options で指定されたローカル解析結果にテンプレート outputTemplate を使用することによって、レポートを生成します。

既定では、project-name の結果のレポートは、PathToFolder\Polyspace-Doc フォルダーに project-name_report-name として保存されます。PathToFolder は project-name の結果フォルダーです。

例

polyspace-report-generator -generate-results-list-file [-results-dir resultsFolder] [-set-language-english] は resultsFolder にローカル保存された解析結果をタブ区切りのテキスト ファイルにエクスポートします。ファイルには、ユーザー インターフェイスの [結果のリスト] ペインで使用可能な結果情報が含まれます。エクスポートされる結果のリストについては、エクスポートした結果の表示を参照してください。

既定では、project-name の結果に関する結果ファイルは、PathToFolder\Polyspace-Doc フォルダーに保存されます。PathToFolder は project-name の結果フォルダーです。

タブ区切りのテキスト ファイルに結果をエクスポートする場合は、polyspace-results-export コマンドをお勧めします。

polyspace-report-generator -generate-variable-access-file [-results-dir resultsFolder] [-set-language-english] は、コードに含まれるグローバル変数のリストを、FOLDER にローカル保存された Code Prover 解析から、タブ区切りのテキスト ファイルにエクスポートします。このファイルには、ユーザー インターフェイスの [変数アクセス] ペインで使用可能な情報が含まれます。エクスポートされる変数のリストについては、エクスポートした変数リストの表示を参照してください。

既定では、project-name の結果に関する変数ファイルは、PathToFolder\Polyspace-Doc フォルダーに保存されます。PathToFolder は project-name の結果フォルダーです。

polyspace-report-generator -configure-keystore は、HTTPS 経由で Polyspace Access™ と通信するように Report Generator を構成します。

この 1 回だけの構成ステップは、HTTPS プロトコルを使用するように Polyspace Access が構成されているが、Polyspace Bug Finder™ デスクトップのライセンスを保持していない場合、またはデスクトップのライセンスを保持しているが、HTTPS 経由で Polyspace Access と通信するようにデスクトップ UI を構成していない場合に実行します。このコマンドを実行する前に Polyspace Access が HTTPS で使用する SSL 証明書を保存するクライアントのキーストアを生成します。クライアント キーストアの生成 (Polyspace Access)を参照してください。

例

PolyspaceAccess の結果からのレポートの生成

polyspace-report-generator -template outputTemplate -host hostName -run-id runID [polyspace access options] [reporting options] は、Polyspace Access 上の実行 runID に対応する解析結果にテンプレート outputTemplate を使用することによって、レポートを生成します。hostName は、Polyspace Access をホストするマシンの完全修飾ホスト名です。

既定では、project-name の結果のレポートは、PathToFolder\Polyspace-Doc フォルダーに project-name_report-name として保存されます。PathToFolder はコマンドの呼び出し元のパスです。

例

polyspace-report-generator -generate-results-list-file -host hostName -run-id runID [polyspace access options] [-set-language-english] は、Polyspace Access 上の実行 runID に対応する解析結果をタブ区切りのテキスト ファイルにエクスポートします。このファイルには、Polyspace Access Web インターフェイスの [結果のリスト] ペインで使用可能な結果情報が含まれています。hostName は、Polyspace Access をホストするマシンの完全修飾ホスト名です。エクスポートされる結果のリストについては、Polyspace Access Web インターフェイスの結果のリスト (Polyspace Access)を参照してください。

既定では、project-name の結果のファイルは、PathToFolder\Polyspace-Doc フォルダーに保存されます。PathToFolder はコマンドの呼び出し元のパスです。

タブ区切りのテキスト ファイルに結果をエクスポートする場合は、polyspace-results-export コマンドをお勧めします。

polyspace-report-generator -generate-variable-access-file -host hostName -run-id runID [polyspace access options] [-set-language-english] は、コードに含まれるグローバル変数のリストを Polyspace Access 上の実行 runID に対応する Code Prover 解析から、タブ区切りのテキスト ファイルにエクスポートします。このファイルには、Polyspace Access Web インターフェイスの [変数アクセス] ペインで使用可能な情報が含まれています。hostName は、Polyspace Access をホストするマシンの完全修飾ホスト名です。エクスポートされる変数のリストについては、エクスポートした変数リストの表示を参照してください。

既定では、project-name の結果に関する変数ファイルは、PathToFolder\Polyspace-Doc フォルダーに保存されます。PathToFolder はコマンドの呼び出し元のパスです。

例

例

すべて折りたたむ

ローカルに保存した解析結果について複数のレポートを生成できます。

レポート テンプレートへのパスを格納する変数 template_path を作成し、使用するテンプレートのコンマ区切りのリストを格納する変数 report_templates を作成します。

SET template_path="C:\Program Files"\Polyspace\R2019a\toolbox\polyspace^
\psrptgen\templates\
SET report_templates=%template_path%\Developer.rpt,^
%template_path%\CodingStandards.rpt

report_templates に指定したテンプレートから、Polyspace プロジェクト myProject の解析結果のレポートを生成します。

 polyspace-report-generator -template %report_templates% ^
-results-dir C:\Polyspace_Workspace\myProject\Module_1\CP_Result ^
-format PDF
このコマンドは 2 つの PDF レポート myProject_Developer.PDF および myProject_CodingStandards.PDF を生成します。レポートは、C:\Polyspace_Workspace\myProject\Module_1\CP_Result\Polyspace-Doc に格納されます。レポートのコンテンツの詳細は、Bug Finder と Code Prover のレポート (-report-template) を参照してください。

HTTPS プロトコルを使用するように Polyspace Access を構成する場合、Polyspace Access によって使用される SSL 証明書を保存するクライアントのキーストアを生成し、そのキーストアを使用するように polyspace-report-generator を構成しなければなりません。クライアント キーストアの生成 (Polyspace Access)を参照してください。この 1 回だけの構成により、Report Generator は HTTPS 経由で Polyspace Access と通信できるようになります。

クライアントのキーストアを使用するように Report Generator を構成するには、polyspace-report-generator -configure-keystore コマンドを使用します。プロンプトに従って、Polyspace Access にログインするために使用する URL、生成したキーストア ファイルへの絶対パス、およびキーストアのパスワードを入力します。

polyspace-report-generator -configure-keystore
Location: US, user name: jsmit, id: 62600@us-jsmith, print mode: false
Enter the Polyspace Access URL using form  http[s]://<host>:<port> :
https://myAccessServer:9443
Enter full path to client keystore file :
C:\R2019b\ssl\client-cert.jks
Enter client keystore password :

The keystore has been configured

以下の場合は、キーストア構成コマンドを再実行しなければなりません。

  • Polyspace Access の URL が変更された (別のポート番号を使用する場合など)。

  • キーストア ファイルへのパスが変更された。

  • キーストアのパスワードが変更された。

メモ

コマンド ラインで Polyspace Access に関する結果のレポートを生成するには、Polyspace Bug Finder Server™ または Polyspace Code Prover™ Server がインストールされている必要があります。

Polyspace Access データベースに保存された Code Prover 解析の結果のレポートを生成して、変数のリストをエクスポートするとします。

Polyspace Access に接続するには、ホスト名と暗号化されたパスワードを含むログイン資格情報を指定します。パスワードを暗号化するには、polyspace-access コマンドを使用し、プロンプトにユーザー名とパスワードを入力します。 

polyspace-access -encrypt-password 
login: jsmith
password:
CRYPTED_PASSWORD LAMMMEACDMKEFELKMNDCONEAPECEEKPL
Command Completed

ログインと暗号化パスワードを資格情報ファイルに保存し、そのファイルに対する読み取り権限と書き込み権限を制限します。テキスト エディターを開いて、エディターで次の 2 行をコピーしてから、ファイルを myCredentials.txt などとして保存します。

 -login jsmith
 -encrypted-password LAMMMEACDMKEFELKMNDCONEAPECEEKPL
ファイルの権限を制限するには、ファイルを右クリックして、Linux® では [アクセス許可] タブを、Windows® では [セキュリティ] タブを選択します。

Polyspace Access でプロジェクト結果を指定するには、プロジェクトの実行 ID を指定します。最新の実行 ID を使用してプロジェクトのリストを取得するには、polyspace-access -list-project (Polyspace Access)コマンドを使用します。 

polyspace-access -host myAccessServer -credentials-file myCredentials.txt -list-project
Connecting to https://myAccessServer:9443
Connecting as jsmith
Get project list with the last Run Id
Restricted/Code_Prover_Example (Code Prover) RUN_ID 14
public/Bug_Finder_Example (Bug Finder) RUN_ID 24
public/CP/Code_Prover_Example (Polyspace Code Prover) RUN_ID 16
public/Polyspace (Code Prover) RUN_ID 28
Command Completed

ホスト名が myAccessServer の Polyspace Access インスタンスから、実行 ID が 16 の結果の Developer レポートを生成します。Polyspace Access のこのインスタンスの URL は https://myAccessServer:9443 です。

SET template_path=^
"C:\Program Files\Polyspace\R2019a\toolbox\polyspace\psrptgen\templates"

polyspace-report-generator -credentials-file myCredentials.txt ^
-template %template_path%\Developer.rpt ^
-host myAccessServer ^
-run-id 16 ^
-output-name myReport
このコマンドは、指定されたテンプレートを使用して myReport.docx レポートを作成します。このレポートは、コマンドの呼び出し元のパスのフォルダー Polyspace-Doc に保存されます。

指定された解析結果に対してコード内のグローバル変数のリストを含むタブ区切りのテキスト ファイルを生成します。

polyspace-report-generator -credentials-file myCredentials.txt^
-generate-variable-access-file ^
-host myAccessServer ^
-run-id 16
グローバル変数のリスト Variable_View.txt は、生成されたレポートと同じフォルダーに保存されます。エクスポートされる変数のリストについては、エクスポートした変数リストの表示を参照してください。

入力引数

すべて折りたたむ

解析レポートを生成するために使用するレポート テンプレートへのパス。複数のレポートを生成するには、レポート テンプレート パスのコンマ区切りのリストを指定します (コンマの後にはスペースを配置しません)。テンプレートは .rpt ファイルとして polyspaceroot\toolbox\polyspace\psrptgen\templates\ にあります。ここで、polyspaceroot は Polyspace インストール フォルダーです。polyspace-report-generator コマンドは、解析オプション -report-template と同じテンプレートを受け入れます。使用可能なテンプレートについては、Bug Finder と Code Prover のレポート (-report-template) を参照してください。

このオプションは -generate-variable-access-file および -generate-results-list-file とは互換性がありません。

例: C:\Program Files\Polyspace\R2019a\toolbox\polyspace\psrptgen\templates\Developer.rpt

例: TEMPLATE_PATH\BugFinder.rpt,TEMPLATE_PATH\CodingStandards.rpt

Polyspace 解析結果 (.psbf ファイルまたは .pscp ファイル) を含むフォルダーへのパス。複数の検証のレポートを生成するには、フォルダー パスのコンマ区切りのリストを指定します (コンマの後にはスペースを配置しません)。フォルダー パスを指定しない場合、コマンドでは現在のフォルダーに含まれている解析結果のレポートが生成されます。

例: C:\Polyspace_Workspace\My_project\Module_1\results

例: C:\Polyspace_Workspace\My_project\Module_2\results,C:\Polyspace_Workspace\My_project\Module_3\other_results

Polyspace Access Gateway API サービスをホストするマシンの完全修飾ホスト名。Polyspace Access データベースで結果のレポートを生成するには、ホスト名を指定しなければなりません。

例: my-company-server

レポートを生成するプロジェクト調査結果の実行 ID。Polyspace は Polyspace Access にアップロードする各解析実行に一意の実行 ID を割り当てます。

Polyspace Access Web インターフェイスでプロジェクトの実行 ID を表示できます。実行 ID を取得するには、コマンド polyspace-access -list-project (Polyspace Access) を使用します。

オプション説明
-format HTML | PDF | WORD

生成されるレポートのファイル形式。既定では、このコマンドは Microsoft® Word ドキュメントを生成します。

複数の形式でレポートを生成するには、形式のコンマ区切りのリストを指定します (コンマの後にはスペースを配置しません)。たとえば、-format PDF,HTML のような場合です。

このオプションは -generate-variable-access-file および -generate-results-list-file とは互換性がありません。

-output-name outputName

生成されるレポート名、または複数のレポートを生成する場合はフォルダー名。

レポートまたはエクスポートされたファイルは、コマンドが呼び出されたパスに保存されます。別のフォルダーに保存するには、-output-name C:\PathTo\OtherFolder など、フォルダーへのフル パスを指定します。

-results-dir FOLDER_1,...,FOLDER_N

ローカルに保存された結果フォルダーへのパス。複数の解析のレポートを生成するには、フォルダー パスのコンマ区切りのリストを指定します。(コンマの後にはスペースを配置しません)。以下に例を示します。

-results-dir folderPath1,folderPath2
このオプションは、PolyspaceAccess の結果と互換性がありません。

-key-mode file-scope | function-scope

エクスポートした結果の [キー] 列のエントリの計算方法を指定します。

  • file-scope (既定) — キーは、結果名、結果のタイプ、ファイルの場所から計算されます。

  • function-scope — キーは、結果名、結果のタイプ、および関数の場所 (結果が関数内部にある場合) またはファイルの場所 (それ以外の場合) から計算されます。結果が関数内にある場合、このモードで生成されるキーには接頭辞 FN が付きます。

エクスポートしたキーの関数スコープを有効にするも参照してください。

このオプションは、オプション -generate-results-list-file との組み合わせでのみ適用されます。

-set-language-english英語でレポートを生成。表示言語が別の言語に設定されている場合、このオプションを使用します。
-helpヘルプ情報の表示。
オプション説明

-host HOST_NAME

HOST_NAME は、Polyspace Access インターフェイスの URL (https://HOST_NAME:port/metrics/index.html など) で指定されたホスト名に対応します。使用するホスト名がわからない場合は、Polyspace Access 管理者にお問い合わせください。既定のホスト名は localhost です。

Polyspace Access データベースに保存された結果のレポートを生成する場合、このオプションは必須です。

-run-id RUN_ID

プロジェクトの実行 ID。Polyspace は、アップロードする各解析実行に一意の実行 ID を割り当てます。プロジェクトの最後の実行 ID を取得するには、polyspace-access -list-project (Polyspace Access) コマンドを使用します。

Polyspace Access データベースに保存された結果のレポートを生成する場合、このオプションは必須です。

-all-units

このオプションを指定して、ユニットごとの解析からすべてのユニットのレポートを生成します。

このオプションを使用するときは、-run-id で 1 つのユニットのみの実行 ID を指定します。このコマンドには、レポート内の解析の他のユニットが含まれます。

-port portNumber

portNumber は、Polyspace Access インターフェイスの URL (https://hostname:portNumber/metrics/index.html など) で指定されたポート番号に対応します。使用するポート番号がわからない場合は、Polyspace Access 管理者にお問い合わせください。既定のポート番号は 9443 です。

-protocol http | https

Polyspace Access に接続するために使用する HTTP プロトコル。既定値は https です。
-credentials-file file_path

ログイン資格情報を保存するテキスト ファイルへのフル パス。このオプションは、スクリプトで Polyspace Access 資格情報が必要なコマンドを使用するが、資格情報をスクリプトに保存しない場合などに使用します。スクリプトの実行中に、現在実行中のプロセスを検査しているユーザーがご使用の資格情報を確認することはできません。

ファイルには資格情報の 1 つのセットしか保存できません。次のような、別々の行の -login エントリと -encrypted-password エントリか、 

-login jsmith
-encrypted-password LAMMMEACDMKEFELKMNDCONEAPECEEKPL
-api-key エントリとして保存できます。
-api-key keyValue123
資格情報を保存するファイルに対する読み取り権限と書き込み権限が制限されていることを確認してください。たとえば、Linux でファイル login.txt に対する読み取り権限と書き込み権限を制限するには、次のコマンドを使用します。
chmod go-rwx login.txt

-api-key keyValue

ログインと暗号化パスワードを指定する代わりにログイン資格情報として使用する API キー。API キーをユーザーに割り当てるには、User Manager の構成 (Polyspace Access)を参照するか、Polyspace Access 管理者にお問い合わせください。

API キーは、Jenkins® などの CI ツールを使用した自動化スクリプトの一部として Polyspace Access ログイン資格情報を必要とするコマンドを使用する場合などに使用します。ユーザーが自分のパスワードをアップデートした場合は、スクリプトでそのユーザーに関連付けられた API キーをアップデートする必要はありません。

API キーをテキスト ファイルに保存し、そのファイルを -credentials-file を使用してコマンドに渡すことをお勧めします。オプション -credentials-file の説明を参照してください。

-login username

-encrypted-password ENCRYPTED_PASSWD

Polyspace Access にログインするために使用する資格情報。-encrypted-password の引数はpolyspace-access -encrypt-password (Polyspace Access)コマンドの出力です。

ヒント

  • Polyspace as You Code で生成された解析結果を指定したコマンド polyspace-report-generator を使用することはできません。代わりにコマンド polyspace-results-export を使用します。polyspace-results-exportを参照してください。

  • 非常に多数の欠陥やコーディング ルール違反が含まれている結果セットでは、レポートの生成に時間がかかることがあります。場合によっては、メモリ不足に起因する問題が発生することがあります。これが発生した場合は、Java® ヒープ サイズを増やすか、またはオプション -wysiwyg を使用して、すべての結果を含む 1 つのファイルではなく、フィルター済みの複数のレポートを生成することができます。詳細は、Polyspace レポート生成時のメモリ不足エラーの修正を参照してください。

代替機能

既存の解析結果からレポートを生成する代わりに、解析と一緒にレポートを生成したい場合があります。その場合は、解析オプション -report-template および -report-output-format を使用します。レポートを参照してください。

解析と一緒に生成されるレポートには、以前の解析からインポートされたレビュー情報 (このような情報がインポートされる場合) のみが記載されます。新しいレビュー情報を結果に追加する場合は、polyspace-report-generator コマンドを使用してレポートを再生成する必要があります。

バージョン履歴

R2013b で導入

参考

トピック