Add V2Endpoint, V3Endpoint helpers

stephenfin · stephenfin · commit 471e1ca82fa5 · 2025-08-06T17:16:53.000+01:00
For now these are exact duplicates of the V2EndpointURL and V3EndpointURL helpers but with different names. diff -u openstack/endpoint_location.go openstack/endpoint.go This is done to ease review. We will introduce further differences shortly. Signed-off-by: Stephen Finucane <stephenfin@redhat.com> (cherry picked from commit ed23d9b)
diff --git a/openstack/endpoint.go b/openstack/endpoint.go
@@ -0,0 +1,101 @@
+package openstack
+
+import (
+	"slices"
+
+	"github.com/gophercloud/gophercloud/v2"
+	tokens2 "github.com/gophercloud/gophercloud/v2/openstack/identity/v2/tokens"
+	tokens3 "github.com/gophercloud/gophercloud/v2/openstack/identity/v3/tokens"
+)
+
+/*
+V2Endpoint discovers the endpoint URL for a specific service from a
+ServiceCatalog acquired during the v2 identity service.
+
+The specified EndpointOpts are used to identify a unique, unambiguous endpoint
+to return. It's an error both when multiple endpoints match the provided
+criteria and when none do. The minimum that can be specified is a Type, but you
+will also often need to specify a Name and/or a Region depending on what's
+available on your OpenStack deployment.
+*/
+func V2Endpoint(catalog *tokens2.ServiceCatalog, opts gophercloud.EndpointOpts) (string, error) {
+	// Extract Endpoints from the catalog entries that match the requested Type, Name if provided, and Region if provided.
+	//
+	// If multiple endpoints are found, we return the first result and disregard the rest.
+	// This behavior matches the Python library. See GH-1764.
+	for _, entry := range catalog.Entries {
+		if (slices.Contains(opts.Types(), entry.Type)) && (opts.Name == "" || entry.Name == opts.Name) {
+			for _, endpoint := range entry.Endpoints {
+				if opts.Region != "" && endpoint.Region != opts.Region {
+					continue
+				}
+
+				var endpointURL string
+				switch opts.Availability {
+				case gophercloud.AvailabilityPublic:
+					endpointURL = gophercloud.NormalizeURL(endpoint.PublicURL)
+				case gophercloud.AvailabilityInternal:
+					endpointURL = gophercloud.NormalizeURL(endpoint.InternalURL)
+				case gophercloud.AvailabilityAdmin:
+					endpointURL = gophercloud.NormalizeURL(endpoint.AdminURL)
+				default:
+					err := &ErrInvalidAvailabilityProvided{}
+					err.Argument = "Availability"
+					err.Value = opts.Availability
+					return "", err
+				}
+
+				return endpointURL, nil
+			}
+		}
+	}
+
+	// Report an error if there were no matching endpoints.
+	err := &gophercloud.ErrEndpointNotFound{}
+	return "", err
+}
+
+/*
+V3Endpoint discovers the endpoint URL for a specific service from a Catalog
+acquired during the v3 identity service.
+
+The specified EndpointOpts are used to identify a unique, unambiguous endpoint
+to return. It's an error both when multiple endpoints match the provided
+criteria and when none do. The minimum that can be specified is a Type, but you
+will also often need to specify a Name and/or a Region depending on what's
+available on your OpenStack deployment.
+*/
+func V3Endpoint(catalog *tokens3.ServiceCatalog, opts gophercloud.EndpointOpts) (string, error) {
+	if opts.Availability != gophercloud.AvailabilityAdmin &&
+		opts.Availability != gophercloud.AvailabilityPublic &&
+		opts.Availability != gophercloud.AvailabilityInternal {
+		err := &ErrInvalidAvailabilityProvided{}
+		err.Argument = "Availability"
+		err.Value = opts.Availability
+		return "", err
+	}
+
+	// Extract Endpoints from the catalog entries that match the requested Type, Interface,
+	// Name if provided, and Region if provided.
+	//
+	// If multiple endpoints are found, we return the first result and disregard the rest.
+	// This behavior matches the Python library. See GH-1764.
+	for _, entry := range catalog.Entries {
+		if (slices.Contains(opts.Types(), entry.Type)) && (opts.Name == "" || entry.Name == opts.Name) {
+			for _, endpoint := range entry.Endpoints {
+				if opts.Availability != gophercloud.Availability(endpoint.Interface) {
+					continue
+				}
+				if opts.Region != "" && endpoint.Region != opts.Region && endpoint.RegionID != opts.Region {
+					continue
+				}
+
+				return gophercloud.NormalizeURL(endpoint.URL), nil
+			}
+		}
+	}
+
+	// Report an error if there were no matching endpoints.
+	err := &gophercloud.ErrEndpointNotFound{}
+	return "", err
+}
