mirror of
https://github.com/logos-co/logos-cpp-sdk.git
synced 2026-08-31 01:31:10 +00:00
Dario LipicarandClaude Opus 5
f8e879de36
The generator emits `<dep>_api.{h,cpp}` in two type surfaces -- Qt-typed
(QString, the default) and lp (std types, Qt-free) -- and they are separately
generated bodies of code. All 7 module definitions across the 5 existing specs
declare `"interface": "universal"`, which resolves to ApiStyle::Lp. No job in
this repository compiled or executed a single line of the Qt emission, and the
consumers that actually use it are real ones: wallet-ui's backend and the
tutorial's C++ UI backend.
The new spec builds an `interface: universal` notifier and a Qt provider-style
watcher (no `interface` key -> LOGOS_API_STYLE defaults to qt), loads both in a
logoscore daemon, fires the notifier and asks the watcher what arrived.
The watcher subscribes from onInit(), not from a method the spec calls later.
That is deliberate: onInit() runs while the dependency's host process has been
spawned and has not yet called listen(), which is both the shape every real C++
consumer has and the case a reachability probe answers "no" to. Asserting
`subscriptionAccepted` AND `lastGreeted` separates "refused at subscribe time"
from "subscribed, module is just quiet" -- the two failures look identical from
the callback alone.
A zero-count control runs before the emit so the delivered count means
something, and the count is re-read after, because a subscription that re-armed
and fired twice is as wrong as one that never fired.
Co-authored-by: Claude Opus 5 <noreply@anthropic.com>
102 lines
4.1 KiB
Bash
Executable File
102 lines
4.1 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
#
|
|
# Execute the cpp-sdk doc-tests end-to-end and regenerate their Markdown.
|
|
#
|
|
# Specs run here:
|
|
# - cpp-sdk-module-runtime.test.yaml a real module (accounts) built and
|
|
# run through logoscore against this SDK
|
|
# - cpp-sdk-module-composition.test.yaml two modules built against this SDK,
|
|
# one calling the other over IPC
|
|
# - cpp-sdk-qt-api-events.test.yaml a Qt-typed consumer subscribing to a
|
|
# dependency's event from onInit()
|
|
#
|
|
# The runner is the shared `doctest` CLI
|
|
# (https://github.com/logos-co/logos-doctest), invoked directly via its flake.
|
|
# `doctest run` executes every command in a temp directory and asserts on the
|
|
# output; `doctest generate` renders each spec to Markdown under outputs/;
|
|
# `doctest clean` strips build artifacts so only the generated docs remain.
|
|
#
|
|
# To run against a local logos-doctest checkout instead of the published flake,
|
|
# set DOCTEST, e.g.: DOCTEST="nix run path:../../logos-doctest --" ./run.sh
|
|
#
|
|
set -euo pipefail
|
|
|
|
# Run from this doctests/ directory regardless of where the script is invoked from.
|
|
cd "$(dirname "$0")"
|
|
|
|
# The doctest CLI. Override by exporting DOCTEST (space-separated command).
|
|
read -r -a DOCTEST <<< "${DOCTEST:-nix run github:logos-co/logos-doctest --}"
|
|
OUTPUT_DIR="./outputs"
|
|
SPECS=(
|
|
"cpp-sdk-module-runtime.test.yaml"
|
|
"cpp-sdk-module-composition.test.yaml"
|
|
"cpp-sdk-worker-thread-http.test.yaml"
|
|
"cpp-sdk-concurrent-dispatch.test.yaml"
|
|
"cpp-sdk-generator-roundtrip.test.yaml"
|
|
"cpp-sdk-qt-api-events.test.yaml"
|
|
)
|
|
|
|
# Build the doc-tests against THIS repo's current commit rather than the latest
|
|
# published flake. Each spec overrides `logos-cpp-sdk` with
|
|
# `github:logos-co/logos-cpp-sdk{release}`, and the pin below makes {release}
|
|
# expand to $COMMIT — so every layer is built against exactly what's checked out
|
|
# here. Override by exporting COMMIT (e.g. a tag), or set COMMIT="" to fall back
|
|
# to latest master.
|
|
#
|
|
# Note: nix fetches the commit from the GitHub remote, so $COMMIT must be pushed
|
|
# to logos-co/logos-cpp-sdk. A local-only / uncommitted HEAD won't resolve;
|
|
# export COMMIT="" (or push first) in that case.
|
|
COMMIT="${COMMIT-$(git rev-parse HEAD)}"
|
|
RELEASE_FOR=()
|
|
if [ -n "${COMMIT}" ]; then
|
|
RELEASE_FOR=(--release-for "logos-cpp-sdk=${COMMIT}")
|
|
echo "==> Pinning logos-cpp-sdk to ${COMMIT}"
|
|
else
|
|
echo "==> COMMIT empty; building against latest logos-cpp-sdk master"
|
|
fi
|
|
|
|
echo "==> Clearing previous ${OUTPUT_DIR}/"
|
|
# A prior run copies module artifacts out of the read-only nix store, so the
|
|
# directories land read-only (r-x) too. `rm -rf` can't delete files inside a
|
|
# directory it can't write to, so restore write permission first.
|
|
if [ -e "${OUTPUT_DIR}" ]; then
|
|
chmod -R u+w "${OUTPUT_DIR}" 2>/dev/null || true
|
|
fi
|
|
rm -rf "${OUTPUT_DIR}"
|
|
mkdir -p "${OUTPUT_DIR}"
|
|
|
|
for SPEC in "${SPECS[@]}"; do
|
|
name="$(basename "${SPEC%.test.yaml}")"
|
|
# Each spec runs in its OWN workdir under outputs/. They must not share one:
|
|
# a standalone spec uses --output-dir directly as its working tree, and the
|
|
# runtime spec leaves read-only nix-store copies under modules/ that a second
|
|
# spec's `cp` into the same tree could not overwrite. The rendered .md is
|
|
# still written flat into outputs/ (matching the .gitignore keep rule).
|
|
spec_out="${OUTPUT_DIR}/${name}"
|
|
mkdir -p "${spec_out}"
|
|
|
|
echo "==> Running ${SPEC} into ${spec_out}/"
|
|
# ${RELEASE_FOR[@]+...} guards the expansion so an empty array doesn't trip
|
|
# `set -u` on older bash (e.g. macOS's stock 3.2).
|
|
"${DOCTEST[@]}" run "${SPEC}" \
|
|
--verbose \
|
|
--continue-on-fail \
|
|
${RELEASE_FOR[@]+"${RELEASE_FOR[@]}"} \
|
|
--output-dir "${spec_out}/"
|
|
|
|
echo "==> Generating ${OUTPUT_DIR}/${name}.md"
|
|
"${DOCTEST[@]}" generate "${SPEC}" \
|
|
${RELEASE_FOR[@]+"${RELEASE_FOR[@]}"} \
|
|
-o "${OUTPUT_DIR}/${name}.md"
|
|
done
|
|
|
|
if [ ! -d "${OUTPUT_DIR}" ]; then
|
|
echo "==> No ${OUTPUT_DIR}/ produced; nothing to clean."
|
|
exit 0
|
|
fi
|
|
|
|
echo "==> Cleaning build artifacts from ${OUTPUT_DIR}/"
|
|
"${DOCTEST[@]}" clean "${OUTPUT_DIR}" --verbose
|
|
|
|
echo "==> Done. Rendered docs are in ${OUTPUT_DIR}/"
|