Einrichten von C++ Quality Gates in Cursor: 3 automatisierte Prüfungen

Die C++-Entwicklung erfordert strenge Qualitätskontrolle. Diese Anleitung zeigt Ihnen, wie Sie drei automatisierte Prüfungen in Cursor einrichten, die vor jedem Commit ausgeführt werden: Target-Builds, Sanitizer-Builds und statische Analyse mit cppcheck. In Kombination mit einem Git-Pre-Push-Hook stellen diese Prüfungen sicher, dass Ihr Code immer produktionsreif ist.

Die drei Prüfungen

Prüfung 1: Target-Build

Kompiliert Ihren Code mit denselben Einstellungen wie Ihre Deployment-Umgebung.

Prüfung 2: Sanitizer-Build

Führt AddressSanitizer (ASan) und UndefinedBehaviorSanitizer (UBSan) aus, um Speicherfehler und undefiniertes Verhalten zu erkennen.

Prüfung 3: Statische Analyse

Verwendet cppcheck, um Bugs, Stilverstöße und potenzielle Probleme zu finden, ohne den Code auszuführen.

Voraussetzungen

Installieren Sie die erforderlichen Tools:

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install -y build-essential cmake cppcheck

# macOS
brew install cmake cppcheck

# Windows (über MSYS2 oder WSL)
pacman -S mingw-w64-x86_64-cmake mingw-w64-x86_64-cppcheck

Projektstruktur

my-cpp-project/
├── src/
│   ├── main.cpp
│   └── utils.cpp
├── include/
│   └── utils.h
├── tests/
│   └── test_main.cpp
├── CMakeLists.txt
├── .cursor/
│   └── quality-gate.sh
└── .git/hooks/
    └── pre-push

Schritt 1: CMake-Konfiguration

Erstellen Sie CMakeLists.txt mit Build-Profilen:

cmake_minimum_required(VERSION 3.14)
project(MyProject CXX)

set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

# Quelldateien
add_executable(myapp
    src/main.cpp
    src/utils.cpp
)

target_include_directories(myapp PRIVATE include)

# Target-Build-Profil (produktionsähnlich)
add_library(target_profile INTERFACE)
target_compile_options(target_profile INTERFACE
    -O2
    -DNDEBUG
    -Wall
    -Wextra
    -Werror
)

# Sanitizer-Build-Profil
add_library(sanitizer_profile INTERFACE)
target_compile_options(sanitizer_profile INTERFACE
    -O1
    -g
    -fsanitize=address,undefined
    -fno-omit-frame-pointer
)
target_link_options(sanitizer_profile INTERFACE
    -fsanitize=address,undefined
)

# Profile anwenden
option(USE_SANITIZER "Build with sanitizers" OFF)
if(USE_SANITIZER)
    target_link_libraries(myapp sanitizer_profile)
else()
    target_link_libraries(myapp target_profile)
endif()

# Tests
enable_testing()
add_executable(myapp_tests tests/test_main.cpp)
target_link_libraries(myapp_tests target_profile)
add_test(NAME unit_tests COMMAND myapp_tests)

Schritt 2: Quality Gate-Skript

Erstellen Sie .cursor/quality-gate.sh:

#!/bin/bash
set -e

PROJECT_ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
BUILD_DIR="$PROJECT_ROOT/build"
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
NC='\033[0m' # Keine Farbe

echo "=========================================="
echo "  Cursor C++ Quality Gate"
echo "=========================================="

# Build-Verzeichnis bereinigen
rm -rf "$BUILD_DIR"
mkdir -p "$BUILD_DIR"

# Prüfung 1: Target-Build
echo -e "\n${YELLOW}[1/3] Target-Build${NC}"
echo "Build mit Produktionseinstellungen..."
mkdir -p "$BUILD_DIR/target"
cd "$BUILD_DIR/target"
cmake ../.. -DCMAKE_BUILD_TYPE=Release
make -j$(nproc)
echo -e "${GREEN}Target-Build: BESTANDEN${NC}"

# Tests ausführen
echo "Tests werden ausgeführt..."
ctest --output-on-failure
echo -e "${GREEN}Tests: BESTANDEN${NC}"

# Prüfung 2: Sanitizer-Build
echo -e "\n${YELLOW}[2/3] Sanitizer-Build${NC}"
echo "Build mit AddressSanitizer und UBSan..."
mkdir -p "$BUILD_DIR/sanitizer"
cd "$BUILD_DIR/sanitizer"
cmake ../.. -DCMAKE_BUILD_TYPE=Debug -DUSE_SANITIZER=ON
make -j$(nproc)

echo "Ausführung mit Sanitizers..."
./myapp || {
    echo -e "${RED}Sanitizer hat Fehler erkannt!${NC}"
    exit 1
}
echo -e "${GREEN}Sanitizer-Build: BESTANDEN${NC}"

# Prüfung 3: Statische Analyse
echo -e "\n${YELLOW}[3/3] Statische Analyse (cppcheck)${NC}"
cd "$PROJECT_ROOT"

cppcheck \
    --enable=all \
    --suppress=missingIncludeSystem \
    --error-exitcode=1 \
    --inline-suppr \
    --check-config \
    -I include \
    src/ \
    tests/ \
    2>&1 | tee "$BUILD_DIR/cppcheck-report.txt"

echo -e "${GREEN}Statische Analyse: BESTANDEN${NC}"

# Zusammenfassung
echo -e "\n=========================================="
echo -e "${GREEN}Alle Quality Gates bestanden!${NC}"
echo "=========================================="
echo "Build-Artefakte: $BUILD_DIR/"
echo "Bericht: $BUILD_DIR/cppcheck-report.txt"

Machen Sie es ausführbar:

chmod +x .cursor/quality-gate.sh

Schritt 3: Git Pre-Push-Hook

Erstellen Sie .git/hooks/pre-push:

#!/bin/bash

echo "Quality Gate vor dem Push ausführen..."

if [ -f ".cursor/quality-gate.sh" ]; then
    bash .cursor/quality-gate.sh
    exit $?
else
    echo "Warnung: Quality Gate-Skript nicht gefunden"
    exit 0
fi

Machen Sie es ausführbar:

chmod +x .git/hooks/pre-push

Schritt 4: Cursor-Integration

Zu Cursor-Aufgaben hinzufügen

Erstellen Sie .vscode/tasks.json (Cursor verwendet das VS Code-Aufgabensystem):

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "C++ Quality Gate",
      "type": "shell",
      "command": "bash",
      "args": [".cursor/quality-gate.sh"],
      "group": {
        "kind": "test",
        "isDefault": true
      },
      "presentation": {
        "echo": true,
        "reveal": "always",
        "focus": false,
        "panel": "shared"
      },
      "problemMatcher": ["$gcc"]
    },
    {
      "label": "Quick Build",
      "type": "shell",
      "command": "cmake",
      "args": ["--build", "build/target", "--parallel"],
      "group": "build"
    },
    {
      "label": "Run Sanitizer Build",
      "type": "shell",
      "command": "bash",
      "args": ["-c", "mkdir -p build/sanitizer && cd build/sanitizer && cmake ../.. -DUSE_SANITIZER=ON && make -j$(nproc) && ./myapp"],
      "group": "test"
    }
  ]
}

Tastaturkürzel

Fügen Sie zu .vscode/keybindings.json hinzu:

[
  {
    "key": "ctrl+shift+q",
    "command": "workbench.action.tasks.runTask",
    "args": "C++ Quality Gate"
  }
]

Sanitizer-Ausgabe verstehen

AddressSanitizer (ASan)

Erkennt:

• Use after free
• Heap-Buffer-Overflow
• Stack-Buffer-Overflow
• Globaler Buffer-Overflow
• Use after return
• Use after scope
• Double-free
• Speicherlecks

Beispielausgabe:

==12345==ERROR: AddressSanitizer: heap-buffer-overflow
READ of size 4 at 0x602000000014 thread T0
    #0 0x5555555551a9 in main src/main.cpp:15

UndefinedBehaviorSanitizer (UBSan)

Erkennt:

• Vorzeichenbehafteter Integer-Overflow
• Division durch Null
• Null-Pointer-Dereferenzierung
• Nicht ausgerichteter Pointer-Zugriff
• Ungültige Shift-Operationen

Beispielausgabe:

src/utils.cpp:42:15: runtime error: signed integer overflow

cppcheck anpassen

Suppression-Kommentare

In Ihrem Code:

// cppcheck-suppress unusedFunction
void debugHelper() {
    // Dies wird nur in Debug-Builds verwendet
}

// cppcheck-suppress knownConditionTrueFalse
if (x == x) {  // Absichtliche NaN-Prüfung
    // NaN behandeln
}

Konfigurationsdatei

Erstellen Sie cppcheck-suppressions.txt:

unusedFunction:*test*
missingIncludeSystem
unmatchedSuppression

Aktualisieren Sie das Skript:

cppcheck \
    --enable=all \
    --suppressions-list=cppcheck-suppressions.txt \
    --error-exitcode=1 \
    src/ tests/

CI/CD-Integration

GitHub Actions

name: C++ Quality Gate

on: [push, pull_request]

jobs:
  quality-gate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      - name: Install dependencies
        run: |
          sudo apt-get update
          sudo apt-get install -y build-essential cmake cppcheck
      
      - name: Run Quality Gate
        run: bash .cursor/quality-gate.sh

Fehlerbehebung

Problem	Lösung
Sanitizer-Build zu langsam	Verwenden Sie -O1 statt -O0 für schnellere Builds
cppcheck-Falschmeldungen	Fügen Sie Suppression-Kommentare oder eine Config-Datei hinzu
Hook wird nicht ausgeführt	Stellen Sie sicher, dass .git/hooks/pre-push ausführbar ist
Nicht genügend Speicher während des Builds	Reduzieren Sie parallele Jobs: make -j2 statt -j$(nproc)

Schnellreferenz

# Vollständiges Quality Gate ausführen
bash .cursor/quality-gate.sh

# Nur schneller Target-Build
mkdir -p build && cd build && cmake .. && make -j$(nproc)

# Mit Sanitizers ausführen
mkdir -p build-san && cd build-san && cmake .. -DUSE_SANITIZER=ON && make -j$(nproc) && ./myapp

# Nur cppcheck ausführen
cppcheck --enable=all --error-exitcode=1 src/

Verwandte Ressourcen

• Debug C++ with Breakpoints in Cursor
• Cursor and JetBrains Compatibility
• Handling Large Projects with Cursor