cli/pkg/cmd/variable/list/list_test.go
2023-03-13 03:41:55 +00:00

279 lines
6.7 KiB
Go

package list
import (
"bytes"
"fmt"
"io"
"net/http"
"strings"
"testing"
"time"
"github.com/cli/cli/v2/internal/config"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmd/variable/shared"
"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 Test_NewCmdList(t *testing.T) {
tests := []struct {
name string
cli string
wants ListOptions
}{
{
name: "repo",
cli: "",
wants: ListOptions{
OrgName: "",
},
},
{
name: "org",
cli: "-oUmbrellaCorporation",
wants: ListOptions{
OrgName: "UmbrellaCorporation",
},
},
{
name: "env",
cli: "-eDevelopment",
wants: ListOptions{
EnvName: "Development",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
ios, _, _, _ := iostreams.Test()
f := &cmdutil.Factory{
IOStreams: ios,
}
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()
assert.NoError(t, err)
assert.Equal(t, tt.wants.OrgName, gotOpts.OrgName)
assert.Equal(t, tt.wants.EnvName, gotOpts.EnvName)
})
}
}
func Test_listRun(t *testing.T) {
tests := []struct {
name string
tty bool
opts *ListOptions
wantOut []string
}{
{
name: "repo tty",
tty: true,
opts: &ListOptions{},
wantOut: []string{
"NAME VALUE UPDATED AT",
"VARIABLE_ONE one Updated 1988-10-11",
"VARIABLE_TWO two Updated 2020-12-04",
"VARIABLE_THREE three Updated 1975-11-30",
},
},
{
name: "repo not tty",
tty: false,
opts: &ListOptions{},
wantOut: []string{
"VARIABLE_ONE\tone\t1988-10-11",
"VARIABLE_TWO\ttwo\t2020-12-04",
"VARIABLE_THREE\tthree\t1975-11-30",
},
},
{
name: "org tty",
tty: true,
opts: &ListOptions{
OrgName: "UmbrellaCorporation",
},
wantOut: []string{
"NAME VALUE UPDATED AT VISIBILITY",
"VARIABLE_ONE org_one Updated 1988-10-11 Visible to all repositories",
"VARIABLE_TWO org_two Updated 2020-12-04 Visible to private repositories",
"VARIABLE_THREE org_three Updated 1975-11-30 Visible to 2 selected reposito...",
},
},
{
name: "org not tty",
tty: false,
opts: &ListOptions{
OrgName: "UmbrellaCorporation",
},
wantOut: []string{
"VARIABLE_ONE\torg_one\t1988-10-11\tALL",
"VARIABLE_TWO\torg_two\t2020-12-04\tPRIVATE",
"VARIABLE_THREE\torg_three\t1975-11-30\tSELECTED",
},
},
{
name: "env tty",
tty: true,
opts: &ListOptions{
EnvName: "Development",
},
wantOut: []string{
"NAME VALUE UPDATED AT",
"VARIABLE_ONE one Updated 1988-10-11",
"VARIABLE_TWO two Updated 2020-12-04",
"VARIABLE_THREE three Updated 1975-11-30",
},
},
{
name: "env not tty",
tty: false,
opts: &ListOptions{
EnvName: "Development",
},
wantOut: []string{
"VARIABLE_ONE\tone\t1988-10-11",
"VARIABLE_TWO\ttwo\t2020-12-04",
"VARIABLE_THREE\tthree\t1975-11-30",
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
reg := &httpmock.Registry{}
path := "repos/owner/repo/actions/variables"
if tt.opts.EnvName != "" {
path = fmt.Sprintf("repositories/owner/repo/environments/%s/variables", tt.opts.EnvName)
}
t0, _ := time.Parse("2006-01-02", "1988-10-11")
t1, _ := time.Parse("2006-01-02", "2020-12-04")
t2, _ := time.Parse("2006-01-02", "1975-11-30")
payload := variablesPayload{}
payload.Variables = []*Variable{
{
Name: "VARIABLE_ONE",
Value: "one",
UpdatedAt: t0,
},
{
Name: "VARIABLE_TWO",
Value: "two",
UpdatedAt: t1,
},
{
Name: "VARIABLE_THREE",
Value: "three",
UpdatedAt: t2,
},
}
if tt.opts.OrgName != "" {
payload.Variables = []*Variable{
{
Name: "VARIABLE_ONE",
Value: "org_one",
UpdatedAt: t0,
Visibility: shared.All,
},
{
Name: "VARIABLE_TWO",
Value: "org_two",
UpdatedAt: t1,
Visibility: shared.Private,
},
{
Name: "VARIABLE_THREE",
Value: "org_three",
UpdatedAt: t2,
Visibility: shared.Selected,
SelectedReposURL: fmt.Sprintf("https://api.github.com/orgs/%s/actions/variables/VARIABLE_THREE/repositories", tt.opts.OrgName),
},
}
path = fmt.Sprintf("orgs/%s/actions/variables", tt.opts.OrgName)
if tt.tty {
reg.Register(
httpmock.REST("GET", fmt.Sprintf("orgs/%s/actions/variables/VARIABLE_THREE/repositories", tt.opts.OrgName)),
httpmock.JSONResponse(struct {
TotalCount int `json:"total_count"`
}{2}))
}
}
reg.Register(httpmock.REST("GET", path), httpmock.JSONResponse(payload))
ios, _, stdout, _ := iostreams.Test()
ios.SetStdoutTTY(tt.tty)
tt.opts.IO = ios
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
return ghrepo.FromFullName("owner/repo")
}
tt.opts.HttpClient = func() (*http.Client, error) {
return &http.Client{Transport: reg}, nil
}
tt.opts.Config = func() (config.Config, error) {
return config.NewBlankConfig(), nil
}
err := listRun(tt.opts)
assert.NoError(t, err)
reg.Verify(t)
outputLines := strings.Split(stdout.String(), "\n")
for i, l := range tt.wantOut {
assert.Equal(t, outputLines[i], l)
}
})
}
}
func Test_getVariables_pagination(t *testing.T) {
var requests []*http.Request
var client testClient = func(req *http.Request) (*http.Response, error) {
header := make(map[string][]string)
if len(requests) == 0 {
header["Link"] = []string{`<http://example.com/page/0>; rel="previous", <http://example.com/page/2>; rel="next"`}
}
requests = append(requests, req)
return &http.Response{
Request: req,
Body: io.NopCloser(strings.NewReader(`{"variables":[{},{}]}`)),
Header: header,
}, nil
}
variables, err := getVariables(client, "github.com", "path/to")
assert.NoError(t, err)
assert.Equal(t, 2, len(requests))
assert.Equal(t, 4, len(variables))
assert.Equal(t, "https://api.github.com/path/to?per_page=100", requests[0].URL.String())
assert.Equal(t, "http://example.com/page/2", requests[1].URL.String())
}
type testClient func(*http.Request) (*http.Response, error)
func (c testClient) Do(req *http.Request) (*http.Response, error) {
return c(req)
}