Merge pull request gophercloud#2648 from kayrus/share-transfer

[manila]: implement share transfer API

Author: mandre

acceptance/clients/conditions.go

@@ -147,7 +147,7 @@ func IsReleasesAbove(t *testing.T, release string) bool {
 func IsReleasesBelow(t *testing.T, release string) bool {
 	current_branch := getReleaseFromEnv(t)
 
-	if current_branch != "master" && current_branch < release {
+	if current_branch != "master" || current_branch < release {
 		return true
 	}
 	t.Logf("Target release %s is above the current branch %s", release, current_branch)

acceptance/openstack/sharedfilesystems/v2/sharetransfers.go

@@ -0,0 +1,46 @@
+package v2
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/gophercloud/gophercloud"
+	"github.com/gophercloud/gophercloud/openstack/sharedfilesystems/v2/shares"
+	"github.com/gophercloud/gophercloud/openstack/sharedfilesystems/v2/sharetransfers"
+)
+
+func CreateTransferRequest(t *testing.T, client *gophercloud.ServiceClient, share *shares.Share, name string) (*sharetransfers.Transfer, error) {
+	opts := sharetransfers.CreateOpts{
+		ShareID: share.ID,
+		Name:    name,
+	}
+	transfer, err := sharetransfers.Create(client, opts).Extract()
+	if err != nil {
+		return nil, fmt.Errorf("failed to create a share transfer request: %s", err)
+	}
+
+	return transfer, nil
+}
+
+func AcceptTransfer(t *testing.T, client *gophercloud.ServiceClient, transferRequest *sharetransfers.Transfer) error {
+	opts := sharetransfers.AcceptOpts{
+		AuthKey:          transferRequest.AuthKey,
+		ClearAccessRules: true,
+	}
+	err := sharetransfers.Accept(client, transferRequest.ID, opts).ExtractErr()
+	if err != nil {
+		return fmt.Errorf("failed to accept a share transfer request: %s", err)
+	}
+
+	return nil
+}
+
+func DeleteTransferRequest(t *testing.T, client *gophercloud.ServiceClient, transfer *sharetransfers.Transfer) {
+	err := sharetransfers.Delete(client, transfer.ID).ExtractErr()
+	if err != nil {
+		if _, ok := err.(gophercloud.ErrDefault404); ok {
+			return
+		}
+		t.Errorf("Unable to delete share transfer %s: %v", transfer.ID, err)
+	}
+}

acceptance/openstack/sharedfilesystems/v2/sharetransfers_test.go

@@ -0,0 +1,67 @@
+//go:build acceptance || share || transfers
+// +build acceptance share transfers
+
+package v2
+
+import (
+	"testing"
+
+	"github.com/gophercloud/gophercloud/acceptance/clients"
+	"github.com/gophercloud/gophercloud/acceptance/tools"
+	th "github.com/gophercloud/gophercloud/testhelper"
+
+	"github.com/gophercloud/gophercloud/openstack/sharedfilesystems/v2/sharetransfers"
+)
+
+// minimal microversion for the share transfers
+const shareTransfersMicroversion = "2.77"
+
+func TestTransferRequestCRUD(t *testing.T) {
+	clients.SkipReleasesBelow(t, "master")
+
+	client, err := clients.NewSharedFileSystemV2Client()
+	if err != nil {
+		t.Fatalf("Unable to create a shared file system client: %v", err)
+	}
+	client.Microversion = shareTransfersMicroversion
+
+	share, err := CreateShare(t, client)
+	if err != nil {
+		t.Fatalf("Unable to create a share: %v", err)
+	}
+
+	defer DeleteShare(t, client, share)
+
+	// Create transfers request to a new tenant
+	trName := "123"
+	transferRequest, err := CreateTransferRequest(t, client, share, trName)
+	th.AssertNoErr(t, err)
+	defer DeleteTransferRequest(t, client, transferRequest)
+
+	// list transfer requests
+	allTransferRequestsPages, err := sharetransfers.ListDetail(client, nil).AllPages()
+	th.AssertNoErr(t, err)
+
+	allTransferRequests, err := sharetransfers.ExtractTransfers(allTransferRequestsPages)
+	th.AssertNoErr(t, err)
+
+	// finding the transfer request
+	var foundRequest bool
+	for _, tr := range allTransferRequests {
+		tools.PrintResource(t, &tr)
+		if tr.ResourceID == share.ID && tr.Name == trName && !tr.Accepted {
+			foundRequest = true
+		}
+	}
+	th.AssertEquals(t, foundRequest, true)
+
+	// checking get
+	tr, err := sharetransfers.Get(client, transferRequest.ID).Extract()
+	th.AssertNoErr(t, err)
+
+	th.AssertEquals(t, transferRequest.ID == tr.ID, true)
+
+	// Accept Share Transfer Request
+	err = AcceptTransfer(t, client, transferRequest)
+	th.AssertNoErr(t, err)
+}

openstack/sharedfilesystems/v2/replicas/requests.go

@@ -51,7 +51,7 @@ func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) (r Create
 }
 
 // ListOpts holds options for listing Share Replicas. This object is passed to the
-// replicas.List function.
+// replicas.List or replicas.ListDetail functions.
 type ListOpts struct {
 	// The UUID of the share.
 	ShareID string `q:"share_id"`

openstack/sharedfilesystems/v2/replicas/results.go

@@ -63,7 +63,7 @@ type commonResult struct {
 	gophercloud.Result
 }
 
-// Extract will get the Replica object from the commonResul.t
+// Extract will get the Replica object from the commonResult.
 func (r commonResult) Extract() (*Replica, error) {
 	var s struct {
 		Replica *Replica `json:"share_replica"`
@@ -149,16 +149,18 @@ func (r ReplicaPage) IsEmpty() (bool, error) {
 	return len(replicas) == 0, err
 }
 
-// ExtractReplicas extracts and returns a Replica slice. It is used while
-// iterating over a replicas.List call.
+// ExtractReplicas extracts and returns Replicas. It is used while iterating
+// over a replicas.List or replicas.ListDetail calls.
 func ExtractReplicas(r pagination.Page) ([]Replica, error) {
-	var s struct {
-		Replicas []Replica `json:"share_replicas"`
-	}
-
-	err := (r.(ReplicaPage)).ExtractInto(&s)
+	var s []Replica
+	err := ExtractReplicasInto(r, &s)
+	return s, err
+}
 
-	return s.Replicas, err
+// ExtractReplicasInto similar to ExtractReplicas but operates on a `list` of
+// replicas.
+func ExtractReplicasInto(r pagination.Page, v interface{}) error {
+	return r.(ReplicaPage).Result.ExtractIntoSlicePtr(v, "share_replicas")
 }
 
 // DeleteResult contains the response body and error from a Delete request.

openstack/sharedfilesystems/v2/sharetransfers/requests.go

@@ -0,0 +1,169 @@
+package sharetransfers
+
+import (
+	"github.com/gophercloud/gophercloud"
+	"github.com/gophercloud/gophercloud/pagination"
+)
+
+// CreateOptsBuilder allows extensions to add additional parameters to the
+// Create request.
+type CreateOptsBuilder interface {
+	ToTransferCreateMap() (map[string]interface{}, error)
+}
+
+// CreateOpts contains options for a Share transfer.
+type CreateOpts struct {
+	// The ID of the share to transfer.
+	ShareID string `json:"share_id" required:"true"`
+
+	// The name of the share transfer.
+	Name string `json:"name,omitempty"`
+}
+
+// ToCreateMap assembles a request body based on the contents of a
+// TransferOpts.
+func (opts CreateOpts) ToTransferCreateMap() (map[string]interface{}, error) {
+	return gophercloud.BuildRequestBody(opts, "transfer")
+}
+
+// Create will create a share tranfer request based on the values in CreateOpts.
+func Create(client *gophercloud.ServiceClient, opts CreateOptsBuilder) (r CreateResult) {
+	b, err := opts.ToTransferCreateMap()
+	if err != nil {
+		r.Err = err
+		return
+	}
+	resp, err := client.Post(transferURL(client), b, &r.Body, &gophercloud.RequestOpts{
+		OkCodes: []int{202},
+	})
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
+
+// AcceptOpts contains options for a Share transfer accept reqeust.
+type AcceptOpts struct {
+	// The auth key of the share transfer to accept.
+	AuthKey string `json:"auth_key" required:"true"`
+
+	// Whether to clear access rules when accept the share.
+	ClearAccessRules bool `json:"clear_access_rules,omitempty"`
+}
+
+// ToAcceptMap assembles a request body based on the contents of a
+// AcceptOpts.
+func (opts AcceptOpts) ToAcceptMap() (map[string]interface{}, error) {
+	return gophercloud.BuildRequestBody(opts, "accept")
+}
+
+// Accept will accept a share tranfer request based on the values in AcceptOpts.
+func Accept(client *gophercloud.ServiceClient, id string, opts AcceptOpts) (r AcceptResult) {
+	b, err := opts.ToAcceptMap()
+	if err != nil {
+		r.Err = err
+		return
+	}
+	resp, err := client.Post(acceptURL(client, id), b, nil, &gophercloud.RequestOpts{
+		OkCodes: []int{202},
+	})
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
+
+// Delete deletes a share transfer.
+func Delete(client *gophercloud.ServiceClient, id string) (r DeleteResult) {
+	resp, err := client.Delete(deleteURL(client, id), &gophercloud.RequestOpts{
+		// DELETE requests response with a 200 code, adding it here
+		OkCodes: []int{200, 202, 204},
+	})
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
+
+// ListOptsBuilder allows extensions to add additional parameters to the List
+// request.
+type ListOptsBuilder interface {
+	ToTransferListQuery() (string, error)
+}
+
+// ListOpts holds options for listing Transfers. It is passed to the sharetransfers.List
+// or sharetransfers.ListDetail functions.
+type ListOpts struct {
+	// AllTenants will retrieve transfers of all tenants/projects. Admin
+	// only.
+	AllTenants bool `q:"all_tenants"`
+
+	// The user defined name of the share transfer to filter resources by.
+	Name string `q:"name"`
+
+	// The name pattern that can be used to filter share transfers.
+	NamePattern string `q:"name~"`
+
+	// The key to sort a list of transfers. A valid value is id, name,
+	// resource_type, resource_id, source_project_id, destination_project_id,
+	// created_at, expires_at.
+	SortKey string `q:"sort_key"`
+
+	// The direction to sort a list of resources. A valid value is asc, or
+	// desc.
+	SortDir string `q:"sort_dir"`
+
+	// Requests a page size of items.
+	Limit int `q:"limit"`
+
+	// Used in conjunction with limit to return a slice of items.
+	Offset int `q:"offset"`
+
+	// The ID of the last-seen item.
+	Marker string `q:"marker"`
+}
+
+// ToTransferListQuery formats a ListOpts into a query string.
+func (opts ListOpts) ToTransferListQuery() (string, error) {
+	q, err := gophercloud.BuildQueryString(opts)
+	return q.String(), err
+}
+
+// List returns Transfers optionally limited by the conditions provided in ListOpts.
+func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
+	url := listURL(client)
+	if opts != nil {
+		query, err := opts.ToTransferListQuery()
+		if err != nil {
+			return pagination.Pager{Err: err}
+		}
+		url += query
+	}
+
+	return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
+		p := TransferPage{pagination.MarkerPageBase{PageResult: r}}
+		p.MarkerPageBase.Owner = p
+		return p
+	})
+}
+
+// List returns Transfers with details optionally limited by the conditions
+// provided in ListOpts.
+func ListDetail(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
+	url := listDetailURL(client)
+	if opts != nil {
+		query, err := opts.ToTransferListQuery()
+		if err != nil {
+			return pagination.Pager{Err: err}
+		}
+		url += query
+	}
+
+	return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
+		p := TransferPage{pagination.MarkerPageBase{PageResult: r}}
+		p.MarkerPageBase.Owner = p
+		return p
+	})
+}
+
+// Get retrieves the Transfer with the provided ID. To extract the Transfer object
+// from the response, call the Extract method on the GetResult.
+func Get(client *gophercloud.ServiceClient, id string) (r GetResult) {
+	resp, err := client.Get(getURL(client, id), &r.Body, nil)
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}