Merge pull request #4011 from beatrausch/cli-extension

✨ (Only relevant for users of Kubebuilder as a library) - Add new cli option and allow access to underlying cli command

Author: k8s-ci-robot

pkg/cli/cli.go

@@ -462,3 +462,8 @@ func (c CLI) metadata() plugin.CLIMetadata {
 func (c CLI) Run() error {
 	return c.cmd.Execute()
 }
+
+// Command returns the underlying root command.
+func (c CLI) Command() *cobra.Command {
+	return c.cmd
+}

pkg/cli/cli_test.go

@@ -600,5 +600,14 @@ plugins:
 					fmt.Sprintf(noticeColor, fmt.Sprintf(deprecationFmt, deprecationWarning))))
 			})
 		})
+
+		When("new succeeds", func() {
+			It("should return the underlying command", func() {
+				c, err = New()
+				Expect(err).NotTo(HaveOccurred())
+				Expect(c.Command()).NotTo(BeNil())
+				Expect(c.Command()).To(Equal(c.cmd))
+			})
+		})
 	})
 })

pkg/cli/options.go

@@ -31,6 +31,7 @@ import (
 
 	"sigs.k8s.io/kubebuilder/v4/pkg/config"
 	cfgv3 "sigs.k8s.io/kubebuilder/v4/pkg/config/v3"
+	"sigs.k8s.io/kubebuilder/v4/pkg/machinery"
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugin"
 	"sigs.k8s.io/kubebuilder/v4/pkg/plugins/external"
 )
@@ -152,6 +153,18 @@ func WithCompletion() Option {
 	}
 }
 
+// WithFilesystem is an Option that allows to set the filesystem used in the CLI.
+func WithFilesystem(fs machinery.Filesystem) Option {
+	return func(c *CLI) error {
+		if fs.FS == nil {
+			return errors.New("invalid filesystem")
+		}
+
+		c.fs = fs
+		return nil
+	}
+}
+
 // parseExternalPluginArgs returns the program arguments.
 func parseExternalPluginArgs() (args []string) {
 	// Loop through os.Args and only get flags and their values that should be passed to the plugins

pkg/cli/options_test.go

@@ -717,4 +717,27 @@ var _ = Describe("CLI options", func() {
 			Expect(c.completionCommand).To(BeTrue())
 		})
 	})
+
+	Context("WithFilesystem", func() {
+		When("providing a valid filesystem", func() {
+			It("should use the provided filesystem", func() {
+				fs := machinery.Filesystem{
+					FS: afero.NewMemMapFs(),
+				}
+				c, err = newCLI(WithFilesystem(fs))
+				Expect(err).NotTo(HaveOccurred())
+				Expect(c).NotTo(BeNil())
+				Expect(c.fs).To(Equal(fs))
+			})
+		})
+
+		When("providing a invalid filesystem", func() {
+			It("should return an error", func() {
+				fs := machinery.Filesystem{}
+				c, err = newCLI(WithFilesystem(fs))
+				Expect(err).To(HaveOccurred())
+				Expect(c).To(BeNil())
+			})
+		})
+	})
 })