Exponenta Banner

polyspace-results-export

(DOS/UNIX) Polyspace Экспорта заканчивается к внешним форматам, таким как CSV или JSON

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

Синтаксис

polyspace-results-export -format exportFormat -results-dir resultsFolder [OPTIONS]
polyspace-results-export -format exportFormat -host hostName -run-id runID [OPTIONS] [ACCESS_OPTIONS]

Описание

пример

polyspace-results-export -format exportFormat -results-dir resultsFolder [OPTIONS] экспорт результаты анализа Polyspace®, сохраненные локально в resultsFolder к внешнему формату exportFormat.

пример

polyspace-results-export -format exportFormat -host hostName -run-id runID [OPTIONS] [ACCESS_OPTIONS] результаты анализа Polyspace экспорта сохранили в Polyspace доступ к внешнему формату exportFormat. Задайте Polyspace доступ к экземпляру при помощи hostName и проект на Polyspace доступ при помощи runID.

Примеры

свернуть все

Экспорт следует из проекта myProject в пользовательском интерфейсе Polyspace к формату 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 доступ в командной строке, у вас должны быть Polyspace Bug Finder™ Server™ или установка Сервера Polyspace Code Prover™.

Предположим, что вы хотите экспортировать результаты проекта на Polyspace доступ к формату JSON.

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

Если Polyspace доступ к использованию протокол HTTPS, используйте polyspace-report-generator двоичный файл, чтобы сконфигурировать polyspace-results-export включить связи с Polyspace доступ по HTTPS. Смотрите Конфигурируют Генератор отчетов с Клиентом Кеистором.

Экспорт следует из проекта с запущенным ID 16 к формату JSON.

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

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

свернуть все

Формат, в котором экспортируются результаты Polyspace: csv для CSV выход или json-sarif для JSON выход.

Каждый результат состоит из информации, такой как имя результата, семейство, и так далее. Оба результата форматов почти в том же экспортируемом содержимом, но экспортируемом довольном сила относятся к тому же типу информации различными именами.

  • В формате CSV каждый результат состоит из разделенной от вкладки информации в столбцах, таких как ID, Family, Group, Color, Check, и так далее.

    К пакету и потенциально фильтруют ваши данные о результате, используют формат CSV. Например, можно импортировать файл CSV к Microsoft® Excel® и использовать фильтры Excel на результатах.

  • В формате JSON каждый результат состоит почти из той же информации как свойства объектов JSON. Свойства, показанные для результата иногда, используют имя, которое отличается от имени, используемого в формате CSV. Например, чтобы получить полное имя средства проверки правила для результата, используйте ruleId свойство результата в сочетании с id и name свойство правила. Причина различия состоит в том, что формат JSON следует за стандартным обозначением, обеспеченным Форматом обмена результатов статического анализа (SARIF) OASIS.

    Формат JSON содержит некоторую дополнительную информацию, такую как краткое название средства проверки и полное сообщение, которое сопровождает результат. Используйте формат JSON, если вы хотите использовать это краткое название или сообщение. Можно также использовать этот формат для более стандартизированного создания отчетов результатов. Например, если вы используете несколько инструментов статического анализа и хотите сообщить об их результатах в одном интерфейсе при помощи одного алгоритма парсинга, можно экспортировать все результаты в стандартный формат SARIF JSON.

Путь к папке, содержащей результаты анализа Polyspace (.psbf или .pscp файл). Если вы не задаете путь к папке, команда генерирует отчет для результатов анализа в текущей папке.

Пример: C:\Polyspace_Workspace\My_project\Module_1\results

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

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

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

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

ОпцияОписание
- выходное имя outputName

Имя экспортируемого файла. Именем по умолчанию является results_list.txt (CSV) или results_list.json (JSON).

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

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

Чтобы видеть опции, доступные с этой командой, введите polyspace-results-export -h.

ОпцияОписание

- порт portNumber

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

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

Протокол HTTP, чтобы соединить с Polyspace доступ. Значением по умолчанию является https.
- файл учетных данных file_path

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

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

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

- ключ API keyValue

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

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

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

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

- encryted-пароль ENCRYPTED_PASSWD

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

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

Смотрите также

Введенный в R2020b

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

Поддержка