aboutsummaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* zen-test: add CLI integration harness + TestArtifactProvider + CI host stats ↵Stefan Boberg2026-04-201-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | (#985) Establishes a new end-to-end integration test harness for the `zen` CLI, the shared fetcher it uses to pull test artifacts, and the CI plumbing that feeds both. Also lowers the default test-harness log level and broadens the artifact fetcher's credential resolution. ### `zen-test` executable (`src/zen-test/`) - New binary modeled on `zenserver-test`, built only in debug. - `zen-test.{h,cpp}` harness: spawns `zen.exe` via `CreateProc` and captures combined stdout/stderr into a `ZenCommandResult` for assertion. - Registered with `scripts/test.lua` under the short name `zen` (`xmake test --run=zen`) and enabled for `--kill-stale-processes`. - Prints a clear console message when invoked from a release build (tests disabled), so misconfiguration is easy to spot. - Documented in `CLAUDE.md` (test-suite naming table + test projects section) and `README.md`. - Test cases in the `zen.artifactprovider` suite: - `probe.lyra_cook_rpc_recording` — probe against a canonical Lyra cook RPC recording that skips with a diagnostic `MESSAGE` when no artifact source is configured. - `probe.s3_readme` — probes the configured S3 bucket for `README.md` using a fresh temp cache to force the request through to S3; skips on macOS without static creds (no EC2 Mac runners in our fleet). - `zen.utility-cmd` suite: new integration tests exercising `zen print`, `zen wipe`, and `zen copy`. ### `TestArtifactProvider` (`src/zenutil/testartifactprovider.{h,cpp}`) - `Ref<TestArtifactProvider>` factory returning a local-only or S3-backed provider, selected from env vars: - `ZEN_TEST_ARTIFACTS_PATH` — local directory to serve from (write-through cache for remote fetches). - `ZEN_TEST_ARTIFACTS_S3` — S3 URL to fetch from. - `AWS_DEFAULT_REGION` / `AWS_REGION`, `AWS_ENDPOINT_URL`, `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_SESSION_TOKEN` — standard AWS config. - `Exists(path)` / `Fetch(path)` API with a `TestArtifactFetchResult` return carrying the content buffer and a diagnostic error string. Content is cached on disk across test runs. - **IMDS credential fallback**: when no static `AWS_ACCESS_KEY_ID` is present, attaches an `ImdsCredentialProvider` so self-hosted EC2 runners with an attached IAM role can sign S3 requests without static credentials (mirrors the pattern in `zenserver/hub/hydration.cpp`). - **IMDS opt-out**: honors the standard `AWS_EC2_METADATA_DISABLED=true` env var, and skips IMDS by default on macOS where the link-local probe would just emit noise. ### Test harness log level (`src/zencore/testing.cpp`) - `TestRunner::ApplyCommandLine` now defaults the global log level to `Info` (was effectively `Trace`), cutting the noise from `xmake test --run=all` now that the suite has grown. Applies uniformly to `zencore-test`, `zenhttp-test`, `zenstore-test`, `zenutil-test`, `zenserver-test`, `zen-test`, etc. `--debug` (Debug) and `--verbose` (Trace) still opt back in when chasing failures. ### CI (`.github/workflows/validate.yml`) - **Runner info step** on all three platforms (Windows/Linux/macOS): prints host, CPU topology, memory, and disk usage before the build/test step, so flakes that correlate with a particular runner or low disk space are easy to spot. - **Artifact env wiring**: passes `ZEN_TEST_ARTIFACTS_S3` and `AWS_DEFAULT_REGION` into the debug Build & Test step on all three platforms so the probe can reach its source when the repo variable is configured. The probe skips cleanly when unset.
* Documentation updates (#882)Stefan Boberg2026-03-231-2/+2
| | | Restructured the docs folder in preparation for more docs. Improved the contents a bit.
* Allow pre-commit without it being in the PATH (#861)Devin Doucette2026-03-181-1/+1
| | | Running through `python -m pre_commit` avoids the need to have the directory containing `pre-commit` in the PATH. This is preferable when the path is subject to change such as `%LocalAppData%\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\site-packages`.
* native xmake toolchain definition for UE-clang (#805)Stefan Boberg2026-03-041-36/+32
| | | | | | | | | | | | | | | This change is meant to provide a smoother experience when working on Linux. After this change, the toolchain setup process is now simply ```bash $ scripts/ue_build_linux/get_ue_toolchain.sh ``` and then at config time the toolchain is automatically detected if you downloaded it to the default location or have the `UE_TOOLCHAIN_DIR` environment variable set ```bash xmake config --mode=debug ``` Compared to the old script-based approach this configures the toolchain more precisely, avoiding leakage into unrelated build processes such as when a package manager decides to build something like Ninja locally etc.
* Update README.mdStefan Boberg2026-03-021-2/+1
|
* ZenServerProcess API changes (#719)Stefan Boberg2026-01-191-5/+15
| | | | | | | This refactor aims to improve the `ZenServerProcess` classes by making them useful for managing child zenserver instances in more scenarios than just automated tests. This involves changing some functions to not talk about "test directory" and instead use "data directory" etc As a consequence of the API changes, some tests have changed accordingly. The code includes som reference to the "hub" mode but there is not yet any other code using this mode, it's just included in this PR to simplify future merges.
* switch to xmake for package management (#611)Stefan Boberg2025-11-071-93/+6
| | | | | | | | | | | | | | | | | | | | | | This change removes our dependency on vcpkg for package management, in favour of bringing some code in-tree in the `thirdparty` folder as well as using the xmake build-in package management feature. For the latter, all the package definitions are maintained in the zen repo itself, in the `repo` folder. It should now also be easier to build the project as it will no longer depend on having the right version of vcpkg installed, which has been a common problem for new people coming in to the codebase. Now you should only need xmake to build. * Bumps xmake requirement on github runners to 2.9.9 to resolve an issue where xmake on Windows invokes cmake with `v144` toolchain which does not exist * BLAKE3 is now in-tree at `thirdparty/blake3` * cpr is now in-tree at `thirdparty/cpr` * cxxopts is now in-tree at `thirdparty/cxxopts` * fmt is now in-tree at `thirdparty/fmt` * robin-map is now in-tree at `thirdparty/robin-map` * ryml is now in-tree at `thirdparty/ryml` * sol2 is now in-tree at `thirdparty/sol2` * spdlog is now in-tree at `thirdparty/spdlog` * utfcpp is now in-tree at `thirdparty/utfcpp` * xmake package repo definitions is in `repo` * implemented support for sanitizers. ASAN is supported on windows, TSAN, UBSAN, MSAN etc are supported on Linux/MacOS though I have not yet tested it extensively on MacOS * the zencore encryption implementation also now supports using mbedTLS which is used on MacOS, though for now we still use openssl on Linux * crashpad * bumps libcurl to 8.11.0 (from 8.8.0) which should address a rare build upload bug
* move cpr in-tree (#605)Stefan Boberg2025-10-241-8/+8
| | | | | | * added cpr 1.10.5 in-tree to allow updates to vcpkg without breaking the build * added asio 1.29.0 in-tree to remove one more vcpkg dependency * bumped vcpkg to 2024.06.15 to address failure to build due to use of deprecated binaries in vcpkg (404 error: `https://mirror.msys2.org/mingw/mingw64/mingw-w64-x86_64-pkgconf-1~2.1.0-1-any.pkg.tar.zst` during build)
* update readme with required vcpkg version (#496)Dan Engelbrecht2025-09-151-8/+17
| | | - Improvement: Updated README.md to state the required version vcpkg
* Update README.mdStefan Boberg2025-06-021-5/+2
|
* Mrp/referencedset (#174)Matt Peters2024-10-041-1/+1
| | | | * zen.exe commands: Add initializers for all POD types; this fixes incorrect behavior for flags in debug * README.md: Fix typo in --no-dry-run line
* Add instructions to README.md for upgrading third party libraries (#173)Matt Peters2024-09-271-0/+11
|
* Added brief section on building for macOS with multiple usersMartin Ridgers2024-09-181-0/+11
|
* Use an example where xmake determines the build architecture for macOSMartin Ridgers2024-09-181-1/+1
|
* Correct header depth for Mac sub-sectionsMartin Ridgers2024-09-181-4/+4
|
* bump vcpkg and xmake to latest (#40)Dan Engelbrecht2024-04-241-9/+12
| | | - Improvement: Bumped xmake to 2.9.1 and vcpkg version to 2024.03.25
* added notes on how to install git hooksStefan Boberg2024-03-131-0/+1
|
* Update README.mdStefan Boberg2024-03-131-1/+1
| | | updated pre-commit installation instructions
* Update README.mdStefan Boberg2024-01-311-1/+1
|
* Update README.mdStefan Boberg2024-01-301-4/+7
|
* Update README.mdStefan Boberg2024-01-301-8/+4
|
* Update README.mdStefan Boberg2023-11-291-1/+1
|
* Update README.mdStefan Boberg2023-11-291-5/+0
|
* Update README.mdStefan Boberg2023-11-151-3/+1
|
* updated xmake versions in READMEStefan Boberg2023-11-151-4/+4
|
* Change default port to 8558zousar2023-10-111-2/+2
| | | | Changes the default port without altering config for shared instances.
* README.md updateStefan Boberg2023-10-041-2/+2
|
* README.md update - merge from sb/protoStefan Boberg2023-06-291-2/+1
|
* Update README.mdv0.2.14-pre1Stefan Boberg2023-06-161-3/+3
|
* Update README.mdStefan Boberg2023-05-031-1/+1
|
* Update README.mdStefan Boberg2023-05-031-0/+1
|
* Update README.mdStefan Boberg2023-05-031-1/+1
|
* moved source directories into `/src` (#264)Stefan Boberg2023-05-021-1/+1
| | | | | | * moved source directories into `/src` * updated bundle.lua for new `src` path * moved some docs, icon * removed old test trees
* Update README.mdStefan Boberg2023-04-131-7/+1
|
* Updated VS instructionsStefan Boberg2023-04-121-1/+2
|
* Update installation instructions Stefan Boberg2023-04-121-10/+13
| | | Now includes information on how to use `winget` to streamline installation
* Update installation instructions Stefan Boberg2023-04-121-9/+18
| | | Now includes information on how to use `winget` to streamline installation
* Added some notes to the Mac installation instructionsStefan Boberg2023-03-291-1/+2
|
* removed catch2 (#241)Stefan Boberg2023-03-071-1/+9
| | | removed catch2 since it's de facto not supported due to the lack of multithreading support
* Update README.mdStefan Boberg2023-02-091-1/+1
|
* Update README.mdStefan Boberg2023-02-091-0/+3
|
* Added xmake install step to README.mdStefan Boberg2023-02-091-0/+1
|
* Updated README.mdStefan Boberg2023-02-011-2/+10
|
* Update README.mdStefan Boberg2023-02-011-9/+6
|
* Update README.mdStefan Boberg2022-12-101-1/+1
|
* Add pkg-config requirement to README.mdDan Engelbrecht2022-09-131-0/+6
|
* Update README.mdStefan Boberg2022-06-081-6/+5
|
* Update README.mdStefan Boberg2022-06-081-9/+9
|
* Fix invalid xmake links in README (#124)ruki2022-06-081-1/+1
|
* Update README.mdStefan Boberg2022-06-071-3/+9
|
generated by cgit v1.2.3 (git 2.25.1) at 2026-06-07 00:27:51 +0000