Exponenta Banner
exponenta event banner

polyspace-report-генератор

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

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

Синтаксис

polyspace-report-generator -template outputTemplate [ПАРАМЕТРЫ]
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 outputШаблон -host hostName -run-id runID > [ACCESS_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] экспортирует список глобальных переменных в коде из анализа программы проверки кода, хранящегося локально в FOLDER в текстовый файл с разделителями табуляции. Файл содержит информацию, доступную на панели «Доступ к переменной» в интерфейсе пользователя. Дополнительные сведения о списке экспортированных переменных см. в разделе Просмотр списка экспортированных переменных (средство проверки кода Polyspace).

По умолчанию файл переменных для результатов из 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 Полное имя узла компьютера, на котором размещен доступ Polyspace.

По умолчанию отчеты для результатов из 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) веб-интерфейса Polyspace Access. hostName Полное имя узла компьютера, на котором размещен доступ Polyspace. Дополнительные сведения об экспортированном списке результатов см. в разделе Список результатов (Polyspace Bug Finder 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] экспортирует список глобальных переменных в коде из анализа программы проверки кода, соответствующего выполнению runID в Polyspace Access к текстовому файлу с разделителями табуляции. Файл содержит информацию, доступную на панели «Переменный доступ» веб-интерфейса Polyspace Access. hostName Полное имя узла компьютера, на котором размещен доступ Polyspace. Дополнительные сведения о списке экспортированных переменных см. в разделе Просмотр списка экспортированных переменных (средство проверки кода Polyspace).

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

пример

polyspace-report-generator -configure-keystore настраивает генератор отчетов для взаимодействия с Polyspace ® Access по HTTPS.

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

Примеры

свернуть все

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

Создание переменной template_path сохранение пути к шаблонам отчетов и создание переменной report_templates для сохранения списка шаблонов, разделенных запятыми.

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

Создание отчетов из шаблонов, указанных в report_templates для анализа результатов проекта Polyspace myProject.

 polyspace-report-generator -template %report_templates% ^
-results-dir C:\Polyspace_Workspace\myProject\Module_1\BF_Result ^
-format PDF
Команда создает два отчета PDF, myProject_BugFinder.PDF и myProject_CodingStandards.PDF. Отчеты хранятся в C:\Polyspace_Workspace\myProject\Module_1\BF_Result\Polyspace-Doc. Дополнительные сведения о содержании отчетов см. в разделе Bug Finder and Code Prover report (-report-template).

При настройке Polyspace Access на использование протокола HTTPS необходимо создать хранилище ключей клиента, в котором хранится SSL-сертификат, используемый Polyspace Access, и настроить polyspace-report-generator использовать это хранилище ключей. См. раздел Создание хранилища ключей клиента (Polyspace Bug Finder 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 Access в командной строке необходимо установить программу Polyspace Bug Finder Server™ или программу Polyspace Code Prover™ Server.

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

Создать 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 хранится в той же папке, что и созданный отчет. Дополнительные сведения о списке экспортированных переменных см. в разделе Просмотр списка экспортированных переменных (средство проверки кода Polyspace).

Входные аргументы

свернуть все

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

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

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

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

Идентификатор выполнения проекта можно просмотреть в веб-интерфейсе Polyspace Access. Для получения идентификатора выполнения используйте команду polyspace-access(Сервер поиска ошибок Polyspace) с опцией -list-project.

ВыборОписание
-format 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 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).

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

-all-units

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

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

-port portNumber

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

-protocol http | https

Протокол HTTP, используемый для подключения к Polyspace Access. Значение по умолчанию: https.
-credentials-file file_path

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

В файле можно сохранить только один набор учетных данных: -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, такого как Дженкинс. Если пользователь обновляет свой пароль, нет необходимости обновлять ключ API, связанный с этим пользователем в сценариях.

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

-login username

-encryted-password ENCRYPTED_PASSWD

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

Дополнительные сведения о команде см. в разделе polyspace-access(Сервер поиска ошибок Polyspace).

Совет

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

См. также

Представлен в R2013b

Документация для поиска ошибок Polyspace

Поддержка