Merge pull request #4995 from camilamacedo86/fix-test

🌱 refactor TestContext to allow use in unit tests with directory setup

Author: k8s-ci-robot

.gitignore

@@ -28,4 +28,6 @@ docs/book/src/docs
 /testdata/**/go.sum
 /docs/book/src/simple-external-plugin-tutorial/testdata/sampleexternalplugin/v1/bin
 /testdata/**legacy**
-/test/e2e/alphaupdate/e2e-**
+
+## Skip testdata files that generate by tests using TestContext
+**/e2e-*/**

pkg/cli/alpha/internal/common/common_test.go

@@ -19,42 +19,37 @@ package common
 import (
 	"os"
 	"path/filepath"
-	"testing"
 
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
 
 	"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"
+	"sigs.k8s.io/kubebuilder/v4/test/e2e/utils"
 )
 
-func TestCommon(t *testing.T) {
-	RegisterFailHandler(Fail)
-	RunSpecs(t, "Common Pkg Suite")
-}
-
 var _ = Describe("LoadProjectConfig", func() {
 	var (
-		tmpDir      string
+		kbc         *utils.TestContext
 		projectFile string
 	)
 
 	BeforeEach(func() {
 		var err error
-		tmpDir, err = os.MkdirTemp("", "kubebuilder-common-test")
+		kbc, err = utils.NewTestContext("kubebuilder", "GO111MODULE=on")
 		Expect(err).NotTo(HaveOccurred())
-		projectFile = filepath.Join(tmpDir, yaml.DefaultPath)
+		Expect(kbc.Prepare()).To(Succeed())
+		projectFile = filepath.Join(kbc.Dir, yaml.DefaultPath)
 	})
 
 	AfterEach(func() {
-		err := os.RemoveAll(tmpDir)
-		Expect(err).NotTo(HaveOccurred())
+		By("cleaning up test artifacts")
+		kbc.Destroy()
 	})
 
 	Context("when PROJECT file exists and is valid", func() {
 		It("should load the project config successfully", func() {
-			// Register version 3 config
 			config.Register(config.Version{Number: 3}, func() config.Config {
 				return &v3.Cfg{Version: config.Version{Number: 3}}
 			})
@@ -63,26 +58,25 @@ var _ = Describe("LoadProjectConfig", func() {
 `
 			Expect(os.WriteFile(projectFile, []byte(version), 0o644)).To(Succeed())
 
-			config, err := LoadProjectConfig(tmpDir)
+			cfg, err := LoadProjectConfig(kbc.Dir)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(config).NotTo(BeNil())
+			Expect(cfg).NotTo(BeNil())
 		})
 	})
 
 	Context("when PROJECT file does not exist", func() {
 		It("should return an error", func() {
-			_, err := LoadProjectConfig(tmpDir)
+			_, err := LoadProjectConfig(kbc.Dir)
 			Expect(err).To(HaveOccurred())
 			Expect(err.Error()).To(ContainSubstring("failed to load PROJECT file"))
 		})
 	})
 
 	Context("when PROJECT file is invalid", func() {
 		It("should return an error", func() {
-			// Write an invalid YAML content
 			Expect(os.WriteFile(projectFile, []byte(":?!"), 0o644)).To(Succeed())
 
-			_, err := LoadProjectConfig(tmpDir)
+			_, err := LoadProjectConfig(kbc.Dir)
 			Expect(err).To(HaveOccurred())
 			Expect(err.Error()).To(ContainSubstring("failed to load PROJECT file"))
 		})
@@ -91,69 +85,64 @@ var _ = Describe("LoadProjectConfig", func() {
 
 var _ = Describe("GetInputPath", func() {
 	var (
-		tmpDir      string
+		kbc         *utils.TestContext
 		projectFile string
 	)
 
 	BeforeEach(func() {
 		var err error
-		tmpDir, err = os.MkdirTemp("", "kubebuilder-common-test")
+		kbc, err = utils.NewTestContext("kubebuilder", "GO111MODULE=on")
 		Expect(err).NotTo(HaveOccurred())
-		projectFile = filepath.Join(tmpDir, yaml.DefaultPath)
+		Expect(kbc.Prepare()).To(Succeed())
+		projectFile = filepath.Join(kbc.Dir, yaml.DefaultPath)
 	})
 
 	AfterEach(func() {
-		err := os.RemoveAll(tmpDir)
-		Expect(err).NotTo(HaveOccurred())
+		By("cleaning up test artifacts")
+		kbc.Destroy()
 	})
 
-	Context("when inputPath is empty", func() {
-		It("should return current working directory if PROJECT file exists", func() {
-			// Create PROJECT file in tmpDir
-			Expect(os.WriteFile(projectFile, []byte("test-data"), 0o644)).To(Succeed())
-
-			// Change working directory to tmpDir
-			Expect(os.Chdir(tmpDir)).To(Succeed())
+	Context("when inputPath has trailing slash", func() {
+		It("should handle trailing slash and find PROJECT file", func() {
+			Expect(os.WriteFile(projectFile, []byte("test"), 0o644)).To(Succeed())
 
-			currWd, err := os.Getwd()
+			inputPath, err := GetInputPath(kbc.Dir + "/")
 			Expect(err).NotTo(HaveOccurred())
-
-			inputPath, err := GetInputPath("")
-			Expect(err).NotTo(HaveOccurred())
-			Expect(inputPath).To(Equal(currWd))
+			Expect(inputPath).To(Equal(kbc.Dir + "/"))
 		})
+	})
 
-		It("should return error if PROJECT file does not exist in cwd", func() {
-			// Change working directory to tmpDir (no PROJECT file)
-			Expect(os.Chdir(tmpDir)).To(Succeed())
-
+	Context("when inputPath is empty", func() {
+		It("should return error if PROJECT file does not exist in CWD", func() {
 			inputPath, err := GetInputPath("")
 			Expect(err).To(HaveOccurred())
 			Expect(inputPath).To(Equal(""))
 			Expect(err.Error()).To(ContainSubstring("does not exist"))
 		})
 	})
 
-	Context("when inputPath is provided", func() {
-		It("should return inputPath if PROJECT file exists", func() {
+	Context("when inputPath is valid and PROJECT file exists", func() {
+		It("should return the inputPath", func() {
 			Expect(os.WriteFile(projectFile, []byte("test"), 0o644)).To(Succeed())
 
-			inputPath, err := GetInputPath(tmpDir)
+			inputPath, err := GetInputPath(kbc.Dir)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(inputPath).To(Equal(tmpDir))
+			Expect(inputPath).To(Equal(kbc.Dir))
 		})
+	})
 
-		It("should return error if PROJECT file does not exist at provided inputPath", func() {
-			inputPath, err := GetInputPath(tmpDir)
+	Context("when inputPath is valid but PROJECT file does not exist", func() {
+		It("should return an error", func() {
+			inputPath, err := GetInputPath(kbc.Dir)
 			Expect(err).To(HaveOccurred())
 			Expect(inputPath).To(Equal(""))
 			Expect(err.Error()).To(ContainSubstring("does not exist"))
 		})
 	})
 
-	Context("when inputPath is invalid", func() {
-		It("should return error if inputPath does not exist", func() {
-			invalidPath := filepath.Join(tmpDir, "nonexistent")
+	Context("when inputPath does not exist", func() {
+		It("should return an error", func() {
+			invalidPath := filepath.Join(kbc.Dir, "nonexistent")
 			inputPath, err := GetInputPath(invalidPath)
 			Expect(err).To(HaveOccurred())
 			Expect(inputPath).To(Equal(""))

pkg/cli/alpha/internal/common/suite_test.go

@@ -0,0 +1,29 @@
+/*
+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 common
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestCommon(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Common Package Suite For Alpha Commands")
+}

test/e2e/utils/test_context.go

@@ -77,22 +77,32 @@ func NewTestContext(binaryName string, env ...string) (*TestContext, error) {
 		ServiceAccount: fmt.Sprintf("e2e-%s-controller-manager", testSuffix),
 		CmdContext:     cc,
 	}
+
+	// For test outside of cluster we do not need to have kubectl
 	var k8sVersion *KubernetesVersion
-	v, err := kubectl.Version()
-	if err != nil {
+	fakeVersion := &KubernetesVersion{
+		ClientVersion: VersionInfo{
+			Major:      "1",
+			Minor:      "0",
+			GitVersion: "v1.0.0-fake",
+		},
+		ServerVersion: VersionInfo{
+			Major:      "1",
+			Minor:      "0",
+			GitVersion: "v1.0.0-fake",
+		},
+	}
+
+	var v KubernetesVersion
+	var lookupErr error
+
+	_, lookupErr = exec.LookPath("kubectl")
+	if lookupErr != nil {
+		_, _ = fmt.Fprintf(GinkgoWriter, "warning: kubectl not found in PATH; proceeding with fake version\n")
+		k8sVersion = fakeVersion
+	} else if v, err = kubectl.Version(); err != nil {
 		_, _ = fmt.Fprintf(GinkgoWriter, "warning: failed to get kubernetes version: %v\n", err)
-		k8sVersion = &KubernetesVersion{
-			ClientVersion: VersionInfo{
-				Major:      "1",
-				Minor:      "0",
-				GitVersion: "v1.0.0-fake",
-			},
-			ServerVersion: VersionInfo{
-				Major:      "1",
-				Minor:      "0",
-				GitVersion: "v1.0.0-fake",
-			},
-		}
+		k8sVersion = fakeVersion
 	} else {
 		k8sVersion = &v
 	}