(fix): (go/v4): Fixed: Init command incorrectly rejects directories with non-conflicting configuration files

Assisted-by: Cursor

Author: camilamacedo86

pkg/plugins/golang/v4/init.go

@@ -179,33 +179,25 @@ func checkDir() error {
 			if strings.HasSuffix(info.Name(), ".md") && !info.IsDir() {
 				return nil
 			}
-			// Allow capitalized files except PROJECT
+			// Deny PROJECT file (reserved for scaffolding)
+			if info.Name() == "PROJECT" {
+				return fmt.Errorf("target directory is not empty and contains the PROJECT file. " +
+					"This file is reserved and will be generated by the scaffolding tool")
+			}
+			// Allow capitalized files
 			isCapitalized := true
 			for _, l := range info.Name() {
 				if !unicode.IsUpper(l) {
 					isCapitalized = false
 					break
 				}
 			}
-			if isCapitalized && info.Name() != "PROJECT" {
+			if isCapitalized {
 				return nil
 			}
-			disallowedExtensions := []string{
-				".go",
-				".yaml",
-				".mod",
-				".sum",
-			}
-			// Deny files with .go or .yaml or .mod or .sum extensions
-			for _, ext := range disallowedExtensions {
-				if strings.HasSuffix(info.Name(), ext) {
-					return nil
-				}
-			}
-			// Do not allow any other file
-			return fmt.Errorf("target directory is not empty and contains a disallowed file %q. "+
-				"files with the following extensions [%s] are not allowed to avoid conflicts with the tooling",
-				path, strings.Join(disallowedExtensions, ", "))
+			// Allow all other files (including .go, .mod, .sum, .yaml, config files, etc.)
+			// The directory doesn't need to be completely empty - we just block PROJECT
+			return nil
 		})
 	if err != nil {
 		return fmt.Errorf("error walking directory: %w", err)

pkg/plugins/golang/v4/init_test.go

@@ -0,0 +1,249 @@
+/*
+Copyright 2022 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 v4
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestCheckDir(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "CheckDir Suite")
+}
+
+var _ = Describe("checkDir", func() {
+	var testDir string
+
+	BeforeEach(func() {
+		var err error
+		testDir, err = os.MkdirTemp("", "checkdir-test-*")
+		Expect(err).NotTo(HaveOccurred())
+
+		// Change to test directory
+		err = os.Chdir(testDir)
+		Expect(err).NotTo(HaveOccurred())
+	})
+
+	AfterEach(func() {
+		// Clean up test directory
+		_ = os.RemoveAll(testDir)
+	})
+
+	Context("when the directory is empty", func() {
+		It("should succeed", func() {
+			err := checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+	})
+
+	Context("when the directory contains allowed files", func() {
+		It("should succeed with .md files", func() {
+			err := os.WriteFile("README.md", []byte("# Test"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with dot files", func() {
+			err := os.WriteFile(".gitignore", []byte("*.log"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with dot directories", func() {
+			err := os.Mkdir(".git", 0o755)
+			Expect(err).NotTo(HaveOccurred())
+			err = os.WriteFile(".git/config", []byte("[core]"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with capitalized files", func() {
+			err := os.WriteFile("LICENSE", []byte("MIT"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with multiple capitalized files", func() {
+			err := os.WriteFile("LICENSE", []byte("MIT"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+			err = os.WriteFile("CONTRIBUTING", []byte("contribute"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with mise.toml file", func() {
+			err := os.WriteFile("mise.toml", []byte("[tools]"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with .tool-versions file", func() {
+			err := os.WriteFile(".tool-versions", []byte("golang 1.23.0"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with .envrc file", func() {
+			err := os.WriteFile(".envrc", []byte("export FOO=bar"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with config.toml file", func() {
+			err := os.WriteFile("config.toml", []byte("[config]"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with settings.json file", func() {
+			err := os.WriteFile("settings.json", []byte("{}"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with .go files", func() {
+			err := os.WriteFile("main.go", []byte("package main"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with .yaml files", func() {
+			err := os.WriteFile("config.yaml", []byte("key: value"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with .mod files", func() {
+			err := os.WriteFile("go.mod", []byte("module test"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with .sum files", func() {
+			err := os.WriteFile("go.sum", []byte("checksums"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should succeed with a combination of allowed files", func() {
+			err := os.WriteFile("README.md", []byte("# Test"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+			err = os.WriteFile(".gitignore", []byte("*.log"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+			err = os.WriteFile("LICENSE", []byte("MIT"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+			err = os.WriteFile("mise.toml", []byte("[tools]"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+			err = os.WriteFile("go.mod", []byte("module test"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+	})
+
+	Context("when the directory contains disallowed files", func() {
+		It("should fail with PROJECT file (reserved for scaffolding)", func() {
+			err := os.WriteFile("PROJECT", []byte("version: 3"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).To(HaveOccurred())
+			Expect(err.Error()).To(ContainSubstring("PROJECT"))
+		})
+	})
+
+	Context("edge cases", func() {
+		It("should handle files in dot directories correctly", func() {
+			err := os.Mkdir(".hidden", 0o755)
+			Expect(err).NotTo(HaveOccurred())
+			// Files in dot directories should be skipped entirely
+			err = os.WriteFile(".hidden/main.go", []byte("package main"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should allow empty subdirectories", func() {
+			err := os.Mkdir("emptydir", 0o755)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should allow files with multiple extensions", func() {
+			err := os.WriteFile("config.backup.yaml", []byte("key: value"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should allow partially capitalized files", func() {
+			err := os.WriteFile("READme", []byte("test"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		It("should allow go files in subdirectories", func() {
+			err := os.Mkdir("subdir", 0o755)
+			Expect(err).NotTo(HaveOccurred())
+			err = os.WriteFile(filepath.Join("subdir", "main.go"), []byte("package main"), 0o644)
+			Expect(err).NotTo(HaveOccurred())
+
+			err = checkDir()
+			Expect(err).NotTo(HaveOccurred())
+		})
+	})
+})