Сравнение показателей с целевыми показателями качества программного обеспечения

Примечание

В этом разделе описывается рабочий процесс в веб-интерфейсе Polyspace Metrics.

Для упрощения совместной работы используйте приложение Polyspace ® Bug Finder™ ^Access™. В дополнение к более интуитивно понятной веб-панели управления, с помощью Polyspace Access можно:

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

Дополнительные сведения см. в документации Polyspace Bug Finder Access.

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

Чтобы сосредоточиться на обзоре, можно:

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

Применение предопределенных целей к метрикам

По умолчанию целевые показатели качества программного обеспечения отключены. для применения целевых показателей качества:

В интерфейсе «Метрики Polyspace» откройте страницу метрик для проекта.
В списке «Цели качества» в левом верхнем углу выберите ON.
Появится новая группа столбцов Цели качества программного обеспечения.
- В столбце Общее состояние (Overall Status) отображается последний используемый целевой уровень качества для создания статуса PASS или FAIL для результатов.
- В столбце Уровень (Level) отображается целевой уровень качества.
  Чтобы изменить целевой уровень качества, в этом столбце выберите ячейку. В раскрывающемся списке выберите уровень качества. Дополнительные сведения см. в разделе Целевые уровни качества поиска ошибок.
Для файлов с общим состоянием FAIL, чтобы увидеть причины сбоя, просмотрите записи в других столбцах «Цели качества программного обеспечения». Отказавшие уровни отмечены красным цветом.
Если значок отображается рядом со статусом, это означает, что у Polyspace недостаточно информации для вычисления статуса. Например, если указать BF-QO-1, некоторые правила кодирования должны быть пересмотрены. Но если не проверить правила кодирования во время анализа, Polyspace не сможет определить, удовлетворяет ли проект целям правил кодирования, указанным в BF-QO-1.
Чтобы проверить несоответствующие цели качества, выберите записи, отмеченные красным цветом, для получения дополнительной информации.
На вкладке «Метрики кода», «Правила кодирования» или «Поиск ошибок»
1. Выберите красные столбцы для загрузки результатов.
2. Просмотрите нарушения и исправьте или обосновайте результаты.
  См. раздел Результаты анализа пространства адресов с помощью исправлений ошибок или обоснований.
3. Загрузите новые обоснования на веб-панель управления Polyspace Metrics.
После просмотра в интерфейсе «Метрики Polyspace» щелкните значок, чтобы просмотреть обновленные метрики.
При изменении кода для обновления показателей повторно запустите анализ и загрузите результаты в репозиторий показателей Polyspace. Если в предыдущих результатах имеются обоснования, перед загрузкой в репозиторий импортируйте их в новые результаты.

Целевые уровни качества поиска ошибок

Цели качества поиска ошибок или BF-QO - это набор пороговых значений, по которым можно сравнить результаты анализа поиска ошибок. Эти цели адаптированы из Polyspace Code Prover™ Software Quality Targets (Polyspace Code Prover). Можно разработать процесс проверки на основе целей качества.

Можно использовать предварительно определенный уровень BF-QO или определить собственный уровень. Ниже приведены предварительно определенные пороговые значения качества, определенные каждым BF-QO.

Уровень 1 BF-QO

Метрика	Пороговое значение
Плотность комментариев в файле	20
Количество путей через функцию	80
Количество `goto` заявления	0
Цикломатическая сложность	10
Количество вызывающих функций	5
Количество вызовов	7
Количество параметров на функцию	5
Количество инструкций на функцию	50
Количество уровней вызовов в функции	4
Количество `return` операторы в функции	1
Языковой объем, показатель стоимости обслуживания или изменения функций. Рассчитывается следующим образом: (N1+N2) / (n1+n2) `n1` - Количество различных операторов `N1` - Общее число операторов `n2` - Количество различных операндов `N2` - Общее количество операндов	4
Количество рекурсий	0
Количество прямых рекурсий	0
Количество необоснованных нарушений следующих правил MISRA C ®: 2004: 5.2 8.11, 8.12 11.2, 11.3 12.12 13.3, 13.4, 13.5 14.4, 14.7 16.1, 16.2, 16.7 17.3, 17.4, 17.5, 17.6 18.4 20.4	0
Количество необоснованных нарушений следующих правил C:2012 МИСРА: 8.8, 8.11 и 8.13 11.1, 11.2, 11.4, 11.5, 11.6 и 11.7 14.1 и 14.2 15.1, 15.2, 15.3 и 15.5 17.1 и 17.2 18.3, 18.4, 18.5 и 18.6 19.2 21.3	0
Количество необоснованных нарушений следующих правил MISRA ® C++: 2-10-2 3-1-3, 3-3-2, 3-9-3 5-0-15, 5-0-18, 5-0-19, 5-2-8, 5-2-9 6-2-2, 6-5-1, 6-5-2, 6-5-3, 6-5-4, 6-6-1, 6-6-2, 6-6-4, 6-6-5 7-5-1, 7-5-2, 7-5-4 8-4-1 9-5-1 10-1-2, 10-1-3, 10-3-1, 10-3-2, 10-3-3 15-0-3, 15-1-3, 15-3-3, 15-3-5, 15-3-6, 15-3-7, 15-4-1, 15-5-1, 15-5-2 18-4-1	0

Уровень 2 и 3 BF-QO

Метрика	Пороговое значение
Количество высокоэффективных дефектов	0

Уровень 4 BF-QO

Метрика	Пороговое значение
Количество средних дефектов воздействия	0

Уровень 5 BF-QO

Метрика	Пороговое значение
Количество необоснованных нарушений следующих правил C:2004 МИСРА: 6.3 8.7 9.2, 9.3 10.3, 10.5 11.1, 11.5 12.1, 12.2, 12.5, 12.6, 12.9, 12.10 13.1, 13.2, 13.6 14.8, 14.10 15.3 16.3, 16.8, 16.9 19.4, 19.9, 19.10, 19.11, 19.12 20.3	0
Количество необоснованных нарушений следующих правил C:2012 МИСРА: 11.8 12.1 и 12.3 13.2 и 13.4 14.4 15.6 и 15.7 16.4 и 16.5 17.4 20.4, 20.6, 20.7, 20.9 и 20.11	0
Количество необоснованных нарушений следующих правил MISRA C++: 3-4-1, 3-9-2 4-5-1 5-0-1, 5-0-2, 5-0-7, 5-0-8, 5-0-9, 5-0-10, 5-0-13, 5-2-1, 5-2-2, 5-2-7, 5-2-11, 5-3-3, 5-2-5, 5-2-6, 5-3-2, 5-18-1 6-2-1, 6-3-1, 6-4-2, 6-4-6, 6-5-3 8-4-3, 8-4-4, 8-5-2, 8-5-3 11-0-1 12-1-1, 12-8-2 16-0-5, 16-0-6, 16-0-7, 16-2-2, 16-3-1	0

Уровень 6 BF-QO

Метрика	Пороговое значение
Количество дефектов с низким ударом	0

Исчерпывающий BF-QO

Метрика	Пороговое значение
Количество необоснованных нарушений правил кодирования MISRA C и MISRA C++	0
Количество необоснованных дефектов	0

Настройка целей качества программного обеспечения

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

Сохраните следующее содержимое в XML-файле. Назовите файл Custom-SQO-Definitions.xml.

<?xml version="1.0" encoding="UTF-8"?>
<MetricsDefinitions>
   
    <SQO ID="Custom-BF-QO-Level" ApplicableProduct="Bug Finder" ApplicableProject="My_Project">
        <comf>20</comf>
        <path>80</path>
        <goto>0</goto>
        <vg>10</vg>
        <calling>5</calling>
        <calls>7</calls>
        <param>5</param>
        <stmt>50</stmt>
        <level>4</level>
        <return>1</return>
        <vocf>4</vocf>
        <ap_cg_cycle>0</ap_cg_cycle>
        <ap_cg_direct_cycle>0</ap_cg_direct_cycle>
        <Num_Unjustified_Violations>Custom_MISRA_Rules_Set</Num_Unjustified_Violations>
        <Num_Unjustified_BF_Checks>Custom_BF_Checks_Set</Num_Unjustified_BF_Checks>
    </SQO>

    <CodingRulesSet ID="Custom_MISRA_Rules_Set">
        <Rule Name="MISRA_C_5_2">0</Rule>
        <Rule Name="MISRA_C_17_6">0</Rule>
    </CodingRulesSet>

    <BugFinderChecksSet ID="Custom_BF_Checks_Set">
        <Check Name="UNREACHABLE">0</Check>
        <Check Name="USELESS_IF">0</Check>
    </BugFinderChecksSet>

</MetricsDefinitions>

Этот файл можно использовать как для поиска ошибок, так и для проверки кода. Сведения о XML-элементах, относящихся к программе проверки кода, см. в разделе Сравнение метрик с целями качества программного обеспечения (программа проверки кода Polyspace).

Сохраните этот XML-файл в папке, в которой хранятся данные удаленного анализа, например: C:\Users\JohnDoe\AppData\Roaming\Polyspace_RLDatas.
Чтобы изменить расположение папки, выберите Метрики > Метрики и параметры удаленного сервера.
Чтобы сделать уровень качества Custom-BF-QO-Level применимо к определенному проекту, замените значение ApplicableProject с именем проекта.
Если необходимо, чтобы цели качества применялись ко всем проектам, используйте ApplicableProject="".

Измените файл, чтобы указать пороговые значения.

Для указания правил кодирования начните имя правила с соответствующей строки, за которой следует номер правила. Использовать _ вместо десятичной запятой в номере правила. Чтобы указать директивы, начните указывать номер директивы с D_, например, MISRA_C3_D4_6, для директивы MISRA C: 2012 4.6.

Правило	Последовательность	Номера правил
MISRA C: 2004	`MISRA_C_`	Правила кодирования MISRA C:2004 и MISRA AC AGC
MISRA C: 2012	`MISRA_C3_`	MISRA C:2012 Директивы и правила
MISRA C++	`MISRA_Cpp_`	Правила MISRA C++: 2008
JSF ® C++	`JSF_Cpp_`	Правила кодирования AV C++ JSF
Пользовательские правила кодирования	`Custom_`	Пользовательские правила кодирования

Для указания дефектов используйте аббревиатуру дефекта. См. Краткие имена чекеров дефектов для поиска ошибок.

Для указания метрик кода используйте акроним метрики кода. См. раздел Краткие имена показателей сложности кода.

После внесения изменений в интерфейсе «Метрики Polyspace» откройте метрики для проекта. В списке «Цели качества» в левом верхнем углу выберите ON.
На вкладке Сводка выберите запись в столбце Уровень. Для указанного имени проекта в раскрывающемся списке появится новая цель качества Custom-BF-QO-Level.
Выберите новую цель качества.
Программа сравнивает указанные пороговые значения с результатами и обновляет столбец Общее состояние с помощью команд PASS или FAIL.
Чтобы определить другой набор пользовательских целей качества, добавьте следующее содержимое в Custom-BF-QO-Definitions.xml файл:
```
<SQO ID="Custom-BF-QO-Level_2" ParentID="Custom-BF-QO-Level" ApplicableProduct="Bug Finder" ApplicableProject="My_Project">
 ...
</SQO>
```
- ID представляет имя нового аппарата.
  Нельзя иметь одинаковые значения ID и ApplicableProject для двух различных наборов целей качества. Например, при использовании ID="Custom-BF-QO-Level" для двух различных пользовательских наборов, и ApplicableProject является либо My_Project или "" для обоих наборов отображается следующая ошибка:
```
The SQO level 'Custom-BF-QO-Level' is multiply defined.
```
- ParentID указывает другой уровень, от которого текущий уровень наследует цели качества. В предыдущем примере уровень Custom-BF-QO-Level_2 наследует цели качества от уровня Custom-BF-QO-Level.
  Если не требуется наследовать цели качества от другого уровня, пропустите этот атрибут.
- ... представляет дополнительные пороговые значения качества, указанные для уровня Custom-BF-QO-Level_2.
  Заданные пороговые значения качества переопределяют пороговые значения, Custom-BF-QO-Level_2 наследует от Custom-BF-QO-Level. Например, если указать <goto>1</goto>, эта цель переопределяет пороговую спецификацию <goto>0</goto> из Custom-BF-QO-Level.

Элементы в пользовательских целевых файлах качества

Метрики HIS
Показатели, не относящиеся к HIS

В следующих таблицах перечислены элементы XML, которые могут быть добавлены в пользовательский файл BF-QO. Содержимое каждого элемента определяет пороговое значение, с которым программное обеспечение сравнивает результаты анализа. Для каждого элемента в таблице отображается метрика, к которой применяется пороговое значение. Здесь HIS ссылается на программное обеспечение Hersteller Initiative.

Метрики HIS

Элемент	Метрика
`comf`	`Comment Density`(Доказательство кода Polyspace)
`path`	`Number of Paths`(Доказательство кода Polyspace)
`goto`	`Number of Goto Statements`(Доказательство кода Polyspace)
`vg`	`Cyclomatic Complexity`(Доказательство кода Polyspace)
`calling`	`Number of Calling Functions`(Доказательство кода Polyspace)
`calls`	`Number of Called Functions`(Доказательство кода Polyspace)
`param`	`Number of Function Parameters`(Доказательство кода Polyspace)
`stmt`	`Number of Instructions`(Доказательство кода Polyspace)
`level`	`Number of Call Levels`(Доказательство кода Polyspace)
`return`	`Number of Return Statements`(Доказательство кода Polyspace)
`vocf`	`Language Scope`(Доказательство кода Polyspace)
`ap_cg_cycle`	`Number of Recursions`(Доказательство кода Polyspace)
`ap_cg_direct_cycle`	`Number of Direct Recursions`(Доказательство кода Polyspace)
`Num_Unjustified_Violations`	Количество необоснованных нарушений правил кодирования, указанных записями под элементом `CodingRulesSet`
`Num_Unjustified_BF_Checks`	Количество необоснованных дефектов типов, указанных записями под элементом `BugFinderChecksSet`

Показатели, не относящиеся к HIS

Элемент	Описание метрики
`fco`	`Estimated Function Coupling`(Доказательство кода Polyspace)
`flin`	`Number of Lines Within Body`(Доказательство кода Polyspace)
`fxln`	`Number of Executable Lines`(Доказательство кода Polyspace)
`ncalls`	`Number of Call Occurrences`(Доказательство кода Polyspace)

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