feat(ps): add ps describe

Author: duanhongyi

cmd/cmd.go

@@ -88,6 +88,7 @@ type Commander interface {
 	PsExec(string, string, bool, bool, []string) error
 	PsScale(string, []string) error
 	PsRestart(string, string) error
+	PsDescribe(string, string) error
 	RegistryList(string) error
 	RegistrySet(string, []string) error
 	RegistryUnset(string, []string) error

cmd/ps.go

@@ -159,6 +159,53 @@ func (d *DryccCmd) PsRestart(appID, target string) error {
 	return nil
 }
 
+// PsDescribe describe an app's processes.
+func (d *DryccCmd) PsDescribe(appID, podID string) error {
+	s, appID, err := load(d.ConfigFile, appID)
+	if err != nil {
+		return err
+	}
+	// The 1000 is fake for now until API understands limits
+	podState, _, err := ps.Describe(s.Client, appID, podID, 1000)
+	if d.checkAPICompatibility(s.Client, err) != nil {
+		return err
+	}
+	table := d.getDefaultFormatTable([]string{})
+	for _, containerState := range podState {
+		table.Append([]string{"Container:", containerState.Container})
+		table.Append([]string{"Image:", containerState.Image})
+		table.Append([]string{"Command:"})
+		for _, command := range containerState.Command {
+			table.Append([]string{"", fmt.Sprintf("- %v", command)})
+		}
+		table.Append([]string{"Args:"})
+		for _, arg := range containerState.Args {
+			table.Append([]string{"", fmt.Sprintf("- %v", arg)})
+		}
+		// State
+		for key := range containerState.State {
+			table.Append([]string{"State:", key})
+			value := containerState.State[key]
+			for innerKey := range value {
+				table.Append([]string{fmt.Sprintf("  %s:", innerKey), strconv.Quote(fmt.Sprintf("%v", value[innerKey]))})
+			}
+		}
+		// LastState
+		for key := range containerState.LastState {
+			table.Append([]string{"Last State:", key})
+			value := containerState.LastState[key]
+			for innerKey := range value {
+				table.Append([]string{fmt.Sprintf("  %s:", innerKey), strconv.Quote(fmt.Sprintf("%v", value[innerKey]))})
+			}
+		}
+		table.Append([]string{"Ready:", fmt.Sprintf("%v", containerState.Ready)})
+		table.Append([]string{"Restart Count:", fmt.Sprintf("%v", containerState.RestartCount)})
+		table.Append([]string{})
+	}
+	table.Render()
+	return nil
+}
+
 func printProcesses(d *DryccCmd, appID string, input []api.Pods) {
 	processes := ps.ByType(input)
 

cmd/ps_test.go

@@ -242,3 +242,52 @@ func TestPsRestart(t *testing.T) {
 	err = cmdr.PsRestart("testapp", "web")
 	assert.NoError(t, err)
 }
+
+func TestPsDescribe(t *testing.T) {
+	t.Parallel()
+	cf, server, err := testutil.NewTestServerAndClient()
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer server.Close()
+	var b bytes.Buffer
+	cmdr := DryccCmd{WOut: &b, ConfigFile: cf}
+
+	server.Mux.HandleFunc("/v2/apps/foo/pods/foo-web-111/describe/", func(w http.ResponseWriter, _ *http.Request) {
+		testutil.SetHeaders(w)
+		fmt.Fprintf(w, `{
+			"count": 1,
+			"next": null,
+			"previous": null,
+			"results": [{
+				"container": "web",
+				"image": "registry.drycc.cc/base/base",
+				"command": ["bash", "-c"],
+				"args": ["sleep 3600s"],
+				"state": {
+					"running": {
+					  "startedAt": "2024-05-21T02:27:03+00:00"
+					},
+					"waiting": {
+					  "message": "container create failed: executable file './start.sh' not found in $PATH: No such file or directory\n",
+					  "reason": "CreateContainerError"
+					}
+				},
+				"lastState": {
+					"terminated": {
+					  "containerID": "cri-o://ccfc73b0b4d966af4f93ca871a04fa97460620cd8005c1c36f7734a08ba49ed0",
+					  "exitCode": 1,
+					  "finishedAt": "2024-05-21T02:27:03+00:00",
+					  "reason": "Error",
+					  "startedAt": "2024-05-21T02:26:33+00:00"
+					}
+				},
+				"ready": true,
+				"restartCount": 1
+			}]
+		}`)
+	})
+
+	err = cmdr.PsDescribe("foo", "foo-web-111")
+	assert.NoError(t, err)
+}

go.mod

@@ -5,7 +5,7 @@ go 1.22
 require (
 	github.com/containerd/console v1.0.4
 	github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815
-	github.com/drycc/controller-sdk-go v0.0.0-20240501162129-fd677ec39e8c
+	github.com/drycc/controller-sdk-go v0.0.0-20240522092128-9ed47aac090e
 	github.com/drycc/pkg v0.0.0-20240225112316-78fc9239f51f
 	github.com/olekukonko/tablewriter v0.0.5
 	github.com/stretchr/testify v1.9.0

go.sum

@@ -4,8 +4,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815 h1:bWDMxwH3px2JBh6AyO7hdCn/PkvCZXii8TGj7sbtEbQ=
 github.com/docopt/docopt-go v0.0.0-20180111231733-ee0de3bc6815/go.mod h1:WwZ+bS3ebgob9U8Nd0kOddGdZWjyMGR8Wziv+TBNwSE=
-github.com/drycc/controller-sdk-go v0.0.0-20240501162129-fd677ec39e8c h1:C581oO1EmNJky8GpAricQftIufdeg2tlWgTvA5xPjJ0=
-github.com/drycc/controller-sdk-go v0.0.0-20240501162129-fd677ec39e8c/go.mod h1:n6eQe1irJqjwLo/7t9+Dhdv6faSESQN+ATnZRBP3/Uc=
+github.com/drycc/controller-sdk-go v0.0.0-20240522092128-9ed47aac090e h1:4gZBm6S2nsHH2JvX7Ky92XEM0JGPmVv6p6W7Phehz34=
+github.com/drycc/controller-sdk-go v0.0.0-20240522092128-9ed47aac090e/go.mod h1:n6eQe1irJqjwLo/7t9+Dhdv6faSESQN+ATnZRBP3/Uc=
 github.com/drycc/pkg v0.0.0-20240225112316-78fc9239f51f h1:kgjvUQJeAszDoU1Vo4vTTE92KI8Av3JPb6Qn890niXg=
 github.com/drycc/pkg v0.0.0-20240225112316-78fc9239f51f/go.mod h1:n+QxGif6ha9CEoxVnlipxb9IdmerybcUSzTEDFkvjiA=
 github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38=

parser/ps.go

@@ -18,6 +18,7 @@ ps:logs        print the logs for a container
 ps:exec        execute a command in a container
 ps:restart     restart an application or process type
 ps:scale       scale processes (e.g. web=4 worker=2)
+ps:describe    print a detailed description of the selected process
 
 Use 'drycc help [command]' to learn more.
 `
@@ -33,6 +34,8 @@ Use 'drycc help [command]' to learn more.
 		return psRestart(argv, cmdr)
 	case "ps:scale":
 		return psScale(argv, cmdr)
+	case "ps:describe":
+		return psDescribe(argv, cmdr)
 	default:
 		if printHelp(argv, usage) {
 			return nil
@@ -184,3 +187,25 @@ Options:
 	apps := safeGetString(args, "--app")
 	return cmdr.PsScale(apps, args["<type>=<num>"].([]string))
 }
+
+func psDescribe(argv []string, cmdr cmd.Commander) error {
+	usage := `
+Print a detailed description of the selected process.
+
+Usage: drycc ps:describe <pod> [options]
+
+Options:
+  -a --app=<app>
+    the uniquely identifiable name for the application.
+`
+
+	args, err := docopt.ParseArgs(usage, argv, "")
+
+	if err != nil {
+		return err
+	}
+
+	app := safeGetString(args, "--app")
+	pod := safeGetString(args, "<pod>")
+	return cmdr.PsDescribe(app, pod)
+}

parser/ps_test.go

@@ -32,6 +32,9 @@ func (d FakeDryccCmd) PsRestart(string, string) error {
 	return errors.New("ps:restart")
 }
 
+func (d FakeDryccCmd) PsDescribe(string, string) error {
+	return errors.New("ps:describe")
+}
 func TestPs(t *testing.T) {
 	t.Parallel()