Store abstraction for persisting Config

- Use PreRunE and PostRunE functions to handle configuration file loading and saving - Use a filesystem provided by the cli to persist the project config and to scaffold files Signed-off-by: Adrian Orive <[email protected]>
kubernetes-sigs · Mar 11, 2021 · 450aa15 · 450aa15
1 parent 0675cd5
commit 450aa15
Show file tree

Hide file tree

Showing 41 changed files with 897 additions and 541 deletions.
diff --git a/pkg/cli/api.go b/pkg/cli/api.go
@@ -21,7 +21,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"sigs.k8s.io/kubebuilder/v3/pkg/cli/internal/config"
+	yamlstore "sigs.k8s.io/kubebuilder/v3/pkg/config/store/yaml"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 )
 
@@ -76,18 +76,15 @@ func (c CLI) bindCreateAPI(ctx plugin.Context, cmd *cobra.Command) {
 		return
 	}
 
-	cfg, err := config.LoadInitialized()
-	if err != nil {
-		cmdErr(cmd, err)
-		return
-	}
-
 	subcommand := createAPIPlugin.GetCreateAPISubcommand()
-	subcommand.InjectConfig(cfg.Config)
 	subcommand.BindFlags(cmd.Flags())
 	subcommand.UpdateContext(&ctx)
 	cmd.Long = ctx.Description
 	cmd.Example = ctx.Examples
-	cmd.RunE = runECmdFunc(cfg, subcommand,
-		fmt.Sprintf("failed to create API with %q", plugin.KeyFor(createAPIPlugin)))
+
+	cfg := yamlstore.New(c.fs)
+	msg := fmt.Sprintf("failed to create API with %q", plugin.KeyFor(createAPIPlugin))
+	cmd.PreRunE = preRunECmdFunc(subcommand, cfg, msg)
+	cmd.RunE = runECmdFunc(c.fs, subcommand, msg)
+	cmd.PostRunE = postRunECmdFunc(cfg, msg)
 }
diff --git a/pkg/cli/cli.go b/pkg/cli/cli.go
@@ -17,15 +17,17 @@ limitations under the License.
 package cli
 
 import (
+	"errors"
 	"fmt"
 	"os"
 	"strings"
 
+	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
-	internalconfig "sigs.k8s.io/kubebuilder/v3/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	yamlstore "sigs.k8s.io/kubebuilder/v3/pkg/config/store/yaml"
 	cfgv3 "sigs.k8s.io/kubebuilder/v3/pkg/config/v3"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 )
@@ -88,6 +90,9 @@ type CLI struct { //nolint:maligned
 
 	// Root command.
 	cmd *cobra.Command
+
+	// Underlying fs
+	fs afero.Fs
 }
 
 // New creates a new CLI instance.
@@ -131,6 +136,7 @@ func newCLI(options ...Option) (*CLI, error) {
 		defaultProjectVersion: cfgv3.Version,
 		defaultPlugins:        make(map[config.Version][]string),
 		plugins:               make(map[string]plugin.Plugin),
+		fs:                    afero.NewOsFs(),
 	}
 
 	// Apply provided options.
@@ -188,18 +194,19 @@ func (c *CLI) getInfoFromFlags() (string, []string, error) {
 }
 
 // getInfoFromConfigFile obtains the project version and plugin keys from the project config file.
-func getInfoFromConfigFile() (config.Version, []string, error) {
+func (c cli) getInfoFromConfigFile() (config.Version, []string, error) {
 	// Read the project configuration file
-	projectConfig, err := internalconfig.Read()
+	cfg := yamlstore.New(c.fs)
+	err := cfg.Load()
 	switch {
 	case err == nil:
-	case os.IsNotExist(err):
+	case errors.Is(err, os.ErrNotExist):
 		return config.Version{}, nil, nil
 	default:
 		return config.Version{}, nil, err
 	}
 
-	return getInfoFromConfig(projectConfig)
+	return getInfoFromConfig(cfg.Config())
 }
 
 // getInfoFromConfig obtains the project version and plugin keys from the project config.
@@ -294,7 +301,7 @@ func (c *CLI) getInfo() error {
 		return err
 	}
 	// Get project version and plugin info from project configuration file
-	cfgProjectVersion, cfgPlugins, _ := getInfoFromConfigFile()
+	cfgProjectVersion, cfgPlugins, _ := c.getInfoFromConfigFile()
 	// We discard the error because not being able to read a project configuration file
 	// is not fatal for some commands. The ones that require it need to check its existence.
 

diff --git a/pkg/cli/cli_test.go b/pkg/cli/cli_test.go
@@ -23,6 +23,7 @@ import (
 
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
 
 	"sigs.k8s.io/kubebuilder/v3/pkg/config"
@@ -585,6 +586,7 @@ var _ = Describe("CLI", func() {
 				defaultPlugins: map[config.Version][]string{
 					projectVersion: pluginKeys,
 				},
+				fs: afero.NewMemMapFs(),
 			}
 			c.cmd = c.newRootCmd()
 			Expect(c.getInfo()).To(Succeed())

diff --git a/pkg/cli/cmd_helpers.go b/pkg/cli/cmd_helpers.go
@@ -18,10 +18,12 @@ package cli
 
 import (
 	"fmt"
+	"os"
 
+	"github.com/spf13/afero"
 	"github.com/spf13/cobra"
 
-	"sigs.k8s.io/kubebuilder/v3/pkg/cli/internal/config"
+	"sigs.k8s.io/kubebuilder/v3/pkg/config/store"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 )
 
@@ -45,17 +47,39 @@ func errCmdFunc(err error) func(*cobra.Command, []string) error {
 	}
 }
 
-// runECmdFunc returns a cobra RunE function that runs subcommand and saves the
-// config, which may have been modified by subcommand.
-func runECmdFunc(
-	c *config.Config,
-	subcommand plugin.Subcommand,
-	msg string,
-) func(*cobra.Command, []string) error {
+// preRunECmdFunc returns a cobra PreRunE function that loads the configuration file
+// and injects it into the subcommand
+func preRunECmdFunc(subcmd plugin.Subcommand, cfg store.Store, msg string) func(*cobra.Command, []string) error {
 	return func(*cobra.Command, []string) error {
-		if err := subcommand.Run(); err != nil {
+		err := cfg.Load()
+		if os.IsNotExist(err) {
+			return fmt.Errorf("%s: unable to find configuration file, project must be initialized", msg)
+		} else if err != nil {
+			return fmt.Errorf("%s: unable to load configuration file: %w", msg, err)
+		}
+
+		subcmd.InjectConfig(cfg.Config())
+		return nil
+	}
+}
+
+// runECmdFunc returns a cobra RunE function that runs subcommand
+func runECmdFunc(fs afero.Fs, subcommand plugin.Subcommand, msg string) func(*cobra.Command, []string) error {
+	return func(*cobra.Command, []string) error {
+		if err := subcommand.Run(fs); err != nil {
 			return fmt.Errorf("%s: %v", msg, err)
 		}
-		return c.Save()
+		return nil
+	}
+}
+
+// postRunECmdFunc returns a cobra PostRunE function that saves the configuration file
+func postRunECmdFunc(cfg store.Store, msg string) func(*cobra.Command, []string) error {
+	return func(*cobra.Command, []string) error {
+		err := cfg.Save()
+		if err != nil {
+			return fmt.Errorf("%s: unable to save configuration file: %w", msg, err)
+		}
+		return nil
 	}
 }
diff --git a/pkg/cli/edit.go b/pkg/cli/edit.go
@@ -21,7 +21,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"sigs.k8s.io/kubebuilder/v3/pkg/cli/internal/config"
+	yamlstore "sigs.k8s.io/kubebuilder/v3/pkg/config/store/yaml"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 )
 
@@ -76,18 +76,15 @@ func (c CLI) bindEdit(ctx plugin.Context, cmd *cobra.Command) {
 		return
 	}
 
-	cfg, err := config.LoadInitialized()
-	if err != nil {
-		cmdErr(cmd, err)
-		return
-	}
-
 	subcommand := editPlugin.GetEditSubcommand()
-	subcommand.InjectConfig(cfg.Config)
 	subcommand.BindFlags(cmd.Flags())
 	subcommand.UpdateContext(&ctx)
 	cmd.Long = ctx.Description
 	cmd.Example = ctx.Examples
-	cmd.RunE = runECmdFunc(cfg, subcommand,
-		fmt.Sprintf("failed to edit project with %q", plugin.KeyFor(editPlugin)))
+
+	cfg := yamlstore.New(c.fs)
+	msg := fmt.Sprintf("failed to edit project with %q", plugin.KeyFor(editPlugin))
+	cmd.PreRunE = preRunECmdFunc(subcommand, cfg, msg)
+	cmd.RunE = runECmdFunc(c.fs, subcommand, msg)
+	cmd.PostRunE = postRunECmdFunc(cfg, msg)
 }
diff --git a/pkg/cli/init.go b/pkg/cli/init.go
@@ -17,17 +17,17 @@ limitations under the License.
 package cli
 
 import (
+	"errors"
 	"fmt"
-	"log"
 	"os"
 	"sort"
 	"strconv"
 	"strings"
 
 	"github.com/spf13/cobra"
 
-	internalconfig "sigs.k8s.io/kubebuilder/v3/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/v3/pkg/config"
+	yamlstore "sigs.k8s.io/kubebuilder/v3/pkg/config/store/yaml"
 	cfgv2 "sigs.k8s.io/kubebuilder/v3/pkg/config/v2"
 	"sigs.k8s.io/kubebuilder/v3/pkg/plugin"
 )
@@ -136,28 +136,28 @@ func (c CLI) bindInit(ctx plugin.Context, cmd *cobra.Command) {
 		return
 	}
 
-	cfg, err := internalconfig.New(c.projectVersion, internalconfig.DefaultPath)
-	if err != nil {
-		cmdErr(cmd, fmt.Errorf("unable to initialize the project configuration: %w", err))
-		return
-	}
-
 	subcommand := initPlugin.GetInitSubcommand()
-	subcommand.InjectConfig(cfg.Config)
 	subcommand.BindFlags(cmd.Flags())
 	subcommand.UpdateContext(&ctx)
 	cmd.Long = ctx.Description
 	cmd.Example = ctx.Examples
-	cmd.RunE = func(*cobra.Command, []string) error {
-		// Check if a config is initialized in the command runner so the check
-		// doesn't erroneously fail other commands used in initialized projects.
-		_, err := internalconfig.Read()
-		if err == nil || os.IsExist(err) {
-			log.Fatal("config already initialized")
+
+	cfg := yamlstore.New(c.fs)
+	msg := fmt.Sprintf("failed to initialize project with %q", plugin.KeyFor(initPlugin))
+	cmd.PreRunE = func(*cobra.Command, []string) error {
+		// Check if a config is initialized.
+		if err := cfg.Load(); err == nil || !errors.Is(err, os.ErrNotExist) {
+			return fmt.Errorf("%s: already initialized", msg)
 		}
-		if err := subcommand.Run(); err != nil {
-			return fmt.Errorf("failed to initialize project with %q: %v", plugin.KeyFor(initPlugin), err)
+
+		err := cfg.New(c.projectVersion)
+		if err != nil {
+			return fmt.Errorf("%s: error initializing project configuration: %w", msg, err)
 		}
-		return cfg.Save()
+
+		subcommand.InjectConfig(cfg.Config())
+		return nil
 	}
+	cmd.RunE = runECmdFunc(c.fs, subcommand, msg)
+	cmd.PostRunE = postRunECmdFunc(cfg, msg)
 }