kctrl: fix repo update bug when url is same but secret changes

Signed-off-by: cguruprasad <[email protected]>
carvel-dev · Oct 17, 2024 · 11b3e5f · 11b3e5f
1 parent c6dbae6
commit 11b3e5f
Show file tree

Hide file tree

Showing 2 changed files with 47 additions and 1 deletion.
diff --git a/cli/pkg/kctrl/cmd/package/repository/add_or_update.go b/cli/pkg/kctrl/cmd/package/repository/add_or_update.go
@@ -196,7 +196,8 @@ func (o *AddOrUpdateOptions) Run(args []string) error {
 		return err
 	}
 
-	if o.URL != "" && o.URL == existingRepository.Spec.Fetch.ImgpkgBundle.Image {
+	if o.URL == existingRepository.Spec.Fetch.ImgpkgBundle.Image &&
+		(o.SecretRef == "" || (existingRepository.Spec.Fetch.ImgpkgBundle.SecretRef != nil && existingRepository.Spec.Fetch.ImgpkgBundle.SecretRef.Name == o.SecretRef)) {
 		return NewRepoTailer(o.NamespaceFlags.Name, o.Name, o.ui, client, RepoTailerOpts{PrintCurrentState: true}).TailRepoStatus()
 	}
 
@@ -260,6 +261,7 @@ func (o *AddOrUpdateOptions) updateExistingPackageRepository(pkgr *kcpkg.Package
 		ImgpkgBundle: &kappctrl.AppFetchImgpkgBundle{Image: o.URL},
 	}
 
+	// the case where a user would want to update the pkgr to remove the secretRef is not supported
 	if o.SecretRef != "" {
 		pkgr.Spec.Fetch.ImgpkgBundle.SecretRef = &kappctrl.AppFetchLocalRef{Name: o.SecretRef}
 	}

diff --git a/cli/test/e2e/package_repository_test.go b/cli/test/e2e/package_repository_test.go
@@ -4,12 +4,14 @@
 package e2e
 
 import (
+	"encoding/json"
 	"fmt"
 	"testing"
 	"time"
 
 	uitest "github.com/cppforlife/go-cli-ui/ui/test"
 	"github.com/stretchr/testify/require"
+	kcpkg "github.com/vmware-tanzu/carvel-kapp-controller/pkg/apis/packaging/v1alpha1"
 )
 
 func TestPackageRepository(t *testing.T) {
@@ -19,14 +21,17 @@ func TestPackageRepository(t *testing.T) {
 	kubectl := Kubectl{t, env.Namespace, logger}
 
 	pkgrName := "test-package-repository"
+	pkgrWithSecretName := "test-package-repository-with-secret"
 	pkgrURL := `ghcr.io/carvel-dev/kc-e2e-test-repo:latest`
+	pkgrSecretRef := "sample-registry-secret"
 
 	newRepoNamespace := "carvel-test-repo-a"
 
 	kind := "PackageRepository"
 
 	cleanUp := func() {
 		RemoveClusterResource(t, kind, pkgrName, env.Namespace, kubectl)
+		RemoveClusterResource(t, kind, pkgrWithSecretName, env.Namespace, kubectl)
 		RemoveClusterResource(t, kind, pkgrName, newRepoNamespace, kubectl)
 	}
 
@@ -205,6 +210,45 @@ func TestPackageRepository(t *testing.T) {
 		kubectl.Run([]string{"get", kind, pkgrName, "-n", env.Namespace})
 	})
 
+	logger.Section("create a repository with secretRef", func() {
+		_, _ = kappCtrl.RunWithOpts([]string{"package", "repository", "add", "-r", pkgrWithSecretName, "--url", pkgrURL, "--secret-ref", pkgrSecretRef}, RunOpts{
+			AllowError: true})
+
+		pkgrYaml := kubectl.Run([]string{"get", kind, pkgrWithSecretName, "-ojson"})
+		pkgr := &kcpkg.PackageRepository{}
+		err := json.Unmarshal([]byte(pkgrYaml), pkgr)
+		require.NoError(t, err)
+		require.Equal(t, pkgrSecretRef, pkgr.Spec.Fetch.ImgpkgBundle.SecretRef.Name)
+
+		kappCtrl.Run([]string{"package", "repository", "delete", "-r", pkgrWithSecretName})
+	})
+
+	logger.Section("updating a repository's secret with no change in url", func() {
+		_, err := kappCtrl.RunWithOpts([]string{"package", "repository", "add", "-r", pkgrWithSecretName, "--url", pkgrURL}, RunOpts{
+			AllowError: true})
+		require.NoError(t, err)
+
+		kubectl.Run([]string{"get", kind, pkgrWithSecretName})
+
+		kappCtrl.RunWithOpts([]string{"package", "repository", "update", "-r", pkgrWithSecretName, "--url", pkgrURL, "--secret-ref", pkgrSecretRef}, RunOpts{
+			AllowError: true})
+
+		pkgrYaml := kubectl.Run([]string{"get", kind, pkgrWithSecretName, "-ojson"})
+		pkgr := &kcpkg.PackageRepository{}
+		err = json.Unmarshal([]byte(pkgrYaml), pkgr)
+		require.NoError(t, err)
+		require.Equal(t, pkgrSecretRef, pkgr.Spec.Fetch.ImgpkgBundle.SecretRef.Name)
+
+		// update to a new secret
+		kappCtrl.RunWithOpts([]string{"package", "repository", "update", "-r", pkgrWithSecretName, "--url", pkgrURL, "--secret-ref", pkgrSecretRef + "-2"}, RunOpts{
+			AllowError: true})
+
+		pkgrYaml = kubectl.Run([]string{"get", kind, pkgrWithSecretName, "-ojson"})
+		pkgr = &kcpkg.PackageRepository{}
+		err = json.Unmarshal([]byte(pkgrYaml), pkgr)
+		require.NoError(t, err)
+		require.Equal(t, pkgrSecretRef+"-2", pkgr.Spec.Fetch.ImgpkgBundle.SecretRef.Name)
+	})
 }
 
 func TestPackageRepositoryTagSemver(t *testing.T) {