Merge pull request #5480 from camilamacedo86/flags-edit

🐛 (go/v4): preserve existing PROJECT values for unset edit flags

Author: k8s-ci-robot

pkg/plugins/golang/v4/edit.go

@@ -35,6 +35,9 @@ type editSubcommand struct {
 	multigroup bool
 	namespaced bool
 	force      bool
+
+	// fs stores the FlagSet to check if flags were explicitly set
+	fs *pflag.FlagSet
 }
 
 func (p *editSubcommand) UpdateMetadata(cliMeta plugin.CLIMetadata, subcmdMeta *plugin.SubcommandMetadata) {
@@ -80,6 +83,7 @@ Note: To add optional plugins after initialization, use 'kubebuilder edit --plug
 }
 
 func (p *editSubcommand) BindFlags(fs *pflag.FlagSet) {
+	p.fs = fs
 	fs.BoolVar(&p.multigroup, "multigroup", false, "enable or disable multigroup layout")
 	fs.BoolVar(&p.namespaced, "namespaced", false, "enable or disable namespace-scoped deployment")
 	fs.BoolVar(&p.force, "force", false, "overwrite scaffolded files to apply changes (manual edits may be lost)")
@@ -91,6 +95,19 @@ func (p *editSubcommand) InjectConfig(c config.Config) error {
 	return nil
 }
 
+func (p *editSubcommand) PreScaffold(machinery.Filesystem) error {
+	// If flags were not explicitly set, preserve existing PROJECT file values
+	// This prevents one flag from clearing another when using default values
+	if !p.fs.Changed("multigroup") {
+		p.multigroup = p.config.IsMultiGroup()
+	}
+	if !p.fs.Changed("namespaced") {
+		p.namespaced = p.config.IsNamespaced()
+	}
+
+	return nil
+}
+
 func (p *editSubcommand) Scaffold(fs machinery.Filesystem) error {
 	scaffolder := scaffolds.NewEditScaffolder(p.config, p.multigroup, p.namespaced, p.force)
 	scaffolder.InjectFS(fs)

pkg/plugins/golang/v4/edit_test.go

@@ -19,9 +19,12 @@ package v4
 import (
 	. "github.com/onsi/ginkgo/v2"
 	. "github.com/onsi/gomega"
+	"github.com/spf13/afero"
+	"github.com/spf13/pflag"
 
 	"sigs.k8s.io/kubebuilder/v4/pkg/config"
 	cfgv3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3"
+	"sigs.k8s.io/kubebuilder/v4/pkg/machinery"
 )
 
 var _ = Describe("editSubcommand", func() {
@@ -39,4 +42,96 @@ var _ = Describe("editSubcommand", func() {
 		Expect(subCmd.InjectConfig(cfg)).To(Succeed())
 		Expect(subCmd.config).To(Equal(cfg))
 	})
+
+	Context("PreScaffold", func() {
+		var (
+			fs     *pflag.FlagSet
+			mockFS machinery.Filesystem
+		)
+
+		BeforeEach(func() {
+			fs = pflag.NewFlagSet("test", pflag.ContinueOnError)
+			subCmd.BindFlags(fs)
+			Expect(subCmd.InjectConfig(cfg)).To(Succeed())
+			mockFS = machinery.Filesystem{FS: afero.NewMemMapFs()}
+		})
+
+		It("should preserve existing multigroup setting when only namespaced flag is set", func() {
+			// Set multigroup in PROJECT file
+			Expect(cfg.SetMultiGroup()).To(Succeed())
+			Expect(cfg.IsMultiGroup()).To(BeTrue())
+
+			// Only set namespaced flag (multigroup not set, so it defaults to false)
+			Expect(fs.Set("namespaced", "true")).To(Succeed())
+
+			// PreScaffold should preserve the existing multigroup value
+			Expect(subCmd.PreScaffold(mockFS)).To(Succeed())
+
+			// Both should be true
+			Expect(subCmd.multigroup).To(BeTrue(), "multigroup should be preserved from PROJECT file")
+			Expect(subCmd.namespaced).To(BeTrue(), "namespaced should be set from flag")
+		})
+
+		It("should preserve existing namespaced setting when only multigroup flag is set", func() {
+			// Set namespaced in PROJECT file
+			Expect(cfg.SetNamespaced()).To(Succeed())
+			Expect(cfg.IsNamespaced()).To(BeTrue())
+
+			// Only set multigroup flag (namespaced not set, so it defaults to false)
+			Expect(fs.Set("multigroup", "true")).To(Succeed())
+
+			// PreScaffold should preserve the existing namespaced value
+			Expect(subCmd.PreScaffold(mockFS)).To(Succeed())
+
+			// Both should be true
+			Expect(subCmd.multigroup).To(BeTrue(), "multigroup should be set from flag")
+			Expect(subCmd.namespaced).To(BeTrue(), "namespaced should be preserved from PROJECT file")
+		})
+
+		It("should allow explicitly disabling a flag", func() {
+			// Set both in PROJECT file
+			Expect(cfg.SetMultiGroup()).To(Succeed())
+			Expect(cfg.SetNamespaced()).To(Succeed())
+
+			// Explicitly disable multigroup
+			Expect(fs.Set("multigroup", "false")).To(Succeed())
+
+			// PreScaffold should respect the explicit false
+			Expect(subCmd.PreScaffold(mockFS)).To(Succeed())
+
+			// multigroup should be false (explicitly set), namespaced should be true (from PROJECT)
+			Expect(subCmd.multigroup).To(BeFalse(), "multigroup should be explicitly disabled")
+			Expect(subCmd.namespaced).To(BeTrue(), "namespaced should be preserved from PROJECT file")
+		})
+
+		It("should use flag values when both flags are explicitly set", func() {
+			// Set different values in PROJECT file
+			Expect(cfg.SetMultiGroup()).To(Succeed())
+			Expect(cfg.ClearNamespaced()).To(Succeed())
+
+			// Explicitly set both flags to opposite values
+			Expect(fs.Set("multigroup", "false")).To(Succeed())
+			Expect(fs.Set("namespaced", "true")).To(Succeed())
+
+			// PreScaffold should use the explicit flag values
+			Expect(subCmd.PreScaffold(mockFS)).To(Succeed())
+
+			Expect(subCmd.multigroup).To(BeFalse(), "multigroup should use explicit flag value")
+			Expect(subCmd.namespaced).To(BeTrue(), "namespaced should use explicit flag value")
+		})
+
+		It("should preserve PROJECT file values when no flags are set", func() {
+			// Set values in PROJECT file
+			Expect(cfg.SetMultiGroup()).To(Succeed())
+			Expect(cfg.SetNamespaced()).To(Succeed())
+
+			// Don't set any flags
+
+			// PreScaffold should preserve both values from PROJECT file
+			Expect(subCmd.PreScaffold(mockFS)).To(Succeed())
+
+			Expect(subCmd.multigroup).To(BeTrue(), "multigroup should be preserved from PROJECT file")
+			Expect(subCmd.namespaced).To(BeTrue(), "namespaced should be preserved from PROJECT file")
+		})
+	})
 })