Примечание
В этом разделе описывается рабочий процесс в веб-интерфейсе Polyspace Metrics.
Для упрощения совместной работы используйте приложение Polyspace ® Bug Finder™ Access™. В дополнение к более интуитивно понятной веб-панели управления, с помощью Polyspace Access можно:
Просмотр и обоснование результатов непосредственно из веб-браузера.
Интеграция инструмента отслеживания дефектов, такого как Jira, с веб-интерфейсом и создание билетов для отслеживания результатов Polyspace.
Обмен результатами анализа с помощью веб-ссылок.
Дополнительные сведения см. в документации Polyspace Bug Finder Access.
Polyspace Metrics - это веб-панель мониторинга, которая отображает метрики качества кода из результатов анализа. С помощью этой панели мониторинга можно выполнять следующие действия:
Отслеживание улучшений или регрессии качества кода с течением времени.
Предоставьте руководителям общий обзор качества кода.
Сравните код с целями качества.
Сократите анализ до критических результатов.
Перед просмотром проекта в Полиспейс (Polyspace Metrics) необходимо загрузить результаты в Полиспейс (Polyspace Metrics).
Открыть интерфейс метрик можно одним из следующих способов.
Если установлено приложение Polyspace, выберите «Метрики» > «Открыть метрики».
Если программа Polyspace не установлена, откройте веб-браузер и введите следующий URL-адрес:
protocol:// ServerName: PortNumber
protocol является либо http (по умолчанию) или https.
Для использования HTTPS требуется дополнительная конфигурация. См. раздел Настройка веб-сервера для HTTPS (средство проверки кода Polyspace).
ServerName - это имя или IP-адрес сервера Polyspace Metrics.
PortNumber номер порта веб-сервера (по умолчанию 8080).
При открытии веб-интерфейса Polyspace Metrics в репозитории отображается список результатов. Эти результаты можно просмотреть по проекту или по прогону.
На вкладке Проекты (Projects) перечислены загруженные результаты по проектам. На этой вкладке можно:
Просмотрите количество прогонов проекта и общую статистику проекта, наведя курсор на имя проекта.
См. метрики уровня проекта, щелкнув правой кнопкой мыши заголовки столбцов и добавив дополнительные столбцы: «Проверки поиска ошибок», «Правила кодирования», «Метрики кода», «Ошибки времени выполнения» или «Обзор хода выполнения».
Создайте группы проектов, щелкнув проект правой кнопкой мыши и выбрав «Создать категорию проекта». Перетащите проекты в новую категорию.
Фильтрация проектов с использованием заголовков столбцов.
Удалите проекты из репозитория Metrics, щелкнув проект правой кнопкой мыши и выбрав команду Удалить проект из репозитория.
Назначьте или измените пароль для проекта, щелкнув проект правой кнопкой мыши и выбрав команду «Изменить/Задать пароль».
Просмотрите метрики качества кода для проекта, щелкнув проект. Дополнительные сведения см. в разделе Интерфейс метрик Polyspace.
На вкладке «Прогоны» перечислены отдельные прогоны для всех проектов. На этой вкладке можно:
Удалите прогон из репозитория, щелкнув его правой кнопкой мыши и выбрав Удалить прогон из репозитория.
Назначьте пароль для запуска, щелкнув его правой кнопкой мыши и выбрав Изменить/задать пароль.
Для просмотра прогонов между двумя определенными датами выберите начальную дату в поле С и конечную дату в поле По.
Увидеть только последний n выполняется путем изменения значения поля Максимальное число запусков.
См. метрики качества кода для прогона, щелкнув его правой кнопкой мыши и выбрав Перейти на страницу показателей.
Загрузите результаты выполнения в интерфейс пользователя Polyspace, щелкнув имя выполнения.
Для каждого проекта или анализа можно просмотреть метрики качества кода на четырех вкладках на уровне проекта, файла и функции. Выберите проект и увидите четыре вкладки:
На вкладке Сводка представлен общий обзор результатов проверки.
На вкладке Метрики кода (Code Metrics) представлены подробные сведения о метриках сложности кода в результатах.
На вкладке Правила кодирования представлены подробные сведения о нарушениях правил кодирования в результатах.
На вкладке Поиск ошибок представлены подробные сведения о дефектах кода в результатах поиска.
Если необходимо сравнить метрики с целевыми показателями качества программного обеспечения, перед просмотром результатов можно включить целевые показатели качества.
Щелкните запись на вкладке Сводка. При щелчке по записи появится соответствующая закладка для получения более подробной информации.
На вкладках «Метрики кода», «Правила кодирования» или «Ошибки времени выполнения» выберите запись для загрузки результата в интерфейс пользователя Polyspace.
Результаты появятся на панели Список результатов (Results List) в интерфейсе пользователя Polyspace. Фильтр Показать (Show) > Веб-проверки на этой панели показывает, что были загружены результаты из параметров Polyspace.
В интерфейсе пользователя Polyspace просмотрите конкретный результат, изучите основную причину в исходном коде и назначьте комментарии и обоснования для проверки.
Чтобы загрузить комментарии и обоснования в репозиторий метрик Polyspace, выберите Метрики > Загрузить в метрики.
Совет
Чтобы автоматически загружать комментарии и обоснования в репозиторий метрик Polyspace при их сохранении, выполните следующие действия.
Выберите «Сервис» > «Установки».
На вкладке Конфигурация сервера выберите Сохранить обоснования в репозитории метрик Polyspace.
В интерфейсе Polyspace Metrics щелкните
, чтобы просмотреть вновь загруженные метрики.
С помощью интерфейса Полиспейс (Polyspace Metrics) можно отслеживать улучшения или регрессию метрик качества кода в различных запусках одного и того же исходного кода.
Чтобы просмотреть тенденции в метриках, загрузите различные версии результатов в репозиторий метрик Polyspace.
Откройте интерфейс «Параметры Polyspace».
Дополнительные сведения см. в разделе Открытие интерфейса метрик.
На вкладке Проекты выберите проект, для которого требуется просмотреть тренды.
Показатели качества кода для всех версий проекта отображаются на вкладках Сводка (Summary), Метрика кода (Code Metrics), Правила кодирования (Coding Rules) и Поиск ошибок (Bug-Finder).
Для сравнения двух версий одного проекта:
В списках От и До в левом верхнем углу веб-панели мониторинга выберите две версии, которые требуется сравнить.
Выберите поле Сравнить (Compare).
На каждой вкладке появляются новые столбцы, а существующие столбцы отображают улучшение или регрессию в метрике. Например, на рисунке ниже отображается новый столбец «Все показатели тренда», который отображается на вкладке «Сводка». В этом столбце описывается сравнение метрик в группе Bug-Finder в двух версиях проекта.
А
означает, что показатели лучше.
А
означает, что метрика хуже.
Смешанный
показатель в столбце All Metrics Trend означает, что некоторые показатели улучшились, а некоторые не улучшились.
Чтобы увидеть только новые выводы в версии по сравнению с предыдущей версией:
В списках От и До в левом верхнем углу веб-панели мониторинга выберите две версии, которые требуется сравнить.
Установите флажок «Только новые результаты».
В существующих столбцах отображаются только новые результаты. Кроме того, появятся два новых столбца:
В столбце «Вновь подтвержденные» показаны новые результаты, которым назначается степень серьезности High, Medium, или Low в интерфейсе пользователя Polyspace.
В столбце New Fixed показаны результаты, которым вы присвоили степень серьезности High, Medium, или Low в предыдущем прогоне. Однако это назначение не существует в текущем прогоне либо потому, что проверка красного или оранжевого цвета стала зеленой, либо потому, что была изменена степень серьезности на Unset.
При включении параметра «Цели качества программного обеспечения» на каждой вкладке также указывается, как проект или запуск сравниваются с этими целями. См. раздел Сравнение показателей с целями качества программного обеспечения.
На вкладке Сводка (Summary) представлены результаты анализа для проекта или прогона.
| Имя столбца | Описание | |
|---|---|---|
| Проверка | Номер версии результатов и исходных файлов. | |
| Состояние проверки | Уровень анализа завершен. | |
| Метрики кода | Файлы | Количество файлов в проекте. |
| Строки кода | Количество строк кода с разбивкой по файлам. | |
| Правила кодирования | Подтвержденные дефекты | Количество нарушений правил кодирования, которым назначена степень серьезности |
| Нарушения | Общее число нарушений правил кодирования. Статистика нарушений стандартов кодирования AUTOSAR C++ 14, CERT ® C, CERT C++ и ISO/IEC TS 17961 отсутствует в интерфейсе Polyspace Metrics. | |
| Проверки поиска ошибок | Подтвержденные дефекты | Количество дефектов, присвоенных степени серьезности |
| Проверки | Общее количество дефектов. | |
| Цели обеспечения качества программного обеспечения | Общее состояние | Состояние PASS или FAIL зависит от того, соответствует ли ваш код указанным целям качества программного обеспечения. |
| Уровень | Указанные цели качества программного обеспечения. Можно либо использовать предварительно определенный набор целей, либо указать собственные цели. | |
| Обзор хода выполнения | Число или процент обоснованных результатов. Для выравнивания результата необходимо назначить статус в интерфейсе пользователя Polyspace. | |
| Оправданные метрики кода | Количество или процент оправданных нарушений порога метрики кода. Для выравнивания результата необходимо назначить статус в интерфейсе пользователя Polyspace. | |
| Оправданные правила кодирования | Число или процент нарушений правил кодирования, которые вы обосновали. Для выравнивания результата необходимо назначить статус в интерфейсе пользователя Polyspace. | |
| Оправданные проверки поиска ошибок | Количество или процент дефектов, которые вы обосновали. Для выравнивания результата необходимо назначить статус в интерфейсе пользователя Polyspace. | |
На вкладке «Метрики кода» перечислены метрики сложности кода для проекта или запуска.
Некоторые метрики рассчитываются на уровне проекта, в то время как другие рассчитываются на уровне файла или функции. Для метрик, рассчитанных на уровне функции, элемент, отображаемый для файла, является либо агрегатом, либо максимумом над функциями в файле.
Дополнительные сведения см. в разделе Метрики кода.
На вкладке «Правила кодирования» перечислены нарушения правил кодирования в проекте или прогоне. Дополнительные сведения о правилах кодирования см. в разделе Стандарты кодирования.
Просмотр результатов для этих стандартов кодирования в интерфейсе «Метрики Polyspace» невозможен.
AUTOSAR C++ 14.
CERT C.
CERT C++.
ISO/IEC TS 17961.
Чтобы проверить нарушения правил кодирования для этих стандартов, используйте интерфейс рабочего стола Polyspace Bug Finder или Polyspace Access (Polyspace Bug Finder Access).
Информацию в столбцах можно сгруппировать по файлам или правилам кодирования.
| Имя столбца | Описание | |
|---|---|---|
| Правила кодирования | Подтвержденные дефекты | Количество нарушений правил кодирования, которым назначена степень серьезности |
| Оправданный | Количество подтвержденных нарушений правил кодирования. Для выравнивания результата необходимо назначить статус в интерфейсе пользователя Polyspace. | |
| Нарушения | Общее число нарушений правил кодирования. | |
| Цели обеспечения качества программного обеспечения | Статус качества | Состояние PASS или FAIL зависит от того, соответствует ли ваш код указанным целям качества программного обеспечения. |
| Уровень | Указанные цели качества программного обеспечения. Можно либо использовать предопределенный набор целей, либо указать собственные цели. | |
| Обзор хода выполнения | Число или процент обоснованных нарушений правил кодирования. Для выравнивания результата необходимо назначить статус в интерфейсе пользователя Polyspace. | |
На вкладке Поиск ошибок отображается список дефектов в проекте или прогоне.
Информацию в столбцах можно сгруппировать по файлам или чекерам Bug-Finder.
| Имя столбца | Описание | |
|---|---|---|
| Подтвержденные дефекты | Количество или процент дефектов, которым назначена степень серьезности См. раздел Результаты анализа пространства адресов с помощью исправлений ошибок или обоснований. | |
| Проверки поиска ошибок | Оправданный | Количество или процент обоснованных дефектов. Для выравнивания результата необходимо назначить статус в интерфейсе пользователя Polyspace. |
| Проверки | Общее количество проверок. | |
| Высоко | Общее количество высокоэффективных дефектов. | |
| Среда | Общее количество средних дефектов воздействия. | |
| Низко | Общее количество дефектов с низким ударом. | |
| Цели обеспечения качества программного обеспечения | Статус качества | Состояние PASS или FAIL зависит от того, соответствует ли ваш код указанным целям качества программного обеспечения. |
| Уровень | Указанные цели качества программного обеспечения. Можно либо использовать предварительно определенный набор целей, либо указать собственные цели. | |
| Обзор хода выполнения | Количество или процент обоснованных дефектов. Для выравнивания результата необходимо назначить статус в интерфейсе пользователя Polyspace. | |