rename pkg/utils to pkg/sync

On-behalf-of: @SAP christoph.mewes@sap.com

Author: xrstf

.golangci.yml

@@ -68,10 +68,6 @@ linters:
         linters:
           - revive
         text: "var-naming" # the package name `utils` is fine here
-      - path: pkg/utils
-        linters:
-          - revive
-        text: "var-naming" # yeah, utils is a bandaid
   settings:
     goheader:
       values:

pkg/generic/generic.go

@@ -40,7 +40,7 @@ import (
 
 	brokerv1alpha1 "github.com/platform-mesh/resource-broker/api/broker/v1alpha1"
 	"github.com/platform-mesh/resource-broker/pkg/kubernetes"
-	brokerutils "github.com/platform-mesh/resource-broker/pkg/utils"
+	"github.com/platform-mesh/resource-broker/pkg/sync"
 )
 
 // Options are the options for the generic reconciler.
@@ -681,7 +681,7 @@ func (gr *genericReconciler) syncResource(ctx context.Context, providerName stri
 	// TODO send conditions back to consumer cluster
 	// TODO there should be two informers triggering this - one
 	// for consumer and one for provider
-	if cond, err := brokerutils.CopyResource(
+	if cond, err := sync.CopyResource(
 		ctx,
 		gr.gvk,
 		gr.req.NamespacedName,
@@ -719,7 +719,7 @@ func (gr *genericReconciler) syncRelatedResources(ctx context.Context, providerN
 	// TODO handle resource drift when a related resource is removed in
 	// the provider it needs to be removed in the consumer
 	// maybe just a finalizer on the resources in the provider?
-	relatedResources, err := brokerutils.CollectRelatedResources(ctx, providerCluster.GetClient(), gr.gvk, gr.req.NamespacedName)
+	relatedResources, err := sync.CollectRelatedResources(ctx, providerCluster.GetClient(), gr.gvk, gr.req.NamespacedName)
 	if err != nil {
 		return fmt.Errorf("failed to collect related resources from provider cluster %q: %w", providerName, err)
 	}
@@ -763,7 +763,7 @@ func (gr *genericReconciler) syncRelatedResource(ctx context.Context, providerCl
 	}
 
 	// TODO conditions
-	_, err := brokerutils.CopyResource(
+	_, err := sync.CopyResource(
 		ctx,
 		relatedResource.SchemaGVK(),
 		types.NamespacedName{

pkg/utils/doc.go pkg/kubernetes/doc.gopkg/utils/doc.go renamed to pkg/kubernetes/doc.go

@@ -15,6 +15,6 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package utils contains utility functions and types for the project.
-// TODO: This should be split, it's more of a bandaid right now.
-package utils
+// Package kubernetes offers utility functions for working with Kubernetes
+// objects.
+package kubernetes

pkg/migration/migration.go

@@ -42,7 +42,7 @@ import (
 	mcreconcile "sigs.k8s.io/multicluster-runtime/pkg/reconcile"
 
 	brokerv1alpha1 "github.com/platform-mesh/resource-broker/api/broker/v1alpha1"
-	brokerutils "github.com/platform-mesh/resource-broker/pkg/utils"
+	"github.com/platform-mesh/resource-broker/pkg/sync"
 )
 
 // MigrationOptions holds the options for the migration reconciler.
@@ -246,7 +246,7 @@ func (mr *migrationReconciler) copyRelatedResources(ctx context.Context, from br
 		return err
 	}
 
-	relatedResources, err := brokerutils.CollectRelatedResources(
+	relatedResources, err := sync.CollectRelatedResources(
 		ctx,
 		cl.GetClient(),
 		schema.GroupVersionKind{
@@ -298,7 +298,7 @@ func (mr *migrationReconciler) copyRelatedResource(ctx context.Context, source c
 		return err
 	}
 
-	targetObj := brokerutils.StripClusterMetadata(sourceObj)
+	targetObj := sync.StripClusterMetadata(sourceObj)
 	targetObj.SetName(prefix + relatedResource.Name)
 	if relatedResource.Namespace != "" {
 		targetObj.SetNamespace(relatedResource.Namespace) // TODO handle namespacing. all resources should probably be in the same namespace

pkg/utils/condition_types.go pkg/sync/condition_types.gopkg/utils/condition_types.go renamed to pkg/sync/condition_types.go

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package utils
+package sync
 
 // ConditionType is a discrete, strongly-typed alias for metav1.Condition.Type
 // values used within this package. Defining a concrete type and named
@@ -25,8 +25,8 @@ type ConditionType string
 func (c ConditionType) String() string { return string(c) }
 
 const (
-	// ConditionResourceCopied indicates the resource was copied/created/updated on the
-	// destination cluster.
+	// ConditionResourceCopied indicates the resource was copied/created/updated
+	// on the destination cluster.
 	ConditionResourceCopied ConditionType = "Copied"
 
 	// ConditionStatusSynced indicates the status was copied back to the

pkg/utils/condition_types_test.go pkg/sync/condition_types_test.gopkg/utils/condition_types_test.go renamed to pkg/sync/condition_types_test.go

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package utils
+package sync
 
 import (
 	"testing"

pkg/sync/doc.go

@@ -0,0 +1,20 @@
+/*
+Copyright The Platform Mesh Authors.
+SPDX-License-Identifier: Apache-2.0
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// Package sync contains code related to synchronizing objects and handling
+// related resources, used by multiple controllers in the resource-broker.
+package sync

pkg/utils/relatedResources.go pkg/sync/related_resources.gopkg/utils/relatedResources.go renamed to pkg/sync/related_resources.go

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package utils
+package sync
 
 import (
 	"context"
@@ -50,7 +50,7 @@ func CollectRelatedResources(ctx context.Context, providerClient client.Client,
 
 	relatedResources := make(map[string]brokerv1alpha1.RelatedResource, len(relatedResourcesI))
 	for key, rrI := range relatedResourcesI {
-		rrMap, ok := rrI.(map[string]interface{})
+		rrMap, ok := rrI.(map[string]any)
 		if !ok {
 			return nil, fmt.Errorf("failed to cast related resource %q from synced resource status", key)
 		}

pkg/utils/resourceCopy.go pkg/sync/resource_copy.gopkg/utils/resourceCopy.go renamed to pkg/sync/resource_copy.go

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package utils
+package sync
 
 import (
 	"context"

pkg/utils/resourceCopy_test.go pkg/sync/resource_copy_test.gopkg/utils/resourceCopy_test.go renamed to pkg/sync/resource_copy_test.go

@@ -15,7 +15,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package utils
+package sync
 
 import (
 	"testing"