Introduces three interconnected features for persistent VM workflows: 1. `banger vm exec <vm> -- <cmd>`: runs a command in the prepared workspace, automatically cd-ing into the guest path and wrapping via `mise exec --` so mise-managed tools are on PATH. Falls back to a plain exec when mise isn't available. Exit code propagates verbatim. 2. Workspace persistence: workspace.prepare now stores the guest path, host source path, and HEAD commit into a new `workspace_json` column on the vms table (migration 3). This state survives daemon restarts and informs both dirty-checking and auto-prepare. 3. Dirty detection: `vm exec` compares the stored HEAD commit against the current host repo HEAD. When stale it warns and, with --auto-prepare, re-syncs the workspace before running. Also: - WORKSPACE column added to `banger ps` / `vm list` - `banger vm` quick reference updated with `vm exec` entry
275 lines
11 KiB
Go
275 lines
11 KiB
Go
package daemon
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"net"
|
|
"strings"
|
|
"time"
|
|
|
|
"banger/internal/api"
|
|
ws "banger/internal/daemon/workspace"
|
|
"banger/internal/model"
|
|
)
|
|
|
|
// workspaceInspectRepoHook + workspaceImportHook dispatch through the
|
|
// per-instance Daemon seams when set, falling back to the real
|
|
// workspace package implementations. Keeping the fallbacks here (as
|
|
// opposed to always requiring callers to populate s.workspaceInspectRepo
|
|
// in a constructor) lets tests selectively override one hook without
|
|
// having to wire both.
|
|
func (s *WorkspaceService) workspaceInspectRepoHook(ctx context.Context, sourcePath, branchName, fromRef string, includeUntracked bool) (ws.RepoSpec, error) {
|
|
if s != nil && s.workspaceInspectRepo != nil {
|
|
return s.workspaceInspectRepo(ctx, sourcePath, branchName, fromRef, includeUntracked)
|
|
}
|
|
return s.inspector().InspectRepo(ctx, sourcePath, branchName, fromRef, includeUntracked)
|
|
}
|
|
|
|
func (s *WorkspaceService) workspaceImportHook(ctx context.Context, client ws.GuestClient, spec ws.RepoSpec, guestPath string, mode model.WorkspacePrepareMode) error {
|
|
if s != nil && s.workspaceImport != nil {
|
|
return s.workspaceImport(ctx, client, spec, guestPath, mode)
|
|
}
|
|
return s.inspector().ImportRepoToGuest(ctx, client, spec, guestPath, mode)
|
|
}
|
|
|
|
// inspector returns the service's workspace Inspector, falling back to
|
|
// a fresh real-runner Inspector when callers constructed the service
|
|
// without wiring one. Keeping the fallback here lets test literals
|
|
// that don't care about the Inspector still function without a manual
|
|
// NewInspector() call.
|
|
func (s *WorkspaceService) inspector() *ws.Inspector {
|
|
if s != nil && s.repoInspector != nil {
|
|
return s.repoInspector
|
|
}
|
|
return ws.NewInspector()
|
|
}
|
|
|
|
func (s *WorkspaceService) ExportVMWorkspace(ctx context.Context, params api.WorkspaceExportParams) (api.WorkspaceExportResult, error) {
|
|
guestPath := strings.TrimSpace(params.GuestPath)
|
|
if guestPath == "" {
|
|
guestPath = "/root/repo"
|
|
}
|
|
vm, err := s.vmResolver(ctx, params.IDOrName)
|
|
if err != nil {
|
|
return api.WorkspaceExportResult{}, err
|
|
}
|
|
if !s.aliveChecker(vm) {
|
|
return api.WorkspaceExportResult{}, fmt.Errorf("vm %q is not running", vm.Name)
|
|
}
|
|
// Serialise with any in-flight workspace.prepare on the same VM so
|
|
// we never snapshot a half-streamed tar. Does not block vm stop /
|
|
// delete / restart — those only take the VM mutex.
|
|
unlock := s.workspaceLocks.lock(vm.ID)
|
|
defer unlock()
|
|
|
|
client, err := s.dialGuest(ctx, net.JoinHostPort(vm.Runtime.GuestIP, "22"))
|
|
if err != nil {
|
|
return api.WorkspaceExportResult{}, fmt.Errorf("dial guest: %w", err)
|
|
}
|
|
defer client.Close()
|
|
|
|
// diffRef is the git ref everything is diffed against.
|
|
// When the caller supplies BaseCommit (the HEAD at workspace.prepare time),
|
|
// we diff against that fixed point so committed guest changes are included.
|
|
// Without it we fall back to HEAD, which silently drops them.
|
|
diffRef := strings.TrimSpace(params.BaseCommit)
|
|
if diffRef == "" {
|
|
diffRef = "HEAD"
|
|
}
|
|
|
|
// Both scripts run `git add -A` to capture the working tree
|
|
// (committed deltas + uncommitted modifications + untracked files
|
|
// minus .gitignore), but they route it through a throwaway index
|
|
// file instead of .git/index. Export is an observation step; the
|
|
// user's real staging area must stay exactly as they left it.
|
|
patchScript := exportScript(guestPath, diffRef, "--binary")
|
|
patch, err := client.RunScriptOutput(ctx, patchScript)
|
|
if err != nil {
|
|
return api.WorkspaceExportResult{}, fmt.Errorf("export workspace diff: %w", err)
|
|
}
|
|
|
|
namesScript := exportScript(guestPath, diffRef, "--name-only")
|
|
namesOut, _ := client.RunScriptOutput(ctx, namesScript)
|
|
var changed []string
|
|
for _, line := range strings.Split(strings.TrimSpace(string(namesOut)), "\n") {
|
|
if line = strings.TrimSpace(line); line != "" {
|
|
changed = append(changed, line)
|
|
}
|
|
}
|
|
|
|
return api.WorkspaceExportResult{
|
|
GuestPath: guestPath,
|
|
BaseCommit: diffRef,
|
|
Patch: patch,
|
|
ChangedFiles: changed,
|
|
HasChanges: len(patch) > 0,
|
|
}, nil
|
|
}
|
|
|
|
// exportScript emits a shell snippet that diffs the working tree at
|
|
// guestPath against diffRef (HEAD or a commit SHA) WITHOUT touching
|
|
// the repo's real index. diffFlag selects the git-diff output mode
|
|
// ("--binary" for the patch body, "--name-only" for the file list).
|
|
//
|
|
// Mechanics: seed a temp index from diffRef's tree via git read-tree,
|
|
// restage the working tree into that temp index with GIT_INDEX_FILE,
|
|
// then emit the diff. The temp index is rm'd on exit via trap.
|
|
//
|
|
// The temp index must live on the same filesystem as the repo's
|
|
// real .git directory. `git read-tree --index-output=PATH` uses a
|
|
// lockfile + rename + hardlink sequence that fails with "unable to
|
|
// write new index file" when PATH is on a different filesystem —
|
|
// reliably reproducible on Debian bookworm guests where /tmp is
|
|
// tmpfs and the workspace overlay is on a separate FS. mktemp'ing
|
|
// inside `$(git rev-parse --git-dir)` keeps the temp index on the
|
|
// same FS as .git/index without polluting the working tree.
|
|
func exportScript(guestPath, diffRef, diffFlag string) string {
|
|
return fmt.Sprintf(
|
|
"set -euo pipefail\n"+
|
|
"cd %s\n"+
|
|
"git_dir=\"$(git rev-parse --git-dir)\"\n"+
|
|
"tmp_idx=\"$(mktemp \"$git_dir/banger-export-idx.XXXXXX\")\"\n"+
|
|
"trap 'rm -f \"$tmp_idx\"' EXIT\n"+
|
|
"git read-tree %s --index-output=\"$tmp_idx\"\n"+
|
|
"GIT_INDEX_FILE=\"$tmp_idx\" git add -A\n"+
|
|
"GIT_INDEX_FILE=\"$tmp_idx\" git diff --cached %s %s\n",
|
|
ws.ShellQuote(guestPath),
|
|
ws.ShellQuote(diffRef),
|
|
ws.ShellQuote(diffRef),
|
|
diffFlag,
|
|
)
|
|
}
|
|
|
|
func (s *WorkspaceService) PrepareVMWorkspace(ctx context.Context, params api.VMWorkspacePrepareParams) (model.WorkspacePrepareResult, error) {
|
|
mode, err := ws.ParsePrepareMode(params.Mode)
|
|
if err != nil {
|
|
return model.WorkspacePrepareResult{}, err
|
|
}
|
|
guestPath := strings.TrimSpace(params.GuestPath)
|
|
if guestPath == "" {
|
|
guestPath = "/root/repo"
|
|
}
|
|
branchName := strings.TrimSpace(params.Branch)
|
|
fromRef := strings.TrimSpace(params.From)
|
|
if branchName != "" && fromRef == "" {
|
|
fromRef = "HEAD"
|
|
}
|
|
if branchName == "" && strings.TrimSpace(params.From) != "" {
|
|
return model.WorkspacePrepareResult{}, errors.New("workspace from requires branch")
|
|
}
|
|
|
|
// Phase 1: acquire the VM mutex ONLY long enough to verify state
|
|
// and snapshot the fields we need (IP, PID, api sock). Release it
|
|
// before any SSH or tar I/O so this slow operation cannot block
|
|
// vm stop / vm delete / vm restart on the same VM.
|
|
vm, err := s.withVMLockByRef(ctx, params.IDOrName, func(vm model.VMRecord) (model.VMRecord, error) {
|
|
if !s.aliveChecker(vm) {
|
|
return model.VMRecord{}, fmt.Errorf("vm %q is not running", vm.Name)
|
|
}
|
|
return vm, nil
|
|
})
|
|
if err != nil {
|
|
return model.WorkspacePrepareResult{}, err
|
|
}
|
|
|
|
// Phase 2: serialise concurrent workspace operations on THIS vm
|
|
// (so two prepares don't interleave tar streams), but do not
|
|
// block lifecycle ops. If the VM gets stopped or deleted mid-
|
|
// flight, the SSH dial or stream will fail naturally; ctx
|
|
// cancellation propagates through.
|
|
unlock := s.workspaceLocks.lock(vm.ID)
|
|
defer unlock()
|
|
|
|
return s.prepareVMWorkspaceGuestIO(ctx, vm, strings.TrimSpace(params.SourcePath), guestPath, branchName, fromRef, mode, params.IncludeUntracked)
|
|
}
|
|
|
|
// miseTrustGuestRepo runs `mise trust` against guestPath inside the
|
|
// guest so any .mise.toml / .tool-versions / mise.toml files in the
|
|
// imported repo become trusted without an interactive prompt. Best
|
|
// effort: a missing mise binary, a non-zero exit, or a trust that
|
|
// finds nothing all log at debug only and don't fail prepare.
|
|
//
|
|
// The guest is single-tenant root@<vm>.vm and the repo just came
|
|
// from the host user's own checkout, so auto-trust is safe in this
|
|
// context — the user has already validated the repo on the host.
|
|
func (s *WorkspaceService) miseTrustGuestRepo(ctx context.Context, client ws.GuestClient, guestPath string) {
|
|
script := miseTrustScript(guestPath)
|
|
if err := client.RunScript(ctx, script, miseTrustLogSink{}); err != nil && s.logger != nil {
|
|
s.logger.Debug("mise trust on imported workspace skipped", "guest_path", guestPath, "error", err.Error())
|
|
}
|
|
}
|
|
|
|
// miseTrustScript is the exact shell run inside the guest. Kept
|
|
// separate so a unit test can pin the string and confirm a future
|
|
// edit doesn't accidentally drop the `command -v` guard.
|
|
func miseTrustScript(guestPath string) string {
|
|
return fmt.Sprintf(
|
|
"if command -v mise >/dev/null 2>&1; then cd %s && mise trust --quiet --all 2>/dev/null || true; fi\n",
|
|
ws.ShellQuote(guestPath),
|
|
)
|
|
}
|
|
|
|
// miseTrustLogSink discards anything mise wrote to stdout/stderr.
|
|
// We don't care about the output — success leaves mise silent and a
|
|
// failure is already covered by the err return path.
|
|
type miseTrustLogSink struct{}
|
|
|
|
func (miseTrustLogSink) Write(p []byte) (int, error) { return len(p), nil }
|
|
|
|
// prepareVMWorkspaceGuestIO performs the actual guest-side work:
|
|
// inspect the local repo, dial SSH, stream the tar. Called without
|
|
// holding the VM mutex.
|
|
func (s *WorkspaceService) prepareVMWorkspaceGuestIO(ctx context.Context, vm model.VMRecord, sourcePath, guestPath, branchName, fromRef string, mode model.WorkspacePrepareMode, includeUntracked bool) (model.WorkspacePrepareResult, error) {
|
|
spec, err := s.workspaceInspectRepoHook(ctx, sourcePath, branchName, fromRef, includeUntracked)
|
|
if err != nil {
|
|
return model.WorkspacePrepareResult{}, err
|
|
}
|
|
if len(spec.Submodules) > 0 && mode != model.WorkspacePrepareModeFullCopy {
|
|
return model.WorkspacePrepareResult{}, fmt.Errorf("workspace mode %q does not support git submodules in %s (%s); use --mode full_copy", mode, spec.RepoRoot, strings.Join(spec.Submodules, ", "))
|
|
}
|
|
address := net.JoinHostPort(vm.Runtime.GuestIP, "22")
|
|
if err := s.waitGuestSSH(ctx, address, 250*time.Millisecond); err != nil {
|
|
return model.WorkspacePrepareResult{}, fmt.Errorf("guest ssh unavailable: %w", err)
|
|
}
|
|
client, err := s.dialGuest(ctx, address)
|
|
if err != nil {
|
|
return model.WorkspacePrepareResult{}, fmt.Errorf("dial guest ssh: %w", err)
|
|
}
|
|
defer client.Close()
|
|
if err := s.workspaceImportHook(ctx, client, spec, guestPath, mode); err != nil {
|
|
return model.WorkspacePrepareResult{}, err
|
|
}
|
|
// Auto-trust mise configs in the imported repo. The guest is
|
|
// single-tenant (root@<vm>.vm), the repo just came from the
|
|
// host user's own checkout, and any .mise.toml landing in /root
|
|
// would otherwise prompt on the first guest command and stall a
|
|
// 'banger vm run ./repo -- <cmd>' invocation. Best-effort: a
|
|
// missing mise binary or a 'trust' that does nothing is fine.
|
|
s.miseTrustGuestRepo(ctx, client, guestPath)
|
|
preparedAt := model.Now()
|
|
// Persist workspace state so `vm exec` and dirty-checking can
|
|
// resolve guest path + HEAD commit without re-stating them. Best
|
|
// effort: a store failure here doesn't roll back the prepare.
|
|
if err := s.store.SetVMWorkspace(ctx, vm.ID, model.VMWorkspace{
|
|
GuestPath: guestPath,
|
|
SourcePath: spec.SourcePath,
|
|
HeadCommit: spec.HeadCommit,
|
|
PreparedAt: preparedAt,
|
|
}); err != nil && s.logger != nil {
|
|
s.logger.Warn("failed to persist workspace state", "vm_id", vm.ID, "error", err)
|
|
}
|
|
return model.WorkspacePrepareResult{
|
|
VMID: vm.ID,
|
|
SourcePath: spec.SourcePath,
|
|
RepoRoot: spec.RepoRoot,
|
|
RepoName: spec.RepoName,
|
|
GuestPath: guestPath,
|
|
Mode: mode,
|
|
HeadCommit: spec.HeadCommit,
|
|
CurrentBranch: spec.CurrentBranch,
|
|
BranchName: spec.BranchName,
|
|
BaseCommit: spec.BaseCommit,
|
|
PreparedAt: preparedAt,
|
|
}, nil
|
|
}
|