Move the command tree into internal/cli #9
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Agent Guidance
|
||||
last_modified: 2026-09-26
|
||||
last_modified: 2026-09-28
|
||||
---
|
||||
|
||||
This file is the single source of guidance for any automated agent
|
||||
@@ -118,9 +118,10 @@ Do not weaken them.
|
||||
## Layout
|
||||
|
||||
```
|
||||
cmd/simplexcalc/ cobra command tree; main(), run and version
|
||||
cmd/simplexcalc/ main(), a single call into internal/cli
|
||||
internal/bot/ startup, address setup, and the reply to a message
|
||||
internal/calc/ the arithmetic: go/parser and go/constant
|
||||
internal/cli/ cobra command tree: run and version
|
||||
internal/config/ viper-backed configuration; the abort-on-garbage rule
|
||||
internal/logger/ log/slog, JSON always
|
||||
internal/simplex/ the simplex-chat child process and its WebSocket API
|
||||
|
||||
+3
-11
@@ -2,12 +2,10 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
)
|
||||
|
||||
// appname is the name the program reports in its logs and its version.
|
||||
const appname = "simplexcalc"
|
||||
"sneak.berlin/go/simplexcalc/internal/cli"
|
||||
)
|
||||
|
||||
// version is injected at build time with -ldflags "-X main.version=...".
|
||||
// The Dockerfile passes VERSION; a `go build` without it says "dev",
|
||||
@@ -16,11 +14,5 @@ const appname = "simplexcalc"
|
||||
var version = "dev"
|
||||
|
||||
func main() {
|
||||
err := rootCmd().Execute()
|
||||
if err != nil {
|
||||
// cobra has already printed the error; this only sets the exit
|
||||
// status, which is what a supervisor and a shell script read.
|
||||
fmt.Fprintln(os.Stderr, "exiting: "+err.Error())
|
||||
os.Exit(1)
|
||||
}
|
||||
os.Exit(cli.Main(version))
|
||||
}
|
||||
|
||||
@@ -27,6 +27,9 @@ with no deprecation warning.
|
||||
|
||||
# Completed Steps
|
||||
|
||||
- 2026-09-28 Moved the command tree and the `run` and `version` commands
|
||||
from `cmd/simplexcalc/` into `internal/cli`; `cmd/simplexcalc/main.go`
|
||||
is now a single call to `cli.Main`
|
||||
- 2026-09-26 Seeded from `go-template-repo` (renamed, its HTTP service
|
||||
removed) and built the bot: `internal/calc` for the arithmetic,
|
||||
`internal/simplex` for the chat client process and its WebSocket API,
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
// Package cli is the simplexcalc command tree: the run and version
|
||||
// commands, and the exit status the program ends with.
|
||||
package cli
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// appname is the name the program reports in its logs and its version.
|
||||
const appname = "simplexcalc"
|
||||
|
||||
// Main runs the command named on the command line and returns the exit
|
||||
// status for main to pass to os.Exit.
|
||||
//
|
||||
// It leaves cobra's output streams at their defaults. cobra writes the
|
||||
// usage and an unknown help topic to stderr, but SetOut moves them onto
|
||||
// the stream it is given.
|
||||
func Main(version string) int {
|
||||
return execute(rootCmd(version))
|
||||
}
|
||||
|
||||
// execute runs root and returns the exit status. It takes the command
|
||||
// so that a test can set its arguments and output streams first.
|
||||
func execute(root *cobra.Command) int {
|
||||
err := root.Execute()
|
||||
if err != nil {
|
||||
// cobra has already printed the error; this only sets the exit
|
||||
// status, which is what a supervisor and a shell script read.
|
||||
_, _ = fmt.Fprintln(root.ErrOrStderr(), "exiting: "+err.Error())
|
||||
|
||||
return 1
|
||||
}
|
||||
|
||||
return 0
|
||||
}
|
||||
@@ -0,0 +1,51 @@
|
||||
package cli_test
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"runtime"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"sneak.berlin/go/simplexcalc/internal/cli"
|
||||
)
|
||||
|
||||
func TestVersionPrintsVersion(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var stdout, stderr bytes.Buffer
|
||||
|
||||
root := cli.RootCmd("1.2.3")
|
||||
root.SetArgs([]string{"version"})
|
||||
root.SetOut(&stdout)
|
||||
root.SetErr(&stderr)
|
||||
|
||||
status := cli.Execute(root)
|
||||
if status != 0 {
|
||||
t.Fatalf("status = %d, want 0; stderr: %q", status, stderr.String())
|
||||
}
|
||||
|
||||
want := "simplexcalc 1.2.3 " + runtime.GOOS + "/" + runtime.GOARCH + "\n"
|
||||
if stdout.String() != want {
|
||||
t.Errorf("stdout = %q, want %q", stdout.String(), want)
|
||||
}
|
||||
}
|
||||
|
||||
func TestUnknownCommandFails(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
var stdout, stderr bytes.Buffer
|
||||
|
||||
root := cli.RootCmd("1.2.3")
|
||||
root.SetArgs([]string{"frobnicate"})
|
||||
root.SetOut(&stdout)
|
||||
root.SetErr(&stderr)
|
||||
|
||||
status := cli.Execute(root)
|
||||
if status == 0 {
|
||||
t.Fatal("status = 0, want non-zero")
|
||||
}
|
||||
|
||||
if !strings.HasPrefix(stderr.String(), "exiting: ") {
|
||||
t.Errorf("stderr = %q, want the error after \"exiting: \"", stderr.String())
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
package cli
|
||||
|
||||
// RootCmd and Execute are rootCmd and execute, exported for the external
|
||||
// test package, which builds the command tree itself so that it can
|
||||
// supply the arguments and read the output.
|
||||
//
|
||||
//nolint:gochecknoglobals // test seams, not mutable state.
|
||||
var (
|
||||
RootCmd = rootCmd
|
||||
Execute = execute
|
||||
)
|
||||
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package cli
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
@@ -11,7 +11,7 @@ import (
|
||||
// environment (see internal/config), not from flags: the bot runs in a
|
||||
// container, where the environment is the interface, and one source of
|
||||
// truth means there is no precedence rule to get wrong.
|
||||
func rootCmd() *cobra.Command {
|
||||
func rootCmd(version string) *cobra.Command {
|
||||
root := &cobra.Command{
|
||||
Use: appname,
|
||||
Short: appname + " — a SimpleX Chat bot that answers arithmetic",
|
||||
@@ -26,12 +26,12 @@ func rootCmd() *cobra.Command {
|
||||
SilenceErrors: true,
|
||||
}
|
||||
|
||||
root.AddCommand(runCmd(), versionCmd())
|
||||
root.AddCommand(runCmd(version), versionCmd(version))
|
||||
|
||||
return root
|
||||
}
|
||||
|
||||
func versionCmd() *cobra.Command {
|
||||
func versionCmd(version string) *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "version",
|
||||
Short: "print the version and exit",
|
||||
@@ -1,4 +1,4 @@
|
||||
package main
|
||||
package cli
|
||||
|
||||
import (
|
||||
"context"
|
||||
@@ -14,13 +14,13 @@ import (
|
||||
"sneak.berlin/go/simplexcalc/internal/logger"
|
||||
)
|
||||
|
||||
func runCmd() *cobra.Command {
|
||||
func runCmd(version string) *cobra.Command {
|
||||
return &cobra.Command{
|
||||
Use: "run",
|
||||
Short: "run the bot",
|
||||
Args: cobra.NoArgs,
|
||||
RunE: func(cmd *cobra.Command, _ []string) error {
|
||||
return run(cmd.Context())
|
||||
return run(cmd.Context(), version)
|
||||
},
|
||||
}
|
||||
}
|
||||
@@ -28,7 +28,7 @@ func runCmd() *cobra.Command {
|
||||
// run reads the configuration and runs the bot until SIGINT or SIGTERM,
|
||||
// or until it fails. A failure is the process's exit status, so a
|
||||
// supervisor restarts it.
|
||||
func run(ctx context.Context) error {
|
||||
func run(ctx context.Context, version string) error {
|
||||
cfg, err := config.New()
|
||||
if err != nil {
|
||||
return fmt.Errorf("reading configuration: %w", err)
|
||||
Reference in New Issue
Block a user