Files
onyx/tools/ods/cmd/object_store_test.go
roshan a8033533d1 refactor(ods): unify launchers and protect shared infrastructure (#16246)
## Description

Make ODS reuse shared development infrastructure by default, with
`--isolated` for separate datasets.

- Use the same service specifications and launchers for `stack`, `web
dev`, and `backend` commands. Remove the duplicate `stack
--frontend-only` option.
- Enforce project ownership across checkouts and resolve database
commands to the actual managed database.
- Stop services before pending migrations, preserve them when already at
head, and reject manual migrations beneath managed services.
- Harden startup cancellation, shutdown grace, descendant cleanup,
terminal input, and frontend API validation. Preserve Windows foreground
commands.
- Consolidate environment helpers, protect symlinked environment files,
propagate restore errors, and update help and documentation.

This PR contains only ODS and its development-stack skill. It does not
include the plugins implementation.

## How Has This Been Tested?

- Targeted command and regression tests using fake tools and disposable
Git repositories.
- Race tests for runtime targeting, ownership, migration ordering,
process cleanup, and terminal input.
- `go vet ./...`, pre-commit checks, native builds, and Windows
cross-builds.
- The full Go suite was run. Its remaining failures are the existing
macOS devcontainer SSH-mount fixture expectations in
`TestDevcontainerCommands` and `TestRunDevRebuild`.

No real database migrations, restores, or development-stack restarts
ran. Native Windows execution remains untested.

## Additional Options

- [ ] [Optional] Please cherry-pick this PR to the latest release
version.
- [x] [Optional] Override Linear Check

<!-- This is an auto-generated description by cubic. -->
---
## Summary by cubic
ODS now shares development infrastructure across worktrees by default,
with `--isolated` for separate datasets. `stack`, `web dev`, and
`backend` use the same service specs and launchers, and the duplicate
`stack --frontend-only` option is removed.

- Direct launches run the same dependency-prepare step as stack startup,
so `backend` and `web dev` work with fresh or stale Python environments.
- A stopped preview discards its former project state before retargeting
to another API owner.
- Enforces project ownership across checkouts and resolves database
commands to the managed database. New tests reject conflicting targets
before any mutation.
- Stops services before pending migrations, preserves them when already
at head, and rejects manual migrations beneath managed services.
Migration probe failures fail closed.
- Hardens startup cancellation, shutdown grace, and descendant cleanup;
ODS keeps the terminal foreground group so Ctrl-C still honors shutdown
timeouts, and tmux pane identifiers no longer change service identity.
- Database passwords reach tools through the child environment only,
never in process arguments; Windows foreground commands are preserved.
- Consolidates environment helpers, protects symlinked env files,
propagates restore errors, and refreshes help and documentation. Test
commits exercise the new migration-target and preview-launch paths.

<sup>Written for commit 14500cb051.
Summary will update on new commits.</sup>

<a
href="https://cubic.dev/pr/onyx-dot-app/onyx/pull/16246?utm_source=github"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/review-in-cubic-light.svg"><img
alt="View guided diff"
src="https://www.cubic.dev/buttons/review-in-cubic-light.svg"></picture></a>
<a
href="https://www.cubic.dev/action/auto-fix/pr/onyx-dot-app/onyx/16246?returnTo=https%3A%2F%2Fgithub.com%2Fonyx-dot-app%2Fonyx%2Fpull%2F16246&source=description"
target="_blank" rel="noopener noreferrer"
data-no-image-dialog="true"><picture><source
media="(prefers-color-scheme: dark)"
srcset="https://www.cubic.dev/buttons/turn-on-auto-fix-dark.svg"><source
media="(prefers-color-scheme: light)"
srcset="https://www.cubic.dev/buttons/turn-on-auto-fix-light.svg"><img
alt="Turn on auto-fix"
src="https://www.cubic.dev/buttons/turn-on-auto-fix-light.svg"></picture></a>

<!-- End of auto-generated description by cubic. -->

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added the global `--isolated` option for separate development stacks;
shared infrastructure is the default, with clearer project ownership and
status information.
* Added `ods web dev` previews that can use a healthy managed API on
macOS and Linux, plus foreground startup on Windows.
* Expanded command guidance for development workflows, database
targeting, and dump formats.
* **Bug Fixes**
* Pending migrations now stop managed application services first;
healthy services remain running when no migrations are needed.
* Database operations verify project ownership and target selection
before making changes. Restore errors now fail the command, SQL restores
stop on errors, and temporary files are cleaned up after failures.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-10-19 20:07:02 +00:00

139 lines
5.0 KiB
Go

package cmd
import (
"errors"
"os"
"os/exec"
"path/filepath"
"slices"
"strings"
"testing"
)
// objectStoreRepo is a compose repo with a backend directory and a docker fake
// that answers "docker port" for Postgres, the object store and MinIO and
// records the MinIO env of every compose call in <bin>/docker.env.
func objectStoreRepo(t *testing.T, bin string) string {
t.Helper()
root := composeRepo(t)
if err := os.MkdirAll(filepath.Join(root, "backend"), 0o755); err != nil {
t.Fatal(err)
}
writeFile(t, filepath.Join(root, ".vscode", "env_template.txt"), "")
writeFile(t, filepath.Join(root, ".vscode", "env.web_template.txt"), "")
composeFakeTool(t, bin, "docker", `case "$1" in
port) case "$2" in *-relational_db-1) echo "0.0.0.0:5432" ;; *-object-store-1) echo "0.0.0.0:9004" ;; *-minio-1) echo "0.0.0.0:9005" ;; *) exit 1 ;; esac ;;
compose) echo "${MINIO_REPLICAS-unset} ${MINIO_API_HOST_PORT-unset}" >> "`+filepath.Join(bin, "docker.env")+`" ;;
esac`)
return root
}
func TestObjectStoreMigrate_copiesThenStopsMinio(t *testing.T) {
bin := composeFakeBin(t)
root := objectStoreRepo(t, bin)
uvEnv := filepath.Join(bin, "uv.env")
composeFakeTool(t, bin, "uv", `echo "$S3_ENDPOINT_URL $S3_LEGACY_ENDPOINT_URL $LEGACY_COPY_ALL_OBJECTS $POSTGRES_HOST $POSTGRES_PORT" > "`+uvEnv+`"`)
envPath := filepath.Join(root, ".vscode", ".env")
writeFile(t, envPath, "POSTGRES_PORT=1\nS3_ENDPOINT_URL=http://localhost:9\nS3_LEGACY_ENDPOINT_URL=http://localhost:8\n")
command := NewObjectStoreCommand()
command.SetArgs([]string{"migrate"})
if err := command.Execute(); err != nil {
t.Fatal(err)
}
compose := "compose -p ods-proj -f docker-compose.yml -f docker-compose.dev.yml --profile s3-filestore "
wantDocker := []string{
"port ods-proj-relational_db-1 5432",
"port ods-proj-object-store-1 8333",
compose + "up -d --wait minio",
"port ods-proj-minio-1 9000",
compose + "stop minio",
}
if got := composeCalls(t, bin, "docker"); !slices.Equal(got, wantDocker) {
t.Fatalf("expected docker calls %q, got %q", wantDocker, got)
}
// MinIO starts despite the dev stack's zero replicas, on a free host port.
if got := composeReadFile(t, filepath.Join(bin, "docker.env")); got != "1 0\n1 0\n" {
t.Fatalf("expected the MinIO env on both compose calls, got %q", got)
}
if got := composeCalls(t, bin, "uv"); !slices.Equal(got, []string{"run python -m onyx.file_store.legacy_copy --retire"}) {
t.Fatalf("expected the legacy copy in retire mode, got %q", got)
}
// The discovered ports beat the .env file, and every object is copied.
if got := composeReadFile(t, uvEnv); got != "http://localhost:9004 http://localhost:9005 true localhost 5432\n" {
t.Fatalf("copy ran with env %q", got)
}
if got := composeReadFile(t, envPath); got != "POSTGRES_PORT=1\nS3_ENDPOINT_URL=http://localhost:9\n" {
t.Fatalf("expected the legacy endpoint dropped from .env, got %q", got)
}
}
func TestObjectStoreMigrate_keepMinioSkipsTheStop(t *testing.T) {
bin := composeFakeBin(t)
root := objectStoreRepo(t, bin)
composeFakeTool(t, bin, "uv", "")
writeFile(t, filepath.Join(root, ".vscode", ".env"), "POSTGRES_PORT=1\n")
command := NewObjectStoreCommand()
command.SetArgs([]string{"migrate", "--keep-minio"})
if err := command.Execute(); err != nil {
t.Fatal(err)
}
for _, call := range composeCalls(t, bin, "docker") {
if strings.HasSuffix(call, "stop minio") {
t.Fatalf("MinIO was stopped despite --keep-minio: %q", call)
}
}
}
func TestObjectStoreMigrate_failedCopyKeepsEnvAndMinio(t *testing.T) {
bin := composeFakeBin(t)
root := objectStoreRepo(t, bin)
composeFakeTool(t, bin, "uv", "exit 3")
envPath := filepath.Join(root, ".vscode", ".env")
writeFile(t, envPath, "S3_LEGACY_ENDPOINT_URL=http://localhost:8\n")
err := runObjectStoreMigrate(false)
var exitErr *exec.ExitError
if !errors.As(err, &exitErr) || exitErr.ExitCode() != 3 {
t.Fatalf("expected the copy's exit code, got %v", err)
}
if got := composeReadFile(t, envPath); got != "S3_LEGACY_ENDPOINT_URL=http://localhost:8\n" {
t.Fatalf("expected .env untouched, got %q", got)
}
for _, call := range composeCalls(t, bin, "docker") {
if strings.HasSuffix(call, "stop minio") {
t.Fatalf("MinIO was stopped after a failed copy: %q", call)
}
}
}
func TestObjectStoreMigrate_needsTheInfraStack(t *testing.T) {
bin := composeFakeBin(t)
composeRepo(t)
composeFakeTool(t, bin, "docker", "exit 1")
err := runObjectStoreMigrate(false)
if err == nil || !strings.Contains(err.Error(), "relational_db is not running") {
t.Fatalf("expected the missing service error, got %v", err)
}
if got := composeCalls(t, bin, "docker"); !slices.Equal(got, []string{"port ods-proj-relational_db-1 5432"}) {
t.Fatalf("expected no compose call before the check, got %q", got)
}
}
func TestRemoveEnvKey(t *testing.T) {
envPath := filepath.Join(t.TempDir(), ".env")
writeFile(t, envPath, "A=1\nS3_LEGACY_ENDPOINT_URL=x\nB=2\n")
if err := removeEnvKey(envPath, "S3_LEGACY_ENDPOINT_URL"); err != nil {
t.Fatal(err)
}
if got := composeReadFile(t, envPath); got != "A=1\nB=2\n" {
t.Fatalf("expected the key dropped, got %q", got)
}
}