mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-06-11 09:07:15 +00:00
52ce2e6e85
On Linux/glibc, getaddrinfo_with_timeout() runs DNS asynchronously via getaddrinfo_a(GAI_NOWAIT) using a stack-local gaicb. When gai_suspend() hits the connection timeout, gai_cancel() is called and the function returns immediately — but gai_cancel() is non-blocking and can return EAI_NOTCANCELED, leaving the resolver worker thread alive and still referencing the destroyed stack frame. Adds three opt-in gtest cases (GetAddrInfoAsyncCancelTest.*) that exercise the cancel path repeatedly. They are gated on Linux/glibc + CPPHTTPLIB_USE_NON_BLOCKING_GETADDRINFO at compile time, and on the CPPHTTPLIB_TEST_ISSUE_2431=1 env var at runtime, so a normal `make test` run is unaffected. Also adds a dedicated CI job (issue-2431-repro) and a Docker-based local runner (test/run_issue_2431_repro.sh) that sinkhole UDP/53 so the timeout branch is taken, and run the test under ASAN/LSAN. With the bug present these runs are expected to fail; with a fix applied they should pass. Refs: https://github.com/yhirose/cpp-httplib/issues/2431 Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
305 lines
12 KiB
YAML
305 lines
12 KiB
YAML
name: test
|
|
|
|
on:
|
|
push:
|
|
pull_request:
|
|
workflow_dispatch:
|
|
inputs:
|
|
gtest_filter:
|
|
description: 'Google Test filter'
|
|
test_linux:
|
|
description: 'Test on Linux'
|
|
type: boolean
|
|
default: true
|
|
test_macos:
|
|
description: 'Test on MacOS'
|
|
type: boolean
|
|
default: true
|
|
test_windows:
|
|
description: 'Test on Windows'
|
|
type: boolean
|
|
default: true
|
|
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
|
|
cancel-in-progress: true
|
|
|
|
env:
|
|
GTEST_FILTER: ${{ github.event.inputs.gtest_filter || '*' }}
|
|
|
|
jobs:
|
|
style-check:
|
|
runs-on: ubuntu-latest
|
|
if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name
|
|
continue-on-error: true
|
|
steps:
|
|
- name: checkout
|
|
uses: actions/checkout@v4
|
|
- name: run style check
|
|
run: |
|
|
clang-format --version
|
|
cd test && make style_check
|
|
|
|
build-and-test-on-32bit:
|
|
runs-on: ubuntu-latest
|
|
if: >
|
|
(github.event_name == 'push') ||
|
|
(github.event_name == 'pull_request' &&
|
|
github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name) ||
|
|
(github.event_name == 'workflow_dispatch' && github.event.inputs.test_linux == 'true')
|
|
strategy:
|
|
matrix:
|
|
config:
|
|
- arch_flags: -m32
|
|
arch_suffix: :i386
|
|
name: (32-bit)
|
|
steps:
|
|
- name: checkout
|
|
uses: actions/checkout@v4
|
|
- name: install libraries
|
|
run: |
|
|
sudo dpkg --add-architecture i386
|
|
sudo apt-get update
|
|
sudo apt-get install -y libc6-dev${{ matrix.config.arch_suffix }} libstdc++-13-dev${{ matrix.config.arch_suffix }} \
|
|
libssl-dev${{ matrix.config.arch_suffix }} libcurl4-openssl-dev${{ matrix.config.arch_suffix }} \
|
|
zlib1g-dev${{ matrix.config.arch_suffix }} libbrotli-dev${{ matrix.config.arch_suffix }} \
|
|
libzstd-dev${{ matrix.config.arch_suffix }}
|
|
- name: build and run tests
|
|
run: cd test && make test EXTRA_CXXFLAGS="${{ matrix.config.arch_flags }}"
|
|
|
|
ubuntu:
|
|
runs-on: ubuntu-latest
|
|
if: >
|
|
(github.event_name == 'push') ||
|
|
(github.event_name == 'pull_request' &&
|
|
github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name) ||
|
|
(github.event_name == 'workflow_dispatch' && github.event.inputs.test_linux == 'true')
|
|
strategy:
|
|
matrix:
|
|
tls_backend: [openssl, mbedtls, wolfssl]
|
|
name: ubuntu (${{ matrix.tls_backend }})
|
|
steps:
|
|
- name: checkout
|
|
uses: actions/checkout@v4
|
|
- name: install common libraries
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y libcurl4-openssl-dev zlib1g-dev libbrotli-dev libzstd-dev
|
|
- name: install OpenSSL
|
|
if: matrix.tls_backend == 'openssl'
|
|
run: sudo apt-get install -y libssl-dev
|
|
- name: install Mbed TLS
|
|
if: matrix.tls_backend == 'mbedtls'
|
|
run: sudo apt-get install -y libmbedtls-dev
|
|
- name: install wolfSSL
|
|
if: matrix.tls_backend == 'wolfssl'
|
|
run: sudo apt-get install -y libwolfssl-dev
|
|
- name: build and run tests (OpenSSL)
|
|
if: matrix.tls_backend == 'openssl'
|
|
run: cd test && make test_split && make test_openssl_parallel
|
|
env:
|
|
LSAN_OPTIONS: suppressions=lsan_suppressions.txt
|
|
- name: build and run tests (Mbed TLS)
|
|
if: matrix.tls_backend == 'mbedtls'
|
|
run: cd test && make test_split_mbedtls && make test_mbedtls_parallel
|
|
- name: build and run tests (wolfSSL)
|
|
if: matrix.tls_backend == 'wolfssl'
|
|
run: cd test && make test_split_wolfssl && make test_wolfssl_parallel
|
|
- name: run fuzz test target
|
|
if: matrix.tls_backend == 'openssl'
|
|
run: cd test && make fuzz_test
|
|
- name: build and run WebSocket heartbeat test
|
|
if: matrix.tls_backend == 'openssl'
|
|
run: cd test && make test_websocket_heartbeat && ./test_websocket_heartbeat
|
|
- name: build and run ThreadPool test
|
|
run: cd test && make test_thread_pool && ./test_thread_pool
|
|
|
|
# Reproducer for https://github.com/yhirose/cpp-httplib/issues/2431.
|
|
# On Linux/glibc, getaddrinfo_with_timeout() schedules an asynchronous
|
|
# DNS lookup with getaddrinfo_a(GAI_NOWAIT) using a stack-local gaicb.
|
|
# When gai_suspend() hits the connection timeout, gai_cancel() is called
|
|
# but does not block; the resolver worker can keep writing into the
|
|
# destroyed stack frame. To exercise that path the runner blocks UDP/53
|
|
# so DNS hangs and the timeout branch is taken on every call.
|
|
issue-2431-repro:
|
|
runs-on: ubuntu-latest
|
|
if: >
|
|
(github.event_name == 'push') ||
|
|
(github.event_name == 'pull_request' &&
|
|
github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name) ||
|
|
(github.event_name == 'workflow_dispatch' && github.event.inputs.test_linux == 'true')
|
|
name: issue-2431 repro (Linux + ASAN)
|
|
steps:
|
|
- name: checkout
|
|
uses: actions/checkout@v4
|
|
- name: install libraries
|
|
run: |
|
|
sudo apt-get update
|
|
sudo apt-get install -y libssl-dev zlib1g-dev libbrotli-dev \
|
|
libzstd-dev libcurl4-openssl-dev iptables util-linux
|
|
- name: sinkhole DNS
|
|
run: |
|
|
# Force the resolver path: Ubuntu's default nsswitch short-circuits
|
|
# to NOTFOUND through mdns4_minimal before glibc DNS code runs, so
|
|
# the gai_cancel() branch would never get exercised.
|
|
sudo sed -i 's/^hosts:.*/hosts: dns/' /etc/nsswitch.conf
|
|
# Drop UDP/53 in both directions so DNS queries hang silently
|
|
# rather than failing fast with ICMP unreachable.
|
|
sudo iptables -I OUTPUT -p udp --dport 53 -j DROP
|
|
sudo iptables -I INPUT -p udp --sport 53 -j DROP
|
|
# Sanity check: a real DNS lookup must hang now.
|
|
if timeout 2 getent hosts example.com >/dev/null 2>&1; then
|
|
echo "ERROR: DNS unexpectedly resolved — sinkhole is not in effect" >&2
|
|
exit 1
|
|
fi
|
|
echo "[ok] DNS UDP/53 is being dropped"
|
|
- name: build test binary
|
|
run: cd test && make test
|
|
- name: run GetAddrInfoAsyncCancelTest
|
|
run: |
|
|
cd test
|
|
ARCH=$(uname -m)
|
|
CPPHTTPLIB_TEST_ISSUE_2431=1 \
|
|
LSAN_OPTIONS=suppressions=lsan_suppressions.txt \
|
|
setarch "$ARCH" -R \
|
|
./test --gtest_filter='GetAddrInfoAsyncCancelTest.*'
|
|
|
|
macos:
|
|
runs-on: macos-latest
|
|
if: >
|
|
(github.event_name == 'push') ||
|
|
(github.event_name == 'pull_request' &&
|
|
github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name) ||
|
|
(github.event_name == 'workflow_dispatch' && github.event.inputs.test_macos == 'true')
|
|
strategy:
|
|
matrix:
|
|
tls_backend: [openssl, mbedtls, wolfssl]
|
|
name: macos (${{ matrix.tls_backend }})
|
|
steps:
|
|
- name: checkout
|
|
uses: actions/checkout@v4
|
|
- name: install Mbed TLS
|
|
if: matrix.tls_backend == 'mbedtls'
|
|
run: brew install mbedtls@3
|
|
- name: install wolfSSL
|
|
if: matrix.tls_backend == 'wolfssl'
|
|
run: brew install wolfssl
|
|
- name: build and run tests (OpenSSL)
|
|
if: matrix.tls_backend == 'openssl'
|
|
run: cd test && make test_split && make test_openssl_parallel
|
|
env:
|
|
LSAN_OPTIONS: suppressions=lsan_suppressions.txt
|
|
- name: build and run tests (Mbed TLS)
|
|
if: matrix.tls_backend == 'mbedtls'
|
|
run: cd test && make test_split_mbedtls && make test_mbedtls_parallel
|
|
- name: build and run tests (wolfSSL)
|
|
if: matrix.tls_backend == 'wolfssl'
|
|
run: cd test && make test_split_wolfssl && make test_wolfssl_parallel
|
|
- name: run fuzz test target
|
|
if: matrix.tls_backend == 'openssl'
|
|
run: cd test && make fuzz_test
|
|
- name: build and run WebSocket heartbeat test
|
|
if: matrix.tls_backend == 'openssl'
|
|
run: cd test && make test_websocket_heartbeat && ./test_websocket_heartbeat
|
|
- name: build and run ThreadPool test
|
|
run: cd test && make test_thread_pool && ./test_thread_pool
|
|
|
|
windows:
|
|
runs-on: windows-latest
|
|
if: >
|
|
(github.event_name == 'push') ||
|
|
(github.event_name == 'pull_request' &&
|
|
github.event.pull_request.head.repo.full_name != github.event.pull_request.base.repo.full_name) ||
|
|
(github.event_name == 'workflow_dispatch' && github.event.inputs.test_windows == 'true')
|
|
strategy:
|
|
matrix:
|
|
config:
|
|
- with_ssl: false
|
|
compiled: false
|
|
run_tests: true
|
|
name: without SSL
|
|
- with_ssl: true
|
|
compiled: false
|
|
run_tests: true
|
|
name: with SSL
|
|
- with_ssl: false
|
|
compiled: true
|
|
run_tests: false
|
|
name: compiled
|
|
name: windows ${{ matrix.config.name }}
|
|
steps:
|
|
- name: Prepare Git for Checkout on Windows
|
|
run: |
|
|
git config --global core.autocrlf false
|
|
git config --global core.eol lf
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
- name: Export GitHub Actions cache environment variables
|
|
uses: actions/github-script@v7
|
|
with:
|
|
script: |
|
|
core.exportVariable('ACTIONS_CACHE_URL', process.env.ACTIONS_CACHE_URL || '');
|
|
core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
|
|
- name: Setup msbuild on windows
|
|
uses: microsoft/setup-msbuild@v2
|
|
- name: Cache vcpkg packages
|
|
id: vcpkg-cache
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: C:/vcpkg/installed
|
|
key: vcpkg-installed-windows-gtest-curl-zlib-brotli-zstd
|
|
- name: Install vcpkg dependencies
|
|
if: steps.vcpkg-cache.outputs.cache-hit != 'true'
|
|
run: vcpkg install gtest curl zlib brotli zstd
|
|
- name: Install OpenSSL
|
|
if: ${{ matrix.config.with_ssl }}
|
|
run: choco install openssl
|
|
- name: Configure CMake ${{ matrix.config.name }}
|
|
run: >
|
|
cmake -B build -S .
|
|
-DCMAKE_BUILD_TYPE=Release
|
|
-DCMAKE_TOOLCHAIN_FILE=${{ env.VCPKG_ROOT }}/scripts/buildsystems/vcpkg.cmake
|
|
-DHTTPLIB_TEST=ON
|
|
-DHTTPLIB_COMPILE=${{ matrix.config.compiled && 'ON' || 'OFF' }}
|
|
-DHTTPLIB_USE_OPENSSL_IF_AVAILABLE=${{ matrix.config.with_ssl && 'ON' || 'OFF' }}
|
|
-DHTTPLIB_REQUIRE_ZLIB=ON
|
|
-DHTTPLIB_REQUIRE_BROTLI=ON
|
|
-DHTTPLIB_REQUIRE_ZSTD=ON
|
|
-DHTTPLIB_REQUIRE_OPENSSL=${{ matrix.config.with_ssl && 'ON' || 'OFF' }}
|
|
- name: Build ${{ matrix.config.name }}
|
|
run: cmake --build build --config Release -- /v:m /clp:ShowCommandLine
|
|
- name: Run tests ${{ matrix.config.name }}
|
|
if: ${{ matrix.config.run_tests }}
|
|
shell: pwsh
|
|
working-directory: build/test
|
|
run: |
|
|
$shards = 4
|
|
$procs = @()
|
|
for ($i = 0; $i -lt $shards; $i++) {
|
|
$log = "shard_${i}.log"
|
|
$procs += Start-Process -FilePath ./Release/httplib-test.exe `
|
|
-ArgumentList "--gtest_color=yes","--gtest_filter=${{ github.event.inputs.gtest_filter || '*' }}" `
|
|
-NoNewWindow -PassThru -RedirectStandardOutput $log -RedirectStandardError "${log}.err" `
|
|
-Environment @{ GTEST_TOTAL_SHARDS="$shards"; GTEST_SHARD_INDEX="$i" }
|
|
}
|
|
$procs | Wait-Process
|
|
$failed = $false
|
|
for ($i = 0; $i -lt $shards; $i++) {
|
|
$log = "shard_${i}.log"
|
|
if (Select-String -Path $log -Pattern "\[ PASSED \]" -Quiet) {
|
|
$passed = (Select-String -Path $log -Pattern "\[ PASSED \]").Line
|
|
Write-Host "Shard ${i}: $passed"
|
|
} else {
|
|
Write-Host "=== Shard $i FAILED ==="
|
|
Get-Content $log
|
|
if (Test-Path "${log}.err") { Get-Content "${log}.err" }
|
|
$failed = $true
|
|
}
|
|
}
|
|
if ($failed) { exit 1 }
|
|
Write-Host "All shards passed."
|
|
|
|
env:
|
|
VCPKG_ROOT: "C:/vcpkg"
|
|
VCPKG_BINARY_SOURCES: "clear;x-gha,readwrite"
|