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

1. Комплексное использование
анализаторов для повышения
качества кода
Юрий Минаев (PVS-Studio)

2. О себе
2
• Юрий Минаев
• C++ разработчик в
компании PVS-Studio
• minaev@viva64.com

3. О чем пойдет речь
• Об инструментах, помогающих обеспечить
качество кода
• О SonarQube как единой платформе контроля
качества
3

4. Зачем это нужно
• В любом проекте есть баги
• Исправлять их проще,
пока они не выросли
• Автоматизация – это
удобно
4

5. Стоимость исправления дефекта
5

6. Как защитить код от багов
6

7. Code review
7

8. Оформление кода
• Единообразный стиль
• Читаемость
• Облегчение отладки
• Проще найти дефекты
8

9. Оформление кода: пример
void DoSomething(Things& things, bool remove) {
for (auto i = 0; i < things.Count(); ++i) {
things[i].DoWhatever();
if (remove) {things.Remove(i);
} else { things.ApplyChange(i); } }
}
9

10. Оформление кода: пример
void DoSomething(Things& things, bool remove)
{
for (auto i = 0; i < things.Count(); ++i)
{
things[i].DoWhatever();
if (remove)
things.Remove(i);
else
things.ApplyChange(i);
}
}
10

11. Статический анализ
• Это как code review, только происходит
автоматически
• Хорошо сочетается с другими методами
• Находит ошибочные паттерны, о которых не
догадываются программисты
11

12. Code smells
• Дублирование кода
• Длинные функции
• Слишком много
параметров
• God object
12

13. Code smells: пример
class ManagerOfEverything
{
public:
void InitDatabase();
void UpdateDatabase();
int CalculateSomeImportantValue();
//…
void SendRequest(const RequestData& data);
void ReceiveRequest(RequestData& data);
//…
void CreateInputForm();
void FillInputForm(const FormData& data);
//…
void MakeMeACoffee();
};
13

14. Code smells != errors
• Даже если код пахнет, это не
значит, что он работает
неправильно
14

15. Code smells != errors, но...
• Такой код сложнее отлаживать
• Как правило, сложнее читать
• Сложнее найти баги
• Сложнее исправить баги
15

16. Динамический анализ
• Отладчики
• Профилировщики
• Санитайзеры
• В некоторой степени юнит-тесты
16

17. AddressSanitizer
17
#include <stdlib.h>
int main()
{
char* x = (char*)malloc(10 * sizeof(char*));
free(x);
return x[5];
}

18. AddressSanitizer
==9901==ERROR: AddressSanitizer: heap-use-after-free on address 0x60700000dfb5 at pc 0x45917b bp 0x7fff4490c700
sp 0x7fff4490c6f8
READ of size 1 at 0x60700000dfb5 thread T0
#0 0x45917a in main use-after-free.c:5
#1 0x7fce9f25e76c in __libc_start_main /build/buildd/eglibc-2.15/csu/libc-start.c:226
#2 0x459074 in _start (a.out+0x459074)
0x60700000dfb5 is located 5 bytes inside of 80-byte region [0x60700000dfb0,0x60700000e000)
freed by thread T0 here:
#0 0x4441ee in __interceptor_free projects/compiler-rt/lib/asan/asan_malloc_linux.cc:64
#1 0x45914a in main use-after-free.c:4
#2 0x7fce9f25e76c in __libc_start_main /build/buildd/eglibc-2.15/csu/libc-start.c:226
previously allocated by thread T0 here:
#0 0x44436e in __interceptor_malloc projects/compiler-rt/lib/asan/asan_malloc_linux.cc:74
#1 0x45913f in main use-after-free.c:3
#2 0x7fce9f25e76c in __libc_start_main /build/buildd/eglibc-2.15/csu/libc-start.c:226
SUMMARY: AddressSanitizer: heap-use-after-free use-after-free.c:5 main
18

19. Метрики
• Определение качества существующего
продукта
• Прогнозирование качества продукта
• Улучшение качества продукта
19

20. Количественные метрики
• Строки кода (SLOC)
• Количество и процент комментариев
• Среднее число строк на функцию/класс/файл
• Процент дублирования кода
• Цикломатическая сложность
20

21. Метрика по дефектам в коде
• Плотность дефектов в коде
• Number of Defects – общее количество дефектов
• Size – размер кодовой базы
21

22. • Платформа с открытым исходным кодом для
непрерывного анализа и измерения качества кода
• Содержит ряд анализаторов для разных языков
• Позволяет интегрировать сторонние анализаторы
• Наглядно визуализирует качество вашего продукта
22

23. Как это использовать
23

24. Что нам понадобится
• JRE 8
• SonarQube LTS
https://www.sonarqube.org/downloads/
• SonarQube C++ Community Plugin
https://github.com/SonarOpenCommunity/sonar-cxx
24

25. 25

26. Подготовка
• Quality profile
• Quality gate
• Конфигурационный файл
26

27. Quality profile
27

28. Quality gate
28

29. sonar-project.properties
sonar.projectKey=demo
sonar.projectName=demo
sonar.projectVersion=1.0
sonar.projectBaseDir=SonarTest
sonar.sources=Thingy
sonar.host.url=http://localhost:9000
29

30. Первый запуск
30

31. Настройка правил
31

32. CppCheck
• Статический анализатор с открытым исходным
кодом
• Основан на регулярных выражениях
• Позволяет добавлять собственные правила
• http://cppcheck.sourceforge.net/
32

33. CppCheck
33
sonar.cxx.cppcheck.reportPath=../cppcheck.xml

34. Clang-Tidy
• Линтер для языков C и C++
• Позволяет проверять code style
• Позволяет добавлять собственные правила
• Поставляется вместе с LLVM
• https://clang.llvm.org/extra/clang-tidy/
34

35. Clang-Tidy
35
sonar.cxx.clangtidy.reportPath=../tidy.log

36. PVS-Studio
• Статический анализатор для C, C++, C# и Java
• Для подключения к SonarQube нужен
специальный плагин (идет в поставке)
• https://www.viva64.com/
36

37. PVS-Studio
37
sonar.pvs-studio.reportPath=report.plog

38. Valgrind
• Динамический анализатор с открытым
исходным кодом
• Работает под Linux
• http://www.valgrind.org/
38

39. Valgrind
39
sonar.cxx.valgrind.reportPath=../valgrind.xml

40. Оценка покрытия кода
• Имеет смысл запускать с юнит-тестами
• Позволяет оценить, насколько хорошо
покрыты разные пути выполнения
40

41. Gcov
• Утилита для оценки покрытия кода
• Часть GCC
• https://gcc.gnu.org/onlinedocs/gcc/Gcov-Intro.html
41

42. Gcov
42
sonar.cxx.coverage.reportPath=../gcov.xml

43. Результат
43

44. Результат
44

45. Результат
45

46. Результат
46

47. Результат
47

48. Итог
• Качество кода можно
обеспечить разными
инструментами
• Полезно использовать их в
комплексе
• "Серебряной пули" не бывает
48

49. Q&A
• Сайт PVS-Studio:
https://www.viva64.com
• Контакты:
Юрий Минаев
minaev@viva64.com
49