odboy
e02f3010cf
- Docker：新增只读、生命周期、清理、Compose 共 32 条命令，Linux 自动适配 podman - 危险命令 clearall/prunevolumes 未带 --yes 时仅提示并以退出码 2 结束 - 需要容器/镜像名的命令做必填参数校验，-- 之后参数计入位置参数 - diagnose：自动识别 Docker/Podman 容器或 K8s Pod，输出状态、根因、依据、建议并附日志与事件 - diagnose 中 -n 表示 namespace，其余命令 -n 仍为 --dry-run - 新增内置动作桥接与平台变体 helper，补充单元/集成/CLI 测试与 README
488 lines
15 KiB
Go
488 lines
15 KiB
Go
package cli
|
|
|
|
import (
|
|
"bytes"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"testing"
|
|
|
|
"gitea.odboy.cn/odboy/kenaito-kopsc/internal/platform"
|
|
"gitea.odboy.cn/odboy/kenaito-kopsc/internal/registry"
|
|
)
|
|
|
|
func centos(runtimes ...string) platform.Info {
|
|
return platform.Info{
|
|
OS: "linux", Arch: "amd64",
|
|
Distro: "centos", DistroLike: []string{"rhel", "fedora"},
|
|
Runtimes: runtimes,
|
|
}
|
|
}
|
|
|
|
func testApp(info platform.Info) (*App, *bytes.Buffer, *bytes.Buffer) {
|
|
stdout, stderr := &bytes.Buffer{}, &bytes.Buffer{}
|
|
return &App{
|
|
Registry: registry.Builtin(),
|
|
Info: info,
|
|
Version: "test",
|
|
Stdin: strings.NewReader(""),
|
|
Stdout: stdout,
|
|
Stderr: stderr,
|
|
}, stdout, stderr
|
|
}
|
|
|
|
func TestLeafDryRun(t *testing.T) {
|
|
app, stdout, stderr := testApp(centos("docker"))
|
|
|
|
code := app.Execute([]string{"docker", "clearsafe", "--dry-run"})
|
|
if code != 0 {
|
|
t.Fatalf("exit code = %d, stderr=%s", code, stderr.String())
|
|
}
|
|
out := stdout.String()
|
|
for _, want := range []string{"[dry-run]", "docker system prune -f", "Linux 上的 Docker 运行时", "依据"} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("dry-run output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestLeafDryRunPrefersPodman(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker", "podman"))
|
|
|
|
if code := app.Execute([]string{"docker", "clearsafe", "--dry-run"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
if !strings.Contains(stdout.String(), "podman system prune -f") {
|
|
t.Errorf("expected podman variant:\n%s", stdout.String())
|
|
}
|
|
if strings.Contains(stdout.String(), "docker system prune -f") {
|
|
t.Errorf("docker variant should not be chosen when podman is present:\n%s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestLeafHelp(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"docker", "clearsafe", "-h"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
out := stdout.String()
|
|
for _, want := range []string{"用法: kopsc docker clearsafe", "安全清理", "--dry-run", "将执行: docker system prune -f"} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("help output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestLeafPassesThroughArgs(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
code := app.Execute([]string{"net", "ports", "--dry-run", "--", "-l"})
|
|
if code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
if !strings.Contains(stdout.String(), "ss -tulnp -l") {
|
|
t.Errorf("passthrough args missing:\n%s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestLeafNoMatch(t *testing.T) {
|
|
app, _, stderr := testApp(centos()) // no container runtime
|
|
|
|
code := app.Execute([]string{"docker", "clearsafe"})
|
|
if code != 1 {
|
|
t.Fatalf("exit code = %d, want 1", code)
|
|
}
|
|
if !strings.Contains(stderr.String(), "不支持当前平台") {
|
|
t.Errorf("stderr lacks explanation:\n%s", stderr.String())
|
|
}
|
|
if !strings.Contains(stderr.String(), "kopsc explain") {
|
|
t.Errorf("stderr lacks hint:\n%s", stderr.String())
|
|
}
|
|
}
|
|
|
|
func TestList(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"list"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
out := stdout.String()
|
|
for _, want := range []string{"docker.clearsafe", "net.ports", "pkg.refreshindex", "可用", "docker system prune -f"} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("list output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestListMarksUnavailable(t *testing.T) {
|
|
app, stdout, _ := testApp(platform.Info{OS: "plan9", Arch: "mips"})
|
|
|
|
if code := app.Execute([]string{"list"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
if !strings.Contains(stdout.String(), "不可用") {
|
|
t.Errorf("unavailable commands not marked:\n%s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestExplain(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker", "podman"))
|
|
|
|
if code := app.Execute([]string{"explain", "docker.clearsafe"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
out := stdout.String()
|
|
for _, want := range []string{
|
|
"命令: docker.clearsafe",
|
|
"平台:",
|
|
"命中变体 #0",
|
|
"候选:",
|
|
"✓",
|
|
"✗",
|
|
"podman system prune -f",
|
|
"distro=centos",
|
|
} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("explain output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestExplainUnavailableStillListsCandidates(t *testing.T) {
|
|
app, stdout, _ := testApp(centos()) // no runtime
|
|
|
|
if code := app.Execute([]string{"explain", "docker.clearsafe"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
out := stdout.String()
|
|
if !strings.Contains(out, "当前平台不可用") {
|
|
t.Errorf("missing unavailable marker:\n%s", out)
|
|
}
|
|
if strings.Count(out, "✗") != len(registry.Builtin().Commands[0].Variants) {
|
|
t.Errorf("expected every candidate to be listed:\n%s", out)
|
|
}
|
|
}
|
|
|
|
func TestExplainUnknownCommand(t *testing.T) {
|
|
app, _, stderr := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"explain", "nope"}); code != 1 {
|
|
t.Fatalf("exit code = %d, want 1", code)
|
|
}
|
|
if !strings.Contains(stderr.String(), "未知命令") {
|
|
t.Errorf("stderr = %s", stderr.String())
|
|
}
|
|
}
|
|
|
|
func TestPlatform(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker", "podman"))
|
|
|
|
if code := app.Execute([]string{"platform"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
out := stdout.String()
|
|
for _, want := range []string{"linux", "amd64", "centos", "rhel fedora", "docker, podman"} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("platform output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestVersion(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"version"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
if !strings.Contains(stdout.String(), "kopsc test linux/amd64") {
|
|
t.Errorf("version output = %s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestGroupHelp(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"docker"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
if !strings.Contains(stdout.String(), "clearsafe") {
|
|
t.Errorf("group help missing subcommand:\n%s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestParseLeafArgs(t *testing.T) {
|
|
plain := ®istry.Command{ID: "docker.logs"}
|
|
namespaced := ®istry.Command{ID: "diagnose", Namespaced: true}
|
|
|
|
tests := []struct {
|
|
name string
|
|
cmd *registry.Command
|
|
args []string
|
|
wantDryRun bool
|
|
wantYes bool
|
|
wantExtra []string
|
|
wantHelp bool
|
|
wantErr bool
|
|
}{
|
|
{"empty", plain, nil, false, false, nil, false, false},
|
|
{"plain -n is dry-run", plain, []string{"-n"}, true, false, nil, false, false},
|
|
{"dry-run long", plain, []string{"--dry-run"}, true, false, nil, false, false},
|
|
{"dry-run false", plain, []string{"--dry-run=false"}, false, false, nil, false, false},
|
|
{"yes long", plain, []string{"--yes"}, false, true, nil, false, false},
|
|
{"yes short", plain, []string{"-y"}, false, true, nil, false, false},
|
|
{"help", plain, []string{"-h"}, false, false, nil, true, false},
|
|
{"passthrough", plain, []string{"--", "--dry-run", "-h", "--yes"}, false, false, []string{"--dry-run", "-h", "--yes"}, false, false},
|
|
{"unknown flags forwarded", plain, []string{"--filter", "until=1h"}, false, false, []string{"--filter", "until=1h"}, false, false},
|
|
{"mixed", plain, []string{"--dry-run", "arg", "--", "-n"}, true, false, []string{"arg", "-n"}, false, false},
|
|
|
|
{"namespaced -n", namespaced, []string{"api-0", "-n", "prod"}, false, false, []string{"api-0", "--namespace", "prod"}, false, false},
|
|
{"namespaced -n=value", namespaced, []string{"api-0", "-n=prod"}, false, false, []string{"api-0", "--namespace=prod"}, false, false},
|
|
{"namespaced -N", namespaced, []string{"api-0", "-N", "prod"}, false, false, []string{"api-0", "--namespace", "prod"}, false, false},
|
|
{"namespaced --namespace", namespaced, []string{"api-0", "--namespace", "prod"}, false, false, []string{"api-0", "--namespace", "prod"}, false, false},
|
|
{"namespaced --namespace=value", namespaced, []string{"api-0", "--namespace=prod"}, false, false, []string{"api-0", "--namespace=prod"}, false, false},
|
|
{"namespaced --dry-run still previews", namespaced, []string{"api-0", "--dry-run"}, true, false, []string{"api-0"}, false, false},
|
|
{"namespaced -n without value", namespaced, []string{"api-0", "-n"}, false, false, nil, false, true},
|
|
{"namespaced passthrough keeps -n", namespaced, []string{"--", "-n", "prod"}, false, false, []string{"-n", "prod"}, false, false},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
dryRun, yes, extra, help, err := parseLeafArgs(tc.cmd, tc.args)
|
|
if tc.wantErr {
|
|
if err == nil {
|
|
t.Fatal("expected an error")
|
|
}
|
|
return
|
|
}
|
|
if err != nil {
|
|
t.Fatalf("unexpected error: %v", err)
|
|
}
|
|
if dryRun != tc.wantDryRun || yes != tc.wantYes || help != tc.wantHelp {
|
|
t.Errorf("dryRun=%v yes=%v help=%v, want %v/%v/%v",
|
|
dryRun, yes, help, tc.wantDryRun, tc.wantYes, tc.wantHelp)
|
|
}
|
|
if strings.Join(extra, "|") != strings.Join(tc.wantExtra, "|") {
|
|
t.Errorf("extra = %v, want %v", extra, tc.wantExtra)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestDestructiveCommandRequiresYes(t *testing.T) {
|
|
app, stdout, stderr := testApp(centos("docker"))
|
|
|
|
code := app.Execute([]string{"docker", "clearall"})
|
|
if code != 2 {
|
|
t.Fatalf("exit code = %d, want 2", code)
|
|
}
|
|
out := stdout.String()
|
|
for _, want := range []string{"破坏性命令", "将执行: docker system prune -a -f", "影响", "kopsc docker clearall --yes"} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("confirmation output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
if stderr.Len() != 0 {
|
|
t.Errorf("unexpected stderr: %s", stderr.String())
|
|
}
|
|
}
|
|
|
|
func TestDestructiveCommandDryRunNeedsNoYes(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"docker", "prunevolumes", "--dry-run"}); code != 0 {
|
|
t.Fatalf("exit code = %d, want 0", code)
|
|
}
|
|
if !strings.Contains(stdout.String(), "docker volume prune -f") {
|
|
t.Errorf("dry-run output:\n%s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestYesIsNotForwarded(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"docker", "clearall", "--yes", "--dry-run"}); code != 0 {
|
|
t.Fatalf("exit code = %d, want 0", code)
|
|
}
|
|
out := stdout.String()
|
|
if strings.Contains(out, "--yes") {
|
|
t.Errorf("--yes leaked into the forwarded args:\n%s", out)
|
|
}
|
|
if !strings.Contains(out, "docker system prune -a -f") {
|
|
t.Errorf("unexpected dry-run output:\n%s", out)
|
|
}
|
|
}
|
|
|
|
func TestMissingRequiredArgs(t *testing.T) {
|
|
app, _, stderr := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"docker", "logs"}); code != 1 {
|
|
t.Fatalf("exit code = %d, want 1", code)
|
|
}
|
|
msg := stderr.String()
|
|
for _, want := range []string{"缺少参数", "kopsc docker logs <容器>"} {
|
|
if !strings.Contains(msg, want) {
|
|
t.Errorf("stderr missing %q:\n%s", want, msg)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestMissingArgsWhenOnlyOptionsGiven(t *testing.T) {
|
|
app, _, stderr := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"docker", "rm", "-f"}); code != 1 {
|
|
t.Fatalf("exit code = %d, want 1", code)
|
|
}
|
|
if !strings.Contains(stderr.String(), "缺少参数") {
|
|
t.Errorf("stderr = %s", stderr.String())
|
|
}
|
|
}
|
|
|
|
func TestDestructiveHelpMentionsYes(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"docker", "clearall", "-h"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
out := stdout.String()
|
|
if !strings.Contains(out, "--yes") || !strings.Contains(out, "状态码 2") {
|
|
t.Errorf("help missing --yes documentation:\n%s", out)
|
|
}
|
|
}
|
|
|
|
func TestDiskUsageCommandThroughCLI(t *testing.T) {
|
|
root := t.TempDir()
|
|
if err := os.WriteFile(filepath.Join(root, "a.bin"), bytes.Repeat([]byte("x"), 4096), 0o644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := os.MkdirAll(filepath.Join(root, "sub"), 0o755); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if err := os.WriteFile(filepath.Join(root, "sub", "b.bin"), bytes.Repeat([]byte("x"), 1024), 0o644); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
app, stdout, stderr := testApp(centos("docker"))
|
|
if code := app.Execute([]string{"disk", "usage", root}); code != 0 {
|
|
t.Fatalf("exit code = %d, stderr=%s", code, stderr.String())
|
|
}
|
|
out := stdout.String()
|
|
for _, want := range []string{"4.0K", "1.0K", "a.bin", "sub", "总计 " + root} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("disk usage output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestDiskUsageAcceptsPathFlagThroughCLI(t *testing.T) {
|
|
root := t.TempDir()
|
|
|
|
app, stdout, stderr := testApp(centos("docker"))
|
|
if code := app.Execute([]string{"disk", "usage", "--path", root}); code != 0 {
|
|
t.Fatalf("exit code = %d, stderr=%s", code, stderr.String())
|
|
}
|
|
if !strings.Contains(stdout.String(), "总计 "+root) {
|
|
t.Errorf("unexpected output:\n%s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestDiskUsageRequiresPathThroughCLI(t *testing.T) {
|
|
app, _, stderr := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"disk", "usage"}); code != 1 {
|
|
t.Fatalf("exit code = %d, want 1", code)
|
|
}
|
|
if !strings.Contains(stderr.String(), "必须提供路径") {
|
|
t.Errorf("stderr = %s", stderr.String())
|
|
}
|
|
}
|
|
|
|
func TestDiskUsageDryRunDoesNotTouchPath(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
code := app.Execute([]string{"disk", "usage", "/path/that/does/not/exist", "--dry-run"})
|
|
if code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
out := stdout.String()
|
|
if !strings.Contains(out, "(内置) disk.usage /path/that/does/not/exist") {
|
|
t.Errorf("dry-run output missing builtin plan:\n%s", out)
|
|
}
|
|
if strings.Contains(out, "无法访问") {
|
|
t.Errorf("dry-run should not execute the builtin:\n%s", out)
|
|
}
|
|
}
|
|
|
|
func TestDiskUsageHelp(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"disk", "usage", "-h"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
if !strings.Contains(stdout.String(), "(内置) disk.usage") {
|
|
t.Errorf("help output missing builtin target:\n%s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestDiagnoseDryRun(t *testing.T) {
|
|
app, stdout, stderr := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"diagnose", "web", "--dry-run"}); code != 0 {
|
|
t.Fatalf("exit code = %d, stderr=%s", code, stderr.String())
|
|
}
|
|
out := stdout.String()
|
|
for _, want := range []string{"[dry-run]", "(内置) diagnose web", "内置实现"} {
|
|
if !strings.Contains(out, want) {
|
|
t.Errorf("dry-run output missing %q:\n%s", want, out)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestDiagnoseNamespaceTranslationThroughCLI(t *testing.T) {
|
|
app, stdout, _ := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"diagnose", "api-0", "-n", "prod", "--dry-run"}); code != 0 {
|
|
t.Fatalf("exit code = %d", code)
|
|
}
|
|
if !strings.Contains(stdout.String(), "api-0 --namespace prod") {
|
|
t.Errorf("-n was not translated to --namespace:\n%s", stdout.String())
|
|
}
|
|
}
|
|
|
|
func TestDiagnoseRequiresTarget(t *testing.T) {
|
|
app, _, stderr := testApp(centos("docker"))
|
|
|
|
if code := app.Execute([]string{"diagnose"}); code != 1 {
|
|
t.Fatalf("exit code = %d, want 1", code)
|
|
}
|
|
if !strings.Contains(stderr.String(), "缺少参数") {
|
|
t.Errorf("stderr = %s", stderr.String())
|
|
}
|
|
}
|
|
|
|
// TestCLIHelperProcess is re-executed as a child to verify exit-code passthrough.
|
|
func TestCLIHelperProcess(t *testing.T) {
|
|
if os.Getenv("KOPSC_CLI_HELPER") != "1" {
|
|
return
|
|
}
|
|
os.Exit(9)
|
|
}
|
|
|
|
func TestExecutionPreservesExitCode(t *testing.T) {
|
|
t.Setenv("KOPSC_CLI_HELPER", "1")
|
|
|
|
app, _, _ := testApp(centos("docker"))
|
|
app.Registry = ®istry.Registry{Commands: []registry.Command{{
|
|
ID: "demo.fail",
|
|
Summary: "always fails",
|
|
Variants: []registry.Variant{{
|
|
Match: registry.Match{OS: "linux"},
|
|
Argv: []string{os.Args[0], "-test.run=TestCLIHelperProcess"},
|
|
}},
|
|
}}}
|
|
|
|
if code := app.Execute([]string{"demo", "fail"}); code != 9 {
|
|
t.Fatalf("exit code = %d, want 9", code)
|
|
}
|
|
}
|