gitprovider_immutability_test.go

// SPDX-License-Identifier: Apache-2.0

package controller

import (
	"context"
	"time"

	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/types"

	configbutleraiv1alpha3 "github.com/ConfigButler/gitops-reverser/api/v1alpha3"
)

// A GitProvider's repository URL is the destination identity its GitTargets materialize
// into, so it is immutable (delete + recreate to repoint). Everything else is
// operational and must stay mutable — especially allowedBranches: widening or narrowing
// the writable set is a routine change that must not force tearing down every GitTarget.
var _ = Describe("GitProvider URL Immutability", func() {
	const (
		timeout  = time.Second * 10
		interval = time.Millisecond * 250
	)

	It("rejects a change to the URL but allows changing allowedGitBranches", func() {
		ctx := context.Background()
		key := types.NamespacedName{Name: "immutable-provider", Namespace: "default"}

		provider := &configbutleraiv1alpha3.GitProvider{
			ObjectMeta: metav1.ObjectMeta{Name: key.Name, Namespace: key.Namespace},
			Spec: configbutleraiv1alpha3.GitProviderSpec{
				URL:                "https://example.com/repo.git",
				AllowedGitBranches: branchesFromSame("main"),
			},
		}
		Expect(k8sClient.Create(ctx, provider)).Should(Succeed())
		DeferCleanup(func() { _ = k8sClient.Delete(ctx, provider) })

		// allowedGitBranches is operational and mutable: widening the set succeeds.
		Eventually(func(g Gomega) {
			current := &configbutleraiv1alpha3.GitProvider{}
			g.Expect(k8sClient.Get(ctx, key, current)).To(Succeed())
			current.Spec.AllowedGitBranches[0].BranchPatterns = []configbutleraiv1alpha3.BranchPattern{
				"main",
				"develop",
			}
			g.Expect(k8sClient.Update(ctx, current)).To(Succeed())
		}, timeout, interval).Should(Succeed())

		// The URL is the destination identity and is immutable.
		Eventually(func(g Gomega) {
			current := &configbutleraiv1alpha3.GitProvider{}
			g.Expect(k8sClient.Get(ctx, key, current)).To(Succeed())
			current.Spec.URL = "https://example.com/other.git"
			err := k8sClient.Update(ctx, current)
			g.Expect(err).To(HaveOccurred())
			g.Expect(err.Error()).To(ContainSubstring("spec.url is immutable"))
		}, timeout, interval).Should(Succeed())
	})
})