C++-Testen

C++-Testen (Agentenfertigkeit)

Agentenorientierter Testworkflow für modernes C++ (C++17/20) mit GoogleTest/GoogleMock und CMake/CTest.

Verwendungszweck

• Neue C++-Tests schreiben oder bestehende Tests reparieren
• Unit-/Integrationstestabdeckung für C++-Komponenten entwerfen
• Testabdeckung, CI-Gating oder Regressionsschutz hinzufügen
• CMake/CTest-Workflows für konsistente Ausführung konfigurieren
• Testfehlschläge oder instabiles Verhalten untersuchen
• Sanitizer für Speicher-/Race-Diagnose aktivieren

Wann NICHT verwenden

• Implementierung neuer Produktfunktionen ohne Teständerungen
• Großflächige Refactorings ohne Bezug zu Testabdeckung oder Fehlschlägen
• Leistungsoptimierung ohne Testregressionen zur Validierung
• Nicht-C++-Projekte oder Nicht-Testaufgaben

Kernkonzepte

• TDD-Schleife: rot → grün → refaktor (zuerst Tests, minimale Korrektur, dann Bereinigung).
• Isolation: Abhängigkeitsinjektion und Fakes gegenüber globalem Zustand bevorzugen.
• Testlayout: tests/unit, tests/integration, tests/testdata.
• Mocks vs. Fakes: Mock für Interaktionen, Fake für zustandsbehaftetes Verhalten.
• CTest-Erkennung: gtest_discover_tests() für stabile Testerkennung verwenden.
• CI-Signal: Zuerst eine Teilmenge ausführen, dann die vollständige Suite mit --output-on-failure.

TDD-Workflow

Befolgen Sie die ROT → GRÜN → REFAKTOR-Schleife:

1. ROT: Schreiben Sie einen fehlschlagenden Test, der das neue Verhalten erfasst.
2. GRÜN: Implementieren Sie die kleinste Änderung, um den Test zu bestehen.
3. REFAKTOR: Bereinigen Sie den Code, während die Tests grün bleiben.

// tests/add_test.cpp
#include <gtest/gtest.h>

int Add(int a, int b); // Wird vom Produktionscode bereitgestellt.

TEST(AddTest, AddsTwoNumbers) { // ROT
  EXPECT_EQ(Add(2, 3), 5);
}

// src/add.cpp
int Add(int a, int b) { // GRÜN
  return a + b;
}

// REFAKTOR: vereinfachen/umbenennen, sobald Tests bestehen

Codebeispiele

Basistest (gtest)

// tests/calculator_test.cpp
#include <gtest/gtest.h>

int Add(int a, int b); // Wird vom Produktionscode bereitgestellt.

TEST(CalculatorTest, AddsTwoNumbers) {
    EXPECT_EQ(Add(2, 3), 5);
}

Fixture (gtest)

// tests/user_store_test.cpp
// Pseudocode-Stub: UserStore/User durch Projekttypen ersetzen.
#include <gtest/gtest.h>
#include <memory>
#include <optional>
#include <string>

struct User { std::string name; };
class UserStore {
public:
    explicit UserStore(std::string /*path*/) {}
    void Seed(std::initializer_list<User> /*users*/) {}
    std::optional<User> Find(const std::string &/*name*/) { return User{"alice"}; }
};

class UserStoreTest : public ::testing::Test {
protected:
    void SetUp() override {
        store = std::make_unique<UserStore>(":memory:");
        store->Seed({{"alice"}, {"bob"}});
    }

    std::unique_ptr<UserStore> store;
};

TEST_F(UserStoreTest, FindsExistingUser) {
    auto user = store->Find("alice");
    ASSERT_TRUE(user.has_value());
    EXPECT_EQ(user->name, "alice");
}

Mock (gmock)

// tests/notifier_test.cpp
#include <gmock/gmock.h>
#include <gtest/gtest.h>
#include <string>

class Notifier {
public:
    virtual ~Notifier() = default;
    virtual void Send(const std::string &message) = 0;
};

class MockNotifier : public Notifier {
public:
    MOCK_METHOD(void, Send, (const std::string &message), (override));
};

class Service {
public:
    explicit Service(Notifier &notifier) : notifier_(notifier) {}
    void Publish(const std::string &message) { notifier_.Send(message); }

private:
    Notifier &notifier_;
};

TEST(ServiceTest, SendsNotifications) {
    MockNotifier notifier;
    Service service(notifier);

    EXPECT_CALL(notifier, Send("hello")).Times(1);
    service.Publish("hello");
}

CMake/CTest-Schnellstart

# CMakeLists.txt (Auszug)
cmake_minimum_required(VERSION 3.20)
project(example LANGUAGES CXX)

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_STANDARD_REQUIRED ON)

include(FetchContent)
# Projektgebundene Versionen bevorzugen. Bei Verwendung eines Tags eine festgelegte Version gemäß Projektrichtlinie verwenden.
set(GTEST_VERSION v1.17.0) # An Projektrichtlinie anpassen.
FetchContent_Declare(
  googletest
  # Google Test Framework (offizielles Repository)
  URL https://github.com/google/googletest/archive/refs/tags/${GTEST_VERSION}.zip
)
FetchContent_MakeAvailable(googletest)

add_executable(example_tests
  tests/calculator_test.cpp
  src/calculator.cpp
)
target_link_libraries(example_tests GTest::gtest GTest::gmock GTest::gtest_main)

enable_testing()
include(GoogleTest)
gtest_discover_tests(example_tests)

cmake -S . -B build -DCMAKE_BUILD_TYPE=Debug
cmake --build build -j
ctest --test-dir build --output-on-failure

Tests ausführen

ctest --test-dir build --output-on-failure
ctest --test-dir build -R ClampTest
ctest --test-dir build -R "UserStoreTest.*" --output-on-failure

./build/example_tests --gtest_filter=ClampTest.*
./build/example_tests --gtest_filter=UserStoreTest.FindsExistingUser

Fehlerdiagnose

1. Einzelnen fehlschlagenden Test mit gtest-Filter erneut ausführen.
2. Bereichsbezogene Protokollierung um die fehlschlagende Assertion hinzufügen.
3. Mit aktivierten Sanitizern erneut ausführen.
4. Auf die gesamte Suite erweitern, sobald die Grundursache behoben ist.

Coverage

Zielebene-Einstellungen anstelle globaler Flags bevorzugen.

option(ENABLE_COVERAGE "Coverage-Flags aktivieren" OFF)

if(ENABLE_COVERAGE)
  if(CMAKE_CXX_COMPILER_ID MATCHES "GNU")
    target_compile_options(example_tests PRIVATE --coverage)
    target_link_options(example_tests PRIVATE --coverage)
  elseif(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
    target_compile_options(example_tests PRIVATE -fprofile-instr-generate -fcoverage-mapping)
    target_link_options(example_tests PRIVATE -fprofile-instr-generate)
  endif()
endif()

GCC + gcov + lcov:

cmake -S . -B build-cov -DENABLE_COVERAGE=ON
cmake --build build-cov -j
ctest --test-dir build-cov
lcov --capture --directory build-cov --output-file coverage.info
lcov --remove coverage.info '/usr/*' --output-file coverage.info
genhtml coverage.info --output-directory coverage

Clang + llvm-cov:

cmake -S . -B build-llvm -DENABLE_COVERAGE=ON -DCMAKE_CXX_COMPILER=clang++
cmake --build build-llvm -j
LLVM_PROFILE_FILE="build-llvm/default.profraw" ctest --test-dir build-llvm
llvm-profdata merge -sparse build-llvm/default.profraw -o build-llvm/default.profdata
llvm-cov report build-llvm/example_tests -instr-profile=build-llvm/default.profdata

Sanitizer

option(ENABLE_ASAN "AddressSanitizer aktivieren" OFF)
option(ENABLE_UBSAN "UndefinedBehaviorSanitizer aktivieren" OFF)
option(ENABLE_TSAN "ThreadSanitizer aktivieren" OFF)

if(ENABLE_ASAN)
  add_compile_options(-fsanitize=address -fno-omit-frame-pointer)
  add_link_options(-fsanitize=address)
endif()
if(ENABLE_UBSAN)
  add_compile_options(-fsanitize=undefined -fno-omit-frame-pointer)
  add_link_options(-fsanitize=undefined)
endif()
if(ENABLE_TSAN)
  add_compile_options(-fsanitize=thread)
  add_link_options(-fsanitize=thread)
endif()

Schutzmaßnahmen gegen Flaky Tests

• Niemals sleep für Synchronisation verwenden; stattdessen Bedingungsvariablen oder Latches einsetzen.
• Temporäre Verzeichnisse pro Test eindeutig machen und immer bereinigen.
• Echtzeit, Netzwerk oder Dateisystemabhängigkeiten in Unittests vermeiden.
• Deterministische Seeds für zufallsgesteuerte Eingaben verwenden.

Best Practices

TUN

• Tests deterministisch und isoliert halten
• Abhängigkeitsinjektion gegenüber globalen Variablen bevorzugen
• ASSERT_* für Vorbedingungen, EXPECT_* für mehrere Prüfungen verwenden
• Unit- und Integrationstests in CTest-Labels oder Verzeichnissen trennen
• Sanitizer im CI für Speicher- und Race-Erkennung ausführen

NICHT TUN

• Nicht von Echtzeit oder Netzwerk in Unittests abhängen
• Keine Schlafbefehle als Synchronisation verwenden, wenn eine Bedingungsvariable verwendet werden kann
• Einfache Wertobjekte nicht übermäßig mocken
• Keine spröden Zeichenfolgenabgleiche für nicht-kritische Protokolle verwenden

Häufige Fallstricke

• Feste temporäre Pfade verwenden → Eindeutige temporäre Verzeichnisse pro Test generieren und bereinigen.
• Auf Wanduhrzeit verlassen → Eine Uhr injizieren oder gefälschte Zeitquellen verwenden.
• Instabile nebenläufige Tests → Bedingungsvariablen/Latches und begrenzte Wartezeiten verwenden.
• Versteckter globaler Zustand → Globalen Zustand in Fixtures zurücksetzen oder entfernen.
• Übermäßiges Mocken → Fakes für zustandsbehaftetes Verhalten bevorzugen und nur Interaktionen mocken.
• Fehlende Sanitizer-Läufe → ASan/UBSan/TSan-Builds im CI hinzufügen.
• Coverage nur für Debug-Builds → Sicherstellen, dass Coverage-Ziele konsistente Flags verwenden.

Optionaler Anhang: Fuzzing / Property Testing

Nur verwenden, wenn das Projekt bereits LLVM/libFuzzer oder eine Property-Testing-Bibliothek unterstützt.

• libFuzzer: Am besten für reine Funktionen mit minimaler E/A.
• RapidCheck: Eigenschaftsbasierte Tests zur Validierung von Invarianten.

Minimaler libFuzzer-Harness (Pseudocode: ParseConfig ersetzen):

#include <cstddef>
#include <cstdint>
#include <string>

extern "C" int LLVMFuzzerTestOneInput(const uint8_t *data, size_t size) {
    std::string input(reinterpret_cast<const char *>(data), size);
    // ParseConfig(input); // Projektfunktion
    return 0;
}

Alternativen zu GoogleTest

• Catch2: Nur-Header, ausdrucksstarke Matcher
• doctest: Leichtgewichtig, minimaler Compile-Overhead