From 9010a2e12c0e3e0fedaae5d03c1a6ccc159b8296 Mon Sep 17 00:00:00 2001 From: nate smith Date: Fri, 7 Apr 2023 14:57:09 -0700 Subject: [PATCH 01/90] use new prompter in run view --- pkg/cmd/run/shared/shared.go | 7 +- pkg/cmd/run/view/view.go | 18 ++-- pkg/cmd/run/view/view_test.go | 166 ++++++++++++++++++++++------------ 3 files changed, 119 insertions(+), 72 deletions(-) diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go index 94a5590a3..8cdd42f87 100644 --- a/pkg/cmd/run/shared/shared.go +++ b/pkg/cmd/run/shared/shared.go @@ -12,12 +12,15 @@ import ( "github.com/AlecAivazis/survey/v2" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" - "github.com/cli/cli/v2/internal/prompter" workflowShared "github.com/cli/cli/v2/pkg/cmd/workflow/shared" "github.com/cli/cli/v2/pkg/iostreams" "github.com/cli/cli/v2/pkg/prompt" ) +type Prompter interface { + Select(string, string, []string) (int, error) +} + const ( // Run statuses Queued Status = "queued" @@ -443,7 +446,7 @@ func GetJob(client *api.Client, repo ghrepo.Interface, jobID string) (*Job, erro } // SelectRun prompts the user to select a run from a list of runs by using the recommended prompter interface -func SelectRun(p prompter.Prompter, cs *iostreams.ColorScheme, runs []Run) (string, error) { +func SelectRun(p Prompter, cs *iostreams.ColorScheme, runs []Run) (string, error) { now := time.Now() candidates := []string{} diff --git a/pkg/cmd/run/view/view.go b/pkg/cmd/run/view/view.go index 34c5fcbc7..d62737595 100644 --- a/pkg/cmd/run/view/view.go +++ b/pkg/cmd/run/view/view.go @@ -14,7 +14,6 @@ import ( "strconv" "time" - "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" @@ -24,7 +23,6 @@ import ( "github.com/cli/cli/v2/pkg/cmd/run/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/prompt" "github.com/spf13/cobra" ) @@ -65,6 +63,7 @@ type ViewOptions struct { IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) Browser browser.Browser + Prompter shared.Prompter RunLogCache runLogCache RunID string @@ -86,6 +85,7 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman opts := &ViewOptions{ IO: f.IOStreams, HttpClient: f.HttpClient, + Prompter: f.Prompter, Now: time.Now, Browser: f.Browser, RunLogCache: rlc{}, @@ -205,7 +205,7 @@ func runView(opts *ViewOptions) error { if err != nil { return fmt.Errorf("failed to get runs: %w", err) } - runID, err = shared.PromptForRun(cs, runs.WorkflowRuns) + runID, err = shared.SelectRun(opts.Prompter, cs, runs.WorkflowRuns) if err != nil { return err } @@ -228,7 +228,7 @@ func runView(opts *ViewOptions) error { } if opts.Prompt && len(jobs) > 1 { - selectedJob, err = promptForJob(cs, jobs) + selectedJob, err = promptForJob(opts.Prompter, cs, jobs) if err != nil { return err } @@ -459,20 +459,14 @@ func getRunLog(cache runLogCache, httpClient *http.Client, repo ghrepo.Interface return cache.Open(filepath) } -func promptForJob(cs *iostreams.ColorScheme, jobs []shared.Job) (*shared.Job, error) { +func promptForJob(prompter shared.Prompter, cs *iostreams.ColorScheme, jobs []shared.Job) (*shared.Job, error) { candidates := []string{"View all jobs in this run"} for _, job := range jobs { symbol, _ := shared.Symbol(cs, job.Status, job.Conclusion) candidates = append(candidates, fmt.Sprintf("%s %s", symbol, job.Name)) } - var selected int - //nolint:staticcheck // SA1019: prompt.SurveyAskOne is deprecated: use Prompter - err := prompt.SurveyAskOne(&survey.Select{ - Message: "View a specific job in this run?", - Options: candidates, - PageSize: 12, - }, &selected) + selected, err := prompter.Select("View a specific job in this run?", "", candidates) if err != nil { return nil, err } diff --git a/pkg/cmd/run/view/view_test.go b/pkg/cmd/run/view/view_test.go index 99a9ef30e..be9e0554d 100644 --- a/pkg/cmd/run/view/view_test.go +++ b/pkg/cmd/run/view/view_test.go @@ -12,12 +12,12 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/run/shared" workflowShared "github.com/cli/cli/v2/pkg/cmd/workflow/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" ) @@ -169,15 +169,15 @@ func TestNewCmdView(t *testing.T) { 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 string + httpStubs func(*httpmock.Registry) + promptStubs func(*prompter.MockPrompter) + opts *ViewOptions + tty bool + wantErr bool + wantOut string + browsedURL string + errMsg string }{ { name: "associate with PR", @@ -532,9 +532,12 @@ func TestViewRun(t *testing.T) { httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), httpmock.JSONResponse(shared.TestWorkflow)) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool commit, CI (trunk) Feb 23, 2021") + }) }, opts: &ViewOptions{ Prompt: true, @@ -579,11 +582,17 @@ func TestViewRun(t *testing.T) { }, })) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(1) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool commit, CI (trunk) Feb 23, 2021") + }) + pm.RegisterSelect("View a specific job in this run?", + []string{"View all jobs in this run", "✓ cool job", "X sad job"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool job") + }) }, wantOut: coolJobRunLogOutput, }, @@ -626,11 +635,17 @@ func TestViewRun(t *testing.T) { }, })) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(1) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool commit, CI (trunk) Feb 23, 2021") + }) + pm.RegisterSelect("View a specific job in this run?", + []string{"View all jobs in this run", "✓ cool job", "X sad job"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool job") + }) }, wantOut: coolJobRunLogOutput, }, @@ -717,11 +732,17 @@ func TestViewRun(t *testing.T) { }, })) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(0) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool commit, CI (trunk) Feb 23, 2021") + }) + pm.RegisterSelect("View a specific job in this run?", + []string{"View all jobs in this run", "✓ cool job", "X sad job"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "View all jobs in this run") + }) }, wantOut: expectedRunLogOutput, }, @@ -791,11 +812,17 @@ func TestViewRun(t *testing.T) { }, })) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(4) - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return 4, nil + }) + pm.RegisterSelect("View a specific job in this run?", + []string{"View all jobs in this run", "✓ cool job", "X sad job"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "X sad job") + }) }, wantOut: quuxTheBarfLogOutput, }, @@ -838,11 +865,17 @@ func TestViewRun(t *testing.T) { }, })) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(4) - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return 4, nil + }) + pm.RegisterSelect("View a specific job in this run?", + []string{"View all jobs in this run", "✓ cool job", "X sad job"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "X sad job") + }) }, wantOut: quuxTheBarfLogOutput, }, @@ -906,11 +939,17 @@ func TestViewRun(t *testing.T) { httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), httpmock.JSONResponse(shared.TestWorkflow)) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(4) - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(0) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return 4, nil + }) + pm.RegisterSelect("View a specific job in this run?", + []string{"View all jobs in this run", "✓ cool job", "X sad job"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "View all jobs in this run") + }) }, wantOut: quuxTheBarfLogOutput, }, @@ -1054,11 +1093,17 @@ func TestViewRun(t *testing.T) { httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), httpmock.JSONResponse(shared.TestWorkflow)) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(0) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool commit, CI (trunk) Feb 23, 2021") + }) + pm.RegisterSelect("View a specific job in this run?", + []string{"View all jobs in this run", "✓ cool job", "X sad job"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "View all jobs in this run") + }) }, wantOut: "\n✓ trunk CI · 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=\nView this run on GitHub: https://github.com/runs/3\n", }, @@ -1099,11 +1144,17 @@ func TestViewRun(t *testing.T) { httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), httpmock.JSONResponse(shared.TestWorkflow)) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(1) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "✓ cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "* cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool commit, CI (trunk) Feb 23, 2021") + }) + pm.RegisterSelect("View a specific job in this run?", + []string{"View all jobs in this run", "✓ cool job", "X sad job"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "✓ cool job") + }) }, wantOut: "\n✓ trunk CI · 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", }, @@ -1211,11 +1262,10 @@ func TestViewRun(t *testing.T) { return ghrepo.FromFullName("OWNER/REPO") } - //nolint:staticcheck // SA1019: prompt.InitAskStubber is deprecated: use NewAskStubber - as, teardown := prompt.InitAskStubber() - defer teardown() - if tt.askStubs != nil { - tt.askStubs(as) + pm := prompter.NewMockPrompter(t) + tt.opts.Prompter = pm + if tt.promptStubs != nil { + tt.promptStubs(pm) } browser := &browser.Stub{} From 415424de85226ab44bbd3ccd51fc1c8edd378692 Mon Sep 17 00:00:00 2001 From: nate smith Date: Mon, 10 Apr 2023 16:29:24 -0700 Subject: [PATCH 02/90] use new prompter in run cancel --- pkg/cmd/run/cancel/cancel.go | 4 +++- pkg/cmd/run/cancel/cancel_test.go | 34 ++++++++++++++++--------------- 2 files changed, 21 insertions(+), 17 deletions(-) diff --git a/pkg/cmd/run/cancel/cancel.go b/pkg/cmd/run/cancel/cancel.go index ca4521b1d..73953bd67 100644 --- a/pkg/cmd/run/cancel/cancel.go +++ b/pkg/cmd/run/cancel/cancel.go @@ -17,6 +17,7 @@ type CancelOptions struct { HttpClient func() (*http.Client, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) + Prompter shared.Prompter Prompt bool @@ -27,6 +28,7 @@ func NewCmdCancel(f *cmdutil.Factory, runF func(*CancelOptions) error) *cobra.Co opts := &CancelOptions{ IO: f.IOStreams, HttpClient: f.HttpClient, + Prompter: f.Prompter, } cmd := &cobra.Command{ @@ -83,7 +85,7 @@ func runCancel(opts *CancelOptions) error { if len(runs) == 0 { return fmt.Errorf("found no in progress runs to cancel") } - runID, err = shared.PromptForRun(cs, runs) + runID, err = shared.SelectRun(opts.Prompter, cs, runs) if err != nil { return err } diff --git a/pkg/cmd/run/cancel/cancel_test.go b/pkg/cmd/run/cancel/cancel_test.go index bcde453c2..fdfedfa0c 100644 --- a/pkg/cmd/run/cancel/cancel_test.go +++ b/pkg/cmd/run/cancel/cancel_test.go @@ -7,12 +7,12 @@ import ( "testing" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/run/shared" workflowShared "github.com/cli/cli/v2/pkg/cmd/workflow/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" ) @@ -86,13 +86,13 @@ func TestRunCancel(t *testing.T) { inProgressRun := shared.TestRun(1234, shared.InProgress, "") completedRun := shared.TestRun(4567, shared.Completed, shared.Failure) tests := []struct { - name string - httpStubs func(*httpmock.Registry) - askStubs func(*prompt.AskStubber) - opts *CancelOptions - wantErr bool - wantOut string - errMsg string + name string + httpStubs func(*httpmock.Registry) + promptStubs func(*prompter.MockPrompter) + opts *CancelOptions + wantErr bool + wantOut string + errMsg string }{ { name: "cancel run", @@ -194,9 +194,12 @@ func TestRunCancel(t *testing.T) { httpmock.REST("POST", "repos/OWNER/REPO/actions/runs/1234/cancel"), httpmock.StatusStringResponse(202, "{}")) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(0) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"* cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "* cool commit, CI (trunk) Feb 23, 2021") + }) }, wantOut: "✓ Request to cancel workflow submitted.\n", }, @@ -217,11 +220,10 @@ func TestRunCancel(t *testing.T) { return ghrepo.FromFullName("OWNER/REPO") } - //nolint:staticcheck // SA1019: prompt.InitAskStubber is deprecated: use NewAskStubber - as, teardown := prompt.InitAskStubber() - defer teardown() - if tt.askStubs != nil { - tt.askStubs(as) + pm := prompter.NewMockPrompter(t) + tt.opts.Prompter = pm + if tt.promptStubs != nil { + tt.promptStubs(pm) } t.Run(tt.name, func(t *testing.T) { From 07776d23b19612de357d31463d416b4ef11af344 Mon Sep 17 00:00:00 2001 From: nate smith Date: Mon, 10 Apr 2023 16:35:00 -0700 Subject: [PATCH 03/90] use new prompter in run rerun --- pkg/cmd/run/rerun/rerun.go | 5 +++-- pkg/cmd/run/rerun/rerun_test.go | 38 +++++++++++++++++---------------- 2 files changed, 23 insertions(+), 20 deletions(-) diff --git a/pkg/cmd/run/rerun/rerun.go b/pkg/cmd/run/rerun/rerun.go index 2522e632c..b640f41f7 100644 --- a/pkg/cmd/run/rerun/rerun.go +++ b/pkg/cmd/run/rerun/rerun.go @@ -20,6 +20,7 @@ type RerunOptions struct { HttpClient func() (*http.Client, error) IO *iostreams.IOStreams BaseRepo func() (ghrepo.Interface, error) + Prompter shared.Prompter RunID string OnlyFailed bool @@ -32,6 +33,7 @@ type RerunOptions struct { func NewCmdRerun(f *cmdutil.Factory, runF func(*RerunOptions) error) *cobra.Command { opts := &RerunOptions{ IO: f.IOStreams, + Prompter: f.Prompter, HttpClient: f.HttpClient, } @@ -114,8 +116,7 @@ func runRerun(opts *RerunOptions) error { if len(runs) == 0 { return errors.New("no recent runs have failed; please specify a specific ``") } - runID, err = shared.PromptForRun(cs, runs) - if err != nil { + if runID, err = shared.SelectRun(opts.Prompter, cs, runs); err != nil { return err } } diff --git a/pkg/cmd/run/rerun/rerun_test.go b/pkg/cmd/run/rerun/rerun_test.go index 730952f1f..991ab5f3a 100644 --- a/pkg/cmd/run/rerun/rerun_test.go +++ b/pkg/cmd/run/rerun/rerun_test.go @@ -8,12 +8,12 @@ import ( "testing" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/run/shared" workflowShared "github.com/cli/cli/v2/pkg/cmd/workflow/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" ) @@ -161,15 +161,15 @@ func TestNewCmdRerun(t *testing.T) { func TestRerun(t *testing.T) { tests := []struct { - name string - httpStubs func(*httpmock.Registry) - askStubs func(*prompt.AskStubber) - opts *RerunOptions - tty bool - wantErr bool - errOut string - wantOut string - wantDebug bool + name string + httpStubs func(*httpmock.Registry) + promptStubs func(*prompter.MockPrompter) + opts *RerunOptions + tty bool + wantErr bool + errOut string + wantOut string + wantDebug bool }{ { name: "arg", @@ -336,9 +336,12 @@ func TestRerun(t *testing.T) { httpmock.REST("POST", "repos/OWNER/REPO/actions/runs/1234/rerun"), httpmock.StringResponse("{}")) }, - askStubs: func(as *prompt.AskStubber) { - //nolint:staticcheck // SA1019: as.StubOne is deprecated: use StubPrompt - as.StubOne(2) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "- cool commit, CI (trunk) Feb 23, 2021", "X cool commit, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return 2, nil + }) }, wantOut: "✓ Requested rerun of run 1234\n", }, @@ -408,11 +411,10 @@ func TestRerun(t *testing.T) { return ghrepo.FromFullName("OWNER/REPO") } - //nolint:staticcheck // SA1019: prompt.InitAskStubber is deprecated: use NewAskStubber - as, teardown := prompt.InitAskStubber() - defer teardown() - if tt.askStubs != nil { - tt.askStubs(as) + pm := prompter.NewMockPrompter(t) + tt.opts.Prompter = pm + if tt.promptStubs != nil { + tt.promptStubs(pm) } t.Run(tt.name, func(t *testing.T) { From 76fdfaa895271a63e2e842b0161332b7c80ccaac Mon Sep 17 00:00:00 2001 From: nate smith Date: Mon, 10 Apr 2023 16:42:35 -0700 Subject: [PATCH 04/90] use new prompter in run watch --- pkg/cmd/run/watch/watch.go | 7 ++--- pkg/cmd/run/watch/watch_test.go | 46 ++++++++++++++++++--------------- 2 files changed, 29 insertions(+), 24 deletions(-) diff --git a/pkg/cmd/run/watch/watch.go b/pkg/cmd/run/watch/watch.go index 05b207693..090737557 100644 --- a/pkg/cmd/run/watch/watch.go +++ b/pkg/cmd/run/watch/watch.go @@ -23,6 +23,7 @@ type WatchOptions struct { IO *iostreams.IOStreams HttpClient func() (*http.Client, error) BaseRepo func() (ghrepo.Interface, error) + Prompter shared.Prompter RunID string Interval int @@ -37,6 +38,7 @@ func NewCmdWatch(f *cmdutil.Factory, runF func(*WatchOptions) error) *cobra.Comm opts := &WatchOptions{ IO: f.IOStreams, HttpClient: f.HttpClient, + Prompter: f.Prompter, Now: time.Now, } @@ -102,11 +104,10 @@ func watchRun(opts *WatchOptions) error { if len(runs) == 0 { return fmt.Errorf("found no in progress runs to watch") } - runID, err = shared.PromptForRun(cs, runs) - if err != nil { + if runID, err = shared.SelectRun(opts.Prompter, cs, runs); err != nil { return err } - // TODO silly stopgap until dust settles and PromptForRun can just return a run + // TODO silly stopgap until dust settles and SelectRun can just return a run for _, r := range runs { if fmt.Sprintf("%d", r.ID) == runID { run = &r diff --git a/pkg/cmd/run/watch/watch_test.go b/pkg/cmd/run/watch/watch_test.go index 89c75e72c..8ff77516b 100644 --- a/pkg/cmd/run/watch/watch_test.go +++ b/pkg/cmd/run/watch/watch_test.go @@ -8,12 +8,12 @@ import ( "time" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/run/shared" workflowShared "github.com/cli/cli/v2/pkg/cmd/workflow/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" ) @@ -193,14 +193,14 @@ func TestWatchRun(t *testing.T) { } tests := []struct { - name string - httpStubs func(*httpmock.Registry) - askStubs func(*prompt.AskStubber) - opts *WatchOptions - tty bool - wantErr bool - errMsg string - wantOut string + name string + httpStubs func(*httpmock.Registry) + promptStubs func(*prompter.MockPrompter) + opts *WatchOptions + tty bool + wantErr bool + errMsg string + wantOut string }{ { name: "run ID provided run already completed", @@ -269,10 +269,12 @@ func TestWatchRun(t *testing.T) { Prompt: true, }, httpStubs: successfulRunStubs, - askStubs: func(as *prompt.AskStubber) { - as.StubPrompt("Select a workflow run"). - AssertOptions([]string{"* commit1, CI (trunk) Feb 23, 2021", "* commit2, CI (trunk) Feb 23, 2021"}). - AnswerWith("* commit2, CI (trunk) Feb 23, 2021") + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"* commit1, CI (trunk) Feb 23, 2021", "* commit2, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "* commit2, CI (trunk) Feb 23, 2021") + }) }, wantOut: "\x1b[?1049h\x1b[0;0H\x1b[JRefreshing run status every 0 seconds. Press Ctrl+C to quit.\n\n* trunk CI · 2\nTriggered via push about 59 minutes ago\n\nJOBS\n✓ cool job in 4m34s (ID 10)\n ✓ fob the barz\n ✓ barz the fob\n\x1b[?1049l✓ trunk CI · 2\nTriggered via push about 59 minutes ago\n\nJOBS\n✓ cool job in 4m34s (ID 10)\n ✓ fob the barz\n ✓ barz the fob\n\n✓ Run CI (2) completed with 'success'\n", }, @@ -285,10 +287,12 @@ func TestWatchRun(t *testing.T) { ExitStatus: true, }, httpStubs: failedRunStubs, - askStubs: func(as *prompt.AskStubber) { - as.StubPrompt("Select a workflow run"). - AssertOptions([]string{"* commit1, CI (trunk) Feb 23, 2021", "* commit2, CI (trunk) Feb 23, 2021"}). - AnswerWith("* commit2, CI (trunk) Feb 23, 2021") + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow run", + []string{"* commit1, CI (trunk) Feb 23, 2021", "* commit2, CI (trunk) Feb 23, 2021"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "* commit2, CI (trunk) Feb 23, 2021") + }) }, wantOut: "\x1b[?1049h\x1b[0;0H\x1b[JRefreshing run status every 0 seconds. Press Ctrl+C to quit.\n\n* trunk CI · 2\nTriggered via push about 59 minutes ago\n\n\x1b[?1049lX trunk CI · 2\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\nX Run CI (2) completed with 'failure'\n", wantErr: true, @@ -317,10 +321,10 @@ func TestWatchRun(t *testing.T) { } t.Run(tt.name, func(t *testing.T) { - //nolint:staticcheck // SA1019: prompt.NewAskStubber is deprecated: use PrompterMock - as := prompt.NewAskStubber(t) - if tt.askStubs != nil { - tt.askStubs(as) + pm := prompter.NewMockPrompter(t) + tt.opts.Prompter = pm + if tt.promptStubs != nil { + tt.promptStubs(pm) } err := watchRun(tt.opts) From 400da5ac9457769e495d624c10ab90841cef2a0a Mon Sep 17 00:00:00 2001 From: nate smith Date: Mon, 10 Apr 2023 16:43:24 -0700 Subject: [PATCH 05/90] golf --- pkg/cmd/run/cancel/cancel.go | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/run/cancel/cancel.go b/pkg/cmd/run/cancel/cancel.go index 73953bd67..e5f77e016 100644 --- a/pkg/cmd/run/cancel/cancel.go +++ b/pkg/cmd/run/cancel/cancel.go @@ -85,11 +85,10 @@ func runCancel(opts *CancelOptions) error { if len(runs) == 0 { return fmt.Errorf("found no in progress runs to cancel") } - runID, err = shared.SelectRun(opts.Prompter, cs, runs) - if err != nil { + if runID, err = shared.SelectRun(opts.Prompter, cs, runs); err != nil { return err } - // TODO silly stopgap until dust settles and PromptForRun can just return a run + // TODO silly stopgap until dust settles and SelectRun can just return a run for _, r := range runs { if fmt.Sprintf("%d", r.ID) == runID { run = &r From 6fd17ec2d212d046c16f2f70763043bf095b1425 Mon Sep 17 00:00:00 2001 From: nate smith Date: Mon, 10 Apr 2023 16:43:31 -0700 Subject: [PATCH 06/90] delete PromptForRun --- pkg/cmd/run/shared/shared.go | 32 -------------------------------- 1 file changed, 32 deletions(-) diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go index 8cdd42f87..0f3a8fca8 100644 --- a/pkg/cmd/run/shared/shared.go +++ b/pkg/cmd/run/shared/shared.go @@ -9,12 +9,10 @@ import ( "strings" "time" - "github.com/AlecAivazis/survey/v2" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" workflowShared "github.com/cli/cli/v2/pkg/cmd/workflow/shared" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/prompt" ) type Prompter interface { @@ -467,36 +465,6 @@ func SelectRun(p Prompter, cs *iostreams.ColorScheme, runs []Run) (string, error return fmt.Sprintf("%d", runs[selected].ID), nil } -// TODO: this should be deprecated in favor of SelectRun -func PromptForRun(cs *iostreams.ColorScheme, runs []Run) (string, error) { - var selected int - now := time.Now() - - candidates := []string{} - - for _, run := range runs { - symbol, _ := Symbol(cs, run.Status, run.Conclusion) - candidates = append(candidates, - // TODO truncate commit message, long ones look terrible - fmt.Sprintf("%s %s, %s (%s) %s", symbol, run.Title(), run.WorkflowName(), run.HeadBranch, preciseAgo(now, run.StartedTime()))) - } - - // TODO consider custom filter so it's fuzzier. right now matches start anywhere in string but - // become contiguous - //nolint:staticcheck // SA1019: prompt.SurveyAskOne is deprecated: use Prompter - err := prompt.SurveyAskOne(&survey.Select{ - Message: "Select a workflow run", - Options: candidates, - PageSize: 10, - }, &selected) - - if err != nil { - return "", err - } - - return fmt.Sprintf("%d", runs[selected].ID), nil -} - func GetRun(client *api.Client, repo ghrepo.Interface, runID string, attempt uint64) (*Run, error) { var result Run From d4a8d15a8a3ed15e5e3eb417273c5b401013e320 Mon Sep 17 00:00:00 2001 From: nate smith Date: Mon, 10 Apr 2023 17:37:36 -0700 Subject: [PATCH 07/90] implement multi select support for prompter --- internal/prompter/prompter.go | 19 ++++++++++--- internal/prompter/prompter_mock.go | 44 +++++++++++++++--------------- internal/prompter/test.go | 10 +++---- 3 files changed, 42 insertions(+), 31 deletions(-) diff --git a/internal/prompter/prompter.go b/internal/prompter/prompter.go index a9cf77992..60c223cff 100644 --- a/internal/prompter/prompter.go +++ b/internal/prompter/prompter.go @@ -13,7 +13,7 @@ import ( //go:generate moq -rm -out prompter_mock.go . Prompter type Prompter interface { Select(string, string, []string) (int, error) - MultiSelect(string, string, []string) ([]string, error) + MultiSelect(string, []string, []string) ([]string, error) Input(string, string) (string, error) InputHostname() (string, error) Password(string) (string, error) @@ -72,15 +72,26 @@ func (p *surveyPrompter) Select(message, defaultValue string, options []string) return } -func (p *surveyPrompter) MultiSelect(message, defaultValue string, options []string) (result []string, err error) { +func (p *surveyPrompter) MultiSelect(message string, defaultValue, options []string) (result []string, err error) { q := &survey.MultiSelect{ Message: message, Options: options, PageSize: 20, } - if defaultValue != "" { - q.Default = defaultValue + // TODO will I regret this returning []string and not []int? + + if defaultValue != nil && len(defaultValue) > 0 { + // TODO I don't actually know that this is needed, just being extra cautious + validatedDefault := []string{} + for _, x := range defaultValue { + for _, y := range options { + if x == y { + validatedDefault = append(validatedDefault, x) + } + } + } + q.Default = validatedDefault } err = p.ask(q, &result) diff --git a/internal/prompter/prompter_mock.go b/internal/prompter/prompter_mock.go index 859832450..174375bfd 100644 --- a/internal/prompter/prompter_mock.go +++ b/internal/prompter/prompter_mock.go @@ -35,7 +35,7 @@ var _ Prompter = &PrompterMock{} // MarkdownEditorFunc: func(s1 string, s2 string, b bool) (string, error) { // panic("mock out the MarkdownEditor method") // }, -// MultiSelectFunc: func(s1 string, s2 string, strings []string) ([]string, error) { +// MultiSelectFunc: func(s string, strings1 []string, strings2 []string) ([]string, error) { // panic("mock out the MultiSelect method") // }, // PasswordFunc: func(s string) (string, error) { @@ -70,7 +70,7 @@ type PrompterMock struct { MarkdownEditorFunc func(s1 string, s2 string, b bool) (string, error) // MultiSelectFunc mocks the MultiSelect method. - MultiSelectFunc func(s1 string, s2 string, strings []string) ([]string, error) + MultiSelectFunc func(s string, strings1 []string, strings2 []string) ([]string, error) // PasswordFunc mocks the Password method. PasswordFunc func(s string) (string, error) @@ -116,12 +116,12 @@ type PrompterMock struct { } // MultiSelect holds details about calls to the MultiSelect method. MultiSelect []struct { - // S1 is the s1 argument value. - S1 string - // S2 is the s2 argument value. - S2 string - // Strings is the strings argument value. - Strings []string + // S is the s argument value. + S string + // Strings1 is the strings1 argument value. + Strings1 []string + // Strings2 is the strings2 argument value. + Strings2 []string } // Password holds details about calls to the Password method. Password []struct { @@ -348,23 +348,23 @@ func (mock *PrompterMock) MarkdownEditorCalls() []struct { } // MultiSelect calls MultiSelectFunc. -func (mock *PrompterMock) MultiSelect(s1 string, s2 string, strings []string) ([]string, error) { +func (mock *PrompterMock) MultiSelect(s string, strings1 []string, strings2 []string) ([]string, error) { if mock.MultiSelectFunc == nil { panic("PrompterMock.MultiSelectFunc: method is nil but Prompter.MultiSelect was just called") } callInfo := struct { - S1 string - S2 string - Strings []string + S string + Strings1 []string + Strings2 []string }{ - S1: s1, - S2: s2, - Strings: strings, + S: s, + Strings1: strings1, + Strings2: strings2, } mock.lockMultiSelect.Lock() mock.calls.MultiSelect = append(mock.calls.MultiSelect, callInfo) mock.lockMultiSelect.Unlock() - return mock.MultiSelectFunc(s1, s2, strings) + return mock.MultiSelectFunc(s, strings1, strings2) } // MultiSelectCalls gets all the calls that were made to MultiSelect. @@ -372,14 +372,14 @@ func (mock *PrompterMock) MultiSelect(s1 string, s2 string, strings []string) ([ // // len(mockedPrompter.MultiSelectCalls()) func (mock *PrompterMock) MultiSelectCalls() []struct { - S1 string - S2 string - Strings []string + S string + Strings1 []string + Strings2 []string } { var calls []struct { - S1 string - S2 string - Strings []string + S string + Strings1 []string + Strings2 []string } mock.lockMultiSelect.RLock() calls = mock.calls.MultiSelect diff --git a/internal/prompter/test.go b/internal/prompter/test.go index a2d0b83ee..a5cebacda 100644 --- a/internal/prompter/test.go +++ b/internal/prompter/test.go @@ -50,7 +50,7 @@ type ConfirmStub struct { type MultiSelectStub struct { Prompt string ExpectedOpts []string - Fn func(string, string, []string) ([]string, error) + Fn func(string, []string, []string) ([]string, error) } type InputHostnameStub struct { @@ -120,11 +120,11 @@ func NewMockPrompter(t *testing.T) *MockPrompter { return s.Fn(p, d, opts) } - m.MultiSelectFunc = func(p, d string, opts []string) ([]string, error) { + m.MultiSelectFunc = func(p string, d, opts []string) ([]string, error) { var s MultiSelectStub - if len(m.SelectStubs) > 0 { + if len(m.MultiSelectStubs) > 0 { s = m.MultiSelectStubs[0] - m.SelectStubs = m.SelectStubs[1:len(m.SelectStubs)] + m.MultiSelectStubs = m.MultiSelectStubs[1:len(m.MultiSelectStubs)] } else { return []string{}, NoSuchPromptErr(p) } @@ -240,7 +240,7 @@ func (m *MockPrompter) RegisterSelect(prompt string, opts []string, stub func(_, Fn: stub}) } -func (m *MockPrompter) RegisterMultiSelect(prompt string, opts []string, stub func(_, _ string, _ []string) ([]string, error)) { +func (m *MockPrompter) RegisterMultiSelect(prompt string, d, opts []string, stub func(_ string, _, _ []string) ([]string, error)) { m.MultiSelectStubs = append(m.MultiSelectStubs, MultiSelectStub{ Prompt: prompt, ExpectedOpts: opts, From c536114de0fd6308b215ed3eaec0c8474ffbc0c2 Mon Sep 17 00:00:00 2001 From: nate smith Date: Mon, 10 Apr 2023 17:38:30 -0700 Subject: [PATCH 08/90] use new prompter in run download --- pkg/cmd/run/download/download.go | 25 ++++--------- pkg/cmd/run/download/download_test.go | 51 +++++++++------------------ 2 files changed, 23 insertions(+), 53 deletions(-) diff --git a/pkg/cmd/run/download/download.go b/pkg/cmd/run/download/download.go index 25eec5d62..4c5322806 100644 --- a/pkg/cmd/run/download/download.go +++ b/pkg/cmd/run/download/download.go @@ -5,12 +5,10 @@ import ( "fmt" "path/filepath" - "github.com/AlecAivazis/survey/v2" "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/run/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/prompt" "github.com/cli/cli/v2/pkg/set" "github.com/spf13/cobra" ) @@ -18,7 +16,7 @@ import ( type DownloadOptions struct { IO *iostreams.IOStreams Platform platform - Prompter prompter + Prompter iprompter DoPrompt bool RunID string @@ -31,13 +29,14 @@ type platform interface { List(runID string) ([]shared.Artifact, error) Download(url string, dir string) error } -type prompter interface { - Prompt(message string, options []string, result interface{}) error +type iprompter interface { + MultiSelect(string, []string, []string) ([]string, error) } func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobra.Command { opts := &DownloadOptions{ - IO: f.IOStreams, + IO: f.IOStreams, + Prompter: f.Prompter, } cmd := &cobra.Command{ @@ -85,7 +84,6 @@ func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobr client: httpClient, repo: baseRepo, } - opts.Prompter = &surveyPrompter{} if runF != nil { return runF(opts) @@ -133,8 +131,7 @@ func runDownload(opts *DownloadOptions) error { if len(options) > 10 { options = options[:10] } - err := opts.Prompter.Prompt("Select artifacts to download:", options, &wantNames) - if err != nil { + if wantNames, err = opts.Prompter.MultiSelect("Select artifacts to download:", nil, options); err != nil { return err } if len(wantNames) == 0 { @@ -194,13 +191,3 @@ func matchAnyPattern(patterns []string, name string) bool { } return false } - -type surveyPrompter struct{} - -func (sp *surveyPrompter) Prompt(message string, options []string, result interface{}) error { - //nolint:staticcheck // SA1019: prompt.SurveyAskOne is deprecated: use Prompter - return prompt.SurveyAskOne(&survey.MultiSelect{ - Message: message, - Options: options, - }, result) -} diff --git a/pkg/cmd/run/download/download_test.go b/pkg/cmd/run/download/download_test.go index 10c7bbe3c..3640f93a0 100644 --- a/pkg/cmd/run/download/download_test.go +++ b/pkg/cmd/run/download/download_test.go @@ -8,6 +8,7 @@ import ( "testing" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/run/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -144,11 +145,11 @@ func Test_NewCmdDownload(t *testing.T) { func Test_runDownload(t *testing.T) { tests := []struct { - name string - opts DownloadOptions - mockAPI func(*mockPlatform) - mockPrompt func(*mockPrompter) - wantErr string + name string + opts DownloadOptions + mockAPI func(*mockPlatform) + promptStubs func(*prompter.MockPrompter) + wantErr string }{ { name: "download non-expired", @@ -281,13 +282,11 @@ func Test_runDownload(t *testing.T) { }, nil) p.On("Download", "http://download.com/artifact2.zip", ".").Return(nil) }, - mockPrompt: func(p *mockPrompter) { - p.On("Prompt", "Select artifacts to download:", []string{"artifact-1", "artifact-2"}, mock.AnythingOfType("*[]string")). - Run(func(args mock.Arguments) { - result := args.Get(2).(*[]string) - *result = []string{"artifact-2"} - }). - Return(nil) + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterMultiSelect("Select artifacts to download:", nil, []string{"artifact-1", "artifact-2"}, + func(_ string, _, opts []string) ([]string, error) { + return []string{"artifact-2"}, nil + }) }, }, } @@ -297,7 +296,12 @@ func Test_runDownload(t *testing.T) { ios, _, stdout, stderr := iostreams.Test() opts.IO = ios opts.Platform = newMockPlatform(t, tt.mockAPI) - opts.Prompter = newMockPrompter(t, tt.mockPrompt) + + pm := prompter.NewMockPrompter(t) + opts.Prompter = pm + if tt.promptStubs != nil { + tt.promptStubs(pm) + } err := runDownload(opts) if tt.wantErr != "" { @@ -337,24 +341,3 @@ func (p *mockPlatform) Download(url string, dir string) error { args := p.Called(url, dir) return args.Error(0) } - -type mockPrompter struct { - mock.Mock -} - -func newMockPrompter(t *testing.T, config func(*mockPrompter)) *mockPrompter { - m := &mockPrompter{} - m.Test(t) - t.Cleanup(func() { - m.AssertExpectations(t) - }) - if config != nil { - config(m) - } - return m -} - -func (p *mockPrompter) Prompt(msg string, opts []string, res interface{}) error { - args := p.Called(msg, opts, res) - return args.Error(0) -} From cb0d2a86715b18ca6833222dee6b62351ca87397 Mon Sep 17 00:00:00 2001 From: nate smith Date: Mon, 10 Apr 2023 18:03:13 -0700 Subject: [PATCH 09/90] linter appeasement --- internal/prompter/prompter.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/prompter/prompter.go b/internal/prompter/prompter.go index 60c223cff..ada470d06 100644 --- a/internal/prompter/prompter.go +++ b/internal/prompter/prompter.go @@ -81,7 +81,7 @@ func (p *surveyPrompter) MultiSelect(message string, defaultValue, options []str // TODO will I regret this returning []string and not []int? - if defaultValue != nil && len(defaultValue) > 0 { + if len(defaultValue) > 0 { // TODO I don't actually know that this is needed, just being extra cautious validatedDefault := []string{} for _, x := range defaultValue { From 65720e498e623795b6d44904f302f04a987a1f77 Mon Sep 17 00:00:00 2001 From: Josh Kraft Date: Fri, 21 Apr 2023 09:47:04 -0600 Subject: [PATCH 10/90] implement code search updates --- pkg/cmd/search/code/code.go | 218 +++++++++++++++++++ pkg/cmd/search/code/code_test.go | 347 +++++++++++++++++++++++++++++++ pkg/cmd/search/search.go | 2 + pkg/iostreams/color.go | 34 ++- pkg/search/query.go | 4 + pkg/search/query_test.go | 8 +- pkg/search/result.go | 52 +++++ pkg/search/result_test.go | 45 ++++ pkg/search/searcher.go | 29 +++ pkg/search/searcher_mock.go | 44 ++++ pkg/search/searcher_test.go | 151 ++++++++++++++ 11 files changed, 924 insertions(+), 10 deletions(-) create mode 100644 pkg/cmd/search/code/code.go create mode 100644 pkg/cmd/search/code/code_test.go diff --git a/pkg/cmd/search/code/code.go b/pkg/cmd/search/code/code.go new file mode 100644 index 000000000..e8d4a6405 --- /dev/null +++ b/pkg/cmd/search/code/code.go @@ -0,0 +1,218 @@ +package code + +import ( + "fmt" + "strconv" + "strings" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/internal/browser" + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/internal/text" + "github.com/cli/cli/v2/pkg/cmd/search/shared" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/cli/v2/pkg/search" + "github.com/spf13/cobra" +) + +type CodeOptions struct { + Browser browser.Browser + Exporter cmdutil.Exporter + IO *iostreams.IOStreams + Query search.Query + Searcher search.Searcher + WebMode bool +} + +func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Command { + opts := &CodeOptions{ + Browser: f.Browser, + IO: f.IOStreams, + Query: search.Query{Kind: search.KindCode, TextMatch: true}, + } + + cmd := &cobra.Command{ + Use: "code []", + Short: "Search for code", + Long: heredoc.Doc(` + Search for code on GitHub. + + The command supports constructing queries using the GitHub search syntax, + using the parameter and qualifier flags, or a combination of the two. + + At least one search term is required when searching code. + + GitHub search syntax is documented at: + + `), + Example: heredoc.Doc(` + # search code matching "react" and "lifecycle" + $ gh search code react lifecycle + + # search code matching "error handling" + $ gh search code "error handling" + + # search code matching "deque" in Python files + $ gh search code deque --language=python + + # search code matching "cli" in repositories owned by microsoft organization + $ gh search code cli --owner=microsoft + + # search code matching "html" in repositories owned by octocat + $ gh search code html --owner=octocat + + # search code matching "panic" in cli repository + $ gh search code panic --repo cli/cli + + # search code matching keyword "lint" in package.json files + $ gh search code lint --filename package.json + `), + RunE: func(c *cobra.Command, args []string) error { + if len(args) == 0 && c.Flags().NFlag() == 0 { + return cmdutil.FlagErrorf("specify search keywords or flags") + } + if opts.Query.Limit < 1 || opts.Query.Limit > shared.SearchMaxResults { + return cmdutil.FlagErrorf("`--limit` must be between 1 and 1000") + } + opts.Query.Keywords = args + if runF != nil { + return runF(opts) + } + var err error + opts.Searcher, err = shared.Searcher(f) + if err != nil { + return err + } + return codeRun(opts) + }, + } + + // Output flags + cmdutil.AddJSONFlags(cmd, &opts.Exporter, search.CodeFields) + cmd.Flags().BoolVarP(&opts.WebMode, "web", "w", false, "Open the search query in the web browser") + + // Query parameter flags + cmd.Flags().IntVarP(&opts.Query.Limit, "limit", "L", 30, "Maximum number of code results to fetch") + + // Query qualifier flags + cmd.Flags().StringVar(&opts.Query.Qualifiers.Extension, "extension", "", "Filter on file extension") + cmd.Flags().StringVar(&opts.Query.Qualifiers.Filename, "filename", "", "Filter on filename") + cmdutil.StringSliceEnumFlag(cmd, &opts.Query.Qualifiers.In, "match", "", nil, []string{"file", "path"}, "Restrict search to file contents or file path") + cmd.Flags().StringVarP(&opts.Query.Qualifiers.Language, "language", "l", "", "Filter results by language") + cmd.Flags().StringSliceVar(&opts.Query.Qualifiers.Repo, "repo", nil, "Filter on repository") + cmd.Flags().StringVar(&opts.Query.Qualifiers.Size, "size", "", "Filter on size range, in kilobytes") + cmd.Flags().StringVar(&opts.Query.Qualifiers.User, "owner", "", "Filter on owner") + + return cmd +} + +func codeRun(opts *CodeOptions) error { + io := opts.IO + if opts.WebMode { + url := opts.Searcher.URL(opts.Query) + if io.IsStdoutTTY() { + fmt.Fprintf(io.ErrOut, "Opening %s in your browser.\n", text.DisplayURL(url)) + } + return opts.Browser.Browse(url) + } + io.StartProgressIndicator() + results, err := opts.Searcher.Code(opts.Query) + io.StopProgressIndicator() + if err != nil { + return err + } + if len(results.Items) == 0 && opts.Exporter == nil { + return cmdutil.NewNoResultsError("no code results matched your search") + } + if err := io.StartPager(); err == nil { + defer io.StopPager() + } else { + fmt.Fprintf(io.ErrOut, "failed to start pager: %v\n", err) + } + if opts.Exporter != nil { + return opts.Exporter.Write(io, results) + } + + return displayResults(io, results, opts.Query.Limit) +} + +func displayResults(io *iostreams.IOStreams, results search.CodeResult, limit int) error { + cs := io.ColorScheme() + tp := tableprinter.New(io) + displayed := 0 + for _, code := range results.Items { + if displayed == limit { + break + } + if io.IsStdoutTTY() { + header := fmt.Sprintf("%s %s", cs.GreenBold(code.Repo.FullName), cs.GreenBold(code.Path)) + tp.AddField(header) + tp.EndRow() + } + row := 0 + for _, textMatch := range code.TextMatches { + out, shouldPrint := buildOutput(textMatch, cs) + + for i, line := range strings.Split(out, "\n") { + if !shouldPrint[i] { + continue + } + if displayed == limit { + break + } + if io.IsStdoutTTY() { + tp.AddField(fmt.Sprintf("%s: %s", cs.YellowBold(strconv.Itoa(row+1)), line)) + } else { + tp.AddField(fmt.Sprintf("%s %s: %s", code.Repo.FullName, code.Path, line)) + } + tp.EndRow() + row++ + displayed++ + } + } + } + if io.IsStdoutTTY() { + header := fmt.Sprintf("Showing %d of %d results\n\n", displayed, max(displayed, results.Total)) + fmt.Fprintf(io.Out, "\n%s", header) + } + return tp.Render() +} + +func buildOutput(tm search.TextMatch, cs *iostreams.ColorScheme) (string, map[int]bool) { + shouldHighlight := getHighlightIndices(tm.Matches) + linesToPrint := make(map[int]bool) + line := 0 + var out strings.Builder + for i, c := range tm.Fragment { + if shouldHighlight[i] { + out.WriteString(cs.Yellow(string(c))) + linesToPrint[line] = true + } else { + out.WriteRune(c) + } + if c == '\n' { + line++ + } + } + return out.String(), linesToPrint +} + +func getHighlightIndices(matches []search.Match) map[int]bool { + m := make(map[int]bool) + for _, match := range matches { + start := match.Indices[0] + stop := match.Indices[1] + for i := start; i < stop; i++ { + m[i] = true + } + } + return m +} + +func max(a, b int) int { + if b < a { + return a + } + return b +} diff --git a/pkg/cmd/search/code/code_test.go b/pkg/cmd/search/code/code_test.go new file mode 100644 index 000000000..6017996ba --- /dev/null +++ b/pkg/cmd/search/code/code_test.go @@ -0,0 +1,347 @@ +package code + +import ( + "bytes" + "fmt" + "testing" + + "github.com/cli/cli/v2/internal/browser" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/cli/v2/pkg/search" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" +) + +func TestNewCmdCode(t *testing.T) { + tests := []struct { + name string + input string + output CodeOptions + wantErr bool + errMsg string + }{ + { + name: "no arguments", + input: "", + wantErr: true, + errMsg: "specify search keywords or flags", + }, + { + name: "keyword arguments", + input: "react lifecycle", + output: CodeOptions{ + Query: search.Query{ + Keywords: []string{"react", "lifecycle"}, + Kind: "code", + Limit: 30, + TextMatch: true, + }, + }, + }, + { + name: "web flag", + input: "--web", + output: CodeOptions{ + Query: search.Query{ + Keywords: []string{}, + Kind: "code", + Limit: 30, + TextMatch: true, + }, + WebMode: true, + }, + }, + { + name: "limit flag", + input: "--limit 10", + output: CodeOptions{ + Query: search.Query{ + Keywords: []string{}, + Kind: "code", + Limit: 10, + TextMatch: true, + }, + }, + }, + { + name: "invalid limit flag", + input: "--limit 1001", + wantErr: true, + errMsg: "`--limit` must be between 1 and 1000", + }, + { + name: "qualifier flags", + input: ` + --extension=extension + --filename=filename + --match=path,file + --language=language + --repo=owner/repo + --size=5 + --owner=owner + `, + output: CodeOptions{ + Query: search.Query{ + Keywords: []string{}, + Kind: "code", + Limit: 30, + TextMatch: true, + Qualifiers: search.Qualifiers{ + Extension: "extension", + Filename: "filename", + In: []string{"path", "file"}, + Language: "language", + Repo: []string{"owner/repo"}, + Size: "5", + User: "owner", + }, + }, + }, + }, + } + + 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.input) + assert.NoError(t, err) + var gotOpts *CodeOptions + cmd := NewCmdCode(f, func(opts *CodeOptions) 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.wantErr { + assert.EqualError(t, err, tt.errMsg) + return + } + + assert.NoError(t, err) + assert.Equal(t, tt.output.Query, gotOpts.Query) + assert.Equal(t, tt.output.WebMode, gotOpts.WebMode) + }) + } +} + +func TestCodeRun(t *testing.T) { + var query = search.Query{ + Keywords: []string{"map"}, + Kind: "code", + Limit: 30, + Qualifiers: search.Qualifiers{ + Language: "go", + Repo: []string{"cli/cli"}, + }, + TextMatch: true, + } + tests := []struct { + errMsg string + name string + opts *CodeOptions + tty bool + wantErr bool + wantStderr string + wantStdout string + }{ + { + name: "displays results tty", + opts: &CodeOptions{ + Query: query, + Searcher: &search.SearcherMock{ + CodeFunc: func(query search.Query) (search.CodeResult, error) { + return search.CodeResult{ + IncompleteResults: false, + Items: []search.Code{ + { + Name: "context.go", + Path: "context/context.go", + Repo: search.Repository{ + FullName: "cli/cli", + }, + TextMatches: []search.TextMatch{ + { + Fragment: "\t}\n\n\tvar repos []*api.Repository\n\trepoMap := map[string]bool{}\n\n\tadd := func(r *api.Repository) {\n\t\tfn := ghrepo.FullName(r)", + Matches: []search.Match{ + { + Text: "Map", + Indices: []int{38, 41}, + }, + { + Text: "map", + Indices: []int{45, 48}, + }, + }, + }, + }, + }, + { + Name: "pr.go", + Path: "pkg/cmd/pr/pr.go", + Repo: search.Repository{ + FullName: "cli/cli", + }, + TextMatches: []search.TextMatch{ + { + + Fragment: "\t\t\t$ gh pr create --fill\n\t\t\t$ gh pr view --web\n\t\t`),\n\t\tAnnotations: map[string]string{\n\t\t\t\"help:arguments\": heredoc.Doc(`\n\t\t\t\tA pull request can be supplied as argument in any of the following formats:\n\t\t\t\t- by number, e.g. \"123\";", + Matches: []search.Match{ + { + Text: "map", + Indices: []int{68, 71}, + }, + }, + }, + }, + }, + }, + Total: 2, + }, nil + }, + }, + }, + tty: true, + wantStdout: "\nShowing 2 of 2 results\n\ncli/cli context/context.go\n1: \trepoMap := map[string]bool{}\ncli/cli pkg/cmd/pr/pr.go\n1: \t\tAnnotations: map[string]string{\n", + }, + { + name: "displays results notty", + opts: &CodeOptions{ + Query: query, + Searcher: &search.SearcherMock{ + CodeFunc: func(query search.Query) (search.CodeResult, error) { + return search.CodeResult{ + IncompleteResults: false, + Items: []search.Code{ + { + Name: "context.go", + Path: "context/context.go", + Repo: search.Repository{ + FullName: "cli/cli", + }, + TextMatches: []search.TextMatch{ + { + Fragment: "\t}\n\n\tvar repos []*api.Repository\n\trepoMap := map[string]bool{}\n\n\tadd := func(r *api.Repository) {\n\t\tfn := ghrepo.FullName(r)", + Matches: []search.Match{ + { + Text: "Map", + Indices: []int{38, 41}, + }, + { + Text: "map", + Indices: []int{45, 48}, + }, + }, + }, + }, + }, + { + Name: "pr.go", + Path: "pkg/cmd/pr/pr.go", + Repo: search.Repository{ + FullName: "cli/cli", + }, + TextMatches: []search.TextMatch{ + { + + Fragment: "\t\t\t$ gh pr create --fill\n\t\t\t$ gh pr view --web\n\t\t`),\n\t\tAnnotations: map[string]string{\n\t\t\t\"help:arguments\": heredoc.Doc(`\n\t\t\t\tA pull request can be supplied as argument in any of the following formats:\n\t\t\t\t- by number, e.g. \"123\";", + Matches: []search.Match{ + { + Text: "map", + Indices: []int{68, 71}, + }, + }, + }, + }, + }, + }, + Total: 2, + }, nil + }, + }, + }, + tty: false, + wantStdout: "cli/cli context/context.go: \trepoMap := map[string]bool{}\ncli/cli pkg/cmd/pr/pr.go: \t\tAnnotations: map[string]string{\n", + }, + { + name: "displays no results", + opts: &CodeOptions{ + Query: query, + Searcher: &search.SearcherMock{ + CodeFunc: func(query search.Query) (search.CodeResult, error) { + return search.CodeResult{}, nil + }, + }, + }, + wantErr: true, + errMsg: "no code results matched your search", + }, + { + name: "displays search error", + opts: &CodeOptions{ + Query: query, + Searcher: &search.SearcherMock{ + CodeFunc: func(query search.Query) (search.CodeResult, error) { + return search.CodeResult{}, fmt.Errorf("error with query") + }, + }, + }, + wantErr: true, + errMsg: "error with query", + }, + { + name: "opens browser for web mode tty", + opts: &CodeOptions{ + Browser: &browser.Stub{}, + Query: query, + Searcher: &search.SearcherMock{ + URLFunc: func(query search.Query) string { + return "https://github.com/search?type=code&q=map+repo%3Acli%2Fcli" + }, + }, + WebMode: true, + }, + tty: true, + wantStderr: "Opening github.com/search in your browser.\n", + }, + { + name: "opens browser for web mode notty", + opts: &CodeOptions{ + Browser: &browser.Stub{}, + Query: query, + Searcher: &search.SearcherMock{ + URLFunc: func(query search.Query) string { + return "https://github.com/search?type=code&q=map+repo%3Acli%2Fcli" + }, + }, + WebMode: true, + }, + }, + } + + for _, tt := range tests { + ios, _, stdout, stderr := iostreams.Test() + ios.SetStdinTTY(tt.tty) + ios.SetStdoutTTY(tt.tty) + ios.SetStderrTTY(tt.tty) + tt.opts.IO = ios + t.Run(tt.name, func(t *testing.T) { + err := codeRun(tt.opts) + if tt.wantErr { + assert.EqualError(t, err, tt.errMsg) + return + } else if err != nil { + t.Fatalf("codeRun unexpected error: %v", err) + } + assert.Equal(t, tt.wantStdout, stdout.String()) + assert.Equal(t, tt.wantStderr, stderr.String()) + }) + } +} diff --git a/pkg/cmd/search/search.go b/pkg/cmd/search/search.go index 7b9a4a653..e8714065b 100644 --- a/pkg/cmd/search/search.go +++ b/pkg/cmd/search/search.go @@ -4,6 +4,7 @@ import ( "github.com/cli/cli/v2/pkg/cmdutil" "github.com/spf13/cobra" + searchCodeCmd "github.com/cli/cli/v2/pkg/cmd/search/code" searchCommitsCmd "github.com/cli/cli/v2/pkg/cmd/search/commits" searchIssuesCmd "github.com/cli/cli/v2/pkg/cmd/search/issues" searchPrsCmd "github.com/cli/cli/v2/pkg/cmd/search/prs" @@ -17,6 +18,7 @@ func NewCmdSearch(f *cmdutil.Factory) *cobra.Command { Long: "Search across all of GitHub.", } + cmd.AddCommand(searchCodeCmd.NewCmdCode(f, nil)) cmd.AddCommand(searchCommitsCmd.NewCmdCommits(f, nil)) cmd.AddCommand(searchIssuesCmd.NewCmdIssues(f, nil)) cmd.AddCommand(searchPrsCmd.NewCmdPrs(f, nil)) diff --git a/pkg/iostreams/color.go b/pkg/iostreams/color.go index 1d35c05d9..12ff49c54 100644 --- a/pkg/iostreams/color.go +++ b/pkg/iostreams/color.go @@ -9,15 +9,17 @@ import ( ) var ( - magenta = ansi.ColorFunc("magenta") - cyan = ansi.ColorFunc("cyan") - red = ansi.ColorFunc("red") - yellow = ansi.ColorFunc("yellow") - blue = ansi.ColorFunc("blue") - green = ansi.ColorFunc("green") - gray = ansi.ColorFunc("black+h") - bold = ansi.ColorFunc("default+b") - cyanBold = ansi.ColorFunc("cyan+b") + magenta = ansi.ColorFunc("magenta") + cyan = ansi.ColorFunc("cyan") + red = ansi.ColorFunc("red") + yellow = ansi.ColorFunc("yellow") + blue = ansi.ColorFunc("blue") + green = ansi.ColorFunc("green") + gray = ansi.ColorFunc("black+h") + bold = ansi.ColorFunc("default+b") + cyanBold = ansi.ColorFunc("cyan+b") + greenBold = ansi.ColorFunc("green+b") + yellowBold = ansi.ColorFunc("yellow+b") gray256 = func(t string) string { return fmt.Sprintf("\x1b[%d;5;%dm%s\x1b[m", 38, 242, t) @@ -71,6 +73,13 @@ func (c *ColorScheme) Yellowf(t string, args ...interface{}) string { return c.Yellow(fmt.Sprintf(t, args...)) } +func (c *ColorScheme) YellowBold(t string) string { + if !c.enabled { + return t + } + return yellowBold(t) +} + func (c *ColorScheme) Green(t string) string { if !c.enabled { return t @@ -82,6 +91,13 @@ func (c *ColorScheme) Greenf(t string, args ...interface{}) string { return c.Green(fmt.Sprintf(t, args...)) } +func (c *ColorScheme) GreenBold(t string) string { + if !c.enabled { + return t + } + return greenBold(t) +} + func (c *ColorScheme) Gray(t string) string { if !c.enabled { return t diff --git a/pkg/search/query.go b/pkg/search/query.go index fab6305f6..cba333984 100644 --- a/pkg/search/query.go +++ b/pkg/search/query.go @@ -10,6 +10,7 @@ import ( const ( KindRepositories = "repositories" + KindCode = "code" KindIssues = "issues" KindCommits = "commits" ) @@ -22,6 +23,7 @@ type Query struct { Page int Qualifiers Qualifiers Sort string + TextMatch bool } type Qualifiers struct { @@ -41,6 +43,8 @@ type Qualifiers struct { CommitterName string Created string Draft *bool + Extension string + Filename string Followers string Fork string Forks string diff --git a/pkg/search/query_test.go b/pkg/search/query_test.go index dacc033f7..58992ba92 100644 --- a/pkg/search/query_test.go +++ b/pkg/search/query_test.go @@ -23,6 +23,8 @@ func TestQueryString(t *testing.T) { AuthorEmail: "foo@example.com", CommitterDate: "2021-02-28", Created: "created", + Extension: "go", + Filename: ".vimrc", Followers: "1", Fork: "true", Forks: "2", @@ -40,7 +42,7 @@ func TestQueryString(t *testing.T) { Is: []string{"public"}, }, }, - out: "some keywords archived:true author-email:foo@example.com committer-date:2021-02-28 created:created followers:1 fork:true forks:2 good-first-issues:3 help-wanted-issues:4 in:description in:readme is:public language:language license:license pushed:updated size:5 stars:6 topic:topic topics:7 user:user", + out: "some keywords archived:true author-email:foo@example.com committer-date:2021-02-28 created:created extension:go filename:.vimrc followers:1 fork:true forks:2 good-first-issues:3 help-wanted-issues:4 in:description in:readme is:public language:language license:license pushed:updated size:5 stars:6 topic:topic topics:7 user:user", }, { name: "quotes keywords", @@ -86,6 +88,8 @@ func TestQualifiersMap(t *testing.T) { AuthorEmail: "foo@example.com", CommitterDate: "2021-02-28", Created: "created", + Extension: "go", + Filename: ".vimrc", Followers: "1", Fork: "true", Forks: "2", @@ -107,6 +111,8 @@ func TestQualifiersMap(t *testing.T) { "author-email": {"foo@example.com"}, "committer-date": {"2021-02-28"}, "created": {"created"}, + "extension": {"go"}, + "filename": {".vimrc"}, "followers": {"1"}, "fork": {"true"}, "forks": {"2"}, diff --git a/pkg/search/result.go b/pkg/search/result.go index d7113bfda..beac37e4f 100644 --- a/pkg/search/result.go +++ b/pkg/search/result.go @@ -6,6 +6,15 @@ import ( "time" ) +var CodeFields = []string{ + "name", + "path", + "repository", + "sha", + "textMatches", + "url", +} + var CommitFields = []string{ "author", "commit", @@ -72,6 +81,12 @@ var PullRequestFields = append(IssueFields, "isDraft", ) +type CodeResult struct { + IncompleteResults bool `json:"incomplete_results"` + Items []Code `json:"items"` + Total int `json:"total_count"` +} + type CommitsResult struct { IncompleteResults bool `json:"incomplete_results"` Items []Commit `json:"items"` @@ -90,6 +105,28 @@ type IssuesResult struct { Total int `json:"total_count"` } +type Code struct { + Name string `json:"name"` + Path string `json:"path"` + Repo Repository `json:"repository"` + Sha string `json:"sha"` + TextMatches []TextMatch `json:"text_matches"` + URL string `json:"html_url"` +} + +type TextMatch struct { + Fragment string `json:"fragment"` + Matches []Match `json:"matches"` + ObjectURL string `json:"object_url"` + ObjectType string `json:"object_type"` + Property string `json:"property"` +} + +type Match struct { + Indices []int `json:"indices"` + Text string `json:"text"` +} + type Commit struct { Author User `json:"author"` Committer User `json:"committer"` @@ -230,6 +267,21 @@ func (u User) ExportData() map[string]interface{} { } } +func (code Code) ExportData(fields []string) map[string]interface{} { + v := reflect.ValueOf(code) + data := map[string]interface{}{} + for _, f := range fields { + switch f { + case "repository": + data[f] = code.Repo.ExportData(RepositoryFields) + default: + sf := fieldByName(v, f) + data[f] = sf.Interface() + } + } + return data +} + func (commit Commit) ExportData(fields []string) map[string]interface{} { v := reflect.ValueOf(commit) data := map[string]interface{}{} diff --git a/pkg/search/result_test.go b/pkg/search/result_test.go index cdf424b0b..376980844 100644 --- a/pkg/search/result_test.go +++ b/pkg/search/result_test.go @@ -11,6 +11,51 @@ import ( "github.com/stretchr/testify/require" ) +func TestCodeExportData(t *testing.T) { + tests := []struct { + name string + fields []string + code Code + output string + }{ + { + name: "exports requested fields", + fields: []string{"name", "path", "textMatches"}, + code: Code{ + Repo: Repository{ + Name: "repo", + }, + Path: "path", + Name: "name", + TextMatches: []TextMatch{ + { + Fragment: "fragment", + Matches: []Match{ + { + Text: "fr", + Indices: []int{ + 0, + 1, + }, + }, + }, + }, + }, + }, + output: `{"name":"name","path":"path","textMatches":[{"object_url":"","object_type":"","property":"","fragment":"fragment","matches":[{"text":"fr","indices":[0,1]}]}]}`, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + exported := tt.code.ExportData(tt.fields) + buf := bytes.Buffer{} + enc := json.NewEncoder(&buf) + require.NoError(t, enc.Encode(exported)) + assert.Equal(t, tt.output, strings.TrimSpace(buf.String())) + }) + } +} + func TestCommitExportData(t *testing.T) { var authoredAt = time.Date(2021, 2, 27, 11, 30, 0, 0, time.UTC) var committedAt = time.Date(2021, 2, 28, 12, 30, 0, 0, time.UTC) diff --git a/pkg/search/searcher.go b/pkg/search/searcher.go index baa84c03c..889a69487 100644 --- a/pkg/search/searcher.go +++ b/pkg/search/searcher.go @@ -25,6 +25,7 @@ var jsonTypeRE = regexp.MustCompile(`[/+]json($|;)`) //go:generate moq -rm -out searcher_mock.go . Searcher type Searcher interface { + Code(Query) (CodeResult, error) Commits(Query) (CommitsResult, error) Repositories(Query) (RepositoriesResult, error) Issues(Query) (IssuesResult, error) @@ -57,6 +58,30 @@ func NewSearcher(client *http.Client, host string) Searcher { } } +func (s searcher) Code(query Query) (CodeResult, error) { + result := CodeResult{} + toRetrieve := query.Limit + var resp *http.Response + var err error + for toRetrieve > 0 { + query.Limit = min(toRetrieve, maxPerPage) + query.Page = nextPage(resp) + if query.Page == 0 { + break + } + page := CodeResult{} + resp, err = s.search(query, &page) + if err != nil { + return result, err + } + result.IncompleteResults = page.IncompleteResults + result.Total = page.Total + result.Items = append(result.Items, page.Items...) + toRetrieve = toRetrieve - len(page.Items) + } + return result, nil +} + func (s searcher) Commits(query Query) (CommitsResult, error) { result := CommitsResult{} toRetrieve := query.Limit @@ -148,6 +173,10 @@ func (s searcher) search(query Query, result interface{}) (*http.Response, error } req.Header.Set("Content-Type", "application/json; charset=utf-8") req.Header.Set("Accept", "application/vnd.github.v3+json") + if query.TextMatch { + req.Header.Set("Accept", "application/vnd.github.text-match+json") + } + resp, err := s.client.Do(req) if err != nil { return nil, err diff --git a/pkg/search/searcher_mock.go b/pkg/search/searcher_mock.go index c1eecdaf4..332539121 100644 --- a/pkg/search/searcher_mock.go +++ b/pkg/search/searcher_mock.go @@ -17,6 +17,9 @@ var _ Searcher = &SearcherMock{} // // // make and configure a mocked Searcher // mockedSearcher := &SearcherMock{ +// CodeFunc: func(query Query) (CodeResult, error) { +// panic("mock out the Code method") +// }, // CommitsFunc: func(query Query) (CommitsResult, error) { // panic("mock out the Commits method") // }, @@ -36,6 +39,9 @@ var _ Searcher = &SearcherMock{} // // } type SearcherMock struct { + // CodeFunc mocks the Code method. + CodeFunc func(query Query) (CodeResult, error) + // CommitsFunc mocks the Commits method. CommitsFunc func(query Query) (CommitsResult, error) @@ -50,6 +56,11 @@ type SearcherMock struct { // calls tracks calls to the methods. calls struct { + // Code holds details about calls to the Code method. + Code []struct { + // Query is the query argument value. + Query Query + } // Commits holds details about calls to the Commits method. Commits []struct { // Query is the query argument value. @@ -71,12 +82,45 @@ type SearcherMock struct { Query Query } } + lockCode sync.RWMutex lockCommits sync.RWMutex lockIssues sync.RWMutex lockRepositories sync.RWMutex lockURL sync.RWMutex } +// Code calls CodeFunc. +func (mock *SearcherMock) Code(query Query) (CodeResult, error) { + if mock.CodeFunc == nil { + panic("SearcherMock.CodeFunc: method is nil but Searcher.Code was just called") + } + callInfo := struct { + Query Query + }{ + Query: query, + } + mock.lockCode.Lock() + mock.calls.Code = append(mock.calls.Code, callInfo) + mock.lockCode.Unlock() + return mock.CodeFunc(query) +} + +// CodeCalls gets all the calls that were made to Code. +// Check the length with: +// +// len(mockedSearcher.CodeCalls()) +func (mock *SearcherMock) CodeCalls() []struct { + Query Query +} { + var calls []struct { + Query Query + } + mock.lockCode.RLock() + calls = mock.calls.Code + mock.lockCode.RUnlock() + return calls +} + // Commits calls CommitsFunc. func (mock *SearcherMock) Commits(query Query) (CommitsResult, error) { if mock.CommitsFunc == nil { diff --git a/pkg/search/searcher_test.go b/pkg/search/searcher_test.go index 8cc90c533..b6a8ae873 100644 --- a/pkg/search/searcher_test.go +++ b/pkg/search/searcher_test.go @@ -10,6 +10,157 @@ import ( "github.com/stretchr/testify/assert" ) +func TestSearcherCode(t *testing.T) { + query := Query{ + Keywords: []string{"keyword"}, + Kind: "code", + Limit: 30, + TextMatch: true, + Qualifiers: Qualifiers{ + Language: "go", + }, + } + + values := url.Values{ + "page": []string{"1"}, + "per_page": []string{"30"}, + "q": []string{"keyword language:go"}, + } + + tests := []struct { + name string + host string + query Query + result CodeResult + wantErr bool + errMsg string + httpStubs func(reg *httpmock.Registry) + }{ + { + name: "searches code", + query: query, + result: CodeResult{ + IncompleteResults: false, + Items: []Code{{Name: "file.go"}}, + Total: 1, + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.QueryMatcher("GET", "search/code", values), + httpmock.JSONResponse(CodeResult{ + IncompleteResults: false, + Items: []Code{{Name: "file.go"}}, + Total: 1, + }), + ) + }, + }, + { + name: "searches code for enterprise host", + host: "enterprise.com", + query: query, + result: CodeResult{ + IncompleteResults: false, + Items: []Code{{Name: "file.go"}}, + Total: 1, + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.QueryMatcher("GET", "api/v3/search/code", values), + httpmock.JSONResponse(CodeResult{ + IncompleteResults: false, + Items: []Code{{Name: "file.go"}}, + Total: 1, + }), + ) + }, + }, + { + name: "paginates results", + query: query, + result: CodeResult{ + IncompleteResults: false, + Items: []Code{{Name: "file.go"}, {Name: "file2.go"}}, + Total: 2, + }, + httpStubs: func(reg *httpmock.Registry) { + firstReq := httpmock.QueryMatcher("GET", "search/code", values) + firstRes := httpmock.JSONResponse(CodeResult{ + IncompleteResults: false, + Items: []Code{{Name: "file.go"}}, + Total: 2, + }, + ) + firstRes = httpmock.WithHeader(firstRes, "Link", `; rel="next"`) + secondReq := httpmock.QueryMatcher("GET", "search/code", url.Values{ + "page": []string{"2"}, + "per_page": []string{"29"}, + "q": []string{"keyword language:go"}, + }, + ) + secondRes := httpmock.JSONResponse(CodeResult{ + IncompleteResults: false, + Items: []Code{{Name: "file2.go"}}, + Total: 2, + }, + ) + reg.Register(firstReq, firstRes) + reg.Register(secondReq, secondRes) + }, + }, + { + name: "handles search errors", + query: query, + wantErr: true, + errMsg: heredoc.Doc(` + Invalid search query "keyword language:go". + "blah" is not a recognized date/time format. Please provide an ISO 8601 date/time value, such as YYYY-MM-DD.`), + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.QueryMatcher("GET", "search/code", values), + httpmock.WithHeader( + httpmock.StatusStringResponse(422, + `{ + "message": "Validation Failed", + "errors": [ + { + "message":"\"blah\" is not a recognized date/time format. Please provide an ISO 8601 date/time value, such as YYYY-MM-DD.", + "resource":"Search", + "field":"q", + "code":"invalid" + } + ], + "documentation_url":"https://developer.github.com/v3/search/" + }`, + ), "Content-Type", "application/json"), + ) + }, + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + reg := &httpmock.Registry{} + defer reg.Verify(t) + if tt.httpStubs != nil { + tt.httpStubs(reg) + } + client := &http.Client{Transport: reg} + if tt.host == "" { + tt.host = "github.com" + } + searcher := NewSearcher(client, tt.host) + result, err := searcher.Code(tt.query) + if tt.wantErr { + assert.EqualError(t, err, tt.errMsg) + return + } + assert.NoError(t, err) + assert.Equal(t, tt.result, result) + }) + } +} + func TestSearcherCommits(t *testing.T) { query := Query{ Keywords: []string{"keyword"}, From b0396d9af26d10bb8688be140612cae808660bb6 Mon Sep 17 00:00:00 2001 From: Josh Kraft Date: Wed, 26 Apr 2023 18:55:33 -0600 Subject: [PATCH 11/90] adopt changes to User --- pkg/cmd/search/code/code.go | 2 +- pkg/cmd/search/code/code_test.go | 2 +- pkg/search/result_test.go | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/search/code/code.go b/pkg/cmd/search/code/code.go index e8d4a6405..9d109950d 100644 --- a/pkg/cmd/search/code/code.go +++ b/pkg/cmd/search/code/code.go @@ -102,7 +102,7 @@ func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Comman cmd.Flags().StringVarP(&opts.Query.Qualifiers.Language, "language", "l", "", "Filter results by language") cmd.Flags().StringSliceVar(&opts.Query.Qualifiers.Repo, "repo", nil, "Filter on repository") cmd.Flags().StringVar(&opts.Query.Qualifiers.Size, "size", "", "Filter on size range, in kilobytes") - cmd.Flags().StringVar(&opts.Query.Qualifiers.User, "owner", "", "Filter on owner") + cmd.Flags().StringSliceVar(&opts.Query.Qualifiers.User, "owner", nil, "Filter on owner") return cmd } diff --git a/pkg/cmd/search/code/code_test.go b/pkg/cmd/search/code/code_test.go index 6017996ba..f48cb4bfc 100644 --- a/pkg/cmd/search/code/code_test.go +++ b/pkg/cmd/search/code/code_test.go @@ -94,7 +94,7 @@ func TestNewCmdCode(t *testing.T) { Language: "language", Repo: []string{"owner/repo"}, Size: "5", - User: "owner", + User: []string{"owner"}, }, }, }, diff --git a/pkg/search/result_test.go b/pkg/search/result_test.go index 376980844..0381d1856 100644 --- a/pkg/search/result_test.go +++ b/pkg/search/result_test.go @@ -42,7 +42,7 @@ func TestCodeExportData(t *testing.T) { }, }, }, - output: `{"name":"name","path":"path","textMatches":[{"object_url":"","object_type":"","property":"","fragment":"fragment","matches":[{"text":"fr","indices":[0,1]}]}]}`, + output: `{"name":"name","path":"path","textMatches":[{"fragment":"fragment","matches":[{"indices":[0,1],"text":"fr"}],"object_url":"","object_type":"","property":""}]}`, }, } for _, tt := range tests { From d82c65ac2f85abeb8f3c5d0318753aaa8dd5b37c Mon Sep 17 00:00:00 2001 From: Josh Kraft Date: Wed, 26 Apr 2023 19:15:31 -0600 Subject: [PATCH 12/90] change highlight color --- pkg/cmd/search/code/code.go | 4 ++-- pkg/iostreams/color.go | 28 ++++++++++------------------ 2 files changed, 12 insertions(+), 20 deletions(-) diff --git a/pkg/cmd/search/code/code.go b/pkg/cmd/search/code/code.go index 9d109950d..5aa15825e 100644 --- a/pkg/cmd/search/code/code.go +++ b/pkg/cmd/search/code/code.go @@ -162,7 +162,7 @@ func displayResults(io *iostreams.IOStreams, results search.CodeResult, limit in break } if io.IsStdoutTTY() { - tp.AddField(fmt.Sprintf("%s: %s", cs.YellowBold(strconv.Itoa(row+1)), line)) + tp.AddField(fmt.Sprintf("%s: %s", cs.CyanBold(strconv.Itoa(row+1)), line)) } else { tp.AddField(fmt.Sprintf("%s %s: %s", code.Repo.FullName, code.Path, line)) } @@ -186,7 +186,7 @@ func buildOutput(tm search.TextMatch, cs *iostreams.ColorScheme) (string, map[in var out strings.Builder for i, c := range tm.Fragment { if shouldHighlight[i] { - out.WriteString(cs.Yellow(string(c))) + out.WriteString(cs.CyanBold(string(c))) linesToPrint[line] = true } else { out.WriteRune(c) diff --git a/pkg/iostreams/color.go b/pkg/iostreams/color.go index 12ff49c54..6cb5a607a 100644 --- a/pkg/iostreams/color.go +++ b/pkg/iostreams/color.go @@ -9,17 +9,16 @@ import ( ) var ( - magenta = ansi.ColorFunc("magenta") - cyan = ansi.ColorFunc("cyan") - red = ansi.ColorFunc("red") - yellow = ansi.ColorFunc("yellow") - blue = ansi.ColorFunc("blue") - green = ansi.ColorFunc("green") - gray = ansi.ColorFunc("black+h") - bold = ansi.ColorFunc("default+b") - cyanBold = ansi.ColorFunc("cyan+b") - greenBold = ansi.ColorFunc("green+b") - yellowBold = ansi.ColorFunc("yellow+b") + magenta = ansi.ColorFunc("magenta") + cyan = ansi.ColorFunc("cyan") + red = ansi.ColorFunc("red") + yellow = ansi.ColorFunc("yellow") + blue = ansi.ColorFunc("blue") + green = ansi.ColorFunc("green") + gray = ansi.ColorFunc("black+h") + bold = ansi.ColorFunc("default+b") + cyanBold = ansi.ColorFunc("cyan+b") + greenBold = ansi.ColorFunc("green+b") gray256 = func(t string) string { return fmt.Sprintf("\x1b[%d;5;%dm%s\x1b[m", 38, 242, t) @@ -73,13 +72,6 @@ func (c *ColorScheme) Yellowf(t string, args ...interface{}) string { return c.Yellow(fmt.Sprintf(t, args...)) } -func (c *ColorScheme) YellowBold(t string) string { - if !c.enabled { - return t - } - return yellowBold(t) -} - func (c *ColorScheme) Green(t string) string { if !c.enabled { return t From 43d5345b8b6bb4827ca18bbcdfff2a4b23239c84 Mon Sep 17 00:00:00 2001 From: Josh Kraft Date: Wed, 26 Apr 2023 19:55:27 -0600 Subject: [PATCH 13/90] remove empty line --- pkg/cmd/search/code/code.go | 1 - 1 file changed, 1 deletion(-) diff --git a/pkg/cmd/search/code/code.go b/pkg/cmd/search/code/code.go index 5aa15825e..7dad2b673 100644 --- a/pkg/cmd/search/code/code.go +++ b/pkg/cmd/search/code/code.go @@ -153,7 +153,6 @@ func displayResults(io *iostreams.IOStreams, results search.CodeResult, limit in row := 0 for _, textMatch := range code.TextMatches { out, shouldPrint := buildOutput(textMatch, cs) - for i, line := range strings.Split(out, "\n") { if !shouldPrint[i] { continue From 88887c8d5556770517a6d4480bcb08ec3a6d6b97 Mon Sep 17 00:00:00 2001 From: Josh Kraft Date: Mon, 8 May 2023 17:02:53 -0600 Subject: [PATCH 14/90] incorporate code review feedback --- pkg/cmd/search/code/code.go | 73 +++++++++++++++----------------- pkg/cmd/search/code/code_test.go | 29 ++++++------- pkg/search/query.go | 1 - pkg/search/result.go | 37 +++++++++++++--- pkg/search/result_test.go | 5 ++- pkg/search/searcher.go | 2 +- pkg/search/searcher_test.go | 7 ++- 7 files changed, 87 insertions(+), 67 deletions(-) diff --git a/pkg/cmd/search/code/code.go b/pkg/cmd/search/code/code.go index 7dad2b673..cde1703e4 100644 --- a/pkg/cmd/search/code/code.go +++ b/pkg/cmd/search/code/code.go @@ -29,7 +29,7 @@ func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Comman opts := &CodeOptions{ Browser: f.Browser, IO: f.IOStreams, - Query: search.Query{Kind: search.KindCode, TextMatch: true}, + Query: search.Query{Kind: search.KindCode}, } cmd := &cobra.Command{ @@ -59,9 +59,6 @@ func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Comman # search code matching "cli" in repositories owned by microsoft organization $ gh search code cli --owner=microsoft - # search code matching "html" in repositories owned by octocat - $ gh search code html --owner=octocat - # search code matching "panic" in cli repository $ gh search code panic --repo cli/cli @@ -99,8 +96,8 @@ func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Comman cmd.Flags().StringVar(&opts.Query.Qualifiers.Extension, "extension", "", "Filter on file extension") cmd.Flags().StringVar(&opts.Query.Qualifiers.Filename, "filename", "", "Filter on filename") cmdutil.StringSliceEnumFlag(cmd, &opts.Query.Qualifiers.In, "match", "", nil, []string{"file", "path"}, "Restrict search to file contents or file path") - cmd.Flags().StringVarP(&opts.Query.Qualifiers.Language, "language", "l", "", "Filter results by language") - cmd.Flags().StringSliceVar(&opts.Query.Qualifiers.Repo, "repo", nil, "Filter on repository") + cmd.Flags().StringVarP(&opts.Query.Qualifiers.Language, "language", "", "", "Filter results by language") + cmd.Flags().StringSliceVarP(&opts.Query.Qualifiers.Repo, "repo", "R", nil, "Filter on repository") cmd.Flags().StringVar(&opts.Query.Qualifiers.Size, "size", "", "Filter on size range, in kilobytes") cmd.Flags().StringSliceVar(&opts.Query.Qualifiers.User, "owner", nil, "Filter on owner") @@ -131,7 +128,7 @@ func codeRun(opts *CodeOptions) error { fmt.Fprintf(io.ErrOut, "failed to start pager: %v\n", err) } if opts.Exporter != nil { - return opts.Exporter.Write(io, results) + return opts.Exporter.Write(io, results.Items) } return displayResults(io, results, opts.Query.Limit) @@ -141,33 +138,28 @@ func displayResults(io *iostreams.IOStreams, results search.CodeResult, limit in cs := io.ColorScheme() tp := tableprinter.New(io) displayed := 0 +outer: for _, code := range results.Items { - if displayed == limit { - break - } if io.IsStdoutTTY() { header := fmt.Sprintf("%s %s", cs.GreenBold(code.Repo.FullName), cs.GreenBold(code.Path)) tp.AddField(header) tp.EndRow() } - row := 0 - for _, textMatch := range code.TextMatches { - out, shouldPrint := buildOutput(textMatch, cs) - for i, line := range strings.Split(out, "\n") { - if !shouldPrint[i] { - continue - } - if displayed == limit { - break - } + i := 1 + for _, match := range code.TextMatches { + fragments := formatMatch(cs, match) + for _, fragment := range fragments { if io.IsStdoutTTY() { - tp.AddField(fmt.Sprintf("%s: %s", cs.CyanBold(strconv.Itoa(row+1)), line)) + tp.AddField(fmt.Sprintf("%s: %s", strconv.Itoa(i), fragment)) } else { - tp.AddField(fmt.Sprintf("%s %s: %s", code.Repo.FullName, code.Path, line)) + tp.AddField(fmt.Sprintf("%s %s: %s", code.Repo.FullName, code.Path, fragment)) } tp.EndRow() - row++ + i++ displayed++ + if displayed == limit { + break outer + } } } } @@ -178,27 +170,32 @@ func displayResults(io *iostreams.IOStreams, results search.CodeResult, limit in return tp.Render() } -func buildOutput(tm search.TextMatch, cs *iostreams.ColorScheme) (string, map[int]bool) { - shouldHighlight := getHighlightIndices(tm.Matches) - linesToPrint := make(map[int]bool) - line := 0 - var out strings.Builder +func formatMatch(cs *iostreams.ColorScheme, tm search.TextMatch) []string { + shouldHighlight := matchHighlightMask(tm.Fragment, tm.Matches) + var lines []string + var found bool + var b strings.Builder for i, c := range tm.Fragment { - if shouldHighlight[i] { - out.WriteString(cs.CyanBold(string(c))) - linesToPrint[line] = true - } else { - out.WriteRune(c) - } if c == '\n' { - line++ + if found { + lines = append(lines, b.String()) + } + found = false + b.Reset() + continue + } + if shouldHighlight[i] { + b.WriteString(cs.CyanBold(string(c))) + found = true + } else { + b.WriteRune(c) } } - return out.String(), linesToPrint + return lines } -func getHighlightIndices(matches []search.Match) map[int]bool { - m := make(map[int]bool) +func matchHighlightMask(fragment string, matches []search.Match) []bool { + m := make([]bool, len(fragment)) for _, match := range matches { start := match.Indices[0] stop := match.Indices[1] diff --git a/pkg/cmd/search/code/code_test.go b/pkg/cmd/search/code/code_test.go index f48cb4bfc..8770ffbbc 100644 --- a/pkg/cmd/search/code/code_test.go +++ b/pkg/cmd/search/code/code_test.go @@ -32,10 +32,9 @@ func TestNewCmdCode(t *testing.T) { input: "react lifecycle", output: CodeOptions{ Query: search.Query{ - Keywords: []string{"react", "lifecycle"}, - Kind: "code", - Limit: 30, - TextMatch: true, + Keywords: []string{"react", "lifecycle"}, + Kind: "code", + Limit: 30, }, }, }, @@ -44,10 +43,9 @@ func TestNewCmdCode(t *testing.T) { input: "--web", output: CodeOptions{ Query: search.Query{ - Keywords: []string{}, - Kind: "code", - Limit: 30, - TextMatch: true, + Keywords: []string{}, + Kind: "code", + Limit: 30, }, WebMode: true, }, @@ -57,10 +55,9 @@ func TestNewCmdCode(t *testing.T) { input: "--limit 10", output: CodeOptions{ Query: search.Query{ - Keywords: []string{}, - Kind: "code", - Limit: 10, - TextMatch: true, + Keywords: []string{}, + Kind: "code", + Limit: 10, }, }, }, @@ -83,10 +80,9 @@ func TestNewCmdCode(t *testing.T) { `, output: CodeOptions{ Query: search.Query{ - Keywords: []string{}, - Kind: "code", - Limit: 30, - TextMatch: true, + Keywords: []string{}, + Kind: "code", + Limit: 30, Qualifiers: search.Qualifiers{ Extension: "extension", Filename: "filename", @@ -141,7 +137,6 @@ func TestCodeRun(t *testing.T) { Language: "go", Repo: []string{"cli/cli"}, }, - TextMatch: true, } tests := []struct { errMsg string diff --git a/pkg/search/query.go b/pkg/search/query.go index 5e9232bea..0181a2240 100644 --- a/pkg/search/query.go +++ b/pkg/search/query.go @@ -23,7 +23,6 @@ type Query struct { Page int Qualifiers Qualifiers Sort string - TextMatch bool } type Qualifiers struct { diff --git a/pkg/search/result.go b/pkg/search/result.go index beac37e4f..cfd78ccf1 100644 --- a/pkg/search/result.go +++ b/pkg/search/result.go @@ -15,6 +15,14 @@ var CodeFields = []string{ "url", } +var TextMatchFields = []string{ + "fragment", + "matches", + "url", + "type", + "property", +} + var CommitFields = []string{ "author", "commit", @@ -115,11 +123,11 @@ type Code struct { } type TextMatch struct { - Fragment string `json:"fragment"` - Matches []Match `json:"matches"` - ObjectURL string `json:"object_url"` - ObjectType string `json:"object_type"` - Property string `json:"property"` + Fragment string `json:"fragment"` + Matches []Match `json:"matches"` + URL string `json:"object_url"` + Type string `json:"object_type"` + Property string `json:"property"` } type Match struct { @@ -274,6 +282,25 @@ func (code Code) ExportData(fields []string) map[string]interface{} { switch f { case "repository": data[f] = code.Repo.ExportData(RepositoryFields) + case "textMatches": + matches := make([]interface{}, 0, len(code.TextMatches)) + for _, match := range code.TextMatches { + matches = append(matches, match.ExportData(TextMatchFields)) + } + data[f] = matches + default: + sf := fieldByName(v, f) + data[f] = sf.Interface() + } + } + return data +} + +func (textMatch TextMatch) ExportData(fields []string) map[string]interface{} { + v := reflect.ValueOf(textMatch) + data := map[string]interface{}{} + for _, f := range fields { + switch f { default: sf := fieldByName(v, f) data[f] = sf.Interface() diff --git a/pkg/search/result_test.go b/pkg/search/result_test.go index 0381d1856..930b80351 100644 --- a/pkg/search/result_test.go +++ b/pkg/search/result_test.go @@ -39,10 +39,13 @@ func TestCodeExportData(t *testing.T) { }, }, }, + Property: "property", + Type: "type", + URL: "url", }, }, }, - output: `{"name":"name","path":"path","textMatches":[{"fragment":"fragment","matches":[{"indices":[0,1],"text":"fr"}],"object_url":"","object_type":"","property":""}]}`, + output: `{"name":"name","path":"path","textMatches":[{"fragment":"fragment","matches":[{"indices":[0,1],"text":"fr"}],"property":"property","type":"type","url":"url"}]}`, }, } for _, tt := range tests { diff --git a/pkg/search/searcher.go b/pkg/search/searcher.go index 889a69487..4168dc7f3 100644 --- a/pkg/search/searcher.go +++ b/pkg/search/searcher.go @@ -173,7 +173,7 @@ func (s searcher) search(query Query, result interface{}) (*http.Response, error } req.Header.Set("Content-Type", "application/json; charset=utf-8") req.Header.Set("Accept", "application/vnd.github.v3+json") - if query.TextMatch { + if query.Kind == KindCode { req.Header.Set("Accept", "application/vnd.github.text-match+json") } diff --git a/pkg/search/searcher_test.go b/pkg/search/searcher_test.go index b6a8ae873..e0c41cfca 100644 --- a/pkg/search/searcher_test.go +++ b/pkg/search/searcher_test.go @@ -12,10 +12,9 @@ import ( func TestSearcherCode(t *testing.T) { query := Query{ - Keywords: []string{"keyword"}, - Kind: "code", - Limit: 30, - TextMatch: true, + Keywords: []string{"keyword"}, + Kind: "code", + Limit: 30, Qualifiers: Qualifiers{ Language: "go", }, From 9d5eb0b784997293c57cd9aec01d744edadf7593 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Wed, 10 May 2023 15:51:53 +0200 Subject: [PATCH 15/90] :nail_care: improve code search output --- pkg/cmd/search/code/code.go | 102 ++++++++++++++++-------------------- 1 file changed, 44 insertions(+), 58 deletions(-) diff --git a/pkg/cmd/search/code/code.go b/pkg/cmd/search/code/code.go index cde1703e4..48ff7179c 100644 --- a/pkg/cmd/search/code/code.go +++ b/pkg/cmd/search/code/code.go @@ -2,12 +2,10 @@ package code import ( "fmt" - "strconv" "strings" "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/search/shared" "github.com/cli/cli/v2/pkg/cmdutil" @@ -131,51 +129,50 @@ func codeRun(opts *CodeOptions) error { return opts.Exporter.Write(io, results.Items) } - return displayResults(io, results, opts.Query.Limit) + return displayResults(io, results) } -func displayResults(io *iostreams.IOStreams, results search.CodeResult, limit int) error { +func displayResults(io *iostreams.IOStreams, results search.CodeResult) error { cs := io.ColorScheme() - tp := tableprinter.New(io) - displayed := 0 -outer: - for _, code := range results.Items { - if io.IsStdoutTTY() { - header := fmt.Sprintf("%s %s", cs.GreenBold(code.Repo.FullName), cs.GreenBold(code.Path)) - tp.AddField(header) - tp.EndRow() - } - i := 1 - for _, match := range code.TextMatches { - fragments := formatMatch(cs, match) - for _, fragment := range fragments { - if io.IsStdoutTTY() { - tp.AddField(fmt.Sprintf("%s: %s", strconv.Itoa(i), fragment)) - } else { - tp.AddField(fmt.Sprintf("%s %s: %s", code.Repo.FullName, code.Path, fragment)) - } - tp.EndRow() - i++ - displayed++ - if displayed == limit { - break outer + if io.IsStdoutTTY() { + fmt.Fprintf(io.Out, "\nShowing %d of %d results\n\n", len(results.Items), results.Total) + for _, code := range results.Items { + fmt.Fprintf(io.Out, "%s %s\n", cs.Blue(code.Repo.FullName), cs.GreenBold(code.Path)) + for _, match := range code.TextMatches { + lines := formatMatch(match.Fragment, match.Matches, io.ColorEnabled()) + for _, line := range lines { + fmt.Fprintf(io.Out, "\t%s\n", strings.TrimSpace(line)) } } } + return nil } - if io.IsStdoutTTY() { - header := fmt.Sprintf("Showing %d of %d results\n\n", displayed, max(displayed, results.Total)) - fmt.Fprintf(io.Out, "\n%s", header) + for _, code := range results.Items { + for _, match := range code.TextMatches { + lines := formatMatch(match.Fragment, match.Matches, io.ColorEnabled()) + for _, line := range lines { + fmt.Fprintf(io.Out, "%s:%s: %s\n", cs.Blue(code.Repo.FullName), cs.GreenBold(code.Path), strings.TrimSpace(line)) + } + } } - return tp.Render() + return nil } -func formatMatch(cs *iostreams.ColorScheme, tm search.TextMatch) []string { - shouldHighlight := matchHighlightMask(tm.Fragment, tm.Matches) +func formatMatch(t string, matches []search.Match, colorize bool) []string { + startIndices := map[int]struct{}{} + endIndices := map[int]struct{}{} + for _, m := range matches { + if len(m.Indices) < 2 { + continue + } + startIndices[m.Indices[0]] = struct{}{} + endIndices[m.Indices[1]] = struct{}{} + } + var lines []string - var found bool var b strings.Builder - for i, c := range tm.Fragment { + var found bool + for i, c := range t { if c == '\n' { if found { lines = append(lines, b.String()) @@ -184,31 +181,20 @@ func formatMatch(cs *iostreams.ColorScheme, tm search.TextMatch) []string { b.Reset() continue } - if shouldHighlight[i] { - b.WriteString(cs.CyanBold(string(c))) + if _, ok := startIndices[i]; ok { + if colorize { + b.WriteString("\x1b[30;43m") // black text on yellow background + } found = true - } else { - b.WriteRune(c) + } else if _, ok := endIndices[i]; ok { + if colorize { + b.WriteString("\x1b[m") // color reset + } } + b.WriteRune(c) + } + if found { + lines = append(lines, b.String()) } return lines } - -func matchHighlightMask(fragment string, matches []search.Match) []bool { - m := make([]bool, len(fragment)) - for _, match := range matches { - start := match.Indices[0] - stop := match.Indices[1] - for i := start; i < stop; i++ { - m[i] = true - } - } - return m -} - -func max(a, b int) int { - if b < a { - return a - } - return b -} From e2c8b16c4b9e6b2d184feb03ba825a700536d632 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Wed, 10 May 2023 16:04:57 +0200 Subject: [PATCH 16/90] Print empty line between file headers --- pkg/cmd/search/code/code.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/search/code/code.go b/pkg/cmd/search/code/code.go index 48ff7179c..e79b371f6 100644 --- a/pkg/cmd/search/code/code.go +++ b/pkg/cmd/search/code/code.go @@ -136,7 +136,10 @@ func displayResults(io *iostreams.IOStreams, results search.CodeResult) error { cs := io.ColorScheme() if io.IsStdoutTTY() { fmt.Fprintf(io.Out, "\nShowing %d of %d results\n\n", len(results.Items), results.Total) - for _, code := range results.Items { + for i, code := range results.Items { + if i > 0 { + fmt.Fprint(io.Out, "\n") + } fmt.Fprintf(io.Out, "%s %s\n", cs.Blue(code.Repo.FullName), cs.GreenBold(code.Path)) for _, match := range code.TextMatches { lines := formatMatch(match.Fragment, match.Matches, io.ColorEnabled()) From e2b2bc007134f09df606afed1ae5b377789975f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Wed, 10 May 2023 16:20:51 +0200 Subject: [PATCH 17/90] fix tests --- pkg/cmd/search/code/code_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/search/code/code_test.go b/pkg/cmd/search/code/code_test.go index 8770ffbbc..fc950ffcb 100644 --- a/pkg/cmd/search/code/code_test.go +++ b/pkg/cmd/search/code/code_test.go @@ -204,7 +204,7 @@ func TestCodeRun(t *testing.T) { }, }, tty: true, - wantStdout: "\nShowing 2 of 2 results\n\ncli/cli context/context.go\n1: \trepoMap := map[string]bool{}\ncli/cli pkg/cmd/pr/pr.go\n1: \t\tAnnotations: map[string]string{\n", + wantStdout: "\nShowing 2 of 2 results\n\ncli/cli context/context.go\n\trepoMap := map[string]bool{}\n\ncli/cli pkg/cmd/pr/pr.go\n\tAnnotations: map[string]string{\n", }, { name: "displays results notty", @@ -263,7 +263,7 @@ func TestCodeRun(t *testing.T) { }, }, tty: false, - wantStdout: "cli/cli context/context.go: \trepoMap := map[string]bool{}\ncli/cli pkg/cmd/pr/pr.go: \t\tAnnotations: map[string]string{\n", + wantStdout: "cli/cli:context/context.go: repoMap := map[string]bool{}\ncli/cli:pkg/cmd/pr/pr.go: Annotations: map[string]string{\n", }, { name: "displays no results", From bd749b67f69cedc6fd975ba949a7dab5eedc947a Mon Sep 17 00:00:00 2001 From: Jakub Kuczys Date: Mon, 15 May 2023 01:08:01 +0200 Subject: [PATCH 18/90] Allow `gh repo set-default --view` without repo argument (#7441) --- pkg/cmd/repo/setdefault/setdefault.go | 8 ++++---- pkg/cmd/repo/setdefault/setdefault_test.go | 13 ++++++++++++- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/pkg/cmd/repo/setdefault/setdefault.go b/pkg/cmd/repo/setdefault/setdefault.go index 2cf8b19b9..d5a03baf1 100644 --- a/pkg/cmd/repo/setdefault/setdefault.go +++ b/pkg/cmd/repo/setdefault/setdefault.go @@ -86,7 +86,7 @@ func NewCmdSetDefault(f *cmdutil.Factory, runF func(*SetDefaultOptions) error) * } } - if !opts.IO.CanPrompt() && opts.Repo == nil { + if !opts.ViewMode && !opts.IO.CanPrompt() && opts.Repo == nil { return cmdutil.FlagErrorf("repository required when not running interactively") } @@ -119,10 +119,10 @@ func setDefaultRun(opts *SetDefaultOptions) error { currentDefaultRepo, _ := remotes.ResolvedRemote() if opts.ViewMode { - if currentDefaultRepo == nil { - fmt.Fprintln(opts.IO.Out, "no default repository has been set; use `gh repo set-default` to select one") - } else { + if currentDefaultRepo != nil { fmt.Fprintln(opts.IO.Out, displayRemoteRepoName(currentDefaultRepo)) + } else if opts.IO.IsStdoutTTY() { + fmt.Fprintln(opts.IO.Out, "no default repository has been set; use `gh repo set-default` to select one") } return nil } diff --git a/pkg/cmd/repo/setdefault/setdefault_test.go b/pkg/cmd/repo/setdefault/setdefault_test.go index a1c1f44ac..58871f75b 100644 --- a/pkg/cmd/repo/setdefault/setdefault_test.go +++ b/pkg/cmd/repo/setdefault/setdefault_test.go @@ -166,7 +166,8 @@ func TestDefaultRun(t *testing.T) { wantStdout: "no default repository has been set\n", }, { - name: "view mode no current default", + name: "tty view mode no current default", + tty: true, opts: SetDefaultOptions{ViewMode: true}, remotes: []*context.Remote{ { @@ -176,6 +177,16 @@ func TestDefaultRun(t *testing.T) { }, wantStdout: "no default repository has been set; use `gh repo set-default` to select one\n", }, + { + name: "view mode no current default", + opts: SetDefaultOptions{ViewMode: true}, + remotes: []*context.Remote{ + { + Remote: &git.Remote{Name: "origin"}, + Repo: repo1, + }, + }, + }, { name: "view mode with base resolved current default", opts: SetDefaultOptions{ViewMode: true}, From ae58b7714c420c2160f9dbcd03ca10f45ab03ac2 Mon Sep 17 00:00:00 2001 From: ffalor <35144141+ffalor@users.noreply.github.com> Date: Sun, 14 May 2023 22:38:49 -0500 Subject: [PATCH 19/90] respect GH_REPO env variable in `pr create` --- pkg/cmd/pr/create/create.go | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index 4fc61f362..93b61d53d 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -6,6 +6,7 @@ import ( "fmt" "net/http" "net/url" + "os" "regexp" "strings" "time" @@ -129,6 +130,12 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co opts.TitleProvided = cmd.Flags().Changed("title") opts.RepoOverride, _ = cmd.Flags().GetString("repo") + // Workaround: Due to the way this command is implemented, we need to manually check GH_REPO. + // Commands should use the standard BaseRepoOverride functionality to handle this behavior instead. + if opts.RepoOverride == "" { + opts.RepoOverride = os.Getenv("GH_REPO") + } + noMaintainerEdit, _ := cmd.Flags().GetBool("no-maintainer-edit") opts.MaintainerCanModify = !noMaintainerEdit From 0d110ea8bf45fbc865ccb15fd17b95398947cd18 Mon Sep 17 00:00:00 2001 From: Rick Kilgore Date: Mon, 15 May 2023 02:47:53 -0700 Subject: [PATCH 20/90] survey: fix color contrast of default values in prompts (#7354) --- cmd/gh/main.go | 3 --- 1 file changed, 3 deletions(-) diff --git a/cmd/gh/main.go b/cmd/gh/main.go index eb0ad0672..f231d7d2c 100644 --- a/cmd/gh/main.go +++ b/cmd/gh/main.go @@ -80,9 +80,6 @@ func mainRun() exitCode { surveyCore.TemplateFuncsWithColor["color"] = func(style string) string { switch style { case "white": - if cmdFactory.IOStreams.ColorSupport256() { - return fmt.Sprintf("\x1b[%d;5;%dm", 38, 242) - } return ansi.ColorCode("default") default: return ansi.ColorCode(style) From ae3e879480a099304c5ad607ff4916d840f1feae Mon Sep 17 00:00:00 2001 From: Tony F Date: Mon, 15 May 2023 10:49:45 -0500 Subject: [PATCH 21/90] Mention setting GH_ENTERPRISE_TOKEN When GH_HOST is set --- pkg/cmd/root/help_topic.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go index 18a7f4801..7db694668 100644 --- a/pkg/cmd/root/help_topic.go +++ b/pkg/cmd/root/help_topic.go @@ -50,7 +50,8 @@ var HelpTopics = []helpTopic{ token for API requests to GitHub Enterprise. When setting this, also set GH_HOST. GH_HOST: specify the GitHub hostname for commands that would otherwise assume the - "github.com" host when not in a context of an existing repository. + "github.com" host when not in a context of an existing repository. When setting this, + also set GH_ENTERPRISE_TOKEN. GH_REPO: specify the GitHub repository in the "[HOST/]OWNER/REPO" format for commands that otherwise operate on a local repository. From f77a3dcacbf265e1b4ce5dafa860552d504a0888 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Tue, 16 May 2023 09:44:00 +1200 Subject: [PATCH 22/90] Do not fall back to legacy template if template selector returns nil (#7444) --- pkg/cmd/pr/create/create.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index 93b61d53d..83421d88b 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -325,8 +325,6 @@ func createRun(opts *CreateOptions) (err error) { if template != nil { templateContent = string(template.Body()) - } else { - templateContent = string(tpl.LegacyBody()) } } From cd8547b227774e34df0101ce92da9702a29075f2 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 16 May 2023 19:35:10 +0200 Subject: [PATCH 23/90] Add some further test coverage around PR ChecksStatus --- api/pull_request_test.go | 301 +++++++++++++++++++++++++++++++++++---- 1 file changed, 277 insertions(+), 24 deletions(-) diff --git a/api/pull_request_test.go b/api/pull_request_test.go index 2e4fa73b1..67ea20cb5 100644 --- a/api/pull_request_test.go +++ b/api/pull_request_test.go @@ -2,42 +2,295 @@ package api import ( "encoding/json" + "fmt" "testing" - "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) -func TestPullRequest_ChecksStatus(t *testing.T) { - pr := PullRequest{} +func TestChecksStatus_NoCheckRunsOrStatusContexts(t *testing.T) { + t.Parallel() + payload := ` + { "statusCheckRollup": { "nodes": [] } } + ` + var pr PullRequest + require.NoError(t, json.Unmarshal([]byte(payload), &pr)) + + expectedChecksStatus := PullRequestChecksStatus{ + Pending: 0, + Failing: 0, + Passing: 0, + Total: 0, + } + require.Equal(t, expectedChecksStatus, pr.ChecksStatus()) +} + +func TestChecksStatus_SummarisingCheckRuns(t *testing.T) { + t.Parallel() + + tests := []struct { + name string + payload string + expectedChecksStatus PullRequestChecksStatus + }{ + { + name: "QUEUED is treated as Pending", + payload: singleCheckRunWithStatus("QUEUED"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "IN_PROGRESS is treated as Pending", + payload: singleCheckRunWithStatus("IN_PROGRESS"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "WAITING is treated as Pending", + payload: singleCheckRunWithStatus("WAITING"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "PENDING is treated as Pending", + payload: singleCheckRunWithStatus("PENDING"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "REQUESTED is treated as Pending", + payload: singleCheckRunWithStatus("REQUESTED"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "COMPLETED / STARTUP_FAILURE is treated as Pending", + payload: singleCompletedCheckRunWithConclusion("STARTUP_FAILURE"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "COMPLETED / STALE is treated as Pending", + payload: singleCompletedCheckRunWithConclusion("STALE"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "COMPLETED / SUCCESS is treated as Passing", + payload: singleCompletedCheckRunWithConclusion("SUCCESS"), + expectedChecksStatus: PullRequestChecksStatus{Passing: 1, Total: 1}, + }, + { + name: "COMPLETED / NEUTRAL is treated as Passing", + payload: singleCompletedCheckRunWithConclusion("NEUTRAL"), + expectedChecksStatus: PullRequestChecksStatus{Passing: 1, Total: 1}, + }, + { + name: "COMPLETED / SKIPPED is treated as Passing", + payload: singleCompletedCheckRunWithConclusion("SKIPPED"), + expectedChecksStatus: PullRequestChecksStatus{Passing: 1, Total: 1}, + }, + { + name: "COMPLETED / ACTION_REQUIRED is treated as Failing", + payload: singleCompletedCheckRunWithConclusion("ACTION_REQUIRED"), + expectedChecksStatus: PullRequestChecksStatus{Failing: 1, Total: 1}, + }, + { + name: "COMPLETED / TIMED_OUT is treated as Failing", + payload: singleCompletedCheckRunWithConclusion("TIMED_OUT"), + expectedChecksStatus: PullRequestChecksStatus{Failing: 1, Total: 1}, + }, + { + name: "COMPLETED / CANCELLED is treated as Failing", + payload: singleCompletedCheckRunWithConclusion("CANCELLED"), + expectedChecksStatus: PullRequestChecksStatus{Failing: 1, Total: 1}, + }, + { + name: "COMPLETED / CANCELLED is treated as Failing", + payload: singleCompletedCheckRunWithConclusion("CANCELLED"), + expectedChecksStatus: PullRequestChecksStatus{Failing: 1, Total: 1}, + }, + { + name: "COMPLETED / FAILURE is treated as Failing", + payload: singleCompletedCheckRunWithConclusion("FAILURE"), + expectedChecksStatus: PullRequestChecksStatus{Failing: 1, Total: 1}, + }, + { + name: "Unrecognized Status are treated as Pending", + payload: singleCheckRunWithStatus("AnUnrecognizedStatusJustForThisTest"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "Unrecognized Conclusions are treated as Pending", + payload: singleCompletedCheckRunWithConclusion("AnUnrecognizedConclusionJustForThisTest"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + } + + for _, tt := range tests { + tt := tt + t.Run(tt.name, func(t *testing.T) { + t.Parallel() + + var pr PullRequest + require.NoError(t, json.Unmarshal([]byte(tt.payload), &pr)) + + require.Equal(t, tt.expectedChecksStatus, pr.ChecksStatus()) + }) + } +} + +func TestChecksStatus_SummarisingStatusContexts(t *testing.T) { + t.Parallel() + + tests := []struct { + name string + payload string + expectedChecksStatus PullRequestChecksStatus + }{ + { + name: "EXPECTED is treated as Pending", + payload: singleStatusContextWithState("EXPECTED"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "PENDING is treated as Pending", + payload: singleStatusContextWithState("PENDING"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + { + name: "SUCCESS is treated as Passing", + payload: singleStatusContextWithState("SUCCESS"), + expectedChecksStatus: PullRequestChecksStatus{Passing: 1, Total: 1}, + }, + { + name: "ERROR is treated as Failing", + payload: singleStatusContextWithState("ERROR"), + expectedChecksStatus: PullRequestChecksStatus{Failing: 1, Total: 1}, + }, + { + name: "FAILURE is treated as Failing", + payload: singleStatusContextWithState("FAILURE"), + expectedChecksStatus: PullRequestChecksStatus{Failing: 1, Total: 1}, + }, + { + name: "Unrecognized States are treated as Pending", + payload: singleStatusContextWithState("AnUnrecognizedStateJustForThisTest"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, + } + + for _, tt := range tests { + tt := tt + t.Run(tt.name, func(t *testing.T) { + t.Parallel() + + var pr PullRequest + require.NoError(t, json.Unmarshal([]byte(tt.payload), &pr)) + + require.Equal(t, tt.expectedChecksStatus, pr.ChecksStatus()) + }) + } +} + +func TestChecksStatus_SummarisingCheckRunsAndStatusContexts(t *testing.T) { + t.Parallel() + + // This might look a bit intimidating, but we're just inserting three nodes + // into the rollup, two completed check run nodes and one status context node. + payload := fmt.Sprintf(` { "statusCheckRollup": { "nodes": [{ "commit": { "statusCheckRollup": { "contexts": { "nodes": [ - { "state": "SUCCESS" }, - { "state": "PENDING" }, - { "state": "FAILURE" }, - { "status": "IN_PROGRESS", - "conclusion": null }, - { "status": "COMPLETED", - "conclusion": "SUCCESS" }, - { "status": "COMPLETED", - "conclusion": "FAILURE" }, - { "status": "COMPLETED", - "conclusion": "ACTION_REQUIRED" }, - { "status": "COMPLETED", - "conclusion": "STALE" } + %s, + %s, + %s ] } } } }] } } - ` - err := json.Unmarshal([]byte(payload), &pr) - assert.NoError(t, err) + `, + completedCheckRunNode("SUCCESS"), + statusContextNode("PENDING"), + completedCheckRunNode("FAILURE"), + ) - checks := pr.ChecksStatus() - assert.Equal(t, 8, checks.Total) - assert.Equal(t, 3, checks.Pending) - assert.Equal(t, 3, checks.Failing) - assert.Equal(t, 2, checks.Passing) + var pr PullRequest + require.NoError(t, json.Unmarshal([]byte(payload), &pr)) + + expectedChecksStatus := PullRequestChecksStatus{ + Pending: 1, + Failing: 1, + Passing: 1, + Total: 3, + } + require.Equal(t, expectedChecksStatus, pr.ChecksStatus()) +} + +// Note that it would be incorrect to provide a status of COMPLETED here +// as the conclusion is always set to null. If you want a COMPLETED status, +// use `singleCompletedCheckRunWithConclusion`. +func singleCheckRunWithStatus(status string) string { + return fmt.Sprintf(` + { "statusCheckRollup": { "nodes": [{ "commit": { + "statusCheckRollup": { + "contexts": { + "nodes": [ + { + "__typename": "CheckRun", + "status": "%s", + "conclusion": null + } + ] + } + } + } }] } } + `, status) +} + +func singleCompletedCheckRunWithConclusion(conclusion string) string { + return fmt.Sprintf(` + { "statusCheckRollup": { "nodes": [{ "commit": { + "statusCheckRollup": { + "contexts": { + "nodes": [ + { + "__typename": "CheckRun", + "status": "COMPLETED", + "conclusion": "%s" + } + ] + } + } + } }] } } + `, conclusion) +} + +func singleStatusContextWithState(state string) string { + return fmt.Sprintf(` + { "statusCheckRollup": { "nodes": [{ "commit": { + "statusCheckRollup": { + "contexts": { + "nodes": [ + { + "__typename": "StatusContext", + "state": "%s" + } + ] + } + } + } }] } } + `, state) +} + +func completedCheckRunNode(conclusion string) string { + return fmt.Sprintf(` + { + "__typename": "CheckRun", + "status": "COMPLETED", + "conclusion": "%s" + }`, conclusion) +} + +func statusContextNode(state string) string { + return fmt.Sprintf(` + { + "__typename": "StatusContext", + "state": "%s" + }`, state) } From c4bb344dddc7b0cd805c28cdc5eb47404a8c2cb1 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 16 May 2023 19:41:59 +0200 Subject: [PATCH 24/90] Add some comments to PR ChecksStatus --- api/queries_pr.go | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/api/queries_pr.go b/api/queries_pr.go index ae8f7c0c6..5ae5cbb8f 100644 --- a/api/queries_pr.go +++ b/api/queries_pr.go @@ -265,11 +265,17 @@ func (pr *PullRequest) ChecksStatus() (summary PullRequestChecksStatus) { if len(pr.StatusCheckRollup.Nodes) == 0 { return } + commit := pr.StatusCheckRollup.Nodes[0].Commit for _, c := range commit.StatusCheckRollup.Contexts.Nodes { - state := c.State // StatusContext + // Nodes are a discriminated union of CheckRun or StatusContext, + // but we can use the State field to disambiguate, rather than using the TypeName. + // First we try to get the State, as if we have a StatusContext + state := c.State + // But if the State is empty, then we assume we actually have a CheckRun if state == "" { - // CheckRun + // If the Status of a CheckRun is COMPLETED, then we want to look more closely + // at the Conclusion, as that contains the relevant information. if c.Status == "COMPLETED" { state = c.Conclusion } else { @@ -281,7 +287,9 @@ func (pr *PullRequest) ChecksStatus() (summary PullRequestChecksStatus) { summary.Passing++ case "ERROR", "FAILURE", "CANCELLED", "TIMED_OUT", "ACTION_REQUIRED": summary.Failing++ - default: // "EXPECTED", "REQUESTED", "WAITING", "QUEUED", "PENDING", "IN_PROGRESS", "STALE" + // We treat anything that isn't Passing or Failing as Pending, which included any future unknown states + // we might get back from the API. + default: // "EXPECTED", "REQUESTED", "WAITING", "QUEUED", "PENDING", "IN_PROGRESS", "STALE", "STARTUP_FAILURE" summary.Pending++ } summary.Total++ From bfb5e8f1d6bef0f161271a26578fba7baf22b05f Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 16 May 2023 19:43:07 +0200 Subject: [PATCH 25/90] Avoid using named return in PR ChecksStatus See: https://dave.cheney.net/practical-go/presentations/gophercon-israel.html#_avoid_named_return_values --- api/queries_pr.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/api/queries_pr.go b/api/queries_pr.go index 5ae5cbb8f..6f121caab 100644 --- a/api/queries_pr.go +++ b/api/queries_pr.go @@ -261,9 +261,11 @@ type PullRequestChecksStatus struct { Total int } -func (pr *PullRequest) ChecksStatus() (summary PullRequestChecksStatus) { +func (pr *PullRequest) ChecksStatus() PullRequestChecksStatus { + var summary PullRequestChecksStatus + if len(pr.StatusCheckRollup.Nodes) == 0 { - return + return summary } commit := pr.StatusCheckRollup.Nodes[0].Commit @@ -295,7 +297,7 @@ func (pr *PullRequest) ChecksStatus() (summary PullRequestChecksStatus) { summary.Total++ } - return + return summary } func (pr *PullRequest) DisplayableReviews() PullRequestReviews { From 83d6dc58780bccb479296b433ac3482f8ae765a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Wed, 17 May 2023 14:43:31 +0200 Subject: [PATCH 26/90] Fix windows crash by bumping wincred --- go.mod | 10 +++++----- go.sum | 20 +++++++++++--------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/go.mod b/go.mod index 3730d469d..e112f2e22 100644 --- a/go.mod +++ b/go.mod @@ -34,8 +34,8 @@ require ( github.com/sourcegraph/jsonrpc2 v0.1.0 github.com/spf13/cobra v1.6.1 github.com/spf13/pflag v1.0.5 - github.com/stretchr/testify v1.7.5 - github.com/zalando/go-keyring v0.2.2 + github.com/stretchr/testify v1.8.1 + github.com/zalando/go-keyring v0.2.3 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 golang.org/x/sync v0.1.0 golang.org/x/term v0.6.0 @@ -51,7 +51,7 @@ require ( github.com/aymerick/douceur v0.2.0 // indirect github.com/cli/browser v1.1.0 // indirect github.com/cli/shurcooL-graphql v0.0.3 // indirect - github.com/danieljoos/wincred v1.1.2 // indirect + github.com/danieljoos/wincred v1.2.0 // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/dlclark/regexp2 v1.4.0 // indirect github.com/fatih/color v1.7.0 // indirect @@ -73,13 +73,13 @@ require ( github.com/rivo/uniseg v0.4.2 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/shurcooL/graphql v0.0.0-20220606043923-3cf50f8a0a29 // indirect - github.com/stretchr/objx v0.4.0 // indirect + github.com/stretchr/objx v0.5.0 // indirect github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e // indirect github.com/yuin/goldmark v1.4.13 // indirect github.com/yuin/goldmark-emoji v1.0.1 // indirect golang.org/x/net v0.8.0 // indirect golang.org/x/oauth2 v0.0.0-20220309155454-6242fa91716a // indirect - golang.org/x/sys v0.6.0 // indirect + golang.org/x/sys v0.8.0 // indirect google.golang.org/genproto v0.0.0-20200825200019-8632dd797987 // indirect gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect ) diff --git a/go.sum b/go.sum index 8808b1ec9..49bdc6ae9 100644 --- a/go.sum +++ b/go.sum @@ -78,8 +78,8 @@ github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46t github.com/creack/pty v1.1.17/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= github.com/creack/pty v1.1.18 h1:n56/Zwd5o6whRC5PMGretI4IdRLlmBXYNjScPaBgsbY= github.com/creack/pty v1.1.18/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= -github.com/danieljoos/wincred v1.1.2 h1:QLdCxFs1/Yl4zduvBdcHB8goaYk9RARS2SgLLRuAyr0= -github.com/danieljoos/wincred v1.1.2/go.mod h1:GijpziifJoIBfYh+S7BbkdUTU4LfM+QnGqR5Vl2tAx0= +github.com/danieljoos/wincred v1.2.0 h1:ozqKHaLK0W/ii4KVbbvluM91W2H3Sh0BncbUNPS7jLE= +github.com/danieljoos/wincred v1.2.0/go.mod h1:FzQLLMKBFdvu+osBrnFODiv32YGwCfx0SkRa/eYHgec= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= @@ -251,14 +251,16 @@ github.com/spf13/cobra v1.6.1/go.mod h1:IOw/AERYS7UzyrGinqmz6HLUo219MORXGxhbaJUq github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= -github.com/stretchr/objx v0.4.0 h1:M2gUjqZET1qApGOWNSnZ49BAIMX4F/1plDv3+l31EJ4= github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= +github.com/stretchr/objx v0.5.0 h1:1zr/of2m5FGMsad5YfcqgdqdWrIhu+EBEJRhR1U7z/c= +github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.7.5 h1:s5PTfem8p8EbKQOctVV53k6jCJt3UX4IEJzwh+C324Q= -github.com/stretchr/testify v1.7.5/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= +github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= +github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e h1:BuzhfgfWQbX0dWzYzT1zsORLnHRv3bcRcsaUk0VmXA8= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e/go.mod h1:/Tnicc6m/lsJE0irFMA0LfIwTBo4QP7A8IfyIv4zZKI= github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= @@ -271,8 +273,8 @@ github.com/yuin/goldmark v1.4.13 h1:fVcFKWvrslecOb/tg+Cc05dkeYx540o0FuFt3nUVDoE= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/yuin/goldmark-emoji v1.0.1 h1:ctuWEyzGBwiucEqxzwe0SOYDXPAucOrE9NQC18Wa1os= github.com/yuin/goldmark-emoji v1.0.1/go.mod h1:2w1E6FEWLcDQkoTE+7HU6QF1F6SLlNGjRIBbIZQFqkQ= -github.com/zalando/go-keyring v0.2.2 h1:f0xmpYiSrHtSNAVgwip93Cg8tuF45HJM6rHq/A5RI/4= -github.com/zalando/go-keyring v0.2.2/go.mod h1:sI3evg9Wvpw3+n4SqplGSJUMwtDeROfD4nsFz4z9PG0= +github.com/zalando/go-keyring v0.2.3 h1:v9CUu9phlABObO4LPWycf+zwMG7nlbb3t/B5wa97yms= +github.com/zalando/go-keyring v0.2.3/go.mod h1:HL4k+OXQfJUWaMnqyuSOc0drfGPX2b51Du6K+MRgZMk= go.opencensus.io v0.21.0/go.mod h1:mSImk1erAIZhrmZN+AvHh14ztQfjbGwt4TtuofqLduU= go.opencensus.io v0.22.0/go.mod h1:+kGneAE2xo2IficOXnaByMWTGM9T73dGwxeWcUqIpI8= go.opencensus.io v0.22.2/go.mod h1:yxeiOL68Rb0Xd1ddK5vPZ/oVn4vY4Ynel7k9FzqtOIw= @@ -393,7 +395,6 @@ golang.org/x/sys v0.0.0-20210319071255-635bc2c9138d/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20210819135213-f52c844e1c1c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210831042530-f4d43177bf5e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= @@ -403,8 +404,9 @@ golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.6.0 h1:MVltZSvRTcU2ljQOhs94SXPftV6DCNnZViHeQps87pQ= golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210503060354-a79de5458b56/go.mod h1:tfny5GFUkzUvx4ps4ajbZsCe5lw1metzhBm9T3x7oIY= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= From 7e2bac89bda62a31a20f28ece74edade5b961c2c Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 17 May 2023 14:50:28 +0200 Subject: [PATCH 27/90] Remove old, unused detector fields (#7458) --- .../featuredetection/feature_detection.go | 25 +++------------- .../feature_detection_test.go | 29 ++++--------------- 2 files changed, 9 insertions(+), 45 deletions(-) diff --git a/internal/featuredetection/feature_detection.go b/internal/featuredetection/feature_detection.go index 6c81ac546..7cd9fa2ff 100644 --- a/internal/featuredetection/feature_detection.go +++ b/internal/featuredetection/feature_detection.go @@ -22,30 +22,20 @@ var allIssueFeatures = IssueFeatures{ } type PullRequestFeatures struct { - ReviewDecision bool - StatusCheckRollup bool - BranchProtectionRule bool - MergeQueue bool + MergeQueue bool } var allPullRequestFeatures = PullRequestFeatures{ - ReviewDecision: true, - StatusCheckRollup: true, - BranchProtectionRule: true, - MergeQueue: true, + MergeQueue: true, } type RepositoryFeatures struct { - IssueTemplateMutation bool - IssueTemplateQuery bool PullRequestTemplateQuery bool VisibilityField bool AutoMerge bool } var allRepositoryFeatures = RepositoryFeatures{ - IssueTemplateMutation: true, - IssueTemplateQuery: true, PullRequestTemplateQuery: true, VisibilityField: true, AutoMerge: true, @@ -103,11 +93,7 @@ func (d *detector) PullRequestFeatures() (PullRequestFeatures, error) { // return allPullRequestFeatures, nil // } - features := PullRequestFeatures{ - ReviewDecision: true, - StatusCheckRollup: true, - BranchProtectionRule: true, - } + features := PullRequestFeatures{} var featureDetection struct { PullRequest struct { @@ -137,10 +123,7 @@ func (d *detector) RepositoryFeatures() (RepositoryFeatures, error) { return allRepositoryFeatures, nil } - features := RepositoryFeatures{ - IssueTemplateQuery: true, - IssueTemplateMutation: true, - } + features := RepositoryFeatures{} var featureDetection struct { Repository struct { diff --git a/internal/featuredetection/feature_detection_test.go b/internal/featuredetection/feature_detection_test.go index 2f2fb5b05..c4944d0de 100644 --- a/internal/featuredetection/feature_detection_test.go +++ b/internal/featuredetection/feature_detection_test.go @@ -93,10 +93,7 @@ func TestPullRequestFeatures(t *testing.T) { `), }, wantFeatures: PullRequestFeatures{ - ReviewDecision: true, - StatusCheckRollup: true, - BranchProtectionRule: true, - MergeQueue: true, + MergeQueue: true, }, wantErr: false, }, @@ -110,10 +107,7 @@ func TestPullRequestFeatures(t *testing.T) { `), }, wantFeatures: PullRequestFeatures{ - ReviewDecision: true, - StatusCheckRollup: true, - BranchProtectionRule: true, - MergeQueue: false, + MergeQueue: false, }, wantErr: false, }, @@ -129,10 +123,7 @@ func TestPullRequestFeatures(t *testing.T) { `), }, wantFeatures: PullRequestFeatures{ - ReviewDecision: true, - StatusCheckRollup: true, - BranchProtectionRule: true, - MergeQueue: true, + MergeQueue: true, }, wantErr: false, }, @@ -169,8 +160,6 @@ func TestRepositoryFeatures(t *testing.T) { name: "github.com", hostname: "github.com", wantFeatures: RepositoryFeatures{ - IssueTemplateMutation: true, - IssueTemplateQuery: true, PullRequestTemplateQuery: true, VisibilityField: true, AutoMerge: true, @@ -184,8 +173,6 @@ func TestRepositoryFeatures(t *testing.T) { `query Repository_fields\b`: `{"data": {}}`, }, wantFeatures: RepositoryFeatures{ - IssueTemplateMutation: true, - IssueTemplateQuery: true, PullRequestTemplateQuery: false, }, wantErr: false, @@ -201,8 +188,6 @@ func TestRepositoryFeatures(t *testing.T) { `), }, wantFeatures: RepositoryFeatures{ - IssueTemplateMutation: true, - IssueTemplateQuery: true, PullRequestTemplateQuery: true, }, wantErr: false, @@ -218,9 +203,7 @@ func TestRepositoryFeatures(t *testing.T) { `), }, wantFeatures: RepositoryFeatures{ - IssueTemplateMutation: true, - IssueTemplateQuery: true, - VisibilityField: true, + VisibilityField: true, }, wantErr: false, }, @@ -235,9 +218,7 @@ func TestRepositoryFeatures(t *testing.T) { `), }, wantFeatures: RepositoryFeatures{ - IssueTemplateMutation: true, - IssueTemplateQuery: true, - AutoMerge: true, + AutoMerge: true, }, wantErr: false, }, From 4a766599966e936d9c587035d7924e7546ed6907 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 17 May 2023 14:58:44 +0000 Subject: [PATCH 28/90] build(deps): bump github.com/stretchr/testify from 1.8.1 to 1.8.2 Bumps [github.com/stretchr/testify](https://github.com/stretchr/testify) from 1.8.1 to 1.8.2. - [Release notes](https://github.com/stretchr/testify/releases) - [Commits](https://github.com/stretchr/testify/compare/v1.8.1...v1.8.2) --- updated-dependencies: - dependency-name: github.com/stretchr/testify dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index e112f2e22..33f10c733 100644 --- a/go.mod +++ b/go.mod @@ -34,7 +34,7 @@ require ( github.com/sourcegraph/jsonrpc2 v0.1.0 github.com/spf13/cobra v1.6.1 github.com/spf13/pflag v1.0.5 - github.com/stretchr/testify v1.8.1 + github.com/stretchr/testify v1.8.2 github.com/zalando/go-keyring v0.2.3 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 golang.org/x/sync v0.1.0 diff --git a/go.sum b/go.sum index 49bdc6ae9..331bef06c 100644 --- a/go.sum +++ b/go.sum @@ -259,8 +259,8 @@ github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= -github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk= -github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8= +github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e h1:BuzhfgfWQbX0dWzYzT1zsORLnHRv3bcRcsaUk0VmXA8= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e/go.mod h1:/Tnicc6m/lsJE0irFMA0LfIwTBo4QP7A8IfyIv4zZKI= github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= From 9d81c1134d6a022d6c04ec016c24a409309b6183 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 17 May 2023 13:11:24 +0200 Subject: [PATCH 29/90] Implement parsing and counting of PR checks using new GQL fields --- api/pull_request_test.go | 119 +++++++++++++++++++++++++++++++++++++++ api/queries_pr.go | 74 +++++++++++++++++++++++- 2 files changed, 191 insertions(+), 2 deletions(-) diff --git a/api/pull_request_test.go b/api/pull_request_test.go index 67ea20cb5..6c15cdddd 100644 --- a/api/pull_request_test.go +++ b/api/pull_request_test.go @@ -59,6 +59,11 @@ func TestChecksStatus_SummarisingCheckRuns(t *testing.T) { payload: singleCheckRunWithStatus("REQUESTED"), expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, }, + { + name: "COMPLETED with no conclusion is treated as Pending", + payload: singleCheckRunWithStatus("COMPLETED"), + expectedChecksStatus: PullRequestChecksStatus{Pending: 1, Total: 1}, + }, { name: "COMPLETED / STARTUP_FAILURE is treated as Pending", payload: singleCompletedCheckRunWithConclusion("STARTUP_FAILURE"), @@ -222,6 +227,120 @@ func TestChecksStatus_SummarisingCheckRunsAndStatusContexts(t *testing.T) { require.Equal(t, expectedChecksStatus, pr.ChecksStatus()) } +func TestChecksStatus_SummarisingCheckRunAndStatusContextCountsByState(t *testing.T) { + t.Parallel() + + payload := ` + { "statusCheckRollup": { "nodes": [{ "commit": { + "statusCheckRollup": { + "contexts": { + "checkRunCount": 14, + "checkRunCountsByState": [ + { + "state": "ACTION_REQUIRED", + "count": 1 + }, + { + "state": "CANCELLED", + "count": 1 + }, + { + "state": "COMPLETED", + "count": 1 + }, + { + "state": "FAILURE", + "count": 1 + }, + { + "state": "IN_PROGRESS", + "count": 1 + }, + { + "state": "NEUTRAL", + "count": 1 + }, + { + "state": "PENDING", + "count": 1 + }, + { + "state": "QUEUED", + "count": 1 + }, + { + "state": "SKIPPED", + "count": 1 + }, + { + "state": "STALE", + "count": 1 + }, + { + "state": "STARTUP_FAILURE", + "count": 1 + }, + { + "state": "SUCCESS", + "count": 1 + }, + { + "state": "TIMED_OUT", + "count": 1 + }, + { + "state": "WAITING", + "count": 1 + }, + { + "state": "AnUnrecognizedStateJustForThisTest", + "count": 1 + } + ], + "statusContextCount": 6, + "statusContextCountsByState": [ + { + "state": "EXPECTED", + "count": 1 + }, + { + "state": "ERROR", + "count": 1 + }, + { + "state": "FAILURE", + "count": 1 + }, + { + "state": "PENDING", + "count": 1 + }, + { + "state": "SUCCESS", + "count": 1 + }, + { + "state": "AnUnrecognizedStateJustForThisTest", + "count": 1 + } + ] + } + } + } }] } } + ` + + var pr PullRequest + require.NoError(t, json.Unmarshal([]byte(payload), &pr)) + + expectedChecksStatus := PullRequestChecksStatus{ + Pending: 11, + Failing: 6, + Passing: 4, + Total: 20, + } + require.Equal(t, expectedChecksStatus, pr.ChecksStatus()) +} + // Note that it would be incorrect to provide a status of COMPLETED here // as the conclusion is always set to null. If you want a COMPLETED status, // use `singleCompletedCheckRunWithConclusion`. diff --git a/api/queries_pr.go b/api/queries_pr.go index 6f121caab..43deb063f 100644 --- a/api/queries_pr.go +++ b/api/queries_pr.go @@ -97,7 +97,26 @@ type CommitStatusCheckRollup struct { Contexts CheckContexts } +type CheckRunCountByState struct { + State string + Count int +} + +type StatusContextCountByState struct { + State string + Count int +} + type CheckContexts struct { + // These fields are available on newer versions of the GraphQL API + // to support summary counts by state + CheckRunCount int + CheckRunCountsByState []CheckRunCountByState + StatusContextCount int + StatusContextCountsByState []StatusContextCountByState + + // These are available on older versions and provide more details + // required for checks Nodes []CheckContext PageInfo struct { HasNextPage bool @@ -268,8 +287,38 @@ func (pr *PullRequest) ChecksStatus() PullRequestChecksStatus { return summary } - commit := pr.StatusCheckRollup.Nodes[0].Commit - for _, c := range commit.StatusCheckRollup.Contexts.Nodes { + contexts := pr.StatusCheckRollup.Nodes[0].Commit.StatusCheckRollup.Contexts + + // If this commit has counts by state then we can summarise check status from those + if len(contexts.CheckRunCountsByState) != 0 && len(contexts.StatusContextCountsByState) != 0 { + summary.Total = contexts.CheckRunCount + contexts.StatusContextCount + for _, countByState := range contexts.CheckRunCountsByState { + switch parseCheckStatus(countByState.State) { + case passing: + summary.Passing += countByState.Count + case failing: + summary.Failing += countByState.Count + default: + summary.Pending += countByState.Count + } + } + + for _, countByState := range contexts.StatusContextCountsByState { + switch parseCheckStatus(countByState.State) { + case passing: + summary.Passing += countByState.Count + case failing: + summary.Failing += countByState.Count + default: + summary.Pending += countByState.Count + } + } + + return summary + } + + // If we don't have the counts by state, then we'll need to summarise by looking at the more detailed contexts + for _, c := range contexts.Nodes { // Nodes are a discriminated union of CheckRun or StatusContext, // but we can use the State field to disambiguate, rather than using the TypeName. // First we try to get the State, as if we have a StatusContext @@ -300,6 +349,27 @@ func (pr *PullRequest) ChecksStatus() PullRequestChecksStatus { return summary } +type checkStatus int + +const ( + passing checkStatus = iota + failing + pending +) + +func parseCheckStatus(state string) checkStatus { + switch state { + case "SUCCESS", "NEUTRAL", "SKIPPED": + return passing + case "ERROR", "FAILURE", "CANCELLED", "TIMED_OUT", "ACTION_REQUIRED": + return failing + // We treat anything that isn't Passing or Failing as Pending, which included any future unknown states + // we might get back from the API. + default: // "EXPECTED", "REQUESTED", "WAITING", "QUEUED", "PENDING", "IN_PROGRESS", "STALE", "STARTUP_FAILURE", "COMPLETED" + return pending + } +} + func (pr *PullRequest) DisplayableReviews() PullRequestReviews { published := []PullRequestReview{} for _, prr := range pr.Reviews.Nodes { From c2e3dae6029970b9cbd83f1f675a6c253f5d7d4b Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 17 May 2023 15:57:59 +0200 Subject: [PATCH 30/90] Add support for detecting status and check counts in GQL --- .../featuredetection/feature_detection.go | 37 +++++++++++++-- .../feature_detection_test.go | 45 +++++++++++++++++++ 2 files changed, 79 insertions(+), 3 deletions(-) diff --git a/internal/featuredetection/feature_detection.go b/internal/featuredetection/feature_detection.go index 7cd9fa2ff..ac894a371 100644 --- a/internal/featuredetection/feature_detection.go +++ b/internal/featuredetection/feature_detection.go @@ -5,6 +5,7 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghinstance" + "golang.org/x/sync/errgroup" ) type Detector interface { @@ -23,6 +24,10 @@ var allIssueFeatures = IssueFeatures{ type PullRequestFeatures struct { MergeQueue bool + // CheckRunAndStatusContextCounts indicates whether the API supports + // the checkRunCount, checkRunCountsByState, statusContextCount and stausContextCountsByState + // fields on the StatusCheckRollupContextConnection + CheckRunAndStatusContextCounts bool } var allPullRequestFeatures = PullRequestFeatures{ @@ -95,7 +100,7 @@ func (d *detector) PullRequestFeatures() (PullRequestFeatures, error) { features := PullRequestFeatures{} - var featureDetection struct { + var pullRequestFeatureDetection struct { PullRequest struct { Fields []struct { Name string @@ -103,18 +108,44 @@ func (d *detector) PullRequestFeatures() (PullRequestFeatures, error) { } `graphql:"PullRequest: __type(name: \"PullRequest\")"` } + var statusCheckRollupContextConnectionFeatureDetection struct { + StatusCheckRollupContextConnection struct { + Fields []struct { + Name string + } `graphql:"fields(includeDeprecated: true)"` + } `graphql:"StatusCheckRollupContextConnection: __type(name: \"StatusCheckRollupContextConnection\")"` + } + gql := api.NewClientFromHTTP(d.httpClient) - err := gql.Query(d.host, "PullRequest_fields", &featureDetection, nil) + + g := new(errgroup.Group) + g.Go(func() error { + return gql.Query(d.host, "PullRequest_fields", &pullRequestFeatureDetection, nil) + }) + + g.Go(func() error { + return gql.Query(d.host, "StatusCheckRollupContextConnection_fields", &statusCheckRollupContextConnectionFeatureDetection, nil) + }) + + err := g.Wait() if err != nil { return features, err } - for _, field := range featureDetection.PullRequest.Fields { + for _, field := range pullRequestFeatureDetection.PullRequest.Fields { if field.Name == "isInMergeQueue" { features.MergeQueue = true } } + for _, field := range statusCheckRollupContextConnectionFeatureDetection.StatusCheckRollupContextConnection.Fields { + // We only check for checkRunCount here but it, checkRunCountsByState, statusContextCount and statusContextCountsByState + // were all introduced in the same version of the API. + if field.Name == "checkRunCount" { + features.CheckRunAndStatusContextCounts = true + } + } + return features, nil } diff --git a/internal/featuredetection/feature_detection_test.go b/internal/featuredetection/feature_detection_test.go index c4944d0de..640ff5d0a 100644 --- a/internal/featuredetection/feature_detection_test.go +++ b/internal/featuredetection/feature_detection_test.go @@ -1,6 +1,7 @@ package featuredetection import ( + "fmt" "net/http" "testing" @@ -91,6 +92,7 @@ func TestPullRequestFeatures(t *testing.T) { {"name": "isMergeQueueEnabled"} ] } } } `), + `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), }, wantFeatures: PullRequestFeatures{ MergeQueue: true, @@ -105,6 +107,7 @@ func TestPullRequestFeatures(t *testing.T) { { "data": { "PullRequest": { "fields": [ ] } } } `), + `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), }, wantFeatures: PullRequestFeatures{ MergeQueue: false, @@ -121,12 +124,47 @@ func TestPullRequestFeatures(t *testing.T) { {"name": "isMergeQueueEnabled"} ] } } } `), + `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), }, wantFeatures: PullRequestFeatures{ MergeQueue: true, }, wantErr: false, }, + { + name: "Any GitHub host without check run and status context count support", + hostname: "github.com", + queryResponse: map[string]string{ + `query PullRequest_fields\b`: emptyIntrospectionFor("PullRequest"), + `query StatusCheckRollupContextConnection_fields\b`: heredoc.Doc(` + { "data": { "StatusCheckRollupContextConnection": { "fields": [ + ] } } } + `), + }, + wantFeatures: PullRequestFeatures{ + CheckRunAndStatusContextCounts: false, + }, + wantErr: false, + }, + { + name: "Any GitHub host with check run and status context count support", + hostname: "github.com", + queryResponse: map[string]string{ + `query PullRequest_fields\b`: emptyIntrospectionFor("PullRequest"), + `query StatusCheckRollupContextConnection_fields\b`: heredoc.Doc(` + { "data": { "StatusCheckRollupContextConnection": { "fields": [ + {"name": "checkRunCount"}, + {"name": "checkRunCountsByState"}, + {"name": "statusContextCount"}, + {"name": "statusContextCountsByState"} + ] } } } + `), + }, + wantFeatures: PullRequestFeatures{ + CheckRunAndStatusContextCounts: true, + }, + wantErr: false, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -243,3 +281,10 @@ func TestRepositoryFeatures(t *testing.T) { }) } } + +func emptyIntrospectionFor(typ string) string { + return fmt.Sprintf(` + { "data": { "%s": { "fields": [ + ] } } } + `, typ) +} From bfd3c7b20b0a3cba7e1259e17c4a6c3dcf3f8cc5 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 17 May 2023 16:24:13 +0200 Subject: [PATCH 31/90] Short circuit status check GQL introspection for GitHub.com --- .../featuredetection/feature_detection.go | 78 +++++++++++-------- .../feature_detection_test.go | 26 +++++-- 2 files changed, 65 insertions(+), 39 deletions(-) diff --git a/internal/featuredetection/feature_detection.go b/internal/featuredetection/feature_detection.go index ac894a371..4cf101c62 100644 --- a/internal/featuredetection/feature_detection.go +++ b/internal/featuredetection/feature_detection.go @@ -99,32 +99,58 @@ func (d *detector) PullRequestFeatures() (PullRequestFeatures, error) { // } features := PullRequestFeatures{} - - var pullRequestFeatureDetection struct { - PullRequest struct { - Fields []struct { - Name string - } `graphql:"fields(includeDeprecated: true)"` - } `graphql:"PullRequest: __type(name: \"PullRequest\")"` - } - - var statusCheckRollupContextConnectionFeatureDetection struct { - StatusCheckRollupContextConnection struct { - Fields []struct { - Name string - } `graphql:"fields(includeDeprecated: true)"` - } `graphql:"StatusCheckRollupContextConnection: __type(name: \"StatusCheckRollupContextConnection\")"` - } - gql := api.NewClientFromHTTP(d.httpClient) g := new(errgroup.Group) g.Go(func() error { - return gql.Query(d.host, "PullRequest_fields", &pullRequestFeatureDetection, nil) + var pullRequestFeatureDetection struct { + PullRequest struct { + Fields []struct { + Name string + } `graphql:"fields(includeDeprecated: true)"` + } `graphql:"PullRequest: __type(name: \"PullRequest\")"` + } + + if err := gql.Query(d.host, "PullRequest_fields", &pullRequestFeatureDetection, nil); err != nil { + return err + } + + for _, field := range pullRequestFeatureDetection.PullRequest.Fields { + if field.Name == "isInMergeQueue" { + features.MergeQueue = true + } + } + + return nil }) g.Go(func() error { - return gql.Query(d.host, "StatusCheckRollupContextConnection_fields", &statusCheckRollupContextConnectionFeatureDetection, nil) + if !ghinstance.IsEnterprise(d.host) { + features.CheckRunAndStatusContextCounts = true + return nil + } + + var statusCheckRollupContextConnectionFeatureDetection struct { + StatusCheckRollupContextConnection struct { + Fields []struct { + Name string + } `graphql:"fields(includeDeprecated: true)"` + } `graphql:"StatusCheckRollupContextConnection: __type(name: \"StatusCheckRollupContextConnection\")"` + } + + if err := gql.Query(d.host, "StatusCheckRollupContextConnection_fields", &statusCheckRollupContextConnectionFeatureDetection, nil); err != nil { + return err + } + + for _, field := range statusCheckRollupContextConnectionFeatureDetection.StatusCheckRollupContextConnection.Fields { + // We only check for checkRunCount here but it, checkRunCountsByState, statusContextCount and statusContextCountsByState + // were all introduced in the same version of the API. + if field.Name == "checkRunCount" { + features.CheckRunAndStatusContextCounts = true + } + } + + return nil }) err := g.Wait() @@ -132,20 +158,6 @@ func (d *detector) PullRequestFeatures() (PullRequestFeatures, error) { return features, err } - for _, field := range pullRequestFeatureDetection.PullRequest.Fields { - if field.Name == "isInMergeQueue" { - features.MergeQueue = true - } - } - - for _, field := range statusCheckRollupContextConnectionFeatureDetection.StatusCheckRollupContextConnection.Fields { - // We only check for checkRunCount here but it, checkRunCountsByState, statusContextCount and statusContextCountsByState - // were all introduced in the same version of the API. - if field.Name == "checkRunCount" { - features.CheckRunAndStatusContextCounts = true - } - } - return features, nil } diff --git a/internal/featuredetection/feature_detection_test.go b/internal/featuredetection/feature_detection_test.go index 640ff5d0a..3cc94e057 100644 --- a/internal/featuredetection/feature_detection_test.go +++ b/internal/featuredetection/feature_detection_test.go @@ -83,7 +83,7 @@ func TestPullRequestFeatures(t *testing.T) { wantErr bool }{ { - name: "github.com", + name: "github.com with merge queue", hostname: "github.com", queryResponse: map[string]string{ `query PullRequest_fields\b`: heredoc.Doc(` @@ -95,7 +95,8 @@ func TestPullRequestFeatures(t *testing.T) { `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), }, wantFeatures: PullRequestFeatures{ - MergeQueue: true, + MergeQueue: true, + CheckRunAndStatusContextCounts: true, }, wantErr: false, }, @@ -110,7 +111,8 @@ func TestPullRequestFeatures(t *testing.T) { `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), }, wantFeatures: PullRequestFeatures{ - MergeQueue: false, + MergeQueue: false, + CheckRunAndStatusContextCounts: true, }, wantErr: false, }, @@ -132,8 +134,20 @@ func TestPullRequestFeatures(t *testing.T) { wantErr: false, }, { - name: "Any GitHub host without check run and status context count support", + name: "GitHub.com supports check and run status context counts regardless of GQL response", hostname: "github.com", + queryResponse: map[string]string{ + `query PullRequest_fields\b`: emptyIntrospectionFor("PullRequest"), + `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), + }, + wantFeatures: PullRequestFeatures{ + CheckRunAndStatusContextCounts: true, + }, + wantErr: false, + }, + { + name: "GHE without check run and status context count support", + hostname: "git.my.org", queryResponse: map[string]string{ `query PullRequest_fields\b`: emptyIntrospectionFor("PullRequest"), `query StatusCheckRollupContextConnection_fields\b`: heredoc.Doc(` @@ -147,8 +161,8 @@ func TestPullRequestFeatures(t *testing.T) { wantErr: false, }, { - name: "Any GitHub host with check run and status context count support", - hostname: "github.com", + name: "GHE host with check run and status context count support", + hostname: "git.my.org", queryResponse: map[string]string{ `query PullRequest_fields\b`: emptyIntrospectionFor("PullRequest"), `query StatusCheckRollupContextConnection_fields\b`: heredoc.Doc(` From ebb7d26f3a223d141f246a025b3809edee713b77 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 17 May 2023 18:44:00 +0200 Subject: [PATCH 32/90] Implement initial spike for detecting and using counts by state --- api/query_builder.go | 58 +++- pkg/cmd/pr/shared/finder.go | 2 +- .../pr/status/fixtures/prIntrospection.json | 317 ++++++++++++++++++ pkg/cmd/pr/status/http.go | 26 +- pkg/cmd/pr/status/status_test.go | 5 +- 5 files changed, 395 insertions(+), 13 deletions(-) create mode 100644 pkg/cmd/pr/status/fixtures/prIntrospection.json diff --git a/api/query_builder.go b/api/query_builder.go index 3e54f4c60..4274e45e8 100644 --- a/api/query_builder.go +++ b/api/query_builder.go @@ -143,7 +143,31 @@ var autoMergeRequest = shortenQuery(` } `) -func StatusCheckRollupGraphQL(after string) string { +func StatusCheckRollupGraphQLWithCountByState() string { + return shortenQuery(` + statusCheckRollup: commits(last: 1) { + nodes { + commit { + statusCheckRollup { + contexts { + checkRunCount, + checkRunCountsByState { + state, + count + }, + statusContextCount, + statusContextCountsByState { + state, + count + } + } + } + } + } + }`) +} + +func StatusCheckRollupGraphQLWithoutCountByState(after string) string { var afterClause string if after != "" { afterClause = ",after:" + after @@ -268,8 +292,28 @@ var PullRequestFields = append(IssueFields, "statusCheckRollup", ) +type issueGraphQLOpts struct { + useCheckRunAndStatusContextCounts bool +} + +type IssueGraphQLOptFn func(*issueGraphQLOpts) + +func WithUseCheckRunAndStatusContextCounts() IssueGraphQLOptFn { + return func(opts *issueGraphQLOpts) { + opts.useCheckRunAndStatusContextCounts = true + } +} + // IssueGraphQL constructs a GraphQL query fragment for a set of issue fields. -func IssueGraphQL(fields []string) string { +func IssueGraphQL(fields []string, opts ...IssueGraphQLOptFn) string { + issueGraphQLOpts := issueGraphQLOpts{ + useCheckRunAndStatusContextCounts: false, + } + + for _, opt := range opts { + opt(&issueGraphQLOpts) + } + var q []string for _, field := range fields { switch field { @@ -320,7 +364,11 @@ func IssueGraphQL(fields []string) string { case "requiresStrictStatusChecks": // pseudo-field q = append(q, `baseRef{branchProtectionRule{requiresStrictStatusChecks}}`) case "statusCheckRollup": - q = append(q, StatusCheckRollupGraphQL("")) + if issueGraphQLOpts.useCheckRunAndStatusContextCounts { + q = append(q, StatusCheckRollupGraphQLWithCountByState()) + } else { + q = append(q, StatusCheckRollupGraphQLWithoutCountByState("")) + } default: q = append(q, field) } @@ -330,12 +378,12 @@ func IssueGraphQL(fields []string) string { // PullRequestGraphQL constructs a GraphQL query fragment for a set of pull request fields. // It will try to sanitize the fields to just those available on pull request. -func PullRequestGraphQL(fields []string) string { +func PullRequestGraphQL(fields []string, opts ...IssueGraphQLOptFn) string { invalidFields := []string{"isPinned", "stateReason"} s := set.NewStringSet() s.AddValues(fields) s.RemoveValues(invalidFields) - return IssueGraphQL(s.ToSlice()) + return IssueGraphQL(s.ToSlice(), opts...) } var RepositoryFields = []string{ diff --git a/pkg/cmd/pr/shared/finder.go b/pkg/cmd/pr/shared/finder.go index f1886b3fe..4bb79ac8b 100644 --- a/pkg/cmd/pr/shared/finder.go +++ b/pkg/cmd/pr/shared/finder.go @@ -465,7 +465,7 @@ func preloadPrChecks(client *http.Client, repo ghrepo.Interface, pr *api.PullReq %s } } - }`, api.StatusCheckRollupGraphQL("$endCursor")) + }`, api.StatusCheckRollupGraphQLWithoutCountByState("$endCursor")) variables := map[string]interface{}{ "id": pr.ID, diff --git a/pkg/cmd/pr/status/fixtures/prIntrospection.json b/pkg/cmd/pr/status/fixtures/prIntrospection.json new file mode 100644 index 000000000..e50ca8df5 --- /dev/null +++ b/pkg/cmd/pr/status/fixtures/prIntrospection.json @@ -0,0 +1,317 @@ +{ + "data": { + "PullRequest": { + "fields": [ + { + "name": "activeLockReason" + }, + { + "name": "additions" + }, + { + "name": "assignees" + }, + { + "name": "author" + }, + { + "name": "authorAssociation" + }, + { + "name": "autoMergeRequest" + }, + { + "name": "baseRef" + }, + { + "name": "baseRefName" + }, + { + "name": "baseRefOid" + }, + { + "name": "baseRepository" + }, + { + "name": "body" + }, + { + "name": "bodyHTML" + }, + { + "name": "bodyText" + }, + { + "name": "changedFiles" + }, + { + "name": "checksResourcePath" + }, + { + "name": "checksUrl" + }, + { + "name": "closed" + }, + { + "name": "closedAt" + }, + { + "name": "closingIssuesReferences" + }, + { + "name": "comments" + }, + { + "name": "commits" + }, + { + "name": "createdAt" + }, + { + "name": "createdViaEmail" + }, + { + "name": "databaseId" + }, + { + "name": "deletions" + }, + { + "name": "editor" + }, + { + "name": "files" + }, + { + "name": "headRef" + }, + { + "name": "headRefName" + }, + { + "name": "headRefOid" + }, + { + "name": "headRepository" + }, + { + "name": "headRepositoryOwner" + }, + { + "name": "hovercard" + }, + { + "name": "id" + }, + { + "name": "includesCreatedEdit" + }, + { + "name": "isCrossRepository" + }, + { + "name": "isDraft" + }, + { + "name": "isInMergeQueue" + }, + { + "name": "isMergeQueueEnabled" + }, + { + "name": "isReadByViewer" + }, + { + "name": "labels" + }, + { + "name": "lastEditedAt" + }, + { + "name": "latestOpinionatedReviews" + }, + { + "name": "latestReviews" + }, + { + "name": "locked" + }, + { + "name": "maintainerCanModify" + }, + { + "name": "mergeCommit" + }, + { + "name": "mergeQueue" + }, + { + "name": "mergeQueueEntry" + }, + { + "name": "mergeable" + }, + { + "name": "merged" + }, + { + "name": "mergedAt" + }, + { + "name": "mergedBy" + }, + { + "name": "milestone" + }, + { + "name": "number" + }, + { + "name": "participants" + }, + { + "name": "permalink" + }, + { + "name": "potentialMergeCommit" + }, + { + "name": "projectCards" + }, + { + "name": "projectItems" + }, + { + "name": "projectV2" + }, + { + "name": "projectsV2" + }, + { + "name": "publishedAt" + }, + { + "name": "reactionGroups" + }, + { + "name": "reactions" + }, + { + "name": "repository" + }, + { + "name": "resourcePath" + }, + { + "name": "revertResourcePath" + }, + { + "name": "revertUrl" + }, + { + "name": "reviewDecision" + }, + { + "name": "reviewRequests" + }, + { + "name": "reviewThreads" + }, + { + "name": "reviews" + }, + { + "name": "state" + }, + { + "name": "suggestedReviewers" + }, + { + "name": "timeline" + }, + { + "name": "timelineItems" + }, + { + "name": "title" + }, + { + "name": "titleHTML" + }, + { + "name": "totalCommentsCount" + }, + { + "name": "updatedAt" + }, + { + "name": "url" + }, + { + "name": "userContentEdits" + }, + { + "name": "viewerCanAddAndRemoveFromMergeQueue" + }, + { + "name": "viewerCanApplySuggestion" + }, + { + "name": "viewerCanClose" + }, + { + "name": "viewerCanDeleteHeadRef" + }, + { + "name": "viewerCanDisableAutoMerge" + }, + { + "name": "viewerCanEditFiles" + }, + { + "name": "viewerCanEnableAutoMerge" + }, + { + "name": "viewerCanMergeAsAdmin" + }, + { + "name": "viewerCanReact" + }, + { + "name": "viewerCanReopen" + }, + { + "name": "viewerCanSubscribe" + }, + { + "name": "viewerCanUpdate" + }, + { + "name": "viewerCanUpdateBranch" + }, + { + "name": "viewerCannotUpdateReasons" + }, + { + "name": "viewerDidAuthor" + }, + { + "name": "viewerLatestReview" + }, + { + "name": "viewerLatestReviewRequest" + }, + { + "name": "viewerMergeBodyText" + }, + { + "name": "viewerMergeHeadlineText" + }, + { + "name": "viewerSubscription" + } + ] + } + } +} diff --git a/pkg/cmd/pr/status/http.go b/pkg/cmd/pr/status/http.go index 49bdb147c..1c38e2221 100644 --- a/pkg/cmd/pr/status/http.go +++ b/pkg/cmd/pr/status/http.go @@ -4,8 +4,10 @@ import ( "fmt" "net/http" "strings" + "time" "github.com/cli/cli/v2/api" + fd "github.com/cli/cli/v2/internal/featuredetection" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/set" @@ -47,17 +49,30 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r ReviewRequested edges } + // SPIKE: Let's see if we can detect here and wire through + cachedClient := api.NewCachedHTTPClient(httpClient, time.Hour*24) + detector := fd.NewDetector(cachedClient, repo.RepoHost()) + prFeatures, err := detector.PullRequestFeatures() + if err != nil { + return nil, err + } + + var prGraphQLOpts []api.IssueGraphQLOptFn + if prFeatures.CheckRunAndStatusContextCounts { + prGraphQLOpts = append(prGraphQLOpts, api.WithUseCheckRunAndStatusContextCounts()) + } + var fragments string if len(options.Fields) > 0 { fields := set.NewStringSet() fields.AddValues(options.Fields) // these are always necessary to find the PR for the current branch fields.AddValues([]string{"isCrossRepository", "headRepositoryOwner", "headRefName"}) - gr := api.PullRequestGraphQL(fields.ToSlice()) + gr := api.PullRequestGraphQL(fields.ToSlice(), prGraphQLOpts...) fragments = fmt.Sprintf("fragment pr on PullRequest{%s}fragment prWithReviews on PullRequest{...pr}", gr) } else { var err error - fragments, err = pullRequestFragment(repo.RepoHost(), options.ConflictStatus) + fragments, err = pullRequestFragment(repo.RepoHost(), options.ConflictStatus, prGraphQLOpts...) if err != nil { return nil, err } @@ -146,8 +161,7 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r } var resp response - err := apiClient.GraphQL(repo.RepoHost(), query, variables, &resp) - if err != nil { + if err = apiClient.GraphQL(repo.RepoHost(), query, variables, &resp); err != nil { return nil, err } @@ -187,7 +201,7 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r return &payload, nil } -func pullRequestFragment(hostname string, conflictStatus bool) (string, error) { +func pullRequestFragment(hostname string, conflictStatus bool, opts ...api.IssueGraphQLOptFn) (string, error) { fields := []string{ "number", "title", "state", "url", "isDraft", "isCrossRepository", "headRefName", "headRepositoryOwner", "mergeStateStatus", @@ -201,6 +215,6 @@ func pullRequestFragment(hostname string, conflictStatus bool) (string, error) { fragments := fmt.Sprintf(` fragment pr on PullRequest {%s} fragment prWithReviews on PullRequest {...pr,%s} - `, api.PullRequestGraphQL(fields), api.PullRequestGraphQL(reviewFields)) + `, api.PullRequestGraphQL(fields, opts...), api.PullRequestGraphQL(reviewFields, opts...)) return fragments, nil } diff --git a/pkg/cmd/pr/status/status_test.go b/pkg/cmd/pr/status/status_test.go index 1b39ddb24..8529c070b 100644 --- a/pkg/cmd/pr/status/status_test.go +++ b/pkg/cmd/pr/status/status_test.go @@ -76,7 +76,10 @@ func runCommand(rt http.RoundTripper, branch string, isTTY bool, cli string) (*t } func initFakeHTTP() *httpmock.Registry { - return &httpmock.Registry{} + registry := &httpmock.Registry{} + // SPIKE: perhaps we should inject a mock detector into the command instead? + registry.Register(httpmock.GraphQL(`query PullRequest_fields\b`), httpmock.FileResponse("./fixtures/prIntrospection.json")) + return registry } func TestPRStatus(t *testing.T) { From d8888f26419410f2797fbf7e70d862625a81820d Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 19 May 2023 14:58:34 +0000 Subject: [PATCH 33/90] build(deps): bump github.com/stretchr/testify from 1.8.2 to 1.8.3 Bumps [github.com/stretchr/testify](https://github.com/stretchr/testify) from 1.8.2 to 1.8.3. - [Release notes](https://github.com/stretchr/testify/releases) - [Commits](https://github.com/stretchr/testify/compare/v1.8.2...v1.8.3) --- updated-dependencies: - dependency-name: github.com/stretchr/testify dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 33f10c733..bbe91a50a 100644 --- a/go.mod +++ b/go.mod @@ -34,7 +34,7 @@ require ( github.com/sourcegraph/jsonrpc2 v0.1.0 github.com/spf13/cobra v1.6.1 github.com/spf13/pflag v1.0.5 - github.com/stretchr/testify v1.8.2 + github.com/stretchr/testify v1.8.3 github.com/zalando/go-keyring v0.2.3 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 golang.org/x/sync v0.1.0 diff --git a/go.sum b/go.sum index 331bef06c..c94d8f9ae 100644 --- a/go.sum +++ b/go.sum @@ -259,8 +259,8 @@ github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= -github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8= -github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY= +github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e h1:BuzhfgfWQbX0dWzYzT1zsORLnHRv3bcRcsaUk0VmXA8= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e/go.mod h1:/Tnicc6m/lsJE0irFMA0LfIwTBo4QP7A8IfyIv4zZKI= github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= From bf5427a65347c4fd286f677a06e4dbe609520a0d Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 22 May 2023 12:19:37 +0200 Subject: [PATCH 34/90] Update triage.md with severity descriptions --- docs/triage.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/triage.md b/docs/triage.md index 8a329de7c..da69c892e 100644 --- a/docs/triage.md +++ b/docs/triage.md @@ -16,7 +16,10 @@ To be considered triaged, `enhancement` issues require at least one of the follo - `needs-investigation`: work that requires a mystery be solved by the core team before it can move forward - `needs-user-input`: we need more information from our users before the task can move forward -To be considered triaged, `bug` issues require a severity label: one of `p1`, `p2`, or `p3` +To be considered triaged, `bug` issues require a severity label: one of `p1`, `p2`, or `p3`, which are defined as follows: + - `p1`: Affects a large population and inhibits work + - `p2`: Affects more than a few users but doesn't prevent core functions + - `p3`: Affects a small number of users or is largely cosmetic ## Expectations for community pull requests From 917c1faa71e367d07f76eab9f69b0187d93d3848 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Mon, 22 May 2023 12:31:05 +0200 Subject: [PATCH 35/90] Update browser package to avoid Windows crash --- go.mod | 2 +- go.sum | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/go.mod b/go.mod index bbe91a50a..86ae08506 100644 --- a/go.mod +++ b/go.mod @@ -49,7 +49,7 @@ require ( github.com/alecthomas/chroma v0.10.0 // indirect github.com/alessio/shellescape v1.4.1 // indirect github.com/aymerick/douceur v0.2.0 // indirect - github.com/cli/browser v1.1.0 // indirect + github.com/cli/browser v1.2.0 // indirect github.com/cli/shurcooL-graphql v0.0.3 // indirect github.com/danieljoos/wincred v1.2.0 // indirect github.com/davecgh/go-spew v1.1.1 // indirect diff --git a/go.sum b/go.sum index c94d8f9ae..4b9332ac5 100644 --- a/go.sum +++ b/go.sum @@ -58,8 +58,8 @@ github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWR github.com/chzyer/readline v0.0.0-20180603132655-2972be24d48e/go.mod h1:nSuG5e5PlCu98SY8svDHJxuZscDgtXS6KTTbou5AhLI= github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1/go.mod h1:Q3SI9o4m/ZMnBNeIyt5eFwwo7qiLfzFZmjNmxjkiQlU= github.com/cli/browser v1.0.0/go.mod h1:IEWkHYbLjkhtjwwWlwTHW2lGxeS5gezEQBMLTwDHf5Q= -github.com/cli/browser v1.1.0 h1:xOZBfkfY9L9vMBgqb1YwRirGu6QFaQ5dP/vXt5ENSOY= -github.com/cli/browser v1.1.0/go.mod h1:HKMQAt9t12kov91Mn7RfZxyJQQgWgyS/3SZswlZ5iTI= +github.com/cli/browser v1.2.0 h1:yvU7e9qf97kZqGFX6n2zJPHsmSObY9ske+iCvKelvXg= +github.com/cli/browser v1.2.0/go.mod h1:xFFnXLVcAyW9ni0cuo6NnrbCP75JxJ0RO7VtCBiH/oI= github.com/cli/crypto v0.0.0-20210929142629-6be313f59b03 h1:3f4uHLfWx4/WlnMPXGai03eoWAI+oGHJwr+5OXfxCr8= github.com/cli/crypto v0.0.0-20210929142629-6be313f59b03/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= github.com/cli/go-gh/v2 v2.0.0 h1:JAgQY7VNHletsO0Eqr+/PzF7fF5QEjhY2t2+Tev3vmk= @@ -391,9 +391,9 @@ golang.org/x/sys v0.0.0-20200515095857-1151b9dac4a9/go.mod h1:h1NjWce9XRLGQEsW7w golang.org/x/sys v0.0.0-20200523222454-059865788121/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20200803210538-64077c9b5642/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210319071255-635bc2c9138d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210616045830-e2b7044e8c71/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20210831042530-f4d43177bf5e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= From 70678b7333da64be932ad83dd6829a80c4abe7ca Mon Sep 17 00:00:00 2001 From: Torgeir Thoresen Date: Mon, 22 May 2023 13:37:27 +0200 Subject: [PATCH 36/90] Clarify docs regarding what is listed when running gh workflow list Prevent confusion that `--all` actually list all workflows, `--limit` is what actually needs to be adjusted to list all workflows, if there are many. --- pkg/cmd/actions/actions.go | 2 +- pkg/cmd/workflow/list/list.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/actions/actions.go b/pkg/cmd/actions/actions.go index d24df6631..fcf33f447 100644 --- a/pkg/cmd/actions/actions.go +++ b/pkg/cmd/actions/actions.go @@ -42,7 +42,7 @@ func actionsExplainer(cs *iostreams.ColorScheme) string { To see more help, run 'gh help run ' %s - gh workflow list: List all the workflow files in your repository + gh workflow list: List workflow files in your repository gh workflow view: View details for a workflow file gh workflow enable: Enable a workflow file gh workflow disable: Disable a workflow file diff --git a/pkg/cmd/workflow/list/list.go b/pkg/cmd/workflow/list/list.go index a080c4cf9..f590f1602 100644 --- a/pkg/cmd/workflow/list/list.go +++ b/pkg/cmd/workflow/list/list.go @@ -58,7 +58,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman } cmd.Flags().IntVarP(&opts.Limit, "limit", "L", defaultLimit, "Maximum number of workflows to fetch") - cmd.Flags().BoolVarP(&opts.All, "all", "a", false, "Show all workflows, including disabled workflows") + cmd.Flags().BoolVarP(&opts.All, "all", "a", false, "Also show disabled workflows") return cmd } From 0a3c5726b74ccbdc0751a2123724cbbb55d6203c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 22 May 2023 15:00:08 +0000 Subject: [PATCH 37/90] build(deps): bump github.com/mattn/go-isatty from 0.0.18 to 0.0.19 Bumps [github.com/mattn/go-isatty](https://github.com/mattn/go-isatty) from 0.0.18 to 0.0.19. - [Commits](https://github.com/mattn/go-isatty/compare/v0.0.18...v0.0.19) --- updated-dependencies: - dependency-name: github.com/mattn/go-isatty dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index bbe91a50a..9ffaa210d 100644 --- a/go.mod +++ b/go.mod @@ -25,7 +25,7 @@ require ( github.com/joho/godotenv v1.5.1 github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51 github.com/mattn/go-colorable v0.1.13 - github.com/mattn/go-isatty v0.0.18 + github.com/mattn/go-isatty v0.0.19 github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38 github.com/opentracing/opentracing-go v1.1.0 diff --git a/go.sum b/go.sum index c94d8f9ae..55347601b 100644 --- a/go.sum +++ b/go.sum @@ -199,8 +199,8 @@ github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovk github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s= github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= -github.com/mattn/go-isatty v0.0.18 h1:DOKFKCQ7FNG2L1rbrmstDN4QVRdS89Nkh85u68Uwp98= -github.com/mattn/go-isatty v0.0.18/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-isatty v0.0.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= +github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI= github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= From 75e35e2ddee2afe846ae29a5b95588752167ce57 Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 22 May 2023 17:28:15 +0200 Subject: [PATCH 38/90] Use pseudo field for statusCheckRollupWithCountByState --- api/query_builder.go | 34 ++++++---------------------------- pkg/cmd/pr/status/http.go | 29 +++++++++++++++++++---------- 2 files changed, 25 insertions(+), 38 deletions(-) diff --git a/api/query_builder.go b/api/query_builder.go index 4274e45e8..76eb5294a 100644 --- a/api/query_builder.go +++ b/api/query_builder.go @@ -292,28 +292,8 @@ var PullRequestFields = append(IssueFields, "statusCheckRollup", ) -type issueGraphQLOpts struct { - useCheckRunAndStatusContextCounts bool -} - -type IssueGraphQLOptFn func(*issueGraphQLOpts) - -func WithUseCheckRunAndStatusContextCounts() IssueGraphQLOptFn { - return func(opts *issueGraphQLOpts) { - opts.useCheckRunAndStatusContextCounts = true - } -} - // IssueGraphQL constructs a GraphQL query fragment for a set of issue fields. -func IssueGraphQL(fields []string, opts ...IssueGraphQLOptFn) string { - issueGraphQLOpts := issueGraphQLOpts{ - useCheckRunAndStatusContextCounts: false, - } - - for _, opt := range opts { - opt(&issueGraphQLOpts) - } - +func IssueGraphQL(fields []string) string { var q []string for _, field := range fields { switch field { @@ -364,11 +344,9 @@ func IssueGraphQL(fields []string, opts ...IssueGraphQLOptFn) string { case "requiresStrictStatusChecks": // pseudo-field q = append(q, `baseRef{branchProtectionRule{requiresStrictStatusChecks}}`) case "statusCheckRollup": - if issueGraphQLOpts.useCheckRunAndStatusContextCounts { - q = append(q, StatusCheckRollupGraphQLWithCountByState()) - } else { - q = append(q, StatusCheckRollupGraphQLWithoutCountByState("")) - } + q = append(q, StatusCheckRollupGraphQLWithoutCountByState("")) + case "statusCheckRollupWithCountByState": // pseudo-field + q = append(q, StatusCheckRollupGraphQLWithCountByState()) default: q = append(q, field) } @@ -378,12 +356,12 @@ func IssueGraphQL(fields []string, opts ...IssueGraphQLOptFn) string { // PullRequestGraphQL constructs a GraphQL query fragment for a set of pull request fields. // It will try to sanitize the fields to just those available on pull request. -func PullRequestGraphQL(fields []string, opts ...IssueGraphQLOptFn) string { +func PullRequestGraphQL(fields []string) string { invalidFields := []string{"isPinned", "stateReason"} s := set.NewStringSet() s.AddValues(fields) s.RemoveValues(invalidFields) - return IssueGraphQL(s.ToSlice(), opts...) + return IssueGraphQL(s.ToSlice()) } var RepositoryFields = []string{ diff --git a/pkg/cmd/pr/status/http.go b/pkg/cmd/pr/status/http.go index 1c38e2221..b240ee8ca 100644 --- a/pkg/cmd/pr/status/http.go +++ b/pkg/cmd/pr/status/http.go @@ -57,22 +57,24 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r return nil, err } - var prGraphQLOpts []api.IssueGraphQLOptFn - if prFeatures.CheckRunAndStatusContextCounts { - prGraphQLOpts = append(prGraphQLOpts, api.WithUseCheckRunAndStatusContextCounts()) - } - var fragments string if len(options.Fields) > 0 { fields := set.NewStringSet() fields.AddValues(options.Fields) // these are always necessary to find the PR for the current branch fields.AddValues([]string{"isCrossRepository", "headRepositoryOwner", "headRefName"}) - gr := api.PullRequestGraphQL(fields.ToSlice(), prGraphQLOpts...) + + if prFeatures.CheckRunAndStatusContextCounts { + fields.Add("statusCheckRollupWithCountByState") + } else { + fields.Add("statusCheckRollup") + } + + gr := api.PullRequestGraphQL(fields.ToSlice()) fragments = fmt.Sprintf("fragment pr on PullRequest{%s}fragment prWithReviews on PullRequest{...pr}", gr) } else { var err error - fragments, err = pullRequestFragment(repo.RepoHost(), options.ConflictStatus, prGraphQLOpts...) + fragments, err = pullRequestFragment(repo.RepoHost(), options.ConflictStatus, prFeatures.CheckRunAndStatusContextCounts) if err != nil { return nil, err } @@ -201,20 +203,27 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r return &payload, nil } -func pullRequestFragment(hostname string, conflictStatus bool, opts ...api.IssueGraphQLOptFn) (string, error) { +func pullRequestFragment(hostname string, conflictStatus bool, statusCheckRollupWithCountByState bool) (string, error) { fields := []string{ "number", "title", "state", "url", "isDraft", "isCrossRepository", "headRefName", "headRepositoryOwner", "mergeStateStatus", - "statusCheckRollup", "requiresStrictStatusChecks", "autoMergeRequest", + "requiresStrictStatusChecks", "autoMergeRequest", } if conflictStatus { fields = append(fields, "mergeable") } + + if statusCheckRollupWithCountByState { + fields = append(fields, "statusCheckRollupWithCountByState") + } else { + fields = append(fields, "statusCheckRollup") + } + reviewFields := []string{"reviewDecision", "latestReviews"} fragments := fmt.Sprintf(` fragment pr on PullRequest {%s} fragment prWithReviews on PullRequest {...pr,%s} - `, api.PullRequestGraphQL(fields, opts...), api.PullRequestGraphQL(reviewFields, opts...)) + `, api.PullRequestGraphQL(fields), api.PullRequestGraphQL(reviewFields)) return fragments, nil } From cdd05a38c66df745e329c94d0d09cd1e1e9f9777 Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 22 May 2023 17:32:52 +0200 Subject: [PATCH 39/90] Move CheckRunAndStatusContextCounts feature detection up stack --- pkg/cmd/pr/status/http.go | 18 +++++------------- pkg/cmd/pr/status/status.go | 11 +++++++++++ 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/pkg/cmd/pr/status/http.go b/pkg/cmd/pr/status/http.go index b240ee8ca..666076c86 100644 --- a/pkg/cmd/pr/status/http.go +++ b/pkg/cmd/pr/status/http.go @@ -4,10 +4,8 @@ import ( "fmt" "net/http" "strings" - "time" "github.com/cli/cli/v2/api" - fd "github.com/cli/cli/v2/internal/featuredetection" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/set" @@ -19,6 +17,8 @@ type requestOptions struct { Username string Fields []string ConflictStatus bool + + CheckRunAndStatusContextCountsSupported bool } type pullRequestsPayload struct { @@ -49,14 +49,6 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r ReviewRequested edges } - // SPIKE: Let's see if we can detect here and wire through - cachedClient := api.NewCachedHTTPClient(httpClient, time.Hour*24) - detector := fd.NewDetector(cachedClient, repo.RepoHost()) - prFeatures, err := detector.PullRequestFeatures() - if err != nil { - return nil, err - } - var fragments string if len(options.Fields) > 0 { fields := set.NewStringSet() @@ -64,7 +56,7 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r // these are always necessary to find the PR for the current branch fields.AddValues([]string{"isCrossRepository", "headRepositoryOwner", "headRefName"}) - if prFeatures.CheckRunAndStatusContextCounts { + if options.CheckRunAndStatusContextCountsSupported { fields.Add("statusCheckRollupWithCountByState") } else { fields.Add("statusCheckRollup") @@ -74,7 +66,7 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r fragments = fmt.Sprintf("fragment pr on PullRequest{%s}fragment prWithReviews on PullRequest{...pr}", gr) } else { var err error - fragments, err = pullRequestFragment(repo.RepoHost(), options.ConflictStatus, prFeatures.CheckRunAndStatusContextCounts) + fragments, err = pullRequestFragment(repo.RepoHost(), options.ConflictStatus, options.CheckRunAndStatusContextCountsSupported) if err != nil { return nil, err } @@ -163,7 +155,7 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r } var resp response - if err = apiClient.GraphQL(repo.RepoHost(), query, variables, &resp); err != nil { + if err := apiClient.GraphQL(repo.RepoHost(), query, variables, &resp); err != nil { return nil, err } diff --git a/pkg/cmd/pr/status/status.go b/pkg/cmd/pr/status/status.go index fa517bada..df9888d3a 100644 --- a/pkg/cmd/pr/status/status.go +++ b/pkg/cmd/pr/status/status.go @@ -8,11 +8,13 @@ import ( "regexp" "strconv" "strings" + "time" "github.com/cli/cli/v2/api" ghContext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + fd "github.com/cli/cli/v2/internal/featuredetection" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/pr/shared" @@ -105,6 +107,15 @@ func statusRun(opts *StatusOptions) error { options.Fields = opts.Exporter.Fields() } + // SPIKE: Let's see if we can detect here and wire through + cachedClient := api.NewCachedHTTPClient(httpClient, time.Hour*24) + detector := fd.NewDetector(cachedClient, baseRepo.RepoHost()) + prFeatures, err := detector.PullRequestFeatures() + if err != nil { + return err + } + options.CheckRunAndStatusContextCountsSupported = prFeatures.CheckRunAndStatusContextCounts + prPayload, err := pullRequestStatus(httpClient, baseRepo, options) if err != nil { return err From 42b61ad53e6ffd264499793faf319ed5fbcfc5b4 Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 22 May 2023 18:44:51 +0200 Subject: [PATCH 40/90] Inject fake detector into PR status tests --- internal/featuredetection/feature_detection.go | 3 ++- pkg/cmd/pr/status/status.go | 11 +++++++---- pkg/cmd/pr/status/status_test.go | 13 ++++++++----- 3 files changed, 17 insertions(+), 10 deletions(-) diff --git a/internal/featuredetection/feature_detection.go b/internal/featuredetection/feature_detection.go index 4cf101c62..f180c72ff 100644 --- a/internal/featuredetection/feature_detection.go +++ b/internal/featuredetection/feature_detection.go @@ -31,7 +31,8 @@ type PullRequestFeatures struct { } var allPullRequestFeatures = PullRequestFeatures{ - MergeQueue: true, + MergeQueue: true, + CheckRunAndStatusContextCounts: true, } type RepositoryFeatures struct { diff --git a/pkg/cmd/pr/status/status.go b/pkg/cmd/pr/status/status.go index df9888d3a..bb7bb735d 100644 --- a/pkg/cmd/pr/status/status.go +++ b/pkg/cmd/pr/status/status.go @@ -35,6 +35,8 @@ type StatusOptions struct { HasRepoOverride bool Exporter cmdutil.Exporter ConflictStatus bool + + Detector fd.Detector } func NewCmdStatus(f *cmdutil.Factory, runF func(*StatusOptions) error) *cobra.Command { @@ -107,10 +109,11 @@ func statusRun(opts *StatusOptions) error { options.Fields = opts.Exporter.Fields() } - // SPIKE: Let's see if we can detect here and wire through - cachedClient := api.NewCachedHTTPClient(httpClient, time.Hour*24) - detector := fd.NewDetector(cachedClient, baseRepo.RepoHost()) - prFeatures, err := detector.PullRequestFeatures() + if opts.Detector == nil { + cachedClient := api.NewCachedHTTPClient(httpClient, time.Hour*24) + opts.Detector = fd.NewDetector(cachedClient, baseRepo.RepoHost()) + } + prFeatures, err := opts.Detector.PullRequestFeatures() if err != nil { return err } diff --git a/pkg/cmd/pr/status/status_test.go b/pkg/cmd/pr/status/status_test.go index 8529c070b..35e8ecb74 100644 --- a/pkg/cmd/pr/status/status_test.go +++ b/pkg/cmd/pr/status/status_test.go @@ -12,6 +12,7 @@ import ( "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/config" + fd "github.com/cli/cli/v2/internal/featuredetection" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmdutil" @@ -55,7 +56,12 @@ func runCommand(rt http.RoundTripper, branch string, isTTY bool, cli string) (*t GitClient: &git.Client{GitPath: "some/path/git"}, } - cmd := NewCmdStatus(factory, nil) + withAllFeaturesDisabled := func(opts *StatusOptions) error { + opts.Detector = &fd.DisabledDetectorMock{} + return statusRun(opts) + } + + cmd := NewCmdStatus(factory, withAllFeaturesDisabled) cmd.PersistentFlags().StringP("repo", "R", "", "") argv, err := shlex.Split(cli) @@ -76,10 +82,7 @@ func runCommand(rt http.RoundTripper, branch string, isTTY bool, cli string) (*t } func initFakeHTTP() *httpmock.Registry { - registry := &httpmock.Registry{} - // SPIKE: perhaps we should inject a mock detector into the command instead? - registry.Register(httpmock.GraphQL(`query PullRequest_fields\b`), httpmock.FileResponse("./fixtures/prIntrospection.json")) - return registry + return &httpmock.Registry{} } func TestPRStatus(t *testing.T) { From c90b87bdad40053adfddeac8dfc97446914cd3b2 Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 22 May 2023 18:46:28 +0200 Subject: [PATCH 41/90] Remove unused prInstrospection fixture --- .../pr/status/fixtures/prIntrospection.json | 317 ------------------ 1 file changed, 317 deletions(-) delete mode 100644 pkg/cmd/pr/status/fixtures/prIntrospection.json diff --git a/pkg/cmd/pr/status/fixtures/prIntrospection.json b/pkg/cmd/pr/status/fixtures/prIntrospection.json deleted file mode 100644 index e50ca8df5..000000000 --- a/pkg/cmd/pr/status/fixtures/prIntrospection.json +++ /dev/null @@ -1,317 +0,0 @@ -{ - "data": { - "PullRequest": { - "fields": [ - { - "name": "activeLockReason" - }, - { - "name": "additions" - }, - { - "name": "assignees" - }, - { - "name": "author" - }, - { - "name": "authorAssociation" - }, - { - "name": "autoMergeRequest" - }, - { - "name": "baseRef" - }, - { - "name": "baseRefName" - }, - { - "name": "baseRefOid" - }, - { - "name": "baseRepository" - }, - { - "name": "body" - }, - { - "name": "bodyHTML" - }, - { - "name": "bodyText" - }, - { - "name": "changedFiles" - }, - { - "name": "checksResourcePath" - }, - { - "name": "checksUrl" - }, - { - "name": "closed" - }, - { - "name": "closedAt" - }, - { - "name": "closingIssuesReferences" - }, - { - "name": "comments" - }, - { - "name": "commits" - }, - { - "name": "createdAt" - }, - { - "name": "createdViaEmail" - }, - { - "name": "databaseId" - }, - { - "name": "deletions" - }, - { - "name": "editor" - }, - { - "name": "files" - }, - { - "name": "headRef" - }, - { - "name": "headRefName" - }, - { - "name": "headRefOid" - }, - { - "name": "headRepository" - }, - { - "name": "headRepositoryOwner" - }, - { - "name": "hovercard" - }, - { - "name": "id" - }, - { - "name": "includesCreatedEdit" - }, - { - "name": "isCrossRepository" - }, - { - "name": "isDraft" - }, - { - "name": "isInMergeQueue" - }, - { - "name": "isMergeQueueEnabled" - }, - { - "name": "isReadByViewer" - }, - { - "name": "labels" - }, - { - "name": "lastEditedAt" - }, - { - "name": "latestOpinionatedReviews" - }, - { - "name": "latestReviews" - }, - { - "name": "locked" - }, - { - "name": "maintainerCanModify" - }, - { - "name": "mergeCommit" - }, - { - "name": "mergeQueue" - }, - { - "name": "mergeQueueEntry" - }, - { - "name": "mergeable" - }, - { - "name": "merged" - }, - { - "name": "mergedAt" - }, - { - "name": "mergedBy" - }, - { - "name": "milestone" - }, - { - "name": "number" - }, - { - "name": "participants" - }, - { - "name": "permalink" - }, - { - "name": "potentialMergeCommit" - }, - { - "name": "projectCards" - }, - { - "name": "projectItems" - }, - { - "name": "projectV2" - }, - { - "name": "projectsV2" - }, - { - "name": "publishedAt" - }, - { - "name": "reactionGroups" - }, - { - "name": "reactions" - }, - { - "name": "repository" - }, - { - "name": "resourcePath" - }, - { - "name": "revertResourcePath" - }, - { - "name": "revertUrl" - }, - { - "name": "reviewDecision" - }, - { - "name": "reviewRequests" - }, - { - "name": "reviewThreads" - }, - { - "name": "reviews" - }, - { - "name": "state" - }, - { - "name": "suggestedReviewers" - }, - { - "name": "timeline" - }, - { - "name": "timelineItems" - }, - { - "name": "title" - }, - { - "name": "titleHTML" - }, - { - "name": "totalCommentsCount" - }, - { - "name": "updatedAt" - }, - { - "name": "url" - }, - { - "name": "userContentEdits" - }, - { - "name": "viewerCanAddAndRemoveFromMergeQueue" - }, - { - "name": "viewerCanApplySuggestion" - }, - { - "name": "viewerCanClose" - }, - { - "name": "viewerCanDeleteHeadRef" - }, - { - "name": "viewerCanDisableAutoMerge" - }, - { - "name": "viewerCanEditFiles" - }, - { - "name": "viewerCanEnableAutoMerge" - }, - { - "name": "viewerCanMergeAsAdmin" - }, - { - "name": "viewerCanReact" - }, - { - "name": "viewerCanReopen" - }, - { - "name": "viewerCanSubscribe" - }, - { - "name": "viewerCanUpdate" - }, - { - "name": "viewerCanUpdateBranch" - }, - { - "name": "viewerCannotUpdateReasons" - }, - { - "name": "viewerDidAuthor" - }, - { - "name": "viewerLatestReview" - }, - { - "name": "viewerLatestReviewRequest" - }, - { - "name": "viewerMergeBodyText" - }, - { - "name": "viewerMergeHeadlineText" - }, - { - "name": "viewerSubscription" - } - ] - } - } -} From e9ff00bd01957271a78a72ea660089ed6d222476 Mon Sep 17 00:00:00 2001 From: Tommy Petty Date: Mon, 22 May 2023 15:29:48 -0400 Subject: [PATCH 42/90] Updated to sanitize asset filename prior to uploading. Fixes #7024 --- pkg/cmd/release/upload/upload.go | 31 +++++++++++++++- pkg/cmd/release/upload/upload_test.go | 52 +++++++++++++++++++++++++++ 2 files changed, 82 insertions(+), 1 deletion(-) create mode 100644 pkg/cmd/release/upload/upload_test.go diff --git a/pkg/cmd/release/upload/upload.go b/pkg/cmd/release/upload/upload.go index b3af37c4a..12cba4542 100644 --- a/pkg/cmd/release/upload/upload.go +++ b/pkg/cmd/release/upload/upload.go @@ -4,6 +4,7 @@ import ( "context" "fmt" "net/http" + "regexp" "strings" "github.com/MakeNowJust/heredoc" @@ -93,8 +94,9 @@ func uploadRun(opts *UploadOptions) error { var existingNames []string for _, a := range opts.Assets { + sanitizedFileName := sanitizeFileName(a.Name) for _, ea := range release.Assets { - if ea.Name == a.Name { + if ea.Name == sanitizedFileName { a.ExistingURL = ea.APIURL existingNames = append(existingNames, ea.Name) break @@ -122,3 +124,30 @@ func uploadRun(opts *UploadOptions) error { return nil } + +// this method attempts to mimic the same functionality on the client that the platform does on +// uploaded assets in order to allow the --clobber logic work correctly, since that feature is +// one that only exists in the client +func sanitizeFileName(name string) string { + value := text.RemoveDiacritics(name) + // Stripped all non-ascii characters, provide default name. + if strings.HasPrefix(value, ".") { + value = "default" + value + } + + // Replace special characters with the separator + value = regexp.MustCompile(`(?i)[^a-z0-9\-_\+@]+`).ReplaceAllLiteralString(value, ".") + + // No more than one of the separator in a row. + value = regexp.MustCompile(`\.{2,}`).ReplaceAllLiteralString(value, ".") + + // Remove leading/trailing separator. + value = strings.Trim(value, ".") + + // Just file extension left, add default name. + if name != value && !strings.Contains(value, ".") { + value = "default." + value + } + + return value +} diff --git a/pkg/cmd/release/upload/upload_test.go b/pkg/cmd/release/upload/upload_test.go new file mode 100644 index 000000000..7a85c82a3 --- /dev/null +++ b/pkg/cmd/release/upload/upload_test.go @@ -0,0 +1,52 @@ +package upload + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func Test_SanitizeFileName(t *testing.T) { + tests := []struct { + name string + expected string + }{ + { + name: "foo", + expected: "foo", + }, + { + name: "foo bar", + expected: "foo.bar", + }, + { + name: ".foo", + expected: "default.foo", + }, + { + name: "Foo bar", + expected: "Foo.bar", + }, + { + name: "Hello, दुनिया", + expected: "default.Hello", + }, + { + name: "this+has+plusses.jpg", + expected: "this+has+plusses.jpg", + }, + { + name: "this@has@at@signs.jpg", + expected: "this@has@at@signs.jpg", + }, + { + name: "façade.exposé", + expected: "facade.expose", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + assert.Equal(t, tt.expected, sanitizeFileName(tt.name)) + }) + } +} From 5597139df3c9aeedcf8b6ac3379bb59dda4a1778 Mon Sep 17 00:00:00 2001 From: vilmibm Date: Tue, 23 May 2023 00:12:44 -0700 Subject: [PATCH 43/90] switch to []int return for multiselect --- internal/prompter/prompter.go | 6 ++---- internal/prompter/test.go | 12 +++++------- pkg/cmd/run/download/download.go | 9 +++++++-- pkg/cmd/run/download/download_test.go | 4 ++-- 4 files changed, 16 insertions(+), 15 deletions(-) diff --git a/internal/prompter/prompter.go b/internal/prompter/prompter.go index 9803f8a49..b91445c49 100644 --- a/internal/prompter/prompter.go +++ b/internal/prompter/prompter.go @@ -14,7 +14,7 @@ import ( //go:generate moq -rm -out prompter_mock.go . Prompter type Prompter interface { Select(string, string, []string) (int, error) - MultiSelect(string, []string, []string) ([]string, error) + MultiSelect(string, []string, []string) ([]int, error) Input(string, string) (string, error) InputHostname() (string, error) Password(string) (string, error) @@ -86,7 +86,7 @@ func (p *surveyPrompter) Select(message, defaultValue string, options []string) return } -func (p *surveyPrompter) MultiSelect(message string, defaultValue, options []string) (result []string, err error) { +func (p *surveyPrompter) MultiSelect(message string, defaultValue, options []string) (result []int, err error) { q := &survey.MultiSelect{ Message: message, Options: options, @@ -94,8 +94,6 @@ func (p *surveyPrompter) MultiSelect(message string, defaultValue, options []str Filter: LatinMatchingFilter, } - // TODO will I regret this returning []string and not []int? - if len(defaultValue) > 0 { // TODO I don't actually know that this is needed, just being extra cautious validatedDefault := []string{} diff --git a/internal/prompter/test.go b/internal/prompter/test.go index a5cebacda..c376e9c83 100644 --- a/internal/prompter/test.go +++ b/internal/prompter/test.go @@ -50,7 +50,7 @@ type ConfirmStub struct { type MultiSelectStub struct { Prompt string ExpectedOpts []string - Fn func(string, []string, []string) ([]string, error) + Fn func(string, []string, []string) ([]int, error) } type InputHostnameStub struct { @@ -84,8 +84,6 @@ type MockPrompter struct { ConfirmDeletionStubs []ConfirmDeletionStub } -// TODO thread safety - func NewMockPrompter(t *testing.T) *MockPrompter { m := &MockPrompter{ t: t, @@ -120,17 +118,17 @@ func NewMockPrompter(t *testing.T) *MockPrompter { return s.Fn(p, d, opts) } - m.MultiSelectFunc = func(p string, d, opts []string) ([]string, error) { + m.MultiSelectFunc = func(p string, d, opts []string) ([]int, error) { var s MultiSelectStub if len(m.MultiSelectStubs) > 0 { s = m.MultiSelectStubs[0] m.MultiSelectStubs = m.MultiSelectStubs[1:len(m.MultiSelectStubs)] } else { - return []string{}, NoSuchPromptErr(p) + return []int{}, NoSuchPromptErr(p) } if s.Prompt != p { - return []string{}, NoSuchPromptErr(p) + return []int{}, NoSuchPromptErr(p) } AssertOptions(m.t, s.ExpectedOpts, opts) @@ -240,7 +238,7 @@ func (m *MockPrompter) RegisterSelect(prompt string, opts []string, stub func(_, Fn: stub}) } -func (m *MockPrompter) RegisterMultiSelect(prompt string, d, opts []string, stub func(_ string, _, _ []string) ([]string, error)) { +func (m *MockPrompter) RegisterMultiSelect(prompt string, d, opts []string, stub func(_ string, _, _ []string) ([]int, error)) { m.MultiSelectStubs = append(m.MultiSelectStubs, MultiSelectStub{ Prompt: prompt, ExpectedOpts: opts, diff --git a/pkg/cmd/run/download/download.go b/pkg/cmd/run/download/download.go index 4c5322806..993e16e52 100644 --- a/pkg/cmd/run/download/download.go +++ b/pkg/cmd/run/download/download.go @@ -30,7 +30,7 @@ type platform interface { Download(url string, dir string) error } type iprompter interface { - MultiSelect(string, []string, []string) ([]string, error) + MultiSelect(string, []string, []string) ([]int, error) } func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobra.Command { @@ -131,9 +131,14 @@ func runDownload(opts *DownloadOptions) error { if len(options) > 10 { options = options[:10] } - if wantNames, err = opts.Prompter.MultiSelect("Select artifacts to download:", nil, options); err != nil { + var selected []int + if selected, err = opts.Prompter.MultiSelect("Select artifacts to download:", nil, options); err != nil { return err } + wantNames = []string{} + for _, x := range selected { + wantNames = append(wantNames, options[x]) + } if len(wantNames) == 0 { return errors.New("no artifacts selected") } diff --git a/pkg/cmd/run/download/download_test.go b/pkg/cmd/run/download/download_test.go index 3640f93a0..3c1c8f2d8 100644 --- a/pkg/cmd/run/download/download_test.go +++ b/pkg/cmd/run/download/download_test.go @@ -284,8 +284,8 @@ func Test_runDownload(t *testing.T) { }, promptStubs: func(pm *prompter.MockPrompter) { pm.RegisterMultiSelect("Select artifacts to download:", nil, []string{"artifact-1", "artifact-2"}, - func(_ string, _, opts []string) ([]string, error) { - return []string{"artifact-2"}, nil + func(_ string, _, opts []string) ([]int, error) { + return []int{1}, nil }) }, }, From a15eb91a0c7b1392f8833f64b0cff24c553e6c80 Mon Sep 17 00:00:00 2001 From: vilmibm Date: Tue, 23 May 2023 00:13:57 -0700 Subject: [PATCH 44/90] go generate --- internal/prompter/prompter_mock.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/prompter/prompter_mock.go b/internal/prompter/prompter_mock.go index 174375bfd..9a59a7bd1 100644 --- a/internal/prompter/prompter_mock.go +++ b/internal/prompter/prompter_mock.go @@ -35,7 +35,7 @@ var _ Prompter = &PrompterMock{} // MarkdownEditorFunc: func(s1 string, s2 string, b bool) (string, error) { // panic("mock out the MarkdownEditor method") // }, -// MultiSelectFunc: func(s string, strings1 []string, strings2 []string) ([]string, error) { +// MultiSelectFunc: func(s string, strings1 []string, strings2 []string) ([]int, error) { // panic("mock out the MultiSelect method") // }, // PasswordFunc: func(s string) (string, error) { @@ -70,7 +70,7 @@ type PrompterMock struct { MarkdownEditorFunc func(s1 string, s2 string, b bool) (string, error) // MultiSelectFunc mocks the MultiSelect method. - MultiSelectFunc func(s string, strings1 []string, strings2 []string) ([]string, error) + MultiSelectFunc func(s string, strings1 []string, strings2 []string) ([]int, error) // PasswordFunc mocks the Password method. PasswordFunc func(s string) (string, error) @@ -348,7 +348,7 @@ func (mock *PrompterMock) MarkdownEditorCalls() []struct { } // MultiSelect calls MultiSelectFunc. -func (mock *PrompterMock) MultiSelect(s string, strings1 []string, strings2 []string) ([]string, error) { +func (mock *PrompterMock) MultiSelect(s string, strings1 []string, strings2 []string) ([]int, error) { if mock.MultiSelectFunc == nil { panic("PrompterMock.MultiSelectFunc: method is nil but Prompter.MultiSelect was just called") } From b02d5efb189555a2a8f8d4b50efe9ad64951186f Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 23 May 2023 15:42:38 +0200 Subject: [PATCH 45/90] Use two queries in one request for PR feature detection --- .../featuredetection/feature_detection.go | 79 ++++-------- .../feature_detection_test.go | 122 ++++++++++-------- 2 files changed, 93 insertions(+), 108 deletions(-) diff --git a/internal/featuredetection/feature_detection.go b/internal/featuredetection/feature_detection.go index f180c72ff..983784804 100644 --- a/internal/featuredetection/feature_detection.go +++ b/internal/featuredetection/feature_detection.go @@ -5,7 +5,6 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghinstance" - "golang.org/x/sync/errgroup" ) type Detector interface { @@ -99,64 +98,38 @@ func (d *detector) PullRequestFeatures() (PullRequestFeatures, error) { // return allPullRequestFeatures, nil // } - features := PullRequestFeatures{} + var pullRequestFeatureDetection struct { + PullRequest struct { + Fields []struct { + Name string + } `graphql:"fields(includeDeprecated: true)"` + } `graphql:"PullRequest: __type(name: \"PullRequest\")"` + StatusCheckRollupContextConnection struct { + Fields []struct { + Name string + } `graphql:"fields(includeDeprecated: true)"` + } `graphql:"StatusCheckRollupContextConnection: __type(name: \"StatusCheckRollupContextConnection\")"` + } + gql := api.NewClientFromHTTP(d.httpClient) + if err := gql.Query(d.host, "PullRequest_fields", &pullRequestFeatureDetection, nil); err != nil { + return PullRequestFeatures{}, err + } - g := new(errgroup.Group) - g.Go(func() error { - var pullRequestFeatureDetection struct { - PullRequest struct { - Fields []struct { - Name string - } `graphql:"fields(includeDeprecated: true)"` - } `graphql:"PullRequest: __type(name: \"PullRequest\")"` + features := PullRequestFeatures{} + + for _, field := range pullRequestFeatureDetection.PullRequest.Fields { + if field.Name == "isInMergeQueue" { + features.MergeQueue = true } + } - if err := gql.Query(d.host, "PullRequest_fields", &pullRequestFeatureDetection, nil); err != nil { - return err - } - - for _, field := range pullRequestFeatureDetection.PullRequest.Fields { - if field.Name == "isInMergeQueue" { - features.MergeQueue = true - } - } - - return nil - }) - - g.Go(func() error { - if !ghinstance.IsEnterprise(d.host) { + for _, field := range pullRequestFeatureDetection.StatusCheckRollupContextConnection.Fields { + // We only check for checkRunCount here but it, checkRunCountsByState, statusContextCount and statusContextCountsByState + // were all introduced in the same version of the API. + if field.Name == "checkRunCount" { features.CheckRunAndStatusContextCounts = true - return nil } - - var statusCheckRollupContextConnectionFeatureDetection struct { - StatusCheckRollupContextConnection struct { - Fields []struct { - Name string - } `graphql:"fields(includeDeprecated: true)"` - } `graphql:"StatusCheckRollupContextConnection: __type(name: \"StatusCheckRollupContextConnection\")"` - } - - if err := gql.Query(d.host, "StatusCheckRollupContextConnection_fields", &statusCheckRollupContextConnectionFeatureDetection, nil); err != nil { - return err - } - - for _, field := range statusCheckRollupContextConnectionFeatureDetection.StatusCheckRollupContextConnection.Fields { - // We only check for checkRunCount here but it, checkRunCountsByState, statusContextCount and statusContextCountsByState - // were all introduced in the same version of the API. - if field.Name == "checkRunCount" { - features.CheckRunAndStatusContextCounts = true - } - } - - return nil - }) - - err := g.Wait() - if err != nil { - return features, err } return features, nil diff --git a/internal/featuredetection/feature_detection_test.go b/internal/featuredetection/feature_detection_test.go index 3cc94e057..673b2c073 100644 --- a/internal/featuredetection/feature_detection_test.go +++ b/internal/featuredetection/feature_detection_test.go @@ -83,16 +83,28 @@ func TestPullRequestFeatures(t *testing.T) { wantErr bool }{ { - name: "github.com with merge queue", + name: "github.com with merge queue and status check counts by state", hostname: "github.com", queryResponse: map[string]string{ `query PullRequest_fields\b`: heredoc.Doc(` - { "data": { "PullRequest": { "fields": [ - {"name": "isInMergeQueue"}, - {"name": "isMergeQueueEnabled"} - ] } } } - `), - `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), + { + "data": { + "PullRequest": { + "fields": [ + {"name": "isInMergeQueue"}, + {"name": "isMergeQueueEnabled"} + ] + }, + "StatusCheckRollupContextConnection": { + "fields": [ + {"name": "checkRunCount"}, + {"name": "checkRunCountsByState"}, + {"name": "statusContextCount"}, + {"name": "statusContextCountsByState"} + ] + } + } + }`), }, wantFeatures: PullRequestFeatures{ MergeQueue: true, @@ -105,10 +117,21 @@ func TestPullRequestFeatures(t *testing.T) { hostname: "github.com", queryResponse: map[string]string{ `query PullRequest_fields\b`: heredoc.Doc(` - { "data": { "PullRequest": { "fields": [ - ] } } } - `), - `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), + { + "data": { + "PullRequest": { + "fields": [] + }, + "StatusCheckRollupContextConnection": { + "fields": [ + {"name": "checkRunCount"}, + {"name": "checkRunCountsByState"}, + {"name": "statusContextCount"}, + {"name": "statusContextCountsByState"} + ] + } + } + }`), }, wantFeatures: PullRequestFeatures{ MergeQueue: false, @@ -117,68 +140,57 @@ func TestPullRequestFeatures(t *testing.T) { wantErr: false, }, { - name: "GHE", + name: "GHE with merge queue and status check counts by state", hostname: "git.my.org", queryResponse: map[string]string{ `query PullRequest_fields\b`: heredoc.Doc(` - { "data": { "PullRequest": { "fields": [ - {"name": "isInMergeQueue"}, - {"name": "isMergeQueueEnabled"} - ] } } } - `), - `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), - }, - wantFeatures: PullRequestFeatures{ - MergeQueue: true, - }, - wantErr: false, - }, - { - name: "GitHub.com supports check and run status context counts regardless of GQL response", - hostname: "github.com", - queryResponse: map[string]string{ - `query PullRequest_fields\b`: emptyIntrospectionFor("PullRequest"), - `query StatusCheckRollupContextConnection_fields\b`: emptyIntrospectionFor("StatusCheckRollupContextConnection"), + { + "data": { + "PullRequest": { + "fields": [ + {"name": "isInMergeQueue"}, + {"name": "isMergeQueueEnabled"} + ] + }, + "StatusCheckRollupContextConnection": { + "fields": [ + {"name": "checkRunCount"}, + {"name": "checkRunCountsByState"}, + {"name": "statusContextCount"}, + {"name": "statusContextCountsByState"} + ] + } + } + }`), }, wantFeatures: PullRequestFeatures{ + MergeQueue: true, CheckRunAndStatusContextCounts: true, }, wantErr: false, }, { - name: "GHE without check run and status context count support", + name: "GHE without merge queue and status check counts by state", hostname: "git.my.org", queryResponse: map[string]string{ - `query PullRequest_fields\b`: emptyIntrospectionFor("PullRequest"), - `query StatusCheckRollupContextConnection_fields\b`: heredoc.Doc(` - { "data": { "StatusCheckRollupContextConnection": { "fields": [ - ] } } } - `), + `query PullRequest_fields\b`: heredoc.Doc(` + { + "data": { + "PullRequest": { + "fields": [] + }, + "StatusCheckRollupContextConnection": { + "fields": [] + } + } + }`), }, wantFeatures: PullRequestFeatures{ + MergeQueue: false, CheckRunAndStatusContextCounts: false, }, wantErr: false, }, - { - name: "GHE host with check run and status context count support", - hostname: "git.my.org", - queryResponse: map[string]string{ - `query PullRequest_fields\b`: emptyIntrospectionFor("PullRequest"), - `query StatusCheckRollupContextConnection_fields\b`: heredoc.Doc(` - { "data": { "StatusCheckRollupContextConnection": { "fields": [ - {"name": "checkRunCount"}, - {"name": "checkRunCountsByState"}, - {"name": "statusContextCount"}, - {"name": "statusContextCountsByState"} - ] } } } - `), - }, - wantFeatures: PullRequestFeatures{ - CheckRunAndStatusContextCounts: true, - }, - wantErr: false, - }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { From 90e680f21abf5647fddbcebd377b99eff3614a5f Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 23 May 2023 15:59:12 +0200 Subject: [PATCH 46/90] Split CheckRunState and StatusState parsing --- api/queries_pr.go | 37 +++++++++++++++++++++++++++++-------- 1 file changed, 29 insertions(+), 8 deletions(-) diff --git a/api/queries_pr.go b/api/queries_pr.go index 43deb063f..267dbe3f5 100644 --- a/api/queries_pr.go +++ b/api/queries_pr.go @@ -293,7 +293,7 @@ func (pr *PullRequest) ChecksStatus() PullRequestChecksStatus { if len(contexts.CheckRunCountsByState) != 0 && len(contexts.StatusContextCountsByState) != 0 { summary.Total = contexts.CheckRunCount + contexts.StatusContextCount for _, countByState := range contexts.CheckRunCountsByState { - switch parseCheckStatus(countByState.State) { + switch parseCheckStatusFromCheckRunState(countByState.State) { case passing: summary.Passing += countByState.Count case failing: @@ -304,7 +304,7 @@ func (pr *PullRequest) ChecksStatus() PullRequestChecksStatus { } for _, countByState := range contexts.StatusContextCountsByState { - switch parseCheckStatus(countByState.State) { + switch parseCheckStatusFromStatusState(countByState.State) { case passing: summary.Passing += countByState.Count case failing: @@ -357,15 +357,36 @@ const ( pending ) -func parseCheckStatus(state string) checkStatus { +// https://docs.github.com/en/graphql/reference/enums#statusstate +func parseCheckStatusFromStatusState(state string) checkStatus { switch state { - case "SUCCESS", "NEUTRAL", "SKIPPED": + case "SUCCESS": return passing - case "ERROR", "FAILURE", "CANCELLED", "TIMED_OUT", "ACTION_REQUIRED": + case "FAILURE", "ERROR": return failing - // We treat anything that isn't Passing or Failing as Pending, which included any future unknown states - // we might get back from the API. - default: // "EXPECTED", "REQUESTED", "WAITING", "QUEUED", "PENDING", "IN_PROGRESS", "STALE", "STARTUP_FAILURE", "COMPLETED" + case "EXPECTED", "PENDING": + return pending + // Currently, we treat anything unknown as pending, which includes any future unknown + // states we might get back from the API. It might be interesting to do some work to add an additional + // unknown state. + default: + return pending + } +} + +// https://docs.github.com/en/graphql/reference/enums#checkrunstate +func parseCheckStatusFromCheckRunState(state string) checkStatus { + switch state { + case "NEUTRAL", "SKIPPED", "SUCCESS": + return passing + case "ACTION_REQUIRED", "CANCELLED", "FAILURE", "TIMED_OUT": + return failing + case "COMPLETED", "IN_PROGRESS", "PENDING", "QUEUED", "STALE", "STARTUP_FAILURE", "WAITING": + return pending + // Currently, we treat anything unknown as pending, which includes any future unknown + // states we might get back from the API. It might be interesting to do some work to add an additional + // unknown state. + default: return pending } } From 04ecac9a6f77b930506000277a1b9f730d2ef0e1 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 23 May 2023 16:51:08 +0200 Subject: [PATCH 47/90] Rework state parsing for CheckRuns and StatusContexts --- api/queries_pr.go | 63 +++++++++++++------ .../prViewPreviewWithAllChecksFailing.json | 2 + .../prViewPreviewWithAllChecksPassing.json | 3 + .../prViewPreviewWithSomeChecksFailing.json | 2 + .../prViewPreviewWithSomeChecksPending.json | 2 + 5 files changed, 52 insertions(+), 20 deletions(-) diff --git a/api/queries_pr.go b/api/queries_pr.go index 267dbe3f5..692251c9f 100644 --- a/api/queries_pr.go +++ b/api/queries_pr.go @@ -319,29 +319,35 @@ func (pr *PullRequest) ChecksStatus() PullRequestChecksStatus { // If we don't have the counts by state, then we'll need to summarise by looking at the more detailed contexts for _, c := range contexts.Nodes { - // Nodes are a discriminated union of CheckRun or StatusContext, - // but we can use the State field to disambiguate, rather than using the TypeName. - // First we try to get the State, as if we have a StatusContext - state := c.State - // But if the State is empty, then we assume we actually have a CheckRun - if state == "" { - // If the Status of a CheckRun is COMPLETED, then we want to look more closely - // at the Conclusion, as that contains the relevant information. + // Nodes are a discriminated union of CheckRun or StatusContext and we can match on + // the TypeName to narrow the type. + if c.TypeName == "CheckRun" { + // https://docs.github.com/en/graphql/reference/enums#checkstatusstate + // If the status is completed then we can check the conclusion field if c.Status == "COMPLETED" { - state = c.Conclusion + switch parseCheckStatusFromCheckConclusionState(c.Conclusion) { + case passing: + summary.Passing++ + case failing: + summary.Failing++ + default: + summary.Pending++ + } + // otherwise we're in some form of pending state: + // "COMPLETED", "IN_PROGRESS", "PENDING", "QUEUED", "REQUESTED", "WAITING" or otherwise unknown } else { - state = c.Status + summary.Pending++ + } + + } else { // c.TypeName == StatusContext + switch parseCheckStatusFromStatusState(c.State) { + case passing: + summary.Passing++ + case failing: + summary.Failing++ + default: + summary.Pending++ } - } - switch state { - case "SUCCESS", "NEUTRAL", "SKIPPED": - summary.Passing++ - case "ERROR", "FAILURE", "CANCELLED", "TIMED_OUT", "ACTION_REQUIRED": - summary.Failing++ - // We treat anything that isn't Passing or Failing as Pending, which included any future unknown states - // we might get back from the API. - default: // "EXPECTED", "REQUESTED", "WAITING", "QUEUED", "PENDING", "IN_PROGRESS", "STALE", "STARTUP_FAILURE" - summary.Pending++ } summary.Total++ } @@ -391,6 +397,23 @@ func parseCheckStatusFromCheckRunState(state string) checkStatus { } } +// https://docs.github.com/en/graphql/reference/enums#checkconclusionstate +func parseCheckStatusFromCheckConclusionState(state string) checkStatus { + switch state { + case "NEUTRAL", "SKIPPED", "SUCCESS": + return passing + case "ACTION_REQUIRED", "CANCELLED", "FAILURE", "TIMED_OUT": + return failing + case "STALE", "STARTUP_FAILURE": + return pending + // Currently, we treat anything unknown as pending, which includes any future unknown + // states we might get back from the API. It might be interesting to do some work to add an additional + // unknown state. + default: + return pending + } +} + func (pr *PullRequest) DisplayableReviews() PullRequestReviews { published := []PullRequestReview{} for _, prr := range pr.Reviews.Nodes { diff --git a/pkg/cmd/pr/view/fixtures/prViewPreviewWithAllChecksFailing.json b/pkg/cmd/pr/view/fixtures/prViewPreviewWithAllChecksFailing.json index 59c4acd8a..48484f1c4 100644 --- a/pkg/cmd/pr/view/fixtures/prViewPreviewWithAllChecksFailing.json +++ b/pkg/cmd/pr/view/fixtures/prViewPreviewWithAllChecksFailing.json @@ -46,6 +46,7 @@ "contexts": { "nodes": [ { + "__typename": "CheckRun", "conclusion": "FAILURE", "status": "COMPLETED", "name": "cool tests", @@ -54,6 +55,7 @@ "detailsUrl": "sweet link" }, { + "__typename": "CheckRun", "conclusion": "FAILURE", "status": "COMPLETED", "name": "sad tests", diff --git a/pkg/cmd/pr/view/fixtures/prViewPreviewWithAllChecksPassing.json b/pkg/cmd/pr/view/fixtures/prViewPreviewWithAllChecksPassing.json index d55e460b3..87152d692 100644 --- a/pkg/cmd/pr/view/fixtures/prViewPreviewWithAllChecksPassing.json +++ b/pkg/cmd/pr/view/fixtures/prViewPreviewWithAllChecksPassing.json @@ -46,6 +46,7 @@ "contexts": { "nodes": [ { + "__typename": "CheckRun", "conclusion": "SUCCESS", "status": "COMPLETED", "name": "cool tests", @@ -54,6 +55,7 @@ "detailsUrl": "sweet link" }, { + "__typename": "CheckRun", "conclusion": "SUCCESS", "status": "COMPLETED", "name": "rad tests", @@ -62,6 +64,7 @@ "detailsUrl": "sweet link" }, { + "__typename": "CheckRun", "conclusion": "SUCCESS", "status": "COMPLETED", "name": "awesome tests", diff --git a/pkg/cmd/pr/view/fixtures/prViewPreviewWithSomeChecksFailing.json b/pkg/cmd/pr/view/fixtures/prViewPreviewWithSomeChecksFailing.json index d817a5da0..adb15e7c3 100644 --- a/pkg/cmd/pr/view/fixtures/prViewPreviewWithSomeChecksFailing.json +++ b/pkg/cmd/pr/view/fixtures/prViewPreviewWithSomeChecksFailing.json @@ -46,6 +46,7 @@ "contexts": { "nodes": [ { + "__typename": "CheckRun", "conclusion": "SUCCESS", "status": "COMPLETED", "name": "cool tests", @@ -54,6 +55,7 @@ "detailsUrl": "sweet link" }, { + "__typename": "CheckRun", "conclusion": "FAILURE", "status": "COMPLETED", "name": "sad tests", diff --git a/pkg/cmd/pr/view/fixtures/prViewPreviewWithSomeChecksPending.json b/pkg/cmd/pr/view/fixtures/prViewPreviewWithSomeChecksPending.json index 019186783..4a011e5c1 100644 --- a/pkg/cmd/pr/view/fixtures/prViewPreviewWithSomeChecksPending.json +++ b/pkg/cmd/pr/view/fixtures/prViewPreviewWithSomeChecksPending.json @@ -46,6 +46,7 @@ "contexts": { "nodes": [ { + "__typename": "CheckRun", "conclusion": "", "status": "WAITING", "name": "cool tests", @@ -54,6 +55,7 @@ "detailsUrl": "sweet link" }, { + "__typename": "CheckRun", "conclusion": "SUCCESS", "status": "COMPLETED", "name": "sad tests", From b73ad06f159db6744a58ae0be6c0a3d8ddd29c54 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 23 May 2023 16:53:16 +0200 Subject: [PATCH 48/90] Avoid setting status check rollups when user supplies fields --- pkg/cmd/pr/status/http.go | 7 ------- 1 file changed, 7 deletions(-) diff --git a/pkg/cmd/pr/status/http.go b/pkg/cmd/pr/status/http.go index 666076c86..755ccf30b 100644 --- a/pkg/cmd/pr/status/http.go +++ b/pkg/cmd/pr/status/http.go @@ -55,13 +55,6 @@ func pullRequestStatus(httpClient *http.Client, repo ghrepo.Interface, options r fields.AddValues(options.Fields) // these are always necessary to find the PR for the current branch fields.AddValues([]string{"isCrossRepository", "headRepositoryOwner", "headRefName"}) - - if options.CheckRunAndStatusContextCountsSupported { - fields.Add("statusCheckRollupWithCountByState") - } else { - fields.Add("statusCheckRollup") - } - gr := api.PullRequestGraphQL(fields.ToSlice()) fragments = fmt.Sprintf("fragment pr on PullRequest{%s}fragment prWithReviews on PullRequest{...pr}", gr) } else { From 505c95454460f3fdc55716c371bdc6f327309dd3 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 23 May 2023 17:13:48 +0200 Subject: [PATCH 49/90] Remove unused emptyIntrospectionFor test helper --- internal/featuredetection/feature_detection_test.go | 8 -------- 1 file changed, 8 deletions(-) diff --git a/internal/featuredetection/feature_detection_test.go b/internal/featuredetection/feature_detection_test.go index 673b2c073..dda6fe6a5 100644 --- a/internal/featuredetection/feature_detection_test.go +++ b/internal/featuredetection/feature_detection_test.go @@ -1,7 +1,6 @@ package featuredetection import ( - "fmt" "net/http" "testing" @@ -307,10 +306,3 @@ func TestRepositoryFeatures(t *testing.T) { }) } } - -func emptyIntrospectionFor(typ string) string { - return fmt.Sprintf(` - { "data": { "%s": { "fields": [ - ] } } } - `, typ) -} From dad5f25748b1bbce909dcb2ba9605a1261ff700f Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 23 May 2023 17:22:56 +0200 Subject: [PATCH 50/90] Use go enums for status and check status graphql enums --- api/queries_pr.go | 104 +++++++++++++++++++++++++-------- pkg/cmd/pr/checks/aggregate.go | 4 +- 2 files changed, 82 insertions(+), 26 deletions(-) diff --git a/api/queries_pr.go b/api/queries_pr.go index 692251c9f..6b4322b13 100644 --- a/api/queries_pr.go +++ b/api/queries_pr.go @@ -97,16 +97,74 @@ type CommitStatusCheckRollup struct { Contexts CheckContexts } +// https://docs.github.com/en/graphql/reference/enums#checkrunstate +type CheckRunState string + +const ( + CheckRunStateActionRequired CheckRunState = "ACTION_REQUIRED" + CheckRunStateCancelled CheckRunState = "CANCELLED" + CheckRunStateCompleted CheckRunState = "COMPLETED" + CheckRunStateFailure CheckRunState = "FAILURE" + CheckRunStateInProgress CheckRunState = "IN_PROGRESS" + CheckRunStateNeutral CheckRunState = "NEUTRAL" + CheckRunStatePending CheckRunState = "PENDING" + CheckRunStateQueued CheckRunState = "QUEUED" + CheckRunStateSkipped CheckRunState = "SKIPPED" + CheckRunStateStale CheckRunState = "STALE" + CheckRunStateStartupFailure CheckRunState = "STARTUP_FAILURE" + CheckRunStateSuccess CheckRunState = "SUCCESS" + CheckRunStateTimedOut CheckRunState = "TIMED_OUT" + CheckRunStateWaiting CheckRunState = "WAITING" +) + type CheckRunCountByState struct { - State string + State CheckRunState Count int } +// https://docs.github.com/en/graphql/reference/enums#statusstate +type StatusState string + +const ( + StatusStateExpected StatusState = "EXPECTED" + StatusStateError StatusState = "ERROR" + StatusStateFailure StatusState = "FAILURE" + StatusStatePending StatusState = "PENDING" + StatusStateSuccess StatusState = "SUCCESS" +) + type StatusContextCountByState struct { - State string + State StatusState Count int } +// https://docs.github.com/en/graphql/reference/enums#checkstatusstate +type CheckStatusState string + +const ( + CheckStatusStateQueued CheckStatusState = "QUEUED" + CheckStatusStateInProgress CheckStatusState = "IN_PROGRESS" + CheckStatusStateCompleted CheckStatusState = "COMPLETED" + CheckStatusStateWaiting CheckStatusState = "WAITING" + CheckStatusStatePending CheckStatusState = "PENDING" + CheckStatusStateRequested CheckStatusState = "REQUESTED" +) + +// https://docs.github.com/en/graphql/reference/enums#checkconclusionstate +type CheckConclusionState string + +const ( + CheckConclusionStateActionRequired CheckConclusionState = "ACTION_REQUIRED" + CheckConclusionStateTimedOut CheckConclusionState = "TIMED_OUT" + CheckConclusionStateCancelled CheckConclusionState = "CANCELLED" + CheckConclusionStateFailure CheckConclusionState = "FAILURE" + CheckConclusionStateSuccess CheckConclusionState = "SUCCESS" + CheckConclusionStateNeutral CheckConclusionState = "NEUTRAL" + CheckConclusionStateSkipped CheckConclusionState = "SKIPPED" + CheckConclusionStateStartupFailure CheckConclusionState = "STARTUP_FAILURE" + CheckConclusionStateStale CheckConclusionState = "STALE" +) + type CheckContexts struct { // These fields are available on newer versions of the GraphQL API // to support summary counts by state @@ -138,18 +196,18 @@ type CheckContext struct { // QUEUED IN_PROGRESS COMPLETED WAITING PENDING REQUESTED Status string `json:"status"` // ACTION_REQUIRED TIMED_OUT CANCELLED FAILURE SUCCESS NEUTRAL SKIPPED STARTUP_FAILURE STALE - Conclusion string `json:"conclusion"` - StartedAt time.Time `json:"startedAt"` - CompletedAt time.Time `json:"completedAt"` - DetailsURL string `json:"detailsUrl"` + Conclusion CheckConclusionState `json:"conclusion"` + StartedAt time.Time `json:"startedAt"` + CompletedAt time.Time `json:"completedAt"` + DetailsURL string `json:"detailsUrl"` /* StatusContext fields */ Context string `json:"context"` // EXPECTED ERROR FAILURE PENDING SUCCESS - State string `json:"state"` - TargetURL string `json:"targetUrl"` - CreatedAt time.Time `json:"createdAt"` + State StatusState `json:"state"` + TargetURL string `json:"targetUrl"` + CreatedAt time.Time `json:"createdAt"` } type PRRepository struct { @@ -363,14 +421,13 @@ const ( pending ) -// https://docs.github.com/en/graphql/reference/enums#statusstate -func parseCheckStatusFromStatusState(state string) checkStatus { +func parseCheckStatusFromStatusState(state StatusState) checkStatus { switch state { - case "SUCCESS": + case StatusStateSuccess: return passing - case "FAILURE", "ERROR": + case StatusStateFailure, StatusStateError: return failing - case "EXPECTED", "PENDING": + case StatusStateExpected, StatusStatePending: return pending // Currently, we treat anything unknown as pending, which includes any future unknown // states we might get back from the API. It might be interesting to do some work to add an additional @@ -380,14 +437,14 @@ func parseCheckStatusFromStatusState(state string) checkStatus { } } -// https://docs.github.com/en/graphql/reference/enums#checkrunstate -func parseCheckStatusFromCheckRunState(state string) checkStatus { +func parseCheckStatusFromCheckRunState(state CheckRunState) checkStatus { switch state { - case "NEUTRAL", "SKIPPED", "SUCCESS": + case CheckRunStateNeutral, CheckRunStateSkipped, CheckRunStateSuccess: return passing - case "ACTION_REQUIRED", "CANCELLED", "FAILURE", "TIMED_OUT": + case CheckRunStateActionRequired, CheckRunStateCancelled, CheckRunStateFailure, CheckRunStateTimedOut: return failing - case "COMPLETED", "IN_PROGRESS", "PENDING", "QUEUED", "STALE", "STARTUP_FAILURE", "WAITING": + case CheckRunStateCompleted, CheckRunStateInProgress, CheckRunStatePending, CheckRunStateQueued, + CheckRunStateStale, CheckRunStateStartupFailure, CheckRunStateWaiting: return pending // Currently, we treat anything unknown as pending, which includes any future unknown // states we might get back from the API. It might be interesting to do some work to add an additional @@ -397,14 +454,13 @@ func parseCheckStatusFromCheckRunState(state string) checkStatus { } } -// https://docs.github.com/en/graphql/reference/enums#checkconclusionstate -func parseCheckStatusFromCheckConclusionState(state string) checkStatus { +func parseCheckStatusFromCheckConclusionState(state CheckConclusionState) checkStatus { switch state { - case "NEUTRAL", "SKIPPED", "SUCCESS": + case CheckConclusionStateNeutral, CheckConclusionStateSkipped, CheckConclusionStateSuccess: return passing - case "ACTION_REQUIRED", "CANCELLED", "FAILURE", "TIMED_OUT": + case CheckConclusionStateActionRequired, CheckConclusionStateCancelled, CheckConclusionStateFailure, CheckConclusionStateTimedOut: return failing - case "STALE", "STARTUP_FAILURE": + case CheckConclusionStateStale, CheckConclusionStateStartupFailure: return pending // Currently, we treat anything unknown as pending, which includes any future unknown // states we might get back from the API. It might be interesting to do some work to add an additional diff --git a/pkg/cmd/pr/checks/aggregate.go b/pkg/cmd/pr/checks/aggregate.go index 53f2bab5f..aa139323f 100644 --- a/pkg/cmd/pr/checks/aggregate.go +++ b/pkg/cmd/pr/checks/aggregate.go @@ -30,10 +30,10 @@ func aggregateChecks(checkContexts []api.CheckContext, requiredChecks bool) (che continue } - state := c.State + state := string(c.State) if state == "" { if c.Status == "COMPLETED" { - state = c.Conclusion + state = string(c.Conclusion) } else { state = c.Status } From e2dc66baea6f33dc1818c8cf5147afa0f1baec86 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 23 May 2023 17:36:20 +0200 Subject: [PATCH 51/90] Reorder Check and Status States enums variants alphabetically --- api/queries_pr.go | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/api/queries_pr.go b/api/queries_pr.go index 6b4322b13..eb41c4c14 100644 --- a/api/queries_pr.go +++ b/api/queries_pr.go @@ -126,8 +126,8 @@ type CheckRunCountByState struct { type StatusState string const ( - StatusStateExpected StatusState = "EXPECTED" StatusStateError StatusState = "ERROR" + StatusStateExpected StatusState = "EXPECTED" StatusStateFailure StatusState = "FAILURE" StatusStatePending StatusState = "PENDING" StatusStateSuccess StatusState = "SUCCESS" @@ -142,12 +142,12 @@ type StatusContextCountByState struct { type CheckStatusState string const ( - CheckStatusStateQueued CheckStatusState = "QUEUED" - CheckStatusStateInProgress CheckStatusState = "IN_PROGRESS" CheckStatusStateCompleted CheckStatusState = "COMPLETED" - CheckStatusStateWaiting CheckStatusState = "WAITING" + CheckStatusStateInProgress CheckStatusState = "IN_PROGRESS" CheckStatusStatePending CheckStatusState = "PENDING" + CheckStatusStateQueued CheckStatusState = "QUEUED" CheckStatusStateRequested CheckStatusState = "REQUESTED" + CheckStatusStateWaiting CheckStatusState = "WAITING" ) // https://docs.github.com/en/graphql/reference/enums#checkconclusionstate @@ -155,14 +155,14 @@ type CheckConclusionState string const ( CheckConclusionStateActionRequired CheckConclusionState = "ACTION_REQUIRED" - CheckConclusionStateTimedOut CheckConclusionState = "TIMED_OUT" CheckConclusionStateCancelled CheckConclusionState = "CANCELLED" CheckConclusionStateFailure CheckConclusionState = "FAILURE" - CheckConclusionStateSuccess CheckConclusionState = "SUCCESS" CheckConclusionStateNeutral CheckConclusionState = "NEUTRAL" CheckConclusionStateSkipped CheckConclusionState = "SKIPPED" - CheckConclusionStateStartupFailure CheckConclusionState = "STARTUP_FAILURE" CheckConclusionStateStale CheckConclusionState = "STALE" + CheckConclusionStateStartupFailure CheckConclusionState = "STARTUP_FAILURE" + CheckConclusionStateSuccess CheckConclusionState = "SUCCESS" + CheckConclusionStateTimedOut CheckConclusionState = "TIMED_OUT" ) type CheckContexts struct { From 2717dc5758d1c260a5b9f06052ae9a9ff96ef0c2 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 24 May 2023 16:00:34 +0200 Subject: [PATCH 52/90] Add cmd test for pr status with counts by state --- .../pr/status/fixtures/prStatusChecks.json | 6 + .../prStatusChecksWithStatesByCount.json | 464 ++++++++++++++++++ pkg/cmd/pr/status/status_test.go | 38 +- 3 files changed, 504 insertions(+), 4 deletions(-) create mode 100644 pkg/cmd/pr/status/fixtures/prStatusChecksWithStatesByCount.json diff --git a/pkg/cmd/pr/status/fixtures/prStatusChecks.json b/pkg/cmd/pr/status/fixtures/prStatusChecks.json index 91455ee2c..0f5d88902 100644 --- a/pkg/cmd/pr/status/fixtures/prStatusChecks.json +++ b/pkg/cmd/pr/status/fixtures/prStatusChecks.json @@ -26,6 +26,7 @@ "contexts": { "nodes": [ { + "__typeName": "StatusContext", "state": "SUCCESS" } ] @@ -80,6 +81,7 @@ "contexts": { "nodes": [ { + "__typeName": "CheckRun", "status": "IN_PROGRESS", "conclusion": "" } @@ -109,13 +111,16 @@ "contexts": { "nodes": [ { + "__typeName": "CheckRun", "status": "IN_PROGRESS", "conclusion": "" }, { + "__typeName": "StatusContext", "state": "FAILURE" }, { + "__typeName": "CheckRun", "status": "COMPLETED", "conclusion": "NEUTRAL" } @@ -144,6 +149,7 @@ "contexts": { "nodes": [ { + "__typeName": "StatusContext", "state": "SUCCESS" } ] diff --git a/pkg/cmd/pr/status/fixtures/prStatusChecksWithStatesByCount.json b/pkg/cmd/pr/status/fixtures/prStatusChecksWithStatesByCount.json new file mode 100644 index 000000000..452cb4e06 --- /dev/null +++ b/pkg/cmd/pr/status/fixtures/prStatusChecksWithStatesByCount.json @@ -0,0 +1,464 @@ +{ + "data": { + "repository": { + "pullRequests": { + "totalCount": 0, + "edges": [] + } + }, + "viewerCreated": { + "totalCount": 4, + "edges": [ + { + "node": { + "number": 8, + "title": "Strawberries are not actually berries", + "state": "OPEN", + "url": "https://github.com/cli/cli/pull/8", + "headRefName": "strawberries", + "mergeable": "UNKNOWN", + "reviewDecision": "CHANGES_REQUESTED", + "statusCheckRollup": { + "nodes": [ + { + "commit": { + "statusCheckRollup": { + "contexts": { + "checkRunCount": 0, + "checkRunCountsByState": [ + { + "state": "ACTION_REQUIRED", + "count": 0 + }, + { + "state": "CANCELLED", + "count": 0 + }, + { + "state": "COMPLETED", + "count": 0 + }, + { + "state": "FAILURE", + "count": 0 + }, + { + "state": "IN_PROGRESS", + "count": 0 + }, + { + "state": "NEUTRAL", + "count": 0 + }, + { + "state": "PENDING", + "count": 0 + }, + { + "state": "QUEUED", + "count": 0 + }, + { + "state": "SKIPPED", + "count": 0 + }, + { + "state": "STALE", + "count": 0 + }, + { + "state": "STARTUP_FAILURE", + "count": 0 + }, + { + "state": "SUCCESS", + "count": 0 + }, + { + "state": "TIMED_OUT", + "count": 0 + }, + { + "state": "WAITING", + "count": 0 + } + ], + "statusContextCount": 1, + "statusContextCountsByState": [ + { + "state": "EXPECTED", + "count": 0 + }, + { + "state": "ERROR", + "count": 0 + }, + { + "state": "FAILURE", + "count": 0 + }, + { + "state": "PENDING", + "count": 0 + }, + { + "state": "SUCCESS", + "count": 1 + } + ] + } + } + } + } + ] + } + } + }, + { + "node": { + "number": 7, + "title": "Bananas are berries", + "state": "OPEN", + "url": "https://github.com/cli/cli/pull/7", + "headRefName": "banananana", + "reviewDecision": "APPROVED", + "baseRef": { + "branchProtectionRule": { + "requiredApprovingReviewCount": 0 + } + }, + "latestReviews": { + "nodes": [ + { + "author": { + "login": "bob" + }, + "state": "APPROVED" + }, + { + "author": { + "login": "stella" + }, + "state": "CHANGES_REQUESTED" + }, + { + "author": { + "login": "alice" + }, + "state": "APPROVED" + } + ] + }, + "statusCheckRollup": { + "nodes": [ + { + "commit": { + "statusCheckRollup": { + "contexts": { + "checkRunCount": 1, + "checkRunCountsByState": [ + { + "state": "ACTION_REQUIRED", + "count": 0 + }, + { + "state": "CANCELLED", + "count": 0 + }, + { + "state": "COMPLETED", + "count": 0 + }, + { + "state": "FAILURE", + "count": 0 + }, + { + "state": "IN_PROGRESS", + "count": 1 + }, + { + "state": "NEUTRAL", + "count": 0 + }, + { + "state": "PENDING", + "count": 0 + }, + { + "state": "QUEUED", + "count": 0 + }, + { + "state": "SKIPPED", + "count": 0 + }, + { + "state": "STALE", + "count": 0 + }, + { + "state": "STARTUP_FAILURE", + "count": 0 + }, + { + "state": "SUCCESS", + "count": 0 + }, + { + "state": "TIMED_OUT", + "count": 0 + }, + { + "state": "WAITING", + "count": 0 + } + ], + "statusContextCount": 1, + "statusContextCountsByState": [ + { + "state": "EXPECTED", + "count": 0 + }, + { + "state": "ERROR", + "count": 0 + }, + { + "state": "FAILURE", + "count": 0 + }, + { + "state": "PENDING", + "count": 0 + }, + { + "state": "SUCCESS", + "count": 1 + } + ] + } + } + } + } + ] + } + } + }, + { + "node": { + "number": 6, + "title": "Avocado is probably not a berry", + "state": "OPEN", + "url": "https://github.com/cli/cli/pull/6", + "headRefName": "avo", + "mergeable": "MERGEABLE", + "reviewDecision": "REVIEW_REQUIRED", + "statusCheckRollup": { + "nodes": [ + { + "commit": { + "statusCheckRollup": { + "contexts": { + "checkRunCount": 2, + "checkRunCountsByState": [ + { + "state": "ACTION_REQUIRED", + "count": 0 + }, + { + "state": "CANCELLED", + "count": 0 + }, + { + "state": "COMPLETED", + "count": 0 + }, + { + "state": "FAILURE", + "count": 0 + }, + { + "state": "IN_PROGRESS", + "count": 1 + }, + { + "state": "NEUTRAL", + "count": 1 + }, + { + "state": "PENDING", + "count": 0 + }, + { + "state": "QUEUED", + "count": 0 + }, + { + "state": "SKIPPED", + "count": 0 + }, + { + "state": "STALE", + "count": 0 + }, + { + "state": "STARTUP_FAILURE", + "count": 0 + }, + { + "state": "SUCCESS", + "count": 0 + }, + { + "state": "TIMED_OUT", + "count": 0 + }, + { + "state": "WAITING", + "count": 0 + } + ], + "statusContextCount": 1, + "statusContextCountsByState": [ + { + "state": "EXPECTED", + "count": 0 + }, + { + "state": "ERROR", + "count": 0 + }, + { + "state": "FAILURE", + "count": 1 + }, + { + "state": "PENDING", + "count": 0 + }, + { + "state": "SUCCESS", + "count": 0 + } + ] + } + } + } + } + ] + } + } + }, + { + "node": { + "number": 5, + "title": "Why can't berries get along?", + "state": "OPEN", + "url": "https://github.com/cli/cli/pull/5", + "headRefName": "strawberries", + "mergeable": "CONFLICTING", + "statusCheckRollup": { + "nodes": [ + { + "commit": { + "statusCheckRollup": { + "contexts": { + "checkRunCount": 0, + "checkRunCountsByState": [ + { + "state": "ACTION_REQUIRED", + "count": 0 + }, + { + "state": "CANCELLED", + "count": 0 + }, + { + "state": "COMPLETED", + "count": 0 + }, + { + "state": "FAILURE", + "count": 0 + }, + { + "state": "IN_PROGRESS", + "count": 0 + }, + { + "state": "NEUTRAL", + "count": 0 + }, + { + "state": "PENDING", + "count": 0 + }, + { + "state": "QUEUED", + "count": 0 + }, + { + "state": "SKIPPED", + "count": 0 + }, + { + "state": "STALE", + "count": 0 + }, + { + "state": "STARTUP_FAILURE", + "count": 0 + }, + { + "state": "SUCCESS", + "count": 0 + }, + { + "state": "TIMED_OUT", + "count": 0 + }, + { + "state": "WAITING", + "count": 0 + } + ], + "statusContextCount": 1, + "statusContextCountsByState": [ + { + "state": "EXPECTED", + "count": 0 + }, + { + "state": "ERROR", + "count": 0 + }, + { + "state": "FAILURE", + "count": 0 + }, + { + "state": "PENDING", + "count": 0 + }, + { + "state": "SUCCESS", + "count": 1 + } + ] + } + } + } + } + ] + } + } + } + ] + }, + "reviewRequested": { + "totalCount": 0, + "edges": [] + } + } +} diff --git a/pkg/cmd/pr/status/status_test.go b/pkg/cmd/pr/status/status_test.go index 35e8ecb74..3df048503 100644 --- a/pkg/cmd/pr/status/status_test.go +++ b/pkg/cmd/pr/status/status_test.go @@ -23,6 +23,10 @@ import ( ) func runCommand(rt http.RoundTripper, branch string, isTTY bool, cli string) (*test.CmdOut, error) { + return runCommandWithDetector(rt, branch, isTTY, cli, &fd.DisabledDetectorMock{}) +} + +func runCommandWithDetector(rt http.RoundTripper, branch string, isTTY bool, cli string, detector fd.Detector) (*test.CmdOut, error) { ios, _, stdout, stderr := iostreams.Test() ios.SetStdoutTTY(isTTY) ios.SetStdinTTY(isTTY) @@ -56,12 +60,12 @@ func runCommand(rt http.RoundTripper, branch string, isTTY bool, cli string) (*t GitClient: &git.Client{GitPath: "some/path/git"}, } - withAllFeaturesDisabled := func(opts *StatusOptions) error { - opts.Detector = &fd.DisabledDetectorMock{} + withProvidedDetector := func(opts *StatusOptions) error { + opts.Detector = detector return statusRun(opts) } - cmd := NewCmdStatus(factory, withAllFeaturesDisabled) + cmd := NewCmdStatus(factory, withProvidedDetector) cmd.PersistentFlags().StringP("repo", "R", "", "") argv, err := shlex.Split(cli) @@ -112,7 +116,8 @@ func TestPRStatus(t *testing.T) { func TestPRStatus_reviewsAndChecks(t *testing.T) { http := initFakeHTTP() defer http.Verify(t) - http.Register(httpmock.GraphQL(`query PullRequestStatus\b`), httpmock.FileResponse("./fixtures/prStatusChecks.json")) + // status,conclusion matches the old StatusContextRollup query + http.Register(httpmock.GraphQL(`status,conclusion`), httpmock.FileResponse("./fixtures/prStatusChecks.json")) output, err := runCommand(http, "blueberries", true, "") if err != nil { @@ -133,6 +138,31 @@ func TestPRStatus_reviewsAndChecks(t *testing.T) { } } +func TestPRStatus_reviewsAndChecksWithStatesByCount(t *testing.T) { + http := initFakeHTTP() + defer http.Verify(t) + // checkRunCount,checkRunCountsByState matches the new StatusContextRollup query + http.Register(httpmock.GraphQL(`checkRunCount,checkRunCountsByState`), httpmock.FileResponse("./fixtures/prStatusChecksWithStatesByCount.json")) + + output, err := runCommandWithDetector(http, "blueberries", true, "", &fd.EnabledDetectorMock{}) + if err != nil { + t.Errorf("error running command `pr status`: %v", err) + } + + expected := []string{ + "✓ Checks passing + Changes requested ! Merge conflict status unknown", + "- Checks pending ✓ 2 Approved", + "× 1/3 checks failing - Review required ✓ No merge conflicts", + "✓ Checks passing × Merge conflicts", + } + + for _, line := range expected { + if !strings.Contains(output.String(), line) { + t.Errorf("output did not contain %q: %q", line, output.String()) + } + } +} + func TestPRStatus_currentBranch_showTheMostRecentPR(t *testing.T) { http := initFakeHTTP() defer http.Verify(t) From 3bd1d6770cd73babd288ae7eeaf7d00393d6d522 Mon Sep 17 00:00:00 2001 From: vilmibm Date: Wed, 24 May 2023 12:40:46 -0700 Subject: [PATCH 53/90] fix variable name --- internal/prompter/prompter.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/internal/prompter/prompter.go b/internal/prompter/prompter.go index b91445c49..cd90fcd2d 100644 --- a/internal/prompter/prompter.go +++ b/internal/prompter/prompter.go @@ -86,7 +86,7 @@ func (p *surveyPrompter) Select(message, defaultValue string, options []string) return } -func (p *surveyPrompter) MultiSelect(message string, defaultValue, options []string) (result []int, err error) { +func (p *surveyPrompter) MultiSelect(message string, defaultValues, options []string) (result []int, err error) { q := &survey.MultiSelect{ Message: message, Options: options, @@ -94,10 +94,10 @@ func (p *surveyPrompter) MultiSelect(message string, defaultValue, options []str Filter: LatinMatchingFilter, } - if len(defaultValue) > 0 { + if len(defaultValues) > 0 { // TODO I don't actually know that this is needed, just being extra cautious validatedDefault := []string{} - for _, x := range defaultValue { + for _, x := range defaultValues { for _, y := range options { if x == y { validatedDefault = append(validatedDefault, x) From 74ee8cacae8f1812b414fcb5b90aec4cc9b6bd02 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Thu, 25 May 2023 09:46:45 +0900 Subject: [PATCH 54/90] Allow creating of nested aliases (#7457) --- cmd/gen-docs/main.go | 46 +++++- cmd/gh/main.go | 155 ++----------------- pkg/cmd/alias/expand/expand.go | 90 ----------- pkg/cmd/alias/expand/expand_test.go | 185 ----------------------- pkg/cmd/alias/imports/import.go | 14 +- pkg/cmd/alias/imports/import_test.go | 24 +-- pkg/cmd/alias/set/set.go | 21 +-- pkg/cmd/alias/set/set_test.go | 4 +- pkg/cmd/alias/shared/validations.go | 43 ++++-- pkg/cmd/alias/shared/validations_test.go | 46 ++++-- pkg/cmd/extension/command.go | 6 +- pkg/cmd/extension/command_test.go | 2 +- pkg/cmd/root/alias.go | 126 +++++++++++++++ pkg/cmd/root/alias_test.go | 123 +++++++++++++++ pkg/cmd/root/extension.go | 42 +++++ pkg/cmd/root/help.go | 51 +++++-- pkg/cmd/root/root.go | 80 +++++++++- 17 files changed, 556 insertions(+), 502 deletions(-) delete mode 100644 pkg/cmd/alias/expand/expand.go delete mode 100644 pkg/cmd/alias/expand/expand_test.go create mode 100644 pkg/cmd/root/alias.go create mode 100644 pkg/cmd/root/alias_test.go create mode 100644 pkg/cmd/root/extension.go diff --git a/cmd/gen-docs/main.go b/cmd/gen-docs/main.go index 7c5078df9..f3a12ef76 100644 --- a/cmd/gen-docs/main.go +++ b/cmd/gen-docs/main.go @@ -2,13 +2,17 @@ package main import ( "fmt" + "io" "os" "path/filepath" "strings" + "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/internal/docs" + "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/root" "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/extensions" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/pflag" ) @@ -41,9 +45,13 @@ func run(args []string) error { } ios, _, _, _ := iostreams.Test() - rootCmd := root.NewCmdRoot(&cmdutil.Factory{ + rootCmd, _ := root.NewCmdRoot(&cmdutil.Factory{ IOStreams: ios, Browser: &browser{}, + Config: func() (config.Config, error) { + return config.NewBlankConfig(), nil + }, + ExtensionManager: &em{}, }, "", "") rootCmd.InitDefaultHelpCmd() @@ -79,8 +87,42 @@ func linkHandler(name string) string { return fmt.Sprintf("./%s", strings.TrimSuffix(name, ".md")) } +// Implements browser.Browser interface. type browser struct{} -func (b *browser) Browse(url string) error { +func (b *browser) Browse(_ string) error { return nil } + +// Implements extensions.ExtensionManager interface. +type em struct{} + +func (e *em) List() []extensions.Extension { + return nil +} + +func (e *em) Install(_ ghrepo.Interface, _ string) error { + return nil +} + +func (e *em) InstallLocal(_ string) error { + return nil +} + +func (e *em) Upgrade(_ string, _ bool) error { + return nil +} + +func (e *em) Remove(_ string) error { + return nil +} + +func (e *em) Dispatch(_ []string, _ io.Reader, _, _ io.Writer) (bool, error) { + return false, nil +} + +func (e *em) Create(_ string, _ extensions.ExtTemplateType) error { + return nil +} + +func (e *em) EnableDryRunMode() {} diff --git a/cmd/gh/main.go b/cmd/gh/main.go index f231d7d2c..c36a4e6e6 100644 --- a/cmd/gh/main.go +++ b/cmd/gh/main.go @@ -14,16 +14,10 @@ import ( surveyCore "github.com/AlecAivazis/survey/v2/core" "github.com/AlecAivazis/survey/v2/terminal" - "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" - "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/build" "github.com/cli/cli/v2/internal/config" - "github.com/cli/cli/v2/internal/ghrepo" - "github.com/cli/cli/v2/internal/run" - "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/internal/update" - "github.com/cli/cli/v2/pkg/cmd/alias/expand" "github.com/cli/cli/v2/pkg/cmd/factory" "github.com/cli/cli/v2/pkg/cmd/root" "github.com/cli/cli/v2/pkg/cmdutil" @@ -93,11 +87,9 @@ func mainRun() exitCode { cobra.MousetrapHelpText = "" } - rootCmd := root.NewCmdRoot(cmdFactory, buildVersion, buildDate) - - cfg, err := cmdFactory.Config() + rootCmd, err := root.NewCmdRoot(cmdFactory, buildVersion, buildDate) if err != nil { - fmt.Fprintf(stderr, "failed to read configuration: %s\n", err) + fmt.Fprintf(stderr, "failed to create root command: %s\n", err) return exitError } @@ -106,110 +98,10 @@ func mainRun() exitCode { expandedArgs = os.Args[1:] } - // translate `gh help ` to `gh --help` for extensions - if len(expandedArgs) == 2 && expandedArgs[0] == "help" && !hasCommand(rootCmd, expandedArgs[1:]) { - expandedArgs = []string{expandedArgs[1], "--help"} - } - - if !hasCommand(rootCmd, expandedArgs) { - originalArgs := expandedArgs - isShell := false - - argsForExpansion := append([]string{"gh"}, expandedArgs...) - expandedArgs, isShell, err = expand.ExpandAlias(cfg, argsForExpansion, nil) - if err != nil { - fmt.Fprintf(stderr, "failed to process aliases: %s\n", err) - return exitError - } - - if hasDebug { - fmt.Fprintf(stderr, "%v -> %v\n", originalArgs, expandedArgs) - } - - if isShell { - exe, err := safeexec.LookPath(expandedArgs[0]) - if err != nil { - fmt.Fprintf(stderr, "failed to run external command: %s", err) - return exitError - } - - externalCmd := exec.Command(exe, expandedArgs[1:]...) - externalCmd.Stderr = os.Stderr - externalCmd.Stdout = os.Stdout - externalCmd.Stdin = os.Stdin - preparedCmd := run.PrepareCmd(externalCmd) - - err = preparedCmd.Run() - if err != nil { - var execError *exec.ExitError - if errors.As(err, &execError) { - return exitCode(execError.ExitCode()) - } - fmt.Fprintf(stderr, "failed to run external command: %s\n", err) - return exitError - } - - return exitOK - } else if len(expandedArgs) > 0 && !hasCommand(rootCmd, expandedArgs) { - extensionManager := cmdFactory.ExtensionManager - if found, err := extensionManager.Dispatch(expandedArgs, os.Stdin, os.Stdout, os.Stderr); err != nil { - var execError *exec.ExitError - if errors.As(err, &execError) { - return exitCode(execError.ExitCode()) - } - fmt.Fprintf(stderr, "failed to run extension: %s\n", err) - return exitError - } else if found { - return exitOK - } - } - } - - // provide completions for aliases and extensions - rootCmd.ValidArgsFunction = func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective) { - var results []string - aliases := cfg.Aliases() - for aliasName, aliasValue := range aliases.All() { - if strings.HasPrefix(aliasName, toComplete) { - var s string - if strings.HasPrefix(aliasValue, "!") { - s = fmt.Sprintf("%s\tShell alias", aliasName) - } else { - aliasValue = text.Truncate(80, aliasValue) - s = fmt.Sprintf("%s\tAlias for %s", aliasName, aliasValue) - } - results = append(results, s) - } - } - for _, ext := range cmdFactory.ExtensionManager.List() { - if strings.HasPrefix(ext.Name(), toComplete) { - var s string - if ext.IsLocal() { - s = fmt.Sprintf("%s\tLocal extension gh-%s", ext.Name(), ext.Name()) - } else { - path := ext.URL() - if u, err := git.ParseURL(ext.URL()); err == nil { - if r, err := ghrepo.FromURL(u); err == nil { - path = ghrepo.FullName(r) - } - } - s = fmt.Sprintf("%s\tExtension %s", ext.Name(), path) - } - results = append(results, s) - } - } - return results, cobra.ShellCompDirectiveNoFileComp - } - - authError := errors.New("authError") - rootCmd.PersistentPreRunE = func(cmd *cobra.Command, args []string) error { - // require that the user is authenticated before running most commands - if cmdutil.IsAuthCheckEnabled(cmd) && !cmdutil.CheckAuth(cfg) { - fmt.Fprint(stderr, authHelp()) - return authError - } - - return nil + // translate `gh help ` to `gh --help` for extensions. + if len(expandedArgs) >= 2 && expandedArgs[0] == "help" && isExtensionCommand(rootCmd, expandedArgs[1:]) { + expandedArgs = expandedArgs[1:] + expandedArgs = append(expandedArgs, "--help") } rootCmd.SetArgs(expandedArgs) @@ -217,6 +109,8 @@ func mainRun() exitCode { if cmd, err := rootCmd.ExecuteContextC(ctx); err != nil { var pagerPipeError *iostreams.ErrClosedPagerPipe var noResultsError cmdutil.NoResultsError + var execError *exec.ExitError + var authError *root.AuthError if err == cmdutil.SilentError { return exitError } else if cmdutil.IsUserCancellation(err) { @@ -225,7 +119,7 @@ func mainRun() exitCode { fmt.Fprint(stderr, "\n") } return exitCancel - } else if errors.Is(err, authError) { + } else if errors.As(err, &authError) { return exitAuth } else if errors.As(err, &pagerPipeError) { // ignore the error raised when piping to a closed pager @@ -236,6 +130,8 @@ func mainRun() exitCode { } // no results is not a command failure return exitOK + } else if errors.As(err, &execError) { + return exitCode(execError.ExitCode()) } printError(stderr, err, cmd, hasDebug) @@ -284,10 +180,10 @@ func mainRun() exitCode { return exitOK } -// hasCommand returns true if args resolve to a built-in command -func hasCommand(rootCmd *cobra.Command, args []string) bool { - c, _, err := rootCmd.Traverse(args) - return err == nil && c != rootCmd +// isExtensionCommand returns true if args resolve to an extension command. +func isExtensionCommand(rootCmd *cobra.Command, args []string) bool { + c, _, err := rootCmd.Find(args) + return err == nil && c != nil && c.GroupID == "extension" } func printError(out io.Writer, err error, cmd *cobra.Command, debug bool) { @@ -312,27 +208,6 @@ func printError(out io.Writer, err error, cmd *cobra.Command, debug bool) { } } -func authHelp() string { - if os.Getenv("GITHUB_ACTIONS") == "true" { - return heredoc.Doc(` - gh: To use GitHub CLI in a GitHub Actions workflow, set the GH_TOKEN environment variable. Example: - env: - GH_TOKEN: ${{ github.token }} - `) - } - - if os.Getenv("CI") != "" { - return heredoc.Doc(` - gh: To use GitHub CLI in automation, set the GH_TOKEN environment variable. - `) - } - - return heredoc.Doc(` - To get started with GitHub CLI, please run: gh auth login - Alternatively, populate the GH_TOKEN environment variable with a GitHub API authentication token. - `) -} - func shouldCheckForUpdate() bool { if os.Getenv("GH_NO_UPDATE_NOTIFIER") != "" { return false diff --git a/pkg/cmd/alias/expand/expand.go b/pkg/cmd/alias/expand/expand.go deleted file mode 100644 index d0e2627fb..000000000 --- a/pkg/cmd/alias/expand/expand.go +++ /dev/null @@ -1,90 +0,0 @@ -package expand - -import ( - "errors" - "fmt" - "os/exec" - "regexp" - "runtime" - "strings" - - "github.com/cli/cli/v2/internal/config" - "github.com/cli/cli/v2/pkg/findsh" - "github.com/google/shlex" -) - -// ExpandAlias processes argv to see if it should be rewritten according to a user's aliases. The -// second return value indicates whether the alias should be executed in a new shell process instead -// of running gh itself. -func ExpandAlias(cfg config.Config, args []string, findShFunc func() (string, error)) (expanded []string, isShell bool, err error) { - if len(args) < 2 { - // the command is lacking a subcommand - return - } - expanded = args[1:] - - aliases := cfg.Aliases() - - expansion, getErr := aliases.Get(args[1]) - if getErr != nil { - return - } - - if strings.HasPrefix(expansion, "!") { - isShell = true - if findShFunc == nil { - findShFunc = findSh - } - shPath, shErr := findShFunc() - if shErr != nil { - err = shErr - return - } - - expanded = []string{shPath, "-c", expansion[1:]} - - if len(args[2:]) > 0 { - expanded = append(expanded, "--") - expanded = append(expanded, args[2:]...) - } - - return - } - - extraArgs := []string{} - for i, a := range args[2:] { - if !strings.Contains(expansion, "$") { - extraArgs = append(extraArgs, a) - } else { - expansion = strings.ReplaceAll(expansion, fmt.Sprintf("$%d", i+1), a) - } - } - lingeringRE := regexp.MustCompile(`\$\d`) - if lingeringRE.MatchString(expansion) { - err = fmt.Errorf("not enough arguments for alias: %s", expansion) - return - } - - var newArgs []string - newArgs, err = shlex.Split(expansion) - if err != nil { - return - } - - expanded = append(newArgs, extraArgs...) - return -} - -func findSh() (string, error) { - shPath, err := findsh.Find() - if err != nil { - if errors.Is(err, exec.ErrNotFound) { - if runtime.GOOS == "windows" { - return "", errors.New("unable to locate sh to execute the shell alias with. The sh.exe interpreter is typically distributed with Git for Windows.") - } - return "", errors.New("unable to locate sh to execute shell alias with") - } - return "", err - } - return shPath, nil -} diff --git a/pkg/cmd/alias/expand/expand_test.go b/pkg/cmd/alias/expand/expand_test.go deleted file mode 100644 index 33af4b073..000000000 --- a/pkg/cmd/alias/expand/expand_test.go +++ /dev/null @@ -1,185 +0,0 @@ -package expand - -import ( - "errors" - "reflect" - "testing" - - "github.com/MakeNowJust/heredoc" - "github.com/cli/cli/v2/internal/config" -) - -func TestExpandAlias(t *testing.T) { - findShFunc := func() (string, error) { - return "/usr/bin/sh", nil - } - - cfg := config.NewFromString(heredoc.Doc(` - aliases: - co: pr checkout - il: issue list --author="$1" --label="$2" - ia: issue list --author="$1" --assignee="$1" - `)) - - type args struct { - config config.Config - argv []string - } - tests := []struct { - name string - args args - wantExpanded []string - wantIsShell bool - wantErr error - }{ - { - name: "no arguments", - args: args{ - config: cfg, - argv: []string{}, - }, - wantExpanded: []string(nil), - wantIsShell: false, - wantErr: nil, - }, - { - name: "too few arguments", - args: args{ - config: cfg, - argv: []string{"gh"}, - }, - wantExpanded: []string(nil), - wantIsShell: false, - wantErr: nil, - }, - { - name: "no expansion", - args: args{ - config: cfg, - argv: []string{"gh", "pr", "status"}, - }, - wantExpanded: []string{"pr", "status"}, - wantIsShell: false, - wantErr: nil, - }, - { - name: "simple expansion", - args: args{ - config: cfg, - argv: []string{"gh", "co"}, - }, - wantExpanded: []string{"pr", "checkout"}, - wantIsShell: false, - wantErr: nil, - }, - { - name: "adding arguments after expansion", - args: args{ - config: cfg, - argv: []string{"gh", "co", "123"}, - }, - wantExpanded: []string{"pr", "checkout", "123"}, - wantIsShell: false, - wantErr: nil, - }, - { - name: "not enough arguments for expansion", - args: args{ - config: cfg, - argv: []string{"gh", "il"}, - }, - wantExpanded: []string{}, - wantIsShell: false, - wantErr: errors.New(`not enough arguments for alias: issue list --author="$1" --label="$2"`), - }, - { - name: "not enough arguments for expansion 2", - args: args{ - config: cfg, - argv: []string{"gh", "il", "vilmibm"}, - }, - wantExpanded: []string{}, - wantIsShell: false, - wantErr: errors.New(`not enough arguments for alias: issue list --author="vilmibm" --label="$2"`), - }, - { - name: "satisfy expansion arguments", - args: args{ - config: cfg, - argv: []string{"gh", "il", "vilmibm", "help wanted"}, - }, - wantExpanded: []string{"issue", "list", "--author=vilmibm", "--label=help wanted"}, - wantIsShell: false, - wantErr: nil, - }, - { - name: "mixed positional and non-positional arguments", - args: args{ - config: cfg, - argv: []string{"gh", "il", "vilmibm", "epic", "-R", "monalisa/testing"}, - }, - wantExpanded: []string{"issue", "list", "--author=vilmibm", "--label=epic", "-R", "monalisa/testing"}, - wantIsShell: false, - wantErr: nil, - }, - { - name: "dollar in expansion", - args: args{ - config: cfg, - argv: []string{"gh", "ia", "$coolmoney$"}, - }, - wantExpanded: []string{"issue", "list", "--author=$coolmoney$", "--assignee=$coolmoney$"}, - wantIsShell: false, - wantErr: nil, - }, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - gotExpanded, gotIsShell, err := ExpandAlias(tt.args.config, tt.args.argv, findShFunc) - if tt.wantErr != nil { - if err == nil { - t.Fatal("expected error") - } - if tt.wantErr.Error() != err.Error() { - t.Fatalf("expected error %q, got %q", tt.wantErr, err) - } - return - } - if err != nil { - t.Fatalf("got error: %v", err) - } - if !reflect.DeepEqual(gotExpanded, tt.wantExpanded) { - t.Errorf("ExpandAlias() gotExpanded = %v, want %v", gotExpanded, tt.wantExpanded) - } - if gotIsShell != tt.wantIsShell { - t.Errorf("ExpandAlias() gotIsShell = %v, want %v", gotIsShell, tt.wantIsShell) - } - }) - } -} - -// cfg := `--- -// aliases: -// co: pr checkout -// il: issue list --author="$1" --label="$2" -// ia: issue list --author="$1" --assignee="$1" -// ` -// initBlankContext(cfg, "OWNER/REPO", "trunk") -// for _, c := range []struct { -// Args string -// ExpectedArgs []string -// Err string -// }{ -// {"gh co", []string{"pr", "checkout"}, ""}, -// {"gh il", nil, `not enough arguments for alias: issue list --author="$1" --label="$2"`}, -// {"gh il vilmibm", nil, `not enough arguments for alias: issue list --author="vilmibm" --label="$2"`}, -// {"gh co 123", []string{"pr", "checkout", "123"}, ""}, -// {"gh il vilmibm epic", []string{"issue", "list", `--author=vilmibm`, `--label=epic`}, ""}, -// {"gh ia vilmibm", []string{"issue", "list", `--author=vilmibm`, `--assignee=vilmibm`}, ""}, -// {"gh ia $coolmoney$", []string{"issue", "list", `--author=$coolmoney$`, `--assignee=$coolmoney$`}, ""}, -// {"gh pr status", []string{"pr", "status"}, ""}, -// {"gh il vilmibm epic -R vilmibm/testing", []string{"issue", "list", "--author=vilmibm", "--label=epic", "-R", "vilmibm/testing"}, ""}, -// {"gh dne", []string{"dne"}, ""}, -// {"gh", []string{}, ""}, -// {"", []string{}, ""}, -// } { diff --git a/pkg/cmd/alias/imports/import.go b/pkg/cmd/alias/imports/import.go index f724e2699..f7de0bb78 100644 --- a/pkg/cmd/alias/imports/import.go +++ b/pkg/cmd/alias/imports/import.go @@ -21,7 +21,8 @@ type ImportOptions struct { Filename string OverwriteExisting bool - existingCommand func(string) bool + validAliasName func(string) bool + validAliasExpansion func(string) bool } func NewCmdImport(f *cmdutil.Factory, runF func(*ImportOptions) error) *cobra.Command { @@ -74,7 +75,8 @@ func NewCmdImport(f *cmdutil.Factory, runF func(*ImportOptions) error) *cobra.Co opts.Filename = args[0] } - opts.existingCommand = shared.ExistingCommandFunc(f, cmd) + opts.validAliasName = shared.ValidAliasNameFunc(cmd) + opts.validAliasExpansion = shared.ValidAliasExpansionFunc(cmd) if runF != nil { return runF(opts) @@ -120,9 +122,9 @@ func importRun(opts *ImportOptions) error { var msg strings.Builder for _, alias := range getSortedKeys(aliasMap) { - if opts.existingCommand(alias) { + if !opts.validAliasName(alias) { msg.WriteString( - fmt.Sprintf("%s Could not import alias %s: already a gh command\n", + fmt.Sprintf("%s Could not import alias %s: already a gh command, extension, or alias\n", cs.FailureIcon(), cs.Bold(alias), ), @@ -133,9 +135,9 @@ func importRun(opts *ImportOptions) error { expansion := aliasMap[alias] - if !(strings.HasPrefix(expansion, "!") || opts.existingCommand(expansion)) { + if !opts.validAliasExpansion(expansion) { msg.WriteString( - fmt.Sprintf("%s Could not import alias %s: expansion does not correspond to a gh command\n", + fmt.Sprintf("%s Could not import alias %s: expansion does not correspond to a gh command, extension, or alias\n", cs.FailureIcon(), cs.Bold(alias), ), diff --git a/pkg/cmd/alias/imports/import_test.go b/pkg/cmd/alias/imports/import_test.go index 8837a52db..0013429f6 100644 --- a/pkg/cmd/alias/imports/import_test.go +++ b/pkg/cmd/alias/imports/import_test.go @@ -13,7 +13,6 @@ import ( "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/pkg/cmd/alias/shared" "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/pkg/extensions" "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" "github.com/spf13/cobra" @@ -257,9 +256,9 @@ func TestImportRun(t *testing.T) { wantStderr: strings.Join( []string{ importFileMsg, - "X Could not import alias api: already a gh command", - "X Could not import alias issue: already a gh command", - "X Could not import alias pr: already a gh command\n\n", + "X Could not import alias api: already a gh command, extension, or alias", + "X Could not import alias issue: already a gh command, extension, or alias", + "X Could not import alias pr: already a gh command, extension, or alias\n\n", }, "\n", ), @@ -277,8 +276,8 @@ func TestImportRun(t *testing.T) { wantStderr: strings.Join( []string{ importFileMsg, - "X Could not import alias alias1: expansion does not correspond to a gh command", - "X Could not import alias alias2: expansion does not correspond to a gh command\n\n", + "X Could not import alias alias1: expansion does not correspond to a gh command, extension, or alias", + "X Could not import alias alias2: expansion does not correspond to a gh command, extension, or alias\n\n", }, "\n", ), @@ -304,16 +303,6 @@ func TestImportRun(t *testing.T) { return cfg, nil } - // Create fake command factory for testing. - f := &cmdutil.Factory{ - IOStreams: ios, - ExtensionManager: &extensions.ExtensionManagerMock{ - ListFunc: func() []extensions.Extension { - return []extensions.Extension{} - }, - }, - } - // Create fake command structure for testing. rootCmd := &cobra.Command{} prCmd := &cobra.Command{Use: "pr"} @@ -327,7 +316,8 @@ func TestImportRun(t *testing.T) { apiCmd.AddCommand(&cobra.Command{Use: "graphql"}) rootCmd.AddCommand(apiCmd) - tt.opts.existingCommand = shared.ExistingCommandFunc(f, rootCmd) + tt.opts.validAliasName = shared.ValidAliasNameFunc(rootCmd) + tt.opts.validAliasExpansion = shared.ValidAliasExpansionFunc(rootCmd) if tt.stdin != "" { stdin.WriteString(tt.stdin) diff --git a/pkg/cmd/alias/set/set.go b/pkg/cmd/alias/set/set.go index 871737881..20c86c473 100644 --- a/pkg/cmd/alias/set/set.go +++ b/pkg/cmd/alias/set/set.go @@ -21,7 +21,8 @@ type SetOptions struct { Expansion string IsShell bool - existingCommand func(string) bool + validAliasName func(string) bool + validAliasExpansion func(string) bool } func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command { @@ -59,6 +60,9 @@ func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command $ gh alias set homework 'issue list --assignee @me' $ gh homework + $ gh alias set 'issue mine' 'issue list --mention @me' + $ gh issue mine + $ gh alias set epicsBy 'issue list --author="$1" --label="epic"' $ gh epicsBy vilmibm #=> gh issue list --author="vilmibm" --label="epic" @@ -70,7 +74,8 @@ func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command opts.Name = args[0] opts.Expansion = args[1] - opts.existingCommand = shared.ExistingCommandFunc(f, cmd) + opts.validAliasName = shared.ValidAliasNameFunc(cmd) + opts.validAliasExpansion = shared.ValidAliasExpansionFunc(cmd) if runF != nil { return runF(opts) @@ -104,18 +109,16 @@ func setRun(opts *SetOptions) error { fmt.Fprintf(opts.IO.ErrOut, "- Adding alias for %s: %s\n", cs.Bold(opts.Name), cs.Bold(expansion)) } - isShell := opts.IsShell - if isShell && !strings.HasPrefix(expansion, "!") { + if opts.IsShell && !strings.HasPrefix(expansion, "!") { expansion = "!" + expansion } - isShell = strings.HasPrefix(expansion, "!") - if opts.existingCommand(opts.Name) { - return fmt.Errorf("could not create alias: %q is already a gh command", opts.Name) + if !opts.validAliasName(opts.Name) { + return fmt.Errorf("could not create alias: %q is already a gh command, extension, or alias", opts.Name) } - if !isShell && !opts.existingCommand(expansion) { - return fmt.Errorf("could not create alias: %s does not correspond to a gh command", expansion) + if !opts.validAliasExpansion(expansion) { + return fmt.Errorf("could not create alias: %s does not correspond to a gh command, extension, or alias", expansion) } successMsg := fmt.Sprintf("%s Added alias.", cs.SuccessIcon()) diff --git a/pkg/cmd/alias/set/set_test.go b/pkg/cmd/alias/set/set_test.go index bec03cba4..54fcabf5b 100644 --- a/pkg/cmd/alias/set/set_test.go +++ b/pkg/cmd/alias/set/set_test.go @@ -73,7 +73,7 @@ func TestAliasSet_gh_command(t *testing.T) { cfg := config.NewFromString(``) _, err := runCommand(cfg, true, "pr 'pr status'", "") - assert.EqualError(t, err, `could not create alias: "pr" is already a gh command`) + assert.EqualError(t, err, `could not create alias: "pr" is already a gh command, extension, or alias`) } func TestAliasSet_empty_aliases(t *testing.T) { @@ -231,7 +231,7 @@ func TestAliasSet_invalid_command(t *testing.T) { cfg := config.NewFromString(``) _, err := runCommand(cfg, true, "co 'pe checkout'", "") - assert.EqualError(t, err, "could not create alias: pe checkout does not correspond to a gh command") + assert.EqualError(t, err, "could not create alias: pe checkout does not correspond to a gh command, extension, or alias") } func TestShellAlias_flag(t *testing.T) { diff --git a/pkg/cmd/alias/shared/validations.go b/pkg/cmd/alias/shared/validations.go index 6557f66ca..9a213ab98 100644 --- a/pkg/cmd/alias/shared/validations.go +++ b/pkg/cmd/alias/shared/validations.go @@ -1,14 +1,18 @@ package shared import ( - "github.com/cli/cli/v2/pkg/cmdutil" + "strings" + "github.com/google/shlex" "github.com/spf13/cobra" ) -// ExistingCommandFunc returns a function that will check if the given string -// corresponds to an existing command. -func ExistingCommandFunc(f *cmdutil.Factory, cmd *cobra.Command) func(string) bool { +// ValidAliasNameFunc returns a function that will check if the given string +// is a valid alias name. A name is valid if: +// - it does not shadow an existing command, +// - it is not nested under a command that is runnable, +// - it is not nested under a command that does not exist. +func ValidAliasNameFunc(cmd *cobra.Command) func(string) bool { return func(args string) bool { split, err := shlex.Split(args) if err != nil || len(split) == 0 { @@ -16,17 +20,32 @@ func ExistingCommandFunc(f *cmdutil.Factory, cmd *cobra.Command) func(string) bo } rootCmd := cmd.Root() - cmd, _, err = rootCmd.Traverse(split) - if err == nil && cmd != rootCmd { + foundCmd, foundArgs, _ := rootCmd.Find(split) + if foundCmd != nil && !foundCmd.Runnable() && len(foundArgs) == 1 { return true } - for _, ext := range f.ExtensionManager.List() { - if ext.Name() == split[0] { - return true - } - } - return false } } + +// ValidAliasExpansionFunc returns a function that will check if the given string +// is a valid alias expansion. An expansion is valid if: +// - it is a shell expansion, +// - it is a non-shell expansion that corresponds to an existing command, extension, or alias. +func ValidAliasExpansionFunc(cmd *cobra.Command) func(string) bool { + return func(expansion string) bool { + if strings.HasPrefix(expansion, "!") { + return true + } + + split, err := shlex.Split(expansion) + if err != nil || len(split) == 0 { + return false + } + + rootCmd := cmd.Root() + cmd, _, _ = rootCmd.Find(split) + return cmd != rootCmd + } +} diff --git a/pkg/cmd/alias/shared/validations_test.go b/pkg/cmd/alias/shared/validations_test.go index faa0e497d..72270a608 100644 --- a/pkg/cmd/alias/shared/validations_test.go +++ b/pkg/cmd/alias/shared/validations_test.go @@ -3,22 +3,11 @@ package shared import ( "testing" - "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/pkg/extensions" "github.com/spf13/cobra" "github.com/stretchr/testify/assert" ) -func TestExistingCommandFunc(t *testing.T) { - // Create fake command factory for testing. - factory := &cmdutil.Factory{ - ExtensionManager: &extensions.ExtensionManagerMock{ - ListFunc: func() []extensions.Extension { - return []extensions.Extension{} - }, - }, - } - +func TestValidAliasNameFunc(t *testing.T) { // Create fake command structure for testing. issueCmd := &cobra.Command{Use: "issue"} prCmd := &cobra.Command{Use: "pr"} @@ -28,13 +17,38 @@ func TestExistingCommandFunc(t *testing.T) { cmd.AddCommand(prCmd) cmd.AddCommand(issueCmd) - f := ExistingCommandFunc(factory, cmd) + f := ValidAliasNameFunc(cmd) - assert.True(t, f("pr")) - assert.True(t, f("pr checkout")) - assert.True(t, f("issue")) + assert.False(t, f("pr")) + assert.False(t, f("pr checkout")) + assert.False(t, f("issue")) + assert.False(t, f("repo list")) + + assert.True(t, f("ps")) + assert.True(t, f("checkout")) + assert.True(t, f("issue erase")) + assert.True(t, f("pr erase")) + assert.True(t, f("pr checkout branch")) +} + +func TestValidAliasExpansionFunc(t *testing.T) { + // Create fake command structure for testing. + issueCmd := &cobra.Command{Use: "issue"} + prCmd := &cobra.Command{Use: "pr"} + prCmd.AddCommand(&cobra.Command{Use: "checkout"}) + + cmd := &cobra.Command{} + cmd.AddCommand(prCmd) + cmd.AddCommand(issueCmd) + + f := ValidAliasExpansionFunc(cmd) assert.False(t, f("ps")) assert.False(t, f("checkout")) assert.False(t, f("repo list")) + + assert.True(t, f("!git branch --show-current")) + assert.True(t, f("pr")) + assert.True(t, f("pr checkout")) + assert.True(t, f("issue")) } diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index 0f2add8aa..6629e599d 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -643,10 +643,8 @@ func checkValidExtension(rootCmd *cobra.Command, m extensions.ExtensionManager, } commandName := strings.TrimPrefix(extName, "gh-") - if c, _, err := rootCmd.Traverse([]string{commandName}); err != nil { - return nil, err - } else if c != rootCmd { - return nil, fmt.Errorf("%q matches the name of a built-in command", commandName) + if c, _, _ := rootCmd.Find([]string{commandName}); c != rootCmd && c.GroupID != "extension" { + return nil, fmt.Errorf("%q matches the name of a built-in command or alias", commandName) } for _, ext := range m.List() { diff --git a/pkg/cmd/extension/command_test.go b/pkg/cmd/extension/command_test.go index ebc4716de..6080e8483 100644 --- a/pkg/cmd/extension/command_test.go +++ b/pkg/cmd/extension/command_test.go @@ -974,7 +974,7 @@ func Test_checkValidExtension(t *testing.T) { manager: m, extName: "gh-auth", }, - wantError: "\"auth\" matches the name of a built-in command", + wantError: "\"auth\" matches the name of a built-in command or alias", }, { name: "clashes with an installed extension", diff --git a/pkg/cmd/root/alias.go b/pkg/cmd/root/alias.go new file mode 100644 index 000000000..ba0bfe9e2 --- /dev/null +++ b/pkg/cmd/root/alias.go @@ -0,0 +1,126 @@ +package root + +import ( + "errors" + "fmt" + "os/exec" + "regexp" + "runtime" + "strings" + + "github.com/cli/cli/v2/internal/run" + "github.com/cli/cli/v2/internal/text" + "github.com/cli/cli/v2/pkg/findsh" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/spf13/cobra" +) + +func NewCmdShellAlias(io *iostreams.IOStreams, aliasName, aliasValue string) *cobra.Command { + return &cobra.Command{ + Use: aliasName, + Short: fmt.Sprintf("Shell alias for %q", text.Truncate(80, aliasValue)), + RunE: func(c *cobra.Command, args []string) error { + expandedArgs, err := expandShellAlias(aliasValue, args, nil) + if err != nil { + return err + } + externalCmd := exec.Command(expandedArgs[0], expandedArgs[1:]...) + externalCmd.Stderr = io.ErrOut + externalCmd.Stdout = io.Out + externalCmd.Stdin = io.In + preparedCmd := run.PrepareCmd(externalCmd) + if err = preparedCmd.Run(); err != nil { + return fmt.Errorf("failed to run external command: %w\n", err) + } + return nil + }, + GroupID: "alias", + Annotations: map[string]string{ + "skipAuthCheck": "true", + }, + DisableFlagParsing: true, + } +} + +func NewCmdAlias(io *iostreams.IOStreams, aliasName, aliasValue string) *cobra.Command { + return &cobra.Command{ + Use: aliasName, + Short: fmt.Sprintf("Alias for %q", text.Truncate(80, aliasValue)), + RunE: func(c *cobra.Command, args []string) error { + expandedArgs, err := expandAlias(aliasValue, args) + if err != nil { + return err + } + root := c.Root() + root.SetArgs(expandedArgs) + return root.Execute() + }, + GroupID: "alias", + Annotations: map[string]string{ + "skipAuthCheck": "true", + }, + DisableFlagParsing: true, + } +} + +// ExpandAlias processes argv to see if it should be rewritten according to a user's aliases. +func expandAlias(expansion string, args []string) ([]string, error) { + extraArgs := []string{} + for i, a := range args { + if !strings.Contains(expansion, "$") { + extraArgs = append(extraArgs, a) + } else { + expansion = strings.ReplaceAll(expansion, fmt.Sprintf("$%d", i+1), a) + } + } + + lingeringRE := regexp.MustCompile(`\$\d`) + if lingeringRE.MatchString(expansion) { + return nil, fmt.Errorf("not enough arguments for alias: %s", expansion) + } + + newArgs, err := shlex.Split(expansion) + if err != nil { + return nil, err + } + + expanded := append(newArgs, extraArgs...) + + return expanded, nil +} + +// ExpandShellAlias processes argv to see if it should be rewritten according to a user's aliases. +func expandShellAlias(expansion string, args []string, findShFunc func() (string, error)) ([]string, error) { + if findShFunc == nil { + findShFunc = findSh + } + + shPath, shErr := findShFunc() + if shErr != nil { + return nil, shErr + } + + expanded := []string{shPath, "-c", expansion[1:]} + + if len(args) > 0 { + expanded = append(expanded, "--") + expanded = append(expanded, args...) + } + + return expanded, nil +} + +func findSh() (string, error) { + shPath, err := findsh.Find() + if err != nil { + if errors.Is(err, exec.ErrNotFound) { + if runtime.GOOS == "windows" { + return "", errors.New("unable to locate sh to execute the shell alias with. The sh.exe interpreter is typically distributed with Git for Windows.") + } + return "", errors.New("unable to locate sh to execute shell alias with") + } + return "", err + } + return shPath, nil +} diff --git a/pkg/cmd/root/alias_test.go b/pkg/cmd/root/alias_test.go new file mode 100644 index 000000000..4a2d3c13e --- /dev/null +++ b/pkg/cmd/root/alias_test.go @@ -0,0 +1,123 @@ +package root + +import ( + "errors" + "testing" + + "github.com/stretchr/testify/assert" +) + +func TestExpandAlias(t *testing.T) { + tests := []struct { + name string + expansion string + args []string + wantExpanded []string + wantErr string + }{ + { + name: "no expansion", + expansion: "pr status", + args: []string{}, + wantExpanded: []string{"pr", "status"}, + }, + { + name: "adding arguments after expansion", + expansion: "pr checkout", + args: []string{"123"}, + wantExpanded: []string{"pr", "checkout", "123"}, + }, + { + name: "not enough arguments for expansion", + expansion: `issue list --author="$1" --label="$2"`, + args: []string{}, + wantErr: `not enough arguments for alias: issue list --author="$1" --label="$2"`, + }, + { + name: "not enough arguments for expansion 2", + expansion: `issue list --author="$1" --label="$2"`, + args: []string{"vilmibm"}, + wantErr: `not enough arguments for alias: issue list --author="vilmibm" --label="$2"`, + }, + { + name: "satisfy expansion arguments", + expansion: `issue list --author="$1" --label="$2"`, + args: []string{"vilmibm", "help wanted"}, + wantExpanded: []string{"issue", "list", "--author=vilmibm", "--label=help wanted"}, + }, + { + name: "mixed positional and non-positional arguments", + expansion: `issue list --author="$1" --label="$2"`, + args: []string{"vilmibm", "epic", "-R", "monalisa/testing"}, + wantExpanded: []string{"issue", "list", "--author=vilmibm", "--label=epic", "-R", "monalisa/testing"}, + }, + { + name: "dollar in expansion", + expansion: `issue list --author="$1" --assignee="$1"`, + args: []string{"$coolmoney$"}, + wantExpanded: []string{"issue", "list", "--author=$coolmoney$", "--assignee=$coolmoney$"}, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + gotExpanded, err := expandAlias(tt.expansion, tt.args) + if tt.wantErr != "" { + assert.Nil(t, gotExpanded) + assert.EqualError(t, err, tt.wantErr) + return + } + assert.NoError(t, err) + assert.Equal(t, tt.wantExpanded, gotExpanded) + }) + } +} + +func TestExpandShellAlias(t *testing.T) { + findShFunc := func() (string, error) { + return "/usr/bin/sh", nil + } + tests := []struct { + name string + expansion string + args []string + findSh func() (string, error) + wantExpanded []string + wantErr string + }{ + { + name: "simple expansion", + expansion: "!git branch --show-current", + args: []string{}, + findSh: findShFunc, + wantExpanded: []string{"/usr/bin/sh", "-c", "git branch --show-current"}, + }, + { + name: "adding arguments after expansion", + expansion: "!git branch checkout", + args: []string{"123"}, + findSh: findShFunc, + wantExpanded: []string{"/usr/bin/sh", "-c", "git branch checkout", "--", "123"}, + }, + { + name: "unable to find sh", + expansion: "!git branch --show-current", + args: []string{}, + findSh: func() (string, error) { + return "", errors.New("unable to locate sh") + }, + wantErr: "unable to locate sh", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + gotExpanded, err := expandShellAlias(tt.expansion, tt.args, tt.findSh) + if tt.wantErr != "" { + assert.Nil(t, gotExpanded) + assert.EqualError(t, err, tt.wantErr) + return + } + assert.NoError(t, err) + assert.Equal(t, tt.wantExpanded, gotExpanded) + }) + } +} diff --git a/pkg/cmd/root/extension.go b/pkg/cmd/root/extension.go new file mode 100644 index 000000000..52ef6b0a4 --- /dev/null +++ b/pkg/cmd/root/extension.go @@ -0,0 +1,42 @@ +package root + +import ( + "fmt" + + "github.com/cli/cli/v2/git" + "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/pkg/extensions" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/spf13/cobra" +) + +func NewCmdExtension(io *iostreams.IOStreams, em extensions.ExtensionManager, ext extensions.Extension) *cobra.Command { + var short string + if ext.IsLocal() { + short = fmt.Sprintf("Local extension gh-%s", ext.Name()) + } else { + path := ext.URL() + if u, err := git.ParseURL(ext.URL()); err == nil { + if r, err := ghrepo.FromURL(u); err == nil { + path = ghrepo.FullName(r) + } + } + short = fmt.Sprintf("Extension %s", path) + } + return &cobra.Command{ + Use: ext.Name(), + Short: short, + RunE: func(c *cobra.Command, args []string) error { + args = append([]string{ext.Name()}, args...) + if _, err := em.Dispatch(args, io.In, io.Out, io.ErrOut); err != nil { + return fmt.Errorf("failed to run extension: %w\n", err) + } + return nil + }, + GroupID: "extension", + Annotations: map[string]string{ + "skipAuthCheck": "true", + }, + DisableFlagParsing: true, + } +} diff --git a/pkg/cmd/root/help.go b/pkg/cmd/root/help.go index 9da57d6e9..c33095c1f 100644 --- a/pkg/cmd/root/help.go +++ b/pkg/cmd/root/help.go @@ -4,9 +4,11 @@ import ( "bytes" "fmt" "io" + "os" "sort" "strings" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/spf13/cobra" @@ -16,13 +18,17 @@ import ( func rootUsageFunc(w io.Writer, command *cobra.Command) error { fmt.Fprintf(w, "Usage: %s", command.UseLine()) - subcommands := command.Commands() + var subcommands []*cobra.Command + for _, c := range command.Commands() { + if !c.IsAvailableCommand() { + continue + } + subcommands = append(subcommands, c) + } + if len(subcommands) > 0 { fmt.Fprint(w, "\n\nAvailable commands:\n") for _, c := range subcommands { - if c.Hidden { - continue - } fmt.Fprintf(w, " %s\n", c.Name()) } return nil @@ -82,8 +88,10 @@ func isRootCmd(command *cobra.Command) bool { } func rootHelpFunc(f *cmdutil.Factory, command *cobra.Command, args []string) { + flags := command.Flags() + if isRootCmd(command) { - if versionVal, err := command.Flags().GetBool("version"); err == nil && versionVal { + if versionVal, err := flags.GetBool("version"); err == nil && versionVal { fmt.Fprint(f.IOStreams.Out, command.Annotations["versionInfo"]) return } else if err != nil { @@ -95,8 +103,8 @@ func rootHelpFunc(f *cmdutil.Factory, command *cobra.Command, args []string) { cs := f.IOStreams.ColorScheme() - if isRootCmd(command.Parent()) && len(args) >= 2 && args[1] != "--help" && args[1] != "-h" { - nestedSuggestFunc(f.IOStreams.ErrOut, command, args[1]) + if help, _ := flags.GetBool("help"); !help && !command.Runnable() && len(flags.Args()) > 0 { + nestedSuggestFunc(f.IOStreams.ErrOut, command, strings.Join(flags.Args(), " ")) hasFailed = true return } @@ -144,14 +152,6 @@ func rootHelpFunc(f *cmdutil.Factory, command *cobra.Command, args []string) { } sort.Strings(helpTopics) helpEntries = append(helpEntries, helpEntry{"HELP TOPICS", strings.Join(helpTopics, "\n")}) - - if exts := f.ExtensionManager.List(); len(exts) > 0 { - var names []string - for _, ext := range exts { - names = append(names, ext.Name()) - } - helpEntries = append(helpEntries, helpEntry{"EXTENSION COMMANDS", strings.Join(names, "\n")}) - } } flagUsages := command.LocalFlags().FlagUsages() @@ -189,6 +189,27 @@ Read the manual at https://cli.github.com/manual`}) } } +func authHelp() string { + if os.Getenv("GITHUB_ACTIONS") == "true" { + return heredoc.Doc(` + gh: To use GitHub CLI in a GitHub Actions workflow, set the GH_TOKEN environment variable. Example: + env: + GH_TOKEN: ${{ github.token }} + `) + } + + if os.Getenv("CI") != "" { + return heredoc.Doc(` + gh: To use GitHub CLI in automation, set the GH_TOKEN environment variable. + `) + } + + return heredoc.Doc(` + To get started with GitHub CLI, please run: gh auth login + Alternatively, populate the GH_TOKEN environment variable with a GitHub API authentication token. + `) +} + func findCommand(cmd *cobra.Command, name string) *cobra.Command { for _, c := range cmd.Commands() { if c.Name() == name { diff --git a/pkg/cmd/root/root.go b/pkg/cmd/root/root.go index 8d18a4db1..5a79e8aeb 100644 --- a/pkg/cmd/root/root.go +++ b/pkg/cmd/root/root.go @@ -1,8 +1,10 @@ package root import ( + "fmt" "net/http" "os" + "strings" "sync" "github.com/MakeNowJust/heredoc" @@ -10,6 +12,7 @@ import ( codespacesAPI "github.com/cli/cli/v2/internal/codespaces/api" actionsCmd "github.com/cli/cli/v2/pkg/cmd/actions" aliasCmd "github.com/cli/cli/v2/pkg/cmd/alias" + "github.com/cli/cli/v2/pkg/cmd/alias/shared" apiCmd "github.com/cli/cli/v2/pkg/cmd/api" authCmd "github.com/cli/cli/v2/pkg/cmd/auth" browseCmd "github.com/cli/cli/v2/pkg/cmd/browse" @@ -36,15 +39,29 @@ import ( versionCmd "github.com/cli/cli/v2/pkg/cmd/version" workflowCmd "github.com/cli/cli/v2/pkg/cmd/workflow" "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/google/shlex" "github.com/spf13/cobra" ) -func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command { +type AuthError struct { + err error +} + +func (ae *AuthError) Error() string { + return ae.err.Error() +} + +func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, error) { + io := f.IOStreams + cfg, err := f.Config() + if err != nil { + return nil, fmt.Errorf("failed to read configuration: %s\n", err) + } + cmd := &cobra.Command{ Use: "gh [flags]", Short: "GitHub CLI", Long: `Work seamlessly with GitHub from the command line.`, - Example: heredoc.Doc(` $ gh issue create $ gh repo clone cli/cli @@ -53,6 +70,14 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command { Annotations: map[string]string{ "versionInfo": versionCmd.Format(version, buildDate), }, + PersistentPreRunE: func(cmd *cobra.Command, args []string) error { + // require that the user is authenticated before running most commands + if cmdutil.IsAuthCheckEnabled(cmd) && !cmdutil.CheckAuth(cfg) { + fmt.Fprint(io.ErrOut, authHelp()) + return &AuthError{} + } + return nil + }, } // cmd.SetOut(f.IOStreams.Out) // can't use due to https://github.com/spf13/cobra/issues/1708 @@ -85,6 +110,10 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command { ID: "actions", Title: "GitHub Actions commands", }) + cmd.AddGroup(&cobra.Group{ + ID: "extension", + Title: "Extension commands", + }) // Child commands cmd.AddCommand(versionCmd.NewCmdVersion(f, version, buildDate)) @@ -136,6 +165,51 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command { } } + // Aliases + aliases := cfg.Aliases() + validAliasName := shared.ValidAliasNameFunc(cmd) + validAliasExpansion := shared.ValidAliasExpansionFunc(cmd) + for k, v := range aliases.All() { + aliasName := k + aliasValue := v + if validAliasName(aliasName) && validAliasExpansion(aliasValue) { + split, _ := shlex.Split(aliasName) + parentCmd, parentArgs, _ := cmd.Find(split) + if !parentCmd.ContainsGroup("alias") { + parentCmd.AddGroup(&cobra.Group{ + ID: "alias", + Title: "Alias commands", + }) + } + if strings.HasPrefix(aliasValue, "!") { + shellAliasCmd := NewCmdShellAlias(io, parentArgs[0], aliasValue) + parentCmd.AddCommand(shellAliasCmd) + parentCmd.ValidArgs = append(parentCmd.ValidArgs, fmt.Sprintf("%s\tShell alias", aliasName)) + } else { + aliasCmd := NewCmdAlias(io, parentArgs[0], aliasValue) + split, _ := shlex.Split(aliasValue) + child, _, _ := cmd.Find(split) + aliasCmd.SetUsageFunc(func(_ *cobra.Command) error { + return rootUsageFunc(f.IOStreams.ErrOut, child) + }) + aliasCmd.SetHelpFunc(func(_ *cobra.Command, args []string) { + rootHelpFunc(f, child, args) + }) + parentCmd.AddCommand(aliasCmd) + parentCmd.ValidArgs = append(parentCmd.ValidArgs, fmt.Sprintf("%s\tAlias for %s", aliasName, aliasValue)) + } + } + } + + // Extensions + em := f.ExtensionManager + for _, e := range em.List() { + extension := e + extensionCmd := NewCmdExtension(io, em, e) + cmd.AddCommand(extensionCmd) + cmd.ValidArgs = append(cmd.ValidArgs, fmt.Sprintf("%s\t%s", extension.Name(), extensionCmd.Short)) + } + cmdutil.DisableAuthCheck(cmd) // The reference command produces paged output that displays information on every other command. @@ -145,7 +219,7 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) *cobra.Command { // is special. referenceCmd.Long = stringifyReference(cmd) referenceCmd.SetHelpFunc(longPager(f.IOStreams)) - return cmd + return cmd, nil } func bareHTTPClient(f *cmdutil.Factory, version string) func() (*http.Client, error) { From 4aa31b3f0fd3824f7d4224c722c11089d2e056d0 Mon Sep 17 00:00:00 2001 From: Benjamin Levesque <14175665+benjlevesque@users.noreply.github.com> Date: Fri, 26 May 2023 14:50:20 +0200 Subject: [PATCH 55/90] fix: apply latin matching filter to more fields --- pkg/cmd/pr/shared/survey.go | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/pkg/cmd/pr/shared/survey.go b/pkg/cmd/pr/shared/survey.go index 8582373b0..4ee93e3db 100644 --- a/pkg/cmd/pr/shared/survey.go +++ b/pkg/cmd/pr/shared/survey.go @@ -7,6 +7,7 @@ import ( "github.com/AlecAivazis/survey/v2" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/iostreams" "github.com/cli/cli/v2/pkg/prompt" ) @@ -223,6 +224,7 @@ func MetadataSurvey(io *iostreams.IOStreams, baseRepo ghrepo.Interface, fetcher Message: "Reviewers", Options: reviewers, Default: state.Reviewers, + Filter: prompter.LatinMatchingFilter, }, }) } else { @@ -237,6 +239,7 @@ func MetadataSurvey(io *iostreams.IOStreams, baseRepo ghrepo.Interface, fetcher Message: "Assignees", Options: assignees, Default: state.Assignees, + Filter: prompter.LatinMatchingFilter, }, }) } else { @@ -251,6 +254,7 @@ func MetadataSurvey(io *iostreams.IOStreams, baseRepo ghrepo.Interface, fetcher Message: "Labels", Options: labels, Default: state.Labels, + Filter: prompter.LatinMatchingFilter, }, }) } else { @@ -265,6 +269,7 @@ func MetadataSurvey(io *iostreams.IOStreams, baseRepo ghrepo.Interface, fetcher Message: "Projects", Options: projects, Default: state.Projects, + Filter: prompter.LatinMatchingFilter, }, }) } else { From 8741b648a64fa0ee9f35d794d4a8184ef6cfdec4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Fri, 26 May 2023 16:38:13 +0200 Subject: [PATCH 56/90] Speed up gh start up time (#7487) The tcell library has an `init()` block where it performs some very expensive indexing that takes 30-40 ms on my machine. This results in fixed overhead for every gh invocation, even for commands that don't use tcell at all. This sets an environment variable that instructs tcell to avoid doing that. --- internal/build/build.go | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/internal/build/build.go b/internal/build/build.go index 8c3e78a7e..267315ad2 100644 --- a/internal/build/build.go +++ b/internal/build/build.go @@ -1,6 +1,7 @@ package build import ( + "os" "runtime/debug" ) @@ -16,4 +17,11 @@ func init() { Version = info.Main.Version } } + + // Signal the tcell library to skip its expensive `init` block. This saves 30-40ms in startup + // time for the gh process. The downside is that some Unicode glyphs from user-generated + // content might cause mis-alignment in tcell-enabled views. + // + // https://github.com/gdamore/tcell/commit/2f889d79bd61b1fd2f43372529975a65b792a7ae + _ = os.Setenv("TCELL_MINIMIZE", "1") } From 54560c19dd9406ab5e1a80d44636498aadaf6618 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Fri, 26 May 2023 09:54:28 -0700 Subject: [PATCH 57/90] Add gh cs view command --- internal/codespaces/api/api.go | 36 ++++++++++++- pkg/cmd/codespace/list.go | 2 +- pkg/cmd/codespace/root.go | 1 + pkg/cmd/codespace/view.go | 99 ++++++++++++++++++++++++++++++++++ 4 files changed, 135 insertions(+), 3 deletions(-) create mode 100644 pkg/cmd/codespace/view.go diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index c45eafb87..b6330a59a 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -192,6 +192,13 @@ type Codespace struct { PendingOperationDisabledReason string `json:"pending_operation_disabled_reason"` IdleTimeoutNotice string `json:"idle_timeout_notice"` WebURL string `json:"web_url"` + DevContainerPath string `json:"devcontainer_path"` + Prebuild bool `json:"prebuild"` + Location string `json:"location"` + IdleTimeoutMinutes int `json:"idle_timeout_minutes"` + RetentionExpiresAt string `json:"retention_expires_at"` + RecentFolders []string `json:"recent_folders"` + BillableOwner User `json:"billable_owner"` } type CodespaceGitStatus struct { @@ -230,8 +237,8 @@ type CodespaceConnection struct { HostPublicKeys []string `json:"hostPublicKeys"` } -// CodespaceFields is the list of exportable fields for a codespace. -var CodespaceFields = []string{ +// ListCodespaceFields is the list of exportable fields for a codespace when using the `gh cs list` command. +var ListCodespaceFields = []string{ "displayName", "name", "owner", @@ -244,6 +251,27 @@ var CodespaceFields = []string{ "vscsTarget", } +// ViewCodespaceFields is the list of exportable fields for a codespace when using the `gh cs view` command. +var ViewCodespaceFields = []string{ + "name", + "displayName", + "state", + "owner", + "billableOwner", + "location", + "repository", + "gitStatus", + "devcontainerPath", + "machineName", + "machineDisplayName", + "prebuild", + "createdAt", + "lastUsedAt", + "idleTimeoutMinutes", + "retentionExpiresAt", + "recentFolders", +} + func (c *Codespace) ExportData(fields []string) map[string]interface{} { v := reflect.ValueOf(c).Elem() data := map[string]interface{}{} @@ -256,11 +284,15 @@ func (c *Codespace) ExportData(fields []string) map[string]interface{} { data[f] = c.Repository.FullName case "machineName": data[f] = c.Machine.Name + case "machineDisplayName": + data[f] = c.Machine.DisplayName case "gitStatus": data[f] = map[string]interface{}{ "ref": c.GitStatus.Ref, "hasUnpushedChanges": c.GitStatus.HasUnpushedChanges, "hasUncommittedChanges": c.GitStatus.HasUncommittedChanges, + "ahead": c.GitStatus.Ahead, + "behind": c.GitStatus.Behind, } case "vscsTarget": if c.VSCSTarget != "" && c.VSCSTarget != VSCSTargetProduction { diff --git a/pkg/cmd/codespace/list.go b/pkg/cmd/codespace/list.go index 6b1cd1cc0..bba34ff45 100644 --- a/pkg/cmd/codespace/list.go +++ b/pkg/cmd/codespace/list.go @@ -70,7 +70,7 @@ func newListCmd(app *App) *cobra.Command { listCmd.Flags().StringVarP(&opts.orgName, "org", "o", "", "The `login` handle of the organization to list codespaces for (admin-only)") listCmd.Flags().StringVarP(&opts.userName, "user", "u", "", "The `username` to list codespaces for (used with --org)") - cmdutil.AddJSONFlags(listCmd, &exporter, api.CodespaceFields) + cmdutil.AddJSONFlags(listCmd, &exporter, api.ListCodespaceFields) listCmd.Flags().BoolVarP(&opts.useWeb, "web", "w", false, "List codespaces in the web browser, cannot be used with --user or --org") diff --git a/pkg/cmd/codespace/root.go b/pkg/cmd/codespace/root.go index 8439430aa..28a80edae 100644 --- a/pkg/cmd/codespace/root.go +++ b/pkg/cmd/codespace/root.go @@ -16,6 +16,7 @@ func NewRootCmd(app *App) *cobra.Command { root.AddCommand(newDeleteCmd(app)) root.AddCommand(newJupyterCmd(app)) root.AddCommand(newListCmd(app)) + root.AddCommand(newViewCmd(app)) root.AddCommand(newLogsCmd(app)) root.AddCommand(newPortsCmd(app)) root.AddCommand(newSSHCmd(app)) diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go new file mode 100644 index 000000000..6f83ed89d --- /dev/null +++ b/pkg/cmd/codespace/view.go @@ -0,0 +1,99 @@ +package codespace + +import ( + "context" + "strconv" + "strings" + + "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/utils" + "github.com/spf13/cobra" +) + +type viewOptions struct { + selector *CodespaceSelector +} + +func newViewCmd(app *App) *cobra.Command { + opts := &viewOptions{} + var exporter cmdutil.Exporter + + viewCmd := &cobra.Command{ + Use: "view", + Short: "View details about a codespace", + Args: noArgsConstraint, + RunE: func(cmd *cobra.Command, args []string) error { + return app.ViewCodespace(cmd.Context(), opts, exporter) + }, + } + opts.selector = AddCodespaceSelector(viewCmd, app.apiClient) + cmdutil.AddJSONFlags(viewCmd, &exporter, api.ViewCodespaceFields) + + return viewCmd +} + +func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmdutil.Exporter) error { + selectedCodespace, err := opts.selector.Select(ctx) + if err != nil { + return err + } + + if err := a.io.StartPager(); err != nil { + a.errLogger.Printf("error starting pager: %v", err) + } + defer a.io.StopPager() + + if exporter != nil { + return exporter.Write(a.io, selectedCodespace) + } + + //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter + tp := utils.NewTablePrinter(a.io) + c := codespace{selectedCodespace} + formattedName := formatNameForVSCSTarget(c.Name, c.VSCSTarget) + + // Create an array of fields to display in the table with their values + fields := []struct { + name string + value string + }{ + {"Name", formattedName}, + {"Display Name", c.DisplayName}, + {"State", c.State}, + {"Machine Name", c.Machine.Name}, + {"Machine Display Name", c.Machine.DisplayName}, + {"Prebuild", strconv.FormatBool(c.Prebuild)}, + {"Owner", c.Owner.Login}, + {"BillableOwner", c.BillableOwner.Login}, + {"Location", c.Location}, + {"Repository", c.Repository.FullName}, + {"Branch", c.GitStatus.Ref}, + {"Devcontainer Path", c.DevContainerPath}, + {"Commits Ahead", strconv.Itoa(c.GitStatus.Ahead)}, + {"Commits Behind", strconv.Itoa(c.GitStatus.Behind)}, + {"Has Uncommitted Changes", strconv.FormatBool(c.GitStatus.HasUncommittedChanges)}, + {"Has Unpushed Changes", strconv.FormatBool(c.GitStatus.HasUnpushedChanges)}, + {"Created At", c.CreatedAt}, + {"Last Used At", c.LastUsedAt}, + {"Idle Timeout Minutes", strconv.Itoa(c.IdleTimeoutMinutes)}, + {"Retention Expires At", c.RetentionExpiresAt}, + {"Recent Folders", strings.Join(c.RecentFolders, ", ")}, + } + + for _, field := range fields { + // Only display the field if it has a value. + if field.value != "" { + tp.AddField(field.name, nil, nil) + tp.AddField(field.value, nil, nil) + tp.EndRow() + } + } + + err = tp.Render() + if err != nil { + return err + } + + return nil +} From 99cd0af8b44b8a82f3b521546fe7aec1043e4970 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Fri, 26 May 2023 15:41:34 -0700 Subject: [PATCH 58/90] Check if running in a codespace --- internal/codespaces/api/api.go | 1 + pkg/cmd/codespace/view.go | 19 +++++++++++++------ 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index b6330a59a..8fdf4f1d3 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -196,6 +196,7 @@ type Codespace struct { Prebuild bool `json:"prebuild"` Location string `json:"location"` IdleTimeoutMinutes int `json:"idle_timeout_minutes"` + RetentionPeriodMinutes int `json:"retention_period_minutes"` RetentionExpiresAt string `json:"retention_expires_at"` RecentFolders []string `json:"recent_folders"` BillableOwner User `json:"billable_owner"` diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go index 6f83ed89d..28d490251 100644 --- a/pkg/cmd/codespace/view.go +++ b/pkg/cmd/codespace/view.go @@ -2,8 +2,9 @@ package codespace import ( "context" + "fmt" + "os" "strconv" - "strings" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/cli/cli/v2/pkg/cmdutil" @@ -34,6 +35,10 @@ func newViewCmd(app *App) *cobra.Command { } func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmdutil.Exporter) error { + if codespaceName := os.Getenv("CODESPACES_NAME"); os.Getenv("CODESPACES") == "true" && codespaceName != "" { + opts.selector.codespaceName = codespaceName + } + selectedCodespace, err := opts.selector.Select(ctx) if err != nil { return err @@ -70,15 +75,12 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmd {"Repository", c.Repository.FullName}, {"Branch", c.GitStatus.Ref}, {"Devcontainer Path", c.DevContainerPath}, - {"Commits Ahead", strconv.Itoa(c.GitStatus.Ahead)}, - {"Commits Behind", strconv.Itoa(c.GitStatus.Behind)}, - {"Has Uncommitted Changes", strconv.FormatBool(c.GitStatus.HasUncommittedChanges)}, - {"Has Unpushed Changes", strconv.FormatBool(c.GitStatus.HasUnpushedChanges)}, + {"Git Status", formatGitStatus(c)}, {"Created At", c.CreatedAt}, {"Last Used At", c.LastUsedAt}, {"Idle Timeout Minutes", strconv.Itoa(c.IdleTimeoutMinutes)}, + {"Retention Period Days", strconv.Itoa(c.RetentionPeriodMinutes / 1440)}, {"Retention Expires At", c.RetentionExpiresAt}, - {"Recent Folders", strings.Join(c.RecentFolders, ", ")}, } for _, field := range fields { @@ -97,3 +99,8 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmd return nil } + +func formatGitStatus(codespace codespace) string { + branchWithGitStatus := codespace.branchWithGitStatus() + return fmt.Sprintf("%s \u25cf %d\u2193 %d\u2191", branchWithGitStatus, codespace.GitStatus.Behind, codespace.GitStatus.Ahead) +} From f6a5398bf9bcce1efe268655e72789d644a240ae Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Fri, 26 May 2023 22:59:28 +0000 Subject: [PATCH 59/90] Update fields to show --- internal/codespaces/api/api.go | 3 +++ pkg/cmd/codespace/view.go | 20 ++++++-------------- 2 files changed, 9 insertions(+), 14 deletions(-) diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index 8fdf4f1d3..e9388d5ed 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -269,6 +269,7 @@ var ViewCodespaceFields = []string{ "createdAt", "lastUsedAt", "idleTimeoutMinutes", + "retentionPeriodDays", "retentionExpiresAt", "recentFolders", } @@ -287,6 +288,8 @@ func (c *Codespace) ExportData(fields []string) map[string]interface{} { data[f] = c.Machine.Name case "machineDisplayName": data[f] = c.Machine.DisplayName + case "retentionPeriodDays": + data[f] = c.RetentionPeriodMinutes / 1440 case "gitStatus": data[f] = map[string]interface{}{ "ref": c.GitStatus.Ref, diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go index 28d490251..e923c92b4 100644 --- a/pkg/cmd/codespace/view.go +++ b/pkg/cmd/codespace/view.go @@ -35,7 +35,8 @@ func newViewCmd(app *App) *cobra.Command { } func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmdutil.Exporter) error { - if codespaceName := os.Getenv("CODESPACES_NAME"); os.Getenv("CODESPACES") == "true" && codespaceName != "" { + // If we are in a codespace, show the details for it + if codespaceName := os.Getenv("CODESPACE_NAME"); os.Getenv("CODESPACES") == "true" && codespaceName != "" { opts.selector.codespaceName = codespaceName } @@ -66,21 +67,12 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmd {"Name", formattedName}, {"Display Name", c.DisplayName}, {"State", c.State}, - {"Machine Name", c.Machine.Name}, - {"Machine Display Name", c.Machine.DisplayName}, - {"Prebuild", strconv.FormatBool(c.Prebuild)}, - {"Owner", c.Owner.Login}, - {"BillableOwner", c.BillableOwner.Login}, - {"Location", c.Location}, - {"Repository", c.Repository.FullName}, - {"Branch", c.GitStatus.Ref}, - {"Devcontainer Path", c.DevContainerPath}, {"Git Status", formatGitStatus(c)}, + {"Devcontainer Path", c.DevContainerPath}, + {"Machine Display Name", c.Machine.DisplayName}, {"Created At", c.CreatedAt}, - {"Last Used At", c.LastUsedAt}, - {"Idle Timeout Minutes", strconv.Itoa(c.IdleTimeoutMinutes)}, - {"Retention Period Days", strconv.Itoa(c.RetentionPeriodMinutes / 1440)}, - {"Retention Expires At", c.RetentionExpiresAt}, + {"Idle Timeout", strconv.Itoa(c.IdleTimeoutMinutes) + " minutes"}, + {"Retention Period", strconv.Itoa(c.RetentionPeriodMinutes/1440) + " days"}, } for _, field := range fields { From 1c3c402377dfe3f96018f3f0dd65b14c62c99111 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Sun, 28 May 2023 09:27:31 +0900 Subject: [PATCH 60/90] Do not generate docs for aliases (#7497) --- cmd/gen-docs/main.go | 2 +- pkg/cmd/root/help.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/gen-docs/main.go b/cmd/gen-docs/main.go index f3a12ef76..aa5c013ff 100644 --- a/cmd/gen-docs/main.go +++ b/cmd/gen-docs/main.go @@ -49,7 +49,7 @@ func run(args []string) error { IOStreams: ios, Browser: &browser{}, Config: func() (config.Config, error) { - return config.NewBlankConfig(), nil + return config.NewFromString(""), nil }, ExtensionManager: &em{}, }, "", "") diff --git a/pkg/cmd/root/help.go b/pkg/cmd/root/help.go index c33095c1f..860fb22c3 100644 --- a/pkg/cmd/root/help.go +++ b/pkg/cmd/root/help.go @@ -104,7 +104,7 @@ func rootHelpFunc(f *cmdutil.Factory, command *cobra.Command, args []string) { cs := f.IOStreams.ColorScheme() if help, _ := flags.GetBool("help"); !help && !command.Runnable() && len(flags.Args()) > 0 { - nestedSuggestFunc(f.IOStreams.ErrOut, command, strings.Join(flags.Args(), " ")) + nestedSuggestFunc(f.IOStreams.ErrOut, command, flags.Args()[0]) hasFailed = true return } From f6bb2e83efe17b1a4afcaec8cf6e0f069a3ce66e Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 30 May 2023 14:58:16 +0000 Subject: [PATCH 61/90] build(deps): bump github.com/stretchr/testify from 1.8.3 to 1.8.4 Bumps [github.com/stretchr/testify](https://github.com/stretchr/testify) from 1.8.3 to 1.8.4. - [Release notes](https://github.com/stretchr/testify/releases) - [Commits](https://github.com/stretchr/testify/compare/v1.8.3...v1.8.4) --- updated-dependencies: - dependency-name: github.com/stretchr/testify dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 461e2e163..0b9e0e89f 100644 --- a/go.mod +++ b/go.mod @@ -34,7 +34,7 @@ require ( github.com/sourcegraph/jsonrpc2 v0.1.0 github.com/spf13/cobra v1.6.1 github.com/spf13/pflag v1.0.5 - github.com/stretchr/testify v1.8.3 + github.com/stretchr/testify v1.8.4 github.com/zalando/go-keyring v0.2.3 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 golang.org/x/sync v0.1.0 diff --git a/go.sum b/go.sum index e8a4fcfa2..e5104761d 100644 --- a/go.sum +++ b/go.sum @@ -259,8 +259,8 @@ github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= -github.com/stretchr/testify v1.8.3 h1:RP3t2pwF7cMEbC1dqtB6poj3niw/9gnV4Cjg5oW5gtY= -github.com/stretchr/testify v1.8.3/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e h1:BuzhfgfWQbX0dWzYzT1zsORLnHRv3bcRcsaUk0VmXA8= github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e/go.mod h1:/Tnicc6m/lsJE0irFMA0LfIwTBo4QP7A8IfyIv4zZKI= github.com/yuin/goldmark v1.1.25/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= From 3c05c99c83538212e5e22521650fcafb0c6f6ba0 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 30 May 2023 12:20:23 -0700 Subject: [PATCH 62/90] Address comments --- internal/codespaces/api/api.go | 3 ++ pkg/cmd/codespace/view.go | 72 +++++++++++++++++++++++++++------- 2 files changed, 61 insertions(+), 14 deletions(-) diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index e9388d5ed..d66aff065 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -200,6 +200,7 @@ type Codespace struct { RetentionExpiresAt string `json:"retention_expires_at"` RecentFolders []string `json:"recent_folders"` BillableOwner User `json:"billable_owner"` + EnvironmentId string `json:"environment_id"` } type CodespaceGitStatus struct { @@ -272,6 +273,8 @@ var ViewCodespaceFields = []string{ "retentionPeriodDays", "retentionExpiresAt", "recentFolders", + "vscsTarget", + "environmentId", } func (c *Codespace) ExportData(fields []string) map[string]interface{} { diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go index e923c92b4..7a381280d 100644 --- a/pkg/cmd/codespace/view.go +++ b/pkg/cmd/codespace/view.go @@ -4,39 +4,73 @@ import ( "context" "fmt" "os" - "strconv" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) +const ( + minutesInDay = 1440 +) + type viewOptions struct { selector *CodespaceSelector + exporter cmdutil.Exporter + orgName string + userName string } func newViewCmd(app *App) *cobra.Command { opts := &viewOptions{} - var exporter cmdutil.Exporter viewCmd := &cobra.Command{ Use: "view", Short: "View details about a codespace", - Args: noArgsConstraint, + Long: heredoc.Doc(` + View details about a codespace. + + For more fine-grained details, you can add the "--json" flag to view the full list of fields available. + + If this command doesn't provide enough information, you can use the "gh api" command to view the full JSON response: + $ gh api /user/codespaces/ + `), + Example: heredoc.Doc(` + # select a codespace from a list of all codespaces you own + $ gh cs view + + # view the details of a specific codespace + $ gh cs view -c + + # select a codespace from a list of codespaces in a repository + $ gh cs view --repo / + + # select a codespace from a list of codespaces with a specific repository owner + $ gh cs view --repo-owner + + # view the list of all available fields for a codespace + $ gh cs view --json + + # view specific fields for a codespace + $ gh cs view --json displayName,machineDisplayName,state + `), + Args: noArgsConstraint, RunE: func(cmd *cobra.Command, args []string) error { - return app.ViewCodespace(cmd.Context(), opts, exporter) + return app.ViewCodespace(cmd.Context(), opts) }, } opts.selector = AddCodespaceSelector(viewCmd, app.apiClient) - cmdutil.AddJSONFlags(viewCmd, &exporter, api.ViewCodespaceFields) + cmdutil.AddJSONFlags(viewCmd, &opts.exporter, api.ViewCodespaceFields) return viewCmd } -func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmdutil.Exporter) error { - // If we are in a codespace, show the details for it - if codespaceName := os.Getenv("CODESPACE_NAME"); os.Getenv("CODESPACES") == "true" && codespaceName != "" { +func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions) error { + // If we are in a codespace and a codespace name wasn't provided, show the details for the codespace we are connected to + if (os.Getenv("CODESPACES") == "true") && opts.selector.codespaceName == "" { + codespaceName := os.Getenv("CODESPACE_NAME") opts.selector.codespaceName = codespaceName } @@ -50,8 +84,8 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmd } defer a.io.StopPager() - if exporter != nil { - return exporter.Write(a.io, selectedCodespace) + if opts.exporter != nil { + return opts.exporter.Write(a.io, selectedCodespace) } //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter @@ -65,14 +99,14 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmd value string }{ {"Name", formattedName}, - {"Display Name", c.DisplayName}, {"State", c.State}, + {"Repository", c.Repository.FullName}, {"Git Status", formatGitStatus(c)}, {"Devcontainer Path", c.DevContainerPath}, {"Machine Display Name", c.Machine.DisplayName}, + {"Idle Timeout", fmt.Sprintf("%d minutes", c.IdleTimeoutMinutes)}, {"Created At", c.CreatedAt}, - {"Idle Timeout", strconv.Itoa(c.IdleTimeoutMinutes) + " minutes"}, - {"Retention Period", strconv.Itoa(c.RetentionPeriodMinutes/1440) + " days"}, + {"Retention Period", formatRetentionPeriodDays(c)}, } for _, field := range fields { @@ -94,5 +128,15 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions, exporter cmd func formatGitStatus(codespace codespace) string { branchWithGitStatus := codespace.branchWithGitStatus() - return fmt.Sprintf("%s \u25cf %d\u2193 %d\u2191", branchWithGitStatus, codespace.GitStatus.Behind, codespace.GitStatus.Ahead) + // u2193 and u2191 are the unicode arrows for down and up + return fmt.Sprintf("%s - %d\u2193 %d\u2191", branchWithGitStatus, codespace.GitStatus.Behind, codespace.GitStatus.Ahead) +} + +func formatRetentionPeriodDays(codespace codespace) string { + days := codespace.RetentionPeriodMinutes / minutesInDay + if days == 1 { + return "1 day" + } + + return fmt.Sprintf("%d days", days) } From 5b83d5518622f12d7257b595ccbcf590e06420fc Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 30 May 2023 12:45:53 -0700 Subject: [PATCH 63/90] Don't display retention period if 0 days --- pkg/cmd/codespace/view.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go index 7a381280d..4ee43d6da 100644 --- a/pkg/cmd/codespace/view.go +++ b/pkg/cmd/codespace/view.go @@ -134,7 +134,10 @@ func formatGitStatus(codespace codespace) string { func formatRetentionPeriodDays(codespace codespace) string { days := codespace.RetentionPeriodMinutes / minutesInDay - if days == 1 { + // Don't display the retention period if it is 0 days + if days == 0 { + return "" + } else if days == 1 { return "1 day" } From 82650b364b75871594e53ff0c2dc015cb71d60c6 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 30 May 2023 12:53:46 -0700 Subject: [PATCH 64/90] Fix linting error --- pkg/cmd/codespace/view.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go index 4ee43d6da..11f772b71 100644 --- a/pkg/cmd/codespace/view.go +++ b/pkg/cmd/codespace/view.go @@ -19,8 +19,6 @@ const ( type viewOptions struct { selector *CodespaceSelector exporter cmdutil.Exporter - orgName string - userName string } func newViewCmd(app *App) *cobra.Command { From 15e1fa510dc1acd468af91c38750458d5e9ea136 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 30 May 2023 14:19:15 -0700 Subject: [PATCH 65/90] Add test --- pkg/cmd/codespace/view_test.go | 128 +++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 pkg/cmd/codespace/view_test.go diff --git a/pkg/cmd/codespace/view_test.go b/pkg/cmd/codespace/view_test.go new file mode 100644 index 000000000..549a53fc6 --- /dev/null +++ b/pkg/cmd/codespace/view_test.go @@ -0,0 +1,128 @@ +package codespace + +import ( + "context" + "fmt" + "testing" + + "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/pkg/iostreams" +) + +func Test_NewCmdView(t *testing.T) { + type fields struct { + apiClient apiClient + } + tests := []struct { + tName string + codespaceName string + opts *viewOptions + cliArgs []string + wantErr bool + wantStdout string + errMsg string + }{ + { + tName: "selector throws because no terminal found", + opts: &viewOptions{}, + wantErr: true, + errMsg: "choosing codespace: error getting answers: no terminal", + }, + { + tName: "command fails because provided codespace doesn't exist", + codespaceName: "i-dont-exist", + opts: &viewOptions{}, + wantErr: true, + errMsg: "getting full codespace details: codespace not found", + }, + { + tName: "command succeeds because codespace exists (no details)", + codespaceName: "monalisa-cli-cli-abcdef", + opts: &viewOptions{}, + wantErr: false, + wantStdout: "Name\tmonalisa-cli-cli-abcdef\nGit Status\t - 0↓ 0↑\nIdle Timeout\t0 minutes\n", + }, + { + tName: "command succeeds because codespace exists (with details)", + codespaceName: "monalisa-cli-cli-hijklm", + opts: &viewOptions{}, + wantErr: false, + wantStdout: "Name\tmonalisa-cli-cli-hijklm\nGit Status\tmain* - 2↓ 1↑\nIdle Timeout\t30 minutes\nRetention Period\t1 day\n", + }, + } + + for _, tt := range tests { + t.Run(tt.tName, func(t *testing.T) { + ios, _, stdout, _ := iostreams.Test() + a := &App{ + apiClient: testViewApiMock(), + io: ios, + } + selector := &CodespaceSelector{api: a.apiClient, codespaceName: tt.codespaceName} + tt.opts.selector = selector + + var err error + if tt.cliArgs == nil { + if tt.opts.selector == nil { + t.Fatalf("selector must be set in opts if cliArgs are not provided") + } + + err = a.ViewCodespace(context.Background(), tt.opts) + } else { + cmd := newViewCmd(a) + cmd.SilenceUsage = true + cmd.SilenceErrors = true + cmd.SetOut(ios.ErrOut) + cmd.SetErr(ios.ErrOut) + cmd.SetArgs(tt.cliArgs) + _, err = cmd.ExecuteC() + } + + if tt.wantErr { + if err == nil { + t.Error("Edit() expected error, got nil") + } else if err.Error() != tt.errMsg { + t.Errorf("Edit() error = %q, want %q", err, tt.errMsg) + } + } else if err != nil { + t.Errorf("Edit() expected no error, got %v", err) + } + + if out := stdout.String(); out != tt.wantStdout { + t.Errorf("stdout = %q, want %q", out, tt.wantStdout) + } + }) + } +} + +func testViewApiMock() *apiClientMock { + codespaceWithNoDetails := &api.Codespace{ + Name: "monalisa-cli-cli-abcdef", + } + codespaceWithDetails := &api.Codespace{ + Name: "monalisa-cli-cli-hijklm", + GitStatus: api.CodespaceGitStatus{ + Ahead: 1, + Behind: 2, + Ref: "main", + HasUnpushedChanges: true, + HasUncommittedChanges: true, + }, + IdleTimeoutMinutes: 30, + RetentionPeriodMinutes: 1440, + } + return &apiClientMock{ + GetCodespaceFunc: func(_ context.Context, name string, _ bool) (*api.Codespace, error) { + if name == codespaceWithDetails.Name { + return codespaceWithDetails, nil + } else if name == codespaceWithNoDetails.Name { + return codespaceWithNoDetails, nil + } + + return nil, fmt.Errorf("codespace not found") + }, + ListCodespacesFunc: func(ctx context.Context, opts api.ListCodespacesOptions) ([]*api.Codespace, error) { + return []*api.Codespace{codespaceWithNoDetails, codespaceWithDetails}, nil + }, + } +} From 290b802bf7c9e2ceef144e940177520aef2e6191 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 30 May 2023 14:22:12 -0700 Subject: [PATCH 66/90] Remove unused type --- pkg/cmd/codespace/view_test.go | 3 --- 1 file changed, 3 deletions(-) diff --git a/pkg/cmd/codespace/view_test.go b/pkg/cmd/codespace/view_test.go index 549a53fc6..edcfefef6 100644 --- a/pkg/cmd/codespace/view_test.go +++ b/pkg/cmd/codespace/view_test.go @@ -10,9 +10,6 @@ import ( ) func Test_NewCmdView(t *testing.T) { - type fields struct { - apiClient apiClient - } tests := []struct { tName string codespaceName string From e9a0b393c98969cb88e3d4295b617aafd788c268 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Wed, 31 May 2023 11:04:06 +0900 Subject: [PATCH 67/90] Fix flaky test --- pkg/cmd/issue/shared/lookup_test.go | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/pkg/cmd/issue/shared/lookup_test.go b/pkg/cmd/issue/shared/lookup_test.go index 8e1595ebc..694a3fd05 100644 --- a/pkg/cmd/issue/shared/lookup_test.go +++ b/pkg/cmd/issue/shared/lookup_test.go @@ -285,10 +285,8 @@ func TestIssuesFromArgsWithFields(t *testing.T) { return } assert.NoError(t, err) - for i, issue := range issues { - if issue.Number != tt.wantIssues[i] { - t.Errorf("want issue #%d, got #%d", tt.wantIssues[i], issue.Number) - } + for i := range issues { + assert.Contains(t, tt.wantIssues, issues[i].Number) } if repo != nil { repoURL := ghrepo.GenerateRepoURL(repo, "") From 7a814b31c2cb1512d3d93433e510db28d8398a87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Wed, 31 May 2023 20:23:31 +0200 Subject: [PATCH 68/90] api: support array params in GET queries (#7513) --- pkg/cmd/api/http.go | 48 +++++++++++++++++++++++++++------------- pkg/cmd/api/http_test.go | 8 +++++++ 2 files changed, 41 insertions(+), 15 deletions(-) diff --git a/pkg/cmd/api/http.go b/pkg/cmd/api/http.go index 30a493130..652d11d81 100644 --- a/pkg/cmd/api/http.go +++ b/pkg/cmd/api/http.go @@ -103,21 +103,8 @@ func addQuery(path string, params map[string]interface{}) string { } query := url.Values{} - for key, value := range params { - switch v := value.(type) { - case string: - query.Add(key, v) - case []byte: - query.Add(key, string(v)) - case nil: - query.Add(key, "") - case int: - query.Add(key, fmt.Sprintf("%d", v)) - case bool: - query.Add(key, fmt.Sprintf("%v", v)) - default: - panic(fmt.Sprintf("unknown type %v", v)) - } + if err := addQueryParam(query, "", params); err != nil { + panic(err) } sep := "?" @@ -126,3 +113,34 @@ func addQuery(path string, params map[string]interface{}) string { } return path + sep + query.Encode() } + +func addQueryParam(query url.Values, key string, value interface{}) error { + switch v := value.(type) { + case string: + query.Add(key, v) + case []byte: + query.Add(key, string(v)) + case nil: + query.Add(key, "") + case int: + query.Add(key, fmt.Sprintf("%d", v)) + case bool: + query.Add(key, fmt.Sprintf("%v", v)) + case map[string]interface{}: + for subkey, value := range v { + // support for nested subkeys can be added here if that is ever necessary + if err := addQueryParam(query, subkey, value); err != nil { + return err + } + } + case []interface{}: + for _, entry := range v { + if err := addQueryParam(query, key+"[]", entry); err != nil { + return err + } + } + default: + return fmt.Errorf("unknown type %v", v) + } + return nil +} diff --git a/pkg/cmd/api/http_test.go b/pkg/cmd/api/http_test.go index 9f0e7d6c3..11294a2e5 100644 --- a/pkg/cmd/api/http_test.go +++ b/pkg/cmd/api/http_test.go @@ -322,6 +322,14 @@ func Test_addQuery(t *testing.T) { }, want: "?a=hello", }, + { + name: "array", + args: args{ + path: "", + params: map[string]interface{}{"a": []interface{}{"hello", "world"}}, + }, + want: "?a%5B%5D=hello&a%5B%5D=world", + }, { name: "append", args: args{ From e4e7bf5c8c47454f276e75773ef820c060cc3b5f Mon Sep 17 00:00:00 2001 From: ffalor <35144141+ffalor@users.noreply.github.com> Date: Thu, 1 Jun 2023 08:54:56 -0500 Subject: [PATCH 69/90] force method to uppercase (#7514) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Mislav Marohnić --- pkg/cmd/api/http.go | 2 +- pkg/cmd/api/http_test.go | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/api/http.go b/pkg/cmd/api/http.go index 652d11d81..3d6bb240e 100644 --- a/pkg/cmd/api/http.go +++ b/pkg/cmd/api/http.go @@ -50,7 +50,7 @@ func httpRequest(client *http.Client, hostname string, method string, p string, return nil, fmt.Errorf("unrecognized parameters type: %v", params) } - req, err := http.NewRequest(method, requestURL, body) + req, err := http.NewRequest(strings.ToUpper(method), requestURL, body) if err != nil { return nil, err } diff --git a/pkg/cmd/api/http_test.go b/pkg/cmd/api/http_test.go index 11294a2e5..f63566490 100644 --- a/pkg/cmd/api/http_test.go +++ b/pkg/cmd/api/http_test.go @@ -129,6 +129,24 @@ func Test_httpRequest(t *testing.T) { headers: "", }, }, + { + name: "lowercase HTTP method", + args: args{ + client: &httpClient, + host: "github.com", + method: "get", + p: "repos/octocat/spoon-knife", + params: nil, + headers: []string{}, + }, + wantErr: false, + want: expects{ + method: "GET", + u: "https://api.github.com/repos/octocat/spoon-knife", + body: "", + headers: "", + }, + }, { name: "GET with leading slash", args: args{ From dfb6d9d5bb4289a0f8c3413395fca61b6a7dd617 Mon Sep 17 00:00:00 2001 From: srz_zumix Date: Fri, 2 Jun 2023 08:20:11 +0900 Subject: [PATCH 70/90] fix: Allow aliases to recognize extended commands (#7523) --- pkg/cmd/root/root.go | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/pkg/cmd/root/root.go b/pkg/cmd/root/root.go index 5a79e8aeb..17e4180e3 100644 --- a/pkg/cmd/root/root.go +++ b/pkg/cmd/root/root.go @@ -165,6 +165,15 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, } } + // Extensions + em := f.ExtensionManager + for _, e := range em.List() { + extension := e + extensionCmd := NewCmdExtension(io, em, e) + cmd.AddCommand(extensionCmd) + cmd.ValidArgs = append(cmd.ValidArgs, fmt.Sprintf("%s\t%s", extension.Name(), extensionCmd.Short)) + } + // Aliases aliases := cfg.Aliases() validAliasName := shared.ValidAliasNameFunc(cmd) @@ -201,15 +210,6 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, } } - // Extensions - em := f.ExtensionManager - for _, e := range em.List() { - extension := e - extensionCmd := NewCmdExtension(io, em, e) - cmd.AddCommand(extensionCmd) - cmd.ValidArgs = append(cmd.ValidArgs, fmt.Sprintf("%s\t%s", extension.Name(), extensionCmd.Short)) - } - cmdutil.DisableAuthCheck(cmd) // The reference command produces paged output that displays information on every other command. From e3569dc7bde3a6812e529b64d4e2643897533742 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Fri, 2 Jun 2023 13:31:02 +0200 Subject: [PATCH 71/90] Fix bash completions for extensions and aliases Now that extensions and alises are real Cobra Command instances, they will appear in completions automatically and don't need to be additionally inserted via ValidArgs. Their addition to ValidArgs have caused all extensions and aliases to be listed twice within completion results, which didn't seem to affect zsh completions at all, but in bash completions it had caused the completion description to be a part of the expansion. --- pkg/cmd/root/root.go | 4 ---- 1 file changed, 4 deletions(-) diff --git a/pkg/cmd/root/root.go b/pkg/cmd/root/root.go index 17e4180e3..437063d77 100644 --- a/pkg/cmd/root/root.go +++ b/pkg/cmd/root/root.go @@ -168,10 +168,8 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, // Extensions em := f.ExtensionManager for _, e := range em.List() { - extension := e extensionCmd := NewCmdExtension(io, em, e) cmd.AddCommand(extensionCmd) - cmd.ValidArgs = append(cmd.ValidArgs, fmt.Sprintf("%s\t%s", extension.Name(), extensionCmd.Short)) } // Aliases @@ -193,7 +191,6 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, if strings.HasPrefix(aliasValue, "!") { shellAliasCmd := NewCmdShellAlias(io, parentArgs[0], aliasValue) parentCmd.AddCommand(shellAliasCmd) - parentCmd.ValidArgs = append(parentCmd.ValidArgs, fmt.Sprintf("%s\tShell alias", aliasName)) } else { aliasCmd := NewCmdAlias(io, parentArgs[0], aliasValue) split, _ := shlex.Split(aliasValue) @@ -205,7 +202,6 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, rootHelpFunc(f, child, args) }) parentCmd.AddCommand(aliasCmd) - parentCmd.ValidArgs = append(parentCmd.ValidArgs, fmt.Sprintf("%s\tAlias for %s", aliasName, aliasValue)) } } } From 2d3047c7e32443a0bff94065e25e8dab7050f4e3 Mon Sep 17 00:00:00 2001 From: William Martin Date: Fri, 2 Jun 2023 13:40:53 +0200 Subject: [PATCH 72/90] Support viewing logs for jobs with composite actions --- pkg/cmd/run/view/fixtures/run_log.zip | Bin 1120 -> 2437 bytes pkg/cmd/run/view/view.go | 19 +++++++++++++++--- pkg/cmd/run/view/view_test.go | 27 ++++++++++++++++++++++---- 3 files changed, 39 insertions(+), 7 deletions(-) diff --git a/pkg/cmd/run/view/fixtures/run_log.zip b/pkg/cmd/run/view/fixtures/run_log.zip index 270310e374c4d3dad97c93984ef8d832cbda6ff4..5b0bb1e306642f9633f9c1b7d41ba4e665dab0e6 100644 GIT binary patch literal 2437 zcmWIWW@Zs#0D%k4ok3s*l;C7gU`Wo-&r!(APtp$!;bmawY{^dmVUzIkl+p@r21b^z zj0_B5?Ezq8I2bq>6t{K2jZp*|C5>#1VSHMCl0r#FszOp?QI%dvMG4qo`y7a&SPVXW z(m(vf$ur)e22V~k8ukkKBy7202^~ z(Q^ro4=%|sN(DzO%#&Cm_U#PYEM`N2*84fzA_|mamR{lH+1Hr!=1?i$go@A3T!)(q z6?WXxJMOpSjPja79>1p(_VBmyhe>(f_K;%S@bmOx5e^2a9Ut5BGbP+Zwp2bbjBaj*WIkkcel@8_cSTpQtkcxIhKx%6%AU2;!YtS)uFyL+roH1;yD>W$ zuXAMo!&9QCe(pbV@>e{^$M%g?g_~zQUaerUXwFu{<97{S9#LKJ>G+}7j{8BnUn?mb zS^5K|A62_JlY!aneabp$jpO^{$#7m#M$C@s+ZL)766L-0d|0}ad;Z7nR0Ger$zUx3`k z&cWSrz`_*h8jy=1ZUr(J0+6y7h|d9ZYjI)YAR&EfC^U_SkgEJmlc!+Ajn_H1p%lag@GlF zvP?Mqg+0e($qleD1f>d)UC0?3RJ6drlE!jo2I>_wFl#}^Bj;}rA5==fz*|RU76y23 z2gerPG6NA?AXAZJ3pI&nBAH4?83J=YDAYhD1a6C-Az4I5c@f~v$_5GxE+FIq8kNin G;sF3)wQcMG literal 1120 zcmWIWW@h1H0D+6u9YJ6Ql;C8LVMxx;&r!(APtp$!;bdUuY{^dm;nE6j21b^zj0_Ac zB0$9fKqEjj2ZK^xN07jyl57x95s0OcjWCQ)%TH1$$w*a5N-V0 z=;@RG;U`X>@eVb3a;nj=SHLG(56L1)d=?qSgDe2s1hf%ukrB`$7UC^}1WEwVBA`d$ zfCK2G;=~k0n9Km0Iv0p>h6%_7^e};$U=&|iT3P`MlQg(fL54nP#xN9rnE2wc$Pg4H zX<&;$Ho`5MM2ba>OmfV)l8OX0gajDgI)a!;35OMua4-T0WE`$!12GPmz!;V^IwKp0 zEfE1N03{+k7GNe9WDC|HTYxR`04)F|9;_DNN+!qwA`0{fEXqSefTn@s7prNI@W4zm x$j%K%G7W12B5VO>QbD%h0Fnh*6AsV7yxCj_Y(jB diff --git a/pkg/cmd/run/view/view.go b/pkg/cmd/run/view/view.go index 87ed9b4fa..6b96c90f8 100644 --- a/pkg/cmd/run/view/view.go +++ b/pkg/cmd/run/view/view.go @@ -12,6 +12,7 @@ import ( "regexp" "sort" "strconv" + "strings" "time" "github.com/MakeNowJust/heredoc" @@ -284,7 +285,7 @@ func runView(opts *ViewOptions) error { } defer runLogZip.Close() - attachRunLog(runLogZip, jobs) + attachRunLog(&runLogZip.Reader, jobs) return displayRunLog(opts.IO.Out, jobs, opts.LogFailed) } @@ -480,7 +481,19 @@ func promptForJob(prompter shared.Prompter, cs *iostreams.ColorScheme, jobs []sh } func logFilenameRegexp(job shared.Job, step shared.Step) *regexp.Regexp { - re := fmt.Sprintf(`%s\/%d_.*\.txt`, regexp.QuoteMeta(job.Name), step.Number) + // As described in https://github.com/cli/cli/issues/5011#issuecomment-1570713070, there are a number of steps + // the server can take when producing the downloaded zip file that can result in a mismatch between the job name + // and the filename in the zip including: + // * Removing characters in the job name that aren't allowed in file paths + // * Truncating names that are too long for zip files + // * Adding collision deduplicating numbers for jobs with the same name + // + // We are hesitant to duplicate all the server logic due to the fragility but while we explore our options, it + // is sensible to fix the issue that is unavoidable for users, that when a job uses a composite action, the server + // constructs a job name by constructing a job name of ` / `. This means that logs will + // never be found for jobs that use composite actions. + sanitizedJobName := strings.ReplaceAll(job.Name, "/", "") + re := fmt.Sprintf(`%s\/%d_.*\.txt`, regexp.QuoteMeta(sanitizedJobName), step.Number) return regexp.MustCompile(re) } @@ -500,7 +513,7 @@ func logFilenameRegexp(job shared.Job, step shared.Step) *regexp.Regexp { // It iterates through the list of jobs and tries to find the matching // log in the zip file. If the matching log is found it is attached // to the job. -func attachRunLog(rlz *zip.ReadCloser, jobs []shared.Job) { +func attachRunLog(rlz *zip.Reader, jobs []shared.Job) { for i, job := range jobs { for j, step := range job.Steps { re := logFilenameRegexp(job, step) diff --git a/pkg/cmd/run/view/view_test.go b/pkg/cmd/run/view/view_test.go index be9e0554d..3d4fc4cf0 100644 --- a/pkg/cmd/run/view/view_test.go +++ b/pkg/cmd/run/view/view_test.go @@ -20,6 +20,7 @@ import ( "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" ) func TestNewCmdView(t *testing.T) { @@ -1381,18 +1382,36 @@ func Test_attachRunLog(t *testing.T) { }, wantMatch: false, }, + { + name: "job name with forward slash matches dir with slash removed", + job: shared.Job{ + Name: "cool job / with slash", + Steps: []shared.Step{{ + Name: "fob the barz", + Number: 1, + }}, + }, + wantMatch: true, + // not the double space in the dir name, as the slash has been removed + wantFilename: "cool job with slash/1_fob the barz.txt", + }, } - rlz, _ := zip.OpenReader("./fixtures/run_log.zip") + + rlz, err := zip.OpenReader("./fixtures/run_log.zip") + require.NoError(t, err) defer rlz.Close() + for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - attachRunLog(rlz, []shared.Job{tt.job}) + + attachRunLog(&rlz.Reader, []shared.Job{tt.job}) + for _, step := range tt.job.Steps { log := step.Log logPresent := log != nil - assert.Equal(t, tt.wantMatch, logPresent) + require.Equal(t, tt.wantMatch, logPresent) if logPresent { - assert.Equal(t, tt.wantFilename, log.Name) + require.Equal(t, tt.wantFilename, log.Name) } } }) From 3859dfaa037cbad323c93c4b4f1dde29c1462063 Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 5 Jun 2023 16:02:27 +0200 Subject: [PATCH 73/90] Improve docs around run rerun job flag (#7527) --- pkg/cmd/run/rerun/rerun.go | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/run/rerun/rerun.go b/pkg/cmd/run/rerun/rerun.go index b640f41f7..56580c642 100644 --- a/pkg/cmd/run/rerun/rerun.go +++ b/pkg/cmd/run/rerun/rerun.go @@ -8,6 +8,7 @@ import ( "io" "net/http" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/run/shared" @@ -39,8 +40,19 @@ func NewCmdRerun(f *cmdutil.Factory, runF func(*RerunOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "rerun []", - Short: "Rerun a failed run", - Args: cobra.MaximumNArgs(1), + Short: "Rerun a run", + Long: heredoc.Docf(` + Rerun an entire run, only failed jobs, or a specific job from a run. + + Note that due for historical reasons, the %[1]s--job%[1]s flag may not take what you expect. + Specifically, when navigating to a job in the browser, the URL looks like this: + %[1]shttps://github.com///actions/runs//jobs/%[1]s. + + However, this %[1]snumber%[1]s should not be used with the %[1]s--job%[1]s flag and will result in the + API returning %[1]s404 NOT FOUND%[1]s. Instead, you can get the correct job IDs using the following command: + %[1]sgh run view --json jobs --jq '.jobs[] | {name, databaseId}'%[1]s. + `, "`"), + Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { // support `-R, --repo` override opts.BaseRepo = f.BaseRepo From 9ccd098eb0664f80d4ea9fd2a4d400c381203531 Mon Sep 17 00:00:00 2001 From: Kousik Mitra Date: Mon, 5 Jun 2023 22:07:04 +0530 Subject: [PATCH 74/90] Add gist selector option to gist edit command --- pkg/cmd/gist/edit/edit.go | 45 ++++++++----- pkg/cmd/gist/shared/shared.go | 57 ++++++++++++++++ pkg/cmd/gist/shared/shared_test.go | 100 +++++++++++++++++++++++++++++ pkg/cmd/gist/view/view.go | 60 ++--------------- pkg/cmd/gist/view/view_test.go | 94 --------------------------- 5 files changed, 190 insertions(+), 166 deletions(-) diff --git a/pkg/cmd/gist/edit/edit.go b/pkg/cmd/gist/edit/edit.go index 773ea41df..bbe62d80b 100644 --- a/pkg/cmd/gist/edit/edit.go +++ b/pkg/cmd/gist/edit/edit.go @@ -55,16 +55,15 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman Use: "edit { | } []", Short: "Edit one of your gists", Args: func(cmd *cobra.Command, args []string) error { - if len(args) < 1 { - return cmdutil.FlagErrorf("cannot edit: gist argument required") - } if len(args) > 2 { return cmdutil.FlagErrorf("too many arguments") } return nil }, RunE: func(c *cobra.Command, args []string) error { - opts.Selector = args[0] + if len(args) > 0 { + opts.Selector = args[0] + } if len(args) > 1 { opts.SourceFile = args[1] } @@ -85,7 +84,33 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman } func editRun(opts *EditOptions) error { + client, err := opts.HttpClient() + if err != nil { + return err + } + + cfg, err := opts.Config() + if err != nil { + return err + } + + host, _ := cfg.Authentication().DefaultHost() + gistID := opts.Selector + if gistID == "" { + cs := opts.IO.ColorScheme() + if gistID == "" { + gistID, err = shared.PromptGists(client, host, cs) + if err != nil { + return err + } + + if gistID == "" { + fmt.Fprintln(opts.IO.Out, "No gists found.") + return nil + } + } + } if strings.Contains(gistID, "/") { id, err := shared.GistIDFromURL(gistID) @@ -95,20 +120,8 @@ func editRun(opts *EditOptions) error { gistID = id } - client, err := opts.HttpClient() - if err != nil { - return err - } - apiClient := api.NewClientFromHTTP(client) - cfg, err := opts.Config() - if err != nil { - return err - } - - host, _ := cfg.Authentication().DefaultHost() - gist, err := shared.GetGist(client, host, gistID) if err != nil { if errors.Is(err, shared.NotFoundErr) { diff --git a/pkg/cmd/gist/shared/shared.go b/pkg/cmd/gist/shared/shared.go index 52c86caa7..547140838 100644 --- a/pkg/cmd/gist/shared/shared.go +++ b/pkg/cmd/gist/shared/shared.go @@ -5,10 +5,15 @@ import ( "fmt" "net/http" "net/url" + "sort" "strings" "time" + "github.com/AlecAivazis/survey/v2" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/text" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/cli/v2/pkg/prompt" "github.com/gabriel-vasile/mimetype" "github.com/shurcooL/githubv4" ) @@ -171,3 +176,55 @@ func IsBinaryContents(contents []byte) bool { } return isBinary } + +func PromptGists(client *http.Client, host string, cs *iostreams.ColorScheme) (gistID string, err error) { + gists, err := ListGists(client, host, 10, "all") + if err != nil { + return "", err + } + + if len(gists) == 0 { + return "", nil + } + + var opts []string + var result int + var gistIDs = make([]string, len(gists)) + + for i, gist := range gists { + gistIDs[i] = gist.ID + description := "" + gistName := "" + + if gist.Description != "" { + description = gist.Description + } + + filenames := make([]string, 0, len(gist.Files)) + for fn := range gist.Files { + filenames = append(filenames, fn) + } + sort.Strings(filenames) + gistName = filenames[0] + + gistTime := text.FuzzyAgo(time.Now(), gist.UpdatedAt) + // TODO: support dynamic maxWidth + description = text.Truncate(100, text.RemoveExcessiveWhitespace(description)) + opt := fmt.Sprintf("%s %s %s", cs.Bold(gistName), description, cs.Gray(gistTime)) + opts = append(opts, opt) + } + + questions := &survey.Select{ + Message: "Select a gist", + Options: opts, + } + + //nolint:staticcheck // SA1019: prompt.SurveyAskOne is deprecated: use Prompter + err = prompt.SurveyAskOne(questions, &result) + + if err != nil { + return "", err + } + + return gistIDs[result], nil +} diff --git a/pkg/cmd/gist/shared/shared_test.go b/pkg/cmd/gist/shared/shared_test.go index c55cbea67..0811464e5 100644 --- a/pkg/cmd/gist/shared/shared_test.go +++ b/pkg/cmd/gist/shared/shared_test.go @@ -1,8 +1,14 @@ package shared import ( + "fmt" + "net/http" "testing" + "time" + "github.com/cli/cli/v2/pkg/httpmock" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/cli/v2/pkg/prompt" "github.com/stretchr/testify/assert" ) @@ -85,3 +91,97 @@ func TestIsBinaryContents(t *testing.T) { assert.Equal(t, tt.want, IsBinaryContents(tt.fileContent)) } } + +func TestPromptGists(t *testing.T) { + tests := []struct { + name string + askStubs func(as *prompt.AskStubber) + response string + wantOut string + gist *Gist + wantErr bool + }{ + { + name: "multiple files, select first gist", + askStubs: func(as *prompt.AskStubber) { + as.StubPrompt("Select a gist").AnswerWith("cool.txt about 6 hours ago") + }, + response: `{ "data": { "viewer": { "gists": { "nodes": [ + { + "name": "gistid1", + "files": [{ "name": "cool.txt" }], + "description": "", + "updatedAt": "%[1]v", + "isPublic": true + }, + { + "name": "gistid2", + "files": [{ "name": "gistfile0.txt" }], + "description": "", + "updatedAt": "%[1]v", + "isPublic": true + } + ] } } } }`, + wantOut: "gistid1", + }, + { + name: "multiple files, select second gist", + askStubs: func(as *prompt.AskStubber) { + as.StubPrompt("Select a gist").AnswerWith("gistfile0.txt about 6 hours ago") + }, + response: `{ "data": { "viewer": { "gists": { "nodes": [ + { + "name": "gistid1", + "files": [{ "name": "cool.txt" }], + "description": "", + "updatedAt": "%[1]v", + "isPublic": true + }, + { + "name": "gistid2", + "files": [{ "name": "gistfile0.txt" }], + "description": "", + "updatedAt": "%[1]v", + "isPublic": true + } + ] } } } }`, + wantOut: "gistid2", + }, + { + name: "no files", + response: `{ "data": { "viewer": { "gists": { "nodes": [] } } } }`, + wantOut: "", + }, + } + + ios, _, _, _ := iostreams.Test() + + for _, tt := range tests { + reg := &httpmock.Registry{} + + const query = `query GistList\b` + sixHours, _ := time.ParseDuration("6h") + sixHoursAgo := time.Now().Add(-sixHours) + reg.Register( + httpmock.GraphQL(query), + httpmock.StringResponse(fmt.Sprintf( + tt.response, + sixHoursAgo.Format(time.RFC3339), + )), + ) + client := &http.Client{Transport: reg} + + t.Run(tt.name, func(t *testing.T) { + //nolint:staticcheck // SA1019: prompt.NewAskStubber is deprecated: use PrompterMock + as := prompt.NewAskStubber(t) + if tt.askStubs != nil { + tt.askStubs(as) + } + + gistID, err := PromptGists(client, "github.com", ios.ColorScheme()) + assert.NoError(t, err) + assert.Equal(t, tt.wantOut, gistID) + reg.Verify(t) + }) + } +} diff --git a/pkg/cmd/gist/view/view.go b/pkg/cmd/gist/view/view.go index 545681522..ffc5d54a9 100644 --- a/pkg/cmd/gist/view/view.go +++ b/pkg/cmd/gist/view/view.go @@ -5,17 +5,15 @@ import ( "net/http" "sort" "strings" - "time" - "github.com/AlecAivazis/survey/v2" "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/internal/ghinstance" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/cli/cli/v2/pkg/markdown" - "github.com/cli/cli/v2/pkg/prompt" "github.com/spf13/cobra" ) @@ -28,6 +26,7 @@ type ViewOptions struct { Config func() (config.Config, error) HttpClient func() (*http.Client, error) Browser browser + Prompter prompter.Prompter Selector string Filename string @@ -42,6 +41,7 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman Config: f.Config, HttpClient: f.HttpClient, Browser: f.Browser, + Prompter: f.Prompter, } cmd := &cobra.Command{ @@ -89,7 +89,7 @@ func viewRun(opts *ViewOptions) error { cs := opts.IO.ColorScheme() if gistID == "" { - gistID, err = promptGists(client, hostname, cs) + gistID, err = shared.PromptGists(client, hostname, cs) if err != nil { return err } @@ -204,55 +204,3 @@ func viewRun(opts *ViewOptions) error { return nil } - -func promptGists(client *http.Client, host string, cs *iostreams.ColorScheme) (gistID string, err error) { - gists, err := shared.ListGists(client, host, 10, "all") - if err != nil { - return "", err - } - - if len(gists) == 0 { - return "", nil - } - - var opts []string - var result int - var gistIDs = make([]string, len(gists)) - - for i, gist := range gists { - gistIDs[i] = gist.ID - description := "" - gistName := "" - - if gist.Description != "" { - description = gist.Description - } - - filenames := make([]string, 0, len(gist.Files)) - for fn := range gist.Files { - filenames = append(filenames, fn) - } - sort.Strings(filenames) - gistName = filenames[0] - - gistTime := text.FuzzyAgo(time.Now(), gist.UpdatedAt) - // TODO: support dynamic maxWidth - description = text.Truncate(100, text.RemoveExcessiveWhitespace(description)) - opt := fmt.Sprintf("%s %s %s", cs.Bold(gistName), description, cs.Gray(gistTime)) - opts = append(opts, opt) - } - - questions := &survey.Select{ - Message: "Select a gist", - Options: opts, - } - - //nolint:staticcheck // SA1019: prompt.SurveyAskOne is deprecated: use Prompter - err = prompt.SurveyAskOne(questions, &result) - - if err != nil { - return "", err - } - - return gistIDs[result], nil -} diff --git a/pkg/cmd/gist/view/view_test.go b/pkg/cmd/gist/view/view_test.go index 8dbc9a748..49cf878ec 100644 --- a/pkg/cmd/gist/view/view_test.go +++ b/pkg/cmd/gist/view/view_test.go @@ -389,97 +389,3 @@ func Test_viewRun(t *testing.T) { }) } } - -func Test_promptGists(t *testing.T) { - tests := []struct { - name string - askStubs func(as *prompt.AskStubber) - response string - wantOut string - gist *shared.Gist - wantErr bool - }{ - { - name: "multiple files, select first gist", - askStubs: func(as *prompt.AskStubber) { - as.StubPrompt("Select a gist").AnswerWith("cool.txt about 6 hours ago") - }, - response: `{ "data": { "viewer": { "gists": { "nodes": [ - { - "name": "gistid1", - "files": [{ "name": "cool.txt" }], - "description": "", - "updatedAt": "%[1]v", - "isPublic": true - }, - { - "name": "gistid2", - "files": [{ "name": "gistfile0.txt" }], - "description": "", - "updatedAt": "%[1]v", - "isPublic": true - } - ] } } } }`, - wantOut: "gistid1", - }, - { - name: "multiple files, select second gist", - askStubs: func(as *prompt.AskStubber) { - as.StubPrompt("Select a gist").AnswerWith("gistfile0.txt about 6 hours ago") - }, - response: `{ "data": { "viewer": { "gists": { "nodes": [ - { - "name": "gistid1", - "files": [{ "name": "cool.txt" }], - "description": "", - "updatedAt": "%[1]v", - "isPublic": true - }, - { - "name": "gistid2", - "files": [{ "name": "gistfile0.txt" }], - "description": "", - "updatedAt": "%[1]v", - "isPublic": true - } - ] } } } }`, - wantOut: "gistid2", - }, - { - name: "no files", - response: `{ "data": { "viewer": { "gists": { "nodes": [] } } } }`, - wantOut: "", - }, - } - - ios, _, _, _ := iostreams.Test() - - for _, tt := range tests { - reg := &httpmock.Registry{} - - const query = `query GistList\b` - sixHours, _ := time.ParseDuration("6h") - sixHoursAgo := time.Now().Add(-sixHours) - reg.Register( - httpmock.GraphQL(query), - httpmock.StringResponse(fmt.Sprintf( - tt.response, - sixHoursAgo.Format(time.RFC3339), - )), - ) - client := &http.Client{Transport: reg} - - t.Run(tt.name, func(t *testing.T) { - //nolint:staticcheck // SA1019: prompt.NewAskStubber is deprecated: use PrompterMock - as := prompt.NewAskStubber(t) - if tt.askStubs != nil { - tt.askStubs(as) - } - - gistID, err := promptGists(client, "github.com", ios.ColorScheme()) - assert.NoError(t, err) - assert.Equal(t, tt.wantOut, gistID) - reg.Verify(t) - }) - } -} From 31209bcf896a029bda027d11f1102c4c463ee3e0 Mon Sep 17 00:00:00 2001 From: Kousik Mitra Date: Mon, 5 Jun 2023 22:48:21 +0530 Subject: [PATCH 75/90] Replace SurveyAskOne with Prompter --- pkg/cmd/gist/edit/edit.go | 30 ++++++---------- pkg/cmd/gist/edit/edit_test.go | 56 +++++++++++++++++++----------- pkg/cmd/gist/shared/shared.go | 14 ++------ pkg/cmd/gist/shared/shared_test.go | 39 +++++++++++++-------- pkg/cmd/gist/view/view.go | 2 +- pkg/cmd/gist/view/view_test.go | 18 +++++----- 6 files changed, 84 insertions(+), 75 deletions(-) diff --git a/pkg/cmd/gist/edit/edit.go b/pkg/cmd/gist/edit/edit.go index bbe62d80b..3ad28b6c4 100644 --- a/pkg/cmd/gist/edit/edit.go +++ b/pkg/cmd/gist/edit/edit.go @@ -12,21 +12,23 @@ import ( "sort" "strings" - "github.com/AlecAivazis/survey/v2" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/gist/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/prompt" "github.com/cli/cli/v2/pkg/surveyext" "github.com/spf13/cobra" ) +var editNextOptions = []string{"Edit another file", "Submit", "Cancel"} + type EditOptions struct { IO *iostreams.IOStreams HttpClient func() (*http.Client, error) Config func() (config.Config, error) + Prompter prompter.Prompter Edit func(string, string, string, *iostreams.IOStreams) (string, error) @@ -42,6 +44,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman IO: f.IOStreams, HttpClient: f.HttpClient, Config: f.Config, + Prompter: f.Prompter, Edit: func(editorCmd, filename, defaultContent string, io *iostreams.IOStreams) (string, error) { return surveyext.Edit( editorCmd, @@ -100,7 +103,7 @@ func editRun(opts *EditOptions) error { if gistID == "" { cs := opts.IO.ColorScheme() if gistID == "" { - gistID, err = shared.PromptGists(client, host, cs) + gistID, err = shared.PromptGists(opts.Prompter, client, host, cs) if err != nil { return err } @@ -202,15 +205,11 @@ func editRun(opts *EditOptions) error { if !opts.IO.CanPrompt() { return errors.New("unsure what file to edit; either specify --filename or run interactively") } - //nolint:staticcheck // SA1019: prompt.SurveyAskOne is deprecated: use Prompter - err = prompt.SurveyAskOne(&survey.Select{ - Message: "Edit which file?", - Options: candidates, - }, &filename) - + result, err := opts.Prompter.Select("Edit which file?", "", candidates) if err != nil { return fmt.Errorf("could not prompt: %w", err) } + filename = candidates[result] } } @@ -262,20 +261,11 @@ func editRun(opts *EditOptions) error { } choice := "" - - //nolint:staticcheck // SA1019: prompt.SurveyAskOne is deprecated: use Prompter - err = prompt.SurveyAskOne(&survey.Select{ - Message: "What next?", - Options: []string{ - "Edit another file", - "Submit", - "Cancel", - }, - }, &choice) - + result, err := opts.Prompter.Select("What next?", "", editNextOptions) if err != nil { return fmt.Errorf("could not prompt: %w", err) } + choice = editNextOptions[result] stop := false diff --git a/pkg/cmd/gist/edit/edit_test.go b/pkg/cmd/gist/edit/edit_test.go index 33223ddee..5e52a8ffb 100644 --- a/pkg/cmd/gist/edit/edit_test.go +++ b/pkg/cmd/gist/edit/edit_test.go @@ -10,11 +10,11 @@ import ( "testing" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/gist/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" "github.com/stretchr/testify/require" @@ -115,15 +115,15 @@ func Test_editRun(t *testing.T) { require.NoError(t, err) tests := []struct { - name string - opts *EditOptions - gist *shared.Gist - httpStubs func(*httpmock.Registry) - askStubs func(*prompt.AskStubber) - nontty bool - stdin string - wantErr string - wantParams map[string]interface{} + name string + opts *EditOptions + gist *shared.Gist + httpStubs func(*httpmock.Registry) + prompterStubs func(*prompter.MockPrompter) + nontty bool + stdin string + wantErr string + wantParams map[string]interface{} }{ { name: "no such gist", @@ -161,9 +161,17 @@ func Test_editRun(t *testing.T) { }, { name: "multiple files, submit", - askStubs: func(as *prompt.AskStubber) { - as.StubPrompt("Edit which file?").AnswerWith("unix.md") - as.StubPrompt("What next?").AnswerWith("Submit") + prompterStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Edit which file?", + []string{"cicada.txt", "unix.md"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "unix.md") + }) + pm.RegisterSelect("What next?", + editNextOptions, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "Submit") + }) }, gist: &shared.Gist{ ID: "1234", @@ -206,9 +214,17 @@ func Test_editRun(t *testing.T) { }, { name: "multiple files, cancel", - askStubs: func(as *prompt.AskStubber) { - as.StubPrompt("Edit which file?").AnswerWith("unix.md") - as.StubPrompt("What next?").AnswerWith("Cancel") + prompterStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Edit which file?", + []string{"cicada.txt", "unix.md"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "unix.md") + }) + pm.RegisterSelect("What next?", + editNextOptions, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "Cancel") + }) }, wantErr: "CancelError", gist: &shared.Gist{ @@ -486,11 +502,11 @@ func Test_editRun(t *testing.T) { } t.Run(tt.name, func(t *testing.T) { - //nolint:staticcheck // SA1019: prompt.NewAskStubber is deprecated: use PrompterMock - as := prompt.NewAskStubber(t) - if tt.askStubs != nil { - tt.askStubs(as) + pm := prompter.NewMockPrompter(t) + if tt.prompterStubs != nil { + tt.prompterStubs(pm) } + tt.opts.Prompter = pm err := editRun(tt.opts) reg.Verify(t) diff --git a/pkg/cmd/gist/shared/shared.go b/pkg/cmd/gist/shared/shared.go index 547140838..66ba6fe0a 100644 --- a/pkg/cmd/gist/shared/shared.go +++ b/pkg/cmd/gist/shared/shared.go @@ -9,11 +9,10 @@ import ( "strings" "time" - "github.com/AlecAivazis/survey/v2" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/prompt" "github.com/gabriel-vasile/mimetype" "github.com/shurcooL/githubv4" ) @@ -177,7 +176,7 @@ func IsBinaryContents(contents []byte) bool { return isBinary } -func PromptGists(client *http.Client, host string, cs *iostreams.ColorScheme) (gistID string, err error) { +func PromptGists(prompter prompter.Prompter, client *http.Client, host string, cs *iostreams.ColorScheme) (gistID string, err error) { gists, err := ListGists(client, host, 10, "all") if err != nil { return "", err @@ -188,7 +187,6 @@ func PromptGists(client *http.Client, host string, cs *iostreams.ColorScheme) (g } var opts []string - var result int var gistIDs = make([]string, len(gists)) for i, gist := range gists { @@ -214,13 +212,7 @@ func PromptGists(client *http.Client, host string, cs *iostreams.ColorScheme) (g opts = append(opts, opt) } - questions := &survey.Select{ - Message: "Select a gist", - Options: opts, - } - - //nolint:staticcheck // SA1019: prompt.SurveyAskOne is deprecated: use Prompter - err = prompt.SurveyAskOne(questions, &result) + result, err := prompter.Select("Select a gist", "", opts) if err != nil { return "", err diff --git a/pkg/cmd/gist/shared/shared_test.go b/pkg/cmd/gist/shared/shared_test.go index 0811464e5..1ec66d156 100644 --- a/pkg/cmd/gist/shared/shared_test.go +++ b/pkg/cmd/gist/shared/shared_test.go @@ -6,9 +6,9 @@ import ( "testing" "time" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/prompt" "github.com/stretchr/testify/assert" ) @@ -94,17 +94,21 @@ func TestIsBinaryContents(t *testing.T) { func TestPromptGists(t *testing.T) { tests := []struct { - name string - askStubs func(as *prompt.AskStubber) - response string - wantOut string - gist *Gist - wantErr bool + name string + prompterStubs func(pm *prompter.MockPrompter) + response string + wantOut string + gist *Gist + wantErr bool }{ { name: "multiple files, select first gist", - askStubs: func(as *prompt.AskStubber) { - as.StubPrompt("Select a gist").AnswerWith("cool.txt about 6 hours ago") + prompterStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a gist", + []string{"cool.txt about 6 hours ago", "gistfile0.txt about 6 hours ago"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "cool.txt about 6 hours ago") + }) }, response: `{ "data": { "viewer": { "gists": { "nodes": [ { @@ -126,8 +130,12 @@ func TestPromptGists(t *testing.T) { }, { name: "multiple files, select second gist", - askStubs: func(as *prompt.AskStubber) { - as.StubPrompt("Select a gist").AnswerWith("gistfile0.txt about 6 hours ago") + prompterStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a gist", + []string{"cool.txt about 6 hours ago", "gistfile0.txt about 6 hours ago"}, + func(_, _ string, opts []string) (int, error) { + return prompter.IndexFor(opts, "gistfile0.txt about 6 hours ago") + }) }, response: `{ "data": { "viewer": { "gists": { "nodes": [ { @@ -173,12 +181,13 @@ func TestPromptGists(t *testing.T) { t.Run(tt.name, func(t *testing.T) { //nolint:staticcheck // SA1019: prompt.NewAskStubber is deprecated: use PrompterMock - as := prompt.NewAskStubber(t) - if tt.askStubs != nil { - tt.askStubs(as) + + mockPrompter := prompter.NewMockPrompter(t) + if tt.prompterStubs != nil { + tt.prompterStubs(mockPrompter) } - gistID, err := PromptGists(client, "github.com", ios.ColorScheme()) + gistID, err := PromptGists(mockPrompter, client, "github.com", ios.ColorScheme()) assert.NoError(t, err) assert.Equal(t, tt.wantOut, gistID) reg.Verify(t) diff --git a/pkg/cmd/gist/view/view.go b/pkg/cmd/gist/view/view.go index ffc5d54a9..e4f5c84e1 100644 --- a/pkg/cmd/gist/view/view.go +++ b/pkg/cmd/gist/view/view.go @@ -89,7 +89,7 @@ func viewRun(opts *ViewOptions) error { cs := opts.IO.ColorScheme() if gistID == "" { - gistID, err = shared.PromptGists(client, hostname, cs) + gistID, err = shared.PromptGists(opts.Prompter, client, hostname, cs) if err != nil { return err } diff --git a/pkg/cmd/gist/view/view_test.go b/pkg/cmd/gist/view/view_test.go index 49cf878ec..c571422c5 100644 --- a/pkg/cmd/gist/view/view_test.go +++ b/pkg/cmd/gist/view/view_test.go @@ -8,11 +8,11 @@ import ( "time" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/prompter" "github.com/cli/cli/v2/pkg/cmd/gist/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" ) @@ -336,6 +336,10 @@ func Test_viewRun(t *testing.T) { httpmock.JSONResponse(tt.gist)) } + if tt.opts == nil { + tt.opts = &ViewOptions{} + } + if tt.mockGistList { sixHours, _ := time.ParseDuration("6h") sixHoursAgo := time.Now().Add(-sixHours) @@ -355,13 +359,11 @@ func Test_viewRun(t *testing.T) { )), ) - //nolint:staticcheck // SA1019: prompt.NewAskStubber is deprecated: use PrompterMock - as := prompt.NewAskStubber(t) - as.StubPrompt("Select a gist").AnswerDefault() - } - - if tt.opts == nil { - tt.opts = &ViewOptions{} + pm := prompter.NewMockPrompter(t) + pm.RegisterSelect("Select a gist", []string{"cool.txt about 6 hours ago"}, func(_, _ string, opts []string) (int, error) { + return 0, nil + }) + tt.opts.Prompter = pm } tt.opts.HttpClient = func() (*http.Client, error) { From 895487127c4f4256b9eeeea4cdf36dd899e6fea9 Mon Sep 17 00:00:00 2001 From: Kousik Mitra Date: Mon, 5 Jun 2023 22:54:35 +0530 Subject: [PATCH 76/90] Remove unused linter flag --- pkg/cmd/gist/shared/shared_test.go | 2 -- 1 file changed, 2 deletions(-) diff --git a/pkg/cmd/gist/shared/shared_test.go b/pkg/cmd/gist/shared/shared_test.go index 1ec66d156..4d185ff7d 100644 --- a/pkg/cmd/gist/shared/shared_test.go +++ b/pkg/cmd/gist/shared/shared_test.go @@ -180,8 +180,6 @@ func TestPromptGists(t *testing.T) { client := &http.Client{Transport: reg} t.Run(tt.name, func(t *testing.T) { - //nolint:staticcheck // SA1019: prompt.NewAskStubber is deprecated: use PrompterMock - mockPrompter := prompter.NewMockPrompter(t) if tt.prompterStubs != nil { tt.prompterStubs(mockPrompter) From ca02aec13b8b9ac66f7aa03bb4a0875d3e41c290 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 7 Jun 2023 12:58:02 +0200 Subject: [PATCH 77/90] Change site deployment ssh key to PAT --- .github/workflows/deployment.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index c2dad891e..40c62836b 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -218,7 +218,7 @@ jobs: repository: github/cli.github.com path: site fetch-depth: 0 - ssh-key: ${{ secrets.SITE_SSH_KEY }} + token: ${{ secrets.SITE_DEPLOY_PAT }} - name: Update site man pages env: GIT_COMMITTER_NAME: cli automation From bd46f923bd59d294f3fcc6474c97457ead621d46 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 7 Jun 2023 13:27:23 +0200 Subject: [PATCH 78/90] Use homebrew fork in cli org and update token --- .github/workflows/deployment.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index 40c62836b..3974737aa 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -341,5 +341,6 @@ jobs: with: formula-name: gh tag-name: ${{ inputs.tag_name }} + push-to: cli/homebrew-core env: - COMMITTER_TOKEN: ${{ secrets.UPLOAD_GITHUB_TOKEN }} + COMMITTER_TOKEN: ${{ secrets.HOMEBREW_PR_PAT }} From 86e4281fc7ddd544af3400e9a61ac59d2415bc11 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 7 Jun 2023 14:58:43 +0000 Subject: [PATCH 79/90] build(deps): bump github.com/cli/go-gh/v2 from 2.0.0 to 2.0.1 Bumps [github.com/cli/go-gh/v2](https://github.com/cli/go-gh) from 2.0.0 to 2.0.1. - [Release notes](https://github.com/cli/go-gh/releases) - [Commits](https://github.com/cli/go-gh/compare/v2.0.0...v2.0.1) --- updated-dependencies: - dependency-name: github.com/cli/go-gh/v2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 8 ++++---- go.sum | 17 ++++++++--------- 2 files changed, 12 insertions(+), 13 deletions(-) diff --git a/go.mod b/go.mod index 0b9e0e89f..39c41efa6 100644 --- a/go.mod +++ b/go.mod @@ -9,7 +9,7 @@ require ( github.com/cenkalti/backoff/v4 v4.2.1 github.com/charmbracelet/glamour v0.5.1-0.20220727184942-e70ff2d969da github.com/charmbracelet/lipgloss v0.5.0 - github.com/cli/go-gh/v2 v2.0.0 + github.com/cli/go-gh/v2 v2.0.1 github.com/cli/oauth v1.0.1 github.com/cli/safeexec v1.0.1 github.com/cpuguy83/go-md2man/v2 v2.0.2 @@ -61,8 +61,8 @@ require ( github.com/gorilla/css v1.0.0 // indirect github.com/hashicorp/errwrap v1.0.0 // indirect github.com/inconshreveable/mousetrap v1.0.1 // indirect - github.com/itchyny/gojq v0.12.8 // indirect - github.com/itchyny/timefmt-go v0.1.3 // indirect + github.com/itchyny/gojq v0.12.13 // indirect + github.com/itchyny/timefmt-go v0.1.5 // indirect github.com/lucasb-eyer/go-colorful v1.2.0 // indirect github.com/mattn/go-runewidth v0.0.14 // indirect github.com/microcosm-cc/bluemonday v1.0.20 // indirect @@ -70,7 +70,7 @@ require ( github.com/muesli/termenv v0.12.0 // indirect github.com/olekukonko/tablewriter v0.0.5 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect - github.com/rivo/uniseg v0.4.2 // indirect + github.com/rivo/uniseg v0.4.4 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/shurcooL/graphql v0.0.0-20220606043923-3cf50f8a0a29 // indirect github.com/stretchr/objx v0.5.0 // indirect diff --git a/go.sum b/go.sum index e5104761d..81d281bc5 100644 --- a/go.sum +++ b/go.sum @@ -62,8 +62,8 @@ github.com/cli/browser v1.2.0 h1:yvU7e9qf97kZqGFX6n2zJPHsmSObY9ske+iCvKelvXg= github.com/cli/browser v1.2.0/go.mod h1:xFFnXLVcAyW9ni0cuo6NnrbCP75JxJ0RO7VtCBiH/oI= github.com/cli/crypto v0.0.0-20210929142629-6be313f59b03 h1:3f4uHLfWx4/WlnMPXGai03eoWAI+oGHJwr+5OXfxCr8= github.com/cli/crypto v0.0.0-20210929142629-6be313f59b03/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= -github.com/cli/go-gh/v2 v2.0.0 h1:JAgQY7VNHletsO0Eqr+/PzF7fF5QEjhY2t2+Tev3vmk= -github.com/cli/go-gh/v2 v2.0.0/go.mod h1:2/ox3Dnc8wDBT5bnTAH1aKGy6Qt1ztlFBe10EufnvoA= +github.com/cli/go-gh/v2 v2.0.1 h1:W4L7C5xT9CwkcqTsUzBhFhRKGpek9oRtdDLku2Hku+E= +github.com/cli/go-gh/v2 v2.0.1/go.mod h1:zWab1jRnJ0Ug8qRjsZHFk/Oq51ZWuhSxRL2FDUDgQWk= github.com/cli/oauth v1.0.1 h1:pXnTFl/qUegXHK531Dv0LNjW4mLx626eS42gnzfXJPA= github.com/cli/oauth v1.0.1/go.mod h1:qd/FX8ZBD6n1sVNQO3aIdRxeu5LGw9WhKnYhIIoC2A4= github.com/cli/safeexec v1.0.0/go.mod h1:Z/D4tTN8Vs5gXYHDCbaM1S/anmEDnJb1iW0+EJ5zx3Q= @@ -138,7 +138,6 @@ github.com/google/go-cmp v0.4.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/ github.com/google/go-cmp v0.4.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.0/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= -github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE= github.com/google/go-cmp v0.5.9 h1:O2Tfq5qg4qc4AmwVlvv0oLiVAGB7enBSJ2x2DqQFi38= github.com/google/go-cmp v0.5.9/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY= @@ -175,10 +174,10 @@ github.com/hinshun/vt10x v0.0.0-20220119200601-820417d04eec/go.mod h1:Q48J4R4Dvx github.com/ianlancetaylor/demangle v0.0.0-20181102032728-5e5cf60278f6/go.mod h1:aSSvb/t6k1mPoxDqO4vJh6VOCGPwU4O0C2/Eqndh1Sc= github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc= github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= -github.com/itchyny/gojq v0.12.8 h1:Zxcwq8w4IeR8JJYEtoG2MWJZUv0RGY6QqJcO1cqV8+A= -github.com/itchyny/gojq v0.12.8/go.mod h1:gE2kZ9fVRU0+JAksaTzjIlgnCa2akU+a1V0WXgJQN5c= -github.com/itchyny/timefmt-go v0.1.3 h1:7M3LGVDsqcd0VZH2U+x393obrzZisp7C0uEe921iRkU= -github.com/itchyny/timefmt-go v0.1.3/go.mod h1:0osSSCQSASBJMsIZnhAaF1C2fCBTJZXrnj37mG8/c+A= +github.com/itchyny/gojq v0.12.13 h1:IxyYlHYIlspQHHTE0f3cJF0NKDMfajxViuhBLnHd/QU= +github.com/itchyny/gojq v0.12.13/go.mod h1:JzwzAqenfhrPUuwbmEz3nu3JQmFLlQTQMUcOdnu/Sf4= +github.com/itchyny/timefmt-go v0.1.5 h1:G0INE2la8S6ru/ZI5JecgyzbbJNs5lG1RcBqa7Jm6GE= +github.com/itchyny/timefmt-go v0.1.5/go.mod h1:nEP7L+2YmAbT2kZ2HfSs1d8Xtw9LY8D2stDBckWakZ8= github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0= github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4= github.com/jstemmer/go-junit-report v0.0.0-20190106144839-af01ea7f8024/go.mod h1:6v2b51hI/fHJwM22ozAgKL4VKDeJcHhJFhtBdhmNjmU= @@ -235,8 +234,8 @@ github.com/rivo/tview v0.0.0-20221029100920-c4a7e501810d h1:jKIUJdMcIVGOSHi6LSqJ github.com/rivo/tview v0.0.0-20221029100920-c4a7e501810d/go.mod h1:YX2wUZOcJGOIycErz2s9KvDaP0jnWwRCirQMPLPpQ+Y= github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= -github.com/rivo/uniseg v0.4.2 h1:YwD0ulJSJytLpiaWua0sBDusfsCZohxjxzVTYjwxfV8= -github.com/rivo/uniseg v0.4.2/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis= +github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= From acf7dadaeb892daaadf8b1fbe674413e9a233741 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 6 Jun 2023 10:50:28 -0700 Subject: [PATCH 80/90] Codespaces view command updates --- pkg/cmd/codespace/view.go | 38 +++++++++++++--------------------- pkg/cmd/codespace/view_test.go | 10 +++++++-- 2 files changed, 22 insertions(+), 26 deletions(-) diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go index 11f772b71..7fe4ae313 100644 --- a/pkg/cmd/codespace/view.go +++ b/pkg/cmd/codespace/view.go @@ -7,8 +7,9 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -27,26 +28,12 @@ func newViewCmd(app *App) *cobra.Command { viewCmd := &cobra.Command{ Use: "view", Short: "View details about a codespace", - Long: heredoc.Doc(` - View details about a codespace. - - For more fine-grained details, you can add the "--json" flag to view the full list of fields available. - - If this command doesn't provide enough information, you can use the "gh api" command to view the full JSON response: - $ gh api /user/codespaces/ - `), Example: heredoc.Doc(` # select a codespace from a list of all codespaces you own $ gh cs view # view the details of a specific codespace - $ gh cs view -c - - # select a codespace from a list of codespaces in a repository - $ gh cs view --repo / - - # select a codespace from a list of codespaces with a specific repository owner - $ gh cs view --repo-owner + $ gh cs view -c codespace-name-12345 # view the list of all available fields for a codespace $ gh cs view --json @@ -86,8 +73,7 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions) error { return opts.exporter.Write(a.io, selectedCodespace) } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(a.io) + tp := tableprinter.New(a.io) c := codespace{selectedCodespace} formattedName := formatNameForVSCSTarget(c.Name, c.VSCSTarget) @@ -108,10 +94,10 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions) error { } for _, field := range fields { - // Only display the field if it has a value. - if field.value != "" { - tp.AddField(field.name, nil, nil) - tp.AddField(field.value, nil, nil) + // Don't display the field if it is empty and we are printing to a TTY + if !a.io.IsStdoutTTY() || field.value != "" { + tp.AddField(field.name) + tp.AddField(field.value) tp.EndRow() } } @@ -126,8 +112,12 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions) error { func formatGitStatus(codespace codespace) string { branchWithGitStatus := codespace.branchWithGitStatus() - // u2193 and u2191 are the unicode arrows for down and up - return fmt.Sprintf("%s - %d\u2193 %d\u2191", branchWithGitStatus, codespace.GitStatus.Behind, codespace.GitStatus.Ahead) + + // Format the commits ahead/behind with proper pluralization + commitsAhead := text.Pluralize(codespace.GitStatus.Ahead, "commit") + commitsBehind := text.Pluralize(codespace.GitStatus.Behind, "commit") + + return fmt.Sprintf("%s - %s ahead, %s behind", branchWithGitStatus, commitsAhead, commitsBehind) } func formatRetentionPeriodDays(codespace codespace) string { diff --git a/pkg/cmd/codespace/view_test.go b/pkg/cmd/codespace/view_test.go index edcfefef6..bba487232 100644 --- a/pkg/cmd/codespace/view_test.go +++ b/pkg/cmd/codespace/view_test.go @@ -37,14 +37,14 @@ func Test_NewCmdView(t *testing.T) { codespaceName: "monalisa-cli-cli-abcdef", opts: &viewOptions{}, wantErr: false, - wantStdout: "Name\tmonalisa-cli-cli-abcdef\nGit Status\t - 0↓ 0↑\nIdle Timeout\t0 minutes\n", + wantStdout: "Name\tmonalisa-cli-cli-abcdef\nState\t\nRepository\t\nGit Status\t - 0 commits ahead, 0 commits behind\nDevcontainer Path\t\nMachine Display Name\t\nIdle Timeout\t0 minutes\nCreated At\t\nRetention Period\t\n", }, { tName: "command succeeds because codespace exists (with details)", codespaceName: "monalisa-cli-cli-hijklm", opts: &viewOptions{}, wantErr: false, - wantStdout: "Name\tmonalisa-cli-cli-hijklm\nGit Status\tmain* - 2↓ 1↑\nIdle Timeout\t30 minutes\nRetention Period\t1 day\n", + wantStdout: "Name\tmonalisa-cli-cli-hijklm\nState\tAvailable\nRepository\tcli/cli\nGit Status\tmain* - 1 commit ahead, 2 commits behind\nDevcontainer Path\t.devcontainer/devcontainer.json\nMachine Display Name\tTest Display Name\nIdle Timeout\t30 minutes\nCreated At\t\nRetention Period\t1 day\n", }, } @@ -107,6 +107,12 @@ func testViewApiMock() *apiClientMock { }, IdleTimeoutMinutes: 30, RetentionPeriodMinutes: 1440, + State: "Available", + Repository: api.Repository{FullName: "cli/cli"}, + DevContainerPath: ".devcontainer/devcontainer.json", + Machine: api.CodespaceMachine{ + DisplayName: "Test Display Name", + }, } return &apiClientMock{ GetCodespaceFunc: func(_ context.Context, name string, _ bool) (*api.Codespace, error) { From a0843e5d84ed248bffef06055de4ea595b2d4ffe Mon Sep 17 00:00:00 2001 From: lerocknrolla <136076674+lerocknrolla@users.noreply.github.com> Date: Fri, 9 Jun 2023 12:31:56 +0100 Subject: [PATCH 81/90] fixed a type "affect" should have been "effect" --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 38c44c788..9ffc6d720 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ For more information, see [Linux & BSD installation](./docs/install_linux.md). | `winget install --id GitHub.cli` | `winget upgrade --id GitHub.cli` | > **Note** -> The Windows installer modifies your PATH. When using Windows Terminal, you will need to **open a new window** for the changes to take affect. (Simply opening a new tab will _not_ be sufficient.) +> The Windows installer modifies your PATH. When using Windows Terminal, you will need to **open a new window** for the changes to take effect. (Simply opening a new tab will _not_ be sufficient.) #### scoop From 94a6312eaf7ed115e5be708bfaaa6fbe638d75fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Fri, 9 Jun 2023 17:36:19 +0200 Subject: [PATCH 82/90] :nail_care: json export --- pkg/cmd/search/code/code.go | 25 ++++++++------- pkg/cmd/search/code/code_test.go | 8 ++--- pkg/search/result.go | 22 ++++++++----- pkg/search/result_test.go | 7 ++--- pkg/search/searcher_test.go | 54 ++++++++++++++++++++------------ 5 files changed, 68 insertions(+), 48 deletions(-) diff --git a/pkg/cmd/search/code/code.go b/pkg/cmd/search/code/code.go index e79b371f6..39f9d2f0c 100644 --- a/pkg/cmd/search/code/code.go +++ b/pkg/cmd/search/code/code.go @@ -31,18 +31,17 @@ func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Comman } cmd := &cobra.Command{ - Use: "code []", - Short: "Search for code", + Use: "code ", + Short: "Search within code", Long: heredoc.Doc(` - Search for code on GitHub. + Search within code in GitHub repositories. - The command supports constructing queries using the GitHub search syntax, - using the parameter and qualifier flags, or a combination of the two. - - At least one search term is required when searching code. - - GitHub search syntax is documented at: + The search syntax is documented at: + + Note that these search results are powered by what is now a legacy GitHub code search engine. + The results might not match what is seen on GitHub.com, and new features like regex search + are not yet available via the GitHub API. `), Example: heredoc.Doc(` # search code matching "react" and "lifecycle" @@ -57,7 +56,7 @@ func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Comman # search code matching "cli" in repositories owned by microsoft organization $ gh search code cli --owner=microsoft - # search code matching "panic" in cli repository + # search code matching "panic" in the GitHub CLI repository $ gh search code panic --repo cli/cli # search code matching keyword "lint" in package.json files @@ -105,6 +104,8 @@ func NewCmdCode(f *cmdutil.Factory, runF func(*CodeOptions) error) *cobra.Comman func codeRun(opts *CodeOptions) error { io := opts.IO if opts.WebMode { + // FIXME: convert legacy `filename` and `extension` ES qualifiers to Blackbird's `path` qualifier + // when opening web search, otherwise the Blackbird search UI will complain. url := opts.Searcher.URL(opts.Query) if io.IsStdoutTTY() { fmt.Fprintf(io.ErrOut, "Opening %s in your browser.\n", text.DisplayURL(url)) @@ -140,7 +141,7 @@ func displayResults(io *iostreams.IOStreams, results search.CodeResult) error { if i > 0 { fmt.Fprint(io.Out, "\n") } - fmt.Fprintf(io.Out, "%s %s\n", cs.Blue(code.Repo.FullName), cs.GreenBold(code.Path)) + fmt.Fprintf(io.Out, "%s %s\n", cs.Blue(code.Repository.FullName), cs.GreenBold(code.Path)) for _, match := range code.TextMatches { lines := formatMatch(match.Fragment, match.Matches, io.ColorEnabled()) for _, line := range lines { @@ -154,7 +155,7 @@ func displayResults(io *iostreams.IOStreams, results search.CodeResult) error { for _, match := range code.TextMatches { lines := formatMatch(match.Fragment, match.Matches, io.ColorEnabled()) for _, line := range lines { - fmt.Fprintf(io.Out, "%s:%s: %s\n", cs.Blue(code.Repo.FullName), cs.GreenBold(code.Path), strings.TrimSpace(line)) + fmt.Fprintf(io.Out, "%s:%s: %s\n", cs.Blue(code.Repository.FullName), cs.GreenBold(code.Path), strings.TrimSpace(line)) } } } diff --git a/pkg/cmd/search/code/code_test.go b/pkg/cmd/search/code/code_test.go index fc950ffcb..253bd2889 100644 --- a/pkg/cmd/search/code/code_test.go +++ b/pkg/cmd/search/code/code_test.go @@ -159,7 +159,7 @@ func TestCodeRun(t *testing.T) { { Name: "context.go", Path: "context/context.go", - Repo: search.Repository{ + Repository: search.Repository{ FullName: "cli/cli", }, TextMatches: []search.TextMatch{ @@ -181,7 +181,7 @@ func TestCodeRun(t *testing.T) { { Name: "pr.go", Path: "pkg/cmd/pr/pr.go", - Repo: search.Repository{ + Repository: search.Repository{ FullName: "cli/cli", }, TextMatches: []search.TextMatch{ @@ -218,7 +218,7 @@ func TestCodeRun(t *testing.T) { { Name: "context.go", Path: "context/context.go", - Repo: search.Repository{ + Repository: search.Repository{ FullName: "cli/cli", }, TextMatches: []search.TextMatch{ @@ -240,7 +240,7 @@ func TestCodeRun(t *testing.T) { { Name: "pr.go", Path: "pkg/cmd/pr/pr.go", - Repo: search.Repository{ + Repository: search.Repository{ FullName: "cli/cli", }, TextMatches: []search.TextMatch{ diff --git a/pkg/search/result.go b/pkg/search/result.go index cfd78ccf1..de00001db 100644 --- a/pkg/search/result.go +++ b/pkg/search/result.go @@ -1,13 +1,13 @@ package search import ( + "encoding/json" "reflect" "strings" "time" ) var CodeFields = []string{ - "name", "path", "repository", "sha", @@ -15,10 +15,9 @@ var CodeFields = []string{ "url", } -var TextMatchFields = []string{ +var textMatchFields = []string{ "fragment", "matches", - "url", "type", "property", } @@ -116,7 +115,7 @@ type IssuesResult struct { type Code struct { Name string `json:"name"` Path string `json:"path"` - Repo Repository `json:"repository"` + Repository Repository `json:"repository"` Sha string `json:"sha"` TextMatches []TextMatch `json:"text_matches"` URL string `json:"html_url"` @@ -125,7 +124,6 @@ type Code struct { type TextMatch struct { Fragment string `json:"fragment"` Matches []Match `json:"matches"` - URL string `json:"object_url"` Type string `json:"object_type"` Property string `json:"property"` } @@ -280,12 +278,10 @@ func (code Code) ExportData(fields []string) map[string]interface{} { data := map[string]interface{}{} for _, f := range fields { switch f { - case "repository": - data[f] = code.Repo.ExportData(RepositoryFields) case "textMatches": matches := make([]interface{}, 0, len(code.TextMatches)) for _, match := range code.TextMatches { - matches = append(matches, match.ExportData(TextMatchFields)) + matches = append(matches, match.ExportData(textMatchFields)) } data[f] = matches default: @@ -385,6 +381,16 @@ func (repo Repository) ExportData(fields []string) map[string]interface{} { return data } +func (repo Repository) MarshalJSON() ([]byte, error) { + return json.Marshal(map[string]interface{}{ + "id": repo.ID, + "nameWithOwner": repo.FullName, + "url": repo.URL, + "isPrivate": repo.IsPrivate, + "isFork": repo.IsFork, + }) +} + // The state of an issue or a pull request, may be either open or closed. // For a pull request, the "merged" state is inferred from a value for merged_at and // which we take return instead of the "closed" state. diff --git a/pkg/search/result_test.go b/pkg/search/result_test.go index 930b80351..3d9fb67b3 100644 --- a/pkg/search/result_test.go +++ b/pkg/search/result_test.go @@ -20,9 +20,9 @@ func TestCodeExportData(t *testing.T) { }{ { name: "exports requested fields", - fields: []string{"name", "path", "textMatches"}, + fields: []string{"path", "textMatches"}, code: Code{ - Repo: Repository{ + Repository: Repository{ Name: "repo", }, Path: "path", @@ -41,11 +41,10 @@ func TestCodeExportData(t *testing.T) { }, Property: "property", Type: "type", - URL: "url", }, }, }, - output: `{"name":"name","path":"path","textMatches":[{"fragment":"fragment","matches":[{"indices":[0,1],"text":"fr"}],"property":"property","type":"type","url":"url"}]}`, + output: `{"path":"path","textMatches":[{"fragment":"fragment","matches":[{"indices":[0,1],"text":"fr"}],"property":"property","type":"type"}]}`, }, } for _, tt := range tests { diff --git a/pkg/search/searcher_test.go b/pkg/search/searcher_test.go index e0c41cfca..8642feed0 100644 --- a/pkg/search/searcher_test.go +++ b/pkg/search/searcher_test.go @@ -358,10 +358,14 @@ func TestSearcherRepositories(t *testing.T) { httpStubs: func(reg *httpmock.Registry) { reg.Register( httpmock.QueryMatcher("GET", "search/repositories", values), - httpmock.JSONResponse(RepositoriesResult{ - IncompleteResults: false, - Items: []Repository{{Name: "test"}}, - Total: 1, + httpmock.JSONResponse(map[string]interface{}{ + "incomplete_results": false, + "total_count": 1, + "items": []interface{}{ + map[string]interface{}{ + "name": "test", + }, + }, }), ) }, @@ -378,10 +382,14 @@ func TestSearcherRepositories(t *testing.T) { httpStubs: func(reg *httpmock.Registry) { reg.Register( httpmock.QueryMatcher("GET", "api/v3/search/repositories", values), - httpmock.JSONResponse(RepositoriesResult{ - IncompleteResults: false, - Items: []Repository{{Name: "test"}}, - Total: 1, + httpmock.JSONResponse(map[string]interface{}{ + "incomplete_results": false, + "total_count": 1, + "items": []interface{}{ + map[string]interface{}{ + "name": "test", + }, + }, }), ) }, @@ -396,12 +404,15 @@ func TestSearcherRepositories(t *testing.T) { }, httpStubs: func(reg *httpmock.Registry) { firstReq := httpmock.QueryMatcher("GET", "search/repositories", values) - firstRes := httpmock.JSONResponse(RepositoriesResult{ - IncompleteResults: false, - Items: []Repository{{Name: "test"}}, - Total: 2, - }, - ) + firstRes := httpmock.JSONResponse(map[string]interface{}{ + "incomplete_results": false, + "total_count": 2, + "items": []interface{}{ + map[string]interface{}{ + "name": "test", + }, + }, + }) firstRes = httpmock.WithHeader(firstRes, "Link", `; rel="next"`) secondReq := httpmock.QueryMatcher("GET", "search/repositories", url.Values{ "page": []string{"2"}, @@ -411,12 +422,15 @@ func TestSearcherRepositories(t *testing.T) { "q": []string{"keyword stars:>=5 topic:topic"}, }, ) - secondRes := httpmock.JSONResponse(RepositoriesResult{ - IncompleteResults: false, - Items: []Repository{{Name: "cli"}}, - Total: 2, - }, - ) + secondRes := httpmock.JSONResponse(map[string]interface{}{ + "incomplete_results": false, + "total_count": 2, + "items": []interface{}{ + map[string]interface{}{ + "name": "cli", + }, + }, + }) reg.Register(firstReq, firstRes) reg.Register(secondReq, secondRes) }, From 3a33b6e5a54102bff2c1f03dcba682cf61c84924 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Fri, 9 Jun 2023 17:46:13 +0200 Subject: [PATCH 83/90] fix test --- pkg/cmd/extension/browse/browse_test.go | 56 ++++++++++++------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/pkg/cmd/extension/browse/browse_test.go b/pkg/cmd/extension/browse/browse_test.go index 5ad117356..3c4ae87ca 100644 --- a/pkg/cmd/extension/browse/browse_test.go +++ b/pkg/cmd/extension/browse/browse_test.go @@ -84,43 +84,43 @@ func Test_getExtensionRepos(t *testing.T) { reg.Register( httpmock.QueryMatcher("GET", "search/repositories", values), - httpmock.JSONResponse(search.RepositoriesResult{ - IncompleteResults: false, - Items: []search.Repository{ - { - FullName: "vilmibm/gh-screensaver", - Name: "gh-screensaver", - Description: "terminal animations", - Owner: search.User{ - Login: "vilmibm", + httpmock.JSONResponse(map[string]interface{}{ + "incomplete_results": false, + "total_count": 4, + "items": []interface{}{ + map[string]interface{}{ + "name": "gh-screensaver", + "full_name": "vilmibm/gh-screensaver", + "description": "terminal animations", + "owner": map[string]interface{}{ + "login": "vilmibm", }, }, - { - FullName: "cli/gh-cool", - Name: "gh-cool", - Description: "it's just cool ok", - Owner: search.User{ - Login: "cli", + map[string]interface{}{ + "name": "gh-cool", + "full_name": "cli/gh-cool", + "description": "it's just cool ok", + "owner": map[string]interface{}{ + "login": "cli", }, }, - { - FullName: "samcoe/gh-triage", - Name: "gh-triage", - Description: "helps with triage", - Owner: search.User{ - Login: "samcoe", + map[string]interface{}{ + "name": "gh-triage", + "full_name": "samcoe/gh-triage", + "description": "helps with triage", + "owner": map[string]interface{}{ + "login": "samcoe", }, }, - { - FullName: "github/gh-gei", - Name: "gh-gei", - Description: "something something enterprise", - Owner: search.User{ - Login: "github", + map[string]interface{}{ + "name": "gh-gei", + "full_name": "github/gh-gei", + "description": "something something enterprise", + "owner": map[string]interface{}{ + "login": "github", }, }, }, - Total: 4, }), ) From cb93db2b22beaac3a096a6cff6d444aece570b87 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Fri, 9 Jun 2023 17:56:51 +0200 Subject: [PATCH 84/90] fix tests --- pkg/cmd/extension/command_test.go | 80 +++++++++++++++---------------- 1 file changed, 39 insertions(+), 41 deletions(-) diff --git a/pkg/cmd/extension/command_test.go b/pkg/cmd/extension/command_test.go index 6080e8483..fd693d7e5 100644 --- a/pkg/cmd/extension/command_test.go +++ b/pkg/cmd/extension/command_test.go @@ -19,7 +19,6 @@ import ( "github.com/cli/cli/v2/pkg/extensions" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/search" "github.com/spf13/cobra" "github.com/stretchr/testify/assert" ) @@ -74,7 +73,7 @@ func TestNewCmdExtension(t *testing.T) { } reg.Register( httpmock.QueryMatcher("GET", "search/repositories", values), - httpmock.JSONResponse(searchResults()), + httpmock.JSONResponse(searchResults(4)), ) }, isTTY: true, @@ -111,7 +110,7 @@ func TestNewCmdExtension(t *testing.T) { } reg.Register( httpmock.QueryMatcher("GET", "search/repositories", values), - httpmock.JSONResponse(searchResults()), + httpmock.JSONResponse(searchResults(4)), ) }, wantStdout: "installed\tvilmibm/gh-screensaver\tterminal animations\n\tcli/gh-cool\tit's just cool ok\n\tsamcoe/gh-triage\thelps with triage\ninstalled\tgithub/gh-gei\tsomething something enterprise\n", @@ -145,9 +144,7 @@ func TestNewCmdExtension(t *testing.T) { "per_page": []string{"30"}, "q": []string{"screen topic:gh-extension"}, } - results := searchResults() - results.Total = 1 - results.Items = []search.Repository{results.Items[0]} + results := searchResults(1) reg.Register( httpmock.QueryMatcher("GET", "search/repositories", values), httpmock.JSONResponse(results), @@ -175,9 +172,7 @@ func TestNewCmdExtension(t *testing.T) { "per_page": []string{"1"}, "q": []string{"topic:gh-extension"}, } - results := searchResults() - results.Total = 1 - results.Items = []search.Repository{results.Items[0]} + results := searchResults(1) reg.Register( httpmock.QueryMatcher("GET", "search/repositories", values), httpmock.JSONResponse(results), @@ -203,9 +198,7 @@ func TestNewCmdExtension(t *testing.T) { "per_page": []string{"30"}, "q": []string{"license:GPLv3 topic:gh-extension user:jillvalentine"}, } - results := searchResults() - results.Total = 1 - results.Items = []search.Repository{results.Items[0]} + results := searchResults(1) reg.Register( httpmock.QueryMatcher("GET", "search/repositories", values), httpmock.JSONResponse(results), @@ -998,43 +991,48 @@ func Test_checkValidExtension(t *testing.T) { } } -func searchResults() search.RepositoriesResult { - return search.RepositoriesResult{ - IncompleteResults: false, - Items: []search.Repository{ - { - FullName: "vilmibm/gh-screensaver", - Name: "gh-screensaver", - Description: "terminal animations", - Owner: search.User{ - Login: "vilmibm", +func searchResults(numResults int) interface{} { + result := map[string]interface{}{ + "incomplete_results": false, + "total_count": 4, + "items": []interface{}{ + map[string]interface{}{ + "name": "gh-screensaver", + "full_name": "vilmibm/gh-screensaver", + "description": "terminal animations", + "owner": map[string]interface{}{ + "login": "vilmibm", }, }, - { - FullName: "cli/gh-cool", - Name: "gh-cool", - Description: "it's just cool ok", - Owner: search.User{ - Login: "cli", + map[string]interface{}{ + "name": "gh-cool", + "full_name": "cli/gh-cool", + "description": "it's just cool ok", + "owner": map[string]interface{}{ + "login": "cli", }, }, - { - FullName: "samcoe/gh-triage", - Name: "gh-triage", - Description: "helps with triage", - Owner: search.User{ - Login: "samcoe", + map[string]interface{}{ + "name": "gh-triage", + "full_name": "samcoe/gh-triage", + "description": "helps with triage", + "owner": map[string]interface{}{ + "login": "samcoe", }, }, - { - FullName: "github/gh-gei", - Name: "gh-gei", - Description: "something something enterprise", - Owner: search.User{ - Login: "github", + map[string]interface{}{ + "name": "gh-gei", + "full_name": "github/gh-gei", + "description": "something something enterprise", + "owner": map[string]interface{}{ + "login": "github", }, }, }, - Total: 4, } + if len(result["items"].([]interface{})) > numResults { + fewerItems := result["items"].([]interface{})[0:numResults] + result["items"] = fewerItems + } + return result } From ad4a489f8d363ee55fa0401b497ee15f0770487d Mon Sep 17 00:00:00 2001 From: Ariel Deitcher <1149246+mntlty@users.noreply.github.com> Date: Fri, 9 Jun 2023 09:57:01 -0700 Subject: [PATCH 85/90] Introduce `gh project` commands (#7375) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Mislav Marohnić --- go.mod | 10 +- go.sum | 20 +- pkg/cmd/project/close/close.go | 148 ++ pkg/cmd/project/close/close_test.go | 457 +++++++ pkg/cmd/project/copy/copy.go | 153 +++ pkg/cmd/project/copy/copy_test.go | 462 +++++++ pkg/cmd/project/create/create.go | 125 ++ pkg/cmd/project/create/create_test.go | 278 ++++ pkg/cmd/project/delete/delete.go | 136 ++ pkg/cmd/project/delete/delete_test.go | 348 +++++ pkg/cmd/project/edit/edit.go | 165 +++ pkg/cmd/project/edit/edit_test.go | 512 +++++++ pkg/cmd/project/field-create/field_create.go | 163 +++ .../project/field-create/field_create_test.go | 632 +++++++++ pkg/cmd/project/field-delete/field_delete.go | 105 ++ .../project/field-delete/field_delete_test.go | 117 ++ pkg/cmd/project/field-list/field_list.go | 132 ++ pkg/cmd/project/field-list/field_list_test.go | 425 ++++++ pkg/cmd/project/item-add/item_add.go | 144 ++ pkg/cmd/project/item-add/item_add_test.go | 426 ++++++ pkg/cmd/project/item-archive/item_archive.go | 171 +++ .../project/item-archive/item_archive_test.go | 639 +++++++++ pkg/cmd/project/item-create/item_create.go | 140 ++ .../project/item-create/item_create_test.go | 374 +++++ pkg/cmd/project/item-delete/item_delete.go | 131 ++ .../project/item-delete/item_delete_test.go | 359 +++++ pkg/cmd/project/item-edit/item_edit.go | 253 ++++ pkg/cmd/project/item-edit/item_edit_test.go | 476 +++++++ pkg/cmd/project/item-list/item_list.go | 136 ++ pkg/cmd/project/item-list/item_list_test.go | 402 ++++++ pkg/cmd/project/list/list.go | 186 +++ pkg/cmd/project/list/list_test.go | 737 ++++++++++ pkg/cmd/project/project.go | 61 + pkg/cmd/project/shared/client/client.go | 22 + pkg/cmd/project/shared/format/json.go | 365 +++++ pkg/cmd/project/shared/format/json_test.go | 287 ++++ pkg/cmd/project/shared/queries/queries.go | 1212 +++++++++++++++++ .../project/shared/queries/queries_test.go | 365 +++++ pkg/cmd/project/view/view.go | 203 +++ pkg/cmd/project/view/view_test.go | 545 ++++++++ pkg/cmd/root/root.go | 3 + 41 files changed, 12013 insertions(+), 12 deletions(-) create mode 100644 pkg/cmd/project/close/close.go create mode 100644 pkg/cmd/project/close/close_test.go create mode 100644 pkg/cmd/project/copy/copy.go create mode 100644 pkg/cmd/project/copy/copy_test.go create mode 100644 pkg/cmd/project/create/create.go create mode 100644 pkg/cmd/project/create/create_test.go create mode 100644 pkg/cmd/project/delete/delete.go create mode 100644 pkg/cmd/project/delete/delete_test.go create mode 100644 pkg/cmd/project/edit/edit.go create mode 100644 pkg/cmd/project/edit/edit_test.go create mode 100644 pkg/cmd/project/field-create/field_create.go create mode 100644 pkg/cmd/project/field-create/field_create_test.go create mode 100644 pkg/cmd/project/field-delete/field_delete.go create mode 100644 pkg/cmd/project/field-delete/field_delete_test.go create mode 100644 pkg/cmd/project/field-list/field_list.go create mode 100644 pkg/cmd/project/field-list/field_list_test.go create mode 100644 pkg/cmd/project/item-add/item_add.go create mode 100644 pkg/cmd/project/item-add/item_add_test.go create mode 100644 pkg/cmd/project/item-archive/item_archive.go create mode 100644 pkg/cmd/project/item-archive/item_archive_test.go create mode 100644 pkg/cmd/project/item-create/item_create.go create mode 100644 pkg/cmd/project/item-create/item_create_test.go create mode 100644 pkg/cmd/project/item-delete/item_delete.go create mode 100644 pkg/cmd/project/item-delete/item_delete_test.go create mode 100644 pkg/cmd/project/item-edit/item_edit.go create mode 100644 pkg/cmd/project/item-edit/item_edit_test.go create mode 100644 pkg/cmd/project/item-list/item_list.go create mode 100644 pkg/cmd/project/item-list/item_list_test.go create mode 100644 pkg/cmd/project/list/list.go create mode 100644 pkg/cmd/project/list/list_test.go create mode 100644 pkg/cmd/project/project.go create mode 100644 pkg/cmd/project/shared/client/client.go create mode 100644 pkg/cmd/project/shared/format/json.go create mode 100644 pkg/cmd/project/shared/format/json_test.go create mode 100644 pkg/cmd/project/shared/queries/queries.go create mode 100644 pkg/cmd/project/shared/queries/queries_test.go create mode 100644 pkg/cmd/project/view/view.go create mode 100644 pkg/cmd/project/view/view_test.go diff --git a/go.mod b/go.mod index 39c41efa6..a0b3781cf 100644 --- a/go.mod +++ b/go.mod @@ -30,7 +30,7 @@ require ( github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38 github.com/opentracing/opentracing-go v1.1.0 github.com/rivo/tview v0.0.0-20221029100920-c4a7e501810d - github.com/shurcooL/githubv4 v0.0.0-20220520033151-0b4e3294ff00 + github.com/shurcooL/githubv4 v0.0.0-20230424031643-6cea62ecd5a9 github.com/sourcegraph/jsonrpc2 v0.1.0 github.com/spf13/cobra v1.6.1 github.com/spf13/pflag v1.0.5 @@ -38,10 +38,11 @@ require ( github.com/zalando/go-keyring v0.2.3 golang.org/x/crypto v0.0.0-20210921155107-089bfa567519 golang.org/x/sync v0.1.0 - golang.org/x/term v0.6.0 - golang.org/x/text v0.8.0 + golang.org/x/term v0.7.0 + golang.org/x/text v0.9.0 google.golang.org/grpc v1.49.0 google.golang.org/protobuf v1.27.1 + gopkg.in/h2non/gock.v1 v1.1.2 gopkg.in/yaml.v3 v3.0.1 ) @@ -59,6 +60,7 @@ require ( github.com/godbus/dbus/v5 v5.1.0 // indirect github.com/golang/protobuf v1.5.2 // indirect github.com/gorilla/css v1.0.0 // indirect + github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 // indirect github.com/hashicorp/errwrap v1.0.0 // indirect github.com/inconshreveable/mousetrap v1.0.1 // indirect github.com/itchyny/gojq v0.12.13 // indirect @@ -77,7 +79,7 @@ require ( github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e // indirect github.com/yuin/goldmark v1.4.13 // indirect github.com/yuin/goldmark-emoji v1.0.1 // indirect - golang.org/x/net v0.8.0 // indirect + golang.org/x/net v0.9.0 // indirect golang.org/x/oauth2 v0.0.0-20220309155454-6242fa91716a // indirect golang.org/x/sys v0.8.0 // indirect google.golang.org/genproto v0.0.0-20200825200019-8632dd797987 // indirect diff --git a/go.sum b/go.sum index 81d281bc5..1d3b83805 100644 --- a/go.sum +++ b/go.sum @@ -161,6 +161,7 @@ github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/ad github.com/gorilla/websocket v1.4.2 h1:+/TMaTYc4QFitKJxsQ7Yye35DkWvkdLcvGKqM+x0Ufc= github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542 h1:2VTzZjLZBgl62/EtslCrtky5vbi9dd7HrQPQIx6wqiw= +github.com/h2non/parth v0.0.0-20190131123155-b4df798d6542/go.mod h1:Ow0tF8D4Kplbc8s8sSb3V2oUCygFHVp8gC3Dn6U4MNI= github.com/hashicorp/errwrap v1.0.0 h1:hLrqtEDnRye3+sgx6z4qVLNuviH3MR5aQ0ykNJa/UYA= github.com/hashicorp/errwrap v1.0.0/go.mod h1:YH+1FKiLXxHSkmPseP+kNlulaMuP3n2brvKWEqk/Jc4= github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+lD48awMYo= @@ -223,6 +224,8 @@ github.com/muesli/termenv v0.12.0 h1:KuQRUE3PgxRFWhq4gHvZtPSLCGDqM5q/cYr1pZ39ytc github.com/muesli/termenv v0.12.0/go.mod h1:WCCv32tusQ/EEZ5S8oUIIrC/nIuBcxCVqlN4Xfkv+7A= github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38 h1:0FrBxrkJ0hVembTb/e4EU5Ml6vLcOusAqymmYISg5Uo= github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38/go.mod h1:saF2fIVw4banK0H4+/EuqfFLpRnoy5S+ECwTOCcRcSU= +github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32 h1:W6apQkHrMkS0Muv8G/TipAy/FJl/rCYT0+EuS8+Z0z4= +github.com/nbio/st v0.0.0-20140626010706-e9e8d9816f32/go.mod h1:9wM+0iRr9ahx58uYLpLIr5fm8diHn0JbqRycJi6w0Ms= github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec= github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY= github.com/opentracing/opentracing-go v1.1.0 h1:pWlfV3Bxv7k65HYwkikxat0+s3pV4bsqf19k25Ur8rU= @@ -239,8 +242,8 @@ github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUc github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= -github.com/shurcooL/githubv4 v0.0.0-20220520033151-0b4e3294ff00 h1:fiFvD4lT0aWjuuAb64LlZ/67v87m+Kc9Qsu5cMFNK0w= -github.com/shurcooL/githubv4 v0.0.0-20220520033151-0b4e3294ff00/go.mod h1:hAF0iLZy4td2EX+/8Tw+4nodhlMrwN3HupfaXj3zkGo= +github.com/shurcooL/githubv4 v0.0.0-20230424031643-6cea62ecd5a9 h1:nCBaIs5/R0HFP5+aPW/SzFUF8z0oKuCXmuDmHWaxzjY= +github.com/shurcooL/githubv4 v0.0.0-20230424031643-6cea62ecd5a9/go.mod h1:hAF0iLZy4td2EX+/8Tw+4nodhlMrwN3HupfaXj3zkGo= github.com/shurcooL/graphql v0.0.0-20220606043923-3cf50f8a0a29 h1:B1PEwpArrNp4dkQrfxh/abbBAOZBVp0ds+fBEOUOqOc= github.com/shurcooL/graphql v0.0.0-20220606043923-3cf50f8a0a29/go.mod h1:AuYgA5Kyo4c7HfUmvRGs/6rGlMMV/6B1bVnB9JxJEEg= github.com/sourcegraph/jsonrpc2 v0.1.0 h1:ohJHjZ+PcaLxDUjqk2NC3tIGsVa5bXThe1ZheSXOjuk= @@ -342,8 +345,8 @@ golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qx golang.org/x/net v0.0.0-20220127200216-cd36cc0744dd/go.mod h1:CfG3xpIq0wQ8r1q4Su4UZFWDARRcnwPjda9FqA0JpMk= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/net v0.0.0-20220923203811-8be639271d50/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= -golang.org/x/net v0.8.0 h1:Zrh2ngAOFYneWTAIAPethzeaQLuHwhuBkuV6ZiRnUaQ= -golang.org/x/net v0.8.0/go.mod h1:QVkue5JL9kW//ek3r6jTKnTFis1tRmNAW2P1shuFdJc= +golang.org/x/net v0.9.0 h1:aWJ/m6xSmxWBx+V0XRHTlrYrPG56jKsLdTFmsSsCzOM= +golang.org/x/net v0.9.0/go.mod h1:d48xBJpPfHeWQsugry2m+kC02ZBRGRgulfHnEXEuWns= golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/oauth2 v0.0.0-20190226205417-e64efc72b421/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45/go.mod h1:gOpvHmFTYa4IltrdGE7lF6nIHvwfUNPOp7c8zoXwtLw= @@ -409,8 +412,8 @@ golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210503060354-a79de5458b56/go.mod h1:tfny5GFUkzUvx4ps4ajbZsCe5lw1metzhBm9T3x7oIY= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.6.0 h1:clScbb1cHjoCkyRbWwBEUZ5H/tIFu5TAXIqaZD0Gcjw= -golang.org/x/term v0.6.0/go.mod h1:m6U89DPEgQRMq3DNkDClhWw02AUbt2daBVO4cn4Hv9U= +golang.org/x/term v0.7.0 h1:BEvjmm5fURWqcfbSKTdpkDXYBrUS1c0m8agp14W48vQ= +golang.org/x/term v0.7.0/go.mod h1:P32HKFT3hSsZrRxla30E9HqToFYAQPCMs/zFMBUFqPY= golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.1-0.20180807135948-17ff2d5776d2/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= @@ -419,8 +422,8 @@ golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= -golang.org/x/text v0.8.0 h1:57P1ETyNKtuIjB4SRd15iJxuhj8Gc416Y78H3qgMh68= -golang.org/x/text v0.8.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= golang.org/x/time v0.0.0-20181108054448-85acf8d2951c/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20190308202827-9d24e82272b4/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= golang.org/x/time v0.0.0-20191024005414-555d28b269f0/go.mod h1:tRJNPiyCQ0inRvYxbN9jk5I+vvW/OXSQhTDSoE431IQ= @@ -558,6 +561,7 @@ gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogR gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= gopkg.in/h2non/gock.v1 v1.1.2 h1:jBbHXgGBK/AoPVfJh5x4r/WxIrElvbLel8TCZkkZJoY= +gopkg.in/h2non/gock.v1 v1.1.2/go.mod h1:n7UGz/ckNChHiK05rDoiC4MYSunEC/lyaUm2WWaDva0= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= diff --git a/pkg/cmd/project/close/close.go b/pkg/cmd/project/close/close.go new file mode 100644 index 000000000..7f8006b6f --- /dev/null +++ b/pkg/cmd/project/close/close.go @@ -0,0 +1,148 @@ +package close + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type closeOpts struct { + number int32 + owner string + reopen bool + projectID string + format string +} + +type closeConfig struct { + io *iostreams.IOStreams + client *queries.Client + opts closeOpts +} + +// the close command relies on the updateProjectV2 mutation +type updateProjectMutation struct { + UpdateProjectV2 struct { + ProjectV2 queries.Project `graphql:"projectV2"` + } `graphql:"updateProjectV2(input:$input)"` +} + +func NewCmdClose(f *cmdutil.Factory, runF func(config closeConfig) error) *cobra.Command { + opts := closeOpts{} + closeCmd := &cobra.Command{ + Short: "Close a project", + Use: "close []", + Example: heredoc.Doc(` + # close project "1" owned by monalisa + gh project close 1 --owner monalisa + + # reopen closed project "1" owned by github + gh project close 1 --owner github --undo + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := closeConfig{ + io: f.IOStreams, + client: client, + opts: opts, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runClose(config) + }, + } + + closeCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + closeCmd.Flags().BoolVar(&opts.reopen, "undo", false, "Reopen a closed project") + closeCmd.Flags().StringVar(&opts.format, "format", "", "Output format, must be 'json'") + + return closeCmd +} + +func runClose(config closeConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectID = project.ID + + query, variables := closeArgs(config) + + err = config.client.Mutate("CloseProjectV2", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, *project) + } + + return printResults(config, query.UpdateProjectV2.ProjectV2) +} + +func closeArgs(config closeConfig) (*updateProjectMutation, map[string]interface{}) { + closed := !config.opts.reopen + return &updateProjectMutation{}, map[string]interface{}{ + "input": githubv4.UpdateProjectV2Input{ + ProjectID: githubv4.ID(config.opts.projectID), + Closed: githubv4.NewBoolean(githubv4.Boolean(closed)), + }, + "firstItems": githubv4.Int(0), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(0), + "afterFields": (*githubv4.String)(nil), + } +} + +func printResults(config closeConfig, project queries.Project) error { + if !config.io.IsStdoutTTY() { + return nil + } + var action string + if config.opts.reopen { + action = "Reopened" + } else { + action = "Closed" + } + _, err := fmt.Fprintf(config.io.Out, "%s project %s\n", action, project.URL) + return err +} + +func printJSON(config closeConfig, project queries.Project) error { + b, err := format.JSONProject(project) + if err != nil { + return err + } + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/close/close_test.go b/pkg/cmd/project/close/close_test.go new file mode 100644 index 000000000..3db3c3c68 --- /dev/null +++ b/pkg/cmd/project/close/close_test.go @@ -0,0 +1,457 @@ +package close + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdClose(t *testing.T) { + tests := []struct { + name string + cli string + wants closeOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "not-a-number", + cli: "x", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "number", + cli: "123", + wants: closeOpts{ + number: 123, + }, + }, + { + name: "owner", + cli: "--owner monalisa", + wants: closeOpts{ + owner: "monalisa", + }, + }, + { + name: "reopen", + cli: "--undo", + wants: closeOpts{ + reopen: true, + }, + }, + { + name: "json", + cli: "--format json", + wants: closeOpts{ + format: "json", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 closeOpts + cmd := NewCmdClose(f, func(config closeConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunClose_User(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // close project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CloseProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","closed":true}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + + config := closeConfig{ + io: ios, + opts: closeOpts{ + number: 1, + owner: "monalisa", + }, + client: client, + } + + err := runClose(config) + assert.NoError(t, err) + assert.Equal( + t, + "Closed project http://a-url.com\n", + stdout.String()) +} + +func TestRunClose_Org(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get org project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // close project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CloseProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","closed":true}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := closeConfig{ + io: ios, + opts: closeOpts{ + number: 1, + owner: "github", + }, + client: client, + } + + err := runClose(config) + assert.NoError(t, err) + assert.Equal(t, "", stdout.String()) +} + +func TestRunClose_Me(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get viewer project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // close project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CloseProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","closed":true}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "me", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := closeConfig{ + io: ios, + opts: closeOpts{ + number: 1, + owner: "@me", + }, + client: client, + } + + err := runClose(config) + assert.NoError(t, err) + assert.Equal(t, "", stdout.String()) +} + +func TestRunClose_Reopen(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // close project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CloseProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","closed":false}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + + config := closeConfig{ + io: ios, + opts: closeOpts{ + number: 1, + owner: "monalisa", + reopen: true, + }, + client: client, + } + + err := runClose(config) + assert.NoError(t, err) + assert.Equal( + t, + "Reopened project http://a-url.com\n", + stdout.String()) +} diff --git a/pkg/cmd/project/copy/copy.go b/pkg/cmd/project/copy/copy.go new file mode 100644 index 000000000..6dae73e40 --- /dev/null +++ b/pkg/cmd/project/copy/copy.go @@ -0,0 +1,153 @@ +package copy + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type copyOpts struct { + includeDraftIssues bool + number int32 + ownerID string + projectID string + sourceOwner string + targetOwner string + title string + format string +} + +type copyConfig struct { + io *iostreams.IOStreams + client *queries.Client + opts copyOpts +} + +type copyProjectMutation struct { + CopyProjectV2 struct { + ProjectV2 queries.Project `graphql:"projectV2"` + } `graphql:"copyProjectV2(input:$input)"` +} + +func NewCmdCopy(f *cmdutil.Factory, runF func(config copyConfig) error) *cobra.Command { + opts := copyOpts{} + copyCmd := &cobra.Command{ + Short: "Copy a project", + Use: "copy []", + Example: heredoc.Doc(` + # copy project "1" owned by monalisa to github + gh project copy 1 --source-owner monalisa --target-owner github --title "a new project" + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := copyConfig{ + io: f.IOStreams, + client: client, + opts: opts, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runCopy(config) + }, + } + + copyCmd.Flags().StringVar(&opts.sourceOwner, "source-owner", "", "Login of the source owner. Use \"@me\" for the current user.") + copyCmd.Flags().StringVar(&opts.targetOwner, "target-owner", "", "Login of the target owner. Use \"@me\" for the current user.") + copyCmd.Flags().StringVar(&opts.title, "title", "", "Title for the new project") + copyCmd.Flags().BoolVar(&opts.includeDraftIssues, "drafts", false, "Include draft issues when copying") + cmdutil.StringEnumFlag(copyCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + _ = copyCmd.MarkFlagRequired("title") + + return copyCmd +} + +func runCopy(config copyConfig) error { + canPrompt := config.io.CanPrompt() + sourceOwner, err := config.client.NewOwner(canPrompt, config.opts.sourceOwner) + if err != nil { + return err + } + + targetOwner, err := config.client.NewOwner(canPrompt, config.opts.targetOwner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, sourceOwner, config.opts.number, false) + if err != nil { + return err + } + + config.opts.projectID = project.ID + config.opts.ownerID = targetOwner.ID + + query, variables := copyArgs(config) + + err = config.client.Mutate("CopyProjectV2", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.CopyProjectV2.ProjectV2) + } + + return printResults(config, query.CopyProjectV2.ProjectV2) +} + +func copyArgs(config copyConfig) (*copyProjectMutation, map[string]interface{}) { + return ©ProjectMutation{}, map[string]interface{}{ + "input": githubv4.CopyProjectV2Input{ + OwnerID: githubv4.ID(config.opts.ownerID), + ProjectID: githubv4.ID(config.opts.projectID), + Title: githubv4.String(config.opts.title), + IncludeDraftIssues: githubv4.NewBoolean(githubv4.Boolean(config.opts.includeDraftIssues)), + }, + "firstItems": githubv4.Int(0), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(0), + "afterFields": (*githubv4.String)(nil), + } +} + +func printResults(config copyConfig, project queries.Project) error { + if !config.io.IsStdoutTTY() { + return nil + } + _, err := fmt.Fprintf(config.io.Out, "Copied project to %s\n", project.URL) + return err +} + +func printJSON(config copyConfig, project queries.Project) error { + b, err := format.JSONProject(project) + if err != nil { + return err + } + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/copy/copy_test.go b/pkg/cmd/project/copy/copy_test.go new file mode 100644 index 000000000..d731adaff --- /dev/null +++ b/pkg/cmd/project/copy/copy_test.go @@ -0,0 +1,462 @@ +package copy + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdCopy(t *testing.T) { + tests := []struct { + name string + cli string + wants copyOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "not-a-number", + cli: "x --title t", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "title", + cli: "--title t", + wants: copyOpts{ + title: "t", + }, + }, + { + name: "number", + cli: "123 --title t", + wants: copyOpts{ + number: 123, + title: "t", + }, + }, + { + name: "source-owner", + cli: "--source-owner monalisa --title t", + wants: copyOpts{ + sourceOwner: "monalisa", + title: "t", + }, + }, + { + name: "target-owner", + cli: "--target-owner monalisa --title t", + wants: copyOpts{ + targetOwner: "monalisa", + title: "t", + }, + }, + { + name: "drafts", + cli: "--drafts --title t", + wants: copyOpts{ + includeDraftIssues: true, + title: "t", + }, + }, + { + name: "json", + cli: "--format json --title t", + wants: copyOpts{ + format: "json", + title: "t", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 copyOpts + cmd := NewCmdCopy(f, func(config copyConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.sourceOwner, gotOpts.sourceOwner) + assert.Equal(t, tt.wants.targetOwner, gotOpts.targetOwner) + assert.Equal(t, tt.wants.title, gotOpts.title) + assert.Equal(t, tt.wants.includeDraftIssues, gotOpts.includeDraftIssues) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunCopy_User(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // get source user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get target user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // Copy project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CopyProjectV2.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","ownerId":"an ID","title":"a title","includeDraftIssues":false}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "copyProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(false) + + config := copyConfig{ + io: ios, + opts: copyOpts{ + title: "a title", + sourceOwner: "monalisa", + targetOwner: "monalisa", + number: 1, + }, + client: client, + } + + err := runCopy(config) + assert.NoError(t, err) + assert.Equal(t, "", stdout.String()) +} + +func TestRunCopy_Org(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get org project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + // get source org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + "login": "github", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get target source org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + "login": "github", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // Copy project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CopyProjectV2.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","ownerId":"an ID","title":"a title","includeDraftIssues":false}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "copyProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(false) + + config := copyConfig{ + io: ios, + opts: copyOpts{ + title: "a title", + sourceOwner: "github", + targetOwner: "github", + number: 1, + }, + client: client, + } + + err := runCopy(config) + assert.NoError(t, err) + assert.Equal(t, "", stdout.String()) +} + +func TestRunCopy_Me(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get viewer project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // get source viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + "login": "me", + }, + }, + }) + + // get target viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + "login": "me", + }, + }, + }) + + // Copy project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CopyProjectV2.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","ownerId":"an ID","title":"a title","includeDraftIssues":false}}}`).Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "copyProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "me", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + + config := copyConfig{ + io: ios, + opts: copyOpts{ + title: "a title", + sourceOwner: "@me", + targetOwner: "@me", + number: 1, + }, + client: client, + } + + err := runCopy(config) + assert.NoError(t, err) + assert.Equal( + t, + "Copied project to http://a-url.com\n", + stdout.String()) +} diff --git a/pkg/cmd/project/create/create.go b/pkg/cmd/project/create/create.go new file mode 100644 index 000000000..0ecd4f5f3 --- /dev/null +++ b/pkg/cmd/project/create/create.go @@ -0,0 +1,125 @@ +package create + +import ( + "fmt" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type createOpts struct { + title string + owner string + ownerID string + format string +} + +type createConfig struct { + client *queries.Client + opts createOpts + io *iostreams.IOStreams +} + +type createProjectMutation struct { + CreateProjectV2 struct { + ProjectV2 queries.Project `graphql:"projectV2"` + } `graphql:"createProjectV2(input:$input)"` +} + +func NewCmdCreate(f *cmdutil.Factory, runF func(config createConfig) error) *cobra.Command { + opts := createOpts{} + createCmd := &cobra.Command{ + Short: "Create a project", + Use: "create", + Example: heredoc.Doc(` + # create a new project owned by login monalisa + gh project create --owner monalisa --title "a new project" + `), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + config := createConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runCreate(config) + }, + } + + createCmd.Flags().StringVar(&opts.title, "title", "", "Title for the project") + createCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + cmdutil.StringEnumFlag(createCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + _ = createCmd.MarkFlagRequired("title") + + return createCmd +} + +func runCreate(config createConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + config.opts.ownerID = owner.ID + query, variables := createArgs(config) + + err = config.client.Mutate("CreateProjectV2", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.CreateProjectV2.ProjectV2) + } + + return printResults(config, query.CreateProjectV2.ProjectV2) +} + +func createArgs(config createConfig) (*createProjectMutation, map[string]interface{}) { + return &createProjectMutation{}, map[string]interface{}{ + "input": githubv4.CreateProjectV2Input{ + OwnerID: githubv4.ID(config.opts.ownerID), + Title: githubv4.String(config.opts.title), + }, + "firstItems": githubv4.Int(0), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(0), + "afterFields": (*githubv4.String)(nil), + } +} + +func printResults(config createConfig, project queries.Project) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Created project '%s'\n%s\n", project.Title, project.URL) + return err +} + +func printJSON(config createConfig, project queries.Project) error { + b, err := format.JSONProject(project) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/create/create_test.go b/pkg/cmd/project/create/create_test.go new file mode 100644 index 000000000..0a6cc9700 --- /dev/null +++ b/pkg/cmd/project/create/create_test.go @@ -0,0 +1,278 @@ +package create + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdCreate(t *testing.T) { + tests := []struct { + name string + cli string + wants createOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "title", + cli: "--title t", + wants: createOpts{ + title: "t", + }, + }, + { + name: "owner", + cli: "--title t --owner monalisa", + wants: createOpts{ + owner: "monalisa", + title: "t", + }, + }, + { + name: "json", + cli: "--title t --format json", + wants: createOpts{ + format: "json", + title: "t", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 createOpts + cmd := NewCmdCreate(f, func(config createConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.title, gotOpts.title) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunCreate_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + "login": "monalisa", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // create project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"ownerId":"an ID","title":"a title"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createConfig{ + opts: createOpts{ + title: "a title", + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runCreate(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created project 'a title'\nhttp://a-url.com\n", + stdout.String()) +} + +func TestRunCreate_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]string{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + "login": "github", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // create project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"ownerId":"an ID","title":"a title"}}}`).Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createConfig{ + opts: createOpts{ + title: "a title", + owner: "github", + }, + client: client, + io: ios, + } + + err := runCreate(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created project 'a title'\nhttp://a-url.com\n", + stdout.String()) +} + +func TestRunCreate_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + "login": "me", + }, + }, + }) + + // create project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"ownerId":"an ID","title":"a title"}}}`).Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "me", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createConfig{ + opts: createOpts{ + title: "a title", + owner: "@me", + }, + client: client, + io: ios, + } + + err := runCreate(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created project 'a title'\nhttp://a-url.com\n", + stdout.String()) +} diff --git a/pkg/cmd/project/delete/delete.go b/pkg/cmd/project/delete/delete.go new file mode 100644 index 000000000..0ae93277b --- /dev/null +++ b/pkg/cmd/project/delete/delete.go @@ -0,0 +1,136 @@ +package delete + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type deleteOpts struct { + owner string + number int32 + projectID string + format string +} + +type deleteConfig struct { + client *queries.Client + opts deleteOpts + io *iostreams.IOStreams +} + +type deleteProjectMutation struct { + DeleteProject struct { + Project queries.Project `graphql:"projectV2"` + } `graphql:"deleteProjectV2(input:$input)"` +} + +func NewCmdDelete(f *cmdutil.Factory, runF func(config deleteConfig) error) *cobra.Command { + opts := deleteOpts{} + deleteCmd := &cobra.Command{ + Short: "Delete a project", + Use: "delete []", + Example: heredoc.Doc(` + # delete the current user's project "1" + gh project delete 1 --owner "@me" + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := deleteConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runDelete(config) + }, + } + + deleteCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + cmdutil.StringEnumFlag(deleteCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + return deleteCmd +} + +func runDelete(config deleteConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectID = project.ID + + query, variables := deleteItemArgs(config) + err = config.client.Mutate("DeleteProject", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, *project) + } + + return printResults(config) + +} + +func deleteItemArgs(config deleteConfig) (*deleteProjectMutation, map[string]interface{}) { + return &deleteProjectMutation{}, map[string]interface{}{ + "input": githubv4.DeleteProjectV2Input{ + ProjectID: githubv4.ID(config.opts.projectID), + }, + "firstItems": githubv4.Int(0), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(0), + "afterFields": (*githubv4.String)(nil), + } +} + +func printResults(config deleteConfig) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Deleted project\n") + return err +} + +func printJSON(config deleteConfig, project queries.Project) error { + b, err := format.JSONProject(project) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/delete/delete_test.go b/pkg/cmd/project/delete/delete_test.go new file mode 100644 index 000000000..28f30ebc6 --- /dev/null +++ b/pkg/cmd/project/delete/delete_test.go @@ -0,0 +1,348 @@ +package delete + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdDelete(t *testing.T) { + tests := []struct { + name string + cli string + wants deleteOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "not-a-number", + cli: "x", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "number", + cli: "123", + wants: deleteOpts{ + number: 123, + }, + }, + { + name: "owner", + cli: "--owner monalisa", + wants: deleteOpts{ + owner: "monalisa", + }, + }, + { + name: "json", + cli: "--format json", + wants: deleteOpts{ + format: "json", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 deleteOpts + cmd := NewCmdDelete(f, func(config deleteConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunDelete_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // delete project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteProject.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "project ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := deleteConfig{ + opts: deleteOpts{ + owner: "monalisa", + number: 1, + }, + client: client, + io: ios, + } + + err := runDelete(config) + assert.NoError(t, err) + assert.Equal( + t, + "Deleted project\n", + stdout.String()) +} + +func TestRunDelete_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // delete project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteProject.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "project ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := deleteConfig{ + opts: deleteOpts{ + owner: "github", + number: 1, + }, + client: client, + io: ios, + } + + err := runDelete(config) + assert.NoError(t, err) + assert.Equal( + t, + "Deleted project\n", + stdout.String()) +} + +func TestRunDelete_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // delete project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteProject.*","variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "project ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := deleteConfig{ + opts: deleteOpts{ + owner: "@me", + number: 1, + }, + client: client, + io: ios, + } + + err := runDelete(config) + assert.NoError(t, err) + assert.Equal( + t, + "Deleted project\n", + stdout.String()) +} diff --git a/pkg/cmd/project/edit/edit.go b/pkg/cmd/project/edit/edit.go new file mode 100644 index 000000000..64ee74d78 --- /dev/null +++ b/pkg/cmd/project/edit/edit.go @@ -0,0 +1,165 @@ +package edit + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type editOpts struct { + number int32 + owner string + title string + readme string + visibility string + shortDescription string + projectID string + format string +} + +type editConfig struct { + client *queries.Client + opts editOpts + io *iostreams.IOStreams +} + +type updateProjectMutation struct { + UpdateProjectV2 struct { + ProjectV2 queries.Project `graphql:"projectV2"` + } `graphql:"updateProjectV2(input:$input)"` +} + +const projectVisibilityPublic = "PUBLIC" +const projectVisibilityPrivate = "PRIVATE" + +func NewCmdEdit(f *cmdutil.Factory, runF func(config editConfig) error) *cobra.Command { + opts := editOpts{} + editCmd := &cobra.Command{ + Short: "Edit a project", + Use: "edit []", + Example: heredoc.Doc(` + # edit the title of monalisa's project "1" + gh project edit 1 --owner monalisa --title "New title" + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := editConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + if config.opts.title == "" && config.opts.shortDescription == "" && config.opts.readme == "" && config.opts.visibility == "" { + return fmt.Errorf("no fields to edit") + } + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runEdit(config) + }, + } + + editCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + cmdutil.StringEnumFlag(editCmd, &opts.visibility, "visibility", "", "", []string{projectVisibilityPublic, projectVisibilityPrivate}, "Change project visibility") + editCmd.Flags().StringVar(&opts.title, "title", "", "New title for the project") + editCmd.Flags().StringVar(&opts.readme, "readme", "", "New readme for the project") + editCmd.Flags().StringVarP(&opts.shortDescription, "description", "d", "", "New description of the project") + cmdutil.StringEnumFlag(editCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + return editCmd +} + +func runEdit(config editConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectID = project.ID + + query, variables := editArgs(config) + err = config.client.Mutate("UpdateProjectV2", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, *project) + } + + return printResults(config, query.UpdateProjectV2.ProjectV2) +} + +func editArgs(config editConfig) (*updateProjectMutation, map[string]interface{}) { + variables := githubv4.UpdateProjectV2Input{ProjectID: githubv4.ID(config.opts.projectID)} + if config.opts.title != "" { + variables.Title = githubv4.NewString(githubv4.String(config.opts.title)) + } + if config.opts.shortDescription != "" { + variables.ShortDescription = githubv4.NewString(githubv4.String(config.opts.shortDescription)) + } + if config.opts.readme != "" { + variables.Readme = githubv4.NewString(githubv4.String(config.opts.readme)) + } + if config.opts.visibility != "" { + if config.opts.visibility == projectVisibilityPublic { + variables.Public = githubv4.NewBoolean(githubv4.Boolean(true)) + } else if config.opts.visibility == projectVisibilityPrivate { + variables.Public = githubv4.NewBoolean(githubv4.Boolean(false)) + } + } + + return &updateProjectMutation{}, map[string]interface{}{ + "input": variables, + "firstItems": githubv4.Int(0), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(0), + "afterFields": (*githubv4.String)(nil), + } +} + +func printResults(config editConfig, project queries.Project) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Updated project %s\n", project.URL) + return err +} + +func printJSON(config editConfig, project queries.Project) error { + b, err := format.JSONProject(project) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/edit/edit_test.go b/pkg/cmd/project/edit/edit_test.go new file mode 100644 index 000000000..45aff1390 --- /dev/null +++ b/pkg/cmd/project/edit/edit_test.go @@ -0,0 +1,512 @@ +package edit + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdEdit(t *testing.T) { + tests := []struct { + name string + cli string + wants editOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "not-a-number", + cli: "x", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "visibility-error", + cli: "--visibility v", + wantsErr: true, + wantsErrMsg: "invalid argument \"v\" for \"--visibility\" flag: valid values are {PUBLIC|PRIVATE}", + }, + { + name: "no-args", + cli: "", + wantsErr: true, + wantsErrMsg: "no fields to edit", + }, + { + name: "title", + cli: "--title t", + wants: editOpts{ + title: "t", + }, + }, + { + name: "number", + cli: "123 --title t", + wants: editOpts{ + number: 123, + title: "t", + }, + }, + { + name: "owner", + cli: "--owner monalisa --title t", + wants: editOpts{ + owner: "monalisa", + title: "t", + }, + }, + { + name: "readme", + cli: "--readme r", + wants: editOpts{ + readme: "r", + }, + }, + { + name: "description", + cli: "--description d", + wants: editOpts{ + shortDescription: "d", + }, + }, + { + name: "visibility", + cli: "--visibility PUBLIC", + wants: editOpts{ + visibility: "PUBLIC", + }, + }, + { + name: "json", + cli: "--format json --title t", + wants: editOpts{ + format: "json", + title: "t", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 editOpts + cmd := NewCmdEdit(f, func(config editConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.visibility, gotOpts.visibility) + assert.Equal(t, tt.wants.title, gotOpts.title) + assert.Equal(t, tt.wants.readme, gotOpts.readme) + assert.Equal(t, tt.wants.shortDescription, gotOpts.shortDescription) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunUpdate_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // edit project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","title":"a new title","shortDescription":"a new description","readme":"a new readme","public":true}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := editConfig{ + opts: editOpts{ + number: 1, + owner: "monalisa", + title: "a new title", + shortDescription: "a new description", + visibility: "PUBLIC", + readme: "a new readme", + }, + client: client, + io: ios, + } + + err := runEdit(config) + assert.NoError(t, err) + assert.Equal( + t, + "Updated project http://a-url.com\n", + stdout.String()) +} + +func TestRunUpdate_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get org project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // edit project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","title":"a new title","shortDescription":"a new description","readme":"a new readme","public":true}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := editConfig{ + opts: editOpts{ + number: 1, + owner: "github", + title: "a new title", + shortDescription: "a new description", + visibility: "PUBLIC", + readme: "a new readme", + }, + client: client, + io: ios, + } + + err := runEdit(config) + assert.NoError(t, err) + assert.Equal( + t, + "Updated project http://a-url.com\n", + stdout.String()) +} + +func TestRunUpdate_Me(t *testing.T) { + defer gock.Off() + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + gock.Observe(gock.DumpRequest) + // get viewer project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // edit project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","title":"a new title","shortDescription":"a new description","readme":"a new readme","public":false}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "me", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := editConfig{ + opts: editOpts{ + number: 1, + owner: "@me", + title: "a new title", + shortDescription: "a new description", + visibility: "PRIVATE", + readme: "a new readme", + }, + client: client, + io: ios, + } + + err := runEdit(config) + assert.NoError(t, err) + assert.Equal( + t, + "Updated project http://a-url.com\n", + stdout.String()) +} + +func TestRunUpdate_OmitParams(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get user project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]string{ + "id": "an ID", + }, + }, + }, + }) + + // Update project + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateProjectV2.*"variables":{"afterFields":null,"afterItems":null,"firstFields":0,"firstItems":0,"input":{"projectId":"an ID","title":"another title"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "title": "a title", + "url": "http://a-url.com", + "owner": map[string]string{ + "login": "monalisa", + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := editConfig{ + opts: editOpts{ + number: 1, + owner: "monalisa", + title: "another title", + }, + client: client, + io: ios, + } + + err := runEdit(config) + assert.NoError(t, err) + assert.Equal( + t, + "Updated project http://a-url.com\n", + stdout.String()) +} diff --git a/pkg/cmd/project/field-create/field_create.go b/pkg/cmd/project/field-create/field_create.go new file mode 100644 index 000000000..d369148ba --- /dev/null +++ b/pkg/cmd/project/field-create/field_create.go @@ -0,0 +1,163 @@ +package fieldcreate + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type createFieldOpts struct { + name string + dataType string + owner string + singleSelectOptions []string + number int32 + projectID string + format string +} + +type createFieldConfig struct { + client *queries.Client + opts createFieldOpts + io *iostreams.IOStreams +} + +type createProjectV2FieldMutation struct { + CreateProjectV2Field struct { + Field queries.ProjectField `graphql:"projectV2Field"` + } `graphql:"createProjectV2Field(input:$input)"` +} + +func NewCmdCreateField(f *cmdutil.Factory, runF func(config createFieldConfig) error) *cobra.Command { + opts := createFieldOpts{} + createFieldCmd := &cobra.Command{ + Short: "Create a field in a project", + Use: "field-create []", + Example: heredoc.Doc(` + # create a field in the current user's project "1" + gh project field-create 1 --owner "@me" --name "new field" --data-type "text" + + # create a field with three options to select from for owner monalisa + gh project field-create 1 --owner monalisa --name "new field" --data-type "SINGLE_SELECT" --single-select-options "one,two,three" + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := createFieldConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + if config.opts.dataType == "SINGLE_SELECT" && len(config.opts.singleSelectOptions) == 0 { + return fmt.Errorf("passing `--single-select-options` is required for SINGLE_SELECT data type") + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runCreateField(config) + }, + } + + createFieldCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + createFieldCmd.Flags().StringVar(&opts.name, "name", "", "Name of the new field") + cmdutil.StringEnumFlag(createFieldCmd, &opts.dataType, "data-type", "", "", []string{"TEXT", "SINGLE_SELECT", "DATE", "NUMBER"}, "DataType of the new field.") + createFieldCmd.Flags().StringSliceVar(&opts.singleSelectOptions, "single-select-options", []string{}, "Options for SINGLE_SELECT data type") + cmdutil.StringEnumFlag(createFieldCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + _ = createFieldCmd.MarkFlagRequired("name") + _ = createFieldCmd.MarkFlagRequired("data-type") + + return createFieldCmd +} + +func runCreateField(config createFieldConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectID = project.ID + + query, variables := createFieldArgs(config) + + err = config.client.Mutate("CreateField", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.CreateProjectV2Field.Field) + } + + return printResults(config, query.CreateProjectV2Field.Field) +} + +func createFieldArgs(config createFieldConfig) (*createProjectV2FieldMutation, map[string]interface{}) { + input := githubv4.CreateProjectV2FieldInput{ + ProjectID: githubv4.ID(config.opts.projectID), + DataType: githubv4.ProjectV2CustomFieldType(config.opts.dataType), + Name: githubv4.String(config.opts.name), + } + + if len(config.opts.singleSelectOptions) != 0 { + opts := make([]githubv4.ProjectV2SingleSelectFieldOptionInput, 0) + for _, opt := range config.opts.singleSelectOptions { + opts = append(opts, githubv4.ProjectV2SingleSelectFieldOptionInput{ + Name: githubv4.String(opt), + Color: githubv4.ProjectV2SingleSelectFieldOptionColor("GRAY"), + }) + } + input.SingleSelectOptions = &opts + } + + return &createProjectV2FieldMutation{}, map[string]interface{}{ + "input": input, + } +} + +func printResults(config createFieldConfig, field queries.ProjectField) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Created field\n") + return err +} + +func printJSON(config createFieldConfig, field queries.ProjectField) error { + b, err := format.JSONProjectField(field) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/field-create/field_create_test.go b/pkg/cmd/project/field-create/field_create_test.go new file mode 100644 index 000000000..31328a04f --- /dev/null +++ b/pkg/cmd/project/field-create/field_create_test.go @@ -0,0 +1,632 @@ +package fieldcreate + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdCreateField(t *testing.T) { + tests := []struct { + name string + cli string + wants createFieldOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "missing-name-and-data-type", + cli: "", + wantsErr: true, + wantsErrMsg: "required flag(s) \"data-type\", \"name\" not set", + }, + { + name: "not-a-number", + cli: "x --name n --data-type TEXT", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "single-select-no-options", + cli: "123 --name n --data-type SINGLE_SELECT", + wantsErr: true, + wantsErrMsg: "passing `--single-select-options` is required for SINGLE_SELECT data type", + }, + { + name: "number", + cli: "123 --name n --data-type TEXT", + wants: createFieldOpts{ + number: 123, + name: "n", + dataType: "TEXT", + singleSelectOptions: []string{}, + }, + }, + { + name: "owner", + cli: "--owner monalisa --name n --data-type TEXT", + wants: createFieldOpts{ + owner: "monalisa", + name: "n", + dataType: "TEXT", + singleSelectOptions: []string{}, + }, + }, + { + name: "single-select-options", + cli: "--name n --data-type TEXT --single-select-options a,b", + wants: createFieldOpts{ + singleSelectOptions: []string{"a", "b"}, + name: "n", + dataType: "TEXT", + }, + }, + { + name: "json", + cli: "--format json --name n --data-type TEXT ", + wants: createFieldOpts{ + format: "json", + name: "n", + dataType: "TEXT", + singleSelectOptions: []string{}, + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 createFieldOpts + cmd := NewCmdCreateField(f, func(config createFieldConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.name, gotOpts.name) + assert.Equal(t, tt.wants.dataType, gotOpts.dataType) + assert.Equal(t, tt.wants.singleSelectOptions, gotOpts.singleSelectOptions) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunCreateField_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateField.*","variables":{"input":{"projectId":"an ID","dataType":"TEXT","name":"a name"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "id": "Field ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createFieldConfig{ + opts: createFieldOpts{ + name: "a name", + owner: "monalisa", + number: 1, + dataType: "TEXT", + }, + client: client, + io: ios, + } + + err := runCreateField(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created field\n", + stdout.String()) +} + +func TestRunCreateField_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateField.*","variables":{"input":{"projectId":"an ID","dataType":"TEXT","name":"a name"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "id": "Field ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createFieldConfig{ + opts: createFieldOpts{ + name: "a name", + owner: "github", + number: 1, + dataType: "TEXT", + }, + client: client, + io: ios, + } + + err := runCreateField(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created field\n", + stdout.String()) +} + +func TestRunCreateField_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateField.*","variables":{"input":{"projectId":"an ID","dataType":"TEXT","name":"a name"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "id": "Field ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createFieldConfig{ + opts: createFieldOpts{ + owner: "@me", + number: 1, + name: "a name", + dataType: "TEXT", + }, + client: client, + io: ios, + } + + err := runCreateField(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created field\n", + stdout.String()) +} + +func TestRunCreateField_TEXT(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateField.*","variables":{"input":{"projectId":"an ID","dataType":"TEXT","name":"a name"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "id": "Field ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createFieldConfig{ + opts: createFieldOpts{ + owner: "@me", + number: 1, + name: "a name", + dataType: "TEXT", + }, + client: client, + io: ios, + } + + err := runCreateField(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created field\n", + stdout.String()) +} + +func TestRunCreateField_DATE(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateField.*","variables":{"input":{"projectId":"an ID","dataType":"DATE","name":"a name"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "id": "Field ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createFieldConfig{ + opts: createFieldOpts{ + owner: "@me", + number: 1, + name: "a name", + dataType: "DATE", + }, + client: client, + io: ios, + } + + err := runCreateField(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created field\n", + stdout.String()) +} + +func TestRunCreateField_NUMBER(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateField.*","variables":{"input":{"projectId":"an ID","dataType":"NUMBER","name":"a name"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "createProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "id": "Field ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createFieldConfig{ + opts: createFieldOpts{ + owner: "@me", + number: 1, + name: "a name", + dataType: "NUMBER", + }, + client: client, + io: ios, + } + + err := runCreateField(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created field\n", + stdout.String()) +} diff --git a/pkg/cmd/project/field-delete/field_delete.go b/pkg/cmd/project/field-delete/field_delete.go new file mode 100644 index 000000000..3d3bb25ce --- /dev/null +++ b/pkg/cmd/project/field-delete/field_delete.go @@ -0,0 +1,105 @@ +package fielddelete + +import ( + "fmt" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type deleteFieldOpts struct { + fieldID string + format string +} + +type deleteFieldConfig struct { + client *queries.Client + opts deleteFieldOpts + io *iostreams.IOStreams +} + +type deleteProjectV2FieldMutation struct { + DeleteProjectV2Field struct { + Field queries.ProjectField `graphql:"projectV2Field"` + } `graphql:"deleteProjectV2Field(input:$input)"` +} + +func NewCmdDeleteField(f *cmdutil.Factory, runF func(config deleteFieldConfig) error) *cobra.Command { + opts := deleteFieldOpts{} + deleteFieldCmd := &cobra.Command{ + Short: "Delete a field in a project", + Use: "field-delete", + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + config := deleteFieldConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runDeleteField(config) + }, + } + + deleteFieldCmd.Flags().StringVar(&opts.fieldID, "id", "", "ID of the field to delete") + cmdutil.StringEnumFlag(deleteFieldCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + _ = deleteFieldCmd.MarkFlagRequired("id") + + return deleteFieldCmd +} + +func runDeleteField(config deleteFieldConfig) error { + query, variables := deleteFieldArgs(config) + + err := config.client.Mutate("DeleteField", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.DeleteProjectV2Field.Field) + } + + return printResults(config, query.DeleteProjectV2Field.Field) +} + +func deleteFieldArgs(config deleteFieldConfig) (*deleteProjectV2FieldMutation, map[string]interface{}) { + return &deleteProjectV2FieldMutation{}, map[string]interface{}{ + "input": githubv4.DeleteProjectV2FieldInput{ + FieldID: githubv4.ID(config.opts.fieldID), + }, + } +} + +func printResults(config deleteFieldConfig, field queries.ProjectField) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Deleted field\n") + return err +} + +func printJSON(config deleteFieldConfig, field queries.ProjectField) error { + b, err := format.JSONProjectField(field) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/field-delete/field_delete_test.go b/pkg/cmd/project/field-delete/field_delete_test.go new file mode 100644 index 000000000..61783d44d --- /dev/null +++ b/pkg/cmd/project/field-delete/field_delete_test.go @@ -0,0 +1,117 @@ +package fielddelete + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdDeleteField(t *testing.T) { + tests := []struct { + name string + cli string + wants deleteFieldOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "no id", + cli: "", + wantsErr: true, + wantsErrMsg: "required flag(s) \"id\" not set", + }, + { + name: "id", + cli: "--id 123", + wants: deleteFieldOpts{ + fieldID: "123", + }, + }, + { + name: "json", + cli: "--id 123 --format json", + wants: deleteFieldOpts{ + format: "json", + fieldID: "123", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 deleteFieldOpts + cmd := NewCmdDeleteField(f, func(config deleteFieldConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.fieldID, gotOpts.fieldID) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunDeleteField(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // delete Field + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteField.*","variables":{"input":{"fieldId":"an ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2Field": map[string]interface{}{ + "projectV2Field": map[string]interface{}{ + "id": "Field ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := deleteFieldConfig{ + opts: deleteFieldOpts{ + fieldID: "an ID", + }, + client: client, + io: ios, + } + + err := runDeleteField(config) + assert.NoError(t, err) + assert.Equal( + t, + "Deleted field\n", + stdout.String()) +} diff --git a/pkg/cmd/project/field-list/field_list.go b/pkg/cmd/project/field-list/field_list.go new file mode 100644 index 000000000..152d90fcd --- /dev/null +++ b/pkg/cmd/project/field-list/field_list.go @@ -0,0 +1,132 @@ +package fieldlist + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/spf13/cobra" +) + +type listOpts struct { + limit int + owner string + number int32 + format string +} + +type listConfig struct { + io *iostreams.IOStreams + tp *tableprinter.TablePrinter + client *queries.Client + opts listOpts +} + +func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.Command { + opts := listOpts{} + listCmd := &cobra.Command{ + Short: "List the fields in a project", + Use: "field-list number", + Example: heredoc.Doc(` + # list fields in the current user's project "1" + gh project field-list 1 --owner "@me" + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + t := tableprinter.New(f.IOStreams) + config := listConfig{ + io: f.IOStreams, + tp: t, + client: client, + opts: opts, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runList(config) + }, + } + + listCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + cmdutil.StringEnumFlag(listCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + listCmd.Flags().IntVarP(&opts.limit, "limit", "L", queries.LimitDefault, "Maximum number of fields to fetch") + + return listCmd +} + +func runList(config listConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + // no need to fetch the project if we already have the number + if config.opts.number == 0 { + canPrompt := config.io.CanPrompt() + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.number = project.Number + } + + project, err := config.client.ProjectFields(owner, config.opts.number, config.opts.limit) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, project) + } + + return printResults(config, project.Fields.Nodes, owner.Login) +} + +func printResults(config listConfig, fields []queries.ProjectField, login string) error { + if len(fields) == 0 { + return cmdutil.NewNoResultsError(fmt.Sprintf("Project %d for owner %s has no fields", config.opts.number, login)) + } + + config.tp.HeaderRow("Name", "Data type", "ID") + + for _, f := range fields { + config.tp.AddField(f.Name()) + config.tp.AddField(f.Type()) + config.tp.AddField(f.ID(), tableprinter.WithTruncate(nil)) + config.tp.EndRow() + } + + return config.tp.Render() +} + +func printJSON(config listConfig, project *queries.Project) error { + b, err := format.JSONProjectFields(project) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/field-list/field_list_test.go b/pkg/cmd/project/field-list/field_list_test.go new file mode 100644 index 000000000..60e61188d --- /dev/null +++ b/pkg/cmd/project/field-list/field_list_test.go @@ -0,0 +1,425 @@ +package fieldlist + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdList(t *testing.T) { + tests := []struct { + name string + cli string + wants listOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "not-a-number", + cli: "x", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "number", + cli: "123", + wants: listOpts{ + number: 123, + limit: 30, + }, + }, + { + name: "owner", + cli: "--owner monalisa", + wants: listOpts{ + owner: "monalisa", + limit: 30, + }, + }, + { + name: "json", + cli: "--format json", + wants: listOpts{ + format: "json", + limit: 30, + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 listOpts + cmd := NewCmdList(f, func(config listConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Equal(t, tt.wantsErrMsg, err.Error()) + assert.Error(t, err) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.limit, gotOpts.limit) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunList_User(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": queries.LimitMax, + "afterItems": nil, + "firstFields": queries.LimitDefault, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "__typename": "ProjectV2Field", + "name": "FieldTitle", + "id": "field ID", + }, + { + "__typename": "ProjectV2SingleSelectField", + "name": "Status", + "id": "status ID", + }, + { + "__typename": "ProjectV2IterationField", + "name": "Iterations", + "id": "iteration ID", + }, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + number: 1, + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "FieldTitle\tProjectV2Field\tfield ID\nStatus\tProjectV2SingleSelectField\tstatus ID\nIterations\tProjectV2IterationField\titeration ID\n", + stdout.String()) +} + +func TestRunList_Org(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": queries.LimitMax, + "afterItems": nil, + "firstFields": queries.LimitDefault, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "__typename": "ProjectV2Field", + "name": "FieldTitle", + "id": "field ID", + }, + { + "__typename": "ProjectV2SingleSelectField", + "name": "Status", + "id": "status ID", + }, + { + "__typename": "ProjectV2IterationField", + "name": "Iterations", + "id": "iteration ID", + }, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + number: 1, + owner: "github", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "FieldTitle\tProjectV2Field\tfield ID\nStatus\tProjectV2SingleSelectField\tstatus ID\nIterations\tProjectV2IterationField\titeration ID\n", + stdout.String()) +} + +func TestRunList_Me(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": queries.LimitMax, + "afterItems": nil, + "firstFields": queries.LimitDefault, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "__typename": "ProjectV2Field", + "name": "FieldTitle", + "id": "field ID", + }, + { + "__typename": "ProjectV2SingleSelectField", + "name": "Status", + "id": "status ID", + }, + { + "__typename": "ProjectV2IterationField", + "name": "Iterations", + "id": "iteration ID", + }, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + number: 1, + owner: "@me", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "FieldTitle\tProjectV2Field\tfield ID\nStatus\tProjectV2SingleSelectField\tstatus ID\nIterations\tProjectV2IterationField\titeration ID\n", + stdout.String()) +} + +func TestRunList_Empty(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": queries.LimitMax, + "afterItems": nil, + "firstFields": queries.LimitDefault, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": nil, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, _, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + number: 1, + owner: "@me", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.EqualError( + t, + err, + "Project 1 for owner @me has no fields") +} diff --git a/pkg/cmd/project/item-add/item_add.go b/pkg/cmd/project/item-add/item_add.go new file mode 100644 index 000000000..51c9ecfce --- /dev/null +++ b/pkg/cmd/project/item-add/item_add.go @@ -0,0 +1,144 @@ +package itemadd + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type addItemOpts struct { + owner string + number int32 + itemURL string + projectID string + itemID string + format string +} + +type addItemConfig struct { + client *queries.Client + opts addItemOpts + io *iostreams.IOStreams +} + +type addProjectItemMutation struct { + CreateProjectItem struct { + ProjectV2Item queries.ProjectItem `graphql:"item"` + } `graphql:"addProjectV2ItemById(input:$input)"` +} + +func NewCmdAddItem(f *cmdutil.Factory, runF func(config addItemConfig) error) *cobra.Command { + opts := addItemOpts{} + addItemCmd := &cobra.Command{ + Short: "Add a pull request or an issue to a project", + Use: "item-add []", + Example: heredoc.Doc(` + # add an item to monalisa's project "1" + gh project item-add 1 --owner monalisa --url https://github.com/monalisa/myproject/issues/23 + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := addItemConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runAddItem(config) + }, + } + + addItemCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + addItemCmd.Flags().StringVar(&opts.itemURL, "url", "", "URL of the issue or pull request to add to the project") + cmdutil.StringEnumFlag(addItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + _ = addItemCmd.MarkFlagRequired("url") + + return addItemCmd +} + +func runAddItem(config addItemConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectID = project.ID + + itemID, err := config.client.IssueOrPullRequestID(config.opts.itemURL) + if err != nil { + return err + } + config.opts.itemID = itemID + + query, variables := addItemArgs(config) + err = config.client.Mutate("AddItem", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.CreateProjectItem.ProjectV2Item) + } + + return printResults(config, query.CreateProjectItem.ProjectV2Item) + +} + +func addItemArgs(config addItemConfig) (*addProjectItemMutation, map[string]interface{}) { + return &addProjectItemMutation{}, map[string]interface{}{ + "input": githubv4.AddProjectV2ItemByIdInput{ + ProjectID: githubv4.ID(config.opts.projectID), + ContentID: githubv4.ID(config.opts.itemID), + }, + } +} + +func printResults(config addItemConfig, item queries.ProjectItem) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Added item\n") + return err +} + +func printJSON(config addItemConfig, item queries.ProjectItem) error { + b, err := format.JSONProjectItem(item) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/item-add/item_add_test.go b/pkg/cmd/project/item-add/item_add_test.go new file mode 100644 index 000000000..4f1ebd4f6 --- /dev/null +++ b/pkg/cmd/project/item-add/item_add_test.go @@ -0,0 +1,426 @@ +package itemadd + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdaddItem(t *testing.T) { + tests := []struct { + name string + cli string + wants addItemOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "missing-url", + cli: "", + wantsErr: true, + wantsErrMsg: "required flag(s) \"url\" not set", + }, + { + name: "not-a-number", + cli: "x --url github.com/cli/cli", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "url", + cli: "--url github.com/cli/cli", + wants: addItemOpts{ + itemURL: "github.com/cli/cli", + }, + }, + { + name: "number", + cli: "123 --url github.com/cli/cli", + wants: addItemOpts{ + number: 123, + itemURL: "github.com/cli/cli", + }, + }, + { + name: "owner", + cli: "--owner monalisa --url github.com/cli/cli", + wants: addItemOpts{ + owner: "monalisa", + itemURL: "github.com/cli/cli", + }, + }, + { + name: "json", + cli: "--format json --url github.com/cli/cli", + wants: addItemOpts{ + format: "json", + itemURL: "github.com/cli/cli", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 addItemOpts + cmd := NewCmdAddItem(f, func(config addItemConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.itemURL, gotOpts.itemURL) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunAddItem_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // get item ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query GetIssueOrPullRequest.*", + "variables": map[string]interface{}{ + "url": "https://github.com/cli/go-gh/issues/1", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "resource": map[string]interface{}{ + "id": "item ID", + "__typename": "Issue", + }, + }, + }) + + // create item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation AddItem.*","variables":{"input":{"projectId":"an ID","contentId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "addProjectV2ItemById": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := addItemConfig{ + opts: addItemOpts{ + owner: "monalisa", + number: 1, + itemURL: "https://github.com/cli/go-gh/issues/1", + }, + client: client, + io: ios, + } + + err := runAddItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Added item\n", + stdout.String()) +} + +func TestRunAddItem_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // get item ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query GetIssueOrPullRequest.*", + "variables": map[string]interface{}{ + "url": "https://github.com/cli/go-gh/issues/1", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "resource": map[string]interface{}{ + "id": "item ID", + "__typename": "Issue", + }, + }, + }) + + // create item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation AddItem.*","variables":{"input":{"projectId":"an ID","contentId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "addProjectV2ItemById": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := addItemConfig{ + opts: addItemOpts{ + owner: "github", + number: 1, + itemURL: "https://github.com/cli/go-gh/issues/1", + }, + client: client, + io: ios, + } + + err := runAddItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Added item\n", + stdout.String()) +} + +func TestRunAddItem_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // get item ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query GetIssueOrPullRequest.*", + "variables": map[string]interface{}{ + "url": "https://github.com/cli/go-gh/pull/1", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "resource": map[string]interface{}{ + "id": "item ID", + "__typename": "PullRequest", + }, + }, + }) + + // create item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation AddItem.*","variables":{"input":{"projectId":"an ID","contentId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "addProjectV2ItemById": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := addItemConfig{ + opts: addItemOpts{ + owner: "@me", + number: 1, + itemURL: "https://github.com/cli/go-gh/pull/1", + }, + client: client, + io: ios, + } + + err := runAddItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Added item\n", + stdout.String()) +} diff --git a/pkg/cmd/project/item-archive/item_archive.go b/pkg/cmd/project/item-archive/item_archive.go new file mode 100644 index 000000000..7ae336242 --- /dev/null +++ b/pkg/cmd/project/item-archive/item_archive.go @@ -0,0 +1,171 @@ +package itemarchive + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type archiveItemOpts struct { + owner string + number int32 + undo bool + itemID string + projectID string + format string +} + +type archiveItemConfig struct { + client *queries.Client + opts archiveItemOpts + io *iostreams.IOStreams +} + +type archiveProjectItemMutation struct { + ArchiveProjectItem struct { + ProjectV2Item queries.ProjectItem `graphql:"item"` + } `graphql:"archiveProjectV2Item(input:$input)"` +} + +type unarchiveProjectItemMutation struct { + UnarchiveProjectItem struct { + ProjectV2Item queries.ProjectItem `graphql:"item"` + } `graphql:"unarchiveProjectV2Item(input:$input)"` +} + +func NewCmdArchiveItem(f *cmdutil.Factory, runF func(config archiveItemConfig) error) *cobra.Command { + opts := archiveItemOpts{} + archiveItemCmd := &cobra.Command{ + Short: "Archive an item in a project", + Use: "item-archive []", + Example: heredoc.Doc(` + # archive an item in the current user's project "1" + gh project item-archive 1 --owner "@me" --id + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := archiveItemConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runArchiveItem(config) + }, + } + + archiveItemCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + archiveItemCmd.Flags().StringVar(&opts.itemID, "id", "", "ID of the item to archive") + archiveItemCmd.Flags().BoolVar(&opts.undo, "undo", false, "Unarchive an item") + cmdutil.StringEnumFlag(archiveItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + _ = archiveItemCmd.MarkFlagRequired("id") + + return archiveItemCmd +} + +func runArchiveItem(config archiveItemConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectID = project.ID + + if config.opts.undo { + query, variables := unarchiveItemArgs(config, config.opts.itemID) + err = config.client.Mutate("UnarchiveProjectItem", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.UnarchiveProjectItem.ProjectV2Item) + } + + return printResults(config, query.UnarchiveProjectItem.ProjectV2Item) + } + query, variables := archiveItemArgs(config) + err = config.client.Mutate("ArchiveProjectItem", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.ArchiveProjectItem.ProjectV2Item) + } + + return printResults(config, query.ArchiveProjectItem.ProjectV2Item) +} + +func archiveItemArgs(config archiveItemConfig) (*archiveProjectItemMutation, map[string]interface{}) { + return &archiveProjectItemMutation{}, map[string]interface{}{ + "input": githubv4.ArchiveProjectV2ItemInput{ + ProjectID: githubv4.ID(config.opts.projectID), + ItemID: githubv4.ID(config.opts.itemID), + }, + } +} + +func unarchiveItemArgs(config archiveItemConfig, itemID string) (*unarchiveProjectItemMutation, map[string]interface{}) { + return &unarchiveProjectItemMutation{}, map[string]interface{}{ + "input": githubv4.UnarchiveProjectV2ItemInput{ + ProjectID: githubv4.ID(config.opts.projectID), + ItemID: githubv4.ID(itemID), + }, + } +} + +func printResults(config archiveItemConfig, item queries.ProjectItem) error { + if !config.io.IsStdoutTTY() { + return nil + } + + if config.opts.undo { + _, err := fmt.Fprintf(config.io.Out, "Unarchived item\n") + return err + } + + _, err := fmt.Fprintf(config.io.Out, "Archived item\n") + return err +} + +func printJSON(config archiveItemConfig, item queries.ProjectItem) error { + b, err := format.JSONProjectItem(item) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/item-archive/item_archive_test.go b/pkg/cmd/project/item-archive/item_archive_test.go new file mode 100644 index 000000000..85a34af22 --- /dev/null +++ b/pkg/cmd/project/item-archive/item_archive_test.go @@ -0,0 +1,639 @@ +package itemarchive + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdarchiveItem(t *testing.T) { + tests := []struct { + name string + cli string + wants archiveItemOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "missing-id", + cli: "", + wantsErr: true, + wantsErrMsg: "required flag(s) \"id\" not set", + }, + { + name: "not-a-number", + cli: "x --id 123", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "id", + cli: "--id 123", + wants: archiveItemOpts{ + itemID: "123", + }, + }, + { + name: "number", + cli: "456 --id 123", + wants: archiveItemOpts{ + number: 456, + itemID: "123", + }, + }, + { + name: "owner", + cli: "--owner monalisa --id 123", + wants: archiveItemOpts{ + owner: "monalisa", + itemID: "123", + }, + }, + { + name: "undo", + cli: "--undo --id 123", + wants: archiveItemOpts{ + undo: true, + itemID: "123", + }, + }, + { + name: "json", + cli: "--format json --id 123", + wants: archiveItemOpts{ + format: "json", + itemID: "123", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 archiveItemOpts + cmd := NewCmdArchiveItem(f, func(config archiveItemConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.itemID, gotOpts.itemID) + assert.Equal(t, tt.wants.undo, gotOpts.undo) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunArchive_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // archive item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation ArchiveProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "archiveProjectV2Item": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := archiveItemConfig{ + opts: archiveItemOpts{ + owner: "monalisa", + number: 1, + itemID: "item ID", + }, + client: client, + io: ios, + } + + err := runArchiveItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Archived item\n", + stdout.String()) +} + +func TestRunArchive_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // archive item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation ArchiveProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "archiveProjectV2Item": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := archiveItemConfig{ + opts: archiveItemOpts{ + owner: "github", + number: 1, + itemID: "item ID", + }, + client: client, + io: ios, + } + + err := runArchiveItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Archived item\n", + stdout.String()) +} + +func TestRunArchive_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // archive item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation ArchiveProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "archiveProjectV2Item": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := archiveItemConfig{ + opts: archiveItemOpts{ + owner: "@me", + number: 1, + itemID: "item ID", + }, + client: client, + io: ios, + } + + err := runArchiveItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Archived item\n", + stdout.String()) +} + +func TestRunArchive_User_Undo(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // archive item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UnarchiveProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "unarchiveProjectV2Item": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := archiveItemConfig{ + opts: archiveItemOpts{ + owner: "monalisa", + number: 1, + itemID: "item ID", + undo: true, + }, + client: client, + io: ios, + } + + err := runArchiveItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Unarchived item\n", + stdout.String()) +} + +func TestRunArchive_Org_Undo(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // archive item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UnarchiveProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "unarchiveProjectV2Item": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := archiveItemConfig{ + opts: archiveItemOpts{ + owner: "github", + number: 1, + itemID: "item ID", + undo: true, + }, + client: client, + io: ios, + } + + err := runArchiveItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Unarchived item\n", + stdout.String()) +} + +func TestRunArchive_Me_Undo(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // archive item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UnarchiveProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "unarchiveProjectV2Item": map[string]interface{}{ + "item": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := archiveItemConfig{ + opts: archiveItemOpts{ + owner: "@me", + number: 1, + itemID: "item ID", + undo: true, + }, + client: client, + io: ios, + } + + err := runArchiveItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Unarchived item\n", + stdout.String()) +} diff --git a/pkg/cmd/project/item-create/item_create.go b/pkg/cmd/project/item-create/item_create.go new file mode 100644 index 000000000..6ee32e9f6 --- /dev/null +++ b/pkg/cmd/project/item-create/item_create.go @@ -0,0 +1,140 @@ +package itemcreate + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type createItemOpts struct { + title string + body string + owner string + number int32 + projectID string + format string +} + +type createItemConfig struct { + client *queries.Client + opts createItemOpts + io *iostreams.IOStreams +} + +type createProjectDraftItemMutation struct { + CreateProjectDraftItem struct { + ProjectV2Item queries.ProjectItem `graphql:"projectItem"` + } `graphql:"addProjectV2DraftIssue(input:$input)"` +} + +func NewCmdCreateItem(f *cmdutil.Factory, runF func(config createItemConfig) error) *cobra.Command { + opts := createItemOpts{} + createItemCmd := &cobra.Command{ + Short: "Create a draft issue item in a project", + Use: "item-create []", + Example: heredoc.Doc(` + # create a draft issue in the current user's project "1" + gh project item-create 1 --owner "@me" --title "new item" --body "new item body" + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := createItemConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runCreateItem(config) + }, + } + + createItemCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + createItemCmd.Flags().StringVar(&opts.title, "title", "", "Title for the draft issue") + createItemCmd.Flags().StringVar(&opts.body, "body", "", "Body for the draft issue") + cmdutil.StringEnumFlag(createItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + _ = createItemCmd.MarkFlagRequired("title") + + return createItemCmd +} + +func runCreateItem(config createItemConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectID = project.ID + + query, variables := createDraftIssueArgs(config) + + err = config.client.Mutate("CreateDraftItem", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.CreateProjectDraftItem.ProjectV2Item) + } + + return printResults(config, query.CreateProjectDraftItem.ProjectV2Item) +} + +func createDraftIssueArgs(config createItemConfig) (*createProjectDraftItemMutation, map[string]interface{}) { + return &createProjectDraftItemMutation{}, map[string]interface{}{ + "input": githubv4.AddProjectV2DraftIssueInput{ + Body: githubv4.NewString(githubv4.String(config.opts.body)), + ProjectID: githubv4.ID(config.opts.projectID), + Title: githubv4.String(config.opts.title), + }, + } +} + +func printResults(config createItemConfig, item queries.ProjectItem) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Created item\n") + return err +} + +func printJSON(config createItemConfig, item queries.ProjectItem) error { + b, err := format.JSONProjectItem(item) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/item-create/item_create_test.go b/pkg/cmd/project/item-create/item_create_test.go new file mode 100644 index 000000000..d49144f3c --- /dev/null +++ b/pkg/cmd/project/item-create/item_create_test.go @@ -0,0 +1,374 @@ +package itemcreate + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdCreateItem(t *testing.T) { + tests := []struct { + name string + cli string + wants createItemOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "missing-title", + cli: "", + wantsErr: true, + wantsErrMsg: "required flag(s) \"title\" not set", + }, + { + name: "not-a-number", + cli: "x --title t", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "title", + cli: "--title t", + wants: createItemOpts{ + title: "t", + }, + }, + { + name: "number", + cli: "123 --title t", + wants: createItemOpts{ + number: 123, + title: "t", + }, + }, + { + name: "owner", + cli: "--owner monalisa --title t", + wants: createItemOpts{ + owner: "monalisa", + title: "t", + }, + }, + { + name: "body", + cli: "--body b --title t", + wants: createItemOpts{ + body: "b", + title: "t", + }, + }, + { + name: "json", + cli: "--format json --title t", + wants: createItemOpts{ + format: "json", + title: "t", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 createItemOpts + cmd := NewCmdCreateItem(f, func(config createItemConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.title, gotOpts.title) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunCreateItem_Draft_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateDraftItem.*","variables":{"input":{"projectId":"an ID","title":"a title","body":""}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "addProjectV2DraftIssue": map[string]interface{}{ + "projectItem": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createItemConfig{ + opts: createItemOpts{ + title: "a title", + owner: "monalisa", + number: 1, + }, + client: client, + io: ios, + } + + err := runCreateItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created item\n", + stdout.String()) +} + +func TestRunCreateItem_Draft_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateDraftItem.*","variables":{"input":{"projectId":"an ID","title":"a title","body":""}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "addProjectV2DraftIssue": map[string]interface{}{ + "projectItem": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createItemConfig{ + opts: createItemOpts{ + title: "a title", + owner: "github", + number: 1, + }, + client: client, + io: ios, + } + + err := runCreateItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created item\n", + stdout.String()) +} + +func TestRunCreateItem_Draft_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // create item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation CreateDraftItem.*","variables":{"input":{"projectId":"an ID","title":"a title","body":"a body"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "addProjectV2DraftIssue": map[string]interface{}{ + "projectItem": map[string]interface{}{ + "id": "item ID", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := createItemConfig{ + opts: createItemOpts{ + title: "a title", + owner: "@me", + number: 1, + body: "a body", + }, + client: client, + io: ios, + } + + err := runCreateItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Created item\n", + stdout.String()) +} diff --git a/pkg/cmd/project/item-delete/item_delete.go b/pkg/cmd/project/item-delete/item_delete.go new file mode 100644 index 000000000..2717afedc --- /dev/null +++ b/pkg/cmd/project/item-delete/item_delete.go @@ -0,0 +1,131 @@ +package itemdelete + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type deleteItemOpts struct { + owner string + number int32 + itemID string + projectID string + format string +} + +type deleteItemConfig struct { + client *queries.Client + opts deleteItemOpts + io *iostreams.IOStreams +} + +type deleteProjectItemMutation struct { + DeleteProjectItem struct { + DeletedItemId githubv4.ID `graphql:"deletedItemId"` + } `graphql:"deleteProjectV2Item(input:$input)"` +} + +func NewCmdDeleteItem(f *cmdutil.Factory, runF func(config deleteItemConfig) error) *cobra.Command { + opts := deleteItemOpts{} + deleteItemCmd := &cobra.Command{ + Short: "Delete an item from a project by ID", + Use: "item-delete []", + Example: heredoc.Doc(` + # delete an item in the current user's project "1" + gh project item-delete 1 --owner "@me" --id + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := deleteItemConfig{ + client: client, + opts: opts, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runDeleteItem(config) + }, + } + + deleteItemCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + deleteItemCmd.Flags().StringVar(&opts.itemID, "id", "", "ID of the item to delete") + cmdutil.StringEnumFlag(deleteItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + _ = deleteItemCmd.MarkFlagRequired("id") + + return deleteItemCmd +} + +func runDeleteItem(config deleteItemConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.projectID = project.ID + + query, variables := deleteItemArgs(config) + err = config.client.Mutate("DeleteProjectItem", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, query.DeleteProjectItem.DeletedItemId) + } + + return printResults(config) + +} + +func deleteItemArgs(config deleteItemConfig) (*deleteProjectItemMutation, map[string]interface{}) { + return &deleteProjectItemMutation{}, map[string]interface{}{ + "input": githubv4.DeleteProjectV2ItemInput{ + ProjectID: githubv4.ID(config.opts.projectID), + ItemID: githubv4.ID(config.opts.itemID), + }, + } +} + +func printResults(config deleteItemConfig) error { + if !config.io.IsStdoutTTY() { + return nil + } + + _, err := fmt.Fprintf(config.io.Out, "Deleted item\n") + return err +} + +func printJSON(config deleteItemConfig, ID githubv4.ID) error { + _, err := config.io.Out.Write([]byte(fmt.Sprintf(`{"id": "%s"}`, ID))) + return err +} diff --git a/pkg/cmd/project/item-delete/item_delete_test.go b/pkg/cmd/project/item-delete/item_delete_test.go new file mode 100644 index 000000000..c5a3f01fd --- /dev/null +++ b/pkg/cmd/project/item-delete/item_delete_test.go @@ -0,0 +1,359 @@ +package itemdelete + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdDeleteItem(t *testing.T) { + tests := []struct { + name string + cli string + wants deleteItemOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "missing-id", + cli: "", + wantsErr: true, + wantsErrMsg: "required flag(s) \"id\" not set", + }, + { + name: "not-a-number", + cli: "x --id 123", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "item-id", + cli: "--id 123", + wants: deleteItemOpts{ + itemID: "123", + }, + }, + { + name: "number", + cli: "456 --id 123", + wants: deleteItemOpts{ + number: 456, + itemID: "123", + }, + }, + { + name: "owner", + cli: "--owner monalisa --id 123", + wants: deleteItemOpts{ + owner: "monalisa", + itemID: "123", + }, + }, + { + name: "json", + cli: "--format json --id 123", + wants: deleteItemOpts{ + format: "json", + itemID: "123", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 deleteItemOpts + cmd := NewCmdDeleteItem(f, func(config deleteItemConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.itemID, gotOpts.itemID) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunDelete_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // delete item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2Item": map[string]interface{}{ + "deletedItemId": "item ID", + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := deleteItemConfig{ + opts: deleteItemOpts{ + owner: "monalisa", + number: 1, + itemID: "item ID", + }, + client: client, + io: ios, + } + + err := runDeleteItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Deleted item\n", + stdout.String()) +} + +func TestRunDelete_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query OrgProject.*", + "variables": map[string]interface{}{ + "login": "github", + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // delete item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2Item": map[string]interface{}{ + "deletedItemId": "item ID", + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := deleteItemConfig{ + opts: deleteItemOpts{ + owner: "github", + number: 1, + itemID: "item ID", + }, + client: client, + io: ios, + } + + err := runDeleteItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Deleted item\n", + stdout.String()) +} + +func TestRunDelete_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // get project ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerProject.*", + "variables": map[string]interface{}{ + "number": 1, + "firstItems": 0, + "afterItems": nil, + "firstFields": 0, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "id": "an ID", + }, + }, + }, + }) + + // delete item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation DeleteProjectItem.*","variables":{"input":{"projectId":"an ID","itemId":"item ID"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "deleteProjectV2Item": map[string]interface{}{ + "deletedItemId": "item ID", + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + config := deleteItemConfig{ + opts: deleteItemOpts{ + owner: "@me", + number: 1, + itemID: "item ID", + }, + client: client, + io: ios, + } + + err := runDeleteItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Deleted item\n", + stdout.String()) +} diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go new file mode 100644 index 000000000..3bd479470 --- /dev/null +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -0,0 +1,253 @@ +package itemedit + +import ( + "fmt" + "strings" + "time" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/shurcooL/githubv4" + "github.com/spf13/cobra" +) + +type editItemOpts struct { + // updateDraftIssue + title string + body string + itemID string + // updateItem + fieldID string + projectID string + text string + number float32 + date string + singleSelectOptionID string + iterationID string + // format + format string +} + +type editItemConfig struct { + io *iostreams.IOStreams + client *queries.Client + opts editItemOpts +} + +type EditProjectDraftIssue struct { + UpdateProjectV2DraftIssue struct { + DraftIssue queries.DraftIssue `graphql:"draftIssue"` + } `graphql:"updateProjectV2DraftIssue(input:$input)"` +} + +type UpdateProjectV2FieldValue struct { + Update struct { + Item queries.ProjectItem `graphql:"projectV2Item"` + } `graphql:"updateProjectV2ItemFieldValue(input:$input)"` +} + +func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) *cobra.Command { + opts := editItemOpts{} + editItemCmd := &cobra.Command{ + Use: "item-edit", + Short: "Edit an item in a project", + Long: heredoc.Doc(` + Edit either a draft issue or a project item. Both usages require the ID of the item to edit. + + For non-draft issues, the ID of the project is also required, and only a single field value can be updated per invocation. + `), + Example: heredoc.Doc(` + # edit an item's text field value + gh project item-edit --id --field-id --project-id --text "new text" + `), + RunE: func(cmd *cobra.Command, args []string) error { + if err := cmdutil.MutuallyExclusive( + "only one of `--text`, `--number`, `--date`, `--single-select-option-id` or `--iteration-id` may be used", + opts.text != "", + opts.number != 0, + opts.date != "", + opts.singleSelectOptionID != "", + opts.iterationID != "", + ); err != nil { + return err + } + + client, err := client.New(f) + if err != nil { + return err + } + + config := editItemConfig{ + io: f.IOStreams, + client: client, + opts: opts, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runEditItem(config) + }, + } + + editItemCmd.Flags().StringVar(&opts.itemID, "id", "", "ID of the item to edit") + cmdutil.StringEnumFlag(editItemCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + editItemCmd.Flags().StringVar(&opts.title, "title", "", "Title of the draft issue item") + editItemCmd.Flags().StringVar(&opts.body, "body", "", "Body of the draft issue item") + + editItemCmd.Flags().StringVar(&opts.fieldID, "field-id", "", "ID of the field to update") + editItemCmd.Flags().StringVar(&opts.projectID, "project-id", "", "ID of the project to which the field belongs to") + editItemCmd.Flags().StringVar(&opts.text, "text", "", "Text value for the field") + editItemCmd.Flags().Float32Var(&opts.number, "number", 0, "Number value for the field") + editItemCmd.Flags().StringVar(&opts.date, "date", "", "Date value for the field (YYYY-MM-DD)") + editItemCmd.Flags().StringVar(&opts.singleSelectOptionID, "single-select-option-id", "", "ID of the single select option value to set on the field") + editItemCmd.Flags().StringVar(&opts.iterationID, "iteration-id", "", "ID of the iteration value to set on the field") + + _ = editItemCmd.MarkFlagRequired("id") + + return editItemCmd +} + +func runEditItem(config editItemConfig) error { + // update draft issue + if config.opts.title != "" || config.opts.body != "" { + if !strings.HasPrefix(config.opts.itemID, "DI_") { + return cmdutil.FlagErrorf("ID must be the ID of the draft issue content which is prefixed with `DI_`") + } + + query, variables := buildEditDraftIssue(config) + + err := config.client.Mutate("EditDraftIssueItem", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printDraftIssueJSON(config, query.UpdateProjectV2DraftIssue.DraftIssue) + } + + return printDraftIssueResults(config, query.UpdateProjectV2DraftIssue.DraftIssue) + } + + // update item values + if config.opts.text != "" || config.opts.number != 0 || config.opts.date != "" || config.opts.singleSelectOptionID != "" || config.opts.iterationID != "" { + if config.opts.fieldID == "" { + return cmdutil.FlagErrorf("field-id must be provided") + } + if config.opts.projectID == "" { + // TODO: offer to fetch interactively + return cmdutil.FlagErrorf("project-id must be provided") + } + + var parsedDate time.Time + if config.opts.date != "" { + date, err := time.Parse("2006-01-02", config.opts.date) + if err != nil { + return err + } + parsedDate = date + } + + query, variables := buildUpdateItem(config, parsedDate) + err := config.client.Mutate("UpdateItemValues", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printItemJSON(config, &query.Update.Item) + } + + return printItemResults(config, &query.Update.Item) + } + + if _, err := fmt.Fprintln(config.io.ErrOut, "error: no changes to make"); err != nil { + return err + } + return cmdutil.SilentError +} + +func buildEditDraftIssue(config editItemConfig) (*EditProjectDraftIssue, map[string]interface{}) { + return &EditProjectDraftIssue{}, map[string]interface{}{ + "input": githubv4.UpdateProjectV2DraftIssueInput{ + Body: githubv4.NewString(githubv4.String(config.opts.body)), + DraftIssueID: githubv4.ID(config.opts.itemID), + Title: githubv4.NewString(githubv4.String(config.opts.title)), + }, + } +} + +func buildUpdateItem(config editItemConfig, date time.Time) (*UpdateProjectV2FieldValue, map[string]interface{}) { + var value githubv4.ProjectV2FieldValue + if config.opts.text != "" { + value = githubv4.ProjectV2FieldValue{ + Text: githubv4.NewString(githubv4.String(config.opts.text)), + } + } else if config.opts.number != 0 { + value = githubv4.ProjectV2FieldValue{ + Number: githubv4.NewFloat(githubv4.Float(config.opts.number)), + } + } else if config.opts.date != "" { + value = githubv4.ProjectV2FieldValue{ + Date: githubv4.NewDate(githubv4.Date{Time: date}), + } + } else if config.opts.singleSelectOptionID != "" { + value = githubv4.ProjectV2FieldValue{ + SingleSelectOptionID: githubv4.NewString(githubv4.String(config.opts.singleSelectOptionID)), + } + } else if config.opts.iterationID != "" { + value = githubv4.ProjectV2FieldValue{ + IterationID: githubv4.NewString(githubv4.String(config.opts.iterationID)), + } + } + + return &UpdateProjectV2FieldValue{}, map[string]interface{}{ + "input": githubv4.UpdateProjectV2ItemFieldValueInput{ + ProjectID: githubv4.ID(config.opts.projectID), + ItemID: githubv4.ID(config.opts.itemID), + FieldID: githubv4.ID(config.opts.fieldID), + Value: value, + }, + } +} + +func printDraftIssueResults(config editItemConfig, item queries.DraftIssue) error { + if !config.io.IsStdoutTTY() { + return nil + } + _, err := fmt.Fprintf(config.io.Out, "Edited draft issue %q\n", item.Title) + return err +} + +func printDraftIssueJSON(config editItemConfig, item queries.DraftIssue) error { + b, err := format.JSONProjectDraftIssue(item) + if err != nil { + return err + } + _, err = config.io.Out.Write(b) + return err +} + +func printItemResults(config editItemConfig, item *queries.ProjectItem) error { + if !config.io.IsStdoutTTY() { + return nil + } + _, err := fmt.Fprintf(config.io.Out, "Edited item %q\n", item.Title()) + return err +} + +func printItemJSON(config editItemConfig, item *queries.ProjectItem) error { + b, err := format.JSONProjectItem(*item) + if err != nil { + return err + } + _, err = config.io.Out.Write(b) + return err + +} diff --git a/pkg/cmd/project/item-edit/item_edit_test.go b/pkg/cmd/project/item-edit/item_edit_test.go new file mode 100644 index 000000000..156871f32 --- /dev/null +++ b/pkg/cmd/project/item-edit/item_edit_test.go @@ -0,0 +1,476 @@ +package itemedit + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdeditItem(t *testing.T) { + tests := []struct { + name string + cli string + wants editItemOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "missing-id", + cli: "", + wantsErr: true, + wantsErrMsg: "required flag(s) \"id\" not set", + }, + { + name: "invalid-flags", + cli: "--id 123 --text t --date 2023-01-01", + wantsErr: true, + wantsErrMsg: "only one of `--text`, `--number`, `--date`, `--single-select-option-id` or `--iteration-id` may be used", + }, + { + name: "item-id", + cli: "--id 123", + wants: editItemOpts{ + itemID: "123", + }, + }, + { + name: "number", + cli: "--number 456 --id 123", + wants: editItemOpts{ + number: 456, + itemID: "123", + }, + }, + { + name: "field-id", + cli: "--field-id FIELD_ID --id 123", + wants: editItemOpts{ + fieldID: "FIELD_ID", + itemID: "123", + }, + }, + { + name: "project-id", + cli: "--project-id PROJECT_ID --id 123", + wants: editItemOpts{ + projectID: "PROJECT_ID", + itemID: "123", + }, + }, + { + name: "text", + cli: "--text t --id 123", + wants: editItemOpts{ + text: "t", + itemID: "123", + }, + }, + { + name: "date", + cli: "--date 2023-01-01 --id 123", + wants: editItemOpts{ + date: "2023-01-01", + itemID: "123", + }, + }, + { + name: "single-select-option-id", + cli: "--single-select-option-id OPTION_ID --id 123", + wants: editItemOpts{ + singleSelectOptionID: "OPTION_ID", + itemID: "123", + }, + }, + { + name: "iteration-id", + cli: "--iteration-id ITERATION_ID --id 123", + wants: editItemOpts{ + iterationID: "ITERATION_ID", + itemID: "123", + }, + }, + { + name: "json", + cli: "--format json --id 123", + wants: editItemOpts{ + format: "json", + itemID: "123", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 editItemOpts + cmd := NewCmdEditItem(f, func(config editItemConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.itemID, gotOpts.itemID) + assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wants.title, gotOpts.title) + assert.Equal(t, tt.wants.fieldID, gotOpts.fieldID) + assert.Equal(t, tt.wants.projectID, gotOpts.projectID) + assert.Equal(t, tt.wants.text, gotOpts.text) + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.date, gotOpts.date) + assert.Equal(t, tt.wants.singleSelectOptionID, gotOpts.singleSelectOptionID) + assert.Equal(t, tt.wants.iterationID, gotOpts.iterationID) + }) + } +} + +func TestRunItemEdit_Draft(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // edit item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation EditDraftIssueItem.*","variables":{"input":{"draftIssueId":"DI_item_id","title":"a title","body":"a new body"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2DraftIssue": map[string]interface{}{ + "draftIssue": map[string]interface{}{ + "title": "a title", + "body": "a new body", + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + + config := editItemConfig{ + io: ios, + opts: editItemOpts{ + title: "a title", + body: "a new body", + itemID: "DI_item_id", + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Edited draft issue \"a title\"\n", + stdout.String()) +} + +func TestRunItemEdit_Text(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // edit item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateItemValues.*","variables":{"input":{"projectId":"project_id","itemId":"item_id","fieldId":"field_id","value":{"text":"item text"}}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2ItemFieldValue": map[string]interface{}{ + "projectV2Item": map[string]interface{}{ + "ID": "item_id", + "content": map[string]interface{}{ + "__typename": "Issue", + "body": "body", + "title": "title", + "number": 1, + "repository": map[string]interface{}{ + "nameWithOwner": "my-repo", + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := editItemConfig{ + io: ios, + opts: editItemOpts{ + text: "item text", + itemID: "item_id", + projectID: "project_id", + fieldID: "field_id", + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.Equal(t, "", stdout.String()) +} + +func TestRunItemEdit_Number(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // edit item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateItemValues.*","variables":{"input":{"projectId":"project_id","itemId":"item_id","fieldId":"field_id","value":{"number":2}}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2ItemFieldValue": map[string]interface{}{ + "projectV2Item": map[string]interface{}{ + "ID": "item_id", + "content": map[string]interface{}{ + "__typename": "Issue", + "body": "body", + "title": "title", + "number": 1, + "repository": map[string]interface{}{ + "nameWithOwner": "my-repo", + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + + config := editItemConfig{ + io: ios, + opts: editItemOpts{ + number: 2, + itemID: "item_id", + projectID: "project_id", + fieldID: "field_id", + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Edited item \"title\"\n", + stdout.String()) +} + +func TestRunItemEdit_Date(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // edit item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateItemValues.*","variables":{"input":{"projectId":"project_id","itemId":"item_id","fieldId":"field_id","value":{"date":"2023-01-01T00:00:00Z"}}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2ItemFieldValue": map[string]interface{}{ + "projectV2Item": map[string]interface{}{ + "ID": "item_id", + "content": map[string]interface{}{ + "__typename": "Issue", + "body": "body", + "title": "title", + "number": 1, + "repository": map[string]interface{}{ + "nameWithOwner": "my-repo", + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := editItemConfig{ + io: ios, + opts: editItemOpts{ + date: "2023-01-01", + itemID: "item_id", + projectID: "project_id", + fieldID: "field_id", + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.Equal(t, "", stdout.String()) +} + +func TestRunItemEdit_SingleSelect(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // edit item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateItemValues.*","variables":{"input":{"projectId":"project_id","itemId":"item_id","fieldId":"field_id","value":{"singleSelectOptionId":"option_id"}}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2ItemFieldValue": map[string]interface{}{ + "projectV2Item": map[string]interface{}{ + "ID": "item_id", + "content": map[string]interface{}{ + "__typename": "Issue", + "body": "body", + "title": "title", + "number": 1, + "repository": map[string]interface{}{ + "nameWithOwner": "my-repo", + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := editItemConfig{ + io: ios, + opts: editItemOpts{ + singleSelectOptionID: "option_id", + itemID: "item_id", + projectID: "project_id", + fieldID: "field_id", + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.Equal(t, "", stdout.String()) +} + +func TestRunItemEdit_Iteration(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // edit item + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation UpdateItemValues.*","variables":{"input":{"projectId":"project_id","itemId":"item_id","fieldId":"field_id","value":{"iterationId":"option_id"}}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "updateProjectV2ItemFieldValue": map[string]interface{}{ + "projectV2Item": map[string]interface{}{ + "ID": "item_id", + "content": map[string]interface{}{ + "__typename": "Issue", + "body": "body", + "title": "title", + "number": 1, + "repository": map[string]interface{}{ + "nameWithOwner": "my-repo", + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + ios.SetStdoutTTY(true) + + config := editItemConfig{ + io: ios, + opts: editItemOpts{ + iterationID: "option_id", + itemID: "item_id", + projectID: "project_id", + fieldID: "field_id", + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.Equal( + t, + "Edited item \"title\"\n", + stdout.String()) +} + +func TestRunItemEdit_NoChanges(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + client := queries.NewTestClient() + + ios, _, stdout, stderr := iostreams.Test() + ios.SetStdoutTTY(true) + + config := editItemConfig{ + io: ios, + opts: editItemOpts{}, + client: client, + } + + err := runEditItem(config) + assert.Error(t, err, "SilentError") + assert.Equal(t, "", stdout.String()) + assert.Equal(t, "error: no changes to make\n", stderr.String()) +} + +func TestRunItemEdit_InvalidID(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + client := queries.NewTestClient() + config := editItemConfig{ + opts: editItemOpts{ + title: "a title", + body: "a new body", + itemID: "item_id", + }, + client: client, + } + + err := runEditItem(config) + assert.Error(t, err, "ID must be the ID of the draft issue content which is prefixed with `DI_`") +} diff --git a/pkg/cmd/project/item-list/item_list.go b/pkg/cmd/project/item-list/item_list.go new file mode 100644 index 000000000..4acc95dcb --- /dev/null +++ b/pkg/cmd/project/item-list/item_list.go @@ -0,0 +1,136 @@ +package itemlist + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/spf13/cobra" +) + +type listOpts struct { + limit int + owner string + number int32 + format string +} + +type listConfig struct { + io *iostreams.IOStreams + tp *tableprinter.TablePrinter + client *queries.Client + opts listOpts +} + +func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.Command { + opts := listOpts{} + listCmd := &cobra.Command{ + Short: "List the items in a project", + Use: "item-list []", + Example: heredoc.Doc(` + # list the items in the current users's project "1" + gh project item-list 1 --owner "@me" + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + t := tableprinter.New(f.IOStreams) + config := listConfig{ + io: f.IOStreams, + tp: t, + client: client, + opts: opts, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runList(config) + }, + } + + listCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + cmdutil.StringEnumFlag(listCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + listCmd.Flags().IntVarP(&opts.limit, "limit", "L", queries.LimitDefault, "Maximum number of items to fetch") + + return listCmd +} + +func runList(config listConfig) error { + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + // no need to fetch the project if we already have the number + if config.opts.number == 0 { + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, false) + if err != nil { + return err + } + config.opts.number = project.Number + } + + project, err := config.client.ProjectItems(owner, config.opts.number, config.opts.limit) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, project) + } + + return printResults(config, project.Items.Nodes, owner.Login) +} + +func printResults(config listConfig, items []queries.ProjectItem, login string) error { + if len(items) == 0 { + return cmdutil.NewNoResultsError(fmt.Sprintf("Project %d for owner %s has no items", config.opts.number, login)) + } + + config.tp.HeaderRow("Type", "Title", "Number", "Repository", "ID") + + for _, i := range items { + config.tp.AddField(i.Type()) + config.tp.AddField(i.Title()) + if i.Number() == 0 { + config.tp.AddField("") + } else { + config.tp.AddField(strconv.Itoa(i.Number())) + } + config.tp.AddField(i.Repo()) + config.tp.AddField(i.ID(), tableprinter.WithTruncate(nil)) + config.tp.EndRow() + } + + return config.tp.Render() +} + +func printJSON(config listConfig, project *queries.Project) error { + b, err := format.JSONProjectDetailedItems(project) + if err != nil { + return err + } + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/item-list/item_list_test.go b/pkg/cmd/project/item-list/item_list_test.go new file mode 100644 index 000000000..d618451b1 --- /dev/null +++ b/pkg/cmd/project/item-list/item_list_test.go @@ -0,0 +1,402 @@ +package itemlist + +import ( + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdList(t *testing.T) { + tests := []struct { + name string + cli string + wants listOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "not-a-number", + cli: "x", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "number", + cli: "123", + wants: listOpts{ + number: 123, + limit: 30, + }, + }, + { + name: "owner", + cli: "--owner monalisa", + wants: listOpts{ + owner: "monalisa", + limit: 30, + }, + }, + { + name: "json", + cli: "--format json", + wants: listOpts{ + format: "json", + limit: 30, + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 listOpts + cmd := NewCmdList(f, func(config listConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wants.limit, gotOpts.limit) + }) + } +} + +func TestRunList_User(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + // list project items + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProjectWithItems.*", + "variables": map[string]interface{}{ + "firstItems": queries.LimitDefault, + "afterItems": nil, + "firstFields": queries.LimitMax, + "afterFields": nil, + "login": "monalisa", + "number": 1, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "items": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "issue ID", + "content": map[string]interface{}{ + "__typename": "Issue", + "title": "an issue", + "number": 1, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "pull request ID", + "content": map[string]interface{}{ + "__typename": "PullRequest", + "title": "a pull request", + "number": 2, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "draft issue ID", + "content": map[string]interface{}{ + "title": "draft issue", + "__typename": "DraftIssue", + }, + }, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + number: 1, + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "Issue\tan issue\t1\tcli/go-gh\tissue ID\nPullRequest\ta pull request\t2\tcli/go-gh\tpull request ID\nDraftIssue\tdraft issue\t\t\tdraft issue ID\n", + stdout.String()) +} + +func TestRunList_Org(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + // list project items + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query OrgProjectWithItems.*", + "variables": map[string]interface{}{ + "firstItems": queries.LimitDefault, + "afterItems": nil, + "firstFields": queries.LimitMax, + "afterFields": nil, + "login": "github", + "number": 1, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "items": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "issue ID", + "content": map[string]interface{}{ + "__typename": "Issue", + "title": "an issue", + "number": 1, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "pull request ID", + "content": map[string]interface{}{ + "__typename": "PullRequest", + "title": "a pull request", + "number": 2, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "draft issue ID", + "content": map[string]interface{}{ + "title": "draft issue", + "__typename": "DraftIssue", + }, + }, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + number: 1, + owner: "github", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "Issue\tan issue\t1\tcli/go-gh\tissue ID\nPullRequest\ta pull request\t2\tcli/go-gh\tpull request ID\nDraftIssue\tdraft issue\t\t\tdraft issue ID\n", + stdout.String()) +} + +func TestRunList_Me(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + // list project items + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query ViewerProjectWithItems.*", + "variables": map[string]interface{}{ + "firstItems": queries.LimitDefault, + "afterItems": nil, + "firstFields": queries.LimitMax, + "afterFields": nil, + "number": 1, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "items": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "issue ID", + "content": map[string]interface{}{ + "__typename": "Issue", + "title": "an issue", + "number": 1, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "pull request ID", + "content": map[string]interface{}{ + "__typename": "PullRequest", + "title": "a pull request", + "number": 2, + "repository": map[string]string{ + "nameWithOwner": "cli/go-gh", + }, + }, + }, + { + "id": "draft issue ID", + "content": map[string]interface{}{ + "title": "draft issue", + "__typename": "DraftIssue", + }, + }, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + number: 1, + owner: "@me", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "Issue\tan issue\t1\tcli/go-gh\tissue ID\nPullRequest\ta pull request\t2\tcli/go-gh\tpull request ID\nDraftIssue\tdraft issue\t\t\tdraft issue ID\n", + stdout.String()) +} diff --git a/pkg/cmd/project/list/list.go b/pkg/cmd/project/list/list.go new file mode 100644 index 000000000..661cbcd10 --- /dev/null +++ b/pkg/cmd/project/list/list.go @@ -0,0 +1,186 @@ +package list + +import ( + "fmt" + "strconv" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/spf13/cobra" +) + +type listOpts struct { + limit int + web bool + owner string + closed bool + format string +} + +type listConfig struct { + tp *tableprinter.TablePrinter + client *queries.Client + opts listOpts + URLOpener func(string) error + io *iostreams.IOStreams +} + +func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.Command { + opts := listOpts{} + listCmd := &cobra.Command{ + Short: "List the projects for an owner", + Use: "list", + Example: heredoc.Doc(` + # list the current user's projects + gh project list + + # list the projects for org github including closed projects + gh project list --owner github --closed + `), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + URLOpener := func(url string) error { + return f.Browser.Browse(url) + } + t := tableprinter.New(f.IOStreams) + config := listConfig{ + tp: t, + client: client, + opts: opts, + URLOpener: URLOpener, + io: f.IOStreams, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runList(config) + }, + } + + listCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner") + listCmd.Flags().BoolVarP(&opts.closed, "closed", "", false, "Include closed projects") + listCmd.Flags().BoolVarP(&opts.web, "web", "w", false, "Open projects list in the browser") + cmdutil.StringEnumFlag(listCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + listCmd.Flags().IntVarP(&opts.limit, "limit", "L", queries.LimitDefault, "Maximum number of projects to fetch") + + return listCmd +} + +func runList(config listConfig) error { + if config.opts.web { + url, err := buildURL(config) + if err != nil { + return err + } + + if err := config.URLOpener(url); err != nil { + return err + } + return nil + } + + if config.opts.owner == "" { + config.opts.owner = "@me" + } + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + projects, totalCount, err := config.client.Projects(config.opts.owner, owner.Type, config.opts.limit, false) + if err != nil { + return err + } + projects = filterProjects(projects, config) + + if config.opts.format == "json" { + return printJSON(config, projects, totalCount) + } + + return printResults(config, projects, owner.Login) +} + +// TODO: support non-github.com hostnames +func buildURL(config listConfig) (string, error) { + var url string + if config.opts.owner == "@me" || config.opts.owner == "" { + owner, err := config.client.ViewerLoginName() + if err != nil { + return "", err + } + url = fmt.Sprintf("https://github.com/users/%s/projects", owner) + } else { + _, ownerType, err := config.client.OwnerIDAndType(config.opts.owner) + if err != nil { + return "", err + } + + if ownerType == queries.UserOwner { + url = fmt.Sprintf("https://github.com/users/%s/projects", config.opts.owner) + } else { + url = fmt.Sprintf("https://github.com/orgs/%s/projects", config.opts.owner) + } + } + + if config.opts.closed { + return url + "?query=is%3Aclosed", nil + } + return url, nil +} + +func filterProjects(nodes []queries.Project, config listConfig) []queries.Project { + projects := make([]queries.Project, 0, len(nodes)) + for _, p := range nodes { + if !config.opts.closed && p.Closed { + continue + } + projects = append(projects, p) + } + return projects +} + +func printResults(config listConfig, projects []queries.Project, owner string) error { + if len(projects) == 0 { + return cmdutil.NewNoResultsError(fmt.Sprintf("No projects found for %s", owner)) + } + + config.tp.HeaderRow("Number", "Title", "State", "ID") + + for _, p := range projects { + config.tp.AddField(strconv.Itoa(int(p.Number)), tableprinter.WithTruncate(nil)) + config.tp.AddField(p.Title) + var state string + if p.Closed { + state = "closed" + } else { + state = "open" + } + config.tp.AddField(state) + config.tp.AddField(p.ID, tableprinter.WithTruncate(nil)) + config.tp.EndRow() + } + + return config.tp.Render() +} + +func printJSON(config listConfig, projects []queries.Project, totalCount int) error { + b, err := format.JSONProjects(projects, totalCount) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/list/list_test.go b/pkg/cmd/project/list/list_test.go new file mode 100644 index 000000000..48fb689ed --- /dev/null +++ b/pkg/cmd/project/list/list_test.go @@ -0,0 +1,737 @@ +package list + +import ( + "bytes" + "os" + "testing" + + "github.com/cli/cli/v2/internal/tableprinter" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdlist(t *testing.T) { + tests := []struct { + name string + cli string + wants listOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "owner", + cli: "--owner monalisa", + wants: listOpts{ + owner: "monalisa", + limit: 30, + }, + }, + { + name: "closed", + cli: "--closed", + wants: listOpts{ + closed: true, + limit: 30, + }, + }, + { + name: "web", + cli: "--web", + wants: listOpts{ + web: true, + limit: 30, + }, + }, + { + name: "json", + cli: "--format json", + wants: listOpts{ + format: "json", + limit: 30, + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 listOpts + cmd := NewCmdList(f, func(config listConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.closed, gotOpts.closed) + assert.Equal(t, tt.wants.web, gotOpts.web) + assert.Equal(t, tt.wants.limit, gotOpts.limit) + assert.Equal(t, tt.wants.format, gotOpts.format) + }) + } +} + +func TestRunList(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "title": "Project 1", + "shortDescription": "Short description 1", + "url": "url1", + "closed": false, + "ID": "id-1", + "number": 1, + }, + map[string]interface{}{ + "title": "Project 2", + "shortDescription": "", + "url": "url2", + "closed": true, + "ID": "id-2", + "number": 2, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "1\tProject 1\topen\tid-1\n", + stdout.String()) +} + +func TestRunList_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "title": "Project 1", + "shortDescription": "Short description 1", + "url": "url1", + "closed": false, + "ID": "id-1", + "number": 1, + }, + map[string]interface{}{ + "title": "Project 2", + "shortDescription": "", + "url": "url2", + "closed": true, + "ID": "id-2", + "number": 2, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + owner: "@me", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "1\tProject 1\topen\tid-1\n", + stdout.String()) +} + +func TestRunListViewer(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "title": "Project 1", + "shortDescription": "Short description 1", + "url": "url1", + "closed": false, + "ID": "id-1", + "number": 1, + }, + map[string]interface{}{ + "title": "Project 2", + "shortDescription": "", + "url": "url2", + "closed": true, + "ID": "id-2", + "number": 2, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{}, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "1\tProject 1\topen\tid-1\n", + stdout.String()) +} + +func TestRunListOrg(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "title": "Project 1", + "shortDescription": "Short description 1", + "url": "url1", + "closed": false, + "ID": "id-1", + "number": 1, + }, + map[string]interface{}{ + "title": "Project 2", + "shortDescription": "", + "url": "url2", + "closed": true, + "ID": "id-2", + "number": 2, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + owner: "github", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "1\tProject 1\topen\tid-1\n", + stdout.String()) +} + +func TestRunListEmpty(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query Viewer.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + "login": "theviewer", + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{}, + }, + }, + }, + }) + client := queries.NewTestClient() + + ios, _, _, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{}, + client: client, + io: ios, + } + + err := runList(config) + assert.EqualError( + t, + err, + "No projects found for @me") +} + +func TestRunListWithClosed(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "login": "monalisa", + "projectsV2": map[string]interface{}{ + "nodes": []interface{}{ + map[string]interface{}{ + "title": "Project 1", + "shortDescription": "Short description 1", + "url": "url1", + "closed": false, + "ID": "id-1", + "number": 1, + }, + map[string]interface{}{ + "title": "Project 2", + "shortDescription": "", + "url": "url2", + "closed": true, + "ID": "id-2", + "number": 2, + }, + }, + }, + }, + }, + }) + + client := queries.NewTestClient() + + ios, _, stdout, _ := iostreams.Test() + config := listConfig{ + tp: tableprinter.New(ios), + opts: listOpts{ + owner: "monalisa", + closed: true, + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal( + t, + "1\tProject 1\topen\tid-1\n2\tProject 2\tclosed\tid-2\n", + stdout.String()) +} + +func TestRunListWeb_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + client := queries.NewTestClient() + buf := bytes.Buffer{} + config := listConfig{ + opts: listOpts{ + owner: "monalisa", + web: true, + }, + URLOpener: func(url string) error { + buf.WriteString(url) + return nil + }, + client: client, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/users/monalisa/projects", buf.String()) +} + +func TestRunListWeb_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + client := queries.NewTestClient() + buf := bytes.Buffer{} + config := listConfig{ + opts: listOpts{ + owner: "github", + web: true, + }, + URLOpener: func(url string) error { + buf.WriteString(url) + return nil + }, + client: client, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/orgs/github/projects", buf.String()) +} + +func TestRunListWeb_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query Viewer.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + "login": "theviewer", + }, + }, + }) + + client := queries.NewTestClient() + buf := bytes.Buffer{} + config := listConfig{ + opts: listOpts{ + owner: "@me", + web: true, + }, + URLOpener: func(url string) error { + buf.WriteString(url) + return nil + }, + client: client, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/users/theviewer/projects", buf.String()) +} + +func TestRunListWeb_Empty(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query Viewer.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + "login": "theviewer", + }, + }, + }) + + client := queries.NewTestClient() + buf := bytes.Buffer{} + config := listConfig{ + opts: listOpts{ + web: true, + }, + URLOpener: func(url string) error { + buf.WriteString(url) + return nil + }, + client: client, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/users/theviewer/projects", buf.String()) +} + +func TestRunListWeb_Closed(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query Viewer.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + "login": "theviewer", + }, + }, + }) + + client := queries.NewTestClient() + buf := bytes.Buffer{} + config := listConfig{ + opts: listOpts{ + web: true, + closed: true, + }, + URLOpener: func(url string) error { + buf.WriteString(url) + return nil + }, + client: client, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/users/theviewer/projects?query=is%3Aclosed", buf.String()) +} diff --git a/pkg/cmd/project/project.go b/pkg/cmd/project/project.go new file mode 100644 index 000000000..520463f64 --- /dev/null +++ b/pkg/cmd/project/project.go @@ -0,0 +1,61 @@ +package project + +import ( + "github.com/MakeNowJust/heredoc" + cmdClose "github.com/cli/cli/v2/pkg/cmd/project/close" + cmdCopy "github.com/cli/cli/v2/pkg/cmd/project/copy" + cmdCreate "github.com/cli/cli/v2/pkg/cmd/project/create" + cmdDelete "github.com/cli/cli/v2/pkg/cmd/project/delete" + cmdEdit "github.com/cli/cli/v2/pkg/cmd/project/edit" + cmdFieldCreate "github.com/cli/cli/v2/pkg/cmd/project/field-create" + cmdFieldDelete "github.com/cli/cli/v2/pkg/cmd/project/field-delete" + cmdFieldList "github.com/cli/cli/v2/pkg/cmd/project/field-list" + cmdItemAdd "github.com/cli/cli/v2/pkg/cmd/project/item-add" + cmdItemArchive "github.com/cli/cli/v2/pkg/cmd/project/item-archive" + cmdItemCreate "github.com/cli/cli/v2/pkg/cmd/project/item-create" + cmdItemDelete "github.com/cli/cli/v2/pkg/cmd/project/item-delete" + cmdItemEdit "github.com/cli/cli/v2/pkg/cmd/project/item-edit" + cmdItemList "github.com/cli/cli/v2/pkg/cmd/project/item-list" + cmdList "github.com/cli/cli/v2/pkg/cmd/project/list" + cmdView "github.com/cli/cli/v2/pkg/cmd/project/view" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/spf13/cobra" +) + +func NewCmdProject(f *cmdutil.Factory) *cobra.Command { + var cmd = &cobra.Command{ + Use: "project [flags]", + Short: "Work with GitHub Projects.", + Long: "Work with GitHub Projects. Note that the token you are using must have 'project' scope, which is not set by default. You can verify your token scope by running 'gh auth status' and add the project scope by running 'gh auth refresh -s project'.", + Example: heredoc.Doc(` + $ gh project create --owner monalisa --title "Roadmap" + $ gh project view 1 --owner cli --web + $ gh project field-list 1 --owner cli + $ gh project item-list 1 --owner cli + `), + GroupID: "core", + } + + cmd.AddCommand(cmdList.NewCmdList(f, nil)) + cmd.AddCommand(cmdCreate.NewCmdCreate(f, nil)) + cmd.AddCommand(cmdCopy.NewCmdCopy(f, nil)) + cmd.AddCommand(cmdClose.NewCmdClose(f, nil)) + cmd.AddCommand(cmdDelete.NewCmdDelete(f, nil)) + cmd.AddCommand(cmdEdit.NewCmdEdit(f, nil)) + cmd.AddCommand(cmdView.NewCmdView(f, nil)) + + // items + cmd.AddCommand(cmdItemList.NewCmdList(f, nil)) + cmd.AddCommand(cmdItemCreate.NewCmdCreateItem(f, nil)) + cmd.AddCommand(cmdItemAdd.NewCmdAddItem(f, nil)) + cmd.AddCommand(cmdItemEdit.NewCmdEditItem(f, nil)) + cmd.AddCommand(cmdItemArchive.NewCmdArchiveItem(f, nil)) + cmd.AddCommand(cmdItemDelete.NewCmdDeleteItem(f, nil)) + + // fields + cmd.AddCommand(cmdFieldList.NewCmdList(f, nil)) + cmd.AddCommand(cmdFieldCreate.NewCmdCreateField(f, nil)) + cmd.AddCommand(cmdFieldDelete.NewCmdDeleteField(f, nil)) + + return cmd +} diff --git a/pkg/cmd/project/shared/client/client.go b/pkg/cmd/project/shared/client/client.go new file mode 100644 index 000000000..1f5835a54 --- /dev/null +++ b/pkg/cmd/project/shared/client/client.go @@ -0,0 +1,22 @@ +package client + +import ( + "os" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" +) + +func New(f *cmdutil.Factory) (*queries.Client, error) { + if f.HttpClient == nil { + // This is for compatibility with tests that exercise Cobra command functionality. + // These tests do not define a `HttpClient` nor do they need to. + return nil, nil + } + + httpClient, err := f.HttpClient() + if err != nil { + return nil, err + } + return queries.NewClient(httpClient, os.Getenv("GH_HOST"), f.IOStreams), nil +} diff --git a/pkg/cmd/project/shared/format/json.go b/pkg/cmd/project/shared/format/json.go new file mode 100644 index 000000000..175485314 --- /dev/null +++ b/pkg/cmd/project/shared/format/json.go @@ -0,0 +1,365 @@ +package format + +import ( + "encoding/json" + "strings" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" +) + +// JSONProject serializes a Project to JSON. +func JSONProject(project queries.Project) ([]byte, error) { + return json.Marshal(projectJSON{ + Number: project.Number, + URL: project.URL, + ShortDescription: project.ShortDescription, + Public: project.Public, + Closed: project.Closed, + Title: project.Title, + ID: project.ID, + Readme: project.Readme, + Items: struct { + TotalCount int `json:"totalCount"` + }{ + TotalCount: project.Items.TotalCount, + }, + Fields: struct { + TotalCount int `json:"totalCount"` + }{ + TotalCount: project.Fields.TotalCount, + }, + Owner: struct { + Type string `json:"type"` + Login string `json:"login"` + }{ + Type: project.OwnerType(), + Login: project.OwnerLogin(), + }, + }) +} + +// JSONProjects serializes a slice of Projects to JSON. +// JSON fields are `totalCount` and `projects`. +func JSONProjects(projects []queries.Project, totalCount int) ([]byte, error) { + var result []projectJSON + for _, p := range projects { + result = append(result, projectJSON{ + Number: p.Number, + URL: p.URL, + ShortDescription: p.ShortDescription, + Public: p.Public, + Closed: p.Closed, + Title: p.Title, + ID: p.ID, + Readme: p.Readme, + Items: struct { + TotalCount int `json:"totalCount"` + }{ + TotalCount: p.Items.TotalCount, + }, + Fields: struct { + TotalCount int `json:"totalCount"` + }{ + TotalCount: p.Fields.TotalCount, + }, + Owner: struct { + Type string `json:"type"` + Login string `json:"login"` + }{ + Type: p.OwnerType(), + Login: p.OwnerLogin(), + }, + }) + } + + return json.Marshal(struct { + Projects []projectJSON `json:"projects"` + TotalCount int `json:"totalCount"` + }{ + Projects: result, + TotalCount: totalCount, + }) +} + +type projectJSON struct { + Number int32 `json:"number"` + URL string `json:"url"` + ShortDescription string `json:"shortDescription"` + Public bool `json:"public"` + Closed bool `json:"closed"` + Title string `json:"title"` + ID string `json:"id"` + Readme string `json:"readme"` + Items struct { + TotalCount int `json:"totalCount"` + } `graphql:"items(first: 100)" json:"items"` + Fields struct { + TotalCount int `json:"totalCount"` + } `graphql:"fields(first:100)" json:"fields"` + Owner struct { + Type string `json:"type"` + Login string `json:"login"` + } `json:"owner"` +} + +// JSONProjectField serializes a ProjectField to JSON. +func JSONProjectField(field queries.ProjectField) ([]byte, error) { + val := projectFieldJSON{ + ID: field.ID(), + Name: field.Name(), + Type: field.Type(), + } + for _, o := range field.Options() { + val.Options = append(val.Options, singleSelectOptionJSON{ + Name: o.Name, + ID: o.ID, + }) + } + + return json.Marshal(val) +} + +// JSONProjectFields serializes a slice of ProjectFields to JSON. +// JSON fields are `totalCount` and `fields`. +func JSONProjectFields(project *queries.Project) ([]byte, error) { + var result []projectFieldJSON + for _, f := range project.Fields.Nodes { + val := projectFieldJSON{ + ID: f.ID(), + Name: f.Name(), + Type: f.Type(), + } + for _, o := range f.Options() { + val.Options = append(val.Options, singleSelectOptionJSON{ + Name: o.Name, + ID: o.ID, + }) + } + + result = append(result, val) + } + + return json.Marshal(struct { + Fields []projectFieldJSON `json:"fields"` + TotalCount int `json:"totalCount"` + }{ + Fields: result, + TotalCount: project.Fields.TotalCount, + }) +} + +type projectFieldJSON struct { + ID string `json:"id"` + Name string `json:"name"` + Type string `json:"type"` + Options []singleSelectOptionJSON `json:"options,omitempty"` +} + +type singleSelectOptionJSON struct { + ID string `json:"id"` + Name string `json:"name"` +} + +// JSONProjectItem serializes a ProjectItem to JSON. +func JSONProjectItem(item queries.ProjectItem) ([]byte, error) { + return json.Marshal(projectItemJSON{ + ID: item.ID(), + Title: item.Title(), + Body: item.Body(), + Type: item.Type(), + URL: item.URL(), + }) +} + +type projectItemJSON struct { + ID string `json:"id"` + Title string `json:"title"` + Body string `json:"body"` + Type string `json:"type"` + URL string `json:"url,omitempty"` +} + +// JSONProjectDraftIssue serializes a DraftIssue to JSON. +// This is needed because the field for +// https://docs.github.com/en/graphql/reference/mutations#updateprojectv2draftissue +// is a DraftIssue https://docs.github.com/en/graphql/reference/objects#draftissue +// and not a ProjectV2Item https://docs.github.com/en/graphql/reference/objects#projectv2item +func JSONProjectDraftIssue(item queries.DraftIssue) ([]byte, error) { + + return json.Marshal(draftIssueJSON{ + ID: item.ID, + Title: item.Title, + Body: item.Body, + Type: "DraftIssue", + }) +} + +type draftIssueJSON struct { + ID string `json:"id"` + Title string `json:"title"` + Body string `json:"body"` + Type string `json:"type"` +} + +func projectItemContent(p queries.ProjectItem) any { + switch p.Content.TypeName { + case "DraftIssue": + return struct { + Type string `json:"type"` + Body string `json:"body"` + Title string `json:"title"` + }{ + Type: p.Type(), + Body: p.Body(), + Title: p.Title(), + } + case "Issue": + return struct { + Type string `json:"type"` + Body string `json:"body"` + Title string `json:"title"` + Number int `json:"number"` + Repository string `json:"repository"` + URL string `json:"url"` + }{ + Type: p.Type(), + Body: p.Body(), + Title: p.Title(), + Number: p.Number(), + Repository: p.Repo(), + URL: p.URL(), + } + case "PullRequest": + return struct { + Type string `json:"type"` + Body string `json:"body"` + Title string `json:"title"` + Number int `json:"number"` + Repository string `json:"repository"` + URL string `json:"url"` + }{ + Type: p.Type(), + Body: p.Body(), + Title: p.Title(), + Number: p.Number(), + Repository: p.Repo(), + URL: p.URL(), + } + } + + return nil +} + +func projectFieldValueData(v queries.FieldValueNodes) any { + switch v.Type { + case "ProjectV2ItemFieldDateValue": + return v.ProjectV2ItemFieldDateValue.Date + case "ProjectV2ItemFieldIterationValue": + return struct { + StartDate string `json:"startDate"` + Duration int `json:"duration"` + }{ + StartDate: v.ProjectV2ItemFieldIterationValue.StartDate, + Duration: v.ProjectV2ItemFieldIterationValue.Duration, + } + case "ProjectV2ItemFieldNumberValue": + return v.ProjectV2ItemFieldNumberValue.Number + case "ProjectV2ItemFieldSingleSelectValue": + return v.ProjectV2ItemFieldSingleSelectValue.Name + case "ProjectV2ItemFieldTextValue": + return v.ProjectV2ItemFieldTextValue.Text + case "ProjectV2ItemFieldMilestoneValue": + return struct { + Description string `json:"description"` + DueOn string `json:"dueOn"` + }{ + Description: v.ProjectV2ItemFieldMilestoneValue.Milestone.Description, + DueOn: v.ProjectV2ItemFieldMilestoneValue.Milestone.DueOn, + } + case "ProjectV2ItemFieldLabelValue": + names := make([]string, 0) + for _, p := range v.ProjectV2ItemFieldLabelValue.Labels.Nodes { + names = append(names, p.Name) + } + return names + case "ProjectV2ItemFieldPullRequestValue": + urls := make([]string, 0) + for _, p := range v.ProjectV2ItemFieldPullRequestValue.PullRequests.Nodes { + urls = append(urls, p.Url) + } + return urls + case "ProjectV2ItemFieldRepositoryValue": + return v.ProjectV2ItemFieldRepositoryValue.Repository.Url + case "ProjectV2ItemFieldUserValue": + logins := make([]string, 0) + for _, p := range v.ProjectV2ItemFieldUserValue.Users.Nodes { + logins = append(logins, p.Login) + } + return logins + case "ProjectV2ItemFieldReviewerValue": + names := make([]string, 0) + for _, p := range v.ProjectV2ItemFieldReviewerValue.Reviewers.Nodes { + if p.Type == "Team" { + names = append(names, p.Team.Name) + } else if p.Type == "User" { + names = append(names, p.User.Login) + } + } + return names + + } + + return nil +} + +// serialize creates a map from field to field values +func serializeProjectWithItems(project *queries.Project) []map[string]any { + fields := make(map[string]string) + + // make a map of fields by ID + for _, f := range project.Fields.Nodes { + fields[f.ID()] = CamelCase(f.Name()) + } + itemsSlice := make([]map[string]any, 0) + + // for each value, look up the name by ID + // and set the value to the field value + for _, i := range project.Items.Nodes { + o := make(map[string]any) + o["id"] = i.Id + o["content"] = projectItemContent(i) + for _, v := range i.FieldValues.Nodes { + id := v.ID() + value := projectFieldValueData(v) + + o[fields[id]] = value + } + itemsSlice = append(itemsSlice, o) + } + return itemsSlice +} + +// JSONProjectWithItems returns a detailed JSON representation of project items. +// JSON fields are `totalCount` and `items`. +func JSONProjectDetailedItems(project *queries.Project) ([]byte, error) { + items := serializeProjectWithItems(project) + return json.Marshal(struct { + Items []map[string]any `json:"items"` + TotalCount int `json:"totalCount"` + }{ + Items: items, + TotalCount: project.Items.TotalCount, + }) +} + +// CamelCase converts a string to camelCase, which is useful for turning Go field names to JSON keys. +func CamelCase(s string) string { + if len(s) == 0 { + return "" + } + + if len(s) == 1 { + return strings.ToLower(s) + } + return strings.ToLower(s[0:1]) + s[1:] +} diff --git a/pkg/cmd/project/shared/format/json_test.go b/pkg/cmd/project/shared/format/json_test.go new file mode 100644 index 000000000..31bdcccc6 --- /dev/null +++ b/pkg/cmd/project/shared/format/json_test.go @@ -0,0 +1,287 @@ +package format + +import ( + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + + "github.com/stretchr/testify/assert" +) + +func TestJSONProject_User(t *testing.T) { + project := queries.Project{ + ID: "123", + Number: 2, + URL: "a url", + ShortDescription: "short description", + Public: true, + Readme: "readme", + } + + project.Items.TotalCount = 1 + project.Fields.TotalCount = 2 + project.Owner.TypeName = "User" + project.Owner.User.Login = "monalisa" + b, err := JSONProject(project) + assert.NoError(t, err) + + assert.Equal(t, `{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"User","login":"monalisa"}}`, string(b)) +} + +func TestJSONProject_Org(t *testing.T) { + project := queries.Project{ + ID: "123", + Number: 2, + URL: "a url", + ShortDescription: "short description", + Public: true, + Readme: "readme", + } + + project.Items.TotalCount = 1 + project.Fields.TotalCount = 2 + project.Owner.TypeName = "Organization" + project.Owner.Organization.Login = "github" + b, err := JSONProject(project) + assert.NoError(t, err) + + assert.Equal(t, `{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"Organization","login":"github"}}`, string(b)) +} + +func TestJSONProjects(t *testing.T) { + userProject := queries.Project{ + ID: "123", + Number: 2, + URL: "a url", + ShortDescription: "short description", + Public: true, + Readme: "readme", + } + + userProject.Items.TotalCount = 1 + userProject.Fields.TotalCount = 2 + userProject.Owner.TypeName = "User" + userProject.Owner.User.Login = "monalisa" + + orgProject := queries.Project{ + ID: "123", + Number: 2, + URL: "a url", + ShortDescription: "short description", + Public: true, + Readme: "readme", + } + + orgProject.Items.TotalCount = 1 + orgProject.Fields.TotalCount = 2 + orgProject.Owner.TypeName = "Organization" + orgProject.Owner.Organization.Login = "github" + b, err := JSONProjects([]queries.Project{userProject, orgProject}, 2) + assert.NoError(t, err) + + assert.Equal( + t, + `{"projects":[{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"User","login":"monalisa"}},{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"Organization","login":"github"}}],"totalCount":2}`, + string(b)) +} + +func TestJSONProjectField_FieldType(t *testing.T) { + field := queries.ProjectField{} + field.TypeName = "ProjectV2Field" + field.Field.ID = "123" + field.Field.Name = "name" + + b, err := JSONProjectField(field) + assert.NoError(t, err) + + assert.Equal(t, `{"id":"123","name":"name","type":"ProjectV2Field"}`, string(b)) +} + +func TestJSONProjectField_SingleSelectType(t *testing.T) { + field := queries.ProjectField{} + field.TypeName = "ProjectV2SingleSelectField" + field.SingleSelectField.ID = "123" + field.SingleSelectField.Name = "name" + field.SingleSelectField.Options = []queries.SingleSelectFieldOptions{ + { + ID: "123", + Name: "name", + }, + { + ID: "456", + Name: "name2", + }, + } + + b, err := JSONProjectField(field) + assert.NoError(t, err) + + assert.Equal(t, `{"id":"123","name":"name","type":"ProjectV2SingleSelectField","options":[{"id":"123","name":"name"},{"id":"456","name":"name2"}]}`, string(b)) +} + +func TestJSONProjectField_ProjectV2IterationField(t *testing.T) { + field := queries.ProjectField{} + field.TypeName = "ProjectV2IterationField" + field.IterationField.ID = "123" + field.IterationField.Name = "name" + + b, err := JSONProjectField(field) + assert.NoError(t, err) + + assert.Equal(t, `{"id":"123","name":"name","type":"ProjectV2IterationField"}`, string(b)) +} + +func TestJSONProjectFields(t *testing.T) { + field := queries.ProjectField{} + field.TypeName = "ProjectV2Field" + field.Field.ID = "123" + field.Field.Name = "name" + + field2 := queries.ProjectField{} + field2.TypeName = "ProjectV2SingleSelectField" + field2.SingleSelectField.ID = "123" + field2.SingleSelectField.Name = "name" + field2.SingleSelectField.Options = []queries.SingleSelectFieldOptions{ + { + ID: "123", + Name: "name", + }, + { + ID: "456", + Name: "name2", + }, + } + + p := &queries.Project{ + Fields: struct { + TotalCount int + Nodes []queries.ProjectField + PageInfo queries.PageInfo + }{ + Nodes: []queries.ProjectField{field, field2}, + TotalCount: 5, + }, + } + b, err := JSONProjectFields(p) + assert.NoError(t, err) + + assert.Equal(t, `{"fields":[{"id":"123","name":"name","type":"ProjectV2Field"},{"id":"123","name":"name","type":"ProjectV2SingleSelectField","options":[{"id":"123","name":"name"},{"id":"456","name":"name2"}]}],"totalCount":5}`, string(b)) +} + +func TestJSONProjectItem_DraftIssue(t *testing.T) { + item := queries.ProjectItem{} + item.Content.TypeName = "DraftIssue" + item.Id = "123" + item.Content.DraftIssue.Title = "title" + item.Content.DraftIssue.Body = "a body" + + b, err := JSONProjectItem(item) + assert.NoError(t, err) + + assert.Equal(t, `{"id":"123","title":"title","body":"a body","type":"DraftIssue"}`, string(b)) +} + +func TestJSONProjectItem_Issue(t *testing.T) { + item := queries.ProjectItem{} + item.Content.TypeName = "Issue" + item.Id = "123" + item.Content.Issue.Title = "title" + item.Content.Issue.Body = "a body" + item.Content.Issue.URL = "a-url" + + b, err := JSONProjectItem(item) + assert.NoError(t, err) + + assert.Equal(t, `{"id":"123","title":"title","body":"a body","type":"Issue","url":"a-url"}`, string(b)) +} + +func TestJSONProjectItem_PullRequest(t *testing.T) { + item := queries.ProjectItem{} + item.Content.TypeName = "PullRequest" + item.Id = "123" + item.Content.PullRequest.Title = "title" + item.Content.PullRequest.Body = "a body" + item.Content.PullRequest.URL = "a-url" + + b, err := JSONProjectItem(item) + assert.NoError(t, err) + + assert.Equal(t, `{"id":"123","title":"title","body":"a body","type":"PullRequest","url":"a-url"}`, string(b)) +} + +func TestJSONProjectDetailedItems(t *testing.T) { + p := &queries.Project{} + p.Items.TotalCount = 5 + p.Items.Nodes = []queries.ProjectItem{ + { + Id: "issueId", + Content: queries.ProjectItemContent{ + TypeName: "Issue", + Issue: queries.Issue{ + Title: "Issue title", + Body: "a body", + Number: 1, + URL: "issue-url", + Repository: struct { + NameWithOwner string + }{ + NameWithOwner: "cli/go-gh", + }, + }, + }, + }, + { + Id: "pullRequestId", + Content: queries.ProjectItemContent{ + TypeName: "PullRequest", + PullRequest: queries.PullRequest{ + Title: "Pull Request title", + Body: "a body", + Number: 2, + URL: "pr-url", + Repository: struct { + NameWithOwner string + }{ + NameWithOwner: "cli/go-gh", + }, + }, + }, + }, + { + Id: "draftIssueId", + Content: queries.ProjectItemContent{ + TypeName: "DraftIssue", + DraftIssue: queries.DraftIssue{ + Title: "Pull Request title", + Body: "a body", + }, + }, + }, + } + + out, err := JSONProjectDetailedItems(p) + assert.NoError(t, err) + assert.Equal( + t, + `{"items":[{"content":{"type":"Issue","body":"a body","title":"Issue title","number":1,"repository":"cli/go-gh","url":"issue-url"},"id":"issueId"},{"content":{"type":"PullRequest","body":"a body","title":"Pull Request title","number":2,"repository":"cli/go-gh","url":"pr-url"},"id":"pullRequestId"},{"content":{"type":"DraftIssue","body":"a body","title":"Pull Request title"},"id":"draftIssueId"}],"totalCount":5}`, + string(out)) +} + +func TestJSONProjectDraftIssue(t *testing.T) { + item := queries.DraftIssue{} + item.ID = "123" + item.Title = "title" + item.Body = "a body" + + b, err := JSONProjectDraftIssue(item) + assert.NoError(t, err) + + assert.Equal(t, `{"id":"123","title":"title","body":"a body","type":"DraftIssue"}`, string(b)) +} + +func TestCamelCase(t *testing.T) { + assert.Equal(t, "camelCase", CamelCase("camelCase")) + assert.Equal(t, "camelCase", CamelCase("CamelCase")) + assert.Equal(t, "c", CamelCase("C")) + assert.Equal(t, "", CamelCase("")) +} diff --git a/pkg/cmd/project/shared/queries/queries.go b/pkg/cmd/project/shared/queries/queries.go new file mode 100644 index 000000000..d58dd1204 --- /dev/null +++ b/pkg/cmd/project/shared/queries/queries.go @@ -0,0 +1,1212 @@ +package queries + +import ( + "errors" + "fmt" + "net/http" + "net/url" + "regexp" + "strings" + "time" + + "github.com/briandowns/spinner" + "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/prompter" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/cli/v2/pkg/set" + "github.com/shurcooL/githubv4" +) + +func NewClient(httpClient *http.Client, hostname string, ios *iostreams.IOStreams) *Client { + apiClient := &hostScopedClient{ + hostname: hostname, + Client: api.NewClientFromHTTP(httpClient), + } + return &Client{ + apiClient: apiClient, + spinner: ios.IsStdoutTTY() && ios.IsStderrTTY(), + prompter: prompter.New("", ios.In, ios.Out, ios.ErrOut), + } +} + +func NewTestClient() *Client { + apiClient := &hostScopedClient{ + hostname: "github.com", + Client: api.NewClientFromHTTP(http.DefaultClient), + } + return &Client{ + apiClient: apiClient, + spinner: false, + prompter: nil, + } +} + +type iprompter interface { + Select(string, string, []string) (int, error) +} + +type hostScopedClient struct { + *api.Client + hostname string +} + +func (c *hostScopedClient) Query(queryName string, query interface{}, variables map[string]interface{}) error { + return c.Client.Query(c.hostname, queryName, query, variables) +} + +func (c *hostScopedClient) Mutate(queryName string, query interface{}, variables map[string]interface{}) error { + return c.Client.Mutate(c.hostname, queryName, query, variables) +} + +type graphqlClient interface { + Query(queryName string, query interface{}, variables map[string]interface{}) error + Mutate(queryName string, query interface{}, variables map[string]interface{}) error +} + +type Client struct { + apiClient graphqlClient + spinner bool + prompter iprompter +} + +const ( + LimitDefault = 30 + LimitMax = 100 // https://docs.github.com/en/graphql/overview/resource-limitations#node-limit +) + +// doQuery wraps API calls with a visual spinner +func (c *Client) doQuery(name string, query interface{}, variables map[string]interface{}) error { + var sp *spinner.Spinner + if c.spinner { + // https://github.com/briandowns/spinner#available-character-sets + dotStyle := spinner.CharSets[11] + sp = spinner.New(dotStyle, 120*time.Millisecond, spinner.WithColor("fgCyan")) + sp.Start() + } + err := c.apiClient.Query(name, query, variables) + if sp != nil { + sp.Stop() + } + return handleError(err) +} + +// TODO: un-export this since it couples the caller heavily to api.GraphQLClient +func (c *Client) Mutate(operationName string, query interface{}, variables map[string]interface{}) error { + err := c.apiClient.Mutate(operationName, query, variables) + return handleError(err) +} + +// PageInfo is a PageInfo GraphQL object https://docs.github.com/en/graphql/reference/objects#pageinfo. +type PageInfo struct { + EndCursor githubv4.String + HasNextPage bool +} + +// Project is a ProjectV2 GraphQL object https://docs.github.com/en/graphql/reference/objects#projectv2. +type Project struct { + Number int32 + URL string + ShortDescription string + Public bool + Closed bool + Title string + ID string + Readme string + Items struct { + PageInfo PageInfo + TotalCount int + Nodes []ProjectItem + } `graphql:"items(first: $firstItems, after: $afterItems)"` + Fields struct { + TotalCount int + Nodes []ProjectField + PageInfo PageInfo + } `graphql:"fields(first: $firstFields, after: $afterFields)"` + Owner struct { + TypeName string `graphql:"__typename"` + User struct { + Login string + } `graphql:"... on User"` + Organization struct { + Login string + } `graphql:"... on Organization"` + } +} + +func (p Project) OwnerType() string { + return p.Owner.TypeName +} + +func (p Project) OwnerLogin() string { + if p.OwnerType() == "User" { + return p.Owner.User.Login + } + return p.Owner.Organization.Login +} + +// ProjectItem is a ProjectV2Item GraphQL object https://docs.github.com/en/graphql/reference/objects#projectv2item. +type ProjectItem struct { + Content ProjectItemContent + Id string + FieldValues struct { + Nodes []FieldValueNodes + } `graphql:"fieldValues(first: 100)"` // hardcoded to 100 for now on the assumption that this is a reasonable limit +} + +type ProjectItemContent struct { + TypeName string `graphql:"__typename"` + DraftIssue DraftIssue `graphql:"... on DraftIssue"` + PullRequest PullRequest `graphql:"... on PullRequest"` + Issue Issue `graphql:"... on Issue"` +} + +type FieldValueNodes struct { + Type string `graphql:"__typename"` + ProjectV2ItemFieldDateValue struct { + Date string + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldDateValue"` + ProjectV2ItemFieldIterationValue struct { + StartDate string + Duration int + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldIterationValue"` + ProjectV2ItemFieldLabelValue struct { + Labels struct { + Nodes []struct { + Name string + } + } `graphql:"labels(first: 10)"` // experienced issues with larger limits, 10 seems like enough for now + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldLabelValue"` + ProjectV2ItemFieldNumberValue struct { + Number float32 + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldNumberValue"` + ProjectV2ItemFieldSingleSelectValue struct { + Name string + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldSingleSelectValue"` + ProjectV2ItemFieldTextValue struct { + Text string + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldTextValue"` + ProjectV2ItemFieldMilestoneValue struct { + Milestone struct { + Description string + DueOn string + } + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldMilestoneValue"` + ProjectV2ItemFieldPullRequestValue struct { + PullRequests struct { + Nodes []struct { + Url string + } + } `graphql:"pullRequests(first:10)"` // experienced issues with larger limits, 10 seems like enough for now + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldPullRequestValue"` + ProjectV2ItemFieldRepositoryValue struct { + Repository struct { + Url string + } + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldRepositoryValue"` + ProjectV2ItemFieldUserValue struct { + Users struct { + Nodes []struct { + Login string + } + } `graphql:"users(first: 10)"` // experienced issues with larger limits, 10 seems like enough for now + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldUserValue"` + ProjectV2ItemFieldReviewerValue struct { + Reviewers struct { + Nodes []struct { + Type string `graphql:"__typename"` + Team struct { + Name string + } `graphql:"... on Team"` + User struct { + Login string + } `graphql:"... on User"` + } + } `graphql:"reviewers(first: 10)"` // experienced issues with larger limits, 10 seems like enough for now + Field ProjectField + } `graphql:"... on ProjectV2ItemFieldReviewerValue"` +} + +func (v FieldValueNodes) ID() string { + switch v.Type { + case "ProjectV2ItemFieldDateValue": + return v.ProjectV2ItemFieldDateValue.Field.ID() + case "ProjectV2ItemFieldIterationValue": + return v.ProjectV2ItemFieldIterationValue.Field.ID() + case "ProjectV2ItemFieldNumberValue": + return v.ProjectV2ItemFieldNumberValue.Field.ID() + case "ProjectV2ItemFieldSingleSelectValue": + return v.ProjectV2ItemFieldSingleSelectValue.Field.ID() + case "ProjectV2ItemFieldTextValue": + return v.ProjectV2ItemFieldTextValue.Field.ID() + case "ProjectV2ItemFieldMilestoneValue": + return v.ProjectV2ItemFieldMilestoneValue.Field.ID() + case "ProjectV2ItemFieldLabelValue": + return v.ProjectV2ItemFieldLabelValue.Field.ID() + case "ProjectV2ItemFieldPullRequestValue": + return v.ProjectV2ItemFieldPullRequestValue.Field.ID() + case "ProjectV2ItemFieldRepositoryValue": + return v.ProjectV2ItemFieldRepositoryValue.Field.ID() + case "ProjectV2ItemFieldUserValue": + return v.ProjectV2ItemFieldUserValue.Field.ID() + case "ProjectV2ItemFieldReviewerValue": + return v.ProjectV2ItemFieldReviewerValue.Field.ID() + } + + return "" +} + +type DraftIssue struct { + ID string + Body string + Title string +} + +type PullRequest struct { + Body string + Title string + Number int + URL string + Repository struct { + NameWithOwner string + } +} + +type Issue struct { + Body string + Title string + Number int + URL string + Repository struct { + NameWithOwner string + } +} + +// Type is the underlying type of the project item. +func (p ProjectItem) Type() string { + return p.Content.TypeName +} + +// Title is the title of the project item. +func (p ProjectItem) Title() string { + switch p.Content.TypeName { + case "Issue": + return p.Content.Issue.Title + case "PullRequest": + return p.Content.PullRequest.Title + case "DraftIssue": + return p.Content.DraftIssue.Title + } + return "" +} + +// Body is the body of the project item. +func (p ProjectItem) Body() string { + switch p.Content.TypeName { + case "Issue": + return p.Content.Issue.Body + case "PullRequest": + return p.Content.PullRequest.Body + case "DraftIssue": + return p.Content.DraftIssue.Body + } + return "" +} + +// Number is the number of the project item. It is only valid for issues and pull requests. +func (p ProjectItem) Number() int { + switch p.Content.TypeName { + case "Issue": + return p.Content.Issue.Number + case "PullRequest": + return p.Content.PullRequest.Number + } + + return 0 +} + +// ID is the id of the ProjectItem. +func (p ProjectItem) ID() string { + return p.Id +} + +// Repo is the repository of the project item. It is only valid for issues and pull requests. +func (p ProjectItem) Repo() string { + switch p.Content.TypeName { + case "Issue": + return p.Content.Issue.Repository.NameWithOwner + case "PullRequest": + return p.Content.PullRequest.Repository.NameWithOwner + } + return "" +} + +// URL is the URL of the project item. Note the draft issues do not have URLs +func (p ProjectItem) URL() string { + switch p.Content.TypeName { + case "Issue": + return p.Content.Issue.URL + case "PullRequest": + return p.Content.PullRequest.URL + } + return "" +} + +// ProjectItems returns the items of a project. If the OwnerType is VIEWER, no login is required. +// If limit is 0, the default limit is used. +func (c *Client) ProjectItems(o *Owner, number int32, limit int) (*Project, error) { + project := &Project{} + if limit == 0 { + limit = LimitDefault + } + + // set first to the min of limit and LimitMax + first := LimitMax + if limit < first { + first = limit + } + + variables := map[string]interface{}{ + "firstItems": githubv4.Int(first), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(LimitMax), + "afterFields": (*githubv4.String)(nil), + "number": githubv4.Int(number), + } + + var query pager[ProjectItem] + var queryName string + switch o.Type { + case UserOwner: + variables["login"] = githubv4.String(o.Login) + query = &userOwnerWithItems{} // must be a pointer to work with graphql queries + queryName = "UserProjectWithItems" + case OrgOwner: + variables["login"] = githubv4.String(o.Login) + query = &orgOwnerWithItems{} // must be a pointer to work with graphql queries + queryName = "OrgProjectWithItems" + case ViewerOwner: + query = &viewerOwnerWithItems{} // must be a pointer to work with graphql queries + queryName = "ViewerProjectWithItems" + } + err := c.doQuery(queryName, query, variables) + if err != nil { + return project, err + } + project = query.Project() + + items, err := paginateAttributes(c, query, variables, queryName, "firstItems", "afterItems", limit, query.Nodes()) + if err != nil { + return project, err + } + + project.Items.Nodes = items + return project, nil +} + +// pager is an interface for paginating over the attributes of a Project. +type pager[N projectAttribute] interface { + HasNextPage() bool + EndCursor() string + Nodes() []N + Project() *Project +} + +// userOwnerWithItems +func (q userOwnerWithItems) HasNextPage() bool { + return q.Owner.Project.Items.PageInfo.HasNextPage +} + +func (q userOwnerWithItems) EndCursor() string { + return string(q.Owner.Project.Items.PageInfo.EndCursor) +} + +func (q userOwnerWithItems) Nodes() []ProjectItem { + return q.Owner.Project.Items.Nodes +} + +func (q userOwnerWithItems) Project() *Project { + return &q.Owner.Project +} + +// orgOwnerWithItems +func (q orgOwnerWithItems) HasNextPage() bool { + return q.Owner.Project.Items.PageInfo.HasNextPage +} + +func (q orgOwnerWithItems) EndCursor() string { + return string(q.Owner.Project.Items.PageInfo.EndCursor) +} + +func (q orgOwnerWithItems) Nodes() []ProjectItem { + return q.Owner.Project.Items.Nodes +} + +func (q orgOwnerWithItems) Project() *Project { + return &q.Owner.Project +} + +// viewerOwnerWithItems +func (q viewerOwnerWithItems) HasNextPage() bool { + return q.Owner.Project.Items.PageInfo.HasNextPage +} + +func (q viewerOwnerWithItems) EndCursor() string { + return string(q.Owner.Project.Items.PageInfo.EndCursor) +} + +func (q viewerOwnerWithItems) Nodes() []ProjectItem { + return q.Owner.Project.Items.Nodes +} + +func (q viewerOwnerWithItems) Project() *Project { + return &q.Owner.Project +} + +// userOwnerWithFields +func (q userOwnerWithFields) HasNextPage() bool { + return q.Owner.Project.Fields.PageInfo.HasNextPage +} + +func (q userOwnerWithFields) EndCursor() string { + return string(q.Owner.Project.Fields.PageInfo.EndCursor) +} + +func (q userOwnerWithFields) Nodes() []ProjectField { + return q.Owner.Project.Fields.Nodes +} + +func (q userOwnerWithFields) Project() *Project { + return &q.Owner.Project +} + +// orgOwnerWithFields +func (q orgOwnerWithFields) HasNextPage() bool { + return q.Owner.Project.Fields.PageInfo.HasNextPage +} + +func (q orgOwnerWithFields) EndCursor() string { + return string(q.Owner.Project.Fields.PageInfo.EndCursor) +} + +func (q orgOwnerWithFields) Nodes() []ProjectField { + return q.Owner.Project.Fields.Nodes +} + +func (q orgOwnerWithFields) Project() *Project { + return &q.Owner.Project +} + +// viewerOwnerWithFields +func (q viewerOwnerWithFields) HasNextPage() bool { + return q.Owner.Project.Fields.PageInfo.HasNextPage +} + +func (q viewerOwnerWithFields) EndCursor() string { + return string(q.Owner.Project.Fields.PageInfo.EndCursor) +} + +func (q viewerOwnerWithFields) Nodes() []ProjectField { + return q.Owner.Project.Fields.Nodes +} + +func (q viewerOwnerWithFields) Project() *Project { + return &q.Owner.Project +} + +type projectAttribute interface { + ProjectItem | ProjectField +} + +// paginateAttributes is for paginating over the attributes of a project, such as items or fields +// +// firstKey and afterKey are the keys in the variables map that are used to set the first and after +// as these are set independently based on the attribute type, such as item or field. +// +// limit is the maximum number of attributes to return, or 0 for no limit. +// +// nodes is the list of attributes that have already been fetched. +// +// the return value is a slice of the newly fetched attributes appended to nodes. +func paginateAttributes[N projectAttribute](c *Client, p pager[N], variables map[string]any, queryName string, firstKey string, afterKey string, limit int, nodes []N) ([]N, error) { + hasNextPage := p.HasNextPage() + cursor := p.EndCursor() + for { + if !hasNextPage || len(nodes) >= limit { + return nodes, nil + } + + if len(nodes)+LimitMax > limit { + first := limit - len(nodes) + variables[firstKey] = githubv4.Int(first) + } + + // set the cursor to the end of the last page + variables[afterKey] = (*githubv4.String)(&cursor) + err := c.doQuery(queryName, p, variables) + if err != nil { + return nodes, err + } + + nodes = append(nodes, p.Nodes()...) + hasNextPage = p.HasNextPage() + cursor = p.EndCursor() + } +} + +// ProjectField is a ProjectV2FieldConfiguration GraphQL object https://docs.github.com/en/graphql/reference/unions#projectv2fieldconfiguration. +type ProjectField struct { + TypeName string `graphql:"__typename"` + Field struct { + ID string + Name string + DataType string + } `graphql:"... on ProjectV2Field"` + IterationField struct { + ID string + Name string + DataType string + } `graphql:"... on ProjectV2IterationField"` + SingleSelectField struct { + ID string + Name string + DataType string + Options []SingleSelectFieldOptions + } `graphql:"... on ProjectV2SingleSelectField"` +} + +// ID is the ID of the project field. +func (p ProjectField) ID() string { + if p.TypeName == "ProjectV2Field" { + return p.Field.ID + } else if p.TypeName == "ProjectV2IterationField" { + return p.IterationField.ID + } else if p.TypeName == "ProjectV2SingleSelectField" { + return p.SingleSelectField.ID + } + return "" +} + +// Name is the name of the project field. +func (p ProjectField) Name() string { + if p.TypeName == "ProjectV2Field" { + return p.Field.Name + } else if p.TypeName == "ProjectV2IterationField" { + return p.IterationField.Name + } else if p.TypeName == "ProjectV2SingleSelectField" { + return p.SingleSelectField.Name + } + return "" +} + +// Type is the typename of the project field. +func (p ProjectField) Type() string { + return p.TypeName +} + +type SingleSelectFieldOptions struct { + ID string + Name string +} + +func (p ProjectField) Options() []SingleSelectFieldOptions { + if p.TypeName == "ProjectV2SingleSelectField" { + var options []SingleSelectFieldOptions + for _, o := range p.SingleSelectField.Options { + options = append(options, SingleSelectFieldOptions{ + ID: o.ID, + Name: o.Name, + }) + } + return options + } + return nil +} + +// ProjectFields returns a project with fields. If the OwnerType is VIEWER, no login is required. +// If limit is 0, the default limit is used. +func (c *Client) ProjectFields(o *Owner, number int32, limit int) (*Project, error) { + project := &Project{} + if limit == 0 { + limit = LimitDefault + } + + // set first to the min of limit and LimitMax + first := LimitMax + if limit < first { + first = limit + } + variables := map[string]interface{}{ + "firstItems": githubv4.Int(LimitMax), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(first), + "afterFields": (*githubv4.String)(nil), + "number": githubv4.Int(number), + } + + var query pager[ProjectField] + var queryName string + switch o.Type { + case UserOwner: + variables["login"] = githubv4.String(o.Login) + query = &userOwnerWithFields{} // must be a pointer to work with graphql queries + queryName = "UserProjectWithFields" + case OrgOwner: + variables["login"] = githubv4.String(o.Login) + query = &orgOwnerWithFields{} // must be a pointer to work with graphql queries + queryName = "OrgProjectWithFields" + case ViewerOwner: + query = &viewerOwnerWithFields{} // must be a pointer to work with graphql queries + queryName = "ViewerProjectWithFields" + } + err := c.doQuery(queryName, query, variables) + if err != nil { + return project, err + } + project = query.Project() + + fields, err := paginateAttributes(c, query, variables, queryName, "firstFields", "afterFields", limit, query.Nodes()) + if err != nil { + return project, err + } + + project.Fields.Nodes = fields + return project, nil +} + +// viewerLogin is used to query the Login of the viewer. +type viewerLogin struct { + Viewer struct { + Login string + Id string + } +} + +type viewerLoginOrgs struct { + Viewer struct { + Login string + ID string + Organizations struct { + PageInfo PageInfo + Nodes []struct { + Login string + ViewerCanCreateProjects bool + ID string + } + } `graphql:"organizations(first: 100, after: $after)"` + } +} + +// userOwner is used to query the project of a user. +type userOwner struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + Login string + } `graphql:"user(login: $login)"` +} + +// userOwnerWithItems is used to query the project of a user with its items. +type userOwnerWithItems struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + } `graphql:"user(login: $login)"` +} + +// userOwnerWithFields is used to query the project of a user with its fields. +type userOwnerWithFields struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + } `graphql:"user(login: $login)"` +} + +// orgOwner is used to query the project of an organization. +type orgOwner struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + Login string + } `graphql:"organization(login: $login)"` +} + +// orgOwnerWithItems is used to query the project of an organization with its items. +type orgOwnerWithItems struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + } `graphql:"organization(login: $login)"` +} + +// orgOwnerWithFields is used to query the project of an organization with its fields. +type orgOwnerWithFields struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + } `graphql:"organization(login: $login)"` +} + +// viewerOwner is used to query the project of the viewer. +type viewerOwner struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + Login string + } `graphql:"viewer"` +} + +// viewerOwnerWithItems is used to query the project of the viewer with its items. +type viewerOwnerWithItems struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + } `graphql:"viewer"` +} + +// viewerOwnerWithFields is used to query the project of the viewer with its fields. +type viewerOwnerWithFields struct { + Owner struct { + Project Project `graphql:"projectV2(number: $number)"` + } `graphql:"viewer"` +} + +// OwnerType is the type of the owner of a project, which can be either a user or an organization. Viewer is the current user. +type OwnerType string + +const UserOwner OwnerType = "USER" +const OrgOwner OwnerType = "ORGANIZATION" +const ViewerOwner OwnerType = "VIEWER" + +// ViewerLoginName returns the login name of the viewer. +func (c *Client) ViewerLoginName() (string, error) { + var query viewerLogin + err := c.doQuery("Viewer", &query, map[string]interface{}{}) + if err != nil { + return "", err + } + return query.Viewer.Login, nil +} + +// OwnerIDAndType returns the ID and OwnerType. The special login "@me" or an empty string queries the current user. +func (c *Client) OwnerIDAndType(login string) (string, OwnerType, error) { + if login == "@me" || login == "" { + var query viewerLogin + err := c.doQuery("ViewerOwner", &query, nil) + if err != nil { + return "", "", err + } + return query.Viewer.Id, ViewerOwner, nil + } + + variables := map[string]interface{}{ + "login": githubv4.String(login), + } + var query struct { + User struct { + Login string + Id string + } `graphql:"user(login: $login)"` + Organization struct { + Login string + Id string + } `graphql:"organization(login: $login)"` + } + + err := c.doQuery("UserOrgOwner", &query, variables) + if err != nil { + // Due to the way the queries are structured, we don't know if a login belongs to a user + // or to an org, even though they are unique. To deal with this, we try both - if neither + // is found, we return the error. + var graphErr api.GraphQLError + if errors.As(err, &graphErr) { + if graphErr.Match("NOT_FOUND", "user") && graphErr.Match("NOT_FOUND", "organization") { + return "", "", err + } else if graphErr.Match("NOT_FOUND", "organization") { // org isn't found must be a user + return query.User.Id, UserOwner, nil + } else if graphErr.Match("NOT_FOUND", "user") { // user isn't found must be an org + return query.Organization.Id, OrgOwner, nil + } + } + } + + return "", "", errors.New("unknown owner type") +} + +// issueOrPullRequest is used to query the global id of an issue or pull request by its URL. +type issueOrPullRequest struct { + Resource struct { + Typename string `graphql:"__typename"` + Issue struct { + ID string + } `graphql:"... on Issue"` + PullRequest struct { + ID string + } `graphql:"... on PullRequest"` + } `graphql:"resource(url: $url)"` +} + +// IssueOrPullRequestID returns the ID of the issue or pull request from a URL. +func (c *Client) IssueOrPullRequestID(rawURL string) (string, error) { + uri, err := url.Parse(rawURL) + if err != nil { + return "", err + } + variables := map[string]interface{}{ + "url": githubv4.URI{URL: uri}, + } + var query issueOrPullRequest + err = c.doQuery("GetIssueOrPullRequest", &query, variables) + if err != nil { + return "", err + } + if query.Resource.Typename == "Issue" { + return query.Resource.Issue.ID, nil + } else if query.Resource.Typename == "PullRequest" { + return query.Resource.PullRequest.ID, nil + } + return "", errors.New("resource not found, please check the URL") +} + +// userProjects queries the $first projects of a user. +type userProjects struct { + Owner struct { + Projects struct { + TotalCount int + PageInfo PageInfo + Nodes []Project + } `graphql:"projectsV2(first: $first, after: $after)"` + Login string + } `graphql:"user(login: $login)"` +} + +// orgProjects queries the $first projects of an organization. +type orgProjects struct { + Owner struct { + Projects struct { + TotalCount int + PageInfo PageInfo + Nodes []Project + } `graphql:"projectsV2(first: $first, after: $after)"` + Login string + } `graphql:"organization(login: $login)"` +} + +// viewerProjects queries the $first projects of the viewer. +type viewerProjects struct { + Owner struct { + Projects struct { + TotalCount int + PageInfo PageInfo + Nodes []Project + } `graphql:"projectsV2(first: $first, after: $after)"` + Login string + } `graphql:"viewer"` +} + +type loginTypes struct { + Login string + Type OwnerType + ID string +} + +// userOrgLogins gets all the logins of the viewer and the organizations the viewer is a member of. +func (c *Client) userOrgLogins() ([]loginTypes, error) { + l := make([]loginTypes, 0) + var v viewerLoginOrgs + variables := map[string]interface{}{ + "after": (*githubv4.String)(nil), + } + + err := c.doQuery("ViewerLoginAndOrgs", &v, variables) + if err != nil { + return l, err + } + + // add the user + l = append(l, loginTypes{ + Login: v.Viewer.Login, + Type: ViewerOwner, + ID: v.Viewer.ID, + }) + + // add orgs where the user can create projects + for _, org := range v.Viewer.Organizations.Nodes { + if org.ViewerCanCreateProjects { + l = append(l, loginTypes{ + Login: org.Login, + Type: OrgOwner, + ID: org.ID, + }) + } + } + + // this seem unlikely, but if there are more org logins, paginate the rest + if v.Viewer.Organizations.PageInfo.HasNextPage { + return c.paginateOrgLogins(l, string(v.Viewer.Organizations.PageInfo.EndCursor)) + } + + return l, nil +} + +// paginateOrgLogins after cursor and append them to the list of logins. +func (c *Client) paginateOrgLogins(l []loginTypes, cursor string) ([]loginTypes, error) { + var v viewerLoginOrgs + variables := map[string]interface{}{ + "after": githubv4.String(cursor), + } + + err := c.doQuery("ViewerLoginAndOrgs", &v, variables) + if err != nil { + return l, err + } + + for _, org := range v.Viewer.Organizations.Nodes { + if org.ViewerCanCreateProjects { + l = append(l, loginTypes{ + Login: org.Login, + Type: OrgOwner, + ID: org.ID, + }) + } + } + + if v.Viewer.Organizations.PageInfo.HasNextPage { + return c.paginateOrgLogins(l, string(v.Viewer.Organizations.PageInfo.EndCursor)) + } + + return l, nil +} + +type Owner struct { + Login string + Type OwnerType + ID string +} + +// NewOwner creates a project Owner +// If canPrompt is false, login is required as we cannot prompt for it. +// If login is not empty, it is used to lookup the project owner. +// If login is empty empty, interative mode is used to select an owner. +// from the current viewer and their organizations +func (c *Client) NewOwner(canPrompt bool, login string) (*Owner, error) { + if login != "" { + id, ownerType, err := c.OwnerIDAndType(login) + if err != nil { + return nil, err + } + + return &Owner{ + Login: login, + Type: ownerType, + ID: id, + }, nil + } + + if !canPrompt { + return nil, fmt.Errorf("login is required when not running interactively") + } + + logins, err := c.userOrgLogins() + if err != nil { + return nil, err + } + + options := make([]string, 0, len(logins)) + for _, l := range logins { + options = append(options, l.Login) + } + + answerIndex, err := c.prompter.Select("Which owner would you like to use?", "", options) + if err != nil { + return nil, err + } + + l := logins[answerIndex] + return &Owner{ + Login: l.Login, + Type: l.Type, + ID: l.ID, + }, nil +} + +// NewProject creates a project based on the owner and project number +// if canPrompt is false, number is required as we cannot prompt for it +// if number is 0 it will prompt the user to select a project interactively +// otherwise it will make a request to get the project by number +// set `fields“ to true to get the project's field data +func (c *Client) NewProject(canPrompt bool, o *Owner, number int32, fields bool) (*Project, error) { + if number != 0 { + variables := map[string]interface{}{ + "number": githubv4.Int(number), + "firstItems": githubv4.Int(0), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(0), + "afterFields": (*githubv4.String)(nil), + } + + if fields { + variables["firstFields"] = githubv4.Int(LimitMax) + } + if o.Type == UserOwner { + var query userOwner + variables["login"] = githubv4.String(o.Login) + err := c.doQuery("UserProject", &query, variables) + return &query.Owner.Project, err + } else if o.Type == OrgOwner { + variables["login"] = githubv4.String(o.Login) + var query orgOwner + err := c.doQuery("OrgProject", &query, variables) + return &query.Owner.Project, err + } else if o.Type == ViewerOwner { + var query viewerOwner + err := c.doQuery("ViewerProject", &query, variables) + return &query.Owner.Project, err + } + return nil, errors.New("unknown owner type") + } + + if !canPrompt { + return nil, fmt.Errorf("project number is required when not running interactively") + } + + projects, _, err := c.Projects(o.Login, o.Type, 0, fields) + if err != nil { + return nil, err + } + + if len(projects) == 0 { + return nil, fmt.Errorf("no projects found for %s", o.Login) + } + + options := make([]string, 0, len(projects)) + for _, p := range projects { + title := fmt.Sprintf("%s (#%d)", p.Title, p.Number) + options = append(options, title) + } + + answerIndex, err := c.prompter.Select("Which project would you like to use?", "", options) + if err != nil { + return nil, err + } + + return &projects[answerIndex], nil +} + +// Projects returns all the projects for an Owner. If the OwnerType is VIEWER, no login is required. +// If limit is 0, the default limit is used. +func (c *Client) Projects(login string, t OwnerType, limit int, fields bool) ([]Project, int, error) { + projects := make([]Project, 0) + cursor := (*githubv4.String)(nil) + hasNextPage := false + totalCount := 0 + + if limit == 0 { + limit = LimitDefault + } + + // set first to the min of limit and LimitMax + first := LimitMax + if limit < first { + first = limit + } + + variables := map[string]interface{}{ + "first": githubv4.Int(first), + "after": cursor, + "firstItems": githubv4.Int(0), + "afterItems": (*githubv4.String)(nil), + "firstFields": githubv4.Int(0), + "afterFields": (*githubv4.String)(nil), + } + + if fields { + variables["firstFields"] = githubv4.Int(LimitMax) + } + + if t != ViewerOwner { + variables["login"] = githubv4.String(login) + } + // loop until we get all the projects + for { + // the code below is very repetitive, the only real difference being the type of the query + // and the query variables. I couldn't figure out a way to make this cleaner that was worth + // the cost. + if t == UserOwner { + var query userProjects + if err := c.doQuery("UserProjects", &query, variables); err != nil { + return projects, 0, err + } + projects = append(projects, query.Owner.Projects.Nodes...) + hasNextPage = query.Owner.Projects.PageInfo.HasNextPage + cursor = &query.Owner.Projects.PageInfo.EndCursor + totalCount = query.Owner.Projects.TotalCount + } else if t == OrgOwner { + var query orgProjects + if err := c.doQuery("OrgProjects", &query, variables); err != nil { + return projects, 0, err + } + projects = append(projects, query.Owner.Projects.Nodes...) + hasNextPage = query.Owner.Projects.PageInfo.HasNextPage + cursor = &query.Owner.Projects.PageInfo.EndCursor + totalCount = query.Owner.Projects.TotalCount + } else if t == ViewerOwner { + var query viewerProjects + if err := c.doQuery("ViewerProjects", &query, variables); err != nil { + return projects, 0, err + } + projects = append(projects, query.Owner.Projects.Nodes...) + hasNextPage = query.Owner.Projects.PageInfo.HasNextPage + cursor = &query.Owner.Projects.PageInfo.EndCursor + totalCount = query.Owner.Projects.TotalCount + } + + if !hasNextPage || len(projects) >= limit { + return projects, totalCount, nil + } + + if len(projects)+LimitMax > limit { + first := limit - len(projects) + variables["first"] = githubv4.Int(first) + } + variables["after"] = cursor + } +} + +func handleError(err error) error { + var gerr api.GraphQLError + if errors.As(err, &gerr) { + missing := set.NewStringSet() + for _, e := range gerr.Errors { + if e.Type != "INSUFFICIENT_SCOPES" { + continue + } + missing.AddValues(requiredScopesFromServerMessage(e.Message)) + } + if missing.Len() > 0 { + s := missing.ToSlice() + // TODO: this duplicates parts of generateScopesSuggestion + return fmt.Errorf( + "error: your authentication token is missing required scopes %v\n"+ + "To request it, run: gh auth refresh -s %s", + s, + strings.Join(s, ",")) + } + } + return err +} + +var scopesRE = regexp.MustCompile(`one of the following scopes: \[(.+?)]`) + +func requiredScopesFromServerMessage(msg string) []string { + m := scopesRE.FindStringSubmatch(msg) + if m == nil { + return nil + } + var scopes []string + for _, mm := range strings.Split(m[1], ",") { + scopes = append(scopes, strings.Trim(mm, "' ")) + } + return scopes +} diff --git a/pkg/cmd/project/shared/queries/queries_test.go b/pkg/cmd/project/shared/queries/queries_test.go new file mode 100644 index 000000000..b5a8a1f76 --- /dev/null +++ b/pkg/cmd/project/shared/queries/queries_test.go @@ -0,0 +1,365 @@ +package queries + +import ( + "reflect" + "testing" + + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestProjectItems_DefaultLimit(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // list project items + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProjectWithItems.*", + "variables": map[string]interface{}{ + "firstItems": LimitMax, + "afterItems": nil, + "firstFields": LimitMax, + "afterFields": nil, + "login": "monalisa", + "number": 1, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "items": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "issue ID", + }, + { + "id": "pull request ID", + }, + { + "id": "draft issue ID", + }, + }, + }, + }, + }, + }, + }) + + client := NewTestClient() + + owner := &Owner{ + Type: "USER", + Login: "monalisa", + ID: "user ID", + } + project, err := client.ProjectItems(owner, 1, LimitMax) + assert.NoError(t, err) + assert.Len(t, project.Items.Nodes, 3) +} + +func TestProjectItems_LowerLimit(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // list project items + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProjectWithItems.*", + "variables": map[string]interface{}{ + "firstItems": 2, + "afterItems": nil, + "firstFields": LimitMax, + "afterFields": nil, + "login": "monalisa", + "number": 1, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "items": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "issue ID", + }, + { + "id": "pull request ID", + }, + }, + }, + }, + }, + }, + }) + + client := NewTestClient() + + owner := &Owner{ + Type: "USER", + Login: "monalisa", + ID: "user ID", + } + project, err := client.ProjectItems(owner, 1, 2) + assert.NoError(t, err) + assert.Len(t, project.Items.Nodes, 2) +} + +func TestProjectItems_NoLimit(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // list project items + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProjectWithItems.*", + "variables": map[string]interface{}{ + "firstItems": LimitDefault, + "afterItems": nil, + "firstFields": LimitMax, + "afterFields": nil, + "login": "monalisa", + "number": 1, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "items": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "issue ID", + }, + { + "id": "pull request ID", + }, + { + "id": "draft issue ID", + }, + }, + }, + }, + }, + }, + }) + + client := NewTestClient() + + owner := &Owner{ + Type: "USER", + Login: "monalisa", + ID: "user ID", + } + project, err := client.ProjectItems(owner, 1, 0) + assert.NoError(t, err) + assert.Len(t, project.Items.Nodes, 3) +} + +func TestProjectFields_LowerLimit(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": LimitMax, + "afterItems": nil, + "firstFields": 2, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "field ID", + }, + { + "id": "status ID", + }, + }, + }, + }, + }, + }, + }) + + client := NewTestClient() + owner := &Owner{ + Type: "USER", + Login: "monalisa", + ID: "user ID", + } + project, err := client.ProjectFields(owner, 1, 2) + assert.NoError(t, err) + assert.Len(t, project.Fields.Nodes, 2) +} + +func TestProjectFields_DefaultLimit(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // list project fields + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": LimitMax, + "afterItems": nil, + "firstFields": LimitMax, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "field ID", + }, + { + "id": "status ID", + }, + { + "id": "iteration ID", + }, + }, + }, + }, + }, + }, + }) + + client := NewTestClient() + + owner := &Owner{ + Type: "USER", + Login: "monalisa", + ID: "user ID", + } + project, err := client.ProjectFields(owner, 1, LimitMax) + assert.NoError(t, err) + assert.Len(t, project.Fields.Nodes, 3) +} + +func TestProjectFields_NoLimit(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + + // list project fields + gock.New("https://api.github.com"). + Post("/graphql"). + JSON(map[string]interface{}{ + "query": "query UserProject.*", + "variables": map[string]interface{}{ + "login": "monalisa", + "number": 1, + "firstItems": LimitMax, + "afterItems": nil, + "firstFields": LimitDefault, + "afterFields": nil, + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "projectV2": map[string]interface{}{ + "fields": map[string]interface{}{ + "nodes": []map[string]interface{}{ + { + "id": "field ID", + }, + { + "id": "status ID", + }, + { + "id": "iteration ID", + }, + }, + }, + }, + }, + }, + }) + + client := NewTestClient() + + owner := &Owner{ + Type: "USER", + Login: "monalisa", + ID: "user ID", + } + project, err := client.ProjectFields(owner, 1, 0) + assert.NoError(t, err) + assert.Len(t, project.Fields.Nodes, 3) +} + +func Test_requiredScopesFromServerMessage(t *testing.T) { + tests := []struct { + name string + msg string + want []string + }{ + { + name: "no scopes", + msg: "SERVER OOPSIE", + want: []string(nil), + }, + { + name: "one scope", + msg: "Your token has not been granted the required scopes to execute this query. The 'dataType' field requires one of the following scopes: ['read:project'], but your token has only been granted the: ['codespace', repo'] scopes. Please modify your token's scopes at: https://github.com/settings/tokens.", + want: []string{"read:project"}, + }, + { + name: "multiple scopes", + msg: "Your token has not been granted the required scopes to execute this query. The 'dataType' field requires one of the following scopes: ['read:project', 'read:discussion', 'codespace'], but your token has only been granted the: [repo'] scopes. Please modify your token's scopes at: https://github.com/settings/tokens.", + want: []string{"read:project", "read:discussion", "codespace"}, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + if got := requiredScopesFromServerMessage(tt.msg); !reflect.DeepEqual(got, tt.want) { + t.Errorf("requiredScopesFromServerMessage() = %v, want %v", got, tt.want) + } + }) + } +} + +func TestNewProject_nonTTY(t *testing.T) { + client := NewTestClient() + _, err := client.NewProject(false, &Owner{}, 0, false) + assert.EqualError(t, err, "project number is required when not running interactively") +} + +func TestNewOwner_nonTTY(t *testing.T) { + client := NewTestClient() + _, err := client.NewOwner(false, "") + assert.EqualError(t, err, "login is required when not running interactively") + +} diff --git a/pkg/cmd/project/view/view.go b/pkg/cmd/project/view/view.go new file mode 100644 index 000000000..36eb148e3 --- /dev/null +++ b/pkg/cmd/project/view/view.go @@ -0,0 +1,203 @@ +package view + +import ( + "fmt" + "strconv" + "strings" + + "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/pkg/cmd/project/shared/client" + "github.com/cli/cli/v2/pkg/cmd/project/shared/format" + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/cli/v2/pkg/markdown" + "github.com/spf13/cobra" +) + +type viewOpts struct { + web bool + owner string + number int32 + format string +} + +type viewConfig struct { + client *queries.Client + opts viewOpts + io *iostreams.IOStreams + URLOpener func(string) error +} + +func NewCmdView(f *cmdutil.Factory, runF func(config viewConfig) error) *cobra.Command { + opts := viewOpts{} + viewCmd := &cobra.Command{ + Short: "View a project", + Use: "view []", + Example: heredoc.Doc(` + # view the current user's project "1" + gh project view 1 + + # open user monalisa's project "1" in the browser + gh project view 1 --owner monalisa --web + `), + Args: cobra.MaximumNArgs(1), + RunE: func(cmd *cobra.Command, args []string) error { + client, err := client.New(f) + if err != nil { + return err + } + + URLOpener := func(url string) error { + return f.Browser.Browse(url) + } + + if len(args) == 1 { + num, err := strconv.ParseInt(args[0], 10, 32) + if err != nil { + return cmdutil.FlagErrorf("invalid number: %v", args[0]) + } + opts.number = int32(num) + } + + config := viewConfig{ + client: client, + opts: opts, + io: f.IOStreams, + URLOpener: URLOpener, + } + + // allow testing of the command without actually running it + if runF != nil { + return runF(config) + } + return runView(config) + }, + } + + viewCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the owner. Use \"@me\" for the current user.") + viewCmd.Flags().BoolVarP(&opts.web, "web", "w", false, "Open a project in the browser") + cmdutil.StringEnumFlag(viewCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + + return viewCmd +} + +func runView(config viewConfig) error { + if config.opts.web { + url, err := buildURL(config) + if err != nil { + return err + } + + if err := config.URLOpener(url); err != nil { + return err + } + return nil + } + + canPrompt := config.io.CanPrompt() + owner, err := config.client.NewOwner(canPrompt, config.opts.owner) + if err != nil { + return err + } + + project, err := config.client.NewProject(canPrompt, owner, config.opts.number, true) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printJSON(config, *project) + } + + return printResults(config, project) +} + +// TODO: support non-github.com hostnames +func buildURL(config viewConfig) (string, error) { + var url string + if config.opts.owner == "@me" { + owner, err := config.client.ViewerLoginName() + if err != nil { + return "", err + } + url = fmt.Sprintf("https://github.com/users/%s/projects/%d", owner, config.opts.number) + } else { + _, ownerType, err := config.client.OwnerIDAndType(config.opts.owner) + if err != nil { + return "", err + } + + if ownerType == queries.UserOwner { + url = fmt.Sprintf("https://github.com/users/%s/projects/%d", config.opts.owner, config.opts.number) + } else { + url = fmt.Sprintf("https://github.com/orgs/%s/projects/%d", config.opts.owner, config.opts.number) + } + } + + return url, nil +} + +func printResults(config viewConfig, project *queries.Project) error { + var sb strings.Builder + sb.WriteString("# Title\n") + sb.WriteString(project.Title) + sb.WriteString("\n") + + sb.WriteString("## Description\n") + if project.ShortDescription == "" { + sb.WriteString(" -- ") + } else { + sb.WriteString(project.ShortDescription) + } + sb.WriteString("\n") + + sb.WriteString("## Visibility\n") + if project.Public { + sb.WriteString("Public") + } else { + sb.WriteString("Private") + } + sb.WriteString("\n") + + sb.WriteString("## URL\n") + sb.WriteString(project.URL) + sb.WriteString("\n") + + sb.WriteString("## Item count\n") + sb.WriteString(fmt.Sprintf("%d", project.Items.TotalCount)) + sb.WriteString("\n") + + sb.WriteString("## Readme\n") + if project.Readme == "" { + sb.WriteString(" -- ") + } else { + sb.WriteString(project.Readme) + } + sb.WriteString("\n") + + sb.WriteString("## Field Name (Field Type)\n") + for _, f := range project.Fields.Nodes { + sb.WriteString(fmt.Sprintf("%s (%s)\n\n", f.Name(), f.Type())) + } + + out, err := markdown.Render(sb.String(), + markdown.WithTheme(config.io.TerminalTheme()), + markdown.WithWrap(config.io.TerminalWidth())) + + if err != nil { + return err + } + _, err = fmt.Fprint(config.io.Out, out) + return err +} + +func printJSON(config viewConfig, project queries.Project) error { + b, err := format.JSONProject(project) + if err != nil { + return err + } + + _, err = config.io.Out.Write(b) + return err +} diff --git a/pkg/cmd/project/view/view_test.go b/pkg/cmd/project/view/view_test.go new file mode 100644 index 000000000..5c76c1413 --- /dev/null +++ b/pkg/cmd/project/view/view_test.go @@ -0,0 +1,545 @@ +package view + +import ( + "bytes" + "os" + "testing" + + "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" + "github.com/cli/cli/v2/pkg/cmdutil" + "github.com/cli/cli/v2/pkg/iostreams" + "github.com/google/shlex" + "github.com/stretchr/testify/assert" + "gopkg.in/h2non/gock.v1" +) + +func TestNewCmdview(t *testing.T) { + tests := []struct { + name string + cli string + wants viewOpts + wantsErr bool + wantsErrMsg string + }{ + { + name: "not-a-number", + cli: "x", + wantsErr: true, + wantsErrMsg: "invalid number: x", + }, + { + name: "number", + cli: "123", + wants: viewOpts{ + number: 123, + }, + }, + { + name: "owner", + cli: "--owner monalisa", + wants: viewOpts{ + owner: "monalisa", + }, + }, + { + name: "web", + cli: "--web", + wants: viewOpts{ + web: true, + }, + }, + { + name: "json", + cli: "--format json", + wants: viewOpts{ + format: "json", + }, + }, + } + + os.Setenv("GH_TOKEN", "auth-token") + defer os.Unsetenv("GH_TOKEN") + + 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 viewOpts + cmd := NewCmdView(f, func(config viewConfig) error { + gotOpts = config.opts + return nil + }) + + cmd.SetArgs(argv) + _, err = cmd.ExecuteC() + if tt.wantsErr { + assert.Error(t, err) + assert.Equal(t, tt.wantsErrMsg, err.Error()) + return + } + assert.NoError(t, err) + + assert.Equal(t, tt.wants.number, gotOpts.number) + assert.Equal(t, tt.wants.owner, gotOpts.owner) + assert.Equal(t, tt.wants.format, gotOpts.format) + assert.Equal(t, tt.wants.web, gotOpts.web) + }) + } +} + +func TestBuildURLViewer(t *testing.T) { + defer gock.Off() + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(` + {"data": + {"viewer": + { + "login":"theviewer" + } + } + } + `) + + client := queries.NewTestClient() + + url, err := buildURL(viewConfig{ + opts: viewOpts{ + number: 1, + owner: "@me", + }, + client: client, + }) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/users/theviewer/projects/1", url) +} + +func TestRunView_User(t *testing.T) { + defer gock.Off() + + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(` + {"data": + {"user": + { + "login":"monalisa", + "projectV2": { + "number": 1, + "items": { + "totalCount": 10 + }, + "readme": null, + "fields": { + "nodes": [ + { + "name": "Title" + } + ] + } + } + } + } + } + `) + + client := queries.NewTestClient() + + ios, _, _, _ := iostreams.Test() + config := viewConfig{ + opts: viewOpts{ + owner: "monalisa", + number: 1, + }, + io: ios, + client: client, + } + + err := runView(config) + assert.NoError(t, err) + +} + +func TestRunView_Viewer(t *testing.T) { + defer gock.Off() + + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query ViewerOwner.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(` + {"data": + {"viewer": + { + "login":"monalisa", + "projectV2": { + "number": 1, + "items": { + "totalCount": 10 + }, + "readme": null, + "fields": { + "nodes": [ + { + "name": "Title" + } + ] + } + } + } + } + } + `) + + client := queries.NewTestClient() + + ios, _, _, _ := iostreams.Test() + config := viewConfig{ + opts: viewOpts{ + owner: "@me", + number: 1, + }, + io: ios, + client: client, + } + + err := runView(config) + assert.NoError(t, err) +} + +func TestRunView_Org(t *testing.T) { + defer gock.Off() + + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(` + {"data": + {"organization": + { + "login":"monalisa", + "projectV2": { + "number": 1, + "items": { + "totalCount": 10 + }, + "readme": null, + "fields": { + "nodes": [ + { + "name": "Title" + } + ] + } + } + } + } + } + `) + + client := queries.NewTestClient() + + ios, _, _, _ := iostreams.Test() + config := viewConfig{ + opts: viewOpts{ + owner: "github", + number: 1, + }, + io: ios, + client: client, + } + + err := runView(config) + assert.NoError(t, err) +} + +func TestRunViewWeb_User(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get user ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "monalisa", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "user": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"organization"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(` + {"data": + {"user": + { + "login":"monalisa", + "projectV2": { + "number": 1, + "items": { + "totalCount": 10 + }, + "readme": null, + "fields": { + "nodes": [ + { + "name": "Title" + } + ] + } + } + } + } + } + `) + + client := queries.NewTestClient() + buf := bytes.Buffer{} + config := viewConfig{ + opts: viewOpts{ + owner: "monalisa", + web: true, + number: 8, + }, + URLOpener: func(url string) error { + buf.WriteString(url) + return nil + }, + client: client, + } + + err := runView(config) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/users/monalisa/projects/8", buf.String()) +} + +func TestRunViewWeb_Org(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get org ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query UserOrgOwner.*", + "variables": map[string]interface{}{ + "login": "github", + }, + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "organization": map[string]interface{}{ + "id": "an ID", + }, + }, + "errors": []interface{}{ + map[string]interface{}{ + "type": "NOT_FOUND", + "path": []string{"user"}, + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(` + {"data": + {"organization": + { + "login":"github", + "projectV2": { + "number": 1, + "items": { + "totalCount": 10 + }, + "readme": null, + "fields": { + "nodes": [ + { + "name": "Title" + } + ] + } + } + } + } + } + `) + + client := queries.NewTestClient() + buf := bytes.Buffer{} + config := viewConfig{ + opts: viewOpts{ + owner: "github", + web: true, + number: 8, + }, + URLOpener: func(url string) error { + buf.WriteString(url) + return nil + }, + client: client, + } + + err := runView(config) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/orgs/github/projects/8", buf.String()) +} + +func TestRunViewWeb_Me(t *testing.T) { + defer gock.Off() + gock.Observe(gock.DumpRequest) + // get viewer ID + gock.New("https://api.github.com"). + Post("/graphql"). + MatchType("json"). + JSON(map[string]interface{}{ + "query": "query Viewer.*", + }). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "viewer": map[string]interface{}{ + "id": "an ID", + "login": "theviewer", + }, + }, + }) + + gock.New("https://api.github.com"). + Post("/graphql"). + Reply(200). + JSON(` + {"data": + {"user": + { + "login":"github", + "projectV2": { + "number": 1, + "items": { + "totalCount": 10 + }, + "readme": null, + "fields": { + "nodes": [ + { + "name": "Title" + } + ] + } + } + } + } + } + `) + + client := queries.NewTestClient() + buf := bytes.Buffer{} + config := viewConfig{ + opts: viewOpts{ + owner: "@me", + web: true, + number: 8, + }, + URLOpener: func(url string) error { + buf.WriteString(url) + return nil + }, + client: client, + } + + err := runView(config) + assert.NoError(t, err) + assert.Equal(t, "https://github.com/users/theviewer/projects/8", buf.String()) +} diff --git a/pkg/cmd/root/root.go b/pkg/cmd/root/root.go index 437063d77..2929ca720 100644 --- a/pkg/cmd/root/root.go +++ b/pkg/cmd/root/root.go @@ -27,6 +27,7 @@ import ( labelCmd "github.com/cli/cli/v2/pkg/cmd/label" orgCmd "github.com/cli/cli/v2/pkg/cmd/org" prCmd "github.com/cli/cli/v2/pkg/cmd/pr" + projectCmd "github.com/cli/cli/v2/pkg/cmd/project" releaseCmd "github.com/cli/cli/v2/pkg/cmd/release" repoCmd "github.com/cli/cli/v2/pkg/cmd/repo" creditsCmd "github.com/cli/cli/v2/pkg/cmd/repo/credits" @@ -139,6 +140,8 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, cmd.AddCommand(apiCmd.NewCmdApi(&bareHTTPCmdFactory, nil)) + cmd.AddCommand(projectCmd.NewCmdProject(f)) + // below here at the commands that require the "intelligent" BaseRepo resolver repoResolvingCmdFactory := *f repoResolvingCmdFactory.BaseRepo = factory.SmartBaseRepoFunc(f) From 63a4319f6caedccbadf1bf0317d70b6f0cb1b5b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Fri, 9 Jun 2023 20:55:06 +0200 Subject: [PATCH 86/90] api: output a single JSON array in REST pagination mode (#7190) When fetching N pages, avoid printing N separate JSON arrays to the output stream. Instead, massage the output so that the N pages of data are merged into a single JSON array. This is achieved by omitting the final `]` for the first page, and omitting the initial `[` for all subsequent pages. --- pkg/cmd/api/api.go | 21 ++++++++--- pkg/cmd/api/api_test.go | 74 ++++++++++++++++++++++++++++++++++++++- pkg/cmd/api/pagination.go | 40 +++++++++++++++++++++ 3 files changed, 129 insertions(+), 6 deletions(-) diff --git a/pkg/cmd/api/api.go b/pkg/cmd/api/api.go index ea0734d21..82eaecb8d 100644 --- a/pkg/cmd/api/api.go +++ b/pkg/cmd/api/api.go @@ -321,6 +321,7 @@ func apiRun(opts *ApiOptions) error { return err } + isFirstPage := true hasNextPage := true for hasNextPage { resp, err := httpRequest(httpClient, host, method, requestPath, requestBody, requestHeaders) @@ -328,10 +329,16 @@ func apiRun(opts *ApiOptions) error { return err } - endCursor, err := processResponse(resp, opts, bodyWriter, headersWriter, tmpl) + if !isGraphQL { + requestPath, hasNextPage = findNextPage(resp) + requestBody = nil // prevent repeating GET parameters + } + + endCursor, err := processResponse(resp, opts, bodyWriter, headersWriter, tmpl, isFirstPage, !hasNextPage) if err != nil { return err } + isFirstPage = false if !opts.Paginate { break @@ -342,9 +349,6 @@ func apiRun(opts *ApiOptions) error { if hasNextPage { params["endCursor"] = endCursor } - } else { - requestPath, hasNextPage = findNextPage(resp) - requestBody = nil // prevent repeating GET parameters } if hasNextPage && opts.ShowResponseHeaders { @@ -355,7 +359,7 @@ func apiRun(opts *ApiOptions) error { return tmpl.Flush() } -func processResponse(resp *http.Response, opts *ApiOptions, bodyWriter, headersWriter io.Writer, template *template.Template) (endCursor string, err error) { +func processResponse(resp *http.Response, opts *ApiOptions, bodyWriter, headersWriter io.Writer, template *template.Template, isFirstPage, isLastPage bool) (endCursor string, err error) { if opts.ShowResponseHeaders { fmt.Fprintln(headersWriter, resp.Proto, resp.Status) printHeaders(headersWriter, resp.Header, opts.IO.ColorEnabled()) @@ -403,6 +407,13 @@ func processResponse(resp *http.Response, opts *ApiOptions, bodyWriter, headersW } else if isJSON && opts.IO.ColorEnabled() { err = jsoncolor.Write(bodyWriter, responseBody, " ") } else { + if isJSON && opts.Paginate && !isGraphQLPaginate && !opts.ShowResponseHeaders { + responseBody = &paginatedArrayReader{ + Reader: responseBody, + isFirstPage: isFirstPage, + isLastPage: isLastPage, + } + } _, err = io.Copy(bodyWriter, responseBody) } if err != nil { diff --git a/pkg/cmd/api/api_test.go b/pkg/cmd/api/api_test.go index ebbff6b6e..bd2a94994 100644 --- a/pkg/cmd/api/api_test.go +++ b/pkg/cmd/api/api_test.go @@ -668,6 +668,78 @@ func Test_apiRun_paginationREST(t *testing.T) { assert.Equal(t, "https://api.github.com/repositories/1227/issues?page=3", responses[2].Request.URL.String()) } +func Test_apiRun_arrayPaginationREST(t *testing.T) { + ios, _, stdout, stderr := iostreams.Test() + ios.SetStdoutTTY(false) + + requestCount := 0 + responses := []*http.Response{ + { + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`[{"item":1},{"item":2}]`)), + Header: http.Header{ + "Content-Type": []string{"application/json"}, + "Link": []string{`; rel="next", ; rel="last"`}, + }, + }, + { + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`[{"item":3},{"item":4}]`)), + Header: http.Header{ + "Content-Type": []string{"application/json"}, + "Link": []string{`; rel="next", ; rel="last"`}, + }, + }, + { + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`[{"item":5}]`)), + Header: http.Header{ + "Content-Type": []string{"application/json"}, + "Link": []string{`; rel="next", ; rel="last"`}, + }, + }, + { + StatusCode: 200, + Body: io.NopCloser(bytes.NewBufferString(`[]`)), + Header: http.Header{ + "Content-Type": []string{"application/json"}, + }, + }, + } + + options := ApiOptions{ + IO: ios, + HttpClient: func() (*http.Client, error) { + var tr roundTripper = func(req *http.Request) (*http.Response, error) { + resp := responses[requestCount] + resp.Request = req + requestCount++ + return resp, nil + } + return &http.Client{Transport: tr}, nil + }, + Config: func() (config.Config, error) { + return config.NewBlankConfig(), nil + }, + + RequestMethod: "GET", + RequestMethodPassed: true, + RequestPath: "issues", + Paginate: true, + RawFields: []string{"per_page=50", "page=1"}, + } + + err := apiRun(&options) + assert.NoError(t, err) + + assert.Equal(t, `[{"item":1},{"item":2},{"item":3},{"item":4},{"item":5} ]`, stdout.String(), "stdout") + assert.Equal(t, "", stderr.String(), "stderr") + + assert.Equal(t, "https://api.github.com/issues?page=1&per_page=50", responses[0].Request.URL.String()) + assert.Equal(t, "https://api.github.com/repositories/1227/issues?page=2", responses[1].Request.URL.String()) + assert.Equal(t, "https://api.github.com/repositories/1227/issues?page=3", responses[2].Request.URL.String()) +} + func Test_apiRun_paginationGraphQL(t *testing.T) { ios, _, stdout, stderr := iostreams.Test() @@ -1236,7 +1308,7 @@ func Test_processResponse_template(t *testing.T) { tmpl := template.New(ios.Out, ios.TerminalWidth(), ios.ColorEnabled()) err := tmpl.Parse(opts.Template) require.NoError(t, err) - _, err = processResponse(&resp, &opts, ios.Out, io.Discard, tmpl) + _, err = processResponse(&resp, &opts, ios.Out, io.Discard, tmpl, true, true) require.NoError(t, err) err = tmpl.Flush() require.NoError(t, err) diff --git a/pkg/cmd/api/pagination.go b/pkg/cmd/api/pagination.go index 65d816480..057a5a7fa 100644 --- a/pkg/cmd/api/pagination.go +++ b/pkg/cmd/api/pagination.go @@ -106,3 +106,43 @@ func addPerPage(p string, perPage int, params map[string]interface{}) string { return fmt.Sprintf("%s%sper_page=%d", p, sep, perPage) } + +// paginatedArrayReader wraps a Reader to omit the opening and/or the closing square bracket of a +// JSON array in order to apply pagination context between multiple API requests. +type paginatedArrayReader struct { + io.Reader + isFirstPage bool + isLastPage bool + + isSubsequentRead bool + cachedByte byte +} + +func (r *paginatedArrayReader) Read(p []byte) (int, error) { + var n int + var err error + if r.cachedByte != 0 && len(p) > 0 { + p[0] = r.cachedByte + n, err = r.Reader.Read(p[1:]) + n += 1 + r.cachedByte = 0 + } else { + n, err = r.Reader.Read(p) + } + if !r.isSubsequentRead && !r.isFirstPage && n > 0 && p[0] == '[' { + if n > 1 && p[1] == ']' { + // empty array case + p[0] = ' ' + } else { + // avoid starting a new array and continue with a comma instead + p[0] = ',' + } + } + if !r.isLastPage && n > 0 && p[n-1] == ']' { + // avoid closing off an array in case we determine we are at EOF + r.cachedByte = p[n-1] + n -= 1 + } + r.isSubsequentRead = true + return n, err +} From fac497108b75158ba09966fca81e500476a1a0f7 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Mon, 12 Jun 2023 09:23:56 +0900 Subject: [PATCH 87/90] Set upstream remote to track all branches after initial fetch (#7542) --- git/client.go | 76 +++++++++++++++++++++---------- git/client_test.go | 78 ++++++++++++++++++++++++++++++++ pkg/cmd/extension/git.go | 13 ++---- pkg/cmd/repo/clone/clone.go | 11 ++++- pkg/cmd/repo/clone/clone_test.go | 2 + pkg/cmd/repo/create/create.go | 15 +----- 6 files changed, 145 insertions(+), 50 deletions(-) diff --git a/git/client.go b/git/client.go index a7d59899e..a029c8ba6 100644 --- a/git/client.go +++ b/git/client.go @@ -36,6 +36,19 @@ type Client struct { mu sync.Mutex } +func (c *Client) Copy() *Client { + return &Client{ + GhPath: c.GhPath, + RepoDir: c.RepoDir, + GitPath: c.GitPath, + Stderr: c.Stderr, + Stdin: c.Stdin, + Stdout: c.Stdout, + + commandContext: c.commandContext, + } +} + func (c *Client) Command(ctx context.Context, args ...string) (*Command, error) { if c.RepoDir != "" { args = append([]string{"-C", c.RepoDir}, args...) @@ -408,6 +421,44 @@ func (c *Client) revParse(ctx context.Context, args ...string) ([]byte, error) { return cmd.Output() } +func (c *Client) IsLocalGitRepo(ctx context.Context) (bool, error) { + _, err := c.GitDir(ctx) + if err != nil { + var execError errWithExitCode + if errors.As(err, &execError) && execError.ExitCode() == 128 { + return false, nil + } + return false, err + } + return true, nil +} + +func (c *Client) UnsetRemoteResolution(ctx context.Context, name string) error { + args := []string{"config", "--unset", fmt.Sprintf("remote.%s.gh-resolved", name)} + cmd, err := c.Command(ctx, args...) + if err != nil { + return err + } + _, err = cmd.Output() + if err != nil { + return err + } + return nil +} + +func (c *Client) SetRemoteBranches(ctx context.Context, remote string, refspec string) error { + args := []string{"remote", "set-branches", remote, refspec} + cmd, err := c.Command(ctx, args...) + if err != nil { + return err + } + _, err = cmd.Output() + if err != nil { + return err + } + return nil +} + // Below are commands that make network calls and need authentication credentials supplied from gh. func (c *Client) Fetch(ctx context.Context, remote string, refspec string, mods ...CommandModifier) error { @@ -513,31 +564,6 @@ func (c *Client) AddRemote(ctx context.Context, name, urlStr string, trackingBra return remote, nil } -func (c *Client) IsLocalGitRepo(ctx context.Context) (bool, error) { - _, err := c.GitDir(ctx) - if err != nil { - var execError errWithExitCode - if errors.As(err, &execError) && execError.ExitCode() == 128 { - return false, nil - } - return false, err - } - return true, nil -} - -func (c *Client) UnsetRemoteResolution(ctx context.Context, name string) error { - args := []string{"config", "--unset", fmt.Sprintf("remote.%s.gh-resolved", name)} - cmd, err := c.Command(ctx, args...) - if err != nil { - return err - } - _, err = cmd.Output() - if err != nil { - return err - } - return nil -} - func resolveGitPath() (string, error) { path, err := safeexec.LookPath("git") if err != nil { diff --git a/git/client_test.go b/git/client_test.go index 6bbeee27e..5e96bb1b7 100644 --- a/git/client_test.go +++ b/git/client_test.go @@ -834,6 +834,84 @@ func TestClientPathFromRoot(t *testing.T) { } } +func TestClientUnsetRemoteResolution(t *testing.T) { + tests := []struct { + name string + cmdExitStatus int + cmdStdout string + cmdStderr string + wantCmdArgs string + wantErrorMsg string + }{ + { + name: "unset remote resolution", + wantCmdArgs: `path/to/git config --unset remote.origin.gh-resolved`, + }, + { + name: "git error", + cmdExitStatus: 1, + cmdStderr: "git error message", + wantCmdArgs: `path/to/git config --unset remote.origin.gh-resolved`, + wantErrorMsg: "failed to run git: git error message", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + cmd, cmdCtx := createCommandContext(t, tt.cmdExitStatus, tt.cmdStdout, tt.cmdStderr) + client := Client{ + GitPath: "path/to/git", + commandContext: cmdCtx, + } + err := client.UnsetRemoteResolution(context.Background(), "origin") + assert.Equal(t, tt.wantCmdArgs, strings.Join(cmd.Args[3:], " ")) + if tt.wantErrorMsg == "" { + assert.NoError(t, err) + } else { + assert.EqualError(t, err, tt.wantErrorMsg) + } + }) + } +} + +func TestClientSetRemoteBranches(t *testing.T) { + tests := []struct { + name string + cmdExitStatus int + cmdStdout string + cmdStderr string + wantCmdArgs string + wantErrorMsg string + }{ + { + name: "set remote branches", + wantCmdArgs: `path/to/git remote set-branches origin trunk`, + }, + { + name: "git error", + cmdExitStatus: 1, + cmdStderr: "git error message", + wantCmdArgs: `path/to/git remote set-branches origin trunk`, + wantErrorMsg: "failed to run git: git error message", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + cmd, cmdCtx := createCommandContext(t, tt.cmdExitStatus, tt.cmdStdout, tt.cmdStderr) + client := Client{ + GitPath: "path/to/git", + commandContext: cmdCtx, + } + err := client.SetRemoteBranches(context.Background(), "origin", "trunk") + assert.Equal(t, tt.wantCmdArgs, strings.Join(cmd.Args[3:], " ")) + if tt.wantErrorMsg == "" { + assert.NoError(t, err) + } else { + assert.EqualError(t, err, tt.wantErrorMsg) + } + }) + } +} + func TestClientFetch(t *testing.T) { tests := []struct { name string diff --git a/pkg/cmd/extension/git.go b/pkg/cmd/extension/git.go index e85ff7371..58ef0ca12 100644 --- a/pkg/cmd/extension/git.go +++ b/pkg/cmd/extension/git.go @@ -46,16 +46,9 @@ func (g *gitExecuter) Fetch(remote string, refspec string) error { } func (g *gitExecuter) ForRepo(repoDir string) gitClient { - return &gitExecuter{ - client: &git.Client{ - GhPath: g.client.GhPath, - RepoDir: repoDir, - GitPath: g.client.GitPath, - Stderr: g.client.Stderr, - Stdin: g.client.Stdin, - Stdout: g.client.Stdout, - }, - } + gc := g.client.Copy() + gc.RepoDir = repoDir + return &gitExecuter{client: gc} } func (g *gitExecuter) Pull(remote, branch string) error { diff --git a/pkg/cmd/repo/clone/clone.go b/pkg/cmd/repo/clone/clone.go index fc39013c0..8d04ac630 100644 --- a/pkg/cmd/repo/clone/clone.go +++ b/pkg/cmd/repo/clone/clone.go @@ -175,12 +175,19 @@ func cloneRun(opts *CloneOptions) error { upstreamName = canonicalRepo.Parent.RepoOwner() } - _, err = gitClient.AddRemote(ctx, upstreamName, upstreamURL, []string{canonicalRepo.Parent.DefaultBranchRef.Name}, git.WithRepoDir(cloneDir)) + gc := gitClient.Copy() + gc.RepoDir = cloneDir + + _, err = gc.AddRemote(ctx, upstreamName, upstreamURL, []string{canonicalRepo.Parent.DefaultBranchRef.Name}) if err != nil { return err } - if err := gitClient.Fetch(ctx, upstreamName, "", git.WithRepoDir(cloneDir)); err != nil { + if err := gc.Fetch(ctx, upstreamName, ""); err != nil { + return err + } + + if err := gc.SetRemoteBranches(ctx, upstreamName, `*`); err != nil { return err } } diff --git a/pkg/cmd/repo/clone/clone_test.go b/pkg/cmd/repo/clone/clone_test.go index 98fc3736c..0ea3a65af 100644 --- a/pkg/cmd/repo/clone/clone_test.go +++ b/pkg/cmd/repo/clone/clone_test.go @@ -247,6 +247,7 @@ func Test_RepoClone_hasParent(t *testing.T) { cs.Register(`git clone https://github.com/OWNER/REPO.git`, 0, "") cs.Register(`git -C REPO remote add -t trunk upstream https://github.com/hubot/ORIG.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO remote set-branches upstream *`, 0, "") _, err := runCloneCommand(httpClient, "OWNER/REPO") if err != nil { @@ -284,6 +285,7 @@ func Test_RepoClone_hasParent_upstreamRemoteName(t *testing.T) { cs.Register(`git clone https://github.com/OWNER/REPO.git`, 0, "") cs.Register(`git -C REPO remote add -t trunk test https://github.com/hubot/ORIG.git`, 0, "") cs.Register(`git -C REPO fetch test`, 0, "") + cs.Register(`git -C REPO remote set-branches test *`, 0, "") _, err := runCloneCommand(httpClient, "OWNER/REPO --upstream-remote-name test") if err != nil { diff --git a/pkg/cmd/repo/create/create.go b/pkg/cmd/repo/create/create.go index fe2269e7e..1bd37769b 100644 --- a/pkg/cmd/repo/create/create.go +++ b/pkg/cmd/repo/create/create.go @@ -662,8 +662,8 @@ func localInit(gitClient *git.Client, remoteURL, path string) error { return err } - // Clone the client so we do not modify the original client's RepoDir. - gc := cloneGitClient(gitClient) + // Copy the client so we do not modify the original client's RepoDir. + gc := gitClient.Copy() gc.RepoDir = path gitRemoteAdd, err := gc.Command(ctx, "remote", "add", "origin", remoteURL) @@ -794,14 +794,3 @@ func splitNameAndOwner(name string) (string, string, error) { } return repo.RepoName(), repo.RepoOwner(), nil } - -func cloneGitClient(c *git.Client) *git.Client { - return &git.Client{ - GhPath: c.GhPath, - RepoDir: c.RepoDir, - GitPath: c.GitPath, - Stderr: c.Stderr, - Stdin: c.Stdin, - Stdout: c.Stdout, - } -} From e9a80652d5ec5f0772f2cb2678b002f19b7378a8 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 13 Jun 2023 14:58:17 +0000 Subject: [PATCH 88/90] build(deps): bump github.com/AlecAivazis/survey/v2 from 2.3.6 to 2.3.7 Bumps [github.com/AlecAivazis/survey/v2](https://github.com/AlecAivazis/survey) from 2.3.6 to 2.3.7. - [Release notes](https://github.com/AlecAivazis/survey/releases) - [Commits](https://github.com/AlecAivazis/survey/compare/v2.3.6...v2.3.7) --- updated-dependencies: - dependency-name: github.com/AlecAivazis/survey/v2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 7 +++---- 2 files changed, 4 insertions(+), 5 deletions(-) diff --git a/go.mod b/go.mod index a0b3781cf..e0e92c352 100644 --- a/go.mod +++ b/go.mod @@ -3,7 +3,7 @@ module github.com/cli/cli/v2 go 1.19 require ( - github.com/AlecAivazis/survey/v2 v2.3.6 + github.com/AlecAivazis/survey/v2 v2.3.7 github.com/MakeNowJust/heredoc v1.0.0 github.com/briandowns/spinner v1.18.1 github.com/cenkalti/backoff/v4 v4.2.1 diff --git a/go.sum b/go.sum index 1d3b83805..85ba744f4 100644 --- a/go.sum +++ b/go.sum @@ -31,8 +31,8 @@ cloud.google.com/go/storage v1.6.0/go.mod h1:N7U0C8pVQ/+NIKOBQyamJIeKQKkZ+mxpohl cloud.google.com/go/storage v1.8.0/go.mod h1:Wv1Oy7z6Yz3DshWRJFhqM/UCfaWIRTdp0RXyy7KQOVs= cloud.google.com/go/storage v1.10.0/go.mod h1:FLPqc6j+Ki4BU591ie1oL6qBQGu2Bl/tZ9ullr3+Kg0= dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU= -github.com/AlecAivazis/survey/v2 v2.3.6 h1:NvTuVHISgTHEHeBFqt6BHOe4Ny/NwGZr7w+F8S9ziyw= -github.com/AlecAivazis/survey/v2 v2.3.6/go.mod h1:4AuI9b7RjAR+G7v9+C4YSlX/YL3K3cWNXgWXOhllqvI= +github.com/AlecAivazis/survey/v2 v2.3.7 h1:6I/u8FvytdGsgonrYsVn2t8t4QiRnh6QSTqkkhIiSjQ= +github.com/AlecAivazis/survey/v2 v2.3.7/go.mod h1:xUTIdE4KCOIjsBAE1JYsUPoCqYdZ1reCfTwbto0Fduo= github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo= github.com/MakeNowJust/heredoc v1.0.0 h1:cXCdzVdstXyiTqTvfqk9SDHpKNjxuom+DOlyEeQ4pzQ= @@ -401,7 +401,6 @@ golang.org/x/sys v0.0.0-20210831042530-f4d43177bf5e/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220209214540-3681064d5158/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.0.0-20220422013727-9388b58f7150/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220728004956-3c1f35247d10/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= @@ -410,7 +409,6 @@ golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.8.0 h1:EBmGv8NaZBZTWvrbjNoL6HVt+IVy3QDQpJs7VRIw3tU= golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/term v0.0.0-20210503060354-a79de5458b56/go.mod h1:tfny5GFUkzUvx4ps4ajbZsCe5lw1metzhBm9T3x7oIY= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.7.0 h1:BEvjmm5fURWqcfbSKTdpkDXYBrUS1c0m8agp14W48vQ= golang.org/x/term v0.7.0/go.mod h1:P32HKFT3hSsZrRxla30E9HqToFYAQPCMs/zFMBUFqPY= @@ -421,6 +419,7 @@ golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE= golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= From beb6234f96a6cd952e02e90b4a6b75fd628f4eda Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mislav=20Marohni=C4=87?= Date: Wed, 14 Jun 2023 02:33:18 +0200 Subject: [PATCH 89/90] Speed up listing extensions by lazy-loading extension information when needed (#7493) --- pkg/cmd/extension/extension.go | 193 +++++++++++++++++++++---- pkg/cmd/extension/extension_test.go | 10 +- pkg/cmd/extension/manager.go | 217 +++++++--------------------- pkg/cmd/extension/manager_test.go | 51 ++----- pkg/cmd/root/extension.go | 16 +- pkg/extensions/extension.go | 1 + pkg/extensions/extension_mock.go | 37 +++++ 7 files changed, 274 insertions(+), 251 deletions(-) diff --git a/pkg/cmd/extension/extension.go b/pkg/cmd/extension/extension.go index 9d1d61c21..188687634 100644 --- a/pkg/cmd/extension/extension.go +++ b/pkg/cmd/extension/extension.go @@ -1,8 +1,16 @@ package extension import ( + "bytes" + "fmt" + "net/http" + "os" "path/filepath" "strings" + "sync" + + "github.com/cli/cli/v2/internal/ghrepo" + "gopkg.in/yaml.v3" ) const manifestName = "manifest.yml" @@ -12,16 +20,22 @@ type ExtensionKind int const ( GitKind ExtensionKind = iota BinaryKind + LocalKind ) type Extension struct { - path string + path string + kind ExtensionKind + gitClient gitClient + httpClient *http.Client + + mu sync.RWMutex + + // These fields get resolved dynamically: url string - isLocal bool - isPinned bool + isPinned *bool currentVersion string latestVersion string - kind ExtensionKind } func (e *Extension) Name() string { @@ -32,32 +46,157 @@ func (e *Extension) Path() string { return e.path } -func (e *Extension) URL() string { - return e.url -} - func (e *Extension) IsLocal() bool { - return e.isLocal -} - -func (e *Extension) CurrentVersion() string { - return e.currentVersion -} - -func (e *Extension) IsPinned() bool { - return e.isPinned -} - -func (e *Extension) UpdateAvailable() bool { - if e.isLocal || - e.currentVersion == "" || - e.latestVersion == "" || - e.currentVersion == e.latestVersion { - return false - } - return true + return e.kind == LocalKind } func (e *Extension) IsBinary() bool { return e.kind == BinaryKind } + +func (e *Extension) URL() string { + e.mu.RLock() + if e.url != "" { + defer e.mu.RUnlock() + return e.url + } + e.mu.RUnlock() + + var url string + switch e.kind { + case LocalKind: + case BinaryKind: + if manifest, err := e.loadManifest(); err == nil { + repo := ghrepo.NewWithHost(manifest.Owner, manifest.Name, manifest.Host) + url = ghrepo.GenerateRepoURL(repo, "") + } + case GitKind: + if remoteURL, err := e.gitClient.Config("remote.origin.url"); err == nil { + url = strings.TrimSpace(string(remoteURL)) + } + } + + e.mu.Lock() + e.url = url + e.mu.Unlock() + + return e.url +} + +func (e *Extension) CurrentVersion() string { + e.mu.RLock() + if e.currentVersion != "" { + defer e.mu.RUnlock() + return e.currentVersion + } + e.mu.RUnlock() + + var currentVersion string + switch e.kind { + case LocalKind: + case BinaryKind: + if manifest, err := e.loadManifest(); err == nil { + currentVersion = manifest.Tag + } + case GitKind: + if sha, err := e.gitClient.CommandOutput([]string{"rev-parse", "HEAD"}); err == nil { + currentVersion = string(bytes.TrimSpace(sha)) + } + } + + e.mu.Lock() + e.currentVersion = currentVersion + e.mu.Unlock() + + return e.currentVersion +} + +func (e *Extension) LatestVersion() string { + e.mu.RLock() + if e.latestVersion != "" { + defer e.mu.RUnlock() + return e.latestVersion + } + e.mu.RUnlock() + + var latestVersion string + switch e.kind { + case LocalKind: + case BinaryKind: + repo, err := ghrepo.FromFullName(e.URL()) + if err != nil { + return "" + } + release, err := fetchLatestRelease(e.httpClient, repo) + if err != nil { + return "" + } + latestVersion = release.Tag + case GitKind: + if lsRemote, err := e.gitClient.CommandOutput([]string{"ls-remote", "origin", "HEAD"}); err == nil { + latestVersion = string(bytes.SplitN(lsRemote, []byte("\t"), 2)[0]) + } + } + + e.mu.Lock() + e.latestVersion = latestVersion + e.mu.Unlock() + + return e.latestVersion +} + +func (e *Extension) IsPinned() bool { + e.mu.RLock() + if e.isPinned != nil { + defer e.mu.RUnlock() + return *e.isPinned + } + e.mu.RUnlock() + + var isPinned bool + switch e.kind { + case LocalKind: + case BinaryKind: + if manifest, err := e.loadManifest(); err == nil { + isPinned = manifest.IsPinned + } + case GitKind: + pinPath := filepath.Join(e.Path(), fmt.Sprintf(".pin-%s", e.CurrentVersion())) + if _, err := os.Stat(pinPath); err == nil { + isPinned = true + } else { + isPinned = false + } + } + + e.mu.Lock() + e.isPinned = &isPinned + e.mu.Unlock() + + return *e.isPinned +} + +func (e *Extension) UpdateAvailable() bool { + if e.IsLocal() || + e.CurrentVersion() == "" || + e.LatestVersion() == "" || + e.CurrentVersion() == e.LatestVersion() { + return false + } + return true +} + +func (e *Extension) loadManifest() (binManifest, error) { + var bm binManifest + dir, _ := filepath.Split(e.Path()) + manifestPath := filepath.Join(dir, manifestName) + manifest, err := os.ReadFile(manifestPath) + if err != nil { + return bm, fmt.Errorf("could not open %s for reading: %w", manifestPath, err) + } + err = yaml.Unmarshal(manifest, &bm) + if err != nil { + return bm, fmt.Errorf("could not parse %s: %w", manifestPath, err) + } + return bm, nil +} diff --git a/pkg/cmd/extension/extension_test.go b/pkg/cmd/extension/extension_test.go index 0a50cbfe8..9b56e0bee 100644 --- a/pkg/cmd/extension/extension_test.go +++ b/pkg/cmd/extension/extension_test.go @@ -8,7 +8,7 @@ import ( func TestUpdateAvailable_IsLocal(t *testing.T) { e := &Extension{ - isLocal: true, + kind: LocalKind, } assert.False(t, e.UpdateAvailable()) @@ -16,7 +16,7 @@ func TestUpdateAvailable_IsLocal(t *testing.T) { func TestUpdateAvailable_NoCurrentVersion(t *testing.T) { e := &Extension{ - isLocal: false, + kind: LocalKind, } assert.False(t, e.UpdateAvailable()) @@ -24,7 +24,7 @@ func TestUpdateAvailable_NoCurrentVersion(t *testing.T) { func TestUpdateAvailable_NoLatestVersion(t *testing.T) { e := &Extension{ - isLocal: false, + kind: BinaryKind, currentVersion: "1.0.0", } @@ -33,7 +33,7 @@ func TestUpdateAvailable_NoLatestVersion(t *testing.T) { func TestUpdateAvailable_CurrentVersionIsLatestVersion(t *testing.T) { e := &Extension{ - isLocal: false, + kind: BinaryKind, currentVersion: "1.0.0", latestVersion: "1.0.0", } @@ -43,7 +43,7 @@ func TestUpdateAvailable_CurrentVersionIsLatestVersion(t *testing.T) { func TestUpdateAvailable(t *testing.T) { e := &Extension{ - isLocal: false, + kind: BinaryKind, currentVersion: "1.0.0", latestVersion: "1.1.0", } diff --git a/pkg/cmd/extension/manager.go b/pkg/cmd/extension/manager.go index 7a76e6a47..b19175880 100644 --- a/pkg/cmd/extension/manager.go +++ b/pkg/cmd/extension/manager.go @@ -1,12 +1,10 @@ package extension import ( - "bytes" _ "embed" "errors" "fmt" "io" - "io/fs" "net/http" "os" "os/exec" @@ -83,7 +81,7 @@ func (m *Manager) Dispatch(args []string, stdin io.Reader, stdout, stderr io.Wri forwardArgs := args[1:] exts, _ := m.list(false) - var ext Extension + var ext *Extension for _, e := range exts { if e.Name() == extName { ext = e @@ -121,39 +119,53 @@ func (m *Manager) Dispatch(args []string, stdin io.Reader, stdout, stderr io.Wri func (m *Manager) List() []extensions.Extension { exts, _ := m.list(false) r := make([]extensions.Extension, len(exts)) - for i, v := range exts { - val := v - r[i] = &val + for i, ext := range exts { + r[i] = ext } return r } -func (m *Manager) list(includeMetadata bool) ([]Extension, error) { +func (m *Manager) list(includeMetadata bool) ([]*Extension, error) { dir := m.installDir() entries, err := os.ReadDir(dir) if err != nil { return nil, err } - var results []Extension + results := make([]*Extension, 0, len(entries)) for _, f := range entries { if !strings.HasPrefix(f.Name(), "gh-") { continue } - var ext Extension - var err error if f.IsDir() { - ext, err = m.parseExtensionDir(f) - if err != nil { - return nil, err + if _, err := os.Stat(filepath.Join(dir, f.Name(), manifestName)); err == nil { + results = append(results, &Extension{ + path: filepath.Join(dir, f.Name(), f.Name()), + kind: BinaryKind, + httpClient: m.client, + }) + } else { + results = append(results, &Extension{ + path: filepath.Join(dir, f.Name(), f.Name()), + kind: GitKind, + gitClient: m.gitClient.ForRepo(filepath.Join(dir, f.Name())), + }) } - results = append(results, ext) + } else if isSymlink(f.Type()) { + results = append(results, &Extension{ + path: filepath.Join(dir, f.Name(), f.Name()), + kind: LocalKind, + }) } else { - ext, err = m.parseExtensionFile(f) + // the contents of a regular file point to a local extension on disk + p, err := readPathFromFile(filepath.Join(dir, f.Name())) if err != nil { return nil, err } - results = append(results, ext) + results = append(results, &Extension{ + path: filepath.Join(p, f.Name()), + kind: LocalKind, + }) } } @@ -164,145 +176,16 @@ func (m *Manager) list(includeMetadata bool) ([]Extension, error) { return results, nil } -func (m *Manager) parseExtensionFile(fi fs.DirEntry) (Extension, error) { - ext := Extension{isLocal: true} - id := m.installDir() - exePath := filepath.Join(id, fi.Name(), fi.Name()) - if !isSymlink(fi.Type()) { - // if this is a regular file, its contents is the local directory of the extension - p, err := readPathFromFile(filepath.Join(id, fi.Name())) - if err != nil { - return ext, err - } - exePath = filepath.Join(p, fi.Name()) - } - ext.path = exePath - return ext, nil -} - -func (m *Manager) parseExtensionDir(fi fs.DirEntry) (Extension, error) { - id := m.installDir() - if _, err := os.Stat(filepath.Join(id, fi.Name(), manifestName)); err == nil { - return m.parseBinaryExtensionDir(fi) - } - - return m.parseGitExtensionDir(fi) -} - -func (m *Manager) parseBinaryExtensionDir(fi fs.DirEntry) (Extension, error) { - id := m.installDir() - exePath := filepath.Join(id, fi.Name(), fi.Name()) - ext := Extension{path: exePath, kind: BinaryKind} - manifestPath := filepath.Join(id, fi.Name(), manifestName) - manifest, err := os.ReadFile(manifestPath) - if err != nil { - return ext, fmt.Errorf("could not open %s for reading: %w", manifestPath, err) - } - var bm binManifest - err = yaml.Unmarshal(manifest, &bm) - if err != nil { - return ext, fmt.Errorf("could not parse %s: %w", manifestPath, err) - } - repo := ghrepo.NewWithHost(bm.Owner, bm.Name, bm.Host) - remoteURL := ghrepo.GenerateRepoURL(repo, "") - ext.url = remoteURL - ext.currentVersion = bm.Tag - ext.isPinned = bm.IsPinned - return ext, nil -} - -func (m *Manager) parseGitExtensionDir(fi fs.DirEntry) (Extension, error) { - id := m.installDir() - exePath := filepath.Join(id, fi.Name(), fi.Name()) - remoteUrl := m.getRemoteUrl(fi.Name()) - currentVersion := m.getCurrentVersion(fi.Name()) - - var isPinned bool - pinPath := filepath.Join(id, fi.Name(), fmt.Sprintf(".pin-%s", currentVersion)) - if _, err := os.Stat(pinPath); err == nil { - isPinned = true - } - - return Extension{ - path: exePath, - url: remoteUrl, - isLocal: false, - currentVersion: currentVersion, - kind: GitKind, - isPinned: isPinned, - }, nil -} - -// getCurrentVersion determines the current version for non-local git extensions. -func (m *Manager) getCurrentVersion(extension string) string { - dir := filepath.Join(m.installDir(), extension) - scopedClient := m.gitClient.ForRepo(dir) - localSha, err := scopedClient.CommandOutput([]string{"rev-parse", "HEAD"}) - if err != nil { - return "" - } - return string(bytes.TrimSpace(localSha)) -} - -// getRemoteUrl determines the remote URL for non-local git extensions. -func (m *Manager) getRemoteUrl(extension string) string { - dir := filepath.Join(m.installDir(), extension) - scopedClient := m.gitClient.ForRepo(dir) - url, err := scopedClient.Config("remote.origin.url") - if err != nil { - return "" - } - return strings.TrimSpace(string(url)) -} - -func (m *Manager) populateLatestVersions(exts []Extension) { - size := len(exts) - type result struct { - index int - version string - } - ch := make(chan result, size) +func (m *Manager) populateLatestVersions(exts []*Extension) { var wg sync.WaitGroup - wg.Add(size) - for idx, ext := range exts { - go func(i int, e Extension) { + for _, ext := range exts { + wg.Add(1) + go func(e *Extension) { defer wg.Done() - version, _ := m.getLatestVersion(e) - ch <- result{index: i, version: version} - }(idx, ext) + e.LatestVersion() + }(ext) } wg.Wait() - close(ch) - for r := range ch { - ext := &exts[r.index] - ext.latestVersion = r.version - } -} - -func (m *Manager) getLatestVersion(ext Extension) (string, error) { - if ext.isLocal { - return "", localExtensionUpgradeError - } - if ext.IsBinary() { - repo, err := ghrepo.FromFullName(ext.url) - if err != nil { - return "", err - } - r, err := fetchLatestRelease(m.client, repo) - if err != nil { - return "", err - } - return r.Tag, nil - } else { - extDir := filepath.Dir(ext.path) - scopedClient := m.gitClient.ForRepo(extDir) - lsRemote, err := scopedClient.CommandOutput([]string{"ls-remote", "origin", "HEAD"}) - if err != nil { - return "", err - } - remoteSha := bytes.SplitN(lsRemote, []byte("\t"), 2)[0] - return string(remoteSha), nil - } } func (m *Manager) InstallLocal(dir string) error { @@ -521,22 +404,23 @@ func (m *Manager) Upgrade(name string, force bool) error { if f.Name() != name { continue } - var err error - // For single extensions manually retrieve latest version since we forgo - // doing it during list. - f.latestVersion, err = m.getLatestVersion(f) - if err != nil { - return err + if f.IsLocal() { + return localExtensionUpgradeError } - return m.upgradeExtensions([]Extension{f}, force) + // For single extensions manually retrieve latest version since we forgo doing it during list. + if latestVersion := f.LatestVersion(); latestVersion == "" { + return fmt.Errorf("unable to retrieve latest version for extension %q", name) + } + return m.upgradeExtensions([]*Extension{f}, force) } return fmt.Errorf("no extension matched %q", name) } -func (m *Manager) upgradeExtensions(exts []Extension, force bool) error { +func (m *Manager) upgradeExtensions(exts []*Extension, force bool) error { var failed bool for _, f := range exts { fmt.Fprintf(m.io.Out, "[%s]: ", f.Name()) + currentVersion := displayExtensionVersion(f, f.CurrentVersion()) err := m.upgradeExtension(f, force) if err != nil { if !errors.Is(err, localExtensionUpgradeError) && @@ -547,8 +431,7 @@ func (m *Manager) upgradeExtensions(exts []Extension, force bool) error { fmt.Fprintf(m.io.Out, "%s\n", err) continue } - currentVersion := displayExtensionVersion(&f, f.currentVersion) - latestVersion := displayExtensionVersion(&f, f.latestVersion) + latestVersion := displayExtensionVersion(f, f.LatestVersion()) if m.dryRunMode { fmt.Fprintf(m.io.Out, "would have upgraded from %s to %s\n", currentVersion, latestVersion) } else { @@ -561,8 +444,8 @@ func (m *Manager) upgradeExtensions(exts []Extension, force bool) error { return nil } -func (m *Manager) upgradeExtension(ext Extension, force bool) error { - if ext.isLocal { +func (m *Manager) upgradeExtension(ext *Extension, force bool) error { + if ext.IsLocal() { return localExtensionUpgradeError } if !force && ext.IsPinned() { @@ -592,7 +475,7 @@ func (m *Manager) upgradeExtension(ext Extension, force bool) error { return err } -func (m *Manager) upgradeGitExtension(ext Extension, force bool) error { +func (m *Manager) upgradeGitExtension(ext *Extension, force bool) error { if m.dryRunMode { return nil } @@ -611,10 +494,10 @@ func (m *Manager) upgradeGitExtension(ext Extension, force bool) error { return scopedClient.Pull("", "") } -func (m *Manager) upgradeBinExtension(ext Extension) error { - repo, err := ghrepo.FromFullName(ext.url) +func (m *Manager) upgradeBinExtension(ext *Extension) error { + repo, err := ghrepo.FromFullName(ext.URL()) if err != nil { - return fmt.Errorf("failed to parse URL %s: %w", ext.url, err) + return fmt.Errorf("failed to parse URL %s: %w", ext.URL(), err) } return m.installBin(repo, "") } diff --git a/pkg/cmd/extension/manager_test.go b/pkg/cmd/extension/manager_test.go index b3fe64567..6d9b63124 100644 --- a/pkg/cmd/extension/manager_test.go +++ b/pkg/cmd/extension/manager_test.go @@ -80,12 +80,8 @@ func TestManager_List(t *testing.T) { dirOne := filepath.Join(tempDir, "extensions", "gh-hello") dirTwo := filepath.Join(tempDir, "extensions", "gh-two") gc, gcOne, gcTwo := &mockGitClient{}, &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", dirOne).Return(gcOne).Twice() - gc.On("ForRepo", dirTwo).Return(gcTwo).Twice() - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcTwo.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() - gcTwo.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", dirOne).Return(gcOne).Once() + gc.On("ForRepo", dirTwo).Return(gcTwo).Once() m := newTestManager(tempDir, nil, gc, nil) exts := m.List() @@ -145,9 +141,7 @@ func TestManager_Dispatch(t *testing.T) { assert.NoError(t, stubExtension(extPath)) gc, gcOne := &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", extDir).Return(gcOne).Twice() - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", extDir).Return(gcOne).Once() m := newTestManager(tempDir, nil, gc, nil) @@ -223,9 +217,7 @@ func TestManager_Upgrade_NoMatchingExtension(t *testing.T) { assert.NoError(t, stubExtension(filepath.Join(tempDir, "extensions", "gh-hello", "gh-hello"))) ios, _, stdout, stderr := iostreams.Test() gc, gcOne := &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", extDir).Return(gcOne).Twice() - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", extDir).Return(gcOne).Once() m := newTestManager(tempDir, nil, gc, ios) err := m.Upgrade("invalid", false) assert.EqualError(t, err, `no extension matched "invalid"`) @@ -244,12 +236,8 @@ func TestManager_UpgradeExtensions(t *testing.T) { assert.NoError(t, stubLocalExtension(tempDir, filepath.Join(tempDir, "extensions", "gh-local", "gh-local"))) ios, _, stdout, stderr := iostreams.Test() gc, gcOne, gcTwo := &mockGitClient{}, &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", dirOne).Return(gcOne).Times(4) - gc.On("ForRepo", dirTwo).Return(gcTwo).Times(4) - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcTwo.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() - gcTwo.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", dirOne).Return(gcOne).Times(3) + gc.On("ForRepo", dirTwo).Return(gcTwo).Times(3) gcOne.On("Remotes").Return(nil, nil).Once() gcTwo.On("Remotes").Return(nil, nil).Once() gcOne.On("Pull", "", "").Return(nil).Once() @@ -286,12 +274,8 @@ func TestManager_UpgradeExtensions_DryRun(t *testing.T) { assert.NoError(t, stubLocalExtension(tempDir, filepath.Join(tempDir, "extensions", "gh-local", "gh-local"))) ios, _, stdout, stderr := iostreams.Test() gc, gcOne, gcTwo := &mockGitClient{}, &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", dirOne).Return(gcOne).Times(3) - gc.On("ForRepo", dirTwo).Return(gcTwo).Times(3) - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcTwo.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() - gcTwo.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", dirOne).Return(gcOne).Twice() + gc.On("ForRepo", dirTwo).Return(gcTwo).Twice() gcOne.On("Remotes").Return(nil, nil).Once() gcTwo.On("Remotes").Return(nil, nil).Once() m := newTestManager(tempDir, nil, gc, ios) @@ -355,9 +339,7 @@ func TestManager_UpgradeExtension_GitExtension(t *testing.T) { assert.NoError(t, stubExtension(filepath.Join(tempDir, "extensions", "gh-remote", "gh-remote"))) ios, _, stdout, stderr := iostreams.Test() gc, gcOne := &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", extensionDir).Return(gcOne).Times(4) - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", extensionDir).Return(gcOne).Times(3) gcOne.On("Remotes").Return(nil, nil).Once() gcOne.On("Pull", "", "").Return(nil).Once() m := newTestManager(tempDir, nil, gc, ios) @@ -381,9 +363,7 @@ func TestManager_UpgradeExtension_GitExtension_DryRun(t *testing.T) { assert.NoError(t, stubExtension(filepath.Join(tempDir, "extensions", "gh-remote", "gh-remote"))) ios, _, stdout, stderr := iostreams.Test() gc, gcOne := &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", extDir).Return(gcOne).Times(3) - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", extDir).Return(gcOne).Twice() gcOne.On("Remotes").Return(nil, nil).Once() m := newTestManager(tempDir, nil, gc, ios) m.EnableDryRunMode() @@ -407,9 +387,7 @@ func TestManager_UpgradeExtension_GitExtension_Force(t *testing.T) { assert.NoError(t, stubExtension(filepath.Join(tempDir, "extensions", "gh-remote", "gh-remote"))) ios, _, stdout, stderr := iostreams.Test() gc, gcOne := &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", extensionDir).Return(gcOne).Times(4) - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", extensionDir).Return(gcOne).Times(3) gcOne.On("Remotes").Return(nil, nil).Once() gcOne.On("Fetch", "origin", "HEAD").Return(nil).Once() gcOne.On("CommandOutput", []string{"reset", "--hard", "origin/HEAD"}).Return("", nil).Once() @@ -721,9 +699,7 @@ func TestManager_UpgradeExtension_GitExtension_Pinned(t *testing.T) { ios, _, _, _ := iostreams.Test() gc, gcOne := &mockGitClient{}, &mockGitClient{} - gc.On("ForRepo", extDir).Return(gcOne).Twice() - gcOne.On("Config", "remote.origin.url").Return("", nil).Once() - gcOne.On("CommandOutput", []string{"rev-parse", "HEAD"}).Return("", nil).Once() + gc.On("ForRepo", extDir).Return(gcOne).Once() m := newTestManager(tempDir, nil, gc, ios) @@ -732,7 +708,8 @@ func TestManager_UpgradeExtension_GitExtension_Pinned(t *testing.T) { assert.NoError(t, err) assert.Equal(t, 1, len(exts)) ext := exts[0] - ext.isPinned = true + pinnedTrue := true + ext.isPinned = &pinnedTrue ext.latestVersion = "new version" err = m.upgradeExtension(ext, false) diff --git a/pkg/cmd/root/extension.go b/pkg/cmd/root/extension.go index 52ef6b0a4..dea637619 100644 --- a/pkg/cmd/root/extension.go +++ b/pkg/cmd/root/extension.go @@ -3,29 +3,15 @@ package root import ( "fmt" - "github.com/cli/cli/v2/git" - "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/extensions" "github.com/cli/cli/v2/pkg/iostreams" "github.com/spf13/cobra" ) func NewCmdExtension(io *iostreams.IOStreams, em extensions.ExtensionManager, ext extensions.Extension) *cobra.Command { - var short string - if ext.IsLocal() { - short = fmt.Sprintf("Local extension gh-%s", ext.Name()) - } else { - path := ext.URL() - if u, err := git.ParseURL(ext.URL()); err == nil { - if r, err := ghrepo.FromURL(u); err == nil { - path = ghrepo.FullName(r) - } - } - short = fmt.Sprintf("Extension %s", path) - } return &cobra.Command{ Use: ext.Name(), - Short: short, + Short: fmt.Sprintf("Extension %s", ext.Name()), RunE: func(c *cobra.Command, args []string) error { args = append([]string{ext.Name()}, args...) if _, err := em.Dispatch(args, io.In, io.Out, io.ErrOut); err != nil { diff --git a/pkg/extensions/extension.go b/pkg/extensions/extension.go index 95af0ccea..2583472c0 100644 --- a/pkg/extensions/extension.go +++ b/pkg/extensions/extension.go @@ -20,6 +20,7 @@ type Extension interface { Path() string // Path to executable URL() string CurrentVersion() string + LatestVersion() string IsPinned() bool UpdateAvailable() bool IsBinary() bool diff --git a/pkg/extensions/extension_mock.go b/pkg/extensions/extension_mock.go index a97de8f62..500603661 100644 --- a/pkg/extensions/extension_mock.go +++ b/pkg/extensions/extension_mock.go @@ -29,6 +29,9 @@ var _ Extension = &ExtensionMock{} // IsPinnedFunc: func() bool { // panic("mock out the IsPinned method") // }, +// LatestVersionFunc: func() string { +// panic("mock out the LatestVersion method") +// }, // NameFunc: func() string { // panic("mock out the Name method") // }, @@ -60,6 +63,9 @@ type ExtensionMock struct { // IsPinnedFunc mocks the IsPinned method. IsPinnedFunc func() bool + // LatestVersionFunc mocks the LatestVersion method. + LatestVersionFunc func() string + // NameFunc mocks the Name method. NameFunc func() string @@ -86,6 +92,9 @@ type ExtensionMock struct { // IsPinned holds details about calls to the IsPinned method. IsPinned []struct { } + // LatestVersion holds details about calls to the LatestVersion method. + LatestVersion []struct { + } // Name holds details about calls to the Name method. Name []struct { } @@ -103,6 +112,7 @@ type ExtensionMock struct { lockIsBinary sync.RWMutex lockIsLocal sync.RWMutex lockIsPinned sync.RWMutex + lockLatestVersion sync.RWMutex lockName sync.RWMutex lockPath sync.RWMutex lockURL sync.RWMutex @@ -217,6 +227,33 @@ func (mock *ExtensionMock) IsPinnedCalls() []struct { return calls } +// LatestVersion calls LatestVersionFunc. +func (mock *ExtensionMock) LatestVersion() string { + if mock.LatestVersionFunc == nil { + panic("ExtensionMock.LatestVersionFunc: method is nil but Extension.LatestVersion was just called") + } + callInfo := struct { + }{} + mock.lockLatestVersion.Lock() + mock.calls.LatestVersion = append(mock.calls.LatestVersion, callInfo) + mock.lockLatestVersion.Unlock() + return mock.LatestVersionFunc() +} + +// LatestVersionCalls gets all the calls that were made to LatestVersion. +// Check the length with: +// +// len(mockedExtension.LatestVersionCalls()) +func (mock *ExtensionMock) LatestVersionCalls() []struct { +} { + var calls []struct { + } + mock.lockLatestVersion.RLock() + calls = mock.calls.LatestVersion + mock.lockLatestVersion.RUnlock() + return calls +} + // Name calls NameFunc. func (mock *ExtensionMock) Name() string { if mock.NameFunc == nil { From 85878512028392d5e89020ad3de2b5c7d079c678 Mon Sep 17 00:00:00 2001 From: guangwu Date: Mon, 19 Jun 2023 09:55:27 +0800 Subject: [PATCH 90/90] chore: pkg imported more than once (#7591) --- pkg/cmd/issue/create/create.go | 9 ++++----- pkg/cmd/issue/list/list.go | 5 ++--- 2 files changed, 6 insertions(+), 8 deletions(-) diff --git a/pkg/cmd/issue/create/create.go b/pkg/cmd/issue/create/create.go index 2414c1807..a4db9d3a1 100644 --- a/pkg/cmd/issue/create/create.go +++ b/pkg/cmd/issue/create/create.go @@ -11,7 +11,6 @@ import ( "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" - "github.com/cli/cli/v2/pkg/cmd/pr/shared" prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -143,7 +142,7 @@ func createRun(opts *CreateOptions) (err error) { milestones = []string{opts.Milestone} } - meReplacer := shared.NewMeReplacer(apiClient, baseRepo.RepoHost()) + meReplacer := prShared.NewMeReplacer(apiClient, baseRepo.RepoHost()) assignees, err := meReplacer.ReplaceSlice(opts.Assignees) if err != nil { return err @@ -167,7 +166,7 @@ func createRun(opts *CreateOptions) (err error) { } } - tpl := shared.NewTemplateManager(httpClient, baseRepo, opts.Prompter, opts.RootDirOverride, !opts.HasRepoOverride, false) + tpl := prShared.NewTemplateManager(httpClient, baseRepo, opts.Prompter, opts.RootDirOverride, !opts.HasRepoOverride, false) if opts.WebMode { var openURL string @@ -222,7 +221,7 @@ func createRun(opts *CreateOptions) (err error) { templateContent := "" if opts.RecoverFile == "" { - var template shared.Template + var template prShared.Template if opts.Template != "" { template, err = tpl.Select(opts.Template) @@ -325,7 +324,7 @@ func createRun(opts *CreateOptions) (err error) { return } -func generatePreviewURL(apiClient *api.Client, baseRepo ghrepo.Interface, tb shared.IssueMetadataState) (string, error) { +func generatePreviewURL(apiClient *api.Client, baseRepo ghrepo.Interface, tb prShared.IssueMetadataState) (string, error) { openURL := ghrepo.GenerateRepoURL(baseRepo, "issues/new") return prShared.WithPrAndIssueQueryParams(apiClient, baseRepo, openURL, tb) } diff --git a/pkg/cmd/issue/list/list.go b/pkg/cmd/issue/list/list.go index 71ed5ed0f..20e77e141 100644 --- a/pkg/cmd/issue/list/list.go +++ b/pkg/cmd/issue/list/list.go @@ -15,7 +15,6 @@ import ( "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/text" issueShared "github.com/cli/cli/v2/pkg/cmd/issue/shared" - "github.com/cli/cli/v2/pkg/cmd/pr/shared" prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -133,7 +132,7 @@ func listRun(opts *ListOptions) error { } issueState := strings.ToLower(opts.State) - if issueState == "open" && shared.QueryHasStateClause(opts.Search) { + if issueState == "open" && prShared.QueryHasStateClause(opts.Search) { issueState = "" } @@ -228,7 +227,7 @@ func issueList(client *http.Client, repo ghrepo.Interface, filters prShared.Filt } var err error - meReplacer := shared.NewMeReplacer(apiClient, repo.RepoHost()) + meReplacer := prShared.NewMeReplacer(apiClient, repo.RepoHost()) filters.Assignee, err = meReplacer.Replace(filters.Assignee) if err != nil { return nil, err