feat(ps): add pod describe

Author: duanhongyi

api/ps.go

@@ -55,3 +55,18 @@ type Types struct {
 func (p PodTypes) Len() int           { return len(p) }
 func (p PodTypes) Swap(i, j int)      { p[i], p[j] = p[j], p[i] }
 func (p PodTypes) Less(i, j int) bool { return p[i].Type < p[j].Type }
+
+// ContainerState defines a container state.
+type ContainerState struct {
+	Container    string                            `json:"container"`
+	Image        string                            `json:"image"`
+	Command      []string                          `json:"command"`
+	Args         []string                          `json:"args"`
+	State        map[string]map[string]interface{} `json:"state"`
+	LastState    map[string]map[string]interface{} `json:"lastState"`
+	Ready        bool                              `json:"ready"`
+	RestartCount int                               `json:"restartCount"`
+}
+
+// PodState defines a collection of container state.
+type PodState []ContainerState

ps/ps.go

@@ -122,6 +122,22 @@ func Restart(c *drycc.Client, appID string, procType string) error {
 	return err
 }
 
+// Describe pod state
+func Describe(c *drycc.Client, appID string, podID string, results int) (api.PodState, int, error) {
+	u := fmt.Sprintf("/v2/apps/%s/pods/%s/describe/", appID, podID)
+
+	body, count, reqErr := c.LimitedRequest(u, results)
+	if reqErr != nil && !drycc.IsErrAPIMismatch(reqErr) {
+		return api.PodState{}, -1, reqErr
+	}
+
+	var podState api.PodState
+	if err := json.Unmarshal([]byte(body), &podState); err != nil {
+		return api.PodState{}, -1, err
+	}
+	return podState, count, reqErr
+}
+
 // ByType organizes processes of an app by process type.
 func ByType(processes api.PodsList) api.PodTypes {
 	var pts api.PodTypes

ps/ps_test.go

@@ -32,6 +32,39 @@ const processesFixture string = `
     ]
 }`
 
+const podStateFixture string = `
+{
+	"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
+	}]
+}`
+
 const scaleExpected string = `{"web":2}`
 
 type fakeHTTPServer struct{}
@@ -44,6 +77,11 @@ func (fakeHTTPServer) ServeHTTP(res http.ResponseWriter, req *http.Request) {
 		return
 	}
 
+	if req.URL.Path == "/v2/apps/example-go/pods/test-pod-web/describe/" && req.Method == "GET" {
+		res.Write([]byte(podStateFixture))
+		return
+	}
+
 	if req.URL.Path == "/v2/apps/example-go/pods/restart/" && req.Method == "POST" {
 		res.WriteHeader(http.StatusNoContent)
 		return
@@ -235,6 +273,54 @@ func TestAppsRestart(t *testing.T) {
 	}
 }
 
+func TestDescribe(t *testing.T) {
+	t.Parallel()
+
+	handler := fakeHTTPServer{}
+	server := httptest.NewServer(&handler)
+	defer server.Close()
+
+	drycc, err := drycc.New(false, server.URL, "abc")
+	if err != nil {
+		t.Fatal(err)
+	}
+	actual, _, err := Describe(drycc, "example-go", "test-pod-web", 100)
+	if err != nil {
+		t.Error(err)
+	}
+	expected := api.PodState{
+		{
+			Container: "web",
+			Image:     "registry.drycc.cc/base/base",
+			Command:   []string{"bash", "-c"},
+			Args:      []string{"sleep 3600s"},
+			State: map[string]map[string]interface{}{
+				"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: map[string]map[string]interface{}{
+				"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,
+		},
+	}
+	if !reflect.DeepEqual(actual[0].State, expected[0].State) {
+		t.Error(fmt.Errorf("Expected %v, Got %v", actual[0].State, expected[0].State))
+	}
+}
+
 func TestScale(t *testing.T) {
 	t.Parallel()