fix: Do not add lsp annotation when set from file (#584)

Signed-off-by: Wendy Arango <[email protected]>

Author: warango4

pkg/commands/testdata/workload-with-lsp-annotation.yaml

@@ -0,0 +1,34 @@
+# Copyright 2023 VMware, Inc.
+#
+# 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.
+
+apiVersion: carto.run/v1alpha1
+kind: Workload
+metadata:
+  name: my-workload
+  namespace: default
+  annotations:
+    local-source-proxy.apps.tanzu.vmware.com: registry.io/project/source:default-service@sha256:123
+spec:
+  resources:
+    requests:
+      memory: 1Gi
+      cpu: 100m
+    limits:
+      memory: 1Gi
+      cpu: 500m
+  source:
+    git:
+      url: https://github.com/spring-projects/spring-petclinic.git
+      ref:
+        branch: main

pkg/commands/testdata/workload-with-no-source.yaml

@@ -0,0 +1,28 @@
+# Copyright 2023 VMware, Inc.
+#
+# 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.
+
+apiVersion: carto.run/v1alpha1
+kind: Workload
+metadata:
+  name: tanzu-web-app
+  labels:
+    apps.tanzu.vmware.com/workload-type: web
+spec:
+  resources:
+    requests:
+      memory: 1Gi
+      cpu: 100m
+    limits:
+      memory: 1Gi
+      cpu: 500m

pkg/commands/workload.go

@@ -664,21 +664,25 @@ func (opts *WorkloadOptions) loadExcludedPaths(c *cli.Config, displayInfo bool)
 	return exclude
 }
 
-func (opts *WorkloadOptions) ManageLocalSourceProxyAnnotation(currentWorkload, workload *cartov1alpha1.Workload) {
+func (opts *WorkloadOptions) ManageLocalSourceProxyAnnotation(fileWorkload, currentWorkload, workload *cartov1alpha1.Workload) {
 	workloadExists := currentWorkload != nil
+	annotationExistsInFile := fileWorkload != nil && fileWorkload.IsAnnotationExists(apis.LocalSourceProxyAnnotationName)
+	mergeAnnotationFromFile := workloadExists && currentWorkload.IsAnnotationExists(apis.LocalSourceProxyAnnotationName)
 
 	// merge annotation only when workload is being created or when source code was changed and there is a new digested,
 	// do not add it when updating workload
 	// since user could be updating another field and annotation must not be added
-	if opts.isLocalSource(currentWorkload) {
+	if opts.isLocalSource(currentWorkload) || (annotationExistsInFile && mergeAnnotationFromFile && workload.Spec.Source != nil) {
 		workload.MergeAnnotations(apis.LocalSourceProxyAnnotationName, workload.Spec.Source.Image)
 	}
 
 	// if workload is updated from LSP registry to custom or any other registry through source image,
 	// or it is moved from LSP to any other source (git, maven, image)
+	// or an annotation comes in a workload file definition and it is not an lsp workload
 	// annotation has to be deleted and workload source image needs to be updated to digested based on opts source image
 	if (opts.SourceImage != "" && workloadExists) ||
-		(workloadExists && ((workload.Spec.Source != nil && workload.Spec.Source.Image == "") || workload.Spec.Source == nil)) {
+		(workloadExists && ((workload.Spec.Source != nil && workload.Spec.Source.Image == "") || workload.Spec.Source == nil)) ||
+		(annotationExistsInFile && !mergeAnnotationFromFile) {
 		workload.RemoveAnnotations(apis.LocalSourceProxyAnnotationName)
 	}
 }

pkg/commands/workload_apply.go

@@ -163,7 +163,7 @@ func (opts *WorkloadApplyOptions) Exec(ctx context.Context, c *cli.Config) error
 	if err := opts.PublishLocalSource(ctx, c, currentWorkload, workload, shouldPrint); err != nil {
 		return err
 	}
-	opts.ManageLocalSourceProxyAnnotation(currentWorkload, workload)
+	opts.ManageLocalSourceProxyAnnotation(fileWorkload, currentWorkload, workload)
 
 	// if output flag was not set or it was not used with yes flag, then proceed to show
 	// surveys and all other output