cli/pkg/cmd/org/list/list_test.go

package list

import (
	"bytes"
	"net/http"
	"testing"

	"github.com/MakeNowJust/heredoc"
	"github.com/cli/cli/v2/internal/config"
	"github.com/cli/cli/v2/internal/gh"
	"github.com/cli/cli/v2/pkg/cmdutil"
	"github.com/cli/cli/v2/pkg/httpmock"
	"github.com/cli/cli/v2/pkg/iostreams"
	"github.com/google/shlex"
	"github.com/stretchr/testify/assert"
)

func TestNewCmdList(t *testing.T) {
	tests := []struct {
		name     string
		cli      string
		wants    ListOptions
		wantsErr string
	}{
		{
			name: "no arguments",
			cli:  "",
			wants: ListOptions{
				Limit: 30,
			},
		},
		{
			name: "with limit",
			cli:  "-L 101",
			wants: ListOptions{
				Limit: 101,
			},
		},
		{
			name:     "too many arguments",
			cli:      "123 456",
			wantsErr: "accepts at most 1 arg(s), received 2",
		},
		{
			name:     "invalid limit",
			cli:      "-L 0",
			wantsErr: "invalid limit: 0",
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			f := &cmdutil.Factory{}

			argv, err := shlex.Split(tt.cli)
			assert.NoError(t, err)

			var gotOpts *ListOptions
			cmd := NewCmdList(f, func(opts *ListOptions) error {
				gotOpts = opts
				return nil
			})
			cmd.SetArgs(argv)
			cmd.SetIn(&bytes.Buffer{})
			cmd.SetOut(&bytes.Buffer{})
			cmd.SetErr(&bytes.Buffer{})

			_, err = cmd.ExecuteC()
			if tt.wantsErr != "" {
				assert.EqualError(t, err, tt.wantsErr)
				return
			}

			assert.NoError(t, err)
			assert.Equal(t, tt.wants.Limit, gotOpts.Limit)
		})
	}
}

func TestListRun(t *testing.T) {
	tests := []struct {
		name    string
		opts    ListOptions
		isTTY   bool
		wantOut string
	}{
		{
			name: "no organizations found",
			opts: ListOptions{HttpClient: func() (*http.Client, error) {
				r := &httpmock.Registry{}

				r.Register(
					httpmock.GraphQL(`query UserCurrent\b`),
					httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))

				r.Register(
					httpmock.GraphQL(`query OrganizationList\b`),
					httpmock.StringResponse(`
						{ "data": { "user": {
							"organizations": { "nodes": [], "totalCount": 0 }
						} } }`,
					),
				)

				return &http.Client{Transport: r}, nil
			}},
			isTTY: true,
			wantOut: heredoc.Doc(`

There are no organizations associated with @octocat

`),
		},
		{
			name: "default behavior",
			opts: ListOptions{HttpClient: func() (*http.Client, error) {
				r := &httpmock.Registry{}

				r.Register(
					httpmock.GraphQL(`query UserCurrent\b`),
					httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))

				r.Register(
					httpmock.GraphQL(`query OrganizationList\b`),
					httpmock.StringResponse(`
						{ "data": { "user": {	"organizations": {
							"totalCount": 2,
							"nodes": [
							{
								"login": "github"
							},
							{
								"login": "cli"
							}
						]	}	} } }`,
					),
				)

				return &http.Client{Transport: r}, nil
			}},
			isTTY: true,
			wantOut: heredoc.Doc(`

Showing 2 of 2 organizations

github
cli
`),
		},
		{
			name: "with limit",
			opts: ListOptions{Limit: 1, HttpClient: func() (*http.Client, error) {
				r := &httpmock.Registry{}

				r.Register(
					httpmock.GraphQL(`query UserCurrent\b`),
					httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))

				r.Register(
					httpmock.GraphQL(`query OrganizationList\b`),
					httpmock.StringResponse(`
						{ "data": { "user": {	"organizations": {
							"totalCount": 2,
							"nodes": [
							{
								"login": "github"
							},
							{
								"login": "cli"
							}
						]	}	} } }`,
					),
				)

				return &http.Client{Transport: r}, nil
			}},
			isTTY: true,
			wantOut: heredoc.Doc(`

Showing 1 of 2 organizations

github
`),
		},
		{
			name: "nontty output",
			opts: ListOptions{HttpClient: func() (*http.Client, error) {
				r := &httpmock.Registry{}

				r.Register(
					httpmock.GraphQL(`query UserCurrent\b`),
					httpmock.StringResponse(`{"data": {"viewer": {"login": "octocat"}}}`))

				r.Register(
					httpmock.GraphQL(`query OrganizationList\b`),
					httpmock.StringResponse(`
						{ "data": { "user": {	"organizations": {
							"totalCount": 2,
							"nodes": [
							{
								"login": "github"
							},
							{
								"login": "cli"
							}
						]	}	} } }`,
					),
				)
				return &http.Client{Transport: r}, nil
			}},
			isTTY: false,
			wantOut: heredoc.Doc(`
github
cli
`),
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			ios, _, stdout, _ := iostreams.Test()

			ios.SetStdoutTTY(tt.isTTY)
			ios.SetStdinTTY(tt.isTTY)
			ios.SetStderrTTY(tt.isTTY)

			tt.opts.IO = ios
			tt.opts.Config = func() (gh.Config, error) {
				return config.NewBlankConfig(), nil
			}

			err := listRun(&tt.opts)

			assert.NoError(t, err)
			assert.Equal(t, tt.wantOut, stdout.String())
		})
	}
}