Быстрый старт в статическом анализе кода на C++: пошаговая инструкция за один день

Введение: Зачем анализировать C++ и можно ли уложиться в день?
C++ — это язык невероятной мощности и гибкости, но за эту мощь приходится платить сложностью. Указатели, ручное управление памятью, неявные преобразования типов и богатые возможности метапрограммирования создают обширное поле для трудноуловимых ошибок: утечек памяти, неопределенного поведения, уязвимостей переполнения буфера и race condition. Статический анализ кода (Static Application Security Testing, SAST) — это методика поиска потенциальных проблем в исходном коде без его выполнения. Он позволяет находить дефекты на самых ранних этапах, экономя часы отладки и предотвращая серьезные инциденты в production. Цель этого руководства — дать вам практический план действий, следуя которому вы за один день сможете настроить базовый, но эффективный пайплайн статического анализа для вашего C++ проекта, даже если вы никогда не делали этого раньше.

Шаг 1: Подготовка среды и выбор инструментов (Утро: 2-3 часа)
Первое, что нужно понять: не существует одного "самого лучшего" статического анализатора. Каждый имеет свои сильные стороны. Для быстрого старта мы сфокусируемся на двух типах инструментов: линтерах/стилевых анализаторах и глубоких SAST-инструментах, и выберем по одному бесплатному и популярному представителю.

• Линтер/Форматтер: **Clang-Tidy**. Это часть проекта LLVM/Clang, де-факто стандарт для анализа C++. Он находит не только стилевые issues, но и серьезные баги: неправильное использование `std::move`, возможные утечки памяти, подозрительные конструкции. Плюс, он может автоматически исправлять многие проблемы.

• Глубокий статический анализатор: **Cppcheck**. Легковесный, специализированный инструмент, который фокусируется на обнаружении реальных ошибок, а не на стиле. Он отлично находит утечки памяти, ошибки работы с указателями, переполнения буферов, неправильное использование стандартной библиотеки. У него низкий уровень ложных срабатываний.

Установка:
* На Ubuntu/Debian: `sudo apt install clang-tidy cppcheck`
* На macOS: `brew install llvm cppcheck` (для clang-tidy может потребоваться `brew install llvm` и добавление в PATH).
* На Windows: Используйте установщики с официальных сайтов или пакеты в MSYS2/MinGW. Проще всего — установить Clang через Visual Studio Installer (компонент "C++ Clang tools") и Cppcheck с официального сайта.

Проверьте установку: `clang-tidy --version`, `cppcheck --version`.

Шаг 2: Первый запуск и настройка базовых проверок (День: 2-3 часа)
Не бросайтесь анализировать весь проект сразу. Начните с одного-двух файлов, чтобы понять вывод инструментов.

Создайте простой тестовый файл `test.cpp` с преднамеренной ошибкой:
```cpp
#include
#include
int main() {
 char src[10] = "hello";
 char dest[5];
 std::strcpy(dest, src); // Переполнение буфера!
 int* p = new int(5);
 // Утечка памяти: нет delete p;
 return 0;
}
```

Запустите анализаторы:

• `clang-tidy test.cpp -- -std=c++17`

Флаг `--` отделяет аргументы clang-tidy от аргументов компилятора. Укажите стандарт C++, который вы используете.

• `cppcheck --enable=all --inconclusive test.cpp`

Флаг `--enable=all` включает все проверки (можно начать с `--enable=warning,style,performance,portability`). `--inconclusive` позволяет выдавать предупреждения, для которых анализ не является однозначным.
Изучите вывод. Cppcheck должен сразу обнаружить переполнение буфера в `strcpy`. Clang-Tidy может указать на использование небезопасной C-функции и предложить использовать `std::string`.

Теперь настройте анализ для реального проекта. Ключевой момент — чтобы анализаторы понимали инклуды и флаги компиляции вашего проекта. Самый простой способ — использовать `compile_commands.json`.

Если ваш проект использует CMake:
```bash
cd /path/to/your/project
mkdir build && cd build
cmake -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
```
В папке `build` появится файл `compile_commands.json`.

Для других систем сборки (Make, Bazel, QMake) существуют утилиты для генерации этого файла (например, `bear` для Make).

Запустите анализ для всего проекта, используя `compile_commands.json`:
```bash
# Для clang-tidy, из папки build:
clang-tidy -p . ../src/*.cpp
# Или для всех файлов в проекте, соответствующих шаблону:
find ../src -name "*.cpp" -exec clang-tidy -p . {} \;

# Для Cppcheck (он тоже может использовать compile_commands.json):
cppcheck --project=compile_commands.json --enable=all --inconclusive
```

Шаг 3: Интеграция в процесс сборки и пода