Merge pull request #22 from KevFan/issues/10

refactor: GetURL() -> GetLocator()
Kuadrant · Sep 2, 2024 · e5173b2 · e5173b2
2 parents 5445f17 + b9625fd
commit e5173b2
Show file tree

Hide file tree

Showing 19 changed files with 138 additions and 137 deletions.
diff --git a/README.md b/README.md
@@ -45,8 +45,8 @@ type MyPolicySpec struct {
   TargetRef gwapiv1alpha2.LocalPolicyTargetReference
 }
 
-func (p *MyPolicy) GetURL() string {
-	return machinery.UrlFromObject(p)
+func (p *MyPolicy) GetLocator() string {
+	return machinery.LocatorFromObject(p)
 }
 
 func (p *MyPolicy) GetTargetRefs() []machinery.PolicyTargetReference {

diff --git a/controller/object.go b/controller/object.go
@@ -32,8 +32,8 @@ func (o *RuntimeObject) GetName() string {
 	return o.Object.GetName()
 }
 
-func (o *RuntimeObject) GetURL() string {
-	return machinery.UrlFromObject(o)
+func (o *RuntimeObject) GetLocator() string {
+	return machinery.LocatorFromObject(o)
 }
 
 // ObjectAs casts an Object generically into any kind

diff --git a/examples/color_policy/color_policy.go b/examples/color_policy/color_policy.go
@@ -16,8 +16,8 @@ type ColorPolicy struct {
 
 var _ machinery.Policy = &ColorPolicy{}
 
-func (p *ColorPolicy) GetURL() string {
-	return machinery.UrlFromObject(p)
+func (p *ColorPolicy) GetLocator() string {
+	return machinery.LocatorFromObject(p)
 }
 
 func (p *ColorPolicy) GetTargetRefs() []machinery.PolicyTargetReference {

diff --git a/examples/json_patch/color_policy.go b/examples/json_patch/color_policy.go
@@ -7,6 +7,7 @@ import (
 	gwapi "sigs.k8s.io/gateway-api/apis/v1alpha2"
 
 	jsonpatch "github.com/evanphx/json-patch"
+
 	"github.com/kuadrant/policy-machinery/machinery"
 )
 
@@ -19,8 +20,8 @@ type ColorPolicy struct {
 
 var _ machinery.Policy = &ColorPolicy{}
 
-func (p *ColorPolicy) GetURL() string {
-	return machinery.UrlFromObject(p)
+func (p *ColorPolicy) GetLocator() string {
+	return machinery.LocatorFromObject(p)
 }
 
 func (p *ColorPolicy) GetTargetRefs() []machinery.PolicyTargetReference {

diff --git a/examples/kuadrant/apis/v1alpha2/dnspolicy_types.go b/examples/kuadrant/apis/v1alpha2/dnspolicy_types.go
@@ -44,8 +44,8 @@ func (p *DNSPolicy) GetName() string {
 	return p.Name
 }
 
-func (p *DNSPolicy) GetURL() string {
-	return machinery.UrlFromObject(p)
+func (p *DNSPolicy) GetLocator() string {
+	return machinery.LocatorFromObject(p)
 }
 
 func (p *DNSPolicy) GetTargetRefs() []machinery.PolicyTargetReference {

diff --git a/examples/kuadrant/apis/v1alpha2/tlspolicy_types.go b/examples/kuadrant/apis/v1alpha2/tlspolicy_types.go
@@ -46,8 +46,8 @@ func (p *TLSPolicy) GetName() string {
 	return p.Name
 }
 
-func (p *TLSPolicy) GetURL() string {
-	return machinery.UrlFromObject(p)
+func (p *TLSPolicy) GetLocator() string {
+	return machinery.LocatorFromObject(p)
 }
 
 func (p *TLSPolicy) GetTargetRefs() []machinery.PolicyTargetReference {

diff --git a/examples/kuadrant/apis/v1beta3/authpolicy_types.go b/examples/kuadrant/apis/v1beta3/authpolicy_types.go
@@ -49,8 +49,8 @@ func (p *AuthPolicy) GetName() string {
 	return p.Name
 }
 
-func (p *AuthPolicy) GetURL() string {
-	return machinery.UrlFromObject(p)
+func (p *AuthPolicy) GetLocator() string {
+	return machinery.LocatorFromObject(p)
 }
 
 func (p *AuthPolicy) GetTargetRefs() []machinery.PolicyTargetReference {

diff --git a/examples/kuadrant/apis/v1beta3/ratelimitpolicy_types.go b/examples/kuadrant/apis/v1beta3/ratelimitpolicy_types.go
@@ -56,8 +56,8 @@ func (p *RateLimitPolicy) GetName() string {
 	return p.Name
 }
 
-func (p *RateLimitPolicy) GetURL() string {
-	return machinery.UrlFromObject(p)
+func (p *RateLimitPolicy) GetLocator() string {
+	return machinery.LocatorFromObject(p)
 }
 
 func (p *RateLimitPolicy) GetTargetRefs() []machinery.PolicyTargetReference {

diff --git a/examples/kuadrant/reconcilers/effective_policies_reconciler.go b/examples/kuadrant/reconcilers/effective_policies_reconciler.go
@@ -103,10 +103,10 @@ func effectivePolicyForPath[T machinery.Policy](ctx context.Context, path []mach
 		return lo.Map(policies, func(p kuadrantapis.MergeablePolicy, _ int) machinery.Policy { return p })
 	})
 
-	pathURLs := lo.Map(path, machinery.MapTargetableToURLFunc)
+	pathLocators := lo.Map(path, machinery.MapTargetableToLocatorFunc)
 
 	if len(policies) == 0 {
-		logger.Info("no policies for path", "kind", reflect.TypeOf(new(T)), "path", pathURLs)
+		logger.Info("no policies for path", "kind", reflect.TypeOf(new(T)), "path", pathLocators)
 		return nil
 	}
 
@@ -116,7 +116,7 @@ func effectivePolicyForPath[T machinery.Policy](ctx context.Context, path []mach
 	}, policies[len(policies)-1])
 
 	jsonEffectivePolicy, _ := json.Marshal(effectivePolicy)
-	logger.Info("effective policy", "kind", reflect.TypeOf(new(T)), "path", pathURLs, "effectivePolicy", string(jsonEffectivePolicy))
+	logger.Info("effective policy", "kind", reflect.TypeOf(new(T)), "path", pathLocators, "effectivePolicy", string(jsonEffectivePolicy))
 
 	concreteEffectivePolicy, _ := effectivePolicy.(T)
 	return &concreteEffectivePolicy

diff --git a/examples/kuadrant/reconcilers/envoy_gateway.go b/examples/kuadrant/reconcilers/envoy_gateway.go
@@ -41,10 +41,10 @@ func (p *EnvoyGatewayProvider) ReconcileSecurityPolicies(ctx context.Context, _
 	for _, gateway := range gateways {
 		paths := lo.Filter(authPaths, func(path []machinery.Targetable, _ int) bool {
 			if len(path) != 4 { // should never happen
-				logger.Error(fmt.Errorf("unexpected topology path length to build Envoy SecurityPolicy"), "path", lo.Map(path, machinery.MapTargetableToURLFunc))
+				logger.Error(fmt.Errorf("unexpected topology path length to build Envoy SecurityPolicy"), "path", lo.Map(path, machinery.MapTargetableToLocatorFunc))
 				return false
 			}
-			return path[0].GetURL() == gateway.GetURL() && lo.ContainsBy(targetables.Parents(path[0]), func(parent machinery.Targetable) bool {
+			return path[0].GetLocator() == gateway.GetLocator() && lo.ContainsBy(targetables.Parents(path[0]), func(parent machinery.Targetable) bool {
 				gc, ok := parent.(*machinery.GatewayClass)
 				return ok && gc.Spec.ControllerName == "gateway.envoyproxy.io/gatewayclass-controller"
 			})

diff --git a/examples/kuadrant/reconcilers/istio.go b/examples/kuadrant/reconcilers/istio.go
@@ -44,10 +44,10 @@ func (p *IstioGatewayProvider) ReconcileAuthorizationPolicies(ctx context.Contex
 	for _, gateway := range gateways {
 		paths := lo.Filter(authPaths, func(path []machinery.Targetable, _ int) bool {
 			if len(path) != 4 { // should never happen
-				logger.Error(fmt.Errorf("unexpected topology path length to build Istio AuthorizationPolicy"), "path", lo.Map(path, machinery.MapTargetableToURLFunc))
+				logger.Error(fmt.Errorf("unexpected topology path length to build Istio AuthorizationPolicy"), "path", lo.Map(path, machinery.MapTargetableToLocatorFunc))
 				return false
 			}
-			return path[0].GetURL() == gateway.GetURL() && lo.ContainsBy(targetables.Parents(path[0]), func(parent machinery.Targetable) bool {
+			return path[0].GetLocator() == gateway.GetLocator() && lo.ContainsBy(targetables.Parents(path[0]), func(parent machinery.Targetable) bool {
 				gc, ok := parent.(*machinery.GatewayClass)
 				return ok && gc.Spec.ControllerName == "istio.io/gateway-controller"
 			})

diff --git a/machinery/core_types.go b/machinery/core_types.go
@@ -22,8 +22,8 @@ type Namespace struct {
 
 var _ Targetable = &Namespace{}
 
-func (n *Namespace) GetURL() string {
-	return UrlFromObject(n)
+func (n *Namespace) GetLocator() string {
+	return LocatorFromObject(n)
 }
 
 func (n *Namespace) SetPolicies(policies []Policy) {
@@ -42,8 +42,8 @@ type Service struct {
 
 var _ Targetable = &Service{}
 
-func (s *Service) GetURL() string {
-	return UrlFromObject(s)
+func (s *Service) GetLocator() string {
+	return LocatorFromObject(s)
 }
 
 func (s *Service) SetPolicies(policies []Policy) {
@@ -71,8 +71,8 @@ func (p *ServicePort) GroupVersionKind() schema.GroupVersionKind {
 
 func (p *ServicePort) SetGroupVersionKind(schema.GroupVersionKind) {}
 
-func (p *ServicePort) GetURL() string {
-	return namespacedSectionName(UrlFromObject(p.Service), gwapiv1.SectionName(p.Name))
+func (p *ServicePort) GetLocator() string {
+	return namespacedSectionName(LocatorFromObject(p.Service), gwapiv1.SectionName(p.Name))
 }
 
 func (p *ServicePort) GetNamespace() string {

diff --git a/machinery/gateway_api_test_helper.go b/machinery/gateway_api_test_helper.go
@@ -539,8 +539,8 @@ type TestPolicySpec struct {
 
 var _ Policy = &TestPolicy{}
 
-func (p *TestPolicy) GetURL() string {
-	return UrlFromObject(p)
+func (p *TestPolicy) GetLocator() string {
+	return LocatorFromObject(p)
 }
 
 func (p *TestPolicy) GetTargetRefs() []PolicyTargetReference {

diff --git a/machinery/gateway_api_topology.go b/machinery/gateway_api_topology.go
@@ -638,15 +638,15 @@ func findListenerFromParentRefFunc(gateways []*Gateway, listeners []*Listener, r
 		}
 		if parentRef.SectionName != nil {
 			listener, ok := lo.Find(listeners, func(l *Listener) bool {
-				return l.Gateway.GetURL() == gateway.GetURL() && l.Name == *parentRef.SectionName
+				return l.Gateway.GetLocator() == gateway.GetLocator() && l.Name == *parentRef.SectionName
 			})
 			if !ok {
 				return nil
 			}
 			return []Object{listener}
 		}
 		return lo.FilterMap(listeners, func(l *Listener, _ int) (Object, bool) {
-			return l, l.Gateway.GetURL() == gateway.GetURL()
+			return l, l.Gateway.GetLocator() == gateway.GetLocator()
 		})
 	}
 }