Merge pull request #3214 from gophercloud/bp-v2-2b109d7

pierreprinetti · web-flow · commit b3417441528e · 2024-10-16T14:48:17.000+02:00
[v2] [manila] add scheduler_hints to the shares CreateOpts
diff --git a/openstack/sharedfilesystems/v2/shares/requests.go b/openstack/sharedfilesystems/v2/shares/requests.go
@@ -7,6 +7,22 @@ import (
 	"github.com/gophercloud/gophercloud/v2/pagination"
 )
 
+// SchedulerHints contains options for providing scheduler hints when creating
+// a Share.
+type SchedulerHints struct {
+	// DifferentHost will place the share on a different back-end that does not
+	// host the given shares.
+	DifferentHost string `json:"different_host,omitempty"`
+
+	// SameHost will place the share on a back-end that hosts the given shares.
+	SameHost string `json:"same_host,omitempty"`
+
+	// OnlyHost value must be a manage-share service host in
+	// host@backend#POOL format (admin only). Only available in and beyond
+	// API version 2.67
+	OnlyHost string `json:"only_host,omitempty"`
+}
+
 // CreateOptsBuilder allows extensions to add additional parameters to the
 // Create request.
 type CreateOptsBuilder interface {
@@ -48,6 +64,9 @@ type CreateOpts struct {
 	ConsistencyGroupID string `json:"consistency_group_id,omitempty"`
 	// The availability zone of the share
 	AvailabilityZone string `json:"availability_zone,omitempty"`
+	// SchedulerHints are hints for the scheduler to select the share backend
+	// Only available in and beyond API version 2.65
+	SchedulerHints *SchedulerHints `json:"scheduler_hints,omitempty"`
 }
 
 // ToShareCreateMap assembles a request body based on the contents of a
diff --git a/openstack/sharedfilesystems/v2/shares/testing/fixtures_test.go b/openstack/sharedfilesystems/v2/shares/testing/fixtures_test.go
@@ -18,7 +18,11 @@ var createRequest = `{
 		"share": {
 			"name": "my_test_share",
 			"size": 1,
-			"share_proto": "NFS"
+			"share_proto": "NFS",
+                        "scheduler_hints": {
+                            "same_host": "e268f4aa-d571-43dd-9ab3-f49ad06ffaef",
+                            "different_host": "e268f4aa-d571-43dd-9ab3-f49ad06ffaef"
+                        }
 		}
 	}`
 
@@ -61,7 +65,9 @@ var createResponse = `{
 			"is_public": true,
 			"metadata": {
 				"project": "my_app",
-				"aim": "doc"
+				"aim": "doc",
+                                "__affinity_same_host": "e268f4aa-d571-43dd-9ab3-f49ad06ffaef",
+                                "__affinity_different_host": "e268f4aa-d571-43dd-9ab3-f49ad06ffaef"
 			},
 			"id": "011d21e2-fbc3-4e4a-9993-9ea223f73264",
 			"description": "My custom share London"
diff --git a/openstack/sharedfilesystems/v2/shares/testing/request_test.go b/openstack/sharedfilesystems/v2/shares/testing/request_test.go
@@ -16,13 +16,23 @@ func TestCreate(t *testing.T) {
 
 	MockCreateResponse(t)
 
-	options := &shares.CreateOpts{Size: 1, Name: "my_test_share", ShareProto: "NFS"}
+	options := &shares.CreateOpts{
+		Size:       1,
+		Name:       "my_test_share",
+		ShareProto: "NFS",
+		SchedulerHints: &shares.SchedulerHints{
+			SameHost:      "e268f4aa-d571-43dd-9ab3-f49ad06ffaef",
+			DifferentHost: "e268f4aa-d571-43dd-9ab3-f49ad06ffaef",
+		},
+	}
 	n, err := shares.Create(context.TODO(), client.ServiceClient(), options).Extract()
 
 	th.AssertNoErr(t, err)
 	th.AssertEquals(t, n.Name, "my_test_share")
 	th.AssertEquals(t, n.Size, 1)
 	th.AssertEquals(t, n.ShareProto, "NFS")
+	th.AssertEquals(t, n.Metadata["__affinity_same_host"], "e268f4aa-d571-43dd-9ab3-f49ad06ffaef")
+	th.AssertEquals(t, n.Metadata["__affinity_different_host"], "e268f4aa-d571-43dd-9ab3-f49ad06ffaef")
 }
 
 func TestUpdate(t *testing.T) {
