diff --git a/README.md b/README.md index 98e32449..78e1be48 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,8 @@ go run main.go flags update \ --api-token {api-token} \ --base-uri http://localhost:3000 \ -d '[{"op": "replace", "path": "/environments/production/on", "value": true}]' \ - --projKey default \ - --key test-flag + --project default \ + --flag test-flag ``` ## Running Github Actions locally diff --git a/cmd/cliflags/flags.go b/cmd/cliflags/flags.go index d10629de..bc2d5eea 100644 --- a/cmd/cliflags/flags.go +++ b/cmd/cliflags/flags.go @@ -3,4 +3,6 @@ package cliflags const ( APITokenFlag = "api-token" BaseURIFlag = "base-uri" + FlagFlag = "flag" + ProjectFlag = "project" ) diff --git a/cmd/flags/create.go b/cmd/flags/create.go index f6d89010..15401841 100644 --- a/cmd/flags/create.go +++ b/cmd/flags/create.go @@ -32,12 +32,12 @@ func NewCreateCmd(client flags.Client) (*cobra.Command, error) { return nil, err } - cmd.Flags().String("projKey", "", "Project key") - err = cmd.MarkFlagRequired("projKey") + cmd.Flags().String(cliflags.ProjectFlag, "", "Project key") + err = cmd.MarkFlagRequired(cliflags.ProjectFlag) if err != nil { return nil, err } - err = viper.BindPFlag("projKey", cmd.Flags().Lookup("projKey")) + err = viper.BindPFlag(cliflags.ProjectFlag, cmd.Flags().Lookup(cliflags.ProjectFlag)) if err != nil { return nil, err } @@ -54,7 +54,7 @@ func runCreate(client flags.Client) func(*cobra.Command, []string) error { return func(cmd *cobra.Command, args []string) error { // rebind flags used in other subcommands _ = viper.BindPFlag("data", cmd.Flags().Lookup("data")) - _ = viper.BindPFlag("projKey", cmd.Flags().Lookup("projKey")) + _ = viper.BindPFlag(cliflags.ProjectFlag, cmd.Flags().Lookup(cliflags.ProjectFlag)) var data inputData err := json.Unmarshal([]byte(viper.GetString("data")), &data) @@ -68,7 +68,7 @@ func runCreate(client flags.Client) func(*cobra.Command, []string) error { viper.GetString(cliflags.BaseURIFlag), data.Name, data.Key, - viper.GetString("projKey"), + viper.GetString(cliflags.ProjectFlag), ) if err != nil { return err diff --git a/cmd/flags/create_test.go b/cmd/flags/create_test.go index 5b04f52e..1cc7d657 100644 --- a/cmd/flags/create_test.go +++ b/cmd/flags/create_test.go @@ -30,7 +30,7 @@ func TestCreate(t *testing.T) { "--api-token", "testAccessToken", "--base-uri", "http://test.com", "-d", `{"key": "test-key", "name": "test-name"}`, - "--projKey", "test-proj-key", + "--project", "test-proj-key", } output, err := cmd.CallCmd(t, &client, nil, nil, args) @@ -49,7 +49,7 @@ func TestCreate(t *testing.T) { "--api-token", "testAccessToken", "--base-uri", "http://test.com", "-d", `{"key": "test-key", "name": "test-name"}`, - "--projKey", "test-proj-key", + "--project", "test-proj-key", } _, err := cmd.CallCmd(t, &client, nil, nil, args) @@ -64,7 +64,7 @@ func TestCreate(t *testing.T) { _, err := cmd.CallCmd(t, &flags.MockClient{}, nil, nil, args) - assert.EqualError(t, err, `required flag(s) "api-token", "data", "projKey" not set`+errorHelp) + assert.EqualError(t, err, `required flag(s) "api-token", "data", "project" not set`+errorHelp) }) t.Run("with missing short flag value is an error", func(t *testing.T) { @@ -95,7 +95,7 @@ func TestCreate(t *testing.T) { "--api-token", "testAccessToken", "--base-uri", "invalid", "-d", `{"key": "test-key", "name": "test-name"}`, - "--projKey", "test-proj-key", + "--project", "test-proj-key", } _, err := cmd.CallCmd(t, &flags.MockClient{}, nil, nil, args) diff --git a/cmd/flags/update.go b/cmd/flags/update.go index 8f75885c..645a0d59 100644 --- a/cmd/flags/update.go +++ b/cmd/flags/update.go @@ -40,22 +40,22 @@ func NewUpdateCmd(client flags.Client) (*cobra.Command, error) { return nil, err } - cmd.Flags().String("key", "", "Flag key") - err = cmd.MarkFlagRequired("key") + cmd.Flags().String(cliflags.FlagFlag, "", "Flag key") + err = cmd.MarkFlagRequired(cliflags.FlagFlag) if err != nil { return nil, err } - err = viper.BindPFlag("key", cmd.Flags().Lookup("key")) + err = viper.BindPFlag(cliflags.FlagFlag, cmd.Flags().Lookup(cliflags.FlagFlag)) if err != nil { return nil, err } - cmd.Flags().String("projKey", "", "Project key") - err = cmd.MarkFlagRequired("projKey") + cmd.Flags().String(cliflags.ProjectFlag, "", "Project key") + err = cmd.MarkFlagRequired(cliflags.ProjectFlag) if err != nil { return nil, err } - err = viper.BindPFlag("projKey", cmd.Flags().Lookup("projKey")) + err = viper.BindPFlag(cliflags.ProjectFlag, cmd.Flags().Lookup(cliflags.ProjectFlag)) if err != nil { return nil, err } @@ -67,7 +67,7 @@ func runUpdate(client flags.Client) func(*cobra.Command, []string) error { return func(cmd *cobra.Command, args []string) error { // rebind flags used in other subcommands _ = viper.BindPFlag("data", cmd.Flags().Lookup("data")) - _ = viper.BindPFlag("projKey", cmd.Flags().Lookup("projKey")) + _ = viper.BindPFlag(cliflags.ProjectFlag, cmd.Flags().Lookup(cliflags.ProjectFlag)) var patch []ldapi.PatchOperation err := json.Unmarshal([]byte(viper.GetString("data")), &patch) @@ -79,8 +79,8 @@ func runUpdate(client flags.Client) func(*cobra.Command, []string) error { context.Background(), viper.GetString(cliflags.APITokenFlag), viper.GetString(cliflags.BaseURIFlag), - viper.GetString("key"), - viper.GetString("projKey"), + viper.GetString(cliflags.FlagFlag), + viper.GetString(cliflags.ProjectFlag), patch, ) if err != nil { diff --git a/cmd/flags/update_test.go b/cmd/flags/update_test.go index 1647640f..a1e5a36f 100644 --- a/cmd/flags/update_test.go +++ b/cmd/flags/update_test.go @@ -37,8 +37,8 @@ func TestUpdate(t *testing.T) { "--api-token", "testAccessToken", "--base-uri", "http://test.com", "-d", `[{"op": "replace", "path": "/name", "value": "new-name"}]`, - "--key", "test-key", - "--projKey", "test-proj-key", + "--flag", "test-key", + "--project", "test-proj-key", } output, err := cmd.CallCmd(t, &client, nil, nil, args) @@ -57,8 +57,8 @@ func TestUpdate(t *testing.T) { "--api-token", "testAccessToken", "--base-uri", "http://test.com", "-d", `[{"op": "replace", "path": "/name", "value": "new-name"}]`, - "--key", "test-key", - "--projKey", "test-proj-key", + "--flag", "test-key", + "--project", "test-proj-key", } _, err := cmd.CallCmd(t, &client, nil, nil, args) @@ -73,7 +73,7 @@ func TestUpdate(t *testing.T) { _, err := cmd.CallCmd(t, &flags.MockClient{}, nil, nil, args) - assert.EqualError(t, err, `required flag(s) "api-token", "data", "key", "projKey" not set`+errorHelp) + assert.EqualError(t, err, `required flag(s) "api-token", "data", "flag", "project" not set`+errorHelp) }) t.Run("with invalid base-uri is an error", func(t *testing.T) { @@ -82,7 +82,7 @@ func TestUpdate(t *testing.T) { "--api-token", "testAccessToken", "--base-uri", "invalid", "-d", `{"key": "test-key", "name": "test-name"}`, - "--projKey", "test-proj-key", + "--project", "test-proj-key", } _, err := cmd.CallCmd(t, &flags.MockClient{}, nil, nil, args)