Repository navigation
chore(xtest): report why docker compose failed to start - #638
Merged
Merged
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage |  |
Docstring coverage is 36.36% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 11 functions across 3 files. | Write docstrings for the functions missing them to satisfy the coverage threshold. |
-
Check name Status Explanation Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly identifies the main change: reporting why docker composefailed to start. Thechore(xtest)scope is less precise than the affectedotdf-localcomponent, but the title remains r…
- Fix all pre-merge checks with AI
✨ Finishing Touches 💡 2
-
📝 Generate docstrings 💡
-
- Commit to this branch
- Create a new PR
🛠️ Fix failing CI checks 💡
-
- Commit to this branch
- Create a new PR
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
A rabbit checked the Compose logs,
And found the fault among the fog.
The CLI shared what errors said,
A fresh start cleared the stale instead.
Then hops resumed, all paths ahead.
Comment @coderabbitai help to get the list of available commands.
dmihalcik-virtru
force-pushed
the
DSPX-4372-fix-docker-error
branch
from
October 14, 2026 12:37
d064936 to
4654432
Compare
|
dmihalcik-virtru
changed the title
pflynn-virtru
approved these changes
Oct 14, 2026
Contributor
|
Review finding:
Suggested fix: if not docker.start():
print_error(docker.start_error or "Failed to restart Docker services")
raise typer.Exit(1)This would make docker restart match the platform/KAS restart failure handling. |
Member
Author
dmihalcik-virtru
added a commit
that referenced
this pull request
Oct 21, 2026
Stages are milestones, not pull requests. Records the stack each stage lands as, with branch names; runs stages 2 and 3 as parallel tracks from main, since they share no imports; and adds a size budget and refactor-first rule to the merge discipline. Also brings the plan up to date: the work that landed as separate fixes (#638, #640, #641, #647), #622's payload sizes, item 7's move into stage 3, the neutral-nightly gap (DSPX-5260), and scratch-disk scheduling (DSPX-5253). Signed-off-by: Dave Mihalcik <dmihalcik@virtru.com>
dmihalcik-virtru
added a commit
that referenced
this pull request
Oct 30, 2026
… record benchmark arms (#626) ## TL;DR Adds **`otdf-sdk-mgr install benchmark <sdk> <ref>...`**: one command that resolves any number of SDK refs (releases, branches, SHAs, `pr:N`) to commits, installs them side by side under `xtest/sdk/<sdk>/dist/`, and writes a manifest recording exactly which commit is in each directory. It makes comparing SDK variants a local, one-command job instead of a CI dispatch or a hand-built set of `dist/` directories. It is part 2c of the [DSPX-4372-t1 plan](#657), based on `main` now that #667 and #668 (the manifest contract) have merged, and it is the preparation step CI will share (#660). ## Why: quicker local testing of multiple SDK variants Today, there are two ways to compare SDK builds: - **Dispatch the xtest workflow with `run-benchmarks`.** That is about 45 minutes per SDK per attempt, and a mis-set input (`main` rather than `main latest`) spends the whole run before it says so. - **Reproduce locally**, per `xtest/perf/README.md`: "whatever two builds you want, side by side under `sdk/<name>/dist/`". You install each build yourself and need to know: - whether each ref is a release or a source build, and the right `--ref` for it; - which directory it will land in: `pr:123` builds into `refs--pull--123--head`, and `otdfctl/v0.24.0` and `v0.24.0` share `dist/v0.24.0`; - how to provision `otdfctl` and the platform separately. Nothing records which commit a directory holds. A `dist/main` left from last week is measured, and labelled, as today's `main`. With this PR: ```bash otdf-sdk-mgr install benchmark go v0.38.0 main pr:123 --platform main --otdfctl v0.38.1 ``` - **Any number of variants in one command.** Refs are kept in order, and the first one is the reference. Stage 3 (#658) measures up to four. - **Fails fast.** Every ref, and the `--otdfctl` pin, is resolved to a full commit before anything builds, so a mistyped branch or tag costs a lookup rather than minutes of compilation. Two refs that would share one `dist/` directory at different commits are rejected before either builds. (A full SHA is not checked to exist; see Follow-ups.) - **Doesn't measure a commit against itself.** If every ref resolves to one commit, preparation stops with `neutral` instead of benchmarking A against A. - **Cheap re-runs.** A source build records its commit in `dist/<slug>/.version` and is reused only when that record matches. Re-running after pushing to a branch rebuilds the branch, not everything. The record is all it checks, so after a hand `make` of local edits, delete `dist/<slug>` (the README says so). - **A manifest instead of hand-built env vars.** `xtest/sdk/benchmark.installed.json` records, for each arm, the requested alias, repository, commit, `dist/` directory and install method, plus the platform and `otdfctl` pins. `otdf-local env` exports its path and the `otdfctl` pin (#642), and from #670 `pytest --bench` reads the arms from it. Until then, name the arms with `--bench-baseline`/`--bench-candidate`, as the README now says. CI runs this same command (#660), so a local result and a CI result come from the same preparation. ## What's in this PR - **`install benchmark`** (`cli_install.py`, `bench_prepare.py`) resolves, checks for collisions, installs releases via `install_release` and source refs via `cmd_tip`, then installs the platform and the `otdfctl` pin. - **Separate provisioning pin.** `--otdfctl` is recorded apart from the measured arms. It joins the collision check only when it shares the arms' `dist/` tree, which is only the case for Go. - **Collision and neutral checks** run before anything builds. They, `dist_slug`, and the manifest's data model are in #668; this PR is the command that uses them. - **Manifest** (schema `v1alpha1`, defined in #668). The status is `success`, `neutral`, `partial` or `failed`, with a `status_message`: - `failed` means nothing was installed; `partial` means some installs completed but not all. - The manifest is written on every exit path, an exception or Ctrl-C included. - The exit code is 0 for `success` or `neutral`, 1 otherwise. **Size.** About 640 non-test lines, over the plan's ~400-line budget. About 315 of them are code; the rest are docstrings, comments and the README section. Resolution, installation and the manifest's exit paths are one command: a PR that resolved without installing would ship a command that does nothing. Two thirds of the diff is tests. **Since the first review:** - Java release arms resolved nothing, because the wrong tag infix was used. Fixed. - The manifest now has one write site: `status` is required, reads check `schema_version`, and writes create the parent directory and replace the file atomically. - JS release arms land in `dist/vX.Y.Z`. - `platform` is rejected as an SDK. - The platform pin records the directory it was installed to. - A first-arm failure is now `failed`, not `partial`. **Since review of #668:** - **Abbreviated commits are rejected.** A ref that resolves to a commit that isn't a full SHA (in practice, an abbreviated SHA that no branch, tag or PR head points at) now fails before anything installs: "give the full commit SHA for …", with a `failed` manifest and exit code 1. Before, `abc1234` and its own full SHA weren't recognised as one build, so the commit was built twice and reported as `success`. Reusing a `dist/` directory and detecting a moved ref now compare full SHAs exactly. - An empty ref list fails instead of writing a `success` manifest with no arms. Every manifest written sets `metadata.sdk` and passes #668's strict reader. - Platform and `otdfctl` install failures are caught narrowly (`PlatformInstallError`, `BenchPrepareError`, `OSError`). Anything else aborts with its traceback, and the manifest records `partial` "Preparation aborted", as arm installs already did. A platform whose `.version` has no full commit is `partial`. **Since the 2026-10-29 review:** - An arm whose stale `dist/` cannot be removed (`OSError`) is now `failed`/`partial` with the error, like the `otdfctl` pin, rather than "Preparation aborted". - If the *first* manifest write fails, the CLI no longer prints "Manifest: …" pointing at an earlier run's file. `prepare_benchmark` raises `BenchPrepareError` for that case. `RuntimeError` is no longer caught around the whole run: `xtest/sdk` is located up front, `--manifest` or not. - The CLI tests now go through Typer (`CliRunner().invoke(install_app, …)`), so a lost registration or renamed option fails them. They also assert a clean `typer.Exit`, since `CliRunner` reports an uncaught exception as exit 1 too. - New tests: - npm-only js releases: one version is `neutral` ("whose commit is unknown"), two versions are not; - a dist of unknown provenance is emptied before rebuilding; - an arm `OSError`; - a failed final write. - Comments: two were wrong and are now corrected: - the repeated-builds example `v0.38.0 main` is in fact neutral, so it is now `v0.38.0 main pr:123`; - the `otdfctl` pin "never provisions the fixtures it is measured against" contradicted `check_collision`. Stale ones fixed: js tags are `sdk-vX.Y.Z`; the go fallback affects `v0.30.x`, not "older tags"; the java Makefile sources `java/<slug>.env`. The `# type: ignore` is gone, and the CLI help example now uses `v0.38.0`/`v0.38.1`. - README: - says reuse trusts `.version`, and that a release `dist/` is reused as is; - says a full SHA is not checked; - says `pytest --bench` doesn't read the manifest yet. **Validation** (on this commit): - `uv run pytest` 404 passed; ruff check, ruff format and pyright are clean, with no `noqa` or `type: ignore`. - Each new test was checked against a deliberate break of the code it covers: the unregistered command, the missing `rmtree`, the uncaught arm `OSError`, the unwrapped first write and the neutral message all fail at least one test. - Live, from an empty `xtest/sdk/go`: - `install benchmark go v0.38.0 main --otdfctl v0.38.1` gave `success`, exit 0. The arms were `v0.38.0` at `308002c2` (release) and `main` at `ef874839` (source). `dist/main/.version` matches `git -C src/main rev-parse HEAD`. The pin was `v0.38.1` at `99b51145`. - The same command re-run gave `success` in 1.4 s, with nothing rebuilt. - `install benchmark go 0e4b0d1 main` gave `failed`, "give the full commit SHA for 0e4b0d1", with exit 1 and no arms. - `--manifest` under a regular file gave "Error: cannot write the manifest …", exit 1, and no "Manifest:" line. - The platform pin (`--platform`) was not exercised live on this commit; its last live run predates the review fixes. ## Stack ([DSPX-4372-t1 plan](#657)) Two parallel tracks from `main`; they share no imports and meet in stage 5. | Part | PR | Base | |---|---|---| | 2a: bare-repo and js install fixes | #667 (merged) | `main` | | 2b: manifest contract | #668 (merged) | `main` | | 2c: `install benchmark` | **#626 (this PR)** | `main` | | 2d: `otdf-local env` exports | #642 | 2c | | 3a: arms as a tuple | #669 | `main` | | 3b: two to four arms | #658 | 3a | | 3c: pytest reads the manifest | #670 | 3b | | 4: candidate-to-candidate conclusions | #659 | 3c | | 5, 6: CI and report | #660, #661 | not yet moved onto these stacks | #667 and #668 were split out of this PR so the fixes and the contract can be reviewed on their own. Split out of an earlier version so they could land first: #638, #639, #640 and #641, all merged. #647, the golden-key configuration CI needs once `otdf-local` starts the platform, is still open. **Related, independent of this stack:** #684 makes go release installs put a real `otdfctl` binary in `dist/`. Before it, a go release arm ran `go run` on every call (about 370 ms wall and 1 s CPU, against 54 ms for the binary), while source-built candidates ran a binary. That made release baselines look slower than they are. ## Follow-ups None of these blocks merge. All but the "Re-run" message are now noted in the code or the README. - **Go repository URL.** Go arms are all recorded under the monorepo URL. The monorepo carries `otdfctl/v0.10.0`–`v0.29.0` at the archived repo's commits, but not `v0.30.x`, which `resolve` answers from the archived repo. That makes `v0.30.x` arms the ones recorded with a commit the monorepo lacks. The fix needs `resolve` to report the repo it matched. - **Fallback on any error.** Go resolution falls back to the archived otdfctl repo whenever the monorepo lookup fails, so a transient error can resolve `main` or `pr:N` against the wrong repo. A source arm then fails the read-back, but the error says "the ref moved". - **Unhelpful "Re-run" advice.** "The ref moved… Re-run" is wrong for a worktree that `is_mutable_ref` treats as fixed (full SHAs; web-sdk `release/x.y.z` branches). Checkout never resets those, so a re-run fails the same way. The message should name `src/<slug>` and say to delete it. - **Reuse trusts `.version`.** The SDK Makefiles rebuild into `dist/<slug>` without touching `.version`, and `_built_commit` doesn't check for a dirty worktree. The README now tells users to delete the directory; a code check (`git status --porcelain`, a binary hash) would be better. - **Release dists reused as is.** A release arm adopts an existing `dist/<tag>` (`install_release`'s skip), including a half-finished install. - **Full SHAs unverified.** A typo fails at checkout after the arms before it have built, giving `partial`. - **`--platform` not resolved up front.** It is not resolved before the arms build: `--platform latest` becomes `service/vlatest` and fails after every build. The release/source label for the pin is also a `startswith("v")` guess; both installers build from source. **Downstream:** #642 is rebased onto this commit with no conflicts (it touches only `otdf-local` and `xtest/perf/README.md`). Its local-run example uses `--otdfctl v0.30.0`, one of the `v0.30.x` tags above; `v0.38.1` would avoid that. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## Summary by CodeRabbit * **New Features** * Added an `install benchmark` command to prepare SDK benchmarks from ordered references, with optional platform and CLI tool artifacts. * Benchmark preparation validates references and installation conflicts, reuses matching builds, and records progress and results in a manifest. Results distinguish successful, neutral, partial, and failed preparations. * **Documentation** * Added guidance for preparing benchmarks and troubleshooting common test failures. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Signed-off-by: Dave Mihalcik <dmihalcik@virtru.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Split out of #626.
DockerService.startcaptureddocker compose up's output and returned a bareFalse, sootdf-local updied with "✗ Failed to start Docker services" and nothing else — the only way to learn why was to rerun compose by hand.It now populates the
start_errorthe base class already defines (the useful lines of compose's output, or a note that it exited silently, or the missing compose file), andupprints it. Found by hitting it: the real message waserror while creating mount source path ... chown ...: permission denied.Tests:
otdf-local/tests/test_startup_failures.py— captured compose stderr is reduced to the failing line; silent non-zero exit; missing compose file; stale error cleared on retry.Summary by CodeRabbit