462 lines
12 KiB
Go
462 lines
12 KiB
Go
package list
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"net/http"
|
|
"net/url"
|
|
"strings"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/cli/cli/v2/internal/config"
|
|
"github.com/cli/cli/v2/internal/gh"
|
|
"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"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestNewCmdList(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
|
|
jsonFields []string
|
|
wantOut []string
|
|
}{
|
|
{
|
|
name: "repo tty",
|
|
tty: true,
|
|
opts: &ListOptions{},
|
|
wantOut: []string{
|
|
"NAME VALUE UPDATED",
|
|
"VARIABLE_ONE one about 34 years ago",
|
|
"VARIABLE_TWO two about 2 years ago",
|
|
"VARIABLE_THREE three about 47 years ago",
|
|
},
|
|
},
|
|
{
|
|
name: "repo not tty",
|
|
tty: false,
|
|
opts: &ListOptions{},
|
|
wantOut: []string{
|
|
"VARIABLE_ONE\tone\t1988-10-11T00:00:00Z",
|
|
"VARIABLE_TWO\ttwo\t2020-12-04T00:00:00Z",
|
|
"VARIABLE_THREE\tthree\t1975-11-30T00:00:00Z",
|
|
},
|
|
},
|
|
{
|
|
name: "repo not tty, json",
|
|
tty: false,
|
|
opts: &ListOptions{},
|
|
jsonFields: []string{"name", "value"},
|
|
wantOut: []string{`[
|
|
{"name":"VARIABLE_ONE","value":"one"},
|
|
{"name":"VARIABLE_TWO","value":"two"},
|
|
{"name":"VARIABLE_THREE","value":"three"}
|
|
]`},
|
|
},
|
|
{
|
|
name: "org tty",
|
|
tty: true,
|
|
opts: &ListOptions{
|
|
OrgName: "UmbrellaCorporation",
|
|
},
|
|
wantOut: []string{
|
|
"NAME VALUE UPDATED VISIBILITY",
|
|
"VARIABLE_ONE org_one about 34 years ago Visible to all repositories",
|
|
"VARIABLE_TWO org_two about 2 years ago Visible to private repositories",
|
|
"VARIABLE_THREE org_three about 47 years ago Visible to 2 selected reposito...",
|
|
},
|
|
},
|
|
{
|
|
name: "org not tty",
|
|
tty: false,
|
|
opts: &ListOptions{
|
|
OrgName: "UmbrellaCorporation",
|
|
},
|
|
wantOut: []string{
|
|
"VARIABLE_ONE\torg_one\t1988-10-11T00:00:00Z\tALL",
|
|
"VARIABLE_TWO\torg_two\t2020-12-04T00:00:00Z\tPRIVATE",
|
|
"VARIABLE_THREE\torg_three\t1975-11-30T00:00:00Z\tSELECTED",
|
|
},
|
|
},
|
|
{
|
|
name: "org not tty, json",
|
|
tty: false,
|
|
opts: &ListOptions{
|
|
OrgName: "UmbrellaCorporation",
|
|
},
|
|
jsonFields: []string{"name", "value"},
|
|
wantOut: []string{`[
|
|
{"name":"VARIABLE_ONE","value":"org_one"},
|
|
{"name":"VARIABLE_TWO","value":"org_two"},
|
|
{"name":"VARIABLE_THREE","value":"org_three"}
|
|
]`},
|
|
},
|
|
{
|
|
name: "env tty",
|
|
tty: true,
|
|
opts: &ListOptions{
|
|
EnvName: "Development",
|
|
},
|
|
wantOut: []string{
|
|
"NAME VALUE UPDATED",
|
|
"VARIABLE_ONE one about 34 years ago",
|
|
"VARIABLE_TWO two about 2 years ago",
|
|
"VARIABLE_THREE three about 47 years ago",
|
|
},
|
|
},
|
|
{
|
|
name: "env not tty",
|
|
tty: false,
|
|
opts: &ListOptions{
|
|
EnvName: "Development",
|
|
},
|
|
wantOut: []string{
|
|
"VARIABLE_ONE\tone\t1988-10-11T00:00:00Z",
|
|
"VARIABLE_TWO\ttwo\t2020-12-04T00:00:00Z",
|
|
"VARIABLE_THREE\tthree\t1975-11-30T00:00:00Z",
|
|
},
|
|
},
|
|
{
|
|
name: "env not tty, json",
|
|
tty: false,
|
|
opts: &ListOptions{
|
|
EnvName: "Development",
|
|
},
|
|
jsonFields: []string{"name", "value"},
|
|
wantOut: []string{`[
|
|
{"name":"VARIABLE_ONE","value":"one"},
|
|
{"name":"VARIABLE_TWO","value":"two"},
|
|
{"name":"VARIABLE_THREE","value":"three"}
|
|
]`},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
reg := &httpmock.Registry{}
|
|
defer reg.Verify(t)
|
|
|
|
path := "repos/owner/repo/actions/variables"
|
|
if tt.opts.EnvName != "" {
|
|
path = fmt.Sprintf("repos/owner/repo/environments/%s/variables", tt.opts.EnvName)
|
|
} else if tt.opts.OrgName != "" {
|
|
path = fmt.Sprintf("orgs/%s/actions/variables", tt.opts.OrgName)
|
|
}
|
|
|
|
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 := struct {
|
|
Variables []shared.Variable
|
|
}{
|
|
Variables: []shared.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 = []shared.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),
|
|
},
|
|
}
|
|
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() (gh.Config, error) {
|
|
return config.NewBlankConfig(), nil
|
|
}
|
|
tt.opts.Now = func() time.Time {
|
|
t, _ := time.Parse(time.RFC822, "15 Mar 23 00:00 UTC")
|
|
return t
|
|
}
|
|
|
|
if tt.jsonFields != nil {
|
|
jsonExporter := cmdutil.NewJSONExporter()
|
|
jsonExporter.SetFields(tt.jsonFields)
|
|
tt.opts.Exporter = jsonExporter
|
|
}
|
|
|
|
err := listRun(tt.opts)
|
|
assert.NoError(t, err)
|
|
|
|
expected := fmt.Sprintf("%s\n", strings.Join(tt.wantOut, "\n"))
|
|
if tt.jsonFields != nil {
|
|
assert.JSONEq(t, expected, stdout.String())
|
|
} else {
|
|
assert.Equal(t, expected, stdout.String())
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
// Test_listRun_populatesNumSelectedReposIfRequired asserts that NumSelectedRepos
|
|
// field is populated **only** when it's going to be presented in the output. Since
|
|
// populating this field costs further API requests (one per variable), it's important
|
|
// to avoid extra calls when the output will not present the field's value. Note
|
|
// that NumSelectedRepos is only meant for organization variables.
|
|
//
|
|
// We should only populate the NumSelectedRepos field in these cases:
|
|
// 1. The command is run in the TTY mode without the `--json <fields>` option.
|
|
// 2. The command is run with `--json <fields>` option, and `numSelectedRepos`
|
|
// is among the selected fields. In this case, TTY mode is irrelevant.
|
|
func Test_listRun_populatesNumSelectedReposIfRequired(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
tty bool
|
|
jsonFields []string
|
|
wantPopulated bool
|
|
}{
|
|
{
|
|
name: "org tty",
|
|
tty: true,
|
|
wantPopulated: true,
|
|
},
|
|
{
|
|
name: "org tty, json with numSelectedRepos",
|
|
tty: true,
|
|
jsonFields: []string{"numSelectedRepos"},
|
|
wantPopulated: true,
|
|
},
|
|
{
|
|
name: "org tty, json without numSelectedRepos",
|
|
tty: true,
|
|
jsonFields: []string{"name"},
|
|
wantPopulated: false,
|
|
},
|
|
{
|
|
name: "org not tty",
|
|
tty: false,
|
|
wantPopulated: false,
|
|
},
|
|
{
|
|
name: "org not tty, json with numSelectedRepos",
|
|
tty: false,
|
|
jsonFields: []string{"numSelectedRepos"},
|
|
wantPopulated: true,
|
|
},
|
|
{
|
|
name: "org not tty, json without numSelectedRepos",
|
|
tty: false,
|
|
jsonFields: []string{"name"},
|
|
wantPopulated: false,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
reg := &httpmock.Registry{}
|
|
reg.Verify(t)
|
|
|
|
reg.Register(
|
|
httpmock.REST("GET", "orgs/umbrellaOrganization/actions/variables"),
|
|
httpmock.JSONResponse(struct{ Variables []shared.Variable }{
|
|
[]shared.Variable{
|
|
{
|
|
Name: "VARIABLE",
|
|
Visibility: shared.Selected,
|
|
SelectedReposURL: "https://api.github.com/orgs/umbrellaOrganization/actions/variables/VARIABLE/repositories",
|
|
},
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "orgs/umbrellaOrganization/actions/variables/VARIABLE/repositories"),
|
|
httpmock.JSONResponse(struct {
|
|
TotalCount int `json:"total_count"`
|
|
}{999}))
|
|
|
|
opts := &ListOptions{
|
|
OrgName: "umbrellaOrganization",
|
|
}
|
|
|
|
if tt.jsonFields != nil {
|
|
exporter := cmdutil.NewJSONExporter()
|
|
exporter.SetFields(tt.jsonFields)
|
|
opts.Exporter = exporter
|
|
}
|
|
|
|
ios, _, _, _ := iostreams.Test()
|
|
ios.SetStdoutTTY(tt.tty)
|
|
opts.IO = ios
|
|
|
|
opts.BaseRepo = func() (ghrepo.Interface, error) {
|
|
return ghrepo.FromFullName("owner/repo")
|
|
}
|
|
opts.HttpClient = func() (*http.Client, error) {
|
|
return &http.Client{Transport: reg}, nil
|
|
}
|
|
opts.Config = func() (gh.Config, error) {
|
|
return config.NewBlankConfig(), nil
|
|
}
|
|
opts.Now = func() time.Time {
|
|
t, _ := time.Parse(time.RFC822, "4 Apr 24 00:00 UTC")
|
|
return t
|
|
}
|
|
|
|
require.NoError(t, listRun(opts))
|
|
|
|
if tt.wantPopulated {
|
|
// There should be 2 requests; one to get the variables list and
|
|
// another to populate the numSelectedRepos field.
|
|
assert.Len(t, reg.Requests, 2)
|
|
} else {
|
|
// Only one requests to get the variables list.
|
|
assert.Len(t, reg.Requests, 1)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_getVariables_pagination(t *testing.T) {
|
|
reg := &httpmock.Registry{}
|
|
defer reg.Verify(t)
|
|
reg.Register(
|
|
httpmock.QueryMatcher("GET", "path/to", url.Values{"per_page": []string{"100"}}),
|
|
httpmock.WithHeader(
|
|
httpmock.StringResponse(`{"variables":[{},{}]}`),
|
|
"Link",
|
|
`<http://example.com/page/0>; rel="previous", <http://example.com/page/2>; rel="next"`),
|
|
)
|
|
reg.Register(
|
|
httpmock.REST("GET", "page/2"),
|
|
httpmock.StringResponse(`{"variables":[{},{}]}`),
|
|
)
|
|
client := &http.Client{Transport: reg}
|
|
variables, err := getVariables(client, "github.com", "path/to")
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 4, len(variables))
|
|
}
|
|
|
|
func TestExportVariables(t *testing.T) {
|
|
ios, _, stdout, _ := iostreams.Test()
|
|
tf, _ := time.Parse(time.RFC3339, "2024-01-01T00:00:00Z")
|
|
vs := []shared.Variable{{
|
|
Name: "v1",
|
|
Value: "test1",
|
|
UpdatedAt: tf,
|
|
CreatedAt: tf,
|
|
Visibility: shared.All,
|
|
SelectedReposURL: "https://someurl.com",
|
|
NumSelectedRepos: 1,
|
|
}}
|
|
exporter := cmdutil.NewJSONExporter()
|
|
exporter.SetFields(shared.VariableJSONFields)
|
|
require.NoError(t, exporter.Write(ios, vs))
|
|
require.JSONEq(t,
|
|
`[{"name":"v1","numSelectedRepos":1,"selectedReposURL":"https://someurl.com","updatedAt":"2024-01-01T00:00:00Z","createdAt":"2024-01-01T00:00:00Z","value":"test1","visibility":"all"}]`,
|
|
stdout.String())
|
|
}
|