Skip to content

Commit

Permalink
updates based on PR review
Browse files Browse the repository at this point in the history
Signed-off-by: Ken Sipe <kensipe@gmail.com>
  • Loading branch information
kensipe committed Dec 20, 2019
1 parent b09daf0 commit d2f136a
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions pkg/kudoctl/cmd/generate/operator.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ import (
"github.com/kudobuilder/kudo/pkg/kudoctl/packages/reader"
)

// OperatorGenSafe checks to see if operator generation makes sense (we don't generate over an operator or existing folder)
// CanGenerateOperator checks to see if operator generation makes sense (we don't generate over an operator or existing folder)
// fails if folder exits (non-destructive)
// if "operator.yaml" exists in current dir, we assume it's a mistake an error
func OperatorGenSafe(fs afero.Fs, dir string, overwrite bool) error {
func CanGenerateOperator(fs afero.Fs, dir string, overwrite bool) error {
exists, err := afero.Exists(fs, dir)
if err != nil {
return err
Expand All @@ -37,7 +37,7 @@ func OperatorGenSafe(fs afero.Fs, dir string, overwrite bool) error {

// Operator generates an initial operator folder with a operator.yaml
func Operator(fs afero.Fs, dir string, op packages.OperatorFile, overwrite bool) error {
err := OperatorGenSafe(fs, dir, overwrite)
err := CanGenerateOperator(fs, dir, overwrite)
if err != nil {
return err
}
Expand Down
20 changes: 10 additions & 10 deletions pkg/kudoctl/cmd/generate/operator_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,20 @@ func TestOperatorGenSafe(t *testing.T) {

// empty fs should be fine
fs := afero.NewMemMapFs()
err := OperatorGenSafe(fs, "operator", false)
err := CanGenerateOperator(fs, "operator", false)
assert.Nil(t, err)

// folder that doesn't exist should be fine
err = OperatorGenSafe(fs, "operator", false)
err = CanGenerateOperator(fs, "operator", false)
assert.Nil(t, err)

_ = fs.Mkdir("operator", 0755)
// folder that exist should fail
err = OperatorGenSafe(fs, "operator", false)
err = CanGenerateOperator(fs, "operator", false)
assert.NotNil(t, err)

// folder that exist should not fail if overwrite
err = OperatorGenSafe(fs, "operator", true)
err = CanGenerateOperator(fs, "operator", true)
assert.Nil(t, err)
}

Expand All @@ -48,7 +48,7 @@ func TestOperator_Write(t *testing.T) {
fs := afero.NewMemMapFs()

err := Operator(fs, "operator", op1, false)
//no error on create
// no error on create
assert.Nil(t, err)

// results in operator file
Expand All @@ -58,13 +58,13 @@ func TestOperator_Write(t *testing.T) {
exists, _ = afero.Exists(fs, paramFilename)
assert.True(t, exists)

// test fail on existing
// test fail on existing
err = Operator(fs, "operator", op1, false)
assert.Errorf(t, err, "folder 'operator' already exists")

// test overwriting with no error
// test overwriting with no error
err = Operator(fs, "operator", op1, true)
//no error on overwrite
// no error on overwrite
assert.Nil(t, err)

// updating params file and testing params are not overwritten
Expand All @@ -75,9 +75,9 @@ func TestOperator_Write(t *testing.T) {
// replace param file with a marker "FOO" to test that we do NOT overwrite it
err = writeParameters(fs, "operator", pf)
assert.Nil(t, err)
//test overwriting with no error
// test overwriting with no error
err = Operator(fs, "operator", op1, true)
//no error on overwrite
// no error on overwrite
assert.Nil(t, err)
parmfile, _ := afero.ReadFile(fs, paramFilename)
assert.Contains(t, string(parmfile), "FOO")
Expand Down
4 changes: 2 additions & 2 deletions pkg/kudoctl/cmd/package_new.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const (
pkgNewDesc = `Create a new KUDO operator on the local filesystem`

pkgNewExample = ` # Create a new KUDO operator name foo
kubectl kudo package foo
kubectl kudo package new foo
`
)

Expand Down Expand Up @@ -93,7 +93,7 @@ func (pkg *packageNewCmd) run() error {
if len(input) < 1 {
return errors.New("Operator directory must have more than 1 character")
}
return generate.OperatorGenSafe(pkg.fs, input, pkg.overwrite)
return generate.CanGenerateOperator(pkg.fs, input, pkg.overwrite)
}

path, err := prompt.WithValidator("Operator directory", pathDefault, pathValid)
Expand Down
2 changes: 1 addition & 1 deletion pkg/kudoctl/cmd/prompt/prompt.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ func WithOptions(label string, options []string) (string, error) {

}

// input is output rune, in other words, no cursor
func cursor(input []rune) []rune {
//return []rune("\u258D")
return input
}

Expand Down

0 comments on commit d2f136a

Please sign in to comment.