Main Content

polyspace-access

(DOS/UNIX) コマンド ラインでの PolyspaceAccess の結果とユーザーの管理

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

構文

polyspace-access -create-project folderPath -host hostname [login options]
polyspace-access -move-project projectPath -to-project-path destinationPath -host hostname [login options]
polyspace-access -delete-project projectPath -host hostname [login options]
polyspace-access -set-deletion-policy projectPath -max-days MAX_DAYS -max-runs MAX_RUNS -host hostname [login options]
polyspace-access -unset-deletion-policy projectPath -host hostname [login options]
polyspace-access -get-deletion-policy projectPath -host hostname [login options]
polyspace-access -list-project [projectPath] -host hostname [login options]
polyspace-access -list-runs projectPath -host hostname [login options]
polyspace-access -set-project-information projectPath -banner bannerText -host hostname [login options]
polyspace-access -unset-project-information projectPath -host hostname [login options]
polyspace-access -upload pathToFileOrFolderOrZipFile [upload options] -host hostname [login options]
polyspace-access -export findingsToExport -output filePath [export options] -host hostname [login options]
polyspace-access -download findingsToDownload -output-folder-path outputFolderPath -host hostname [login options]
polyspace-access -review fileOrFindingID -project-path projectToReview review options -host hostname [login options]
polyspace-access -import-reviews sourceProjectPath -project-path targetProjectPath [-import-strategy never-overwrite-target | always-overwrite-target] -host hostname [login options]
polyspace-access -set-sqo projectPathWithSQO -level sqoLevel [-name sqoName] -host hostname [login options]
polyspace-access -get-sqo projectPathWithSQO -host hostname [login options]
polyspace-access -list-sqo -host hostname [login options]
polyspace-access -add-label label -run-id runID -host hostname [login options]
polyspace-access -remove-label label -run-id runID -host hostname [login options]
polyspace-access -set-unassigned-findings findingsToAssign -owner userToAssign -source-contains pattern [set unassigned findings options] -host hostname [login options]
polyspace-access -set-role role -user username -group groupname -project-path folderPathOrProjectPath -host hostname [login options]
polyspace-access -unset-role -user username -group groupname -project-path folderPathOrProjectPath -host hostname [login options]
polyspace-access -generate-migration-commands metrics_dir -output-folder-path dir [generate migration commands options]
polyspace-access -migrate -option-file-path dir [-dryrun] -host hostname [login options]
polyspace-access -ver -host hostname [login options]
polyspace-access -encrypt-password

説明

プロジェクトの管理および表示

例

メモ

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

polyspace-access -create-project folderPath -host hostname [login options] は、Polyspace Access Web インターフェイスでプロジェクト フォルダーを作成します。このフォルダーは、プロジェクト階層の最上位に配置することも、既存のプロジェクト フォルダーのサブフォルダーにすることもできます。

polyspace-access -move-project projectPath -to-project-path destinationPath -host hostname [login options] は、プロジェクトまたはフォルダーを移動するか、またはその名前を変更します。sourcePath および destinationPath は、それぞれソース、宛先のプロジェクトまたはフォルダーの絶対パスでなければなりません。宛先として指定したパスが既に存在する場合、プロジェクトまたはフォルダーを移動したり、その名前を変更したりすることはできません。

polyspace-access -delete-project projectPath -host hostname [login options] は、指定されたプロジェクトまたはフォルダーを Polyspace Access™ の [プロジェクト エクスプローラー] から削除します。プロジェクトまたはフォルダーは、[管理者] の役割をもつユーザーのみが表示できる [ProjectsWaitingForDeletion] フォルダーに移動されます。プロジェクトが既に [ProjectsWaitingForDeletion] フォルダーに含まれている場合、このコマンドによりプロジェクトがデータベースから完全に削除されます。プロジェクト実行またはプロジェクト全体の削除も参照してください。

polyspace-access -set-deletion-policy projectPath -max-days MAX_DAYS -max-runs MAX_RUNS -host hostname [login options] は、指定されたプロジェクトのプロジェクト実行削除ポリシーを設定または変更します。このポリシーを設定すると、それ以降、実行がプロジェクトにアップロードされるたびに、Polyspace によってポリシーが適用され、次のしきい値に基づいてデータベースからプロジェクト実行が削除されます。

  • プロジェクト実行の経過日数 (MAX_DAYS) — プロジェクトに実行がアップロードされた時点からの経過日数が MAX_DAYS を超えると、その実行が Polyspace により削除されます。

  • プロジェクト内の実行数 (MAX_RUNS) — プロジェクトに MAX_RUNS 個の実行が既に含まれている場合に、新しい実行をアップロードすると、そのプロジェクトの最も古い実行が Polyspace により削除されます。

ポリシーを設定するときには、いずれかまたは両方のしきい値を指定できます。両方のしきい値を指定すると、実行がいずれかのしきい値を満たした場合に Polyspace はプロジェクト実行を削除します。プロジェクト実行またはプロジェクト全体の削除も参照してください。

polyspace-access -unset-deletion-policy projectPath -host hostname [login options] は、指定されたプロジェクトのプロジェクト実行削除ポリシーを設定解除します。プロジェクトに削除ポリシーが設定されていない場合、そのプロジェクトにアップロードされたすべての実行は、手動で削除されるまでデータベース内に残ります。プロジェクト実行またはプロジェクト全体の削除も参照してください。

polyspace-access -get-deletion-policy projectPath -host hostname [login options] は、指定されたプロジェクトの削除ポリシーを表示します。プロジェクト実行またはプロジェクト全体の削除も参照してください。

例

polyspace-access -list-project [projectPath] -host hostname [login options] をオプションの引数 projectPath なしで使用すると、Polyspace Access データベース内のすべてのプロジェクトのパスと、それらのプロジェクトの最後の実行 ID がリストされます。引数 projectPath でプロジェクトの絶対パスを指定すると、このコマンドにより、そのプロジェクトのみの最後の実行 ID がリストされます。

polyspace-access -list-runs projectPath -host hostname [login options] は、指定されたプロジェクトにアップロードされたすべての実行を表示します。各実行について、その実行 ID と、その実行に関連付けられているすべてのラベルが表示されます。

polyspace-access -set-project-information projectPath -banner bannerText -host hostname [login options] は、bannerText で指定したテキストを Polyspace Access ユーザー インターフェイスのバナー内に表示します。バナーは、projectPath で指定したフォルダーまたはプロジェクトを選択すると表示されます。Add Project Banners to Results in Polyspace Accessを参照してください。

polyspace-access -unset-project-information projectPath -host hostname [login options] は、指定されたプロジェクトから既存のプロジェクト バナーを削除します。

結果のアップロード、ダウンロード、またはエクスポート

例

polyspace-access -upload pathToFileOrFolderOrZipFile [upload options] -host hostname [login options] は、Polyspace Bug Finder、Code Prover、または Polyspace Test™ の結果を、ユーザーが指定したファイル (推奨)、フォルダー、または圧縮ファイルから Polyspace Access データベースにアップロードします。このコマンドを使用して Bug Finder または Code Prover の結果をアップロードできるのは、その結果が Polyspace Bug Finder™ Server™ または Polyspace Code Prover™ Server で生成された場合のみです。結果を既存の Polyspace Access プロジェクトにアップロードできるのは、その結果が同じタイプの解析から生成された場合のみです。たとえば、Bug Finder 解析の結果を Code Prover の結果を含むプロジェクトにアップロードすることはできません。Polyspace デスクトップ インターフェイスで生成された結果をアップロードするには、Polyspace デスクトップ クライアントからの結果のアップロード (Polyspace Bug Finder)を参照してください。プロジェクトの親フォルダーを指定する場合、またはプロジェクトの名前を変更する場合は、upload optionsを使用します。

例

polyspace-access -export findingsToExport -output filePath [export options] -host hostname [login options] は、Polyspace Access データベースから、filePath で場所が指定されたテキスト ファイルにプロジェクト結果をエクスポートします。結果をエクスポートするとき、または 2 つのプロジェクトの比較をエクスポートするときに、フィルターを指定できます。プロジェクトを指定するには、Polyspace Access 内の絶対パスまたは実行 ID のいずれかを使用します。このコマンドを使用して、カスタム レポートで使用する他のツールに調査結果をエクスポートできます。プロジェクトのパスとその最後の実行 ID を取得するには、-list-project を指定した polyspace-access コマンドを使用します。

polyspace-access -download findingsToDownload -output-folder-path outputFolderPath -host hostname [login options] は、Polyspace Access プロジェクトの調査結果 findingsToDownload を、outputFolderPath で場所が指定されたフォルダーにダウンロードします。プロジェクトを指定するには、Polyspace Access 内の絶対パスまたは実行 ID のいずれかを使用します。

ダウンロードした結果を Polyspace デスクトップ インターフェイスや Polyspace as You Code IDE 拡張機能で開くことはできません。プロジェクト間でレビュー情報をマージする場合や、以降の Polyspace 解析のベースラインを作成する場合は、このコマンドをワークフローの一環として使用します。

プロジェクトのパスとその最後の実行 ID を取得するには、-list-project を指定した polyspace-access コマンドを使用します。

調査結果のレビュー情報の管理

例

polyspace-access -review fileOrFindingID -project-path projectToReview review options -host hostname [login options] は、プロジェクト projectToReview 内の調査結果のレビュー フィールド内の情報を編集します。単一の調査結果をレビューするには、その調査結果 ID を -review コマンドに渡します。バッチ レビューを実行するには、複数の調査結果の調査結果 ID が保存されたファイルのパスを -review コマンドに渡します。このファイルでは、1 行に 1 つの調査結果 ID が記録されています。review options で少なくとも 1 つのレビュー フィールドを指定する必要があります。たとえば、ステータス、重大度、コメント、オーナー、バグ トラッキング ツール (BTT) のチケット番号などです。

レビュー フィールドがコード注釈を使用して設定されている場合、そのレビュー フィールドを調査結果に割り当てることはできません。

polyspace-access -import-reviews sourceProjectPath -project-path targetProjectPath [-import-strategy never-overwrite-target | always-overwrite-target] -host hostname [login options] は、レビュー情報をソース プロジェクト sourceProjectPath からターゲット プロジェクト targetProjectPath にインポートします。このオプションは、ソース プロジェクトの調査結果を既にレビューしていて、それらの調査結果を含むコードをターゲット プロジェクトで再利用する場合に使用します。

必要に応じて、次のインポート方法のいずれかを指定できます。

  • never-overwrite-target (既定) — ターゲット プロジェクトのレビュー フィールドに既に内容が含まれている場合は、そのレビュー フィールドをソース プロジェクトの内容で上書きすることはしません。

  • always-overwrite-target — ターゲット プロジェクトのレビュー フィールドに既に内容が含まれている場合でも、常に、そのレビュー フィールドの内容をソース プロジェクトの内容で上書きします。

既存の Polyspace Access プロジェクトからのレビュー情報のインポートも参照してください。

ソフトウェア品質目標 (SQO) の管理

polyspace-access -set-sqo projectPathWithSQO -level sqoLevel [-name sqoName] -host hostname [login options] は、SQO 定義が現在適用されている、指定されたプロジェクトに、SQO レベルを割り当てます。必要に応じて、オプション -name で SQO 定義の名前を指定して、プロジェクトに別の SQO 定義を適用することもできます。Polyspace Access でのソフトウェア品質目標 (SQO) の管理も参照してください。このコマンドは、個々のプロジェクトに対してのみ実行できます。プロジェクト フォルダーに対しては実行できません。

polyspace-access -get-sqo projectPathWithSQO -host hostname [login options] は、指定されたプロジェクトに現在割り当てられている SQO 定義と SQO レベルを表示します。Polyspace Access でのソフトウェア品質目標 (SQO) の管理も参照してください。このコマンドは、個々のプロジェクトに対してのみ実行できます。プロジェクト フォルダーに対しては実行できません。

polyspace-access -list-sqo -host hostname [login options] は、使用可能なすべての SQO の名前をリストします。Polyspace Access でのソフトウェア品質目標 (SQO) の管理も参照してください。

プロジェクト実行ラベルおよび未割り当ての調査結果の管理

polyspace-access -add-label label -run-id runID -host hostname [login options] は、runID で指定されたプロジェクトにラベルを追加します。ラベルを使用すると、対象とするプロジェクト実行を識別しやすくしたり、実行に特定のブランチまたは継続的インテグレーション ビルド ジョブを関連付けることができます。コマンド ラインでのラベルの管理も参照してください。

polyspace-access -remove-label label -run-id runID -host hostname [login options] は、runID で指定された実行 ID をもつプロジェクト実行から、指定されたラベルを削除します。指定されたラベルがプロジェクト実行ラベルのいずれとも一致しない場合、このコマンドは無視されます。コマンド ラインでのラベルの管理も参照してください。

例

polyspace-access -set-unassigned-findings findingsToAssign -owner userToAssign -source-contains pattern [set unassigned findings options] -host hostname [login options] は、Polyspace Access データベース内のプロジェクトでオーナーが未割り当ての結果に、オーナーを割り当てます。プロジェクトを指定するには、Polyspace Access 内の絶対パスまたは実行 ID のいずれかを使用します。さまざまなソース ファイルまたはソース ファイルのグループに含まれる調査結果を、さまざまなオーナーに割り当てるには、set unassigned findings options を使用します。プロジェクトのパスとその最後の実行 ID を取得するには、-list-project を指定した polyspace-access コマンドを使用します。

ユーザーのアクセス許可の管理

例

polyspace-access -set-role role -user username -group groupname -project-path folderPathOrProjectPath -host hostname [login options] は、役割 role を、指定されたプロジェクトまたはプロジェクト フォルダーの username あるいは groupname に割り当てます。プロジェクト フォルダーに設定されたユーザーまたはグループの役割は、そのフォルダー内のすべてのプロジェクト調査結果に適用されます。あるグループのすべてのユーザーは、その親グループに割り当てられている役割を継承します。プロジェクトを指定するには、Polyspace Access 内の絶対パスまたは最後の実行 ID のいずれかを使用します。プロジェクトのパスとその最後の実行 ID を取得するには、-list-project コマンドで polyspace-access コマンドを使用します。

polyspace-access -unset-role -user username -group groupname -project-path folderPathOrProjectPath -host hostname [login options] は、指定されたプロジェクトまたはプロジェクト フォルダーの username あるいは groupname に以前に割り当てられたすべての役割を削除します。グループの役割を割り当て解除すると、そのグループ内のすべてのユーザーの役割も割り当て解除されます。プロジェクトを指定するには、Polyspace Access 内の絶対パスまたは最後の実行 ID のいずれかを使用します。プロジェクトのパスとその最後の実行 ID を取得するには、-list-project を指定した polyspace-access コマンドを使用します。

Polyspace Web Metrics からの結果の移行

例

polyspace-access -generate-migration-commands metrics_dir -output-folder-path dir [generate migration commands options] は、プロジェクトを Polyspace Metrics 内のパス metrics_dir から Polyspace Access に移行するためのスクリプトを生成します。このコマンドはスクリプトを dir 内に保存します。移行するプロジェクト調査結果を指定するには、generate migration commands options を使用します。

例

polyspace-access -migrate -option-file-path dir [-dryrun] -host hostname [login options] は、-generate-migration-commands コマンドで生成されたスクリプトを使用して、プロジェクトを Polyspace Metrics から Polyspace Access に移行します。プロジェクトを実際に移行せずに、移行されるプロジェクトを確認するには、-dryrun オプションを使用します。

その他のコマンド

polyspace-access -ver -host hostname [login options] は、hostname で指定された Polyspace Access インスタンスのバージョンとライセンス番号、および polyspace-access バイナリのバージョンを表示します。このコマンドは、ログイン資格情報を持っている Polyspace Access インスタンスに対してのみ実行できます。

例

polyspace-access -encrypt-password は、Polyspace Access にログインするために使用するパスワードを暗号化します。Polyspace Access を操作するための自動化スクリプトを作成する際は、このコマンドの出力を -encrypted-password オプションの引数として使用します。

ユーザー名またはパスワードに ASCII 以外の文字が含まれている場合、UTF-8 でエンコードされるターミナルから -encrypt-password コマンドを実行したかどうかをチェックします。

例

すべて折りたたむ

Polyspace Access を使用するにはログイン資格情報が必要です。資格情報は、コマンドを実行する際にコマンド ラインで入力することも、暗号化パスワードを生成して自動化スクリプトで他のログイン オプションと共に使用することもできます。

パスワードを暗号化するには、-encrypt-password コマンドを使用し、Polyspace Access 資格情報を入力します。このコマンドは、入力されたユーザー名とパスワードを使用して暗号化パスワードを生成します。

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

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

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

自動化スクリプトを使用して解析の調査結果を管理する場合は、接続構成とログイン資格情報を格納する変数を作成します。コマンドを実行する際に資格情報を入力しなくてもよいように、この変数をスクリプト内またはコマンド ラインで使用します。

set LOGIN=-host myAccessServer -port 1234 -credentials-file myCredentials.txt
 
polyspace-access %LOGIN% -create-project myProject

たとえば、Polyspace Bug Finder Server または Polyspace Code Prover Server で生成された一連の調査結果を Polyspace Access にアップロードし、これらの調査結果の表示を一部のチーム メンバーだけに許可するとします。

プロジェクト階層の最上位にプロジェクト フォルダー restrictedProject を作成します。

polyspace-access -host myAccessServer -port 1234 ^
-create-project restrictedProject

ユーザー jsmith および rroll とグループ Authorized Users の役割を設定し、これらのユーザーとグループに対し、コントリビューターとしてプロジェクト フォルダーにアクセスすることを許可します。ユーザー名やグループ名にスペースが含まれている場合は、名前を二重引用符で囲みます。

polyspace-access -host myAccessServer ^
-port 1234 -set-role contributor ^
-user jsmith -user rroll -group "Authorized Users" -project-path restrictedProject
プロジェクト フォルダーの作成者と、コントリビューターの役割が設定されたユーザーおよびグループ以外のユーザーは、restrictedProject にアップロードされた調査結果を表示することも、これらの調査結果にアクセスすることもできません。

Bug Finder プロジェクト調査結果を、プロジェクト "My Example Project" から親フォルダー Restricted にアップロードします。

polyspace-access -host myAccessServer -port 1234 ^
-upload "C:\Polyspace_Workspace\My Example Project\Module1\ps_results.psbf" ^
-parent-project Restricted
アップロードされた調査結果は restrictedProject/My_Example_Project (Bug Finder) に保存されます。-upload コマンドは、ACCESS URL を含むアップロードに関する情報を出力します。この URL を使用して、アップロードされた結果を PolyspaceAccess インターフェイスで表示できます。

Manage Project Permissionsも参照してください。

コンポーネントベースの開発手法に従っている場合、コンポーネントごとの解析の調査結果を、それぞれに該当するオーナーに割り当てることができます。

Polyspace Access データベースに現在保存されているプロジェクトのリストを取得します。このコマンドは、プロジェクト調査結果のパスとそれぞれの最後の実行 ID のリストを出力します。

polyspace-access -host myAccessServer -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
multimodule/vxWorks_demo (Code Prover) RUN_ID 16
public/Bug_Finder_Example (Bug Finder) RUN_ID 24
public/CP/Code_Prover_Example (Polyspace Code Prover) RUN_ID 8
public/Polyspace (Code Prover) RUN_ID 28
Command Completed

検出されたレッドとオレンジのランタイム エラーすべてを、プロジェクト vxWorks_demo の Component_A に含まれるすべてのファイルのオーナーに割り当てます。Component_B のオーナーに対しても、同じ割り当てを行います。vxWorks_demo プロジェクトを指定するには、その実行 ID を指定します。

polyspace-access -host myAccessServer ^
-set-unassigned-findings 16 ^
-owner A_owner -source-contains Component_A ^
-owner B_owner -source-contains Component_B ^
-rte Red -rte Orange
-source-contains Component_A は、ファイル パスに Component_A が含まれるすべてのファイルを照合します。

-source-contains Component_B は、ファイル パスに Component_B が含まれるすべてのファイルを照合しますが、ファイル パスに Component_A が含まれるファイルは除外します。

調査結果を割り当てた後、調査結果をエクスポートし、オーナーごとにそのオーナーに割り当てられている調査結果を含む .csv ファイルを生成します。

polyspace-access -host myAccessServer ^
-export 16 ^
-output C:\Polyspace_Workspace\myResults.csv ^
-output-per-owner
このコマンドは、実行 ID が 16 のプロジェクトからの、すべての調査結果を含む、myResults.csv ファイルを生成します。また、このコマンドは同じファイル パスに myResutls.csv.A_owner.csv ファイルと myResults.csv.B_owner.csv ファイルも生成します。

解析結果を Polyspace Access にアップロードした後に、それらの解析結果のレビュー情報を一括で編集する場合は、次のようにします。

  1. レビューする調査結果のリストをエクスポートします。

  2. ステップ 1 でファイルに保存された調査結果 ID を使用して調査結果ごとのレビュー情報を編集します。

レビューする調査結果のリストをエクスポートするには、polyspace-access -export コマンドを使用します。たとえば、プロジェクト パスが public/example/Bug_Finder_Example (Bug Finder) でプロジェクト ID が 129 のプロジェクトから、重大度が [高] または [中] の新しい欠陥のみをエクスポートする場合は、次のコマンドを実行します。

polyspace-access $login -export 129 -output newMedHighDefects.txt\
 -resolution new -defects High -defects Medium

このコマンドは、タブ区切り値 (TSV) ファイル newMedHighDefects.txt を出力します。このファイルには、指定したフィルターと一致する調査結果のリストが含まれ、ファイルの最初の列は調査結果 ID を示します。

ここで、$login は、ログイン資格情報やその他の接続情報を格納する変数です。この変数を構成するには、パスワードの暗号化とログイン オプションの変数への格納を参照してください。

前の手順で生成したファイルから別のテキスト ファイルに調査結果 ID 列を抽出します。たとえば、awk コマンド (BASH コマンド) または for ループ (DOS コマンド) を使用して、列ヘッダーをスキップしてから、調査結果 ID をファイル findingIDs.txt に保存します。

#BASH COMMAND
awk ' NR>1 {print$1} ' newMedHighDefects.txt >> findingIDs.txt

##########################################

REM DOS COMMAND
for /f "skip=1" %i in (newMedHighDefects.txt); do @echo %i >> findingIDs.txt

ファイル findingIDs.txt を polyspace-access -review コマンドに渡します。これらの調査結果と編集するレビュー フィールドを含むプロジェクトのパスを指定します。たとえば、調査結果にステータス、オーナー、またはコメントを割り当てることができます。

# BASH COMMAND

 polyspace-access $login -review findingIDs.txt \
 -project-path "public/example/Bug_Finder_Example (Bug Finder)" \
 -set-status "To investigate" -set-owner jsmith \
 -set-comment "Finding assigned automatically"

######################################################

REM DOS COMMAND

polyspace-access %login% -review findingIDs.txt ^
 -project-path "public/example/Bug_Finder_Example (Bug Finder)" ^
 -set-status To investigate" -set-owner jsmith ^
 -set-comment "Finding assigned automatically"

コマンドは 1 回のみ実行され、ファイル findingsIDs.txt 内のすべての調査結果の指定されたレビュー フィールドの一括編集が行われます。調査結果の数とネットワークの速度によっては、コマンドを完了するのに少し時間がかかることがあります。

Polyspace Metrics サーバー上に保存されているプロジェクトがある場合、それらのプロジェクトを Polyspace Access データベースに移行できます。Metrics サーバーにログインして、以下の操作を行います。

移行するプロジェクトを対象に移行プロジェクトを生成します。プロジェクトの保存場所のフォルダー パスを指定します。例: C:\Users\jsmith\AppData\Roaming\Polyspace_RLDatas\results-repository 

polyspace-access -generate-migration-commands ^
C:\Users\jsmith\AppData\Roaming\Polyspace_RLDatas\results-repository ^
-output-folder-path C:\Polyspace_Workspace\toMigrate -project-date-after 2017-06

このコマンドは、指定されたメトリクス フォルダー内に、2017 年 6 月以降にアップロードされた、すべてのプロジェクトの移行スクリプトを生成します。このスクリプトは、フォルダー C:\Polyspace_Workspace\toMigrate 内に保存されます。

-dryrun オプションを使用して、移行されるプロジェクトをチェックします。

polyspace-access -host myAccessServer ^
-migrate -option-file-path ^
C:\Polyspace_Workspace\toMigrate -dryrun
コマンド出力に、プロジェクトのリストが含まれます。これを検査して、必ず正しいプロジェクトが移行されるようにします。

移行を実行するには、-dryrun オプションなしで最後のコマンドを再実行します。

入力引数

すべて折りたたむ

接続構成およびログイン

hostname は、Polyspace Access インターフェイスの URL (https://hostname:port/metrics/index.html など) で指定されたホスト名に対応します。使用するホスト名がわからない場合は、Polyspace Access 管理者にお問い合わせください。既定のホスト名は localhost です。-generate-migration-commands および -encrypt-password コマンドを除き、すべての polyspace-access コマンドではホスト名を指定しなければなりません。

例: -host myAccessServer

接続構成およびログイン資格情報を指定するためのオプションは以下のとおりです。

接続オプション

オプション説明

-port portNumber

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

-protocol http | https

Polyspace Access にアクセスするために使用する HTTP プロトコル。既定のプロトコルは https です。
-credentials-file filePath

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

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

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

-api-key keyValue

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

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

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

-login username

-encrypted-password ENCRYPTED_PASSWD

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

これら 2 つのオプションを使用しない場合は、-api-key を使用しない限り、コマンド ラインで資格情報を入力するよう求められます。

-max-retry retryNumber

クライアント マシンから、Polyspace Access をホストするサーバー マシンに結果をアップロードする際に、polyspace-access コマンドがアップロードを再試行する回数。散発的なネットワーク停止が発生した場合にアップロード コマンドを再試行するには、このオプションを使用します。コマンドは再試行間で 10 秒待機します。

既定では、このコマンドの最大再試行回数は 60 回です。

その他のオプション

オプション説明

-output filePath

コマンド出力を保存するファイルの絶対パス。

-tmp-dir folderPath

polyspace-access コマンドによって生成される一時ファイルを保存するフォルダーのパス。既定のフォルダー パスは、Linux では tmp/ps_results_server、Windows では C:/Users/%username%/AppData/Local/Temp/ps_results_server です。

-log filePath

コマンド出力ログを保存するファイルのパス。既定では、このコマンドはログ ファイルを生成しません。

-h

polyspace-access またはそのコマンドのいずれかに関するヘルプ情報を表示します。

プロジェクトの管理および表示

文字列として指定された、プロジェクト フォルダーの絶対パス。名前にスペースが含まれる場合は、二重引用符を使用します。親フォルダー内に入れ子にされたフォルダーの絶対パスを指定します。

フォルダー パスにまだ存在していないフォルダーが含まれる場合、そのフォルダーが作成されます。

例: -create-project topFolder

例: -create-project "topFolder/subFolder/Folder has spaces"

文字列として指定するプロジェクトの絶対パス。パス名にスペースが含まれる場合は、二重引用符を使用します。この引数を使用するときには、以下のようになります。

  • -list-project と共に指定するとき、この引数はオプションです。このコマンドは、指定されたプロジェクトにアップロードされた最後の実行 ID を返します。

  • -list-run と共に指定するとき、このコマンドは、指定されたプロジェクトにアップロードされたすべての実行の実行 ID とラベルを返します。

例: -move-project "public/Examples/Bug_Finder_Example (Bug Finder)"

例: -move-runs public/Examples/Code_Prover_Example

例: -delete-project public/Folder/projectName

例: -set-deletion-policy public/Folder/projectName

例: -unset-deletion-policy public/Folder/projectName

例: -get-deletion-policy public/Folder/projectName

例: -list-project public/Folder/projectName

例: -list-runs public/Folder/projectName

例: -set-project-information public/Folder/projectName -banner "My banner text."

文字列として指定された、プロジェクトまたはフォルダーの絶対パス。名前にスペースが含まれる場合は、二重引用符を使用します。新しいフォルダーまたはプロジェクトの場所の絶対パスを指定します。

フォルダーを移動または名前変更する場合、サブフォルダーとサブプロジェクトのすべてが新しい親フォルダーに移動されます。プロジェクトを別のフォルダーに移動する場合、宛先パスに対応するプロジェクト名を含む絶対パスを指定する必要があります。

例: -to-project-path new/Folder/Path

例: -to-project-path "new/Folder/name has spaces"

日数として指定されたプロジェクト実行の最大経過日数。プロジェクト実行のアップロード時点からの経過日数が MAX_DAYS を超えると、Polyspace によりその実行が削除されます。

削除ポリシーを設定すると、その後、実行がアップロードされるたびにそのポリシーが適用されます。プロジェクトに新しい実行をアップロードしなければ、実行がアップロードされてからの日数が MAX_DAYS を超えていても、実行は削除されません。

例: -set-deletion-policy public/Folder/projectName -max-days 30

プロジェクトで保持する実行の最大数です。プロジェクトに MAX_RUNS 個の実行が既に含まれている場合に、新しい実行をアップロードすると、Polyspace によりそのプロジェクトの最も古い実行がデータベースから削除されます。Polyspace は、最大数に関する実行の削除ポリシーを適用する際、ユーザーが削除対象から除外した実行は数に含めません。

例: -set-deletion-policy public/Folder/projectName -max-runs 10

プロジェクト バナーに表示するテキスト文字列。バナーが既に存在する場合は、bannerText によって既存のバナーが置き換えられます。複数行にわたるバナーを作成するには、改行文字 \n を使用します。バナーのテキストにスペースが含まれる場合は、二重引用符を使用します。

Polyspace Access ユーザー インターフェイスでは、集約プロジェクト フォルダーまたは個々のプロジェクト実行で、プロジェクト バナーが表示されます。バナー上の展開アイコンをクリックすると、ユーザー インターフェイス内に長いバナー メッセージ全体が表示されます。

例: -set-project-information public/Folder/projectName -banner "My banner text."

例: -set-project-information public/Folder/projectName -banner "Multi-line banner example.\n\nMy banner text."

結果のアップロード、ダウンロード、またはエクスポート

文字列として指定された Bug Finder (PSBF)、Code Prover (PSCP)、または Polyspace Test (PSTESTR or PSPROF) 結果ファイルのパス。このコマンドは、結果ファイル、および同じ結果フォルダー内にある他のファイルのコピーをアップロードします。あるいは、単一の PSBF、PSCP、PSTESTR、または PSPROF 結果ファイルを格納する親フォルダーのパスや、圧縮された結果ファイルまたはフォルダーのパスを指定することもできます。

たとえば、Bug Finder の結果が C:\Polyspace_Workspace\myProject\Module_1\BF_results\ps_results.psbf に保存されている場合、これを -upload コマンドで指定します。パス名にスペースが含まれる場合は、二重引用符でパスを囲みます。

アップロードを高速化するには、解析を実行するときにオプション -results-dir (Polyspace Bug Finder) を使用して、解析結果を専用の結果フォルダーに格納します。Polyspace 解析結果とは無関係のファイルが大量に入ったフォルダー (リポジトリのルート フォルダーなど) に結果を格納すると、Polyspace Access で結果のアップロードにかかる時間が長くなります。

例: -upload C:\Polyspace_Workspace\myProject\Module_1\BF_results\ps_results.psbf

例: -upload C:\Polyspace_Workspace\myProject\Module_1\ -project projectFolder

例: -upload C:\Polyspace_Workspace\myTestProj\results\results.pstestr -project testsFolder

結果のアップロード先とするプロジェクト フォルダーのパスとプロジェクトの名前を指定するためのオプションは以下のとおりです。これらのオプションは任意指定ではありません。

オプション説明

-parent-project folderPath

アップロードした結果を保存する、Polyspace Access エクスプローラーでの親フォルダーのパス。

親フォルダーを指定しない場合、アップロードした結果は [パブリック] フォルダーに保存されます。

-project resultsName

Polyspace Access エクスプローラーにおける、アップロードした結果の名前。アップロードした結果の名前を変更するには、このオプションを使用します。

結果の名前を指定しない場合、結果は projectName (resultsType) という名前で保存されます。projectName に含まれるスペースはアンダースコアで置換されます。たとえば、プロジェクト Bug Finder Example の Bug Finder の結果をアップロードすると、その結果は Bug_Finder_Example (Bug Finder) という名前で保存されます。

-exclude-from-deletion

アップロードする実行が、プロジェクト実行削除ポリシーの対象から除外されます。このオプションを使用すると、特定のプロジェクト実行が削除されないようにすることができます。たとえば、プロジェクトにアップロードした最初の実行はベースラインとして保持して、そのプロジェクトにアップロードするその他のすべての実行には削除ポリシーを適用するような場合です。Polyspace は、最大数に関する実行の削除ポリシーを適用する際、ユーザーが削除対象から除外した実行は数に含めません。

削除ポリシーの対象から除外された実行は、ユーザーが明示的に削除するまでデータベース内に残ります。この実行は、Polyspace Access インターフェイスの [実行の削除] ウィンドウで [永続] として表示されます。個々の実行をコマンド ラインで手動で削除することはできません。

例: 

polyspace-access -upload /usr/local/polyspace/results/ps_results.psbf \
 -parent-project public/examples \
 -exclude-from-deletion
プロジェクト実行またはプロジェクト全体の削除も参照してください。

エクスポートするプロジェクト調査結果のパスまたは実行 ID。Polyspace は、アップロードする各解析実行に一意の実行 ID を割り当てます。パス名にスペースが含まれる場合は、二重引用符を使用します。プロジェクト調査結果のパスまたは最後の実行 ID を取得するには、-list-project を使用します。

例: -export "public/Examples/Bug_Finder_Example (Bug Finder)"

例: -export 4

-output オプションを指定する場合、コマンドの出力を保存するファイルのパス。-export コマンドでは、このオプションは必須です。

例: -output C:\Polyspace_Workspace\myResults.txt

調査結果のエクスポート先と、エクスポートする調査結果のサブセットを指定するためのオプションは以下のとおりです。カスタム レポートを作成するために使用する他のツールや、他のカスタム レビュー テンプレートに調査結果をエクスポートする場合は、これらのオプションを使用します。

オプション説明

-output filePath

調査結果のエクスポート先とするファイルのパス。-export コマンドでは、このオプションは必須です。

-output-per-owner

特定のユーザーに割り当てられた調査結果のみを含む、ファイルを生成するにはこのオプションを使用します。生成されたファイルは、-output で指定したパスに保存されます。

コマンド ラインで調査結果をオーナーに割り当てる方法の例は、コンポーネント オーナーへの結果の割り当てと割り当てられた結果のエクスポートを参照してください。

-rte All | Red | Gray | Orange | Green

エクスポートする RTE 調査結果のタイプ。All、Red、Gray、Orange、または Green を指定します。

複数の引数を指定するには、引数ごとにこのオプションを呼び出します。たとえば、-rte Red -rte Orange とします。

-defects All | High | Medium | Low

調査結果のうち、エクスポートの対象とする欠陥の影響。All、High、Medium、または Low を指定します。

複数の引数を指定するには、引数ごとにこのオプションを呼び出します。たとえば、-defects Medium -defects Low とします。

-custom-coding-rules

すべてのカスタム コーディング ルール調査結果をエクスポートします。

-coding-rules

すべてのコーディング ルール調査結果をエクスポートします。

-code-metrics

すべてのコード メトリクス調査結果をエクスポートします。

-global-variables

すべてのグローバル変数調査結果をエクスポートします。

-status Unreviewed | "To investigate" | "To fix" | Justified | "No action planned" | "Not a defect" | Other

エクスポートの対象とする、調査結果のレビュー ステータス。Unreviewed (既定)、"To investigate"、"To fix"、Justified、"No action planned"、"Not a defect"、または Other を指定します。

複数の引数を指定するには、引数ごとにこのオプションを呼び出します。たとえば、-status Tofix -status Toinvestigate とします。

-severity All | High | Medium | Low

エクスポートの対象とする、調査結果の重大度。All、High、Medium、または Low を指定します。

複数の引数を指定するには、引数ごとにこのオプションを呼び出します。たとえば、-severity High -severity Low とします。

-unassigned-findings

未割り当ての調査結果をすべてエクスポートします。

-open-findings-for-sqo 1 | 2 | 3 | 4 |5 | 6

満たさなければならないソフトウェア品質目標 (SQO)。sqo_level として 1 から 6 までの数値を指定します。SQO レベルを指定すると、polyspace-access コマンドにより、このレベルの要件を満たすために修正または正当化する必要がある未解決の調査結果のみがエクスポートされます。

SQO レベルでは、1 から 6 に数値が大きくなるにつれ、より厳密な事前定義またはユーザー定義の要件が Polyspace の結果に適用されます。Polyspace Access Web インターフェイスで要件をカスタマイズするには、Customize Software Quality Objectivesを参照してください。

SQO レベルの詳細については、Bug Finder 品質目標に照らし合わせた Polyspace Bug Finder の結果の評価 (Polyspace Bug Finder)を参照してください。

たとえば、Code Prover の SQO レベル 2 では、正当化されないレッド チェックがないことが要件となります。つまり、レベル 2 以上を指定した -open-findings-for-sqo を使用した場合、すべてのレッド チェックをエクスポートして、修正または正当化する必要があります。それより前の SQO レベル 1 でこの要件を適用したい場合は、Polyspace Access Web インターフェイスでレベル 1 をカスタマイズできます。

-resolution New | Fixed | Unresolved | Resolved

このオプションは、同じプロジェクトの 2 つの実行を比較するために使用します。解決は、ソフトウェアが実行する、現在の実行とオプション -baseline で指定されたベースライン実行との間の比較に対応します。ベースライン実行は、現在の実行より古いものである必要があります。

解決のタイプは次のとおりです。

  • New — 調査結果が現在の実行には含まれているが、ベースライン実行には含まれていない。

    プロジェクトに含まれる実行が 1 つしかない場合、すべての調査結果は新規であり、このオプションは省略できます。

  • Fixed — 調査結果が現在の実行で修正された。これは、ソース コードで調査結果が修正されたか、あるいは調査結果が含まれているソース コードが削除されたか、解析に含まれなくなったためです。

    プロジェクトに含まれる実行が 1 つだけである場合は、エラーになります。

  • Unresolved — ベースライン実行に含まれている調査結果が、現在の実行にもまだ存在する。

    プロジェクトに含まれる実行が 1 つだけである場合は、エラーになります。

  • Resolved — 調査結果が現在の実行で Fixed になったか、現在の実行で [正当化済み]、[アクションの予定なし]、または [欠陥ではない] のステータスになっている。

    プロジェクトに含まれる実行が 1 つだけである場合は、エラーになります。

ベースラインを指定しない場合、現在の実行がその直前の実行と比較されます。

一度に指定できる解決のタイプは 1 つのみです。複数の解決のタイプの比較をエクスポートするには、解決のタイプごとに polyspace-access -export コマンドを実行します。

Comparison Mode at the Command Lineも参照してください。

-baseline runID

現在の実行との比較でベースラインとして使用する実行の実行 ID を指定します。このオプションにはオプション -resolution が必要です。

このオプションは必須ではありません。ベースラインを指定しない場合、現在の実行がその直前の実行と比較されます。プロジェクトに含まれる実行が 1 つだけである場合は、エラーになります。

Comparison Mode at the Command Lineも参照してください。

-imported-reviews Not applied | Written | Overwritten | Unconfirmed

このオプションは、別のプロジェクト (ソース) からレビュー情報をインポートしているプロジェクト (ターゲット) から、調査結果のリストをエクスポートする場合に使用します。インポート タイプには次のいずれかを指定します。

  • Not applied — レビュー情報はソース プロジェクトからインポートされたものですが、ターゲット プロジェクトのレビュー フィールドは元の値のままです。

  • Written — ターゲット プロジェクトのレビュー フィールドが以前に空だった場合に限り、ソース プロジェクトのレビュー情報がターゲット プロジェクトに書き込まれます。

  • Overwritten — ターゲット プロジェクトのレビュー フィールドが以前に空でなかった場合にも、ソース プロジェクトのレビュー情報がターゲット プロジェクトに書き込まれます。

  • Unconfirmed — インポート操作の結果がレビュー担当者によって確認されていない調査結果を選択する場合に、このフィルターを使用します。インポート操作の結果は、Polyspace Access インターフェイスで確認します。インポートされたレビュー情報の確認を参照してください。

既存の Polyspace Access プロジェクトからのレビュー情報のインポートも参照してください。

オプションを組み合わせて使用することもできます。たとえば、-coding-rules -severity High は、Polyspace Access Web インターフェイスでステータスとして High が割り当てられているコーディング ルール違反をエクスポートします。

ダウンロードするプロジェクト調査結果のパスまたは実行 ID。Polyspace は、Polyspace Access にアップロードする各解析実行に一意の実行 ID を割り当てます。パス名にスペースが含まれる場合は、二重引用符を使用します。プロジェクトの調査結果のパスまたは最新の実行 ID を取得するには、-list-project を使用します。

プロジェクト パスを指定すると、このコマンドはそのプロジェクトの最新の実行をダウンロードします。以前の実行をダウンロードするには、実行 ID を指定します。以前の実行の実行 ID を取得するには、Polyspace Access インターフェイスの [プロジェクト エクスプローラー] でプロジェクトを選択してからツールストリップのドロップダウンをクリックし、[現在] を選択して使用可能な実行 ID を表示します。

例: -download "public/Examples/Bug_Finder_Example (Bug Finder)"

例: -download 5113

ダウンロードした結果を格納するフォルダーのパス。既存のフォルダーを指定する場合、そのフォルダーは空でなければなりません。-download コマンドでは、このオプションは必須です。

例: -output-folder-path C:\Polyspace_Workspace\baseline

調査結果のレビュー情報の管理

コマンド -review を使用して、レビュー情報を追加する調査結果の ID を指定します。バッチ レビューを実行するには、代わりに、複数の調査結果の調査結果 ID を 1 つのテキスト ファイルに保存し (1 行に 1 つの調査結果 ID)、そのファイルを -review コマンドに渡します。

Polyspace Access は、アップロードする各調査結果に一意の ID を割り当てます。

例: -review 1234

例: -review listOfFindings.txt

レビュー情報を追加する先の調査結果を含むプロジェクトの絶対パスを指定します。オプション -project-path を使用して、パスを指定します。-review を使用する場合は、このオプションが必須です。

例: -project-path path/To/Project

例: -project-path "project/path/with spaces"

指定した調査結果 ID を持つ調査結果に 1 つ以上のレビュー フィールドを割り当てるオプションです。polyspace-access -review を使用する場合は、少なくとも 1 つのレビュー オプションを指定する必要があります。レビュー情報を調査結果に割り当てた後、その情報は Polyspace Access の [結果の詳細] ペインで確認できるようになります。

オプション説明

-set-status Unreviewed | "To investigate" | "To fix" | Justified | "No action planned" | "Not a defect" | Other

調査結果のステータスを割り当てます。Unreviewed (既定)、"To investigate"、"To fix"、Justified、"No action planned"、"Not a defect"、または Other を指定します。

調査結果のステータスをリセットするには、そのステータスを Unreviewed に設定します。

-set-severity Unset | High | Medium | Low

調査結果の重大度を割り当てます。Unset (既定)、High、Medium、または Low を指定します。

調査結果の重大度をリセットするには、その重大度を Unset に設定します。

-set-comment comment

調査結果にコメントを割り当てます。

-unset-comment

調査結果に現在割り当てられているコメントを削除します。

-set-owner username

調査結果にオーナーを割り当てます。表示名ではなく、ユーザーが Polyspace Access にログインするために使用するユーザー名を指定してください。たとえば、John Smith ではなく jsmith を指定します。

-unset-owner

調査結果に現在割り当てられているオーナーを除去します。

-set-ticket ticketID

既存の BTT チケットを調査結果に割り当てます。チケット ID を指定してください。

BTT チケットを調査結果に割り当てることができるのは、Jira Software や Redmine などの BTT を Polyspace Access に統合している場合のみです。Polyspace が問題の追跡用に構成されているかどうかを判断するには、Polyspace の管理者にお問い合わせください。

-unset-ticket

調査結果に現在適用されている BTT チケットを除去します。

調査結果を既にレビューしたプロジェクトの絶対パスを指定します。このソース プロジェクトからレビュー情報をインポートします。

例: -import-reviews path/To/sourceProject

例: -import-reviews "source project/path/with spaces"

レビュー情報をインポートするターゲット プロジェクトの絶対パスを指定します。既定で、レビュー フィールドに既に内容が含まれている場合は、そのレビュー フィールドがソース プロジェクトからインポートされたレビュー情報で上書きされません。オプション -import-strategy always-overwrite-target を使用すると、ターゲット プロジェクトのレビュー情報が、ソース プロジェクトからインポートされたレビュー情報で強制的に上書きされます。

例: -to-project-path path/To/targetProject

例: -import-reviews "target project/path/with spaces"

ソフトウェア品質目標 (SQO) の管理

SQO レベルとオプションで SQO 定義を割り当てるには、コマンド -set-sqo でプロジェクトの絶対パスを指定します。指定したプロジェクトに現在適用されている SQO レベルと SQO 定義を表示するには、コマンド -get-sqo を使用します。コマンドの -set-sqo と -get-sqo でフォルダー パスを指定することはできません。

プロジェクトのパスにまだ存在していないフォルダーが含まれる場合、そのフォルダーが作成されます。

例: -set-sqo path/To/Project

例: -get-sqo "project/path/with spaces"

現在適用されている SQO 定義について、指定したプロジェクトに割り当てる SQO のレベル。別の SQO 定義も割り当てるには、オプション -name を使用します。

例: -level 3

例: -level Exhaustive

指定したプロジェクトに別の SQO 定義を適用するには、SQO 定義の名前を指定します (オプション)。

使用可能な SQO 定義のリストを表示するには、コマンド -list-sqo を使用します。指定したプロジェクトに現在適用されている SQO 定義を表示するには、コマンド -get-sqo を使用します。

SQO 定義名にスペースが含まれる場合は、二重引用符を使用します。

例: -name Polyspace

例: -name "My Custom SQO"

プロジェクト実行ラベルおよび未割り当ての調査結果の管理

追加または削除する、オプション -run-id で指定したプロジェクト実行のラベルを指定します。ラベルにスペースが含まれる場合は、二重引用符を使用します。

例: -add-label testing_branch

例: -remove-label "testing branch"

ラベルを追加または削除するプロジェクト実行の実行 ID を指定します。プロジェクトの最新の実行 ID を表示するには、コマンド -list-project を使用します。特定のプロジェクトのすべてのプロジェクト実行の実行 ID を表示するには、コマンド -list-runs を使用します。

例: -run-id 1234

ユーザーに割り当てるプロジェクト調査結果のパスまたは実行 ID。Polyspace は、アップロードする各解析実行に一意の実行 ID を割り当てます。パス名にスペースが含まれる場合は、二重引用符を使用します。プロジェクト調査結果のパスまたは最後の実行 ID を取得するには、-list-project を使用します。

例: -set-unassigned-findings "public/Examples/Bug_Finder_Example (Bug Finder)"

例: -set-unassigned-findings 4

未割り当ての調査結果のオーナーとして割り当てるユーザーのユーザー名。複数のオーナーを割り当てるには、ユーザーごとにこのオプションを呼び出します。

-owner の各呼び出しは、-source-contains の呼び出しとペアにする必要があります。

例: -owner jsmith

プロジェクト ソース ファイルのファイル パスと照合するパターン。すべてのソース ファイルのファイル パスを照合するには、"-source-contains /" を使用します。

ファイル パスの部分文字列を入力します。正規表現を使用することはできません。

このオプションを複数回呼び出すと、各インスタンスで前のインスタンスでのパターンが除外されます。たとえば、-source-contains foo -source-contains bar は foo が含まれるすべてのファイルのパスを照合し、次に foo が含まれるパスを除外して、bar が含まれるすべてのファイルのパスを照合します。

調査結果を複数のオーナーに割り当てる場合は、-owner の呼び出しごとにこのオプションを呼び出します。

例: -source-contains main

すべての調査結果を割り当てるか、コンポーネントや個々のソース ファイルに基づくサブセットのみを割り当てるためのオプションは以下のとおりです。割り当てを行うには、割り当てるフォルダーまたはファイルのパスと照合するパターンを指定します。

オプション説明

-rte All | Red | Gray | Orange | Green

割り当ての対象とする、未割り当ての RTE 調査結果のタイプ。All、Red、Gray、Orange、または Green を指定します。

複数の引数を指定するには、引数ごとにこのオプションを呼び出します。たとえば、-rte Red -rte Orange とします。

-defects All | High | Medium | Low

調査結果のうち割り当ての対象とする、未割り当ての欠陥の影響。All、High、Medium、または Low を指定します。

複数の引数を指定するには、引数ごとにこのオプションを呼び出します。たとえば、-defects Medium -defects Low とします。

-custom-coding-rules

すべての未割り当てのカスタム コーディング ルール調査結果にオーナーを割り当てます。

-coding-rules

すべての未割り当てのコーディング ルール調査結果にオーナーを割り当てます。

-code-metrics

すべての未割り当てのコード メトリクス調査結果にオーナーを割り当てます。

-global-variables

すべての未割り当てのグローバル変数調査結果にオーナーを割り当てます。

-resolution New

未割り当ての調査結果のうち、前回の解析実行に比べて新規のものにオーナーを割り当てます。プロジェクトに含まれる実行が 1 つしかない場合、すべての調査結果は新規であり、このオプションは省略できます。

-status Unreviewed | "To investigate" | "To fix" | Justified | "No action planned" | "Not a defect" | Other

これから割り当てる、未割り当ての調査結果のレビュー ステータス。Unreviewed、"To investigate"、"To fix"、Justified、"No actionp lanned"、"Not a defect"、または Other を指定します。

複数の引数を指定するには、引数ごとにこのオプションを呼び出します。たとえば、-status "To fix" -status "To investigate" とします。

-severity All | High | Medium | Low

これから割り当てる、未割り当ての調査結果の重大度。All、High、Medium、または Low を指定します。

複数の引数を指定するには、引数ごとにこのオプションを呼び出します。たとえば、-severity High -severity Low とします。

-dryrun

割り当てを行わずにコマンド出力を表示します。このオプションは、割り当てが適切であることをチェックするために使用します。

ユーザーのアクセス許可の管理

プロジェクト フォルダーまたは調査結果に対する、ユーザーのアクセス権のレベル。

  • オーナー:指定されたプロジェクト フォルダーまたは調査結果の移動、名前変更、削除、およびそのコンテンツのレビューがユーザーに許可されます。

  • コントリビューター:指定されたプロジェクト フォルダーまたは調査結果のコンテンツのレビューがユーザーに許可されます。

  • 禁止:指定されたプロジェクト フォルダーまたは調査結果へのアクセスはユーザーに許可されません。プロジェクト フォルダーにアクセスできるユーザーに対し、そのフォルダー内のプロジェクト調査結果へのアクセスを制限するには、この役割を設定します。

例: -set-role contributor

Polyspace Access ユーザー名。

例: -user jsmith

Polyspace Access グループ名。

例: -group "Group UI team"

プロジェクト フォルダーまたはプロジェクト調査結果のパス。folderPathOrProjectPath がプロジェクト フォルダーのパスである場合、設定するユーザーの役割は、そのフォルダー内のすべてのサブフォルダーとプロジェクト調査結果に適用されます。パス名にスペースが含まれる場合は、二重引用符を使用します。プロジェクト フォルダーまたは調査結果のパスを取得するには、-list-project を使用します。

例: -project-path "public/Examples/Bug_Finder_Example (Bug Finder)"

例: -project-path public

Metrics から Polyspace Access への調査結果の移行

Polyspace Access に移行する Polyspace Metrics プロジェクトが含まれるフォルダーのパス。

例: -generate-migration-commands C:\Users\%username%\AppData\Roaming\Polyspace_RLDatas\results-repository

-generate-migration-commands の出力を保存するフォルダーのパス。既存のフォルダーは指定しないでください。

例: local/Polyspace_Workspace/migration_scripts

オプション説明

-output-folder-path folderPath

生成されたコマンド ファイルを保存するフォルダーのパス。既存のフォルダーは指定しないでください。

-max-project-runs int

各プロジェクトで移行する直近の解析実行の数。たとえば、プロジェクトの直近 2 件の解析実行のみを移行するには、2 を指定します。

-project-date-after YYYY[-MM[-DD]]

指定された日付以降に Polyspace Metrics にアップロードされた結果のみを移行します。

-product productName

プロジェクト調査結果を解析および生成するために使用した製品。bug-finder、code-prover、または polyspace-ada として指定します。

-analysis-mode integration | unit-by-unit

プロジェクト調査結果を生成するために使用した解析モード。integration または unit-by-unit として指定します。

バージョン履歴

R2019a で導入

すべて展開する

参考

トピック