Merge pull request #3294 from gophercloud/bp-v2-a0214a5-05687fb

mandre · web-flow · commit ec8349253f8a · 2025-02-07T14:22:45.000+01:00
[v2] Add support for zone sharing in DNS v2
diff --git a/openstack/dns/v2/zones/requests.go b/openstack/dns/v2/zones/requests.go
@@ -178,3 +178,45 @@ func Delete(ctx context.Context, client *gophercloud.ServiceClient, zoneID strin
 	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
 	return
 }
+
+// request body for sharing a zone.
+type ShareOptsBuilder interface {
+	ToShareMap() (map[string]interface{}, error)
+}
+
+// ShareZoneOpts specifies the target project for sharing a zone.
+type ShareZoneOpts struct {
+	// TargetProjectID is the ID of the project to share the zone with.
+	TargetProjectID string `json:"target_project_id" required:"true"`
+}
+
+// ToShareMap constructs a request body from a ShareZoneOpts.
+func (opts ShareZoneOpts) ToShareMap() (map[string]interface{}, error) {
+	return map[string]interface{}{
+		"target_project_id": opts.TargetProjectID,
+	}, nil
+}
+
+// Share shares a zone with another project.
+func Share(ctx context.Context, client *gophercloud.ServiceClient, zoneID string, opts ShareOptsBuilder) (r gophercloud.ErrResult) {
+	body, err := gophercloud.BuildRequestBody(opts, "")
+	if err != nil {
+		r.Err = err
+		return
+	}
+
+	resp, err := client.Post(ctx, zoneShareURL(client, zoneID), body, nil, &gophercloud.RequestOpts{
+		OkCodes: []int{201},
+	})
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
+
+// Unshare removes a share for a zone.
+func Unshare(ctx context.Context, client *gophercloud.ServiceClient, zoneID, shareID string) (r gophercloud.ErrResult) {
+	resp, err := client.Delete(ctx, zoneUnshareURL(client, zoneID, shareID), &gophercloud.RequestOpts{
+		OkCodes: []int{204},
+	})
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
diff --git a/openstack/dns/v2/zones/results.go b/openstack/dns/v2/zones/results.go
@@ -50,6 +50,11 @@ type ZonePage struct {
 	pagination.LinkedPageBase
 }
 
+// ErrResult represents a generic error result.
+type ErrResult struct {
+	gophercloud.ErrResult
+}
+
 // IsEmpty returns true if the page contains no results.
 func (r ZonePage) IsEmpty() (bool, error) {
 	if r.StatusCode == 204 {
diff --git a/openstack/dns/v2/zones/testing/requests_test.go b/openstack/dns/v2/zones/testing/requests_test.go
@@ -2,6 +2,9 @@ package testing
 
 import (
 	"context"
+	"encoding/json"
+	"io"
+	"net/http"
 	"testing"
 
 	"github.com/gophercloud/gophercloud/v2/openstack/dns/v2/zones"
@@ -105,3 +108,41 @@ func TestDelete(t *testing.T) {
 	th.AssertNoErr(t, err)
 	th.CheckDeepEquals(t, &DeletedZone, actual)
 }
+
+func TestShare(t *testing.T) {
+	th.SetupHTTP()
+	defer th.TeardownHTTP()
+
+	th.Mux.HandleFunc("/zones/zone-id/shares", func(w http.ResponseWriter, r *http.Request) {
+		th.AssertEquals(t, r.Method, "POST")
+
+		body, err := io.ReadAll(r.Body)
+		defer r.Body.Close()
+		th.AssertNoErr(t, err)
+
+		var reqBody map[string]string
+		err = json.Unmarshal(body, &reqBody)
+		th.AssertNoErr(t, err)
+		expectedBody := map[string]string{"target_project_id": "project-id"}
+		th.CheckDeepEquals(t, expectedBody, reqBody)
+
+		w.WriteHeader(http.StatusCreated)
+	})
+
+	opts := zones.ShareZoneOpts{TargetProjectID: "project-id"}
+	err := zones.Share(context.TODO(), client.ServiceClient(), "zone-id", opts).ExtractErr()
+	th.AssertNoErr(t, err)
+}
+
+func TestUnshare(t *testing.T) {
+	th.SetupHTTP()
+	defer th.TeardownHTTP()
+
+	th.Mux.HandleFunc("/zones/zone-id/shares/share-id", func(w http.ResponseWriter, r *http.Request) {
+		th.AssertEquals(t, r.Method, "DELETE")
+		w.WriteHeader(http.StatusNoContent)
+	})
+
+	err := zones.Unshare(context.TODO(), client.ServiceClient(), "zone-id", "share-id").ExtractErr()
+	th.AssertNoErr(t, err)
+}
diff --git a/openstack/dns/v2/zones/urls.go b/openstack/dns/v2/zones/urls.go
@@ -2,10 +2,22 @@ package zones
 
 import "github.com/gophercloud/gophercloud/v2"
 
+// baseURL returns the base URL for zones.
 func baseURL(c *gophercloud.ServiceClient) string {
 	return c.ServiceURL("zones")
 }
 
+// zoneURL returns the URL for a specific zone.
 func zoneURL(c *gophercloud.ServiceClient, zoneID string) string {
 	return c.ServiceURL("zones", zoneID)
 }
+
+// zoneShareURL returns the URL for sharing a zone.
+func zoneShareURL(c *gophercloud.ServiceClient, zoneID string) string {
+	return c.ServiceURL("zones", zoneID, "shares")
+}
+
+// zoneUnshareURL returns the URL for unsharing a zone.
+func zoneUnshareURL(c *gophercloud.ServiceClient, zoneID, shareID string) string {
+	return c.ServiceURL("zones", zoneID, "shares", shareID)
+}
