8000 feat: add JSON output format to many CLI commands by deansheather · Pull Request #6082 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

feat: add JSON output format to many CLI commands #6082

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
merged 8 commits into from
Feb 8, 2023
Merged

feat: add JSON output format to many CLI commands #6082

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
457cd51
chore: make output formatting generic
deansheather Feb 7, 2023
e33bde8
feat: add JSON output format to many CLI commands
deansheather Feb 7, 2023
1ad2a4c
fixup! feat: add JSON output format to many CLI commands
deansheather Feb 7, 2023
1ced0ce
chore: add more output format tests
deansheather Feb 7, 2023
54b0a94
fixup! chore: add more output format tests
deansheather Feb 8, 2023
3eb6813
chore: add golden files for json commands
deansheather Feb 8, 2023
92a125e
Merge branch 'main' into dean/output-formats
deansheather Feb 8, 2023
ec4a432
fixup! Merge branch 'main' into dean/output-formats
deansheather Feb 8, 2023
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
Prev Previous commit
Next Next commit
fixup! chore: add more output format tests
  • Loading branch information
@deansheather
deansheather committed Feb 8, 2023
commit 54b0a9483017c735810f32aebb18d432af1bb759
5 changes: 4 additions & 1 deletion cli/list_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,12 @@ func TestList(t *testing.T) {
cmd, root := clitest.New(t, "list", "--output=json")
clitest.SetupConfig(t, client, root)

ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancelFunc()

out := bytes.NewBuffer(nil)
cmd.SetOut(out)
err := cmd.Execute()
err := cmd.ExecuteContext(ctx)
require.NoError(t, err)

var templates []codersdk.Workspace
Expand Down
17 changes: 14 additions & 3 deletions cli/templatelist_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cli_test

import (
"bytes"
"context"
"encoding/json"
"sort"
"testing"
Expand All @@ -12,6 +13,7 @@ import (
"github.com/coder/coder/coderd/coderdtest"
"github.com/coder/coder/codersdk"
"github.com/coder/coder/pty/ptytest"
"github.com/coder/coder/testutil"
)

func TestTemplateList(t *testing.T) {
Expand All @@ -35,9 +37,12 @@ func TestTemplateList(t *testing.T) {
cmd.SetIn(pty.Input())
cmd.SetOut(pty.Output())

ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancelFunc()

errC := make(chan error)
go func() {
errC <- cmd.Execute()
errC <- cmd.ExecuteContext(ctx)
}()

// expect that templates are listed alphabetically
Expand Down Expand Up @@ -65,9 +70,12 @@ func TestTemplateList(t *testing.T) {
cmd, root := clitest.New(t, "templates", "list", "--output=json")
clitest.SetupConfig(t, client, root)

ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancelFunc()

out := bytes.NewBuffer(nil)
cmd.SetOut(out)
err := cmd.Execute()
err := cmd.ExecuteContext(ctx)
require.NoError(t, err)

var templates []codersdk.Template
Expand All @@ -86,9 +94,12 @@ func TestTemplateList(t *testing.T) {
cmd.SetIn(pty.Input())
cmd.SetErr(pty.Output())

ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancelFunc()

errC := make(chan error)
go func() {
errC <- cmd.Execute()
errC <- cmd.ExecuteContext(ctx)
}()

require.NoError(t, <-errC)
Expand Down
15 changes: 10 additions & 5 deletions cli/tokens_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cli_test

import (
"bytes"
"context"
"encoding/json"
"regexp"
"testing"
Expand All @@ -11,19 +12,23 @@ import (
"github.com/coder/coder/cli/clitest"
"github.com/coder/coder/coderd/coderdtest"
"github.com/coder/coder/codersdk"
"github.com/coder/coder/testutil"
)

func TestTokens(t *testing.T) {
t.Parallel()
client := coderdtest.New(t, nil)
_ = coderdtest.CreateFirstUser(t, client)

ctx, cancelFunc := context.WithTimeout(context.Background(), testutil.WaitLong)
defer cancelFunc()

// helpful empty response
cmd, root := clitest.New(t, "tokens", "ls")
clitest.SetupConfig(t, client, root)
buf := new(bytes.Buffer)
cmd.SetOut(buf)
err := cmd.Execute()
err := cmd.ExecuteContext(ctx)
require.NoError(t, err)
res := buf.String()
require.Contains(t, res, "tokens found")
Expand All @@ -32,7 +37,7 @@ func TestTokens(t *testing.T) {
clitest.SetupConfig(t, client, root)
buf = new(bytes.Buffer)
cmd.SetOut(buf)
err = cmd.Execute()
err = cmd.ExecuteContext(ctx)
require.NoError(t, err)
res = buf.String()
require.NotEmpty(t, res)
Expand All @@ -46,7 +51,7 @@ func TestTokens(t *testing.T) {
clitest.SetupConfig(t, client, root)
buf = new(bytes.Buffer)
cmd.SetOut(buf)
err = cmd.Execute()
err = cmd.ExecuteContext(ctx)
require.NoError(t, err)
res = buf.String()
require.NotEmpty(t, res)
Expand All @@ -60,7 +65,7 @@ func TestTokens(t *testing.T) {
clitest.SetupConfig(t, client, root)
buf = new(bytes.Buffer)
cmd.SetOut(buf)
err = cmd.Execute()
err = cmd.ExecuteContext(ctx)
require.NoError(t, err)

var tokens []codersdk.APIKey
Expand All @@ -72,7 +77,7 @@ func TestTokens(t *testing.T) {
clitest.SetupConfig(t, client, root)
buf = new(bytes.Buffer)
cmd.SetOut(buf)
err = cmd.Execute()
err = cmd.ExecuteContext(ctx)
require.NoError(t, err)
res = buf.String()
require.NotEmpty(t, res)
Expand Down
0