1007 lines
28 KiB
Go
1007 lines
28 KiB
Go
package view
|
|
|
|
import (
|
|
"archive/zip"
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/MakeNowJust/heredoc"
|
|
"github.com/cli/cli/v2/internal/ghrepo"
|
|
"github.com/cli/cli/v2/pkg/cmd/run/shared"
|
|
"github.com/cli/cli/v2/pkg/cmdutil"
|
|
"github.com/cli/cli/v2/pkg/httpmock"
|
|
"github.com/cli/cli/v2/pkg/iostreams"
|
|
"github.com/cli/cli/v2/pkg/prompt"
|
|
"github.com/google/shlex"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestNewCmdView(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
cli string
|
|
tty bool
|
|
wants ViewOptions
|
|
wantsErr bool
|
|
}{
|
|
{
|
|
name: "blank nontty",
|
|
wantsErr: true,
|
|
},
|
|
{
|
|
name: "blank tty",
|
|
tty: true,
|
|
wants: ViewOptions{
|
|
Prompt: true,
|
|
},
|
|
},
|
|
{
|
|
name: "web tty",
|
|
tty: true,
|
|
cli: "--web",
|
|
wants: ViewOptions{
|
|
Prompt: true,
|
|
Web: true,
|
|
},
|
|
},
|
|
{
|
|
name: "web nontty",
|
|
cli: "1234 --web",
|
|
wants: ViewOptions{
|
|
Web: true,
|
|
RunID: "1234",
|
|
},
|
|
},
|
|
{
|
|
name: "disallow web and log",
|
|
tty: true,
|
|
cli: "-w --log",
|
|
wantsErr: true,
|
|
},
|
|
{
|
|
name: "disallow log and log-failed",
|
|
tty: true,
|
|
cli: "--log --log-failed",
|
|
wantsErr: true,
|
|
},
|
|
{
|
|
name: "exit status",
|
|
cli: "--exit-status 1234",
|
|
wants: ViewOptions{
|
|
RunID: "1234",
|
|
ExitStatus: true,
|
|
},
|
|
},
|
|
{
|
|
name: "verbosity",
|
|
cli: "-v",
|
|
tty: true,
|
|
wants: ViewOptions{
|
|
Verbose: true,
|
|
Prompt: true,
|
|
},
|
|
},
|
|
{
|
|
name: "with arg nontty",
|
|
cli: "1234",
|
|
wants: ViewOptions{
|
|
RunID: "1234",
|
|
},
|
|
},
|
|
{
|
|
name: "job id passed",
|
|
cli: "--job 1234",
|
|
wants: ViewOptions{
|
|
JobID: "1234",
|
|
},
|
|
},
|
|
{
|
|
name: "log passed",
|
|
tty: true,
|
|
cli: "--log",
|
|
wants: ViewOptions{
|
|
Prompt: true,
|
|
Log: true,
|
|
},
|
|
},
|
|
{
|
|
name: "tolerates both run and job id",
|
|
cli: "1234 --job 4567",
|
|
wants: ViewOptions{
|
|
JobID: "4567",
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
io, _, _, _ := iostreams.Test()
|
|
io.SetStdinTTY(tt.tty)
|
|
io.SetStdoutTTY(tt.tty)
|
|
|
|
f := &cmdutil.Factory{
|
|
IOStreams: io,
|
|
}
|
|
|
|
argv, err := shlex.Split(tt.cli)
|
|
assert.NoError(t, err)
|
|
|
|
var gotOpts *ViewOptions
|
|
cmd := NewCmdView(f, func(opts *ViewOptions) error {
|
|
gotOpts = opts
|
|
return nil
|
|
})
|
|
cmd.SetArgs(argv)
|
|
cmd.SetIn(&bytes.Buffer{})
|
|
cmd.SetOut(ioutil.Discard)
|
|
cmd.SetErr(ioutil.Discard)
|
|
|
|
_, err = cmd.ExecuteC()
|
|
if tt.wantsErr {
|
|
assert.Error(t, err)
|
|
return
|
|
}
|
|
|
|
assert.NoError(t, err)
|
|
|
|
assert.Equal(t, tt.wants.RunID, gotOpts.RunID)
|
|
assert.Equal(t, tt.wants.Prompt, gotOpts.Prompt)
|
|
assert.Equal(t, tt.wants.ExitStatus, gotOpts.ExitStatus)
|
|
assert.Equal(t, tt.wants.Verbose, gotOpts.Verbose)
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestViewRun(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
httpStubs func(*httpmock.Registry)
|
|
askStubs func(*prompt.AskStubber)
|
|
opts *ViewOptions
|
|
tty bool
|
|
wantErr bool
|
|
wantOut string
|
|
browsedURL string
|
|
errMsg string
|
|
}{
|
|
{
|
|
name: "associate with PR",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
RunID: "3",
|
|
Prompt: false,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/artifacts"),
|
|
httpmock.StringResponse(`{}`))
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestForRun`),
|
|
httpmock.StringResponse(`{"data": {
|
|
"repository": {
|
|
"pullRequests": {
|
|
"nodes": [
|
|
{"number": 2898,
|
|
"headRepository": {
|
|
"owner": {
|
|
"login": "OWNER"
|
|
},
|
|
"name": "REPO"}}
|
|
]}}}}`))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/10/annotations"),
|
|
httpmock.JSONResponse([]shared.Annotation{}))
|
|
},
|
|
wantOut: "\n✓ trunk successful #2898 · 3\nTriggered via push about 59 minutes ago\n\nJOBS\n✓ cool job in 4m34s (ID 10)\n\nFor more information about a job, try: gh run view --job=<job-id>\nView this run on GitHub: https://github.com/runs/3\n",
|
|
},
|
|
{
|
|
name: "exit status, failed run",
|
|
opts: &ViewOptions{
|
|
RunID: "1234",
|
|
ExitStatus: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"),
|
|
httpmock.JSONResponse(shared.FailedRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/artifacts"),
|
|
httpmock.StringResponse(`{}`))
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestForRun`),
|
|
httpmock.StringResponse(``))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/1234/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/20/annotations"),
|
|
httpmock.JSONResponse(shared.FailedJobAnnotations))
|
|
},
|
|
wantOut: "\nX trunk failed · 1234\nTriggered via push about 59 minutes ago\n\nJOBS\nX sad job in 4m34s (ID 20)\n ✓ barf the quux\n X quux the barf\n\nANNOTATIONS\nX the job is sad\nsad job: blaze.py#420\n\n\nTo see what failed, try: gh run view 1234 --log-failed\nView this run on GitHub: https://github.com/runs/1234\n",
|
|
wantErr: true,
|
|
},
|
|
{
|
|
name: "with artifacts",
|
|
opts: &ViewOptions{
|
|
RunID: "3",
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/artifacts"),
|
|
httpmock.JSONResponse(map[string][]shared.Artifact{
|
|
"artifacts": {
|
|
shared.Artifact{Name: "artifact-1", Expired: false},
|
|
shared.Artifact{Name: "artifact-2", Expired: true},
|
|
shared.Artifact{Name: "artifact-3", Expired: false},
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestForRun`),
|
|
httpmock.StringResponse(``))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{}))
|
|
},
|
|
wantOut: heredoc.Doc(`
|
|
|
|
✓ trunk successful · 3
|
|
Triggered via push about 59 minutes ago
|
|
|
|
JOBS
|
|
|
|
|
|
ARTIFACTS
|
|
artifact-1
|
|
artifact-2 (expired)
|
|
artifact-3
|
|
|
|
For more information about a job, try: gh run view --job=<job-id>
|
|
View this run on GitHub: https://github.com/runs/3
|
|
`),
|
|
},
|
|
{
|
|
name: "exit status, successful run",
|
|
opts: &ViewOptions{
|
|
RunID: "3",
|
|
ExitStatus: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/artifacts"),
|
|
httpmock.StringResponse(`{}`))
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestForRun`),
|
|
httpmock.StringResponse(``))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/10/annotations"),
|
|
httpmock.JSONResponse([]shared.Annotation{}))
|
|
},
|
|
wantOut: "\n✓ trunk successful · 3\nTriggered via push about 59 minutes ago\n\nJOBS\n✓ cool job in 4m34s (ID 10)\n\nFor more information about a job, try: gh run view --job=<job-id>\nView this run on GitHub: https://github.com/runs/3\n",
|
|
},
|
|
{
|
|
name: "verbose",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
RunID: "1234",
|
|
Prompt: false,
|
|
Verbose: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"),
|
|
httpmock.JSONResponse(shared.FailedRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/artifacts"),
|
|
httpmock.StringResponse(`{}`))
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestForRun`),
|
|
httpmock.StringResponse(``))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/1234/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/10/annotations"),
|
|
httpmock.JSONResponse([]shared.Annotation{}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/20/annotations"),
|
|
httpmock.JSONResponse(shared.FailedJobAnnotations))
|
|
},
|
|
wantOut: "\nX trunk failed · 1234\nTriggered via push about 59 minutes ago\n\nJOBS\n✓ cool job in 4m34s (ID 10)\n ✓ fob the barz\n ✓ barz the fob\nX sad job in 4m34s (ID 20)\n ✓ barf the quux\n X quux the barf\n\nANNOTATIONS\nX the job is sad\nsad job: blaze.py#420\n\n\nTo see what failed, try: gh run view 1234 --log-failed\nView this run on GitHub: https://github.com/runs/1234\n",
|
|
},
|
|
{
|
|
name: "prompts for choice, one job",
|
|
tty: true,
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs"),
|
|
httpmock.JSONResponse(shared.RunsPayload{
|
|
WorkflowRuns: shared.TestRuns,
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/artifacts"),
|
|
httpmock.StringResponse(`{}`))
|
|
reg.Register(
|
|
httpmock.GraphQL(`query PullRequestForRun`),
|
|
httpmock.StringResponse(``))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/10/annotations"),
|
|
httpmock.JSONResponse([]shared.Annotation{}))
|
|
},
|
|
askStubs: func(as *prompt.AskStubber) {
|
|
as.StubOne(2)
|
|
},
|
|
opts: &ViewOptions{
|
|
Prompt: true,
|
|
},
|
|
wantOut: "\n✓ trunk successful · 3\nTriggered via push about 59 minutes ago\n\nJOBS\n✓ cool job in 4m34s (ID 10)\n\nFor more information about a job, try: gh run view --job=<job-id>\nView this run on GitHub: https://github.com/runs/3\n",
|
|
},
|
|
{
|
|
name: "interactive with log",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
Prompt: true,
|
|
Log: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs"),
|
|
httpmock.JSONResponse(shared.RunsPayload{
|
|
WorkflowRuns: shared.TestRuns,
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/logs"),
|
|
httpmock.FileResponse("./fixtures/run_log.zip"))
|
|
},
|
|
askStubs: func(as *prompt.AskStubber) {
|
|
as.StubOne(2)
|
|
as.StubOne(1)
|
|
},
|
|
wantOut: coolJobRunLogOutput,
|
|
},
|
|
{
|
|
name: "noninteractive with log",
|
|
opts: &ViewOptions{
|
|
JobID: "10",
|
|
Log: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/jobs/10"),
|
|
httpmock.JSONResponse(shared.SuccessfulJob))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/logs"),
|
|
httpmock.FileResponse("./fixtures/run_log.zip"))
|
|
},
|
|
wantOut: coolJobRunLogOutput,
|
|
},
|
|
{
|
|
name: "interactive with run log",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
Prompt: true,
|
|
Log: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs"),
|
|
httpmock.JSONResponse(shared.RunsPayload{
|
|
WorkflowRuns: shared.TestRuns,
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/logs"),
|
|
httpmock.FileResponse("./fixtures/run_log.zip"))
|
|
},
|
|
askStubs: func(as *prompt.AskStubber) {
|
|
as.StubOne(2)
|
|
as.StubOne(0)
|
|
},
|
|
wantOut: expectedRunLogOutput,
|
|
},
|
|
{
|
|
name: "noninteractive with run log",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
RunID: "3",
|
|
Log: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/logs"),
|
|
httpmock.FileResponse("./fixtures/run_log.zip"))
|
|
},
|
|
wantOut: expectedRunLogOutput,
|
|
},
|
|
{
|
|
name: "interactive with log-failed",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
Prompt: true,
|
|
LogFailed: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs"),
|
|
httpmock.JSONResponse(shared.RunsPayload{
|
|
WorkflowRuns: shared.TestRuns,
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"),
|
|
httpmock.JSONResponse(shared.FailedRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/1234/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/logs"),
|
|
httpmock.FileResponse("./fixtures/run_log.zip"))
|
|
},
|
|
askStubs: func(as *prompt.AskStubber) {
|
|
as.StubOne(4)
|
|
as.StubOne(2)
|
|
},
|
|
wantOut: quuxTheBarfLogOutput,
|
|
},
|
|
{
|
|
name: "noninteractive with log-failed",
|
|
opts: &ViewOptions{
|
|
JobID: "20",
|
|
LogFailed: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/jobs/20"),
|
|
httpmock.JSONResponse(shared.FailedJob))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"),
|
|
httpmock.JSONResponse(shared.FailedRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/logs"),
|
|
httpmock.FileResponse("./fixtures/run_log.zip"))
|
|
},
|
|
wantOut: quuxTheBarfLogOutput,
|
|
},
|
|
{
|
|
name: "interactive with run log-failed",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
Prompt: true,
|
|
LogFailed: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs"),
|
|
httpmock.JSONResponse(shared.RunsPayload{
|
|
WorkflowRuns: shared.TestRuns,
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"),
|
|
httpmock.JSONResponse(shared.FailedRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/1234/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/logs"),
|
|
httpmock.FileResponse("./fixtures/run_log.zip"))
|
|
},
|
|
askStubs: func(as *prompt.AskStubber) {
|
|
as.StubOne(4)
|
|
as.StubOne(0)
|
|
},
|
|
wantOut: quuxTheBarfLogOutput,
|
|
},
|
|
{
|
|
name: "noninteractive with run log-failed",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
RunID: "1234",
|
|
LogFailed: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"),
|
|
httpmock.JSONResponse(shared.FailedRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/1234/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/logs"),
|
|
httpmock.FileResponse("./fixtures/run_log.zip"))
|
|
},
|
|
wantOut: quuxTheBarfLogOutput,
|
|
},
|
|
{
|
|
name: "run log but run is not done",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
RunID: "2",
|
|
Log: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/2"),
|
|
httpmock.JSONResponse(shared.TestRun("in progress", 2, shared.InProgress, "")))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/2/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{},
|
|
}))
|
|
},
|
|
wantErr: true,
|
|
errMsg: "run 2 is still in progress; logs will be available when it is complete",
|
|
},
|
|
{
|
|
name: "job log but job is not done",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
JobID: "20",
|
|
Log: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/jobs/20"),
|
|
httpmock.JSONResponse(shared.Job{
|
|
ID: 20,
|
|
Status: shared.InProgress,
|
|
RunID: 2,
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/2"),
|
|
httpmock.JSONResponse(shared.TestRun("in progress", 2, shared.InProgress, "")))
|
|
},
|
|
wantErr: true,
|
|
errMsg: "job 20 is still in progress; logs will be available when it is complete",
|
|
},
|
|
{
|
|
name: "noninteractive with job",
|
|
opts: &ViewOptions{
|
|
JobID: "10",
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/jobs/10"),
|
|
httpmock.JSONResponse(shared.SuccessfulJob))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/10/annotations"),
|
|
httpmock.JSONResponse([]shared.Annotation{}))
|
|
},
|
|
wantOut: "\n✓ trunk successful · 3\nTriggered via push about 59 minutes ago\n\n✓ cool job in 4m34s (ID 10)\n ✓ fob the barz\n ✓ barz the fob\n\nTo see the full job log, try: gh run view --log --job=10\nView this run on GitHub: https://github.com/runs/3\n",
|
|
},
|
|
{
|
|
name: "interactive, multiple jobs, choose all jobs",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
Prompt: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs"),
|
|
httpmock.JSONResponse(shared.RunsPayload{
|
|
WorkflowRuns: shared.TestRuns,
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/artifacts"),
|
|
httpmock.StringResponse(`{}`))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/10/annotations"),
|
|
httpmock.JSONResponse([]shared.Annotation{}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/20/annotations"),
|
|
httpmock.JSONResponse(shared.FailedJobAnnotations))
|
|
},
|
|
askStubs: func(as *prompt.AskStubber) {
|
|
as.StubOne(2)
|
|
as.StubOne(0)
|
|
},
|
|
wantOut: "\n✓ trunk successful · 3\nTriggered via push about 59 minutes ago\n\nJOBS\n✓ cool job in 4m34s (ID 10)\nX sad job in 4m34s (ID 20)\n ✓ barf the quux\n X quux the barf\n\nANNOTATIONS\nX the job is sad\nsad job: blaze.py#420\n\n\nFor more information about a job, try: gh run view --job=<job-id>\nView this run on GitHub: https://github.com/runs/3\n",
|
|
},
|
|
{
|
|
name: "interactive, multiple jobs, choose specific jobs",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
Prompt: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs"),
|
|
httpmock.JSONResponse(shared.RunsPayload{
|
|
WorkflowRuns: shared.TestRuns,
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/3/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{
|
|
Jobs: []shared.Job{
|
|
shared.SuccessfulJob,
|
|
shared.FailedJob,
|
|
},
|
|
}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/check-runs/10/annotations"),
|
|
httpmock.JSONResponse([]shared.Annotation{}))
|
|
},
|
|
askStubs: func(as *prompt.AskStubber) {
|
|
as.StubOne(2)
|
|
as.StubOne(1)
|
|
},
|
|
wantOut: "\n✓ trunk successful · 3\nTriggered via push about 59 minutes ago\n\n✓ cool job in 4m34s (ID 10)\n ✓ fob the barz\n ✓ barz the fob\n\nTo see the full job log, try: gh run view --log --job=10\nView this run on GitHub: https://github.com/runs/3\n",
|
|
},
|
|
{
|
|
name: "web run",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
RunID: "3",
|
|
Web: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
},
|
|
browsedURL: "https://github.com/runs/3",
|
|
wantOut: "Opening github.com/runs/3 in your browser.\n",
|
|
},
|
|
{
|
|
name: "web job",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
JobID: "10",
|
|
Web: true,
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/jobs/10"),
|
|
httpmock.JSONResponse(shared.SuccessfulJob))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"),
|
|
httpmock.JSONResponse(shared.SuccessfulRun))
|
|
},
|
|
browsedURL: "https://github.com/jobs/10?check_suite_focus=true",
|
|
wantOut: "Opening github.com/jobs/10 in your browser.\n",
|
|
},
|
|
{
|
|
name: "hide job header, failure",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
RunID: "123",
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/123"),
|
|
httpmock.JSONResponse(shared.TestRun("failed no job", 123, shared.Completed, shared.Failure)))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/123/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{Jobs: []shared.Job{}}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/123/artifacts"),
|
|
httpmock.StringResponse(`{}`))
|
|
},
|
|
wantOut: "\nX trunk failed no job · 123\nTriggered via push about 59 minutes ago\n\nX This run likely failed because of a workflow file issue.\n\nFor more information, see: https://github.com/runs/123\n",
|
|
},
|
|
{
|
|
name: "hide job header, startup_failure",
|
|
tty: true,
|
|
opts: &ViewOptions{
|
|
RunID: "123",
|
|
},
|
|
httpStubs: func(reg *httpmock.Registry) {
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/123"),
|
|
httpmock.JSONResponse(shared.TestRun("failed no job", 123, shared.Completed, shared.StartupFailure)))
|
|
reg.Register(
|
|
httpmock.REST("GET", "runs/123/jobs"),
|
|
httpmock.JSONResponse(shared.JobsPayload{Jobs: []shared.Job{}}))
|
|
reg.Register(
|
|
httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/123/artifacts"),
|
|
httpmock.StringResponse(`{}`))
|
|
},
|
|
wantOut: "\nX trunk failed no job · 123\nTriggered via push about 59 minutes ago\n\nX This run likely failed because of a workflow file issue.\n\nFor more information, see: https://github.com/runs/123\n",
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
reg := &httpmock.Registry{}
|
|
tt.httpStubs(reg)
|
|
tt.opts.HttpClient = func() (*http.Client, error) {
|
|
return &http.Client{Transport: reg}, nil
|
|
}
|
|
|
|
tt.opts.Now = func() time.Time {
|
|
notnow, _ := time.Parse("2006-01-02 15:04:05", "2021-02-23 05:50:00")
|
|
return notnow
|
|
}
|
|
|
|
io, _, stdout, _ := iostreams.Test()
|
|
io.SetStdoutTTY(tt.tty)
|
|
tt.opts.IO = io
|
|
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
|
|
return ghrepo.FromFullName("OWNER/REPO")
|
|
}
|
|
|
|
as, teardown := prompt.InitAskStubber()
|
|
defer teardown()
|
|
if tt.askStubs != nil {
|
|
tt.askStubs(as)
|
|
}
|
|
|
|
browser := &cmdutil.TestBrowser{}
|
|
tt.opts.Browser = browser
|
|
rlc := testRunLogCache{}
|
|
tt.opts.RunLogCache = rlc
|
|
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
err := runView(tt.opts)
|
|
if tt.wantErr {
|
|
assert.Error(t, err)
|
|
if tt.errMsg != "" {
|
|
assert.Equal(t, tt.errMsg, err.Error())
|
|
}
|
|
if !tt.opts.ExitStatus {
|
|
return
|
|
}
|
|
}
|
|
if !tt.opts.ExitStatus {
|
|
assert.NoError(t, err)
|
|
}
|
|
assert.Equal(t, tt.wantOut, stdout.String())
|
|
if tt.browsedURL != "" {
|
|
assert.Equal(t, tt.browsedURL, browser.BrowsedURL())
|
|
}
|
|
reg.Verify(t)
|
|
})
|
|
}
|
|
}
|
|
|
|
// Structure of fixture zip file
|
|
// run log/
|
|
// ├── cool job/
|
|
// │ ├── 1_fob the barz.txt
|
|
// │ └── 2_barz the fob.txt
|
|
// └── sad job/
|
|
// ├── 1_barf the quux.txt
|
|
// └── 2_quux the barf.txt
|
|
func Test_attachRunLog(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
job shared.Job
|
|
wantMatch bool
|
|
wantFilename string
|
|
}{
|
|
{
|
|
name: "matching job name and step number 1",
|
|
job: shared.Job{
|
|
Name: "cool job",
|
|
Steps: []shared.Step{{
|
|
Name: "fob the barz",
|
|
Number: 1,
|
|
}},
|
|
},
|
|
wantMatch: true,
|
|
wantFilename: "cool job/1_fob the barz.txt",
|
|
},
|
|
{
|
|
name: "matching job name and step number 2",
|
|
job: shared.Job{
|
|
Name: "cool job",
|
|
Steps: []shared.Step{{
|
|
Name: "barz the fob",
|
|
Number: 2,
|
|
}},
|
|
},
|
|
wantMatch: true,
|
|
wantFilename: "cool job/2_barz the fob.txt",
|
|
},
|
|
{
|
|
name: "matching job name and step number and mismatch step name",
|
|
job: shared.Job{
|
|
Name: "cool job",
|
|
Steps: []shared.Step{{
|
|
Name: "mismatch",
|
|
Number: 1,
|
|
}},
|
|
},
|
|
wantMatch: true,
|
|
wantFilename: "cool job/1_fob the barz.txt",
|
|
},
|
|
{
|
|
name: "matching job name and mismatch step number",
|
|
job: shared.Job{
|
|
Name: "cool job",
|
|
Steps: []shared.Step{{
|
|
Name: "fob the barz",
|
|
Number: 3,
|
|
}},
|
|
},
|
|
wantMatch: false,
|
|
},
|
|
{
|
|
name: "escape metacharacters in job name",
|
|
job: shared.Job{
|
|
Name: "metacharacters .+*?()|[]{}^$ job",
|
|
Steps: []shared.Step{{
|
|
Name: "fob the barz",
|
|
Number: 0,
|
|
}},
|
|
},
|
|
wantMatch: false,
|
|
},
|
|
{
|
|
name: "mismatching job name",
|
|
job: shared.Job{
|
|
Name: "mismatch",
|
|
Steps: []shared.Step{{
|
|
Name: "fob the barz",
|
|
Number: 1,
|
|
}},
|
|
},
|
|
wantMatch: false,
|
|
},
|
|
}
|
|
rlz, _ := zip.OpenReader("./fixtures/run_log.zip")
|
|
defer rlz.Close()
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
attachRunLog(rlz, []shared.Job{tt.job})
|
|
for _, step := range tt.job.Steps {
|
|
log := step.Log
|
|
logPresent := log != nil
|
|
assert.Equal(t, tt.wantMatch, logPresent)
|
|
if logPresent {
|
|
assert.Equal(t, tt.wantFilename, log.Name)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
type testRunLogCache struct{}
|
|
|
|
func (testRunLogCache) Exists(path string) bool {
|
|
return false
|
|
}
|
|
func (testRunLogCache) Create(path string, content io.ReadCloser) error {
|
|
return nil
|
|
}
|
|
func (testRunLogCache) Open(path string) (*zip.ReadCloser, error) {
|
|
return zip.OpenReader("./fixtures/run_log.zip")
|
|
}
|
|
|
|
var barfTheFobLogOutput = heredoc.Doc(`
|
|
cool job barz the fob log line 1
|
|
cool job barz the fob log line 2
|
|
cool job barz the fob log line 3
|
|
`)
|
|
|
|
var fobTheBarzLogOutput = heredoc.Doc(`
|
|
cool job fob the barz log line 1
|
|
cool job fob the barz log line 2
|
|
cool job fob the barz log line 3
|
|
`)
|
|
|
|
var barfTheQuuxLogOutput = heredoc.Doc(`
|
|
sad job barf the quux log line 1
|
|
sad job barf the quux log line 2
|
|
sad job barf the quux log line 3
|
|
`)
|
|
|
|
var quuxTheBarfLogOutput = heredoc.Doc(`
|
|
sad job quux the barf log line 1
|
|
sad job quux the barf log line 2
|
|
sad job quux the barf log line 3
|
|
`)
|
|
|
|
var coolJobRunLogOutput = fmt.Sprintf("%s%s", fobTheBarzLogOutput, barfTheFobLogOutput)
|
|
var sadJobRunLogOutput = fmt.Sprintf("%s%s", barfTheQuuxLogOutput, quuxTheBarfLogOutput)
|
|
var expectedRunLogOutput = fmt.Sprintf("%s%s", coolJobRunLogOutput, sadJobRunLogOutput)
|