Optmize handling topology logic

This patch removes the need of using GetLastAppliedTopologyRef to build
a topologyRef used by EnsureServiceTopology provided by infra-operator.
In particular, we can now blindly pass instance.Status.lastAppliedTopologyRef,
and checking that is not nil is deferred to the infra-operator logic [1].
This change also allows to deduplicate most of the common code present
in all operators.

[1] openstack-k8s-operators/infra-operator#367

Signed-off-by: Francesco Pantano <[email protected]>

Author: fmount

api/go.mod

@@ -7,7 +7,7 @@ require (
 	github.com/google/uuid v1.6.0
 	github.com/gophercloud/gophercloud v1.14.1
 	github.com/onsi/gomega v1.34.1
-	github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250411133346-82683c873656
+	github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250414173555-d17cbc245462
 	github.com/openstack-k8s-operators/lib-common/modules/common v0.6.1-0.20250408123225-0d9e9b82c41b
 	github.com/openstack-k8s-operators/lib-common/modules/openstack v0.6.1-0.20250408123225-0d9e9b82c41b
 	github.com/openstack-k8s-operators/lib-common/modules/storage v0.6.1-0.20250408123225-0d9e9b82c41b

api/go.sum

@@ -80,8 +80,8 @@ github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k=
 github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY=
 github.com/openshift/api v0.0.0-20240830023148-b7d0481c9094 h1:J1wuGhVxpsHykZBa6Beb1gQ96Ptej9AE/BvwCBiRj1E=
 github.com/openshift/api v0.0.0-20240830023148-b7d0481c9094/go.mod h1:CxgbWAlvu2iQB0UmKTtRu1YfepRg1/vJ64n2DlIEVz4=
-github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250411133346-82683c873656 h1:T/hODJCaWH13MV+7+snYAA1d/uuDYW0K20QDCfSSXj4=
-github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250411133346-82683c873656/go.mod h1:+l+sclC6YCRcLcvS3UEGKBf8xya8aExMrmHeA9tMg+k=
+github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250414173555-d17cbc245462 h1:hWdJM9hB/GSFjXc7E7b9L+2H4ZfCOxygceMiYXR4kKc=
+github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250414173555-d17cbc245462/go.mod h1:+l+sclC6YCRcLcvS3UEGKBf8xya8aExMrmHeA9tMg+k=
 github.com/openstack-k8s-operators/lib-common/modules/common v0.6.1-0.20250408123225-0d9e9b82c41b h1:T+N6xOT2NP+hVp2K1xl/NV3uheVHu38CcBuW+8uOBYw=
 github.com/openstack-k8s-operators/lib-common/modules/common v0.6.1-0.20250408123225-0d9e9b82c41b/go.mod h1:A9Ohw5Q90YOGhcDF4ZHkMr5RArz3phoBu9+ibbYDKG4=
 github.com/openstack-k8s-operators/lib-common/modules/openstack v0.6.1-0.20250408123225-0d9e9b82c41b h1:WvlbQ1nXX3MuVKVXdd2o5EK0RDMy5x/VtV845ReUlM4=

api/v1beta1/keystoneapi_types.go

@@ -360,19 +360,6 @@ func (c *KeystoneExtraMounts) Propagate(svc []storage.PropagationType) []storage
 	return vl
 }
 
-// GetLastTopologyRef - Returns a TopoRef object that can be passed to the
-// Handle topology logic
-func (instance KeystoneAPI) GetLastAppliedTopologyRef() *topologyv1.TopoRef {
-	lastAppliedTopologyName := ""
-	if instance.Status.LastAppliedTopology != nil {
-		lastAppliedTopologyName = instance.Status.LastAppliedTopology.Name
-	}
-	return &topologyv1.TopoRef{
-		Name:      lastAppliedTopologyName,
-		Namespace: instance.Namespace,
-	}
-}
-
 // ValidateTopology -
 func (instance *KeystoneAPISpecCore) ValidateTopology(
 	basePath *field.Path,

controllers/keystoneapi_controller.go

@@ -1064,7 +1064,7 @@ func (r *KeystoneAPIReconciler) reconcileNormal(
 		ctx,
 		helper,
 		instance.Spec.TopologyRef,
-		instance.GetLastAppliedTopologyRef(),
+		instance.Status.LastAppliedTopology,
 		instance.Name,
 		labels.GetLabelSelector(serviceLabels),
 	)

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/k8snetworkplumbingwg/network-attachment-definition-client v1.7.6
 	github.com/onsi/ginkgo/v2 v2.20.1
 	github.com/onsi/gomega v1.34.1
-	github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250411133346-82683c873656
+	github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250414173555-d17cbc245462
 	github.com/openstack-k8s-operators/keystone-operator/api v0.3.1-0.20240213125925-e40975f3db7e
 	github.com/openstack-k8s-operators/lib-common/modules/common v0.6.1-0.20250408123225-0d9e9b82c41b
 	github.com/openstack-k8s-operators/lib-common/modules/openstack v0.6.1-0.20250408123225-0d9e9b82c41b

go.sum

@@ -78,8 +78,8 @@ github.com/onsi/gomega v1.34.1 h1:EUMJIKUjM8sKjYbtxQI9A4z2o+rruxnzNvpknOXie6k=
 github.com/onsi/gomega v1.34.1/go.mod h1:kU1QgUvBDLXBJq618Xvm2LUX6rSAfRaFRTcdOeDLwwY=
 github.com/openshift/api v0.0.0-20240830023148-b7d0481c9094 h1:J1wuGhVxpsHykZBa6Beb1gQ96Ptej9AE/BvwCBiRj1E=
 github.com/openshift/api v0.0.0-20240830023148-b7d0481c9094/go.mod h1:CxgbWAlvu2iQB0UmKTtRu1YfepRg1/vJ64n2DlIEVz4=
-github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250411133346-82683c873656 h1:T/hODJCaWH13MV+7+snYAA1d/uuDYW0K20QDCfSSXj4=
-github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250411133346-82683c873656/go.mod h1:+l+sclC6YCRcLcvS3UEGKBf8xya8aExMrmHeA9tMg+k=
+github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250414173555-d17cbc245462 h1:hWdJM9hB/GSFjXc7E7b9L+2H4ZfCOxygceMiYXR4kKc=
+github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250414173555-d17cbc245462/go.mod h1:+l+sclC6YCRcLcvS3UEGKBf8xya8aExMrmHeA9tMg+k=
 github.com/openstack-k8s-operators/lib-common/modules/common v0.6.1-0.20250408123225-0d9e9b82c41b h1:T+N6xOT2NP+hVp2K1xl/NV3uheVHu38CcBuW+8uOBYw=
 github.com/openstack-k8s-operators/lib-common/modules/common v0.6.1-0.20250408123225-0d9e9b82c41b/go.mod h1:A9Ohw5Q90YOGhcDF4ZHkMr5RArz3phoBu9+ibbYDKG4=
 github.com/openstack-k8s-operators/lib-common/modules/openstack v0.6.1-0.20250408123225-0d9e9b82c41b h1:WvlbQ1nXX3MuVKVXdd2o5EK0RDMy5x/VtV845ReUlM4=

tests/functional/base_test.go

@@ -26,7 +26,6 @@ import (
 	"k8s.io/apimachinery/pkg/types"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	topologyv1 "github.com/openstack-k8s-operators/infra-operator/apis/topology/v1beta1"
 	keystonev1 "github.com/openstack-k8s-operators/keystone-operator/api/v1beta1"
 	keystone_base "github.com/openstack-k8s-operators/keystone-operator/pkg/keystone"
 	condition "github.com/openstack-k8s-operators/lib-common/modules/common/condition"
@@ -164,38 +163,6 @@ func GetSampleTopologySpec(label string) (map[string]interface{}, []corev1.Topol
 	return topologySpec, topologySpecObj
 }
 
-// CreateTopology - Creates a Topology CR based on the spec passed as input
-func CreateTopology(
-	topology types.NamespacedName,
-	spec map[string]interface{},
-) (client.Object, topologyv1.TopoRef) {
-	raw := map[string]interface{}{
-		"apiVersion": "topology.openstack.org/v1beta1",
-		"kind":       "Topology",
-		"metadata": map[string]interface{}{
-			"name":      topology.Name,
-			"namespace": topology.Namespace,
-		},
-		"spec": spec,
-	}
-	// other than creating the topology based on the raw spec, we return the
-	// TopoRef that can be referenced
-	topologyRef := topologyv1.TopoRef{
-		Name:      topology.Name,
-		Namespace: topology.Namespace,
-	}
-	return th.CreateUnstructured(raw), topologyRef
-}
-
-// GetTopology - Returns the referenced Topology
-func GetTopology(name types.NamespacedName) *topologyv1.Topology {
-	instance := &topologyv1.Topology{}
-	Eventually(func(g Gomega) {
-		g.Expect(k8sClient.Get(ctx, name, instance)).Should(Succeed())
-	}, timeout, interval).Should(Succeed())
-	return instance
-}
-
 // GetExtraMounts - Utility function that simulates extraMounts pointing
 // to a  secret
 func GetExtraMounts(kemName string, kemPath string) []map[string]interface{} {

tests/functional/keystoneapi_controller_test.go

@@ -1573,7 +1573,7 @@ var _ = Describe("Keystone controller", func() {
 			for _, t := range keystoneAPITopologies {
 				// Build the topology Spec
 				topologySpec, _ := GetSampleTopologySpec(t.Name)
-				CreateTopology(t, topologySpec)
+				infra.CreateTopology(t, topologySpec)
 			}
 			spec := GetDefaultKeystoneAPISpec()
 			spec["topologyRef"] = map[string]interface{}{
@@ -1613,7 +1613,7 @@ var _ = Describe("Keystone controller", func() {
 
 		It("check topology has been applied", func() {
 			Eventually(func(g Gomega) {
-				tp := GetTopology(types.NamespacedName{
+				tp := infra.GetTopology(types.NamespacedName{
 					Name:      topologyRef.Name,
 					Namespace: topologyRef.Namespace,
 				})
@@ -1642,7 +1642,7 @@ var _ = Describe("Keystone controller", func() {
 			}, timeout, interval).Should(Succeed())
 
 			Eventually(func(g Gomega) {
-				tp := GetTopology(types.NamespacedName{
+				tp := infra.GetTopology(types.NamespacedName{
 					Name:      topologyRefAlt.Name,
 					Namespace: topologyRefAlt.Namespace,
 				})
@@ -1656,7 +1656,7 @@ var _ = Describe("Keystone controller", func() {
 					fmt.Sprintf("openstack.org/keystoneapi-%s", keystoneAPIName.Name)))
 
 				// Verify the previous referenced topology has no finalizers
-				tp = GetTopology(types.NamespacedName{
+				tp = infra.GetTopology(types.NamespacedName{
 					Name:      topologyRef.Name,
 					Namespace: topologyRef.Namespace,
 				})
@@ -1685,7 +1685,7 @@ var _ = Describe("Keystone controller", func() {
 			// Verify the existing topologies have no finalizer anymore
 			Eventually(func(g Gomega) {
 				for _, topology := range keystoneAPITopologies {
-					tp := GetTopology(types.NamespacedName{
+					tp := infra.GetTopology(types.NamespacedName{
 						Name:      topology.Name,
 						Namespace: topology.Namespace,
 					})