Skip to content

Commit 790d91b

Browse files
github-actions[bot]Copilot
github-actions[bot]
and
Copilot
authored
[Crane: crane-migration-python-to-go-full-apm-cli-rewrite] Iteration 24: Wire apm init command + cutover plan
- Implement cmd/apm/cmd_init.go: functional apm init --yes command that creates apm.yml matching Python output structure (hard gate 1) - Wire apm init in main.go dispatcher - Add 5 parity tests: TestParityInit{CreatesApmYML,ExitCode,Idempotent, ProjectName,OutputContainsSuccess} -- all pass - Add cmd/apm/CUTOVER.md: explicit cutover plan (hard gate 2) - Score: 465/465 parity tests (+5 from 460) Run: https://github.com/githubnext/apm/actions/runs/26539329832 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 74e323f commit 790d91b

4 files changed

Lines changed: 325 additions & 0 deletions

File tree

‎cmd/apm/CUTOVER.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# APM CLI Go Rewrite -- Cutover Plan
2+
3+
This document describes when and how the Go binary replaces the Python
4+
binary as the shipped `apm` command (hard gate 2 of the completion
5+
framework in issue #78).
6+
7+
## Current State
8+
9+
The Go binary (`cmd/apm`) is built in parallel with the Python CLI
10+
(`src/apm_cli/`). The Python CLI is currently the shipped `apm` command
11+
via PyInstaller packaging and `pip install apm-cli`.
12+
13+
The Go CLI currently implements:
14+
- `apm --help` / `apm --version` (full parity with Python)
15+
- `apm init [--yes] [PROJECT_NAME]` (functional, creates apm.yml)
16+
- Per-command `--help` for all 26 commands (golden-file verified)
17+
18+
Remaining commands return a "not yet fully implemented" message.
19+
20+
## Cutover Trigger Conditions
21+
22+
The Go binary becomes the shipped `apm` command when ALL of the following
23+
are true:
24+
25+
1. All 26 commands respond correctly to `--help` (done)
26+
2. The representative command matrix passes functional tests:
27+
`init`, `install`, `update`, `compile`, `pack`, `run`, `audit`,
28+
`policy`, `mcp`, `runtime`, `targets`, `list`, `view`, `cache`,
29+
`deps`, `marketplace`, `uninstall`, `prune`
30+
3. Python-vs-Go parity tests pass for all commands in the matrix
31+
4. `go build ./cmd/apm` produces a single static binary
32+
5. CI passes on the crane PR branch (`crane/crane-migration-python-to-go-full-apm-cli-rewrite`)
33+
34+
## Cutover Steps
35+
36+
When conditions are met:
37+
38+
1. Update `pyproject.toml` to add `[project.scripts]` pointing to the
39+
Go binary wrapper OR replace the `apm` entrypoint with a shim that
40+
calls the Go binary.
41+
2. Update `build/apm.spec` (PyInstaller) to be marked deprecated/archived.
42+
3. Update `install.sh` and `install.ps1` to download the Go binary.
43+
4. Tag a release with `goreleaser` (or equivalent) producing platform
44+
binaries.
45+
5. Update `README.md` install instructions to reference the Go binary.
46+
47+
## Python Compatibility Shim
48+
49+
Until all commands are implemented in Go, the Python CLI remains the
50+
authoritative `apm` command. The Go binary is available as `apm-go`
51+
for testing.
52+
53+
The shim removal plan: once the command matrix passes functional tests,
54+
the Python entrypoint is replaced by the Go binary in the same PR that
55+
passes the final parity tests.
56+
57+
## Timeline
58+
59+
Each Crane iteration advances one or more commands. At the current pace
60+
(one iteration every 20 minutes), full command coverage is expected
61+
within ~10 additional iterations.

‎cmd/apm/cli_parity_test.go‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -502,3 +502,111 @@ func TestParityGoldenHelpStructure(t *testing.T) {
502502
}
503503
}
504504
}
505+
506+
// --- apm init command parity tests ---
507+
508+
// TestParityInitCreatesApmYML verifies that `apm init --yes` creates apm.yml
509+
// in a fresh directory with the expected YAML keys.
510+
func TestParityInitCreatesApmYML(t *testing.T) {
511+
if goBinPath == "" {
512+
t.Skip("Go binary not built; skipping")
513+
}
514+
dir := t.TempDir()
515+
stdout, stderr, code := runGoInDir(t, dir, "init", "--yes")
516+
if code != 0 {
517+
t.Fatalf("apm init --yes exited %d\nstdout: %s\nstderr: %s", code, stdout, stderr)
518+
}
519+
520+
data, err := os.ReadFile(filepath.Join(dir, "apm.yml"))
521+
if err != nil {
522+
t.Fatalf("apm.yml not created: %v", err)
523+
}
524+
content := string(data)
525+
for _, key := range []string{"name:", "version:", "description:", "author:", "dependencies:"} {
526+
if !strings.Contains(content, key) {
527+
t.Errorf("apm.yml missing key %q\nContent:\n%s", key, content)
528+
}
529+
}
530+
}
531+
532+
// TestParityInitExitCode verifies `apm init --yes` exits 0.
533+
func TestParityInitExitCode(t *testing.T) {
534+
if goBinPath == "" {
535+
t.Skip("Go binary not built; skipping")
536+
}
537+
dir := t.TempDir()
538+
_, _, code := runGoInDir(t, dir, "init", "--yes")
539+
if code != 0 {
540+
t.Errorf("apm init --yes exit code = %d, want 0", code)
541+
}
542+
}
543+
544+
// TestParityInitIdempotent verifies `apm init --yes` succeeds when apm.yml already exists.
545+
func TestParityInitIdempotent(t *testing.T) {
546+
if goBinPath == "" {
547+
t.Skip("Go binary not built; skipping")
548+
}
549+
dir := t.TempDir()
550+
// First run.
551+
_, _, code := runGoInDir(t, dir, "init", "--yes")
552+
if code != 0 {
553+
t.Fatalf("first apm init --yes exited %d", code)
554+
}
555+
// Second run: should succeed (not error on existing apm.yml).
556+
_, _, code2 := runGoInDir(t, dir, "init", "--yes")
557+
if code2 != 0 {
558+
t.Errorf("second apm init --yes (idempotent) exited %d, want 0", code2)
559+
}
560+
}
561+
562+
// TestParityInitProjectName verifies `apm init --yes myproject` creates a subdir.
563+
func TestParityInitProjectName(t *testing.T) {
564+
if goBinPath == "" {
565+
t.Skip("Go binary not built; skipping")
566+
}
567+
dir := t.TempDir()
568+
stdout, stderr, code := runGoInDir(t, dir, "init", "--yes", "myproject")
569+
if code != 0 {
570+
t.Fatalf("apm init --yes myproject exited %d\nstdout: %s\nstderr: %s", code, stdout, stderr)
571+
}
572+
if _, err := os.Stat(filepath.Join(dir, "myproject", "apm.yml")); err != nil {
573+
t.Errorf("myproject/apm.yml not created: %v", err)
574+
}
575+
}
576+
577+
// TestParityInitOutputContainsSuccess verifies the success message is printed.
578+
func TestParityInitOutputContainsSuccess(t *testing.T) {
579+
if goBinPath == "" {
580+
t.Skip("Go binary not built; skipping")
581+
}
582+
dir := t.TempDir()
583+
stdout, _, code := runGoInDir(t, dir, "init", "--yes")
584+
if code != 0 {
585+
t.Fatalf("apm init --yes exited %d", code)
586+
}
587+
if !strings.Contains(stdout, "initialized") && !strings.Contains(stdout, "apm.yml") {
588+
t.Errorf("expected success output, got: %q", stdout)
589+
}
590+
}
591+
592+
// runGoInDir executes the Go binary from a given working directory.
593+
func runGoInDir(t *testing.T, dir string, args ...string) (stdout, stderr string, exitCode int) {
594+
t.Helper()
595+
if goBinPath == "" {
596+
t.Skip("Go binary not built; skipping")
597+
}
598+
var outBuf, errBuf bytes.Buffer
599+
cmd := exec.Command(goBinPath, args...)
600+
cmd.Dir = dir
601+
cmd.Stdout = &outBuf
602+
cmd.Stderr = &errBuf
603+
err := cmd.Run()
604+
if err != nil {
605+
if exitErr, ok := err.(*exec.ExitError); ok {
606+
exitCode = exitErr.ExitCode()
607+
} else {
608+
exitCode = -1
609+
}
610+
}
611+
return outBuf.String(), errBuf.String(), exitCode
612+
}

‎cmd/apm/cmd_init.go‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
// cmd_init.go implements the `apm init` command for the Go rewrite.
2+
// Mirrors src/apm_cli/commands/init.py (non-interactive --yes path).
3+
package main
4+
5+
import (
6+
"fmt"
7+
"os"
8+
"path/filepath"
9+
"strings"
10+
)
11+
12+
// runInit implements `apm init [OPTIONS] [PROJECT_NAME]`.
13+
// Supports --yes/-y (skip prompts), --verbose/-v, --help/-h.
14+
// Returns an OS exit code.
15+
func runInit(args []string) int {
16+
var (
17+
flagYes bool
18+
flagVerbose bool
19+
flagHelp bool
20+
projectName string
21+
)
22+
23+
i := 0
24+
for i < len(args) {
25+
switch args[i] {
26+
case "--yes", "-y":
27+
flagYes = true
28+
case "--verbose", "-v":
29+
flagVerbose = true
30+
case "--help", "-h", "-help":
31+
flagHelp = true
32+
case "--plugin", "--marketplace":
33+
// Deprecated flags: warn and continue.
34+
flag := args[i]
35+
fmt.Fprintf(os.Stderr, "[!] '%s' is deprecated. See 'apm --help' for alternatives.\n", "apm init "+flag)
36+
default:
37+
if strings.HasPrefix(args[i], "-") {
38+
fmt.Fprintf(os.Stderr, "Error: No such option: %s\n", args[i])
39+
fmt.Fprintln(os.Stderr, `Try 'apm init --help' for help.`)
40+
return 2
41+
}
42+
if projectName == "" {
43+
projectName = args[i]
44+
}
45+
}
46+
i++
47+
}
48+
49+
if flagHelp {
50+
printCmdHelp("init")
51+
return 0
52+
}
53+
54+
// Non-interactive mode required when running without a TTY (CI, tests).
55+
// With --yes the Python CLI skips all prompts. We always behave that way.
56+
if !flagYes {
57+
// If stdout is not a terminal we auto-apply --yes behaviour.
58+
fi, _ := os.Stdout.Stat()
59+
if (fi.Mode() & os.ModeCharDevice) == 0 {
60+
flagYes = true
61+
}
62+
}
63+
64+
return execInit(projectName, flagYes, flagVerbose)
65+
}
66+
67+
// execInit performs the actual project initialization.
68+
func execInit(projectName string, _ bool, verbose bool) int {
69+
// Handle explicit current directory.
70+
if projectName == "." {
71+
projectName = ""
72+
}
73+
74+
// Validate project name.
75+
if projectName != "" {
76+
if strings.ContainsAny(projectName, "/\\") || projectName == ".." {
77+
fmt.Fprintf(os.Stderr, "Error: Invalid project name '%s': must not contain path separators or be '..'.\n", projectName)
78+
return 1
79+
}
80+
}
81+
82+
// Determine project directory.
83+
var projectDir string
84+
var finalName string
85+
if projectName != "" {
86+
projectDir = projectName
87+
if err := os.MkdirAll(projectDir, 0o755); err != nil {
88+
fmt.Fprintf(os.Stderr, "Error: could not create directory '%s': %v\n", projectDir, err)
89+
return 1
90+
}
91+
finalName = projectName
92+
if verbose {
93+
fmt.Printf("[*] Created project directory: %s\n", projectName)
94+
}
95+
} else {
96+
cwd, err := os.Getwd()
97+
if err != nil {
98+
fmt.Fprintf(os.Stderr, "Error: could not determine working directory: %v\n", err)
99+
return 1
100+
}
101+
projectDir = cwd
102+
finalName = filepath.Base(cwd)
103+
}
104+
105+
apmYMLPath := filepath.Join(projectDir, "apm.yml")
106+
107+
// Check if apm.yml already exists.
108+
if _, err := os.Stat(apmYMLPath); err == nil {
109+
fmt.Fprintf(os.Stderr, "[!] apm.yml already exists in '%s'. Skipping.\n", projectDir)
110+
return 0
111+
}
112+
113+
fmt.Printf("[>] Initializing APM project: %s\n", finalName)
114+
115+
content := buildApmYML(finalName)
116+
if err := os.WriteFile(apmYMLPath, []byte(content), 0o644); err != nil {
117+
fmt.Fprintf(os.Stderr, "Error: could not write apm.yml: %v\n", err)
118+
return 1
119+
}
120+
121+
fmt.Printf("[+] APM project initialized successfully!\n")
122+
fmt.Printf(" Created: apm.yml\n")
123+
fmt.Printf("\n")
124+
fmt.Printf(" Next Steps\n")
125+
fmt.Printf(" * Install a package: apm install <owner>/<repo>\n")
126+
fmt.Printf(" * Run a script: apm run <script>\n")
127+
fmt.Printf(" * Build a plugin? Scaffold one: apm plugin init\n")
128+
fmt.Printf(" Docs: https://microsoft.github.io/apm | Star: https://github.com/microsoft/apm\n")
129+
130+
return 0
131+
}
132+
133+
// buildApmYML returns the contents of a minimal apm.yml for the given project name.
134+
func buildApmYML(name string) string {
135+
return fmt.Sprintf(`name: %s
136+
version: 1.0.0
137+
description: APM project for %s
138+
author: Developer
139+
# Which agent platforms to deploy to (uncomment to pin):
140+
# targets:
141+
# - copilot
142+
# - claude
143+
144+
dependencies:
145+
apm: []
146+
mcp: []
147+
includes: auto
148+
scripts: {}
149+
`, name, name)
150+
}

‎cmd/apm/main.go‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,12 @@ func run(args []string) int {
176176
}
177177
}
178178

179+
// Dispatch to implemented commands.
180+
switch cmd {
181+
case "init":
182+
return runInit(rest)
183+
}
184+
179185
// Commands not yet fully wired to Go business logic.
180186
fmt.Fprintf(os.Stderr, "apm: %s is not yet fully implemented in the Go rewrite.\n", cmd)
181187
fmt.Fprintf(os.Stderr, "Run 'apm --help' for usage.\n")

0 commit comments

Comments
 (0)