Примечание
В этом разделе описывается рабочий процесс в веб-интерфейсе Polyspace Metrics.
Для более простых совместных обзоров используйте Polyspace® Bug Finder™ Access™. В дополнение к более интуитивно понятной веб-приборной панели, с Polyspace Access можно:
Просмотрите и разъясните результаты непосредственно из веб-браузера.
Интеграция инструмента отслеживания дефектов, такого как Jira, с веб-интерфейсом и создание билетов для отслеживания результатов Polyspace.
Делитесь результатами анализа с помощью веб- ссылок.
Для получения дополнительной информации см. документацию Polyspace Bug Finder Access.
Polyspace Metrics - это веб-панель мониторинга, которая отображает метрики качества кода из результатов анализа. Используя эту инструментальную панель, можно:
Отслеживайте улучшения или регрессию в качестве кода с течением времени.
Предоставьте менеджерам высокоуровневый обзор качества вашего кода.
Сравните свой код с целями качества.
Сузьте обзор анализа до критических результатов.
Прежде чем вы сможете просмотреть свой проект в Polyspace Metrics, вы должны загрузить результаты в Polyspace Metrics.
Вы можете открыть интерфейс метрики одним из следующих способов:
Если у вас установлен Polyspace, выберите Metrics > Open Metrics.
Если у вас нет установленного Polyspace, откройте веб-браузер и введите следующий URL-адрес:
protocol://ServerName: PortNumber
protocol является либо http (по умолчанию) или https.
Для использования HTTPS требуется дополнительное строение. См. раздел Настройка веб-сервера для HTTPS (Polyspace Code Prover).
ServerName - имя или IP-адрес сервера Polyspace Metrics.
PortNumber - номер порта веб-сервера (по умолчанию 8080).
Когда откроется веб-интерфейс Polyspace Metrics, в репозитории появится список результатов. Можно просмотреть эти результаты по проекту или по запуску.
На вкладке Projects перечислены загруженные результаты по проектам. На этой вкладке можно:
Смотрите количество выполненных проектов и общую статистику о проекте, наведя курсор на имя проекта.
Смотрите метрики уровня проекта, щелкнув правой кнопкой мыши заголовки столбцов и добавив дополнительные столбцы: Bug Finder Checks, Coding Rules, Code Metrics, Ошибки Времени Выполнения или Review Progress.
Создайте группы проектов, щелкнув правой кнопкой мыши проект и выбрав Create Project Category. Перетащите проекты в новую категорию.
Фильтрация проектов с использованием заголовков столбцов.
Удалите проекты из репозитория Metrics, щелкнув правой кнопкой мыши проект и выбрав Delete Project from Repository.
Присвойте или измените пароль для проекта, щелкнув правой кнопкой мыши проект и выбрав Change/Set Password.
Просмотрите метрики качества кода для проекта, нажав на проект. Для получения дополнительной информации смотрите Polyspace Metrics Interface.
На вкладке Runs перечислены отдельные запуски для всех проектов. На этой вкладке можно:
Удалите запуск из репозитория, щелкнув правой кнопкой мыши по запуску и выбрав Delete Run from Repository.
Присвойте пароль для выполнения, щелкнув правой кнопкой мыши запуск и выбрав Change/Set Password.
Просмотр запусков между двумя определенными датами путем выбора начальной даты в поле From и конечной даты в поле To.
Смотрите только последнюю n выполняется путем изменения значения поля Maximum number of runs.
Смотрите метрики качества кода для запуска, щелкнув правой кнопкой мыши по запуску и выбрав Go to Metrics Page.
Загрузите результаты выполнения в пользовательский интерфейс Polyspace, щелкнув имя запуска.
Для каждого проекта или анализа можно просмотреть метрики качества кода, расположенные на четырех вкладках, на уровне проекта, файла и функции. Выберите проект, и вы увидите четыре вкладки:
Вкладка Summary предоставляет высокоуровневый обзор результатов верификации.
Вкладка Code Metrics содержит подробные сведения о метриках сложности кода в результатах.
Вкладка Coding Rules содержит подробную информацию о нарушениях правил кодирования в результатах.
Вкладка Bug Finder содержит подробную информацию о дефектах кода в ваших результатах.
Если вы хотите сравнить метрики с целями качества программного обеспечения, перед рассмотрением результатов можно включить цели качества.
Щелкните запись на вкладке Summary. При нажатии на запись для получения дополнительной информации откроется соответствующая вкладка.
На Code Metrics, Coding Rules или Run-Time Errors вкладках выберите запись для загрузки результата в пользовательский интерфейс Polyspace.
Результаты отображаются на панели Results List в пользовательском интерфейсе Polyspace. Фильтр Show > Web checks на этой панели указывает, что вы загрузили результаты из Polyspace Metrics.
В пользовательском интерфейсе Polyspace проверьте конкретный результат, исследуйте первопричину в исходном коде и назначьте комментарии и обоснования для проверки.
Чтобы загрузить комментарии и обоснования в репозиторий Polyspace Metrics, выберите Metrics > Upload to Metrics.
Совет
Чтобы автоматически загрузить ваши комментарии и обоснования в репозиторий Polyspace Metrics при их сохранении:
Выберите Tools > Preferences.
На вкладке Server Configuration выберите Save justifications in the Polyspace Metrics repository.
В интерфейсе Polyspace Metrics щелкните
, чтобы просмотреть новые загруженные метрики.
Используя интерфейс Polyspace Metrics, можно отслеживать улучшения или регрессию в метриках качества кода во время различных запусков на том же исходном коде.
Чтобы просмотреть тренды в метриках, загрузите различные версии результатов в репозиторий Polyspace Metrics.
Откройте интерфейс Polyspace Metrics.
Для получения дополнительной информации смотрите Open Metrics Interface.
На вкладке Projects выберите проект, для которого необходимо просмотреть тренды.
Метрики качества кода для всех версий проекта появляются на Summary, Code Metrics, Coding Rules и Bug-Finder вкладках.
Сравнение двух версий одного и того же проекта:
В From и To списках в верхней левой части веб-панели инструментов выберите две версии, которые необходимо сравнить.
Выберите поле Compare.
На каждой вкладке появляются новые столбцы, а существующие столбцы отображают улучшение или регрессию в метрике. Для примера на рисунке ниже отображается новый столбец All Metrics Trend, который появляется на вкладке Summary. В этом столбце описывается сравнение метрик в группе Bug-Finder с двумя версиями проекта.
А
означает, что метрики лучше.
А
значит, что метрика хуже.
Смешение
в All Metrics Trend столбце означает, что некоторые метрики улучшились, а некоторые не улучшились.
Чтобы увидеть только новые результаты в версии по сравнению с предыдущей версией:
В From и To списках в верхней левой части веб-панели инструментов выберите две версии, которые необходимо сравнить.
Выберите поле New Findings Only.
В существующих столбцах отображаются только новые результаты. В сложение вы также видите два новых столбцов:
В Newly Confirmed столбце показаны новые выводы, которым вы присваиваете Severity High, Medium, или Low в пользовательском интерфейсе Polyspace.
В Newly Fixed столбце показаны те выводы, которым вы присвоили Severity High, Medium, или Low в предыдущем запуске. Однако назначение не существует в текущем запуске, поскольку красный или оранжевый чек стал зеленым, или потому, что вы изменили Severity на Unset.
Если вы включаете Software Quality Targets, каждая вкладка также определяет, как ваш проект или запуск сравнивается с этими целями. См. Сравнение метрик с целями качества программного обеспечения.
На вкладке Summary представлены результаты анализа для проекта или запуска.
| Имя столбца | Описание | |
|---|---|---|
| Verification | Номер версии результатов и исходных файлов. | |
| Verification Status | Уровень анализа завершен. | |
| Code Metrics | Files | Количество файлов в проекте. |
| Lines of code | Количество строк кода, с разбивкой по файлам. | |
| Coding Rules | Confirmed Defects | Количество нарушений правил кодирования, назначенных Severity |
| Violations | Общее количество нарушений правил кодирования. Статистика для AUTOSAR C++ 14, CERT® Нарушения стандартов кодирования C, CERT C++ и ISO/IEC TS 17961 недоступны в интерфейсе Polyspace Metrics. | |
| Bug-Finder Checks | Confirmed Defects | Количество дефектов, присвоенных Severity |
| Checks | Общее количество дефектов. | |
| Software Quality Objectives | Overall Status | Статус PASS или FAIL зависит от того, удовлетворяет ли ваш код заданным вами целям качества программного обеспечения. |
| Level | Заданные вами цели качества программного обеспечения. Можно либо использовать предопределенный набор целей, либо задать свои собственные цели. | |
| Review Progress | Количество или процент обоснованных результатов. Для обоснования результата необходимо назначить Status в пользовательском интерфейсе Polyspace. | |
| Justified Code Metrics | Количество или процент обоснованных нарушений порога метрики кода. Для обоснования результата необходимо назначить Status в пользовательском интерфейсе Polyspace. | |
| Justified Coding Rules | Количество или процент нарушений правил кодирования, которые вы обосновали. Для обоснования результата необходимо назначить Status в пользовательском интерфейсе Polyspace. | |
| Justified Bug-Finder Checks | Количество или процент дефектов, которые вы оправдали. Для обоснования результата необходимо назначить Status в пользовательском интерфейсе Polyspace. | |
На вкладке Code Metrics перечислены метрики сложности кода для вашего проекта или запуска.
Некоторые метрики вычисляются на уровне проекта, другие вычисляются на уровне файла или функции. Для метрик, вычисленных на уровне функции, запись, отображаемая для файла, является либо агрегированной, либо максимальной по сравнению с функциями в файле.
Для получения дополнительной информации см. Раздел «Метрики кода».
На вкладке Coding Rules перечислены нарушения правил кодирования в проекте или запуске. Для получения дополнительной информации о правилах кодирования смотрите Стандарты кодирования.
Вы не можете просмотреть результаты для этих стандартов кодирования в интерфейсе Polyspace Metrics.
AUTOSAR C++ 14.
CERT C.
CERT C++.
ISO/IEC TS 17961.
Чтобы просмотреть нарушения правил кодирования для этих стандартов, используйте интерфейс рабочего стола Polyspace Bug Finder или Polyspace Access (Polyspace Bug Finder Access).
Можно сгруппировать информацию в столбцы по Files или Coding Rules.
| Имя столбца | Описание | |
|---|---|---|
| Coding Rules | Confirmed Defects | Количество нарушений правил кодирования, назначенных Severity |
| Justified | Количество обоснованных нарушений правил кодирования. Для обоснования результата необходимо назначить Status в пользовательском интерфейсе Polyspace. | |
| Violations | Общее количество нарушений правил кодирования. | |
| Software Quality Objectives | Quality Status | Статус PASS или FAIL зависит от того, удовлетворяет ли ваш код заданным вами целям качества программного обеспечения. |
| Level | Заданные вами цели качества программного обеспечения. Можно либо использовать предопределенный набор целей, либо задать свои собственные цели. | |
| Review Progress | Количество или процент обоснованных нарушений правил кодирования. Для обоснования результата необходимо назначить Status в пользовательском интерфейсе Polyspace. | |
На вкладке Bug-Finder перечислены дефекты в проекте или запуске.
Можно сгруппировать информацию в столбцы по Files или Bug-Finder Checkers.
| Имя столбца | Описание | |
|---|---|---|
| Confirmed Defects | Количество или процент дефектов, присвоенных Severity Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования. | |
| Bug-Finder Checks | Justified | Количество или процент обоснованных дефектов. Для обоснования результата необходимо назначить Status в пользовательском интерфейсе Polyspace. |
| Checks | Общее количество проверок. | |
| High | Общее количество дефектов высокой ударной вязкости. | |
| Medium | Общее количество дефектов среднего влияния. | |
| Low | Общее количество дефектов с низким влиянием. | |
| Software Quality Objectives | Quality Status | Статус PASS или FAIL зависит от того, удовлетворяет ли ваш код заданным вами целям качества программного обеспечения. |
| Level | Заданные вами цели качества программного обеспечения. Можно либо использовать предопределенный набор целей, либо задать свои собственные цели. | |
| Review Progress | Количество или процент обоснованных дефектов. Для обоснования результата необходимо назначить Status в пользовательском интерфейсе Polyspace. | |
