Exponenta Banner

polyspace-report-generator

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

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

Синтаксис

polyspace-report-generator -template <template> [OPTIONS]
polyspace-report-generator -generate-results-list-file [-results-dir <FOLDER>] [-set-language-english]
polyspace-report-generator -generate-variable-access-file [-results-dir <FOLDER>] [-set-language-english]
polyspace-report-generator -template <template> -host <HOSTNAME> -run-id <RUN_ID> [ACCESS_OPTIONS] [OPTIONS]
polyspace-report-generator -generate-results-list-file -host <HOSTNAME> -run-id <RUN_ID> [ACCESS_OPTIONS] [-set-language-english]
polyspace-report-generator -generate-variable-access-file -host <HOSTNAME> -run-id <RUN_ID> [ACCESS_OPTIONS] [-set-language-english]
polyspace-report-generator -configure-keystore

Описание

пример

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

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

polyspace-report-generator -generate-results-list-file [-results-dir <FOLDER>] [-set-language-english] экспортирует результаты анализа, сохраненные локально в FOLDER в текстовый файл с разделителями табуляции. Файл содержит информацию о результате, доступную на панели Results List в пользовательском интерфейсе. Для получения дополнительной информации об экспортируемом списке результатов, вид на море Экспортируемые Результаты (Polyspace Code Prover).

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

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

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

пример

polyspace-report-generator -template <template> -host <HOSTNAME> -run-id <RUN_ID> [ACCESS_OPTIONS] [OPTIONS] генерирует отчет при помощи TEMPLATE поскольку результаты анализа запускают RUN_ID сохраненный на Polyspace доступ. HOSTNAME полностью определенное имя хоста машины, которая размещает Polyspace доступ.

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

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

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

пример

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

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

пример

polyspace-report-generator -configure-keystore конфигурирует генератор отчетов, чтобы связаться с Polyspace® Access по HTTPS.

Запустите этот одноразовый шаг настройки, если Polyspace, доступ сконфигурирован, чтобы использовать протокол HTTPS и у вас нет лицензии рабочего стола Polyspace Bug Finder™, или у вас есть настольная лицензия, но вы не сконфигурировали настольный пользовательский интерфейс, чтобы передать с Polyspace доступ по HTTPS. Прежде, чем запустить эту команду, сгенерируйте клиент keystore, чтобы сохранить сертификат SSL что Polyspace доступ к использованию для 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).

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

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

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

Необходимо запустить keystore команду настройки снова если:

  • Доступ к Polyspace к изменениям URL, например, если вы используете различный номер порта.

  • Путь к keystore изменениям файла.

  • keystore изменения пароля.

Примечание

Использовать командную строку в генерации отчетов результатов сохранило на Polyspace доступ, у вас должны быть Polyspace Bug Finder Server™ или установка Сервера Polyspace Code Prover™.

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

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

polyspace-access -encrypt-password 
login: jsmith
password:
CRYPTED_PASSWORD LAMMMEACDMKEFELKMNDCONEAPECEEKPL
Command Completed
Сохраните свой Polyspace доступ к учетным данным входа в систему в переменной LOGIN.
set LOGIN=-host jsmith ^
-encrypted-password LAMMMEACDMKEFELKMNDCONEAPECEEKPL
Чтобы задать результаты проекта на Polyspace доступ, задайте ID запуска проекта. Чтобы получить список проектов с их последним ID запуска, используйте polyspace-access с опцией -list-project. 
polyspace-access -host myAccessServer %LOGIN% -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.

Сгенерируйте Developer сообщите для результатов с запущенным ID о 16 от Polyspace доступ к экземпляру с именем хоста myAccessServer. URL этого экземпляра Polyspace доступ является https://myAccessServer:9443.

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

polyspace-report-generator %LOGIN% ^
-template %template_path%\Developer.rpt ^
-host myAccessServer ^
-run-id 16 ^
-output-name myReport
Команда создает, сообщает myReport.docx при помощи шаблона, который вы задаете. Отчет хранится в папке Polyspace-Doc на пути, от которого вы вызвали команду.

Сгенерируйте текстовый файл с разделителями табуляции, который содержит список глобальных переменных в вашем коде для заданных результатов анализа.

polyspace-report-generator %LOGIN%^
-generate-variable-access-file ^
-host myAccessServer ^
-run-id 16
Список глобальных переменных Variable_View.txt хранится в той же папке как сгенерированный отчет. Для получения дополнительной информации об экспортируемом списке переменных смотрите Глобальные переменные (Polyspace Code Prover Access).

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

свернуть все

Путь к шаблону отчета, который вы используете, чтобы сгенерировать аналитический отчет. Чтобы сгенерировать несколько отчетов, задайте список, разделенный запятыми путей к шаблону отчета (не помещайте пробел после запятых). Шаблоны доступны в 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

Путь к папке, содержащей результаты анализа, для которых вы генерируете отчет или результаты анализа, от которых вы экспортируете список результатов или глобальных переменных (Программа автоматического доказательства Кода). Чтобы сгенерировать отчет для нескольких верификаций, задайте список, разделенный запятыми путей к папкам (не помещайте пробел после запятых). Если вы не задаете путь к папке, команда генерирует отчет для результатов анализа в текущей папке.

Пример: 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 доступ к сервису Gateway API. Необходимо задать имя хоста, чтобы сгенерировать отчет для результатов на базе данных Access Polyspace.

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

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

Пример 4

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

Формат файла отчета, что вы генерируете. По умолчанию команда генерирует документ WORD.

Чтобы сгенерировать отчеты в нескольких форматах, задайте список, разделенный запятыми форматов. (Не помещайте пробел после запятых). Например, -format PDF,HTML.

Эта опция не совместима с -generate-variable-access-file и -generate-results-list-file.

- выходное имя outputName

Имя сгенерированного отчета или имени папки, если вы генерируете несколько отчетов.

Команда хранит outputName на пути, от которого вы вызываете команду. Чтобы хранить сгенерированные файлы в различной папке, задайте полный путь папки, например, -output-name C:\PathTo\OtherFolder.

- dir результатов FOLDER_1,...,FOLDER_N

Путь к локально сохраненной папке результатов. Чтобы сгенерировать отчеты для нескольких исследований, задайте список, разделенный запятыми пути к папке. (Не помещайте пробел после запятых). Например:

-results-dir folderPath1,folderPath2

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

- разместите HOST_NAME

Полностью определенное имя хоста машины, которая размещает Polyspace доступ к сервису Gateway API.

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

- ID запуска RUN_ID

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

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

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

-all-units

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

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

- порт portNumber

Номер порта Polyspace доступ к экземпляру. Значением по умолчанию является 9443.

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

Протокол HTTP раньше соединял с Polyspace доступ. Значением по умолчанию является https.

- вход в систему username

- encryted-пароль ENCRYPTED_PASSWD

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

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

Введенный в R2013b

Документация Polyspace Code Prover Server
Поддержка