testing

name	testing
description	Use when: running hiredis-happ tests, adding regression coverage, debugging CTest failures, or planning Redis/raw/cluster integration tests.

Testing skill

Use this skill for unit tests, CTest execution, deterministic regressions, Redis integration tests, and sanitizer-oriented lifecycle validation.

Test framework

Tests live under test/case/ and use the atframe_utils private test framework, not Google Test.

Common macros:

• CASE_TEST(group, name)
• CASE_EXPECT_TRUE, CASE_EXPECT_FALSE
• CASE_EXPECT_EQ, CASE_EXPECT_NE, CASE_EXPECT_LT, CASE_EXPECT_LE, CASE_EXPECT_GT, CASE_EXPECT_GE
• CASE_MSG_INFO(), CASE_MSG_ERROR()
• CASE_THREAD_SLEEP_MS, CASE_THREAD_YIELD

Configure/build before tests

cmake -S . -B build_jobs_review -DPROJECT_HIREDIS_HAPP_ENABLE_UNITTEST=ON -DPROJECT_HIREDIS_HAPP_ENABLE_SAMPLE=ON -DATFRAMEWORK_CMAKE_TOOLSET_THIRD_PARTY_LOW_MEMORY_MODE=ON
cmake --build build_jobs_review --config RelWithDebInfo

Run tests

Windows requires the third-party bin directory in PATH. Prefer resolving it from build_jobs_review/CMakeCache.txt instead of hardcoding an MSVC version suffix:

$thirdPartyInstallDir = Select-String -Path "$PWD\build_jobs_review\CMakeCache.txt" -Pattern '^PROJECT_THIRD_PARTY_INSTALL_DIR:PATH=(.+)$' | ForEach-Object { $_.Matches[0].Groups[1].Value } | Select-Object -First 1
if (-not $thirdPartyInstallDir) { $thirdPartyInstallDir = Get-ChildItem "$PWD\third_party\install" -Directory | Where-Object { $_.Name -like 'windows-*-msvc-*' } | Sort-Object Name -Descending | Select-Object -First 1 -ExpandProperty FullName }
if (-not $thirdPartyInstallDir) { throw "Could not locate the third-party install directory. Configure the build first." }
$env:PATH = "$thirdPartyInstallDir\bin;$env:PATH"
ctest --test-dir build_jobs_review -V -R hiredis-happ-run-test -C RelWithDebInfo --timeout 120

hiredis-happ-run-test covers the pure unit/regression groups (happ_cmd, happ_connection, happ_cluster, happ_raw). Redis-backed integration coverage is split into:

• hiredis-happ-redis-integration-raw
• hiredis-happ-redis-integration-cluster

The repository-owned Unix platform flows run all three CTest entries in one pass and clean the temporary Redis instances automatically. The Windows MSVC flow can do the same when Redis integration is enabled:

• Linux/macOS: bash ci/do_ci.sh ssl.openssl
• Legacy GCC flow: bash ci/do_ci.sh gcc.legacy.test
• Windows MSVC: pwsh ci/do_ci.ps1 msvc.modern.test

Set HIREDIS_HAPP_TEST_WITH_REDIS=OFF when you want pwsh ci/do_ci.ps1 msvc.modern.test to run unit tests only. The GitHub Actions Windows job uses that switch so CI does not rely on WSL provisioning.

Provision Redis for integration tests with the fixture scripts under test/redis/.

Linux/macOS/WSL:

bash ./test/redis/redis-fixture.sh start-all
while IFS='=' read -r key value; do export "$key=$value"; done < <(bash ./test/redis/redis-fixture.sh print-env)
ctest --test-dir build_jobs_review -V -R hiredis-happ-redis-integration-raw --timeout 120
ctest --test-dir build_jobs_review -V -R hiredis-happ-redis-integration-cluster --timeout 180
bash ./test/redis/redis-fixture.sh cleanup

Windows wrapper (requires WSL plus an installed Linux distribution):

.\test\redis\redis-fixture.ps1 start-all
$envLines = .\test\redis\redis-fixture.ps1 print-env
foreach ($line in $envLines) { if ($line -match '^([^=]+)=(.*)$') { Set-Item -Path ("Env:" + $Matches[1]) -Value $Matches[2] } }
ctest --test-dir build_jobs_review -V -R hiredis-happ-redis-integration-raw -C RelWithDebInfo --timeout 120
ctest --test-dir build_jobs_review -V -R hiredis-happ-redis-integration-cluster -C RelWithDebInfo --timeout 180
.\test\redis\redis-fixture.ps1 cleanup

The fixture defaults match the tests: standalone Redis on 127.0.0.1:6390, cluster seed on 127.0.0.1:7300, and related values exported through print-env as HIREDIS_HAPP_TEST_* variables.

If multiple WSL distros are installed on Windows, set HIREDIS_HAPP_TEST_WSL_DISTRO before invoking the PowerShell wrapper. The wrapper terminates that distro after stop-* / cleanup so temporary Redis processes do not linger after the test flow finishes.

Inspect discovered test names with:

ctest --test-dir build_jobs_review -N -C RelWithDebInfo

Prefer ctest over invoking hiredis-happ-test.exe directly so generator-specific paths, environment handling, and future test additions stay consistent.

If ctest reports 0xC0000135 or produces no useful test output, first check missing DLLs and PATH before debugging test logic.

Regression focus

• Redis Cluster hash tags and slot routing.
• MOVED, ASK + ASKING, TRYAGAIN, CLUSTERDOWN, empty endpoint, and malformed CLUSTER SLOTS replies.
• hiredis async lifecycle: connect failure, disconnect, reset while commands are pending, and callbacks with reply == nullptr.
• Non request-response commands: subscribe, unsubscribe, and monitor must use raw command handling rather than normal exec().
• Logging with small buffers to catch truncation and null-termination issues.

Integration test guidance

Use real Redis/Redis Cluster and an event-loop adapter for lifecycle behavior. Prefer sanitizer-backed tests for connection::release(), reset, disconnect, retry, pending callbacks, and command destruction. Do not claim lifecycle safety from object-state unit tests alone.

For this repository, start from the fixture scripts and keep Redis provisioning scripted. Avoid hand-created local clusters when documenting reproducible test workflows.

Validation

After adding tests, run the narrow test first, then full CTest when practical. If the current Windows workstation does not have WSL + a Linux distro, document the skipped local integration run. In CI, keep Redis coverage inside the existing Unix platform jobs instead of splitting it into a side job; the GitHub Actions Windows job intentionally disables WSL-backed Redis integration.