endpoint groups feature: add list, get & association

Author: gcnathan

acceptance/openstack/identity/v3/endpointgroups_test.go

@@ -0,0 +1,31 @@
+//go:build acceptance || identity || endpointgroups
+// +build acceptance identity endpointgroups
+
+package v3
+
+import (
+	"testing"
+
+	"github.com/gophercloud/gophercloud/acceptance/clients"
+	"github.com/gophercloud/gophercloud/openstack/identity/v3/extensions/endpointgroups"
+	th "github.com/gophercloud/gophercloud/testhelper"
+)
+
+func TestEndpointGroupsList(t *testing.T) {
+	clients.SkipRelease(t, "stable/mitaka")
+	clients.SkipRelease(t, "stable/newton")
+	clients.SkipRelease(t, "stable/ocata")
+	clients.SkipRelease(t, "stable/pike")
+	clients.SkipRelease(t, "stable/queens")
+	clients.RequireAdmin(t)
+
+	client, err := clients.NewIdentityV3Client()
+	th.AssertNoErr(t, err)
+
+	allPages, err := endpointgroups.List(client, nil).AllPages()
+	th.AssertNoErr(t, err)
+
+	allEndpointGroups, err := endpointgroups.ExtractEndpointGroups(allPages)
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, len(allEndpointGroups), 0)
+}

openstack/identity/v3/extensions/endpointgroups/doc.go

@@ -0,0 +1,32 @@
+/*
+Package endpointgroups enables management of OpenStack Identity Endpoint Groups
+and Endpoint associations.
+
+Example to Get an Endpoint Group
+
+	err := endpointgroups.Get(identityClient, endpointGroupID).ExtractErr()
+	if err != nil {
+		panic(err)
+	}
+
+Example to List all Endpoint Groups by name
+
+	listOpts := endpointgropus.ListOpts{
+		Name: "mygroup",
+	}
+
+	allPages, err := endpointgroups.List(identityClient, listOpts).AllPages()
+	if err != nil {
+		panic(err)
+	}
+
+	allGroups, err := endpointgroups.ExtractEndpointGroups(allPages)
+	if err != nil {
+		panic(err)
+	}
+
+	for _, endpointgroup := range allGroups {
+		fmt.Printf("%+v\n", endpointgroup)
+	}
+*/
+package endpointgroups

openstack/identity/v3/extensions/endpointgroups/requests.go

@@ -0,0 +1,78 @@
+package endpointgroups
+
+import (
+	"net/http"
+
+	"github.com/gophercloud/gophercloud"
+	"github.com/gophercloud/gophercloud/pagination"
+)
+
+// Get retrieves details on a single endpoint group, by ID.
+func Get(client *gophercloud.ServiceClient, id string) (r GetResult) {
+	_, r.Err = client.Get(resourceURL(client, id), &r.Body, nil)
+	return
+}
+
+// ListOptsBuilder allows extensions to add additional parameters to
+// the List request
+type ListOptsBuilder interface {
+	ToEndpointGroupListQuery() (string, error)
+}
+
+// ListOpts provides options to filter the List results.
+type ListOpts struct {
+	// Name filters the response by endpoint group name.
+	Name string `q:"name"`
+}
+
+// ToEndpointGroupListQuery formats a ListOpts into a query string.
+func (opts ListOpts) ToEndpointGroupListQuery() (string, error) {
+	q, err := gophercloud.BuildQueryString(opts)
+	return q.String(), err
+}
+
+// List enumerates the endpoint groups.
+func List(client *gophercloud.ServiceClient, opts ListOptsBuilder) pagination.Pager {
+	url := rootURL(client)
+	if opts != nil {
+		query, err := opts.ToEndpointGroupListQuery()
+		if err != nil {
+			return pagination.Pager{Err: err}
+		}
+		url += query
+	}
+
+	return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
+		return EndpointGroupPage{pagination.LinkedPageBase{PageResult: r}}
+	})
+}
+
+// ListForProjects enumerates the endpoint groups associated to a project.
+func ListForProjects(client *gophercloud.ServiceClient, projectId string) pagination.Pager {
+	return pagination.NewPager(client, listEndpointGroupsAssociationURL(client, projectId), func(r pagination.PageResult) pagination.Page {
+		return EndpointGroupPage{pagination.LinkedPageBase{PageResult: r}}
+	})
+}
+
+// CreateProjectAssociation creates an endpoint group to a project association.
+func CreateProjectAssociation(client *gophercloud.ServiceClient, id string, projectId string) (r CreateProjectAssociationResult) {
+	resp, err := client.Put(projectAssociationURL(client, id, projectId), nil, nil, &gophercloud.RequestOpts{
+		OkCodes: []int{http.StatusNoContent},
+	})
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
+
+// CheckProjectAssociation checks if an endpoint group is associated to a project.
+func CheckProjectAssociation(client *gophercloud.ServiceClient, id string, projectId string) (r CheckProjectAssociationResult) {
+	resp, err := client.Head(projectAssociationURL(client, id, projectId), nil)
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}
+
+// DeleteProjectAssociation deletes an endpoint group to a project association.
+func DeleteProjectAssociation(client *gophercloud.ServiceClient, id string, projectId string) (r DeleteProjectAssociationResult) {
+	resp, err := client.Delete(projectAssociationURL(client, id, projectId), nil)
+	_, r.Header, r.Err = gophercloud.ParseResponse(resp, err)
+	return
+}

openstack/identity/v3/extensions/endpointgroups/results.go

@@ -0,0 +1,75 @@
+package endpointgroups
+
+import (
+	"github.com/gophercloud/gophercloud"
+	"github.com/gophercloud/gophercloud/pagination"
+)
+
+type commonResult struct {
+	gophercloud.Result
+}
+
+// Extract interprets a GetResult, CreateResult or UpdateResult as a concrete
+// EndpointGroup. An error is returned if the original call or the extraction
+// failed.
+func (r commonResult) Extract() (*EndpointGroup, error) {
+	var s struct {
+		EndpointGroup *EndpointGroup `json:"endpoint_group"`
+	}
+	err := r.ExtractInto(&s)
+	return s.EndpointGroup, err
+}
+
+// GetResult is the response from a Get operation. Call its Extract method
+// to interpret it as an EndpointGroup.
+type GetResult struct {
+	commonResult
+}
+
+// EndpointGroup represents a group of endpoints matching one or several filter
+// criteria.
+type EndpointGroup struct {
+	// ID is the unique ID of the endpoint group.
+	ID string `json:"id"`
+
+	// Name is the name of the new endpoint group.
+	Name string `json:"name"`
+
+	// Filters is a map type describing the filter criteria
+	Filters map[string]interface{} `json:"filters"`
+
+	// Description is the description of the endpoint group
+	Description string `json:"description"`
+}
+
+// EndpointGroupPage is a single page of EndpointGroup results.
+type EndpointGroupPage struct {
+	pagination.LinkedPageBase
+}
+
+// IsEmpty returns true if no EndpointGroups were returned.
+func (r EndpointGroupPage) IsEmpty() (bool, error) {
+	es, err := ExtractEndpointGroups(r)
+	return len(es) == 0, err
+}
+
+// ExtractEndpointGroups extracts an EndpointGroup slice from a Page.
+func ExtractEndpointGroups(r pagination.Page) ([]EndpointGroup, error) {
+	var s struct {
+		EndpointGroups []EndpointGroup `json:"endpoint_groups"`
+	}
+	err := (r.(EndpointGroupPage)).ExtractInto(&s)
+	return s.EndpointGroups, err
+}
+
+type CreateProjectAssociationResult struct {
+	gophercloud.ErrResult
+}
+
+type CheckProjectAssociationResult struct {
+	gophercloud.ErrResult
+}
+
+type DeleteProjectAssociationResult struct {
+	gophercloud.ErrResult
+}