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

polyspace-results-export

(システム コマンド) CSV や JSON などの外部形式への Polyspace 結果のエクスポート

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

構文

polyspace-results-export -format exportFormat -results-dir resultsFolder [export options]
polyspace-results-export -format exportFormat -host hostName -run-id runID [export options] [polyspace access options]

説明

polyspace-results-export システム コマンドは、CSV や JSON などの外部形式に Polyspace® 静的解析結果をエクスポートします。

メモ

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

polyspace-results-export -format exportFormat -results-dir resultsFolder [export options] は、resultsFolder にローカルに保存された Polyspace 解析結果を外部形式 exportFormat にエクスポートします。

例

polyspace-results-export -format exportFormat -host hostName -run-id runID [export options] [polyspace access options] は、Polyspace Access™ に保存された Polyspace 解析結果を外部形式 exportFormat にエクスポートします。hostName を使用することによって Polyspace Access インスタンスを指定し、runID を使用することによって Polyspace Access 上のプロジェクトを指定します。

Polyspace Access から結果をエクスポートすると、エクスポートされた結果では、各調査結果に Polyspace Access URL が含められます。URL をクリックすると、調査結果に関連付けられたコード、結果の詳細、その他の情報が Polyspace Access インターフェイスに表示されます。

例

例

すべて折りたたむ

Polyspace ユーザー インターフェイス内のプロジェクト myProject からの結果を JSON 形式にエクスポートします。

プロジェクトは C:\Polyspace_Workspace に保存されているものとします。プロジェクト内の特定のモジュールから結果をエクスポートするには、モジュールからの結果を直接格納するフォルダーへのパスを指定します。

polyspace-results-export -format json-sarif -results-dir C:\Polyspace_Workspace\myProject\Module_1\BF_Result -output-name C:\Polyspace_Workspace\reports\myProject\myProject.json

メモ

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

Polyspace Access 上のプロジェクトの結果を JSON 形式にエクスポートするものとします。

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 example-access-server -credentials-file myCredentials.txt -list-project
Connecting to https://example-access-server: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

Polyspace Access で HTTPS プロトコルが使用されている場合は、polyspace-report-generator バイナリを使用して、HTTPS 経由の Polyspace Access との通信を有効にするように polyspace-results-export を構成します。クライアントのキーストアを使用するように Report Generator を構成 を参照してください。

実行 ID が 16 のプロジェクトからの結果を JSON 形式にエクスポートします。

polyspace-results-export -credentials-file myCredentials.txt -format json-sarif -host myAccessServer -run-id 16

入力引数

すべて折りたたむ

Polyspace 結果がエクスポートされる形式: タブ区切り値 (TSV) 出力用の csv または JSON 出力用の json-sarif。polyspace-bug-finder-access コマンドを使用して単一ファイルの解析 (Polyspace as You Code) を実行する場合、console 形式を使用して結果をコンソールにエクスポートできます。

各結果は、結果名やファミリなどの情報で構成されます。TSV 形式でも JSON 形式でも、ほぼ同じコンテンツがエクスポートされますが、エクスポートされるコンテンツは別々の名前で同じタイプの情報を参照する可能性があります。

  • TSV 形式では、各結果が ID、Family、Group、Color、Check などの列内のタブ区切りの情報で構成されます。

    結果データをパッケージ化して潜在的にフィルターするには、csv 形式を使用します。たとえば、TSV ファイルを Microsoft® Excel® にインポートして、結果に対して Excel フィルターを使用できます。

  • JSON 形式では、各結果が JSON オブジェクト プロパティとほぼ同じ情報で構成されます。結果に関して表示されるプロパティには、CSV 形式で使用されている名前とは別の名前が使用されます。たとえば、結果の完全なルール チェッカー名を取得するには、結果の ruleId プロパティとルールの id および name プロパティを組み合わせて使用します。違いがあるのは、JSON 形式が OASIS Static Analysis Results Interchange Format (SARIF) で指定された標準記法に従っているためです。

    JSON 形式には、チェッカーの短い名前や結果に付随する完全なメッセージなど、いくつかの追加情報が含められます。この短い名前やメッセージを使用する場合は、JSON 形式を使用します。結果をより標準化されたレポートにする場合も、この形式を使用できます。たとえば、複数の静的解析ツールを使用し、その結果を 1 つの解析アルゴリズムを使用して 1 つのインターフェイスでレポートにする場合、結果すべてを標準 SARIF JSON 形式にエクスポートできます。

コンソール出力は、コンパイラ エラーおよび警告と同様の形式に書式設定済みであり、表示される情報は他の形式より少なくなります。console 形式は Polyspace as You Code の結果に対してのみ使用できます。特に、Polyspace Access Web インターフェイスで統合結果を Polyspace as You Code の解析結果のベースラインとして使用する場合は、このベースライン設定から最大限のメリットを引き出すために、JSON 形式または CSV 形式を使用してください。コマンド ラインで Polyspace as You Code の結果をベースラインとして設定する (Polyspace Access)を参照してください。

Polyspace 解析結果 (.psbf ファイルまたは .pscp ファイル) を含むフォルダーへのパス。フォルダー パスを指定しない場合、コマンドは現在のフォルダーに含まれている解析結果を検索します。

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

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

例: my-company-server

エクスポートするプロジェクト結果の実行 ID。Polyspace Access にアップロードする各解析実行に一意の実行 ID が割り当てられます。

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

オプション説明
-output-name outputName

エクスポートするファイルの名前。既定の名前は、results_list.txt (TSV) または results_list.json (JSON) です。

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

このオプションは、コンソール出力形式 (-format console) と互換性がありません。

-set-language-englishこのオプションは、表示言語が英語以外の言語に設定されているが、英語のエクスポートされた結果が必要な場合に使用します。
-key-mode file-scope | function-scope

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

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

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

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

このコマンドと一緒に使用可能なオプションを表示するには、polyspace-results-export -h と入力します。

オプション説明

-port portNumber

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

-protocol http | https

PolyspaceAccess に接続するための 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) コマンドの出力です。

バージョン履歴

R2020b で導入

すべて展開する

参考