Skip to content

feat: output flag errors #204

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

Merged
dbolson merged 10 commits into from
Apr 24, 2024
Merged

feat: output flag errors #204

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7fc4a54
Add plain text error handling
Apr 23, 2024
313bf1f
Output flag errors as plain text or JSON
Apr 24, 2024
83745de
Remove unused code
Apr 24, 2024
d41e2c1
Update all commands to return plaintext or JSON
Apr 24, 2024
526bbec
Refactor outputter
Apr 24, 2024
f8de751
Backfill tests
Apr 24, 2024
614b6f0
Reorganize
Apr 24, 2024
1764f0e
Refactor
Apr 24, 2024
d6b08f2
Remove comments
Apr 24, 2024
62d1f66
Renamed functions
Apr 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions cmd/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,10 @@ func run() func(*cobra.Command, []string) error {
return err
}

output, err := output.CmdOutput(
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
output.NewConfigOutput(configJSON),
configJSON,
output.ConfigPlaintextOutputFn,
)
if err != nil {
return err
Expand Down
19 changes: 15 additions & 4 deletions cmd/environments/get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (
"ldcli/cmd/cliflags"
"ldcli/cmd/validators"
"ldcli/internal/environments"
"ldcli/internal/errors"
"ldcli/internal/output"
)

Expand Down Expand Up @@ -63,15 +64,25 @@ func runGet(
viper.GetString(cliflags.ProjectFlag),
)
if err != nil {
return err
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
[]byte(err.Error()),
output.ErrorPlaintextOutputFn,
)
if err != nil {
return errors.NewError(err.Error())
}

return errors.NewError(output)
}

output, err := output.CmdOutput(
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
output.NewSingularOutput(response),
response,
output.SingularPlaintextOutputFn,
)
if err != nil {
return err
return errors.NewError(err.Error())
}

fmt.Fprintf(cmd.OutOrStdout(), output+"\n")
Expand Down
3 changes: 1 addition & 2 deletions cmd/environments/get_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,15 +72,14 @@ func TestGet(t *testing.T) {
client := environments.MockClient{}
client.
On("Get", mockArgs...).
Return([]byte(`{}`), errors.NewError("An error"))
Return([]byte(`{}`), errors.NewError(`{"message": "An error"}`))
clients := cmd.APIClients{
EnvironmentsClient: &client,
}
args := []string{
"environments", "get",
"--access-token", "testAccessToken",
"--base-uri", "http://test.com",
"--output", "json",
"--environment", "test-env",
"--project", "test-proj",
}
Expand Down
23 changes: 15 additions & 8 deletions cmd/flags/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (

"ldcli/cmd/cliflags"
"ldcli/cmd/validators"
"ldcli/internal/errors"
"ldcli/internal/flags"
"ldcli/internal/output"
)
Expand Down Expand Up @@ -53,10 +54,6 @@ type inputData struct {

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(cliflags.DataFlag, cmd.Flags().Lookup(cliflags.DataFlag))
_ = viper.BindPFlag(cliflags.ProjectFlag, cmd.Flags().Lookup(cliflags.ProjectFlag))

var data inputData
err := json.Unmarshal([]byte(viper.GetString(cliflags.DataFlag)), &data)
if err != nil {
Expand All @@ -72,15 +69,25 @@ func runCreate(client flags.Client) func(*cobra.Command, []string) error {
viper.GetString(cliflags.ProjectFlag),
)
if err != nil {
return err
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
[]byte(err.Error()),
output.ErrorPlaintextOutputFn,
)
if err != nil {
return errors.NewError(err.Error())
}

return errors.NewError(output)
}

output, err := output.CmdOutput(
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
output.NewSingularOutput(response),
response,
output.SingularPlaintextOutputFn,
)
if err != nil {
return err
return errors.NewError(err.Error())
}

fmt.Fprintf(cmd.OutOrStdout(), output+"\n")
Expand Down
2 changes: 1 addition & 1 deletion cmd/flags/create_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ func TestCreate(t *testing.T) {
client := flags.MockClient{}
client.
On("Create", mockArgs...).
Return([]byte(`{}`), errors.NewError("An error"))
Return([]byte(`{}`), errors.NewError(`{"message": "An error"}`))
clients := cmd.APIClients{
FlagsClient: &client,
}
Expand Down
24 changes: 15 additions & 9 deletions cmd/flags/get.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

"ldcli/cmd/cliflags"
"ldcli/cmd/validators"
"ldcli/internal/errors"
"ldcli/internal/flags"
"ldcli/internal/output"
)
Expand Down Expand Up @@ -57,11 +58,6 @@ func NewGetCmd(client flags.Client) (*cobra.Command, error) {

func runGet(client flags.Client) func(*cobra.Command, []string) error {
return func(cmd *cobra.Command, args []string) error {
// rebind flags used in other subcommands
Copy link
Copy Markdown
Contributor Author

@dbolson dbolson Apr 24, 2024

Choose a reason for hiding this comment

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

Turns out we don't need to do this. It will be easier to remove these with the generated commands since they'll only be written once.

_ = viper.BindPFlag(cliflags.FlagFlag, cmd.Flags().Lookup(cliflags.FlagFlag))
_ = viper.BindPFlag(cliflags.ProjectFlag, cmd.Flags().Lookup(cliflags.ProjectFlag))
_ = viper.BindPFlag(cliflags.EnvironmentFlag, cmd.Flags().Lookup(cliflags.EnvironmentFlag))

response, err := client.Get(
context.Background(),
viper.GetString(cliflags.AccessTokenFlag),
Expand All @@ -71,15 +67,25 @@ func runGet(client flags.Client) func(*cobra.Command, []string) error {
viper.GetString(cliflags.EnvironmentFlag),
)
if err != nil {
return err
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
[]byte(err.Error()),
output.ErrorPlaintextOutputFn,
)
if err != nil {
return errors.NewError(err.Error())
}

return errors.NewError(output)
}

output, err := output.CmdOutput(
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
output.NewSingularOutput(response),
response,
output.SingularPlaintextOutputFn,
)
if err != nil {
return err
return errors.NewError(err.Error())
}

fmt.Fprintf(cmd.OutOrStdout(), output+"\n")
Expand Down
3 changes: 1 addition & 2 deletions cmd/flags/get_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,15 +73,14 @@ func TestGet(t *testing.T) {
client := flags.MockClient{}
client.
On("Get", mockArgs...).
Return([]byte(`{}`), errors.NewError("An error"))
Return([]byte(`{}`), errors.NewError(`{"message": "An error"}`))
clients := cmd.APIClients{
FlagsClient: &client,
}
args := []string{
"flags", "get",
"--access-token", "testAccessToken",
"--base-uri", "http://test.com",
"--output", "json",
"--flag", "test-key",
"--project", "test-proj-key",
"--environment", "test-env-key",
Expand Down
24 changes: 15 additions & 9 deletions cmd/flags/update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (

"ldcli/cmd/cliflags"
"ldcli/cmd/validators"
"ldcli/internal/errors"
"ldcli/internal/flags"
"ldcli/internal/output"
)
Expand Down Expand Up @@ -116,11 +117,6 @@ func setToggleCommandFlags(cmd *cobra.Command) (*cobra.Command, error) {

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(cliflags.DataFlag, cmd.Flags().Lookup(cliflags.DataFlag))
_ = viper.BindPFlag(cliflags.ProjectFlag, cmd.Flags().Lookup(cliflags.ProjectFlag))
_ = viper.BindPFlag(cliflags.FlagFlag, cmd.Flags().Lookup(cliflags.FlagFlag))

var patch []flags.UpdateInput
if cmd.CalledAs() == "toggle-on" || cmd.CalledAs() == "toggle-off" {
_ = viper.BindPFlag(cliflags.EnvironmentFlag, cmd.Flags().Lookup(cliflags.EnvironmentFlag))
Expand All @@ -142,15 +138,25 @@ func runUpdate(client flags.Client) func(*cobra.Command, []string) error {
patch,
)
if err != nil {
return err
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
[]byte(err.Error()),
output.ErrorPlaintextOutputFn,
)
if err != nil {
return errors.NewError(err.Error())
}

return errors.NewError(output)
}

output, err := output.CmdOutput(
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
output.NewSingularOutput(response),
response,
output.SingularPlaintextOutputFn,
)
if err != nil {
return err
return errors.NewError(err.Error())
}

fmt.Fprintf(cmd.OutOrStdout(), output+"\n")
Expand Down
4 changes: 2 additions & 2 deletions cmd/flags/update_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func TestUpdate(t *testing.T) {
client := flags.MockClient{}
client.
On("Update", mockArgs...).
Return([]byte(`{}`), errors.NewError("An error"))
Return([]byte(`{}`), errors.NewError(`{"message": "An error"}`))
clients := cmd.APIClients{
FlagsClient: &client,
}
Expand Down Expand Up @@ -207,7 +207,7 @@ func TestToggle(t *testing.T) {
client := flags.MockClient{}
client.
On("Update", mockArgs...).
Return([]byte(`{}`), errors.NewError("An error"))
Return([]byte(`{}`), errors.NewError(`{"message": "An error"}`))
clients := cmd.APIClients{
FlagsClient: &client,
}
Expand Down
21 changes: 16 additions & 5 deletions cmd/members/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import (

"ldcli/cmd/cliflags"
"ldcli/cmd/validators"
"ldcli/internal/errors"
"ldcli/internal/members"
"ldcli/internal/output"
)
Expand Down Expand Up @@ -42,7 +43,7 @@ func runCreate(client members.Client) func(*cobra.Command, []string) error {
// TODO: why does viper.GetString(cliflags.DataFlag) not work?
err := json.Unmarshal([]byte(cmd.Flags().Lookup(cliflags.DataFlag).Value.String()), &data)
if err != nil {
return err
return errors.NewError(err.Error())
}

response, err := client.Create(
Expand All @@ -52,15 +53,25 @@ func runCreate(client members.Client) func(*cobra.Command, []string) error {
data,
)
if err != nil {
return err
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
[]byte(err.Error()),
output.ErrorPlaintextOutputFn,
)
if err != nil {
return errors.NewError(err.Error())
}

return errors.NewError(output)
}

output, err := output.CmdOutput(
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
output.NewSingularOutput(response),
response,
output.SingularPlaintextOutputFn,
)
if err != nil {
return err
return errors.NewError(err.Error())
}

fmt.Fprintf(cmd.OutOrStdout(), output+"\n")
Expand Down
2 changes: 1 addition & 1 deletion cmd/members/create_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ func TestCreate(t *testing.T) {
client := members.MockClient{}
client.
On("Create", mockArgs...).
Return([]byte(`{}`), errors.NewError("An error"))
Return([]byte(`{}`), errors.NewError(`{"message": "An error"}`))
clients := cmd.APIClients{
MembersClient: &client,
}
Expand Down
19 changes: 15 additions & 4 deletions cmd/members/invite.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (

"ldcli/cmd/cliflags"
"ldcli/cmd/validators"
"ldcli/internal/errors"
"ldcli/internal/members"
"ldcli/internal/output"
)
Expand Down Expand Up @@ -61,15 +62,25 @@ func runInvite(client members.Client) func(*cobra.Command, []string) error {
memberInputs,
)
if err != nil {
return err
output, err := output.CmdOutputSingular(
viper.GetString(cliflags.OutputFlag),
[]byte(err.Error()),
output.ErrorPlaintextOutputFn,
)
if err != nil {
return errors.NewError(err.Error())
}

return errors.NewError(output)
}

output, err := output.CmdOutput(
output, err := output.CmdOutputMultiple(
viper.GetString(cliflags.OutputFlag),
output.NewSingularOutput(response),
response,
output.MultipleEmailPlaintextOutputFn,
Copy link
Copy Markdown
Contributor Author

@dbolson dbolson Apr 24, 2024

Choose a reason for hiding this comment

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

Here's an example of a different function used because the response is

[
    {
        "email": ""
    }
]

which is different from a normal "list" type of response because

  1. it doesn't have "items" as a property
  2. it has "email" and "_id" instead of "name" and "key"

Copy link
Copy Markdown
Contributor

@k3llymariee k3llymariee Apr 24, 2024

Choose a reason for hiding this comment

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

fun times! can't wait to find more

)
if err != nil {
return err
return errors.NewError(err.Error())
}

fmt.Fprintf(cmd.OutOrStdout(), output+"\n")
Expand Down
3 changes: 1 addition & 2 deletions cmd/members/invite_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ func TestInvite(t *testing.T) {
client := members.MockClient{}
client.
On("Create", mockArgs...).
Return([]byte(`{}`), errors.NewError("An error"))
Return([]byte(`{}`), errors.NewError(`{"message": "An error"}`))
clients := cmd.APIClients{
MembersClient: &client,
}
Expand All @@ -86,7 +86,6 @@ func TestInvite(t *testing.T) {
"invite",
"--access-token", "testAccessToken",
"--base-uri", "http://test.com",
"--output", "json",
"-e", `testemail1@test.com,testemail2@test.com`,
}

Expand Down
Loading