Files
onyx/tools/ods/cmd/stack_cli_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

201 lines
6.7 KiB
Go

//go:build !windows
package cmd
import (
"context"
"encoding/json"
"os"
"os/exec"
"path/filepath"
"slices"
"strings"
"testing"
log "github.com/sirupsen/logrus"
"github.com/onyx-dot-app/onyx/tools/ods/internal/devstack"
)
func TestStackStopAndDownCommandsPreserveDataAndPorts(t *testing.T) {
for _, action := range []string{"stop", "down"} {
t.Run(action, func(t *testing.T) {
_, calls := stackTestRepo(t)
stack, _ := openStack(nil)
if err := stack.WriteState(&devstack.State{Phase: devstack.PhaseReady, Profile: "minimal", Ports: map[string]int{"web": 3100}}); err != nil {
t.Fatal(err)
}
cmd := NewRootCommand()
cmd.SetArgs([]string{"stack", action, "--timeout", "100ms", "--lock-wait", "1s"})
if err := cmd.Execute(); err != nil {
t.Fatal(err)
}
state, err := stack.ReadState()
if err != nil || state == nil || state.Phase != devstack.PhaseStopped || state.Ports["web"] != 3100 {
t.Fatalf("shutdown must preserve durable ports: state=%+v err=%v", state, err)
}
dockerCalls := devtoolCalls(t, calls["docker"])
if action == "stop" {
if len(dockerCalls) != 0 {
t.Fatalf("stop touched infrastructure: %v", dockerCalls)
}
return
}
if len(dockerCalls) != 1 || !slices.Contains(dockerCalls[0].Args, "down") {
t.Fatalf("down did not stop Compose: %v", dockerCalls)
}
if slices.Contains(dockerCalls[0].Args, "--volumes") || slices.Contains(dockerCalls[0].Args, "-v") {
t.Fatalf("normal shutdown deletes volumes: %v", dockerCalls)
}
})
}
}
func TestStackStatusCommandJSONUsesWorktreePorts(t *testing.T) {
root, _ := stackTestRepo(t)
stack, _ := openStack(nil)
if err := stack.WriteState(&devstack.State{
Phase: devstack.PhaseReady, Profile: "full", Ports: map[string]int{"web": 3101, "api": 8181},
Services: []devstack.ServiceRecord{{Name: "Slack Bot", Slug: "slack-bot", Skipped: "credentials missing", Optional: true}},
}); err != nil {
t.Fatal(err)
}
cmd := NewRootCommand()
cmd.SetArgs([]string{"stack", "status", "--json"})
out := composeCapture(t, &os.Stdout, func() {
if err := cmd.Execute(); err != nil {
t.Error(err)
}
})
var status devstack.Status
if err := json.Unmarshal([]byte(out), &status); err != nil {
t.Fatalf("status stdout is not one JSON document: %v: %s", err, out)
}
if status.Root != root || status.Project != stack.Project || status.URLs["web"] != "http://localhost:3101" || status.URLs["api"] != "http://localhost:8181" {
t.Fatalf("wrong worktree discovery: %+v", status)
}
if len(status.Services) != 1 || status.Services[0].Reason != "credentials missing" {
t.Fatalf("optional-service explanation missing: %+v", status.Services)
}
}
func TestStackLogsCommandAcceptsLaunchName(t *testing.T) {
root, calls := stackTestRepo(t)
stack, _ := openStack(nil)
logPath := filepath.Join(root, "api.log")
if err := stack.WriteState(&devstack.State{Services: []devstack.ServiceRecord{{Name: "API Server", Slug: "api", Log: logPath}}}); err != nil {
t.Fatal(err)
}
cmd := NewRootCommand()
cmd.SetArgs([]string{"stack", "logs", "API Server", "--lines", "7", "--follow"})
if err := cmd.Execute(); err != nil {
t.Fatal(err)
}
tail := devtoolCalls(t, calls["tail"])
if len(tail) != 1 || !slices.Equal(tail[0].Args, []string{"-n", "7", "-F", logPath}) {
t.Fatalf("logs invocation: %v", tail)
}
}
func TestStackCommandsRejectUnexpectedArgumentsBeforeSetup(t *testing.T) {
_, calls := stackTestRepo(t)
for _, action := range []string{"up", "start", "restart", "stop", "down", "status", "plan"} {
cmd := NewRootCommand()
cmd.SetArgs([]string{"stack", action, "unexpected"})
if err := cmd.Execute(); err == nil || !strings.Contains(err.Error(), "unknown command") {
t.Errorf("%s accepted an unexpected argument: %v", action, err)
}
}
for tool, path := range calls {
if _, err := os.Stat(path); !os.IsNotExist(err) {
t.Errorf("argument validation invoked %s: %v", tool, err)
}
}
}
func TestStackUsesGlobalIsolationAndRejectsRemovedFrontendFlag(t *testing.T) {
_, calls := stackTestRepo(t)
original := rootIsolated
t.Cleanup(func() { rootIsolated = original })
cmd := NewRootCommand()
cmd.SetArgs([]string{"stack", "plan", "--frontend-only"})
if err := cmd.Execute(); err == nil || !strings.Contains(err.Error(), "unknown flag") {
t.Fatalf("removed flag accepted: %v", err)
}
for _, path := range calls {
if _, err := os.Stat(path); !os.IsNotExist(err) {
t.Fatal("invalid flag invoked tools")
}
}
for _, isolated := range []bool{false, true} {
rootIsolated = isolated
stack, _ := openStack(nil)
want := devstack.Shared
if isolated {
want = devstack.Isolated
}
if stack.Mode != want {
t.Fatalf("isolation=%v selected %s", isolated, stack.Mode)
}
}
if NewRootCommand().PersistentFlags().Lookup("isolated") == nil {
t.Fatal("isolation is not a global target option")
}
}
func TestStackPrepareReportsDockerAndDependencyFailures(t *testing.T) {
for _, tool := range []string{"docker", "uv"} {
t.Run(tool, func(t *testing.T) {
_, calls := stackTestRepo(t)
bin, err := exec.LookPath(tool)
if err != nil {
t.Fatal(err)
}
devtoolFakeTool(t, filepath.Dir(bin), tool, "exit 42\n")
_, provider := openStack(nil)
err = provider.Prepare(context.Background())
if err == nil || !strings.Contains(err.Error(), tool) || !strings.Contains(err.Error(), "exit status 42") {
t.Fatalf("missing actionable setup failure: %v", err)
}
if got := devtoolCalls(t, calls["bun"]); len(got) != 0 {
t.Fatalf("continued installation after failure: %v", got)
}
})
}
}
func TestStackLifecycleCommandsReportFailedSetup(t *testing.T) {
for _, action := range []string{"up", "start", "restart"} {
t.Run(action, func(t *testing.T) {
_, _ = stackTestRepo(t)
uv, err := exec.LookPath("uv")
if err != nil {
t.Fatal(err)
}
devtoolFakeTool(t, filepath.Dir(uv), "uv", "exit 42\n")
logger := log.StandardLogger()
originalExit := logger.ExitFunc
originalHook := exitHook
t.Cleanup(func() { logger.ExitFunc = originalExit; exitHook = originalHook })
type exitCode int
logger.ExitFunc = func(code int) { panic(exitCode(code)) }
exitHook = func(code int) { panic(exitCode(code)) }
cmd := NewRootCommand()
cmd.SetArgs([]string{"stack", action, "--timeout", "100ms", "--lock-wait", "1s"})
func() {
defer func() {
if got := recover(); got != exitCode(1) {
t.Fatalf("setup failure exit = %v, want 1", got)
}
}()
_ = cmd.Execute()
}()
stack, _ := openStack(nil)
state, err := stack.ReadState()
if err != nil || state == nil || state.Phase != devstack.PhaseFailed || len(state.Errors) != 1 || !strings.Contains(state.Errors[0], "exit status 42") {
t.Fatalf("failed setup was not recorded: state=%+v err=%v", state, err)
}
})
}
}