111e8dbcf2
This removes sensitivity to the BROWSER environment variable in tests and makes it easier to verify the URL that the browser was invoked with without having to stub sub-processes.
267 lines
7 KiB
Go
267 lines
7 KiB
Go
package checks
|
|
|
|
import (
|
|
"bytes"
|
|
"net/http"
|
|
"testing"
|
|
|
|
"github.com/cli/cli/internal/ghrepo"
|
|
"github.com/cli/cli/internal/run"
|
|
"github.com/cli/cli/pkg/cmdutil"
|
|
"github.com/cli/cli/pkg/httpmock"
|
|
"github.com/cli/cli/pkg/iostreams"
|
|
"github.com/google/shlex"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestNewCmdChecks(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
cli string
|
|
wants ChecksOptions
|
|
}{
|
|
{
|
|
name: "no arguments",
|
|
cli: "",
|
|
wants: ChecksOptions{},
|
|
},
|
|
{
|
|
name: "pr argument",
|
|
cli: "1234",
|
|
wants: ChecksOptions{
|
|
SelectorArg: "1234",
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
io, _, _, _ := iostreams.Test()
|
|
f := &cmdutil.Factory{
|
|
IOStreams: io,
|
|
}
|
|
|
|
argv, err := shlex.Split(tt.cli)
|
|
assert.NoError(t, err)
|
|
|
|
var gotOpts *ChecksOptions
|
|
cmd := NewCmdChecks(f, func(opts *ChecksOptions) 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.SelectorArg, gotOpts.SelectorArg)
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_checksRun(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
fixture string
|
|
stubs func(*httpmock.Registry)
|
|
nontty bool
|
|
wantOut string
|
|
wantErr string
|
|
}{
|
|
{
|
|
name: "no commits",
|
|
stubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestByNumber\b`),
|
|
httpmock.StringResponse(`
|
|
{ "data": { "repository": {
|
|
"pullRequest": { "number": 123 }
|
|
} } }
|
|
`))
|
|
},
|
|
wantOut: "",
|
|
wantErr: "no commit found on the pull request",
|
|
},
|
|
{
|
|
name: "no checks",
|
|
stubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestByNumber\b`),
|
|
httpmock.StringResponse(`
|
|
{ "data": { "repository": {
|
|
"pullRequest": { "number": 123, "commits": { "nodes": [{"commit": {"oid": "abc"}}]}, "baseRefName": "master" }
|
|
} } }
|
|
`))
|
|
},
|
|
wantOut: "",
|
|
wantErr: "no checks reported on the 'master' branch",
|
|
},
|
|
{
|
|
name: "some failing",
|
|
fixture: "./fixtures/someFailing.json",
|
|
wantOut: "Some checks were not successful\n1 failing, 1 successful, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n- slow tests 1m26s sweet link\n",
|
|
wantErr: "SilentError",
|
|
},
|
|
{
|
|
name: "some pending",
|
|
fixture: "./fixtures/somePending.json",
|
|
wantOut: "Some checks are still pending\n0 failing, 2 successful, and 1 pending checks\n\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n- slow tests 1m26s sweet link\n",
|
|
wantErr: "SilentError",
|
|
},
|
|
{
|
|
name: "all passing",
|
|
fixture: "./fixtures/allPassing.json",
|
|
wantOut: "All checks were successful\n0 failing, 3 successful, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n",
|
|
wantErr: "",
|
|
},
|
|
{
|
|
name: "with statuses",
|
|
fixture: "./fixtures/withStatuses.json",
|
|
wantOut: "Some checks were not successful\n1 failing, 2 successful, and 0 pending checks\n\nX a status sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n",
|
|
wantErr: "SilentError",
|
|
},
|
|
{
|
|
name: "no checks",
|
|
nontty: true,
|
|
stubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestByNumber\b`),
|
|
httpmock.StringResponse(`
|
|
{ "data": { "repository": {
|
|
"pullRequest": { "number": 123, "commits": { "nodes": [{"commit": {"oid": "abc"}}]}, "baseRefName": "master" }
|
|
} } }
|
|
`))
|
|
},
|
|
wantOut: "",
|
|
wantErr: "no checks reported on the 'master' branch",
|
|
},
|
|
{
|
|
name: "some failing",
|
|
nontty: true,
|
|
fixture: "./fixtures/someFailing.json",
|
|
wantOut: "sad tests\tfail\t1m26s\tsweet link\ncool tests\tpass\t1m26s\tsweet link\nslow tests\tpending\t1m26s\tsweet link\n",
|
|
wantErr: "SilentError",
|
|
},
|
|
{
|
|
name: "some pending",
|
|
nontty: true,
|
|
fixture: "./fixtures/somePending.json",
|
|
wantOut: "cool tests\tpass\t1m26s\tsweet link\nrad tests\tpass\t1m26s\tsweet link\nslow tests\tpending\t1m26s\tsweet link\n",
|
|
wantErr: "SilentError",
|
|
},
|
|
{
|
|
name: "all passing",
|
|
nontty: true,
|
|
fixture: "./fixtures/allPassing.json",
|
|
wantOut: "awesome tests\tpass\t1m26s\tsweet link\ncool tests\tpass\t1m26s\tsweet link\nrad tests\tpass\t1m26s\tsweet link\n",
|
|
wantErr: "",
|
|
},
|
|
{
|
|
name: "with statuses",
|
|
nontty: true,
|
|
fixture: "./fixtures/withStatuses.json",
|
|
wantOut: "a status\tfail\t0\tsweet link\ncool tests\tpass\t1m26s\tsweet link\nrad tests\tpass\t1m26s\tsweet link\n",
|
|
wantErr: "SilentError",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
io, _, stdout, _ := iostreams.Test()
|
|
io.SetStdoutTTY(!tt.nontty)
|
|
|
|
opts := &ChecksOptions{
|
|
IO: io,
|
|
BaseRepo: func() (ghrepo.Interface, error) {
|
|
return ghrepo.New("OWNER", "REPO"), nil
|
|
},
|
|
SelectorArg: "123",
|
|
}
|
|
|
|
reg := &httpmock.Registry{}
|
|
defer reg.Verify(t)
|
|
|
|
if tt.stubs != nil {
|
|
tt.stubs(reg)
|
|
} else if tt.fixture != "" {
|
|
reg.Register(httpmock.GraphQL(`query PullRequestByNumber\b`), httpmock.FileResponse(tt.fixture))
|
|
}
|
|
|
|
opts.HttpClient = func() (*http.Client, error) {
|
|
return &http.Client{Transport: reg}, nil
|
|
}
|
|
|
|
err := checksRun(opts)
|
|
if tt.wantErr != "" {
|
|
assert.EqualError(t, err, tt.wantErr)
|
|
} else {
|
|
assert.NoError(t, err)
|
|
}
|
|
|
|
assert.Equal(t, tt.wantOut, stdout.String())
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestChecksRun_web(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
isTTY bool
|
|
wantStderr string
|
|
wantStdout string
|
|
wantBrowse string
|
|
}{
|
|
{
|
|
name: "tty",
|
|
isTTY: true,
|
|
wantStderr: "Opening github.com/OWNER/REPO/pull/123/checks in your browser.\n",
|
|
wantStdout: "",
|
|
wantBrowse: "https://github.com/OWNER/REPO/pull/123/checks",
|
|
},
|
|
{
|
|
name: "nontty",
|
|
isTTY: false,
|
|
wantStderr: "",
|
|
wantStdout: "",
|
|
wantBrowse: "https://github.com/OWNER/REPO/pull/123/checks",
|
|
},
|
|
}
|
|
for _, tc := range tests {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
browser := &cmdutil.TestBrowser{}
|
|
reg := &httpmock.Registry{}
|
|
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestByNumber\b`), httpmock.FileResponse("./fixtures/allPassing.json"))
|
|
|
|
io, _, stdout, stderr := iostreams.Test()
|
|
io.SetStdoutTTY(tc.isTTY)
|
|
io.SetStdinTTY(tc.isTTY)
|
|
io.SetStderrTTY(tc.isTTY)
|
|
|
|
_, teardown := run.Stub()
|
|
defer teardown(t)
|
|
|
|
err := checksRun(&ChecksOptions{
|
|
IO: io,
|
|
Browser: browser,
|
|
WebMode: true,
|
|
HttpClient: func() (*http.Client, error) {
|
|
return &http.Client{Transport: reg}, nil
|
|
},
|
|
BaseRepo: func() (ghrepo.Interface, error) {
|
|
return ghrepo.New("OWNER", "REPO"), nil
|
|
},
|
|
SelectorArg: "123",
|
|
})
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, tc.wantStdout, stdout.String())
|
|
assert.Equal(t, tc.wantStderr, stderr.String())
|
|
reg.Verify(t)
|
|
browser.Verify(t, tc.wantBrowse)
|
|
})
|
|
}
|
|
}
|