Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Plugins Phase 1 #1469

Merged
merged 13 commits into from
Apr 28, 2020
Merged

Plugins Phase 1 #1469

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1bba4fb
Plugin implementation: Phase 1
estroz Feb 5, 2020
883e8c6
pkg/cli: validate cli struct's fields
estroz Feb 25, 2020
e1d2f11
pkg/scaffold: pass pkg/model/config.Config to scaffolds, not the
estroz Mar 21, 2020
d331eaa
pkg/cli: use --plugins to determine which plugin.Base's kubebuilder
estroz Feb 27, 2020
478c233
pkg/mode/config: add arbitrary extra fields to Config under the
estroz Mar 22, 2020
e4b8d15
cli: check if project is v1 when validating default plugins
estroz Mar 27, 2020
5d5e7d2
Any changes that break 'PROJECT' file backwards-compatibility require…
estroz Mar 27, 2020
706019b
test/e2e: add v3 tests
estroz Apr 2, 2020
cd2d948
pkg/plugin: inject command name from Context so help messages contain
estroz Apr 8, 2020
3596e21
pkg/cli: move --plugins to init, since phase 1 only allows one plugin
estroz Apr 8, 2020
1ee71ec
*: fix validation of default values, update license years, and make
estroz Apr 27, 2020
a639be0
pkg: make added unit tests into ginkgo/gomega tests
estroz Apr 28, 2020
8093011
pkg/model/config: use Version3Alpha variable name for project version…
estroz Apr 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,6 @@ bin/*
/testdata/project-v2/go.sum
/testdata/project-v2-addon/go.sum
/testdata/project-v2-multigroup/go.sum
/testdata/project-v3/go.sum
/testdata/project-v3-multigroup/go.sum
/testdata/project-v3-addon/go.sum
221 changes: 0 additions & 221 deletions cmd/api.go
View file
Open in desktop

This file was deleted.

38 changes: 17 additions & 21 deletions cmd/edit.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,12 @@ limitations under the License.
package main

import (
"errors"
"fmt"
"log"
"os"

"github.com/spf13/cobra"

"sigs.k8s.io/kubebuilder/internal/cmdutil"
"sigs.k8s.io/kubebuilder/internal/config"
"sigs.k8s.io/kubebuilder/pkg/scaffold"
)
Expand All @@ -49,7 +48,11 @@ func newEditCmd() *cobra.Command {
# Disable the multigroup layout
kubebuilder edit --multigroup=false`,
Run: func(_ *cobra.Command, _ []string) {
if err := run(options); err != nil {
var err error
if options.config, err = config.LoadInitialized(); err != nil {
log.Fatal(err)
}
if err := cmdutil.Run(options); err != nil {
log.Fatal(editError{err})
}
},
Expand All @@ -60,39 +63,32 @@ func newEditCmd() *cobra.Command {
return cmd
}

var _ commandOptions = &editOptions{}
var _ cmdutil.RunOptions = &editOptions{}

type editOptions struct {
config *config.Config

multigroup bool
}

func (o *editOptions) bindFlags(cmd *cobra.Command) {
cmd.Flags().BoolVar(&o.multigroup, "multigroup", false, "enable or disable multigroup layout")
}

func (o *editOptions) loadConfig() (*config.Config, error) {
projectConfig, err := config.Load()
if os.IsNotExist(err) {
return nil, errors.New("unable to find configuration file, project must be initialized")
}

return projectConfig, err
}

func (o *editOptions) validate(c *config.Config) error {
if !c.IsV2() {
if c.MultiGroup {
return fmt.Errorf("multiple group support can't be enabled for version %s", c.Version)
func (o *editOptions) Validate() error {
if !o.config.IsV2() && !o.config.IsV3() {
Copy link
Member

@camilamacedo86 camilamacedo86 Apr 11, 2020 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if !o.config.IsV2() && !o.config.IsV3() {
if o.config.IsV1() {

Copy link
Member

@camilamacedo86 camilamacedo86 Apr 11, 2020 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will make easier remove the if to clean the code if/when we remove V1 impl

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this was the intent, but using !o.config.IsV2() && !o.config.IsV3() means that we would need to explicitly assert that a future version (e.g. v4) supports multi-group. This is probably safer than assuming that all future versions will support multi-group.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once #1355 is merged I will rebase to remove v1 checks.

if o.config.MultiGroup {
return fmt.Errorf("multiple group support can't be enabled for version %s", o.config.Version)
}
}

return nil
}

func (o *editOptions) scaffolder(c *config.Config) (scaffold.Scaffolder, error) { //nolint:unparam
return scaffold.NewEditScaffolder(c, o.multigroup), nil
func (o *editOptions) GetScaffolder() (scaffold.Scaffolder, error) {
return scaffold.NewEditScaffolder(&o.config.Config, o.multigroup), nil
}

func (o *editOptions) postScaffold(_ *config.Config) error {
return nil
func (o *editOptions) PostScaffold() error {
return o.config.Save()
}