Exponenta Banner

polyspace-report-generator

(DOS/UNIX) Создание отчетов для результатов анализа Polyspace, хранящихся локально или в Polyspace Access

Свернуть все на странице

Синтаксис

polyspace-report-generator -template outputTemplate [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 -template outputTemplate -host hostName -run-id runID> [ACCESS_OPTIONS] [OPTIONS]
polyspace-report-generator -generate-results-list-file -host hostName -run-id runID [ACCESS_OPTIONS] [-set-language-english]
polyspace-report-generator -generate-variable-access-file -host hostName -run-id runID [ACCESS_OPTIONS] [-set-language-english]
polyspace-report-generator -configure-keystore

Описание

пример

polyspace-report-generator -template outputTemplate [OPTIONS] формирует отчет при помощи шаблона outputTemplate для локальных результатов анализа, которые вы задаете с OPTIONS.

По умолчанию отчеты для результатов из project-name хранятся как project-name_report-name в PathToFolder\Polyspace-Doc папка. PathToFolder - папка результатов project-name.

polyspace-report-generator -generate-results-list-file [-results-dir resultsFolder] [-set-language-english] экспортирует результаты анализа, хранящиеся локально в resultsFolder в текстовый файл с разделителями табуляции. Файл содержит информацию о результатах, доступную на панели Results List в пользовательском интерфейсе. Дополнительные сведения об экспортированном списке результатов см. в разделе Просмотр экспортированных результатов.

По умолчанию файл результатов для результатов из project-name хранится в PathToFolder\Polyspace-Doc папка. PathToFolder - папка результатов project-name.

Для экспорта результатов в текстовый файл с разделителями табуляции, polyspace-results-export команда является предпочтительной.

polyspace-report-generator -generate-variable-access-file [-results-dir resultsFolder] [-set-language-english] экспортирует список глобальных переменных в коде из анализа Code Prover, хранящегося локально в FOLDER в текстовый файл с разделителями табуляции. Файл содержит информацию, доступную на панели Variable Access в пользовательском интерфейсе. Дополнительные сведения об экспортированном списке переменных см. в разделе Просмотр экспортированного списка переменных.

По умолчанию файл переменных для результатов из project-name хранится в PathToFolder\Polyspace-Doc папка. PathToFolder - папка результатов project-name.

пример

polyspace-report-generator -template outputTemplate -host hostName -run-id runID> [ACCESS_OPTIONS] [OPTIONS] формирует отчет при помощи шаблона outputTemplate для результатов анализа, соответствующих выполнению runID на Polyspace Access. hostName - полное имя хоста компьютера, на котором размещен Доступ.

По умолчанию отчеты для результатов из project-name хранятся как project-name_report-name в PathToFolder\Polyspace-Doc папка. PathToFolder - путь, из которого вы вызываете команду.

polyspace-report-generator -generate-results-list-file -host hostName -run-id runID [ACCESS_OPTIONS] [-set-language-english] экспортирует результаты анализа, соответствующие выполнению runID в Polyspace Access к текстовому файлу с разделителями табуляции. Файл содержит информацию о результатах, доступную на панели Results List в веб-интерфейсе Доступ. hostName - полное имя хоста компьютера, на котором размещен Доступ. Для получения дополнительной информации об экспортированном списке результатов смотрите Список результатов (Polyspace Code Prover Access).

По умолчанию файл результатов для результатов из project-name хранится в PathToFolder\Polyspace-Doc папка. PathToFolder - путь, из которого вы вызываете команду.

Для экспорта результатов в текстовый файл с разделителями табуляции, polyspace-results-export команда является предпочтительной.

пример

polyspace-report-generator -generate-variable-access-file -host hostName -run-id runID [ACCESS_OPTIONS] [-set-language-english] экспортирует список глобальных переменных в коде из анализа Code Prover, соответствующего выполнению runID в Polyspace Access к текстовому файлу с разделителями табуляции. Файл содержит информацию, доступную на панели Variable Access в веб-интерфейсе Доступ. hostName - полное имя хоста компьютера, на котором размещен Доступ. Дополнительные сведения об экспортированном списке переменных см. в разделе Просмотр экспортированного списка переменных.

По умолчанию файл переменных для результатов из project-name хранится в PathToFolder\Polyspace-Doc папка. PathToFolder - путь, из которого вы вызываете команду.

пример

polyspace-report-generator -configure-keystore конфигурирует генератор отчетов для связи с Polyspace® Доступ через HTTPS.

Запустите этот одноразовый шаг строения, если Polyspace Access настроен на использование протокола HTTPS, и у вас нет лицензии Polyspace Bug Finder™ рабочего стола, или у вас есть лицензия рабочего стола, но вы не настроили пользовательский интерфейс рабочего стола для связи с Polyspace Access через HTTPS. Перед запуском этой команды сгенерируйте клиентский хранилище ключей для хранения SSL-сертификата, который Polyspace Access использует для HTTPS. См. «Генерация клиентского хранилища ключей» (Polyspace Code Prover Access).

Примеры

свернуть все

Можно создать несколько отчетов для результатов анализа, которые хранятся локально.

Создайте переменную 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
Команда генерирует два отчета PDF, myProject_Developer.PDF и myProject_CodingStandards.PDF. Отчеты хранятся в C:\Polyspace_Workspace\myProject\Module_1\CP_Result\Polyspace-Doc. Для получения дополнительной информации о содержимом отчетов см. Bug Finder and Code Prover report (-report-template).

Если вы конфигурируете Доступ для использования протокола HTTPS, необходимо сгенерировать клиентский хранилище ключей, где хранится SSL-сертификат, который использует Polyspace Access, и сконфигурировать polyspace-report-generator для использования этого хранилища ключей. См. «Генерация клиентского хранилища ключей» (Polyspace Code Prover Access). Это одноразовое строение позволяет генератору отчетов взаимодействовать с Polyspace Access через HTTPS.

Чтобы сконфигурировать генератор отчетов с клиентским хранилищем ключей, используйте polyspace-report-generator -configure-keystore команда. Следуйте инструкциям, чтобы указать URL-адрес, используемый для входа в Polyspace Access, полный путь к сгенерированному файлу хранилища ключей и пароль хранилища ключей.

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

Выполните команду строение еще раз, если:

  • URL-адрес Доступ изменяется, например, если используется другой номер порта.

  • Изменяется путь к файлу хранилища ключей.

  • Пароль хранилища ключей изменяется.

Примечание

Чтобы сгенерировать отчеты о результатах на Polyspace Access в командной строке, необходимо установить Polyspace Bug Finder Server™ или Polyspace Code Prover™ Server.

Предположим, что вы хотите сгенерировать отчет и экспортировать список переменных для результатов анализа Code Prover, хранящихся в базе данных Polyspace Access.

Чтобы подключиться к Polyspace Access, укажите имя хоста и свои учетные данные для входа, включая ваш зашифрованный пароль. Чтобы зашифровать пароль, используйте polyspace-access и введите свое имя пользователя и пароль в приглашении. 

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

Сохраните логин и зашифрованный пароль в файле учетных данных и ограничьте разрешение на чтение и запись в этот файл. Откройте текстовый редактор, скопируйте эти две линии в редактор, а затем сохраните файл как myCredentials.txt для примера.

 -login jsmith
 -encrypted-password LAMMMEACDMKEFELKMNDCONEAPECEEKPL
Чтобы ограничить права доступа к файлам, щелкните правой кнопкой мыши файл и выберите вкладку Permissions в Linux® или вкладку Security в Windows®.

Чтобы задать результаты проекта в Polyspace Access, укажите идентификатор запуска проекта. Чтобы получить список проектов с их последними идентификаторами запуска, используйте polyspace-access с опцией -list-project. 

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
Для получения дополнительной информации об этой команде см. polyspace-access (Polyspace Code Prover Server).

Сгенерируйте Developer отчет по результатам с идентификатором выполнения 16 из образца Polyspace Access с именем хоста myAccessServer. URL-адрес этого образца Polyspace Access 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 хранится в той же папке, что и сгенерированный отчет. Дополнительные сведения об экспортированном списке переменных см. в разделе Просмотр экспортированного списка переменных.

Входные параметры

свернуть все

Путь к шаблону отчета, который используется для создания отчета анализа. Чтобы сгенерировать несколько отчетов, задайте разделенный запятыми список путей к шаблонам отчетов (не помещайте пространство после запятых). Шаблоны доступны в polyspaceroot\ toolbox\polyspace\psrptgen\templates\ как .rpt файлы. Здесь, polyspaceroot - папка установки Polyspace. Для получения дополнительной информации о доступных шаблонах смотрите Bug Finder and Code Prover report (-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

Полное имя узла компьютера, на котором размещена служба Gateway API Доступ. Необходимо задать имя хоста, чтобы сгенерировать отчет для результатов в базе данных Polyspace Access.

Пример: my-company-server

Запустите идентификатор результатов проекта, для которого вы генерируете отчет. Polyspace присваивает уникальный идентификатор выполнения каждому запуску анализа, который вы загружаете в Polyspace Access.

Идентификатор запуска проекта можно увидеть в веб-интерфейсе Polyspace Access. Чтобы получить идентификатор запуска, используйте команду polyspace-access (Polyspace Code Prover Server) с опцией -list-project.

ОпцияОписание
-формат HTML | PDF | WORD

Формат файла отчета, который вы генерируете. По умолчанию команда генерирует документ 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

-set-language-englishСгенерируйте отчет на английском языке. Используйте эту опцию, если для вашего языка отображения задан другой язык.
-hОтображение справочной информации.
ОпцияОписание

-хост HOST_NAME

HOST_NAME соответствует имени хоста, заданному в URL-адресе интерфейса Polyspace Access, например https :// HOST_NAME: port/ metrics/index.html. Если вы не уверены, какое имя хоста использовать, обратитесь к администратору Polyspace Access. Имя хоста по умолчанию localhost.

Эта опция обязательна при создании отчетов для результатов, хранящихся в базе данных Polyspace Access.

-run-id RUN_ID

Выполните идентификатор проекта. Polyspace присваивает уникальный идентификатор запуска каждому запуску анализа, который вы загружаете. Чтобы получить последний идентификатор запуска проекта, используйте -list-project опция polyspace-access команда.

Для получения дополнительной информации о команде см. polyspace-access (Polyspace Code Prover Server).

Эта опция обязательна при создании отчетов для результатов, хранящихся в базе данных Polyspace Access.

-all-units

Задайте эту опцию, чтобы сгенерировать отчет для всех модулей измерения от unit by unit анализ.

Когда вы используете эту опцию, задайте идентификатор запуска только одного модуля измерения с -run-id. Команда включает другие модули из анализа в отчет.

-портовый portNumber

portNumber соответствует номеру порта, который вы задаете в URL интерфейса Polyspace Access, например https :// hostname: portNumber/ metrics/index.html. Если вы не уверены, какой номер порта использовать, обратитесь к администратору Polyspace Access. Номер порта по умолчанию 9443.

-протоколь http | https

Протокол HTTP для подключения к Polyspace Access. Значение по умолчанию https.
-credentials-file file_path

Полный путь к текстовому файлу, в котором вы храните свои учетные данные для входа в систему. Используйте эту опцию, если, например, вы используете команду, которая требует ваших учетных данных Доступ в скрипте, но вы не хотите хранить свои учетные данные в этом скрипте. Во время выполнения скрипта кто-то, проверяющий текущие процессы, не может увидеть ваши учетные данные.

В файле можно хранить только один набор учетных данных, как -login и -encrypted-password записи на отдельных линиях, для образца: 

-login jsmith
-encrypted-password LAMMMEACDMKEFELKMNDCONEAPECEEKPL
или как -api-key запись:
-api-key keyValue123
Убедитесь, что вы ограничиваете права на чтение и запись в файл, в котором хранятся ваши учетные данные. Например, чтобы ограничить разрешения на чтение и запись в файл login.txt в Linux используйте следующую команду:
chmod go-rwx login.txt

-api-key keyValue

API-ключ, который вы используете в качестве учетных данных для входа, вместо того, чтобы предоставлять логин и зашифрованный пароль. Чтобы назначить пользователю ключ API, смотрите или свяжитесь с администратором Polyspace Access.

Используйте ключ API, если, например, вы используете команду, которая требует ваших учетных данных Polyspace Access в качестве части скрипта автоматизации с помощью инструмента CI, такого как Jenkins. Если пользователь обновляет свой пароль, вы не должны обновлять ключ API, сопоставленный с этим пользователем в ваших скриптах.

Рекомендуется, чтобы вы хранили ключ API в файле и передали этот файл в команду при помощи -credentials-file.

-логин username

-encryted-password ENCRYPTED_PASSWD

Учетные данные, используемые для входа в Polyspace Access. Аргумент -encrypted-password - выход polyspace-access -encrypt-password команда.

Для получения дополнительной информации о команде см. polyspace-access (Polyspace Code Prover Server).

Совет

Вы не можете использовать polyspace-report-generator команда с результатами, сгенерированными с Polyspace as You Code. Используйте polyspace-results-export вместо этого команда. Посмотрите polyspace-results-export (Polyspace Bug Finder Access).

См. также

Введенный в R2013b

Документация Polyspace Code Prover

Поддержка