Merge pull request #1782 from Adirio/internal-refactor

🌱 Move internal packages

Author: camilamacedo86

pkg/cli/api.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"sigs.k8s.io/kubebuilder/internal/config"
+	"sigs.k8s.io/kubebuilder/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/pkg/plugin"
 )
 

pkg/cli/cli.go

@@ -25,7 +25,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
-	internalconfig "sigs.k8s.io/kubebuilder/internal/config"
+	internalconfig "sigs.k8s.io/kubebuilder/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/pkg/internal/validation"
 	"sigs.k8s.io/kubebuilder/pkg/model/config"
 	"sigs.k8s.io/kubebuilder/pkg/plugin"

pkg/cli/cli_test.go

@@ -24,7 +24,7 @@ import (
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
 
-	internalconfig "sigs.k8s.io/kubebuilder/internal/config"
+	internalconfig "sigs.k8s.io/kubebuilder/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/pkg/model/config"
 	"sigs.k8s.io/kubebuilder/pkg/plugin"
 )

pkg/cli/cmd_helpers.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"sigs.k8s.io/kubebuilder/internal/config"
+	"sigs.k8s.io/kubebuilder/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/pkg/plugin"
 )
 

pkg/cli/edit.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"sigs.k8s.io/kubebuilder/internal/config"
+	"sigs.k8s.io/kubebuilder/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/pkg/plugin"
 )
 

pkg/cli/init.go

@@ -26,7 +26,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	internalconfig "sigs.k8s.io/kubebuilder/internal/config"
+	internalconfig "sigs.k8s.io/kubebuilder/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/pkg/model/config"
 	"sigs.k8s.io/kubebuilder/pkg/plugin"
 )

internal/config/config.go renamed to pkg/cli/internal/config/config.go

@@ -62,7 +62,7 @@ func readFrom(fs afero.Fs, path string) (c config.Config, err error) {
 		return
 	}
 
-	// kubebuilder v1 omitted version, so default to v1
+	// kubebuilder v1 omitted version and it is not supported, so return an error
 	if c.Version == "" {
 		return config.Config{}, fmt.Errorf("project version key `version` is empty or does not exist in %s", path)
 	}

internal/config/config_suite_test.go renamed to pkg/cli/internal/config/config_suite_test.go

@@ -36,7 +36,7 @@ var _ = Describe("Config", func() {
 		It("should save correctly", func() {
 
 			By("saving empty config")
-			Expect(cfg.Save()).To(HaveOccurred())
+			Expect(cfg.Save()).NotTo(Succeed())
 
 			By("saving empty config with path")
 			cfg = Config{
@@ -89,7 +89,7 @@ version: "2"
 			}
 			expectedConfigStr = `domain: example.com
 repo: github.com/example/project
-version: "3-alpha"
+version: 3-alpha
 plugins:
   plugin-x:
     data-1: single plugin datum
@@ -108,12 +108,13 @@ plugins:
 
 		It("should load correctly", func() {
 			var (
-				fs             = afero.NewMemMapFs()
+				fs             afero.Fs
 				configStr      string
 				expectedConfig config.Config
 			)
 
 			By("loading config version 2")
+			fs = afero.NewMemMapFs()
 			configStr = `domain: example.com
 repo: github.com/example/project
 version: "2"`
@@ -122,17 +123,16 @@ version: "2"`
 				Repo:    "github.com/example/project",
 				Domain:  "example.com",
 			}
-			err := afero.WriteFile(fs, DefaultPath, []byte(configStr), os.ModePerm)
-			Expect(err).ToNot(HaveOccurred())
+			Expect(afero.WriteFile(fs, DefaultPath, []byte(configStr), os.ModePerm)).To(Succeed())
 			cfg, err := readFrom(fs, DefaultPath)
 			Expect(err).NotTo(HaveOccurred())
-			Expect(cfg).To(BeEquivalentTo(expectedConfig))
+			Expect(cfg).To(Equal(expectedConfig))
 
 			By("loading config version 3-alpha with plugin config")
 			fs = afero.NewMemMapFs()
 			configStr = `domain: example.com
 repo: github.com/example/project
-version: "3-alpha"
+version: 3-alpha
 plugins:
   plugin-x:
     data-1: single plugin datum
@@ -143,7 +143,7 @@ plugins:
     - "plugin value 3"
     - "plugin value 4"`
 			expectedConfig = config.Config{
-				Version: config.Version2,
+				Version: config.Version3Alpha,
 				Repo:    "github.com/example/project",
 				Domain:  "example.com",
 				Plugins: config.PluginConfigs{
@@ -157,8 +157,7 @@ plugins:
 					},
 				},
 			}
-			err = afero.WriteFile(fs, DefaultPath, []byte(configStr), os.ModePerm)
-			Expect(err).ToNot(HaveOccurred())
+			Expect(afero.WriteFile(fs, DefaultPath, []byte(configStr), os.ModePerm)).To(Succeed())
 			cfg, err = readFrom(fs, DefaultPath)
 			Expect(err).NotTo(HaveOccurred())
 			Expect(cfg).To(Equal(expectedConfig))
@@ -186,22 +185,16 @@ plugins:
 		})
 
 		It("should return a load error", func() {
-			var (
-				fs        afero.Fs
-				configStr string
-				err       error
-			)
 			By("loading config version 2 with plugin config")
-			fs = afero.NewMemMapFs()
-			configStr = `domain: example.com
+			fs := afero.NewMemMapFs()
+			configStr := `domain: example.com
 repo: github.com/example/project
-version: "3-alpha"
+version: "2"
 plugins:
 	plugin-x:
 		data-1: single plugin datum`
-			err = afero.WriteFile(fs, DefaultPath, []byte(configStr), os.ModePerm)
-			Expect(err).ToNot(HaveOccurred())
-			_, err = readFrom(fs, DefaultPath)
+			Expect(afero.WriteFile(fs, DefaultPath, []byte(configStr), os.ModePerm)).To(Succeed())
+			_, err := readFrom(fs, DefaultPath)
 			Expect(err).To(HaveOccurred())
 		})
 	})

internal/config/config_test.go renamed to pkg/cli/internal/config/config_test.go

@@ -21,7 +21,7 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"sigs.k8s.io/kubebuilder/internal/config"
+	"sigs.k8s.io/kubebuilder/pkg/cli/internal/config"
 	"sigs.k8s.io/kubebuilder/pkg/plugin"
 )