Skip to content

Commit

Permalink
cleanup: remove v1 code source which is deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
Camila Macedo committed May 1, 2020
1 parent bd2bfc6 commit bcf261b
Show file tree
Hide file tree
Showing 9 changed files with 41 additions and 50 deletions.
6 changes: 1 addition & 5 deletions cmd/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,11 @@ import (
"log"

"sigs.k8s.io/kubebuilder/cmd/version"
"sigs.k8s.io/kubebuilder/internal/config"
"sigs.k8s.io/kubebuilder/pkg/cli"
pluginv2 "sigs.k8s.io/kubebuilder/pkg/plugin/v2"
)

func main() {
if err := config.CheckProjectVersionSupported(); err != nil {
log.Fatal(err)
}

c, err := cli.New(
cli.WithPlugins(
&pluginv2.Plugin{},
Expand All @@ -39,6 +34,7 @@ func main() {
),
cli.WithExtraCommands(
newEditCmd(),
newUpdateCmd(),
newCompletionCmd(),
version.NewCmd(),
),
Expand Down
26 changes: 0 additions & 26 deletions internal/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ const (

// DefaultVersion is the version which will be used when the version flag is not provided
DefaultVersion = config.Version3Alpha

// To print error with colored
NoticeColor = "\033[1;36m%s\033[0m"
)

func exists(fs afero.Fs, path string) (bool, error) {
Expand Down Expand Up @@ -182,26 +179,3 @@ type saveError struct {
func (e saveError) Error() string {
return fmt.Sprintf("unable to save the configuration: %v", e.err)
}

// todo: check the best way we centralize it
// CheckProjectVersionSupported returns true if the project is already configured and it is v2
func CheckProjectVersionSupported() error {
cfg, err := Read()
if os.IsNotExist(err) {
return nil
}

if err != nil {
return err
}

if cfg.IsV1() {
return fmt.Errorf(NoticeColor, "The v1 projects are no longer supported.\n"+
"See how to upgrade your project to v2: https://book.kubebuilder.io/migration/guide.html\n")
}

if !cfg.IsV2() && !cfg.IsV3() {
return fmt.Errorf("unknown project version %v", cfg.Version)
}
return nil
}
13 changes: 8 additions & 5 deletions pkg/cli/cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ import (
)

const (
noticeColor = "\033[1;36m%s\033[0m"
runInProjectRootMsg = `For project-specific information, run this command in the root directory of a
project.
`
Expand Down Expand Up @@ -193,10 +194,15 @@ func (c *cli) initialize() error {
} else if err == nil {
c.configured = true
c.projectVersion = projectConfig.Version

if projectConfig.IsV1() {
return fmt.Errorf(noticeColor, "The v1 projects are no longer supported.\n"+
"See how to upgrade your project to v2: https://book.kubebuilder.io/migration/guide.html\n")
}
} else {
return fmt.Errorf("failed to read config: %v", err)
}

// Validate after setting projectVersion but before buildRootCmd so we error
// out before an error resulting from an incorrect cli is returned downstream.
if err = c.validate(); err != nil {
Expand Down Expand Up @@ -248,7 +254,7 @@ func (c *cli) initialize() error {
// Write deprecation notices after all commands have been constructed.
for _, p := range c.resolvedPlugins {
if d, isDeprecated := p.(plugin.Deprecated); isDeprecated {
fmt.Printf(internalconfig.NoticeColor, fmt.Sprintf("[Deprecation Notice] %s\n\n",
fmt.Printf(noticeColor, fmt.Sprintf("[Deprecation Notice] %s\n\n",
d.DeprecationWarning()))
}
}
Expand Down Expand Up @@ -358,9 +364,6 @@ func validatePlugins(plugins ...plugin.Base) error {
// buildRootCmd returns a root command with a subcommand tree reflecting the
// current project's state.
func (c cli) buildRootCmd() *cobra.Command {
if err := internalconfig.CheckProjectVersionSupported(); err != nil {
log.Fatal(err)
}
rootCmd := c.defaultCommand()

// kubebuilder alpha
Expand Down
12 changes: 12 additions & 0 deletions pkg/model/config/project_type.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
package config

// constants for scaffolding types
const (
Go = "go"
Ansible = "Ansible"
Helm = "Helm"
)

type Type struct {
Type string
}
10 changes: 6 additions & 4 deletions pkg/scaffold/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ package scaffold
import (
"fmt"

internalconfig "sigs.k8s.io/kubebuilder/internal/config"
"sigs.k8s.io/kubebuilder/pkg/model"
"sigs.k8s.io/kubebuilder/pkg/model/config"
"sigs.k8s.io/kubebuilder/pkg/model/resource"
Expand Down Expand Up @@ -66,10 +65,13 @@ func NewAPIScaffolder(
// Scaffold implements Scaffolder
func (s *apiScaffolder) Scaffold() error {
fmt.Println("Writing scaffold for you to edit...")
if err := internalconfig.CheckProjectVersionSupported(); err != nil {
return err

switch {
case s.config.IsV2(), s.config.IsV3():
return s.scaffold()
default:
return fmt.Errorf("unknown project version %v", s.config.Version)
}
return s.scaffold()
}

func (s *apiScaffolder) newUniverse() *model.Universe {
Expand Down
10 changes: 6 additions & 4 deletions pkg/scaffold/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ import (
"io/ioutil"
"path/filepath"

internalconfig "sigs.k8s.io/kubebuilder/internal/config"
"sigs.k8s.io/kubebuilder/pkg/model"
"sigs.k8s.io/kubebuilder/pkg/model/config"
"sigs.k8s.io/kubebuilder/pkg/scaffold/internal/machinery"
Expand Down Expand Up @@ -73,10 +72,13 @@ func (s *initScaffolder) newUniverse(boilerplate string) *model.Universe {
// Scaffold implements Scaffolder
func (s *initScaffolder) Scaffold() error {
fmt.Println("Writing scaffold for you to edit...")
if err := internalconfig.CheckProjectVersionSupported(); err != nil {
return err

switch {
case s.config.IsV2(), s.config.IsV3():
return s.scaffold()
default:
return fmt.Errorf("unknown project version %v", s.config.Version)
}
return s.scaffold()
}

func (s *initScaffolder) scaffold() error {
Expand Down
10 changes: 6 additions & 4 deletions pkg/scaffold/webhook.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ package scaffold
import (
"fmt"

internalconfig "sigs.k8s.io/kubebuilder/internal/config"
"sigs.k8s.io/kubebuilder/pkg/model"
"sigs.k8s.io/kubebuilder/pkg/model/config"
"sigs.k8s.io/kubebuilder/pkg/model/resource"
Expand Down Expand Up @@ -61,10 +60,13 @@ func NewWebhookScaffolder(
// Scaffold implements Scaffolder
func (s *webhookScaffolder) Scaffold() error {
fmt.Println("Writing scaffold for you to edit...")
if err := internalconfig.CheckProjectVersionSupported(); err != nil {
return err

switch {
case s.config.IsV2(), s.config.IsV3():
return s.scaffold()
default:
return fmt.Errorf("unknown project version %v", s.config.Version)
}
return s.scaffold()
}

func (s *webhookScaffolder) newUniverse() *model.Universe {
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/v2/e2e_suite.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ var _ = Describe("kubebuilder", func() {
By("init v2 project")
err := kbc.Init(
"--domain", kbc.Domain,
"--fetch-deps=false")
"--dep=false")
Expect(err).Should(Succeed())

By("creating api definition")
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/v3/e2e_suite.go
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ var _ = Describe("kubebuilder", func() {
err := kbc.Init(
"--project-version", "3-alpha",
"--domain", kbc.Domain,
"--fetch-deps=false")
"--dep=false")
Expect(err).Should(Succeed())

By("creating api definition")
Expand Down

0 comments on commit bcf261b

Please sign in to comment.