🌱 Add unit tests for alpha/internal/update

go.mod

@@ -23,6 +23,8 @@ require (
 	github.com/go-task/slim-sprig/v3 v3.0.0 // indirect
 	github.com/google/go-cmp v0.7.0 // indirect
 	github.com/google/pprof v0.0.0-20250403155104-27863c87afa6 // indirect
+	github.com/h2non/gock v1.2.0 // indirect
+	github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/kr/pretty v0.3.1 // indirect
 	github.com/pkg/errors v0.9.1 // indirect

go.sum

@@ -18,6 +18,10 @@ github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
 github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
 github.com/google/pprof v0.0.0-20250403155104-27863c87afa6 h1:BHT72Gu3keYf3ZEu2J0b1vyeLSOYI8bm5wbJM/8yDe8=
 github.com/google/pprof v0.0.0-20250403155104-27863c87afa6/go.mod h1:boTsfXsheKC2y+lKOCMpSfarhxDeIzfZG1jqGcPl3cA=
+github.com/h2non/gock v1.2.0 h1:K6ol8rfrRkUOefooBC8elXoaNGYkpp7y2qcxGG6BzUE=
+github.com/h2non/gock v1.2.0/go.mod h1:tNhoxHYW2W42cYkYb1WqzdbYIieALC99kpYr7rH/BQk=
+github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw=
+github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
@@ -27,6 +31,7 @@ github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms=
 github.com/onsi/ginkgo/v2 v2.23.4 h1:ktYTpKJAVZnDT4VjxSbiBenUjmlL/5QkBEocaWXiQus=
 github.com/onsi/ginkgo/v2 v2.23.4/go.mod h1:Bt66ApGPBFzHyR+JO10Zbt0Gsp4uWxu5mIOTusL46e8=
 github.com/onsi/gomega v1.38.0 h1:c/WX+w8SLAinvuKKQFh77WEucCnPk4j2OTUr7lt7BeY=

pkg/cli/alpha/internal/update/prepare.go

@@ -59,7 +59,7 @@ func (opts *Update) Prepare() error {
 
 // defineFromVersion will return the CLI version to be used for the update with the v prefix.
 func (opts *Update) defineFromVersion(config store.Store) (string, error) {
-	if len(opts.FromBranch) == 0 && len(config.Config().GetCliVersion()) == 0 {
+	if len(opts.FromVersion) == 0 && len(config.Config().GetCliVersion()) == 0 {
 		return "", fmt.Errorf("no version specified in PROJECT file. " +
 			"Please use --from-version flag to specify the version to update from")
 	}

pkg/cli/alpha/internal/update/prepare_test.go

@@ -0,0 +1,178 @@
+/*
+Copyright 2025 The Kubernetes Authors.
+
+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.
+*/
+
+package update
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	"github.com/h2non/gock"
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+
+	"sigs.k8s.io/kubebuilder/v4/pkg/cli/alpha/internal/common"
+	"sigs.k8s.io/kubebuilder/v4/pkg/config"
+	"sigs.k8s.io/kubebuilder/v4/pkg/config/store/yaml"
+	v3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3"
+)
+
+func TestCommand(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "update")
+}
+
+var _ = Describe("Prepare for internal update", func() {
+	var (
+		tmpDir      string
+		workDir     string
+		projectFile string
+		err         error
+	)
+
+	BeforeEach(func() {
+		workDir, err = os.Getwd()
+		Expect(err).ToNot(HaveOccurred())
+
+		tmpDir, err = os.MkdirTemp("", "kubebuilder-prepare-test")
+		Expect(err).ToNot(HaveOccurred())
+		err = os.Chdir(tmpDir)
+		Expect(err).ToNot(HaveOccurred())
+
+		projectFile = filepath.Join(tmpDir, yaml.DefaultPath)
+
+		config.Register(config.Version{Number: 3}, func() config.Config {
+			return &v3.Cfg{Version: config.Version{Number: 3}, CliVersion: "1.0.0"}
+		})
+
+		gock.New("https://api.github.com").
+			Get("/repos/kubernetes-sigs/kubebuilder/releases/latest").
+			Reply(200).
+			JSON(map[string]string{
+				"tag_name": "v1.1.0",
+			})
+	})
+
+	AfterEach(func() {
+		err = os.Chdir(workDir)
+		Expect(err).ToNot(HaveOccurred())
+
+		err = os.RemoveAll(tmpDir)
+		Expect(err).ToNot(HaveOccurred())
+		defer gock.Off()
+	})
+
+	Context("Prepare", func() {
+		DescribeTable("should succeed for valid options",
+			func(options *Update) {
+				const version = `version: "3"`
+				Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
+
+				result := options.Prepare()
+				Expect(result).ToNot(HaveOccurred())
+				Expect(options.Prepare()).To(Succeed())
+				Expect(options.FromVersion).To(Equal("v1.0.0"))
+				Expect(options.ToVersion).To(Equal("v1.1.0"))
+			},
+			Entry("options", &Update{FromVersion: "v1.0.0", ToVersion: "v1.1.0", FromBranch: "test"}),
+			Entry("options", &Update{FromVersion: "1.0.0", ToVersion: "1.1.0", FromBranch: "test"}),
+			Entry("options", &Update{FromVersion: "v1.0.0", ToVersion: "v1.1.0"}),
+			Entry("options", &Update{}),
+		)
+
+		DescribeTable("Should fail to prepare if project path is undetermined",
+			func(options *Update) {
+				err = options.Prepare()
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).Should(ContainSubstring("failed to determine project path"))
+			},
+			Entry("options", &Update{FromVersion: "v1.0.0", ToVersion: "v1.1.0", FromBranch: "test"}),
+		)
+
+		DescribeTable("Should fail if PROJECT config could not be loaded",
+			func(options *Update) {
+				const version = ""
+				Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
+
+				err := options.Prepare()
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).Should(ContainSubstring("failed to load PROJECT config"))
+			},
+			Entry("options", &Update{FromVersion: "v1.0.0", ToVersion: "v1.1.0", FromBranch: "test"}),
+		)
+
+		DescribeTable("Should fail if FromVersion cannot be determined",
+			func(options *Update) {
+				config.Register(config.Version{Number: 3}, func() config.Config {
+					return &v3.Cfg{Version: config.Version{Number: 3}}
+				})
+
+				const version = `version: "3"`
+				Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
+				Expect(options.FromVersion).To(BeEquivalentTo(""))
+			},
+			Entry("options", &Update{}),
+		)
+	})
+
+	Context("DefineFromVersion", func() {
+		DescribeTable("Should succeed when branch or CliVersion in Project config is present",
+			func(options *Update) {
+				const version = `version: "3"`
+				Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
+
+				config, err := common.LoadProjectConfig(tmpDir)
+				Expect(err).ToNot(HaveOccurred())
+				fromVersion, err := options.defineFromVersion(config)
+				Expect(err).ToNot(HaveOccurred())
+				Expect(fromVersion).To(BeEquivalentTo("v1.0.0"))
+			},
+			Entry("options", &Update{FromVersion: ""}),
+			Entry("options", &Update{FromVersion: "1.0.0"}),
+		)
+		DescribeTable("Should fail when --from-version and CliVersion in Project config both are absent",
+			func(options *Update) {
+				config.Register(config.Version{Number: 3}, func() config.Config {
+					return &v3.Cfg{Version: config.Version{Number: 3}}
+				})
+
+				const version = `version: "3"`
+				Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
+
+				config, err := common.LoadProjectConfig(tmpDir)
+				Expect(err).NotTo(HaveOccurred())
+				fromVersion, err := options.defineFromVersion(config)
+				Expect(err).To(HaveOccurred())
+				Expect(err.Error()).To(ContainSubstring("no version specified in PROJECT file"))
+				Expect(fromVersion).To(Equal(""))
+			},
+			Entry("options", &Update{FromVersion: ""}),
+		)
+	})
+
+	Context("DefineToVersion", func() {
+		DescribeTable("Should succeed.",
+			func(options *Update) {
+				toVersion := options.defineToVersion()
+				Expect(toVersion).To(BeEquivalentTo("v1.1.0"))
+			},
+			Entry("options", &Update{ToVersion: "1.1.0"}),
+			Entry("options", &Update{ToVersion: "v1.1.0"}),
+			Entry("options", &Update{}),
+		)
+	})
+})

pkg/cli/alpha/internal/update/update.go

@@ -142,7 +142,7 @@ func (opts *Update) prepareAncestorBranch() error {
 	if err := gitCmd.Run(); err != nil {
 		return fmt.Errorf("failed to stage changes in %s: %w", opts.AncestorBranch, err)
 	}
-	commitMessage := "Clean scaffold from release version:" + opts.FromVersion
+	commitMessage := "Clean scaffolding from release version: " + opts.FromVersion
 	_ = exec.Command("git", "commit", "-m", commitMessage).Run()
 	return nil
 }
@@ -252,7 +252,7 @@ func runAlphaGenerate(tempDir, version string) error {
 	if err := cmd.Run(); err != nil {
 		return fmt.Errorf("failed to run alpha generate: %w", err)
 	}
-	log.Info("Successfully ran alpha generate", version)
+	log.Info("Successfully ran alpha generate ", version)
 
 	// TODO: Analyse if this command is still needed in the future.
 	// It was added because the alpha generate command in versions prior to v4.7.0 does
@@ -314,7 +314,7 @@ func (opts *Update) prepareUpgradeBranch() error {
 		return fmt.Errorf("failed to stage changes in %s: %w", opts.UpgradeBranch, err)
 	}
 
-	_ = exec.Command("git", "commit", "-m", "Clean scaffolding from version "+opts.ToVersion).Run()
+	_ = exec.Command("git", "commit", "-m", "Clean scaffolding from release version: "+opts.ToVersion).Run()
 	return nil
 }