Skip to content
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

Return empty array when using --json flag for list commands #736

Merged
merged 4 commits into from
Apr 13, 2023
+148 −65
Merged

Return empty array when using --json flag for list commands #736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2875a4a
Return empty array when using --json flag for list commands
sergiught Apr 13, 2023
c215a53
Add unit test for results display
sergiught Apr 13, 2023
baee9e5
Fix test
sergiught Apr 13, 2023
1f88eb4
Merge branch 'main' into patch/empty-json-flag
willvedd Apr 13, 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
3 changes: 3 additions & 0 deletions internal/display/display.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ func (r *Renderer) JSONResult(data interface{}) {

func (r *Renderer) Results(data []View) {
if len(data) == 0 {
if r.Format == OutputFormatJSON {
r.JSONResult([]interface{}{})
}
return
}

Expand Down
114 changes: 57 additions & 57 deletions internal/display/display_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,10 @@ package display
import (
"bytes"
"io"
"sync"
"testing"
"time"

"github.com/auth0/go-auth0/management"
"github.com/stretchr/testify/assert"

"github.com/auth0/auth0-cli/internal/auth0"
)

func TestTimeAgo(t *testing.T) {
Expand Down Expand Up @@ -44,68 +40,72 @@ func TestTimeAgo(t *testing.T) {
}
}

func TestStream(t *testing.T) {
func TestIndent(t *testing.T) {
assert.Equal(t, "foo", indent("foo", ""))
assert.Equal(t, " foo", indent("foo", " "))
assert.Equal(t, " line1\n line2\n line3", indent("line1\nline2\nline3", " "))
}

func TestRenderer_Results(t *testing.T) {
var stdout bytes.Buffer
mockRender := &Renderer{
MessageWriter: io.Discard,
ResultWriter: &stdout,
}

results := []View{
&logView{
Log: &management.Log{
LogID: auth0.String("354234"),
Type: auth0.String("sapi"),
Description: auth0.String("Update branding settings"),
var testCases = []struct {
name string
givenData []View
givenFormat string
expectedResults string
}{
{
name: "it can correctly output members as a table",
givenData: []View{
&membersView{
ID: "123",
Name: "John",
Email: "[email protected]",
},
},
expectedResults: " ID NAME EMAIL PICTURE \n 123 John [email protected] \n",
},
}

t.Run("Stream correctly handles nil channel", func(t *testing.T) {
mockRender.Stream(results, nil)
expectedResult := `TYPE DESCRIPTION DATE CONNECTION CLIENT
API Operation Update branding settings Jan 01 00:00:00.000 N/A N/A
`
assert.Equal(t, expectedResult, stdout.String())
stdout.Reset()
})

t.Run("Stream successfully", func(t *testing.T) {
viewChan := make(chan View)

var wg sync.WaitGroup
wg.Add(1)
go func() {
defer wg.Done()
mockRender.Stream(results, viewChan)
}()

wg.Add(1)
go func() {
defer wg.Done()
viewChan <- &logView{
Log: &management.Log{
LogID: auth0.String("354236"),
Type: auth0.String("sapi"),
Description: auth0.String("Update tenant settings"),
{
name: "it can correctly output members as json",
givenData: []View{
&membersView{
ID: "123",
Name: "John",
Email: "[email protected]",
raw: struct {
ID string
Name string
Email string
}{
ID: "123",
Name: "John",
Email: "[email protected]",
},
},
}
close(viewChan)
}()

wg.Wait()
},
givenFormat: string(OutputFormatJSON),
expectedResults: "[\n {\n \"ID\": \"123\",\n \"Name\": \"John\",\n \"Email\": \"[email protected]\"\n }\n]",
},
{
name: "it can correctly output an empty json array when no data",
givenData: []View{},
givenFormat: string(OutputFormatJSON),
expectedResults: "[]",
},
}

expectedResult := `TYPE DESCRIPTION DATE CONNECTION CLIENT
API Operation Update branding settings Jan 01 00:00:00.000 N/A N/A
API Operation Update tenant settings Jan 01 00:00:00.000 N/A N/A
`
assert.Equal(t, expectedResult, stdout.String())
stdout.Reset()
})
}
for _, testCase := range testCases {
t.Run(testCase.name, func(t *testing.T) {
mockRender.Format = OutputFormat(testCase.givenFormat)
mockRender.Results(testCase.givenData)

func TestIndent(t *testing.T) {
assert.Equal(t, "foo", indent("foo", ""))
assert.Equal(t, " foo", indent("foo", " "))
assert.Equal(t, " line1\n line2\n line3", indent("line1\nline2\nline3", " "))
assert.Equal(t, testCase.expectedResults, stdout.String())
stdout.Reset()
})
}
}
73 changes: 73 additions & 0 deletions internal/display/logs_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
package display

import (
"bytes"
"io"
"sync"
"testing"

"github.com/auth0/go-auth0/management"
"github.com/stretchr/testify/assert"

"github.com/auth0/auth0-cli/internal/auth0"
)

func TestStream(t *testing.T) {
var stdout bytes.Buffer
mockRender := &Renderer{
MessageWriter: io.Discard,
ResultWriter: &stdout,
}

results := []View{
&logView{
Log: &management.Log{
LogID: auth0.String("354234"),
Type: auth0.String("sapi"),
Description: auth0.String("Update branding settings"),
},
},
}

t.Run("Stream correctly handles nil channel", func(t *testing.T) {
mockRender.Stream(results, nil)
expectedResult := `TYPE DESCRIPTION DATE CONNECTION CLIENT
API Operation Update branding settings Jan 01 00:00:00.000 N/A N/A
`
assert.Equal(t, expectedResult, stdout.String())
stdout.Reset()
})

t.Run("Stream successfully", func(t *testing.T) {
viewChan := make(chan View)

var wg sync.WaitGroup
wg.Add(1)
go func() {
defer wg.Done()
mockRender.Stream(results, viewChan)
}()

wg.Add(1)
go func() {
defer wg.Done()
viewChan <- &logView{
Log: &management.Log{
LogID: auth0.String("354236"),
Type: auth0.String("sapi"),
Description: auth0.String("Update tenant settings"),
},
}
close(viewChan)
}()

wg.Wait()

expectedResult := `TYPE DESCRIPTION DATE CONNECTION CLIENT
API Operation Update branding settings Jan 01 00:00:00.000 N/A N/A
API Operation Update tenant settings Jan 01 00:00:00.000 N/A N/A
`
assert.Equal(t, expectedResult, stdout.String())
stdout.Reset()
})
}
23 changes: 15 additions & 8 deletions test/integration/organizations-test-cases.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,18 @@ tests:
- "Open the following URL in a browser: https://manage.auth0.com/dashboard/"
- "/organizations/org_"

013 - add organization members:
013 - list organization members should return an empty array if no members found:
command: auth0 orgs members list $(./test/integration/scripts/get-org-id.sh) --json
exit-code: 0
stdout:
contains:
- "[]"

014 - add organization members:
command: auth0 api POST "organizations/$(./test/integration/scripts/get-org-id.sh)/members" --data "{\"members\":[\"$(./test/integration/scripts/get-user-id.sh)\"]}"
exit-code: 0

014 - list organization members:
015 - list organization members:
command: auth0 orgs members list $(./test/integration/scripts/get-org-id.sh)
exit-code: 0
stdout:
Expand All @@ -123,7 +130,7 @@ tests:
config:
retries: 3

015 - list organization members as json:
016 - list organization members as json:
command: auth0 orgs members list $(./test/integration/scripts/get-org-id.sh) --json
exit-code: 0
stdout:
Expand All @@ -133,7 +140,7 @@ tests:
config:
retries: 3

016 - list organization members with invalid number:
017 - list organization members with invalid number:
command: auth0 orgs members list $(./test/integration/scripts/get-org-id.sh) --number 1001
exit-code: 1
stderr:
Expand All @@ -142,22 +149,22 @@ tests:
config:
retries: 3

017 - list organization roles:
018 - list organization roles:
command: auth0 orgs roles list $(./test/integration/scripts/get-org-id.sh)
exit-code: 0

018 - list organization roles with invalid number:
019 - list organization roles with invalid number:
command: auth0 orgs roles list $(./test/integration/scripts/get-org-id.sh) --number 1001
exit-code: 1
stderr:
contains:
- number flag invalid, please pass a number between 1 and 1000

019 - list organization roles members:
020 - list organization roles members:
command: auth0 orgs roles members list $(./test/integration/scripts/get-org-id.sh)
exit-code: 0

020 - list organization roles members with invalid number:
021 - list organization roles members with invalid number:
command: auth0 orgs roles members list $(./test/integration/scripts/get-org-id.sh) --number 1001
exit-code: 1
stderr:
Expand Down