baremetal: add API to set maintenance and maintenance reason

dtantsur · dtantsur · commit a2b45326b4b8 · 2022-04-21T11:41:20.000+02:00
For very historical reasons, Ironic requires a special API to set them.
While the maintenance itself can be set directly (for even more
historical reasons), the reason cannot.
diff --git a/acceptance/openstack/baremetal/v1/nodes_test.go b/acceptance/openstack/baremetal/v1/nodes_test.go
@@ -68,6 +68,38 @@ func TestNodesUpdate(t *testing.T) {
 	th.AssertEquals(t, updated.Maintenance, true)
 }
 
+func TestNodesMaintenance(t *testing.T) {
+	clients.RequireLong(t)
+
+	client, err := clients.NewBareMetalV1Client()
+	th.AssertNoErr(t, err)
+	client.Microversion = "1.38"
+
+	node, err := CreateNode(t, client)
+	th.AssertNoErr(t, err)
+	defer DeleteNode(t, client, node)
+
+	err = nodes.SetMaintenance(client, node.UUID, nodes.MaintenanceOpts{
+		Reason: "I'm tired",
+	}).ExtractErr()
+	th.AssertNoErr(t, err)
+
+	updated, err := nodes.Get(client, node.UUID).Extract()
+	th.AssertNoErr(t, err)
+
+	th.AssertEquals(t, updated.Maintenance, true)
+	th.AssertEquals(t, updated.MaintenanceReason, "I'm tired")
+
+	err = nodes.UnsetMaintenance(client, node.UUID).ExtractErr()
+	th.AssertNoErr(t, err)
+
+	updated, err = nodes.Get(client, node.UUID).Extract()
+	th.AssertNoErr(t, err)
+
+	th.AssertEquals(t, updated.Maintenance, false)
+	th.AssertEquals(t, updated.MaintenanceReason, "")
+}
+
 func TestNodesRAIDConfig(t *testing.T) {
 	clients.SkipReleasesBelow(t, "stable/ussuri")
 	clients.RequireLong(t)
diff --git a/openstack/baremetal/v1/nodes/requests.go b/openstack/baremetal/v1/nodes/requests.go
@@ -835,3 +835,47 @@ func CreateSubscription(client *gophercloud.ServiceClient, id string, method Cal
 	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
 	return r
 }
+
+// MaintenanceOpts for a request to set the node's maintenance mode.
+type MaintenanceOpts struct {
+	Reason string `json:"reason,omitempty"`
+}
+
+// MaintenanceOptsBuilder allows extensions to add additional parameters to the SetMaintenance request.
+type MaintenanceOptsBuilder interface {
+	ToMaintenanceMap() (map[string]interface{}, error)
+}
+
+// ToMaintenanceMap assembles a request body based on the contents of a MaintenanceOpts.
+func (opts MaintenanceOpts) ToMaintenanceMap() (map[string]interface{}, error) {
+	body, err := gophercloud.BuildRequestBody(opts, "")
+	if err != nil {
+		return nil, err
+	}
+
+	return body, nil
+}
+
+// Request to set the Node's maintenance mode.
+func SetMaintenance(client *gophercloud.ServiceClient, id string, opts MaintenanceOptsBuilder) (r SetMaintenanceResult) {
+	reqBody, err := opts.ToMaintenanceMap()
+	if err != nil {
+		r.Err = err
+		return
+	}
+
+	resp, err := client.Put(maintenanceURL(client, id), reqBody, nil, &gophercloud.RequestOpts{
+		OkCodes: []int{202},
+	})
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
+
+// Request to unset the Node's maintenance mode.
+func UnsetMaintenance(client *gophercloud.ServiceClient, id string) (r SetMaintenanceResult) {
+	resp, err := client.Delete(maintenanceURL(client, id), &gophercloud.RequestOpts{
+		OkCodes: []int{202},
+	})
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
diff --git a/openstack/baremetal/v1/nodes/results.go b/openstack/baremetal/v1/nodes/results.go
@@ -501,3 +501,9 @@ type SubscriptionVendorPassthru struct {
 	EventTypes  []string `json:"EventTypes"`
 	Protocol    string   `json:"Protocol"`
 }
+
+// SetMaintenanceResult is the response from a SetMaintenance operation. Call its ExtractErr
+// method to determine if the call succeeded or failed.
+type SetMaintenanceResult struct {
+	gophercloud.ErrResult
+}
diff --git a/openstack/baremetal/v1/nodes/testing/fixtures.go b/openstack/baremetal/v1/nodes/testing/fixtures.go
@@ -806,6 +806,12 @@ const NodeCreateSubscriptionVendorPassthruRequiredParametersBody = `
 }
 `
 
+const NodeSetMaintenanceBody = `
+{
+  "reason": "I'm tired"
+}
+`
+
 var (
 	NodeFoo = nodes.Node{
 		UUID:                 "d2630783-6ec8-4836-b556-ab427c4b581e",
@@ -1524,3 +1530,22 @@ func HandleDeleteSubscriptionVendorPassthruSuccessfully(t *testing.T) {
 		w.WriteHeader(http.StatusNoContent)
 	})
 }
+
+func HandleSetNodeMaintenanceSuccessfully(t *testing.T) {
+	th.Mux.HandleFunc("/nodes/1234asdf/maintenance", func(w http.ResponseWriter, r *http.Request) {
+		th.TestMethod(t, r, "PUT")
+		th.TestHeader(t, r, "X-Auth-Token", client.TokenID)
+		th.TestJSONRequest(t, r, NodeSetMaintenanceBody)
+
+		w.WriteHeader(http.StatusAccepted)
+	})
+}
+
+func HandleUnsetNodeMaintenanceSuccessfully(t *testing.T) {
+	th.Mux.HandleFunc("/nodes/1234asdf/maintenance", func(w http.ResponseWriter, r *http.Request) {
+		th.TestMethod(t, r, "DELETE")
+		th.TestHeader(t, r, "X-Auth-Token", client.TokenID)
+
+		w.WriteHeader(http.StatusAccepted)
+	})
+}
diff --git a/openstack/baremetal/v1/nodes/testing/requests_test.go b/openstack/baremetal/v1/nodes/testing/requests_test.go
@@ -689,3 +689,25 @@ func TestDeleteSubscription(t *testing.T) {
 	err := nodes.DeleteSubscription(c, "1234asdf", method, deleteOpt).ExtractErr()
 	th.AssertNoErr(t, err)
 }
+
+func TestSetMaintenance(t *testing.T) {
+	th.SetupHTTP()
+	defer th.TeardownHTTP()
+	HandleSetNodeMaintenanceSuccessfully(t)
+
+	c := client.ServiceClient()
+	err := nodes.SetMaintenance(c, "1234asdf", nodes.MaintenanceOpts{
+		Reason: "I'm tired",
+	}).ExtractErr()
+	th.AssertNoErr(t, err)
+}
+
+func TestUnsetMaintenance(t *testing.T) {
+	th.SetupHTTP()
+	defer th.TeardownHTTP()
+	HandleUnsetNodeMaintenanceSuccessfully(t)
+
+	c := client.ServiceClient()
+	err := nodes.UnsetMaintenance(c, "1234asdf").ExtractErr()
+	th.AssertNoErr(t, err)
+}
diff --git a/openstack/baremetal/v1/nodes/urls.go b/openstack/baremetal/v1/nodes/urls.go
@@ -73,3 +73,7 @@ func vendorPassthruMethodsURL(client *gophercloud.ServiceClient, id string) stri
 func vendorPassthruCallURL(client *gophercloud.ServiceClient, id string) string {
 	return client.ServiceURL("nodes", id, "vendor_passthru")
 }
+
+func maintenanceURL(client *gophercloud.ServiceClient, id string) string {
+	return client.ServiceURL("nodes", id, "maintenance")
+}

Original file line number	Diff line number	Diff line change
`@@ -73,3 +73,7 @@ func vendorPassthruMethodsURL(client *gophercloud.ServiceClient, id string) stri`
`73`	`73`	`func vendorPassthruCallURL(client *gophercloud.ServiceClient, id string) string {`
`74`	`74`	`return client.ServiceURL("nodes", id, "vendor_passthru")`
`75`	`75`	`}`
	`76`	`+`
	`77`	`+func maintenanceURL(client *gophercloud.ServiceClient, id string) string {`
	`78`	`+ return client.ServiceURL("nodes", id, "maintenance")`
	`79`	`+}`