Отправьте уведомления по электронной почте результатами Polyspace Code Prover

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

Создание уведомлений по электронной почте

Создать уведомления по электронной почте:

  1. Экспортируйте новые результаты анализа в текстовый файл с разделителями табуляции (.tsv формат.

    Примените фильтры, чтобы экспортировать определенные типы результатов, например, дефектов с высоким ударом. При необходимости можно также применить дополнительные фильтры к экспортируемым файлам с помощью поиска и заменить утилиты. Смотрите Результаты Экспорта для почтовых Прикреплений.

  2. Пошлите электронное письмо с файлом результатов в прикреплении. Для каждого результата прикрепление содержит ссылки, чтобы открыть результат в веб-интерфейсе Polyspace Code Prover™ Access™.

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

Если вы используете плагин Polyspace в Дженкинсе, можно использовать утилиты помощника Polyspace для целого процесса уведомления по электронной почте. См. Демонстрационные Скрипты для Анализа Polyspace с Дженкинсом

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

Необходимые условия

Запускать этот пример:

  • Вы, должно быть, загрузили некоторый результат в интерфейсе Polyspace Code Prover Access. Если вы завершаете учебный Polyspace Code Prover Запуска на Результатах Сервера и Загрузки к веб-интерфейсу, необходимо видеть папку testProject на панели PROJECT EXPLORER. Папка содержит один проект myFirstProject.

    Видеть результаты в проекте, с myFirstProject выбранный, нажмите кнопку Review. Вы видите список проверок на этапе выполнения. Столбец Type показывает цвет проверок. В этом примере только красные проверки будут экспортироваться для почтовых прикреплений.

  • Необходимо смочь взаимодействовать с интерфейсом Polyspace Code Prover Access из командной строки. Например, перейдите к polyspaceserverroot\polyspace\bin и войдите:

    polyspace-access login -list-project

    Здесь. polyspaceserverroot папка установки Polyspace Code Prover Server™, например, C:\Program Files\Polyspace Server\R2020bПеременная login.The относится к следующей комбинации опций. Вы предоставляете эти возможности с каждым использованием polyspace-access команда.

    -host hostName -port portNumber -login username -encrypted-password pwd

    Здесь, hostName имя веб-сервера Polyspace Code Prover Access. Для локально размещенного сервера используйте localhost. portNumber дополнительный номер порта сервера. Если вы не используете номер порта, 9443 используется. username и pwd обратитесь к входу в систему и зашифрованной версии вашего пароля. Создать зашифрованный пароль, введите:

    polyspace-access -encrypt-password

    Скопируйте зашифрованный пароль и предоставьте этому паролю более позднее использование polyspace-access команда.

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

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

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

  • Чтобы экспортировать все результаты, введите следующее:

    polyspace-access login -export testProject/myFirstProject -output .\result.txt

  • Чтобы экспортировать только красные проверки, введите следующее:

    polyspace-access login -export testProject/myFirstProject -rte Red -output .\result_red_checks.txt

Откройте каждый текстовый файл в электронной таблице, просматривающей утилиту, такую как Microsoft® Excel®. В первом файле вы видите все результаты, но во втором файле, вы только видите красные проверки на этапе выполнения. Вместо -rte Red, можно применить другие фильтры.

  • Чтобы видеть только новые результаты по сравнению с предыдущим анализом того же проекта, используйте опцию -new-findings.

  • Чтобы применить более мелкомодульный набор фильтров, можно использовать цели качества программного обеспечения (SQOs). Цели качества программного обеспечения заданы через прогрессивно более строгий набор уровней SQO, пронумерованных от 1 до 6. Можно настроить требования каждого уровня в Polyspace доступ к веб-интерфейсу, и затем использовать опцию -open-findings-for-sqo с номером уровня, чтобы экспортировать только те результаты, которые должны быть рассмотрены, чтобы удовлетворить требования. См. также Цели Качества программного обеспечения (Polyspace Code Prover Access).

Видеть все опции фильтрации, введите:

polyspace-access -h -export

Можно сконфигурировать почтовую утилиту, чтобы отправить эти экспортируемые файлы в прикреплении.

При необходимости можно также применить дополнительные фильтры к экспортируемым файлам с помощью поиска и заменить утилиты. Например, используйте поиск и замените утилиты на файле результатов, чтобы включать результаты только из определенных файлов и функций. В Linux® можно использовать grep и sed сохранить только результаты в определенных файлах.

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

Можно присвоить владельцев результатам в определенных файлах или папках. Можно затем экспортировать один файл результата на владельца и послать электронное письмо каждому владельцу с соответствующим файлом в прикреплении.

Можно присвоить владельцев в веб-интерфейсе Polyspace Code Prover Access или в командной строке.

В этом примере присвойте все результаты в файле example.c к jsmith и все результаты в файле single_file_analysis.c к jboyd.

polyspace-access login -set-unassigned-findings testProject/myFirstProject -owner jsmith -source-contains example.c
polyspace-access login -set-unassigned-findings testProject/myFirstProject -owner jboyd -source-contains single_file_analysis.c

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

polyspace-access login -export testProject/myFirstProject -output .\results.txt -output-per-owner

Эти файлы содержат экспортируемые результаты:

  • results.txt содержит все результаты.

  • results_jsmith.txt и results_jboyd.txt содержит результаты, присвоенные jsmith и jboyd соответственно.

  • results.txt.owners.list содержит список владельцев, в этом случае:

    jsmith
    jboyd

Прежде, чем присвоить владельцев результатам, используйте опцию -dryrun выполнять пробный прогон присвоений. Не выполняя присвоение, опция показывает файлы результатами, которые присвоены и владелец, которому присвоены результаты.

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