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

Примечание

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

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

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

Для получения дополнительной информации см. документацию Polyspace Bug Finder Access.

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

Чтобы сфокусировать свой обзор, вы можете:

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

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

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

В интерфейсе Polyspace Metrics откройте страницу метрики для проекта.
Из списка Quality Objectives в верхнем левом углу выберите ON.
Появится новая группа Software Quality Objectives столбцов.
- В Overall Status столбце показан последний используемый целевой уровень качества для создания статуса PASS или FAIL для результатов.
- В Level столбце показан целевой уровень качества.
  Чтобы изменить целевой уровень качества, в этом столбце выберите камеру. В раскрывающемся списке выберите уровень качества. Для получения дополнительной информации смотрите Bug Finder Quality Object Levels.
Для файлов с Overall Status FAIL, чтобы увидеть, что является причиной отказа, просмотрите записи в других столбцах Software Quality Objectives. Аварийные уровни отмечены красным цветом.
Если значок появляется рядом со статусом, это означает, что Polyspace не имеет достаточной информации для вычисления статуса. Например, если вы задаете BF-QO-1, некоторые правила кодирования должны быть пересмотрены. Но, если вы не проверяете правила кодирования во время анализа, Polyspace не может определить, удовлетворяет ли ваш проект целям правил кодирования, заданным в BF-QO-1.
Чтобы выяснить недостающие цели качества, выберите записи, отмеченные красным цветом, для получения дополнительной информации.
На Code Metrics, Coding Rules или Bug-Finder вкладке
1. Выберите красные столбцы для загрузки результатов.
2. Проверьте нарушения и исправьте или обосновайте результаты.
  Смотрите Адрес Результаты Polyspace через исправления ошибок или обоснования.
3. Загрузите свои новые обоснования на веб-панель управления Polyspace Metrics.
После просмотра в интерфейсе Polyspace Metrics щелкните, чтобы просмотреть обновленные метрики.
Если вы измените код, чтобы обновить метрики, перезапустите анализ и загрузите результаты в репозиторий Polyspace Metrics. Если у вас есть обоснования в предыдущих результатах, импортируйте их в новые результаты перед загрузкой в репозиторий.

Целевые уровни качества Bug Finder

Цели качества Bug Finder или BF-QO являются набором порогов, с которыми можно сравнить результаты анализа Bug Finder. Эти цели адаптированы из Polyspace Code Prover™ целей качества программного обеспечения (Polyspace Code Prover). Можно разработать процесс проверки на основе целей качества.

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

BF-QO Уровень 1

Метрика	Пороговое значение
Плотность комментариев файла	20
Количество путей через функцию	80
Количество `goto` операторы	0
Цикломатическая сложность	10
Количество функций вызова	5
Количество вызовов	7
Количество параметров на функцию	5
Количество инструкций на функцию	50
Количество уровней вызовов в функции	4
Количество `return` операторы в функции	1
Языковые возможности, показатель стоимости обслуживания или изменения функций. Рассчитывается следующим образом: (N1+N2) / (n1+n2) `n1` - Количество различных операторов `N1` - Общее количество операторов `n2` - Количество различных операндов `N2` - Общее количество операндов	4
Количество рекурсий	0
Количество прямых рекурсий	0
Число необоснованных нарушений нижеследующего МИСРА С^®: правила 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 MISRA: 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

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

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

BF-QO Уровень 4

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

BF-QO Уровень 5

Метрика	Пороговое значение
Число необоснованных нарушений следующих правил C:2004 MISRA: 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 MISRA: 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

BF-QO Уровень 6

Метрика	Пороговое значение
Количество дефектов с низким влиянием	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>

Вы можете использовать этот файл как для результатов Bug Finder, так и для результатов Code Prover. Для получения информации об элементах XML, характерных для Code Prover, смотрите Сравнение метрики с целями качества программного обеспечения (Polyspace Code Prover).

Сохраните этот XML- файл в папке, в которой хранятся данные удаленного анализа, для примера C:\Users\JohnDoe\AppData\Roaming\Polyspace_RLDatas.
Если необходимо изменить расположение папки, выберите Metrics > Metrics and Remote Server Settings.
Чтобы сделать уровень качества 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_`	Пользовательские правила кодирования

Для определения дефектов используйте аббревиатуру дефекта. Смотрите краткие имена Bug Finder Defect Checkers.

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

После внесения изменений в интерфейсе Polyspace Metrics откройте метрики для своего проекта. Из списка Quality Objectives в верхнем левом углу выберите ON.
На вкладке Summary выберите запись в столбце Level. Для заданного имени проекта в раскрывающемся списке появится новое Custom-BF-QO-Level цели качества.
Выберите новую цель качества.
Программа сравнивает указанные пороги с результатами и обновляет столбец Overall Status на 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 Code Prover)
`path`	`Number of Paths` (Polyspace Code Prover)
`goto`	`Number of Goto Statements` (Polyspace Code Prover)
`vg`	`Cyclomatic Complexity` (Polyspace Code Prover)
`calling`	`Number of Calling Functions` (Polyspace Code Prover)
`calls`	`Number of Called Functions` (Polyspace Code Prover)
`param`	`Number of Function Parameters` (Polyspace Code Prover)
`stmt`	`Number of Instructions` (Polyspace Code Prover)
`level`	`Number of Call Levels` (Polyspace Code Prover)
`return`	`Number of Return Statements` (Polyspace Code Prover)
`vocf`	`Language Scope` (Polyspace Code Prover)
`ap_cg_cycle`	`Number of Recursions` (Polyspace Code Prover)
`ap_cg_direct_cycle`	`Number of Direct Recursions` (Polyspace Code Prover)
`Num_Unjustified_Violations`	Количество необоснованных нарушений правил кодирования, заданных записями под элементом `CodingRulesSet`
`Num_Unjustified_BF_Checks`	Количество необоснованных дефектов типов, заданных записями под элементом `BugFinderChecksSet`

Метрики, отличные от HIS

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

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