Files
jak-project/third-party/curl/docs/tests/CI.md
T
Alexander J. Semenuk 5d5e35fb9b fix: Windows toolchain compatibility (curl 8.21 re-vendor, endless reconfigure loop) (#4355)
## Problem

Windows builds break with a current local toolchain (Scoop LLVM 22.1.8,
CMake 4.4.0, VS 2026), in two independent ways:

1. The build stops at curl's deliberate guard: `#error "no non-blocking
method was found/used/set"` in `third-party/curl/lib/nonblock.c`.
2. From the second configure onward, `cmake --build` re-runs CMake in an
endless loop (observed 42 consecutive reconfigure cycles in a single
build). Likely the same mechanism behind the "endlessly building" VS
2026 note in `docs/setup/dev/vs.md`.

## Root cause

1. `third-party/curl/CMake/CurlTests.c` passes `int *` to
`ioctlsocket()`, whose third parameter is `u_long *`. Clang 22 promotes
`-Wincompatible-pointer-types` to a hard error in C, so the
`HAVE_IOCTLSOCKET_FIONBIO` try_compile silently fails and
`curl_config.h` never defines it. Upstream CI does not see this because
the windows-2022 runner image ships an older LLVM. GCC 14 promotes the
same warning to a hard error, which is very likely the `CurlTests.c.obj`
failure reported from MSYS2 in open-goal/jak-project#3551. Upstream curl
hit the identical problem with GCC 14 and fixed the probe in curl 8.8.0
(curl/curl#13578).
2. The root CMakeLists copies the build tree's `compile_commands.json`
into `<src>/build/` for clangd using `configure_file()`, which registers
its input as a configure dependency. CMake rewrites
`compile_commands.json` late in every generation, after
`CTestTestfile.cmake` and `cmake_install.cmake` (outputs of the same
Ninja regen rule), so once the dependency is registered the rule is
deterministically dirty and every `ninja` invocation re-runs CMake. A
pristine first configure is safe (the file does not exist yet, so the
`if(EXISTS ...)` guard skips the copy), which is why the loop looks
machine- or IDE-specific.

## Fix

1. Per review, re-vendor `third-party/curl` at the `curl-8_21_0` tag
(previously `curl-8_3_0`), which carries the upstream probe fix plus two
years of upstream development; `vendor.yaml` updated to match.
Adjustments the version jump forced:
- curl 8.15 removed the native macOS Secure Transport backend
(`CURL_USE_SECTRANSP`), so macOS now builds curl against OpenSSL like
Linux. The two macOS workflows install Homebrew `openssl@3` and export
`OPENSSL_ROOT_DIR` (keg-only), and the macOS setup docs gained the same
two lines.
- `CURL_BROTLI` / `CURL_ZSTD` switched to AUTO-detection in curl 8.10;
pinned OFF to keep the previous no-compression behavior and avoid
silently linking whatever the CI images happen to have.
- curl's new top-level `BUILD_EXAMPLES` cache option (default ON) leaked
into discord-rpc's identically named option and broke configure at a
nonexistent `examples/send-presence` directory; pinned OFF ahead of the
third-party subdirectories.

The diff is dominated by the mechanical tag-tree swap under
`third-party/curl` (linguist-vendored, collapsed in review). The
hand-written changes are `CMakeLists.txt`, the two macOS workflows,
`docs/setup/system/macos.md`, and `vendor.yaml`.
2. Swap `configure_file()` for `file(COPY ...)`: the same clangd copy
with no configure dependency registered. (`file(COPY_FILE ...
ONLY_IF_DIFFERENT)` would be cleaner still but requires CMake 3.21,
above the declared `cmake_minimum_required(VERSION 3.10)`.)

## Test plan

- [x] Fresh `cmake --preset Release-windows-clang` (LLVM 22, no cache
seeding) completes and logs `Enabled SSL backends: Schannel`; the
FIONBIO probe passes without the previous `#error`
- [x] Full Windows Release build from scratch in the branch worktree
(all 1422 targets)
- [x] goalc-test suite: 1509 passed, 0 failed
- [x] Second consecutive configure with `compile_commands.json` present:
the regen rule in `build.ninja` has no `compile_commands.json` input;
`<src>/build/compile_commands.json` is still refreshed for clangd
- [x] Repeated `ninja` invocations after a full build no longer re-run
CMake
- [x] macOS Intel and ARM CI green (first exercise of the OpenSSL
backend switch)

---

I work off a self-hosted forge, so this GitHub account is quiet; the
configure logs and ninja dirty-node traces from the investigation are
available if anyone wants the raw data.

(AI-assisted)
2026-07-27 19:19:18 -04:00

3.6 KiB
Vendored
Generated

Continuous Integration for curl

curl runs in many different environments, so every change is run against a large number of test suites.

Every pull request is verified for each of the following:

  • it still builds, warning-free, on Linux, macOS, Windows, BSDs, with both clang and gcc, autotools and cmake, out-of-tree and in-tree.
  • it still builds fine on Windows with all supported MSVC versions
  • it follows rudimentary code style rules
  • the test suite still runs 100% fine
  • the release tarball (the "dist") still works
  • different TLS backends and options still compile and pass tests

If the pull-request fails one of these tests, it shows up as a red X and you are expected to fix the problem. If you do not understand what the issue is or have other problems to fix the complaint, ask and other project members can likely help out.

Consider the following table while looking at pull request failures:

CI platform as shown in PR State What to look at next
Linux / macOS / Windows / ... stable all errors and failures
Fuzzer stable fuzzing results
Code analyzers stable new findings
checkdocs / checksrc / dist / ... stable all errors and failures
AppVeyor stable all errors and failures
buildbot/curl_Schannel ... stable all errors and failures
curl.curl (linux ...) stable all errors and failures

Sometimes the tests fail or run slowly due to a dependency service temporarily having issues, for example package downloads, or virtualized (non-native) environments. Sometimes a flaky failed test may occur in any jobs.

Windows jobs have a number of flaky issues, most often, these:

  • test run hanging and timing out after 20 minutes.
  • test run aborting with 2304 (hex 0900) or 3840 (hex 0F00).
  • test run crashing with fork errors.
  • steps past the test run exiting with -1073741502 (hex C0000142).

In these cases you can try to update your pull requests to rerun the tests later as described below.

A detailed overview of test runs and results can be found on Test Clutch.

CI servers

Here are the different CI environments that are currently in use, and how they are configured:

GitHub Actions (GHA)

GitHub Actions runs the following tests:

  • Tests with a variety of different compilation options, OSes, CPUs.
  • Fuzz tests (see the curl-fuzzer repo for more info).
  • Static analysis and sanitizers: clang-tidy, address sanitizer, memory sanitizer, thread sanitizer, CodeQL, valgrind, torture tests.

These are each configured in different files in .github/workflows.

AppVeyor CI

AppVeyor runs a variety of different Windows builds, with different compilation options.

As of October 2025 @bagder, @mback2k, @jay, @vszakats, @dfandrich and @danielgustafsson have administrator access to the AppVeyor CI environment. Additional admins/group members can be added on request.

The tests are configured in appveyor.yml.

Circle CI

Circle CI runs a basic Linux test suite on Ubuntu for both x86 and ARM processors. This is configured in .circleci/config.yml.

You can view the full list of CI jobs on Circle CI's website.

@bagder has access to edit the "Project Settings" on that page. Additional admins/group members can be added on request.