polyspace-access

(DOS/UNIX) Управляет загрузкой, или экспорт Polyspace следует из Polyspace доступ к веб-интерфейсу

Описание

пример

polyspace-access -host hostname [configuration options] -create-project projectFolder создает папку проекта в веб-интерфейсе Polyspace® Access. Папка может быть наверху иерархии проекта или подпапки под существующей папкой проекта.

пример

polyspace-access -host hostname [configuration options] -upload pathToFolderOrZipFile [upload options] Polyspace загрузок следует из папки или заархивированного файла к базе данных Access Polyspace. Используйте upload options задавать папку проекта кроме public.

пример

polyspace-access -host hostname [configuration options] -export findingsToExport -output filePath [export options] проект экспорта следует из проекта в базе данных Access Polyspace к текстовому файлу, местоположение которого вы задаете с filePath. Вы задаете проект с помощью или полного пути в Polyspace доступ или ID запуска. Используйте эту команду, чтобы экспортировать результаты в другие инструменты, которые вы используете для пользовательских отчетов. Чтобы получить пути к проектам и их последним идентификаторам запуска, используйте polyspace-access команда с -list-project команда.

пример

polyspace-access -host hostname [configuration options] -set-unassigned-findings findingsToAssign -owner userToAssign -source-contains pattern [set unassigned findings options] владельцы присвоений к неприсвоенным результатам в проекте в базе данных Access Polyspace. Вы задаете проект с помощью или полного пути в Polyspace доступ или ID запуска. Используйте set unassigned findings options присваивать результаты от групп файлов другого источника или различных групп исходных файлов различным владельцам. Чтобы получить пути к проектам и их последним идентификаторам запуска, используйте polyspace-access команда с -list-project команда.

пример

polyspace-access -host hostname [configuration options] -list-project [findingsPath] без дополнительного аргумента findingsPath перечисляет пути ко всем проектам в базе данных Access Polyspace и их последних идентификаторах запуска. Если вы задаете полный путь к проекту с аргументом findingsPath, списки команд последний ID запуска.

пример

polyspace-access -host hostname [configuration options] -set-role role -user username -project-path projectFolderOrFindingsPath присваивает роль role пользователю, заданному username для заданной папки проекта или проекта. Пользовательский ролевой набор для папки проекта применяется ко всем результатам проекта под той папкой. Вы задаете проект с помощью или полного пути в Polyspace доступ или последнего ID запуска. Чтобы получить пути к проектам и их последним идентификаторам запуска, используйте polyspace-access команда с -list-project команда.

polyspace-access -host hostname [configuration options] -unset-role -user username -project-path projectFolderOrFindingsPath удаляет любую роль, ранее присвоенную username для заданной папки проекта или проекта. Вы задаете проект с помощью или полного пути в Polyspace доступ или последнего ID запуска. Чтобы получить пути к проектам и их последним идентификаторам запуска, используйте polyspace-access команда с -list-project команда.

пример

polyspace-access -encrypt-password шифрует пароль, который вы используете, чтобы регистрировать в Polyspace доступ. Используйте выход этой команды в качестве аргумента -encrypted-password опция, когда вы пишете скрипты автоматизации, чтобы взаимодействовать с Polyspace доступ.

пример

polyspace-access -generate-migration-commands metrics_dir -output-folder-path dir [generate migration commands options] генерирует скрипты, чтобы переместить проекты от пути metrics_dir в Метриках Polyspace к Polyspace доступ. Команда хранит скрипты в dir. Чтобы задать который результаты проекта мигрировать, используйте generate migration commands options.

пример

polyspace-access -host hostname [configuration options] -migrate -option-file-path dir [-dryrun] перемещает проекты от Метрик Polyspace до Polyspace доступ к использованию скриптов, сгенерированных с -generate-migration-commands команда. Чтобы просмотреть, какие проекты перемещаются, на самом деле не перемещая проекты, используйте -dryrun опция.

Примеры

свернуть все

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

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

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

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

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

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

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

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

Создайте папку Restricted проекта наверху иерархии проекта.

polyspace-access -host my-company-server -port 1234 ^
-create-project Restricted

Роли пользователя аппарата для пользователей aUser и bUser, то, чтобы разрешать их получить доступ к папке проекта как к факторам.

polyspace-access -host my-company-server ^
-port 1234 -set-role contributor ^
-user aUser -user bUser -project Restricted
Кроме создателя папки проекта и предыдущих двух пользователей, никакой другой пользователь не может просмотреть или доступ никакие результаты, загруженные на Restricted.

Загрузите результаты проекта под Restricted.

polyspace-access -host my-company-server -port 1234 ^
-upload C:\Polyspace_Workspace\projectName\Module_1 ^
-parent-project Restricted
Загруженные результаты хранятся под Restricted/projectName.

Если вы следуете за компонентно-ориентированным подходом к разработке, можно присвоить аналитические результаты компонентом их соответствующим владельцам.

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

polyspace-access -host my-company-server ^
-list-project

Команда выводит список путей к результатам проекта и их последнего ID запуска.

Connecting to https://my-company-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

Присвойте все красные и оранжевые результаты ошибки времени выполнения владельцу всех файлов в Component_A из проекта vxWorks_demo. Выполните то же присвоение для владельца Component_B. Задавать vxWorks_demo проект, используйте ID запуска.

polyspace-access -host my-company-server ^
-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 my-company-server ^
-export 16 ^
-output C:\Polyspace_Workspace\myResults.csv ^
-output-per-owner 
Команда генерирует файл myResults.csv содержа все результаты из проекта с запущенным ID 16. Команда также генерирует файлы myResutls.csv.A_owner.csv и myResults.csv.B_owner.csv на том же пути к файлу.

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

Сгенерируйте скрипты миграции для проектов, которые вы хотите переместить. Задайте путь к папке местоположения, где проекты хранятся, например, 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. Скрипты хранятся в папке C:\Polyspace_Workspace\toMigrate.

Используйте -dryrun опция, чтобы проверять, какие проекты будут перемещены.

polyspace-access -host my-company-server ^
-migrate -option-file-path ^
C:\Polyspace_Workspace\toMigrate -dryrun
Команда выход содержит список проектов. Смотрите его, чтобы гарантировать, что вы перемещаете правильные проекты.

Чтобы выполнить миграцию, повторно выполните последнюю команду без -dryrun опция.

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

свернуть все

Соединитесь и войдите в систему

hostname соответствует имени хоста, которое вы задаете в URL интерфейса Polyspace Access, например, https://hostnameПорт/metrics/index.html. Если вы не уверены, о котором имени хоста использовать, связываются с вашим Polyspace доступ к администратору. Именем хоста по умолчанию является localhost. Необходимо задать имя хоста со всем polyspace-access команды, кроме -generate-migration-commands и -encrypt-password команды.

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

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

Параметры конфигурации

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

- порт 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 Bug Finder Access) или связываются с вашим Polyspace доступ к администратору.

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

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

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

- encryted-пароль ENCRYPTED_PASSWD

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

Если вы не используете эти две опции, вам предлагают ввести ваши учетные данные в командной строке, если вы не используете -api-key.

Разные опции

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

- выход file_path

Полный путь к файлу, где вы храните команду выходные параметры.

- tmp-dir folder_path

Путь к папке, где вы храните временные файлы, сгенерированные polyspace-access команды. Путем к папке по умолчанию является tmp/ps_results_server на Linux и C:/Users/%username%/AppData/Local/Temp/ps_results_server на Windows.

-log

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

-h

Отобразите справочную информацию для polyspace-access или одна из его команд.

Создайте новую папку

Путь к папке проекта, заданный как строка. Если имя включает пробелы, используйте двойные кавычки. Задайте полный путь к папкам, вложенным под родительской папкой.

Если ваш путь к папке включает папку, которая уже не существует, папка создается.

Пример: -create-project topFolder

Пример: -create-project "topFolder/subFolder/subSubFolder"

Загрузите результаты

Папка или заархивированный путь к файлу, заданный как строка. Папка или заархивированный файл содержат результаты анализа, вы хотите загрузить на Polyspace доступ. Задайте путь папки, содержащей *.psbf, *.pscp, или *.rte файл или путь родительского элемента этой папки, чтобы загрузить несколько аналитических запусков.

Например, для результатов Средства поиска Ошибки сохранен в C:\Polyspace_Workspace\myProject\Module_1\BF_results\ps_results.psbf, задайте путь к BF_results или к Module_1. Если путь включает пробелы, используйте двойные кавычки.

Пример: -upload C:\Polyspace_Workspace\myProject\Module_1\BF_results

Пример: -upload C:\Polyspace_Workspace\myProject\Module_1\ -project projectFolder

Опции, чтобы задать путь к папке проекта, где вы загружаете результаты.

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

- родительский проект projectFolder

Путь родительской папки проекта, под которой вы загружаете результаты проекта. Если вы не задаете родительскую папку проекта, проекты являются загрузкой на папку public.

- проект projectFolderOrFindingsPath

Если FOLDER вы задаете для -upload содержит только один запущенный анализ, например, ps_results.psbf, эта опция является дополнительной. Используйте -project переименовать результаты проекта или не использовать его, чтобы использовать название проекта от вашего анализа Polyspace.

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

Экспортируйте результаты

Путь или ID запуска результатов проекта, которые вы экспортируете. Polyspace присваивает уникальный ID запуска каждому аналитическому запуску, который вы загружаете. Если путь включает пробелы, используйте двойные кавычки. Чтобы получить путь к результатам проекта или в последний раз запустить ID, используйте -list-project.

Пример: -export "public/Examples/Bug_Finder_Example (Bug Finder)"

Пример: -export 4

Путь к файлу, который хранит выход команды, когда вы задаете -output опция. Эта опция обязательна с -export команда.

Пример: -output C:\Polyspace_Workspace\myResults.txt

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

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

- выход file_path

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

-new-findings

Экспортируйте только новые результаты по сравнению с предыдущим анализом (предыдущая загрузка с тем же названием проекта).

-output-per-owner

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

- rte color

Тип RTE, находящего, чтобы экспортировать. Задайте All, Redсерый, Orange, или Green.

Чтобы задать больше чем один аргумент, вызовите опцию для каждого аргумента. Например, -rte Red -rte Orange.

- дефекты impact

Удар результатов ДЕФЕКТОВ, чтобы экспортировать. Задайте All, High, Medium, или Low.

Чтобы задать больше чем один аргумент, вызовите опцию для каждого аргумента. Например, -defects Medium -defects Low.

-custom-coding-rules

Экспортируйте все пользовательские результаты правил кодирования.

-coding-rules

Экспортируйте все результаты правил кодирования.

-code-metrics

Экспортируйте все метрические результаты кода.

-global-variables

Экспортируйте все результаты глобальных переменных.

- состояние анализа status

Рассмотрите состояние результатов, чтобы экспортировать. Задайте New, Unreviewed, Unassigned, Toinvestigate, Tofix, Justified, Noactionplanned, NotadefectДругой, или Annotated.

Чтобы задать больше чем один аргумент, вызовите опцию для каждого аргумента. Например, -review-status Tofix -review-status Toinvestigate.

- серьезность severity

Серьезность результатов, чтобы экспортировать. Задайте All, High, Medium, или Low.

Чтобы задать больше чем один аргумент, вызовите опцию для каждого аргумента. Например, -severity High -severity Low.

- открытые результаты для sqo sqo_level

Цель качества программного обеспечения или уровень SQO, которому нужно удовлетворить. Задайте номер от 1 до 6 для sqo_level. Если вы задаете уровень SQO, polyspace-access команда экспортирует только открытые результаты, которые должны быть зафиксированы или выровнены по ширине, чтобы удовлетворить требованиям этого уровня.

Для получения дополнительной информации об уровнях SQO смотрите Качественные Цели Средства поиска Ошибки (Polyspace Bug Finder Access). Уровни 1 - 6 SQO задают все больше более строгий набор требований, заданных в терминах результатов Polyspace. Требования предопределены, но можно настроить их в Polyspace доступ к веб-интерфейсу.

Например, уровень 2 SQO в Программе автоматического доказательства Кода требует, чтобы у вас не было невыровненных красных проверок. Эта спецификация означает это, если вы используете -open-findings-for-sqo с уровнем выше, чем 2, все красные проверки экспортируются и должны быть впоследствии зафиксированы или выровнены по ширине. Если вы хотите наложить это требование в ранее уровень 1 SQO, можно настроить уровень 1 в Polyspace доступ к веб-интерфейсу.

Можно также использовать комбинацию опций. Например, -coding-rules -severity High экспорт, кодирующий нарушения правила, которые были присвоены состояние High в Polyspace доступ к веб-интерфейсу.

Присвойте результаты

Путь или ID запуска результатов проекта, которые вы присваиваете пользователю. Polyspace присваивает уникальный ID запуска каждому аналитическому запуску, который вы загружаете. Если путь включает пробелы, используйте двойные кавычки. Чтобы получить путь к результатам проекта или в последний раз запустить ID, используйте -list-project.

Пример: -set-unassigned-findings "public/Examples/Bug_Finder_Example (Bug Finder)"

Пример: -set-unassigned-findings 4

Имя пользователя пользователя вы присваиваете как владелец неприсвоенных результатов. Чтобы присвоить несколько владельцев, вызовите опцию для каждого пользователя.

Каждый вызов -owner должен быть соединен с вызовом -source-contains.

Пример: -user jsmith

Шаблон, чтобы соответствовать против пути к файлу исходных файлов проекта. Чтобы совпадать с путями к файлам для всех исходных файлов, используйте -source-contains /.

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

Когда вы вызываете эту опцию несколько раз, каждый экземпляр исключает шаблоны из предыдущих экземпляров. Например, -source-contains foo -source-contains bar соответствия все пути к файлам, которые содержат foo, затем все пути к файлам, которые содержат bar исключая пути, которые содержат foo.

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

Пример: -source-contains main

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

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

- rte color

Тип RTE, находящего, чтобы присвоить. Задайте All, Redсерый, Orange, или Green.

Чтобы задать больше чем один аргумент, вызовите опцию для каждого аргумента. Например, -rte Red -rte Orange.

- дефекты impact

Удар результатов ДЕФЕКТОВ, чтобы присвоить. Задайте All, High, Medium, или Low.

Чтобы задать больше чем один аргумент, вызовите опцию для каждого аргумента. Например, -defects Medium -defects Low.

-custom-coding-rules

Присвойте все пользовательские результаты правил кодирования.

-coding-rules

Присвойте все результаты правил кодирования.

-code-metrics

Присвойте все метрические результаты кода.

-global-variables

Присвойте все результаты глобальных переменных.

- состояние анализа status

Рассмотрите состояние результатов, чтобы присвоить. Задайте New, Unreviewed, Unassigned, Toinvestigate, Tofix, Justified, Noactionplanned, NotadefectДругой, или Annotated.

Чтобы задать больше чем один аргумент, вызовите опцию для каждого аргумента. Например, -review-status Tofix -review-status Toinvestigate.

- серьезность severity

Серьезность результатов, чтобы присвоить. Задайте All, High, Medium, или Low.

Чтобы задать больше чем один аргумент, вызовите опцию для каждого аргумента. Например, -severity High -severity Low.

-dryrun

Команда отображения выход, не делая присвоения. Используйте эту опцию, чтобы проверять, что ваши присвоения правильны.

Перечислите проекты

Путь результатов проекта. Задайте этот дополнительный аргумент с -list-project получить путь и последний ID запуска соответствующих результатов проекта. Если путь включает пробелы, используйте двойные кавычки.

Пример: -list-project "public/Examples/Bug_Finder_Example (Bug Finder)"

Установите и пользовательские роли сброса

Уровень доступа к папке проекта и результатам для пользователя.

  • владелец: Пользователь может переместиться, переименовать, или удалить заданные папки проекта или результаты и рассмотреть их содержимое.

  • фактор: Пользователь может рассмотреть содержимое заданной папки проекта или результатов.

  • запрещенный: Пользователь не может получить доступ к заданной папке проекта или результатам. Установите эту роль ограничивать доступ пользователя к набору результатов проекта в папке проекта, которая доступна для пользователя.

Пример: -set-role contributor

Имя Пользователя доступа Polyspace.

Пример: -user jsmith

Путь папки проекта или результатов проекта. Когда projectFolderOrFindingsPath путь к папке проекта, пользовательская роль, которую вы устанавливаете, применяется ко всем подпапкам и результатам проекта под той папкой. Если путь включает пробелы, используйте двойные кавычки. Чтобы получить папку проекта или путь к результатам, используйте -list-project.

Пример: -project-path "public/Examples/Bug_Finder_Example (Bug Finder)"

Пример: -project-path public

Переместите результаты метрик на Polyspace доступ

Путь папки, содержащей Метрические проекты Polyspace, вы хотите переместить на Polyspace доступ.

Пример: -generate-migration-commands C:\Users\%username%\AppData\Roaming\Polyspace_RLDatas\results-repository

Путь к папке, которая хранит выход -generate-migration-commands. Не задавайте существующую папку.

Пример: local/Polyspace_Workspace/migration_scripts

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

- выходной путь к папке dir

Путь к папке, где вы хотите сохранить сгенерированные командные файлы. Не задавайте существующую папку.

- макс. запуски проекта int

Количество новых аналитических запусков вы хотите мигрировать для каждого проекта. Например, чтобы переместить только последние два аналитических запуска проекта, задайте 2.

- YYYY[-MM[-DD]] "дата проекта после"

Только переместите результаты, которые были загружены на Метрики Polyspace на или после заданной даты.

- продукт productName

Продукт раньше анализировал и производил результаты проекта в виде bug-finder, code-prover, или polyspace-ada.

- аналитический режим mode

Использование режима Analysis, чтобы сгенерировать результаты проекта в виде integration или unit-by-unit.

Введенный в R2019a