Мониторинг метрик кода#

Языковые анализаторы вычисляют различные метрики кода, которые будут использоваться для оценки качества кода:

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

• Метрики кода используются в определении Quality Gates. Например, можно установить условие для общего количества выявленных проблем в коде.

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

Определение метрик#

В этом разделе описаны метрики кода, используемые в данном программном продукте, с разбивкой по категориям.

Сложность#

В таблице ниже перечислены метрики сложности кода.

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

Цикломатическая сложность#

Цикломатическая сложность - это количественная метрика, используемая для подсчета числа путей в графе потока управления программы. Анализатор вычисляет значение этого показателя для данной “функции” (в зависимости от языка, это может быть функция, метод, подпрограмма и т.д.), увеличивая счетчик цикломатической сложности функции на единицу каждый раз, когда поток управления функцией разделяется, что приводит к новой условной ветви. Минимальная сложность каждой функции равна 1. Формула расчета выглядит следующим образом:

cyclomaticComplexity = 1 + numberOfConditionalBranches

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

ABAP#

ABAP-анализатор вычисляет цикломатическую сложность на функциональном уровне. Он увеличивает цикломатическую сложность на единицу каждый раз, когда обнаруживает одно из следующих ключевых слов:

C/C++/Objective-C#

Анализатор C/C++/Objective-C вычисляет цикломатическую сложность на уровне функций и сопрограмм. Он увеличивает цикломатическую сложность на единицу при каждом обнаружении:

C##

Анализатор C# вычисляет цикломатическую сложность на уровнях метода и свойства. Он увеличивает цикломатическую сложность на единицу при каждом обнаружении:

Java#

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

PL/SQL#

Анализатор PL/SQL вычисляет цикломатическую сложность на уровне функций и процедур. Он увеличивает цикломатическую сложность на единицу при каждом обнаружении:

• Главный анонимный блок PL/SQL (не внутренние)

• Один из следующих операторов:

  • CREATE PROCEDURE;

  • CREATE TRIGGER;

  • basic LOOP;

  • WHEN («WHEN» простого оператора CASE и искомого оператора CASE);

  • FOR LOOP;

  • CONTINUE / EXIT WHEN (часть «WHEN» операторов CONTINUE и EXIT)

  • обработчик исключений (каждое отдельное «WHEN»);

  • EXIT;

  • FORLOOP;

  • FORALL;

  • IF;

  • ELSIF;

  • RAISE;

  • WHILELOOP;

• Одно из следующих выражений:

  • AND(«AND» зарезервированное слово, используемое в выражениях PL/SQL);

  • Rexpression («OR» зарезервированное слово, используемое в выражениях PL/SQL);

  • WHEN («WHEN» простого CASE-выражения и искомого CASE-выражения).

JS/TS, PHP#

Анализатор JS/TS вычисляет цикломатическую сложность на функциональном уровне. Анализатор PHP вычисляет цикломатическую сложность на функциональном и классовом уровнях. Оба анализатора увеличивают цикломатическую сложность на единицу при каждом обнаружении:

• Функция (т.е. неабстрактные и неанонимные конструкторы, функции, процедуры или методы);

• Ключевое слово if;

• Замыкающую (она же «ленивая») логическую связку (&&);

• Короткозамкнутая (она же «ленивая») логическая дизъюнкция (||);

• Троичное условное выражение;

• Цикл;

• Пункт case оператора switch;

• Оператор throw или catch;

• Оператор go to (только для PHP).

Покрытие#

В таблице ниже перечислены метрики тестового покрытия, используемые в решении Sonar.

Дублирование#

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

Замечания#

В таблице ниже перечислены метрики замечаний.

Сопровождаемость#

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

Технический долг (Усилие)#

Технический долг (Усилие) - это сумма затрат на устранение замечаний, связанных сопровождением. Затраты на устранение замечаний рассчитываются исходя из затрат, связанных с правилом, из-за которого возникло замечание.

Коэффициент технического долга#

Коэффициент технического долга - это соотношение между затратами на разработку программного обеспечения и техническим долгом (затратами на его исправление). Он рассчитывается по следующей формуле:

technicalDebt /(costToDevelop1lineOfCode * numberOfLinesOfCode), где стоимость разработки одной строки кода предопределена в базе данных (по умолчанию 30 минут, может быть изменена).

Пример:

Технический долг: 122,563
Количество строк кода: 63,987
Стоимость разработки одной строки кода: 30 минут
Коэффициент технического долга: 6,4%

Рейтинг сопровождаемости#

По умолчанию используется шкала рейтинга сопровождаемости:

• A = 0-0.05;

• B = 0.06 - 0.1;

• C = 0.11-0.20;

• D = 0.21-0.5;

• E = 0.51 - 1.

Шкала оценки сопровождаемости может быть определена альтернативным образом. Если непогашенные затраты на восстановление составляют:

• <=5% от времени, которое уже было затрачено на применение, то оценка A;

• от 6 до 10% - оценка B;

• от 11 до 20% - оценка C;

• от 21 до 50% - оценка D;

• свыше 50 % - E;

Quality gate#

Надежность#

Безопасность#

Все метрики безопасности могут быть использованы в Quality Gates, кроме метрики Security hotspots.

Обзор безопасности#

Размер#

Мониторинг метрик кода в проекте#

Чтобы просмотреть значения всех показателей кода в проекте:

1. Перейдите в нужный проект;

2. На панели навигации проекта выберите Показатели;

Чтобы просмотреть историю значений одной или нескольких метрик кода в проекте:

1. Выберите проект, который хотите отслеживать.

2. На панели навигации по проекту выберите Активность. Количество проблем показано на графике.

3. Чтобы изменить отображаемые показатели, нажмите Замечания и выберите другую категорию показателей в раскрывающемся списке.

4. Если необходимо отслеживать другие метрики, выберите Собственный: появится раскрывающийся список Добавить метрику. Затем нажмите Добавить метрику и выберите в раскрывающемся списке метрику(и), которую(ые) хотите отслеживать. Выбранные метрики отображаются на одном или нескольких графиках, чтобы пользователь мог их сравнить.

Изменение параметров, связанных с техническими долгами#

Некоторые параметры, связанные с показателями сопровождаемости, могут быть изменены в пользовательском интерфейсе на глобальном уровне при наличии разрешения на администрирование системы. Альтернативно возможно задать соответствующее свойство sonar на хосте CI/CD.

Изменение расчета стоимости разработки программного обеспечения#

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

1. В верхней навигационной панели CodeScanner выберите Администрирование -> Конфигурация -> Общие настройки -> Технический долг;

2. В разделе Стоимость разработки измените значения (в минутах).

   Соответствующее свойство - sonar.technicalDebt.developmentCost

Изменение таблицы рейтинга поддерживаемости#

Чтобы изменить таблицу рейтинга поддерживаемости по умолчанию:

1. В верхней навигационной панели CodeScanner выберите Администрирование -> Конфигурация -> Общие настройки -> Технический долг;

2. В разделе Таблица рейтинга поддерживаемости измените определение рейтинга.

Соответствующее свойство - sonar.technicalDebt.ratingGrid