[VPCEP] Add endpoints support (#261)

[VPCEP] Add `endpoints` support

What this PR does / why we need it
Implement methods for handling VPC EP endpoints
Which issue this PR fixes

Refers to #257
Special notes for your reviewer
=== RUN   TestEndpointLifecycle
--- PASS: TestEndpointLifecycle (14.06s)
PASS

Process finished with the exit code 0

Reviewed-by: None <None>
Reviewed-by: Rodion Gyrbu <[email protected]>
Reviewed-by: Anton Sidelnikov <None>

Author: outcatcher

acceptance/openstack/vpcep/endpoints_test.go

@@ -0,0 +1,84 @@
+package vpcep
+
+import (
+	"testing"
+
+	golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+	"github.com/opentelekomcloud/gophertelekomcloud/acceptance/clients"
+	"github.com/opentelekomcloud/gophertelekomcloud/acceptance/tools"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/common/tags"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/vpcep/v1/endpoints"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/vpcep/v1/services"
+	th "github.com/opentelekomcloud/gophertelekomcloud/testhelper"
+)
+
+func createService(t *testing.T, client *golangsdk.ServiceClient, elbPortID string) string {
+	iFalse := false
+	createOpts := &services.CreateOpts{
+		PortID:      elbPortID,
+		ServiceName: tools.RandomString("svc-", 5),
+		RouterID:    routerID,
+		ServerType:  services.ServerTypeLB,
+		ServiceType: services.ServiceTypeInterface,
+		Ports: []services.PortMapping{
+			{
+				ClientPort: 80,
+				ServerPort: 8080,
+			},
+		},
+		ApprovalEnabled: &iFalse,
+	}
+	svc, err := services.Create(client, createOpts).Extract()
+	th.AssertNoErr(t, err)
+
+	err = services.WaitForServiceStatus(client, svc.ID, services.StatusAvailable, 30)
+	th.AssertNoErr(t, err)
+	return svc.ID
+}
+
+func deleteService(t *testing.T, client *golangsdk.ServiceClient, id string) {
+	th.AssertNoErr(t, services.Delete(client, id).ExtractErr())
+}
+
+func TestEndpointLifecycle(t *testing.T) {
+	if routerID == "" || networkID == "" || subnetID == "" {
+		t.Skip("OS_ROUTER_ID/VPC_ID, OS_SUBNET_ID and OS_NETWORK_ID variables need to be set")
+	}
+
+	client, err := clients.NewVPCEndpointV1Client()
+	th.AssertNoErr(t, err)
+
+	elb := createELB(t)
+	defer deleteELB(t, elb.ID)
+
+	srvID := createService(t, client, elb.VipPortID)
+	defer deleteService(t, client, srvID)
+
+	opts := endpoints.CreateOpts{
+		NetworkID: networkID,
+		ServiceID: srvID,
+		RouterID:  routerID,
+		EnableDNS: true,
+		Tags:      []tags.ResourceTag{{Key: "fizz", Value: "buzz"}},
+	}
+	created, err := endpoints.Create(client, opts).Extract()
+	th.AssertNoErr(t, err)
+
+	defer func() {
+		th.AssertNoErr(t, endpoints.Delete(client, created.ID).ExtractErr())
+	}()
+
+	got, err := endpoints.Get(client, created.ID).Extract()
+	th.AssertNoErr(t, err)
+	th.AssertEquals(t, endpoints.StatusCreating, got.Status)
+
+	th.AssertNoErr(t, endpoints.WaitForEndpointStatus(client, created.ID, endpoints.StatusAccepted, 30))
+
+	pages, err := endpoints.List(client, nil).AllPages()
+	th.AssertNoErr(t, err)
+
+	eps, err := endpoints.ExtractEndpoints(pages)
+	th.AssertNoErr(t, err)
+
+	th.AssertEquals(t, created.ID, eps[0].ID)
+}

openstack/vpcep/v1/endpoints/requests.go

@@ -0,0 +1,127 @@
+package endpoints
+
+import (
+	"net/http"
+
+	golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/common/tags"
+	"github.com/opentelekomcloud/gophertelekomcloud/pagination"
+)
+
+type CreateOpts struct {
+	// The value must be the ID of the subnet created in the VPC specified by vpc_id and in the format of the UUID.
+	// This parameter is mandatory only if you create a VPC endpoint for connecting to an interface VPC endpoint service.
+	NetworkID string `json:"subnet_id,omitempty"`
+
+	// Specifies the ID of the VPC endpoint service.
+	ServiceID string `json:"endpoint_service_id" required:"true"`
+
+	// Specifies the ID of the VPC where the VPC endpoint is to be created.
+	RouterID string `json:"vpc_id" required:"true"`
+
+	// Specifies whether to create a private domain name.
+	EnableDNS bool `json:"enable_dns"`
+
+	// Lists the resource tags.
+	Tags []tags.ResourceTag `json:"tags,omitempty"`
+
+	// Lists the IDs of route tables.
+	// This parameter is mandatory only if you create a VPC endpoint for connecting to a `gateway` VPC endpoint service.
+	RouteTables []string `json:"routetables,omitempty"`
+
+	// Specifies the IP address for accessing the associated VPC endpoint service.
+	// This parameter is mandatory only if you create a VPC endpoint for connecting to an `interface` VPC endpoint service.
+	PortID string `json:"port_id,omitempty"`
+
+	// Specifies the whitelist for controlling access to the VPC endpoint.
+	//
+	// IPv4 addresses or CIDR blocks can be specified to control access when you create a VPC endpoint.
+	//
+	// This parameter is mandatory only when you create a VPC endpoint for connecting to an interface VPC endpoint service.
+	Whitelist []string `json:"whitelist,omitempty"`
+
+	// Specifies whether to enable access control.
+	EnableWhitelist *bool `json:"enable_whitelist,omitempty"`
+}
+
+type CreateOptsBuilder interface {
+	ToEndpointCreateMap() (map[string]interface{}, error)
+}
+
+func (opts CreateOpts) ToEndpointCreateMap() (map[string]interface{}, error) {
+	return golangsdk.BuildRequestBody(opts, "")
+}
+
+func Create(client *golangsdk.ServiceClient, opts CreateOptsBuilder) (r CreateResult) {
+	b, err := opts.ToEndpointCreateMap()
+	if err != nil {
+		r.Err = err
+		return
+	}
+	_, r.Err = client.Post(baseURL(client), b, &r.Body, &golangsdk.RequestOpts{
+		OkCodes: []int{http.StatusOK, http.StatusCreated},
+	})
+	return
+}
+
+func Get(client *golangsdk.ServiceClient, id string) (r GetResult) {
+	_, r.Err = client.Get(resourceURL(client, id), &r.Body, nil)
+	return
+}
+
+func Delete(client *golangsdk.ServiceClient, id string) (r DeleteResult) {
+	_, r.Err = client.Delete(resourceURL(client, id), &golangsdk.RequestOpts{
+		OkCodes: []int{http.StatusNoContent},
+	})
+	return
+}
+
+type ListOptsBuilder interface {
+	ToEndpointListQuery() (string, error)
+}
+
+type ListOpts struct {
+	ServiceName string `q:"endpoint_service_name"`
+	RouterID    string `q:"vpc_id"`
+	ID          string `q:"id"`
+	SortKey     string `q:"sort_key"`
+	SortDir     string `q:"sort_dir"`
+}
+
+func (opts ListOpts) ToEndpointListQuery() (string, error) {
+	q, err := golangsdk.BuildQueryString(opts)
+	if err != nil {
+		return "", err
+	}
+	return q.String(), nil
+}
+
+func List(client *golangsdk.ServiceClient, opts ListOptsBuilder) pagination.Pager {
+	url := baseURL(client)
+	if opts != nil {
+		q, err := opts.ToEndpointListQuery()
+		if err != nil {
+			return pagination.Pager{Err: err}
+		}
+		url += q
+	}
+	return pagination.NewPager(client, url, func(r pagination.PageResult) pagination.Page {
+		return EndpointPage{OffsetPageBase: pagination.OffsetPageBase{PageResult: r}}
+	})
+}
+
+func WaitForEndpointStatus(client *golangsdk.ServiceClient, id string, status Status, timeout int) error {
+	return golangsdk.WaitFor(timeout, func() (bool, error) {
+		ep, err := Get(client, id).Extract()
+		if err != nil {
+			if _, ok := err.(golangsdk.ErrDefault404); ok && status == "" {
+				return true, nil
+			}
+			return false, err
+		}
+		if ep.Status == status {
+			return true, nil
+		}
+		return false, nil
+	})
+}

openstack/vpcep/v1/endpoints/results.go

@@ -0,0 +1,113 @@
+package endpoints
+
+import (
+	golangsdk "github.com/opentelekomcloud/gophertelekomcloud"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/common/tags"
+	"github.com/opentelekomcloud/gophertelekomcloud/openstack/vpcep/v1/services"
+	"github.com/opentelekomcloud/gophertelekomcloud/pagination"
+)
+
+type Status string
+
+const (
+	StatusPendingAcceptance Status = "pendingAcceptance"
+	StatusCreating          Status = "creating"
+	StatusAccepted          Status = "accepted"
+	StatusFailed            Status = "failed"
+)
+
+type Endpoint struct {
+	// Specifies the unique ID of the VPC endpoint.
+	ID string `json:"id"`
+
+	// Specifies the type of the VPC endpoint service that is associated with the VPC endpoint.
+	ServiceType services.ServiceType `json:"service_type"`
+
+	// Specifies the packet ID of the VPC endpoint.
+	MarkerID int `json:"marker_id"`
+
+	// Specifies the connection status of the VPC endpoint.
+	//
+	//    pendingAcceptance: indicates that the VPC endpoint is pending acceptance.
+	//    creating: indicates the VPC endpoint is being created.
+	//    accepted: indicates the VPC endpoint has been accepted.
+	//    failed: indicates the creation of the VPC endpoint failed.
+	Status Status `json:"status"`
+
+	// Specifies the ID of the VPC where the VPC endpoint is to be created.
+	RouterID string `json:"vpc_id"`
+
+	// Specifies whether to create a private domain name.
+	EnableDNS bool `json:"enable_dns"`
+
+	// Specifies the name of the VPC endpoint service.
+	ServiceName string `json:"endpoint_service_name"`
+
+	// Specifies the ID of the VPC endpoint service.
+	ServiceID string `json:"endpoint_service_id"`
+
+	// Specifies the project ID.
+	ProjectID string `json:"project_id"`
+
+	// Specifies the whitelist for controlling access to the VPC endpoint.
+	Whitelist []string `json:"whitelist"`
+
+	// Specifies whether to enable access control.
+	EnableWhitelist bool `json:"enable_whitelist"`
+
+	// Specifies the creation time of the VPC endpoint.
+	CreatedAt string `json:"created_at"`
+
+	// Specifies the update time of the VPC endpoint.
+	UpdatedAt string `json:"updated_at"`
+
+	// Lists the resource tags.
+	Tags []tags.ResourceTag `json:"tags"`
+}
+
+type commonResult struct {
+	golangsdk.Result
+}
+
+func (r commonResult) Extract() (*Endpoint, error) {
+	ep := new(Endpoint)
+	err := r.ExtractIntoStructPtr(ep, "")
+	if err != nil {
+		return nil, err
+	}
+	return ep, nil
+}
+
+type CreateResult struct {
+	commonResult
+}
+
+type GetResult struct {
+	commonResult
+}
+
+type UpdateResult struct {
+	commonResult
+}
+
+type DeleteResult struct {
+	golangsdk.ErrResult
+}
+
+type EndpointPage struct {
+	pagination.OffsetPageBase
+}
+
+func (p EndpointPage) IsEmpty() (bool, error) {
+	eps, err := ExtractEndpoints(p)
+	if err != nil {
+		return false, err
+	}
+	return len(eps) == 0, nil
+}
+
+func ExtractEndpoints(p pagination.Page) ([]Endpoint, error) {
+	var eps []Endpoint
+	err := p.(EndpointPage).ExtractIntoSlicePtr(&eps, "endpoints")
+	return eps, err
+}