fix: resourceRef should be a required property (#411)

## Description

Closes open-component-model/ocm-project#66


## What type of PR is this? (check all applicable)

- [ ] 🍕 Feature
- [ ] 🐛 Bug Fix
- [ ] 📝 Documentation Update
- [ ] 🎨 Style
- [ ] 🧑‍💻 Code Refactor
- [ ] 🔥 Performance Improvements
- [ ] ✅ Test
- [ ] 🤖 Build
- [ ] 🔁 CI
- [ ] 📦 Chore (Release)
- [ ] ⏩ Revert

## Related Tickets & Documents

<!-- 
Please use this format link issue numbers: Fixes #123

https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
-->
- Related Issue # (issue)
- Closes # (issue)
- Fixes # (issue)
> Remove if not applicable

## Screenshots

<!-- Visual changes require screenshots -->


## Added tests?

- [ ] 👍 yes
- [ ] 🙅 no, because they aren't needed
- [ ] 🙋 no, because I need help
- [ ] Separate ticket for tests # (issue/pr)

Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration


## Added to documentation?

- [ ] 📜 README.md
- [ ] 🙅 no documentation needed

## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream
modules

api/v1alpha1/reference_types.go

@@ -20,6 +20,7 @@ import (
 type ObjectReference struct {
 	meta.NamespacedObjectKindReference `json:",inline"`
 
+	// ResourceRef defines what resource to fetch.
 	// +optional
 	ResourceRef *ResourceReference `json:"resourceRef,omitempty"`
 }

api/v1alpha1/resource_types.go

@@ -103,6 +103,10 @@ func (in Resource) GetRequeueAfter() time.Duration {
 
 // GetReferencePath returns the component reference path for the Resource.
 func (in Resource) GetReferencePath() []ocmmetav1.Identity {
+	if in.Spec.SourceRef.ResourceRef == nil {
+		return nil
+	}
+
 	return in.Spec.SourceRef.ResourceRef.ReferencePath
 }
 

config/crd/bases/delivery.ocm.software_configurations.yaml

@@ -75,6 +75,7 @@ spec:
                       acts as LocalObjectReference.
                     type: string
                   resourceRef:
+                    description: ResourceRef defines what resource to fetch.
                     properties:
                       extraIdentity:
                         additionalProperties:
@@ -217,6 +218,7 @@ spec:
                       acts as LocalObjectReference.
                     type: string
                   resourceRef:
+                    description: ResourceRef defines what resource to fetch.
                     properties:
                       extraIdentity:
                         additionalProperties:

config/crd/bases/delivery.ocm.software_fluxdeployers.yaml

@@ -77,6 +77,7 @@ spec:
                       acts as LocalObjectReference.
                     type: string
                   resourceRef:
+                    description: ResourceRef defines what resource to fetch.
                     properties:
                       extraIdentity:
                         additionalProperties:

config/crd/bases/delivery.ocm.software_localizations.yaml

@@ -75,6 +75,7 @@ spec:
                       acts as LocalObjectReference.
                     type: string
                   resourceRef:
+                    description: ResourceRef defines what resource to fetch.
                     properties:
                       extraIdentity:
                         additionalProperties:
@@ -217,6 +218,7 @@ spec:
                       acts as LocalObjectReference.
                     type: string
                   resourceRef:
+                    description: ResourceRef defines what resource to fetch.
                     properties:
                       extraIdentity:
                         additionalProperties:

config/crd/bases/delivery.ocm.software_resourcepipelines.yaml

@@ -109,6 +109,7 @@ spec:
                       acts as LocalObjectReference.
                     type: string
                   resourceRef:
+                    description: ResourceRef defines what resource to fetch.
                     properties:
                       extraIdentity:
                         additionalProperties:

config/crd/bases/delivery.ocm.software_resources.yaml

@@ -75,6 +75,7 @@ spec:
                       acts as LocalObjectReference.
                     type: string
                   resourceRef:
+                    description: ResourceRef defines what resource to fetch.
                     properties:
                       extraIdentity:
                         additionalProperties:

controllers/mutation_reconcile_looper.go

@@ -190,14 +190,17 @@ func (m *MutationReconcileLooper) localize(
 	mutationSpec *v1alpha1.MutationSpec,
 	data, configObj []byte,
 ) (string, error) {
-	log := log.FromContext(ctx)
+	logger := log.FromContext(ctx)
 
 	cv, err := m.getComponentVersion(ctx, mutationSpec.ConfigRef)
 	if err != nil {
 		return "", fmt.Errorf("failed to get component version: %w", err)
 	}
 
-	refPath := mutationSpec.ConfigRef.ResourceRef.ReferencePath
+	var refPath []ocmmetav1.Identity
+	if mutationSpec.ConfigRef.ResourceRef != nil {
+		refPath = mutationSpec.ConfigRef.ResourceRef.ReferencePath
+	}
 
 	virtualFS, err := osfs.NewTempFileSystem()
 	if err != nil {
@@ -225,7 +228,7 @@ func (m *MutationReconcileLooper) localize(
 	}
 
 	if len(rules) == 0 {
-		log.Info("no rules generated from the available config data; the generate snapshot will have no modifications")
+		logger.Info("no rules generated from the available config data; the generate snapshot will have no modifications")
 	}
 
 	if err := localize.Substitute(rules, virtualFS); err != nil {
@@ -297,6 +300,10 @@ func (m *MutationReconcileLooper) fetchDataFromComponentVersion(ctx context.Cont
 		return nil, fmt.Errorf("failed to create authenticated client: %w", err)
 	}
 
+	if obj.ResourceRef == nil {
+		return nil, fmt.Errorf("no resource ref found for %s", key)
+	}
+
 	resource, _, _, err := m.OCMClient.GetResource(ctx, octx, componentVersion, obj.ResourceRef)
 	if err != nil {
 		return nil, fmt.Errorf("failed to fetch resource from component version: %w", err)
@@ -743,8 +750,10 @@ func (m *MutationReconcileLooper) getIdentity(ctx context.Context, obj *v1alpha1
 		id = ocmmetav1.Identity{
 			v1alpha1.ComponentNameKey:    cv.Status.ComponentDescriptor.ComponentDescriptorRef.Name,
 			v1alpha1.ComponentVersionKey: cv.Status.ComponentDescriptor.Version,
-			v1alpha1.ResourceNameKey:     obj.ResourceRef.Name,
-			v1alpha1.ResourceVersionKey:  obj.ResourceRef.Version,
+		}
+		if obj.ResourceRef != nil {
+			id[v1alpha1.ResourceNameKey] = obj.ResourceRef.Name
+			id[v1alpha1.ResourceVersionKey] = obj.ResourceRef.Version
 		}
 	default:
 		// if kind is not ComponentVersion, then fetch resource using dynamic client

controllers/resource_controller.go

@@ -104,6 +104,10 @@ func (r *ResourceReconciler) Reconcile(
 		return result, nil
 	}
 
+	if obj.Spec.SourceRef.ResourceRef == nil {
+		return ctrl.Result{}, fmt.Errorf("resource requires resource ref")
+	}
+
 	patchHelper := patch.NewSerialPatcher(obj, r.Client)
 
 	// Always attempt to patch the object and status after each reconciliation.

controllers/resourcepipeline_controller.go

@@ -86,15 +86,14 @@ func (r *ResourcePipelineReconciler) Reconcile(
 		return ctrl.Result{RequeueAfter: obj.GetRequeueAfter()}, nil
 	}
 
+	if obj.Spec.SourceRef.ResourceRef == nil {
+		return ctrl.Result{}, fmt.Errorf("resource reference is needed to fetch the pipeline objects")
+	}
+
 	patchHelper := patch.NewSerialPatcher(obj, r.Client)
 
 	// Always attempt to patch the object and status after each reconciliation.
 	defer func() {
-		// Patching has not been set up, or the controller errored earlier.
-		if patchHelper == nil {
-			return
-		}
-
 		if condition := conditions.Get(obj, meta.StalledCondition); condition != nil &&
 			condition.Status == metav1.ConditionTrue {
 			conditions.Delete(obj, meta.ReconcilingCondition)
@@ -510,13 +509,15 @@ func (r *ResourcePipelineReconciler) getIdentity(
 	id = ocmmetav1.Identity{
 		v1alpha1.ComponentNameKey:    cv.Status.ComponentDescriptor.ComponentDescriptorRef.Name,
 		v1alpha1.ComponentVersionKey: cv.Status.ComponentDescriptor.Version,
-		v1alpha1.ResourceNameKey:     obj.ResourceRef.Name,
-		v1alpha1.ResourceVersionKey:  obj.ResourceRef.Version,
 	}
 
-	// apply the extra identity fields if provided
-	for k, v := range obj.ResourceRef.ExtraIdentity {
-		id[k] = v
+	if obj.ResourceRef != nil {
+		id[v1alpha1.ResourceNameKey] = obj.ResourceRef.Name
+		id[v1alpha1.ResourceVersionKey] = obj.ResourceRef.Version
+		// apply the extra identity fields if provided
+		for k, v := range obj.ResourceRef.ExtraIdentity {
+			id[k] = v
+		}
 	}
 
 	return id, err