Baremetal: support deploy_steps for the provisioning API

dtantsur · dtantsur · commit 04a5ac49d9aa · 2021-02-22T13:16:20.000+01:00
Deploy steps work similarly to clean steps but during deployment. For: #2119
diff --git a/openstack/baremetal/v1/nodes/requests.go b/openstack/baremetal/v1/nodes/requests.go
@@ -394,15 +394,36 @@ func GetSupportedBootDevices(client *gophercloud.ServiceClient, id string) (r Su
 	return
 }
 
+// An interface type for a deploy (or clean) step.
+type StepInterface string
+
+const (
+	InterfaceBIOS       StepInterface = "bios"
+	InterfaceDeploy     StepInterface = "deploy"
+	InterfaceManagement StepInterface = "management"
+	InterfacePower      StepInterface = "power"
+	InterfaceRAID       StepInterface = "raid"
+)
+
 // A cleaning step has required keys ‘interface’ and ‘step’, and optional key ‘args’. If specified,
 // the value for ‘args’ is a keyword variable argument dictionary that is passed to the cleaning step
 // method.
 type CleanStep struct {
-	Interface string                 `json:"interface" required:"true"`
+	Interface StepInterface          `json:"interface" required:"true"`
 	Step      string                 `json:"step" required:"true"`
 	Args      map[string]interface{} `json:"args,omitempty"`
 }
 
+// A deploy step has required keys ‘interface’, ‘step’, ’args’ and ’priority’.
+// The value for ‘args’ is a keyword variable argument dictionary that is passed to the deploy step
+// method. Priority is a numeric priority at which the step is running.
+type DeployStep struct {
+	Interface StepInterface          `json:"interface" required:"true"`
+	Step      string                 `json:"step" required:"true"`
+	Args      map[string]interface{} `json:"args" required:"true"`
+	Priority  int                    `json:"priority" required:"true"`
+}
+
 // ProvisionStateOptsBuilder allows extensions to add additional parameters to the
 // ChangeProvisionState request.
 type ProvisionStateOptsBuilder interface {
@@ -418,11 +439,12 @@ type ConfigDrive struct {
 }
 
 // ProvisionStateOpts for a request to change a node's provision state. A config drive should be base64-encoded
-// gzipped ISO9660 image.
+// gzipped ISO9660 image. Deploy steps are supported starting with API 1.69.
 type ProvisionStateOpts struct {
 	Target         TargetProvisionState `json:"target" required:"true"`
 	ConfigDrive    interface{}          `json:"configdrive,omitempty"`
 	CleanSteps     []CleanStep          `json:"clean_steps,omitempty"`
+	DeploySteps    []DeployStep         `json:"deploy_steps,omitempty"`
 	RescuePassword string               `json:"rescue_password,omitempty"`
 }
 
diff --git a/openstack/baremetal/v1/nodes/testing/fixtures.go b/openstack/baremetal/v1/nodes/testing/fixtures.go
@@ -547,6 +547,23 @@ const NodeProvisionStateActiveBody = `
     "configdrive": "http://127.0.0.1/images/test-node-config-drive.iso.gz"
 }
 `
+
+const NodeProvisionStateActiveBodyWithSteps = `
+{
+    "target": "active",
+    "deploy_steps": [
+	{
+	    "interface": "deploy",
+	    "step": "inject_files",
+	    "priority": 50,
+	    "args": {
+		"files": []
+	    }
+	}
+    ]
+}
+`
+
 const NodeProvisionStateCleanBody = `
 {
     "target": "clean",
@@ -937,6 +954,15 @@ func HandleNodeChangeProvisionStateActive(t *testing.T) {
 	})
 }
 
+func HandleNodeChangeProvisionStateActiveWithSteps(t *testing.T) {
+	th.Mux.HandleFunc("/nodes/1234asdf/states/provision", 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, NodeProvisionStateActiveBodyWithSteps)
+		w.WriteHeader(http.StatusAccepted)
+	})
+}
+
 func HandleNodeChangeProvisionStateClean(t *testing.T) {
 	th.Mux.HandleFunc("/nodes/1234asdf/states/provision", func(w http.ResponseWriter, r *http.Request) {
 		th.TestMethod(t, r, "PUT")
diff --git a/openstack/baremetal/v1/nodes/testing/requests_test.go b/openstack/baremetal/v1/nodes/testing/requests_test.go
@@ -254,6 +254,29 @@ func TestNodeChangeProvisionStateActive(t *testing.T) {
 	th.AssertNoErr(t, err)
 }
 
+func TestNodeChangeProvisionStateActiveWithSteps(t *testing.T) {
+	th.SetupHTTP()
+	defer th.TeardownHTTP()
+	HandleNodeChangeProvisionStateActiveWithSteps(t)
+
+	c := client.ServiceClient()
+	err := nodes.ChangeProvisionState(c, "1234asdf", nodes.ProvisionStateOpts{
+		Target: nodes.TargetActive,
+		DeploySteps: []nodes.DeployStep{
+			{
+				Interface: nodes.InterfaceDeploy,
+				Step:      "inject_files",
+				Priority:  50,
+				Args: map[string]interface{}{
+					"files": []interface{}{},
+				},
+			},
+		},
+	}).ExtractErr()
+
+	th.AssertNoErr(t, err)
+}
+
 func TestHandleNodeChangeProvisionStateConfigDrive(t *testing.T) {
 	th.SetupHTTP()
 	defer th.TeardownHTTP()
@@ -280,7 +303,7 @@ func TestNodeChangeProvisionStateClean(t *testing.T) {
 		Target: nodes.TargetClean,
 		CleanSteps: []nodes.CleanStep{
 			{
-				Interface: "deploy",
+				Interface: nodes.InterfaceDeploy,
 				Step:      "upgrade_firmware",
 				Args: map[string]interface{}{
 					"force": "True",
@@ -302,7 +325,7 @@ func TestNodeChangeProvisionStateCleanWithConflict(t *testing.T) {
 		Target: nodes.TargetClean,
 		CleanSteps: []nodes.CleanStep{
 			{
-				Interface: "deploy",
+				Interface: nodes.InterfaceDeploy,
 				Step:      "upgrade_firmware",
 				Args: map[string]interface{}{
 					"force": "True",
@@ -341,7 +364,7 @@ func TestCleanStepRequiresStep(t *testing.T) {
 		Target: nodes.TargetClean,
 		CleanSteps: []nodes.CleanStep{
 			{
-				Interface: "deploy",
+				Interface: nodes.InterfaceDeploy,
 				Args: map[string]interface{}{
 					"force": "True",
 				},
