Skip to content

Commit

Permalink
Fix the error message for the update cmd (flyteorg#411)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverhu authored and austin362667 committed May 7, 2024
1 parent 001db2c commit cc03896
Show file tree
Hide file tree
Showing 6 changed files with 52 additions and 20 deletions.
1 change: 1 addition & 0 deletions flytectl/clierrors/errors.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ var (
ErrInvalidStateUpdate = "invalid state passed. Specify either activate or archive\n"

ErrProjectNotPassed = "project id wasn't passed\n" // #nosec
ErrProjectIDBothPassed = "both project and id are passed\n"
ErrProjectNameNotPassed = "project name is a required flag"
ErrFailedProjectUpdate = "Project %v failed to update due to %v\n"

Expand Down
38 changes: 26 additions & 12 deletions flytectl/cmd/config/subcommand/project/project_config.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"io/ioutil"

"github.com/flyteorg/flytectl/clierrors"
"github.com/flyteorg/flytectl/cmd/config"
"github.com/flyteorg/flytectl/pkg/filters"
"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin"

Expand Down Expand Up @@ -45,8 +46,9 @@ var DefaultProjectConfig = &ConfigProject{
}

// GetProjectSpec return project spec from a file/flags
func (c *ConfigProject) GetProjectSpec(id string) (*admin.Project, error) {
func (c *ConfigProject) GetProjectSpec(cf *config.Config) (*admin.Project, error) {
projectSpec := admin.Project{}

if len(c.File) > 0 {
yamlFile, err := ioutil.ReadFile(c.File)
if err != nil {
Expand All @@ -56,23 +58,35 @@ func (c *ConfigProject) GetProjectSpec(id string) (*admin.Project, error) {
if err != nil {
return nil, err
}
if len(id) > 0 {
projectSpec.Id = id
} else {
projectSpec.Id = c.ID
projectSpec.Name = c.Name
projectSpec.Description = c.Description
projectSpec.Labels = &admin.Labels{
Values: c.Labels,
}
projectState, err := c.MapToAdminState()
if err != nil {
return nil, err
}
return &projectSpec, nil
projectSpec.State = projectState
}

projectSpec.Id = id
projectSpec.Name = c.Name
projectSpec.Description = c.Description
projectSpec.Labels = &admin.Labels{
Values: c.Labels,
project := cf.Project
if len(projectSpec.Id) == 0 && len(project) == 0 {
err := fmt.Errorf(clierrors.ErrProjectNotPassed)
return nil, err
}
projectState, err := c.MapToAdminState()
if err != nil {

if len(projectSpec.Id) > 0 && len(project) > 0 {
err := fmt.Errorf(clierrors.ErrProjectIDBothPassed)
return nil, err
}
projectSpec.State = projectState

// Get projectId from file, if not provided, fall back to project
if len(projectSpec.Id) == 0 {
projectSpec.Id = project
}
return &projectSpec, nil
}

Expand Down
20 changes: 17 additions & 3 deletions flytectl/cmd/config/subcommand/project/project_config_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,39 @@ import (
"testing"

"github.com/flyteorg/flytectl/clierrors"
"github.com/flyteorg/flytectl/cmd/config"
"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin"

"github.com/stretchr/testify/assert"
)

func TestGetProjectSpec(t *testing.T) {
cf := &config.Config{
Project: "flytesnacks1",
}
t.Run("Successful get project spec", func(t *testing.T) {
c := &ConfigProject{
Name: "flytesnacks",
}
response, err := c.GetProjectSpec("flytesnacks")
response, err := c.GetProjectSpec(cf)
assert.Nil(t, err)
assert.NotNil(t, response)
assert.Equal(t, "flytesnacks1", response.Id)
})

t.Run("Error if project and ID both exist", func(t *testing.T) {
c := &ConfigProject{
ID: "flytesnacks",
Name: "flytesnacks",
}
_, err := c.GetProjectSpec(cf)
assert.NotNil(t, err)
})

t.Run("Successful get request spec from file", func(t *testing.T) {
c := &ConfigProject{
File: "testdata/project.yaml",
}
response, err := c.GetProjectSpec("flytesnacks")
response, err := c.GetProjectSpec(&config.Config{})
assert.Nil(t, err)
assert.Equal(t, "flytesnacks", response.Name)
assert.Equal(t, "flytesnacks test", response.Description)
Expand Down
3 changes: 2 additions & 1 deletion flytectl/cmd/create/project.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"

"github.com/flyteorg/flytectl/clierrors"
"github.com/flyteorg/flytectl/cmd/config"
"github.com/flyteorg/flytectl/cmd/config/subcommand/project"
"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin"

Expand Down Expand Up @@ -45,7 +46,7 @@ Create a project by definition file.
)

func createProjectsCommand(ctx context.Context, args []string, cmdCtx cmdCore.CommandContext) error {
projectSpec, err := project.DefaultProjectConfig.GetProjectSpec(project.DefaultProjectConfig.ID)
projectSpec, err := project.DefaultProjectConfig.GetProjectSpec(config.GetConfig())
if err != nil {
return err
}
Expand Down
2 changes: 2 additions & 0 deletions flytectl/cmd/create/project_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/flyteorg/flytectl/clierrors"

"github.com/flyteorg/flytectl/cmd/config"
"github.com/flyteorg/flytectl/cmd/config/subcommand/project"

"github.com/flyteorg/flyteidl/gen/pb-go/flyteidl/admin"
Expand Down Expand Up @@ -36,6 +37,7 @@ func createProjectSetup() {
project.DefaultProjectConfig.Name = ""
project.DefaultProjectConfig.Labels = map[string]string{}
project.DefaultProjectConfig.Description = ""
config.GetConfig().Project = ""
}
func TestCreateProjectFunc(t *testing.T) {
s := setup()
Expand Down
8 changes: 4 additions & 4 deletions flytectl/cmd/update/project.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ import (
"context"
"fmt"

"github.com/flyteorg/flytectl/cmd/config"

"github.com/flyteorg/flytectl/clierrors"
"github.com/flyteorg/flytectl/cmd/config"
"github.com/flyteorg/flytectl/cmd/config/subcommand/project"
cmdCore "github.com/flyteorg/flytectl/cmd/core"
"github.com/flyteorg/flytestdlib/logger"
Expand Down Expand Up @@ -54,7 +53,7 @@ Update projects.(project/projects can be used interchangeably in these commands)
Update a project by definition file. Note: The name shouldn't contain any whitespace characters.
::
flytectl update project --file project.yaml
flytectl update project --file project.yaml
.. code-block:: yaml
Expand Down Expand Up @@ -84,10 +83,11 @@ Usage
)

func updateProjectsFunc(ctx context.Context, args []string, cmdCtx cmdCore.CommandContext) error {
projectSpec, err := project.DefaultProjectConfig.GetProjectSpec(config.GetConfig().Project)
projectSpec, err := project.DefaultProjectConfig.GetProjectSpec(config.GetConfig())
if err != nil {
return err
}

if projectSpec.Id == "" {
return fmt.Errorf(clierrors.ErrProjectNotPassed)
}
Expand Down

0 comments on commit cc03896

Please sign in to comment.