add the unit tests for related resources

Signed-off-by: Karol Szwaj <karol.szwaj@gmail.com>

On-behalf-of: @SAP karol.szwaj@sap.com

Author: cnvergence

deploy/crd/kcp.io/syncagent.kcp.io_publishedresources.yaml

@@ -407,9 +407,6 @@ spec:
                               type: object
                             type: array
                         type: object
-                      optional:
-                        description: Optional indicates whether the related resource must be referenced.
-                        type: boolean
                       origin:
                         description: '"service" or "kcp"'
                         type: string

internal/sync/syncer_related.go

@@ -35,15 +35,13 @@ import (
 
 func (s *ResourceSyncer) processRelatedResources(log *zap.SugaredLogger, stateStore ObjectStateStore, remote, local syncSide) (requeue bool, err error) {
 	for _, relatedResource := range s.pubRes.Spec.Related {
-		if !relatedResource.Optional {
-			requeue, err := s.processRelatedResource(log.With("identifier", relatedResource.Identifier), stateStore, remote, local, relatedResource)
-			if err != nil {
-				return false, fmt.Errorf("failed to process related resource %s: %w", relatedResource.Identifier, err)
-			}
+		requeue, err := s.processRelatedResource(log.With("identifier", relatedResource.Identifier), stateStore, remote, local, relatedResource)
+		if err != nil {
+			return false, fmt.Errorf("failed to process related resource %s: %w", relatedResource.Identifier, err)
+		}
 
-			if requeue {
-				return true, nil
-			}
+		if requeue {
+			return true, nil
 		}
 	}
 
@@ -139,6 +137,7 @@ func (s *ResourceSyncer) processRelatedResource(log *zap.SugaredLogger, stateSto
 			dest := source.DeepCopy()
 			dest.SetName(destKey.Name)
 			dest.SetNamespace(destKey.Namespace)
+
 			return dest
 		},
 		// ConfigMaps and Secrets have no subresources
@@ -242,6 +241,7 @@ func resolveResourceLocator(jsonData string, loc syncagentv1alpha1.ResourceLocat
 		if err != nil {
 			return "", fmt.Errorf("invalid pattern %q: %w", re.Pattern, err)
 		}
+
 		// this does apply some coalescing, like turning numbers into strings
 		strVal := gval.String()
 

internal/sync/syncer_related_test.go

@@ -37,6 +37,25 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/kontext"
 )
 
+func newPublishedResources(relatedResources []syncagentv1alpha1.RelatedResourceSpec) *syncagentv1alpha1.PublishedResource {
+	return &syncagentv1alpha1.PublishedResource{
+		Spec: syncagentv1alpha1.PublishedResourceSpec{
+			Resource: syncagentv1alpha1.SourceResourceDescriptor{
+				APIGroup: dummyv1alpha1.GroupName,
+				Version:  dummyv1alpha1.GroupVersion,
+				Kind:     "NamespacedThing",
+			},
+			Projection: &syncagentv1alpha1.ResourceProjection{
+				Kind: "RemoteThing",
+			},
+			Naming: &syncagentv1alpha1.ResourceNaming{
+				Name: "$remoteClusterName-$remoteName",
+			},
+			Related: relatedResources,
+		},
+	}
+}
+
 func TestSyncerProcessingRelatedResources(t *testing.T) {
 	const stateNamespace = "kcp-system"
 
@@ -57,34 +76,12 @@ func TestSyncerProcessingRelatedResources(t *testing.T) {
 
 	clusterName := logicalcluster.Name("testcluster")
 
-	remoteThingPR := &syncagentv1alpha1.PublishedResource{
-		Spec: syncagentv1alpha1.PublishedResourceSpec{
-			Resource: syncagentv1alpha1.SourceResourceDescriptor{
-				APIGroup: dummyv1alpha1.GroupName,
-				Version:  dummyv1alpha1.GroupVersion,
-				Kind:     "NamespacedThing",
-			},
-			Projection: &syncagentv1alpha1.ResourceProjection{
-				Kind: "RemoteThing",
-			},
-			// include explicit naming rules to be independent of possible changes to the defaults
-			Naming: &syncagentv1alpha1.ResourceNaming{
-				Name: "$remoteClusterName-$remoteName", // Things are Cluster-scoped
-			},
-			Related: []syncagentv1alpha1.RelatedResourceSpec{
-				{
-					Identifier: "mandatory-credentials",
-					Origin:     "kcp",
-					Kind:       "Secret",
-					Reference: syncagentv1alpha1.RelatedResourceReference{
-						Name: syncagentv1alpha1.ResourceLocator{
-							Path: "metadata.name",
-							Regex: &syncagentv1alpha1.RegexResourceLocator{
-								Replacement: "mandatory-credentials",
-							},
-						},
-					},
-				},
+	testcases := []testcase{
+		{
+			name:           "optional related resource does not exist",
+			remoteAPIGroup: "remote.example.corp",
+			localCRD:       loadCRD("things"),
+			pubRes: newPublishedResources([]syncagentv1alpha1.RelatedResourceSpec{
 				{
 					Identifier: "optional-secret",
 					Origin:     "service",
@@ -97,20 +94,9 @@ func TestSyncerProcessingRelatedResources(t *testing.T) {
 							},
 						},
 					},
-					Optional: true,
 				},
-			},
-		},
-	}
-
-	testcases := []testcase{
-		{
-			name:            "optional related resource does not exist",
-			remoteAPIGroup:  "remote.example.corp",
-			localCRD:        loadCRD("things"),
-			pubRes:          remoteThingPR,
+			}),
 			performRequeues: true,
-
 			remoteObject: newUnstructured(&dummyv1alpha1.NamespacedThing{
 				ObjectMeta: metav1.ObjectMeta{
 					Name:      "my-test-thing",
@@ -173,12 +159,25 @@ func TestSyncerProcessingRelatedResources(t *testing.T) {
 			expectedState: `{"apiVersion":"remote.example.corp/v1alpha1","kind":"RemoteThing","metadata":{"name":"my-test-thing","namespace":"kcp-system"},"spec":{"username":"Colonel Mustard"}}`,
 		},
 		{
-			name:            "mandatory related resource does not exist",
-			remoteAPIGroup:  "remote.example.corp",
-			localCRD:        loadCRD("things"),
-			pubRes:          remoteThingPR,
+			name:           "mandatory related resource does not exist",
+			remoteAPIGroup: "remote.example.corp",
+			localCRD:       loadCRD("things"),
+			pubRes: newPublishedResources([]syncagentv1alpha1.RelatedResourceSpec{
+				{
+					Identifier: "mandatory-credentials",
+					Origin:     "kcp",
+					Kind:       "Secret",
+					Reference: syncagentv1alpha1.RelatedResourceReference{
+						Name: syncagentv1alpha1.ResourceLocator{
+							Path: "metadata.name",
+							Regex: &syncagentv1alpha1.RegexResourceLocator{
+								Replacement: "mandatory-credentials",
+							},
+						},
+					},
+				},
+			}),
 			performRequeues: true,
-
 			remoteObject: newUnstructured(&dummyv1alpha1.NamespacedThing{
 				ObjectMeta: metav1.ObjectMeta{
 					Name:      "my-test-thing",

sdk/apis/syncagent/v1alpha1/published_resource.go

@@ -176,9 +176,6 @@ type RelatedResourceSpec struct {
 	// Mutation configures optional transformation rules for the related resource.
 	// Status mutations are only performed when the related resource originates in kcp.
 	Mutation *ResourceMutationSpec `json:"mutation,omitempty"`
-
-	// Optional indicates whether the related resource must be referenced.
-	Optional bool `json:"optional,omitempty"`
 }
 
 type RelatedResourceReference struct {

sdk/applyconfiguration/syncagent/v1alpha1/relatedresourcespec.go

@@ -91,20 +91,6 @@ func TestSyncSecretBackToKcp(t *testing.T) {
 						},
 					},
 				},
-				{
-					Identifier: "credentials",
-					Origin:     "service",
-					Kind:       "Secret",
-					Reference: syncagentv1alpha1.RelatedResourceReference{
-						Name: syncagentv1alpha1.ResourceLocator{
-							Path: "metadata.name", // irrelevant
-							Regex: &syncagentv1alpha1.RegexResourceLocator{
-								Replacement: "my-optional-credentials",
-							},
-						},
-					},
-					Optional: true,
-				},
 			},
 		},
 	}