Merge pull request #502 from zavitaev-a/add-stack-state

Add state and state_reason to Stack object as described in https://v3-apidocs.cloudfoundry.org/version/3.212.0/index.html#stacks

Author: sneal

client/stack_test.go

@@ -13,6 +13,8 @@ func TestStacks(t *testing.T) {
 	g := testutil.NewObjectJSONGenerator()
 	stack := g.Stack().JSON
 	stack2 := g.Stack().JSON
+	stackWithState := g.StackWithState("ACTIVE", "Stack is fully available").JSON
+	stackWithState2 := g.StackWithState("DEPRECATED", "Stack deprecated and will be removed").JSON
 	app := g.Application().JSON
 	app2 := g.Application().JSON
 
@@ -36,6 +38,29 @@ func TestStacks(t *testing.T) {
 				return c.Stacks.Create(context.Background(), r)
 			},
 		},
+		{
+			Description: "Create stack with state",
+			Route: testutil.MockRoute{
+				Method:   "POST",
+				Endpoint: "/v3/stacks",
+				Output:   g.Single(stackWithState),
+				Status:   http.StatusCreated,
+				PostForm: `{ "name": "my-stack", "description": "Here is my stack!", "state": "ACTIVE", "state_reason": "Stack is fully available" }`,
+			},
+			Expected: stackWithState,
+			Action: func(c *Client, t *testing.T) (any, error) {
+				stackDescription := "Here is my stack!"
+				stackState := "ACTIVE"
+				stackStateReason := "Stack is fully available"
+				r := &resource.StackCreate{
+					Name:        "my-stack",
+					Description: &stackDescription,
+					State:       &stackState,
+					StateReason: &stackStateReason,
+				}
+				return c.Stacks.Create(context.Background(), r)
+			},
+		},
 		{
 			Description: "Delete stack",
 			Route: testutil.MockRoute{
@@ -59,6 +84,18 @@ func TestStacks(t *testing.T) {
 				return c.Stacks.Get(context.Background(), "88db2b75-671f-4e4b-a19a-7db992366595")
 			},
 		},
+		{
+			Description: "Get stack with state",
+			Route: testutil.MockRoute{
+				Method:   "GET",
+				Endpoint: "/v3/stacks/88db2b75-671f-4e4b-a19a-7db992366595",
+				Output:   g.Single(stackWithState),
+				Status:   http.StatusOK},
+			Expected: stackWithState,
+			Action: func(c *Client, t *testing.T) (any, error) {
+				return c.Stacks.Get(context.Background(), "88db2b75-671f-4e4b-a19a-7db992366595")
+			},
+		},
 		{
 			Description: "List all stacks",
 			Route: testutil.MockRoute{
@@ -71,6 +108,18 @@ func TestStacks(t *testing.T) {
 				return c.Stacks.ListAll(context.Background(), nil)
 			},
 		},
+		{
+			Description: "List all stacks with state",
+			Route: testutil.MockRoute{
+				Method:   "GET",
+				Endpoint: "/v3/stacks",
+				Output:   g.Paged([]string{stackWithState}, []string{stackWithState2}),
+				Status:   http.StatusOK},
+			Expected: g.Array(stackWithState, stackWithState2),
+			Action: func(c *Client, t *testing.T) (any, error) {
+				return c.Stacks.ListAll(context.Background(), nil)
+			},
+		},
 		{
 			Description: "List all apps for given stack",
 			Route: testutil.MockRoute{
@@ -102,6 +151,26 @@ func TestStacks(t *testing.T) {
 				return c.Stacks.Update(context.Background(), "88db2b75-671f-4e4b-a19a-7db992366595", r)
 			},
 		},
+		{
+			Description: "Update stack state",
+			Route: testutil.MockRoute{
+				Method:   "PATCH",
+				Endpoint: "/v3/stacks/88db2b75-671f-4e4b-a19a-7db992366595",
+				Output:   g.Single(stackWithState2),
+				Status:   http.StatusOK,
+				PostForm: `{ "state": "DEPRECATED", "state_reason": "Stack deprecated and will be removed" }`,
+			},
+			Expected: stackWithState2,
+			Action: func(c *Client, t *testing.T) (any, error) {
+				state := "DEPRECATED"
+				stateReason := "Stack deprecated and will be removed"
+				r := &resource.StackUpdate{
+					State:       &state,
+					StateReason: &stateReason,
+				}
+				return c.Stacks.Update(context.Background(), "88db2b75-671f-4e4b-a19a-7db992366595", r)
+			},
+		},
 	}
 	ExecuteTests(tests, t)
 }

resource/stack.go

@@ -6,6 +6,8 @@ package resource
 type Stack struct {
 	Name             string    `json:"name"`
 	Description      *string   `json:"description"`
+	State            *string   `json:"state,omitempty"`
+	StateReason      *string   `json:"state_reason,omitempty"`
 	RunRootfsImage   string    `json:"run_rootfs_image"`
 	BuildRootfsImage string    `json:"build_rootfs_image"`
 	Default          bool      `json:"default"`
@@ -16,11 +18,15 @@ type Stack struct {
 type StackCreate struct {
 	Name        string    `json:"name"`
 	Description *string   `json:"description,omitempty"`
+	State       *string   `json:"state,omitempty"`
+	StateReason *string   `json:"state_reason,omitempty"`
 	Metadata    *Metadata `json:"metadata,omitempty"`
 }
 
 type StackUpdate struct {
-	Metadata *Metadata `json:"metadata,omitempty"`
+	Metadata    *Metadata `json:"metadata,omitempty"`
+	State       *string   `json:"state,omitempty"`
+	StateReason *string   `json:"state_reason,omitempty"`
 }
 
 type StackList struct {

testutil/object_generator.go

@@ -455,6 +455,18 @@ func (o ObjectJSONGenerator) Stack() *JSONResource {
 	return o.renderTemplate(r, "stack.json")
 }
 
+func (o ObjectJSONGenerator) StackWithState(state, stateReason string) *JSONResource {
+	r := &JSONResource{
+		GUID: RandomGUID(),
+		Name: RandomName(),
+		Params: map[string]string{
+			"state":        state,
+			"state_reason": stateReason,
+		},
+	}
+	return o.renderTemplate(r, "stack.json")
+}
+
 func (o ObjectJSONGenerator) Task() *JSONResource {
 	r := &JSONResource{
 		GUID: RandomGUID(),

testutil/template/stack.json

@@ -4,6 +4,12 @@
   "updated_at": "2018-11-09T22:43:28Z",
   "name": "{{.Name}}",
   "description": "Here is my stack!",
+  {{- if index .Params "state"}}
+  "state": "{{index .Params "state"}}",
+  {{- end}}
+  {{- if index .Params "state_reason"}}
+  "state_reason": "{{index .Params "state_reason"}}",
+  {{- end}}
   "build_rootfs_image": "{{.Name}}",
   "run_rootfs_image": "{{.Name}}",
   "default": false,