From 5ccfbe9d7e97d80ceb91ba68af75f36f1d83cc80 Mon Sep 17 00:00:00 2001 From: Keith Bailey Date: Thu, 17 Aug 2023 15:40:52 -0400 Subject: [PATCH 001/527] Add `gh release create [] --notes-from-tag` Generates release notes from an annotated git tag noninteractively. Fixes #6718 --- pkg/cmd/release/create/create.go | 25 ++++++++++++++++-- pkg/cmd/release/create/create_test.go | 37 +++++++++++++++++++++++++++ 2 files changed, 60 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/release/create/create.go b/pkg/cmd/release/create/create.go index a5a02fa31..07e40b708 100644 --- a/pkg/cmd/release/create/create.go +++ b/pkg/cmd/release/create/create.go @@ -59,6 +59,7 @@ type CreateOptions struct { GenerateNotes bool NotesStartTag string VerifyTag bool + NotesFromTag bool } func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Command { @@ -92,6 +93,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co To create a release from an annotated git tag, first create one locally with git, push the tag to GitHub, then run this command. + You may also use %[1]s--notes-from-tag%[1]s to create it noninteractively. When using automatically generated release notes, a release title will also be automatically generated unless a title was explicitly passed. Additional release notes can be prepended to @@ -146,9 +148,13 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co return cmdutil.FlagErrorf("tag required when not running interactively") } + if opts.NotesFromTag && (opts.GenerateNotes || opts.NotesStartTag != "") { + return cmdutil.FlagErrorf("using `--notes-from-tag` with `--generate-notes` or `notes-start-tag` is not supported") + } + opts.Concurrency = 5 - opts.BodyProvided = cmd.Flags().Changed("notes") || opts.GenerateNotes + opts.BodyProvided = cmd.Flags().Changed("notes") || opts.GenerateNotes || opts.NotesFromTag if notesFile != "" { b, err := cmdutil.ReadFile(notesFile, opts.IO.In) if err != nil { @@ -176,6 +182,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co cmd.Flags().StringVar(&opts.NotesStartTag, "notes-start-tag", "", "Tag to use as the starting point for generating release notes") cmdutil.NilBoolFlag(cmd, &opts.IsLatest, "latest", "", "Mark this release as \"Latest\" (default: automatic based on date and version)") cmd.Flags().BoolVarP(&opts.VerifyTag, "verify-tag", "", false, "Abort in case the git tag doesn't already exist in the remote repository") + cmd.Flags().BoolVarP(&opts.NotesFromTag, "notes-from-tag", "", false, "Automatically populate the release notes with the message in the tag specified by `gh release create []`") _ = cmdutil.RegisterBranchCompletionFlags(f.GitClient, cmd, "target") @@ -241,6 +248,7 @@ func createRun(opts *CreateOptions) error { var tagDescription string if opts.RepoOverride == "" { tagDescription, _ = gitTagInfo(opts.GitClient, opts.TagName) + remoteExists, err := remoteTagExists(httpClient, baseRepo, opts.TagName) // If there is a local tag with the same name as specified // the user may not want to create a new tag on the remote // as the local one might be annotated or signed. @@ -250,7 +258,6 @@ func createRun(opts *CreateOptions) error { // If a remote tag with the same name as specified exists already // then a new tag will not be created so ignore local tag status. if tagDescription != "" && !existingTag && opts.Target == "" && !opts.VerifyTag { - remoteExists, err := remoteTagExists(httpClient, baseRepo, opts.TagName) if err != nil { return err } @@ -259,6 +266,13 @@ func createRun(opts *CreateOptions) error { opts.TagName, ghrepo.FullName(baseRepo)) } } + + if opts.NotesFromTag { + if !remoteExists { + return fmt.Errorf("tag %s doesn't exist in the repo %s, cannot populate release notes with annotated git tag message using the `--notes-from-tag` flag", + opts.TagName, ghrepo.FullName(baseRepo)) + } + } } if !opts.BodyProvided && opts.IO.CanPrompt() { @@ -427,6 +441,13 @@ func createRun(opts *CreateOptions) error { params["generate_release_notes"] = true } } + if opts.NotesFromTag { + if opts.Body == "" { + params["body"] = tagDescription + } else { + params["body"] = fmt.Sprintf("%s\n%s", opts.Body, tagDescription) + } + } hasAssets := len(opts.Assets) > 0 draftWhileUploading := false diff --git a/pkg/cmd/release/create/create_test.go b/pkg/cmd/release/create/create_test.go index 69188f593..1787c0931 100644 --- a/pkg/cmd/release/create/create_test.go +++ b/pkg/cmd/release/create/create_test.go @@ -321,6 +321,43 @@ func Test_NewCmdCreate(t *testing.T) { VerifyTag: true, }, }, + { + name: "tag and --notes-from-tag", + args: "v1.2.3 --notes-from-tag", + isTTY: false, + want: CreateOptions{ + TagName: "v1.2.3", + Target: "", + Name: "", + Body: "", + BodyProvided: true, + Draft: false, + Prerelease: false, + RepoOverride: "", + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + GenerateNotes: false, + NotesFromTag: true, + }, + }, + { + name: "--notes-from-tag only ", + args: "--notes-from-tag", + isTTY: false, + wantErr: "tag required when not running interactively", + }, + { + name: "tag and --notes-from-tag and --generate-notes", + args: "v1.2.3 --notes-from-tag --generate-notes", + isTTY: false, + wantErr: "using `--notes-from-tag` with `--generate-notes` or `notes-start-tag` is not supported", + }, + { + name: "tag and --notes-from-tag and --notes-start-tag", + args: "v1.2.3 --notes-from-tag --notes-start-tag v1.2.3", + isTTY: false, + wantErr: "using `--notes-from-tag` with `--generate-notes` or `notes-start-tag` is not supported", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { From 44e1efc22190504b8428d82b338012297153b256 Mon Sep 17 00:00:00 2001 From: Harvey Sanders Date: Mon, 21 Aug 2023 10:29:58 -0400 Subject: [PATCH 002/527] Fetch all jobs on a gh view run --json --- pkg/cmd/run/shared/shared.go | 22 +++++++++++++---- pkg/cmd/run/shared/test.go | 18 ++++++++++++++ pkg/cmd/run/view/view_test.go | 45 +++++++++++++++++++++++++++++++++++ 3 files changed, 81 insertions(+), 4 deletions(-) diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go index a755ce93c..9fcdb5df3 100644 --- a/pkg/cmd/run/shared/shared.go +++ b/pkg/cmd/run/shared/shared.go @@ -424,7 +424,8 @@ func preloadWorkflowNames(client *api.Client, repo ghrepo.Interface, runs []Run) } type JobsPayload struct { - Jobs []Job + TotalCount int `json:"total_count"` + Jobs []Job } func GetJobs(client *api.Client, repo ghrepo.Interface, run *Run) ([]Job, error) { @@ -432,10 +433,23 @@ func GetJobs(client *api.Client, repo ghrepo.Interface, run *Run) ([]Job, error) return run.Jobs, nil } var result JobsPayload - if err := client.REST(repo.RepoHost(), "GET", run.JobsURL, nil, &result); err != nil { - return nil, err + perPage := 100 + v := url.Values{} + v.Set("per_page", fmt.Sprintf("%d", perPage)) + + // Fetch all the pages until total fetched jobs == result.TotalCount + maxPages := 10 + for p := 1; p < maxPages; p++ { + v.Set("page", fmt.Sprintf("%d", p)) + jobsPath := fmt.Sprintf("%s?%s", run.JobsURL, v.Encode()) + if err := client.REST(repo.RepoHost(), "GET", jobsPath, nil, &result); err != nil { + return run.Jobs, err + } + run.Jobs = append(run.Jobs, result.Jobs...) + if len(run.Jobs) >= result.TotalCount { + break + } } - run.Jobs = result.Jobs return result.Jobs, nil } diff --git a/pkg/cmd/run/shared/test.go b/pkg/cmd/run/shared/test.go index 0e37572e3..e44debaa4 100644 --- a/pkg/cmd/run/shared/test.go +++ b/pkg/cmd/run/shared/test.go @@ -5,6 +5,7 @@ import ( "time" workflowShared "github.com/cli/cli/v2/pkg/cmd/workflow/shared" + "github.com/cli/cli/v2/pkg/iostreams" ) var TestRunStartTime, _ = time.Parse("2006-01-02 15:04:05", "2021-02-23 04:51:00") @@ -122,3 +123,20 @@ var TestWorkflow workflowShared.Workflow = workflowShared.Workflow{ Name: "CI", ID: 123, } + +type TestExporter struct { + fields []string + writeHandler func(io *iostreams.IOStreams, data interface{}) error +} + +func MakeTestExporter(fields []string, wh func(io *iostreams.IOStreams, data interface{}) error) *TestExporter { + return &TestExporter{fields: fields, writeHandler: wh} +} + +func (t *TestExporter) Fields() []string { + return t.fields +} + +func (t *TestExporter) Write(io *iostreams.IOStreams, data interface{}) error { + return t.writeHandler(io, data) +} diff --git a/pkg/cmd/run/view/view_test.go b/pkg/cmd/run/view/view_test.go index 3d4fc4cf0..e2a2a2456 100644 --- a/pkg/cmd/run/view/view_test.go +++ b/pkg/cmd/run/view/view_test.go @@ -1242,6 +1242,51 @@ func TestViewRun(t *testing.T) { }, wantOut: "\nX trunk CI · 123\nTriggered via push about 59 minutes ago\n\nX This run likely failed because of a workflow file issue.\n\nFor more information, see: https://github.com/runs/123\n", }, + { + name: "Fetches all of a run's jobs with --json flag", + opts: &ViewOptions{ + RunID: "3", + Exporter: shared.MakeTestExporter( + []string{"jobs"}, + func(io *iostreams.IOStreams, data interface{}) error { + run, ok := data.(*shared.Run) + if !ok { + return fmt.Errorf("expected data type *shared.Run") + } + fmt.Fprintf(io.Out, "fetched %d jobs\n", len(run.Jobs)) + return nil + }, + ), + }, + httpStubs: func(reg *httpmock.Registry) { + jobs := []shared.Job{} + for i := 0; i < 115; i++ { + jobs = append(jobs, shared.Job{ + ID: int64(i), + Name: fmt.Sprintf("job %d", i), + }) + } + + limit := 100 + firstPage := jobs[:limit] + secondPage := jobs[limit:] + + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"), + httpmock.JSONResponse(shared.SuccessfulRun)) + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), + httpmock.JSONResponse(shared.TestWorkflow)) + reg.Register( + httpmock.REST("GET", "runs/3/jobs"), + httpmock.JSONResponse(shared.JobsPayload{TotalCount: len(jobs), Jobs: firstPage})) + // /runs/:runID/jobs endpoint should be called once more to fetch the remaining jobs + reg.Register( + httpmock.REST("GET", "runs/3/jobs"), + httpmock.JSONResponse(shared.JobsPayload{TotalCount: len(jobs), Jobs: secondPage})) + }, + wantOut: "fetched 115 jobs\n", + }, } for _, tt := range tests { From a4547481d6041554ea9c610087f8efbea75c90c8 Mon Sep 17 00:00:00 2001 From: Harvey Sanders Date: Sat, 2 Sep 2023 01:01:29 -0400 Subject: [PATCH 003/527] Refactor GetJobs to use RESTWithNext --- pkg/cmd/run/shared/shared.go | 30 ++++++++++++++++-------------- 1 file changed, 16 insertions(+), 14 deletions(-) diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go index 9fcdb5df3..3bbfb3726 100644 --- a/pkg/cmd/run/shared/shared.go +++ b/pkg/cmd/run/shared/shared.go @@ -4,6 +4,7 @@ import ( "archive/zip" "errors" "fmt" + "net/http" "net/url" "reflect" "strings" @@ -432,25 +433,26 @@ func GetJobs(client *api.Client, repo ghrepo.Interface, run *Run) ([]Job, error) if run.Jobs != nil { return run.Jobs, nil } - var result JobsPayload - perPage := 100 - v := url.Values{} - v.Set("per_page", fmt.Sprintf("%d", perPage)) - // Fetch all the pages until total fetched jobs == result.TotalCount - maxPages := 10 - for p := 1; p < maxPages; p++ { - v.Set("page", fmt.Sprintf("%d", p)) - jobsPath := fmt.Sprintf("%s?%s", run.JobsURL, v.Encode()) - if err := client.REST(repo.RepoHost(), "GET", jobsPath, nil, &result); err != nil { + v := url.Values{} + v.Set("per_page", "100") + + jobsPath := fmt.Sprintf("%s?%s", run.JobsURL, v.Encode()) + + for jobsPath != "" { + var resp JobsPayload + var err error + jobsPath, err = client.RESTWithNext(repo.RepoHost(), http.MethodGet, jobsPath, nil, &resp) + if err != nil { return run.Jobs, err } - run.Jobs = append(run.Jobs, result.Jobs...) - if len(run.Jobs) >= result.TotalCount { - break + + run.Jobs = append(run.Jobs, resp.Jobs...) + if len(run.Jobs) >= resp.TotalCount { + return run.Jobs, nil } } - return result.Jobs, nil + return run.Jobs, nil } func GetJob(client *api.Client, repo ghrepo.Interface, jobID string) (*Job, error) { From acc362f9d8977412386b6724f7444768be92bcd8 Mon Sep 17 00:00:00 2001 From: Harvey Sanders Date: Sun, 3 Sep 2023 19:55:27 -0400 Subject: [PATCH 004/527] Fix pagination resp with "Link" header --- pkg/cmd/run/view/view_test.go | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/run/view/view_test.go b/pkg/cmd/run/view/view_test.go index e2a2a2456..1bef02fc3 100644 --- a/pkg/cmd/run/view/view_test.go +++ b/pkg/cmd/run/view/view_test.go @@ -6,6 +6,7 @@ import ( "fmt" "io" "net/http" + "net/url" "testing" "time" @@ -1278,9 +1279,12 @@ func TestViewRun(t *testing.T) { httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), httpmock.JSONResponse(shared.TestWorkflow)) reg.Register( - httpmock.REST("GET", "runs/3/jobs"), - httpmock.JSONResponse(shared.JobsPayload{TotalCount: len(jobs), Jobs: firstPage})) - // /runs/:runID/jobs endpoint should be called once more to fetch the remaining jobs + httpmock.QueryMatcher("GET", "runs/3/jobs", url.Values{"per_page": []string{"100"}}), + httpmock.WithHeader( + httpmock.JSONResponse(shared.JobsPayload{TotalCount: len(jobs), Jobs: firstPage}), + "Link", + `; rel="next", ; rel="last"`), + ) reg.Register( httpmock.REST("GET", "runs/3/jobs"), httpmock.JSONResponse(shared.JobsPayload{TotalCount: len(jobs), Jobs: secondPage})) From d5d10a6f38879225bcdeb020b39da2515c6cf8aa Mon Sep 17 00:00:00 2001 From: Harvey Sanders Date: Sun, 3 Sep 2023 20:32:08 -0400 Subject: [PATCH 005/527] Use "Link" header for pagination completion check --- pkg/cmd/run/shared/shared.go | 3 --- 1 file changed, 3 deletions(-) diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go index 3bbfb3726..d5a918776 100644 --- a/pkg/cmd/run/shared/shared.go +++ b/pkg/cmd/run/shared/shared.go @@ -448,9 +448,6 @@ func GetJobs(client *api.Client, repo ghrepo.Interface, run *Run) ([]Job, error) } run.Jobs = append(run.Jobs, resp.Jobs...) - if len(run.Jobs) >= resp.TotalCount { - return run.Jobs, nil - } } return run.Jobs, nil } From 137da73642fc66165abf42faa44269c816af08ac Mon Sep 17 00:00:00 2001 From: Harvey Sanders Date: Sun, 3 Sep 2023 20:32:41 -0400 Subject: [PATCH 006/527] Simplify mock jobs response --- pkg/cmd/run/view/view_test.go | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/pkg/cmd/run/view/view_test.go b/pkg/cmd/run/view/view_test.go index 1bef02fc3..36d563eee 100644 --- a/pkg/cmd/run/view/view_test.go +++ b/pkg/cmd/run/view/view_test.go @@ -1260,18 +1260,6 @@ func TestViewRun(t *testing.T) { ), }, httpStubs: func(reg *httpmock.Registry) { - jobs := []shared.Job{} - for i := 0; i < 115; i++ { - jobs = append(jobs, shared.Job{ - ID: int64(i), - Name: fmt.Sprintf("job %d", i), - }) - } - - limit := 100 - firstPage := jobs[:limit] - secondPage := jobs[limit:] - reg.Register( httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3"), httpmock.JSONResponse(shared.SuccessfulRun)) @@ -1281,15 +1269,15 @@ func TestViewRun(t *testing.T) { reg.Register( httpmock.QueryMatcher("GET", "runs/3/jobs", url.Values{"per_page": []string{"100"}}), httpmock.WithHeader( - httpmock.JSONResponse(shared.JobsPayload{TotalCount: len(jobs), Jobs: firstPage}), + httpmock.StringResponse(`{"jobs":[{},{},{}]}`), "Link", `; rel="next", ; rel="last"`), ) reg.Register( httpmock.REST("GET", "runs/3/jobs"), - httpmock.JSONResponse(shared.JobsPayload{TotalCount: len(jobs), Jobs: secondPage})) + httpmock.StringResponse(`{"jobs":[{},{}]}`)) }, - wantOut: "fetched 115 jobs\n", + wantOut: "fetched 5 jobs\n", }, } From 52a2a722103693dcb55296f6ef5a4af6a0453a07 Mon Sep 17 00:00:00 2001 From: Ariel Deitcher <1149246+mntlty@users.noreply.github.com> Date: Mon, 4 Sep 2023 18:58:07 -0700 Subject: [PATCH 007/527] rename template to mark-template cmd (#7923) --- .../mark_template.go} | 42 +++++++++---------- .../mark_template_test.go} | 30 ++++++------- pkg/cmd/project/project.go | 4 +- 3 files changed, 38 insertions(+), 38 deletions(-) rename pkg/cmd/project/{template/template.go => mark-template/mark_template.go} (75%) rename pkg/cmd/project/{template/template_test.go => mark-template/mark_template_test.go} (91%) diff --git a/pkg/cmd/project/template/template.go b/pkg/cmd/project/mark-template/mark_template.go similarity index 75% rename from pkg/cmd/project/template/template.go rename to pkg/cmd/project/mark-template/mark_template.go index 9ef0732b9..92eb87ca6 100644 --- a/pkg/cmd/project/template/template.go +++ b/pkg/cmd/project/mark-template/mark_template.go @@ -1,4 +1,4 @@ -package template +package marktemplate import ( "fmt" @@ -14,7 +14,7 @@ import ( "github.com/spf13/cobra" ) -type templateOpts struct { +type markTemplateOpts struct { owner string undo bool number int32 @@ -22,9 +22,9 @@ type templateOpts struct { format string } -type templateConfig struct { +type markTemplateConfig struct { client *queries.Client - opts templateOpts + opts markTemplateOpts io *iostreams.IOStreams } @@ -39,17 +39,17 @@ type unmarkProjectTemplateMutation struct { } `graphql:"unmarkProjectV2AsTemplate(input:$input)"` } -func NewCmdTemplate(f *cmdutil.Factory, runF func(config templateConfig) error) *cobra.Command { - opts := templateOpts{} - templateCmd := &cobra.Command{ +func NewCmdMarkTemplate(f *cmdutil.Factory, runF func(config markTemplateConfig) error) *cobra.Command { + opts := markTemplateOpts{} + markTemplateCmd := &cobra.Command{ Short: "Mark a project as a template", - Use: "template []", + Use: "mark-template []", Example: heredoc.Doc(` # mark the github org's project "1" as a template - gh project template 1 --owner "github" + gh project mark-template 1 --owner "github" # unmark the github org's project "1" as a template - gh project template 1 --owner "github" --undo + gh project mark-template 1 --owner "github" --undo `), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { @@ -66,7 +66,7 @@ func NewCmdTemplate(f *cmdutil.Factory, runF func(config templateConfig) error) opts.number = int32(num) } - config := templateConfig{ + config := markTemplateConfig{ client: client, opts: opts, io: f.IOStreams, @@ -76,18 +76,18 @@ func NewCmdTemplate(f *cmdutil.Factory, runF func(config templateConfig) error) if runF != nil { return runF(config) } - return runTemplate(config) + return runMarkTemplate(config) }, } - templateCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the org owner.") - templateCmd.Flags().BoolVar(&opts.undo, "undo", false, "Unmark the project as a template.") - cmdutil.StringEnumFlag(templateCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") + markTemplateCmd.Flags().StringVar(&opts.owner, "owner", "", "Login of the org owner.") + markTemplateCmd.Flags().BoolVar(&opts.undo, "undo", false, "Unmark the project as a template.") + cmdutil.StringEnumFlag(markTemplateCmd, &opts.format, "format", "", "", []string{"json"}, "Output format") - return templateCmd + return markTemplateCmd } -func runTemplate(config templateConfig) error { +func runMarkTemplate(config markTemplateConfig) error { canPrompt := config.io.CanPrompt() owner, err := config.client.NewOwner(canPrompt, config.opts.owner) if err != nil { @@ -127,7 +127,7 @@ func runTemplate(config templateConfig) error { return printResults(config, query.TemplateProject.Project) } -func markTemplateArgs(config templateConfig) (*markProjectTemplateMutation, map[string]interface{}) { +func markTemplateArgs(config markTemplateConfig) (*markProjectTemplateMutation, map[string]interface{}) { return &markProjectTemplateMutation{}, map[string]interface{}{ "input": githubv4.MarkProjectV2AsTemplateInput{ ProjectID: githubv4.ID(config.opts.projectID), @@ -139,7 +139,7 @@ func markTemplateArgs(config templateConfig) (*markProjectTemplateMutation, map[ } } -func unmarkTemplateArgs(config templateConfig) (*unmarkProjectTemplateMutation, map[string]interface{}) { +func unmarkTemplateArgs(config markTemplateConfig) (*unmarkProjectTemplateMutation, map[string]interface{}) { return &unmarkProjectTemplateMutation{}, map[string]interface{}{ "input": githubv4.UnmarkProjectV2AsTemplateInput{ ProjectID: githubv4.ID(config.opts.projectID), @@ -151,7 +151,7 @@ func unmarkTemplateArgs(config templateConfig) (*unmarkProjectTemplateMutation, } } -func printResults(config templateConfig, project queries.Project) error { +func printResults(config markTemplateConfig, project queries.Project) error { if !config.io.IsStdoutTTY() { return nil } @@ -165,7 +165,7 @@ func printResults(config templateConfig, project queries.Project) error { return err } -func printJSON(config templateConfig, project queries.Project) error { +func printJSON(config markTemplateConfig, project queries.Project) error { b, err := format.JSONProject(project) if err != nil { return err diff --git a/pkg/cmd/project/template/template_test.go b/pkg/cmd/project/mark-template/mark_template_test.go similarity index 91% rename from pkg/cmd/project/template/template_test.go rename to pkg/cmd/project/mark-template/mark_template_test.go index df42ae5ca..581c4d8f6 100644 --- a/pkg/cmd/project/template/template_test.go +++ b/pkg/cmd/project/mark-template/mark_template_test.go @@ -1,4 +1,4 @@ -package template +package marktemplate import ( "testing" @@ -11,11 +11,11 @@ import ( "gopkg.in/h2non/gock.v1" ) -func TestNewCmdTemplate(t *testing.T) { +func TestNewCmdMarkTemplate(t *testing.T) { tests := []struct { name string cli string - wants templateOpts + wants markTemplateOpts wantsErr bool wantsErrMsg string }{ @@ -28,21 +28,21 @@ func TestNewCmdTemplate(t *testing.T) { { name: "number", cli: "123", - wants: templateOpts{ + wants: markTemplateOpts{ number: 123, }, }, { name: "owner", cli: "--owner monalisa", - wants: templateOpts{ + wants: markTemplateOpts{ owner: "monalisa", }, }, { name: "undo", cli: "--undo", - wants: templateOpts{ + wants: markTemplateOpts{ undo: true, }, }, @@ -50,7 +50,7 @@ func TestNewCmdTemplate(t *testing.T) { { name: "json", cli: "--format json", - wants: templateOpts{ + wants: markTemplateOpts{ format: "json", }, }, @@ -68,8 +68,8 @@ func TestNewCmdTemplate(t *testing.T) { argv, err := shlex.Split(tt.cli) assert.NoError(t, err) - var gotOpts templateOpts - cmd := NewCmdTemplate(f, func(config templateConfig) error { + var gotOpts markTemplateOpts + cmd := NewCmdMarkTemplate(f, func(config markTemplateConfig) error { gotOpts = config.opts return nil }) @@ -164,8 +164,8 @@ func TestRunMarkTemplate_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() ios.SetStdoutTTY(true) - config := templateConfig{ - opts: templateOpts{ + config := markTemplateConfig{ + opts: markTemplateOpts{ owner: "github", number: 1, }, @@ -173,7 +173,7 @@ func TestRunMarkTemplate_Org(t *testing.T) { io: ios, } - err := runTemplate(config) + err := runMarkTemplate(config) assert.NoError(t, err) assert.Equal( t, @@ -256,8 +256,8 @@ func TestRunUnmarkTemplate_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() ios.SetStdoutTTY(true) - config := templateConfig{ - opts: templateOpts{ + config := markTemplateConfig{ + opts: markTemplateOpts{ owner: "github", number: 1, undo: true, @@ -266,7 +266,7 @@ func TestRunUnmarkTemplate_Org(t *testing.T) { io: ios, } - err := runTemplate(config) + err := runMarkTemplate(config) assert.NoError(t, err) assert.Equal( t, diff --git a/pkg/cmd/project/project.go b/pkg/cmd/project/project.go index d9858953d..cb5e54149 100644 --- a/pkg/cmd/project/project.go +++ b/pkg/cmd/project/project.go @@ -17,7 +17,7 @@ import ( 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" - cmdTemplate "github.com/cli/cli/v2/pkg/cmd/project/template" + cmdTemplate "github.com/cli/cli/v2/pkg/cmd/project/mark-template" cmdView "github.com/cli/cli/v2/pkg/cmd/project/view" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/spf13/cobra" @@ -44,7 +44,7 @@ func NewCmdProject(f *cmdutil.Factory) *cobra.Command { cmd.AddCommand(cmdDelete.NewCmdDelete(f, nil)) cmd.AddCommand(cmdEdit.NewCmdEdit(f, nil)) cmd.AddCommand(cmdView.NewCmdView(f, nil)) - cmd.AddCommand(cmdTemplate.NewCmdTemplate(f, nil)) + cmd.AddCommand(cmdTemplate.NewCmdMarkTemplate(f, nil)) // items cmd.AddCommand(cmdItemList.NewCmdList(f, nil)) From f9df89da0fea2c483fb3d5db8b18c664cfc6bc2c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 5 Sep 2023 04:06:24 +0200 Subject: [PATCH 008/527] build(deps): bump actions/checkout from 3 to 4 (#7937) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- .github/workflows/codeql.yml | 2 +- .github/workflows/deployment.yml | 10 +++++----- .github/workflows/go.yml | 2 +- .github/workflows/lint.yml | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 4aa93810d..7e8117c46 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -21,7 +21,7 @@ jobs: steps: - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Initialize CodeQL uses: github/codeql-action/init@v2 diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index 1f1a24b1d..6b951cd68 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -34,7 +34,7 @@ jobs: if: contains(inputs.platforms, 'linux') steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Go uses: actions/setup-go@v4 with: @@ -68,7 +68,7 @@ jobs: if: contains(inputs.platforms, 'macos') steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Go uses: actions/setup-go@v4 with: @@ -125,7 +125,7 @@ jobs: if: contains(inputs.platforms, 'windows') steps: - name: Checkout - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up Go uses: actions/setup-go@v4 with: @@ -209,11 +209,11 @@ jobs: if: inputs.release steps: - name: Checkout cli/cli - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Merge built artifacts uses: actions/download-artifact@v3 - name: Checkout documentation site - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: repository: github/cli.github.com path: site diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index a375e2d8f..13fbfb7f1 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -19,7 +19,7 @@ jobs: go-version: 1.21 - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Restore Go modules cache uses: actions/cache@v3 diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index c8defbf3a..bb6526faa 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -25,7 +25,7 @@ jobs: go-version: 1.21 - name: Check out code - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Restore Go modules cache uses: actions/cache@v3 From b91cfd8484e26a5190998f274bf1f56f1d61804a Mon Sep 17 00:00:00 2001 From: Robert Estelle Date: Mon, 4 Sep 2023 19:34:44 -0700 Subject: [PATCH 009/527] `gh status`: show status even if a comment 404s (#7873) --- pkg/cmd/status/status.go | 31 +++++++++++++------ pkg/cmd/status/status_test.go | 57 +++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+), 9 deletions(-) diff --git a/pkg/cmd/status/status.go b/pkg/cmd/status/status.go index 7e39d63d0..4e6bd3781 100644 --- a/pkg/cmd/status/status.go +++ b/pkg/cmd/status/status.go @@ -286,7 +286,28 @@ func (s *StatusGetter) LoadNotifications() error { if !ok { return nil } - if actual, err := s.ActualMention(n.Subject.LatestCommentURL); actual != "" && err == nil { + actual, err := s.ActualMention(n.Subject.LatestCommentURL) + + if err != nil { + var httpErr api.HTTPError + httpStatusCode := -1 + + if errors.As(err, &httpErr) { + httpStatusCode = httpErr.StatusCode + } + + switch httpStatusCode { + case 403: + s.addAuthError(httpErr.Message, factory.SSOURL()) + case 404: + return nil + default: + abortFetching() + return fmt.Errorf("could not fetch comment: %w", err) + } + } + + if actual != "" { // I'm so sorry split := strings.Split(n.Subject.URL, "/") fetched <- StatusItem{ @@ -295,14 +316,6 @@ func (s *StatusGetter) LoadNotifications() error { preview: actual, index: n.index, } - } else if err != nil { - var httpErr api.HTTPError - if errors.As(err, &httpErr) && httpErr.StatusCode == 403 { - s.addAuthError(httpErr.Message, factory.SSOURL()) - } else { - abortFetching() - return fmt.Errorf("could not fetch comment: %w", err) - } } } } diff --git a/pkg/cmd/status/status_test.go b/pkg/cmd/status/status_test.go index c592c90a0..d9fdd54bc 100644 --- a/pkg/cmd/status/status_test.go +++ b/pkg/cmd/status/status_test.go @@ -295,6 +295,63 @@ func TestStatusRun(t *testing.T) { warning: You don't have permission to access this resource. `), }, + { + name: "not found errors", + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL("UserCurrent"), + httpmock.StringResponse(`{"data": {"viewer": {"login": "jillvalentine"}}}`)) + reg.Register( + httpmock.REST("GET", "repos/rpd/todo/issues/110"), + httpmock.StringResponse(`{"body":"hello @jillvalentine how are you"}`)) + reg.Register( + httpmock.REST("GET", "repos/rpd/todo/issues/4113"), + httpmock.StringResponse(`{"body":"this is a comment"}`)) + reg.Register( + httpmock.REST("GET", "repos/cli/cli/issues/1096"), + httpmock.StringResponse(`{"body":"@jillvalentine hi"}`)) + reg.Register( + httpmock.REST("GET", "repos/rpd/todo/issues/comments/1065"), + httpmock.StatusStringResponse(404, `{ + "message": "Not Found." + }`)) + reg.Register( + httpmock.REST("GET", "repos/vilmibm/gh-screensaver/issues/comments/10"), + httpmock.StringResponse(`{"body":"a message for @jillvalentine"}`)) + reg.Register( + httpmock.GraphQL("AssignedSearch"), + httpmock.FileResponse("./fixtures/search.json")) + reg.Register( + httpmock.REST("GET", "notifications"), + httpmock.FileResponse("./fixtures/notifications.json")) + reg.Register( + httpmock.REST("GET", "users/jillvalentine/received_events"), + httpmock.FileResponse("./fixtures/events.json")) + }, + opts: &StatusOptions{}, + wantOut: heredoc.Doc(` + Assigned Issues │ Assigned Pull Requests + vilmibm/testing#157 yolo │ cli/cli#5272 Pin extensions + cli/cli#3223 Repo garden...│ rpd/todo#73 Board up RPD windows + rpd/todo#514 Reducing zo...│ cli/cli#4768 Issue Frecency + vilmibm/testing#74 welp │ + adreyer/arkestrator#22 complete mo...│ + │ + Review Requests │ Mentions + cli/cli#5272 Pin extensions │ rpd/todo#110 hello @j... + vilmibm/testing#1234 Foobar │ cli/cli#1096 @jillval... + rpd/todo#50 Welcome party...│ vilmibm/gh-screensaver#15 a messag... + cli/cli#4671 This pull req...│ + rpd/todo#49 Haircut for Leon│ + │ + Repository Activity + rpd/todo#5326 new PR Only write UTF-8 BOM on W... + vilmibm/testing#5325 comment on Ability to sea... We are working on dedicat... + cli/cli#5319 comment on [Codespaces] D... Wondering if we shouldn't... + cli/cli#5300 new issue Terminal bell when a runn... + + `), + }, { name: "notification errors", httpStubs: func(reg *httpmock.Registry) { From 6f0f5a89e2538c20cb02b3e1951026f08ea1e082 Mon Sep 17 00:00:00 2001 From: Harvey Sanders Date: Tue, 5 Sep 2023 11:36:33 -0400 Subject: [PATCH 010/527] Use consistent variable naming --- pkg/cmd/run/shared/shared.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go index d5a918776..cd9d481b8 100644 --- a/pkg/cmd/run/shared/shared.go +++ b/pkg/cmd/run/shared/shared.go @@ -434,17 +434,17 @@ func GetJobs(client *api.Client, repo ghrepo.Interface, run *Run) ([]Job, error) return run.Jobs, nil } - v := url.Values{} - v.Set("per_page", "100") - - jobsPath := fmt.Sprintf("%s?%s", run.JobsURL, v.Encode()) + query := url.Values{} + query.Set("per_page", "100") + jobsPath := fmt.Sprintf("%s?%s", run.JobsURL, query.Encode()) for jobsPath != "" { var resp JobsPayload var err error jobsPath, err = client.RESTWithNext(repo.RepoHost(), http.MethodGet, jobsPath, nil, &resp) if err != nil { - return run.Jobs, err + run.Jobs = nil + return nil, err } run.Jobs = append(run.Jobs, resp.Jobs...) From 3d4df8800e2546cf6d92ad825dd1d776ecf02490 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 6 Sep 2023 15:02:58 +0200 Subject: [PATCH 011/527] Add a test workflow for homebrew bump investigations (#7951) --- .github/workflows/homebrew.yml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .github/workflows/homebrew.yml diff --git a/.github/workflows/homebrew.yml b/.github/workflows/homebrew.yml new file mode 100644 index 000000000..9a6400f42 --- /dev/null +++ b/.github/workflows/homebrew.yml @@ -0,0 +1,22 @@ +name: homebrewbump + +permissions: + contents: write + +on: + workflow_dispatch: + +jobs: + homebrewbump: + environment: production + runs-on: ubuntu-latest + steps: + - name: Bump homebrew-core formula + uses: mislav/bump-homebrew-formula-action@v2 + with: + formula-name: gh + formula-path: Formula/g/gh.rb + tag-name: v2.34.0 + push-to: cli/homebrew-core + env: + COMMITTER_TOKEN: ${{ secrets.HOMEBREW_PR_PAT }} From 1d650a1577c8f0b928263abe695721bf76963f08 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 6 Sep 2023 15:22:21 +0200 Subject: [PATCH 012/527] Revert "Add a test workflow for homebrew bump investigations (#7951)" This reverts commit 3d4df8800e2546cf6d92ad825dd1d776ecf02490. --- .github/workflows/homebrew.yml | 22 ---------------------- 1 file changed, 22 deletions(-) delete mode 100644 .github/workflows/homebrew.yml diff --git a/.github/workflows/homebrew.yml b/.github/workflows/homebrew.yml deleted file mode 100644 index 9a6400f42..000000000 --- a/.github/workflows/homebrew.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: homebrewbump - -permissions: - contents: write - -on: - workflow_dispatch: - -jobs: - homebrewbump: - environment: production - runs-on: ubuntu-latest - steps: - - name: Bump homebrew-core formula - uses: mislav/bump-homebrew-formula-action@v2 - with: - formula-name: gh - formula-path: Formula/g/gh.rb - tag-name: v2.34.0 - push-to: cli/homebrew-core - env: - COMMITTER_TOKEN: ${{ secrets.HOMEBREW_PR_PAT }} From 1d0d51834d9171150c51d99a3293f6127155fb0d Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 6 Sep 2023 15:22:36 +0200 Subject: [PATCH 013/527] Move homebrew bump fork to personal repo --- .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 6b951cd68..7cf5c3645 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -342,6 +342,6 @@ jobs: formula-name: gh formula-path: Formula/g/gh.rb tag-name: ${{ inputs.tag_name }} - push-to: cli/homebrew-core + push-to: williammartin/homebrew-core env: COMMITTER_TOKEN: ${{ secrets.HOMEBREW_PR_PAT }} From 1749574310a0b7061045c3d1573701b1eacc5837 Mon Sep 17 00:00:00 2001 From: Natsuki Ikeguchi Date: Thu, 7 Sep 2023 01:35:03 +0900 Subject: [PATCH 014/527] feat(cache): Add JSON exporting support for cache list Signed-off-by: Natsuki Ikeguchi --- pkg/cmd/cache/list/list.go | 6 ++++++ pkg/cmd/cache/shared/shared.go | 28 ++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+) diff --git a/pkg/cmd/cache/list/list.go b/pkg/cmd/cache/list/list.go index d2f4aa10d..85ab68f6b 100644 --- a/pkg/cmd/cache/list/list.go +++ b/pkg/cmd/cache/list/list.go @@ -21,6 +21,7 @@ type ListOptions struct { BaseRepo func() (ghrepo.Interface, error) HttpClient func() (*http.Client, error) IO *iostreams.IOStreams + Exporter cmdutil.Exporter Now time.Time Limit int @@ -68,6 +69,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman cmd.Flags().IntVarP(&opts.Limit, "limit", "L", 30, "Maximum number of caches to fetch") cmdutil.StringEnumFlag(cmd, &opts.Order, "order", "O", "desc", []string{"asc", "desc"}, "Order of caches returned") cmdutil.StringEnumFlag(cmd, &opts.Sort, "sort", "S", "last_accessed_at", []string{"created_at", "last_accessed_at", "size_in_bytes"}, "Sort fetched caches") + cmdutil.AddJSONFlags(cmd, &opts.Exporter, shared.CacheFields) return cmd } @@ -101,6 +103,10 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.Out, "Failed to start pager: %v\n", err) } + if opts.Exporter != nil { + return opts.Exporter.Write(opts.IO, result.ActionsCaches) + } + if opts.IO.IsStdoutTTY() { fmt.Fprintf(opts.IO.Out, "\nShowing %d of %s in %s\n\n", len(result.ActionsCaches), text.Pluralize(result.TotalCount, "cache"), ghrepo.FullName(repo)) } diff --git a/pkg/cmd/cache/shared/shared.go b/pkg/cmd/cache/shared/shared.go index 271dee508..c3ae7568d 100644 --- a/pkg/cmd/cache/shared/shared.go +++ b/pkg/cmd/cache/shared/shared.go @@ -2,12 +2,24 @@ package shared import ( "fmt" + "reflect" + "strings" "time" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" ) +var CacheFields = []string{ + "createdAt", + "id", + "key", + "lastAccessedAt", + "ref", + "sizeInBytes", + "version", +} + type Cache struct { CreatedAt time.Time `json:"created_at"` Id int `json:"id"` @@ -71,3 +83,19 @@ pagination: return result, nil } + +func (c *Cache) ExportData(fields []string) map[string]interface{} { + v := reflect.ValueOf(c).Elem() + fieldByName := func(v reflect.Value, field string) reflect.Value { + return v.FieldByNameFunc(func(s string) bool { + return strings.EqualFold(field, s) + }) + } + data := map[string]interface{}{} + + for _, f := range fields { + data[f] = fieldByName(v, f).Interface() + } + + return data +} From 925473eeb1e4e7826018aa812f156cda96791714 Mon Sep 17 00:00:00 2001 From: Jun Nishimura Date: Thu, 7 Sep 2023 19:56:44 +0900 Subject: [PATCH 015/527] Add `--all` flag to `alias delete` command (#7900) --- pkg/cmd/alias/delete/delete.go | 56 ++++++--- pkg/cmd/alias/delete/delete_test.go | 186 +++++++++++++++++++++------- 2 files changed, 182 insertions(+), 60 deletions(-) diff --git a/pkg/cmd/alias/delete/delete.go b/pkg/cmd/alias/delete/delete.go index daaaa2435..16e943044 100644 --- a/pkg/cmd/alias/delete/delete.go +++ b/pkg/cmd/alias/delete/delete.go @@ -2,6 +2,7 @@ package delete import ( "fmt" + "sort" "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/pkg/cmdutil" @@ -14,6 +15,7 @@ type DeleteOptions struct { IO *iostreams.IOStreams Name string + All bool } func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Command { @@ -23,12 +25,19 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co } cmd := &cobra.Command{ - Use: "delete ", - Short: "Delete an alias", - Args: cobra.ExactArgs(1), + Use: "delete { | --all}", + Short: "Delete set aliases", + Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { - opts.Name = args[0] - + if len(args) == 0 && !opts.All { + return cmdutil.FlagErrorf("specify an alias to delete or `--all`") + } + if len(args) > 0 && opts.All { + return cmdutil.FlagErrorf("cannot use `--all` with alias name") + } + if len(args) > 0 { + opts.Name = args[0] + } if runF != nil { return runF(opts) } @@ -36,6 +45,8 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co }, } + cmd.Flags().BoolVar(&opts.All, "all", false, "Delete all aliases") + return cmd } @@ -47,25 +58,40 @@ func deleteRun(opts *DeleteOptions) error { aliasCfg := cfg.Aliases() - expansion, err := aliasCfg.Get(opts.Name) - if err != nil { - return fmt.Errorf("no such alias %s", opts.Name) - + aliases := make(map[string]string) + if opts.All { + aliases = aliasCfg.All() + if len(aliases) == 0 { + return cmdutil.NewNoResultsError("no aliases configured") + } + } else { + expansion, err := aliasCfg.Get(opts.Name) + if err != nil { + return fmt.Errorf("no such alias %s", opts.Name) + } + aliases[opts.Name] = expansion } - err = aliasCfg.Delete(opts.Name) - if err != nil { - return fmt.Errorf("failed to delete alias %s: %w", opts.Name, err) + for name := range aliases { + if err := aliasCfg.Delete(name); err != nil { + return fmt.Errorf("failed to delete alias %s: %w", name, err) + } } - err = cfg.Write() - if err != nil { + if err := cfg.Write(); err != nil { return err } if opts.IO.IsStdoutTTY() { cs := opts.IO.ColorScheme() - fmt.Fprintf(opts.IO.ErrOut, "%s Deleted alias %s; was %s\n", cs.SuccessIconWithColor(cs.Red), opts.Name, expansion) + keys := make([]string, 0, len(aliases)) + for k := range aliases { + keys = append(keys, k) + } + sort.Strings(keys) + for _, k := range keys { + fmt.Fprintf(opts.IO.ErrOut, "%s Deleted alias %s; was %s\n", cs.SuccessIconWithColor(cs.Red), k, aliases[k]) + } } return nil diff --git a/pkg/cmd/alias/delete/delete_test.go b/pkg/cmd/alias/delete/delete_test.go index d6c7098b1..9990abdfc 100644 --- a/pkg/cmd/alias/delete/delete_test.go +++ b/pkg/cmd/alias/delete/delete_test.go @@ -11,78 +11,174 @@ import ( "github.com/cli/cli/v2/pkg/iostreams" "github.com/google/shlex" "github.com/stretchr/testify/assert" - "github.com/stretchr/testify/require" ) -func TestAliasDelete(t *testing.T) { - _ = config.StubWriteConfig(t) - +func TestNewCmdDelete(t *testing.T) { tests := []struct { - name string - config string - cli string - isTTY bool - wantStdout string - wantStderr string - wantErr string + name string + input string + output DeleteOptions + wantErr bool + errMsg string }{ { - name: "no aliases", - config: "", - cli: "co", - isTTY: true, - wantStdout: "", - wantStderr: "", - wantErr: "no such alias co", + name: "no arguments", + input: "", + wantErr: true, + errMsg: "specify an alias to delete or `--all`", }, { - name: "delete one", + name: "specified alias", + input: "co", + output: DeleteOptions{ + Name: "co", + }, + }, + { + name: "all flag", + input: "--all", + output: DeleteOptions{ + All: true, + }, + }, + { + name: "specified alias and all flag", + input: "co --all", + wantErr: true, + errMsg: "cannot use `--all` with alias name", + }, + { + name: "too many arguments", + input: "il co", + wantErr: true, + errMsg: "accepts at most 1 arg(s), received 2", + }, + } + 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 *DeleteOptions + cmd := NewCmdDelete(f, func(opts *DeleteOptions) error { + gotOpts = opts + return nil + }) + cmd.SetArgs(argv) + cmd.SetIn(&bytes.Buffer{}) + cmd.SetOut(io.Discard) + cmd.SetErr(io.Discard) + _, err = cmd.ExecuteC() + if tt.wantErr { + assert.EqualError(t, err, tt.errMsg) + return + } + assert.NoError(t, err) + assert.Equal(t, tt.output.Name, gotOpts.Name) + assert.Equal(t, tt.output.All, gotOpts.All) + }) + } +} + +func TestDeleteRun(t *testing.T) { + tests := []struct { + name string + config string + isTTY bool + opts *DeleteOptions + wantAliases map[string]string + wantStdout string + wantStderr string + wantErrMsg string + }{ + { + name: "delete alias", config: heredoc.Doc(` aliases: il: issue list co: pr checkout `), - cli: "co", - isTTY: true, - wantStdout: "", + isTTY: true, + opts: &DeleteOptions{ + Name: "co", + All: false, + }, + wantAliases: map[string]string{ + "il": "issue list", + }, wantStderr: "✓ Deleted alias co; was pr checkout\n", }, + { + name: "delete all aliases", + config: heredoc.Doc(` + aliases: + il: issue list + co: pr checkout + `), + isTTY: true, + opts: &DeleteOptions{ + All: true, + }, + wantAliases: map[string]string{}, + wantStderr: "✓ Deleted alias co; was pr checkout\n✓ Deleted alias il; was issue list\n", + }, + { + name: "delete alias that does not exist", + config: heredoc.Doc(` + aliases: + il: issue list + co: pr checkout + `), + isTTY: true, + opts: &DeleteOptions{ + Name: "unknown", + }, + wantAliases: map[string]string{ + "il": "issue list", + "co": "pr checkout", + }, + wantErrMsg: "no such alias unknown", + }, + { + name: "delete all aliases when none exist", + isTTY: true, + opts: &DeleteOptions{ + All: true, + }, + wantAliases: map[string]string{}, + wantErrMsg: "no aliases configured", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - cfg := config.NewFromString(tt.config) - ios, _, stdout, stderr := iostreams.Test() - ios.SetStdoutTTY(tt.isTTY) ios.SetStdinTTY(tt.isTTY) + ios.SetStdoutTTY(tt.isTTY) ios.SetStderrTTY(tt.isTTY) + tt.opts.IO = ios - factory := &cmdutil.Factory{ - IOStreams: ios, - Config: func() (config.Config, error) { - return cfg, nil - }, + cfg := config.NewFromString(tt.config) + tt.opts.Config = func() (config.Config, error) { + return cfg, nil } - cmd := NewCmdDelete(factory, nil) - - argv, err := shlex.Split(tt.cli) - require.NoError(t, err) - cmd.SetArgs(argv) - - cmd.SetIn(&bytes.Buffer{}) - cmd.SetOut(io.Discard) - cmd.SetErr(io.Discard) - - _, err = cmd.ExecuteC() - if tt.wantErr != "" { - assert.EqualError(t, err, tt.wantErr) - return + err := deleteRun(tt.opts) + if tt.wantErrMsg != "" { + assert.EqualError(t, err, tt.wantErrMsg) + writeCalls := cfg.WriteCalls() + assert.Equal(t, 0, len(writeCalls)) + } else { + assert.NoError(t, err) + writeCalls := cfg.WriteCalls() + assert.Equal(t, 1, len(writeCalls)) } - require.NoError(t, err) assert.Equal(t, tt.wantStdout, stdout.String()) assert.Equal(t, tt.wantStderr, stderr.String()) + assert.Equal(t, tt.wantAliases, cfg.Aliases().All()) }) } } From ba60f89f424967605f327348ff436f68d24d775d Mon Sep 17 00:00:00 2001 From: Keming Date: Thu, 7 Sep 2023 20:04:15 +0800 Subject: [PATCH 016/527] Delete local tag when running `gh release delete --cleanup-tag` (#7884) --- git/client.go | 13 +++++++++ git/client_test.go | 39 +++++++++++++++++++++++++++ pkg/cmd/release/delete/delete.go | 24 ++++++++++------- pkg/cmd/release/delete/delete_test.go | 16 +++++++++++ 4 files changed, 83 insertions(+), 9 deletions(-) diff --git a/git/client.go b/git/client.go index a029c8ba6..d90990cc7 100644 --- a/git/client.go +++ b/git/client.go @@ -322,6 +322,19 @@ func (c *Client) ReadBranchConfig(ctx context.Context, branch string) (cfg Branc return } +func (c *Client) DeleteLocalTag(ctx context.Context, tag string) error { + args := []string{"tag", "-d", tag} + cmd, err := c.Command(ctx, args...) + if err != nil { + return err + } + _, err = cmd.Output() + if err != nil { + return err + } + return nil +} + func (c *Client) DeleteLocalBranch(ctx context.Context, branch string) error { args := []string{"branch", "-D", branch} cmd, err := c.Command(ctx, args...) diff --git a/git/client_test.go b/git/client_test.go index 5e96bb1b7..841a496da 100644 --- a/git/client_test.go +++ b/git/client_test.go @@ -558,6 +558,45 @@ func TestClientReadBranchConfig(t *testing.T) { } } +func TestClientDeleteLocalTag(t *testing.T) { + tests := []struct { + name string + cmdExitStatus int + cmdStdout string + cmdStderr string + wantCmdArgs string + wantErrorMsg string + }{ + { + name: "delete local tag", + wantCmdArgs: `path/to/git tag -d v1.0`, + }, + { + name: "git error", + cmdExitStatus: 1, + cmdStderr: "git error message", + wantCmdArgs: `path/to/git tag -d v1.0`, + 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.DeleteLocalTag(context.Background(), "v1.0") + 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 TestClientDeleteLocalBranch(t *testing.T) { tests := []struct { name string diff --git a/pkg/cmd/release/delete/delete.go b/pkg/cmd/release/delete/delete.go index 94b09cfcb..622b18893 100644 --- a/pkg/cmd/release/delete/delete.go +++ b/pkg/cmd/release/delete/delete.go @@ -6,6 +6,7 @@ import ( "net/http" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghinstance" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/cmd/release/shared" @@ -19,10 +20,12 @@ type iprompter interface { } type DeleteOptions struct { - HttpClient func() (*http.Client, error) - IO *iostreams.IOStreams - BaseRepo func() (ghrepo.Interface, error) - Prompter iprompter + HttpClient func() (*http.Client, error) + GitClient *git.Client + IO *iostreams.IOStreams + BaseRepo func() (ghrepo.Interface, error) + RepoOverride string + Prompter iprompter TagName string SkipConfirm bool @@ -33,6 +36,7 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co opts := &DeleteOptions{ IO: f.IOStreams, HttpClient: f.HttpClient, + GitClient: f.GitClient, Prompter: f.Prompter, } @@ -43,6 +47,7 @@ func NewCmdDelete(f *cmdutil.Factory, runF func(*DeleteOptions) error) *cobra.Co RunE: func(cmd *cobra.Command, args []string) error { // support `-R, --repo` override opts.BaseRepo = f.BaseRepo + opts.RepoOverride, _ = cmd.Flags().GetString("repo") opts.TagName = args[0] @@ -93,12 +98,13 @@ func deleteRun(opts *DeleteOptions) error { } var cleanupMessage string - mustCleanupTag := opts.CleanupTag - if mustCleanupTag { - err = deleteTag(httpClient, baseRepo, release.TagName) - if err != nil { + if opts.CleanupTag { + if err := deleteTag(httpClient, baseRepo, release.TagName); err != nil { return err } + if opts.RepoOverride == "" { + _ = opts.GitClient.DeleteLocalTag(context.Background(), release.TagName) + } cleanupMessage = " and tag" } @@ -108,7 +114,7 @@ func deleteRun(opts *DeleteOptions) error { iofmt := opts.IO.ColorScheme() fmt.Fprintf(opts.IO.ErrOut, "%s Deleted release%s %s\n", iofmt.SuccessIconWithColor(iofmt.Red), cleanupMessage, release.TagName) - if !release.IsDraft && !mustCleanupTag { + if !release.IsDraft && !opts.CleanupTag { fmt.Fprintf(opts.IO.ErrOut, "%s Note that the %s git tag still remains in the repository\n", iofmt.WarningIcon(), release.TagName) } diff --git a/pkg/cmd/release/delete/delete_test.go b/pkg/cmd/release/delete/delete_test.go index c0c43f990..2787f247b 100644 --- a/pkg/cmd/release/delete/delete_test.go +++ b/pkg/cmd/release/delete/delete_test.go @@ -7,8 +7,10 @@ import ( "testing" "github.com/MakeNowJust/heredoc" + "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/prompter" + "github.com/cli/cli/v2/internal/run" "github.com/cli/cli/v2/pkg/cmd/release/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" @@ -110,6 +112,7 @@ func Test_deleteRun(t *testing.T) { isTTY bool opts DeleteOptions prompterStubs func(*prompter.PrompterMock) + runStubs func(*run.CommandStubber) wantErr string wantStdout string wantStderr string @@ -164,6 +167,9 @@ func Test_deleteRun(t *testing.T) { SkipConfirm: true, CleanupTag: true, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag -d v1.2.3`, 0, "") + }, wantStdout: ``, wantStderr: heredoc.Doc(` ✓ Deleted release and tag v1.2.3 @@ -177,6 +183,9 @@ func Test_deleteRun(t *testing.T) { SkipConfirm: false, CleanupTag: true, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag -d v1.2.3`, 0, "") + }, wantStdout: ``, wantStderr: ``, }, @@ -203,6 +212,12 @@ func Test_deleteRun(t *testing.T) { fakeHTTP.Register(httpmock.REST("DELETE", "repos/OWNER/REPO/releases/23456"), httpmock.StatusStringResponse(204, "")) fakeHTTP.Register(httpmock.REST("DELETE", "repos/OWNER/REPO/git/refs/tags/v1.2.3"), httpmock.StatusStringResponse(204, "")) + rs, teardown := run.Stub() + defer teardown(t) + if tt.runStubs != nil { + tt.runStubs(rs) + } + tt.opts.IO = ios tt.opts.Prompter = pm tt.opts.HttpClient = func() (*http.Client, error) { @@ -211,6 +226,7 @@ func Test_deleteRun(t *testing.T) { tt.opts.BaseRepo = func() (ghrepo.Interface, error) { return ghrepo.FromFullName("OWNER/REPO") } + tt.opts.GitClient = &git.Client{GitPath: "some/path/git"} err := deleteRun(&tt.opts) if tt.wantErr != "" { From 27493ca2f8b13393ffda61822d1450ea74d65433 Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 11 Sep 2023 15:18:20 +0200 Subject: [PATCH 017/527] Reinforce not opening PRs without approval on an issue --- .github/CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 10f17a2fc..73174db65 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -16,6 +16,7 @@ Please do: Please avoid: * Opening pull requests for issues marked `needs-design`, `needs-investigation`, or `blocked`. +* Opening pull requests that haven't been approved for work in an issue * Adding installation instructions specifically for your OS/package manager. * Opening pull requests for any issue marked `core`. These issues require additional context from the core CLI team at GitHub and any external pull requests will not be accepted. From 7e7391bf88b8cf3da0b51b1b9bfc840645d43b32 Mon Sep 17 00:00:00 2001 From: Nick Alteen Date: Mon, 11 Sep 2023 11:28:14 -0400 Subject: [PATCH 018/527] Clarify list repo behavior (#7964) Co-authored-by: William Martin --- pkg/cmd/repo/list/list.go | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/repo/list/list.go b/pkg/cmd/repo/list/list.go index e5b031794..07729b481 100644 --- a/pkg/cmd/repo/list/list.go +++ b/pkg/cmd/repo/list/list.go @@ -6,6 +6,7 @@ import ( "strings" "time" + "github.com/MakeNowJust/heredoc" "github.com/spf13/cobra" "github.com/cli/cli/v2/api" @@ -52,9 +53,16 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman ) cmd := &cobra.Command{ - Use: "list []", - Args: cobra.MaximumNArgs(1), - Short: "List repositories owned by user or organization", + Use: "list []", + Args: cobra.MaximumNArgs(1), + Short: "List repositories owned by user or organization", + Long: heredoc.Docf(` + List repositories owned by a user or organization. + + Note that the list will only include repositories owned by the provided argument, + and the %[1]s--fork%[1]s or %[1]s--source%[1]s flags will not traverse ownership boundaries. For example, + when listing the forks in an organization, the output would not include those owned by individual users. + `, "`"), Aliases: []string{"ls"}, RunE: func(c *cobra.Command, args []string) error { if opts.Limit < 1 { From be41a9bd20c597231e5f32494f47bbc313b16f40 Mon Sep 17 00:00:00 2001 From: Keith Bailey Date: Mon, 11 Sep 2023 14:17:49 -0400 Subject: [PATCH 019/527] moved remoteTagExists under if NotesFromTag exists and added three tests --- pkg/cmd/release/create/create.go | 6 +- pkg/cmd/release/create/create_test.go | 83 +++++++++++++++++++++++++++ 2 files changed, 88 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/release/create/create.go b/pkg/cmd/release/create/create.go index 07e40b708..aa021748b 100644 --- a/pkg/cmd/release/create/create.go +++ b/pkg/cmd/release/create/create.go @@ -248,7 +248,6 @@ func createRun(opts *CreateOptions) error { var tagDescription string if opts.RepoOverride == "" { tagDescription, _ = gitTagInfo(opts.GitClient, opts.TagName) - remoteExists, err := remoteTagExists(httpClient, baseRepo, opts.TagName) // If there is a local tag with the same name as specified // the user may not want to create a new tag on the remote // as the local one might be annotated or signed. @@ -258,6 +257,7 @@ func createRun(opts *CreateOptions) error { // If a remote tag with the same name as specified exists already // then a new tag will not be created so ignore local tag status. if tagDescription != "" && !existingTag && opts.Target == "" && !opts.VerifyTag { + remoteExists, err := remoteTagExists(httpClient, baseRepo, opts.TagName) if err != nil { return err } @@ -268,6 +268,10 @@ func createRun(opts *CreateOptions) error { } if opts.NotesFromTag { + remoteExists, err := remoteTagExists(httpClient, baseRepo, opts.TagName) + if err != nil { + return err + } if !remoteExists { return fmt.Errorf("tag %s doesn't exist in the repo %s, cannot populate release notes with annotated git tag message using the `--notes-from-tag` flag", opts.TagName, ghrepo.FullName(baseRepo)) diff --git a/pkg/cmd/release/create/create_test.go b/pkg/cmd/release/create/create_test.go index 1787c0931..53af2168b 100644 --- a/pkg/cmd/release/create/create_test.go +++ b/pkg/cmd/release/create/create_test.go @@ -921,6 +921,89 @@ func Test_createRun(t *testing.T) { wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3-final\n", wantStderr: ``, }, + { + name: "with tag and --notes-from-tag", + isTTY: false, + opts: CreateOptions{ + TagName: "v1.2.3", + Target: "", + Name: "", + Body: "", + BodyProvided: true, + Draft: false, + Prerelease: false, + RepoOverride: "", + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + GenerateNotes: false, + NotesFromTag: true, + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register(httpmock.GraphQL("RepositoryFindRef"), + httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": "tag id"}}}}`)) + reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.StatusStringResponse(201, `{ + "url": "https://api.github.com/releases/123", + "upload_url": "https://api.github.com/assets/upload", + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" + }`)) + }, + wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n", + wantStderr: "", + }, + { + name: "with tag and --notes-from-tag and --notes", + isTTY: false, + opts: CreateOptions{ + TagName: "v1.2.3", + Target: "", + Name: "", + Body: "Notes from --notes here", + BodyProvided: true, + Draft: false, + Prerelease: false, + RepoOverride: "", + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + GenerateNotes: false, + NotesFromTag: true, + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register(httpmock.GraphQL("RepositoryFindRef"), + httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": "tag id"}}}}`)) + reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.StatusStringResponse(201, `{ + "url": "https://api.github.com/releases/123", + "upload_url": "https://api.github.com/assets/upload", + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" + }`)) + }, + wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n", + wantStderr: "", + }, + { + name: "tag and --notes-from-tag but tag does not exist in repo", + isTTY: false, + opts: CreateOptions{ + TagName: "v1.2.4", + Target: "", + Name: "", + Body: "", + BodyProvided: true, + Draft: false, + Prerelease: false, + RepoOverride: "", + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + GenerateNotes: false, + NotesFromTag: true, + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register(httpmock.GraphQL("RepositoryFindRef"), + httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": ""}}}}`)) + }, + wantStdout: "", + wantStderr: "", + wantErr: "tag v1.2.4 doesn't exist in the repo OWNER/REPO, cannot populate release notes with annotated git tag message using the `--notes-from-tag` flag", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { From fe40c2652e64f244a08cb07c6f502261396ff437 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 12 Sep 2023 14:24:27 +0000 Subject: [PATCH 020/527] build(deps): bump goreleaser/goreleaser-action from 4 to 5 Bumps [goreleaser/goreleaser-action](https://github.com/goreleaser/goreleaser-action) from 4 to 5. - [Release notes](https://github.com/goreleaser/goreleaser-action/releases) - [Commits](https://github.com/goreleaser/goreleaser-action/compare/v4...v5) --- updated-dependencies: - dependency-name: goreleaser/goreleaser-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .github/workflows/deployment.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index 7cf5c3645..dfec56462 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -40,7 +40,7 @@ jobs: with: go-version: ${{ inputs.go_version }} - name: Install GoReleaser - uses: goreleaser/goreleaser-action@v4 + uses: goreleaser/goreleaser-action@v5 with: version: "~1.17.1" install-only: true @@ -92,7 +92,7 @@ jobs: security set-key-partition-list -S "apple-tool:,apple:,codesign:" -s -k "$keychain_password" "$keychain" rm "$RUNNER_TEMP/cert.p12" - name: Install GoReleaser - uses: goreleaser/goreleaser-action@v4 + uses: goreleaser/goreleaser-action@v5 with: version: "~1.17.1" install-only: true @@ -140,7 +140,7 @@ jobs: env: CERT_CONTENTS: ${{ secrets.WINDOWS_CERT_PFX }} - name: Install GoReleaser - uses: goreleaser/goreleaser-action@v4 + uses: goreleaser/goreleaser-action@v5 with: version: "~1.17.1" install-only: true From c5f88bb551e22b04a3799561f3abea4892012eff Mon Sep 17 00:00:00 2001 From: Josh Gross Date: Tue, 12 Sep 2023 13:12:53 -0400 Subject: [PATCH 021/527] Show full permissions URL in `gh cs create` (#7983) * Show full permissions URL in `gh cs create` * Validate that full permissions URL is displayed --- pkg/cmd/codespace/create.go | 4 +--- pkg/cmd/codespace/create_test.go | 34 +++++++++++++++++++++++++++++++- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/pkg/cmd/codespace/create.go b/pkg/cmd/codespace/create.go index 889f0b33b..a2782aef7 100644 --- a/pkg/cmd/codespace/create.go +++ b/pkg/cmd/codespace/create.go @@ -11,7 +11,6 @@ import ( "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/cli/cli/v2/internal/ghrepo" - "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/spf13/cobra" ) @@ -336,13 +335,12 @@ func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api var ( isInteractive = a.io.CanPrompt() cs = a.io.ColorScheme() - displayURL = text.DisplayURL(allowPermissionsURL) ) fmt.Fprintf(a.io.ErrOut, "You must authorize or deny additional permissions requested by this codespace before continuing.\n") if !isInteractive { - fmt.Fprintf(a.io.ErrOut, "%s in your browser to review and authorize additional permissions: %s\n", cs.Bold("Open this URL"), displayURL) + fmt.Fprintf(a.io.ErrOut, "%s in your browser to review and authorize additional permissions: %s\n", cs.Bold("Open this URL"), allowPermissionsURL) fmt.Fprintf(a.io.ErrOut, "Alternatively, you can run %q with the %q option to continue without authorizing additional permissions.\n", a.io.ColorScheme().Bold("create"), cs.Bold("--default-permissions")) return nil, cmdutil.SilentError } diff --git a/pkg/cmd/codespace/create_test.go b/pkg/cmd/codespace/create_test.go index caf6df271..ae85fc34a 100644 --- a/pkg/cmd/codespace/create_test.go +++ b/pkg/cmd/codespace/create_test.go @@ -356,7 +356,39 @@ func TestApp_Create(t *testing.T) { wantErr: cmdutil.SilentError, wantStderr: ` ✓ Codespaces usage for this repository is paid for by monalisa You must authorize or deny additional permissions requested by this codespace before continuing. -Open this URL in your browser to review and authorize additional permissions: example.com/permissions +Open this URL in your browser to review and authorize additional permissions: https://example.com/permissions +Alternatively, you can run "create" with the "--default-permissions" option to continue without authorizing additional permissions. +`, + }, + { + name: "create codespace that requires accepting additional permissions for devcontainer path", + fields: fields{ + apiClient: apiCreateDefaults(&apiClientMock{ + CreateCodespaceFunc: func(ctx context.Context, params *api.CreateCodespaceParams) (*api.Codespace, error) { + if params.Branch != "feature-branch" { + return nil, fmt.Errorf("got branch %q, want %q", params.Branch, "main") + } + if params.IdleTimeoutMinutes != 30 { + return nil, fmt.Errorf("idle timeout minutes was %v", params.IdleTimeoutMinutes) + } + return &api.Codespace{}, api.AcceptPermissionsRequiredError{ + AllowPermissionsURL: "https://example.com/permissions?ref=feature-branch&devcontainer_path=.devcontainer/actions/devcontainer.json", + } + }, + }), + }, + opts: createOptions{ + repo: "monalisa/dotfiles", + branch: "feature-branch", + devContainerPath: ".devcontainer/actions/devcontainer.json", + machine: "GIGA", + showStatus: false, + idleTimeout: 30 * time.Minute, + }, + wantErr: cmdutil.SilentError, + wantStderr: ` ✓ Codespaces usage for this repository is paid for by monalisa +You must authorize or deny additional permissions requested by this codespace before continuing. +Open this URL in your browser to review and authorize additional permissions: https://example.com/permissions?ref=feature-branch&devcontainer_path=.devcontainer/actions/devcontainer.json Alternatively, you can run "create" with the "--default-permissions" option to continue without authorizing additional permissions. `, }, From 97755c6bf0c08695eaf316728259213cd0799160 Mon Sep 17 00:00:00 2001 From: Keith Bailey Date: Mon, 18 Sep 2023 05:34:13 -0400 Subject: [PATCH 022/527] Document when gh auth login writes oauth token to plain text (#7781) --- internal/config/config.go | 6 ++++-- pkg/cmd/auth/login/login.go | 7 +++++-- pkg/cmd/auth/refresh/refresh.go | 3 ++- pkg/cmd/auth/shared/login_flow.go | 8 ++++++-- pkg/cmd/auth/shared/login_flow_test.go | 4 ++-- 5 files changed, 19 insertions(+), 9 deletions(-) diff --git a/internal/config/config.go b/internal/config/config.go index bf14a1aa0..290c32577 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -220,7 +220,7 @@ func (c *AuthConfig) SetDefaultHost(host, source string) { // Login will set user, git protocol, and auth token for the given hostname. // If the encrypt option is specified it will first try to store the auth token // in encrypted storage and will fall back to the plain text config file. -func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secureStorage bool) error { +func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secureStorage bool) (bool, error) { var setErr error if secureStorage { if setErr = keyring.Set(keyringServiceName(hostname), "", token); setErr == nil { @@ -228,8 +228,10 @@ func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secure _ = c.cfg.Remove([]string{hosts, hostname, oauthToken}) } } + insecureStorageUsed := false if !secureStorage || setErr != nil { c.cfg.Set([]string{hosts, hostname, oauthToken}, token) + insecureStorageUsed = true } if username != "" { c.cfg.Set([]string{hosts, hostname, "user"}, username) @@ -237,7 +239,7 @@ func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secure if gitProtocol != "" { c.cfg.Set([]string{hosts, hostname, "git_protocol"}, gitProtocol) } - return ghConfig.Write(c.cfg) + return insecureStorageUsed, ghConfig.Write(c.cfg) } // Logout will remove user, git protocol, and auth token for the given hostname. diff --git a/pkg/cmd/auth/login/login.go b/pkg/cmd/auth/login/login.go index 84894bf10..d02c28df4 100644 --- a/pkg/cmd/auth/login/login.go +++ b/pkg/cmd/auth/login/login.go @@ -58,7 +58,9 @@ func NewCmdLogin(f *cmdutil.Factory, runF func(*LoginOptions) error) *cobra.Comm Authenticate with a GitHub host. The default authentication mode is a web-based browser flow. After completion, an - authentication token will be stored internally. + authentication token will be stored securely in the system credential store. + If a credential store is not found or there is an issue using it gh will fallback to writing the token to a plain text file. + See %[1]sgh auth status%[1]s for its stored location. Alternatively, use %[1]s--with-token%[1]s to pass in a token on standard input. The minimum required scopes for the token are: "repo", "read:org". @@ -172,7 +174,8 @@ func loginRun(opts *LoginOptions) error { return fmt.Errorf("error validating token: %w", err) } // Adding a user key ensures that a nonempty host section gets written to the config file. - return authCfg.Login(hostname, "x-access-token", opts.Token, opts.GitProtocol, !opts.InsecureStorage) + _, loginErr := authCfg.Login(hostname, "x-access-token", opts.Token, opts.GitProtocol, !opts.InsecureStorage) + return loginErr } existingToken, _ := authCfg.Token(hostname) diff --git a/pkg/cmd/auth/refresh/refresh.go b/pkg/cmd/auth/refresh/refresh.go index 4debd0a45..489746179 100644 --- a/pkg/cmd/auth/refresh/refresh.go +++ b/pkg/cmd/auth/refresh/refresh.go @@ -48,7 +48,8 @@ func NewCmdRefresh(f *cmdutil.Factory, runF func(*RefreshOptions) error) *cobra. if err != nil { return err } - return authCfg.Login(hostname, username, token, "", secureStorage) + _, loginErr := authCfg.Login(hostname, username, token, "", secureStorage) + return loginErr }, HttpClient: &http.Client{}, GitClient: f.GitClient, diff --git a/pkg/cmd/auth/shared/login_flow.go b/pkg/cmd/auth/shared/login_flow.go index 48cccd3b2..5f8a524cb 100644 --- a/pkg/cmd/auth/shared/login_flow.go +++ b/pkg/cmd/auth/shared/login_flow.go @@ -22,7 +22,7 @@ import ( const defaultSSHKeyTitle = "GitHub CLI" type iconfig interface { - Login(string, string, string, string, bool) error + Login(string, string, string, string, bool) (bool, error) } type LoginOptions struct { @@ -188,9 +188,13 @@ func Login(opts *LoginOptions) error { fmt.Fprintf(opts.IO.ErrOut, "%s Configured git protocol\n", cs.SuccessIcon()) } - if err := cfg.Login(hostname, username, authToken, gitProtocol, opts.SecureStorage); err != nil { + insecureStorageUsed, err := cfg.Login(hostname, username, authToken, gitProtocol, opts.SecureStorage) + if err != nil { return err } + if insecureStorageUsed { + fmt.Fprintf(opts.IO.ErrOut, "%s Authentication credentials saved in plain text\n", cs.Yellow("!")) + } if credentialFlow.ShouldSetup() { err := credentialFlow.Setup(hostname, username, authToken) diff --git a/pkg/cmd/auth/shared/login_flow_test.go b/pkg/cmd/auth/shared/login_flow_test.go index 15cc3d2d6..5dbbc46c1 100644 --- a/pkg/cmd/auth/shared/login_flow_test.go +++ b/pkg/cmd/auth/shared/login_flow_test.go @@ -18,11 +18,11 @@ import ( type tinyConfig map[string]string -func (c tinyConfig) Login(host, username, token, gitProtocol string, encrypt bool) error { +func (c tinyConfig) Login(host, username, token, gitProtocol string, encrypt bool) (bool, error) { c[fmt.Sprintf("%s:%s", host, "user")] = username c[fmt.Sprintf("%s:%s", host, "oauth_token")] = token c[fmt.Sprintf("%s:%s", host, "git_protocol")] = gitProtocol - return nil + return false, nil } func TestLogin_ssh(t *testing.T) { From 94fbbdf9b5b81a433c8bb60cd16b8d179822d834 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Tue, 19 Sep 2023 10:26:52 +0200 Subject: [PATCH 023/527] Cleanup release create around new --notes-from-tag flag (#8016) --- pkg/cmd/release/create/create.go | 28 +-- pkg/cmd/release/create/create_test.go | 254 +++++++++++++++----------- pkg/httpmock/stub.go | 1 + 3 files changed, 163 insertions(+), 120 deletions(-) diff --git a/pkg/cmd/release/create/create.go b/pkg/cmd/release/create/create.go index aa021748b..a0307d34a 100644 --- a/pkg/cmd/release/create/create.go +++ b/pkg/cmd/release/create/create.go @@ -93,7 +93,8 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co To create a release from an annotated git tag, first create one locally with git, push the tag to GitHub, then run this command. - You may also use %[1]s--notes-from-tag%[1]s to create it noninteractively. + Use %[1]s--notes-from-tag%[1]s to automatically generate the release notes + from the annotated git tag. When using automatically generated release notes, a release title will also be automatically generated unless a title was explicitly passed. Additional release notes can be prepended to @@ -149,7 +150,11 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co } if opts.NotesFromTag && (opts.GenerateNotes || opts.NotesStartTag != "") { - return cmdutil.FlagErrorf("using `--notes-from-tag` with `--generate-notes` or `notes-start-tag` is not supported") + return cmdutil.FlagErrorf("using `--notes-from-tag` with `--generate-notes` or `--notes-start-tag` is not supported") + } + + if opts.NotesFromTag && opts.RepoOverride != "" { + return cmdutil.FlagErrorf("using `--notes-from-tag` with `--repo` is not supported") } opts.Concurrency = 5 @@ -182,7 +187,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co cmd.Flags().StringVar(&opts.NotesStartTag, "notes-start-tag", "", "Tag to use as the starting point for generating release notes") cmdutil.NilBoolFlag(cmd, &opts.IsLatest, "latest", "", "Mark this release as \"Latest\" (default: automatic based on date and version)") cmd.Flags().BoolVarP(&opts.VerifyTag, "verify-tag", "", false, "Abort in case the git tag doesn't already exist in the remote repository") - cmd.Flags().BoolVarP(&opts.NotesFromTag, "notes-from-tag", "", false, "Automatically populate the release notes with the message in the tag specified by `gh release create []`") + cmd.Flags().BoolVarP(&opts.NotesFromTag, "notes-from-tag", "", false, "Automatically generate notes from annotated tag") _ = cmdutil.RegisterBranchCompletionFlags(f.GitClient, cmd, "target") @@ -248,6 +253,12 @@ func createRun(opts *CreateOptions) error { var tagDescription string if opts.RepoOverride == "" { tagDescription, _ = gitTagInfo(opts.GitClient, opts.TagName) + + if opts.NotesFromTag && tagDescription == "" { + return fmt.Errorf("cannot generate release notes from tag %s as it does not exist locally", + opts.TagName) + } + // If there is a local tag with the same name as specified // the user may not want to create a new tag on the remote // as the local one might be annotated or signed. @@ -266,17 +277,6 @@ func createRun(opts *CreateOptions) error { opts.TagName, ghrepo.FullName(baseRepo)) } } - - if opts.NotesFromTag { - remoteExists, err := remoteTagExists(httpClient, baseRepo, opts.TagName) - if err != nil { - return err - } - if !remoteExists { - return fmt.Errorf("tag %s doesn't exist in the repo %s, cannot populate release notes with annotated git tag message using the `--notes-from-tag` flag", - opts.TagName, ghrepo.FullName(baseRepo)) - } - } } if !opts.BodyProvided && opts.IO.CanPrompt() { diff --git a/pkg/cmd/release/create/create_test.go b/pkg/cmd/release/create/create_test.go index 53af2168b..644177aba 100644 --- a/pkg/cmd/release/create/create_test.go +++ b/pkg/cmd/release/create/create_test.go @@ -322,41 +322,28 @@ func Test_NewCmdCreate(t *testing.T) { }, }, { - name: "tag and --notes-from-tag", + name: "with --notes-from-tag", args: "v1.2.3 --notes-from-tag", isTTY: false, want: CreateOptions{ - TagName: "v1.2.3", - Target: "", - Name: "", - Body: "", - BodyProvided: true, - Draft: false, - Prerelease: false, - RepoOverride: "", - Concurrency: 5, - Assets: []*shared.AssetForUpload(nil), - GenerateNotes: false, - NotesFromTag: true, + TagName: "v1.2.3", + BodyProvided: true, + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + NotesFromTag: true, }, }, { - name: "--notes-from-tag only ", - args: "--notes-from-tag", - isTTY: false, - wantErr: "tag required when not running interactively", - }, - { - name: "tag and --notes-from-tag and --generate-notes", + name: "with --notes-from-tag and --generate-notes", args: "v1.2.3 --notes-from-tag --generate-notes", isTTY: false, - wantErr: "using `--notes-from-tag` with `--generate-notes` or `notes-start-tag` is not supported", + wantErr: "using `--notes-from-tag` with `--generate-notes` or `--notes-start-tag` is not supported", }, { - name: "tag and --notes-from-tag and --notes-start-tag", + name: "with --notes-from-tag and --notes-start-tag", args: "v1.2.3 --notes-from-tag --notes-start-tag v1.2.3", isTTY: false, - wantErr: "using `--notes-from-tag` with `--generate-notes` or `notes-start-tag` is not supported", + wantErr: "using `--notes-from-tag` with `--generate-notes` or `--notes-start-tag` is not supported", }, } for _, tt := range tests { @@ -412,6 +399,7 @@ func Test_NewCmdCreate(t *testing.T) { assert.Equal(t, tt.want.NotesStartTag, opts.NotesStartTag) assert.Equal(t, tt.want.IsLatest, opts.IsLatest) assert.Equal(t, tt.want.VerifyTag, opts.VerifyTag) + assert.Equal(t, tt.want.NotesFromTag, opts.NotesFromTag) require.Equal(t, len(tt.want.Assets), len(opts.Assets)) for i := range tt.want.Assets { @@ -428,6 +416,7 @@ func Test_createRun(t *testing.T) { isTTY bool opts CreateOptions httpStubs func(t *testing.T, reg *httpmock.Registry) + runStubs func(rs *run.CommandStubber) wantErr string wantStdout string wantStderr string @@ -442,6 +431,9 @@ func Test_createRun(t *testing.T) { BodyProvided: true, Target: "", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -471,6 +463,9 @@ func Test_createRun(t *testing.T) { Target: "", DiscussionCategory: "General", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -500,6 +495,9 @@ func Test_createRun(t *testing.T) { BodyProvided: true, Target: "main", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -528,6 +526,9 @@ func Test_createRun(t *testing.T) { Draft: true, Target: "", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -556,6 +557,9 @@ func Test_createRun(t *testing.T) { BodyProvided: true, GenerateNotes: false, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -584,6 +588,9 @@ func Test_createRun(t *testing.T) { BodyProvided: true, GenerateNotes: true, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", @@ -613,6 +620,9 @@ func Test_createRun(t *testing.T) { GenerateNotes: true, NotesStartTag: "v1.1.0", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases/generate-notes"), httpmock.RESTPayload(200, `{ @@ -653,6 +663,9 @@ func Test_createRun(t *testing.T) { GenerateNotes: true, NotesStartTag: "v1.1.0", }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases/generate-notes"), httpmock.RESTPayload(200, `{ @@ -701,6 +714,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ @@ -758,6 +774,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(200, ``)) }, @@ -785,6 +804,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.StatusStringResponse(201, `{ @@ -819,6 +841,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.StatusStringResponse(201, `{ @@ -854,6 +879,9 @@ func Test_createRun(t *testing.T) { }, Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(200, ``)) }, @@ -882,6 +910,9 @@ func Test_createRun(t *testing.T) { DiscussionCategory: "general", Concurrency: 1, }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ @@ -922,87 +953,92 @@ func Test_createRun(t *testing.T) { wantStderr: ``, }, { - name: "with tag and --notes-from-tag", + name: "with generate notes from tag", isTTY: false, opts: CreateOptions{ - TagName: "v1.2.3", - Target: "", - Name: "", - Body: "", - BodyProvided: true, - Draft: false, - Prerelease: false, - RepoOverride: "", - Concurrency: 5, - Assets: []*shared.AssetForUpload(nil), - GenerateNotes: false, - NotesFromTag: true, + TagName: "v1.2.3", + BodyProvided: true, + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + NotesFromTag: true, + }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "some tag message") }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { - reg.Register(httpmock.GraphQL("RepositoryFindRef"), - httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": "tag id"}}}}`)) - reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.StatusStringResponse(201, `{ + reg.Register( + httpmock.GraphQL("RepositoryFindRef"), + httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": "tag id"}}}}`), + ) + reg.Register( + httpmock.REST("POST", "repos/OWNER/REPO/releases"), + httpmock.RESTPayload(201, `{ "url": "https://api.github.com/releases/123", "upload_url": "https://api.github.com/assets/upload", "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" - }`)) + }`, func(payload map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "tag_name": "v1.2.3", + "draft": false, + "prerelease": false, + "body": "some tag message", + }, payload) + })) }, wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n", wantStderr: "", }, { - name: "with tag and --notes-from-tag and --notes", + name: "with generate notes from tag and notes provided", isTTY: false, opts: CreateOptions{ - TagName: "v1.2.3", - Target: "", - Name: "", - Body: "Notes from --notes here", - BodyProvided: true, - Draft: false, - Prerelease: false, - RepoOverride: "", - Concurrency: 5, - Assets: []*shared.AssetForUpload(nil), - GenerateNotes: false, - NotesFromTag: true, + TagName: "v1.2.3", + Body: "some notes here", + BodyProvided: true, + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + NotesFromTag: true, + }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "some tag message") }, httpStubs: func(t *testing.T, reg *httpmock.Registry) { - reg.Register(httpmock.GraphQL("RepositoryFindRef"), - httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": "tag id"}}}}`)) - reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.StatusStringResponse(201, `{ - "url": "https://api.github.com/releases/123", - "upload_url": "https://api.github.com/assets/upload", - "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" - }`)) + reg.Register( + httpmock.GraphQL("RepositoryFindRef"), + httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": "tag id"}}}}`), + ) + reg.Register( + httpmock.REST("POST", "repos/OWNER/REPO/releases"), + httpmock.RESTPayload(201, `{ + "url": "https://api.github.com/releases/123", + "upload_url": "https://api.github.com/assets/upload", + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" + }`, func(payload map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "tag_name": "v1.2.3", + "draft": false, + "prerelease": false, + "body": "some notes here\nsome tag message", + }, payload) + })) }, wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n", wantStderr: "", }, { - name: "tag and --notes-from-tag but tag does not exist in repo", + name: "with generate notes from tag and tag does not exist", isTTY: false, opts: CreateOptions{ - TagName: "v1.2.4", - Target: "", - Name: "", - Body: "", - BodyProvided: true, - Draft: false, - Prerelease: false, - RepoOverride: "", - Concurrency: 5, - Assets: []*shared.AssetForUpload(nil), - GenerateNotes: false, - NotesFromTag: true, + TagName: "v1.2.3", + BodyProvided: true, + Concurrency: 5, + Assets: []*shared.AssetForUpload(nil), + NotesFromTag: true, }, - httpStubs: func(t *testing.T, reg *httpmock.Registry) { - reg.Register(httpmock.GraphQL("RepositoryFindRef"), - httpmock.StringResponse(`{"data":{"repository":{"ref": {"id": ""}}}}`)) + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") }, - wantStdout: "", - wantStderr: "", - wantErr: "tag v1.2.4 doesn't exist in the repo OWNER/REPO, cannot populate release notes with annotated git tag message using the `--notes-from-tag` flag", + wantErr: "cannot generate release notes from tag v1.2.3 as it does not exist locally", }, } for _, tt := range tests { @@ -1028,6 +1064,12 @@ func Test_createRun(t *testing.T) { tt.opts.GitClient = &git.Client{GitPath: "some/path/git"} + rs, teardown := run.Stub() + defer teardown(t) + if tt.runStubs != nil { + tt.runStubs(rs) + } + err := createRun(&tt.opts) if tt.wantErr != "" { require.EqualError(t, err, tt.wantErr) @@ -1571,34 +1613,34 @@ func Test_createRun_interactive(t *testing.T) { }, } for _, tt := range tests { - ios, _, stdout, stderr := iostreams.Test() - ios.SetStdoutTTY(true) - ios.SetStdinTTY(true) - ios.SetStderrTTY(true) - tt.opts.IO = ios - - reg := &httpmock.Registry{} - defer reg.Verify(t) - tt.httpStubs(reg) - tt.opts.HttpClient = func() (*http.Client, error) { - return &http.Client{Transport: reg}, nil - } - - tt.opts.BaseRepo = func() (ghrepo.Interface, error) { - return ghrepo.FromFullName("OWNER/REPO") - } - - tt.opts.Config = func() (config.Config, error) { - return config.NewBlankConfig(), nil - } - - tt.opts.Edit = func(_, _, val string, _ io.Reader, _, _ io.Writer) (string, error) { - return val, nil - } - - tt.opts.GitClient = &git.Client{GitPath: "some/path/git"} - t.Run(tt.name, func(t *testing.T) { + ios, _, stdout, stderr := iostreams.Test() + ios.SetStdoutTTY(true) + ios.SetStdinTTY(true) + ios.SetStderrTTY(true) + tt.opts.IO = ios + + reg := &httpmock.Registry{} + defer reg.Verify(t) + tt.httpStubs(reg) + tt.opts.HttpClient = func() (*http.Client, error) { + return &http.Client{Transport: reg}, nil + } + + tt.opts.BaseRepo = func() (ghrepo.Interface, error) { + return ghrepo.FromFullName("OWNER/REPO") + } + + tt.opts.Config = func() (config.Config, error) { + return config.NewBlankConfig(), nil + } + + tt.opts.Edit = func(_, _, val string, _ io.Reader, _, _ io.Writer) (string, error) { + return val, nil + } + + tt.opts.GitClient = &git.Client{GitPath: "some/path/git"} + pm := prompter.NewMockPrompter(t) if tt.prompterStubs != nil { tt.prompterStubs(t, pm) diff --git a/pkg/httpmock/stub.go b/pkg/httpmock/stub.go index 9332ac9dd..147d36fc8 100644 --- a/pkg/httpmock/stub.go +++ b/pkg/httpmock/stub.go @@ -181,6 +181,7 @@ func RESTPayload(responseStatus int, responseBody string, cb func(payload map[st return httpResponse(responseStatus, req, bytes.NewBufferString(responseBody)), nil } } + func GraphQLMutation(body string, cb func(map[string]interface{})) Responder { return func(req *http.Request) (*http.Response, error) { var bodyData struct { From 55b41d8fa68a57744812fe34e037f62ffa27de3a Mon Sep 17 00:00:00 2001 From: Arun Date: Tue, 19 Sep 2023 19:03:57 -0700 Subject: [PATCH 024/527] Introduce clear flag on 'project item-edit' command to remove field value --- pkg/cmd/project/item-edit/item_edit.go | 46 ++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index 3bd479470..c8f9b07a9 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -28,6 +28,7 @@ type editItemOpts struct { date string singleSelectOptionID string iterationID string + clear bool // format format string } @@ -50,6 +51,12 @@ type UpdateProjectV2FieldValue struct { } `graphql:"updateProjectV2ItemFieldValue(input:$input)"` } +type ClearProjectV2FieldValue struct { + Clear struct { + Item queries.ProjectItem `graphql:"projectV2Item"` + } `graphql:"clearProjectV2ItemFieldValue(input:$input)"` +} + func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) *cobra.Command { opts := editItemOpts{} editItemCmd := &cobra.Command{ @@ -108,6 +115,7 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) 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.Flags().BoolVar(&opts.clear, "clear", false, "Remove field value") _ = editItemCmd.MarkFlagRequired("id") @@ -115,6 +123,34 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) } func runEditItem(config editItemConfig) error { + // when clear flag is used, remove value set to the corresponding field ID + if config.opts.clear { + if config.opts.fieldID == "" && config.opts.projectID == "" { + return cmdutil.FlagErrorf("field-id and project-id must be provided for use with the clear flag") + } + if config.opts.fieldID == "" { + return cmdutil.FlagErrorf("field-id must be provided for use with the clear flag") + } + if config.opts.projectID == "" { + // TODO: offer to fetch interactively + return cmdutil.FlagErrorf("project-id must be provided for use with the clear flag") + } + if config.opts.text != "" || config.opts.number != 0 || config.opts.date != "" || config.opts.singleSelectOptionID != "" || config.opts.iterationID != "" { + return cmdutil.FlagErrorf("cannot use this flag in conjunction with clear") + } + query, variables := buildClearItem(config) + err := config.client.Mutate("ClearItemFieldValue", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printItemJSON(config, &query.Clear.Item) + } + + return printItemResults(config, &query.Clear.Item) + } + // update draft issue if config.opts.title != "" || config.opts.body != "" { if !strings.HasPrefix(config.opts.itemID, "DI_") { @@ -217,6 +253,16 @@ func buildUpdateItem(config editItemConfig, date time.Time) (*UpdateProjectV2Fie } } +func buildClearItem(config editItemConfig) (*ClearProjectV2FieldValue, map[string]interface{}) { + return &ClearProjectV2FieldValue{}, map[string]interface{}{ + "input": githubv4.ClearProjectV2ItemFieldValueInput{ + ProjectID: githubv4.ID(config.opts.projectID), + ItemID: githubv4.ID(config.opts.itemID), + FieldID: githubv4.ID(config.opts.fieldID), + }, + } +} + func printDraftIssueResults(config editItemConfig, item queries.DraftIssue) error { if !config.io.IsStdoutTTY() { return nil From dde84c27a3c5ee4d08ab5477db0a635a3318a64e Mon Sep 17 00:00:00 2001 From: Arun Date: Tue, 19 Sep 2023 19:04:43 -0700 Subject: [PATCH 025/527] Driveby unrelated update: when both field ID and project ID are missing, specify that it's necessary to update the field value --- pkg/cmd/project/item-edit/item_edit.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index c8f9b07a9..d76152b24 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -173,6 +173,9 @@ func runEditItem(config editItemConfig) error { // update item values if config.opts.text != "" || config.opts.number != 0 || config.opts.date != "" || config.opts.singleSelectOptionID != "" || config.opts.iterationID != "" { + if config.opts.fieldID == "" && config.opts.projectID == "" { + return cmdutil.FlagErrorf("field-id and project-id must be provided") + } if config.opts.fieldID == "" { return cmdutil.FlagErrorf("field-id must be provided") } From 31fd8dfc4538668a48b084270f67c27614b4a123 Mon Sep 17 00:00:00 2001 From: Arun Date: Tue, 19 Sep 2023 19:57:25 -0700 Subject: [PATCH 026/527] Tests for the new clear flag --- pkg/cmd/project/item-edit/item_edit_test.go | 59 +++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/pkg/cmd/project/item-edit/item_edit_test.go b/pkg/cmd/project/item-edit/item_edit_test.go index 5cdc69b87..f865d4ade 100644 --- a/pkg/cmd/project/item-edit/item_edit_test.go +++ b/pkg/cmd/project/item-edit/item_edit_test.go @@ -94,6 +94,16 @@ func TestNewCmdeditItem(t *testing.T) { itemID: "123", }, }, + { + name: "clear", + cli: "--id 123 --field-id FIELD_ID --project-id PROJECT_ID --clear", + wants: editItemOpts{ + itemID: "123", + fieldID: "FIELD_ID", + projectID: "PROJECT_ID", + clear: true, + }, + }, { name: "json", cli: "--format json --id 123", @@ -142,6 +152,7 @@ func TestNewCmdeditItem(t *testing.T) { assert.Equal(t, tt.wants.date, gotOpts.date) assert.Equal(t, tt.wants.singleSelectOptionID, gotOpts.singleSelectOptionID) assert.Equal(t, tt.wants.iterationID, gotOpts.iterationID) + assert.Equal(t, tt.wants.clear, gotOpts.clear) }) } } @@ -472,3 +483,51 @@ func TestRunItemEdit_InvalidID(t *testing.T) { err := runEditItem(config) assert.Error(t, err, "ID must be the ID of the draft issue content which is prefixed with `DI_`") } + +func TestRunItemEdit_Clear(t *testing.T) { + defer gock.Off() + // gock.Observe(gock.DumpRequest) + + gock.New("https://api.github.com"). + Post("/graphql"). + BodyString(`{"query":"mutation ClearItemFieldValue.*","variables":{"input":{"projectId":"project_id","itemId":"item_id","fieldId":"field_id"}}}`). + Reply(200). + JSON(map[string]interface{}{ + "data": map[string]interface{}{ + "clearProjectV2ItemFieldValue": 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{ + itemID: "item_id", + projectID: "project_id", + fieldID: "field_id", + clear: true, + }, + client: client, + } + + err := runEditItem(config) + assert.NoError(t, err) + assert.Equal(t, "Edited item \"title\"\n", stdout.String()) +} From c5a7bf8f45440488cc596b21ef396c6d02fa6692 Mon Sep 17 00:00:00 2001 From: Raj Hawaldar Date: Thu, 21 Sep 2023 12:13:27 +0530 Subject: [PATCH 027/527] Hint adding codespace scope to auth login (#7961) --- pkg/cmd/root/root.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/root/root.go b/pkg/cmd/root/root.go index 12884198e..353b9836a 100644 --- a/pkg/cmd/root/root.go +++ b/pkg/cmd/root/root.go @@ -72,7 +72,11 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, 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()) + if cmd.Parent().Use == "codespace" { + fmt.Fprintln(io.ErrOut, "To get started with GitHub CLI, please run: gh auth login -s codespace") + } else { + fmt.Fprint(io.ErrOut, authHelp()) + } return &AuthError{} } return nil From 9683b913636a6897024b2b7a907d19a0e563aead Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 21 Sep 2023 14:07:16 +0000 Subject: [PATCH 028/527] build(deps): bump mislav/bump-homebrew-formula-action from 2 to 3 Bumps [mislav/bump-homebrew-formula-action](https://github.com/mislav/bump-homebrew-formula-action) from 2 to 3. - [Release notes](https://github.com/mislav/bump-homebrew-formula-action/releases) - [Commits](https://github.com/mislav/bump-homebrew-formula-action/compare/v2...v3) --- updated-dependencies: - dependency-name: mislav/bump-homebrew-formula-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- .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 dfec56462..24d89c83b 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -336,7 +336,7 @@ jobs: git diff --name-status @{upstream}.. fi - name: Bump homebrew-core formula - uses: mislav/bump-homebrew-formula-action@v2 + uses: mislav/bump-homebrew-formula-action@v3 if: inputs.environment == 'production' && !contains(inputs.tag_name, '-') with: formula-name: gh From 564d07ce00f28635b597422f23affb3b8f5f6221 Mon Sep 17 00:00:00 2001 From: Benoit Pierre Date: Thu, 21 Sep 2023 14:18:26 +0200 Subject: [PATCH 029/527] cache/delete: percent-encode keys --- pkg/cmd/cache/delete/delete.go | 3 ++- pkg/cmd/cache/delete/delete_test.go | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/cache/delete/delete.go b/pkg/cmd/cache/delete/delete.go index c6d0672f8..9a0783eb6 100644 --- a/pkg/cmd/cache/delete/delete.go +++ b/pkg/cmd/cache/delete/delete.go @@ -4,6 +4,7 @@ import ( "errors" "fmt" "net/http" + "net/url" "strconv" "github.com/MakeNowJust/heredoc" @@ -127,7 +128,7 @@ func deleteCaches(opts *DeleteOptions, client *api.Client, repo ghrepo.Interface if id, err := strconv.Atoi(cache); err == nil { path = fmt.Sprintf("%s/%d", base, id) } else { - path = fmt.Sprintf("%s?key=%s", base, cache) + path = fmt.Sprintf("%s?key=%s", base, url.QueryEscape(cache)) } err := client.REST(repo.RepoHost(), "DELETE", path, nil, nil) diff --git a/pkg/cmd/cache/delete/delete_test.go b/pkg/cmd/cache/delete/delete_test.go index d6cd4ac56..43fc7d213 100644 --- a/pkg/cmd/cache/delete/delete_test.go +++ b/pkg/cmd/cache/delete/delete_test.go @@ -3,6 +3,7 @@ package delete import ( "bytes" "net/http" + "net/url" "testing" "time" @@ -171,6 +172,20 @@ func TestDeleteRun(t *testing.T) { wantErr: true, wantErrMsg: "X Failed to delete cache: HTTP 500 (https://api.github.com/repos/OWNER/REPO/actions/caches/123)", }, + { + name: "keys must be percent-encoded before being used as query params", + opts: DeleteOptions{Identifier: "a weird＿cache+key"}, + stubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.QueryMatcher("DELETE", "repos/OWNER/REPO/actions/caches", url.Values{ + "key": []string{"a weird＿cache+key"}, + }), + httpmock.StatusStringResponse(204, ""), + ) + }, + tty: true, + wantStdout: "✓ Deleted 1 cache from OWNER/REPO\n", + }, } for _, tt := range tests { From 9ef7a5f26230c0d97b91b207f8f245b7c61c60b5 Mon Sep 17 00:00:00 2001 From: Natsuki Ikeguchi Date: Sun, 24 Sep 2023 02:51:56 +0900 Subject: [PATCH 030/527] test: Add unit test for cache.ExportData --- pkg/cmd/cache/shared/shared_test.go | 79 ++++++++++++++++++++++++++++- 1 file changed, 78 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/cache/shared/shared_test.go b/pkg/cmd/cache/shared/shared_test.go index 2b64fed28..b9afc3e6b 100644 --- a/pkg/cmd/cache/shared/shared_test.go +++ b/pkg/cmd/cache/shared/shared_test.go @@ -1,13 +1,19 @@ package shared import ( + "bytes" + "encoding/json" "net/http" + "strings" "testing" + "github.com/MakeNowJust/heredoc" + "github.com/stretchr/testify/assert" + "github.com/stretchr/testify/require" + "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/pkg/httpmock" - "github.com/stretchr/testify/assert" ) func TestGetCaches(t *testing.T) { @@ -66,3 +72,74 @@ func TestGetCaches(t *testing.T) { }) } } + +func TestCache_ExportData(t *testing.T) { + src := heredoc.Doc( + ` + { + "id": 505, + "ref": "refs/heads/main", + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0", + "last_accessed_at": "2019-01-24T22:45:36.000Z", + "created_at": "2019-01-24T22:45:36.000Z", + "size_in_bytes": 1024 + } + `, + ) + + tests := []struct { + name string + fields []string + inputJSON string + outputJSON string + }{ + { + name: "basic", + fields: []string{"id", "key"}, + inputJSON: src, + outputJSON: heredoc.Doc( + ` + { + "id": 505, + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b" + } + `, + ), + }, + { + name: "full", + fields: []string{"id", "ref", "key", "version", "lastAccessedAt", "createdAt", "sizeInBytes"}, + inputJSON: src, + outputJSON: heredoc.Doc( + ` + { + "createdAt": "2019-01-24T22:45:36Z", + "id": 505, + "key": "Linux-node-958aff96db2d75d67787d1e634ae70b659de937b", + "lastAccessedAt": "2019-01-24T22:45:36Z", + "ref": "refs/heads/main", + "sizeInBytes": 1024, + "version": "73885106f58cc52a7df9ec4d4a5622a5614813162cb516c759a30af6bf56e6f0" + } + `, + ), + }, + } + + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + var cache Cache + dec := json.NewDecoder(strings.NewReader(tt.inputJSON)) + require.NoError(t, dec.Decode(&cache)) + + exported := cache.ExportData(tt.fields) + + buf := bytes.Buffer{} + enc := json.NewEncoder(&buf) + enc.SetIndent("", "\t") + require.NoError(t, enc.Encode(exported)) + assert.Equal(t, tt.outputJSON, buf.String()) + }) + } +} From 073ec3426be4e36fbd125d65f8a6aa76510eb85c Mon Sep 17 00:00:00 2001 From: Heath Stewart Date: Sun, 24 Sep 2023 09:22:55 -0700 Subject: [PATCH 031/527] Return HTTP errors properly for some commands (#8037) * Return HTTP error for `run watch` Partially fixes #8026 * Return HTTP error for `gpg-key delete` Partially fixes #8026 --- pkg/cmd/gpg-key/delete/delete.go | 2 +- pkg/cmd/gpg-key/delete/delete_test.go | 14 ++++++++++++++ pkg/cmd/run/watch/watch.go | 2 +- pkg/cmd/run/watch/watch_test.go | 28 +++++++++++++++++++++++++++ 4 files changed, 44 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/gpg-key/delete/delete.go b/pkg/cmd/gpg-key/delete/delete.go index 0f152297a..f86957bdb 100644 --- a/pkg/cmd/gpg-key/delete/delete.go +++ b/pkg/cmd/gpg-key/delete/delete.go @@ -91,7 +91,7 @@ func deleteRun(opts *DeleteOptions) error { err = deleteGPGKey(httpClient, host, id) if err != nil { - return nil + return err } if opts.IO.IsStdoutTTY() { diff --git a/pkg/cmd/gpg-key/delete/delete_test.go b/pkg/cmd/gpg-key/delete/delete_test.go index a7f0fda67..c9c29aa3c 100644 --- a/pkg/cmd/gpg-key/delete/delete_test.go +++ b/pkg/cmd/gpg-key/delete/delete_test.go @@ -10,6 +10,7 @@ import ( "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/go-gh/v2/pkg/api" "github.com/google/shlex" "github.com/stretchr/testify/assert" ) @@ -170,6 +171,19 @@ func Test_deleteRun(t *testing.T) { wantErr: true, wantErrMsg: "unable to delete GPG key ABC123: either the GPG key is not found or it is not owned by you", }, + { + name: "delete failed", + opts: DeleteOptions{KeyID: "ABC123", Confirmed: true}, + httpStubs: func(reg *httpmock.Registry) { + reg.Register(httpmock.REST("GET", "user/gpg_keys"), httpmock.StatusStringResponse(200, keysResp)) + reg.Register(httpmock.REST("DELETE", "user/gpg_keys/123"), httpmock.StatusJSONResponse(404, api.HTTPError{ + StatusCode: 404, + Message: "GPG key 123 not found", + })) + }, + wantErr: true, + wantErrMsg: "HTTP 404: GPG key 123 not found (https://api.github.com/user/gpg_keys/123)", + }, } for _, tt := range tests { diff --git a/pkg/cmd/run/watch/watch.go b/pkg/cmd/run/watch/watch.go index 090737557..48d50ed57 100644 --- a/pkg/cmd/run/watch/watch.go +++ b/pkg/cmd/run/watch/watch.go @@ -173,7 +173,7 @@ func watchRun(opts *WatchOptions) error { opts.IO.StopAlternateScreenBuffer() if err != nil { - return nil + return err } // Write the last temporary buffer one last time diff --git a/pkg/cmd/run/watch/watch_test.go b/pkg/cmd/run/watch/watch_test.go index 8ff77516b..a73fd2949 100644 --- a/pkg/cmd/run/watch/watch_test.go +++ b/pkg/cmd/run/watch/watch_test.go @@ -14,6 +14,7 @@ import ( "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/httpmock" "github.com/cli/cli/v2/pkg/iostreams" + "github.com/cli/go-gh/v2/pkg/api" "github.com/google/shlex" "github.com/stretchr/testify/assert" ) @@ -298,6 +299,33 @@ func TestWatchRun(t *testing.T) { wantErr: true, errMsg: "SilentError", }, + { + name: "failed to get run status", + tty: true, + opts: &WatchOptions{ + RunID: "1234", + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"), + httpmock.JSONResponse(shared.TestRunWithCommit(1234, shared.InProgress, "", "commit2")), + ) + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), + httpmock.JSONResponse(shared.TestWorkflow), + ) + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"), + httpmock.StatusJSONResponse(404, api.HTTPError{ + StatusCode: 404, + Message: "run 1234 not found", + }), + ) + }, + wantOut: "\x1b[?1049h\x1b[?1049l", + wantErr: true, + errMsg: "failed to get run: HTTP 404: run 1234 not found (https://api.github.com/repos/OWNER/REPO/actions/runs/1234?exclude_pull_requests=true)", + }, } for _, tt := range tests { From decbbd21654a061d8a9c8ea1e200fbeb3da2d028 Mon Sep 17 00:00:00 2001 From: Raj Hawaldar Date: Sun, 24 Sep 2023 21:57:01 +0530 Subject: [PATCH 032/527] Show cancelled checks (#7960) --- pkg/cmd/pr/checks/aggregate.go | 6 ++- pkg/cmd/pr/checks/checks_test.go | 36 ++++++++++----- pkg/cmd/pr/checks/fixtures/someCancelled.json | 45 +++++++++++++++++++ pkg/cmd/pr/checks/fixtures/somePending.json | 8 ++++ pkg/cmd/pr/checks/output.go | 14 ++++-- 5 files changed, 92 insertions(+), 17 deletions(-) create mode 100644 pkg/cmd/pr/checks/fixtures/someCancelled.json diff --git a/pkg/cmd/pr/checks/aggregate.go b/pkg/cmd/pr/checks/aggregate.go index f9f0b73cb..40e34e79a 100644 --- a/pkg/cmd/pr/checks/aggregate.go +++ b/pkg/cmd/pr/checks/aggregate.go @@ -25,6 +25,7 @@ type checkCounts struct { Passed int Pending int Skipping int + Canceled int } func aggregateChecks(checkContexts []api.CheckContext, requiredChecks bool) (checks []check, counts checkCounts) { @@ -70,9 +71,12 @@ func aggregateChecks(checkContexts []api.CheckContext, requiredChecks bool) (che case "SKIPPED", "NEUTRAL": item.Bucket = "skipping" counts.Skipping++ - case "ERROR", "FAILURE", "CANCELLED", "TIMED_OUT", "ACTION_REQUIRED": + case "ERROR", "FAILURE", "TIMED_OUT", "ACTION_REQUIRED": item.Bucket = "fail" counts.Failed++ + case "CANCELLED": + item.Bucket = "cancel" + counts.Canceled++ default: // "EXPECTED", "REQUESTED", "WAITING", "QUEUED", "PENDING", "IN_PROGRESS", "STALE" item.Bucket = "pending" counts.Pending++ diff --git a/pkg/cmd/pr/checks/checks_test.go b/pkg/cmd/pr/checks/checks_test.go index 06377e516..dcab36117 100644 --- a/pkg/cmd/pr/checks/checks_test.go +++ b/pkg/cmd/pr/checks/checks_test.go @@ -167,9 +167,21 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someFailing.json"), ) }, - wantOut: "Some checks were not successful\n1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", + wantOut: "Some checks were not successful\n0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", wantErr: "SilentError", }, + { + name: "some cancelled tty", + tty: true, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL(`query PullRequestStatusChecks\b`), + httpmock.FileResponse("./fixtures/someCancelled.json"), + ) + }, + wantOut: "Some checks were cancelled\n1 cancelled, 0 failing, 2 successful, 0 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n- sad tests 1m26s sweet link\n✓ awesome tests 1m26s sweet link\n", + wantErr: "", + }, { name: "some pending tty", tty: true, @@ -179,7 +191,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/somePending.json"), ) }, - wantOut: "Some checks are still pending\n0 failing, 2 successful, 0 skipped, and 1 pending checks\n\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", + wantOut: "Some checks are still pending\n1 cancelled, 0 failing, 2 successful, 0 skipped, and 1 pending checks\n\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n* slow tests 1m26s sweet link\n- sad tests 1m26s sweet link\n", wantErr: "PendingError", }, { @@ -191,7 +203,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/allPassing.json"), ) }, - wantOut: "All checks were successful\n0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: "All checks were successful\n0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", wantErr: "", }, { @@ -204,7 +216,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/allPassing.json"), ) }, - wantOut: "\x1b[?1049hAll checks were successful\n0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n\x1b[?1049lAll checks were successful\n0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: "\x1b[?1049hAll checks were successful\n0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n\x1b[?1049lAll checks were successful\n0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", wantErr: "", }, { @@ -218,7 +230,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someFailing.json"), ) }, - wantOut: "\x1b[?1049h\x1b[0;0H\x1b[JRefreshing checks status every 0 seconds. Press Ctrl+C to quit.\n\nSome checks were not successful\n1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n\x1b[?1049lSome checks were not successful\n1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", + wantOut: "\x1b[?1049h\x1b[0;0H\x1b[JRefreshing checks status every 0 seconds. Press Ctrl+C to quit.\n\nSome checks were not successful\n0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n\x1b[?1049lSome checks were not successful\n0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", wantErr: "SilentError", }, { @@ -230,7 +242,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withStatuses.json"), ) }, - wantOut: "Some checks were not successful\n1 failing, 2 successful, 0 skipped, and 0 pending checks\n\nX a status sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: "Some checks were not successful\n0 cancelled, 1 failing, 2 successful, 0 skipped, and 0 pending checks\n\nX a status sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", wantErr: "SilentError", }, { @@ -274,7 +286,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/somePending.json"), ) }, - wantOut: "cool tests\tpass\t1m26s\tsweet link\t\nrad tests\tpass\t1m26s\tsweet link\t\nslow tests\tpending\t1m26s\tsweet link\t\n", + wantOut: "cool tests\tpass\t1m26s\tsweet link\t\nrad tests\tpass\t1m26s\tsweet link\t\nslow tests\tpending\t1m26s\tsweet link\t\nsad tests\tfail\t1m26s\tsweet link\t\n", wantErr: "PendingError", }, { @@ -308,7 +320,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someSkipping.json"), ) }, - wantOut: "All checks were successful\n0 failing, 1 successful, 2 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n- rad tests 1m26s sweet link\n- skip tests 1m26s sweet link\n", + wantOut: "All checks were successful\n0 cancelled, 0 failing, 1 successful, 2 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n- rad tests 1m26s sweet link\n- skip tests 1m26s sweet link\n", wantErr: "", }, { @@ -332,7 +344,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/onlyRequired.json"), ) }, - wantOut: "All checks were successful\n0 failing, 1 successful, 0 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n", + wantOut: "All checks were successful\n0 cancelled, 0 failing, 1 successful, 0 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n", wantErr: "", }, { @@ -381,7 +393,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withDescriptions.json"), ) }, - wantOut: "All checks were successful\n0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests awesome description 1m26s sweet link\n✓ cool tests cool description 1m26s sweet link\n✓ rad tests rad description 1m26s sweet link\n", + wantOut: "All checks were successful\n0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests awesome description 1m26s sweet link\n✓ cool tests cool description 1m26s sweet link\n✓ rad tests rad description 1m26s sweet link\n", wantErr: "", }, { @@ -404,7 +416,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withEvents.json"), ) }, - wantOut: "All checks were successful\n0 failing, 2 successful, 0 skipped, and 0 pending checks\n\n✓ tests/cool tests (pull_request) cool description 1m26s sweet link\n✓ tests/cool tests (push) cool description 1m26s sweet link\n", + wantOut: "All checks were successful\n0 cancelled, 0 failing, 2 successful, 0 skipped, and 0 pending checks\n\n✓ tests/cool tests (pull_request) cool description 1m26s sweet link\n✓ tests/cool tests (push) cool description 1m26s sweet link\n", wantErr: "", }, { @@ -417,7 +429,7 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withoutEvents.json"), ) }, - wantOut: "All checks were successful\n0 failing, 1 successful, 0 skipped, and 0 pending checks\n\n✓ tests/cool tests cool description 1m26s sweet link\n", + wantOut: "All checks were successful\n0 cancelled, 0 failing, 1 successful, 0 skipped, and 0 pending checks\n\n✓ tests/cool tests cool description 1m26s sweet link\n", wantErr: "", }, { diff --git a/pkg/cmd/pr/checks/fixtures/someCancelled.json b/pkg/cmd/pr/checks/fixtures/someCancelled.json new file mode 100644 index 000000000..5e321a5f3 --- /dev/null +++ b/pkg/cmd/pr/checks/fixtures/someCancelled.json @@ -0,0 +1,45 @@ +{ + "data": { + "node": { + "statusCheckRollup": { + "nodes": [ + { + "commit": { + "oid": "abc", + "statusCheckRollup": { + "contexts": { + "nodes": [ + { + "conclusion": "SUCCESS", + "status": "COMPLETED", + "name": "cool tests", + "completedAt": "2020-08-27T19:00:12Z", + "startedAt": "2020-08-27T18:58:46Z", + "detailsUrl": "sweet link" + }, + { + "conclusion": "CANCELLED", + "status": "COMPLETED", + "name": "sad tests", + "completedAt": "2020-08-27T19:00:12Z", + "startedAt": "2020-08-27T18:58:46Z", + "detailsUrl": "sweet link" + }, + { + "conclusion": "SUCCESS", + "status": "COMPLETED", + "name": "awesome tests", + "completedAt": "2020-08-27T19:00:12Z", + "startedAt": "2020-08-27T18:58:46Z", + "detailsUrl": "sweet link" + } + ] + } + } + } + } + ] + } + } + } +} diff --git a/pkg/cmd/pr/checks/fixtures/somePending.json b/pkg/cmd/pr/checks/fixtures/somePending.json index a96ea4fda..c10cb2f84 100644 --- a/pkg/cmd/pr/checks/fixtures/somePending.json +++ b/pkg/cmd/pr/checks/fixtures/somePending.json @@ -32,6 +32,14 @@ "completedAt": "2020-08-27T19:00:12Z", "startedAt": "2020-08-27T18:58:46Z", "detailsUrl": "sweet link" + }, + { + "conclusion": "CANCELLED", + "status": "COMPLETED", + "name": "sad tests", + "completedAt": "2020-08-27T19:00:12Z", + "startedAt": "2020-08-27T18:58:46Z", + "detailsUrl": "sweet link" } ] } diff --git a/pkg/cmd/pr/checks/output.go b/pkg/cmd/pr/checks/output.go index a1e3f889a..9efee29cf 100644 --- a/pkg/cmd/pr/checks/output.go +++ b/pkg/cmd/pr/checks/output.go @@ -28,7 +28,7 @@ func addRow(tp *tableprinter.TablePrinter, io *iostreams.IOStreams, o check) { case "pending": mark = "*" markColor = cs.Yellow - case "skipping": + case "skipping", "cancel": mark = "-" markColor = cs.Gray } @@ -49,7 +49,11 @@ func addRow(tp *tableprinter.TablePrinter, io *iostreams.IOStreams, o check) { tp.AddField(o.Link) } else { tp.AddField(o.Name) - tp.AddField(o.Bucket) + if o.Bucket == "cancel" { + tp.AddField("fail") + } else { + tp.AddField(o.Bucket) + } if elapsed == "" { tp.AddField("0") } else { @@ -69,12 +73,14 @@ func printSummary(io *iostreams.IOStreams, counts checkCounts) { summary = "Some checks were not successful" } else if counts.Pending > 0 { summary = "Some checks are still pending" + } else if counts.Canceled > 0 { + summary = "Some checks were cancelled" } else { summary = "All checks were successful" } - tallies := fmt.Sprintf("%d failing, %d successful, %d skipped, and %d pending checks", - counts.Failed, counts.Passed, counts.Skipping, counts.Pending) + tallies := fmt.Sprintf("%d cancelled, %d failing, %d successful, %d skipped, and %d pending checks", + counts.Canceled, counts.Failed, counts.Passed, counts.Skipping, counts.Pending) summary = fmt.Sprintf("%s\n%s", io.ColorScheme().Bold(summary), tallies) } From 756d9a07d0fea897b945cb200d74ab940402d403 Mon Sep 17 00:00:00 2001 From: Peter Admilson Ramaldes Date: Mon, 25 Sep 2023 07:26:33 -0300 Subject: [PATCH 033/527] docs: update the flag `--fill` docs The `--title` and/or `--body` could be overwritten when use `--fill` togheter, so, this change makes this behavior more evident --- pkg/cmd/pr/create/create.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index 7321d4f38..ad1a954cb 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -193,8 +193,8 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co fl.StringVarP(&opts.BaseBranch, "base", "B", "", "The `branch` into which you want your code merged") fl.StringVarP(&opts.HeadBranch, "head", "H", "", "The `branch` that contains commits for your pull request (default: current branch)") fl.BoolVarP(&opts.WebMode, "web", "w", false, "Open the web browser to create a pull request") - fl.BoolVarP(&opts.Autofill, "fill", "f", false, "Do not prompt for title/body and just use commit info") - fl.BoolVar(&opts.FillFirst, "fill-first", false, "Do not prompt for title/body and just use first commit info") + fl.BoolVarP(&opts.Autofill, "fill", "f", false, "Do not prompt for title/body and just use commit info (could be overwritten by --title and/or --body)") + fl.BoolVar(&opts.FillFirst, "fill-first", false, "Do not prompt for title/body and just use first commit info (could be overwritten by --title and/or --body)") fl.StringSliceVarP(&opts.Reviewers, "reviewer", "r", nil, "Request reviews from people or teams by their `handle`") fl.StringSliceVarP(&opts.Assignees, "assignee", "a", nil, "Assign people by their `login`. Use \"@me\" to self-assign.") fl.StringSliceVarP(&opts.Labels, "label", "l", nil, "Add labels by `name`") From 965eabd503c6e43278101b13999496a43fb0f820 Mon Sep 17 00:00:00 2001 From: rajhawaldar Date: Mon, 25 Sep 2023 21:35:47 +0530 Subject: [PATCH 034/527] Support standard output format flags for secret and deploy-key list Signed-off-by: rajhawaldar --- pkg/cmd/repo/deploy-key/list/http.go | 6 +++--- pkg/cmd/repo/deploy-key/list/list.go | 15 ++++++++++++++- pkg/cmd/secret/list/list.go | 25 +++++++++++++++++++------ 3 files changed, 36 insertions(+), 10 deletions(-) diff --git a/pkg/cmd/repo/deploy-key/list/http.go b/pkg/cmd/repo/deploy-key/list/http.go index 2be4436bc..4470cec04 100644 --- a/pkg/cmd/repo/deploy-key/list/http.go +++ b/pkg/cmd/repo/deploy-key/list/http.go @@ -13,9 +13,9 @@ import ( ) type deployKey struct { - ID int - Key string - Title string + ID int `json:"id"` + Key string `json:"key"` + Title string `json:"title"` CreatedAt time.Time `json:"created_at"` ReadOnly bool `json:"read_only"` } diff --git a/pkg/cmd/repo/deploy-key/list/list.go b/pkg/cmd/repo/deploy-key/list/list.go index 9504b3725..11623a679 100644 --- a/pkg/cmd/repo/deploy-key/list/list.go +++ b/pkg/cmd/repo/deploy-key/list/list.go @@ -18,6 +18,15 @@ type ListOptions struct { IO *iostreams.IOStreams HTTPClient func() (*http.Client, error) BaseRepo func() (ghrepo.Interface, error) + Exporter cmdutil.Exporter +} + +var deployKeyFields = []string{ + "id", + "key", + "title", + "created_at", + "read_only", } func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command { @@ -40,7 +49,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman return listRun(opts) }, } - + cmdutil.AddJSONFlags(cmd, &opts.Exporter, deployKeyFields) return cmd } @@ -64,6 +73,10 @@ func listRun(opts *ListOptions) error { return cmdutil.NewNoResultsError(fmt.Sprintf("no deploy keys found in %s", ghrepo.FullName(repo))) } + if opts.Exporter != nil { + return opts.Exporter.Write(opts.IO, deployKeys) + } + //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter t := utils.NewTablePrinter(opts.IO) cs := opts.IO.ColorScheme() diff --git a/pkg/cmd/secret/list/list.go b/pkg/cmd/secret/list/list.go index 965466b67..b2b01834e 100644 --- a/pkg/cmd/secret/list/list.go +++ b/pkg/cmd/secret/list/list.go @@ -23,6 +23,7 @@ type ListOptions struct { Config func() (config.Config, error) BaseRepo func() (ghrepo.Interface, error) Now func() time.Time + Exporter cmdutil.Exporter OrgName string EnvName string @@ -30,6 +31,14 @@ type ListOptions struct { Application string } +var secretFields = []string{ + "selected_repos_url", + "name", + "visibility", + "updated_at", + "num_selected_repos", +} + func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command { opts := &ListOptions{ IO: f.IOStreams, @@ -70,7 +79,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman cmd.Flags().StringVarP(&opts.EnvName, "env", "e", "", "List secrets for an environment") cmd.Flags().BoolVarP(&opts.UserSecrets, "user", "u", false, "List a secret for your user") cmdutil.StringEnumFlag(cmd, &opts.Application, "app", "a", "", []string{shared.Actions, shared.Codespaces, shared.Dependabot}, "List secrets for a specific application") - + cmdutil.AddJSONFlags(cmd, &opts.Exporter, secretFields) return cmd } @@ -145,6 +154,10 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err) } + if opts.Exporter != nil { + return opts.Exporter.Write(opts.IO, secrets) + } + table := tableprinter.New(opts.IO) if secretEntity == shared.Organization || secretEntity == shared.User { table.HeaderRow("Name", "Updated", "Visibility") @@ -173,11 +186,11 @@ func listRun(opts *ListOptions) error { } type Secret struct { - Name string - UpdatedAt time.Time `json:"updated_at"` - Visibility shared.Visibility - SelectedReposURL string `json:"selected_repositories_url"` - NumSelectedRepos int + Name string `json:"name"` + UpdatedAt time.Time `json:"updated_at"` + Visibility shared.Visibility `json:"visibility"` + SelectedReposURL string `json:"selected_repositories_url"` + NumSelectedRepos int `json:"num_selected_repos"` } func fmtVisibility(s Secret) string { From 8c2fd37bec4c565bdbc5b77ed5eadf9f7865e634 Mon Sep 17 00:00:00 2001 From: Andy Feller Date: Mon, 25 Sep 2023 13:55:33 -0400 Subject: [PATCH 035/527] Update triage.md Adding link to triage document for ease of reviewing incoming / open issues. --- docs/triage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/triage.md b/docs/triage.md index da69c892e..ae9b0c15c 100644 --- a/docs/triage.md +++ b/docs/triage.md @@ -6,7 +6,7 @@ triage role. The initial expectation is that the person in the role for the week ## Expectations for incoming issues -All incoming issues need either an `enhancement`, `bug`, or `docs` label. +Review and label [open issues missing either the `enhancement`, `bug`, or `docs` label](https://github.com/cli/cli/issues?q=is%3Aopen+is%3Aissue+-label%3Abug%2Cenhancement%2Cdocs+). To be considered triaged, `enhancement` issues require at least one of the following additional labels: From e059f32aa5d38f2e472d1f4287c27de8b097b080 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 19 Sep 2023 13:36:06 -0700 Subject: [PATCH 036/527] Forward codespace ports over Dev Tunnels --- go.mod | 2 + go.sum | 4 + internal/codespaces/api/api.go | 35 +- internal/codespaces/codespaces.go | 83 +++- internal/codespaces/connection/connection.go | 116 +++++ .../codespaces/connection/connection_test.go | 75 ++++ .../connection/tunnels_api_server_mock.go | 396 ++++++++++++++++++ .../portforwarder/port_forwarder.go | 253 +++++++++++ .../portforwarder/port_forwarder_test.go | 139 ++++++ pkg/cmd/codespace/common.go | 2 + pkg/cmd/codespace/mock_api.go | 112 +++-- pkg/cmd/codespace/ports.go | 141 +++---- pkg/cmd/codespace/ports_test.go | 216 +++------- 13 files changed, 1271 insertions(+), 303 deletions(-) create mode 100644 internal/codespaces/connection/connection.go create mode 100644 internal/codespaces/connection/connection_test.go create mode 100644 internal/codespaces/connection/tunnels_api_server_mock.go create mode 100644 internal/codespaces/portforwarder/port_forwarder.go create mode 100644 internal/codespaces/portforwarder/port_forwarder_test.go diff --git a/go.mod b/go.mod index 4a97a0e94..376480ecc 100644 --- a/go.mod +++ b/go.mod @@ -27,6 +27,7 @@ require ( github.com/mattn/go-colorable v0.1.13 github.com/mattn/go-isatty v0.0.19 github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d + github.com/microsoft/dev-tunnels v0.0.21 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 @@ -75,6 +76,7 @@ require ( github.com/olekukonko/tablewriter v0.0.5 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect github.com/rivo/uniseg v0.4.4 // indirect + github.com/rodaine/table v1.0.1 // indirect github.com/russross/blackfriday/v2 v2.1.0 // indirect github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466 // indirect github.com/stretchr/objx v0.5.0 // indirect diff --git a/go.sum b/go.sum index e2996530f..a6c982abb 100644 --- a/go.sum +++ b/go.sum @@ -117,6 +117,8 @@ github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d h1:5PJl274Y63IEHC+7izoQ github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE= github.com/microcosm-cc/bluemonday v1.0.21 h1:dNH3e4PSyE4vNX+KlRGHT5KrSvjeUkoNPwEORjffHJg= github.com/microcosm-cc/bluemonday v1.0.21/go.mod h1:ytNkv4RrDrLJ2pqlsSI46O6IVXmZOBBD4SaJyDwwTkM= +github.com/microsoft/dev-tunnels v0.0.21 h1:p4QP7C5ZOyP9bGbmanRjPxUMckfi9Z41Gl+KY4C11w0= +github.com/microsoft/dev-tunnels v0.0.21/go.mod h1:frU++12T/oqxckXkDpTuYa427ncguEOodSPZcGCCrzQ= github.com/muesli/reflow v0.2.1-0.20210115123740-9e1d0d53df68/go.mod h1:Xk+z4oIWdQqJzsxyjgl3P22oYZnHdZ8FFTHAQQt5BMQ= github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s= github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8= @@ -139,6 +141,8 @@ github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJ github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis= github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= +github.com/rodaine/table v1.0.1 h1:U/VwCnUxlVYxw8+NJiLIuCxA/xa6jL38MY3FYysVWWQ= +github.com/rodaine/table v1.0.1/go.mod h1:UVEtfBsflpeEcD56nF4F5AocNFta0ZuolpSVdPtlmP4= 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-20230704064427-599ae7bbf278 h1:kdEGVAV4sO46DPtb8k793jiecUEhaX9ixoIBt41HEGU= diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index d6b21c304..dd2ba4033 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -201,6 +201,7 @@ type Codespace struct { GitStatus CodespaceGitStatus `json:"git_status"` Connection CodespaceConnection `json:"connection"` Machine CodespaceMachine `json:"machine"` + RuntimeConstraints RuntimeConstraints `json:"runtime_constraints"` VSCSTarget string `json:"vscs_target"` PendingOperation bool `json:"pending_operation"` PendingOperationDisabledReason string `json:"pending_operation_disabled_reason"` @@ -246,11 +247,25 @@ const ( ) type CodespaceConnection struct { - SessionID string `json:"sessionId"` - SessionToken string `json:"sessionToken"` - RelayEndpoint string `json:"relayEndpoint"` - RelaySAS string `json:"relaySas"` - HostPublicKeys []string `json:"hostPublicKeys"` + SessionID string `json:"sessionId"` + SessionToken string `json:"sessionToken"` + RelayEndpoint string `json:"relayEndpoint"` + RelaySAS string `json:"relaySas"` + HostPublicKeys []string `json:"hostPublicKeys"` + TunnelProperties TunnelProperties `json:"tunnelProperties"` +} + +type TunnelProperties struct { + ConnectAccessToken string `json:"connectAccessToken"` + ManagePortsAccessToken string `json:"managePortsAccessToken"` + ServiceUri string `json:"serviceUri"` + TunnelId string `json:"tunnelId"` + ClusterId string `json:"clusterId"` + Domain string `json:"domain"` +} + +type RuntimeConstraints struct { + AllowedPortPrivacySettings []string `json:"allowed_port_privacy_settings"` } // ListCodespaceFields is the list of exportable fields for a codespace when using the `gh cs list` command. @@ -1162,3 +1177,13 @@ func (a *API) withRetry(f func() (*http.Response, error)) (*http.Response, error return nil, fmt.Errorf("received response with status code %d", resp.StatusCode) }, backoff.WithMaxRetries(bo, 3)) } + +// HTTPClient returns the HTTP client used to make requests to the API. +func (a *API) HTTPClient() (*http.Client, error) { + httpClient, err := a.client() + if err != nil { + return nil, err + } + + return httpClient, nil +} diff --git a/internal/codespaces/codespaces.go b/internal/codespaces/codespaces.go index 8834f0e6c..3bcc2b404 100644 --- a/internal/codespaces/codespaces.go +++ b/internal/codespaces/codespaces.go @@ -5,24 +5,42 @@ import ( "errors" "fmt" "net" + "net/http" "time" "github.com/cenkalti/backoff/v4" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/connection" "github.com/cli/cli/v2/pkg/liveshare" ) -func connectionReady(codespace *api.Codespace) bool { +func connectionReady(codespace *api.Codespace, usingDevTunnels bool) bool { + // If the codespace is not available, it is not ready + if codespace.State != api.CodespaceStateAvailable { + return false + } + + // If using Dev Tunnels, we need to check that we have all of the required tunnel properties + if usingDevTunnels { + return codespace.Connection.TunnelProperties.ConnectAccessToken != "" && + codespace.Connection.TunnelProperties.ManagePortsAccessToken != "" && + codespace.Connection.TunnelProperties.ServiceUri != "" && + codespace.Connection.TunnelProperties.TunnelId != "" && + codespace.Connection.TunnelProperties.ClusterId != "" && + codespace.Connection.TunnelProperties.Domain != "" + } + + // If not using Dev Tunnels, we need to check that we have all of the required Live Share properties return codespace.Connection.SessionID != "" && codespace.Connection.SessionToken != "" && codespace.Connection.RelayEndpoint != "" && - codespace.Connection.RelaySAS != "" && - codespace.State == api.CodespaceStateAvailable + codespace.Connection.RelaySAS != "" } type apiClient interface { GetCodespace(ctx context.Context, name string, includeConnection bool) (*api.Codespace, error) StartCodespace(ctx context.Context, name string) error + HTTPClient() (*http.Client, error) } type progressIndicator interface { @@ -43,9 +61,48 @@ func (e *TimeoutError) Error() string { return e.message } -// ConnectToLiveshare waits for a Codespace to become running, -// and connects to it using a Live Share session. +// GetCodespaceConnection waits until a codespace is able +// to be connected to and initializes a connection to it. +func GetCodespaceConnection(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace) (*connection.CodespaceConnection, error) { + codespace, err := waitUntilCodespaceConnectionReady(ctx, progress, apiClient, codespace, true) + if err != nil { + return nil, err + } + + progress.StartProgressIndicatorWithLabel("Connecting to codespace") + defer progress.StopProgressIndicator() + + httpClient, err := apiClient.HTTPClient() + if err != nil { + return nil, fmt.Errorf("error getting http client: %w", err) + } + + return connection.NewCodespaceConnection(ctx, codespace, httpClient) +} + +// ConnectToLiveshare waits until a codespace is able to be +// connected to and connects to it using a Live Share session. func ConnectToLiveshare(ctx context.Context, progress progressIndicator, sessionLogger logger, apiClient apiClient, codespace *api.Codespace) (*liveshare.Session, error) { + codespace, err := waitUntilCodespaceConnectionReady(ctx, progress, apiClient, codespace, false) + if err != nil { + return nil, err + } + + progress.StartProgressIndicatorWithLabel("Connecting to codespace") + defer progress.StopProgressIndicator() + + return liveshare.Connect(ctx, liveshare.Options{ + SessionID: codespace.Connection.SessionID, + SessionToken: codespace.Connection.SessionToken, + RelaySAS: codespace.Connection.RelaySAS, + RelayEndpoint: codespace.Connection.RelayEndpoint, + HostPublicKeys: codespace.Connection.HostPublicKeys, + Logger: sessionLogger, + }) +} + +// waitUntilCodespaceConnectionReady waits for a Codespace to be running and is able to be connected to. +func waitUntilCodespaceConnectionReady(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace, usingDevTunnels bool) (*api.Codespace, error) { if codespace.State != api.CodespaceStateAvailable { progress.StartProgressIndicatorWithLabel("Starting codespace") defer progress.StopProgressIndicator() @@ -54,7 +111,7 @@ func ConnectToLiveshare(ctx context.Context, progress progressIndicator, session } } - if !connectionReady(codespace) { + if !connectionReady(codespace, usingDevTunnels) { expBackoff := backoff.NewExponentialBackOff() expBackoff.Multiplier = 1.1 expBackoff.MaxInterval = 10 * time.Second @@ -67,7 +124,7 @@ func ConnectToLiveshare(ctx context.Context, progress progressIndicator, session return backoff.Permanent(fmt.Errorf("error getting codespace: %w", err)) } - if connectionReady(codespace) { + if connectionReady(codespace, usingDevTunnels) { return nil } @@ -83,17 +140,7 @@ func ConnectToLiveshare(ctx context.Context, progress progressIndicator, session } } - progress.StartProgressIndicatorWithLabel("Connecting to codespace") - defer progress.StopProgressIndicator() - - return liveshare.Connect(ctx, liveshare.Options{ - SessionID: codespace.Connection.SessionID, - SessionToken: codespace.Connection.SessionToken, - RelaySAS: codespace.Connection.RelaySAS, - RelayEndpoint: codespace.Connection.RelayEndpoint, - HostPublicKeys: codespace.Connection.HostPublicKeys, - Logger: sessionLogger, - }) + return codespace, nil } // ListenTCP starts a localhost tcp listener on 127.0.0.1 (unless allInterfaces is true) and returns the listener and bound port diff --git a/internal/codespaces/connection/connection.go b/internal/codespaces/connection/connection.go new file mode 100644 index 000000000..5eea89a76 --- /dev/null +++ b/internal/codespaces/connection/connection.go @@ -0,0 +1,116 @@ +package connection + +import ( + "context" + "fmt" + "io" + "log" + "net/http" + "net/url" + + "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +const ( + clientName = "gh" +) + +type CodespaceConnection struct { + tunnelProperties api.TunnelProperties + TunnelManager *tunnels.Manager + TunnelClient *tunnels.Client + Options *tunnels.TunnelRequestOptions + Tunnel *tunnels.Tunnel + AllowedPortPrivacySettings []string +} + +// NewCodespaceConnection initializes a connection to a codespace. +// This connections allows for port forwarding which enables the +// use of most features of the codespace command. +func NewCodespaceConnection(ctx context.Context, codespace *api.Codespace, httpClient *http.Client) (connection *CodespaceConnection, err error) { + // Get the tunnel properties + tunnelProperties := codespace.Connection.TunnelProperties + + // Create the tunnel manager + tunnelManager, err := getTunnelManager(tunnelProperties, httpClient) + if err != nil { + return nil, fmt.Errorf("error getting tunnel management client: %w", err) + } + + // Calculate allowed port privacy settings + allowedPortPrivacySettings := codespace.RuntimeConstraints.AllowedPortPrivacySettings + + // Get the access tokens + connectToken := tunnelProperties.ConnectAccessToken + managementToken := tunnelProperties.ManagePortsAccessToken + + // Create the tunnel definition + tunnel := &tunnels.Tunnel{ + AccessTokens: map[tunnels.TunnelAccessScope]string{tunnels.TunnelAccessScopeConnect: connectToken, tunnels.TunnelAccessScopeManagePorts: managementToken}, + TunnelID: tunnelProperties.TunnelId, + ClusterID: tunnelProperties.ClusterId, + Domain: tunnelProperties.Domain, + } + + // Create options + options := &tunnels.TunnelRequestOptions{ + IncludePorts: true, + } + + // Create the tunnel client (not connected yet) + tunnelClient, err := getTunnelClient(ctx, tunnelManager, tunnel, options) + if err != nil { + return nil, fmt.Errorf("error getting tunnel client: %w", err) + } + + return &CodespaceConnection{ + tunnelProperties: tunnelProperties, + TunnelManager: tunnelManager, + TunnelClient: tunnelClient, + Options: options, + Tunnel: tunnel, + AllowedPortPrivacySettings: allowedPortPrivacySettings, + }, nil +} + +// getTunnelManager creates a tunnel manager for the given codespace. +// The tunnel manager is used to get the tunnel hosted in the codespace that we +// want to connect to and perform operations on ports (add, remove, list, etc.). +func getTunnelManager(tunnelProperties api.TunnelProperties, httpClient *http.Client) (tunnelManager *tunnels.Manager, err error) { + userAgent := []tunnels.UserAgent{{Name: clientName}} + url, err := url.Parse(tunnelProperties.ServiceUri) + if err != nil { + return nil, fmt.Errorf("error parsing tunnel service uri: %w", err) + } + + // Create the tunnel manager + tunnelManager, err = tunnels.NewManager(userAgent, nil, url, httpClient) + if err != nil { + return nil, fmt.Errorf("error creating tunnel manager: %w", err) + } + + return tunnelManager, nil +} + +// getTunnelClient creates a tunnel client for the given tunnel. +// The tunnel client is used to connect to the the tunnel and allows +// for ports to be forwarded locally. +func getTunnelClient(ctx context.Context, tunnelManager *tunnels.Manager, tunnel *tunnels.Tunnel, options *tunnels.TunnelRequestOptions) (tunnelClient *tunnels.Client, err error) { + // Get the tunnel that we want to connect to + codespaceTunnel, err := tunnelManager.GetTunnel(ctx, tunnel, options) + if err != nil { + return nil, fmt.Errorf("error getting tunnel: %w", err) + } + + // Copy the access tokens from the tunnel definition + codespaceTunnel.AccessTokens = tunnel.AccessTokens + + // We need to pass false for accept local connections because we don't want to automatically connect to all forwarded ports + tunnelClient, err = tunnels.NewClient(log.New(io.Discard, "", log.LstdFlags), codespaceTunnel, false) + if err != nil { + return nil, fmt.Errorf("error creating tunnel client: %w", err) + } + + return tunnelClient, nil +} diff --git a/internal/codespaces/connection/connection_test.go b/internal/codespaces/connection/connection_test.go new file mode 100644 index 000000000..e7ebd2788 --- /dev/null +++ b/internal/codespaces/connection/connection_test.go @@ -0,0 +1,75 @@ +package connection + +import ( + "context" + "reflect" + "testing" + + "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +func TestNewCodespaceConnection(t *testing.T) { + ctx := context.Background() + + // Create a mock codespace + connection := api.CodespaceConnection{ + TunnelProperties: api.TunnelProperties{ + ConnectAccessToken: "connect-token", + ManagePortsAccessToken: "manage-ports-token", + ServiceUri: "http://global.rel.tunnels.api.visualstudio.com/", + TunnelId: "tunnel-id", + ClusterId: "usw2", + Domain: "domain.com", + }, + } + allowedPortPrivacySettings := []string{"public", "private"} + codespace := &api.Codespace{ + Connection: connection, + RuntimeConstraints: api.RuntimeConstraints{AllowedPortPrivacySettings: allowedPortPrivacySettings}, + } + + // Create the mock HTTP client + httpClient, err := NewMockHttpClient() + if err != nil { + t.Fatalf("NewHttpClient returned an error: %v", err) + } + + // Create the connection + conn, err := NewCodespaceConnection(ctx, codespace, httpClient) + if err != nil { + t.Fatalf("NewCodespaceConnection returned an error: %v", err) + } + + // Check that the connection was created successfully + if conn == nil { + t.Fatal("NewCodespaceConnection returned nil") + } + + // Verify that the connection contains the expected tunnel properties + if conn.tunnelProperties != connection.TunnelProperties { + t.Fatalf("NewCodespaceConnection returned a connection with unexpected tunnel properties: %+v", conn.tunnelProperties) + } + + // Verify that the connection contains the expected tunnel + expectedTunnel := &tunnels.Tunnel{ + AccessTokens: map[tunnels.TunnelAccessScope]string{tunnels.TunnelAccessScopeConnect: connection.TunnelProperties.ConnectAccessToken, tunnels.TunnelAccessScopeManagePorts: connection.TunnelProperties.ManagePortsAccessToken}, + TunnelID: connection.TunnelProperties.TunnelId, + ClusterID: connection.TunnelProperties.ClusterId, + Domain: connection.TunnelProperties.Domain, + } + if !reflect.DeepEqual(conn.Tunnel, expectedTunnel) { + t.Fatalf("NewCodespaceConnection returned a connection with unexpected tunnel: %+v", conn.Tunnel) + } + + // Verify that the connection contains the expected tunnel options + expectedOptions := &tunnels.TunnelRequestOptions{IncludePorts: true} + if !reflect.DeepEqual(conn.Options, expectedOptions) { + t.Fatalf("NewCodespaceConnection returned a connection with unexpected options: %+v", conn.Options) + } + + // Verify that the connection contains the expected allowed port privacy settings + if !reflect.DeepEqual(conn.AllowedPortPrivacySettings, allowedPortPrivacySettings) { + t.Fatalf("NewCodespaceConnection returned a connection with unexpected allowed port privacy settings: %+v", conn.AllowedPortPrivacySettings) + } +} diff --git a/internal/codespaces/connection/tunnels_api_server_mock.go b/internal/codespaces/connection/tunnels_api_server_mock.go new file mode 100644 index 000000000..cf8f05cfa --- /dev/null +++ b/internal/codespaces/connection/tunnels_api_server_mock.go @@ -0,0 +1,396 @@ +package connection + +import ( + "context" + "crypto/rand" + "crypto/rsa" + "crypto/x509" + "encoding/json" + "encoding/pem" + "fmt" + "io" + "log" + "net/http" + "net/http/httptest" + "net/url" + "regexp" + "strings" + "sync" + "time" + + "github.com/gorilla/websocket" + "github.com/microsoft/dev-tunnels/go/tunnels" + tunnelssh "github.com/microsoft/dev-tunnels/go/tunnels/ssh" + "github.com/microsoft/dev-tunnels/go/tunnels/ssh/messages" + "golang.org/x/crypto/ssh" +) + +func NewMockHttpClient() (*http.Client, error) { + accessToken := "tunnel access-token" + relayServer, err := newMockrelayServer(withAccessToken(accessToken)) + if err != nil { + return nil, fmt.Errorf("NewrelayServer returned an error: %w", err) + } + + hostURL := strings.Replace(relayServer.URL(), "http://", "ws://", 1) + mockServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + var response []byte + if r.URL.Path == "/api/v1/tunnels/tunnel-id" { + tunnel := &tunnels.Tunnel{ + AccessTokens: map[tunnels.TunnelAccessScope]string{ + tunnels.TunnelAccessScopeConnect: accessToken, + }, + Endpoints: []tunnels.TunnelEndpoint{ + { + HostID: "host1", + TunnelRelayTunnelEndpoint: tunnels.TunnelRelayTunnelEndpoint{ + ClientRelayURI: hostURL, + }, + }, + }, + } + + response, err = json.Marshal(*tunnel) + if err != nil { + log.Fatalf("json.Marshal returned an error: %v", err) + } + } else if strings.HasPrefix(r.URL.Path, "/api/v1/tunnels/tunnel-id/ports") { + // Use regex to check if the path ends with a number + match, err := regexp.MatchString(`\/\d+$`, r.URL.Path) + if err != nil { + log.Fatalf("regexp.MatchString returned an error: %v", err) + } + + // If the path ends with a number, it's a request for a specific port + if match || r.Method == http.MethodPost { + if r.Method == http.MethodDelete { + w.WriteHeader(http.StatusOK) + return + } + + tunnelPort := &tunnels.TunnelPort{ + AccessControl: &tunnels.TunnelAccessControl{ + Entries: []tunnels.TunnelAccessControlEntry{}, + }, + } + + // Convert the tunnel to JSON and write it to the response + response, err = json.Marshal(*tunnelPort) + if err != nil { + log.Fatalf("json.Marshal returned an error: %v", err) + } + } else { + // If the path doesn't end with a number and we aren't making a POST request, return an array of ports + tunnelPorts := []tunnels.TunnelPort{ + { + AccessControl: &tunnels.TunnelAccessControl{ + Entries: []tunnels.TunnelAccessControlEntry{}, + }, + }, + } + + response, err = json.Marshal(tunnelPorts) + if err != nil { + log.Fatalf("json.Marshal returned an error: %v", err) + } + } + + } else { + w.WriteHeader(http.StatusNotFound) + return + } + + // Write the response + _, _ = w.Write(response) + })) + + url, err := url.Parse(mockServer.URL) + if err != nil { + return nil, fmt.Errorf("url.Parse returned an error: %w", err) + } + return &http.Client{ + Transport: &http.Transport{ + Proxy: http.ProxyURL(url), + }, + }, nil +} + +type relayServer struct { + httpServer *httptest.Server + errc chan error + sshConfig *ssh.ServerConfig + channels map[string]channelHandler + accessToken string + + serverConn *ssh.ServerConn +} + +type relayServerOption func(*relayServer) +type channelHandler func(context.Context, ssh.NewChannel) error + +func newMockrelayServer(opts ...relayServerOption) (*relayServer, error) { + server := &relayServer{ + errc: make(chan error), + sshConfig: &ssh.ServerConfig{ + NoClientAuth: true, + }, + } + + // Create a private key with the crypto package + key, err := rsa.GenerateKey(rand.Reader, 2048) + if err != nil { + return nil, fmt.Errorf("failed to generate key: %w", err) + } + + privateKeyPEM := pem.EncodeToMemory( + &pem.Block{ + Type: "RSA PRIVATE KEY", + Bytes: x509.MarshalPKCS1PrivateKey(key), + }, + ) + + // Parse the private key + sshPrivateKey, err := ssh.ParsePrivateKey(privateKeyPEM) + if err != nil { + return nil, fmt.Errorf("failed to parse private key: %w", err) + } + + server.sshConfig.AddHostKey(ssh.Signer(sshPrivateKey)) + + server.httpServer = httptest.NewServer(http.HandlerFunc(makeConnection(server))) + + for _, opt := range opts { + opt(server) + } + + return server, nil +} + +func withAccessToken(accessToken string) func(*relayServer) { + return func(server *relayServer) { + server.accessToken = accessToken + } +} + +func (rs *relayServer) URL() string { + return rs.httpServer.URL +} + +func (rs *relayServer) Err() <-chan error { + return rs.errc +} + +func (rs *relayServer) sendError(err error) { + select { + case rs.errc <- err: + default: + // channel is blocked with a previous error, so we ignore this one + } +} + +func (rs *relayServer) ForwardPort(ctx context.Context, port uint16) error { + pfr := messages.NewPortForwardRequest("127.0.0.1", uint32(port)) + b, err := pfr.Marshal() + if err != nil { + return fmt.Errorf("error marshaling port forward request: %w", err) + } + + replied, data, err := rs.serverConn.SendRequest(messages.PortForwardRequestType, true, b) + if err != nil { + return fmt.Errorf("error sending port forward request: %w", err) + } + + if !replied { + return fmt.Errorf("port forward request not replied") + } + + if data == nil { + return fmt.Errorf("no data returned") + } + + return nil +} + +func makeConnection(server *relayServer) http.HandlerFunc { + return func(w http.ResponseWriter, r *http.Request) { + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + + if server.accessToken != "" { + if r.Header.Get("Authorization") != server.accessToken { + server.sendError(fmt.Errorf("invalid access token")) + return + } + } + + upgrader := websocket.Upgrader{} + c, err := upgrader.Upgrade(w, r, nil) + if err != nil { + server.sendError(fmt.Errorf("error upgrading to websocket: %w", err)) + return + } + defer func() { + if err := c.Close(); err != nil { + server.sendError(fmt.Errorf("error closing websocket: %w", err)) + } + }() + + socketConn := newSocketConn(c) + serverConn, chans, reqs, err := ssh.NewServerConn(socketConn, server.sshConfig) + if err != nil { + server.sendError(fmt.Errorf("error creating ssh server conn: %w", err)) + return + } + + go handleRequests(ctx, convertRequests(reqs)) + + server.serverConn = serverConn + if err := handleChannels(ctx, server, chans); err != nil { + server.sendError(fmt.Errorf("error handling channels: %w", err)) + return + } + } +} + +func (sr *sshRequest) Type() string { + return sr.request.Type +} + +type sshRequest struct { + request *ssh.Request +} + +// Reply method for sshRequest to satisfy the tunnelssh.SSHRequest interface +func (sr *sshRequest) Reply(success bool, message []byte) error { + return sr.request.Reply(success, message) +} + +// convertRequests function +func convertRequests(reqs <-chan *ssh.Request) <-chan tunnelssh.SSHRequest { + out := make(chan tunnelssh.SSHRequest) + go func() { + for req := range reqs { + out <- &sshRequest{req} + } + close(out) + }() + return out +} + +func handleChannels(ctx context.Context, server *relayServer, chans <-chan ssh.NewChannel) error { + errc := make(chan error, 1) + go func() { + for ch := range chans { + if handler, ok := server.channels[ch.ChannelType()]; ok { + if err := handler(ctx, ch); err != nil { + errc <- err + return + } + } else { + // generic accept of the channel to not block + _, _, err := ch.Accept() + if err != nil { + errc <- fmt.Errorf("error accepting channel: %w", err) + return + } + } + } + }() + return awaitError(ctx, errc) +} + +func handleRequests(ctx context.Context, reqs <-chan tunnelssh.SSHRequest) { + for { + select { + case <-ctx.Done(): + return + case req, ok := <-reqs: + if !ok { + return + } + + if req.Type() == "RefreshPorts" { + _ = req.Reply(true, nil) + continue + } else { + _ = req.Reply(false, nil) + } + } + } +} + +func awaitError(ctx context.Context, errc <-chan error) error { + select { + case <-ctx.Done(): + return ctx.Err() + case err := <-errc: + return err + } +} + +type socketConn struct { + *websocket.Conn + + reader io.Reader + writeMutex sync.Mutex + readMutex sync.Mutex +} + +func newSocketConn(conn *websocket.Conn) *socketConn { + return &socketConn{Conn: conn} +} + +func (s *socketConn) Read(b []byte) (int, error) { + s.readMutex.Lock() + defer s.readMutex.Unlock() + + if s.reader == nil { + msgType, r, err := s.Conn.NextReader() + if err != nil { + return 0, fmt.Errorf("error getting next reader: %w", err) + } + if msgType != websocket.BinaryMessage { + return 0, fmt.Errorf("invalid message type") + } + s.reader = r + } + + bytesRead, err := s.reader.Read(b) + if err != nil { + s.reader = nil + + if err == io.EOF { + err = nil + } + } + + return bytesRead, err +} + +func (s *socketConn) Write(b []byte) (int, error) { + s.writeMutex.Lock() + defer s.writeMutex.Unlock() + + w, err := s.Conn.NextWriter(websocket.BinaryMessage) + if err != nil { + return 0, fmt.Errorf("error getting next writer: %w", err) + } + + n, err := w.Write(b) + if err != nil { + return 0, fmt.Errorf("error writing: %w", err) + } + + if err := w.Close(); err != nil { + return 0, fmt.Errorf("error closing writer: %w", err) + } + + return n, nil +} + +func (s *socketConn) SetDeadline(deadline time.Time) error { + if err := s.Conn.SetReadDeadline(deadline); err != nil { + return err + } + return s.Conn.SetWriteDeadline(deadline) +} diff --git a/internal/codespaces/portforwarder/port_forwarder.go b/internal/codespaces/portforwarder/port_forwarder.go new file mode 100644 index 000000000..ba510e4ff --- /dev/null +++ b/internal/codespaces/portforwarder/port_forwarder.go @@ -0,0 +1,253 @@ +package portforwarder + +import ( + "context" + "fmt" + "net" + "strings" + + "github.com/cli/cli/v2/internal/codespaces/connection" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +const ( + githubSubjectId = "1" + InternalPortTag = "InternalPort" + UserForwardedPortTag = "UserForwardedPort" +) + +const ( + PrivatePortVisibility = "private" + OrgPortVisibility = "org" + PublicPortVisibility = "public" +) + +type PortForwarder struct { + connection connection.CodespaceConnection +} + +// NewPortForwarder returns a new PortForwarder for the specified codespace. +func NewPortForwarder(ctx context.Context, codespaceConnection *connection.CodespaceConnection) (fwd *PortForwarder, err error) { + return &PortForwarder{ + connection: *codespaceConnection, + }, nil +} + +// ForwardAndConnectToPort forwards a port and connects to it via a local TCP port. +func (fwd *PortForwarder) ForwardAndConnectToPort(ctx context.Context, remotePort uint16, listen *net.TCPListener, keepAlive bool, internal bool) error { + return fwd.ForwardPort(ctx, remotePort, listen, keepAlive, true, internal, "") +} + +// ForwardPort forwards a port and optionally connects to it via a local TCP port. +func (fwd *PortForwarder) ForwardPort(ctx context.Context, remotePort uint16, listen *net.TCPListener, keepAlive bool, connect bool, internal bool, visibility string) error { + tunnelPort := tunnels.NewTunnelPort(remotePort, "", "", tunnels.TunnelProtocolHttp) + + // If no visibility is provided, Dev Tunnels will use the default (private) + if visibility != "" { + // Check if the requested visibility is allowed + allowed := false + for _, allowedVisibility := range fwd.connection.AllowedPortPrivacySettings { + if allowedVisibility == visibility { + allowed = true + break + } + } + + // If the requested visibility is not allowed, return an error + if !allowed { + return fmt.Errorf("visibility %s is not allowed", visibility) + } + + accessControlEntries := visibilityToAccessControlEntries(visibility) + if len(accessControlEntries) > 0 { + tunnelPort.AccessControl = &tunnels.TunnelAccessControl{ + Entries: accessControlEntries, + } + } + } + + // Tag the port as internal or user forwarded so we know if it needs to be shown in the UI + if internal { + tunnelPort.Tags = []string{InternalPortTag} + } else { + tunnelPort.Tags = []string{UserForwardedPortTag} + } + + // Create the tunnel port + _, err := fwd.connection.TunnelManager.CreateTunnelPort(ctx, fwd.connection.Tunnel, tunnelPort, fwd.connection.Options) + if err != nil && !strings.Contains(err.Error(), "409") { + return fmt.Errorf("create tunnel port failed: %v", err) + } + + done := make(chan error) + go func() { + // Connect to the tunnel + err = fwd.connection.TunnelClient.Connect(ctx, "") + if err != nil { + done <- fmt.Errorf("connect failed: %v", err) + return + } + + // Inform the host that we've forwarded the port locally + err = fwd.connection.TunnelClient.RefreshPorts(ctx) + if err != nil { + done <- fmt.Errorf("refresh ports failed: %v", err) + return + } + + // If we don't want to connect to the port, exit early + if !connect { + done <- nil + return + } + + // Ensure the port is forwarded before connecting + err = fwd.connection.TunnelClient.WaitForForwardedPort(ctx, remotePort) + if err != nil { + done <- fmt.Errorf("wait for forwarded port failed: %v", err) + return + } + + // Connect to the forwarded port via a local TCP port + err = fwd.connection.TunnelClient.ConnectToForwardedPort(ctx, listen, remotePort) + if err != nil { + done <- fmt.Errorf("connect to forwarded port failed: %v", err) + return + } + + done <- nil + }() + select { + case err := <-done: + if err != nil { + return fmt.Errorf("error connecting to tunnel: %w", err) + } + return nil + case <-ctx.Done(): + return nil + } +} + +// ListPorts fetches the list of ports that are currently forwarded. +func (fwd *PortForwarder) ListPorts(ctx context.Context) (ports []*tunnels.TunnelPort, err error) { + ports, err = fwd.connection.TunnelManager.ListTunnelPorts(ctx, fwd.connection.Tunnel, fwd.connection.Options) + if err != nil { + return nil, fmt.Errorf("error listing ports: %w", err) + } + + return ports, nil +} + +// UpdatePortVisibility changes the visibility (private, org, public) of the specified port. +func (fwd *PortForwarder) UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error { + tunnelPort, err := fwd.connection.TunnelManager.GetTunnelPort(ctx, fwd.connection.Tunnel, remotePort, fwd.connection.Options) + if err != nil { + return fmt.Errorf("error getting tunnel port: %w", err) + } + + // If the port visibility isn't changing, don't do anything + if AccessControlEntriesToVisibility(tunnelPort.AccessControl.Entries) == visibility { + return nil + } + + // Delete the existing tunnel port to update + err = fwd.connection.TunnelManager.DeleteTunnelPort(ctx, fwd.connection.Tunnel, uint16(remotePort), fwd.connection.Options) + if err != nil { + return fmt.Errorf("error deleting tunnel port: %w", err) + } + + done := make(chan error) + go func() { + // Connect to the tunnel + err = fwd.connection.TunnelClient.Connect(ctx, "") + if err != nil { + done <- fmt.Errorf("connect failed: %v", err) + return + } + + // Inform the host that we've deleted the port + err = fwd.connection.TunnelClient.RefreshPorts(ctx) + if err != nil { + done <- fmt.Errorf("refresh ports failed: %v", err) + return + } + + done <- nil + }() + + // Wait for the done channel to be closed + select { + case err := <-done: + if err != nil { + return fmt.Errorf("error connecting to tunnel: %w", err) + } + + // Re-forward the port with the updated visibility + err = fwd.ForwardPort(ctx, uint16(remotePort), nil, false, false, false, visibility) + if err != nil { + return fmt.Errorf("error forwarding port: %w", err) + } + + return nil + case <-ctx.Done(): + return nil + } +} + +// AccessControlEntriesToVisibility converts the access control entries used by Dev Tunnels to a friendly visibility value. +func AccessControlEntriesToVisibility(accessControlEntries []tunnels.TunnelAccessControlEntry) string { + for _, entry := range accessControlEntries { + // If we have the anonymous type (and we're not denying it), it's public + if (entry.Type == tunnels.TunnelAccessControlEntryTypeAnonymous) && (!entry.IsDeny) { + return PublicPortVisibility + } + + // If we have the organizations type (and we're not denying it), it's org + if (entry.Provider == string(tunnels.TunnelAuthenticationSchemeGitHub)) && (!entry.IsDeny) { + return OrgPortVisibility + } + } + + // Else, it's private + return PrivatePortVisibility +} + +// visibilityToAccessControlEntries converts the given visibility to access control entries that can be used by Dev Tunnels. +func visibilityToAccessControlEntries(visibility string) []tunnels.TunnelAccessControlEntry { + switch visibility { + case PublicPortVisibility: + return []tunnels.TunnelAccessControlEntry{{ + Type: tunnels.TunnelAccessControlEntryTypeAnonymous, + Subjects: []string{}, + Scopes: []string{string(tunnels.TunnelAccessScopeConnect)}, + }} + case OrgPortVisibility: + return []tunnels.TunnelAccessControlEntry{{ + Type: tunnels.TunnelAccessControlEntryTypeOrganizations, + Subjects: []string{githubSubjectId}, + Scopes: []string{ + string(tunnels.TunnelAccessScopeConnect), + }, + Provider: string(tunnels.TunnelAuthenticationSchemeGitHub), + }} + default: + // The tunnel manager doesn't accept empty access control entries, so we need to return a deny entry + return []tunnels.TunnelAccessControlEntry{{ + Type: tunnels.TunnelAccessControlEntryTypeOrganizations, + Subjects: []string{githubSubjectId}, + Scopes: []string{}, + IsDeny: true, + }} + } +} + +// IsInternalPort returns true if the port is internal. +func IsInternalPort(port *tunnels.TunnelPort) bool { + for _, tag := range port.Tags { + if strings.EqualFold(tag, InternalPortTag) { + return true + } + } + + return false +} diff --git a/internal/codespaces/portforwarder/port_forwarder_test.go b/internal/codespaces/portforwarder/port_forwarder_test.go new file mode 100644 index 000000000..d107afec4 --- /dev/null +++ b/internal/codespaces/portforwarder/port_forwarder_test.go @@ -0,0 +1,139 @@ +package portforwarder + +import ( + "context" + "testing" + + "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/connection" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +func TestNewPortForwarder(t *testing.T) { + ctx := context.Background() + + // Create a mock codespace + codespace := &api.Codespace{ + Connection: api.CodespaceConnection{ + TunnelProperties: api.TunnelProperties{ + ConnectAccessToken: "connect-token", + ManagePortsAccessToken: "manage-ports-token", + ServiceUri: "http://global.rel.tunnels.api.visualstudio.com/", + TunnelId: "tunnel-id", + ClusterId: "usw2", + Domain: "domain.com", + }, + }, + RuntimeConstraints: api.RuntimeConstraints{ + AllowedPortPrivacySettings: []string{"public", "private"}, + }, + } + + // Create the mock HTTP client + httpClient, err := connection.NewMockHttpClient() + if err != nil { + t.Fatalf("NewHttpClient returned an error: %v", err) + } + + // Call the function being tested + conn, err := connection.NewCodespaceConnection(ctx, codespace, httpClient) + if err != nil { + t.Fatalf("NewCodespaceConnection returned an error: %v", err) + } + + // Create the new port forwarder + portForwarder, err := NewPortForwarder(ctx, conn) + if err != nil { + t.Fatalf("NewPortForwarder returned an error: %v", err) + } + + // Check that the port forwarder was created successfully + if portForwarder == nil { + t.Fatal("NewPortForwarder returned nil") + } +} + +func TestAccessControlEntriesToVisibility(t *testing.T) { + publicAccessControlEntry := []tunnels.TunnelAccessControlEntry{{ + Type: tunnels.TunnelAccessControlEntryTypeAnonymous, + }} + orgAccessControlEntry := []tunnels.TunnelAccessControlEntry{{ + Provider: string(tunnels.TunnelAuthenticationSchemeGitHub), + }} + privateAccessControlEntry := []tunnels.TunnelAccessControlEntry{} + orgIsDenyAccessControlEntry := []tunnels.TunnelAccessControlEntry{{ + Provider: string(tunnels.TunnelAuthenticationSchemeGitHub), + IsDeny: true, + }} + + tests := []struct { + name string + accessControlEntries []tunnels.TunnelAccessControlEntry + expected string + }{ + { + name: "public", + accessControlEntries: publicAccessControlEntry, + expected: PublicPortVisibility, + }, + { + name: "org", + accessControlEntries: orgAccessControlEntry, + expected: OrgPortVisibility, + }, + { + name: "private", + accessControlEntries: privateAccessControlEntry, + expected: PrivatePortVisibility, + }, + { + name: "orgIsDeny", + accessControlEntries: orgIsDenyAccessControlEntry, + expected: PrivatePortVisibility, + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + visibility := AccessControlEntriesToVisibility(test.accessControlEntries) + if visibility != test.expected { + t.Errorf("expected %q, got %q", test.expected, visibility) + } + }) + } +} + +func TestIsInternalPort(t *testing.T) { + internalPort := &tunnels.TunnelPort{ + Tags: []string{"InternalPort"}, + } + userForwardedPort := &tunnels.TunnelPort{ + Tags: []string{"UserForwardedPort"}, + } + + tests := []struct { + name string + port *tunnels.TunnelPort + expected bool + }{ + { + name: "internal", + port: internalPort, + expected: true, + }, + { + name: "user-forwarded", + port: userForwardedPort, + expected: false, + }, + } + + for _, test := range tests { + t.Run(test.name, func(t *testing.T) { + isInternal := IsInternalPort(test.port) + if isInternal != test.expected { + t.Errorf("expected %v, got %v", test.expected, isInternal) + } + }) + } +} diff --git a/pkg/cmd/codespace/common.go b/pkg/cmd/codespace/common.go index 006669151..86493ce8e 100644 --- a/pkg/cmd/codespace/common.go +++ b/pkg/cmd/codespace/common.go @@ -8,6 +8,7 @@ import ( "fmt" "io" "log" + "net/http" "os" "sort" "strings" @@ -104,6 +105,7 @@ type apiClient interface { ListDevContainers(ctx context.Context, repoID int, branch string, limit int) (devcontainers []api.DevContainerEntry, err error) GetCodespaceRepoSuggestions(ctx context.Context, partialSearch string, params api.RepoSearchParameters) ([]string, error) GetCodespaceBillableOwner(ctx context.Context, nwo string) (*api.User, error) + HTTPClient() (*http.Client, error) } var errNoCodespaces = errors.New("you have no codespaces") diff --git a/pkg/cmd/codespace/mock_api.go b/pkg/cmd/codespace/mock_api.go index 7e211fd7c..aad15c025 100644 --- a/pkg/cmd/codespace/mock_api.go +++ b/pkg/cmd/codespace/mock_api.go @@ -5,6 +5,7 @@ package codespace import ( "context" + "net/http" "sync" codespacesAPI "github.com/cli/cli/v2/internal/codespaces/api" @@ -40,15 +41,15 @@ import ( // GetCodespacesMachinesFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) { // panic("mock out the GetCodespacesMachines method") // }, +// HTTPClientFunc: func() (*http.Client, error) { +// panic("mock out the HTTPClient method") +// }, // GetOrgMemberCodespaceFunc: func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { // panic("mock out the GetOrgMemberCodespace method") // }, // GetRepositoryFunc: func(ctx context.Context, nwo string) (*codespacesAPI.Repository, error) { // panic("mock out the GetRepository method") // }, -// ServerURLFunc: func() string { -// panic("mock out the ServerURL method") -// }, // GetUserFunc: func(ctx context.Context) (*codespacesAPI.User, error) { // panic("mock out the GetUser method") // }, @@ -58,6 +59,9 @@ import ( // ListDevContainersFunc: func(ctx context.Context, repoID int, branch string, limit int) ([]codespacesAPI.DevContainerEntry, error) { // panic("mock out the ListDevContainers method") // }, +// ServerURLFunc: func() string { +// panic("mock out the ServerURL method") +// }, // StartCodespaceFunc: func(ctx context.Context, name string) error { // panic("mock out the StartCodespace method") // }, @@ -95,15 +99,15 @@ type apiClientMock struct { // GetCodespacesMachinesFunc mocks the GetCodespacesMachines method. GetCodespacesMachinesFunc func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) + // HTTPClientFunc mocks the HTTPClient method. + HTTPClientFunc func() (*http.Client, error) + // GetOrgMemberCodespaceFunc mocks the GetOrgMemberCodespace method. GetOrgMemberCodespaceFunc func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) // GetRepositoryFunc mocks the GetRepository method. GetRepositoryFunc func(ctx context.Context, nwo string) (*codespacesAPI.Repository, error) - // ServerURLFunc mocks the ServerURL method. - ServerURLFunc func() string - // GetUserFunc mocks the GetUser method. GetUserFunc func(ctx context.Context) (*codespacesAPI.User, error) @@ -113,6 +117,9 @@ type apiClientMock struct { // ListDevContainersFunc mocks the ListDevContainers method. ListDevContainersFunc func(ctx context.Context, repoID int, branch string, limit int) ([]codespacesAPI.DevContainerEntry, error) + // ServerURLFunc mocks the ServerURL method. + ServerURLFunc func() string + // StartCodespaceFunc mocks the StartCodespace method. StartCodespaceFunc func(ctx context.Context, name string) error @@ -195,6 +202,9 @@ type apiClientMock struct { // DevcontainerPath is the devcontainerPath argument value. DevcontainerPath string } + // HTTPClient holds details about calls to the HTTPClient method. + HTTPClient []struct { + } // GetOrgMemberCodespace holds details about calls to the GetOrgMemberCodespace method. GetOrgMemberCodespace []struct { // Ctx is the ctx argument value. @@ -213,9 +223,6 @@ type apiClientMock struct { // Nwo is the nwo argument value. Nwo string } - // ServerURL holds details about calls to the ServerURL method. - ServerURL []struct { - } // GetUser holds details about calls to the GetUser method. GetUser []struct { // Ctx is the ctx argument value. @@ -239,6 +246,9 @@ type apiClientMock struct { // Limit is the limit argument value. Limit int } + // ServerURL holds details about calls to the ServerURL method. + ServerURL []struct { + } // StartCodespace holds details about calls to the StartCodespace method. StartCodespace []struct { // Ctx is the ctx argument value. @@ -266,12 +276,13 @@ type apiClientMock struct { lockGetCodespaceRepoSuggestions sync.RWMutex lockGetCodespaceRepositoryContents sync.RWMutex lockGetCodespacesMachines sync.RWMutex + lockHTTPClient sync.RWMutex lockGetOrgMemberCodespace sync.RWMutex lockGetRepository sync.RWMutex - lockServerURL sync.RWMutex lockGetUser sync.RWMutex lockListCodespaces sync.RWMutex lockListDevContainers sync.RWMutex + lockServerURL sync.RWMutex lockStartCodespace sync.RWMutex lockStopCodespace sync.RWMutex } @@ -600,6 +611,33 @@ func (mock *apiClientMock) GetCodespacesMachinesCalls() []struct { return calls } +// HTTPClient calls HTTPClientFunc. +func (mock *apiClientMock) HTTPClient() (*http.Client, error) { + if mock.HTTPClientFunc == nil { + panic("apiClientMock.HTTPClientFunc: method is nil but apiClient.HTTPClient was just called") + } + callInfo := struct { + }{} + mock.lockHTTPClient.Lock() + mock.calls.HTTPClient = append(mock.calls.HTTPClient, callInfo) + mock.lockHTTPClient.Unlock() + return mock.HTTPClientFunc() +} + +// HTTPClientCalls gets all the calls that were made to HTTPClient. +// Check the length with: +// +// len(mockedapiClient.HTTPClientCalls()) +func (mock *apiClientMock) HTTPClientCalls() []struct { +} { + var calls []struct { + } + mock.lockHTTPClient.RLock() + calls = mock.calls.HTTPClient + mock.lockHTTPClient.RUnlock() + return calls +} + // GetOrgMemberCodespace calls GetOrgMemberCodespaceFunc. func (mock *apiClientMock) GetOrgMemberCodespace(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { if mock.GetOrgMemberCodespaceFunc == nil { @@ -680,33 +718,6 @@ func (mock *apiClientMock) GetRepositoryCalls() []struct { return calls } -// ServerURL calls ServerURLFunc. -func (mock *apiClientMock) ServerURL() string { - if mock.ServerURLFunc == nil { - panic("apiClientMock.ServerURLFunc: method is nil but apiClient.ServerURL was just called") - } - callInfo := struct { - }{} - mock.lockServerURL.Lock() - mock.calls.ServerURL = append(mock.calls.ServerURL, callInfo) - mock.lockServerURL.Unlock() - return mock.ServerURLFunc() -} - -// ServerURLCalls gets all the calls that were made to ServerURL. -// Check the length with: -// -// len(mockedapiClient.ServerURLCalls()) -func (mock *apiClientMock) ServerURLCalls() []struct { -} { - var calls []struct { - } - mock.lockServerURL.RLock() - calls = mock.calls.ServerURL - mock.lockServerURL.RUnlock() - return calls -} - // GetUser calls GetUserFunc. func (mock *apiClientMock) GetUser(ctx context.Context) (*codespacesAPI.User, error) { if mock.GetUserFunc == nil { @@ -819,6 +830,33 @@ func (mock *apiClientMock) ListDevContainersCalls() []struct { return calls } +// ServerURL calls ServerURLFunc. +func (mock *apiClientMock) ServerURL() string { + if mock.ServerURLFunc == nil { + panic("apiClientMock.ServerURLFunc: method is nil but apiClient.ServerURL was just called") + } + callInfo := struct { + }{} + mock.lockServerURL.Lock() + mock.calls.ServerURL = append(mock.calls.ServerURL, callInfo) + mock.lockServerURL.Unlock() + return mock.ServerURLFunc() +} + +// ServerURLCalls gets all the calls that were made to ServerURL. +// Check the length with: +// +// len(mockedapiClient.ServerURLCalls()) +func (mock *apiClientMock) ServerURLCalls() []struct { +} { + var calls []struct { + } + mock.lockServerURL.RLock() + calls = mock.calls.ServerURL + mock.lockServerURL.RUnlock() + return calls +} + // StartCodespace calls StartCodespaceFunc. func (mock *apiClientMock) StartCodespace(ctx context.Context, name string) error { if mock.StartCodespaceFunc == nil { diff --git a/pkg/cmd/codespace/ports.go b/pkg/cmd/codespace/ports.go index cbe48b7b3..b7eb96537 100644 --- a/pkg/cmd/codespace/ports.go +++ b/pkg/cmd/codespace/ports.go @@ -6,26 +6,21 @@ import ( "encoding/json" "errors" "fmt" - "net/http" "strconv" "strings" "time" "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/pkg/liveshare" - "github.com/cli/cli/v2/utils" + "github.com/microsoft/dev-tunnels/go/tunnels" "github.com/muhammadmuzzammil1998/jsonc" "github.com/spf13/cobra" "golang.org/x/sync/errgroup" ) -const ( - vscodeServerPortName = "VSCodeServerInternal" - codespacesInternalPortName = "CodespacesInternal" -) - // newPortsCmd returns a Cobra "ports" command that displays a table of available ports, // according to the specified flags. func newPortsCmd(app *App) *cobra.Command { @@ -62,15 +57,19 @@ func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, export devContainerCh := getDevContainer(ctx, a.apiClient, codespace) - session, err := startLiveShareSession(ctx, codespace, a, false, "") + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return err + return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) - var ports []*liveshare.Port + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + + var ports []*tunnels.TunnelPort err = a.RunWithProgress("Fetching ports", func() (err error) { - ports, err = session.GetSharedServers(ctx) + ports, err = fwd.ListPorts(ctx) return }) if err != nil { @@ -87,9 +86,10 @@ func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, export for _, p := range ports { // filter out internal ports from list - if strings.HasPrefix(p.SessionName, vscodeServerPortName) || strings.HasPrefix(p.SessionName, codespacesInternalPortName) { + if portforwarder.IsInternalPort(p) { continue } + portInfos = append(portInfos, &portInfo{ Port: p, codespace: codespace, @@ -107,40 +107,42 @@ func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, export } cs := a.io.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(a.io) + tp := tableprinter.New(a.io) - if tp.IsTTY() { - tp.AddField("LABEL", nil, nil) - tp.AddField("PORT", nil, nil) - tp.AddField("VISIBILITY", nil, nil) - tp.AddField("BROWSE URL", nil, nil) + if a.io.IsStdoutTTY() { + tp.AddField("LABEL") + tp.AddField("PORT") + tp.AddField("VISIBILITY") + tp.AddField("BROWSE URL") tp.EndRow() } for _, port := range portInfos { - tp.AddField(port.Label(), nil, nil) - tp.AddField(strconv.Itoa(port.SourcePort), nil, cs.Yellow) - tp.AddField(port.Privacy, nil, nil) - tp.AddField(port.BrowseURL(), nil, nil) + // Convert the ACE to a friendly visibility string (private, org, public) + visibility := portforwarder.AccessControlEntriesToVisibility(port.Port.AccessControl.Entries) + + tp.AddField(port.Label()) + tp.AddField(cs.Yellow(fmt.Sprintf("%d", port.Port.PortNumber))) + tp.AddField(visibility) + tp.AddField(port.BrowseURL()) tp.EndRow() } return tp.Render() } type portInfo struct { - *liveshare.Port + Port *tunnels.TunnelPort codespace *api.Codespace devContainer *devContainer } func (pi *portInfo) BrowseURL() string { - return fmt.Sprintf("https://%s-%d.preview.app.github.dev", pi.codespace.Name, pi.Port.SourcePort) + return fmt.Sprintf("https://%s-%d.app.github.dev", pi.codespace.Name, pi.Port.PortNumber) } func (pi *portInfo) Label() string { if pi.devContainer != nil { - portStr := strconv.Itoa(pi.Port.SourcePort) + portStr := strconv.Itoa(int(pi.Port.PortNumber)) if attributes, ok := pi.devContainer.PortAttributes[portStr]; ok { return attributes.Label } @@ -150,7 +152,6 @@ func (pi *portInfo) Label() string { var portFields = []string{ "sourcePort", - // "destinationPort", // TODO(mislav): this appears to always be blank? "visibility", "label", "browseUrl", @@ -162,11 +163,9 @@ func (pi *portInfo) ExportData(fields []string) map[string]interface{} { for _, f := range fields { switch f { case "sourcePort": - data[f] = pi.Port.SourcePort - case "destinationPort": - data[f] = pi.Port.DestinationPort + data[f] = pi.Port.PortNumber case "visibility": - data[f] = pi.Port.Privacy + data[f] = portforwarder.AccessControlEntriesToVisibility(pi.Port.AccessControl.Entries) case "label": data[f] = pi.Label() case "browseUrl": @@ -235,30 +234,6 @@ func newPortsVisibilityCmd(app *App, selector *CodespaceSelector) *cobra.Command } } -type ErrUpdatingPortVisibility struct { - port int - visibility string - err error -} - -func newErrUpdatingPortVisibility(port int, visibility string, err error) *ErrUpdatingPortVisibility { - return &ErrUpdatingPortVisibility{ - port: port, - visibility: visibility, - err: err, - } -} - -func (e *ErrUpdatingPortVisibility) Error() string { - return fmt.Sprintf("error waiting for port %d to update to %s: %s", e.port, e.visibility, e.err) -} - -func (e *ErrUpdatingPortVisibility) Unwrap() error { - return e.err -} - -var errUpdatePortVisibilityForbidden = errors.New("organization admin has forbidden this privacy setting") - func (a *App) UpdatePortVisibility(ctx context.Context, selector *CodespaceSelector, args []string) (err error) { ports, err := a.parsePortVisibilities(args) if err != nil { @@ -270,47 +245,28 @@ func (a *App) UpdatePortVisibility(ctx context.Context, selector *CodespaceSelec return err } - session, err := codespaces.ConnectToLiveshare(ctx, a, noopLogger(), a.apiClient, codespace) + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } // TODO: check if port visibility can be updated in parallel instead of sequentially for _, port := range ports { err := a.RunWithProgress(fmt.Sprintf("Updating port %d visibility to: %s", port.number, port.visibility), func() (err error) { // wait for success or failure - g, ctx := errgroup.WithContext(ctx) ctx, cancel := context.WithTimeout(ctx, 30*time.Second) defer cancel() - g.Go(func() error { - updateNotif, err := session.WaitForPortNotification(ctx, port.number, liveshare.PortChangeKindUpdate) - if err != nil { - return fmt.Errorf("error waiting for port %d to update: %w", port.number, err) - - } - if !updateNotif.Success { - if updateNotif.StatusCode == http.StatusForbidden { - return newErrUpdatingPortVisibility(port.number, port.visibility, errUpdatePortVisibilityForbidden) - } - return newErrUpdatingPortVisibility(port.number, port.visibility, errors.New(updateNotif.ErrorDetail)) - - } - return nil // success - }) - - g.Go(func() error { - err := session.UpdateSharedServerPrivacy(ctx, port.number, port.visibility) - if err != nil { - return fmt.Errorf("error updating port %d to %s: %w", port.number, port.visibility, err) - } - return nil - }) - - // wait for success or failure - err = g.Wait() - return + err = fwd.UpdatePortVisibility(ctx, port.number, port.visibility) + if err != nil { + return fmt.Errorf("error updating port %d to %s: %w", port.number, port.visibility, err) + } + return nil }) if err != nil { return err @@ -367,11 +323,10 @@ func (a *App) ForwardPorts(ctx context.Context, selector *CodespaceSelector, por return err } - session, err := codespaces.ConnectToLiveshare(ctx, a, noopLogger(), a.apiClient, codespace) + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) // Run forwarding of all ports concurrently, aborting all of // them at the first failure, including cancellation of the context. @@ -386,9 +341,11 @@ func (a *App) ForwardPorts(ctx context.Context, selector *CodespaceSelector, por defer listen.Close() a.errLogger.Printf("Forwarding ports: remote %d <=> local %d", pair.remote, pair.local) - name := fmt.Sprintf("share-%d", pair.remote) - fwd := liveshare.NewPortForwarder(session, name, pair.remote, false) - return fwd.ForwardToListener(ctx, listen) // error always non-nil + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + return fwd.ForwardAndConnectToPort(ctx, uint16(pair.remote), listen, false, false) }) } return group.Wait() // first error diff --git a/pkg/cmd/codespace/ports_test.go b/pkg/cmd/codespace/ports_test.go index bb7554238..034c15eb6 100644 --- a/pkg/cmd/codespace/ports_test.go +++ b/pkg/cmd/codespace/ports_test.go @@ -2,18 +2,34 @@ package codespace import ( "context" - "errors" "fmt" - "os" + "net/http" "testing" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/connection" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/liveshare" - livesharetest "github.com/cli/cli/v2/pkg/liveshare/test" - "github.com/sourcegraph/jsonrpc2" ) +func TestListPorts(t *testing.T) { + ctx, cancel := context.WithCancel(context.Background()) + defer cancel() + + mockApi := GetMockApi(false) + ios, _, _, _ := iostreams.Test() + + a := &App{ + io: ios, + apiClient: mockApi, + } + + selector := &CodespaceSelector{api: a.apiClient, codespaceName: "codespace-name"} + err := a.ListPorts(ctx, selector, nil) + if err != nil { + t.Errorf("unexpected error: %v", err) + } +} + func TestPortsUpdateVisibilitySuccess(t *testing.T) { portVisibilities := []portVisibility{ { @@ -26,175 +42,35 @@ func TestPortsUpdateVisibilitySuccess(t *testing.T) { }, } - eventResponses := []string{ - "serverSharing.sharingSucceeded", - "serverSharing.sharingSucceeded", - } - - portsData := []liveshare.PortNotification{ - { - Success: true, - Port: 80, - ChangeKind: liveshare.PortChangeKindUpdate, - }, - { - Success: true, - Port: 9999, - ChangeKind: liveshare.PortChangeKindUpdate, - }, - } - - err := runUpdateVisibilityTest(t, portVisibilities, eventResponses, portsData) - + err := runUpdateVisibilityTest(t, portVisibilities, true) if err != nil { t.Errorf("unexpected error: %v", err) } } -func TestPortsUpdateVisibilityFailure403(t *testing.T) { - portVisibilities := []portVisibility{ - { - number: 80, - visibility: "org", - }, - { - number: 9999, - visibility: "public", - }, - } - - eventResponses := []string{ - "serverSharing.sharingSucceeded", - "serverSharing.sharingFailed", - } - - portsData := []liveshare.PortNotification{ - { - Success: true, - Port: 80, - ChangeKind: liveshare.PortChangeKindUpdate, - }, - { - Success: false, - Port: 9999, - ChangeKind: liveshare.PortChangeKindUpdate, - ErrorDetail: "test error", - StatusCode: 403, - }, - } - - err := runUpdateVisibilityTest(t, portVisibilities, eventResponses, portsData) - if err == nil { - t.Fatalf("runUpdateVisibilityTest succeeded unexpectedly") - } - - if errors.Unwrap(err) != errUpdatePortVisibilityForbidden { - t.Errorf("expected: %v, got: %v", errUpdatePortVisibilityForbidden, errors.Unwrap(err)) - } -} - func TestPortsUpdateVisibilityFailure(t *testing.T) { portVisibilities := []portVisibility{ - { - number: 80, - visibility: "org", - }, { number: 9999, visibility: "public", }, - } - - eventResponses := []string{ - "serverSharing.sharingSucceeded", - "serverSharing.sharingFailed", - } - - portsData := []liveshare.PortNotification{ { - Success: true, - Port: 80, - ChangeKind: liveshare.PortChangeKindUpdate, - }, - { - Success: false, - Port: 9999, - ChangeKind: liveshare.PortChangeKindUpdate, - ErrorDetail: "test error", + number: 80, + visibility: "org", }, } - err := runUpdateVisibilityTest(t, portVisibilities, eventResponses, portsData) + err := runUpdateVisibilityTest(t, portVisibilities, false) if err == nil { t.Fatalf("runUpdateVisibilityTest succeeded unexpectedly") } - - var expectedErr *ErrUpdatingPortVisibility - if !errors.As(err, &expectedErr) { - t.Errorf("expected: %v, got: %v", expectedErr, err) - } } -type joinWorkspaceResult struct { - SessionNumber int `json:"sessionNumber"` -} - -func runUpdateVisibilityTest(t *testing.T, portVisibilities []portVisibility, eventResponses []string, portsData []liveshare.PortNotification) error { - t.Helper() - if os.Getenv("GITHUB_ACTIONS") == "true" { - t.Skip("fails intermittently in CI: https://github.com/cli/cli/issues/5663") - } - - joinWorkspace := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - return joinWorkspaceResult{1}, nil - } - const sessionToken = "session-token" - - ch := make(chan *jsonrpc2.Conn, 1) - updateSharedVisibility := func(conn *jsonrpc2.Conn, rpcReq *jsonrpc2.Request) (interface{}, error) { - ch <- conn - return nil, nil - } - testServer, err := livesharetest.NewServer( - livesharetest.WithNonSecure(), - livesharetest.WithPassword(sessionToken), - livesharetest.WithService("workspace.joinWorkspace", joinWorkspace), - livesharetest.WithService("serverSharing.updateSharedServerPrivacy", updateSharedVisibility), - ) - if err != nil { - return fmt.Errorf("unable to create test server: %w", err) - } - +func runUpdateVisibilityTest(t *testing.T, portVisibilities []portVisibility, allowOrgPorts bool) error { ctx, cancel := context.WithCancel(context.Background()) defer cancel() - go func() { - for i, pd := range portsData { - select { - case <-ctx.Done(): - return - case conn := <-ch: - _, _ = conn.DispatchCall(ctx, eventResponses[i], pd, nil) - } - } - }() - - mockApi := &apiClientMock{ - GetCodespaceFunc: func(ctx context.Context, codespaceName string, includeConnection bool) (*api.Codespace, error) { - return &api.Codespace{ - Name: "codespace-name", - State: api.CodespaceStateAvailable, - Connection: api.CodespaceConnection{ - SessionID: "session-id", - SessionToken: sessionToken, - RelayEndpoint: testServer.URL(), - RelaySAS: "relay-sas", - HostPublicKeys: []string{livesharetest.SSHPublicKey}, - }, - }, nil - }, - } - + mockApi := GetMockApi(allowOrgPorts) ios, _, _, _ := iostreams.Test() a := &App{ @@ -251,6 +127,44 @@ func TestPendingOperationDisallowsForwardPorts(t *testing.T) { } } +func GetMockApi(allowOrgPorts bool) *apiClientMock { + return &apiClientMock{ + GetCodespaceFunc: func(ctx context.Context, codespaceName string, includeConnection bool) (*api.Codespace, error) { + allowedPortPrivacySettings := []string{"public", "private"} + if allowOrgPorts { + allowedPortPrivacySettings = append(allowedPortPrivacySettings, "org") + } + + return &api.Codespace{ + Name: "codespace-name", + State: api.CodespaceStateAvailable, + Connection: api.CodespaceConnection{ + TunnelProperties: api.TunnelProperties{ + ConnectAccessToken: "tunnel access-token", + ManagePortsAccessToken: "manage-ports-token", + ServiceUri: "http://global.rel.tunnels.api.visualstudio.com/", + TunnelId: "tunnel-id", + ClusterId: "usw2", + Domain: "domain.com", + }, + }, + RuntimeConstraints: api.RuntimeConstraints{ + AllowedPortPrivacySettings: allowedPortPrivacySettings, + }, + }, nil + }, + StartCodespaceFunc: func(ctx context.Context, codespaceName string) error { + return nil + }, + GetCodespaceRepositoryContentsFunc: func(ctx context.Context, codespace *api.Codespace, path string) ([]byte, error) { + return nil, nil + }, + HTTPClientFunc: func() (*http.Client, error) { + return connection.NewMockHttpClient() + }, + } +} + func testingPortsApp() *App { disabledCodespace := &api.Codespace{ Name: "disabledCodespace", From d4668c599ed02f74ad5fc207d51c8dd253ce3a6c Mon Sep 17 00:00:00 2001 From: Peter Admilson Ramaldes Date: Thu, 28 Sep 2023 06:00:54 -0300 Subject: [PATCH 037/527] docs: update the details of fill and fill-first --- pkg/cmd/pr/create/create.go | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index ad1a954cb..d70c2f740 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -105,6 +105,14 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co to push the branch and offer an option to fork the base repository. Use %[1]s--head%[1]s to explicitly skip any forking or pushing behavior. + A prompt will also ask for the title and the body of the pull request. + Use %[1]s--title%[1]s and %[1]s--body%[1]s to skip this, or use + %[1]s--fill%[1]s to autofill these values from git commits. It's + important to notice that if the %[1]s--title%[1]s and/or %[1]s--body%[1]s + are also provided alongside %[1]s--fill%[1]s, the values specified by + %[1]s--title%[1]s and/or %[1]s--body%[1]s will take precedence and + overwrite any autofilled content. + A prompt will also ask for the title and the body of the pull request. Use %[1]s--title%[1]s and %[1]s--body%[1]s to skip this, or use %[1]s--fill%[1]s to autofill these values from git commits. @@ -193,8 +201,8 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co fl.StringVarP(&opts.BaseBranch, "base", "B", "", "The `branch` into which you want your code merged") fl.StringVarP(&opts.HeadBranch, "head", "H", "", "The `branch` that contains commits for your pull request (default: current branch)") fl.BoolVarP(&opts.WebMode, "web", "w", false, "Open the web browser to create a pull request") - fl.BoolVarP(&opts.Autofill, "fill", "f", false, "Do not prompt for title/body and just use commit info (could be overwritten by --title and/or --body)") - fl.BoolVar(&opts.FillFirst, "fill-first", false, "Do not prompt for title/body and just use first commit info (could be overwritten by --title and/or --body)") + fl.BoolVarP(&opts.Autofill, "fill", "f", false, "Use commit info for title and body") + fl.BoolVar(&opts.FillFirst, "fill-first", false, "Use first commit info for title and body") fl.StringSliceVarP(&opts.Reviewers, "reviewer", "r", nil, "Request reviews from people or teams by their `handle`") fl.StringSliceVarP(&opts.Assignees, "assignee", "a", nil, "Assign people by their `login`. Use \"@me\" to self-assign.") fl.StringSliceVarP(&opts.Labels, "label", "l", nil, "Add labels by `name`") From 79296c0a62bfaba134d92f775bd411f8147e7ba2 Mon Sep 17 00:00:00 2001 From: rajhawaldar Date: Fri, 29 Sep 2023 13:02:59 +0530 Subject: [PATCH 038/527] Use camelCase for fields Signed-off-by: rajhawaldar --- pkg/cmd/repo/deploy-key/list/list.go | 4 ++-- pkg/cmd/secret/list/list.go | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pkg/cmd/repo/deploy-key/list/list.go b/pkg/cmd/repo/deploy-key/list/list.go index 11623a679..537599fe5 100644 --- a/pkg/cmd/repo/deploy-key/list/list.go +++ b/pkg/cmd/repo/deploy-key/list/list.go @@ -25,8 +25,8 @@ var deployKeyFields = []string{ "id", "key", "title", - "created_at", - "read_only", + "createdAt", + "readOnly", } func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command { diff --git a/pkg/cmd/secret/list/list.go b/pkg/cmd/secret/list/list.go index b2b01834e..dae097fce 100644 --- a/pkg/cmd/secret/list/list.go +++ b/pkg/cmd/secret/list/list.go @@ -32,11 +32,11 @@ type ListOptions struct { } var secretFields = []string{ - "selected_repos_url", + "selectedReposURL", "name", "visibility", - "updated_at", - "num_selected_repos", + "updatedAt", + "numSelectedRepos", } func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Command { From 6f6e179c49ea728c4925be7fb3bf1f4e9928d250 Mon Sep 17 00:00:00 2001 From: Arun Date: Fri, 29 Sep 2023 11:54:14 -0700 Subject: [PATCH 039/527] Move field value flag and clear flag exclusivity one level higher up to RunE --- pkg/cmd/project/item-edit/item_edit.go | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index d76152b24..8ac2a8f1b 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -83,6 +83,14 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) return err } + if err := cmdutil.MutuallyExclusive( + "cannot use `--text`, `--number`, `--date`, `--single-select-option-id` or `--iteration-id` in conjunction with `--clear`", + opts.text != "" || opts.number != 0 || opts.date != "" || opts.singleSelectOptionID != "" || opts.iterationID != "", + opts.clear, + ); err != nil { + return err + } + client, err := client.New(f) if err != nil { return err @@ -135,9 +143,6 @@ func runEditItem(config editItemConfig) error { // TODO: offer to fetch interactively return cmdutil.FlagErrorf("project-id must be provided for use with the clear flag") } - if config.opts.text != "" || config.opts.number != 0 || config.opts.date != "" || config.opts.singleSelectOptionID != "" || config.opts.iterationID != "" { - return cmdutil.FlagErrorf("cannot use this flag in conjunction with clear") - } query, variables := buildClearItem(config) err := config.client.Mutate("ClearItemFieldValue", query, variables) if err != nil { From 9d81ca0e44f9172b43ae41d2deaaa092bc7c3fcc Mon Sep 17 00:00:00 2001 From: Arun Date: Fri, 29 Sep 2023 11:54:26 -0700 Subject: [PATCH 040/527] Add clear flag usage example --- pkg/cmd/project/item-edit/item_edit.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index 8ac2a8f1b..41d8c4830 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -70,6 +70,9 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) Example: heredoc.Doc(` # edit an item's text field value gh project item-edit --id --field-id --project-id --text "new text" + + # clear an item's field value + gh project item-edit --id --field-id --project-id --clear `), RunE: func(cmd *cobra.Command, args []string) error { if err := cmdutil.MutuallyExclusive( From eebef99b1cd4e6fc28896c500eda7cfc397b55ff Mon Sep 17 00:00:00 2001 From: Arun Date: Fri, 29 Sep 2023 11:56:19 -0700 Subject: [PATCH 041/527] Document clear flag in long form help as well --- pkg/cmd/project/item-edit/item_edit.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index 41d8c4830..6d0d91dc5 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -66,6 +66,8 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) 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. + + Remove project item field value using "--clear" flag. `), Example: heredoc.Doc(` # edit an item's text field value From 45e4bf7fc0a791e78e39c62f8133bbaa50b0bf36 Mon Sep 17 00:00:00 2001 From: Arun Date: Fri, 29 Sep 2023 12:15:35 -0700 Subject: [PATCH 042/527] Split clearing item, updating draft item and updating item values into individual functions for better readability; refactor field ID and project ID presence check into a separate function --- pkg/cmd/project/item-edit/item_edit.go | 142 ++++++++++++++----------- 1 file changed, 80 insertions(+), 62 deletions(-) diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index 6d0d91dc5..f8d66d9e4 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -138,82 +138,23 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) func runEditItem(config editItemConfig) error { // when clear flag is used, remove value set to the corresponding field ID if config.opts.clear { - if config.opts.fieldID == "" && config.opts.projectID == "" { - return cmdutil.FlagErrorf("field-id and project-id must be provided for use with the clear flag") - } - if config.opts.fieldID == "" { - return cmdutil.FlagErrorf("field-id must be provided for use with the clear flag") - } - if config.opts.projectID == "" { - // TODO: offer to fetch interactively - return cmdutil.FlagErrorf("project-id must be provided for use with the clear flag") - } - query, variables := buildClearItem(config) - err := config.client.Mutate("ClearItemFieldValue", query, variables) - if err != nil { + if err := clearItemFieldValue(config); err != nil { return err } - - if config.opts.format == "json" { - return printItemJSON(config, &query.Clear.Item) - } - - return printItemResults(config, &query.Clear.Item) } // 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 { + if err := updateDraftIssue(config); 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 == "" && config.opts.projectID == "" { - return cmdutil.FlagErrorf("field-id and project-id must be provided") - } - 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 { + if err := updateItemValues(config); 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 { @@ -310,3 +251,80 @@ func printItemJSON(config editItemConfig, item *queries.ProjectItem) error { return err } + +func clearItemFieldValue(config editItemConfig) error { + if err := fieldIdAndProjectIdPresence(config); err != nil { + return err + } + query, variables := buildClearItem(config) + err := config.client.Mutate("ClearItemFieldValue", query, variables) + if err != nil { + return err + } + + if config.opts.format == "json" { + return printItemJSON(config, &query.Clear.Item) + } + + return printItemResults(config, &query.Clear.Item) +} + +func updateDraftIssue(config editItemConfig) error { + 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) +} + +func updateItemValues(config editItemConfig) error { + if err := fieldIdAndProjectIdPresence(config); err != nil { + return err + } + + 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) +} + +func fieldIdAndProjectIdPresence(config editItemConfig) error { + if config.opts.fieldID == "" && config.opts.projectID == "" { + return cmdutil.FlagErrorf("field-id and project-id must be provided") + } + 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") + } + return nil +} From 07ee387f25220b0e97455f6266e89a68bc409cfb Mon Sep 17 00:00:00 2001 From: Lars Lehtonen Date: Mon, 2 Oct 2023 00:03:24 -0700 Subject: [PATCH 043/527] pkg/cmd/root: fix startup panic (#8105) --- pkg/cmd/root/root.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/root/root.go b/pkg/cmd/root/root.go index 353b9836a..db591c27b 100644 --- a/pkg/cmd/root/root.go +++ b/pkg/cmd/root/root.go @@ -72,7 +72,8 @@ func NewCmdRoot(f *cmdutil.Factory, version, buildDate string) (*cobra.Command, 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) { - if cmd.Parent().Use == "codespace" { + parent := cmd.Parent() + if parent != nil && parent.Use == "codespace" { fmt.Fprintln(io.ErrOut, "To get started with GitHub CLI, please run: gh auth login -s codespace") } else { fmt.Fprint(io.ErrOut, authHelp()) From c10371605c0b70e07221a90e159784676e186f81 Mon Sep 17 00:00:00 2001 From: "Peter A. Ramaldes" Date: Mon, 2 Oct 2023 14:46:02 -0300 Subject: [PATCH 044/527] Update pkg/cmd/pr/create/create.go Co-authored-by: Andy Feller --- pkg/cmd/pr/create/create.go | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index d70c2f740..3e60a7240 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -105,13 +105,11 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co to push the branch and offer an option to fork the base repository. Use %[1]s--head%[1]s to explicitly skip any forking or pushing behavior. - A prompt will also ask for the title and the body of the pull request. - Use %[1]s--title%[1]s and %[1]s--body%[1]s to skip this, or use - %[1]s--fill%[1]s to autofill these values from git commits. It's - important to notice that if the %[1]s--title%[1]s and/or %[1]s--body%[1]s - are also provided alongside %[1]s--fill%[1]s, the values specified by - %[1]s--title%[1]s and/or %[1]s--body%[1]s will take precedence and - overwrite any autofilled content. + A prompt will also ask for the title and the body of the pull request. Use %[0]s--title%[1]s and + %[1]s--body%[1]s to skip this, or use %[1]s--fill%[1]s to autofill these values from git commits. + It's important to notice that if the %[1]s--title%[1]s and/or %[1]s--body%[1]s are also provided + alongside %[1]s--fill%[1]s, the values specified by %[1]s--title%[1]s and/or %[1]s--body%[1]s will + take precedence and overwrite any autofilled content. A prompt will also ask for the title and the body of the pull request. Use %[1]s--title%[1]s and %[1]s--body%[1]s to skip this, or use %[1]s--fill%[1]s to autofill these values from git commits. From c8b465269e0c2bc800e81c91916681660c7efee1 Mon Sep 17 00:00:00 2001 From: Andy Feller Date: Mon, 2 Oct 2023 11:42:34 -0700 Subject: [PATCH 045/527] Bubble up return value from inner function calls in runEditItem --- pkg/cmd/project/item-edit/item_edit.go | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index f8d66d9e4..c21548a4a 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -138,23 +138,17 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) func runEditItem(config editItemConfig) error { // when clear flag is used, remove value set to the corresponding field ID if config.opts.clear { - if err := clearItemFieldValue(config); err != nil { - return err - } + return clearItemFieldValue(config) } // update draft issue if config.opts.title != "" || config.opts.body != "" { - if err := updateDraftIssue(config); err != nil { - return err - } + return updateDraftIssue(config) } // update item values if config.opts.text != "" || config.opts.number != 0 || config.opts.date != "" || config.opts.singleSelectOptionID != "" || config.opts.iterationID != "" { - if err := updateItemValues(config); err != nil { - return err - } + return updateItemValues(config) } if _, err := fmt.Fprintln(config.io.ErrOut, "error: no changes to make"); err != nil { From 9d04ee6c8de41a5e48bfee8b10e29a80becd192e Mon Sep 17 00:00:00 2001 From: Arun Sathiya Date: Tue, 3 Oct 2023 05:36:47 -0700 Subject: [PATCH 046/527] update(run): Use attempt input when fetching jobs (#7831) * Introduce attempt flag for run watch and use attempt input when fetching jobs * Handle attempt input for 'run watch' commands instead of using the latest attempt * Revert attempt flag implementation for 'run watch' command because it is intended only for the latest attempt * Fix tests for cases when attempt flag is used on 'run view' command --------- Co-authored-by: Andy Feller --- pkg/cmd/run/shared/shared.go | 6 +++++- pkg/cmd/run/view/view.go | 4 ++-- pkg/cmd/run/view/view_test.go | 10 +++++----- pkg/cmd/run/watch/watch.go | 2 +- 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/pkg/cmd/run/shared/shared.go b/pkg/cmd/run/shared/shared.go index cd9d481b8..516e70b50 100644 --- a/pkg/cmd/run/shared/shared.go +++ b/pkg/cmd/run/shared/shared.go @@ -429,7 +429,7 @@ type JobsPayload struct { Jobs []Job } -func GetJobs(client *api.Client, repo ghrepo.Interface, run *Run) ([]Job, error) { +func GetJobs(client *api.Client, repo ghrepo.Interface, run *Run, attempt uint64) ([]Job, error) { if run.Jobs != nil { return run.Jobs, nil } @@ -438,6 +438,10 @@ func GetJobs(client *api.Client, repo ghrepo.Interface, run *Run) ([]Job, error) query.Set("per_page", "100") jobsPath := fmt.Sprintf("%s?%s", run.JobsURL, query.Encode()) + if attempt > 0 { + jobsPath = fmt.Sprintf("repos/%s/actions/runs/%d/attempts/%d/jobs?%s", ghrepo.FullName(repo), run.ID, attempt, query.Encode()) + } + for jobsPath != "" { var resp JobsPayload var err error diff --git a/pkg/cmd/run/view/view.go b/pkg/cmd/run/view/view.go index 6b96c90f8..bc40b66ee 100644 --- a/pkg/cmd/run/view/view.go +++ b/pkg/cmd/run/view/view.go @@ -221,7 +221,7 @@ func runView(opts *ViewOptions) error { if shouldFetchJobs(opts) { opts.IO.StartProgressIndicator() - jobs, err = shared.GetJobs(client, repo, run) + jobs, err = shared.GetJobs(client, repo, run, attempt) opts.IO.StopProgressIndicator() if err != nil { return err @@ -259,7 +259,7 @@ func runView(opts *ViewOptions) error { if selectedJob == nil && len(jobs) == 0 { opts.IO.StartProgressIndicator() - jobs, err = shared.GetJobs(client, repo, run) + jobs, err = shared.GetJobs(client, repo, run, attempt) opts.IO.StopProgressIndicator() if err != nil { return fmt.Errorf("failed to get jobs: %w", err) diff --git a/pkg/cmd/run/view/view_test.go b/pkg/cmd/run/view/view_test.go index 36d563eee..86aab619b 100644 --- a/pkg/cmd/run/view/view_test.go +++ b/pkg/cmd/run/view/view_test.go @@ -256,7 +256,7 @@ func TestViewRun(t *testing.T) { "name": "REPO"}} ]}}}}`)) reg.Register( - httpmock.REST("GET", "runs/3/jobs"), + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/attempts/3/jobs"), httpmock.JSONResponse(shared.JobsPayload{ Jobs: []shared.Job{ shared.SuccessfulJob, @@ -369,7 +369,7 @@ func TestViewRun(t *testing.T) { httpmock.GraphQL(`query PullRequestForRun`), httpmock.StringResponse(``)) reg.Register( - httpmock.REST("GET", "runs/3/jobs"), + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/attempts/3/jobs"), httpmock.JSONResponse(shared.JobsPayload{})) reg.Register( httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), @@ -442,7 +442,7 @@ func TestViewRun(t *testing.T) { httpmock.GraphQL(`query PullRequestForRun`), httpmock.StringResponse(``)) reg.Register( - httpmock.REST("GET", "runs/3/jobs"), + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/attempts/3/jobs"), httpmock.JSONResponse(shared.JobsPayload{ Jobs: []shared.Job{ shared.SuccessfulJob, @@ -616,7 +616,7 @@ func TestViewRun(t *testing.T) { httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/attempts/3"), httpmock.JSONResponse(shared.SuccessfulRun)) reg.Register( - httpmock.REST("GET", "runs/3/jobs"), + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/3/attempts/3/jobs"), httpmock.JSONResponse(shared.JobsPayload{ Jobs: []shared.Job{ shared.SuccessfulJob, @@ -846,7 +846,7 @@ func TestViewRun(t *testing.T) { httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/attempts/3"), httpmock.JSONResponse(shared.FailedRun)) reg.Register( - httpmock.REST("GET", "runs/1234/jobs"), + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/attempts/3/jobs"), httpmock.JSONResponse(shared.JobsPayload{ Jobs: []shared.Job{ shared.SuccessfulJob, diff --git a/pkg/cmd/run/watch/watch.go b/pkg/cmd/run/watch/watch.go index 48d50ed57..27a7ba272 100644 --- a/pkg/cmd/run/watch/watch.go +++ b/pkg/cmd/run/watch/watch.go @@ -207,7 +207,7 @@ func renderRun(out io.Writer, opts WatchOptions, client *api.Client, repo ghrepo return nil, fmt.Errorf("failed to get run: %w", err) } - jobs, err := shared.GetJobs(client, repo, run) + jobs, err := shared.GetJobs(client, repo, run, 0) if err != nil { return nil, fmt.Errorf("failed to get jobs: %w", err) } From 49ec4842116f67fc672c01d393953cf0af22f279 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 3 Oct 2023 16:45:44 +0200 Subject: [PATCH 047/527] Add homebrew-bump-debug workflow (#8114) --- .github/workflows/homebrew-bump.yml | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 .github/workflows/homebrew-bump.yml diff --git a/.github/workflows/homebrew-bump.yml b/.github/workflows/homebrew-bump.yml new file mode 100644 index 000000000..19ecd9d5c --- /dev/null +++ b/.github/workflows/homebrew-bump.yml @@ -0,0 +1,24 @@ +name: homebrew-bump-debug + +permissions: + contents: write + +on: + workflow_dispatch: + inputs: + tag_name: + required: true + type: string + +jobs: + bump: + runs-on: ubuntu-latest + steps: + - name: Bump homebrew-core formula + uses: mislav/bump-homebrew-formula-action@v3 + if: inputs.environment == 'production' && !contains(inputs.tag_name, '-') + with: + formula-name: gh + tag-name: ${{ inputs.tag_name }} + env: + COMMITTER_TOKEN: ${{ secrets.HOMEBREW_PR_PAT }} From aefecbab6515b1b864e381b6a0210cf4f90a0d0a Mon Sep 17 00:00:00 2001 From: Andy Feller Date: Tue, 3 Oct 2023 10:54:44 -0400 Subject: [PATCH 048/527] Update homebrew-bump.yml Adding missing input needed for testing --- .github/workflows/homebrew-bump.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/homebrew-bump.yml b/.github/workflows/homebrew-bump.yml index 19ecd9d5c..2bc395a1e 100644 --- a/.github/workflows/homebrew-bump.yml +++ b/.github/workflows/homebrew-bump.yml @@ -9,7 +9,9 @@ on: tag_name: required: true type: string - + environment: + default: production + type: environment jobs: bump: runs-on: ubuntu-latest From 80e46cabebb378ae9bd70cf341517ba09b195bb1 Mon Sep 17 00:00:00 2001 From: Andy Feller Date: Tue, 3 Oct 2023 11:28:58 -0400 Subject: [PATCH 049/527] Update deployment.yml Update release job to use repository environment needed for homebrew secret --- .github/workflows/deployment.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/deployment.yml b/.github/workflows/deployment.yml index 24d89c83b..11ca5b485 100644 --- a/.github/workflows/deployment.yml +++ b/.github/workflows/deployment.yml @@ -206,6 +206,7 @@ jobs: release: runs-on: ubuntu-latest needs: [linux, macos, windows] + environment: ${{ inputs.environment }} if: inputs.release steps: - name: Checkout cli/cli From 3443a752a9949ee4f954a84f7ab94a4b99df1b27 Mon Sep 17 00:00:00 2001 From: Carl Walsh Date: Tue, 3 Oct 2023 10:20:02 -0700 Subject: [PATCH 050/527] docs: fix typo in pr create (#8115) https://cli.github.com/manual/gh_pr_create shows `BADINDEX` and broken markdown formatting right now. Was very recently introduced in #8080 --- pkg/cmd/pr/create/create.go | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index 3e60a7240..8c1047de7 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -105,15 +105,12 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co to push the branch and offer an option to fork the base repository. Use %[1]s--head%[1]s to explicitly skip any forking or pushing behavior. - A prompt will also ask for the title and the body of the pull request. Use %[0]s--title%[1]s and + A prompt will also ask for the title and the body of the pull request. Use %[1]s--title%[1]s and %[1]s--body%[1]s to skip this, or use %[1]s--fill%[1]s to autofill these values from git commits. It's important to notice that if the %[1]s--title%[1]s and/or %[1]s--body%[1]s are also provided alongside %[1]s--fill%[1]s, the values specified by %[1]s--title%[1]s and/or %[1]s--body%[1]s will take precedence and overwrite any autofilled content. - A prompt will also ask for the title and the body of the pull request. Use %[1]s--title%[1]s - and %[1]s--body%[1]s to skip this, or use %[1]s--fill%[1]s to autofill these values from git commits. - Link an issue to the pull request by referencing the issue in the body of the pull request. If the body text mentions %[1]sFixes #123%[1]s or %[1]sCloses #123%[1]s, the referenced issue will automatically get closed when the pull request gets merged. From 885ccd7424acb8db9519dc972bbac2b67c5a9d3f Mon Sep 17 00:00:00 2001 From: Yuto <39439017+utouto97@users.noreply.github.com> Date: Wed, 11 Oct 2023 17:35:40 +0900 Subject: [PATCH 051/527] Disable issue with template (#7918) * allow --disable-issues option with --template * add a test case for creating repo with --disable-issues --template --- pkg/cmd/repo/create/create.go | 4 +- pkg/cmd/repo/create/http.go | 12 +++--- pkg/cmd/repo/create/http_test.go | 70 +++++++++++++++++++++++++++++++- 3 files changed, 77 insertions(+), 9 deletions(-) diff --git a/pkg/cmd/repo/create/create.go b/pkg/cmd/repo/create/create.go index 3cc1d2f62..f56a59ce2 100644 --- a/pkg/cmd/repo/create/create.go +++ b/pkg/cmd/repo/create/create.go @@ -164,8 +164,8 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co if cmd.Flags().Changed("enable-wiki") { opts.DisableWiki = !enableWiki } - if opts.Template != "" && (opts.Homepage != "" || opts.Team != "" || opts.DisableIssues) { - return cmdutil.FlagErrorf("the `--template` option is not supported with `--homepage`, `--team`, or `--disable-issues`") + if opts.Template != "" && (opts.Homepage != "" || opts.Team != "") { + return cmdutil.FlagErrorf("the `--template` option is not supported with `--homepage`, or `--team`") } if opts.Template == "" && opts.IncludeAllBranches { diff --git a/pkg/cmd/repo/create/http.go b/pkg/cmd/repo/create/http.go index d3a077300..8142f8133 100644 --- a/pkg/cmd/repo/create/http.go +++ b/pkg/cmd/repo/create/http.go @@ -65,8 +65,9 @@ type cloneTemplateRepositoryInput struct { } type updateRepositoryInput struct { - RepositoryID string `json:"repositoryId"` - HasWikiEnabled bool `json:"hasWikiEnabled"` + RepositoryID string `json:"repositoryId"` + HasWikiEnabled bool `json:"hasWikiEnabled"` + HasIssuesEnabled bool `json:"hasIssuesEnabled"` } // repoCreate creates a new GitHub repository @@ -138,11 +139,12 @@ func repoCreate(client *http.Client, hostname string, input repoCreateInput) (*a return nil, err } - if !input.HasWikiEnabled { + if !input.HasWikiEnabled || !input.HasIssuesEnabled { updateVariables := map[string]interface{}{ "input": updateRepositoryInput{ - RepositoryID: response.CloneTemplateRepository.Repository.ID, - HasWikiEnabled: input.HasWikiEnabled, + RepositoryID: response.CloneTemplateRepository.Repository.ID, + HasWikiEnabled: input.HasWikiEnabled, + HasIssuesEnabled: input.HasIssuesEnabled, }, } diff --git a/pkg/cmd/repo/create/http_test.go b/pkg/cmd/repo/create/http_test.go index 7ebeb93b8..86831899d 100644 --- a/pkg/cmd/repo/create/http_test.go +++ b/pkg/cmd/repo/create/http_test.go @@ -287,8 +287,74 @@ func Test_repoCreate(t *testing.T) { }`, func(inputs map[string]interface{}) { assert.Equal(t, map[string]interface{}{ - "repositoryId": "REPOID", - "hasWikiEnabled": false, + "repositoryId": "REPOID", + "hasWikiEnabled": false, + "hasIssuesEnabled": true, + }, inputs) + }), + ) + }, + wantRepo: "https://github.com/OWNER/REPO", + }, + { + name: "create personal repo from template repo, and disable issues", + hostname: "github.com", + input: repoCreateInput{ + Name: "gen-project", + Description: "my generated project", + Visibility: "private", + TemplateRepositoryID: "TPLID", + HasIssuesEnabled: false, + HasWikiEnabled: true, + IncludeAllBranches: false, + }, + stubs: func(t *testing.T, r *httpmock.Registry) { + r.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data": {"viewer": {"id":"USERID"} } }`)) + r.Register( + httpmock.GraphQL(`mutation CloneTemplateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "cloneTemplateRepository": { + "repository": { + "id": "REPOID", + "name": "REPO", + "owner": {"login":"OWNER"}, + "url": "the://URL" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "name": "gen-project", + "description": "my generated project", + "visibility": "PRIVATE", + "ownerId": "USERID", + "repositoryId": "TPLID", + "includeAllBranches": false, + }, inputs) + }), + ) + r.Register( + httpmock.GraphQL(`mutation UpdateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "updateRepository": { + "repository": { + "id": "REPOID" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "repositoryId": "REPOID", + "hasWikiEnabled": true, + "hasIssuesEnabled": false, }, inputs) }), ) From 363dacbbed8cc9f86026ec1b1e38c6dca0d78c08 Mon Sep 17 00:00:00 2001 From: Keith Bailey Date: Wed, 11 Oct 2023 09:41:00 -0400 Subject: [PATCH 052/527] Set default repository for `repo clone` and `repo fork` (#7768) --- pkg/cmd/repo/clone/clone.go | 17 ++++++++++++++--- pkg/cmd/repo/clone/clone_test.go | 4 ++++ pkg/cmd/repo/fork/fork.go | 16 +++++++++++++--- pkg/cmd/repo/fork/fork_test.go | 18 +++++++++++++----- 4 files changed, 44 insertions(+), 11 deletions(-) diff --git a/pkg/cmd/repo/clone/clone.go b/pkg/cmd/repo/clone/clone.go index 8d04ac630..174951243 100644 --- a/pkg/cmd/repo/clone/clone.go +++ b/pkg/cmd/repo/clone/clone.go @@ -53,6 +53,8 @@ func NewCmdClone(f *cmdutil.Factory, runF func(*CloneOptions) error) *cobra.Comm git remote called "upstream". The remote name can be configured using %[1]s--upstream-remote-name%[1]s. The %[1]s--upstream-remote-name%[1]s option supports an "@owner" value which will name the remote after the owner of the parent repository. + + If the repository is a fork, its parent repository will be set as the default remote repository. `, "`"), RunE: func(cmd *cobra.Command, args []string) error { opts.Repository = args[0] @@ -162,7 +164,7 @@ func cloneRun(opts *CloneOptions) error { return err } - // If the repo is a fork, add the parent as an upstream + // If the repo is a fork, add the parent as an upstream remote and set the parent as the default repo. if canonicalRepo.Parent != nil { protocol, err := cfg.GetOrDefault(canonicalRepo.Parent.RepoHost(), "git_protocol") if err != nil { @@ -178,8 +180,7 @@ func cloneRun(opts *CloneOptions) error { gc := gitClient.Copy() gc.RepoDir = cloneDir - _, err = gc.AddRemote(ctx, upstreamName, upstreamURL, []string{canonicalRepo.Parent.DefaultBranchRef.Name}) - if err != nil { + if _, err := gc.AddRemote(ctx, upstreamName, upstreamURL, []string{canonicalRepo.Parent.DefaultBranchRef.Name}); err != nil { return err } @@ -190,6 +191,16 @@ func cloneRun(opts *CloneOptions) error { if err := gc.SetRemoteBranches(ctx, upstreamName, `*`); err != nil { return err } + + if err = gc.SetRemoteResolution(ctx, upstreamName, "base"); err != nil { + return err + } + + connectedToTerminal := opts.IO.IsStdoutTTY() + if connectedToTerminal { + cs := opts.IO.ColorScheme() + fmt.Fprintf(opts.IO.ErrOut, "%s Repository %s set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", cs.WarningIcon(), cs.Bold(ghrepo.FullName(canonicalRepo.Parent))) + } } return nil } diff --git a/pkg/cmd/repo/clone/clone_test.go b/pkg/cmd/repo/clone/clone_test.go index 0ea3a65af..9546b6f08 100644 --- a/pkg/cmd/repo/clone/clone_test.go +++ b/pkg/cmd/repo/clone/clone_test.go @@ -219,6 +219,7 @@ func Test_RepoClone(t *testing.T) { func Test_RepoClone_hasParent(t *testing.T) { reg := &httpmock.Registry{} + defer reg.Verify(t) reg.Register( httpmock.GraphQL(`query RepositoryInfo\b`), httpmock.StringResponse(` @@ -248,6 +249,7 @@ func Test_RepoClone_hasParent(t *testing.T) { 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, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") _, err := runCloneCommand(httpClient, "OWNER/REPO") if err != nil { @@ -257,6 +259,7 @@ func Test_RepoClone_hasParent(t *testing.T) { func Test_RepoClone_hasParent_upstreamRemoteName(t *testing.T) { reg := &httpmock.Registry{} + defer reg.Verify(t) reg.Register( httpmock.GraphQL(`query RepositoryInfo\b`), httpmock.StringResponse(` @@ -286,6 +289,7 @@ func Test_RepoClone_hasParent_upstreamRemoteName(t *testing.T) { 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, "") + cs.Register(`git -C REPO config --add remote.test.gh-resolved base`, 0, "") _, err := runCloneCommand(httpClient, "OWNER/REPO --upstream-remote-name test") if err != nil { diff --git a/pkg/cmd/repo/fork/fork.go b/pkg/cmd/repo/fork/fork.go index 0d2d1da69..e31a6a3c9 100644 --- a/pkg/cmd/repo/fork/fork.go +++ b/pkg/cmd/repo/fork/fork.go @@ -92,6 +92,8 @@ func NewCmdFork(f *cmdutil.Factory, runF func(*ForkOptions) error) *cobra.Comman origin remote is renamed to "upstream". To alter this behavior, you can set a name for the new fork's remote with %[1]s--remote-name%[1]s. + The "upstream" remote will be set as the default remote repository. + Additional git clone flags can be passed after %[1]s--%[1]s. `, "`"), RunE: func(cmd *cobra.Command, args []string) error { @@ -350,18 +352,26 @@ func forkRun(opts *ForkOptions) error { return fmt.Errorf("failed to clone fork: %w", err) } + gc := gitClient.Copy() + gc.RepoDir = cloneDir upstreamURL := ghrepo.FormatRemoteURL(repoToFork, protocol) - _, err = gitClient.AddRemote(ctx, "upstream", upstreamURL, []string{}, git.WithRepoDir(cloneDir)) - if err != nil { + upstreamRemote := "upstream" + + if _, err := gc.AddRemote(ctx, upstreamRemote, upstreamURL, []string{}); err != nil { return err } - if err := gitClient.Fetch(ctx, "upstream", "", git.WithRepoDir(cloneDir)); err != nil { + if err := gc.SetRemoteResolution(ctx, upstreamRemote, "base"); err != nil { + return err + } + + if err := gc.Fetch(ctx, upstreamRemote, ""); err != nil { return err } if connectedToTerminal { fmt.Fprintf(stderr, "%s Cloned fork\n", cs.SuccessIcon()) + fmt.Fprintf(stderr, "%s Repository %s set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", cs.WarningIcon(), cs.Bold(ghrepo.FullName(repoToFork))) } } } diff --git a/pkg/cmd/repo/fork/fork_test.go b/pkg/cmd/repo/fork/fork_test.go index f59fba1b7..c0aa32bbd 100644 --- a/pkg/cmd/repo/fork/fork_test.go +++ b/pkg/cmd/repo/fork/fork_test.go @@ -442,8 +442,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone --depth 1 https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n", + wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg fork to org", @@ -473,8 +474,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/gamehendge/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "✓ Created fork gamehendge/REPO\n✓ Cloned fork\n", + wantErrOut: "✓ Created fork gamehendge/REPO\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg url arg", @@ -488,8 +490,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n", + wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg interactive no clone", @@ -523,8 +526,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n", + wantErrOut: "✓ Created fork someone/REPO\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg interactive already forked", @@ -546,8 +550,9 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, - wantErrOut: "! someone/REPO already exists\n✓ Cloned fork\n", + wantErrOut: "! someone/REPO already exists\n✓ Cloned fork\n! Repository OWNER/REPO set as the default repository. To learn more about the default repository, run: gh repo set-default --help\n", }, { name: "repo arg nontty no flags", @@ -581,6 +586,7 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, wantErrOut: "someone/REPO already exists\n", }, @@ -595,6 +601,7 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, }, { @@ -684,6 +691,7 @@ func TestRepoFork(t *testing.T) { cs.Register(`git clone https://github.com/someone/REPO\.git`, 0, "") cs.Register(`git -C REPO remote add upstream https://github\.com/OWNER/REPO\.git`, 0, "") cs.Register(`git -C REPO fetch upstream`, 0, "") + cs.Register(`git -C REPO config --add remote.upstream.gh-resolved base`, 0, "") }, }, { From 776fdf5bb2fd033e31f67a342bf22ead05821e44 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Thu, 12 Oct 2023 14:06:20 +0200 Subject: [PATCH 053/527] Update dependencies to fix security vulnerability (#8176) --- go.mod | 12 ++++++------ go.sum | 19 ++++++++++--------- 2 files changed, 16 insertions(+), 15 deletions(-) diff --git a/go.mod b/go.mod index 376480ecc..96bbc113a 100644 --- a/go.mod +++ b/go.mod @@ -37,10 +37,10 @@ require ( github.com/spf13/pflag v1.0.5 github.com/stretchr/testify v1.8.4 github.com/zalando/go-keyring v0.2.3 - golang.org/x/crypto v0.12.0 + golang.org/x/crypto v0.14.0 golang.org/x/sync v0.1.0 - golang.org/x/term v0.11.0 - golang.org/x/text v0.12.0 + golang.org/x/term v0.13.0 + golang.org/x/text v0.13.0 google.golang.org/grpc v1.53.0 google.golang.org/protobuf v1.28.1 gopkg.in/h2non/gock.v1 v1.1.2 @@ -70,7 +70,7 @@ require ( github.com/kr/text v0.2.0 // 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.21 // indirect + github.com/microcosm-cc/bluemonday v1.0.26 // indirect github.com/muesli/reflow v0.3.0 // indirect github.com/muesli/termenv v0.13.0 // indirect github.com/olekukonko/tablewriter v0.0.5 // indirect @@ -83,8 +83,8 @@ require ( github.com/thlib/go-timezone-local v0.0.0-20210907160436-ef149e42d28e // indirect github.com/yuin/goldmark v1.5.2 // indirect github.com/yuin/goldmark-emoji v1.0.1 // indirect - golang.org/x/net v0.14.0 // indirect - golang.org/x/sys v0.11.0 // indirect + golang.org/x/net v0.17.0 // indirect + golang.org/x/sys v0.13.0 // indirect google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f // indirect gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect ) diff --git a/go.sum b/go.sum index a6c982abb..a6e30ac16 100644 --- a/go.sum +++ b/go.sum @@ -115,8 +115,9 @@ github.com/mattn/go-runewidth v0.0.14/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE= github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d h1:5PJl274Y63IEHC+7izoQE9x6ikvDFZS2mDVS3drnohI= github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE= -github.com/microcosm-cc/bluemonday v1.0.21 h1:dNH3e4PSyE4vNX+KlRGHT5KrSvjeUkoNPwEORjffHJg= github.com/microcosm-cc/bluemonday v1.0.21/go.mod h1:ytNkv4RrDrLJ2pqlsSI46O6IVXmZOBBD4SaJyDwwTkM= +github.com/microcosm-cc/bluemonday v1.0.26 h1:xbqSvqzQMeEHCqMi64VAs4d8uy6Mequs3rQ0k/Khz58= +github.com/microcosm-cc/bluemonday v1.0.26/go.mod h1:JyzOCs9gkyQyjs+6h10UEVSe02CGwkhd72Xdqh78TWs= github.com/microsoft/dev-tunnels v0.0.21 h1:p4QP7C5ZOyP9bGbmanRjPxUMckfi9Z41Gl+KY4C11w0= github.com/microsoft/dev-tunnels v0.0.21/go.mod h1:frU++12T/oqxckXkDpTuYa427ncguEOodSPZcGCCrzQ= github.com/muesli/reflow v0.2.1-0.20210115123740-9e1d0d53df68/go.mod h1:Xk+z4oIWdQqJzsxyjgl3P22oYZnHdZ8FFTHAQQt5BMQ= @@ -184,8 +185,8 @@ golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qx 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.0.0-20221002022538-bcab6841153b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= -golang.org/x/net v0.14.0 h1:BONx9s002vGdD9umnlX1Po8vOZmrgH34qlHcD1MfK14= -golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI= +golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= +golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= golang.org/x/oauth2 v0.4.0 h1:NF0gk8LVPg1Ml7SSbGyySuoxdsXitj7TvgvuRxIMc/M= golang.org/x/oauth2 v0.4.0/go.mod h1:RznEsdpjGAINPTOF0UH/t+xJ75L18YO3Ho6Pyn+uRec= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -207,20 +208,20 @@ golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBc 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/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM= -golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE= +golang.org/x/sys v0.13.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-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= -golang.org/x/term v0.11.0 h1:F9tnn/DA/Im8nCwm+fX+1/eBwi4qFjRT++MhtVC4ZX0= -golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU= +golang.org/x/term v0.13.0 h1:bb+I9cTfFazGW51MZqBVmZy7+JEJMouUHTUSKVQLBek= +golang.org/x/term v0.13.0/go.mod h1:LTmsnFJwVN6bCy1rVCoS+qHT1HhALEFxKncY3WNNh4U= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 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.12.0 h1:k+n5B8goJNdU7hSvEtMUz3d1Q6D/XW4COJSJR6fN0mc= -golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k= +golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.10/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E= From 7d6fba0d7d6088c67e1ff6861ea30b4d62eab3a4 Mon Sep 17 00:00:00 2001 From: Jun Nishimura Date: Fri, 13 Oct 2023 00:53:05 +0900 Subject: [PATCH 054/527] Create repositories from templates in interactive mode (#7769) --- pkg/cmd/repo/create/create.go | 133 +++++++++++++++++- pkg/cmd/repo/create/create_test.go | 125 ++++++++++++++++ .../repo/create/fixtures/repoTempList.json | 25 ++++ pkg/cmd/repo/create/http.go | 68 +++++++++ 4 files changed, 346 insertions(+), 5 deletions(-) create mode 100644 pkg/cmd/repo/create/fixtures/repoTempList.json diff --git a/pkg/cmd/repo/create/create.go b/pkg/cmd/repo/create/create.go index f56a59ce2..4a94c05a2 100644 --- a/pkg/cmd/repo/create/create.go +++ b/pkg/cmd/repo/create/create.go @@ -248,20 +248,26 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co } func createRun(opts *CreateOptions) error { - fromScratch := opts.Source == "" - if opts.Interactive { - selected, err := opts.Prompter.Select("What would you like to do?", "", []string{ + answer, err := opts.Prompter.Select("What would you like to do?", "", []string{ "Create a new repository on GitHub from scratch", + "Create a new repository on GitHub from a template repository", "Push an existing local repository to GitHub", }) if err != nil { return err } - fromScratch = selected == 0 + switch answer { + case 0: + return createFromScratch(opts) + case 1: + return createFromTemplate(opts) + case 2: + return createFromLocal(opts) + } } - if fromScratch { + if opts.Source == "" { return createFromScratch(opts) } return createFromLocal(opts) @@ -404,6 +410,102 @@ func createFromScratch(opts *CreateOptions) error { } else if err := cloneWithRetry(opts, remoteURL, templateRepoMainBranch); err != nil { return err } + + } + + return nil +} + +// create new repo on remote host from template repo +func createFromTemplate(opts *CreateOptions) error { + httpClient, err := opts.HttpClient() + if err != nil { + return err + } + + cfg, err := opts.Config() + if err != nil { + return err + } + + host, _ := cfg.Authentication().DefaultHost() + + opts.Name, opts.Description, opts.Visibility, err = interactiveRepoInfo(httpClient, host, opts.Prompter, "") + if err != nil { + return err + } + + if !strings.Contains(opts.Name, "/") { + username, _, err := userAndOrgs(httpClient, host) + if err != nil { + return err + } + opts.Name = fmt.Sprintf("%s/%s", username, opts.Name) + } + repoToCreate, err := ghrepo.FromFullName(opts.Name) + if err != nil { + return fmt.Errorf("argument error: %w", err) + } + + templateRepo, err := interactiveRepoTemplate(httpClient, host, repoToCreate.RepoOwner(), opts.Prompter) + if err != nil { + return err + } + input := repoCreateInput{ + Name: repoToCreate.RepoName(), + Visibility: opts.Visibility, + OwnerLogin: repoToCreate.RepoOwner(), + TeamSlug: opts.Team, + Description: opts.Description, + HomepageURL: opts.Homepage, + HasIssuesEnabled: !opts.DisableIssues, + HasWikiEnabled: !opts.DisableWiki, + GitIgnoreTemplate: opts.GitIgnoreTemplate, + LicenseTemplate: opts.LicenseTemplate, + IncludeAllBranches: opts.IncludeAllBranches, + InitReadme: opts.AddReadme, + TemplateRepositoryID: templateRepo.ID, + } + templateRepoMainBranch := templateRepo.DefaultBranchRef.Name + + targetRepo := shared.NormalizeRepoName(opts.Name) + if idx := strings.IndexRune(opts.Name, '/'); idx > 0 { + targetRepo = opts.Name[0:idx+1] + shared.NormalizeRepoName(opts.Name[idx+1:]) + } + confirmed, err := opts.Prompter.Confirm(fmt.Sprintf(`This will create "%s" as a %s repository on GitHub. Continue?`, targetRepo, strings.ToLower(opts.Visibility)), true) + if err != nil { + return err + } else if !confirmed { + return cmdutil.CancelError + } + + repo, err := repoCreate(httpClient, repoToCreate.RepoHost(), input) + if err != nil { + return err + } + + cs := opts.IO.ColorScheme() + fmt.Fprintf(opts.IO.Out, + "%s Created repository %s on GitHub\n", + cs.SuccessIconWithColor(cs.Green), + ghrepo.FullName(repo)) + + opts.Clone, err = opts.Prompter.Confirm("Clone the new repository locally?", true) + if err != nil { + return err + } + + if opts.Clone { + protocol, err := cfg.GetOrDefault(repo.RepoHost(), "git_protocol") + if err != nil { + return err + } + + remoteURL := ghrepo.FormatRemoteURL(repo, protocol) + + if err := cloneWithRetry(opts, remoteURL, templateRepoMainBranch); err != nil { + return err + } } return nil @@ -678,6 +780,27 @@ func localInit(gitClient *git.Client, remoteURL, path string) error { return nil } +func interactiveRepoTemplate(client *http.Client, hostname, owner string, prompter iprompter) (*api.Repository, error) { + templateRepos, err := listTemplateRepositories(client, hostname, owner) + if err != nil { + return nil, err + } + if len(templateRepos) == 0 { + return nil, fmt.Errorf("%s has no template repositories", owner) + } + + var templates []string + for _, repo := range templateRepos { + templates = append(templates, repo.Name) + } + + selected, err := prompter.Select("Choose a template repository", "", templates) + if err != nil { + return nil, err + } + return &templateRepos[selected], nil +} + func interactiveGitIgnore(client *http.Client, hostname string, prompter iprompter) (string, error) { confirmed, err := prompter.Confirm("Would you like to add a .gitignore?", false) if err != nil { diff --git a/pkg/cmd/repo/create/create_test.go b/pkg/cmd/repo/create/create_test.go index b0d21460e..58e897628 100644 --- a/pkg/cmd/repo/create/create_test.go +++ b/pkg/cmd/repo/create/create_test.go @@ -510,6 +510,131 @@ func Test_createRun(t *testing.T) { }, wantStdout: "✓ Created repository OWNER/REPO on GitHub\n✓ Added remote https://github.com/OWNER/REPO.git\n✓ Pushed commits to https://github.com/OWNER/REPO.git\n", }, + { + name: "interactive create from a template repository", + opts: &CreateOptions{Interactive: true}, + tty: true, + promptStubs: func(p *prompter.PrompterMock) { + p.ConfirmFunc = func(message string, defaultValue bool) (bool, error) { + switch message { + case `This will create "OWNER/REPO" as a private repository on GitHub. Continue?`: + return defaultValue, nil + case "Clone the new repository locally?": + return defaultValue, nil + default: + return false, fmt.Errorf("unexpected confirm prompt: %s", message) + } + } + p.InputFunc = func(message, defaultValue string) (string, error) { + switch message { + case "Repository name": + return "REPO", nil + case "Description": + return "my new repo", nil + default: + return "", fmt.Errorf("unexpected input prompt: %s", message) + } + } + p.SelectFunc = func(message, defaultValue string, options []string) (int, error) { + switch message { + case "Repository owner": + return prompter.IndexFor(options, "OWNER") + case "Choose a template repository": + return prompter.IndexFor(options, "REPO") + case "What would you like to do?": + return prompter.IndexFor(options, "Create a new repository on GitHub from a template repository") + case "Visibility": + return prompter.IndexFor(options, "Private") + default: + return 0, fmt.Errorf("unexpected select prompt: %s", message) + } + } + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"OWNER","organizations":{"nodes": []}}}}`)) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"OWNER","organizations":{"nodes": []}}}}`)) + reg.Register( + httpmock.GraphQL(`query RepositoryList\b`), + httpmock.FileResponse("./fixtures/repoTempList.json")) + reg.Register( + httpmock.REST("GET", "users/OWNER"), + httpmock.StringResponse(`{"login":"OWNER","type":"User"}`)) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"id":"OWNER"}}}`)) + reg.Register( + httpmock.GraphQL(`mutation CloneTemplateRepository\b`), + httpmock.StringResponse(` + { + "data": { + "cloneTemplateRepository": { + "repository": { + "id": "REPOID", + "name": "REPO", + "owner": {"login":"OWNER"}, + "url": "https://github.com/OWNER/REPO" + } + } + } + }`)) + }, + execStubs: func(cs *run.CommandStubber) { + cs.Register(`git clone --branch main https://github.com/OWNER/REPO`, 0, "") + }, + wantStdout: "✓ Created repository OWNER/REPO on GitHub\n", + }, + { + name: "interactive create from template repo but there are no template repos", + opts: &CreateOptions{Interactive: true}, + tty: true, + promptStubs: func(p *prompter.PrompterMock) { + p.ConfirmFunc = func(message string, defaultValue bool) (bool, error) { + switch message { + default: + return false, fmt.Errorf("unexpected confirm prompt: %s", message) + } + } + p.InputFunc = func(message, defaultValue string) (string, error) { + switch message { + case "Repository name": + return "REPO", nil + case "Description": + return "my new repo", nil + default: + return "", fmt.Errorf("unexpected input prompt: %s", message) + } + } + p.SelectFunc = func(message, defaultValue string, options []string) (int, error) { + switch message { + case "What would you like to do?": + return prompter.IndexFor(options, "Create a new repository on GitHub from a template repository") + case "Visibility": + return prompter.IndexFor(options, "Private") + default: + return 0, fmt.Errorf("unexpected select prompt: %s", message) + } + } + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"OWNER","organizations":{"nodes": []}}}}`)) + reg.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data":{"viewer":{"login":"OWNER","organizations":{"nodes": []}}}}`)) + reg.Register( + httpmock.GraphQL(`query RepositoryList\b`), + httpmock.StringResponse(`{"data":{"repositoryOwner":{"login":"OWNER","repositories":{"nodes":[]},"totalCount":0,"pageInfo":{"hasNextPage":false,"endCursor":""}}}}`)) + }, + execStubs: func(cs *run.CommandStubber) {}, + wantStdout: "", + wantErr: true, + errMsg: "OWNER has no template repositories", + }, { name: "noninteractive create from scratch", opts: &CreateOptions{ diff --git a/pkg/cmd/repo/create/fixtures/repoTempList.json b/pkg/cmd/repo/create/fixtures/repoTempList.json new file mode 100644 index 000000000..9fbe46c51 --- /dev/null +++ b/pkg/cmd/repo/create/fixtures/repoTempList.json @@ -0,0 +1,25 @@ +{ + "data": { + "repositoryOwner": { + "login": "OWNER", + "repositories": { + "nodes": [ + { + "id": "REPOID", + "name": "REPO", + "isTemplate": true, + "pushedAt": "2021-02-19T06:34:58Z", + "defaultBranchRef": { + "name": "main" + } + } + ] + }, + "totalCount": 0, + "pageInfo": { + "hasNextPage": false, + "endCursor": "" + } + } + } +} \ No newline at end of file diff --git a/pkg/cmd/repo/create/http.go b/pkg/cmd/repo/create/http.go index 8142f8133..86024a254 100644 --- a/pkg/cmd/repo/create/http.go +++ b/pkg/cmd/repo/create/http.go @@ -8,6 +8,7 @@ import ( "strings" "github.com/cli/cli/v2/api" + "github.com/shurcooL/githubv4" ) // repoCreateInput is input parameters for the repoCreate method @@ -264,6 +265,73 @@ func resolveOrganizationTeam(client *api.Client, hostname, orgName, teamSlug str return &response, err } +func listTemplateRepositories(client *http.Client, hostname, owner string) ([]api.Repository, error) { + ownerConnection := "repositoryOwner(login: $owner)" + + variables := map[string]interface{}{ + "perPage": githubv4.Int(100), + "owner": githubv4.String(owner), + } + inputs := []string{"$perPage:Int!", "$endCursor:String", "$owner:String!"} + + type result struct { + RepositoryOwner struct { + Login string + Repositories struct { + Nodes []api.Repository + TotalCount int + PageInfo struct { + HasNextPage bool + EndCursor string + } + } + } + } + + query := fmt.Sprintf(`query RepositoryList(%s) { + %s { + login + repositories(first: $perPage, after: $endCursor, ownerAffiliations: OWNER, orderBy: { field: PUSHED_AT, direction: DESC }) { + nodes{ + id + name + isTemplate + defaultBranchRef { + name + } + } + totalCount + pageInfo{hasNextPage,endCursor} + } + } + }`, strings.Join(inputs, ","), ownerConnection) + + apiClient := api.NewClientFromHTTP(client) + var templateRepositories []api.Repository + for { + var res result + err := apiClient.GraphQL(hostname, query, variables, &res) + if err != nil { + return nil, err + } + + owner := res.RepositoryOwner + + for _, repo := range owner.Repositories.Nodes { + if repo.IsTemplate { + templateRepositories = append(templateRepositories, repo) + } + } + + if !owner.Repositories.PageInfo.HasNextPage { + break + } + variables["endCursor"] = githubv4.String(owner.Repositories.PageInfo.EndCursor) + } + + return templateRepositories, nil +} + // listGitIgnoreTemplates uses API v3 here because gitignore template isn't supported by GraphQL yet. func listGitIgnoreTemplates(httpClient *http.Client, hostname string) ([]string, error) { var gitIgnoreTemplates []string From 64f4660ec71a46a7c7089ca81c0366de4cc9b000 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Thu, 12 Oct 2023 15:16:36 -0700 Subject: [PATCH 055/527] Migrate all Codespaces operations from Live Share to Dev Tunnels (#8149) * Migrate all Codespaces operations from Live Share to Dev Tunnels * Remove Live Share references * Fix linting errors * Update comments, remove deps, add uint16 bound checks * Fix tests and move keep-alive logic to forwarder * Address comments * Updated mock port forwarder * Fix CodeQL error * Update comment * Update func name * Add missing connection close * Fix linting error * https -> http * Update defer * Fix tests --- .github/CODEOWNERS | 1 - go.mod | 3 +- go.sum | 7 +- internal/codespaces/api/api.go | 5 - internal/codespaces/codespaces.go | 58 +-- .../portforwarder/port_forwarder.go | 324 ++++++++++++---- internal/codespaces/rpc/invoker.go | 22 +- internal/codespaces/rpc/invoker_test.go | 3 +- internal/codespaces/rpc/test/channel.go | 34 -- .../codespaces/rpc/test/port_forwarder.go | 78 ++++ internal/codespaces/rpc/test/session.go | 43 --- internal/codespaces/states.go | 28 +- pkg/cmd/codespace/common.go | 28 -- pkg/cmd/codespace/jupyter.go | 20 +- pkg/cmd/codespace/logs.go | 21 +- pkg/cmd/codespace/ports.go | 6 +- pkg/cmd/codespace/rebuild.go | 14 +- pkg/cmd/codespace/ssh.go | 150 ++++---- pkg/liveshare/client.go | 130 ------- pkg/liveshare/client_test.go | 73 ---- pkg/liveshare/options_test.go | 56 --- pkg/liveshare/port_forwarder.go | 241 ------------ pkg/liveshare/port_forwarder_test.go | 153 -------- pkg/liveshare/ports.go | 101 ----- pkg/liveshare/rpc.go | 87 ----- pkg/liveshare/session.go | 133 ------- pkg/liveshare/session_test.go | 278 -------------- pkg/liveshare/socket.go | 100 ----- pkg/liveshare/ssh.go | 79 ---- pkg/liveshare/test/server.go | 349 ------------------ pkg/liveshare/test/socket.go | 77 ---- 31 files changed, 491 insertions(+), 2211 deletions(-) delete mode 100644 internal/codespaces/rpc/test/channel.go create mode 100644 internal/codespaces/rpc/test/port_forwarder.go delete mode 100644 internal/codespaces/rpc/test/session.go delete mode 100644 pkg/liveshare/client.go delete mode 100644 pkg/liveshare/client_test.go delete mode 100644 pkg/liveshare/options_test.go delete mode 100644 pkg/liveshare/port_forwarder.go delete mode 100644 pkg/liveshare/port_forwarder_test.go delete mode 100644 pkg/liveshare/ports.go delete mode 100644 pkg/liveshare/rpc.go delete mode 100644 pkg/liveshare/session.go delete mode 100644 pkg/liveshare/session_test.go delete mode 100644 pkg/liveshare/socket.go delete mode 100644 pkg/liveshare/ssh.go delete mode 100644 pkg/liveshare/test/server.go delete mode 100644 pkg/liveshare/test/socket.go diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4b9029313..cd5695abc 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,5 +1,4 @@ * @cli/code-reviewers pkg/cmd/codespace/ @cli/codespaces -pkg/liveshare/ @cli/codespaces internal/codespaces/ @cli/codespaces diff --git a/go.mod b/go.mod index 96bbc113a..cc56bda51 100644 --- a/go.mod +++ b/go.mod @@ -27,12 +27,11 @@ require ( github.com/mattn/go-colorable v0.1.13 github.com/mattn/go-isatty v0.0.19 github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d - github.com/microsoft/dev-tunnels v0.0.21 + github.com/microsoft/dev-tunnels v0.0.25 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-20230704064427-599ae7bbf278 - 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.4 diff --git a/go.sum b/go.sum index a6e30ac16..c1160707a 100644 --- a/go.sum +++ b/go.sum @@ -67,7 +67,6 @@ github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 h1:El6M4kTTCOh6aBiKaU github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510/go.mod h1:pupxD2MaaD3pAXIBCelhxNneeOaAeabZDe5s4K6zSpQ= github.com/gorilla/css v1.0.0 h1:BQqNyPTi50JCFMTw/b67hByjMVXZRwGha6wxVGkeihY= github.com/gorilla/css v1.0.0/go.mod h1:Dn721qIggHpt4+EFCcTLTU/vk5ySda2ReITrtgBl60c= -github.com/gorilla/websocket v1.4.1/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/adAjf1fMHhE= 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= @@ -118,8 +117,8 @@ github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d/go.mod h1:01TrycV0kFyex github.com/microcosm-cc/bluemonday v1.0.21/go.mod h1:ytNkv4RrDrLJ2pqlsSI46O6IVXmZOBBD4SaJyDwwTkM= github.com/microcosm-cc/bluemonday v1.0.26 h1:xbqSvqzQMeEHCqMi64VAs4d8uy6Mequs3rQ0k/Khz58= github.com/microcosm-cc/bluemonday v1.0.26/go.mod h1:JyzOCs9gkyQyjs+6h10UEVSe02CGwkhd72Xdqh78TWs= -github.com/microsoft/dev-tunnels v0.0.21 h1:p4QP7C5ZOyP9bGbmanRjPxUMckfi9Z41Gl+KY4C11w0= -github.com/microsoft/dev-tunnels v0.0.21/go.mod h1:frU++12T/oqxckXkDpTuYa427ncguEOodSPZcGCCrzQ= +github.com/microsoft/dev-tunnels v0.0.25 h1:UlMKUI+2O8cSu4RlB52ioSyn1LthYSVkJA+CSTsdKoA= +github.com/microsoft/dev-tunnels v0.0.25/go.mod h1:frU++12T/oqxckXkDpTuYa427ncguEOodSPZcGCCrzQ= github.com/muesli/reflow v0.2.1-0.20210115123740-9e1d0d53df68/go.mod h1:Xk+z4oIWdQqJzsxyjgl3P22oYZnHdZ8FFTHAQQt5BMQ= github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s= github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8= @@ -150,8 +149,6 @@ github.com/shurcooL/githubv4 v0.0.0-20230704064427-599ae7bbf278 h1:kdEGVAV4sO46D github.com/shurcooL/githubv4 v0.0.0-20230704064427-599ae7bbf278/go.mod h1:zqMwyHmnN/eDOZOdiTohqIUKUrTFX62PNlu7IJdu0q8= github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466 h1:17JxqqJY66GmZVHkmAsGEkcIu0oCe3AM420QDgGwZx0= github.com/shurcooL/graphql v0.0.0-20230722043721-ed46e5a46466/go.mod h1:9dIRpgIY7hVhoqfe0/FcYp0bpInZaT7dc3BYOprrIUE= -github.com/sourcegraph/jsonrpc2 v0.1.0 h1:ohJHjZ+PcaLxDUjqk2NC3tIGsVa5bXThe1ZheSXOjuk= -github.com/sourcegraph/jsonrpc2 v0.1.0/go.mod h1:ZafdZgk/axhT1cvZAPOhw+95nz2I/Ra5qMlU4gTRwIo= github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA= github.com/spf13/cobra v1.6.1/go.mod h1:IOw/AERYS7UzyrGinqmz6HLUo219MORXGxhbaJUqzrY= github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA= diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index dd2ba4033..302e0ee0f 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -247,11 +247,6 @@ const ( ) type CodespaceConnection struct { - SessionID string `json:"sessionId"` - SessionToken string `json:"sessionToken"` - RelayEndpoint string `json:"relayEndpoint"` - RelaySAS string `json:"relaySas"` - HostPublicKeys []string `json:"hostPublicKeys"` TunnelProperties TunnelProperties `json:"tunnelProperties"` } diff --git a/internal/codespaces/codespaces.go b/internal/codespaces/codespaces.go index 3bcc2b404..da2eacd44 100644 --- a/internal/codespaces/codespaces.go +++ b/internal/codespaces/codespaces.go @@ -11,30 +11,20 @@ import ( "github.com/cenkalti/backoff/v4" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/cli/cli/v2/internal/codespaces/connection" - "github.com/cli/cli/v2/pkg/liveshare" ) -func connectionReady(codespace *api.Codespace, usingDevTunnels bool) bool { +func connectionReady(codespace *api.Codespace) bool { // If the codespace is not available, it is not ready if codespace.State != api.CodespaceStateAvailable { return false } - // If using Dev Tunnels, we need to check that we have all of the required tunnel properties - if usingDevTunnels { - return codespace.Connection.TunnelProperties.ConnectAccessToken != "" && - codespace.Connection.TunnelProperties.ManagePortsAccessToken != "" && - codespace.Connection.TunnelProperties.ServiceUri != "" && - codespace.Connection.TunnelProperties.TunnelId != "" && - codespace.Connection.TunnelProperties.ClusterId != "" && - codespace.Connection.TunnelProperties.Domain != "" - } - - // If not using Dev Tunnels, we need to check that we have all of the required Live Share properties - return codespace.Connection.SessionID != "" && - codespace.Connection.SessionToken != "" && - codespace.Connection.RelayEndpoint != "" && - codespace.Connection.RelaySAS != "" + return codespace.Connection.TunnelProperties.ConnectAccessToken != "" && + codespace.Connection.TunnelProperties.ManagePortsAccessToken != "" && + codespace.Connection.TunnelProperties.ServiceUri != "" && + codespace.Connection.TunnelProperties.TunnelId != "" && + codespace.Connection.TunnelProperties.ClusterId != "" && + codespace.Connection.TunnelProperties.Domain != "" } type apiClient interface { @@ -48,11 +38,6 @@ type progressIndicator interface { StopProgressIndicator() } -type logger interface { - Println(v ...interface{}) - Printf(f string, v ...interface{}) -} - type TimeoutError struct { message string } @@ -64,7 +49,7 @@ func (e *TimeoutError) Error() string { // GetCodespaceConnection waits until a codespace is able // to be connected to and initializes a connection to it. func GetCodespaceConnection(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace) (*connection.CodespaceConnection, error) { - codespace, err := waitUntilCodespaceConnectionReady(ctx, progress, apiClient, codespace, true) + codespace, err := waitUntilCodespaceConnectionReady(ctx, progress, apiClient, codespace) if err != nil { return nil, err } @@ -80,29 +65,8 @@ func GetCodespaceConnection(ctx context.Context, progress progressIndicator, api return connection.NewCodespaceConnection(ctx, codespace, httpClient) } -// ConnectToLiveshare waits until a codespace is able to be -// connected to and connects to it using a Live Share session. -func ConnectToLiveshare(ctx context.Context, progress progressIndicator, sessionLogger logger, apiClient apiClient, codespace *api.Codespace) (*liveshare.Session, error) { - codespace, err := waitUntilCodespaceConnectionReady(ctx, progress, apiClient, codespace, false) - if err != nil { - return nil, err - } - - progress.StartProgressIndicatorWithLabel("Connecting to codespace") - defer progress.StopProgressIndicator() - - return liveshare.Connect(ctx, liveshare.Options{ - SessionID: codespace.Connection.SessionID, - SessionToken: codespace.Connection.SessionToken, - RelaySAS: codespace.Connection.RelaySAS, - RelayEndpoint: codespace.Connection.RelayEndpoint, - HostPublicKeys: codespace.Connection.HostPublicKeys, - Logger: sessionLogger, - }) -} - // waitUntilCodespaceConnectionReady waits for a Codespace to be running and is able to be connected to. -func waitUntilCodespaceConnectionReady(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace, usingDevTunnels bool) (*api.Codespace, error) { +func waitUntilCodespaceConnectionReady(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace) (*api.Codespace, error) { if codespace.State != api.CodespaceStateAvailable { progress.StartProgressIndicatorWithLabel("Starting codespace") defer progress.StopProgressIndicator() @@ -111,7 +75,7 @@ func waitUntilCodespaceConnectionReady(ctx context.Context, progress progressInd } } - if !connectionReady(codespace, usingDevTunnels) { + if !connectionReady(codespace) { expBackoff := backoff.NewExponentialBackOff() expBackoff.Multiplier = 1.1 expBackoff.MaxInterval = 10 * time.Second @@ -124,7 +88,7 @@ func waitUntilCodespaceConnectionReady(ctx context.Context, progress progressInd return backoff.Permanent(fmt.Errorf("error getting codespace: %w", err)) } - if connectionReady(codespace, usingDevTunnels) { + if connectionReady(codespace) { return nil } diff --git a/internal/codespaces/portforwarder/port_forwarder.go b/internal/codespaces/portforwarder/port_forwarder.go index ba510e4ff..44838a6be 100644 --- a/internal/codespaces/portforwarder/port_forwarder.go +++ b/internal/codespaces/portforwarder/port_forwarder.go @@ -3,6 +3,7 @@ package portforwarder import ( "context" "fmt" + "io" "net" "strings" @@ -22,101 +23,75 @@ const ( PublicPortVisibility = "public" ) -type PortForwarder struct { - connection connection.CodespaceConnection +const ( + trafficTypeInput = "input" + trafficTypeOutput = "output" +) + +type ForwardPortOpts struct { + Port int + Internal bool + KeepAlive bool + Visibility string +} + +type CodespacesPortForwarder struct { + connection connection.CodespaceConnection + keepAliveReason chan string +} + +type PortForwarder interface { + ForwardPortToListener(ctx context.Context, opts ForwardPortOpts, listener *net.TCPListener) error + ForwardPort(ctx context.Context, opts ForwardPortOpts) error + ConnectToForwardedPort(ctx context.Context, conn io.ReadWriteCloser, opts ForwardPortOpts) error + ListPorts(ctx context.Context) ([]*tunnels.TunnelPort, error) + UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error + KeepAlive(reason string) + GetKeepAliveReason() string + CloseSSHConnection() } // NewPortForwarder returns a new PortForwarder for the specified codespace. -func NewPortForwarder(ctx context.Context, codespaceConnection *connection.CodespaceConnection) (fwd *PortForwarder, err error) { - return &PortForwarder{ - connection: *codespaceConnection, +func NewPortForwarder(ctx context.Context, codespaceConnection *connection.CodespaceConnection) (fwd PortForwarder, err error) { + return &CodespacesPortForwarder{ + connection: *codespaceConnection, + keepAliveReason: make(chan string, 1), }, nil } -// ForwardAndConnectToPort forwards a port and connects to it via a local TCP port. -func (fwd *PortForwarder) ForwardAndConnectToPort(ctx context.Context, remotePort uint16, listen *net.TCPListener, keepAlive bool, internal bool) error { - return fwd.ForwardPort(ctx, remotePort, listen, keepAlive, true, internal, "") -} - -// ForwardPort forwards a port and optionally connects to it via a local TCP port. -func (fwd *PortForwarder) ForwardPort(ctx context.Context, remotePort uint16, listen *net.TCPListener, keepAlive bool, connect bool, internal bool, visibility string) error { - tunnelPort := tunnels.NewTunnelPort(remotePort, "", "", tunnels.TunnelProtocolHttp) - - // If no visibility is provided, Dev Tunnels will use the default (private) - if visibility != "" { - // Check if the requested visibility is allowed - allowed := false - for _, allowedVisibility := range fwd.connection.AllowedPortPrivacySettings { - if allowedVisibility == visibility { - allowed = true - break - } - } - - // If the requested visibility is not allowed, return an error - if !allowed { - return fmt.Errorf("visibility %s is not allowed", visibility) - } - - accessControlEntries := visibilityToAccessControlEntries(visibility) - if len(accessControlEntries) > 0 { - tunnelPort.AccessControl = &tunnels.TunnelAccessControl{ - Entries: accessControlEntries, - } - } +// ForwardPortToListener forwards the specified port to the given TCP listener. +func (fwd *CodespacesPortForwarder) ForwardPortToListener(ctx context.Context, opts ForwardPortOpts, listener *net.TCPListener) error { + err := fwd.ForwardPort(ctx, opts) + if err != nil { + return fmt.Errorf("error forwarding port: %w", err) } - // Tag the port as internal or user forwarded so we know if it needs to be shown in the UI - if internal { - tunnelPort.Tags = []string{InternalPortTag} - } else { - tunnelPort.Tags = []string{UserForwardedPortTag} - } - - // Create the tunnel port - _, err := fwd.connection.TunnelManager.CreateTunnelPort(ctx, fwd.connection.Tunnel, tunnelPort, fwd.connection.Options) - if err != nil && !strings.Contains(err.Error(), "409") { - return fmt.Errorf("create tunnel port failed: %v", err) - } + // Close the SSH connection when we're done + defer fwd.CloseSSHConnection() done := make(chan error) go func() { - // Connect to the tunnel - err = fwd.connection.TunnelClient.Connect(ctx, "") + // Convert the port number to a uint16 + port, err := convertIntToUint16(opts.Port) if err != nil { - done <- fmt.Errorf("connect failed: %v", err) - return - } - - // Inform the host that we've forwarded the port locally - err = fwd.connection.TunnelClient.RefreshPorts(ctx) - if err != nil { - done <- fmt.Errorf("refresh ports failed: %v", err) - return - } - - // If we don't want to connect to the port, exit early - if !connect { - done <- nil + done <- fmt.Errorf("error converting port: %w", err) return } // Ensure the port is forwarded before connecting - err = fwd.connection.TunnelClient.WaitForForwardedPort(ctx, remotePort) + err = fwd.connection.TunnelClient.WaitForForwardedPort(ctx, port) if err != nil { done <- fmt.Errorf("wait for forwarded port failed: %v", err) return } - // Connect to the forwarded port via a local TCP port - err = fwd.connection.TunnelClient.ConnectToForwardedPort(ctx, listen, remotePort) + // Connect to the forwarded port + err = fwd.connectListenerToForwardedPort(ctx, opts, listener) if err != nil { done <- fmt.Errorf("connect to forwarded port failed: %v", err) - return } - - done <- nil }() + select { case err := <-done: if err != nil { @@ -128,8 +103,131 @@ func (fwd *PortForwarder) ForwardPort(ctx context.Context, remotePort uint16, li } } +// ForwardPort informs the host that we would like to forward the given port. +func (fwd *CodespacesPortForwarder) ForwardPort(ctx context.Context, opts ForwardPortOpts) error { + // Convert the port number to a uint16 + port, err := convertIntToUint16(opts.Port) + if err != nil { + return fmt.Errorf("error converting port: %w", err) + } + + tunnelPort := tunnels.NewTunnelPort(port, "", "", tunnels.TunnelProtocolHttp) + + // If no visibility is provided, Dev Tunnels will use the default (private) + if opts.Visibility != "" { + // Check if the requested visibility is allowed + allowed := false + for _, allowedVisibility := range fwd.connection.AllowedPortPrivacySettings { + if allowedVisibility == opts.Visibility { + allowed = true + break + } + } + + // If the requested visibility is not allowed, return an error + if !allowed { + return fmt.Errorf("visibility %s is not allowed", opts.Visibility) + } + + accessControlEntries := visibilityToAccessControlEntries(opts.Visibility) + if len(accessControlEntries) > 0 { + tunnelPort.AccessControl = &tunnels.TunnelAccessControl{ + Entries: accessControlEntries, + } + } + } + + // Tag the port as internal or user forwarded so we know if it needs to be shown in the UI + if opts.Internal { + tunnelPort.Tags = []string{InternalPortTag} + } else { + tunnelPort.Tags = []string{UserForwardedPortTag} + } + + // Create the tunnel port + _, err = fwd.connection.TunnelManager.CreateTunnelPort(ctx, fwd.connection.Tunnel, tunnelPort, fwd.connection.Options) + if err != nil && !strings.Contains(err.Error(), "409") { + return fmt.Errorf("create tunnel port failed: %v", err) + } + + // Connect to the tunnel + err = fwd.connection.TunnelClient.Connect(ctx, "") + if err != nil { + return fmt.Errorf("connect failed: %v", err) + } + + // Inform the host that we've forwarded the port locally + err = fwd.connection.TunnelClient.RefreshPorts(ctx) + if err != nil { + fwd.CloseSSHConnection() + return fmt.Errorf("refresh ports failed: %v", err) + } + + return nil +} + +// connectListenerToForwardedPort connects to the forwarded port via a local TCP port. +func (fwd *CodespacesPortForwarder) connectListenerToForwardedPort(ctx context.Context, opts ForwardPortOpts, listener *net.TCPListener) (err error) { + errc := make(chan error, 1) + sendError := func(err error) { + // Use non-blocking send, to avoid goroutines getting + // stuck in case of concurrent or sequential errors. + select { + case errc <- err: + default: + } + } + go func() { + for { + conn, err := listener.AcceptTCP() + if err != nil { + sendError(err) + return + } + + // Connect to the forwarded port in a goroutine so we can accept new connections + go func() { + if err := fwd.ConnectToForwardedPort(ctx, conn, opts); err != nil { + sendError(err) + } + }() + } + }() + + // Wait for an error or for the context to be cancelled + select { + case err := <-errc: + return err + case <-ctx.Done(): + return ctx.Err() // canceled + } +} + +// ConnectToForwardedPort connects to the forwarded port via a given ReadWriteCloser. +// Optionally, it detects traffic over the connection and sends activity signals to the server to keep the codespace from shutting down. +func (fwd *CodespacesPortForwarder) ConnectToForwardedPort(ctx context.Context, conn io.ReadWriteCloser, opts ForwardPortOpts) error { + // Create a traffic monitor to keep the session alive + if opts.KeepAlive { + conn = newTrafficMonitor(conn, fwd) + } + + // Convert the port number to a uint16 + port, err := convertIntToUint16(opts.Port) + if err != nil { + return fmt.Errorf("error converting port: %w", err) + } + + // Connect to the forwarded port + err = fwd.connection.TunnelClient.ConnectToForwardedPort(ctx, conn, port) + if err != nil { + return fmt.Errorf("error connecting to forwarded port: %w", err) + } + + return nil +} + // ListPorts fetches the list of ports that are currently forwarded. -func (fwd *PortForwarder) ListPorts(ctx context.Context) (ports []*tunnels.TunnelPort, err error) { +func (fwd *CodespacesPortForwarder) ListPorts(ctx context.Context) (ports []*tunnels.TunnelPort, err error) { ports, err = fwd.connection.TunnelManager.ListTunnelPorts(ctx, fwd.connection.Tunnel, fwd.connection.Options) if err != nil { return nil, fmt.Errorf("error listing ports: %w", err) @@ -139,7 +237,7 @@ func (fwd *PortForwarder) ListPorts(ctx context.Context) (ports []*tunnels.Tunne } // UpdatePortVisibility changes the visibility (private, org, public) of the specified port. -func (fwd *PortForwarder) UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error { +func (fwd *CodespacesPortForwarder) UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error { tunnelPort, err := fwd.connection.TunnelManager.GetTunnelPort(ctx, fwd.connection.Tunnel, remotePort, fwd.connection.Options) if err != nil { return fmt.Errorf("error getting tunnel port: %w", err) @@ -165,6 +263,9 @@ func (fwd *PortForwarder) UpdatePortVisibility(ctx context.Context, remotePort i return } + // Close the SSH connection when we're done + defer fwd.CloseSSHConnection() + // Inform the host that we've deleted the port err = fwd.connection.TunnelClient.RefreshPorts(ctx) if err != nil { @@ -172,6 +273,13 @@ func (fwd *PortForwarder) UpdatePortVisibility(ctx context.Context, remotePort i return } + // Re-forward the port with the updated visibility + err = fwd.ForwardPort(ctx, ForwardPortOpts{Port: remotePort, Visibility: visibility}) + if err != nil { + done <- fmt.Errorf("error forwarding port: %w", err) + return + } + done <- nil }() @@ -179,13 +287,10 @@ func (fwd *PortForwarder) UpdatePortVisibility(ctx context.Context, remotePort i select { case err := <-done: if err != nil { - return fmt.Errorf("error connecting to tunnel: %w", err) - } + // If we fail to re-forward the port, we need to forward again with the original visibility so the port is still accessible + _ = fwd.ForwardPort(ctx, ForwardPortOpts{Port: remotePort, Visibility: AccessControlEntriesToVisibility(tunnelPort.AccessControl.Entries)}) - // Re-forward the port with the updated visibility - err = fwd.ForwardPort(ctx, uint16(remotePort), nil, false, false, false, visibility) - if err != nil { - return fmt.Errorf("error forwarding port: %w", err) + return fmt.Errorf("error connecting to tunnel: %w", err) } return nil @@ -194,6 +299,27 @@ func (fwd *PortForwarder) UpdatePortVisibility(ctx context.Context, remotePort i } } +// KeepAlive accepts a reason that is retained if there is no active reason +// to send to the server. +func (fwd *CodespacesPortForwarder) KeepAlive(reason string) { + select { + case fwd.keepAliveReason <- reason: + default: + // there is already an active keep alive reason + // so we can ignore this one + } +} + +// GetKeepAliveReason fetches the keep alive reason from the channel and returns it. +func (fwd *CodespacesPortForwarder) GetKeepAliveReason() string { + return <-fwd.keepAliveReason +} + +// Close closes the port forwarder's tunnel client connection. +func (fwd *CodespacesPortForwarder) CloseSSHConnection() { + _ = fwd.connection.TunnelClient.Close() +} + // AccessControlEntriesToVisibility converts the access control entries used by Dev Tunnels to a friendly visibility value. func AccessControlEntriesToVisibility(accessControlEntries []tunnels.TunnelAccessControlEntry) string { for _, entry := range accessControlEntries { @@ -251,3 +377,45 @@ func IsInternalPort(port *tunnels.TunnelPort) bool { return false } + +// convertIntToUint16 converts the given int to a uint16. +func convertIntToUint16(port int) (uint16, error) { + var updatedPort uint16 + if port >= 0 && port <= 65535 { + updatedPort = uint16(port) + } else { + return 0, fmt.Errorf("invalid port number: %d", port) + } + + return updatedPort, nil +} + +// trafficMonitor implements io.Reader. It keeps the session alive by notifying +// it of the traffic type during Read operations. +type trafficMonitor struct { + rwc io.ReadWriteCloser + fwd PortForwarder +} + +// newTrafficMonitor returns a trafficMonitor for the specified codespace connection. +// It wraps the provided io.ReaderWriteCloser with its own Read/Write/Close methods. +func newTrafficMonitor(rwc io.ReadWriteCloser, fwd PortForwarder) *trafficMonitor { + return &trafficMonitor{rwc, fwd} +} + +// Read wraps the underlying ReadWriteCloser's Read method and keeps the session alive with the "input" traffic type. +func (t *trafficMonitor) Read(p []byte) (n int, err error) { + t.fwd.KeepAlive(trafficTypeInput) + return t.rwc.Read(p) +} + +// Write wraps the underlying ReadWriteCloser's Write method and keeps the session alive with the "output" traffic type. +func (t *trafficMonitor) Write(p []byte) (n int, err error) { + t.fwd.KeepAlive(trafficTypeOutput) + return t.rwc.Write(p) +} + +// Close closes the underlying ReadWriteCloser. +func (t *trafficMonitor) Close() error { + return t.rwc.Close() +} diff --git a/internal/codespaces/rpc/invoker.go b/internal/codespaces/rpc/invoker.go index 39ae5ab19..7701d6092 100644 --- a/internal/codespaces/rpc/invoker.go +++ b/internal/codespaces/rpc/invoker.go @@ -12,10 +12,10 @@ import ( "strings" "time" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc/codespace" "github.com/cli/cli/v2/internal/codespaces/rpc/jupyter" "github.com/cli/cli/v2/internal/codespaces/rpc/ssh" - "github.com/cli/cli/v2/pkg/liveshare" "google.golang.org/grpc" "google.golang.org/grpc/credentials/insecure" "google.golang.org/grpc/metadata" @@ -47,7 +47,7 @@ type Invoker interface { type invoker struct { conn *grpc.ClientConn - session liveshare.LiveshareSession + fwd portforwarder.PortForwarder listener net.Listener jupyterClient jupyter.JupyterServerHostClient codespaceClient codespace.CodespaceHostClient @@ -56,11 +56,11 @@ type invoker struct { } // Connects to the internal RPC server and returns a new invoker for it -func CreateInvoker(ctx context.Context, session liveshare.LiveshareSession) (Invoker, error) { +func CreateInvoker(ctx context.Context, fwd portforwarder.PortForwarder) (Invoker, error) { ctx, cancel := context.WithTimeout(ctx, ConnectionTimeout) defer cancel() - invoker, err := connect(ctx, session) + invoker, err := connect(ctx, fwd) if err != nil { return nil, fmt.Errorf("error connecting to internal server: %w", err) } @@ -69,7 +69,7 @@ func CreateInvoker(ctx context.Context, session liveshare.LiveshareSession) (Inv } // Finds a free port to listen on and creates a new RPC invoker that connects to that port -func connect(ctx context.Context, session liveshare.LiveshareSession) (Invoker, error) { +func connect(ctx context.Context, fwd portforwarder.PortForwarder) (Invoker, error) { listener, err := listenTCP() if err != nil { return nil, err @@ -77,7 +77,7 @@ func connect(ctx context.Context, session liveshare.LiveshareSession) (Invoker, localAddress := listener.Addr().String() invoker := &invoker{ - session: session, + fwd: fwd, listener: listener, } @@ -100,8 +100,12 @@ func connect(ctx context.Context, session liveshare.LiveshareSession) (Invoker, // Tunnel the remote gRPC server port to the local port go func() { - fwd := liveshare.NewPortForwarder(session, codespacesInternalSessionName, codespacesInternalPort, true) - ch <- fwd.ForwardToListener(pfctx, listener) + // Start forwarding the port locally + opts := portforwarder.ForwardPortOpts{ + Port: codespacesInternalPort, + Internal: true, + } + ch <- fwd.ForwardPortToListener(pfctx, opts, listener) }() var conn *grpc.ClientConn @@ -262,7 +266,7 @@ func (i *invoker) heartbeat(ctx context.Context, interval time.Duration) { case <-ctx.Done(): return case <-ticker.C: - reason := i.session.GetKeepAliveReason() + reason := i.fwd.GetKeepAliveReason() _ = i.notifyCodespaceOfClientActivity(ctx, reason) } } diff --git a/internal/codespaces/rpc/invoker_test.go b/internal/codespaces/rpc/invoker_test.go index ba3e13ac3..d9b271c54 100644 --- a/internal/codespaces/rpc/invoker_test.go +++ b/internal/codespaces/rpc/invoker_test.go @@ -72,7 +72,8 @@ func createTestInvoker(t *testing.T, server *mockServer) (Invoker, func(), error listener.Close() } - invoker, err := CreateInvoker(context.Background(), &rpctest.Session{}) + // Create a new invoker with a mock port forwarder + invoker, err := CreateInvoker(context.Background(), rpctest.PortForwarder{}) if err != nil { close() return nil, nil, fmt.Errorf("error connecting to internal server: %w", err) diff --git a/internal/codespaces/rpc/test/channel.go b/internal/codespaces/rpc/test/channel.go deleted file mode 100644 index eef42c4aa..000000000 --- a/internal/codespaces/rpc/test/channel.go +++ /dev/null @@ -1,34 +0,0 @@ -package test - -import ( - "io" - "net" -) - -type Channel struct { - conn net.Conn -} - -func (c *Channel) Read(data []byte) (int, error) { - return c.conn.Read(data) -} - -func (c *Channel) Write(data []byte) (int, error) { - return c.conn.Write(data) -} - -func (c *Channel) Close() error { - return c.conn.Close() -} - -func (c *Channel) CloseWrite() error { - return nil -} - -func (c *Channel) SendRequest(name string, wantReply bool, payload []byte) (bool, error) { - return false, nil -} - -func (c *Channel) Stderr() io.ReadWriter { - return nil -} diff --git a/internal/codespaces/rpc/test/port_forwarder.go b/internal/codespaces/rpc/test/port_forwarder.go new file mode 100644 index 000000000..4993ac0a1 --- /dev/null +++ b/internal/codespaces/rpc/test/port_forwarder.go @@ -0,0 +1,78 @@ +package test + +import ( + "context" + "fmt" + "io" + "net" + + "github.com/cli/cli/v2/internal/codespaces/portforwarder" + "github.com/microsoft/dev-tunnels/go/tunnels" +) + +type PortForwarder struct{} + +// Close implements portforwarder.PortForwarder. +func (PortForwarder) CloseSSHConnection() { + panic("unimplemented") +} + +// ConnectToForwardedPort implements portforwarder.PortForwarder. +func (PortForwarder) ConnectToForwardedPort(ctx context.Context, conn io.ReadWriteCloser, opts portforwarder.ForwardPortOpts) error { + panic("unimplemented") +} + +// ForwardPort implements portforwarder.PortForwarder. +func (PortForwarder) ForwardPort(ctx context.Context, opts portforwarder.ForwardPortOpts) error { + panic("unimplemented") +} + +// GetKeepAliveReason implements portforwarder.PortForwarder. +func (PortForwarder) GetKeepAliveReason() string { + panic("unimplemented") +} + +// KeepAlive implements portforwarder.PortForwarder. +func (PortForwarder) KeepAlive(reason string) { + panic("unimplemented") +} + +// ForwardPortToListener implements portforwarder.PortForwarder. +func (PortForwarder) ForwardPortToListener(ctx context.Context, opts portforwarder.ForwardPortOpts, listener *net.TCPListener) error { + // Start forwarding the port locally + hostConn, err := net.Dial("tcp", fmt.Sprintf("127.0.0.1:%d", opts.Port)) + if err != nil { + return err + } + + // Accept the connection from the listener + listenerConn, err := listener.Accept() + if err != nil { + return err + } + + // Copy data between the two connections + go func() { + _, _ = io.Copy(hostConn, listenerConn) + hostConn.Close() + }() + go func() { + _, _ = io.Copy(listenerConn, hostConn) + listenerConn.Close() + }() + + // ForwardPortToListener typically blocks until the context is cancelled so we need to do the same + <-ctx.Done() + + return nil +} + +// ListPorts implements portforwarder.PortForwarder. +func (PortForwarder) ListPorts(ctx context.Context) ([]*tunnels.TunnelPort, error) { + panic("unimplemented") +} + +// UpdatePortVisibility implements portforwarder.PortForwarder. +func (PortForwarder) UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error { + panic("unimplemented") +} diff --git a/internal/codespaces/rpc/test/session.go b/internal/codespaces/rpc/test/session.go deleted file mode 100644 index 531d4c33f..000000000 --- a/internal/codespaces/rpc/test/session.go +++ /dev/null @@ -1,43 +0,0 @@ -package test - -import ( - "context" - "fmt" - "net" - - "github.com/cli/cli/v2/pkg/liveshare" - "golang.org/x/crypto/ssh" -) - -type Session struct { - channel ssh.Channel -} - -func (*Session) Close() error { - panic("unimplemented") -} - -func (*Session) GetSharedServers(context.Context) ([]*liveshare.Port, error) { - panic("unimplemented") -} - -func (s *Session) KeepAlive(reason string) { -} - -func (s *Session) GetKeepAliveReason() string { - return "" -} - -func (s *Session) StartSharing(ctx context.Context, sessionName string, port int) (liveshare.ChannelID, error) { - conn, err := net.Dial("tcp", fmt.Sprintf("127.0.0.1:%d", port)) - if err != nil { - return liveshare.ChannelID{}, err - } - s.channel = &Channel{conn} - return liveshare.ChannelID{}, nil -} - -// Creates mock SSH channel connected to the mock gRPC server -func (s *Session) OpenStreamingChannel(ctx context.Context, id liveshare.ChannelID) (ssh.Channel, error) { - return s.channel, nil -} diff --git a/internal/codespaces/states.go b/internal/codespaces/states.go index 3a2872365..afbdf4673 100644 --- a/internal/codespaces/states.go +++ b/internal/codespaces/states.go @@ -6,13 +6,12 @@ import ( "encoding/json" "fmt" "io" - "log" "time" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" "github.com/cli/cli/v2/internal/text" - "github.com/cli/cli/v2/pkg/liveshare" ) // PostCreateStateStatus is a string value representing the different statuses a state can have. @@ -39,17 +38,15 @@ type PostCreateState struct { // and calls the supplied poller for each batch of state changes. // It runs until it encounters an error, including cancellation of the context. func PollPostCreateStates(ctx context.Context, progress progressIndicator, apiClient apiClient, codespace *api.Codespace, poller func([]PostCreateState)) (err error) { - noopLogger := log.New(io.Discard, "", 0) - - session, err := ConnectToLiveshare(ctx, progress, noopLogger, apiClient, codespace) + codespaceConnection, err := GetCodespaceConnection(ctx, progress, apiClient, codespace) if err != nil { - return fmt.Errorf("connect to codespace: %w", err) + return fmt.Errorf("error connecting to codespace: %w", err) + } + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) } - defer func() { - if closeErr := session.Close(); err == nil { - err = closeErr - } - }() // Ensure local port is listening before client (getPostCreateOutput) connects. listen, localPort, err := ListenTCP(0, false) @@ -58,7 +55,7 @@ func PollPostCreateStates(ctx context.Context, progress progressIndicator, apiCl } progress.StartProgressIndicatorWithLabel("Fetching SSH Details") - invoker, err := rpc.CreateInvoker(ctx, session) + invoker, err := rpc.CreateInvoker(ctx, fwd) if err != nil { return err } @@ -73,8 +70,11 @@ func PollPostCreateStates(ctx context.Context, progress progressIndicator, apiCl progress.StartProgressIndicatorWithLabel("Fetching status") tunnelClosed := make(chan error, 1) // buffered to avoid sender stuckness go func() { - fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, false) - tunnelClosed <- fwd.ForwardToListener(ctx, listen) // error is non-nil + opts := portforwarder.ForwardPortOpts{ + Port: remoteSSHServerPort, + Internal: true, + } + tunnelClosed <- fwd.ForwardPortToListener(ctx, opts, listen) }() t := time.NewTicker(1 * time.Second) diff --git a/pkg/cmd/codespace/common.go b/pkg/cmd/codespace/common.go index 86493ce8e..3ad3463e6 100644 --- a/pkg/cmd/codespace/common.go +++ b/pkg/cmd/codespace/common.go @@ -17,10 +17,8 @@ import ( "github.com/AlecAivazis/survey/v2/terminal" clicontext "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/internal/browser" - "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/pkg/liveshare" "github.com/spf13/cobra" "golang.org/x/term" ) @@ -65,28 +63,6 @@ func (a *App) RunWithProgress(label string, run func() error) error { return a.io.RunWithProgress(label, run) } -// Connects to a codespace using Live Share and returns that session -func startLiveShareSession(ctx context.Context, codespace *api.Codespace, a *App, debug bool, debugFile string) (session *liveshare.Session, err error) { - liveshareLogger := noopLogger() - if debug { - debugLogger, err := newFileLogger(debugFile) - if err != nil { - return nil, fmt.Errorf("couldn't create file logger: %w", err) - } - defer safeClose(debugLogger, &err) - - liveshareLogger = debugLogger.Logger - a.errLogger.Printf("Debug file located at: %s", debugLogger.Name()) - } - - session, err = codespaces.ConnectToLiveshare(ctx, a, liveshareLogger, a.apiClient, codespace) - if err != nil { - return nil, fmt.Errorf("failed to connect to Live Share: %w", err) - } - - return session, nil -} - //go:generate moq -fmt goimports -rm -skip-ensure -out mock_api.go . apiClient type apiClient interface { ServerURL() string @@ -201,10 +177,6 @@ func noArgsConstraint(cmd *cobra.Command, args []string) error { return nil } -func noopLogger() *log.Logger { - return log.New(io.Discard, "", 0) -} - type codespace struct { *api.Codespace } diff --git a/pkg/cmd/codespace/jupyter.go b/pkg/cmd/codespace/jupyter.go index 91c798eda..3546837fa 100644 --- a/pkg/cmd/codespace/jupyter.go +++ b/pkg/cmd/codespace/jupyter.go @@ -7,8 +7,8 @@ import ( "strings" "github.com/cli/cli/v2/internal/codespaces" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" - "github.com/cli/cli/v2/pkg/liveshare" "github.com/spf13/cobra" ) @@ -39,11 +39,15 @@ func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err err return err } - session, err := startLiveShareSession(ctx, codespace, a, false, "") + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return err + return fmt.Errorf("error connecting to codespace: %w", err) + } + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) } - defer safeClose(session, &err) var ( invoker rpc.Invoker @@ -51,7 +55,7 @@ func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err err serverUrl string ) err = a.RunWithProgress("Starting JupyterLab on codespace", func() (err error) { - invoker, err = rpc.CreateInvoker(ctx, session) + invoker, err = rpc.CreateInvoker(ctx, fwd) if err != nil { return } @@ -76,8 +80,10 @@ func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err err tunnelClosed := make(chan error, 1) go func() { - fwd := liveshare.NewPortForwarder(session, "jupyter", serverPort, true) - tunnelClosed <- fwd.ForwardToListener(ctx, listen) // always non-nil + opts := portforwarder.ForwardPortOpts{ + Port: serverPort, + } + tunnelClosed <- fwd.ForwardPortToListener(ctx, opts, listen) }() // Server URL contains an authentication token that must be preserved diff --git a/pkg/cmd/codespace/logs.go b/pkg/cmd/codespace/logs.go index 3ec950849..13d5ce185 100644 --- a/pkg/cmd/codespace/logs.go +++ b/pkg/cmd/codespace/logs.go @@ -5,8 +5,8 @@ import ( "fmt" "github.com/cli/cli/v2/internal/codespaces" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" - "github.com/cli/cli/v2/pkg/liveshare" "github.com/spf13/cobra" ) @@ -42,11 +42,15 @@ func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool return err } - session, err := startLiveShareSession(ctx, codespace, a, false, "") + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return err + return fmt.Errorf("error connecting to codespace: %w", err) + } + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) } - defer safeClose(session, &err) // Ensure local port is listening before client (getPostCreateOutput) connects. listen, localPort, err := codespaces.ListenTCP(0, false) @@ -57,7 +61,7 @@ func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool remoteSSHServerPort, sshUser := 0, "" err = a.RunWithProgress("Fetching SSH Details", func() (err error) { - invoker, err := rpc.CreateInvoker(ctx, session) + invoker, err := rpc.CreateInvoker(ctx, fwd) if err != nil { return } @@ -85,8 +89,11 @@ func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool tunnelClosed := make(chan error, 1) go func() { - fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, false) - tunnelClosed <- fwd.ForwardToListener(ctx, listen) // error is non-nil + opts := portforwarder.ForwardPortOpts{ + Port: remoteSSHServerPort, + Internal: true, + } + tunnelClosed <- fwd.ForwardPortToListener(ctx, opts, listen) }() cmdDone := make(chan error, 1) diff --git a/pkg/cmd/codespace/ports.go b/pkg/cmd/codespace/ports.go index b7eb96537..38688cd3a 100644 --- a/pkg/cmd/codespace/ports.go +++ b/pkg/cmd/codespace/ports.go @@ -345,7 +345,11 @@ func (a *App) ForwardPorts(ctx context.Context, selector *CodespaceSelector, por if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } - return fwd.ForwardAndConnectToPort(ctx, uint16(pair.remote), listen, false, false) + + opts := portforwarder.ForwardPortOpts{ + Port: pair.remote, + } + return fwd.ForwardPortToListener(ctx, opts, listen) }) } return group.Wait() // first error diff --git a/pkg/cmd/codespace/rebuild.go b/pkg/cmd/codespace/rebuild.go index 17e00670b..464c58502 100644 --- a/pkg/cmd/codespace/rebuild.go +++ b/pkg/cmd/codespace/rebuild.go @@ -4,7 +4,9 @@ import ( "context" "fmt" + "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" "github.com/spf13/cobra" ) @@ -49,13 +51,17 @@ func (a *App) Rebuild(ctx context.Context, selector *CodespaceSelector, full boo return nil } - session, err := startLiveShareSession(ctx, codespace, a, false, "") + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return fmt.Errorf("starting Live Share session: %w", err) + return fmt.Errorf("error connecting to codespace: %w", err) } - defer safeClose(session, &err) - invoker, err := rpc.CreateInvoker(ctx, session) + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) + } + + invoker, err := rpc.CreateInvoker(ctx, fwd) if err != nil { return err } diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go index 40eebcc63..42571b52e 100644 --- a/pkg/cmd/codespace/ssh.go +++ b/pkg/cmd/codespace/ssh.go @@ -6,7 +6,7 @@ import ( "context" "errors" "fmt" - "log" + "io" "os" "os/exec" "path" @@ -18,10 +18,10 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/codespaces" "github.com/cli/cli/v2/internal/codespaces/api" + "github.com/cli/cli/v2/internal/codespaces/portforwarder" "github.com/cli/cli/v2/internal/codespaces/rpc" "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/pkg/cmdutil" - "github.com/cli/cli/v2/pkg/liveshare" "github.com/cli/cli/v2/pkg/ssh" "github.com/cli/safeexec" "github.com/spf13/cobra" @@ -144,6 +144,24 @@ func newSSHCmd(app *App) *cobra.Command { return sshCmd } +type combinedReadWriteHalfCloser struct { + io.ReadCloser + io.WriteCloser +} + +func (crwc *combinedReadWriteHalfCloser) Close() error { + werr := crwc.WriteCloser.Close() + rerr := crwc.ReadCloser.Close() + if werr != nil { + return werr + } + return rerr +} + +func (crwc *combinedReadWriteHalfCloser) CloseWrite() error { + return crwc.WriteCloser.Close() +} + // SSH opens an ssh session or runs an ssh command in a codespace. func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err error) { // Ensure all child tasks (e.g. port forwarding) terminate before return. @@ -175,11 +193,15 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e return err } - session, err := startLiveShareSession(ctx, codespace, a, opts.debug, opts.debugFile) + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, codespace) if err != nil { - return err + return fmt.Errorf("error connecting to codespace: %w", err) + } + + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + return fmt.Errorf("failed to create port forwarder: %w", err) } - defer safeClose(session, &err) var ( invoker rpc.Invoker @@ -187,7 +209,7 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e sshUser string ) err = a.RunWithProgress("Fetching SSH Details", func() (err error) { - invoker, err = rpc.CreateInvoker(ctx, session) + invoker, err = rpc.CreateInvoker(ctx, fwd) if err != nil { return } @@ -203,9 +225,28 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e } if opts.stdio { - fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, true) - stdio := liveshare.NewReadWriteHalfCloser(os.Stdin, os.Stdout) - err := fwd.Forward(ctx, stdio) // always non-nil + stdio := &combinedReadWriteHalfCloser{os.Stdin, os.Stdout} + opts := portforwarder.ForwardPortOpts{ + Port: remoteSSHServerPort, + Internal: true, + KeepAlive: true, + } + + // Forward the port + err = fwd.ForwardPort(ctx, opts) + if err != nil { + return fmt.Errorf("failed to forward port: %w", err) + } + + // Close the SSH connection when we're done + defer fwd.CloseSSHConnection() + + // Connect to the forwarded port + err = fwd.ConnectToForwardedPort(ctx, stdio, opts) + if err != nil { + return fmt.Errorf("failed to connect to forwarded port: %w", err) + } + return fmt.Errorf("tunnel closed: %w", err) } @@ -227,8 +268,12 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e tunnelClosed := make(chan error, 1) go func() { - fwd := liveshare.NewPortForwarder(session, "sshd", remoteSSHServerPort, true) - tunnelClosed <- fwd.ForwardToListener(ctx, listen) // always non-nil + opts := portforwarder.ForwardPortOpts{ + Port: remoteSSHServerPort, + Internal: true, + KeepAlive: true, + } + tunnelClosed <- fwd.ForwardPortToListener(ctx, opts, listen) }() shellClosed := make(chan error, 1) @@ -526,27 +571,36 @@ func (a *App) printOpenSSHConfig(ctx context.Context, opts sshOptions) (err erro result := sshResult{} defer wg.Done() - session, err := codespaces.ConnectToLiveshare(ctx, a, noopLogger(), a.apiClient, cs) + codespaceConnection, err := codespaces.GetCodespaceConnection(ctx, a, a.apiClient, cs) if err != nil { result.err = fmt.Errorf("error connecting to codespace: %w", err) - } else { - defer safeClose(session, &err) - - invoker, err := rpc.CreateInvoker(ctx, session) - if err != nil { - result.err = fmt.Errorf("error connecting to codespace: %w", err) - } else { - defer safeClose(invoker, &err) - - _, result.user, err = invoker.StartSSHServer(ctx) - if err != nil { - result.err = fmt.Errorf("error getting ssh server details: %w", err) - } else { - result.codespace = cs - } - } + sshUsers <- result + return } + fwd, err := portforwarder.NewPortForwarder(ctx, codespaceConnection) + if err != nil { + result.err = fmt.Errorf("failed to create port forwarder: %w", err) + sshUsers <- result + return + } + + invoker, err := rpc.CreateInvoker(ctx, fwd) + if err != nil { + result.err = fmt.Errorf("error connecting to codespace: %w", err) + sshUsers <- result + return + } + defer safeClose(invoker, &err) + + _, result.user, err = invoker.StartSSHServer(ctx) + if err != nil { + result.err = fmt.Errorf("error getting ssh server details: %w", err) + sshUsers <- result + return + } + + result.codespace = cs sshUsers <- result }() } @@ -722,43 +776,3 @@ func (a *App) Copy(ctx context.Context, args []string, opts cpOptions) error { } return a.SSH(ctx, nil, opts.sshOptions) } - -// fileLogger is a wrapper around an log.Logger configured to write -// to a file. It exports two additional methods to get the log file name -// and close the file handle when the operation is finished. -type fileLogger struct { - *log.Logger - - f *os.File -} - -// newFileLogger creates a new fileLogger. It returns an error if the file -// cannot be created. The file is created on the specified path, if the path -// is empty it is created in the temporary directory. -func newFileLogger(file string) (fl *fileLogger, err error) { - var f *os.File - if file == "" { - f, err = os.CreateTemp("", "") - if err != nil { - return nil, fmt.Errorf("failed to create tmp file: %w", err) - } - } else { - f, err = os.Create(file) - if err != nil { - return nil, err - } - } - - return &fileLogger{ - Logger: log.New(f, "", log.LstdFlags), - f: f, - }, nil -} - -func (fl *fileLogger) Name() string { - return fl.f.Name() -} - -func (fl *fileLogger) Close() error { - return fl.f.Close() -} diff --git a/pkg/liveshare/client.go b/pkg/liveshare/client.go deleted file mode 100644 index cbfa5d458..000000000 --- a/pkg/liveshare/client.go +++ /dev/null @@ -1,130 +0,0 @@ -// Package liveshare is a Go client library for the Visual Studio Live Share -// service, which provides collaborative, distributed editing and debugging. -// See https://docs.microsoft.com/en-us/visualstudio/liveshare for an overview. -// -// It provides the ability for a Go program to connect to a Live Share -// workspace (Connect), to expose a TCP port on a remote host -// (UpdateSharedVisibility), to start an SSH server listening on an -// exposed port (StartSSHServer), and to forward connections between -// the remote port and a local listening TCP port (ForwardToListener) -// or a local Go reader/writer (Forward). -package liveshare - -import ( - "context" - "crypto/tls" - "errors" - "fmt" - "net/url" - "strings" - - "github.com/opentracing/opentracing-go" -) - -type logger interface { - Println(v ...interface{}) - Printf(f string, v ...interface{}) -} - -// An Options specifies Live Share connection parameters. -type Options struct { - SessionID string - SessionToken string // token for SSH session - RelaySAS string - RelayEndpoint string - HostPublicKeys []string - Logger logger // required - TLSConfig *tls.Config // (optional) -} - -// uri returns a websocket URL for the specified options. -func (opts *Options) uri(action string) (string, error) { - if opts.SessionID == "" { - return "", errors.New("SessionID is required") - } - if opts.RelaySAS == "" { - return "", errors.New("RelaySAS is required") - } - if opts.RelayEndpoint == "" { - return "", errors.New("RelayEndpoint is required") - } - - sas := url.QueryEscape(opts.RelaySAS) - uri := opts.RelayEndpoint - - if strings.HasPrefix(uri, "http:") { - uri = strings.Replace(uri, "http:", "ws:", 1) - } else { - uri = strings.Replace(uri, "sb:", "wss:", -1) - } - - uri = strings.Replace(uri, ".net/", ".net:443/$hc/", 1) - uri = uri + "?sb-hc-action=" + action + "&sb-hc-token=" + sas - return uri, nil -} - -// Connect connects to a Live Share workspace specified by the -// options, and returns a session representing the connection. -// The caller must call the session's Close method to end the session. -func Connect(ctx context.Context, opts Options) (*Session, error) { - span, ctx := opentracing.StartSpanFromContext(ctx, "Connect") - defer span.Finish() - - uri, err := opts.uri("connect") - if err != nil { - return nil, err - } - - sock := newSocket(uri, opts.TLSConfig) - if err := sock.connect(ctx); err != nil { - return nil, fmt.Errorf("error connecting websocket: %w", err) - } - - if opts.SessionToken == "" { - return nil, errors.New("SessionToken is required") - } - ssh := newSSHSession(opts.SessionToken, opts.HostPublicKeys, sock) - if err := ssh.connect(ctx); err != nil { - return nil, fmt.Errorf("error connecting to ssh session: %w", err) - } - - rpc := newRPCClient(ssh) - rpc.connect(ctx) - - args := joinWorkspaceArgs{ - ID: opts.SessionID, - ConnectionMode: "local", - JoiningUserSessionToken: opts.SessionToken, - ClientCapabilities: clientCapabilities{ - IsNonInteractive: false, - }, - } - var result joinWorkspaceResult - if err := rpc.do(ctx, "workspace.joinWorkspace", &args, &result); err != nil { - return nil, fmt.Errorf("error joining Live Share workspace: %w", err) - } - - s := &Session{ - ssh: ssh, - rpc: rpc, - keepAliveReason: make(chan string, 1), - logger: opts.Logger, - } - - return s, nil -} - -type clientCapabilities struct { - IsNonInteractive bool `json:"isNonInteractive"` -} - -type joinWorkspaceArgs struct { - ID string `json:"id"` - ConnectionMode string `json:"connectionMode"` - JoiningUserSessionToken string `json:"joiningUserSessionToken"` - ClientCapabilities clientCapabilities `json:"clientCapabilities"` -} - -type joinWorkspaceResult struct { - SessionNumber int `json:"sessionNumber"` -} diff --git a/pkg/liveshare/client_test.go b/pkg/liveshare/client_test.go deleted file mode 100644 index 4ccc42729..000000000 --- a/pkg/liveshare/client_test.go +++ /dev/null @@ -1,73 +0,0 @@ -package liveshare - -import ( - "context" - "crypto/tls" - "encoding/json" - "errors" - "fmt" - "strings" - "testing" - - livesharetest "github.com/cli/cli/v2/pkg/liveshare/test" - "github.com/sourcegraph/jsonrpc2" -) - -func TestConnect(t *testing.T) { - opts := Options{ - SessionID: "session-id", - SessionToken: "session-token", - RelaySAS: "relay-sas", - HostPublicKeys: []string{livesharetest.SSHPublicKey}, - Logger: newMockLogger(), - } - joinWorkspace := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - var joinWorkspaceReq joinWorkspaceArgs - if err := json.Unmarshal(*req.Params, &joinWorkspaceReq); err != nil { - return nil, fmt.Errorf("error unmarshalling req: %w", err) - } - if joinWorkspaceReq.ID != opts.SessionID { - return nil, errors.New("connection session id does not match") - } - if joinWorkspaceReq.ConnectionMode != "local" { - return nil, errors.New("connection mode is not local") - } - if joinWorkspaceReq.JoiningUserSessionToken != opts.SessionToken { - return nil, errors.New("connection user token does not match") - } - if joinWorkspaceReq.ClientCapabilities.IsNonInteractive != false { - return nil, errors.New("non interactive is not false") - } - return joinWorkspaceResult{1}, nil - } - - server, err := livesharetest.NewServer( - livesharetest.WithPassword(opts.SessionToken), - livesharetest.WithService("workspace.joinWorkspace", joinWorkspace), - livesharetest.WithRelaySAS(opts.RelaySAS), - ) - if err != nil { - t.Errorf("error creating Live Share server: %v", err) - } - defer server.Close() - opts.RelayEndpoint = "sb" + strings.TrimPrefix(server.URL(), "https") - - ctx := context.Background() - - opts.TLSConfig = &tls.Config{InsecureSkipVerify: true} - - done := make(chan error) - go func() { - _, err := Connect(ctx, opts) // ignore session - done <- err - }() - - select { - case err := <-server.Err(): - t.Errorf("error from server: %v", err) - case err := <-done: - if err != nil { - t.Errorf("error from client: %v", err) - } - } -} diff --git a/pkg/liveshare/options_test.go b/pkg/liveshare/options_test.go deleted file mode 100644 index 830c59104..000000000 --- a/pkg/liveshare/options_test.go +++ /dev/null @@ -1,56 +0,0 @@ -package liveshare - -import ( - "context" - "testing" -) - -func TestBadOptions(t *testing.T) { - goodOptions := Options{ - SessionID: "sess-id", - SessionToken: "sess-token", - RelaySAS: "sas", - RelayEndpoint: "endpoint", - } - - opts := goodOptions - opts.SessionID = "" - checkBadOptions(t, opts) - - opts = goodOptions - opts.SessionToken = "" - checkBadOptions(t, opts) - - opts = goodOptions - opts.RelaySAS = "" - checkBadOptions(t, opts) - - opts = goodOptions - opts.RelayEndpoint = "" - checkBadOptions(t, opts) - - opts = Options{} - checkBadOptions(t, opts) -} - -func checkBadOptions(t *testing.T, opts Options) { - if _, err := Connect(context.Background(), opts); err == nil { - t.Errorf("Connect(%+v): no error", opts) - } -} - -func TestOptionsURI(t *testing.T) { - opts := Options{ - SessionID: "sess-id", - SessionToken: "sess-token", - RelaySAS: "sas", - RelayEndpoint: "sb://endpoint/.net/liveshare", - } - uri, err := opts.uri("connect") - if err != nil { - t.Fatal(err) - } - if uri != "wss://endpoint/.net:443/$hc/liveshare?sb-hc-action=connect&sb-hc-token=sas" { - t.Errorf("uri is not correct, got: '%v'", uri) - } -} diff --git a/pkg/liveshare/port_forwarder.go b/pkg/liveshare/port_forwarder.go deleted file mode 100644 index 5f2742209..000000000 --- a/pkg/liveshare/port_forwarder.go +++ /dev/null @@ -1,241 +0,0 @@ -package liveshare - -import ( - "context" - "fmt" - "io" - "net" - - "github.com/opentracing/opentracing-go" - "golang.org/x/crypto/ssh" -) - -type portForwardingSession interface { - StartSharing(context.Context, string, int) (ChannelID, error) - OpenStreamingChannel(context.Context, ChannelID) (ssh.Channel, error) - KeepAlive(string) -} - -type ReadWriteHalfCloser interface { - io.ReadWriteCloser - CloseWrite() error -} - -type combinedReadWriteHalfCloser struct { - io.ReadCloser - io.WriteCloser -} - -func NewReadWriteHalfCloser(reader io.ReadCloser, writer io.WriteCloser) ReadWriteHalfCloser { - return &combinedReadWriteHalfCloser{reader, writer} -} - -func (crwc *combinedReadWriteHalfCloser) Close() error { - werr := crwc.WriteCloser.Close() - rerr := crwc.ReadCloser.Close() - if werr != nil { - return werr - } - return rerr -} - -func (crwc *combinedReadWriteHalfCloser) CloseWrite() error { - return crwc.WriteCloser.Close() -} - -// A PortForwarder forwards TCP traffic over a Live Share session from a port on a remote -// container to a local destination such as a network port or Go reader/writer. -type PortForwarder struct { - session portForwardingSession - name string - remotePort int - keepAlive bool -} - -// NewPortForwarder returns a new PortForwarder for the specified -// remote port and Live Share session. The name describes the purpose -// of the remote port or service. The keepAlive flag indicates whether -// the session should be kept alive with port forwarding traffic. -func NewPortForwarder(session portForwardingSession, name string, remotePort int, keepAlive bool) *PortForwarder { - return &PortForwarder{ - session: session, - name: name, - remotePort: remotePort, - keepAlive: keepAlive, - } -} - -// ForwardToListener forwards traffic between the container's remote -// port and a local port, which must already be listening for -// connections. (Accepting a listener rather than a port number avoids -// races against other processes opening ports, and against a client -// connecting to the socket prematurely.) -// -// ForwardToListener accepts and handles connections on the local port -// until it encounters the first error, which may include context -// cancellation. Its error result is always non-nil. The caller is -// responsible for closing the listening port. -func (fwd *PortForwarder) ForwardToListener(ctx context.Context, listen *net.TCPListener) (err error) { - id, err := fwd.shareRemotePort(ctx) - if err != nil { - return err - } - - errc := make(chan error, 1) - sendError := func(err error) { - // Use non-blocking send, to avoid goroutines getting - // stuck in case of concurrent or sequential errors. - select { - case errc <- err: - default: - } - } - go func() { - for { - conn, err := listen.AcceptTCP() - if err != nil { - sendError(err) - return - } - - go func() { - if err := fwd.handleConnection(ctx, id, conn); err != nil { - sendError(err) - } - }() - } - }() - - return awaitError(ctx, errc) -} - -// Forward forwards traffic between the container's remote port and -// the specified read/write stream. On return, the stream is closed. -func (fwd *PortForwarder) Forward(ctx context.Context, conn ReadWriteHalfCloser) error { - id, err := fwd.shareRemotePort(ctx) - if err != nil { - conn.Close() - return err - } - - // Create buffered channel so that send doesn't get stuck after context cancellation. - errc := make(chan error, 1) - go func() { - errc <- fwd.handleConnection(ctx, id, conn) - }() - return awaitError(ctx, errc) -} - -func (fwd *PortForwarder) shareRemotePort(ctx context.Context) (ChannelID, error) { - id, err := fwd.session.StartSharing(ctx, fwd.name, fwd.remotePort) - if err != nil { - err = fmt.Errorf("failed to share remote port %d: %w", fwd.remotePort, err) - } - - return id, err -} - -func awaitError(ctx context.Context, errc <-chan error) error { - select { - case err := <-errc: - return err - case <-ctx.Done(): - return ctx.Err() // canceled - } -} - -type trafficMonitorSession interface { - KeepAlive(string) -} - -// trafficMonitor implements io.Reader. It keeps the session alive by notifying -// it of the traffic type during Read operations. -type trafficMonitor struct { - reader io.Reader - - session trafficMonitorSession - trafficType string -} - -// newTrafficMonitor returns a new trafficMonitor for the specified -// session and traffic type. It wraps the provided io.Reader with its own -// Read method. -func newTrafficMonitor(reader io.Reader, session trafficMonitorSession, trafficType string) *trafficMonitor { - return &trafficMonitor{reader, session, trafficType} -} - -func (t *trafficMonitor) Read(p []byte) (n int, err error) { - t.session.KeepAlive(t.trafficType) - return t.reader.Read(p) -} - -// handleConnection handles forwarding for a single accepted connection, then closes it. -func (fwd *PortForwarder) handleConnection(ctx context.Context, id ChannelID, conn ReadWriteHalfCloser) (err error) { - span, ctx := opentracing.StartSpanFromContext(ctx, "PortForwarder.handleConnection") - defer span.Finish() - - defer safeClose(conn, &err) - - channel, err := fwd.session.OpenStreamingChannel(ctx, id) - if err != nil { - return fmt.Errorf("error opening streaming channel for new connection: %w", err) - } - // Ideally we would call safeClose again, but (*ssh.channel).Close - // appears to have a bug that causes it return io.EOF spuriously - // if its peer closed first; see github.com/golang/go/issues/38115. - defer func() { - closeErr := channel.Close() - if err == nil && closeErr != io.EOF { - err = closeErr - } - }() - - // bi-directional copy of data. - errs := make(chan error, 2) - copyConn := func(w ReadWriteHalfCloser, r io.Reader) { - _, err := io.Copy(w, r) - errs <- err - - // Ignore errors here, we call the full Close() later and catch that error - _ = w.CloseWrite() - } - - var ( - channelReader io.Reader = channel - connReader io.Reader = conn - ) - - // If the forwader has been configured to keep the session alive - // it will monitor the I/O and notify the session of the traffic. - if fwd.keepAlive { - channelReader = newTrafficMonitor(channelReader, fwd.session, "output") - connReader = newTrafficMonitor(connReader, fwd.session, "input") - } - - go copyConn(conn, channelReader) - go copyConn(channel, connReader) - - // Wait until context is cancelled or both copies are done. - // Discard errors from io.Copy; they should not cause (e.g.) ForwardToListener to fail. - // TODO: how can we proxy errors from Copy so that each peer can distinguish an error from a short file? - for i := 0; ; { - select { - case <-ctx.Done(): - return ctx.Err() - case <-errs: - i++ - if i == 2 { - return nil - } - } - } -} - -// safeClose reports the error (to *err) from closing the stream only -// if no other error was previously reported. -func safeClose(closer io.Closer, err *error) { - closeErr := closer.Close() - if *err == nil { - *err = closeErr - } -} diff --git a/pkg/liveshare/port_forwarder_test.go b/pkg/liveshare/port_forwarder_test.go deleted file mode 100644 index 61acde368..000000000 --- a/pkg/liveshare/port_forwarder_test.go +++ /dev/null @@ -1,153 +0,0 @@ -package liveshare - -import ( - "bytes" - "context" - "errors" - "fmt" - "io" - "net" - "os" - "testing" - "time" - - livesharetest "github.com/cli/cli/v2/pkg/liveshare/test" - "github.com/sourcegraph/jsonrpc2" -) - -func TestNewPortForwarder(t *testing.T) { - testServer, session, err := makeMockSession() - if err != nil { - t.Errorf("create mock client: %v", err) - } - defer testServer.Close() - pf := NewPortForwarder(session, "ssh", 80, false) - if pf == nil { - t.Error("port forwarder is nil") - } -} - -type portUpdateNotification struct { - PortNotification - conn *jsonrpc2.Conn -} - -func TestPortForwarderStart(t *testing.T) { - if os.Getenv("GITHUB_ACTIONS") == "true" { - t.Skip("fails intermittently in CI: https://github.com/cli/cli/issues/5338") - } - - streamName, streamCondition := "stream-name", "stream-condition" - const port = 8000 - sendNotification := make(chan portUpdateNotification) - serverSharing := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - // Send the PortNotification that will be awaited on in session.StartSharing - sendNotification <- portUpdateNotification{ - PortNotification: PortNotification{ - Port: port, - ChangeKind: PortChangeKindStart, - }, - conn: conn, - } - return Port{StreamName: streamName, StreamCondition: streamCondition}, nil - } - getStream := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - return "stream-id", nil - } - - stream := bytes.NewBufferString("stream-data") - testServer, session, err := makeMockSession( - livesharetest.WithService("serverSharing.startSharing", serverSharing), - livesharetest.WithService("streamManager.getStream", getStream), - livesharetest.WithStream("stream-id", stream), - ) - if err != nil { - t.Errorf("create mock session: %v", err) - } - defer testServer.Close() - - listen, err := net.Listen("tcp", "127.0.0.1:8000") - if err != nil { - t.Fatal(err) - } - defer listen.Close() - tcpListener, ok := listen.(*net.TCPListener) - if !ok { - t.Fatal("net.Listen did not return a TCPListener") - } - - ctx, cancel := context.WithCancel(context.Background()) - defer cancel() - - go func() { - notif := <-sendNotification - _, _ = notif.conn.DispatchCall(context.Background(), "serverSharing.sharingSucceeded", notif) - }() - - done := make(chan error, 2) - go func() { - done <- NewPortForwarder(session, "ssh", port, false).ForwardToListener(ctx, tcpListener) - }() - - go func() { - var conn net.Conn - - // We retry DialTimeout in a loop to deal with a race in PortForwarder startup. - for tries := 0; conn == nil && tries < 2; tries++ { - conn, err = net.DialTimeout("tcp", ":8000", 2*time.Second) - if conn == nil { - time.Sleep(1 * time.Second) - } - } - if conn == nil { - done <- errors.New("failed to connect to forwarded port") - return - } - b := make([]byte, len("stream-data")) - if _, err := conn.Read(b); err != nil && err != io.EOF { - done <- fmt.Errorf("reading stream: %w", err) - return - } - if string(b) != "stream-data" { - done <- fmt.Errorf("stream data is not expected value, got: %s", string(b)) - return - } - if _, err := conn.Write([]byte("new-data")); err != nil { - done <- fmt.Errorf("writing to stream: %w", err) - return - } - done <- nil - }() - - select { - case err := <-testServer.Err(): - t.Errorf("error from server: %v", err) - case err := <-done: - if err != nil { - t.Errorf("error from client: %v", err) - } - } -} - -func TestPortForwarderTrafficMonitor(t *testing.T) { - buf := bytes.NewBufferString("some-input") - session := &Session{keepAliveReason: make(chan string, 1)} - trafficType := "io" - - tm := newTrafficMonitor(buf, session, trafficType) - l := len(buf.Bytes()) - - bb := make([]byte, l) - n, err := tm.Read(bb) - if err != nil { - t.Errorf("failed to read from traffic monitor: %v", err) - } - if n != l { - t.Errorf("expected to read %d bytes, got %d", l, n) - } - - keepAliveReason := <-session.keepAliveReason - if keepAliveReason != trafficType { - t.Errorf("expected keep alive reason to be %s, got %s", trafficType, keepAliveReason) - } -} diff --git a/pkg/liveshare/ports.go b/pkg/liveshare/ports.go deleted file mode 100644 index b39a4f630..000000000 --- a/pkg/liveshare/ports.go +++ /dev/null @@ -1,101 +0,0 @@ -package liveshare - -import ( - "context" - "encoding/json" - "fmt" - - "github.com/sourcegraph/jsonrpc2" -) - -// Port describes a port exposed by the container. -type Port struct { - SourcePort int `json:"sourcePort"` - DestinationPort int `json:"destinationPort"` - SessionName string `json:"sessionName"` - StreamName string `json:"streamName"` - StreamCondition string `json:"streamCondition"` - BrowseURL string `json:"browseUrl"` - IsPublic bool `json:"isPublic"` - IsTCPServerConnectionEstablished bool `json:"isTCPServerConnectionEstablished"` - HasTLSHandshakePassed bool `json:"hasTLSHandshakePassed"` - Privacy string `json:"privacy"` -} - -type PortChangeKind string - -const ( - PortChangeKindStart PortChangeKind = "start" - PortChangeKindUpdate PortChangeKind = "update" -) - -type PortNotification struct { - Success bool // Helps us disambiguate between the SharingSucceeded/SharingFailed events - // The following are properties included in the SharingSucceeded/SharingFailed events sent by the server sharing service in the Codespace - Port int `json:"port"` - ChangeKind PortChangeKind `json:"changeKind"` - ErrorDetail string `json:"errorDetail"` - StatusCode int `json:"statusCode"` -} - -// WaitForPortNotification waits for a port notification to be received. It returns the notification -// or an error if the notification is not received before the context is cancelled or it fails -// to parse the notification. -func (s *Session) WaitForPortNotification(ctx context.Context, port int, notifType PortChangeKind) (*PortNotification, error) { - // We use 1-buffered channels and non-blocking sends so that - // no goroutine gets stuck. - notificationCh := make(chan *PortNotification, 1) - errCh := make(chan error, 1) - - h := func(success bool) func(*jsonrpc2.Conn, *jsonrpc2.Request) { - return func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) { - notification := new(PortNotification) - if err := json.Unmarshal(*req.Params, ¬ification); err != nil { - select { - case errCh <- fmt.Errorf("error unmarshalling notification: %w", err): - default: - } - return - } - notification.Success = success - if notification.Port == port && notification.ChangeKind == notifType { - select { - case notificationCh <- notification: - default: - } - } - } - } - deregisterSuccess := s.registerRequestHandler("serverSharing.sharingSucceeded", h(true)) - deregisterFailure := s.registerRequestHandler("serverSharing.sharingFailed", h(false)) - defer deregisterSuccess() - defer deregisterFailure() - - for { - select { - case <-ctx.Done(): - return nil, ctx.Err() - case err := <-errCh: - return nil, err - case notification := <-notificationCh: - return notification, nil - } - } -} - -// GetSharedServers returns a description of each container port -// shared by a prior call to StartSharing by some client. -func (s *Session) GetSharedServers(ctx context.Context) ([]*Port, error) { - var response []*Port - if err := s.rpc.do(ctx, "serverSharing.getSharedServers", []string{}, &response); err != nil { - return nil, err - } - - return response, nil -} - -// UpdateSharedServerPrivacy controls port permissions and visibility scopes for who can access its URLs -// in the browser. -func (s *Session) UpdateSharedServerPrivacy(ctx context.Context, port int, visibility string) error { - return s.rpc.do(ctx, "serverSharing.updateSharedServerPrivacy", []interface{}{port, visibility}, nil) -} diff --git a/pkg/liveshare/rpc.go b/pkg/liveshare/rpc.go deleted file mode 100644 index 639f538c9..000000000 --- a/pkg/liveshare/rpc.go +++ /dev/null @@ -1,87 +0,0 @@ -package liveshare - -import ( - "context" - "fmt" - "io" - "sync" - "time" - - "github.com/opentracing/opentracing-go" - "github.com/sourcegraph/jsonrpc2" -) - -type rpcClient struct { - *jsonrpc2.Conn - conn io.ReadWriteCloser - handlersMu sync.Mutex - handlers map[string][]*handlerWrapper -} - -func newRPCClient(conn io.ReadWriteCloser) *rpcClient { - return &rpcClient{conn: conn, handlers: make(map[string][]*handlerWrapper)} -} - -func (r *rpcClient) connect(ctx context.Context) { - stream := jsonrpc2.NewBufferedStream(r.conn, jsonrpc2.VSCodeObjectCodec{}) - r.Conn = jsonrpc2.NewConn(ctx, stream, r) -} - -func (r *rpcClient) do(ctx context.Context, method string, args, result interface{}) error { - span, ctx := opentracing.StartSpanFromContext(ctx, method) - defer span.Finish() - - waiter, err := r.Conn.DispatchCall(ctx, method, args) - if err != nil { - return fmt.Errorf("error dispatching %q call: %w", method, err) - } - - // timeout for waiter in case a connection cannot be made - waitCtx, cancel := context.WithTimeout(ctx, 2*time.Minute) - defer cancel() - - return waiter.Wait(waitCtx, result) -} - -type handler func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) - -type handlerWrapper struct { - fn handler -} - -func (r *rpcClient) register(requestType string, fn handler) func() { - r.handlersMu.Lock() - defer r.handlersMu.Unlock() - - h := &handlerWrapper{fn: fn} - r.handlers[requestType] = append(r.handlers[requestType], h) - - return func() { - r.deregister(requestType, h) - } -} - -func (r *rpcClient) deregister(requestType string, handler *handlerWrapper) { - r.handlersMu.Lock() - defer r.handlersMu.Unlock() - - handlers := r.handlers[requestType] - for i, h := range handlers { - if h == handler { - // Swap h with last element and pop. - last := len(handlers) - 1 - handlers[i], handlers[last] = handlers[last], nil - r.handlers[requestType] = handlers[:last] - break - } - } -} - -func (r *rpcClient) Handle(ctx context.Context, conn *jsonrpc2.Conn, req *jsonrpc2.Request) { - r.handlersMu.Lock() - defer r.handlersMu.Unlock() - - for _, handler := range r.handlers[req.Method] { - go handler.fn(conn, req) - } -} diff --git a/pkg/liveshare/session.go b/pkg/liveshare/session.go deleted file mode 100644 index e5ec86703..000000000 --- a/pkg/liveshare/session.go +++ /dev/null @@ -1,133 +0,0 @@ -package liveshare - -import ( - "context" - "fmt" - - "github.com/opentracing/opentracing-go" - "golang.org/x/crypto/ssh" - "golang.org/x/sync/errgroup" -) - -// A ChannelID is an identifier for an exposed port on a remote -// container that may be used to open an SSH channel to it. -type ChannelID struct { - name, condition string -} - -// Interface to allow the mocking of the liveshare session -type LiveshareSession interface { - Close() error - GetSharedServers(context.Context) ([]*Port, error) - KeepAlive(string) - OpenStreamingChannel(context.Context, ChannelID) (ssh.Channel, error) - StartSharing(context.Context, string, int) (ChannelID, error) - GetKeepAliveReason() string -} - -// A Session represents the session between a connected Live Share client and server. -type Session struct { - ssh *sshSession - rpc *rpcClient - - keepAliveReason chan string - logger logger -} - -// Close should be called by users to clean up RPC and SSH resources whenever the session -// is no longer active. -func (s *Session) Close() error { - // Closing the RPC conn closes the underlying stream (SSH) - // So we only need to close once - if err := s.rpc.Close(); err != nil { - s.ssh.Close() // close SSH and ignore error - return fmt.Errorf("error while closing Live Share session: %w", err) - } - - return nil -} - -// Fetches the keep alive reason from the channel and returns it. -func (s *Session) GetKeepAliveReason() string { - return <-s.keepAliveReason -} - -// registerRequestHandler registers a handler for the given request type with the RPC -// server and returns a callback function to deregister the handler -func (s *Session) registerRequestHandler(requestType string, h handler) func() { - return s.rpc.register(requestType, h) -} - -// KeepAlive accepts a reason that is retained if there is no active reason -// to send to the server. -func (s *Session) KeepAlive(reason string) { - select { - case s.keepAliveReason <- reason: - default: - // there is already an active keep alive reason - // so we can ignore this one - } -} - -// StartSharing tells the Live Share host to start sharing the specified port from the container. -// The sessionName describes the purpose of the remote port or service. -// It returns an identifier that can be used to open an SSH channel to the remote port. -func (s *Session) StartSharing(ctx context.Context, sessionName string, port int) (ChannelID, error) { - args := []interface{}{port, sessionName, fmt.Sprintf("http://localhost:%d", port)} - g, ctx := errgroup.WithContext(ctx) - - g.Go(func() error { - startNotification, err := s.WaitForPortNotification(ctx, port, PortChangeKindStart) - if err != nil { - return fmt.Errorf("error while waiting for port notification: %w", err) - - } - if !startNotification.Success { - return fmt.Errorf("error while starting port sharing: %s", startNotification.ErrorDetail) - } - return nil // success - }) - - var response Port - g.Go(func() error { - return s.rpc.do(ctx, "serverSharing.startSharing", args, &response) - }) - - if err := g.Wait(); err != nil { - return ChannelID{}, err - } - - return ChannelID{response.StreamName, response.StreamCondition}, nil -} - -func (s *Session) OpenStreamingChannel(ctx context.Context, id ChannelID) (ssh.Channel, error) { - type getStreamArgs struct { - StreamName string `json:"streamName"` - Condition string `json:"condition"` - } - args := getStreamArgs{ - StreamName: id.name, - Condition: id.condition, - } - var streamID string - if err := s.rpc.do(ctx, "streamManager.getStream", args, &streamID); err != nil { - return nil, fmt.Errorf("error getting stream id: %w", err) - } - - span, ctx := opentracing.StartSpanFromContext(ctx, "Session.OpenChannel+SendRequest") - defer span.Finish() - _ = ctx // ctx is not currently used - - channel, reqs, err := s.ssh.conn.OpenChannel("session", nil) - if err != nil { - return nil, fmt.Errorf("error opening ssh channel for transport: %w", err) - } - go ssh.DiscardRequests(reqs) - - requestType := fmt.Sprintf("stream-transport-%s", streamID) - if _, err = channel.SendRequest(requestType, true, nil); err != nil { - return nil, fmt.Errorf("error sending channel request: %w", err) - } - - return channel, nil -} diff --git a/pkg/liveshare/session_test.go b/pkg/liveshare/session_test.go deleted file mode 100644 index ab7cf18bd..000000000 --- a/pkg/liveshare/session_test.go +++ /dev/null @@ -1,278 +0,0 @@ -package liveshare - -import ( - "bytes" - "context" - "crypto/tls" - "encoding/json" - "errors" - "fmt" - "strings" - "sync" - "testing" - - livesharetest "github.com/cli/cli/v2/pkg/liveshare/test" - "github.com/sourcegraph/jsonrpc2" -) - -func makeMockSession(opts ...livesharetest.ServerOption) (*livesharetest.Server, *Session, error) { - joinWorkspace := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - return joinWorkspaceResult{1}, nil - } - const sessionToken = "session-token" - opts = append( - opts, - livesharetest.WithPassword(sessionToken), - livesharetest.WithService("workspace.joinWorkspace", joinWorkspace), - ) - testServer, err := livesharetest.NewServer(opts...) - if err != nil { - return nil, nil, fmt.Errorf("error creating server: %w", err) - } - - session, err := Connect(context.Background(), Options{ - SessionID: "session-id", - SessionToken: sessionToken, - RelayEndpoint: "sb" + strings.TrimPrefix(testServer.URL(), "https"), - RelaySAS: "relay-sas", - HostPublicKeys: []string{livesharetest.SSHPublicKey}, - TLSConfig: &tls.Config{InsecureSkipVerify: true}, - Logger: newMockLogger(), - }) - if err != nil { - return nil, nil, fmt.Errorf("error connecting to Live Share: %w", err) - } - return testServer, session, nil -} - -func TestServerStartSharing(t *testing.T) { - serverPort, serverProtocol := 2222, "sshd" - sendNotification := make(chan portUpdateNotification) - startSharing := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - var args []interface{} - if err := json.Unmarshal(*req.Params, &args); err != nil { - return nil, fmt.Errorf("error unmarshalling request: %w", err) - } - if len(args) < 3 { - return nil, errors.New("not enough arguments to start sharing") - } - port, ok := args[0].(float64) - if !ok { - return nil, errors.New("port argument is not an int") - } - if port != float64(serverPort) { - return nil, errors.New("port does not match serverPort") - } - if protocol, ok := args[1].(string); !ok { - return nil, errors.New("protocol argument is not a string") - } else if protocol != serverProtocol { - return nil, errors.New("protocol does not match serverProtocol") - } - if browseURL, ok := args[2].(string); !ok { - return nil, errors.New("browse url is not a string") - } else if browseURL != fmt.Sprintf("http://localhost:%d", serverPort) { - return nil, errors.New("browseURL does not match expected") - } - sendNotification <- portUpdateNotification{ - PortNotification: PortNotification{ - Port: int(port), - ChangeKind: PortChangeKindStart, - }, - conn: conn, - } - return Port{StreamName: "stream-name", StreamCondition: "stream-condition"}, nil - } - testServer, session, err := makeMockSession( - livesharetest.WithService("serverSharing.startSharing", startSharing), - ) - defer testServer.Close() //nolint:staticcheck // httptest.Server does not return errors on Close() - - if err != nil { - t.Errorf("error creating mock session: %v", err) - } - ctx := context.Background() - - go func() { - notif := <-sendNotification - _, _ = notif.conn.DispatchCall(context.Background(), "serverSharing.sharingSucceeded", notif) - }() - - done := make(chan error) - go func() { - streamID, err := session.StartSharing(ctx, serverProtocol, serverPort) - if err != nil { - done <- fmt.Errorf("error sharing server: %w", err) - } - if streamID.name == "" || streamID.condition == "" { - done <- errors.New("stream name or condition is blank") - } - done <- nil - }() - - select { - case err := <-testServer.Err(): - t.Errorf("error from server: %v", err) - case err := <-done: - if err != nil { - t.Errorf("error from client: %v", err) - } - } -} - -func TestServerGetSharedServers(t *testing.T) { - sharedServer := Port{ - SourcePort: 2222, - StreamName: "stream-name", - StreamCondition: "stream-condition", - } - getSharedServers := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - return []*Port{&sharedServer}, nil - } - testServer, session, err := makeMockSession( - livesharetest.WithService("serverSharing.getSharedServers", getSharedServers), - ) - if err != nil { - t.Errorf("error creating mock session: %v", err) - } - defer testServer.Close() - ctx := context.Background() - done := make(chan error) - go func() { - ports, err := session.GetSharedServers(ctx) - if err != nil { - done <- fmt.Errorf("error getting shared servers: %w", err) - } - if len(ports) < 1 { - done <- errors.New("not enough ports returned") - } - if ports[0].SourcePort != sharedServer.SourcePort { - done <- errors.New("source port does not match") - } - if ports[0].StreamName != sharedServer.StreamName { - done <- errors.New("stream name does not match") - } - if ports[0].StreamCondition != sharedServer.StreamCondition { - done <- errors.New("stream condiion does not match") - } - done <- nil - }() - - select { - case err := <-testServer.Err(): - t.Errorf("error from server: %v", err) - case err := <-done: - if err != nil { - t.Errorf("error from client: %v", err) - } - } -} - -func TestServerUpdateSharedServerPrivacy(t *testing.T) { - updateSharedVisibility := func(conn *jsonrpc2.Conn, rpcReq *jsonrpc2.Request) (interface{}, error) { - var req []interface{} - if err := json.Unmarshal(*rpcReq.Params, &req); err != nil { - return nil, fmt.Errorf("unmarshal req: %w", err) - } - if len(req) < 2 { - return nil, errors.New("request arguments is less than 2") - } - if port, ok := req[0].(float64); ok { - if port != 80.0 { - return nil, errors.New("port param is not expected value") - } - } else { - return nil, errors.New("port param is not a float64") - } - if privacy, ok := req[1].(string); ok { - if privacy != "public" { - return nil, fmt.Errorf("expected privacy param to be public but got %q", privacy) - } - } else { - return nil, fmt.Errorf("expected privacy param to be a bool but go %T", req[1]) - } - return nil, nil - } - testServer, session, err := makeMockSession( - livesharetest.WithService("serverSharing.updateSharedServerPrivacy", updateSharedVisibility), - ) - if err != nil { - t.Errorf("creating mock session: %v", err) - } - defer testServer.Close() - ctx := context.Background() - done := make(chan error) - go func() { - done <- session.UpdateSharedServerPrivacy(ctx, 80, "public") - }() - select { - case err := <-testServer.Err(): - t.Errorf("error from server: %v", err) - case err := <-done: - if err != nil { - t.Errorf("error from client: %v", err) - } - } -} - -func TestInvalidHostKey(t *testing.T) { - joinWorkspace := func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) { - return joinWorkspaceResult{1}, nil - } - const sessionToken = "session-token" - opts := []livesharetest.ServerOption{ - livesharetest.WithPassword(sessionToken), - livesharetest.WithService("workspace.joinWorkspace", joinWorkspace), - } - testServer, err := livesharetest.NewServer(opts...) - if err != nil { - t.Errorf("error creating server: %v", err) - } - _, err = Connect(context.Background(), Options{ - SessionID: "session-id", - SessionToken: sessionToken, - RelayEndpoint: "sb" + strings.TrimPrefix(testServer.URL(), "https"), - RelaySAS: "relay-sas", - HostPublicKeys: []string{}, - TLSConfig: &tls.Config{InsecureSkipVerify: true}, - }) - if err == nil { - t.Error("expected invalid host key error, got: nil") - } -} - -func TestKeepAliveNonBlocking(t *testing.T) { - session := &Session{keepAliveReason: make(chan string, 1)} - for i := 0; i < 2; i++ { - session.KeepAlive("io") - } - - // if KeepAlive blocks, we'll never reach this and timeout the test - // timing out -} - -type mockLogger struct { - sync.Mutex - buf *bytes.Buffer -} - -func newMockLogger() *mockLogger { - return &mockLogger{buf: new(bytes.Buffer)} -} - -func (m *mockLogger) Printf(format string, v ...interface{}) { - m.Lock() - defer m.Unlock() - m.buf.WriteString(fmt.Sprintf(format, v...)) -} - -func (m *mockLogger) Println(v ...interface{}) { - m.Lock() - defer m.Unlock() - m.buf.WriteString(fmt.Sprintln(v...)) -} - -func (m *mockLogger) String() string { - m.Lock() - defer m.Unlock() - return m.buf.String() -} diff --git a/pkg/liveshare/socket.go b/pkg/liveshare/socket.go deleted file mode 100644 index f66436f65..000000000 --- a/pkg/liveshare/socket.go +++ /dev/null @@ -1,100 +0,0 @@ -package liveshare - -import ( - "context" - "crypto/tls" - "io" - "net" - "net/http" - "time" - - "github.com/gorilla/websocket" -) - -type socket struct { - addr string - tlsConfig *tls.Config - - conn *websocket.Conn - reader io.Reader -} - -func newSocket(uri string, tlsConfig *tls.Config) *socket { - return &socket{addr: uri, tlsConfig: tlsConfig} -} - -func (s *socket) connect(ctx context.Context) error { - dialer := websocket.Dialer{ - Proxy: http.ProxyFromEnvironment, - HandshakeTimeout: 45 * time.Second, - TLSClientConfig: s.tlsConfig, - } - ws, _, err := dialer.Dial(s.addr, nil) - if err != nil { - return err - } - s.conn = ws - return nil -} - -func (s *socket) Read(b []byte) (int, error) { - if s.reader == nil { - _, reader, err := s.conn.NextReader() - if err != nil { - return 0, err - } - - s.reader = reader - } - - bytesRead, err := s.reader.Read(b) - if err != nil { - s.reader = nil - - if err == io.EOF { - err = nil - } - } - - return bytesRead, err -} - -func (s *socket) Write(b []byte) (int, error) { - nextWriter, err := s.conn.NextWriter(websocket.BinaryMessage) - if err != nil { - return 0, err - } - - bytesWritten, err := nextWriter.Write(b) - nextWriter.Close() - - return bytesWritten, err -} - -func (s *socket) Close() error { - return s.conn.Close() -} - -func (s *socket) LocalAddr() net.Addr { - return s.conn.LocalAddr() -} - -func (s *socket) RemoteAddr() net.Addr { - return s.conn.RemoteAddr() -} - -func (s *socket) SetDeadline(t time.Time) error { - if err := s.SetReadDeadline(t); err != nil { - return err - } - - return s.SetWriteDeadline(t) -} - -func (s *socket) SetReadDeadline(t time.Time) error { - return s.conn.SetReadDeadline(t) -} - -func (s *socket) SetWriteDeadline(t time.Time) error { - return s.conn.SetWriteDeadline(t) -} diff --git a/pkg/liveshare/ssh.go b/pkg/liveshare/ssh.go deleted file mode 100644 index e7de9055a..000000000 --- a/pkg/liveshare/ssh.go +++ /dev/null @@ -1,79 +0,0 @@ -package liveshare - -import ( - "context" - "encoding/base64" - "errors" - "fmt" - "io" - "net" - "time" - - "golang.org/x/crypto/ssh" -) - -type sshSession struct { - *ssh.Session - token string - hostPublicKeys []string - socket net.Conn - conn ssh.Conn - reader io.Reader - writer io.Writer -} - -func newSSHSession(token string, hostPublicKeys []string, socket net.Conn) *sshSession { - return &sshSession{token: token, hostPublicKeys: hostPublicKeys, socket: socket} -} - -func (s *sshSession) connect(ctx context.Context) error { - clientConfig := ssh.ClientConfig{ - User: "", - Auth: []ssh.AuthMethod{ - ssh.Password(s.token), - }, - HostKeyAlgorithms: []string{"rsa-sha2-512", "rsa-sha2-256"}, - HostKeyCallback: func(hostname string, addr net.Addr, key ssh.PublicKey) error { - encodedKey := base64.StdEncoding.EncodeToString(key.Marshal()) - for _, hpk := range s.hostPublicKeys { - if encodedKey == hpk { - return nil // we found a match for expected public key, safely return - } - } - return errors.New("invalid host public key") - }, - Timeout: 10 * time.Second, - } - - sshClientConn, chans, reqs, err := ssh.NewClientConn(s.socket, "", &clientConfig) - if err != nil { - return fmt.Errorf("error creating ssh client connection: %w", err) - } - s.conn = sshClientConn - - sshClient := ssh.NewClient(sshClientConn, chans, reqs) - s.Session, err = sshClient.NewSession() - if err != nil { - return fmt.Errorf("error creating ssh client session: %w", err) - } - - s.reader, err = s.Session.StdoutPipe() - if err != nil { - return fmt.Errorf("error creating ssh session reader: %w", err) - } - - s.writer, err = s.Session.StdinPipe() - if err != nil { - return fmt.Errorf("error creating ssh session writer: %w", err) - } - - return nil -} - -func (s *sshSession) Read(p []byte) (n int, err error) { - return s.reader.Read(p) -} - -func (s *sshSession) Write(p []byte) (n int, err error) { - return s.writer.Write(p) -} diff --git a/pkg/liveshare/test/server.go b/pkg/liveshare/test/server.go deleted file mode 100644 index 0b4f6a7ba..000000000 --- a/pkg/liveshare/test/server.go +++ /dev/null @@ -1,349 +0,0 @@ -package livesharetest - -import ( - "context" - "errors" - "fmt" - "io" - "net/http" - "net/http/httptest" - "strings" - "sync" - - "github.com/gorilla/websocket" - "github.com/sourcegraph/jsonrpc2" - "golang.org/x/crypto/ssh" -) - -const sshPrivateKey = `-----BEGIN RSA PRIVATE KEY----- -MIICXgIBAAKBgQC6VU6XsMaTot9ogsGcJ+juvJOmDvvCZmgJRTRwKkW0u2BLz4yV -rCzQcxaY4kaIuR80Y+1f0BLnZgh4pTREDR0T+p8hUsDSHim1ttKI8rK0hRtJ2qhY -lR4qt7P51rPA4KFA9z9gDjTwQLbDq21QMC4+n4d8CL3xRVGtlUAMM3Kl3wIDAQAB -AoGBAI8UemkYoSM06gBCh5D1RHQt8eKNltzL7g9QSNfoXeZOC7+q+/TiZPcbqLp0 -5lyOalu8b8Ym7J0rSE377Ypj13LyHMXS63e4wMiXv3qOl3GDhMLpypnJ8PwqR2b8 -IijL2jrpQfLu6IYqlteA+7e9aEexJa1RRwxYIyq6pG1IYpbhAkEA9nKgtj3Z6ZDC -46IdqYzuUM9ZQdcw4AFr407+lub7tbWe5pYmaq3cT725IwLw081OAmnWJYFDMa/n -IPl9YcZSPQJBAMGOMbPs/YPkQAsgNdIUlFtK3o41OrrwJuTRTvv0DsbqDV0LKOiC -t8oAQQvjisH6Ew5OOhFyIFXtvZfzQMJppksCQQDWFd+cUICTUEise/Duj9maY3Uz -J99ySGnTbZTlu8PfJuXhg3/d3ihrMPG6A1z3cPqaSBxaOj8H07mhQHn1zNU1AkEA -hkl+SGPrO793g4CUdq2ahIA8SpO5rIsDoQtq7jlUq0MlhGFCv5Y5pydn+bSjx5MV -933kocf5kUSBntPBIWElYwJAZTm5ghu0JtSE6t3km0iuj7NGAQSdb6mD8+O7C3CP -FU3vi+4HlBysaT6IZ/HG+/dBsr4gYp4LGuS7DbaLuYw/uw== ------END RSA PRIVATE KEY-----` - -const SSHPublicKey = `AAAAB3NzaC1yc2EAAAADAQABAAAAgQC6VU6XsMaTot9ogsGcJ+juvJOmDvvCZmgJRTRwKkW0u2BLz4yVrCzQcxaY4kaIuR80Y+1f0BLnZgh4pTREDR0T+p8hUsDSHim1ttKI8rK0hRtJ2qhYlR4qt7P51rPA4KFA9z9gDjTwQLbDq21QMC4+n4d8CL3xRVGtlUAMM3Kl3w==` - -// Server represents a LiveShare relay host server. -type Server struct { - password string - services map[string]RPCHandleFunc - relaySAS string - streams map[string]io.ReadWriter - sshConfig *ssh.ServerConfig - httptestServer *httptest.Server - errCh chan error - nonSecure bool -} - -// NewServer creates a new Server. ServerOptions can be passed to configure -// the SSH password, backing service, secrets and more. -func NewServer(opts ...ServerOption) (*Server, error) { - server := new(Server) - - for _, o := range opts { - if err := o(server); err != nil { - return nil, err - } - } - - server.sshConfig = &ssh.ServerConfig{ - PasswordCallback: sshPasswordCallback(server.password), - } - privateKey, err := ssh.ParsePrivateKey([]byte(sshPrivateKey)) - if err != nil { - return nil, fmt.Errorf("error parsing key: %w", err) - } - server.sshConfig.AddHostKey(privateKey) - - server.errCh = make(chan error, 1) - - if server.nonSecure { - server.httptestServer = httptest.NewServer(http.HandlerFunc(makeConnection(server))) - } else { - server.httptestServer = httptest.NewTLSServer(http.HandlerFunc(makeConnection(server))) - } - return server, nil -} - -// ServerOption is used to configure the Server. -type ServerOption func(*Server) error - -// WithPassword configures the Server password for SSH. -func WithPassword(password string) ServerOption { - return func(s *Server) error { - s.password = password - return nil - } -} - -// WithNonSecure configures the Server as non-secure. -func WithNonSecure() ServerOption { - return func(s *Server) error { - s.nonSecure = true - return nil - } -} - -// WithService accepts a mock RPC service for the Server to invoke. -func WithService(serviceName string, handler RPCHandleFunc) ServerOption { - return func(s *Server) error { - if s.services == nil { - s.services = make(map[string]RPCHandleFunc) - } - - s.services[serviceName] = handler - return nil - } -} - -// WithRelaySAS configures the relay SAS configuration key. -func WithRelaySAS(sas string) ServerOption { - return func(s *Server) error { - s.relaySAS = sas - return nil - } -} - -// WithStream allows you to specify a mock data stream for the server. -func WithStream(name string, stream io.ReadWriter) ServerOption { - return func(s *Server) error { - if s.streams == nil { - s.streams = make(map[string]io.ReadWriter) - } - s.streams[name] = stream - return nil - } -} - -func sshPasswordCallback(serverPassword string) func(ssh.ConnMetadata, []byte) (*ssh.Permissions, error) { - return func(conn ssh.ConnMetadata, password []byte) (*ssh.Permissions, error) { - if string(password) == serverPassword { - return nil, nil - } - return nil, errors.New("password rejected") - } -} - -// Close closes the underlying httptest Server. -func (s *Server) Close() { - s.httptestServer.Close() -} - -// URL returns the httptest Server url. -func (s *Server) URL() string { - return s.httptestServer.URL -} - -func (s *Server) Err() <-chan error { - return s.errCh -} - -var upgrader = websocket.Upgrader{} - -func makeConnection(server *Server) http.HandlerFunc { - return func(w http.ResponseWriter, req *http.Request) { - ctx, cancel := context.WithCancel(context.Background()) - defer cancel() - - if server.relaySAS != "" { - // validate the sas key - sasParam := req.URL.Query().Get("sb-hc-token") - if sasParam != server.relaySAS { - sendError(server.errCh, errors.New("error validating sas")) - return - } - } - c, err := upgrader.Upgrade(w, req, nil) - if err != nil { - sendError(server.errCh, fmt.Errorf("error upgrading connection: %w", err)) - return - } - defer func() { - if err := c.Close(); err != nil { - sendError(server.errCh, err) - } - }() - - socketConn := newSocketConn(c) - _, chans, reqs, err := ssh.NewServerConn(socketConn, server.sshConfig) - if err != nil { - sendError(server.errCh, fmt.Errorf("error creating new ssh conn: %w", err)) - return - } - go ssh.DiscardRequests(reqs) - - if err := handleChannels(ctx, server, chans); err != nil { - sendError(server.errCh, err) - } - } -} - -// sendError does a non-blocking send of the error to the err channel. -func sendError(errc chan<- error, err error) { - select { - case errc <- err: - default: - // channel is blocked with a previous error, so we ignore - // this current error - } -} - -// awaitError waits for the context to finish and returns its error (if any). -// It also waits for an err to come through the err channel. -func awaitError(ctx context.Context, errc <-chan error) error { - select { - case <-ctx.Done(): - return ctx.Err() - case err := <-errc: - return err - } -} - -// handleChannels services the sshChannels channel. For each SSH channel received -// it creates a go routine to service the channel's requests. It returns on the first -// error encountered. -func handleChannels(ctx context.Context, server *Server, sshChannels <-chan ssh.NewChannel) error { - errc := make(chan error, 1) - go func() { - for sshCh := range sshChannels { - ch, reqs, err := sshCh.Accept() - if err != nil { - sendError(errc, fmt.Errorf("failed to accept channel: %w", err)) - return - } - - go func() { - if err := handleRequests(ctx, server, ch, reqs); err != nil { - sendError(errc, fmt.Errorf("failed to handle requests: %w", err)) - } - }() - - handleChannel(server, ch) - } - }() - return awaitError(ctx, errc) -} - -// handleRequests services the SSH channel requests channel. It replies to requests and -// when stream transport requests are encountered, creates a go routine to create a -// bi-directional data stream between the channel and server stream. It returns on the first error -// encountered. -func handleRequests(ctx context.Context, server *Server, channel ssh.Channel, reqs <-chan *ssh.Request) error { - errc := make(chan error, 1) - go func() { - for req := range reqs { - r := req - if r.WantReply { - if err := r.Reply(true, nil); err != nil { - sendError(errc, fmt.Errorf("error replying to channel request: %w", err)) - return - } - } - - if strings.HasPrefix(r.Type, "stream-transport") { - go func() { - if err := forwardStream(ctx, server, r.Type, channel); err != nil { - sendError(errc, fmt.Errorf("failed to forward stream: %w", err)) - } - }() - } - } - }() - - return awaitError(ctx, errc) -} - -// concurrentStream is a concurrency safe io.ReadWriter. -type concurrentStream struct { - sync.RWMutex - stream io.ReadWriter -} - -func newConcurrentStream(rw io.ReadWriter) *concurrentStream { - return &concurrentStream{stream: rw} -} - -func (cs *concurrentStream) Read(b []byte) (int, error) { - cs.RLock() - defer cs.RUnlock() - return cs.stream.Read(b) -} - -func (cs *concurrentStream) Write(b []byte) (int, error) { - cs.Lock() - defer cs.Unlock() - return cs.stream.Write(b) -} - -// forwardStream does a bi-directional copy of the stream <-> with the SSH channel. The io.Copy -// runs until an error is encountered. -func forwardStream(ctx context.Context, server *Server, streamName string, channel ssh.Channel) (err error) { - simpleStreamName := strings.TrimPrefix(streamName, "stream-transport-") - stream, found := server.streams[simpleStreamName] - if !found { - return fmt.Errorf("stream '%s' not found", simpleStreamName) - } - defer func() { - if closeErr := channel.Close(); err == nil && closeErr != io.EOF { - err = closeErr - } - }() - - errc := make(chan error, 2) - copy := func(dst io.Writer, src io.Reader) { - if _, err := io.Copy(dst, src); err != nil { - errc <- err - } - } - - csStream := newConcurrentStream(stream) - go copy(csStream, channel) - go copy(channel, csStream) - - return awaitError(ctx, errc) -} - -func handleChannel(server *Server, channel ssh.Channel) { - stream := jsonrpc2.NewBufferedStream(channel, jsonrpc2.VSCodeObjectCodec{}) - jsonrpc2.NewConn(context.Background(), stream, newRPCHandler(server)) -} - -type RPCHandleFunc func(conn *jsonrpc2.Conn, req *jsonrpc2.Request) (interface{}, error) - -type rpcHandler struct { - server *Server -} - -func newRPCHandler(server *Server) *rpcHandler { - return &rpcHandler{server} -} - -// Handle satisfies the jsonrpc2 pkg handler interface. It tries to find a mocked -// RPC service method and if found, it invokes the handler and replies to the request. -func (r *rpcHandler) Handle(ctx context.Context, conn *jsonrpc2.Conn, req *jsonrpc2.Request) { - handler, found := r.server.services[req.Method] - if !found { - sendError(r.server.errCh, fmt.Errorf("RPC Method: '%s' not serviced", req.Method)) - return - } - - result, err := handler(conn, req) - if err != nil { - sendError(r.server.errCh, fmt.Errorf("error handling: '%s': %w", req.Method, err)) - return - } - - if err := conn.Reply(ctx, req.ID, result); err != nil { - sendError(r.server.errCh, fmt.Errorf("error replying: %w", err)) - } -} diff --git a/pkg/liveshare/test/socket.go b/pkg/liveshare/test/socket.go deleted file mode 100644 index 00cd64a1b..000000000 --- a/pkg/liveshare/test/socket.go +++ /dev/null @@ -1,77 +0,0 @@ -package livesharetest - -import ( - "fmt" - "io" - "sync" - "time" - - "github.com/gorilla/websocket" -) - -type socketConn struct { - *websocket.Conn - - reader io.Reader - writeMutex sync.Mutex - readMutex sync.Mutex -} - -func newSocketConn(conn *websocket.Conn) *socketConn { - return &socketConn{Conn: conn} -} - -func (s *socketConn) Read(b []byte) (int, error) { - s.readMutex.Lock() - defer s.readMutex.Unlock() - - if s.reader == nil { - msgType, r, err := s.Conn.NextReader() - if err != nil { - return 0, fmt.Errorf("error getting next reader: %w", err) - } - if msgType != websocket.BinaryMessage { - return 0, fmt.Errorf("invalid message type") - } - s.reader = r - } - - bytesRead, err := s.reader.Read(b) - if err != nil { - s.reader = nil - - if err == io.EOF { - err = nil - } - } - - return bytesRead, err -} - -func (s *socketConn) Write(b []byte) (int, error) { - s.writeMutex.Lock() - defer s.writeMutex.Unlock() - - w, err := s.Conn.NextWriter(websocket.BinaryMessage) - if err != nil { - return 0, fmt.Errorf("error getting next writer: %w", err) - } - - n, err := w.Write(b) - if err != nil { - return 0, fmt.Errorf("error writing: %w", err) - } - - if err := w.Close(); err != nil { - return 0, fmt.Errorf("error closing writer: %w", err) - } - - return n, nil -} - -func (s *socketConn) SetDeadline(deadline time.Time) error { - if err := s.Conn.SetReadDeadline(deadline); err != nil { - return err - } - return s.Conn.SetWriteDeadline(deadline) -} From a8f8728056c8457e53dba3f56e1cf772472f9fd9 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Thu, 12 Oct 2023 16:55:13 -0700 Subject: [PATCH 056/527] Poll permission acceptance endpoint on codespace creation --- internal/codespaces/api/api.go | 40 +++++ pkg/cmd/codespace/common.go | 3 +- pkg/cmd/codespace/create.go | 50 +++++- pkg/cmd/codespace/mock_api.go | 272 +++++++++++++++++++-------------- 4 files changed, 246 insertions(+), 119 deletions(-) diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index 302e0ee0f..950a8ea52 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -639,6 +639,46 @@ func (a *API) GetCodespacesMachines(ctx context.Context, repoID int, branch, loc return response.Machines, nil } +// GetCodespacesPermissionsCheck returns a bool indicating whether the user has accepted permissions for the given repo and devcontainer path. +func (a *API) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) { + reqURL := fmt.Sprintf("%s/repositories/%d/codespaces/permissions_check", a.githubAPI, repoID) + req, err := http.NewRequest(http.MethodGet, reqURL, nil) + if err != nil { + return false, fmt.Errorf("error creating request: %w", err) + } + + q := req.URL.Query() + q.Add("location", location) + q.Add("ref", branch) + q.Add("devcontainer_path", devcontainerPath) + req.URL.RawQuery = q.Encode() + + a.setHeaders(req) + resp, err := a.do(ctx, req, "/repositories/*/codespaces/permissions_check") + if err != nil { + return false, fmt.Errorf("error making request: %w", err) + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusOK { + return false, api.HandleHTTPError(resp) + } + + b, err := io.ReadAll(resp.Body) + if err != nil { + return false, fmt.Errorf("error reading response body: %w", err) + } + + var response struct { + Accepted bool `json:"accepted"` + } + if err := json.Unmarshal(b, &response); err != nil { + return false, fmt.Errorf("error unmarshalling response: %w", err) + } + + return response.Accepted, nil +} + // RepoSearchParameters are the optional parameters for searching for repositories. type RepoSearchParameters struct { // The maximum number of repos to return. At most 100 repos are returned even if this value is greater than 100. diff --git a/pkg/cmd/codespace/common.go b/pkg/cmd/codespace/common.go index 3ad3463e6..78dae09e4 100644 --- a/pkg/cmd/codespace/common.go +++ b/pkg/cmd/codespace/common.go @@ -76,7 +76,8 @@ type apiClient interface { CreateCodespace(ctx context.Context, params *api.CreateCodespaceParams) (*api.Codespace, error) EditCodespace(ctx context.Context, codespaceName string, params *api.EditCodespaceParams) (*api.Codespace, error) GetRepository(ctx context.Context, nwo string) (*api.Repository, error) - GetCodespacesMachines(ctx context.Context, repoID int, branch, location string, devcontainerPath string) ([]*api.Machine, error) + GetCodespacesMachines(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*api.Machine, error) + GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) GetCodespaceRepositoryContents(ctx context.Context, codespace *api.Codespace, path string) ([]byte, error) ListDevContainers(ctx context.Context, repoID int, branch string, limit int) (devcontainers []api.DevContainerEntry, err error) GetCodespaceRepoSuggestions(ctx context.Context, partialSearch string, params api.RepoSearchParameters) ([]string, error) diff --git a/pkg/cmd/codespace/create.go b/pkg/cmd/codespace/create.go index a2782aef7..485f8e57c 100644 --- a/pkg/cmd/codespace/create.go +++ b/pkg/cmd/codespace/create.go @@ -19,6 +19,11 @@ const ( DEVCONTAINER_PROMPT_DEFAULT = "Default Codespaces configuration" ) +const ( + permissionsPollingInterval = 5 * time.Second + permissionsPollingTimeout = 1 * time.Minute +) + var ( DEFAULT_DEVCONTAINER_DEFINITIONS = []string{".devcontainer.json", ".devcontainer/devcontainer.json"} ) @@ -307,7 +312,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { return fmt.Errorf("error creating codespace: %w", err) } - codespace, err = a.handleAdditionalPermissions(ctx, createParams, aerr.AllowPermissionsURL) + codespace, err = a.handleAdditionalPermissions(ctx, createParams, aerr.AllowPermissionsURL, userInputs.Location) if err != nil { // this error could be a cmdutil.SilentError (in the case that the user opened the browser) so we don't want to wrap it return err @@ -331,7 +336,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { return nil } -func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api.CreateCodespaceParams, allowPermissionsURL string) (*api.Codespace, error) { +func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api.CreateCodespaceParams, allowPermissionsURL string, location string) (*api.Codespace, error) { var ( isInteractive = a.io.CanPrompt() cs = a.io.ColorScheme() @@ -372,13 +377,44 @@ func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api // if the user chose to continue in the browser, open the URL if answers.Accept == choices[0] { - fmt.Fprintln(a.io.ErrOut, "Please re-run the create request after accepting permissions in the browser.") if err := a.browser.Browse(allowPermissionsURL); err != nil { return nil, fmt.Errorf("error opening browser: %w", err) } - // browser opened successfully but we do not know if they accepted the permissions - // so we must exit and wait for the user to attempt the create again - return nil, cmdutil.SilentError + } + + // Poll until the user has accepted the permissions or timeout + err := a.RunWithProgress("Waiting for permissions to be accepted in the browser", func() (err error) { + ctx, cancel := context.WithTimeout(ctx, permissionsPollingTimeout) + defer cancel() + + done := make(chan error, 1) + go func() { + for { + accepted, err := a.apiClient.GetCodespacesPermissionsCheck(ctx, createParams.RepositoryID, createParams.Branch, location, createParams.DevContainerPath) + if err != nil { + done <- err + return + } + + if accepted { + done <- nil + return + } + + // Wait before polling again + time.Sleep(permissionsPollingInterval) + } + }() + + select { + case err := <-done: + return err + case <-ctx.Done(): + return fmt.Errorf("timed out waiting for permissions to be accepted in the browser") + } + }) + if err != nil { + return nil, fmt.Errorf("error polling for permissions: %w", err) } // if the user chose to create the codespace without the permissions, @@ -386,7 +422,7 @@ func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api createParams.PermissionsOptOut = true var codespace *api.Codespace - err := a.RunWithProgress("Creating codespace", func() (err error) { + err = a.RunWithProgress("Creating codespace", func() (err error) { codespace, err = a.apiClient.CreateCodespace(ctx, createParams) return }) diff --git a/pkg/cmd/codespace/mock_api.go b/pkg/cmd/codespace/mock_api.go index aad15c025..3edae8b85 100644 --- a/pkg/cmd/codespace/mock_api.go +++ b/pkg/cmd/codespace/mock_api.go @@ -13,67 +13,70 @@ import ( // apiClientMock is a mock implementation of apiClient. // -// func TestSomethingThatUsesapiClient(t *testing.T) { +// func TestSomethingThatUsesapiClient(t *testing.T) { // -// // make and configure a mocked apiClient -// mockedapiClient := &apiClientMock{ -// CreateCodespaceFunc: func(ctx context.Context, params *codespacesAPI.CreateCodespaceParams) (*codespacesAPI.Codespace, error) { -// panic("mock out the CreateCodespace method") -// }, -// DeleteCodespaceFunc: func(ctx context.Context, name string, orgName string, userName string) error { -// panic("mock out the DeleteCodespace method") -// }, -// EditCodespaceFunc: func(ctx context.Context, codespaceName string, params *codespacesAPI.EditCodespaceParams) (*codespacesAPI.Codespace, error) { -// panic("mock out the EditCodespace method") -// }, -// GetCodespaceFunc: func(ctx context.Context, name string, includeConnection bool) (*codespacesAPI.Codespace, error) { -// panic("mock out the GetCodespace method") -// }, -// GetCodespaceBillableOwnerFunc: func(ctx context.Context, nwo string) (*codespacesAPI.User, error) { -// panic("mock out the GetCodespaceBillableOwner method") -// }, -// GetCodespaceRepoSuggestionsFunc: func(ctx context.Context, partialSearch string, params codespacesAPI.RepoSearchParameters) ([]string, error) { -// panic("mock out the GetCodespaceRepoSuggestions method") -// }, -// GetCodespaceRepositoryContentsFunc: func(ctx context.Context, codespace *codespacesAPI.Codespace, path string) ([]byte, error) { -// panic("mock out the GetCodespaceRepositoryContents method") -// }, -// GetCodespacesMachinesFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) { -// panic("mock out the GetCodespacesMachines method") -// }, -// HTTPClientFunc: func() (*http.Client, error) { -// panic("mock out the HTTPClient method") -// }, -// GetOrgMemberCodespaceFunc: func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { -// panic("mock out the GetOrgMemberCodespace method") -// }, -// GetRepositoryFunc: func(ctx context.Context, nwo string) (*codespacesAPI.Repository, error) { -// panic("mock out the GetRepository method") -// }, -// GetUserFunc: func(ctx context.Context) (*codespacesAPI.User, error) { -// panic("mock out the GetUser method") -// }, -// ListCodespacesFunc: func(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) { -// panic("mock out the ListCodespaces method") -// }, -// ListDevContainersFunc: func(ctx context.Context, repoID int, branch string, limit int) ([]codespacesAPI.DevContainerEntry, error) { -// panic("mock out the ListDevContainers method") -// }, -// ServerURLFunc: func() string { -// panic("mock out the ServerURL method") -// }, -// StartCodespaceFunc: func(ctx context.Context, name string) error { -// panic("mock out the StartCodespace method") -// }, -// StopCodespaceFunc: func(ctx context.Context, name string, orgName string, userName string) error { -// panic("mock out the StopCodespace method") -// }, -// } +// // make and configure a mocked apiClient +// mockedapiClient := &apiClientMock{ +// CreateCodespaceFunc: func(ctx context.Context, params *codespacesAPI.CreateCodespaceParams) (*codespacesAPI.Codespace, error) { +// panic("mock out the CreateCodespace method") +// }, +// DeleteCodespaceFunc: func(ctx context.Context, name string, orgName string, userName string) error { +// panic("mock out the DeleteCodespace method") +// }, +// EditCodespaceFunc: func(ctx context.Context, codespaceName string, params *codespacesAPI.EditCodespaceParams) (*codespacesAPI.Codespace, error) { +// panic("mock out the EditCodespace method") +// }, +// GetCodespaceFunc: func(ctx context.Context, name string, includeConnection bool) (*codespacesAPI.Codespace, error) { +// panic("mock out the GetCodespace method") +// }, +// GetCodespaceBillableOwnerFunc: func(ctx context.Context, nwo string) (*codespacesAPI.User, error) { +// panic("mock out the GetCodespaceBillableOwner method") +// }, +// GetCodespaceRepoSuggestionsFunc: func(ctx context.Context, partialSearch string, params codespacesAPI.RepoSearchParameters) ([]string, error) { +// panic("mock out the GetCodespaceRepoSuggestions method") +// }, +// GetCodespaceRepositoryContentsFunc: func(ctx context.Context, codespace *codespacesAPI.Codespace, path string) ([]byte, error) { +// panic("mock out the GetCodespaceRepositoryContents method") +// }, +// GetCodespacesMachinesFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) { +// panic("mock out the GetCodespacesMachines method") +// }, +// GetCodespacesPermissionsCheckFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) { +// panic("mock out the GetCodespacesPermissionsCheck method") +// }, +// GetOrgMemberCodespaceFunc: func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { +// panic("mock out the GetOrgMemberCodespace method") +// }, +// GetRepositoryFunc: func(ctx context.Context, nwo string) (*codespacesAPI.Repository, error) { +// panic("mock out the GetRepository method") +// }, +// GetUserFunc: func(ctx context.Context) (*codespacesAPI.User, error) { +// panic("mock out the GetUser method") +// }, +// HTTPClientFunc: func() (*http.Client, error) { +// panic("mock out the HTTPClient method") +// }, +// ListCodespacesFunc: func(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) { +// panic("mock out the ListCodespaces method") +// }, +// ListDevContainersFunc: func(ctx context.Context, repoID int, branch string, limit int) ([]codespacesAPI.DevContainerEntry, error) { +// panic("mock out the ListDevContainers method") +// }, +// ServerURLFunc: func() string { +// panic("mock out the ServerURL method") +// }, +// StartCodespaceFunc: func(ctx context.Context, name string) error { +// panic("mock out the StartCodespace method") +// }, +// StopCodespaceFunc: func(ctx context.Context, name string, orgName string, userName string) error { +// panic("mock out the StopCodespace method") +// }, +// } // -// // use mockedapiClient in code that requires apiClient -// // and then make assertions. +// // use mockedapiClient in code that requires apiClient +// // and then make assertions. // -// } +// } type apiClientMock struct { // CreateCodespaceFunc mocks the CreateCodespace method. CreateCodespaceFunc func(ctx context.Context, params *codespacesAPI.CreateCodespaceParams) (*codespacesAPI.Codespace, error) @@ -99,8 +102,8 @@ type apiClientMock struct { // GetCodespacesMachinesFunc mocks the GetCodespacesMachines method. GetCodespacesMachinesFunc func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) - // HTTPClientFunc mocks the HTTPClient method. - HTTPClientFunc func() (*http.Client, error) + // GetCodespacesPermissionsCheckFunc mocks the GetCodespacesPermissionsCheck method. + GetCodespacesPermissionsCheckFunc func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) // GetOrgMemberCodespaceFunc mocks the GetOrgMemberCodespace method. GetOrgMemberCodespaceFunc func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) @@ -111,6 +114,9 @@ type apiClientMock struct { // GetUserFunc mocks the GetUser method. GetUserFunc func(ctx context.Context) (*codespacesAPI.User, error) + // HTTPClientFunc mocks the HTTPClient method. + HTTPClientFunc func() (*http.Client, error) + // ListCodespacesFunc mocks the ListCodespaces method. ListCodespacesFunc func(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) @@ -202,8 +208,18 @@ type apiClientMock struct { // DevcontainerPath is the devcontainerPath argument value. DevcontainerPath string } - // HTTPClient holds details about calls to the HTTPClient method. - HTTPClient []struct { + // GetCodespacesPermissionsCheck holds details about calls to the GetCodespacesPermissionsCheck method. + GetCodespacesPermissionsCheck []struct { + // Ctx is the ctx argument value. + Ctx context.Context + // RepoID is the repoID argument value. + RepoID int + // Branch is the branch argument value. + Branch string + // Location is the location argument value. + Location string + // DevcontainerPath is the devcontainerPath argument value. + DevcontainerPath string } // GetOrgMemberCodespace holds details about calls to the GetOrgMemberCodespace method. GetOrgMemberCodespace []struct { @@ -228,6 +244,9 @@ type apiClientMock struct { // Ctx is the ctx argument value. Ctx context.Context } + // HTTPClient holds details about calls to the HTTPClient method. + HTTPClient []struct { + } // ListCodespaces holds details about calls to the ListCodespaces method. ListCodespaces []struct { // Ctx is the ctx argument value. @@ -276,10 +295,11 @@ type apiClientMock struct { lockGetCodespaceRepoSuggestions sync.RWMutex lockGetCodespaceRepositoryContents sync.RWMutex lockGetCodespacesMachines sync.RWMutex - lockHTTPClient sync.RWMutex + lockGetCodespacesPermissionsCheck sync.RWMutex lockGetOrgMemberCodespace sync.RWMutex lockGetRepository sync.RWMutex lockGetUser sync.RWMutex + lockHTTPClient sync.RWMutex lockListCodespaces sync.RWMutex lockListDevContainers sync.RWMutex lockServerURL sync.RWMutex @@ -307,8 +327,7 @@ func (mock *apiClientMock) CreateCodespace(ctx context.Context, params *codespac // CreateCodespaceCalls gets all the calls that were made to CreateCodespace. // Check the length with: -// -// len(mockedapiClient.CreateCodespaceCalls()) +// len(mockedapiClient.CreateCodespaceCalls()) func (mock *apiClientMock) CreateCodespaceCalls() []struct { Ctx context.Context Params *codespacesAPI.CreateCodespaceParams @@ -347,8 +366,7 @@ func (mock *apiClientMock) DeleteCodespace(ctx context.Context, name string, org // DeleteCodespaceCalls gets all the calls that were made to DeleteCodespace. // Check the length with: -// -// len(mockedapiClient.DeleteCodespaceCalls()) +// len(mockedapiClient.DeleteCodespaceCalls()) func (mock *apiClientMock) DeleteCodespaceCalls() []struct { Ctx context.Context Name string @@ -389,8 +407,7 @@ func (mock *apiClientMock) EditCodespace(ctx context.Context, codespaceName stri // EditCodespaceCalls gets all the calls that were made to EditCodespace. // Check the length with: -// -// len(mockedapiClient.EditCodespaceCalls()) +// len(mockedapiClient.EditCodespaceCalls()) func (mock *apiClientMock) EditCodespaceCalls() []struct { Ctx context.Context CodespaceName string @@ -429,8 +446,7 @@ func (mock *apiClientMock) GetCodespace(ctx context.Context, name string, includ // GetCodespaceCalls gets all the calls that were made to GetCodespace. // Check the length with: -// -// len(mockedapiClient.GetCodespaceCalls()) +// len(mockedapiClient.GetCodespaceCalls()) func (mock *apiClientMock) GetCodespaceCalls() []struct { Ctx context.Context Name string @@ -467,8 +483,7 @@ func (mock *apiClientMock) GetCodespaceBillableOwner(ctx context.Context, nwo st // GetCodespaceBillableOwnerCalls gets all the calls that were made to GetCodespaceBillableOwner. // Check the length with: -// -// len(mockedapiClient.GetCodespaceBillableOwnerCalls()) +// len(mockedapiClient.GetCodespaceBillableOwnerCalls()) func (mock *apiClientMock) GetCodespaceBillableOwnerCalls() []struct { Ctx context.Context Nwo string @@ -505,8 +520,7 @@ func (mock *apiClientMock) GetCodespaceRepoSuggestions(ctx context.Context, part // GetCodespaceRepoSuggestionsCalls gets all the calls that were made to GetCodespaceRepoSuggestions. // Check the length with: -// -// len(mockedapiClient.GetCodespaceRepoSuggestionsCalls()) +// len(mockedapiClient.GetCodespaceRepoSuggestionsCalls()) func (mock *apiClientMock) GetCodespaceRepoSuggestionsCalls() []struct { Ctx context.Context PartialSearch string @@ -545,8 +559,7 @@ func (mock *apiClientMock) GetCodespaceRepositoryContents(ctx context.Context, c // GetCodespaceRepositoryContentsCalls gets all the calls that were made to GetCodespaceRepositoryContents. // Check the length with: -// -// len(mockedapiClient.GetCodespaceRepositoryContentsCalls()) +// len(mockedapiClient.GetCodespaceRepositoryContentsCalls()) func (mock *apiClientMock) GetCodespaceRepositoryContentsCalls() []struct { Ctx context.Context Codespace *codespacesAPI.Codespace @@ -589,8 +602,7 @@ func (mock *apiClientMock) GetCodespacesMachines(ctx context.Context, repoID int // GetCodespacesMachinesCalls gets all the calls that were made to GetCodespacesMachines. // Check the length with: -// -// len(mockedapiClient.GetCodespacesMachinesCalls()) +// len(mockedapiClient.GetCodespacesMachinesCalls()) func (mock *apiClientMock) GetCodespacesMachinesCalls() []struct { Ctx context.Context RepoID int @@ -611,30 +623,50 @@ func (mock *apiClientMock) GetCodespacesMachinesCalls() []struct { return calls } -// HTTPClient calls HTTPClientFunc. -func (mock *apiClientMock) HTTPClient() (*http.Client, error) { - if mock.HTTPClientFunc == nil { - panic("apiClientMock.HTTPClientFunc: method is nil but apiClient.HTTPClient was just called") +// GetCodespacesPermissionsCheck calls GetCodespacesPermissionsCheckFunc. +func (mock *apiClientMock) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) { + if mock.GetCodespacesPermissionsCheckFunc == nil { + panic("apiClientMock.GetCodespacesPermissionsCheckFunc: method is nil but apiClient.GetCodespacesPermissionsCheck was just called") } callInfo := struct { - }{} - mock.lockHTTPClient.Lock() - mock.calls.HTTPClient = append(mock.calls.HTTPClient, callInfo) - mock.lockHTTPClient.Unlock() - return mock.HTTPClientFunc() + Ctx context.Context + RepoID int + Branch string + Location string + DevcontainerPath string + }{ + Ctx: ctx, + RepoID: repoID, + Branch: branch, + Location: location, + DevcontainerPath: devcontainerPath, + } + mock.lockGetCodespacesPermissionsCheck.Lock() + mock.calls.GetCodespacesPermissionsCheck = append(mock.calls.GetCodespacesPermissionsCheck, callInfo) + mock.lockGetCodespacesPermissionsCheck.Unlock() + return mock.GetCodespacesPermissionsCheckFunc(ctx, repoID, branch, location, devcontainerPath) } -// HTTPClientCalls gets all the calls that were made to HTTPClient. +// GetCodespacesPermissionsCheckCalls gets all the calls that were made to GetCodespacesPermissionsCheck. // Check the length with: -// -// len(mockedapiClient.HTTPClientCalls()) -func (mock *apiClientMock) HTTPClientCalls() []struct { +// len(mockedapiClient.GetCodespacesPermissionsCheckCalls()) +func (mock *apiClientMock) GetCodespacesPermissionsCheckCalls() []struct { + Ctx context.Context + RepoID int + Branch string + Location string + DevcontainerPath string } { var calls []struct { + Ctx context.Context + RepoID int + Branch string + Location string + DevcontainerPath string } - mock.lockHTTPClient.RLock() - calls = mock.calls.HTTPClient - mock.lockHTTPClient.RUnlock() + mock.lockGetCodespacesPermissionsCheck.RLock() + calls = mock.calls.GetCodespacesPermissionsCheck + mock.lockGetCodespacesPermissionsCheck.RUnlock() return calls } @@ -662,8 +694,7 @@ func (mock *apiClientMock) GetOrgMemberCodespace(ctx context.Context, orgName st // GetOrgMemberCodespaceCalls gets all the calls that were made to GetOrgMemberCodespace. // Check the length with: -// -// len(mockedapiClient.GetOrgMemberCodespaceCalls()) +// len(mockedapiClient.GetOrgMemberCodespaceCalls()) func (mock *apiClientMock) GetOrgMemberCodespaceCalls() []struct { Ctx context.Context OrgName string @@ -702,8 +733,7 @@ func (mock *apiClientMock) GetRepository(ctx context.Context, nwo string) (*code // GetRepositoryCalls gets all the calls that were made to GetRepository. // Check the length with: -// -// len(mockedapiClient.GetRepositoryCalls()) +// len(mockedapiClient.GetRepositoryCalls()) func (mock *apiClientMock) GetRepositoryCalls() []struct { Ctx context.Context Nwo string @@ -736,8 +766,7 @@ func (mock *apiClientMock) GetUser(ctx context.Context) (*codespacesAPI.User, er // GetUserCalls gets all the calls that were made to GetUser. // Check the length with: -// -// len(mockedapiClient.GetUserCalls()) +// len(mockedapiClient.GetUserCalls()) func (mock *apiClientMock) GetUserCalls() []struct { Ctx context.Context } { @@ -750,6 +779,32 @@ func (mock *apiClientMock) GetUserCalls() []struct { return calls } +// HTTPClient calls HTTPClientFunc. +func (mock *apiClientMock) HTTPClient() (*http.Client, error) { + if mock.HTTPClientFunc == nil { + panic("apiClientMock.HTTPClientFunc: method is nil but apiClient.HTTPClient was just called") + } + callInfo := struct { + }{} + mock.lockHTTPClient.Lock() + mock.calls.HTTPClient = append(mock.calls.HTTPClient, callInfo) + mock.lockHTTPClient.Unlock() + return mock.HTTPClientFunc() +} + +// HTTPClientCalls gets all the calls that were made to HTTPClient. +// Check the length with: +// len(mockedapiClient.HTTPClientCalls()) +func (mock *apiClientMock) HTTPClientCalls() []struct { +} { + var calls []struct { + } + mock.lockHTTPClient.RLock() + calls = mock.calls.HTTPClient + mock.lockHTTPClient.RUnlock() + return calls +} + // ListCodespaces calls ListCodespacesFunc. func (mock *apiClientMock) ListCodespaces(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) { if mock.ListCodespacesFunc == nil { @@ -770,8 +825,7 @@ func (mock *apiClientMock) ListCodespaces(ctx context.Context, opts codespacesAP // ListCodespacesCalls gets all the calls that were made to ListCodespaces. // Check the length with: -// -// len(mockedapiClient.ListCodespacesCalls()) +// len(mockedapiClient.ListCodespacesCalls()) func (mock *apiClientMock) ListCodespacesCalls() []struct { Ctx context.Context Opts codespacesAPI.ListCodespacesOptions @@ -810,8 +864,7 @@ func (mock *apiClientMock) ListDevContainers(ctx context.Context, repoID int, br // ListDevContainersCalls gets all the calls that were made to ListDevContainers. // Check the length with: -// -// len(mockedapiClient.ListDevContainersCalls()) +// len(mockedapiClient.ListDevContainersCalls()) func (mock *apiClientMock) ListDevContainersCalls() []struct { Ctx context.Context RepoID int @@ -845,8 +898,7 @@ func (mock *apiClientMock) ServerURL() string { // ServerURLCalls gets all the calls that were made to ServerURL. // Check the length with: -// -// len(mockedapiClient.ServerURLCalls()) +// len(mockedapiClient.ServerURLCalls()) func (mock *apiClientMock) ServerURLCalls() []struct { } { var calls []struct { @@ -877,8 +929,7 @@ func (mock *apiClientMock) StartCodespace(ctx context.Context, name string) erro // StartCodespaceCalls gets all the calls that were made to StartCodespace. // Check the length with: -// -// len(mockedapiClient.StartCodespaceCalls()) +// len(mockedapiClient.StartCodespaceCalls()) func (mock *apiClientMock) StartCodespaceCalls() []struct { Ctx context.Context Name string @@ -917,8 +968,7 @@ func (mock *apiClientMock) StopCodespace(ctx context.Context, name string, orgNa // StopCodespaceCalls gets all the calls that were made to StopCodespace. // Check the length with: -// -// len(mockedapiClient.StopCodespaceCalls()) +// len(mockedapiClient.StopCodespaceCalls()) func (mock *apiClientMock) StopCodespaceCalls() []struct { Ctx context.Context Name string From 7d558edd12d6b4101a0b3d3df3c689385a1c830a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 13 Oct 2023 17:15:54 +0200 Subject: [PATCH 057/527] build(deps): bump github.com/gabriel-vasile/mimetype from 1.4.2 to 1.4.3 (#8185) Bumps [github.com/gabriel-vasile/mimetype](https://github.com/gabriel-vasile/mimetype) from 1.4.2 to 1.4.3. - [Release notes](https://github.com/gabriel-vasile/mimetype/releases) - [Commits](https://github.com/gabriel-vasile/mimetype/compare/v1.4.2...v1.4.3) --- updated-dependencies: - dependency-name: github.com/gabriel-vasile/mimetype dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index cc56bda51..5d3433b1e 100644 --- a/go.mod +++ b/go.mod @@ -14,7 +14,7 @@ require ( github.com/cli/safeexec v1.0.1 github.com/cpuguy83/go-md2man/v2 v2.0.2 github.com/creack/pty v1.1.18 - github.com/gabriel-vasile/mimetype v1.4.2 + github.com/gabriel-vasile/mimetype v1.4.3 github.com/gdamore/tcell/v2 v2.5.4 github.com/google/go-cmp v0.5.9 github.com/google/shlex v0.0.0-20191202100458-e7afc7fbc510 diff --git a/go.sum b/go.sum index c1160707a..dfd6acc5d 100644 --- a/go.sum +++ b/go.sum @@ -49,8 +49,8 @@ github.com/dlclark/regexp2 v1.4.0 h1:F1rxgk7p4uKjwIQxBs9oAXe5CqrXlCduYEJvrF4u93E github.com/dlclark/regexp2 v1.4.0/go.mod h1:2pZnwuY/m+8K6iRw6wQdMtk+rH5tNGR1i55kozfMjCc= github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys= github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4= -github.com/gabriel-vasile/mimetype v1.4.2 h1:w5qFW6JKBz9Y393Y4q372O9A7cUSequkh1Q7OhCmWKU= -github.com/gabriel-vasile/mimetype v1.4.2/go.mod h1:zApsH/mKG4w07erKIaJPFiX0Tsq9BFQgN3qGY5GnNgA= +github.com/gabriel-vasile/mimetype v1.4.3 h1:in2uUcidCuFcDKtdcBxlR0rJ1+fsokWf+uqxgUFjbI0= +github.com/gabriel-vasile/mimetype v1.4.3/go.mod h1:d8uq/6HKRL6CGdk+aubisF/M5GcPfT7nKyLpA0lbSSk= github.com/gdamore/encoding v1.0.0 h1:+7OoQ1Bc6eTm5niUzBa0Ctsh6JbMW6Ra+YNuAtDBdko= github.com/gdamore/encoding v1.0.0/go.mod h1:alR0ol34c49FCSBLjhosxzcPHQbf2trDkoo5dl+VrEg= github.com/gdamore/tcell/v2 v2.5.4 h1:TGU4tSjD3sCL788vFNeJnTdzpNKIw1H5dgLnJRQVv/k= From 135c56aead3bf12fb0b457d21b70eb64c72897d6 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Mon, 16 Oct 2023 10:09:04 -0700 Subject: [PATCH 058/527] Fix linting error --- pkg/cmd/codespace/mock_api.go | 176 +++++++++++++++++++--------------- 1 file changed, 97 insertions(+), 79 deletions(-) diff --git a/pkg/cmd/codespace/mock_api.go b/pkg/cmd/codespace/mock_api.go index 3edae8b85..d6cf37eeb 100644 --- a/pkg/cmd/codespace/mock_api.go +++ b/pkg/cmd/codespace/mock_api.go @@ -13,70 +13,70 @@ import ( // apiClientMock is a mock implementation of apiClient. // -// func TestSomethingThatUsesapiClient(t *testing.T) { +// func TestSomethingThatUsesapiClient(t *testing.T) { // -// // make and configure a mocked apiClient -// mockedapiClient := &apiClientMock{ -// CreateCodespaceFunc: func(ctx context.Context, params *codespacesAPI.CreateCodespaceParams) (*codespacesAPI.Codespace, error) { -// panic("mock out the CreateCodespace method") -// }, -// DeleteCodespaceFunc: func(ctx context.Context, name string, orgName string, userName string) error { -// panic("mock out the DeleteCodespace method") -// }, -// EditCodespaceFunc: func(ctx context.Context, codespaceName string, params *codespacesAPI.EditCodespaceParams) (*codespacesAPI.Codespace, error) { -// panic("mock out the EditCodespace method") -// }, -// GetCodespaceFunc: func(ctx context.Context, name string, includeConnection bool) (*codespacesAPI.Codespace, error) { -// panic("mock out the GetCodespace method") -// }, -// GetCodespaceBillableOwnerFunc: func(ctx context.Context, nwo string) (*codespacesAPI.User, error) { -// panic("mock out the GetCodespaceBillableOwner method") -// }, -// GetCodespaceRepoSuggestionsFunc: func(ctx context.Context, partialSearch string, params codespacesAPI.RepoSearchParameters) ([]string, error) { -// panic("mock out the GetCodespaceRepoSuggestions method") -// }, -// GetCodespaceRepositoryContentsFunc: func(ctx context.Context, codespace *codespacesAPI.Codespace, path string) ([]byte, error) { -// panic("mock out the GetCodespaceRepositoryContents method") -// }, -// GetCodespacesMachinesFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) { -// panic("mock out the GetCodespacesMachines method") -// }, -// GetCodespacesPermissionsCheckFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) { -// panic("mock out the GetCodespacesPermissionsCheck method") -// }, -// GetOrgMemberCodespaceFunc: func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { -// panic("mock out the GetOrgMemberCodespace method") -// }, -// GetRepositoryFunc: func(ctx context.Context, nwo string) (*codespacesAPI.Repository, error) { -// panic("mock out the GetRepository method") -// }, -// GetUserFunc: func(ctx context.Context) (*codespacesAPI.User, error) { -// panic("mock out the GetUser method") -// }, -// HTTPClientFunc: func() (*http.Client, error) { -// panic("mock out the HTTPClient method") -// }, -// ListCodespacesFunc: func(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) { -// panic("mock out the ListCodespaces method") -// }, -// ListDevContainersFunc: func(ctx context.Context, repoID int, branch string, limit int) ([]codespacesAPI.DevContainerEntry, error) { -// panic("mock out the ListDevContainers method") -// }, -// ServerURLFunc: func() string { -// panic("mock out the ServerURL method") -// }, -// StartCodespaceFunc: func(ctx context.Context, name string) error { -// panic("mock out the StartCodespace method") -// }, -// StopCodespaceFunc: func(ctx context.Context, name string, orgName string, userName string) error { -// panic("mock out the StopCodespace method") -// }, -// } +// // make and configure a mocked apiClient +// mockedapiClient := &apiClientMock{ +// CreateCodespaceFunc: func(ctx context.Context, params *codespacesAPI.CreateCodespaceParams) (*codespacesAPI.Codespace, error) { +// panic("mock out the CreateCodespace method") +// }, +// DeleteCodespaceFunc: func(ctx context.Context, name string, orgName string, userName string) error { +// panic("mock out the DeleteCodespace method") +// }, +// EditCodespaceFunc: func(ctx context.Context, codespaceName string, params *codespacesAPI.EditCodespaceParams) (*codespacesAPI.Codespace, error) { +// panic("mock out the EditCodespace method") +// }, +// GetCodespaceFunc: func(ctx context.Context, name string, includeConnection bool) (*codespacesAPI.Codespace, error) { +// panic("mock out the GetCodespace method") +// }, +// GetCodespaceBillableOwnerFunc: func(ctx context.Context, nwo string) (*codespacesAPI.User, error) { +// panic("mock out the GetCodespaceBillableOwner method") +// }, +// GetCodespaceRepoSuggestionsFunc: func(ctx context.Context, partialSearch string, params codespacesAPI.RepoSearchParameters) ([]string, error) { +// panic("mock out the GetCodespaceRepoSuggestions method") +// }, +// GetCodespaceRepositoryContentsFunc: func(ctx context.Context, codespace *codespacesAPI.Codespace, path string) ([]byte, error) { +// panic("mock out the GetCodespaceRepositoryContents method") +// }, +// GetCodespacesMachinesFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) { +// panic("mock out the GetCodespacesMachines method") +// }, +// GetCodespacesPermissionsCheckFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) { +// panic("mock out the GetCodespacesPermissionsCheck method") +// }, +// GetOrgMemberCodespaceFunc: func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { +// panic("mock out the GetOrgMemberCodespace method") +// }, +// GetRepositoryFunc: func(ctx context.Context, nwo string) (*codespacesAPI.Repository, error) { +// panic("mock out the GetRepository method") +// }, +// GetUserFunc: func(ctx context.Context) (*codespacesAPI.User, error) { +// panic("mock out the GetUser method") +// }, +// HTTPClientFunc: func() (*http.Client, error) { +// panic("mock out the HTTPClient method") +// }, +// ListCodespacesFunc: func(ctx context.Context, opts codespacesAPI.ListCodespacesOptions) ([]*codespacesAPI.Codespace, error) { +// panic("mock out the ListCodespaces method") +// }, +// ListDevContainersFunc: func(ctx context.Context, repoID int, branch string, limit int) ([]codespacesAPI.DevContainerEntry, error) { +// panic("mock out the ListDevContainers method") +// }, +// ServerURLFunc: func() string { +// panic("mock out the ServerURL method") +// }, +// StartCodespaceFunc: func(ctx context.Context, name string) error { +// panic("mock out the StartCodespace method") +// }, +// StopCodespaceFunc: func(ctx context.Context, name string, orgName string, userName string) error { +// panic("mock out the StopCodespace method") +// }, +// } // -// // use mockedapiClient in code that requires apiClient -// // and then make assertions. +// // use mockedapiClient in code that requires apiClient +// // and then make assertions. // -// } +// } type apiClientMock struct { // CreateCodespaceFunc mocks the CreateCodespace method. CreateCodespaceFunc func(ctx context.Context, params *codespacesAPI.CreateCodespaceParams) (*codespacesAPI.Codespace, error) @@ -327,7 +327,8 @@ func (mock *apiClientMock) CreateCodespace(ctx context.Context, params *codespac // CreateCodespaceCalls gets all the calls that were made to CreateCodespace. // Check the length with: -// len(mockedapiClient.CreateCodespaceCalls()) +// +// len(mockedapiClient.CreateCodespaceCalls()) func (mock *apiClientMock) CreateCodespaceCalls() []struct { Ctx context.Context Params *codespacesAPI.CreateCodespaceParams @@ -366,7 +367,8 @@ func (mock *apiClientMock) DeleteCodespace(ctx context.Context, name string, org // DeleteCodespaceCalls gets all the calls that were made to DeleteCodespace. // Check the length with: -// len(mockedapiClient.DeleteCodespaceCalls()) +// +// len(mockedapiClient.DeleteCodespaceCalls()) func (mock *apiClientMock) DeleteCodespaceCalls() []struct { Ctx context.Context Name string @@ -407,7 +409,8 @@ func (mock *apiClientMock) EditCodespace(ctx context.Context, codespaceName stri // EditCodespaceCalls gets all the calls that were made to EditCodespace. // Check the length with: -// len(mockedapiClient.EditCodespaceCalls()) +// +// len(mockedapiClient.EditCodespaceCalls()) func (mock *apiClientMock) EditCodespaceCalls() []struct { Ctx context.Context CodespaceName string @@ -446,7 +449,8 @@ func (mock *apiClientMock) GetCodespace(ctx context.Context, name string, includ // GetCodespaceCalls gets all the calls that were made to GetCodespace. // Check the length with: -// len(mockedapiClient.GetCodespaceCalls()) +// +// len(mockedapiClient.GetCodespaceCalls()) func (mock *apiClientMock) GetCodespaceCalls() []struct { Ctx context.Context Name string @@ -483,7 +487,8 @@ func (mock *apiClientMock) GetCodespaceBillableOwner(ctx context.Context, nwo st // GetCodespaceBillableOwnerCalls gets all the calls that were made to GetCodespaceBillableOwner. // Check the length with: -// len(mockedapiClient.GetCodespaceBillableOwnerCalls()) +// +// len(mockedapiClient.GetCodespaceBillableOwnerCalls()) func (mock *apiClientMock) GetCodespaceBillableOwnerCalls() []struct { Ctx context.Context Nwo string @@ -520,7 +525,8 @@ func (mock *apiClientMock) GetCodespaceRepoSuggestions(ctx context.Context, part // GetCodespaceRepoSuggestionsCalls gets all the calls that were made to GetCodespaceRepoSuggestions. // Check the length with: -// len(mockedapiClient.GetCodespaceRepoSuggestionsCalls()) +// +// len(mockedapiClient.GetCodespaceRepoSuggestionsCalls()) func (mock *apiClientMock) GetCodespaceRepoSuggestionsCalls() []struct { Ctx context.Context PartialSearch string @@ -559,7 +565,8 @@ func (mock *apiClientMock) GetCodespaceRepositoryContents(ctx context.Context, c // GetCodespaceRepositoryContentsCalls gets all the calls that were made to GetCodespaceRepositoryContents. // Check the length with: -// len(mockedapiClient.GetCodespaceRepositoryContentsCalls()) +// +// len(mockedapiClient.GetCodespaceRepositoryContentsCalls()) func (mock *apiClientMock) GetCodespaceRepositoryContentsCalls() []struct { Ctx context.Context Codespace *codespacesAPI.Codespace @@ -602,7 +609,8 @@ func (mock *apiClientMock) GetCodespacesMachines(ctx context.Context, repoID int // GetCodespacesMachinesCalls gets all the calls that were made to GetCodespacesMachines. // Check the length with: -// len(mockedapiClient.GetCodespacesMachinesCalls()) +// +// len(mockedapiClient.GetCodespacesMachinesCalls()) func (mock *apiClientMock) GetCodespacesMachinesCalls() []struct { Ctx context.Context RepoID int @@ -649,7 +657,8 @@ func (mock *apiClientMock) GetCodespacesPermissionsCheck(ctx context.Context, re // GetCodespacesPermissionsCheckCalls gets all the calls that were made to GetCodespacesPermissionsCheck. // Check the length with: -// len(mockedapiClient.GetCodespacesPermissionsCheckCalls()) +// +// len(mockedapiClient.GetCodespacesPermissionsCheckCalls()) func (mock *apiClientMock) GetCodespacesPermissionsCheckCalls() []struct { Ctx context.Context RepoID int @@ -694,7 +703,8 @@ func (mock *apiClientMock) GetOrgMemberCodespace(ctx context.Context, orgName st // GetOrgMemberCodespaceCalls gets all the calls that were made to GetOrgMemberCodespace. // Check the length with: -// len(mockedapiClient.GetOrgMemberCodespaceCalls()) +// +// len(mockedapiClient.GetOrgMemberCodespaceCalls()) func (mock *apiClientMock) GetOrgMemberCodespaceCalls() []struct { Ctx context.Context OrgName string @@ -733,7 +743,8 @@ func (mock *apiClientMock) GetRepository(ctx context.Context, nwo string) (*code // GetRepositoryCalls gets all the calls that were made to GetRepository. // Check the length with: -// len(mockedapiClient.GetRepositoryCalls()) +// +// len(mockedapiClient.GetRepositoryCalls()) func (mock *apiClientMock) GetRepositoryCalls() []struct { Ctx context.Context Nwo string @@ -766,7 +777,8 @@ func (mock *apiClientMock) GetUser(ctx context.Context) (*codespacesAPI.User, er // GetUserCalls gets all the calls that were made to GetUser. // Check the length with: -// len(mockedapiClient.GetUserCalls()) +// +// len(mockedapiClient.GetUserCalls()) func (mock *apiClientMock) GetUserCalls() []struct { Ctx context.Context } { @@ -794,7 +806,8 @@ func (mock *apiClientMock) HTTPClient() (*http.Client, error) { // HTTPClientCalls gets all the calls that were made to HTTPClient. // Check the length with: -// len(mockedapiClient.HTTPClientCalls()) +// +// len(mockedapiClient.HTTPClientCalls()) func (mock *apiClientMock) HTTPClientCalls() []struct { } { var calls []struct { @@ -825,7 +838,8 @@ func (mock *apiClientMock) ListCodespaces(ctx context.Context, opts codespacesAP // ListCodespacesCalls gets all the calls that were made to ListCodespaces. // Check the length with: -// len(mockedapiClient.ListCodespacesCalls()) +// +// len(mockedapiClient.ListCodespacesCalls()) func (mock *apiClientMock) ListCodespacesCalls() []struct { Ctx context.Context Opts codespacesAPI.ListCodespacesOptions @@ -864,7 +878,8 @@ func (mock *apiClientMock) ListDevContainers(ctx context.Context, repoID int, br // ListDevContainersCalls gets all the calls that were made to ListDevContainers. // Check the length with: -// len(mockedapiClient.ListDevContainersCalls()) +// +// len(mockedapiClient.ListDevContainersCalls()) func (mock *apiClientMock) ListDevContainersCalls() []struct { Ctx context.Context RepoID int @@ -898,7 +913,8 @@ func (mock *apiClientMock) ServerURL() string { // ServerURLCalls gets all the calls that were made to ServerURL. // Check the length with: -// len(mockedapiClient.ServerURLCalls()) +// +// len(mockedapiClient.ServerURLCalls()) func (mock *apiClientMock) ServerURLCalls() []struct { } { var calls []struct { @@ -929,7 +945,8 @@ func (mock *apiClientMock) StartCodespace(ctx context.Context, name string) erro // StartCodespaceCalls gets all the calls that were made to StartCodespace. // Check the length with: -// len(mockedapiClient.StartCodespaceCalls()) +// +// len(mockedapiClient.StartCodespaceCalls()) func (mock *apiClientMock) StartCodespaceCalls() []struct { Ctx context.Context Name string @@ -968,7 +985,8 @@ func (mock *apiClientMock) StopCodespace(ctx context.Context, name string, orgNa // StopCodespaceCalls gets all the calls that were made to StopCodespace. // Check the length with: -// len(mockedapiClient.StopCodespaceCalls()) +// +// len(mockedapiClient.StopCodespaceCalls()) func (mock *apiClientMock) StopCodespaceCalls() []struct { Ctx context.Context Name string From 8a868779a64bcad0c6051d6e84bf1fc646bc7182 Mon Sep 17 00:00:00 2001 From: Matthew Ruggio Date: Fri, 13 Oct 2023 07:56:42 -0500 Subject: [PATCH 059/527] Add status column for each projectItem object. This should be comparable to classic project's notion of column, although not _exactly_ the same since new projects are much more configurable. --- api/export_pr.go | 3 ++- api/export_pr_test.go | 8 ++++++++ api/queries_issue.go | 4 ++++ api/query_builder.go | 2 +- 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/api/export_pr.go b/api/export_pr.go index c2ddb4277..218bf7c47 100644 --- a/api/export_pr.go +++ b/api/export_pr.go @@ -23,7 +23,8 @@ func (issue *Issue) ExportData(fields []string) map[string]interface{} { items := make([]map[string]interface{}, 0, len(issue.ProjectItems.Nodes)) for _, n := range issue.ProjectItems.Nodes { items = append(items, map[string]interface{}{ - "title": n.Project.Title, + "status": n.Status, + "title": n.Project.Title, }) } data[f] = items diff --git a/api/export_pr_test.go b/api/export_pr_test.go index e7d930078..94a672fbd 100644 --- a/api/export_pr_test.go +++ b/api/export_pr_test.go @@ -85,6 +85,10 @@ func TestIssue_ExportData(t *testing.T) { "project": { "id": "PVT_id", "title": "Some Project" + }, + "status": { + "name": "Todo", + "optionId": "abc123" } } ] } } @@ -93,6 +97,10 @@ func TestIssue_ExportData(t *testing.T) { { "projectItems": [ { + "status": { + "optionId": "abc123", + "name": "Todo" + }, "title": "Some Project" } ] diff --git a/api/queries_issue.go b/api/queries_issue.go index 58053f8df..b971845b9 100644 --- a/api/queries_issue.go +++ b/api/queries_issue.go @@ -106,6 +106,10 @@ type ProjectV2Item struct { ID string `json:"id"` Title string `json:"title"` } + Status struct { + OptionID string `json:"optionId"` + Name string `json:"name"` + } } func (p ProjectCards) ProjectNames() []string { diff --git a/api/query_builder.go b/api/query_builder.go index bd2d2ece5..9c8aaac17 100644 --- a/api/query_builder.go +++ b/api/query_builder.go @@ -318,7 +318,7 @@ func IssueGraphQL(fields []string) string { case "projectCards": q = append(q, `projectCards(first:100){nodes{project{name}column{name}},totalCount}`) case "projectItems": - q = append(q, `projectItems(first:100){nodes{id, project{id,title}},totalCount}`) + q = append(q, `projectItems(first:100){nodes{id, project{id,title}, status:fieldValueByName(name: "Status") { ... on ProjectV2ItemFieldSingleSelectValue{optionId,name}}},totalCount}`) case "milestone": q = append(q, `milestone{number,title,description,dueOn}`) case "reactionGroups": From 83418cba542cbb92de3b57b7eb2529e9abe70e70 Mon Sep 17 00:00:00 2001 From: Matthew Ruggio Date: Mon, 16 Oct 2023 20:47:18 -0500 Subject: [PATCH 060/527] export status optionId and name for pull request projectItems --- api/export_pr.go | 3 ++- api/export_pr_test.go | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 1 deletion(-) diff --git a/api/export_pr.go b/api/export_pr.go index 218bf7c47..bb3310811 100644 --- a/api/export_pr.go +++ b/api/export_pr.go @@ -109,7 +109,8 @@ func (pr *PullRequest) ExportData(fields []string) map[string]interface{} { items := make([]map[string]interface{}, 0, len(pr.ProjectItems.Nodes)) for _, n := range pr.ProjectItems.Nodes { items = append(items, map[string]interface{}{ - "title": n.Project.Title, + "status": n.Status, + "title": n.Project.Title, }) } data[f] = items diff --git a/api/export_pr_test.go b/api/export_pr_test.go index 94a672fbd..b7f4dcddb 100644 --- a/api/export_pr_test.go +++ b/api/export_pr_test.go @@ -213,6 +213,38 @@ func TestPullRequest_ExportData(t *testing.T) { } `), }, + { + name: "project items", + fields: []string{"projectItems"}, + inputJSON: heredoc.Doc(` + { "projectItems": { "nodes": [ + { + "id": "PVTPR_id", + "project": { + "id": "PVT_id", + "title": "Some Project" + }, + "status": { + "name": "Todo", + "optionId": "abc123" + } + } + ] } } + `), + outputJSON: heredoc.Doc(` + { + "projectItems": [ + { + "status": { + "optionId": "abc123", + "name": "Todo" + }, + "title": "Some Project" + } + ] + } + `), + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { From 9b037ffac1850eae4c413174411726db0542a4fd Mon Sep 17 00:00:00 2001 From: Arun Sathiya Date: Tue, 17 Oct 2023 00:01:32 -0700 Subject: [PATCH 061/527] update(repo create): Support for `--homepage` flag for template-based repository creation flow (#8188) --- pkg/cmd/repo/create/create.go | 4 +- pkg/cmd/repo/create/http.go | 4 +- pkg/cmd/repo/create/http_test.go | 136 ++++++++++++++++++++++++++++++- 3 files changed, 139 insertions(+), 5 deletions(-) diff --git a/pkg/cmd/repo/create/create.go b/pkg/cmd/repo/create/create.go index 4a94c05a2..c050607ed 100644 --- a/pkg/cmd/repo/create/create.go +++ b/pkg/cmd/repo/create/create.go @@ -164,8 +164,8 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co if cmd.Flags().Changed("enable-wiki") { opts.DisableWiki = !enableWiki } - if opts.Template != "" && (opts.Homepage != "" || opts.Team != "") { - return cmdutil.FlagErrorf("the `--template` option is not supported with `--homepage`, or `--team`") + if opts.Template != "" && opts.Team != "" { + return cmdutil.FlagErrorf("the `--template` option is not supported with `--team`") } if opts.Template == "" && opts.IncludeAllBranches { diff --git a/pkg/cmd/repo/create/http.go b/pkg/cmd/repo/create/http.go index 86024a254..ffe9dbb6f 100644 --- a/pkg/cmd/repo/create/http.go +++ b/pkg/cmd/repo/create/http.go @@ -69,6 +69,7 @@ type updateRepositoryInput struct { RepositoryID string `json:"repositoryId"` HasWikiEnabled bool `json:"hasWikiEnabled"` HasIssuesEnabled bool `json:"hasIssuesEnabled"` + HomepageURL string `json:"homepageUrl,omitempty"` } // repoCreate creates a new GitHub repository @@ -140,12 +141,13 @@ func repoCreate(client *http.Client, hostname string, input repoCreateInput) (*a return nil, err } - if !input.HasWikiEnabled || !input.HasIssuesEnabled { + if !input.HasWikiEnabled || !input.HasIssuesEnabled || input.HomepageURL != "" { updateVariables := map[string]interface{}{ "input": updateRepositoryInput{ RepositoryID: response.CloneTemplateRepository.Repository.ID, HasWikiEnabled: input.HasWikiEnabled, HasIssuesEnabled: input.HasIssuesEnabled, + HomepageURL: input.HomepageURL, }, } diff --git a/pkg/cmd/repo/create/http_test.go b/pkg/cmd/repo/create/http_test.go index 86831899d..cfe14563a 100644 --- a/pkg/cmd/repo/create/http_test.go +++ b/pkg/cmd/repo/create/http_test.go @@ -288,8 +288,8 @@ func Test_repoCreate(t *testing.T) { func(inputs map[string]interface{}) { assert.Equal(t, map[string]interface{}{ "repositoryId": "REPOID", - "hasWikiEnabled": false, "hasIssuesEnabled": true, + "hasWikiEnabled": false, }, inputs) }), ) @@ -353,8 +353,140 @@ func Test_repoCreate(t *testing.T) { func(inputs map[string]interface{}) { assert.Equal(t, map[string]interface{}{ "repositoryId": "REPOID", - "hasWikiEnabled": true, "hasIssuesEnabled": false, + "hasWikiEnabled": true, + }, inputs) + }), + ) + }, + wantRepo: "https://github.com/OWNER/REPO", + }, + { + name: "create personal repo from template repo, and disable both wiki and issues", + hostname: "github.com", + input: repoCreateInput{ + Name: "gen-project", + Description: "my generated project", + Visibility: "private", + TemplateRepositoryID: "TPLID", + HasIssuesEnabled: false, + HasWikiEnabled: false, + IncludeAllBranches: false, + }, + stubs: func(t *testing.T, r *httpmock.Registry) { + r.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data": {"viewer": {"id":"USERID"} } }`)) + r.Register( + httpmock.GraphQL(`mutation CloneTemplateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "cloneTemplateRepository": { + "repository": { + "id": "REPOID", + "name": "REPO", + "owner": {"login":"OWNER"}, + "url": "the://URL" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "name": "gen-project", + "description": "my generated project", + "visibility": "PRIVATE", + "ownerId": "USERID", + "repositoryId": "TPLID", + "includeAllBranches": false, + }, inputs) + }), + ) + r.Register( + httpmock.GraphQL(`mutation UpdateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "updateRepository": { + "repository": { + "id": "REPOID" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "repositoryId": "REPOID", + "hasIssuesEnabled": false, + "hasWikiEnabled": false, + }, inputs) + }), + ) + }, + wantRepo: "https://github.com/OWNER/REPO", + }, + { + name: "create personal repo from template repo, and set homepage url", + hostname: "github.com", + input: repoCreateInput{ + Name: "gen-project", + Description: "my generated project", + Visibility: "private", + TemplateRepositoryID: "TPLID", + HasIssuesEnabled: true, + HasWikiEnabled: true, + IncludeAllBranches: false, + HomepageURL: "https://example.com", + }, + stubs: func(t *testing.T, r *httpmock.Registry) { + r.Register( + httpmock.GraphQL(`query UserCurrent\b`), + httpmock.StringResponse(`{"data": {"viewer": {"id":"USERID"} } }`)) + r.Register( + httpmock.GraphQL(`mutation CloneTemplateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "cloneTemplateRepository": { + "repository": { + "id": "REPOID", + "name": "REPO", + "owner": {"login":"OWNER"}, + "url": "the://URL" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "name": "gen-project", + "description": "my generated project", + "visibility": "PRIVATE", + "ownerId": "USERID", + "repositoryId": "TPLID", + "includeAllBranches": false, + }, inputs) + }), + ) + r.Register( + httpmock.GraphQL(`mutation UpdateRepository\b`), + httpmock.GraphQLMutation( + `{ + "data": { + "updateRepository": { + "repository": { + "id": "REPOID" + } + } + } + }`, + func(inputs map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "repositoryId": "REPOID", + "hasIssuesEnabled": true, + "hasWikiEnabled": true, + "homepageUrl": "https://example.com", }, inputs) }), ) From 5916439d22568e3c7242a3a2f3530bd1f97b4643 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Tue, 17 Oct 2023 09:54:12 +0200 Subject: [PATCH 062/527] Remove template field from projects exporting (#8160) --- pkg/cmd/project/shared/format/json.go | 35 ++++++++++++++-------- pkg/cmd/project/shared/format/json_test.go | 8 ++--- pkg/cmd/project/shared/queries/queries.go | 20 +++++++++---- 3 files changed, 40 insertions(+), 23 deletions(-) diff --git a/pkg/cmd/project/shared/format/json.go b/pkg/cmd/project/shared/format/json.go index 7bfebdeda..efe9f4800 100644 --- a/pkg/cmd/project/shared/format/json.go +++ b/pkg/cmd/project/shared/format/json.go @@ -15,10 +15,13 @@ func JSONProject(project queries.Project) ([]byte, error) { ShortDescription: project.ShortDescription, Public: project.Public, Closed: project.Closed, - Template: project.Template, - Title: project.Title, - ID: project.ID, - Readme: project.Readme, + // The Template field is commented out due to https://github.com/cli/cli/issues/8103. + // The Template field does not exist on GHES 3.8 and older, once GHES 3.8 gets + // deprecated on 2024-03-07 we can start populating this field again. + // Template: project.Template, + Title: project.Title, + ID: project.ID, + Readme: project.Readme, Items: struct { TotalCount int `json:"totalCount"` }{ @@ -50,10 +53,13 @@ func JSONProjects(projects []queries.Project, totalCount int) ([]byte, error) { ShortDescription: p.ShortDescription, Public: p.Public, Closed: p.Closed, - Template: p.Template, - Title: p.Title, - ID: p.ID, - Readme: p.Readme, + // The Template field is commented out due to https://github.com/cli/cli/issues/8103. + // The Template field does not exist on GHES 3.8 and older, once GHES 3.8 gets + // deprecated on 2024-03-07 we can start populating this field again. + // Template: p.Template, + Title: p.Title, + ID: p.ID, + Readme: p.Readme, Items: struct { TotalCount int `json:"totalCount"` }{ @@ -89,11 +95,14 @@ type projectJSON struct { ShortDescription string `json:"shortDescription"` Public bool `json:"public"` Closed bool `json:"closed"` - Template bool `json:"template"` - Title string `json:"title"` - ID string `json:"id"` - Readme string `json:"readme"` - Items struct { + // The Template field is commented out due to https://github.com/cli/cli/issues/8103. + // The Template field does not exist on GHES 3.8 and older, once GHES 3.8 gets + // deprecated on 2024-03-07 we can start populating this field again. + // Template bool `json:"template"` + 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 { diff --git a/pkg/cmd/project/shared/format/json_test.go b/pkg/cmd/project/shared/format/json_test.go index 9e75167c5..c05a3e5ff 100644 --- a/pkg/cmd/project/shared/format/json_test.go +++ b/pkg/cmd/project/shared/format/json_test.go @@ -25,7 +25,7 @@ func TestJSONProject_User(t *testing.T) { b, err := JSONProject(project) assert.NoError(t, err) - assert.Equal(t, `{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"template":false,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"User","login":"monalisa"}}`, string(b)) + 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) { @@ -36,7 +36,6 @@ func TestJSONProject_Org(t *testing.T) { ShortDescription: "short description", Public: true, Readme: "readme", - Template: true, } project.Items.TotalCount = 1 @@ -46,7 +45,7 @@ func TestJSONProject_Org(t *testing.T) { b, err := JSONProject(project) assert.NoError(t, err) - assert.Equal(t, `{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"template":true,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"Organization","login":"github"}}`, string(b)) + 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) { @@ -71,7 +70,6 @@ func TestJSONProjects(t *testing.T) { ShortDescription: "short description", Public: true, Readme: "readme", - Template: true, } orgProject.Items.TotalCount = 1 @@ -83,7 +81,7 @@ func TestJSONProjects(t *testing.T) { assert.Equal( t, - `{"projects":[{"number":2,"url":"a url","shortDescription":"short description","public":true,"closed":false,"template":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,"template":true,"title":"","id":"123","readme":"readme","items":{"totalCount":1},"fields":{"totalCount":2},"owner":{"type":"Organization","login":"github"}}],"totalCount":2}`, + `{"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)) } diff --git a/pkg/cmd/project/shared/queries/queries.go b/pkg/cmd/project/shared/queries/queries.go index ff68d4583..0bf96ba63 100644 --- a/pkg/cmd/project/shared/queries/queries.go +++ b/pkg/cmd/project/shared/queries/queries.go @@ -109,11 +109,21 @@ type Project struct { ShortDescription string Public bool Closed bool - Template bool - Title string - ID string - Readme string - Items struct { + // The Template field is commented out due to https://github.com/cli/cli/issues/8103. + // We released gh v2.34.0 without realizing the Template field does not exist + // on GHES 3.8 and older. This broke all project commands for users targeting GHES 3.8 + // and older. In order to fix this we will no longer query the Template field until + // GHES 3.8 gets deprecated on 2024-03-07. This solution was simplier and quicker + // than adding a feature detection measure to every place this query is used. + // It does have the negative consequence that we have had to remove the + // Template field when outputing projects to JSON using the --format flag supported + // by a number of project commands. See `pkg/cmd/project/shared/format/json.go` for + // implementation. + // Template bool + Title string + ID string + Readme string + Items struct { PageInfo PageInfo TotalCount int Nodes []ProjectItem From fd8bbf0be5b590c61cf4fe1a67153b58a29a7579 Mon Sep 17 00:00:00 2001 From: EBIBO Date: Tue, 17 Oct 2023 16:21:35 +0800 Subject: [PATCH 063/527] `gh pr create` duplicates targets if there are duplicate remotes (#8184) * `gh pr create` duplicates targets if there are duplicate remotes * De-duplicate the same remote --- context/context.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/context/context.go b/context/context.go index 7030a557f..06ef8ca7d 100644 --- a/context/context.go +++ b/context/context.go @@ -4,6 +4,7 @@ package context import ( "errors" "fmt" + "slices" "sort" "github.com/cli/cli/v2/api" @@ -116,9 +117,11 @@ func (r *ResolvedRemotes) HeadRepos() ([]*api.Repository, error) { } var results []*api.Repository + var ids []string // Check if repo duplicates for _, repo := range r.network.Repositories { - if repo != nil && repo.ViewerCanPush() { + if repo != nil && repo.ViewerCanPush() && !slices.Contains(ids, repo.ID) { results = append(results, repo) + ids = append(ids, repo.ID) } } return results, nil From 8e8e6d9ac6638ac62283e916a6d83a63a8846792 Mon Sep 17 00:00:00 2001 From: EBIBO Date: Tue, 17 Oct 2023 17:01:51 +0800 Subject: [PATCH 064/527] `gh browse` subdirectory path problem with `repo` flag (#8141) --- pkg/cmd/browse/browse.go | 21 ++++++++++++--------- pkg/cmd/browse/browse_test.go | 14 ++++++++++++++ 2 files changed, 26 insertions(+), 9 deletions(-) diff --git a/pkg/cmd/browse/browse.go b/pkg/cmd/browse/browse.go index b89434555..11f75a753 100644 --- a/pkg/cmd/browse/browse.go +++ b/pkg/cmd/browse/browse.go @@ -5,6 +5,7 @@ import ( "fmt" "net/http" "net/url" + "os" "path" "path/filepath" "regexp" @@ -36,13 +37,14 @@ type BrowseOptions struct { SelectorArg string - Branch string - Commit string - ProjectsFlag bool - ReleasesFlag bool - SettingsFlag bool - WikiFlag bool - NoBrowserFlag bool + Branch string + Commit string + ProjectsFlag bool + ReleasesFlag bool + SettingsFlag bool + WikiFlag bool + NoBrowserFlag bool + HasRepoOverride bool } func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Command { @@ -129,8 +131,9 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co return cmdutil.FlagErrorf("%q is an invalid argument when using `--branch` or `--commit`", opts.SelectorArg) } - if cmd.Flags().Changed("repo") { + if cmd.Flags().Changed("repo") || os.Getenv("GH_REPO") != "" { opts.GitClient = &remoteGitClient{opts.BaseRepo, opts.HttpClient} + opts.HasRepoOverride = true } if runF != nil { @@ -275,7 +278,7 @@ func parseFile(opts BrowseOptions, f string) (p string, start int, end int, err } p = filepath.ToSlash(parts[0]) - if !path.IsAbs(p) { + if !path.IsAbs(p) && !opts.HasRepoOverride { p = path.Join(opts.PathFromRepoRoot(), p) if p == "." || strings.HasPrefix(p, "..") { p = "" diff --git a/pkg/cmd/browse/browse_test.go b/pkg/cmd/browse/browse_test.go index 67b920fdb..cceba045a 100644 --- a/pkg/cmd/browse/browse_test.go +++ b/pkg/cmd/browse/browse_test.go @@ -511,6 +511,20 @@ func Test_runBrowse(t *testing.T) { expectedURL: "https://github.com/bchadwic/gh-graph/tree/trunk/pkg/cmd/pr", wantsErr: false, }, + { + name: "does not use relative path when has repo override", + opts: BrowseOptions{ + SelectorArg: "README.md", + HasRepoOverride: true, + PathFromRepoRoot: func() string { + return "pkg/cmd/browse/" + }, + }, + baseRepo: ghrepo.New("bchadwic", "gh-graph"), + defaultBranch: "trunk", + expectedURL: "https://github.com/bchadwic/gh-graph/tree/trunk/README.md", + wantsErr: false, + }, { name: "use special characters in selector arg", opts: BrowseOptions{ From 46a7042b88c2787124dffce19fdf4d71840d6856 Mon Sep 17 00:00:00 2001 From: Mikel Olasagasti Uranga Date: Wed, 18 Oct 2023 09:17:20 +0200 Subject: [PATCH 065/527] Bump cpuguy83/go-md2man from 2.0.1 to 2.0.3 (#8209) Version 2.0.3 introduces a fix in PR https://github.com/cpuguy83/go-md2man/pull/105 that breaks a test for gen-doc, thus requires a small change in the test. --- cmd/gen-docs/main_test.go | 2 +- go.mod | 2 +- go.sum | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/cmd/gen-docs/main_test.go b/cmd/gen-docs/main_test.go index 312f7bc99..98f9f2fd5 100644 --- a/cmd/gen-docs/main_test.go +++ b/cmd/gen-docs/main_test.go @@ -18,7 +18,7 @@ func Test_run(t *testing.T) { if err != nil { t.Fatalf("error reading `gh-issue-create.1`: %v", err) } - if !strings.Contains(string(manPage), `\fB\fCgh issue create`) { + if !strings.Contains(string(manPage), `\fBgh issue create`) { t.Fatal("man page corrupted") } diff --git a/go.mod b/go.mod index 5d3433b1e..0b243e413 100644 --- a/go.mod +++ b/go.mod @@ -12,7 +12,7 @@ require ( github.com/cli/go-gh/v2 v2.3.0 github.com/cli/oauth v1.0.1 github.com/cli/safeexec v1.0.1 - github.com/cpuguy83/go-md2man/v2 v2.0.2 + github.com/cpuguy83/go-md2man/v2 v2.0.3 github.com/creack/pty v1.1.18 github.com/gabriel-vasile/mimetype v1.4.3 github.com/gdamore/tcell/v2 v2.5.4 diff --git a/go.sum b/go.sum index dfd6acc5d..e0989c87d 100644 --- a/go.sum +++ b/go.sum @@ -36,6 +36,8 @@ github.com/cli/shurcooL-graphql v0.0.3 h1:CtpPxyGDs136/+ZeyAfUKYmcQBjDlq5aqnrDCW github.com/cli/shurcooL-graphql v0.0.3/go.mod h1:tlrLmw/n5Q/+4qSvosT+9/W5zc8ZMjnJeYBxSdb4nWA= github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w= github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= +github.com/cpuguy83/go-md2man/v2 v2.0.3 h1:qMCsGGgs+MAzDFyp9LpAe1Lqy/fY/qCovCm0qnXZOBM= +github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= github.com/creack/pty v1.1.17/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= github.com/creack/pty v1.1.18 h1:n56/Zwd5o6whRC5PMGretI4IdRLlmBXYNjScPaBgsbY= From 59e84dd0692912946e5bd90649ebecf0050852c1 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Wed, 18 Oct 2023 11:19:03 +0200 Subject: [PATCH 066/527] Remove crypto fork (#8204) --- go.mod | 2 -- go.sum | 6 ++++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/go.mod b/go.mod index 0b243e413..7123e69cc 100644 --- a/go.mod +++ b/go.mod @@ -87,5 +87,3 @@ require ( google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f // indirect gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect ) - -replace golang.org/x/crypto => github.com/cli/crypto v0.0.0-20210929142629-6be313f59b03 diff --git a/go.sum b/go.sum index e0989c87d..45f962146 100644 --- a/go.sum +++ b/go.sum @@ -23,8 +23,6 @@ github.com/charmbracelet/lipgloss v0.5.0/go.mod h1:EZLha/HbzEt7cYqdFPovlqy5FZPj0 github.com/cli/browser v1.0.0/go.mod h1:IEWkHYbLjkhtjwwWlwTHW2lGxeS5gezEQBMLTwDHf5Q= 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.3.0 h1:FAQAP4PaWSAJf4VSxFEIYDQ1oBIs+bKB4GXQAiRr2sQ= github.com/cli/go-gh/v2 v2.3.0/go.mod h1:6WBUuf7LUVAc+eXYYX/nYTYURRc6M03K9cJNwBKvwT0= github.com/cli/oauth v1.0.1 h1:pXnTFl/qUegXHK531Dv0LNjW4mLx626eS42gnzfXJPA= @@ -176,6 +174,10 @@ github.com/yuin/goldmark-emoji v1.0.1 h1:ctuWEyzGBwiucEqxzwe0SOYDXPAucOrE9NQC18W github.com/yuin/goldmark-emoji v1.0.1/go.mod h1:2w1E6FEWLcDQkoTE+7HU6QF1F6SLlNGjRIBbIZQFqkQ= 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= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc= +golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4= golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2K1YbXdKPJLVgG5VJdoTa1poYQBtP1AY= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= From 1b58241501a147ce4782fd91299b429ca165b199 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 18 Oct 2023 15:26:14 +0200 Subject: [PATCH 067/527] build(deps): bump github.com/mattn/go-isatty from 0.0.19 to 0.0.20 (#8205) Bumps [github.com/mattn/go-isatty](https://github.com/mattn/go-isatty) from 0.0.19 to 0.0.20. - [Commits](https://github.com/mattn/go-isatty/compare/v0.0.19...v0.0.20) --- updated-dependencies: - dependency-name: github.com/mattn/go-isatty dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index 7123e69cc..252405f72 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.19 + github.com/mattn/go-isatty v0.0.20 github.com/mgutz/ansi v0.0.0-20200706080929-d51e80ef957d github.com/microsoft/dev-tunnels v0.0.25 github.com/muhammadmuzzammil1998/jsonc v0.0.0-20201229145248-615b0916ca38 diff --git a/go.sum b/go.sum index 45f962146..95392510f 100644 --- a/go.sum +++ b/go.sum @@ -103,8 +103,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.19 h1:JITubQf0MOLdlGRuRq+jtsDlekdYPia9ZFsB8h/APPA= -github.com/mattn/go-isatty v0.0.19/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y= +github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY= +github.com/mattn/go-isatty v0.0.20/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 b94f45895021614f14b24ae90bca6397015ee998 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 18 Oct 2023 15:51:46 +0200 Subject: [PATCH 068/527] Add initial tests for config Get --- internal/config/config_test.go | 95 ++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) create mode 100644 internal/config/config_test.go diff --git a/internal/config/config_test.go b/internal/config/config_test.go new file mode 100644 index 000000000..86ad79e99 --- /dev/null +++ b/internal/config/config_test.go @@ -0,0 +1,95 @@ +package config_test + +import ( + "testing" + + "github.com/cli/cli/v2/internal/config" + "github.com/stretchr/testify/require" + + ghConfig "github.com/cli/go-gh/v2/pkg/config" +) + +func TestGetNonExistentKey(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given we have no top level configuration + cfg, err := config.NewConfig() + require.NoError(t, err) + + // When we get a key that has no value + val, err := cfg.Get("", "non-existent-key") + + // Then it returns an error and the value is empty + var keyNotFoundError *ghConfig.KeyNotFoundError + require.ErrorAs(t, err, &keyNotFoundError) + require.Empty(t, val) +} + +func TestGetNonExistentHostSpecificKey(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given have no top level configuration + cfg, err := config.NewConfig() + require.NoError(t, err) + + // When we get a key for a host that has no value + val, err := cfg.Get("non-existent-host", "non-existent-key") + + // Then it returns an error and the value is empty + var keyNotFoundError *ghConfig.KeyNotFoundError + require.ErrorAs(t, err, &keyNotFoundError) + require.Empty(t, val) +} + +func TestGetExistingTopLevelKey(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given have a top level config entry + cfg, err := config.NewConfig() + require.NoError(t, err) + cfg.Set("", "top-level-key", "top-level-value") + + // When we get that key + val, err := cfg.Get("non-existent-host", "top-level-key") + + // Then it returns successfully with the correct value + require.NoError(t, err) + require.Equal(t, "top-level-value", val) +} + +func TestGetExistingHostSpecificKey(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given have a host specific config entry + cfg, err := config.NewConfig() + require.NoError(t, err) + cfg.Set("github.com", "host-specific-key", "host-specific-value") + + // When we get that key + val, err := cfg.Get("github.com", "host-specific-key") + + // Then it returns successfully with the correct value + require.NoError(t, err) + require.Equal(t, "host-specific-value", val) +} + +func TestGetHostnameSpecificKeyFallsBackToTopLevel(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given have a top level config entry + cfg, err := config.NewConfig() + require.NoError(t, err) + cfg.Set("", "key", "value") + + // When we get that key on a specific host + val, err := cfg.Get("github.com", "key") + + // Then it returns successfully, falling back to the top level config + require.NoError(t, err) + require.Equal(t, "value", val) +} From 5f645eadedd96110316e5cd4fc499aadf93148a9 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 18 Oct 2023 16:10:53 +0200 Subject: [PATCH 069/527] Add tests for config GetOrDefault --- internal/config/config.go | 24 ++++----- internal/config/config_test.go | 94 ++++++++++++++++++++++++---------- 2 files changed, 79 insertions(+), 39 deletions(-) diff --git a/internal/config/config.go b/internal/config/config.go index 290c32577..335f70264 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -53,22 +53,13 @@ func (c *cfg) Get(hostname, key string) (string, error) { } func (c *cfg) GetOrDefault(hostname, key string) (string, error) { - var val string - var err error - if hostname != "" { - val, err = c.cfg.Get([]string{hosts, hostname, key}) - if err == nil { - return val, err - } - } - - val, err = c.cfg.Get([]string{key}) + val, err := c.Get(hostname, key) if err == nil { return val, err } - if defaultExists(key) { - return defaultFor(key), nil + if val, ok := def(key); ok { + return val, nil } return val, err @@ -94,6 +85,15 @@ func (c *cfg) Authentication() *AuthConfig { return &AuthConfig{cfg: c.cfg} } +func def(key string) (string, bool) { + for _, co := range configOptions { + if co.Key == key { + return co.DefaultValue, true + } + } + return "", false +} + func defaultFor(key string) string { for _, co := range configOptions { if co.Key == key { diff --git a/internal/config/config_test.go b/internal/config/config_test.go index 86ad79e99..df948a279 100644 --- a/internal/config/config_test.go +++ b/internal/config/config_test.go @@ -1,21 +1,22 @@ -package config_test +package config import ( "testing" - "github.com/cli/cli/v2/internal/config" "github.com/stretchr/testify/require" ghConfig "github.com/cli/go-gh/v2/pkg/config" ) -func TestGetNonExistentKey(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) +func newTestConfig() *cfg { + return &cfg{ + cfg: ghConfig.ReadFromString(""), + } +} +func TestGetNonExistentKey(t *testing.T) { // Given we have no top level configuration - cfg, err := config.NewConfig() - require.NoError(t, err) + cfg := newTestConfig() // When we get a key that has no value val, err := cfg.Get("", "non-existent-key") @@ -27,12 +28,8 @@ func TestGetNonExistentKey(t *testing.T) { } func TestGetNonExistentHostSpecificKey(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given have no top level configuration - cfg, err := config.NewConfig() - require.NoError(t, err) + cfg := newTestConfig() // When we get a key for a host that has no value val, err := cfg.Get("non-existent-host", "non-existent-key") @@ -44,12 +41,8 @@ func TestGetNonExistentHostSpecificKey(t *testing.T) { } func TestGetExistingTopLevelKey(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given have a top level config entry - cfg, err := config.NewConfig() - require.NoError(t, err) + cfg := newTestConfig() cfg.Set("", "top-level-key", "top-level-value") // When we get that key @@ -61,12 +54,8 @@ func TestGetExistingTopLevelKey(t *testing.T) { } func TestGetExistingHostSpecificKey(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given have a host specific config entry - cfg, err := config.NewConfig() - require.NoError(t, err) + cfg := newTestConfig() cfg.Set("github.com", "host-specific-key", "host-specific-value") // When we get that key @@ -78,12 +67,8 @@ func TestGetExistingHostSpecificKey(t *testing.T) { } func TestGetHostnameSpecificKeyFallsBackToTopLevel(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given have a top level config entry - cfg, err := config.NewConfig() - require.NoError(t, err) + cfg := newTestConfig() cfg.Set("", "key", "value") // When we get that key on a specific host @@ -93,3 +78,58 @@ func TestGetHostnameSpecificKeyFallsBackToTopLevel(t *testing.T) { require.NoError(t, err) require.Equal(t, "value", val) } + +func TestGetOrDefaultApplicationDefaults(t *testing.T) { + tests := []struct { + key string + expectedDefault string + }{ + {"git_protocol", "https"}, + {"editor", ""}, + {"prompt", "enabled"}, + {"pager", ""}, + {"http_unix_socket", ""}, + {"browser", ""}, + } + + for _, tt := range tests { + t.Run(tt.key, func(t *testing.T) { + // Given we have no top level configuration + cfg := newTestConfig() + + // When we get a key that has no value, but has a default + val, err := cfg.GetOrDefault("", tt.key) + + // Then it returns the default value + require.NoError(t, err) + require.Equal(t, tt.expectedDefault, val) + }) + } +} + +func TestGetOrDefaultExistingKey(t *testing.T) { + // Given have a top level config entry + cfg := newTestConfig() + cfg.Set("", "git_protocol", "ssh") + + // When we get that key + val, err := cfg.GetOrDefault("", "git_protocol") + + // Then it returns successfully with the correct value, and doesn't fall back + // to the default + require.NoError(t, err) + require.Equal(t, "ssh", val) +} + +func TestGetOrDefaultNotFoundAndNoDefault(t *testing.T) { + // Given have no configuration + cfg := newTestConfig() + + // When we get a non-existent-key that has no default + val, err := cfg.GetOrDefault("", "non-existent-key") + + // Then it returns an error and the value is empty + var keyNotFoundError *ghConfig.KeyNotFoundError + require.ErrorAs(t, err, &keyNotFoundError) + require.Empty(t, val) +} From 34b0b33f241de6e1ad3d8e92bf84ffe780e436b5 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 18 Oct 2023 16:31:13 +0200 Subject: [PATCH 070/527] Add initial AuthConfig tests --- internal/config/auth_config_test.go | 91 +++++++++++++++++++++++++++++ internal/config/config.go | 1 + 2 files changed, 92 insertions(+) create mode 100644 internal/config/auth_config_test.go diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go new file mode 100644 index 000000000..92a3cc89d --- /dev/null +++ b/internal/config/auth_config_test.go @@ -0,0 +1,91 @@ +package config + +import ( + "testing" + + ghConfig "github.com/cli/go-gh/v2/pkg/config" + "github.com/stretchr/testify/require" + "github.com/zalando/go-keyring" +) + +func newTestAuthConfig() *AuthConfig { + return &AuthConfig{ + cfg: ghConfig.ReadFromString(""), + } +} + +func TestTokenFromKeyring(t *testing.T) { + // Given a keyring that contains a token for a host + keyring.MockInit() + keyring.Set(keyringServiceName("github.com"), "", "test-token") + + // When we get the token from the auth config + authCfg := newTestAuthConfig() + token, err := authCfg.TokenFromKeyring("github.com") + + // Then it returns successfully with the correct token + require.NoError(t, err) + require.Equal(t, "test-token", token) +} + +func TestTokenFromKeyringNonExistent(t *testing.T) { + // Given a keyring that doesn't contain any tokens + keyring.MockInit() + + // When we try to get a token from the auth config + authCfg := newTestAuthConfig() + _, err := authCfg.TokenFromKeyring("github.com") + + // Then it returns failure bubbling the ErrNotFound + require.ErrorIs(t, err, keyring.ErrNotFound) +} + +func TestNoUserInAuthConfig(t *testing.T) { + // Given a host configuration without a user + authCfg := newTestAuthConfig() + + // When we get the user + _, err := authCfg.User("github.com") + + // Then it returns failure, bubbling the KeyNotFoundError + var keyNotFoundError *ghConfig.KeyNotFoundError + require.ErrorAs(t, err, &keyNotFoundError) +} + +func TestUserInAuthConfig(t *testing.T) { + // Given an a host configuration with a user + authCfg := newTestAuthConfig() + authCfg.cfg.Set([]string{hosts, "github.com", "user"}, "test-user") + + // When we get the user + user, err := authCfg.User("github.com") + + // Then it returns success with the correct user + require.NoError(t, err) + require.Equal(t, "test-user", user) +} + +func TestNoGitProtocolInAuthConfig(t *testing.T) { + // Given a host configuration without a git protocol + authCfg := newTestAuthConfig() + + // When we get the git protocol + gitProtocol, err := authCfg.GitProtocol("github.com") + + // Then it returns success, using the default + require.NoError(t, err) + require.Equal(t, "https", gitProtocol) +} + +func TestGitProtocolInAuthConfig(t *testing.T) { + // Given an a host configuration with a git protocol + authCfg := newTestAuthConfig() + authCfg.cfg.Set([]string{hosts, "github.com", "git_protocol"}, "ssh") + + // When we get the git protocol + gitProtocol, err := authCfg.GitProtocol("github.com") + + // Then it returns success with the correct git protocol + require.NoError(t, err) + require.Equal(t, "ssh", gitProtocol) +} diff --git a/internal/config/config.go b/internal/config/config.go index 335f70264..1dafa7bbb 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -178,6 +178,7 @@ func (c *AuthConfig) User(hostname string) (string, error) { // GitProtocol will retrieve the git protocol for the logged in user at the given hostname. // If none is set it will return the default value. +// TODO: although this returns an error, it actually has no path to error. func (c *AuthConfig) GitProtocol(hostname string) (string, error) { key := "git_protocol" val, err := c.cfg.Get([]string{hosts, hostname, key}) From 614e49296bc160d92e223daa2c68ddd4bb842cc2 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 18 Oct 2023 16:57:54 +0200 Subject: [PATCH 071/527] Add tests for AuthConfig Login and Logout --- internal/config/auth_config_test.go | 149 +++++++++++++++++++++++++++- internal/config/config.go | 4 + 2 files changed, 152 insertions(+), 1 deletion(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 92a3cc89d..4fde4fd4f 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -1,6 +1,7 @@ package config import ( + "errors" "testing" ghConfig "github.com/cli/go-gh/v2/pkg/config" @@ -17,7 +18,7 @@ func newTestAuthConfig() *AuthConfig { func TestTokenFromKeyring(t *testing.T) { // Given a keyring that contains a token for a host keyring.MockInit() - keyring.Set(keyringServiceName("github.com"), "", "test-token") + require.NoError(t, keyring.Set(keyringServiceName("github.com"), "", "test-token")) // When we get the token from the auth config authCfg := newTestAuthConfig() @@ -89,3 +90,149 @@ func TestGitProtocolInAuthConfig(t *testing.T) { require.NoError(t, err) require.Equal(t, "ssh", gitProtocol) } + +func TestLoginSecureStorageUsesKeyring(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given a usable keyring + keyring.MockInit() + authCfg := newTestAuthConfig() + + // When we login with secure storage + insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", true) + + // Then it returns success, notes that insecure storage was not used, and stores the token in the keyring + require.NoError(t, err) + require.False(t, insecureStorageUsed, "expected to use secure storage") + + token, err := keyring.Get(keyringServiceName("github.com"), "") + require.NoError(t, err) + require.Equal(t, "test-token", token) +} + +func TestLoginSecureStorageRemovesOldInsecureConfigToken(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given a usable keyring and an oauth token in the config + keyring.MockInit() + authCfg := newTestAuthConfig() + authCfg.cfg.Set([]string{hosts, "github.com", oauthToken}, "old-token") + + // When we login with secure storage + _, err := authCfg.Login("github.com", "test-user", "test-token", "", true) + + // Then it returns success, having also removed the old token from the config + require.NoError(t, err) + requireNoKey(t, authCfg.cfg, []string{hosts, "github.com", oauthToken}) +} + +func TestLoginSecureStorageWithErrorFallsbackAndReports(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given a keyring that errors + keyring.MockInitWithError(errors.New("test-explosion")) + authCfg := newTestAuthConfig() + + // When we login with secure storage + insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", true) + + // Then it returns success, reports that insecure storage was used, and stores the token in the config + require.NoError(t, err) + + require.True(t, insecureStorageUsed, "expected to use insecure storage") + requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", oauthToken}, "test-token") +} + +func TestLoginInsecureStorage(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + authCfg := newTestAuthConfig() + + // When we login with insecure storage + insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", false) + + // Then it returns success, notes that insecure storage was used, and stores the token in the config + require.NoError(t, err) + + require.True(t, insecureStorageUsed, "expected to use insecure storage") + requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", oauthToken}, "test-token") +} + +func TestLoginSetsUserAndGitProtocolInConfig(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given a usable keyring + keyring.MockInit() + authCfg := newTestAuthConfig() + + // When we login with secure storage + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) + + // Then it returns success, and stores the user and git protocol in the config + require.NoError(t, err) + + requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", "user"}, "test-user") + requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", "git_protocol"}, "ssh") +} + +func TestLogoutRemovesHostAndKeyringToken(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given we are logged into a host + keyring.MockInit() + authCfg := newTestAuthConfig() + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) + require.NoError(t, err) + + // When we logout + err = authCfg.Logout("github.com") + + // Then we return success, and the host and token are removed from the config and keyring + require.NoError(t, err) + + requireNoKey(t, authCfg.cfg, []string{hosts, "github.com"}) + _, err = keyring.Get(keyringServiceName("github.com"), "") + require.ErrorIs(t, err, keyring.ErrNotFound) +} + +// Note that I'm not sure this test enforces particularly desirable behaviour +// since it leads users to believe a token has been removed when really +// that might have failed for some reason. +func TestLogoutIgnoresErrorsFromConfigAndKeyring(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given we have keyring that errors, and a config that + // doesn't even have a hosts key (which would cause Remove to fail) + keyring.MockInitWithError(errors.New("test-explosion")) + authCfg := newTestAuthConfig() + + // When we logout + err := authCfg.Logout("github.com") + + // Then it returns success anyway, suppressing the errors + require.NoError(t, err) +} + +func requireKeyWithValue(t *testing.T, cfg *ghConfig.Config, keys []string, value string) { + t.Helper() + + actual, err := cfg.Get(keys) + require.NoError(t, err) + + require.Equal(t, value, actual) +} + +func requireNoKey(t *testing.T, cfg *ghConfig.Config, keys []string) { + t.Helper() + + _, err := cfg.Get(keys) + var keyNotFoundError *ghConfig.KeyNotFoundError + require.ErrorAs(t, err, &keyNotFoundError) +} diff --git a/internal/config/config.go b/internal/config/config.go index 1dafa7bbb..a413baa64 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -234,6 +234,8 @@ func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secure c.cfg.Set([]string{hosts, hostname, oauthToken}, token) insecureStorageUsed = true } + // TODO: I can't find anywhere that calls this function without a username, so that would seem like + // something we might want to error on? if username != "" { c.cfg.Set([]string{hosts, hostname, "user"}, username) } @@ -246,6 +248,8 @@ func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secure // Logout will remove user, git protocol, and auth token for the given hostname. // It will remove the auth token from the encrypted storage if it exists there. func (c *AuthConfig) Logout(hostname string) error { + // TODO: I can't find anywhere that expects to call this function without a hostname + // and that would seem like a programmer error? if hostname == "" { return nil } From 52ba99ebabd0f77257698326d0896591fae4809e Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 18 Oct 2023 16:59:39 +0200 Subject: [PATCH 072/527] Update AuthConfig to use default fn --- internal/config/config.go | 29 ++++++++--------------------- 1 file changed, 8 insertions(+), 21 deletions(-) diff --git a/internal/config/config.go b/internal/config/config.go index a413baa64..a9a421bd4 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -58,7 +58,7 @@ func (c *cfg) GetOrDefault(hostname, key string) (string, error) { return val, err } - if val, ok := def(key); ok { + if val, ok := defaultFor(key); ok { return val, nil } @@ -85,7 +85,7 @@ func (c *cfg) Authentication() *AuthConfig { return &AuthConfig{cfg: c.cfg} } -func def(key string) (string, bool) { +func defaultFor(key string) (string, bool) { for _, co := range configOptions { if co.Key == key { return co.DefaultValue, true @@ -94,24 +94,6 @@ func def(key string) (string, bool) { return "", false } -func defaultFor(key string) string { - for _, co := range configOptions { - if co.Key == key { - return co.DefaultValue - } - } - return "" -} - -func defaultExists(key string) bool { - for _, co := range configOptions { - if co.Key == key { - return true - } - } - return false -} - // AuthConfig is used for interacting with some persistent configuration for gh, // with knowledge on how to access encrypted storage when neccesarry. // Behavior is scoped to authentication specific tasks. @@ -185,7 +167,12 @@ func (c *AuthConfig) GitProtocol(hostname string) (string, error) { if err == nil { return val, err } - return defaultFor(key), nil + + if val, ok := defaultFor(key); ok { + return val, nil + } + + return "", nil } func (c *AuthConfig) Hosts() []string { From 07110eca3322e838ca7ae5343f95a7614fcdb648 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 18 Oct 2023 17:37:35 +0200 Subject: [PATCH 073/527] Add tests for AuthConfig Token --- internal/config/auth_config_test.go | 64 +++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 4fde4fd4f..7459f89c2 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -29,6 +29,70 @@ func TestTokenFromKeyring(t *testing.T) { require.Equal(t, "test-token", token) } +func TestTokenStoredInConfig(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // When the user has logged in insecurely + authCfg := newTestAuthConfig() + ghConfig.Read = func() (*ghConfig.Config, error) { + return authCfg.cfg, nil + } + _, err := authCfg.Login("github.com", "test-user", "test-token", "", false) + require.NoError(t, err) + + // When we get the token + token, source := authCfg.Token("github.com") + + // Then the token is successfully fetched + // and the source is set to oauth_token but this isn't great + // but I can't find the issue # that references this. + require.Equal(t, "test-token", token) + require.Equal(t, "oauth_token", source) +} + +func TestTokenStoredInEnv(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // When the user is authenticated via env var + authCfg := newTestAuthConfig() + ghConfig.Read = func() (*ghConfig.Config, error) { + return authCfg.cfg, nil + } + t.Setenv("GH_TOKEN", "test-token") + + // When we get the token + token, source := authCfg.Token("github.com") + + // Then the token is successfully fetched + // and the source is set to the name of the env var + require.Equal(t, "test-token", token) + require.Equal(t, "GH_TOKEN", source) +} + +func TestTokenStoredInKeyring(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // When the user has logged in securely + keyring.MockInit() + authCfg := newTestAuthConfig() + ghConfig.Read = func() (*ghConfig.Config, error) { + return authCfg.cfg, nil + } + _, err := authCfg.Login("github.com", "test-user", "test-token", "", true) + require.NoError(t, err) + + // When we get the token + token, source := authCfg.Token("github.com") + + // Then the token is successfully fetched + // and the source is set to keyring + require.Equal(t, "test-token", token) + require.Equal(t, "keyring", source) +} + func TestTokenFromKeyringNonExistent(t *testing.T) { // Given a keyring that doesn't contain any tokens keyring.MockInit() From 465474ec5b551ac99cf13db6642a609b364ed111 Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 18 Oct 2023 17:38:46 +0200 Subject: [PATCH 074/527] Mod tidy go-md2man --- go.sum | 1 - 1 file changed, 1 deletion(-) diff --git a/go.sum b/go.sum index 45f962146..8746b26a3 100644 --- a/go.sum +++ b/go.sum @@ -32,7 +32,6 @@ github.com/cli/safeexec v1.0.1 h1:e/C79PbXF4yYTN/wauC4tviMxEV13BwljGj0N9j+N00= github.com/cli/safeexec v1.0.1/go.mod h1:Z/D4tTN8Vs5gXYHDCbaM1S/anmEDnJb1iW0+EJ5zx3Q= github.com/cli/shurcooL-graphql v0.0.3 h1:CtpPxyGDs136/+ZeyAfUKYmcQBjDlq5aqnrDCW5Ghh8= github.com/cli/shurcooL-graphql v0.0.3/go.mod h1:tlrLmw/n5Q/+4qSvosT+9/W5zc8ZMjnJeYBxSdb4nWA= -github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w= github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/cpuguy83/go-md2man/v2 v2.0.3 h1:qMCsGGgs+MAzDFyp9LpAe1Lqy/fY/qCovCm0qnXZOBM= github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= From e011633cdc5889c579b8835657dde2615e90291b Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 18 Oct 2023 18:10:00 +0200 Subject: [PATCH 075/527] Add tests for AuthConfig HasEnvToken --- internal/config/auth_config_test.go | 48 +++++++++++++++++++++++++++++ internal/config/config.go | 8 +++++ 2 files changed, 56 insertions(+) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 7459f89c2..621bc9c8b 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -105,6 +105,54 @@ func TestTokenFromKeyringNonExistent(t *testing.T) { require.ErrorIs(t, err, keyring.ErrNotFound) } +func TestHasEnvTokenWithoutAnyEnvToken(t *testing.T) { + // Given an empty hosts configuration + authCfg := newTestAuthConfig() + ghConfig.Read = func() (*ghConfig.Config, error) { + return authCfg.cfg, nil + } + + // When we check if it has an env token + hasEnvToken := authCfg.HasEnvToken() + + // Then it returns false + require.False(t, hasEnvToken, "expected not to have env token") +} + +func TestHasEnvTokenWithEnvToken(t *testing.T) { + // Given an empty hosts configuration but a token set in the env var + authCfg := newTestAuthConfig() + ghConfig.Read = func() (*ghConfig.Config, error) { + return authCfg.cfg, nil + } + t.Setenv("GH_ENTERPRISE_TOKEN", "test-token") + + // When we check if it has an env token + hasEnvToken := authCfg.HasEnvToken() + + // Then it returns true + require.True(t, hasEnvToken, "expected to have env token") +} + +func TestHasEnvTokenWithNoEnvTokenButAConfigVar(t *testing.T) { + t.Skip("this test is explicitly breaking some implementation assumptions") + + // Given a token in the config + authCfg := newTestAuthConfig() + ghConfig.Read = func() (*ghConfig.Config, error) { + return authCfg.cfg, nil + } + // Using example.com here will cause the token to be returned from the config + _, err := authCfg.Login("example.com", "test-user", "test-token", "", false) + require.NoError(t, err) + + // When we check if it has an env token + hasEnvToken := authCfg.HasEnvToken() + + // Then it SHOULD return false + require.False(t, hasEnvToken, "expected not to have env token") +} + func TestNoUserInAuthConfig(t *testing.T) { // Given a host configuration without a user authCfg := newTestAuthConfig() diff --git a/internal/config/config.go b/internal/config/config.go index a9a421bd4..d93c37e3c 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -135,6 +135,14 @@ func (c *AuthConfig) HasEnvToken() bool { return true } } + // TODO: This is _extremely_ knowledgable about the implementation of TokenFromEnvOrConfig + // It has to use a hostname that is not going to be found in the hosts so that it + // can guarantee that tokens will only be returned from a set env var. + // Discussed here, but maybe worth revisiting: https://github.com/cli/cli/pull/7169#discussion_r1136979033 + // + // By providing example.com. it's also _only_ looking for GH_ENTERPRISE_TOKEN or GITHUB_ENTERPRISE_TOKEN + // or the GITHUB_TOKEN if we happen to be in a codespace?? This doesn't seem to reflect the actual + // name of the function at all. token, _ := ghAuth.TokenFromEnvOrConfig(hostname) return token != "" } From 33808316721c2a2e0045e56047737029ea245702 Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:05:14 +0200 Subject: [PATCH 076/527] Rewrite AuthConfig User and GitProtocol tests --- internal/config/auth_config_test.go | 49 ++++++++++++++++------------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 621bc9c8b..461ebc723 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -153,8 +153,8 @@ func TestHasEnvTokenWithNoEnvTokenButAConfigVar(t *testing.T) { require.False(t, hasEnvToken, "expected not to have env token") } -func TestNoUserInAuthConfig(t *testing.T) { - // Given a host configuration without a user +func TestUserNotLoggedIn(t *testing.T) { + // Given we have not logged in authCfg := newTestAuthConfig() // When we get the user @@ -165,19 +165,6 @@ func TestNoUserInAuthConfig(t *testing.T) { require.ErrorAs(t, err, &keyNotFoundError) } -func TestUserInAuthConfig(t *testing.T) { - // Given an a host configuration with a user - authCfg := newTestAuthConfig() - authCfg.cfg.Set([]string{hosts, "github.com", "user"}, "test-user") - - // When we get the user - user, err := authCfg.User("github.com") - - // Then it returns success with the correct user - require.NoError(t, err) - require.Equal(t, "test-user", user) -} - func TestNoGitProtocolInAuthConfig(t *testing.T) { // Given a host configuration without a git protocol authCfg := newTestAuthConfig() @@ -274,22 +261,42 @@ func TestLoginInsecureStorage(t *testing.T) { requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", oauthToken}, "test-token") } -func TestLoginSetsUserAndGitProtocolInConfig(t *testing.T) { +func TestLoginSetsUserForProvidedHost(t *testing.T) { tempDir := t.TempDir() t.Setenv("GH_CONFIG_DIR", tempDir) - // Given a usable keyring + // Given a usable keyring and an empty config keyring.MockInit() authCfg := newTestAuthConfig() - // When we login with secure storage + // When we login _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) - // Then it returns success, and stores the user and git protocol in the config + // Then it returns success and the user is set require.NoError(t, err) - requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", "user"}, "test-user") - requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", "git_protocol"}, "ssh") + user, err := authCfg.User("github.com") + require.NoError(t, err) + require.Equal(t, "test-user", user) +} + +func TestLoginSetsGitProtocolForProdivdedHost(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given a usable keyring and an empty config + keyring.MockInit() + authCfg := newTestAuthConfig() + + // When we login + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) + + // Then it returns success and the git protocol is set + require.NoError(t, err) + + gitProtocol, err := authCfg.GitProtocol("github.com") + require.NoError(t, err) + require.Equal(t, "ssh", gitProtocol) } func TestLogoutRemovesHostAndKeyringToken(t *testing.T) { From cb7672e573735dee89df241844a0c4519f0e9837 Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:05:40 +0200 Subject: [PATCH 077/527] Add additional comment on Logout ignoring errors --- internal/config/auth_config_test.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 461ebc723..a1f9b0833 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -323,6 +323,10 @@ func TestLogoutRemovesHostAndKeyringToken(t *testing.T) { // Note that I'm not sure this test enforces particularly desirable behaviour // since it leads users to believe a token has been removed when really // that might have failed for some reason. +// +// The original intention here is that if the logout fails, the user can't +// really do anything to recover. On the other hand, a user might +// want to rectify this manually, for example if there were on a shared machine. func TestLogoutIgnoresErrorsFromConfigAndKeyring(t *testing.T) { tempDir := t.TempDir() t.Setenv("GH_CONFIG_DIR", tempDir) From e0bc2ff0caab8dbaf2fd2a5176e788fdfc0b8268 Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:08:03 +0200 Subject: [PATCH 078/527] Add test that host is added on Login --- internal/config/auth_config_test.go | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index a1f9b0833..772452b3b 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -299,6 +299,27 @@ func TestLoginSetsGitProtocolForProdivdedHost(t *testing.T) { require.Equal(t, "ssh", gitProtocol) } +func TestLoginAddsHostIfNotAlreadyAdded(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given a usable keyring and an empty config + keyring.MockInit() + authCfg := newTestAuthConfig() + ghConfig.Read = func() (*ghConfig.Config, error) { + return authCfg.cfg, nil + } + + // When we login + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) + + // Then it returns success and a host is added + require.NoError(t, err) + + hosts := authCfg.Hosts() + require.Contains(t, hosts, "github.com") +} + func TestLogoutRemovesHostAndKeyringToken(t *testing.T) { tempDir := t.TempDir() t.Setenv("GH_CONFIG_DIR", tempDir) From 07f5ca48d897563da5d6f4d19023b20b4222cb7a Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:24:05 +0200 Subject: [PATCH 079/527] Share config.Read setup in AuthConfig tests --- internal/config/auth_config_test.go | 35 ++++++++++------------------- 1 file changed, 12 insertions(+), 23 deletions(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 772452b3b..0ae8f29a2 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -10,9 +10,19 @@ import ( ) func newTestAuthConfig() *AuthConfig { - return &AuthConfig{ + authCfg := AuthConfig{ cfg: ghConfig.ReadFromString(""), } + // The real implementation of config.Read uses a sync.Once + // to read config files and initialise package level variables + // that are used from then on. + // + // This means that tests can't be isolated from each other, so + // we swap out the function here to return a new config each time. + ghConfig.Read = func() (*ghConfig.Config, error) { + return authCfg.cfg, nil + } + return &authCfg } func TestTokenFromKeyring(t *testing.T) { @@ -35,9 +45,6 @@ func TestTokenStoredInConfig(t *testing.T) { // When the user has logged in insecurely authCfg := newTestAuthConfig() - ghConfig.Read = func() (*ghConfig.Config, error) { - return authCfg.cfg, nil - } _, err := authCfg.Login("github.com", "test-user", "test-token", "", false) require.NoError(t, err) @@ -57,9 +64,6 @@ func TestTokenStoredInEnv(t *testing.T) { // When the user is authenticated via env var authCfg := newTestAuthConfig() - ghConfig.Read = func() (*ghConfig.Config, error) { - return authCfg.cfg, nil - } t.Setenv("GH_TOKEN", "test-token") // When we get the token @@ -78,9 +82,6 @@ func TestTokenStoredInKeyring(t *testing.T) { // When the user has logged in securely keyring.MockInit() authCfg := newTestAuthConfig() - ghConfig.Read = func() (*ghConfig.Config, error) { - return authCfg.cfg, nil - } _, err := authCfg.Login("github.com", "test-user", "test-token", "", true) require.NoError(t, err) @@ -108,9 +109,6 @@ func TestTokenFromKeyringNonExistent(t *testing.T) { func TestHasEnvTokenWithoutAnyEnvToken(t *testing.T) { // Given an empty hosts configuration authCfg := newTestAuthConfig() - ghConfig.Read = func() (*ghConfig.Config, error) { - return authCfg.cfg, nil - } // When we check if it has an env token hasEnvToken := authCfg.HasEnvToken() @@ -122,9 +120,6 @@ func TestHasEnvTokenWithoutAnyEnvToken(t *testing.T) { func TestHasEnvTokenWithEnvToken(t *testing.T) { // Given an empty hosts configuration but a token set in the env var authCfg := newTestAuthConfig() - ghConfig.Read = func() (*ghConfig.Config, error) { - return authCfg.cfg, nil - } t.Setenv("GH_ENTERPRISE_TOKEN", "test-token") // When we check if it has an env token @@ -139,9 +134,6 @@ func TestHasEnvTokenWithNoEnvTokenButAConfigVar(t *testing.T) { // Given a token in the config authCfg := newTestAuthConfig() - ghConfig.Read = func() (*ghConfig.Config, error) { - return authCfg.cfg, nil - } // Using example.com here will cause the token to be returned from the config _, err := authCfg.Login("example.com", "test-user", "test-token", "", false) require.NoError(t, err) @@ -165,7 +157,7 @@ func TestUserNotLoggedIn(t *testing.T) { require.ErrorAs(t, err, &keyNotFoundError) } -func TestNoGitProtocolInAuthConfig(t *testing.T) { +func TestGitProtocolNotLoggedInDefaults(t *testing.T) { // Given a host configuration without a git protocol authCfg := newTestAuthConfig() @@ -306,9 +298,6 @@ func TestLoginAddsHostIfNotAlreadyAdded(t *testing.T) { // Given a usable keyring and an empty config keyring.MockInit() authCfg := newTestAuthConfig() - ghConfig.Read = func() (*ghConfig.Config, error) { - return authCfg.cfg, nil - } // When we login _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) From fa80802c81eee9b7f3b213989edd25108394ec47 Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:24:25 +0200 Subject: [PATCH 080/527] Add tests for AuthConfig DefaultHost --- internal/config/auth_config_test.go | 43 ++++++++++++++++++++++++----- 1 file changed, 36 insertions(+), 7 deletions(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 0ae8f29a2..335489525 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -169,17 +169,46 @@ func TestGitProtocolNotLoggedInDefaults(t *testing.T) { require.Equal(t, "https", gitProtocol) } -func TestGitProtocolInAuthConfig(t *testing.T) { - // Given an a host configuration with a git protocol +func TestDefaultHostFromEnvVar(t *testing.T) { + // Given the GH_HOST env var is set authCfg := newTestAuthConfig() - authCfg.cfg.Set([]string{hosts, "github.com", "git_protocol"}, "ssh") + t.Setenv("GH_HOST", "ghe.io") - // When we get the git protocol - gitProtocol, err := authCfg.GitProtocol("github.com") + // When we get the DefaultHost + defaultHost, source := authCfg.DefaultHost() - // Then it returns success with the correct git protocol + // Then the returned host and source are using the env var + require.Equal(t, "ghe.io", defaultHost) + require.Equal(t, "GH_HOST", source) +} + +func TestDefaultHostNotLoggedIn(t *testing.T) { + // Given we are not logged in + authCfg := newTestAuthConfig() + + // When we get the DefaultHost + defaultHost, source := authCfg.DefaultHost() + + // Then the returned host is always github.com + require.Equal(t, "github.com", defaultHost) + require.Equal(t, "default", source) +} + +func TestDefaultHostLoggedInToOnlyOneHost(t *testing.T) { + tempDir := t.TempDir() + t.Setenv("GH_CONFIG_DIR", tempDir) + + // Given we are logged into one host (not github.com to differentiate from the fallback) + authCfg := newTestAuthConfig() + _, err := authCfg.Login("ghe.io", "test-user", "test-token", "", false) require.NoError(t, err) - require.Equal(t, "ssh", gitProtocol) + + // When we get the DefaultHost + defaultHost, source := authCfg.DefaultHost() + + // Then the returned host is that logged in host and the source is the hosts config + require.Equal(t, "ghe.io", defaultHost) + require.Equal(t, "hosts", source) } func TestLoginSecureStorageUsesKeyring(t *testing.T) { From c9de81786587231bf488f800d0ca6d4fefd7fb0f Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:26:52 +0200 Subject: [PATCH 081/527] Avoid using keyring unnecessarily in AuthConfig tests This is to avoid the impression that the keyring matters, when the test is actually about general auth behaviour --- internal/config/auth_config_test.go | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 335489525..09649bce8 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -286,12 +286,11 @@ func TestLoginSetsUserForProvidedHost(t *testing.T) { tempDir := t.TempDir() t.Setenv("GH_CONFIG_DIR", tempDir) - // Given a usable keyring and an empty config - keyring.MockInit() + // Given we are not logged in authCfg := newTestAuthConfig() // When we login - _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) // Then it returns success and the user is set require.NoError(t, err) @@ -301,16 +300,15 @@ func TestLoginSetsUserForProvidedHost(t *testing.T) { require.Equal(t, "test-user", user) } -func TestLoginSetsGitProtocolForProdivdedHost(t *testing.T) { +func TestLoginSetsGitProtocolForProvidedHost(t *testing.T) { tempDir := t.TempDir() t.Setenv("GH_CONFIG_DIR", tempDir) - // Given a usable keyring and an empty config - keyring.MockInit() + // Given we are not logged in authCfg := newTestAuthConfig() // When we login - _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) // Then it returns success and the git protocol is set require.NoError(t, err) @@ -324,12 +322,11 @@ func TestLoginAddsHostIfNotAlreadyAdded(t *testing.T) { tempDir := t.TempDir() t.Setenv("GH_CONFIG_DIR", tempDir) - // Given a usable keyring and an empty config - keyring.MockInit() + // Given we are not logged in authCfg := newTestAuthConfig() // When we login - _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) + _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) // Then it returns success and a host is added require.NoError(t, err) From c430da732960ca673b3dd8c4f13f70190d5b41a2 Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:31:41 +0200 Subject: [PATCH 082/527] Ensure all AuthConfig tests are isolated on disk --- internal/config/auth_config_test.go | 95 ++++++++++------------------- 1 file changed, 33 insertions(+), 62 deletions(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 09649bce8..221c5cb2f 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -9,10 +9,11 @@ import ( "github.com/zalando/go-keyring" ) -func newTestAuthConfig() *AuthConfig { +func newTestAuthConfig(t *testing.T) *AuthConfig { authCfg := AuthConfig{ cfg: ghConfig.ReadFromString(""), } + // The real implementation of config.Read uses a sync.Once // to read config files and initialise package level variables // that are used from then on. @@ -22,6 +23,14 @@ func newTestAuthConfig() *AuthConfig { ghConfig.Read = func() (*ghConfig.Config, error) { return authCfg.cfg, nil } + + // The config.Write method isn't defined in the same way as Read to allow + // the function to be swapped out and it does try to write to disk. + // + // We should consider whether it makes sense to change that but in the meantime + // we can use GH_CONFIG_DIR env var to ensure the tests remain isolated. + t.Setenv("GH_CONFIG_DIR", t.TempDir()) + return &authCfg } @@ -31,7 +40,7 @@ func TestTokenFromKeyring(t *testing.T) { require.NoError(t, keyring.Set(keyringServiceName("github.com"), "", "test-token")) // When we get the token from the auth config - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) token, err := authCfg.TokenFromKeyring("github.com") // Then it returns successfully with the correct token @@ -40,11 +49,8 @@ func TestTokenFromKeyring(t *testing.T) { } func TestTokenStoredInConfig(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // When the user has logged in insecurely - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) _, err := authCfg.Login("github.com", "test-user", "test-token", "", false) require.NoError(t, err) @@ -59,11 +65,8 @@ func TestTokenStoredInConfig(t *testing.T) { } func TestTokenStoredInEnv(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // When the user is authenticated via env var - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) t.Setenv("GH_TOKEN", "test-token") // When we get the token @@ -76,12 +79,9 @@ func TestTokenStoredInEnv(t *testing.T) { } func TestTokenStoredInKeyring(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // When the user has logged in securely keyring.MockInit() - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) _, err := authCfg.Login("github.com", "test-user", "test-token", "", true) require.NoError(t, err) @@ -99,7 +99,7 @@ func TestTokenFromKeyringNonExistent(t *testing.T) { keyring.MockInit() // When we try to get a token from the auth config - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) _, err := authCfg.TokenFromKeyring("github.com") // Then it returns failure bubbling the ErrNotFound @@ -108,7 +108,7 @@ func TestTokenFromKeyringNonExistent(t *testing.T) { func TestHasEnvTokenWithoutAnyEnvToken(t *testing.T) { // Given an empty hosts configuration - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we check if it has an env token hasEnvToken := authCfg.HasEnvToken() @@ -119,7 +119,7 @@ func TestHasEnvTokenWithoutAnyEnvToken(t *testing.T) { func TestHasEnvTokenWithEnvToken(t *testing.T) { // Given an empty hosts configuration but a token set in the env var - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) t.Setenv("GH_ENTERPRISE_TOKEN", "test-token") // When we check if it has an env token @@ -133,7 +133,7 @@ func TestHasEnvTokenWithNoEnvTokenButAConfigVar(t *testing.T) { t.Skip("this test is explicitly breaking some implementation assumptions") // Given a token in the config - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // Using example.com here will cause the token to be returned from the config _, err := authCfg.Login("example.com", "test-user", "test-token", "", false) require.NoError(t, err) @@ -147,7 +147,7 @@ func TestHasEnvTokenWithNoEnvTokenButAConfigVar(t *testing.T) { func TestUserNotLoggedIn(t *testing.T) { // Given we have not logged in - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we get the user _, err := authCfg.User("github.com") @@ -159,7 +159,7 @@ func TestUserNotLoggedIn(t *testing.T) { func TestGitProtocolNotLoggedInDefaults(t *testing.T) { // Given a host configuration without a git protocol - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we get the git protocol gitProtocol, err := authCfg.GitProtocol("github.com") @@ -171,7 +171,7 @@ func TestGitProtocolNotLoggedInDefaults(t *testing.T) { func TestDefaultHostFromEnvVar(t *testing.T) { // Given the GH_HOST env var is set - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) t.Setenv("GH_HOST", "ghe.io") // When we get the DefaultHost @@ -184,7 +184,7 @@ func TestDefaultHostFromEnvVar(t *testing.T) { func TestDefaultHostNotLoggedIn(t *testing.T) { // Given we are not logged in - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we get the DefaultHost defaultHost, source := authCfg.DefaultHost() @@ -195,11 +195,8 @@ func TestDefaultHostNotLoggedIn(t *testing.T) { } func TestDefaultHostLoggedInToOnlyOneHost(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given we are logged into one host (not github.com to differentiate from the fallback) - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) _, err := authCfg.Login("ghe.io", "test-user", "test-token", "", false) require.NoError(t, err) @@ -212,12 +209,9 @@ func TestDefaultHostLoggedInToOnlyOneHost(t *testing.T) { } func TestLoginSecureStorageUsesKeyring(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given a usable keyring keyring.MockInit() - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we login with secure storage insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", true) @@ -232,12 +226,9 @@ func TestLoginSecureStorageUsesKeyring(t *testing.T) { } func TestLoginSecureStorageRemovesOldInsecureConfigToken(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given a usable keyring and an oauth token in the config keyring.MockInit() - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) authCfg.cfg.Set([]string{hosts, "github.com", oauthToken}, "old-token") // When we login with secure storage @@ -249,12 +240,9 @@ func TestLoginSecureStorageRemovesOldInsecureConfigToken(t *testing.T) { } func TestLoginSecureStorageWithErrorFallsbackAndReports(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given a keyring that errors keyring.MockInitWithError(errors.New("test-explosion")) - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we login with secure storage insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", true) @@ -267,10 +255,8 @@ func TestLoginSecureStorageWithErrorFallsbackAndReports(t *testing.T) { } func TestLoginInsecureStorage(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - - authCfg := newTestAuthConfig() + // Given we are not logged in + authCfg := newTestAuthConfig(t) // When we login with insecure storage insecureStorageUsed, err := authCfg.Login("github.com", "test-user", "test-token", "", false) @@ -283,11 +269,8 @@ func TestLoginInsecureStorage(t *testing.T) { } func TestLoginSetsUserForProvidedHost(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given we are not logged in - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we login _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) @@ -301,11 +284,8 @@ func TestLoginSetsUserForProvidedHost(t *testing.T) { } func TestLoginSetsGitProtocolForProvidedHost(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given we are not logged in - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we login _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) @@ -319,11 +299,8 @@ func TestLoginSetsGitProtocolForProvidedHost(t *testing.T) { } func TestLoginAddsHostIfNotAlreadyAdded(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given we are not logged in - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we login _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) @@ -336,12 +313,9 @@ func TestLoginAddsHostIfNotAlreadyAdded(t *testing.T) { } func TestLogoutRemovesHostAndKeyringToken(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given we are logged into a host keyring.MockInit() - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", true) require.NoError(t, err) @@ -364,13 +338,10 @@ func TestLogoutRemovesHostAndKeyringToken(t *testing.T) { // really do anything to recover. On the other hand, a user might // want to rectify this manually, for example if there were on a shared machine. func TestLogoutIgnoresErrorsFromConfigAndKeyring(t *testing.T) { - tempDir := t.TempDir() - t.Setenv("GH_CONFIG_DIR", tempDir) - // Given we have keyring that errors, and a config that // doesn't even have a hosts key (which would cause Remove to fail) keyring.MockInitWithError(errors.New("test-explosion")) - authCfg := newTestAuthConfig() + authCfg := newTestAuthConfig(t) // When we logout err := authCfg.Logout("github.com") From aa8848471f18ab6d40c98cc09136be1c0bbd71bd Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:33:15 +0200 Subject: [PATCH 083/527] Remove Logout branch that handles empty hostname --- internal/config/config.go | 5 ----- 1 file changed, 5 deletions(-) diff --git a/internal/config/config.go b/internal/config/config.go index d93c37e3c..65240aa3f 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -243,11 +243,6 @@ func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secure // Logout will remove user, git protocol, and auth token for the given hostname. // It will remove the auth token from the encrypted storage if it exists there. func (c *AuthConfig) Logout(hostname string) error { - // TODO: I can't find anywhere that expects to call this function without a hostname - // and that would seem like a programmer error? - if hostname == "" { - return nil - } _ = c.cfg.Remove([]string{hosts, hostname}) _ = keyring.Delete(keyringServiceName(hostname), "") return ghConfig.Write(c.cfg) From 3c3fbcdb66b3ae4d98d9a020a833fd2dfce4249b Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:35:43 +0200 Subject: [PATCH 084/527] Remove Login branch that handles empty username --- internal/config/config.go | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/internal/config/config.go b/internal/config/config.go index 65240aa3f..faa6497e6 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -229,11 +229,9 @@ func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secure c.cfg.Set([]string{hosts, hostname, oauthToken}, token) insecureStorageUsed = true } - // TODO: I can't find anywhere that calls this function without a username, so that would seem like - // something we might want to error on? - if username != "" { - c.cfg.Set([]string{hosts, hostname, "user"}, username) - } + + c.cfg.Set([]string{hosts, hostname, "user"}, username) + if gitProtocol != "" { c.cfg.Set([]string{hosts, hostname, "git_protocol"}, gitProtocol) } From b9cbee046203663bb013d53f8df5dde2ed5364b5 Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:39:31 +0200 Subject: [PATCH 085/527] Remove incorrect comment about HasEnvToken --- internal/config/config.go | 4 ---- 1 file changed, 4 deletions(-) diff --git a/internal/config/config.go b/internal/config/config.go index faa6497e6..96a7f0716 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -139,10 +139,6 @@ func (c *AuthConfig) HasEnvToken() bool { // It has to use a hostname that is not going to be found in the hosts so that it // can guarantee that tokens will only be returned from a set env var. // Discussed here, but maybe worth revisiting: https://github.com/cli/cli/pull/7169#discussion_r1136979033 - // - // By providing example.com. it's also _only_ looking for GH_ENTERPRISE_TOKEN or GITHUB_ENTERPRISE_TOKEN - // or the GITHUB_TOKEN if we happen to be in a codespace?? This doesn't seem to reflect the actual - // name of the function at all. token, _ := ghAuth.TokenFromEnvOrConfig(hostname) return token != "" } From 7d8c1af009705e867af334ea11ce3c8144f704dd Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:48:30 +0200 Subject: [PATCH 086/527] Fix GitProtocol signature and rework test descriptions --- internal/config/auth_config_test.go | 45 +++++++++++++++++------------ internal/config/config.go | 14 ++++----- pkg/cmd/auth/refresh/refresh.go | 2 +- pkg/cmd/auth/status/status.go | 2 +- 4 files changed, 36 insertions(+), 27 deletions(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 221c5cb2f..2b0d0ff98 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -107,7 +107,7 @@ func TestTokenFromKeyringNonExistent(t *testing.T) { } func TestHasEnvTokenWithoutAnyEnvToken(t *testing.T) { - // Given an empty hosts configuration + // Given we have no env set authCfg := newTestAuthConfig(t) // When we check if it has an env token @@ -118,7 +118,8 @@ func TestHasEnvTokenWithoutAnyEnvToken(t *testing.T) { } func TestHasEnvTokenWithEnvToken(t *testing.T) { - // Given an empty hosts configuration but a token set in the env var + // Given we have an env token set + // Note that any valid env var for tokens will do, not just GH_ENTERPRISE_TOKEN authCfg := newTestAuthConfig(t) t.Setenv("GH_ENTERPRISE_TOKEN", "test-token") @@ -158,17 +159,28 @@ func TestUserNotLoggedIn(t *testing.T) { } func TestGitProtocolNotLoggedInDefaults(t *testing.T) { - // Given a host configuration without a git protocol + // Given we have not logged in authCfg := newTestAuthConfig(t) // When we get the git protocol - gitProtocol, err := authCfg.GitProtocol("github.com") + gitProtocol := authCfg.GitProtocol("github.com") - // Then it returns success, using the default - require.NoError(t, err) + // Then it returns the default require.Equal(t, "https", gitProtocol) } +func TestHostsIncludesEnvVar(t *testing.T) { + // Given the GH_HOST env var is set + authCfg := newTestAuthConfig(t) + t.Setenv("GH_HOST", "ghe.io") + + // When we get the hosts + hosts := authCfg.Hosts() + + // Then the host in the env var is included + require.Contains(t, hosts, "ghe.io") +} + func TestDefaultHostFromEnvVar(t *testing.T) { // Given the GH_HOST env var is set authCfg := newTestAuthConfig(t) @@ -284,31 +296,28 @@ func TestLoginSetsUserForProvidedHost(t *testing.T) { } func TestLoginSetsGitProtocolForProvidedHost(t *testing.T) { - // Given we are not logged in + // Given we are loggedin authCfg := newTestAuthConfig(t) - - // When we login _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) - - // Then it returns success and the git protocol is set require.NoError(t, err) - gitProtocol, err := authCfg.GitProtocol("github.com") - require.NoError(t, err) + // When we get the git protocol + gitProtocol := authCfg.GitProtocol("github.com") + + // Then it returns the git protocol we provided on login require.Equal(t, "ssh", gitProtocol) } func TestLoginAddsHostIfNotAlreadyAdded(t *testing.T) { - // Given we are not logged in + // Given we are logged in authCfg := newTestAuthConfig(t) - - // When we login _, err := authCfg.Login("github.com", "test-user", "test-token", "ssh", false) - - // Then it returns success and a host is added require.NoError(t, err) + // When we get the hosts hosts := authCfg.Hosts() + + // Then it includes our logged in host require.Contains(t, hosts, "github.com") } diff --git a/internal/config/config.go b/internal/config/config.go index 96a7f0716..587cc996b 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -164,19 +164,19 @@ func (c *AuthConfig) User(hostname string) (string, error) { // GitProtocol will retrieve the git protocol for the logged in user at the given hostname. // If none is set it will return the default value. -// TODO: although this returns an error, it actually has no path to error. -func (c *AuthConfig) GitProtocol(hostname string) (string, error) { +func (c *AuthConfig) GitProtocol(hostname string) string { key := "git_protocol" - val, err := c.cfg.Get([]string{hosts, hostname, key}) - if err == nil { - return val, err + if val, err := c.cfg.Get([]string{hosts, hostname, key}); err == nil { + return val } if val, ok := defaultFor(key); ok { - return val, nil + return val } - return "", nil + // This should not happen, as we know there is a default value for this key. + // Perhaps it says something about our current default abstraction being not quite right? + return "" } func (c *AuthConfig) Hosts() []string { diff --git a/pkg/cmd/auth/refresh/refresh.go b/pkg/cmd/auth/refresh/refresh.go index 489746179..30b5a3ff0 100644 --- a/pkg/cmd/auth/refresh/refresh.go +++ b/pkg/cmd/auth/refresh/refresh.go @@ -178,7 +178,7 @@ func refreshRun(opts *RefreshOptions) error { Prompter: opts.Prompter, GitClient: opts.GitClient, } - gitProtocol, _ := authCfg.GitProtocol(hostname) + gitProtocol := authCfg.GitProtocol(hostname) if opts.Interactive && gitProtocol == "https" { if err := credentialFlow.Prompt(hostname); err != nil { return err diff --git a/pkg/cmd/auth/status/status.go b/pkg/cmd/auth/status/status.go index 1739cfe09..bde74306a 100644 --- a/pkg/cmd/auth/status/status.go +++ b/pkg/cmd/auth/status/status.go @@ -139,7 +139,7 @@ func statusRun(opts *StatusOptions) error { } addMsg("%s Logged in to %s as %s (%s)", cs.SuccessIcon(), hostname, cs.Bold(username), tokenSource) - proto, _ := authCfg.GitProtocol(hostname) + proto := authCfg.GitProtocol(hostname) if proto != "" { addMsg("%s Git operations for %s configured to use %s protocol.", cs.SuccessIcon(), hostname, cs.Bold(proto)) From 6dc04bb1e2b19bfde12392fa09328a4799b153ae Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 12:57:19 +0200 Subject: [PATCH 087/527] Remove GetOrDefault uses in favour of GitProtocol --- internal/config/config.go | 1 + pkg/cmd/gist/clone/clone.go | 5 +---- pkg/cmd/pr/checkout/checkout.go | 2 +- pkg/cmd/pr/create/create.go | 2 +- pkg/cmd/repo/clone/clone.go | 10 ++-------- pkg/cmd/repo/create/create.go | 18 +++--------------- pkg/cmd/repo/rename/rename.go | 5 +---- 7 files changed, 10 insertions(+), 33 deletions(-) diff --git a/internal/config/config.go b/internal/config/config.go index 587cc996b..6f60f14b5 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -176,6 +176,7 @@ func (c *AuthConfig) GitProtocol(hostname string) string { // This should not happen, as we know there is a default value for this key. // Perhaps it says something about our current default abstraction being not quite right? + // The defaults are also currently used to provide information about the config options. return "" } diff --git a/pkg/cmd/gist/clone/clone.go b/pkg/cmd/gist/clone/clone.go index 9b75a309c..cd477a745 100644 --- a/pkg/cmd/gist/clone/clone.go +++ b/pkg/cmd/gist/clone/clone.go @@ -80,10 +80,7 @@ func cloneRun(opts *CloneOptions) error { return err } hostname, _ := cfg.Authentication().DefaultHost() - protocol, err := cfg.GetOrDefault(hostname, "git_protocol") - if err != nil { - return err - } + protocol := cfg.Authentication().GitProtocol(hostname) gistURL = formatRemoteURL(hostname, gistURL, protocol) } diff --git a/pkg/cmd/pr/checkout/checkout.go b/pkg/cmd/pr/checkout/checkout.go index 193eea735..b91fb1765 100644 --- a/pkg/cmd/pr/checkout/checkout.go +++ b/pkg/cmd/pr/checkout/checkout.go @@ -84,7 +84,7 @@ func checkoutRun(opts *CheckoutOptions) error { if err != nil { return err } - protocol, _ := cfg.GetOrDefault(baseRepo.RepoHost(), "git_protocol") + protocol := cfg.Authentication().GitProtocol(baseRepo.RepoHost()) remotes, err := opts.Remotes() if err != nil { diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index 8c1047de7..81b2c05f3 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -761,7 +761,7 @@ func handlePush(opts CreateOptions, ctx CreateContext) error { return err } - cloneProtocol, _ := cfg.GetOrDefault(headRepo.RepoHost(), "git_protocol") + cloneProtocol := cfg.Authentication().GitProtocol(headRepo.RepoHost()) headRepoURL := ghrepo.FormatRemoteURL(headRepo, cloneProtocol) gitClient := ctx.GitClient origin, _ := remotes.FindByName("origin") diff --git a/pkg/cmd/repo/clone/clone.go b/pkg/cmd/repo/clone/clone.go index 174951243..298ca30de 100644 --- a/pkg/cmd/repo/clone/clone.go +++ b/pkg/cmd/repo/clone/clone.go @@ -129,10 +129,7 @@ func cloneRun(opts *CloneOptions) error { return err } - protocol, err = cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return err - } + protocol = cfg.Authentication().GitProtocol(repo.RepoHost()) } wantsWiki := strings.HasSuffix(repo.RepoName(), ".wiki") @@ -166,10 +163,7 @@ func cloneRun(opts *CloneOptions) error { // If the repo is a fork, add the parent as an upstream remote and set the parent as the default repo. if canonicalRepo.Parent != nil { - protocol, err := cfg.GetOrDefault(canonicalRepo.Parent.RepoHost(), "git_protocol") - if err != nil { - return err - } + protocol := cfg.Authentication().GitProtocol(canonicalRepo.Parent.RepoHost()) upstreamURL := ghrepo.FormatRemoteURL(canonicalRepo.Parent, protocol) upstreamName := opts.UpstreamName diff --git a/pkg/cmd/repo/create/create.go b/pkg/cmd/repo/create/create.go index c050607ed..c96aeb3f9 100644 --- a/pkg/cmd/repo/create/create.go +++ b/pkg/cmd/repo/create/create.go @@ -395,11 +395,7 @@ func createFromScratch(opts *CreateOptions) error { } if opts.Clone { - protocol, err := cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return err - } - + protocol := cfg.Authentication().GitProtocol(repo.RepoHost()) remoteURL := ghrepo.FormatRemoteURL(repo, protocol) if !opts.AddReadme && opts.LicenseTemplate == "" && opts.GitIgnoreTemplate == "" && opts.Template == "" { @@ -496,11 +492,7 @@ func createFromTemplate(opts *CreateOptions) error { } if opts.Clone { - protocol, err := cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return err - } - + protocol := cfg.Authentication().GitProtocol(repo.RepoHost()) remoteURL := ghrepo.FormatRemoteURL(repo, protocol) if err := cloneWithRetry(opts, remoteURL, templateRepoMainBranch); err != nil { @@ -622,11 +614,7 @@ func createFromLocal(opts *CreateOptions) error { fmt.Fprintln(stdout, repo.URL) } - protocol, err := cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return err - } - + protocol := cfg.Authentication().GitProtocol(repo.RepoHost()) remoteURL := ghrepo.FormatRemoteURL(repo, protocol) if opts.Interactive { diff --git a/pkg/cmd/repo/rename/rename.go b/pkg/cmd/repo/rename/rename.go index 973eb7bd6..8dbc1326d 100644 --- a/pkg/cmd/repo/rename/rename.go +++ b/pkg/cmd/repo/rename/rename.go @@ -149,10 +149,7 @@ func updateRemote(repo ghrepo.Interface, renamed ghrepo.Interface, opts *RenameO return nil, err } - protocol, err := cfg.GetOrDefault(repo.RepoHost(), "git_protocol") - if err != nil { - return nil, err - } + protocol := cfg.Authentication().GitProtocol(repo.RepoHost()) remotes, err := opts.Remotes() if err != nil { From 6696229fb1631a16ad4c92522cc170f7d7cfd687 Mon Sep 17 00:00:00 2001 From: Swastik Baranwal Date: Thu, 19 Oct 2023 18:52:21 +0530 Subject: [PATCH 088/527] `gh extension install` not give an error if extension already installed and a clear message (#8211) * `gh extension install` not give an error if extension already installed and a clear message * remove test * Add implementation * lint go.sum --------- Co-authored-by: Sam Coe --- go.sum | 1 - pkg/cmd/extension/command.go | 17 +++++-- pkg/cmd/extension/command_test.go | 72 +++++++++++++++++++++-------- pkg/cmd/extension/extension.go | 34 ++++++++++++++ pkg/cmd/extension/extension_test.go | 52 +++++++++++++++++++++ pkg/extensions/extension.go | 1 + pkg/extensions/extension_mock.go | 37 +++++++++++++++ 7 files changed, 190 insertions(+), 24 deletions(-) diff --git a/go.sum b/go.sum index 95392510f..00876d819 100644 --- a/go.sum +++ b/go.sum @@ -32,7 +32,6 @@ github.com/cli/safeexec v1.0.1 h1:e/C79PbXF4yYTN/wauC4tviMxEV13BwljGj0N9j+N00= github.com/cli/safeexec v1.0.1/go.mod h1:Z/D4tTN8Vs5gXYHDCbaM1S/anmEDnJb1iW0+EJ5zx3Q= github.com/cli/shurcooL-graphql v0.0.3 h1:CtpPxyGDs136/+ZeyAfUKYmcQBjDlq5aqnrDCW5Ghh8= github.com/cli/shurcooL-graphql v0.0.3/go.mod h1:tlrLmw/n5Q/+4qSvosT+9/W5zc8ZMjnJeYBxSdb4nWA= -github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w= github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/cpuguy83/go-md2man/v2 v2.0.3 h1:qMCsGGgs+MAzDFyp9LpAe1Lqy/fY/qCovCm0qnXZOBM= github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index 6629e599d..4348e2cd3 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -22,6 +22,8 @@ import ( "github.com/spf13/cobra" ) +var alreadyInstalledError = errors.New("alreadyInstalledError") + func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { m := f.ExtensionManager io := f.IOStreams @@ -333,16 +335,22 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { return err } - if ext, err := checkValidExtension(cmd.Root(), m, repo.RepoName()); err != nil { + cs := io.ColorScheme() + + if ext, err := checkValidExtension(cmd.Root(), m, repo.RepoName(), repo.RepoOwner()); err != nil { // If an existing extension was found and --force was specified, attempt to upgrade. if forceFlag && ext != nil { return upgradeFunc(ext.Name(), forceFlag, false) } + if errors.Is(err, alreadyInstalledError) { + fmt.Fprintf(io.ErrOut, "%s Extension %s is already installed\n", cs.WarningIcon(), ghrepo.FullName(repo)) + return nil + } + return err } - cs := io.ColorScheme() if err := m.Install(repo, pinFlag); err != nil { if errors.Is(err, releaseNotFoundErr) { return fmt.Errorf("%s Could not find a release of %s for %s", @@ -637,7 +645,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { return &extCmd } -func checkValidExtension(rootCmd *cobra.Command, m extensions.ExtensionManager, extName string) (extensions.Extension, error) { +func checkValidExtension(rootCmd *cobra.Command, m extensions.ExtensionManager, extName, extOwner string) (extensions.Extension, error) { if !strings.HasPrefix(extName, "gh-") { return nil, errors.New("extension repository name must start with `gh-`") } @@ -649,6 +657,9 @@ func checkValidExtension(rootCmd *cobra.Command, m extensions.ExtensionManager, for _, ext := range m.List() { if ext.Name() == commandName { + if ext.Owner() == extOwner { + return ext, alreadyInstalledError + } return ext, fmt.Errorf("there is already an installed extension that provides the %q command", commandName) } } diff --git a/pkg/cmd/extension/command_test.go b/pkg/cmd/extension/command_test.go index fd693d7e5..094fa330a 100644 --- a/pkg/cmd/extension/command_test.go +++ b/pkg/cmd/extension/command_test.go @@ -239,7 +239,7 @@ func TestNewCmdExtension(t *testing.T) { args: []string{"install", "owner/gh-existing-ext"}, managerStubs: func(em *extensions.ExtensionManagerMock) func(*testing.T) { em.ListFunc = func() []extensions.Extension { - e := &Extension{path: "owner2/gh-existing-ext"} + e := &Extension{path: "owner2/gh-existing-ext", owner: "owner2"} return []extensions.Extension{e} } return func(t *testing.T) { @@ -250,6 +250,21 @@ func TestNewCmdExtension(t *testing.T) { wantErr: true, errMsg: "there is already an installed extension that provides the \"existing-ext\" command", }, + { + name: "install an already installed extension", + args: []string{"install", "owner/gh-existing-ext"}, + managerStubs: func(em *extensions.ExtensionManagerMock) func(*testing.T) { + em.ListFunc = func() []extensions.Extension { + e := &Extension{path: "owner/gh-existing-ext", owner: "owner"} + return []extensions.Extension{e} + } + return func(t *testing.T) { + calls := em.ListCalls() + assert.Equal(t, 1, len(calls)) + } + }, + wantStderr: "! Extension owner/gh-existing-ext is already installed\n", + }, { name: "install local extension", args: []string{"install", "."}, @@ -817,7 +832,7 @@ func TestNewCmdExtension(t *testing.T) { managerStubs: func(em *extensions.ExtensionManagerMock) func(*testing.T) { em.ListFunc = func() []extensions.Extension { return []extensions.Extension{ - &Extension{path: "owner/gh-hello"}, + &Extension{path: "owner/gh-hello", owner: "owner"}, } } em.InstallFunc = func(_ ghrepo.Interface, _ string) error { @@ -924,19 +939,22 @@ func Test_checkValidExtension(t *testing.T) { ListFunc: func() []extensions.Extension { return []extensions.Extension{ &extensions.ExtensionMock{ - NameFunc: func() string { return "screensaver" }, + OwnerFunc: func() string { return "monalisa" }, + NameFunc: func() string { return "screensaver" }, }, &extensions.ExtensionMock{ - NameFunc: func() string { return "triage" }, + OwnerFunc: func() string { return "monalisa" }, + NameFunc: func() string { return "triage" }, }, } }, } type args struct { - rootCmd *cobra.Command - manager extensions.ExtensionManager - extName string + rootCmd *cobra.Command + manager extensions.ExtensionManager + extName string + extOwner string } tests := []struct { name string @@ -946,42 +964,56 @@ func Test_checkValidExtension(t *testing.T) { { name: "valid extension", args: args{ - rootCmd: rootCmd, - manager: m, - extName: "gh-hello", + rootCmd: rootCmd, + manager: m, + extOwner: "monalisa", + extName: "gh-hello", }, }, { name: "invalid extension name", args: args{ - rootCmd: rootCmd, - manager: m, - extName: "gherkins", + rootCmd: rootCmd, + manager: m, + extOwner: "monalisa", + extName: "gherkins", }, wantError: "extension repository name must start with `gh-`", }, { name: "clashes with built-in command", args: args{ - rootCmd: rootCmd, - manager: m, - extName: "gh-auth", + rootCmd: rootCmd, + manager: m, + extOwner: "monalisa", + extName: "gh-auth", }, wantError: "\"auth\" matches the name of a built-in command or alias", }, { name: "clashes with an installed extension", args: args{ - rootCmd: rootCmd, - manager: m, - extName: "gh-triage", + rootCmd: rootCmd, + manager: m, + extOwner: "cli", + extName: "gh-triage", }, wantError: "there is already an installed extension that provides the \"triage\" command", }, + { + name: "clashes with same extension", + args: args{ + rootCmd: rootCmd, + manager: m, + extOwner: "monalisa", + extName: "gh-triage", + }, + wantError: "alreadyInstalledError", + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - _, err := checkValidExtension(tt.args.rootCmd, tt.args.manager, tt.args.extName) + _, err := checkValidExtension(tt.args.rootCmd, tt.args.manager, tt.args.extName, tt.args.extOwner) if tt.wantError == "" { assert.NoError(t, err) } else { diff --git a/pkg/cmd/extension/extension.go b/pkg/cmd/extension/extension.go index 188687634..dc7ffa8c3 100644 --- a/pkg/cmd/extension/extension.go +++ b/pkg/cmd/extension/extension.go @@ -9,6 +9,7 @@ import ( "strings" "sync" + "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghrepo" "gopkg.in/yaml.v3" ) @@ -36,6 +37,7 @@ type Extension struct { isPinned *bool currentVersion string latestVersion string + owner string } func (e *Extension) Name() string { @@ -176,6 +178,38 @@ func (e *Extension) IsPinned() bool { return *e.isPinned } +func (e *Extension) Owner() string { + e.mu.RLock() + if e.owner != "" { + defer e.mu.RUnlock() + return e.owner + } + e.mu.RUnlock() + + var owner string + switch e.kind { + case LocalKind: + case BinaryKind: + if manifest, err := e.loadManifest(); err == nil { + owner = manifest.Owner + } + case GitKind: + if remoteURL, err := e.gitClient.Config("remote.origin.url"); err == nil { + if url, err := git.ParseURL(strings.TrimSpace(string(remoteURL))); err == nil { + if repo, err := ghrepo.FromURL(url); err == nil { + owner = repo.RepoOwner() + } + } + } + } + + e.mu.Lock() + e.owner = owner + e.mu.Unlock() + + return e.owner +} + func (e *Extension) UpdateAvailable() bool { if e.IsLocal() || e.CurrentVersion() == "" || diff --git a/pkg/cmd/extension/extension_test.go b/pkg/cmd/extension/extension_test.go index 9b56e0bee..6f0afc3a6 100644 --- a/pkg/cmd/extension/extension_test.go +++ b/pkg/cmd/extension/extension_test.go @@ -1,6 +1,7 @@ package extension import ( + "path/filepath" "testing" "github.com/stretchr/testify/assert" @@ -50,3 +51,54 @@ func TestUpdateAvailable(t *testing.T) { assert.True(t, e.UpdateAvailable()) } + +func TestOwnerLocalExtension(t *testing.T) { + tempDir := t.TempDir() + extPath := filepath.Join(tempDir, "extensions", "gh-local", "gh-local") + assert.NoError(t, stubLocalExtension(tempDir, extPath)) + e := &Extension{ + kind: LocalKind, + path: extPath, + } + + assert.Equal(t, "", e.Owner()) +} + +func TestOwnerBinaryExtension(t *testing.T) { + tempDir := t.TempDir() + extName := "gh-bin-ext" + extDir := filepath.Join(tempDir, "extensions", extName) + extPath := filepath.Join(extDir, extName) + bm := binManifest{ + Owner: "owner", + Name: "gh-bin-ext", + Host: "example.com", + Tag: "v1.0.1", + } + assert.NoError(t, stubBinaryExtension(extDir, bm)) + e := &Extension{ + kind: BinaryKind, + path: extPath, + } + + assert.Equal(t, "owner", e.Owner()) +} + +func TestOwnerGitExtension(t *testing.T) { + gc := &mockGitClient{} + gc.On("Config", "remote.origin.url").Return("git@github.com:owner/repo.git", nil).Once() + e := &Extension{ + kind: GitKind, + gitClient: gc, + } + + assert.Equal(t, "owner", e.Owner()) +} + +func TestOwnerCached(t *testing.T) { + e := &Extension{ + owner: "cli", + } + + assert.Equal(t, "cli", e.Owner()) +} diff --git a/pkg/extensions/extension.go b/pkg/extensions/extension.go index 2583472c0..0b94032df 100644 --- a/pkg/extensions/extension.go +++ b/pkg/extensions/extension.go @@ -25,6 +25,7 @@ type Extension interface { UpdateAvailable() bool IsBinary() bool IsLocal() bool + Owner() string } //go:generate moq -rm -out manager_mock.go . ExtensionManager diff --git a/pkg/extensions/extension_mock.go b/pkg/extensions/extension_mock.go index 500603661..9b473e20a 100644 --- a/pkg/extensions/extension_mock.go +++ b/pkg/extensions/extension_mock.go @@ -35,6 +35,9 @@ var _ Extension = &ExtensionMock{} // NameFunc: func() string { // panic("mock out the Name method") // }, +// OwnerFunc: func() string { +// panic("mock out the Owner method") +// }, // PathFunc: func() string { // panic("mock out the Path method") // }, @@ -69,6 +72,9 @@ type ExtensionMock struct { // NameFunc mocks the Name method. NameFunc func() string + // OwnerFunc mocks the Owner method. + OwnerFunc func() string + // PathFunc mocks the Path method. PathFunc func() string @@ -98,6 +104,9 @@ type ExtensionMock struct { // Name holds details about calls to the Name method. Name []struct { } + // Owner holds details about calls to the Owner method. + Owner []struct { + } // Path holds details about calls to the Path method. Path []struct { } @@ -114,6 +123,7 @@ type ExtensionMock struct { lockIsPinned sync.RWMutex lockLatestVersion sync.RWMutex lockName sync.RWMutex + lockOwner sync.RWMutex lockPath sync.RWMutex lockURL sync.RWMutex lockUpdateAvailable sync.RWMutex @@ -281,6 +291,33 @@ func (mock *ExtensionMock) NameCalls() []struct { return calls } +// Owner calls OwnerFunc. +func (mock *ExtensionMock) Owner() string { + if mock.OwnerFunc == nil { + panic("ExtensionMock.OwnerFunc: method is nil but Extension.Owner was just called") + } + callInfo := struct { + }{} + mock.lockOwner.Lock() + mock.calls.Owner = append(mock.calls.Owner, callInfo) + mock.lockOwner.Unlock() + return mock.OwnerFunc() +} + +// OwnerCalls gets all the calls that were made to Owner. +// Check the length with: +// +// len(mockedExtension.OwnerCalls()) +func (mock *ExtensionMock) OwnerCalls() []struct { +} { + var calls []struct { + } + mock.lockOwner.RLock() + calls = mock.calls.Owner + mock.lockOwner.RUnlock() + return calls +} + // Path calls PathFunc. func (mock *ExtensionMock) Path() string { if mock.PathFunc == nil { From 4fc1999847c5a7c419cc31418c1ed7c129f0de66 Mon Sep 17 00:00:00 2001 From: William Martin Date: Thu, 19 Oct 2023 15:39:10 +0200 Subject: [PATCH 089/527] Add link to token source issue --- internal/config/auth_config_test.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 2b0d0ff98..e4a1dc9c4 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -58,8 +58,8 @@ func TestTokenStoredInConfig(t *testing.T) { token, source := authCfg.Token("github.com") // Then the token is successfully fetched - // and the source is set to oauth_token but this isn't great - // but I can't find the issue # that references this. + // and the source is set to oauth_token but this isn't great: + // https://github.com/cli/go-gh/issues/94 require.Equal(t, "test-token", token) require.Equal(t, "oauth_token", source) } From 7738b6187c80f128728aeba15fdba6bf62ec9e1b Mon Sep 17 00:00:00 2001 From: Heath Stewart Date: Fri, 20 Oct 2023 02:20:02 -0700 Subject: [PATCH 090/527] Add headers to all tables (#8157) --- go.mod | 6 +- go.sum | 14 +- internal/tableprinter/table_printer.go | 81 ++++++++--- internal/text/text.go | 4 + pkg/cmd/cache/list/list.go | 3 +- pkg/cmd/codespace/list.go | 56 ++++---- pkg/cmd/codespace/ports.go | 10 +- pkg/cmd/codespace/view.go | 3 +- pkg/cmd/extension/command.go | 16 +-- pkg/cmd/gist/list/list.go | 24 ++-- pkg/cmd/gist/list/list_test.go | 24 ++-- pkg/cmd/gpg-key/list/list.go | 24 +--- pkg/cmd/issue/develop/develop.go | 2 +- pkg/cmd/issue/develop/develop_test.go | 10 +- pkg/cmd/issue/list/list_test.go | 7 +- pkg/cmd/issue/shared/display.go | 33 +++-- pkg/cmd/label/list.go | 11 +- pkg/cmd/label/list_test.go | 10 +- pkg/cmd/org/list/list.go | 11 +- pkg/cmd/pr/checks/checks_test.go | 133 ++++++++++++++++-- pkg/cmd/pr/checks/output.go | 9 +- pkg/cmd/pr/list/list.go | 35 +++-- pkg/cmd/pr/list/list_test.go | 1 + pkg/cmd/project/field-list/field_list.go | 4 +- pkg/cmd/project/field-list/field_list_test.go | 12 +- pkg/cmd/project/item-list/item_list.go | 4 +- pkg/cmd/project/item-list/item_list_test.go | 9 +- pkg/cmd/project/list/list.go | 4 +- pkg/cmd/project/list/list_test.go | 18 ++- pkg/cmd/release/list/list.go | 3 +- pkg/cmd/release/view/view.go | 10 +- pkg/cmd/repo/deploy-key/list/list.go | 16 +-- pkg/cmd/repo/deploy-key/list/list_test.go | 1 + pkg/cmd/repo/list/list.go | 24 ++-- pkg/cmd/repo/list/list_test.go | 1 + pkg/cmd/ruleset/list/list.go | 3 +- pkg/cmd/run/list/list.go | 37 ++--- pkg/cmd/search/commits/commits.go | 3 +- pkg/cmd/search/repos/repos.go | 3 +- pkg/cmd/search/shared/shared.go | 20 +-- pkg/cmd/secret/list/list.go | 8 +- pkg/cmd/ssh-key/list/list.go | 34 ++--- pkg/cmd/status/status.go | 27 ++-- pkg/cmd/variable/list/list.go | 8 +- pkg/cmd/workflow/list/list.go | 3 +- pkg/cmd/workflow/view/view.go | 35 +++-- pkg/cmd/workflow/view/view_test.go | 9 +- pkg/iostreams/color.go | 32 +++-- utils/table_printer.go | 89 ------------ 49 files changed, 516 insertions(+), 428 deletions(-) delete mode 100644 utils/table_printer.go diff --git a/go.mod b/go.mod index 252405f72..c26451600 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.6.0 github.com/charmbracelet/lipgloss v0.5.0 - github.com/cli/go-gh/v2 v2.3.0 + github.com/cli/go-gh/v2 v2.4.1-0.20231019124728-ec1e1cd3e0cb github.com/cli/oauth v1.0.1 github.com/cli/safeexec v1.0.1 github.com/cpuguy83/go-md2man/v2 v2.0.3 @@ -51,8 +51,8 @@ require ( github.com/alessio/shellescape v1.4.1 // indirect github.com/aymanbagabas/go-osc52 v1.0.3 // indirect github.com/aymerick/douceur v0.2.0 // indirect - github.com/cli/browser v1.2.0 // indirect - github.com/cli/shurcooL-graphql v0.0.3 // indirect + github.com/cli/browser v1.3.0 // indirect + github.com/cli/shurcooL-graphql v0.0.4 // 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 diff --git a/go.sum b/go.sum index 00876d819..4e177e4d7 100644 --- a/go.sum +++ b/go.sum @@ -21,17 +21,17 @@ github.com/charmbracelet/glamour v0.6.0/go.mod h1:taqWV4swIMMbWALc0m7AfE9JkPSU8o github.com/charmbracelet/lipgloss v0.5.0 h1:lulQHuVeodSgDez+3rGiuxlPVXSnhth442DATR2/8t8= github.com/charmbracelet/lipgloss v0.5.0/go.mod h1:EZLha/HbzEt7cYqdFPovlqy5FZPj0xFhg5SaqxScmgs= github.com/cli/browser v1.0.0/go.mod h1:IEWkHYbLjkhtjwwWlwTHW2lGxeS5gezEQBMLTwDHf5Q= -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/go-gh/v2 v2.3.0 h1:FAQAP4PaWSAJf4VSxFEIYDQ1oBIs+bKB4GXQAiRr2sQ= -github.com/cli/go-gh/v2 v2.3.0/go.mod h1:6WBUuf7LUVAc+eXYYX/nYTYURRc6M03K9cJNwBKvwT0= +github.com/cli/browser v1.3.0 h1:LejqCrpWr+1pRqmEPDGnTZOjsMe7sehifLynZJuqJpo= +github.com/cli/browser v1.3.0/go.mod h1:HH8s+fOAxjhQoBUAsKuPCbqUuxZDhQ2/aD+SzsEfBTk= +github.com/cli/go-gh/v2 v2.4.1-0.20231019124728-ec1e1cd3e0cb h1:HeIpiv5Jf09GQA0AyABbjC7Zq55eyIxpv4/BU6ujHRk= +github.com/cli/go-gh/v2 v2.4.1-0.20231019124728-ec1e1cd3e0cb/go.mod h1:h3salfqqooVpzKmHp6aUdeNx62UmxQRpLbagFSHTJGQ= 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= github.com/cli/safeexec v1.0.1 h1:e/C79PbXF4yYTN/wauC4tviMxEV13BwljGj0N9j+N00= github.com/cli/safeexec v1.0.1/go.mod h1:Z/D4tTN8Vs5gXYHDCbaM1S/anmEDnJb1iW0+EJ5zx3Q= -github.com/cli/shurcooL-graphql v0.0.3 h1:CtpPxyGDs136/+ZeyAfUKYmcQBjDlq5aqnrDCW5Ghh8= -github.com/cli/shurcooL-graphql v0.0.3/go.mod h1:tlrLmw/n5Q/+4qSvosT+9/W5zc8ZMjnJeYBxSdb4nWA= +github.com/cli/shurcooL-graphql v0.0.4 h1:6MogPnQJLjKkaXPyGqPRXOI2qCsQdqNfUY1QSJu2GuY= +github.com/cli/shurcooL-graphql v0.0.4/go.mod h1:3waN4u02FiZivIV+p1y4d0Jo1jc6BViMA73C+sZo2fk= github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/cpuguy83/go-md2man/v2 v2.0.3 h1:qMCsGGgs+MAzDFyp9LpAe1Lqy/fY/qCovCm0qnXZOBM= github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= @@ -183,7 +183,6 @@ golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLL golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= 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.0.0-20221002022538-bcab6841153b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= @@ -199,7 +198,6 @@ golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5h golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/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= diff --git a/internal/tableprinter/table_printer.go b/internal/tableprinter/table_printer.go index 1cd7c7d6e..ed734cbad 100644 --- a/internal/tableprinter/table_printer.go +++ b/internal/tableprinter/table_printer.go @@ -1,6 +1,7 @@ package tableprinter import ( + "io" "strings" "time" @@ -12,24 +13,22 @@ import ( type TablePrinter struct { tableprinter.TablePrinter isTTY bool + cs *iostreams.ColorScheme } -func (t *TablePrinter) HeaderRow(columns ...string) { - if !t.isTTY { - return - } - for _, col := range columns { - t.AddField(strings.ToUpper(col)) - } - t.EndRow() +// IsTTY gets wether the TablePrinter will render to a terminal. +func (t *TablePrinter) IsTTY() bool { + return t.isTTY } -// In tty mode display the fuzzy time difference between now and t. -// In nontty mode just display t with the time.RFC3339 format. +// AddTimeField in TTY mode displays the fuzzy time difference between now and t. +// In non-TTY mode it just displays t with the time.RFC3339 format. func (tp *TablePrinter) AddTimeField(now, t time.Time, c func(string) string) { - tf := t.Format(time.RFC3339) + var tf string if tp.isTTY { tf = text.FuzzyAgo(now, t) + } else { + tf = t.Format(time.RFC3339) } tp.AddField(tf, tableprinter.WithColor(c)) } @@ -39,15 +38,63 @@ var ( WithColor = tableprinter.WithColor ) -func New(ios *iostreams.IOStreams) *TablePrinter { +type headerOption struct { + columns []string +} + +// New creates a TablePrinter from an IOStreams. +func New(ios *iostreams.IOStreams, headers headerOption) *TablePrinter { maxWidth := 80 isTTY := ios.IsStdoutTTY() if isTTY { maxWidth = ios.TerminalWidth() } - tp := tableprinter.New(ios.Out, isTTY, maxWidth) - return &TablePrinter{ - TablePrinter: tp, - isTTY: isTTY, - } + + return NewWithWriter(ios.Out, isTTY, maxWidth, ios.ColorScheme(), headers) } + +// NewWithWriter creates a TablePrinter from a Writer, whether the output is a terminal, the terminal width, and more. +func NewWithWriter(w io.Writer, isTTY bool, maxWidth int, cs *iostreams.ColorScheme, headers headerOption) *TablePrinter { + tp := &TablePrinter{ + TablePrinter: tableprinter.New(w, isTTY, maxWidth), + isTTY: isTTY, + cs: cs, + } + + if isTTY && len(headers.columns) > 0 { + // Make sure all headers are uppercase. + for i := range headers.columns { + headers.columns[i] = strings.ToUpper(headers.columns[i]) + } + + // Make sure all header columns are padded - even the last one. Previously, the last header column + // was not padded. In tests cs.Enabled() is false which allows us to avoid having to fix up + // numerous tests that verify header padding. + var paddingFunc func(int, string) string + if cs.Enabled() { + paddingFunc = text.PadRight + } + + tp.AddHeader( + headers.columns, + tableprinter.WithPadding(paddingFunc), + tableprinter.WithColor(cs.LightGrayUnderline), + ) + } + + return tp +} + +// WithHeader defines the column names for a table. +// Panics if columns is nil or empty. +func WithHeader(columns ...string) headerOption { + if len(columns) == 0 { + panic("must define header columns") + } + return headerOption{columns} +} + +// NoHeader disable printing or checking for a table header. +// +// Deprecated: use WithHeader unless required otherwise. +var NoHeader = headerOption{} diff --git a/internal/text/text.go b/internal/text/text.go index 6eb541584..9ecfad93b 100644 --- a/internal/text/text.go +++ b/internal/text/text.go @@ -77,3 +77,7 @@ func DisplayURL(urlStr string) string { func RemoveDiacritics(value string) string { return text.RemoveDiacritics(value) } + +func PadRight(maxWidth int, s string) string { + return text.PadRight(maxWidth, s) +} diff --git a/pkg/cmd/cache/list/list.go b/pkg/cmd/cache/list/list.go index 85ab68f6b..ab5d662b5 100644 --- a/pkg/cmd/cache/list/list.go +++ b/pkg/cmd/cache/list/list.go @@ -115,8 +115,7 @@ func listRun(opts *ListOptions) error { opts.Now = time.Now() } - tp := tableprinter.New(opts.IO) - tp.HeaderRow("ID", "KEY", "SIZE", "CREATED", "ACCESSED") + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("ID", "KEY", "SIZE", "CREATED", "ACCESSED")) for _, cache := range result.ActionsCaches { tp.AddField(opts.IO.ColorScheme().Cyan(fmt.Sprintf("%d", cache.Id))) tp.AddField(cache.Key) diff --git a/pkg/cmd/codespace/list.go b/pkg/cmd/codespace/list.go index 4775e3db5..086334e29 100644 --- a/pkg/cmd/codespace/list.go +++ b/pkg/cmd/codespace/list.go @@ -7,9 +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" ) @@ -116,25 +116,23 @@ func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Expo return a.browser.Browse(fmt.Sprintf("%s/codespaces?repository_id=%d", a.apiClient.ServerURL(), codespaces[0].Repository.ID)) } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(a.io) - if tp.IsTTY() { - tp.AddField("NAME", nil, nil) - tp.AddField("DISPLAY NAME", nil, nil) - if opts.orgName != "" { - tp.AddField("OWNER", nil, nil) - } - tp.AddField("REPOSITORY", nil, nil) - tp.AddField("BRANCH", nil, nil) - tp.AddField("STATE", nil, nil) - tp.AddField("CREATED AT", nil, nil) - - if hasNonProdVSCSTarget { - tp.AddField("VSCS TARGET", nil, nil) - } - - tp.EndRow() + headers := []string{ + "NAME", + "DISPLAY NAME", } + if opts.orgName != "" { + headers = append(headers, "OWNER") + } + headers = append(headers, + "REPOSITORY", + "BRANCH", + "STATE", + "CREATED AT", + ) + if hasNonProdVSCSTarget { + headers = append(headers, "VSCS TARGET") + } + tp := tableprinter.New(a.io, tableprinter.WithHeader(headers...)) cs := a.io.ColorScheme() for _, apiCodespace := range codespaces { @@ -158,17 +156,17 @@ func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Expo nameColor = cs.Gray } - tp.AddField(formattedName, nil, nameColor) - tp.AddField(c.DisplayName, nil, nil) + tp.AddField(formattedName, tableprinter.WithColor(nameColor)) + tp.AddField(c.DisplayName) if opts.orgName != "" { - tp.AddField(c.Owner.Login, nil, nil) + tp.AddField(c.Owner.Login) } - tp.AddField(c.Repository.FullName, nil, nil) - tp.AddField(c.branchWithGitStatus(), nil, cs.Cyan) + tp.AddField(c.Repository.FullName) + tp.AddField(c.branchWithGitStatus(), tableprinter.WithColor(cs.Cyan)) if c.PendingOperation { - tp.AddField(c.PendingOperationDisabledReason, nil, nameColor) + tp.AddField(c.PendingOperationDisabledReason, tableprinter.WithColor(nameColor)) } else { - tp.AddField(c.State, nil, stateColor) + tp.AddField(c.State, tableprinter.WithColor(stateColor)) } if tp.IsTTY() { @@ -176,13 +174,13 @@ func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Expo if err != nil { return fmt.Errorf("error parsing date %q: %w", c.CreatedAt, err) } - tp.AddField(text.FuzzyAgoAbbr(time.Now(), ct), nil, cs.Gray) + tp.AddField(text.FuzzyAgoAbbr(time.Now(), ct), tableprinter.WithColor(cs.Gray)) } else { - tp.AddField(c.CreatedAt, nil, nil) + tp.AddField(c.CreatedAt) } if hasNonProdVSCSTarget { - tp.AddField(c.VSCSTarget, nil, nil) + tp.AddField(c.VSCSTarget) } tp.EndRow() diff --git a/pkg/cmd/codespace/ports.go b/pkg/cmd/codespace/ports.go index 38688cd3a..3903da6cb 100644 --- a/pkg/cmd/codespace/ports.go +++ b/pkg/cmd/codespace/ports.go @@ -107,15 +107,7 @@ func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, export } cs := a.io.ColorScheme() - tp := tableprinter.New(a.io) - - if a.io.IsStdoutTTY() { - tp.AddField("LABEL") - tp.AddField("PORT") - tp.AddField("VISIBILITY") - tp.AddField("BROWSE URL") - tp.EndRow() - } + tp := tableprinter.New(a.io, tableprinter.WithHeader("LABEL", "PORT", "VISIBILITY", "BROWSE URL")) for _, port := range portInfos { // Convert the ACE to a friendly visibility string (private, org, public) diff --git a/pkg/cmd/codespace/view.go b/pkg/cmd/codespace/view.go index 7fe4ae313..e212f0820 100644 --- a/pkg/cmd/codespace/view.go +++ b/pkg/cmd/codespace/view.go @@ -73,7 +73,8 @@ func (a *App) ViewCodespace(ctx context.Context, opts *viewOptions) error { return opts.exporter.Write(a.io, selectedCodespace) } - tp := tableprinter.New(a.io) + //nolint:staticcheck // SA1019: Showing NAME|VALUE headers adds nothing to table. + tp := tableprinter.New(a.io, tableprinter.NoHeader) c := codespace{selectedCodespace} formattedName := formatNameForVSCSTarget(c.Name, c.VSCSTarget) diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index 4348e2cd3..c2ed18985 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -18,7 +18,6 @@ import ( "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/extensions" "github.com/cli/cli/v2/pkg/search" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -217,9 +216,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { return false } - tp := tableprinter.New(io) - tp.HeaderRow("", "REPO", "DESCRIPTION") - + tp := tableprinter.New(io, tableprinter.WithHeader("", "REPO", "DESCRIPTION")) for _, repo := range result.Items { if !strings.HasPrefix(repo.Name, "gh-") { continue @@ -270,8 +267,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { return cmdutil.NewNoResultsError("no installed extensions found") } cs := io.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - t := utils.NewTablePrinter(io) + t := tableprinter.New(io, tableprinter.WithHeader("NAME", "REPO", "VERSION")) for _, c := range cmds { // TODO consider a Repo() on Extension interface var repo string @@ -281,13 +277,13 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { } } - t.AddField(fmt.Sprintf("gh %s", c.Name()), nil, nil) - t.AddField(repo, nil, nil) + t.AddField(fmt.Sprintf("gh %s", c.Name())) + t.AddField(repo) version := displayExtensionVersion(c, c.CurrentVersion()) if c.IsPinned() { - t.AddField(version, nil, cs.Cyan) + t.AddField(version, tableprinter.WithColor(cs.Cyan)) } else { - t.AddField(version, nil, nil) + t.AddField(version) } t.EndRow() diff --git a/pkg/cmd/gist/list/list.go b/pkg/cmd/gist/list/list.go index c49f1fffd..ee9fb2539 100644 --- a/pkg/cmd/gist/list/list.go +++ b/pkg/cmd/gist/list/list.go @@ -7,11 +7,11 @@ import ( "time" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/tableprinter" "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/utils" "github.com/spf13/cobra" ) @@ -94,9 +94,7 @@ func listRun(opts *ListOptions) error { } cs := opts.IO.ColorScheme() - - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(opts.IO) + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("ID", "DESCRIPTION", "FILES", "VISIBILITY", "UPDATED")) for _, gist := range gists { fileCount := len(gist.Files) @@ -118,16 +116,14 @@ func listRun(opts *ListOptions) error { } } - gistTime := gist.UpdatedAt.Format(time.RFC3339) - if tp.IsTTY() { - gistTime = text.FuzzyAgo(time.Now(), gist.UpdatedAt) - } - - tp.AddField(gist.ID, nil, nil) - tp.AddField(text.RemoveExcessiveWhitespace(description), nil, cs.Bold) - tp.AddField(text.Pluralize(fileCount, "file"), nil, nil) - tp.AddField(visibility, nil, visColor) - tp.AddField(gistTime, nil, cs.Gray) + tp.AddField(gist.ID) + tp.AddField( + text.RemoveExcessiveWhitespace(description), + tableprinter.WithColor(cs.Bold), + ) + tp.AddField(text.Pluralize(fileCount, "file")) + tp.AddField(visibility, tableprinter.WithColor(visColor)) + tp.AddTimeField(time.Now(), gist.UpdatedAt, cs.Gray) tp.EndRow() } diff --git a/pkg/cmd/gist/list/list_test.go b/pkg/cmd/gist/list/list_test.go index 54bb52eb1..682ebe8dc 100644 --- a/pkg/cmd/gist/list/list_test.go +++ b/pkg/cmd/gist/list/list_test.go @@ -180,10 +180,11 @@ func Test_listRun(t *testing.T) { ) }, wantOut: heredoc.Doc(` - 1234567890 cool.txt 1 file public about 6 hours ago - 4567890123 1 file public about 6 hours ago - 2345678901 tea leaves thwart those who ... 2 files secret about 6 hours ago - 3456789012 short desc 11 files secret about 6 hours ago + ID DESCRIPTION FILES VISIBILITY UPDATED + 1234567890 cool.txt 1 file public about 6 hours ago + 4567890123 1 file public about 6 hours ago + 2345678901 tea leaves thwart those ... 2 files secret about 6 hours ago + 3456789012 short desc 11 files secret about 6 hours ago `), }, { @@ -214,8 +215,9 @@ func Test_listRun(t *testing.T) { ) }, wantOut: heredoc.Doc(` - 1234567890 cool.txt 1 file public about 6 hours ago - 4567890123 1 file public about 6 hours ago + ID DESCRIPTION FILES VISIBILITY UPDATED + 1234567890 cool.txt 1 file public about 6 hours ago + 4567890123 1 file public about 6 hours ago `), }, { @@ -261,8 +263,9 @@ func Test_listRun(t *testing.T) { ) }, wantOut: heredoc.Doc(` - 2345678901 tea leaves thwart those who ... 2 files secret about 6 hours ago - 3456789012 short desc 11 files secret about 6 hours ago + ID DESCRIPTION FILES VISIBILITY UPDATED + 2345678901 tea leaves thwart those ... 2 files secret about 6 hours ago + 3456789012 short desc 11 files secret about 6 hours ago `), }, { @@ -285,7 +288,10 @@ func Test_listRun(t *testing.T) { )), ) }, - wantOut: "1234567890 cool.txt 1 file public about 6 hours ago\n", + wantOut: heredoc.Doc(` + ID DESCRIPTION FILES VISIBILITY UPDATED + 1234567890 cool.txt 1 file public about 6 hours ago + `), }, { name: "nontty output", diff --git a/pkg/cmd/gpg-key/list/list.go b/pkg/cmd/gpg-key/list/list.go index 623cc63e6..1ecc88b85 100644 --- a/pkg/cmd/gpg-key/list/list.go +++ b/pkg/cmd/gpg-key/list/list.go @@ -7,10 +7,10 @@ import ( "time" "github.com/cli/cli/v2/internal/config" + "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/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -71,30 +71,20 @@ func listRun(opts *ListOptions) error { return cmdutil.NewNoResultsError("no GPG keys present in the GitHub account") } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - t := utils.NewTablePrinter(opts.IO) + t := tableprinter.New(opts.IO, tableprinter.WithHeader("EMAIL", "KEY ID", "PUBLIC KEY", "ADDED", "EXPIRES")) cs := opts.IO.ColorScheme() now := time.Now() - if t.IsTTY() { - t.AddField("EMAIL", nil, nil) - t.AddField("KEY ID", nil, nil) - t.AddField("PUBLIC KEY", nil, nil) - t.AddField("ADDED", nil, nil) - t.AddField("EXPIRES", nil, nil) - t.EndRow() - } - for _, gpgKey := range gpgKeys { - t.AddField(gpgKey.Emails.String(), nil, nil) - t.AddField(gpgKey.KeyID, nil, nil) - t.AddField(gpgKey.PublicKey, truncateMiddle, nil) + t.AddField(gpgKey.Emails.String()) + t.AddField(gpgKey.KeyID) + t.AddField(gpgKey.PublicKey, tableprinter.WithTruncate(truncateMiddle)) createdAt := gpgKey.CreatedAt.Format(time.RFC3339) if t.IsTTY() { createdAt = text.FuzzyAgoAbbr(now, gpgKey.CreatedAt) } - t.AddField(createdAt, nil, cs.Gray) + t.AddField(createdAt, tableprinter.WithColor(cs.Gray)) expiresAt := gpgKey.ExpiresAt.Format(time.RFC3339) if t.IsTTY() { @@ -104,7 +94,7 @@ func listRun(opts *ListOptions) error { expiresAt = gpgKey.ExpiresAt.Format("2006-01-02") } } - t.AddField(expiresAt, nil, cs.Gray) + t.AddField(expiresAt, tableprinter.WithColor(cs.Gray)) t.EndRow() } diff --git a/pkg/cmd/issue/develop/develop.go b/pkg/cmd/issue/develop/develop.go index 1a100c9a1..20149c6e3 100644 --- a/pkg/cmd/issue/develop/develop.go +++ b/pkg/cmd/issue/develop/develop.go @@ -199,7 +199,7 @@ func developRunList(opts *DevelopOptions, apiClient *api.Client, issueRepo ghrep func printLinkedBranches(io *iostreams.IOStreams, branches []api.LinkedBranch) { cs := io.ColorScheme() - table := tableprinter.New(io) + table := tableprinter.New(io, tableprinter.WithHeader("BRANCH", "URL")) for _, branch := range branches { table.AddField(branch.BranchName, tableprinter.WithColor(cs.ColorFromString("cyan"))) table.AddField(branch.URL) diff --git a/pkg/cmd/issue/develop/develop_test.go b/pkg/cmd/issue/develop/develop_test.go index d4f8bce2d..b834237ab 100644 --- a/pkg/cmd/issue/develop/develop_test.go +++ b/pkg/cmd/issue/develop/develop_test.go @@ -6,6 +6,7 @@ import ( "net/http" "testing" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/context" "github.com/cli/cli/v2/git" "github.com/cli/cli/v2/internal/ghrepo" @@ -245,7 +246,14 @@ func TestDevelopRun(t *testing.T) { assert.Equal(t, "REPO", inputs["name"]) })) }, - expectedOut: "\nShowing linked branches for OWNER/REPO#42\n\nfoo https://github.com/OWNER/REPO/tree/foo\nbar https://github.com/OWNER/OTHER-REPO/tree/bar\n", + expectedOut: heredoc.Doc(` + + Showing linked branches for OWNER/REPO#42 + + BRANCH URL + foo https://github.com/OWNER/REPO/tree/foo + bar https://github.com/OWNER/OTHER-REPO/tree/bar + `), }, { name: "list branches for an issue providing an issue url", diff --git a/pkg/cmd/issue/list/list_test.go b/pkg/cmd/issue/list/list_test.go index cf0624c87..e816500c2 100644 --- a/pkg/cmd/issue/list/list_test.go +++ b/pkg/cmd/issue/list/list_test.go @@ -104,9 +104,10 @@ func TestIssueList_tty(t *testing.T) { Showing 3 of 3 open issues in OWNER/REPO - #1 number won label about 1 day ago - #2 number too label about 1 month ago - #4 number fore label about 2 years ago + ID TITLE LABELS UPDATED + #1 number won label about 1 day ago + #2 number too label about 1 month ago + #4 number fore label about 2 years ago `), output.String()) assert.Equal(t, ``, output.Stderr()) } diff --git a/pkg/cmd/issue/shared/display.go b/pkg/cmd/issue/shared/display.go index efb8398ce..0c56ffd2c 100644 --- a/pkg/cmd/issue/shared/display.go +++ b/pkg/cmd/issue/shared/display.go @@ -7,33 +7,38 @@ import ( "time" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" ) func PrintIssues(io *iostreams.IOStreams, now time.Time, prefix string, totalCount int, issues []api.Issue) { cs := io.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - table := utils.NewTablePrinter(io) + isTTY := io.IsStdoutTTY() + headers := []string{"ID"} + if !isTTY { + headers = append(headers, "STATE") + } + headers = append(headers, + "TITLE", + "LABELS", + "UPDATED", + ) + table := tableprinter.New(io, tableprinter.WithHeader(headers...)) for _, issue := range issues { issueNum := strconv.Itoa(issue.Number) - if table.IsTTY() { + if isTTY { issueNum = "#" + issueNum } issueNum = prefix + issueNum - table.AddField(issueNum, nil, cs.ColorFromString(prShared.ColorForIssueState(issue))) - if !table.IsTTY() { - table.AddField(issue.State, nil, nil) - } - table.AddField(text.RemoveExcessiveWhitespace(issue.Title), nil, nil) - table.AddField(issueLabelList(&issue, cs, table.IsTTY()), nil, nil) - if table.IsTTY() { - table.AddField(text.FuzzyAgo(now, issue.UpdatedAt), nil, cs.Gray) - } else { - table.AddField(issue.UpdatedAt.String(), nil, nil) + table.AddField(issueNum, tableprinter.WithColor(cs.ColorFromString(prShared.ColorForIssueState(issue)))) + if !isTTY { + table.AddField(issue.State) } + table.AddField(text.RemoveExcessiveWhitespace(issue.Title)) + table.AddField(issueLabelList(&issue, cs, isTTY)) + table.AddTimeField(now, issue.UpdatedAt, cs.Gray) table.EndRow() } _ = table.Render() diff --git a/pkg/cmd/label/list.go b/pkg/cmd/label/list.go index 5ad056115..7b4c95ed1 100644 --- a/pkg/cmd/label/list.go +++ b/pkg/cmd/label/list.go @@ -7,10 +7,10 @@ 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/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -134,13 +134,12 @@ func listRun(opts *listOptions) error { func printLabels(io *iostreams.IOStreams, labels []label) error { cs := io.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - table := utils.NewTablePrinter(io) + table := tableprinter.New(io, tableprinter.WithHeader("NAME", "DESCRIPTION", "COLOR")) for _, label := range labels { - table.AddField(label.Name, nil, cs.ColorFromRGB(label.Color)) - table.AddField(label.Description, text.Truncate, nil) - table.AddField("#"+label.Color, nil, nil) + table.AddField(label.Name, tableprinter.WithColor(cs.ColorFromRGB(label.Color))) + table.AddField(label.Description) + table.AddField("#" + label.Color) table.EndRow() } diff --git a/pkg/cmd/label/list_test.go b/pkg/cmd/label/list_test.go index 7e7a9a93d..37f458439 100644 --- a/pkg/cmd/label/list_test.go +++ b/pkg/cmd/label/list_test.go @@ -215,7 +215,14 @@ func TestListRun(t *testing.T) { ), ) }, - wantStdout: "\nShowing 2 of 2 labels in OWNER/REPO\n\nbug This is a bug label #d73a4a\ndocs This is a docs label #ffa8da\n", + wantStdout: heredoc.Doc(` + + Showing 2 of 2 labels in OWNER/REPO + + NAME DESCRIPTION COLOR + bug This is a bug label #d73a4a + docs This is a docs label #ffa8da + `), }, { name: "lists labels notty", @@ -343,6 +350,7 @@ func TestListRun(t *testing.T) { Showing 2 of 2 labels in OWNER/REPO + NAME DESCRIPTION COLOR bug This is a bug label #d73a4a docs This is a docs label #ffa8da `), diff --git a/pkg/cmd/org/list/list.go b/pkg/cmd/org/list/list.go index 54e5daf5a..888d76c74 100644 --- a/pkg/cmd/org/list/list.go +++ b/pkg/cmd/org/list/list.go @@ -6,7 +6,6 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/config" - "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/pkg/iostreams" @@ -85,16 +84,8 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.Out, "\n%s\n\n", header) } - table := tableprinter.New(opts.IO) - for _, org := range listResult.Organizations { - table.AddField(org.Login) - table.EndRow() - } - - err = table.Render() - if err != nil { - return err + fmt.Fprintln(opts.IO.Out, org.Login) } return nil diff --git a/pkg/cmd/pr/checks/checks_test.go b/pkg/cmd/pr/checks/checks_test.go index dcab36117..cc21043ba 100644 --- a/pkg/cmd/pr/checks/checks_test.go +++ b/pkg/cmd/pr/checks/checks_test.go @@ -7,6 +7,7 @@ import ( "testing" "time" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" fd "github.com/cli/cli/v2/internal/featuredetection" @@ -167,7 +168,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someFailing.json"), ) }, - wantOut: "Some checks were not successful\n0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + Some checks were not successful + 0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks + + NAME DESCRIPTION ELAPSED URL + X sad tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + * slow tests 1m26s sweet link + `), wantErr: "SilentError", }, { @@ -179,7 +188,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someCancelled.json"), ) }, - wantOut: "Some checks were cancelled\n1 cancelled, 0 failing, 2 successful, 0 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n- sad tests 1m26s sweet link\n✓ awesome tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + Some checks were cancelled + 1 cancelled, 0 failing, 2 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ cool tests 1m26s sweet link + - sad tests 1m26s sweet link + ✓ awesome tests 1m26s sweet link + `), wantErr: "", }, { @@ -191,7 +208,16 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/somePending.json"), ) }, - wantOut: "Some checks are still pending\n1 cancelled, 0 failing, 2 successful, 0 skipped, and 1 pending checks\n\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n* slow tests 1m26s sweet link\n- sad tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + Some checks are still pending + 1 cancelled, 0 failing, 2 successful, 0 skipped, and 1 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + * slow tests 1m26s sweet link + - sad tests 1m26s sweet link + `), wantErr: "PendingError", }, { @@ -203,7 +229,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/allPassing.json"), ) }, - wantOut: "All checks were successful\n0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ awesome tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + `), wantErr: "", }, { @@ -216,7 +250,22 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/allPassing.json"), ) }, - wantOut: "\x1b[?1049hAll checks were successful\n0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n\x1b[?1049lAll checks were successful\n0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: heredoc.Docf(` + %[1]s[?1049hAll checks were successful + 0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ awesome tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + %[1]s[?1049lAll checks were successful + 0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ awesome tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + `, "\x1b"), wantErr: "", }, { @@ -230,7 +279,24 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someFailing.json"), ) }, - wantOut: "\x1b[?1049h\x1b[0;0H\x1b[JRefreshing checks status every 0 seconds. Press Ctrl+C to quit.\n\nSome checks were not successful\n0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n\x1b[?1049lSome checks were not successful\n0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks\n\nX sad tests 1m26s sweet link\n✓ cool tests 1m26s sweet link\n* slow tests 1m26s sweet link\n", + wantOut: heredoc.Docf(` + %[1]s[?1049h%[1]s[0;0H%[1]s[JRefreshing checks status every 0 seconds. Press Ctrl+C to quit. + + Some checks were not successful + 0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks + + NAME DESCRIPTION ELAPSED URL + X sad tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + * slow tests 1m26s sweet link + %[1]s[?1049lSome checks were not successful + 0 cancelled, 1 failing, 1 successful, 0 skipped, and 1 pending checks + + NAME DESCRIPTION ELAPSED URL + X sad tests 1m26s sweet link + ✓ cool tests 1m26s sweet link + * slow tests 1m26s sweet link + `, "\x1b"), wantErr: "SilentError", }, { @@ -242,7 +308,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withStatuses.json"), ) }, - wantOut: "Some checks were not successful\n0 cancelled, 1 failing, 2 successful, 0 skipped, and 0 pending checks\n\nX a status sweet link\n✓ cool tests 1m26s sweet link\n✓ rad tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + Some checks were not successful + 0 cancelled, 1 failing, 2 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + X a status sweet link + ✓ cool tests 1m26s sweet link + ✓ rad tests 1m26s sweet link + `), wantErr: "SilentError", }, { @@ -320,7 +394,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/someSkipping.json"), ) }, - wantOut: "All checks were successful\n0 cancelled, 0 failing, 1 successful, 2 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n- rad tests 1m26s sweet link\n- skip tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 1 successful, 2 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ cool tests 1m26s sweet link + - rad tests 1m26s sweet link + - skip tests 1m26s sweet link + `), wantErr: "", }, { @@ -344,7 +426,13 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/onlyRequired.json"), ) }, - wantOut: "All checks were successful\n0 cancelled, 0 failing, 1 successful, 0 skipped, and 0 pending checks\n\n✓ cool tests 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 1 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ cool tests 1m26s sweet link + `), wantErr: "", }, { @@ -393,7 +481,15 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withDescriptions.json"), ) }, - wantOut: "All checks were successful\n0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks\n\n✓ awesome tests awesome description 1m26s sweet link\n✓ cool tests cool description 1m26s sweet link\n✓ rad tests rad description 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 3 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ awesome tests awesome description 1m26s sweet link + ✓ cool tests cool description 1m26s sweet link + ✓ rad tests rad description 1m26s sweet link + `), wantErr: "", }, { @@ -416,7 +512,14 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withEvents.json"), ) }, - wantOut: "All checks were successful\n0 cancelled, 0 failing, 2 successful, 0 skipped, and 0 pending checks\n\n✓ tests/cool tests (pull_request) cool description 1m26s sweet link\n✓ tests/cool tests (push) cool description 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 2 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ tests/cool tests (pull_request) cool description 1m26s sweet link + ✓ tests/cool tests (push) cool description 1m26s sweet link + `), wantErr: "", }, { @@ -429,7 +532,13 @@ func Test_checksRun(t *testing.T) { httpmock.FileResponse("./fixtures/withoutEvents.json"), ) }, - wantOut: "All checks were successful\n0 cancelled, 0 failing, 1 successful, 0 skipped, and 0 pending checks\n\n✓ tests/cool tests cool description 1m26s sweet link\n", + wantOut: heredoc.Doc(` + All checks were successful + 0 cancelled, 0 failing, 1 successful, 0 skipped, and 0 pending checks + + NAME DESCRIPTION ELAPSED URL + ✓ tests/cool tests cool description 1m26s sweet link + `), wantErr: "", }, { diff --git a/pkg/cmd/pr/checks/output.go b/pkg/cmd/pr/checks/output.go index 9efee29cf..5d2f080c6 100644 --- a/pkg/cmd/pr/checks/output.go +++ b/pkg/cmd/pr/checks/output.go @@ -92,7 +92,14 @@ func printSummary(io *iostreams.IOStreams, counts checkCounts) { } func printTable(io *iostreams.IOStreams, checks []check) error { - tp := tableprinter.New(io) + var headers []string + if io.IsStdoutTTY() { + headers = []string{"", "NAME", "DESCRIPTION", "ELAPSED", "URL"} + } else { + headers = []string{"NAME", "STATUS", "ELAPSED", "URL", "DESCRIPTION"} + } + + tp := tableprinter.New(io, tableprinter.WithHeader(headers...)) sort.Slice(checks, func(i, j int) bool { b0 := checks[i].Bucket diff --git a/pkg/cmd/pr/list/list.go b/pkg/cmd/pr/list/list.go index cea7c2b19..e900a5d7b 100644 --- a/pkg/cmd/pr/list/list.go +++ b/pkg/cmd/pr/list/list.go @@ -11,11 +11,11 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/pr/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -199,24 +199,35 @@ func listRun(opts *ListOptions) error { } cs := opts.IO.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - table := utils.NewTablePrinter(opts.IO) + isTTY := opts.IO.IsStdoutTTY() + + headers := []string{ + "ID", + "TITLE", + "BRANCH", + } + if !isTTY { + headers = append(headers, "STATE") + } + headers = append(headers, "CREATED AT") + + table := tableprinter.New(opts.IO, tableprinter.WithHeader(headers...)) for _, pr := range listResult.PullRequests { prNum := strconv.Itoa(pr.Number) - if table.IsTTY() { + if isTTY { prNum = "#" + prNum } - table.AddField(prNum, nil, cs.ColorFromString(shared.ColorForPRState(pr))) - table.AddField(text.RemoveExcessiveWhitespace(pr.Title), nil, nil) - table.AddField(pr.HeadLabel(), nil, cs.Cyan) - if !table.IsTTY() { - table.AddField(prStateWithDraft(&pr), nil, nil) + table.AddField(prNum, tableprinter.WithColor(cs.ColorFromString(shared.ColorForPRState(pr)))) + table.AddField(text.RemoveExcessiveWhitespace(pr.Title)) + table.AddField(pr.HeadLabel(), tableprinter.WithColor(cs.Cyan)) + if !isTTY { + table.AddField(prStateWithDraft(&pr)) } - if table.IsTTY() { - table.AddField(text.FuzzyAgo(opts.Now(), pr.CreatedAt), nil, cs.Gray) + if isTTY { + table.AddField(text.FuzzyAgo(opts.Now(), pr.CreatedAt), tableprinter.WithColor(cs.Gray)) } else { - table.AddField(pr.CreatedAt.String(), nil, nil) + table.AddField(pr.CreatedAt.String()) } table.EndRow() } diff --git a/pkg/cmd/pr/list/list_test.go b/pkg/cmd/pr/list/list_test.go index bc661f104..d4a658a81 100644 --- a/pkg/cmd/pr/list/list_test.go +++ b/pkg/cmd/pr/list/list_test.go @@ -84,6 +84,7 @@ func TestPRList(t *testing.T) { Showing 3 of 3 open pull requests in OWNER/REPO + ID TITLE BRANCH CREATED AT #32 New feature feature about 3 hours ago #29 Fixed bad bug hubot:bug-fix about 1 month ago #28 Improve documentation docs about 2 years ago diff --git a/pkg/cmd/project/field-list/field_list.go b/pkg/cmd/project/field-list/field_list.go index 152d90fcd..3e36e2a86 100644 --- a/pkg/cmd/project/field-list/field_list.go +++ b/pkg/cmd/project/field-list/field_list.go @@ -52,7 +52,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C opts.number = int32(num) } - t := tableprinter.New(f.IOStreams) + t := tableprinter.New(f.IOStreams, tableprinter.WithHeader("Name", "Data type", "ID")) config := listConfig{ io: f.IOStreams, tp: t, @@ -109,8 +109,6 @@ func printResults(config listConfig, fields []queries.ProjectField, login string 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()) diff --git a/pkg/cmd/project/field-list/field_list_test.go b/pkg/cmd/project/field-list/field_list_test.go index c6c2f97c6..85e67451f 100644 --- a/pkg/cmd/project/field-list/field_list_test.go +++ b/pkg/cmd/project/field-list/field_list_test.go @@ -163,7 +163,8 @@ func TestRunList_User(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "monalisa", @@ -256,7 +257,8 @@ func TestRunList_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "github", @@ -339,7 +341,8 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "@me", @@ -406,7 +409,8 @@ func TestRunList_Empty(t *testing.T) { ios, _, _, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "@me", diff --git a/pkg/cmd/project/item-list/item_list.go b/pkg/cmd/project/item-list/item_list.go index 4acc95dcb..f2e9bf8a6 100644 --- a/pkg/cmd/project/item-list/item_list.go +++ b/pkg/cmd/project/item-list/item_list.go @@ -52,7 +52,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C opts.number = int32(num) } - t := tableprinter.New(f.IOStreams) + t := tableprinter.New(f.IOStreams, tableprinter.WithHeader("Type", "Title", "Number", "Repository", "ID")) config := listConfig{ io: f.IOStreams, tp: t, @@ -108,8 +108,6 @@ func printResults(config listConfig, items []queries.ProjectItem, login string) 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()) diff --git a/pkg/cmd/project/item-list/item_list_test.go b/pkg/cmd/project/item-list/item_list_test.go index 490473691..c36dfc589 100644 --- a/pkg/cmd/project/item-list/item_list_test.go +++ b/pkg/cmd/project/item-list/item_list_test.go @@ -178,7 +178,8 @@ func TestRunList_User(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "monalisa", @@ -285,7 +286,8 @@ func TestRunList_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "github", @@ -382,7 +384,8 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "@me", diff --git a/pkg/cmd/project/list/list.go b/pkg/cmd/project/list/list.go index c92434522..d3168d7eb 100644 --- a/pkg/cmd/project/list/list.go +++ b/pkg/cmd/project/list/list.go @@ -52,7 +52,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C URLOpener := func(url string) error { return f.Browser.Browse(url) } - t := tableprinter.New(f.IOStreams) + t := tableprinter.New(f.IOStreams, tableprinter.WithHeader("Number", "Title", "State", "ID")) config := listConfig{ tp: t, client: client, @@ -157,8 +157,6 @@ func printResults(config listConfig, projects []queries.Project, owner string) e 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) diff --git a/pkg/cmd/project/list/list_test.go b/pkg/cmd/project/list/list_test.go index 492d224b0..bafdf8e93 100644 --- a/pkg/cmd/project/list/list_test.go +++ b/pkg/cmd/project/list/list_test.go @@ -154,7 +154,8 @@ func TestRunList(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ owner: "monalisa", }, @@ -225,7 +226,8 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ owner: "@me", }, @@ -296,7 +298,8 @@ func TestRunListViewer(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{}, client: client, io: ios, @@ -374,7 +377,8 @@ func TestRunListOrg(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ owner: "github", }, @@ -428,7 +432,8 @@ func TestRunListEmpty(t *testing.T) { ios, _, _, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{}, client: client, io: ios, @@ -504,7 +509,8 @@ func TestRunListWithClosed(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - tp: tableprinter.New(ios), + //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. + tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ owner: "monalisa", closed: true, diff --git a/pkg/cmd/release/list/list.go b/pkg/cmd/release/list/list.go index f2258a933..e6efc6062 100644 --- a/pkg/cmd/release/list/list.go +++ b/pkg/cmd/release/list/list.go @@ -78,9 +78,8 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err) } - table := tableprinter.New(opts.IO) + table := tableprinter.New(opts.IO, tableprinter.WithHeader("Title", "Type", "Tag name", "Published")) iofmt := opts.IO.ColorScheme() - table.HeaderRow("Title", "Type", "Tag name", "Published") for _, rel := range releases { title := text.RemoveExcessiveWhitespace(rel.Name) if title == "" { diff --git a/pkg/cmd/release/view/view.go b/pkg/cmd/release/view/view.go index 1f6fb6a34..a32482e65 100644 --- a/pkg/cmd/release/view/view.go +++ b/pkg/cmd/release/view/view.go @@ -10,12 +10,12 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/release/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/utils" "github.com/spf13/cobra" ) @@ -154,11 +154,11 @@ func renderReleaseTTY(io *iostreams.IOStreams, release *shared.Release) error { if len(release.Assets) > 0 { fmt.Fprintf(w, "%s\n", iofmt.Bold("Assets")) - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - table := utils.NewTablePrinter(io) + //nolint:staticcheck // SA1019: Showing NAME|SIZE headers adds nothing to table. + table := tableprinter.New(io, tableprinter.NoHeader) for _, a := range release.Assets { - table.AddField(a.Name, nil, nil) - table.AddField(humanFileSize(a.Size), nil, nil) + table.AddField(a.Name) + table.AddField(humanFileSize(a.Size)) table.EndRow() } err := table.Render() diff --git a/pkg/cmd/repo/deploy-key/list/list.go b/pkg/cmd/repo/deploy-key/list/list.go index 537599fe5..3df78212c 100644 --- a/pkg/cmd/repo/deploy-key/list/list.go +++ b/pkg/cmd/repo/deploy-key/list/list.go @@ -7,10 +7,10 @@ import ( "time" "github.com/cli/cli/v2/internal/ghrepo" + "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/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -77,28 +77,28 @@ func listRun(opts *ListOptions) error { return opts.Exporter.Write(opts.IO, deployKeys) } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - t := utils.NewTablePrinter(opts.IO) + t := tableprinter.New(opts.IO, tableprinter.WithHeader("ID", "TITLE", "TYPE", "KEY", "CREATED AT")) cs := opts.IO.ColorScheme() now := time.Now() for _, deployKey := range deployKeys { sshID := strconv.Itoa(deployKey.ID) - t.AddField(sshID, nil, nil) - t.AddField(deployKey.Title, nil, nil) + t.AddField(sshID) + t.AddField(deployKey.Title) sshType := "read-only" if !deployKey.ReadOnly { sshType = "read-write" } - t.AddField(sshType, nil, nil) - t.AddField(deployKey.Key, truncateMiddle, nil) + t.AddField(sshType) + t.AddField(deployKey.Key, tableprinter.WithTruncate(truncateMiddle)) + // TODO: Modify AddTimeField, add AddAbbrTimeField, or something else. createdAt := deployKey.CreatedAt.Format(time.RFC3339) if t.IsTTY() { createdAt = text.FuzzyAgoAbbr(now, deployKey.CreatedAt) } - t.AddField(createdAt, nil, cs.Gray) + t.AddField(createdAt, tableprinter.WithColor(cs.Gray)) t.EndRow() } diff --git a/pkg/cmd/repo/deploy-key/list/list_test.go b/pkg/cmd/repo/deploy-key/list/list_test.go index 0cefd0eb2..4e5a57f11 100644 --- a/pkg/cmd/repo/deploy-key/list/list_test.go +++ b/pkg/cmd/repo/deploy-key/list/list_test.go @@ -48,6 +48,7 @@ func TestListRun(t *testing.T) { ) }, wantStdout: heredoc.Doc(` + ID TITLE TYPE KEY CREATED AT 1234 Mac read-only ssh-rsa AAAABbBB123 1d 5678 hubot@Windows read-write ssh-rsa EEEEEEEK247 1d `), diff --git a/pkg/cmd/repo/list/list.go b/pkg/cmd/repo/list/list.go index 07729b481..f91b847a7 100644 --- a/pkg/cmd/repo/list/list.go +++ b/pkg/cmd/repo/list/list.go @@ -12,10 +12,10 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/config" fd "github.com/cli/cli/v2/internal/featuredetection" + "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/pkg/iostreams" - "github.com/cli/cli/v2/utils" ) type ListOptions struct { @@ -176,9 +176,9 @@ func listRun(opts *ListOptions) error { } cs := opts.IO.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(opts.IO) + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("NAME", "DESCRIPTION", "INFO", "UPDATED")) + totalMatchCount := len(listResult.Repositories) for _, repo := range listResult.Repositories { info := repoInfo(repo) infoColor := cs.Gray @@ -192,13 +192,13 @@ func listRun(opts *ListOptions) error { t = &repo.CreatedAt } - tp.AddField(repo.NameWithOwner, nil, cs.Bold) - tp.AddField(text.RemoveExcessiveWhitespace(repo.Description), nil, nil) - tp.AddField(info, nil, infoColor) + tp.AddField(repo.NameWithOwner, tableprinter.WithColor(cs.Bold)) + tp.AddField(text.RemoveExcessiveWhitespace(repo.Description)) + tp.AddField(info, tableprinter.WithColor(infoColor)) if tp.IsTTY() { - tp.AddField(text.FuzzyAgoAbbr(opts.Now(), *t), nil, cs.Gray) + tp.AddField(text.FuzzyAgoAbbr(opts.Now(), *t), tableprinter.WithColor(cs.Gray)) } else { - tp.AddField(t.Format(time.RFC3339), nil, nil) + tp.AddField(t.Format(time.RFC3339)) } tp.EndRow() } @@ -208,11 +208,15 @@ func listRun(opts *ListOptions) error { } if opts.IO.IsStdoutTTY() { hasFilters := filter.Visibility != "" || filter.Fork || filter.Source || filter.Language != "" || len(filter.Topic) > 0 - title := listHeader(listResult.Owner, len(listResult.Repositories), listResult.TotalCount, hasFilters) + title := listHeader(listResult.Owner, totalMatchCount, listResult.TotalCount, hasFilters) fmt.Fprintf(opts.IO.Out, "\n%s\n\n", title) } - return tp.Render() + if totalMatchCount > 0 { + return tp.Render() + } + + return nil } func listHeader(owner string, matchCount, totalMatchCount int, hasFilters bool) string { diff --git a/pkg/cmd/repo/list/list_test.go b/pkg/cmd/repo/list/list_test.go index 3a02cbb22..55e4da83d 100644 --- a/pkg/cmd/repo/list/list_test.go +++ b/pkg/cmd/repo/list/list_test.go @@ -385,6 +385,7 @@ func TestRepoList_tty(t *testing.T) { Showing 3 of 3 repositories in @octocat + NAME DESCRIPTION INFO UPDATED octocat/hello-world My first repository public 8h octocat/cli GitHub CLI public, fork 8h octocat/testing private 7d diff --git a/pkg/cmd/ruleset/list/list.go b/pkg/cmd/ruleset/list/list.go index c88f2d1e0..a4b52073d 100644 --- a/pkg/cmd/ruleset/list/list.go +++ b/pkg/cmd/ruleset/list/list.go @@ -161,8 +161,7 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.Out, "\nShowing %d of %d rulesets in %s\n\n", len(result.Rulesets), result.TotalCount, inMsg) } - tp := tableprinter.New(opts.IO) - tp.HeaderRow("ID", "NAME", "SOURCE", "STATUS", "RULES") + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("ID", "NAME", "SOURCE", "STATUS", "RULES")) for _, rs := range result.Rulesets { tp.AddField(strconv.Itoa(rs.DatabaseId), tableprinter.WithColor(cs.Cyan)) diff --git a/pkg/cmd/run/list/list.go b/pkg/cmd/run/list/list.go index 394af5dcb..39e14442a 100644 --- a/pkg/cmd/run/list/list.go +++ b/pkg/cmd/run/list/list.go @@ -7,12 +7,12 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "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/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -138,41 +138,28 @@ func listRun(opts *ListOptions) error { return opts.Exporter.Write(opts.IO, runs) } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(opts.IO) + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("STATUS", "TITLE", "WORKFLOW", "BRANCH", "EVENT", "ID", "ELAPSED", "AGE")) cs := opts.IO.ColorScheme() - if tp.IsTTY() { - tp.AddField("STATUS", nil, nil) - tp.AddField("TITLE", nil, nil) - tp.AddField("WORKFLOW", nil, nil) - tp.AddField("BRANCH", nil, nil) - tp.AddField("EVENT", nil, nil) - tp.AddField("ID", nil, nil) - tp.AddField("ELAPSED", nil, nil) - tp.AddField("AGE", nil, nil) - tp.EndRow() - } - for _, run := range runs { if tp.IsTTY() { symbol, symbolColor := shared.Symbol(cs, run.Status, run.Conclusion) - tp.AddField(symbol, nil, symbolColor) + tp.AddField(symbol, tableprinter.WithColor(symbolColor)) } else { - tp.AddField(string(run.Status), nil, nil) - tp.AddField(string(run.Conclusion), nil, nil) + tp.AddField(string(run.Status)) + tp.AddField(string(run.Conclusion)) } - tp.AddField(run.Title(), nil, cs.Bold) + tp.AddField(run.Title(), tableprinter.WithColor(cs.Bold)) - tp.AddField(run.WorkflowName(), nil, nil) - tp.AddField(run.HeadBranch, nil, cs.Bold) - tp.AddField(string(run.Event), nil, nil) - tp.AddField(fmt.Sprintf("%d", run.ID), nil, cs.Cyan) + tp.AddField(run.WorkflowName()) + tp.AddField(run.HeadBranch, tableprinter.WithColor(cs.Bold)) + tp.AddField(string(run.Event)) + tp.AddField(fmt.Sprintf("%d", run.ID), tableprinter.WithColor(cs.Cyan)) - tp.AddField(run.Duration(opts.now).String(), nil, nil) - tp.AddField(text.FuzzyAgoAbbr(time.Now(), run.StartedTime()), nil, nil) + tp.AddField(run.Duration(opts.now).String()) + tp.AddField(text.FuzzyAgoAbbr(time.Now(), run.StartedTime())) tp.EndRow() } diff --git a/pkg/cmd/search/commits/commits.go b/pkg/cmd/search/commits/commits.go index 7f74c51d8..698e933bb 100644 --- a/pkg/cmd/search/commits/commits.go +++ b/pkg/cmd/search/commits/commits.go @@ -155,8 +155,7 @@ func displayResults(io *iostreams.IOStreams, now time.Time, results search.Commi now = time.Now() } cs := io.ColorScheme() - tp := tableprinter.New(io) - tp.HeaderRow("Repo", "SHA", "Message", "Author", "Created") + tp := tableprinter.New(io, tableprinter.WithHeader("Repo", "SHA", "Message", "Author", "Created")) for _, commit := range results.Items { tp.AddField(commit.Repo.FullName) tp.AddField(commit.Sha) diff --git a/pkg/cmd/search/repos/repos.go b/pkg/cmd/search/repos/repos.go index 759b3d120..bf88edbe8 100644 --- a/pkg/cmd/search/repos/repos.go +++ b/pkg/cmd/search/repos/repos.go @@ -158,8 +158,7 @@ func displayResults(io *iostreams.IOStreams, now time.Time, results search.Repos now = time.Now() } cs := io.ColorScheme() - tp := tableprinter.New(io) - tp.HeaderRow("Name", "Description", "Visibility", "Updated") + tp := tableprinter.New(io, tableprinter.WithHeader("Name", "Description", "Visibility", "Updated")) for _, repo := range results.Items { tags := []string{visibilityLabel(repo)} if repo.IsFork { diff --git a/pkg/cmd/search/shared/shared.go b/pkg/cmd/search/shared/shared.go index 141ab5421..f0a346fc8 100644 --- a/pkg/cmd/search/shared/shared.go +++ b/pkg/cmd/search/shared/shared.go @@ -95,14 +95,16 @@ func displayIssueResults(io *iostreams.IOStreams, now time.Time, et EntityType, if now.IsZero() { now = time.Now() } - isTTY := io.IsStdoutTTY() - cs := io.ColorScheme() - tp := tableprinter.New(io) + + var headers []string if et == Both { - tp.HeaderRow("Kind", "Repo", "ID", "Title", "Labels", "Updated") + headers = []string{"Kind", "Repo", "ID", "Title", "Labels", "Updated"} } else { - tp.HeaderRow("Repo", "ID", "Title", "Labels", "Updated") + headers = []string{"Repo", "ID", "Title", "Labels", "Updated"} } + + cs := io.ColorScheme() + tp := tableprinter.New(io, tableprinter.WithHeader(headers...)) for _, issue := range results.Items { if et == Both { kind := "issue" @@ -115,7 +117,7 @@ func displayIssueResults(io *iostreams.IOStreams, now time.Time, et EntityType, name := comp[len(comp)-2:] tp.AddField(strings.Join(name, "/")) issueNum := strconv.Itoa(issue.Number) - if isTTY { + if tp.IsTTY() { issueNum = "#" + issueNum } if issue.IsPullRequest() { @@ -125,16 +127,16 @@ func displayIssueResults(io *iostreams.IOStreams, now time.Time, et EntityType, color := tableprinter.WithColor(cs.ColorFromString(colorForIssueState(issue.State(), issue.StateReason))) tp.AddField(issueNum, color) } - if !isTTY { + if !tp.IsTTY() { tp.AddField(issue.State()) } tp.AddField(text.RemoveExcessiveWhitespace(issue.Title)) - tp.AddField(listIssueLabels(&issue, cs, isTTY)) + tp.AddField(listIssueLabels(&issue, cs, tp.IsTTY())) tp.AddTimeField(now, issue.UpdatedAt, cs.Gray) tp.EndRow() } - if isTTY { + if tp.IsTTY() { var header string switch et { case Both: diff --git a/pkg/cmd/secret/list/list.go b/pkg/cmd/secret/list/list.go index dae097fce..53582412d 100644 --- a/pkg/cmd/secret/list/list.go +++ b/pkg/cmd/secret/list/list.go @@ -158,12 +158,14 @@ func listRun(opts *ListOptions) error { return opts.Exporter.Write(opts.IO, secrets) } - table := tableprinter.New(opts.IO) + var headers []string if secretEntity == shared.Organization || secretEntity == shared.User { - table.HeaderRow("Name", "Updated", "Visibility") + headers = []string{"Name", "Updated", "Visibility"} } else { - table.HeaderRow("Name", "Updated") + headers = []string{"Name", "Updated"} } + + table := tableprinter.New(opts.IO, tableprinter.WithHeader(headers...)) for _, secret := range secrets { table.AddField(secret.Name) table.AddTimeField(opts.Now(), secret.UpdatedAt, nil) diff --git a/pkg/cmd/ssh-key/list/list.go b/pkg/cmd/ssh-key/list/list.go index 12ee6d635..828fc0b31 100644 --- a/pkg/cmd/ssh-key/list/list.go +++ b/pkg/cmd/ssh-key/list/list.go @@ -10,11 +10,11 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/config" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/ssh-key/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/cli/v2/utils" "github.com/spf13/cobra" ) @@ -79,36 +79,26 @@ func listRun(opts *ListOptions) error { return cmdutil.NewNoResultsError("no SSH keys present in the GitHub account") } - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - t := utils.NewTablePrinter(opts.IO) + t := tableprinter.New(opts.IO, tableprinter.WithHeader("TITLE", "ID", "KEY", "TYPE", "ADDED")) cs := opts.IO.ColorScheme() now := time.Now() - if t.IsTTY() { - t.AddField("TITLE", nil, nil) - t.AddField("ID", nil, nil) - t.AddField("KEY", nil, nil) - t.AddField("TYPE", nil, nil) - t.AddField("ADDED", nil, nil) - t.EndRow() - } - for _, sshKey := range sshKeys { id := strconv.Itoa(sshKey.ID) createdAt := sshKey.CreatedAt.Format(time.RFC3339) if t.IsTTY() { - t.AddField(sshKey.Title, nil, nil) - t.AddField(id, nil, nil) - t.AddField(sshKey.Key, truncateMiddle, nil) - t.AddField(sshKey.Type, nil, nil) - t.AddField(text.FuzzyAgoAbbr(now, sshKey.CreatedAt), nil, cs.Gray) + t.AddField(sshKey.Title) + t.AddField(id) + t.AddField(sshKey.Key, tableprinter.WithTruncate(truncateMiddle)) + t.AddField(sshKey.Type) + t.AddField(text.FuzzyAgoAbbr(now, sshKey.CreatedAt), tableprinter.WithColor(cs.Gray)) } else { - t.AddField(sshKey.Title, nil, nil) - t.AddField(sshKey.Key, nil, nil) - t.AddField(createdAt, nil, nil) - t.AddField(id, nil, nil) - t.AddField(sshKey.Type, nil, nil) + t.AddField(sshKey.Title) + t.AddField(sshKey.Key) + t.AddField(createdAt) + t.AddField(id) + t.AddField(sshKey.Type) } t.EndRow() diff --git a/pkg/cmd/status/status.go b/pkg/cmd/status/status.go index 4e6bd3781..0ed7dd3a7 100644 --- a/pkg/cmd/status/status.go +++ b/pkg/cmd/status/status.go @@ -15,11 +15,11 @@ import ( "github.com/MakeNowJust/heredoc" "github.com/charmbracelet/lipgloss" "github.com/cli/cli/v2/api" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/pkg/cmd/factory" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" "github.com/cli/cli/v2/pkg/set" - "github.com/cli/cli/v2/utils" ghAPI "github.com/cli/go-gh/v2/pkg/api" "github.com/spf13/cobra" "golang.org/x/sync/errgroup" @@ -677,32 +677,27 @@ func statusRun(opts *StatusOptions) error { section := func(header string, items []StatusItem, width, rowLimit int) (string, error) { tableOut := &bytes.Buffer{} fmt.Fprintln(tableOut, cs.Bold(header)) - //nolint:staticcheck // SA1019: utils.NewTablePrinterWithOptions is deprecated: use internal/tableprinter - tp := utils.NewTablePrinterWithOptions(opts.IO, utils.TablePrinterOptions{ - IsTTY: opts.IO.IsStdoutTTY(), - MaxWidth: width, - Out: tableOut, - }) if len(items) == 0 { - tp.AddField("Nothing here ^_^", nil, nil) - tp.EndRow() + fmt.Fprintln(tableOut, "Nothing here ^_^") } else { + //nolint:staticcheck // SA1019: Headers distract from numerous nested tables. + tp := tableprinter.NewWithWriter(tableOut, opts.IO.IsStdoutTTY(), width, cs, tableprinter.NoHeader) for i, si := range items { if i == rowLimit { break } - tp.AddField(si.Identifier, nil, idStyle) + tp.AddField(si.Identifier, tableprinter.WithColor(idStyle), tableprinter.WithTruncate(nil)) if si.Reason != "" { - tp.AddField(si.Reason, nil, nil) + tp.AddField(si.Reason) } - tp.AddField(si.Preview(), nil, nil) + tp.AddField(si.Preview()) tp.EndRow() } - } - err := tp.Render() - if err != nil { - return "", err + err := tp.Render() + if err != nil { + return "", err + } } return tableOut.String(), nil diff --git a/pkg/cmd/variable/list/list.go b/pkg/cmd/variable/list/list.go index 7925b0f22..86dd99500 100644 --- a/pkg/cmd/variable/list/list.go +++ b/pkg/cmd/variable/list/list.go @@ -124,12 +124,14 @@ func listRun(opts *ListOptions) error { fmt.Fprintf(opts.IO.ErrOut, "failed to start pager: %v\n", err) } - table := tableprinter.New(opts.IO) + var headers []string if variableEntity == shared.Organization { - table.HeaderRow("Name", "Value", "Updated", "Visibility") + headers = []string{"Name", "Value", "Updated", "Visibility"} } else { - table.HeaderRow("Name", "Value", "Updated") + headers = []string{"Name", "Value", "Updated"} } + + table := tableprinter.New(opts.IO, tableprinter.WithHeader(headers...)) for _, variable := range variables { table.AddField(variable.Name) table.AddField(variable.Value) diff --git a/pkg/cmd/workflow/list/list.go b/pkg/cmd/workflow/list/list.go index acfbe7d55..efedc731e 100644 --- a/pkg/cmd/workflow/list/list.go +++ b/pkg/cmd/workflow/list/list.go @@ -111,8 +111,7 @@ func listRun(opts *ListOptions) error { } cs := opts.IO.ColorScheme() - tp := tableprinter.New(opts.IO) - tp.HeaderRow("Name", "State", "ID") + tp := tableprinter.New(opts.IO, tableprinter.WithHeader("Name", "State", "ID")) for _, workflow := range filteredWorkflows { tp.AddField(workflow.Name) diff --git a/pkg/cmd/workflow/view/view.go b/pkg/cmd/workflow/view/view.go index 23b148942..28e561766 100644 --- a/pkg/cmd/workflow/view/view.go +++ b/pkg/cmd/workflow/view/view.go @@ -11,13 +11,13 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/browser" "github.com/cli/cli/v2/internal/ghrepo" + "github.com/cli/cli/v2/internal/tableprinter" "github.com/cli/cli/v2/internal/text" runShared "github.com/cli/cli/v2/pkg/cmd/run/shared" "github.com/cli/cli/v2/pkg/cmd/workflow/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/utils" "github.com/spf13/cobra" ) @@ -213,8 +213,6 @@ func viewWorkflowInfo(opts *ViewOptions, client *api.Client, repo ghrepo.Interfa out := opts.IO.Out cs := opts.IO.ColorScheme() - //nolint:staticcheck // SA1019: utils.NewTablePrinter is deprecated: use internal/tableprinter - tp := utils.NewTablePrinter(opts.IO) // Header filename := workflow.Base() @@ -228,26 +226,39 @@ func viewWorkflowInfo(opts *ViewOptions, client *api.Client, repo ghrepo.Interfa fmt.Fprintln(out, "Recent runs") } + headers := make([]string, 0, 8) + if opts.Raw { + headers = append(headers, "STATUS", "CONCLUSION") + } else { + headers = append(headers, "") + } + headers = append(headers, "TITLE", "WORKFLOW", "BRANCH", "EVENT") + if opts.Raw { + headers = append(headers, "ELAPSED") + } + headers = append(headers, "ID") + + tp := tableprinter.New(opts.IO, tableprinter.WithHeader(headers...)) for _, run := range wr.WorkflowRuns { if opts.Raw { - tp.AddField(string(run.Status), nil, nil) - tp.AddField(string(run.Conclusion), nil, nil) + tp.AddField(string(run.Status)) + tp.AddField(string(run.Conclusion)) } else { symbol, symbolColor := runShared.Symbol(cs, run.Status, run.Conclusion) - tp.AddField(symbol, nil, symbolColor) + tp.AddField(symbol, tableprinter.WithColor(symbolColor)) } - tp.AddField(run.Title(), nil, cs.Bold) + tp.AddField(run.Title(), tableprinter.WithColor(cs.Bold)) - tp.AddField(run.WorkflowName(), nil, nil) - tp.AddField(run.HeadBranch, nil, cs.Bold) - tp.AddField(string(run.Event), nil, nil) + tp.AddField(run.WorkflowName()) + tp.AddField(run.HeadBranch, tableprinter.WithColor(cs.Bold)) + tp.AddField(string(run.Event)) if opts.Raw { - tp.AddField(run.Duration(opts.now).String(), nil, nil) + tp.AddField(run.Duration(opts.now).String()) } - tp.AddField(fmt.Sprintf("%d", run.ID), nil, cs.Cyan) + tp.AddField(fmt.Sprintf("%d", run.ID), tableprinter.WithColor(cs.Cyan)) tp.EndRow() } diff --git a/pkg/cmd/workflow/view/view_test.go b/pkg/cmd/workflow/view/view_test.go index 9be264d92..c706da48f 100644 --- a/pkg/cmd/workflow/view/view_test.go +++ b/pkg/cmd/workflow/view/view_test.go @@ -176,10 +176,11 @@ func TestViewRun(t *testing.T) { Total runs 10 Recent runs - X cool commit a workflow trunk push 1 - * cool commit a workflow trunk push 2 - ✓ cool commit a workflow trunk push 3 - X cool commit a workflow trunk push 4 + TITLE WORKFLOW BRANCH EVENT ID + X cool commit a workflow trunk push 1 + * cool commit a workflow trunk push 2 + ✓ cool commit a workflow trunk push 3 + X cool commit a workflow trunk push 4 To see more runs for this workflow, try: gh run list --workflow flow.yml To see the YAML for this workflow, try: gh workflow view flow.yml --yaml diff --git a/pkg/iostreams/color.go b/pkg/iostreams/color.go index 6cb5a607a..804b9a275 100644 --- a/pkg/iostreams/color.go +++ b/pkg/iostreams/color.go @@ -9,16 +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") - greenBold = ansi.ColorFunc("green+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") + lightGrayUnderline = ansi.ColorFunc("white+du") + 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) @@ -39,6 +40,10 @@ type ColorScheme struct { hasTrueColor bool } +func (c *ColorScheme) Enabled() bool { + return c.enabled +} + func (c *ColorScheme) Bold(t string) string { if !c.enabled { return t @@ -104,6 +109,13 @@ func (c *ColorScheme) Grayf(t string, args ...interface{}) string { return c.Gray(fmt.Sprintf(t, args...)) } +func (c *ColorScheme) LightGrayUnderline(t string) string { + if !c.enabled { + return t + } + return lightGrayUnderline(t) +} + func (c *ColorScheme) Magenta(t string) string { if !c.enabled { return t diff --git a/utils/table_printer.go b/utils/table_printer.go deleted file mode 100644 index 1bf9a955b..000000000 --- a/utils/table_printer.go +++ /dev/null @@ -1,89 +0,0 @@ -package utils - -import ( - "io" - "strings" - - "github.com/cli/cli/v2/pkg/iostreams" - "github.com/cli/go-gh/v2/pkg/tableprinter" -) - -type TablePrinter interface { - IsTTY() bool - AddField(string, func(int, string) string, func(string) string) - EndRow() - Render() error -} - -type TablePrinterOptions struct { - IsTTY bool - MaxWidth int - Out io.Writer -} - -// Deprecated: use internal/tableprinter -func NewTablePrinter(io *iostreams.IOStreams) TablePrinter { - return NewTablePrinterWithOptions(io, TablePrinterOptions{ - IsTTY: io.IsStdoutTTY(), - }) -} - -// Deprecated: use internal/tableprinter -func NewTablePrinterWithOptions(ios *iostreams.IOStreams, opts TablePrinterOptions) TablePrinter { - var out io.Writer - if opts.Out != nil { - out = opts.Out - } else { - out = ios.Out - } - var maxWidth int - if opts.IsTTY { - if opts.MaxWidth > 0 { - maxWidth = opts.MaxWidth - } else { - maxWidth = ios.TerminalWidth() - } - } - tp := tableprinter.New(out, opts.IsTTY, maxWidth) - return &printer{ - tp: tp, - isTTY: opts.IsTTY, - } -} - -type printer struct { - tp tableprinter.TablePrinter - colIndex int - isTTY bool -} - -func (p printer) IsTTY() bool { - return p.isTTY -} - -func (p *printer) AddField(s string, truncateFunc func(int, string) string, colorFunc func(string) string) { - if truncateFunc == nil { - // Disallow ever truncating the 1st column or any URL value - if p.colIndex == 0 || isURL(s) { - p.tp.AddField(s, tableprinter.WithTruncate(nil), tableprinter.WithColor(colorFunc)) - } else { - p.tp.AddField(s, tableprinter.WithColor(colorFunc)) - } - } else { - p.tp.AddField(s, tableprinter.WithTruncate(truncateFunc), tableprinter.WithColor(colorFunc)) - } - p.colIndex++ -} - -func (p *printer) EndRow() { - p.tp.EndRow() - p.colIndex = 0 -} - -func (p *printer) Render() error { - return p.tp.Render() -} - -func isURL(s string) bool { - return strings.HasPrefix(s, "https://") || strings.HasPrefix(s, "http://") -} From d70d798ebf52e14eff778fe102f6a97afc18041d Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Fri, 20 Oct 2023 15:30:13 +0200 Subject: [PATCH 091/527] Fix up NoHeaders linter errors in project commands (#8223) --- pkg/cmd/project/field-list/field_list.go | 15 ++- pkg/cmd/project/field-list/field_list_test.go | 105 ++++++++++++++-- pkg/cmd/project/item-list/item_list.go | 21 ++-- pkg/cmd/project/item-list/item_list_test.go | 117 ++++++++++++++++-- pkg/cmd/project/list/list.go | 19 ++- pkg/cmd/project/list/list_test.go | 93 ++++++++++++-- 6 files changed, 312 insertions(+), 58 deletions(-) diff --git a/pkg/cmd/project/field-list/field_list.go b/pkg/cmd/project/field-list/field_list.go index 3e36e2a86..f15369c94 100644 --- a/pkg/cmd/project/field-list/field_list.go +++ b/pkg/cmd/project/field-list/field_list.go @@ -23,7 +23,6 @@ type listOpts struct { type listConfig struct { io *iostreams.IOStreams - tp *tableprinter.TablePrinter client *queries.Client opts listOpts } @@ -52,10 +51,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C opts.number = int32(num) } - t := tableprinter.New(f.IOStreams, tableprinter.WithHeader("Name", "Data type", "ID")) config := listConfig{ io: f.IOStreams, - tp: t, client: client, opts: opts, } @@ -109,14 +106,16 @@ func printResults(config listConfig, fields []queries.ProjectField, login string return cmdutil.NewNoResultsError(fmt.Sprintf("Project %d for owner %s has no fields", config.opts.number, login)) } + tp := tableprinter.New(config.io, tableprinter.WithHeader("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() + tp.AddField(f.Name()) + tp.AddField(f.Type()) + tp.AddField(f.ID(), tableprinter.WithTruncate(nil)) + tp.EndRow() } - return config.tp.Render() + return tp.Render() } func printJSON(config listConfig, project *queries.Project) error { diff --git a/pkg/cmd/project/field-list/field_list_test.go b/pkg/cmd/project/field-list/field_list_test.go index 85e67451f..ca01599fb 100644 --- a/pkg/cmd/project/field-list/field_list_test.go +++ b/pkg/cmd/project/field-list/field_list_test.go @@ -3,7 +3,7 @@ package fieldlist import ( "testing" - "github.com/cli/cli/v2/internal/tableprinter" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -87,6 +87,101 @@ func TestNewCmdList(t *testing.T) { } } +func TestRunList_User_tty(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() + ios.SetStdoutTTY(true) + config := listConfig{ + opts: listOpts{ + number: 1, + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, heredoc.Doc(` + NAME DATA TYPE ID + FieldTitle ProjectV2Field field ID + Status ProjectV2SingleSelectField status ID + Iterations ProjectV2IterationField iteration ID + `), stdout.String()) +} + func TestRunList_User(t *testing.T) { defer gock.Off() // gock.Observe(gock.DumpRequest) @@ -163,8 +258,6 @@ func TestRunList_User(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "monalisa", @@ -257,8 +350,6 @@ func TestRunList_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "github", @@ -341,8 +432,6 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "@me", @@ -409,8 +498,6 @@ func TestRunList_Empty(t *testing.T) { ios, _, _, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "@me", diff --git a/pkg/cmd/project/item-list/item_list.go b/pkg/cmd/project/item-list/item_list.go index f2e9bf8a6..45ca0c77f 100644 --- a/pkg/cmd/project/item-list/item_list.go +++ b/pkg/cmd/project/item-list/item_list.go @@ -23,7 +23,6 @@ type listOpts struct { type listConfig struct { io *iostreams.IOStreams - tp *tableprinter.TablePrinter client *queries.Client opts listOpts } @@ -52,10 +51,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C opts.number = int32(num) } - t := tableprinter.New(f.IOStreams, tableprinter.WithHeader("Type", "Title", "Number", "Repository", "ID")) config := listConfig{ io: f.IOStreams, - tp: t, client: client, opts: opts, } @@ -108,20 +105,22 @@ func printResults(config listConfig, items []queries.ProjectItem, login string) return cmdutil.NewNoResultsError(fmt.Sprintf("Project %d for owner %s has no items", config.opts.number, login)) } + tp := tableprinter.New(config.io, tableprinter.WithHeader("Type", "Title", "Number", "Repository", "ID")) + for _, i := range items { - config.tp.AddField(i.Type()) - config.tp.AddField(i.Title()) + tp.AddField(i.Type()) + tp.AddField(i.Title()) if i.Number() == 0 { - config.tp.AddField("") + tp.AddField("") } else { - config.tp.AddField(strconv.Itoa(i.Number())) + tp.AddField(strconv.Itoa(i.Number())) } - config.tp.AddField(i.Repo()) - config.tp.AddField(i.ID(), tableprinter.WithTruncate(nil)) - config.tp.EndRow() + tp.AddField(i.Repo()) + tp.AddField(i.ID(), tableprinter.WithTruncate(nil)) + tp.EndRow() } - return config.tp.Render() + return tp.Render() } func printJSON(config listConfig, project *queries.Project) error { diff --git a/pkg/cmd/project/item-list/item_list_test.go b/pkg/cmd/project/item-list/item_list_test.go index c36dfc589..f637ea99b 100644 --- a/pkg/cmd/project/item-list/item_list_test.go +++ b/pkg/cmd/project/item-list/item_list_test.go @@ -3,12 +3,12 @@ package itemlist import ( "testing" + "github.com/MakeNowJust/heredoc" "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" ) @@ -88,6 +88,115 @@ func TestNewCmdList(t *testing.T) { } } +func TestRunList_User_tty(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() + ios.SetStdoutTTY(true) + config := listConfig{ + opts: listOpts{ + number: 1, + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, heredoc.Doc(` + TYPE TITLE NUMBER REPOSITORY ID + Issue an issue 1 cli/go-gh issue ID + PullRequest a pull request 2 cli/go-gh pull request ID + DraftIssue draft issue draft issue ID + `), stdout.String()) +} + func TestRunList_User(t *testing.T) { defer gock.Off() // gock.Observe(gock.DumpRequest) @@ -178,8 +287,6 @@ func TestRunList_User(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "monalisa", @@ -286,8 +393,6 @@ func TestRunList_Org(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "github", @@ -384,8 +489,6 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ number: 1, owner: "@me", diff --git a/pkg/cmd/project/list/list.go b/pkg/cmd/project/list/list.go index d3168d7eb..88f419b90 100644 --- a/pkg/cmd/project/list/list.go +++ b/pkg/cmd/project/list/list.go @@ -23,7 +23,6 @@ type listOpts struct { } type listConfig struct { - tp *tableprinter.TablePrinter client *queries.Client opts listOpts URLOpener func(string) error @@ -52,9 +51,8 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C URLOpener := func(url string) error { return f.Browser.Browse(url) } - t := tableprinter.New(f.IOStreams, tableprinter.WithHeader("Number", "Title", "State", "ID")) + config := listConfig{ - tp: t, client: client, opts: opts, URLOpener: URLOpener, @@ -68,7 +66,6 @@ func NewCmdList(f *cmdutil.Factory, runF func(config listConfig) error) *cobra.C 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") @@ -157,21 +154,23 @@ func printResults(config listConfig, projects []queries.Project, owner string) e return cmdutil.NewNoResultsError(fmt.Sprintf("No projects found for %s", owner)) } + tp := tableprinter.New(config.io, tableprinter.WithHeader("Number", "Title", "State", "ID")) + for _, p := range projects { - config.tp.AddField(strconv.Itoa(int(p.Number)), tableprinter.WithTruncate(nil)) - config.tp.AddField(p.Title) + tp.AddField(strconv.Itoa(int(p.Number)), tableprinter.WithTruncate(nil)) + 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() + tp.AddField(state) + tp.AddField(p.ID, tableprinter.WithTruncate(nil)) + tp.EndRow() } - return config.tp.Render() + return tp.Render() } func printJSON(config listConfig, projects []queries.Project, totalCount int) error { diff --git a/pkg/cmd/project/list/list_test.go b/pkg/cmd/project/list/list_test.go index bafdf8e93..bb840caa6 100644 --- a/pkg/cmd/project/list/list_test.go +++ b/pkg/cmd/project/list/list_test.go @@ -4,7 +4,7 @@ import ( "bytes" "testing" - "github.com/cli/cli/v2/internal/tableprinter" + "github.com/MakeNowJust/heredoc" "github.com/cli/cli/v2/pkg/cmd/project/shared/queries" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -91,6 +91,85 @@ func TestNewCmdlist(t *testing.T) { } } +func TestRunListTTY(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() + ios.SetStdoutTTY(true) + config := listConfig{ + opts: listOpts{ + owner: "monalisa", + }, + client: client, + io: ios, + } + + err := runList(config) + assert.NoError(t, err) + assert.Equal(t, heredoc.Doc(` + NUMBER TITLE STATE ID + 1 Project 1 open id-1 + `), stdout.String()) +} + func TestRunList(t *testing.T) { defer gock.Off() gock.Observe(gock.DumpRequest) @@ -154,8 +233,6 @@ func TestRunList(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ owner: "monalisa", }, @@ -226,8 +303,6 @@ func TestRunList_Me(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ owner: "@me", }, @@ -298,8 +373,6 @@ func TestRunListViewer(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{}, client: client, io: ios, @@ -377,8 +450,6 @@ func TestRunListOrg(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ owner: "github", }, @@ -432,8 +503,6 @@ func TestRunListEmpty(t *testing.T) { ios, _, _, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{}, client: client, io: ios, @@ -509,8 +578,6 @@ func TestRunListWithClosed(t *testing.T) { ios, _, stdout, _ := iostreams.Test() config := listConfig{ - //nolint:staticcheck // SA1019: tableprinter.NoHeaders temporarily allowed in project tests. - tp: tableprinter.New(ios, tableprinter.NoHeader), opts: listOpts{ owner: "monalisa", closed: true, From 5023b619099ffdd5dc0d57c0b7f4718706c249b0 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Sun, 22 Oct 2023 17:33:49 +0200 Subject: [PATCH 092/527] Remove uses of FuzzyAgoAbbr in tables (#8222) --- internal/tableprinter/table_printer.go | 9 +- pkg/cmd/codespace/list.go | 13 +- pkg/cmd/codespace/list_test.go | 4 + pkg/cmd/gpg-key/list/list.go | 10 +- pkg/cmd/gpg-key/list/list_test.go | 6 +- pkg/cmd/pr/list/list.go | 6 +- pkg/cmd/pr/list/list_test.go | 6 +- pkg/cmd/repo/deploy-key/list/list.go | 10 +- pkg/cmd/repo/deploy-key/list/list_test.go | 4 +- pkg/cmd/repo/list/list.go | 6 +- pkg/cmd/repo/list/list_test.go | 6 +- pkg/cmd/run/list/list.go | 9 +- pkg/cmd/run/list/list_test.go | 248 +++++++++++----------- pkg/cmd/ssh-key/list/list.go | 8 +- pkg/cmd/ssh-key/list/list_test.go | 10 +- 15 files changed, 161 insertions(+), 194 deletions(-) diff --git a/internal/tableprinter/table_printer.go b/internal/tableprinter/table_printer.go index ed734cbad..c7056d478 100644 --- a/internal/tableprinter/table_printer.go +++ b/internal/tableprinter/table_printer.go @@ -30,12 +30,13 @@ func (tp *TablePrinter) AddTimeField(now, t time.Time, c func(string) string) { } else { tf = t.Format(time.RFC3339) } - tp.AddField(tf, tableprinter.WithColor(c)) + tp.AddField(tf, WithColor(c)) } var ( - WithTruncate = tableprinter.WithTruncate WithColor = tableprinter.WithColor + WithPadding = tableprinter.WithPadding + WithTruncate = tableprinter.WithTruncate ) type headerOption struct { @@ -77,8 +78,8 @@ func NewWithWriter(w io.Writer, isTTY bool, maxWidth int, cs *iostreams.ColorSch tp.AddHeader( headers.columns, - tableprinter.WithPadding(paddingFunc), - tableprinter.WithColor(cs.LightGrayUnderline), + WithPadding(paddingFunc), + WithColor(cs.LightGrayUnderline), ) } diff --git a/pkg/cmd/codespace/list.go b/pkg/cmd/codespace/list.go index 086334e29..c1acccabb 100644 --- a/pkg/cmd/codespace/list.go +++ b/pkg/cmd/codespace/list.go @@ -8,7 +8,6 @@ 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/spf13/cobra" ) @@ -169,15 +168,11 @@ func (a *App) List(ctx context.Context, opts *listOptions, exporter cmdutil.Expo tp.AddField(c.State, tableprinter.WithColor(stateColor)) } - if tp.IsTTY() { - ct, err := time.Parse(time.RFC3339, c.CreatedAt) - if err != nil { - return fmt.Errorf("error parsing date %q: %w", c.CreatedAt, err) - } - tp.AddField(text.FuzzyAgoAbbr(time.Now(), ct), tableprinter.WithColor(cs.Gray)) - } else { - tp.AddField(c.CreatedAt) + ct, err := time.Parse(time.RFC3339, c.CreatedAt) + if err != nil { + return fmt.Errorf("error parsing date %q: %w", c.CreatedAt, err) } + tp.AddTimeField(time.Now(), ct, cs.Gray) if hasNonProdVSCSTarget { tp.AddField(c.VSCSTarget) diff --git a/pkg/cmd/codespace/list_test.go b/pkg/cmd/codespace/list_test.go index 35f30581b..49bb0b4d2 100644 --- a/pkg/cmd/codespace/list_test.go +++ b/pkg/cmd/codespace/list_test.go @@ -85,6 +85,7 @@ func TestApp_List(t *testing.T) { return []*api.Codespace{ { DisplayName: "CS1", + CreatedAt: "2023-01-01T00:00:00Z", }, }, nil }, @@ -106,6 +107,7 @@ func TestApp_List(t *testing.T) { return []*api.Codespace{ { DisplayName: "CS1", + CreatedAt: "2023-01-01T00:00:00Z", }, }, nil }, @@ -129,6 +131,7 @@ func TestApp_List(t *testing.T) { return []*api.Codespace{ { DisplayName: "CS1", + CreatedAt: "2023-01-01T00:00:00Z", }, }, nil }, @@ -159,6 +162,7 @@ func TestApp_List(t *testing.T) { return []*api.Codespace{ { DisplayName: "CS1", + CreatedAt: "2023-01-01T00:00:00Z", }, }, nil }, diff --git a/pkg/cmd/gpg-key/list/list.go b/pkg/cmd/gpg-key/list/list.go index 1ecc88b85..4c594c584 100644 --- a/pkg/cmd/gpg-key/list/list.go +++ b/pkg/cmd/gpg-key/list/list.go @@ -8,7 +8,6 @@ import ( "github.com/cli/cli/v2/internal/config" "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/pkg/iostreams" "github.com/spf13/cobra" @@ -79,13 +78,7 @@ func listRun(opts *ListOptions) error { t.AddField(gpgKey.Emails.String()) t.AddField(gpgKey.KeyID) t.AddField(gpgKey.PublicKey, tableprinter.WithTruncate(truncateMiddle)) - - createdAt := gpgKey.CreatedAt.Format(time.RFC3339) - if t.IsTTY() { - createdAt = text.FuzzyAgoAbbr(now, gpgKey.CreatedAt) - } - t.AddField(createdAt, tableprinter.WithColor(cs.Gray)) - + t.AddTimeField(now, gpgKey.CreatedAt, cs.Gray) expiresAt := gpgKey.ExpiresAt.Format(time.RFC3339) if t.IsTTY() { if gpgKey.ExpiresAt.IsZero() { @@ -95,7 +88,6 @@ func listRun(opts *ListOptions) error { } } t.AddField(expiresAt, tableprinter.WithColor(cs.Gray)) - t.EndRow() } diff --git a/pkg/cmd/gpg-key/list/list_test.go b/pkg/cmd/gpg-key/list/list_test.go index a596275d1..de702498c 100644 --- a/pkg/cmd/gpg-key/list/list_test.go +++ b/pkg/cmd/gpg-key/list/list_test.go @@ -56,9 +56,9 @@ func Test_listRun(t *testing.T) { }}, isTTY: true, wantStdout: heredoc.Doc(` - EMAIL KEY ID PUBLIC KEY ADDED EXPIRES - johnny@test.com ABCDEF1234567890 xJMEWfoofoofoo 1d 2099-01-01 - monalisa@github.com 1234567890ABCDEF xJMEWbarbarbar 1d Never + EMAIL KEY ID PUBLIC KEY ADDED EXPIRES + johnny@test.com ABCDEF123456... xJMEWfoofoofoo about 1 day ago 2099-01-01 + monalisa@github... 1234567890AB... xJMEWbarbarbar about 1 day ago Never `), wantStderr: "", }, diff --git a/pkg/cmd/pr/list/list.go b/pkg/cmd/pr/list/list.go index e900a5d7b..7721ecc1b 100644 --- a/pkg/cmd/pr/list/list.go +++ b/pkg/cmd/pr/list/list.go @@ -224,11 +224,7 @@ func listRun(opts *ListOptions) error { if !isTTY { table.AddField(prStateWithDraft(&pr)) } - if isTTY { - table.AddField(text.FuzzyAgo(opts.Now(), pr.CreatedAt), tableprinter.WithColor(cs.Gray)) - } else { - table.AddField(pr.CreatedAt.String()) - } + table.AddTimeField(opts.Now(), pr.CreatedAt, cs.Gray) table.EndRow() } err = table.Render() diff --git a/pkg/cmd/pr/list/list_test.go b/pkg/cmd/pr/list/list_test.go index d4a658a81..61a8e3698 100644 --- a/pkg/cmd/pr/list/list_test.go +++ b/pkg/cmd/pr/list/list_test.go @@ -105,9 +105,9 @@ func TestPRList_nontty(t *testing.T) { assert.Equal(t, "", output.Stderr()) - assert.Equal(t, `32 New feature feature DRAFT 2022-08-24 20:01:12 +0000 UTC -29 Fixed bad bug hubot:bug-fix OPEN 2022-07-20 19:01:12 +0000 UTC -28 Improve documentation docs MERGED 2020-01-26 19:01:12 +0000 UTC + assert.Equal(t, `32 New feature feature DRAFT 2022-08-24T20:01:12Z +29 Fixed bad bug hubot:bug-fix OPEN 2022-07-20T19:01:12Z +28 Improve documentation docs MERGED 2020-01-26T19:01:12Z `, output.String()) } diff --git a/pkg/cmd/repo/deploy-key/list/list.go b/pkg/cmd/repo/deploy-key/list/list.go index 3df78212c..0cf2861c1 100644 --- a/pkg/cmd/repo/deploy-key/list/list.go +++ b/pkg/cmd/repo/deploy-key/list/list.go @@ -8,7 +8,6 @@ import ( "github.com/cli/cli/v2/internal/ghrepo" "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/pkg/iostreams" "github.com/spf13/cobra" @@ -85,20 +84,13 @@ func listRun(opts *ListOptions) error { sshID := strconv.Itoa(deployKey.ID) t.AddField(sshID) t.AddField(deployKey.Title) - sshType := "read-only" if !deployKey.ReadOnly { sshType = "read-write" } t.AddField(sshType) t.AddField(deployKey.Key, tableprinter.WithTruncate(truncateMiddle)) - - // TODO: Modify AddTimeField, add AddAbbrTimeField, or something else. - createdAt := deployKey.CreatedAt.Format(time.RFC3339) - if t.IsTTY() { - createdAt = text.FuzzyAgoAbbr(now, deployKey.CreatedAt) - } - t.AddField(createdAt, tableprinter.WithColor(cs.Gray)) + t.AddTimeField(now, deployKey.CreatedAt, cs.Gray) t.EndRow() } diff --git a/pkg/cmd/repo/deploy-key/list/list_test.go b/pkg/cmd/repo/deploy-key/list/list_test.go index 4e5a57f11..0f6977db7 100644 --- a/pkg/cmd/repo/deploy-key/list/list_test.go +++ b/pkg/cmd/repo/deploy-key/list/list_test.go @@ -49,8 +49,8 @@ func TestListRun(t *testing.T) { }, wantStdout: heredoc.Doc(` ID TITLE TYPE KEY CREATED AT - 1234 Mac read-only ssh-rsa AAAABbBB123 1d - 5678 hubot@Windows read-write ssh-rsa EEEEEEEK247 1d + 1234 Mac read-only ssh-rsa AAAABbBB123 about 1 day ago + 5678 hubot@Windows read-write ssh-rsa EEEEEEEK247 about 1 day ago `), wantStderr: "", }, diff --git a/pkg/cmd/repo/list/list.go b/pkg/cmd/repo/list/list.go index f91b847a7..e48142723 100644 --- a/pkg/cmd/repo/list/list.go +++ b/pkg/cmd/repo/list/list.go @@ -195,11 +195,7 @@ func listRun(opts *ListOptions) error { tp.AddField(repo.NameWithOwner, tableprinter.WithColor(cs.Bold)) tp.AddField(text.RemoveExcessiveWhitespace(repo.Description)) tp.AddField(info, tableprinter.WithColor(infoColor)) - if tp.IsTTY() { - tp.AddField(text.FuzzyAgoAbbr(opts.Now(), *t), tableprinter.WithColor(cs.Gray)) - } else { - tp.AddField(t.Format(time.RFC3339)) - } + tp.AddTimeField(opts.Now(), *t, cs.Gray) tp.EndRow() } diff --git a/pkg/cmd/repo/list/list_test.go b/pkg/cmd/repo/list/list_test.go index 55e4da83d..1a209e04d 100644 --- a/pkg/cmd/repo/list/list_test.go +++ b/pkg/cmd/repo/list/list_test.go @@ -386,9 +386,9 @@ func TestRepoList_tty(t *testing.T) { Showing 3 of 3 repositories in @octocat NAME DESCRIPTION INFO UPDATED - octocat/hello-world My first repository public 8h - octocat/cli GitHub CLI public, fork 8h - octocat/testing private 7d + octocat/hello-world My first repository public about 8 hours ago + octocat/cli GitHub CLI public, fork about 8 hours ago + octocat/testing private about 7 days ago `), stdout.String()) } diff --git a/pkg/cmd/run/list/list.go b/pkg/cmd/run/list/list.go index 39e14442a..7776b3521 100644 --- a/pkg/cmd/run/list/list.go +++ b/pkg/cmd/run/list/list.go @@ -8,7 +8,6 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/ghrepo" "github.com/cli/cli/v2/internal/tableprinter" - "github.com/cli/cli/v2/internal/text" "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" @@ -150,21 +149,17 @@ func listRun(opts *ListOptions) error { tp.AddField(string(run.Status)) tp.AddField(string(run.Conclusion)) } - tp.AddField(run.Title(), tableprinter.WithColor(cs.Bold)) - tp.AddField(run.WorkflowName()) tp.AddField(run.HeadBranch, tableprinter.WithColor(cs.Bold)) tp.AddField(string(run.Event)) tp.AddField(fmt.Sprintf("%d", run.ID), tableprinter.WithColor(cs.Cyan)) - tp.AddField(run.Duration(opts.now).String()) - tp.AddField(text.FuzzyAgoAbbr(time.Now(), run.StartedTime())) + tp.AddTimeField(time.Now(), run.StartedTime(), cs.Gray) tp.EndRow() } - err = tp.Render() - if err != nil { + if err := tp.Render(); err != nil { return err } diff --git a/pkg/cmd/run/list/list_test.go b/pkg/cmd/run/list/list_test.go index cf5ba97ad..31680928f 100644 --- a/pkg/cmd/run/list/list_test.go +++ b/pkg/cmd/run/list/list_test.go @@ -169,16 +169,16 @@ func TestListRun(t *testing.T) { }, wantOut: heredoc.Doc(` STATUS TITLE WORKFLOW BRANCH EVENT ID ELAPSED AGE - X cool commit CI trunk push 1 4m34s Feb 23, 2021 - * cool commit CI trunk push 2 4m34s Feb 23, 2021 - ✓ cool commit CI trunk push 3 4m34s Feb 23, 2021 - X cool commit CI trunk push 4 4m34s Feb 23, 2021 - X cool commit CI trunk push 1234 4m34s Feb 23, 2021 - - cool commit CI trunk push 6 4m34s Feb 23, 2021 - - cool commit CI trunk push 7 4m34s Feb 23, 2021 - * cool commit CI trunk push 8 4m34s Feb 23, 2021 - * cool commit CI trunk push 9 4m34s Feb 23, 2021 - X cool commit CI trunk push 10 4m34s Feb 23, 2021 + X cool commit CI trunk push 1 4m34s about 2 years ago + * cool commit CI trunk push 2 4m34s about 2 years ago + ✓ cool commit CI trunk push 3 4m34s about 2 years ago + X cool commit CI trunk push 4 4m34s about 2 years ago + X cool commit CI trunk push 1234 4m34s about 2 years ago + - cool commit CI trunk push 6 4m34s about 2 years ago + - cool commit CI trunk push 7 4m34s about 2 years ago + * cool commit CI trunk push 8 4m34s about 2 years ago + * cool commit CI trunk push 9 4m34s about 2 years ago + X cool commit CI trunk push 10 4m34s about 2 years ago `), }, { @@ -203,16 +203,16 @@ func TestListRun(t *testing.T) { })) }, wantOut: heredoc.Doc(` - completed timed_out cool commit CI trunk push 1 4m34s Feb 23, 2021 - in_progress cool commit CI trunk push 2 4m34s Feb 23, 2021 - completed success cool commit CI trunk push 3 4m34s Feb 23, 2021 - completed cancelled cool commit CI trunk push 4 4m34s Feb 23, 2021 - completed failure cool commit CI trunk push 1234 4m34s Feb 23, 2021 - completed neutral cool commit CI trunk push 6 4m34s Feb 23, 2021 - completed skipped cool commit CI trunk push 7 4m34s Feb 23, 2021 - requested cool commit CI trunk push 8 4m34s Feb 23, 2021 - queued cool commit CI trunk push 9 4m34s Feb 23, 2021 - completed stale cool commit CI trunk push 10 4m34s Feb 23, 2021 + completed timed_out cool commit CI trunk push 1 4m34s 2021-02-23T04:51:00Z + in_progress cool commit CI trunk push 2 4m34s 2021-02-23T04:51:00Z + completed success cool commit CI trunk push 3 4m34s 2021-02-23T04:51:00Z + completed cancelled cool commit CI trunk push 4 4m34s 2021-02-23T04:51:00Z + completed failure cool commit CI trunk push 1234 4m34s 2021-02-23T04:51:00Z + completed neutral cool commit CI trunk push 6 4m34s 2021-02-23T04:51:00Z + completed skipped cool commit CI trunk push 7 4m34s 2021-02-23T04:51:00Z + requested cool commit CI trunk push 8 4m34s 2021-02-23T04:51:00Z + queued cool commit CI trunk push 9 4m34s 2021-02-23T04:51:00Z + completed stale cool commit CI trunk push 10 4m34s 2021-02-23T04:51:00Z `), }, { @@ -249,107 +249,107 @@ func TestListRun(t *testing.T) { }, wantOut: heredoc.Doc(` STATUS TITLE WORKFLOW BRANCH EVENT ID ELAPSED AGE - * cool commit CI trunk push 0 4m34s Feb 23, 2021 - * cool commit CI trunk push 1 4m34s Feb 23, 2021 - * cool commit CI trunk push 2 4m34s Feb 23, 2021 - * cool commit CI trunk push 3 4m34s Feb 23, 2021 - * cool commit CI trunk push 4 4m34s Feb 23, 2021 - * cool commit CI trunk push 5 4m34s Feb 23, 2021 - * cool commit CI trunk push 6 4m34s Feb 23, 2021 - * cool commit CI trunk push 7 4m34s Feb 23, 2021 - * cool commit CI trunk push 8 4m34s Feb 23, 2021 - * cool commit CI trunk push 9 4m34s Feb 23, 2021 - * cool commit CI trunk push 10 4m34s Feb 23, 2021 - * cool commit CI trunk push 11 4m34s Feb 23, 2021 - * cool commit CI trunk push 12 4m34s Feb 23, 2021 - * cool commit CI trunk push 13 4m34s Feb 23, 2021 - * cool commit CI trunk push 14 4m34s Feb 23, 2021 - * cool commit CI trunk push 15 4m34s Feb 23, 2021 - * cool commit CI trunk push 16 4m34s Feb 23, 2021 - * cool commit CI trunk push 17 4m34s Feb 23, 2021 - * cool commit CI trunk push 18 4m34s Feb 23, 2021 - * cool commit CI trunk push 19 4m34s Feb 23, 2021 - * cool commit CI trunk push 20 4m34s Feb 23, 2021 - * cool commit CI trunk push 21 4m34s Feb 23, 2021 - * cool commit CI trunk push 22 4m34s Feb 23, 2021 - * cool commit CI trunk push 23 4m34s Feb 23, 2021 - * cool commit CI trunk push 24 4m34s Feb 23, 2021 - * cool commit CI trunk push 25 4m34s Feb 23, 2021 - * cool commit CI trunk push 26 4m34s Feb 23, 2021 - * cool commit CI trunk push 27 4m34s Feb 23, 2021 - * cool commit CI trunk push 28 4m34s Feb 23, 2021 - * cool commit CI trunk push 29 4m34s Feb 23, 2021 - * cool commit CI trunk push 30 4m34s Feb 23, 2021 - * cool commit CI trunk push 31 4m34s Feb 23, 2021 - * cool commit CI trunk push 32 4m34s Feb 23, 2021 - * cool commit CI trunk push 33 4m34s Feb 23, 2021 - * cool commit CI trunk push 34 4m34s Feb 23, 2021 - * cool commit CI trunk push 35 4m34s Feb 23, 2021 - * cool commit CI trunk push 36 4m34s Feb 23, 2021 - * cool commit CI trunk push 37 4m34s Feb 23, 2021 - * cool commit CI trunk push 38 4m34s Feb 23, 2021 - * cool commit CI trunk push 39 4m34s Feb 23, 2021 - * cool commit CI trunk push 40 4m34s Feb 23, 2021 - * cool commit CI trunk push 41 4m34s Feb 23, 2021 - * cool commit CI trunk push 42 4m34s Feb 23, 2021 - * cool commit CI trunk push 43 4m34s Feb 23, 2021 - * cool commit CI trunk push 44 4m34s Feb 23, 2021 - * cool commit CI trunk push 45 4m34s Feb 23, 2021 - * cool commit CI trunk push 46 4m34s Feb 23, 2021 - * cool commit CI trunk push 47 4m34s Feb 23, 2021 - * cool commit CI trunk push 48 4m34s Feb 23, 2021 - * cool commit CI trunk push 49 4m34s Feb 23, 2021 - * cool commit CI trunk push 50 4m34s Feb 23, 2021 - * cool commit CI trunk push 51 4m34s Feb 23, 2021 - * cool commit CI trunk push 52 4m34s Feb 23, 2021 - * cool commit CI trunk push 53 4m34s Feb 23, 2021 - * cool commit CI trunk push 54 4m34s Feb 23, 2021 - * cool commit CI trunk push 55 4m34s Feb 23, 2021 - * cool commit CI trunk push 56 4m34s Feb 23, 2021 - * cool commit CI trunk push 57 4m34s Feb 23, 2021 - * cool commit CI trunk push 58 4m34s Feb 23, 2021 - * cool commit CI trunk push 59 4m34s Feb 23, 2021 - * cool commit CI trunk push 60 4m34s Feb 23, 2021 - * cool commit CI trunk push 61 4m34s Feb 23, 2021 - * cool commit CI trunk push 62 4m34s Feb 23, 2021 - * cool commit CI trunk push 63 4m34s Feb 23, 2021 - * cool commit CI trunk push 64 4m34s Feb 23, 2021 - * cool commit CI trunk push 65 4m34s Feb 23, 2021 - * cool commit CI trunk push 66 4m34s Feb 23, 2021 - * cool commit CI trunk push 67 4m34s Feb 23, 2021 - * cool commit CI trunk push 68 4m34s Feb 23, 2021 - * cool commit CI trunk push 69 4m34s Feb 23, 2021 - * cool commit CI trunk push 70 4m34s Feb 23, 2021 - * cool commit CI trunk push 71 4m34s Feb 23, 2021 - * cool commit CI trunk push 72 4m34s Feb 23, 2021 - * cool commit CI trunk push 73 4m34s Feb 23, 2021 - * cool commit CI trunk push 74 4m34s Feb 23, 2021 - * cool commit CI trunk push 75 4m34s Feb 23, 2021 - * cool commit CI trunk push 76 4m34s Feb 23, 2021 - * cool commit CI trunk push 77 4m34s Feb 23, 2021 - * cool commit CI trunk push 78 4m34s Feb 23, 2021 - * cool commit CI trunk push 79 4m34s Feb 23, 2021 - * cool commit CI trunk push 80 4m34s Feb 23, 2021 - * cool commit CI trunk push 81 4m34s Feb 23, 2021 - * cool commit CI trunk push 82 4m34s Feb 23, 2021 - * cool commit CI trunk push 83 4m34s Feb 23, 2021 - * cool commit CI trunk push 84 4m34s Feb 23, 2021 - * cool commit CI trunk push 85 4m34s Feb 23, 2021 - * cool commit CI trunk push 86 4m34s Feb 23, 2021 - * cool commit CI trunk push 87 4m34s Feb 23, 2021 - * cool commit CI trunk push 88 4m34s Feb 23, 2021 - * cool commit CI trunk push 89 4m34s Feb 23, 2021 - * cool commit CI trunk push 90 4m34s Feb 23, 2021 - * cool commit CI trunk push 91 4m34s Feb 23, 2021 - * cool commit CI trunk push 92 4m34s Feb 23, 2021 - * cool commit CI trunk push 93 4m34s Feb 23, 2021 - * cool commit CI trunk push 94 4m34s Feb 23, 2021 - * cool commit CI trunk push 95 4m34s Feb 23, 2021 - * cool commit CI trunk push 96 4m34s Feb 23, 2021 - * cool commit CI trunk push 97 4m34s Feb 23, 2021 - * cool commit CI trunk push 98 4m34s Feb 23, 2021 - * cool commit CI trunk push 99 4m34s Feb 23, 2021 - * cool commit CI trunk push 100 4m34s Feb 23, 2021 + * cool commit CI trunk push 0 4m34s about 2 years ago + * cool commit CI trunk push 1 4m34s about 2 years ago + * cool commit CI trunk push 2 4m34s about 2 years ago + * cool commit CI trunk push 3 4m34s about 2 years ago + * cool commit CI trunk push 4 4m34s about 2 years ago + * cool commit CI trunk push 5 4m34s about 2 years ago + * cool commit CI trunk push 6 4m34s about 2 years ago + * cool commit CI trunk push 7 4m34s about 2 years ago + * cool commit CI trunk push 8 4m34s about 2 years ago + * cool commit CI trunk push 9 4m34s about 2 years ago + * cool commit CI trunk push 10 4m34s about 2 years ago + * cool commit CI trunk push 11 4m34s about 2 years ago + * cool commit CI trunk push 12 4m34s about 2 years ago + * cool commit CI trunk push 13 4m34s about 2 years ago + * cool commit CI trunk push 14 4m34s about 2 years ago + * cool commit CI trunk push 15 4m34s about 2 years ago + * cool commit CI trunk push 16 4m34s about 2 years ago + * cool commit CI trunk push 17 4m34s about 2 years ago + * cool commit CI trunk push 18 4m34s about 2 years ago + * cool commit CI trunk push 19 4m34s about 2 years ago + * cool commit CI trunk push 20 4m34s about 2 years ago + * cool commit CI trunk push 21 4m34s about 2 years ago + * cool commit CI trunk push 22 4m34s about 2 years ago + * cool commit CI trunk push 23 4m34s about 2 years ago + * cool commit CI trunk push 24 4m34s about 2 years ago + * cool commit CI trunk push 25 4m34s about 2 years ago + * cool commit CI trunk push 26 4m34s about 2 years ago + * cool commit CI trunk push 27 4m34s about 2 years ago + * cool commit CI trunk push 28 4m34s about 2 years ago + * cool commit CI trunk push 29 4m34s about 2 years ago + * cool commit CI trunk push 30 4m34s about 2 years ago + * cool commit CI trunk push 31 4m34s about 2 years ago + * cool commit CI trunk push 32 4m34s about 2 years ago + * cool commit CI trunk push 33 4m34s about 2 years ago + * cool commit CI trunk push 34 4m34s about 2 years ago + * cool commit CI trunk push 35 4m34s about 2 years ago + * cool commit CI trunk push 36 4m34s about 2 years ago + * cool commit CI trunk push 37 4m34s about 2 years ago + * cool commit CI trunk push 38 4m34s about 2 years ago + * cool commit CI trunk push 39 4m34s about 2 years ago + * cool commit CI trunk push 40 4m34s about 2 years ago + * cool commit CI trunk push 41 4m34s about 2 years ago + * cool commit CI trunk push 42 4m34s about 2 years ago + * cool commit CI trunk push 43 4m34s about 2 years ago + * cool commit CI trunk push 44 4m34s about 2 years ago + * cool commit CI trunk push 45 4m34s about 2 years ago + * cool commit CI trunk push 46 4m34s about 2 years ago + * cool commit CI trunk push 47 4m34s about 2 years ago + * cool commit CI trunk push 48 4m34s about 2 years ago + * cool commit CI trunk push 49 4m34s about 2 years ago + * cool commit CI trunk push 50 4m34s about 2 years ago + * cool commit CI trunk push 51 4m34s about 2 years ago + * cool commit CI trunk push 52 4m34s about 2 years ago + * cool commit CI trunk push 53 4m34s about 2 years ago + * cool commit CI trunk push 54 4m34s about 2 years ago + * cool commit CI trunk push 55 4m34s about 2 years ago + * cool commit CI trunk push 56 4m34s about 2 years ago + * cool commit CI trunk push 57 4m34s about 2 years ago + * cool commit CI trunk push 58 4m34s about 2 years ago + * cool commit CI trunk push 59 4m34s about 2 years ago + * cool commit CI trunk push 60 4m34s about 2 years ago + * cool commit CI trunk push 61 4m34s about 2 years ago + * cool commit CI trunk push 62 4m34s about 2 years ago + * cool commit CI trunk push 63 4m34s about 2 years ago + * cool commit CI trunk push 64 4m34s about 2 years ago + * cool commit CI trunk push 65 4m34s about 2 years ago + * cool commit CI trunk push 66 4m34s about 2 years ago + * cool commit CI trunk push 67 4m34s about 2 years ago + * cool commit CI trunk push 68 4m34s about 2 years ago + * cool commit CI trunk push 69 4m34s about 2 years ago + * cool commit CI trunk push 70 4m34s about 2 years ago + * cool commit CI trunk push 71 4m34s about 2 years ago + * cool commit CI trunk push 72 4m34s about 2 years ago + * cool commit CI trunk push 73 4m34s about 2 years ago + * cool commit CI trunk push 74 4m34s about 2 years ago + * cool commit CI trunk push 75 4m34s about 2 years ago + * cool commit CI trunk push 76 4m34s about 2 years ago + * cool commit CI trunk push 77 4m34s about 2 years ago + * cool commit CI trunk push 78 4m34s about 2 years ago + * cool commit CI trunk push 79 4m34s about 2 years ago + * cool commit CI trunk push 80 4m34s about 2 years ago + * cool commit CI trunk push 81 4m34s about 2 years ago + * cool commit CI trunk push 82 4m34s about 2 years ago + * cool commit CI trunk push 83 4m34s about 2 years ago + * cool commit CI trunk push 84 4m34s about 2 years ago + * cool commit CI trunk push 85 4m34s about 2 years ago + * cool commit CI trunk push 86 4m34s about 2 years ago + * cool commit CI trunk push 87 4m34s about 2 years ago + * cool commit CI trunk push 88 4m34s about 2 years ago + * cool commit CI trunk push 89 4m34s about 2 years ago + * cool commit CI trunk push 90 4m34s about 2 years ago + * cool commit CI trunk push 91 4m34s about 2 years ago + * cool commit CI trunk push 92 4m34s about 2 years ago + * cool commit CI trunk push 93 4m34s about 2 years ago + * cool commit CI trunk push 94 4m34s about 2 years ago + * cool commit CI trunk push 95 4m34s about 2 years ago + * cool commit CI trunk push 96 4m34s about 2 years ago + * cool commit CI trunk push 97 4m34s about 2 years ago + * cool commit CI trunk push 98 4m34s about 2 years ago + * cool commit CI trunk push 99 4m34s about 2 years ago + * cool commit CI trunk push 100 4m34s about 2 years ago `), }, { @@ -386,9 +386,9 @@ func TestListRun(t *testing.T) { }, wantOut: heredoc.Doc(` STATUS TITLE WORKFLOW BRANCH EVENT ID ELAPSED AGE - * cool commit a workflow trunk push 2 4m34s Feb 23, 2021 - ✓ cool commit a workflow trunk push 3 4m34s Feb 23, 2021 - X cool commit a workflow trunk push 1234 4m34s Feb 23, 2021 + * cool commit a workflow trunk push 2 4m34s about 2 years ago + ✓ cool commit a workflow trunk push 3 4m34s about 2 years ago + X cool commit a workflow trunk push 1234 4m34s about 2 years ago `), }, { diff --git a/pkg/cmd/ssh-key/list/list.go b/pkg/cmd/ssh-key/list/list.go index 828fc0b31..f00075944 100644 --- a/pkg/cmd/ssh-key/list/list.go +++ b/pkg/cmd/ssh-key/list/list.go @@ -11,7 +11,6 @@ import ( "github.com/cli/cli/v2/api" "github.com/cli/cli/v2/internal/config" "github.com/cli/cli/v2/internal/tableprinter" - "github.com/cli/cli/v2/internal/text" "github.com/cli/cli/v2/pkg/cmd/ssh-key/shared" "github.com/cli/cli/v2/pkg/cmdutil" "github.com/cli/cli/v2/pkg/iostreams" @@ -85,22 +84,19 @@ func listRun(opts *ListOptions) error { for _, sshKey := range sshKeys { id := strconv.Itoa(sshKey.ID) - createdAt := sshKey.CreatedAt.Format(time.RFC3339) - if t.IsTTY() { t.AddField(sshKey.Title) t.AddField(id) t.AddField(sshKey.Key, tableprinter.WithTruncate(truncateMiddle)) t.AddField(sshKey.Type) - t.AddField(text.FuzzyAgoAbbr(now, sshKey.CreatedAt), tableprinter.WithColor(cs.Gray)) + t.AddTimeField(now, sshKey.CreatedAt, cs.Gray) } else { t.AddField(sshKey.Title) t.AddField(sshKey.Key) - t.AddField(createdAt) + t.AddTimeField(now, sshKey.CreatedAt, cs.Gray) t.AddField(id) t.AddField(sshKey.Type) } - t.EndRow() } diff --git a/pkg/cmd/ssh-key/list/list_test.go b/pkg/cmd/ssh-key/list/list_test.go index 7334beccf..ab28c34c3 100644 --- a/pkg/cmd/ssh-key/list/list_test.go +++ b/pkg/cmd/ssh-key/list/list_test.go @@ -61,9 +61,9 @@ func TestListRun(t *testing.T) { isTTY: true, wantStdout: heredoc.Doc(` TITLE ID KEY TYPE ADDED - Mac 1234 ssh-rsa AAAABbBB123 authentication 1d - hubot@Windows 5678 ssh-rsa EEEEEEEK247 authentication 1d - Mac Signing 321 ssh-rsa AAAABbBB123 signing 1d + Mac 1234 ssh-rsa AAAABbBB123 authentication about 1 day ago + hubot@Windows 5678 ssh-rsa EEEEEEEK247 authentication about 1 day ago + Mac Signing 321 ssh-rsa AAAABbBB123 signing about 1 day ago `), wantStderr: "", }, @@ -138,7 +138,7 @@ func TestListRun(t *testing.T) { }, wantStdout: heredoc.Doc(` TITLE ID KEY TYPE ADDED - Mac 1234 ssh-rsa AAAABbBB123 authentication 1d + Mac 1234 ssh-rsa AAAABbBB123 authentication about 1 day ago `), wantStderr: heredoc.Doc(` warning: HTTP 404 (https://api.github.com/user/ssh_signing_keys?per_page=100) @@ -172,7 +172,7 @@ func TestListRun(t *testing.T) { }, wantStdout: heredoc.Doc(` TITLE ID KEY TYPE ADDED - Mac 1234 ssh-rsa AAAABbBB123 signing 1d + Mac 1234 ssh-rsa AAAABbBB123 signing about 1 day ago `), wantStderr: heredoc.Doc(` warning: HTTP 404 (https://api.github.com/user/keys?per_page=100) From f4535004c2dc54139cb2f16ece26271ba76ccb58 Mon Sep 17 00:00:00 2001 From: ffalor <35144141+ffalor@users.noreply.github.com> Date: Sun, 22 Oct 2023 23:35:56 -0500 Subject: [PATCH 093/527] clearer error message --- pkg/cmd/project/shared/queries/queries.go | 4 ++-- pkg/cmd/project/shared/queries/queries_test.go | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/pkg/cmd/project/shared/queries/queries.go b/pkg/cmd/project/shared/queries/queries.go index 0bf96ba63..c1c518848 100644 --- a/pkg/cmd/project/shared/queries/queries.go +++ b/pkg/cmd/project/shared/queries/queries.go @@ -1001,7 +1001,7 @@ type Owner struct { // 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. +// If login is 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 != "" { @@ -1018,7 +1018,7 @@ func (c *Client) NewOwner(canPrompt bool, login string) (*Owner, error) { } if !canPrompt { - return nil, fmt.Errorf("login is required when not running interactively") + return nil, fmt.Errorf("owner is required when not running interactively") } logins, err := c.userOrgLogins() diff --git a/pkg/cmd/project/shared/queries/queries_test.go b/pkg/cmd/project/shared/queries/queries_test.go index e1cf8c68b..5767929a3 100644 --- a/pkg/cmd/project/shared/queries/queries_test.go +++ b/pkg/cmd/project/shared/queries/queries_test.go @@ -361,7 +361,7 @@ func TestNewProject_nonTTY(t *testing.T) { func TestNewOwner_nonTTY(t *testing.T) { client := NewTestClient() _, err := client.NewOwner(false, "") - assert.EqualError(t, err, "login is required when not running interactively") + assert.EqualError(t, err, "owner is required when not running interactively") } From 20baccfa85d15963eb1ab4f750da0da37b0af7f5 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Tue, 24 Oct 2023 13:23:31 +0200 Subject: [PATCH 094/527] Add default configuration back from go-gh (#8244) --- go.mod | 2 +- go.sum | 4 +- internal/config/auth_config_test.go | 4 +- internal/config/config.go | 96 +++++++++++++++++------------ internal/config/config_test.go | 29 +++++++++ internal/config/stub.go | 19 +----- 6 files changed, 93 insertions(+), 61 deletions(-) diff --git a/go.mod b/go.mod index c26451600..91bfac2ad 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.6.0 github.com/charmbracelet/lipgloss v0.5.0 - github.com/cli/go-gh/v2 v2.4.1-0.20231019124728-ec1e1cd3e0cb + github.com/cli/go-gh/v2 v2.4.1-0.20231024095351-47a83eeb1778 github.com/cli/oauth v1.0.1 github.com/cli/safeexec v1.0.1 github.com/cpuguy83/go-md2man/v2 v2.0.3 diff --git a/go.sum b/go.sum index 4e177e4d7..d77e0ef20 100644 --- a/go.sum +++ b/go.sum @@ -23,8 +23,8 @@ github.com/charmbracelet/lipgloss v0.5.0/go.mod h1:EZLha/HbzEt7cYqdFPovlqy5FZPj0 github.com/cli/browser v1.0.0/go.mod h1:IEWkHYbLjkhtjwwWlwTHW2lGxeS5gezEQBMLTwDHf5Q= github.com/cli/browser v1.3.0 h1:LejqCrpWr+1pRqmEPDGnTZOjsMe7sehifLynZJuqJpo= github.com/cli/browser v1.3.0/go.mod h1:HH8s+fOAxjhQoBUAsKuPCbqUuxZDhQ2/aD+SzsEfBTk= -github.com/cli/go-gh/v2 v2.4.1-0.20231019124728-ec1e1cd3e0cb h1:HeIpiv5Jf09GQA0AyABbjC7Zq55eyIxpv4/BU6ujHRk= -github.com/cli/go-gh/v2 v2.4.1-0.20231019124728-ec1e1cd3e0cb/go.mod h1:h3salfqqooVpzKmHp6aUdeNx62UmxQRpLbagFSHTJGQ= +github.com/cli/go-gh/v2 v2.4.1-0.20231024095351-47a83eeb1778 h1:2WcQtkNIafTIimwJJUTzFLqXO3BH4avCAcWQT22xiKc= +github.com/cli/go-gh/v2 v2.4.1-0.20231024095351-47a83eeb1778/go.mod h1:h3salfqqooVpzKmHp6aUdeNx62UmxQRpLbagFSHTJGQ= 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= diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index e4a1dc9c4..6d7e73c5c 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -20,7 +20,7 @@ func newTestAuthConfig(t *testing.T) *AuthConfig { // // This means that tests can't be isolated from each other, so // we swap out the function here to return a new config each time. - ghConfig.Read = func() (*ghConfig.Config, error) { + ghConfig.Read = func(_ *ghConfig.Config) (*ghConfig.Config, error) { return authCfg.cfg, nil } @@ -29,7 +29,7 @@ func newTestAuthConfig(t *testing.T) *AuthConfig { // // We should consider whether it makes sense to change that but in the meantime // we can use GH_CONFIG_DIR env var to ensure the tests remain isolated. - t.Setenv("GH_CONFIG_DIR", t.TempDir()) + StubWriteConfig(t) return &authCfg } diff --git a/internal/config/config.go b/internal/config/config.go index 6f60f14b5..32475a5d8 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -29,7 +29,7 @@ type Config interface { } func NewConfig() (Config, error) { - c, err := ghConfig.Read() + c, err := ghConfig.Read(fallbackConfig()) if err != nil { return nil, err } @@ -86,7 +86,7 @@ func (c *cfg) Authentication() *AuthConfig { } func defaultFor(key string) (string, bool) { - for _, co := range configOptions { + for _, co := range ConfigOptions() { if co.Key == key { return co.DefaultValue, true } @@ -276,6 +276,28 @@ func (a *AliasConfig) All() map[string]string { return out } +func fallbackConfig() *ghConfig.Config { + return ghConfig.ReadFromString(defaultConfigStr) +} + +const defaultConfigStr = ` +# What protocol to use when performing git operations. Supported values: ssh, https +git_protocol: https +# What editor gh should run when creating issues, pull requests, etc. If blank, will refer to environment. +editor: +# When to interactively prompt. This is a global config that cannot be overridden by hostname. Supported values: enabled, disabled +prompt: enabled +# A pager program to send command output to, e.g. "less". Set the value to "cat" to disable the pager. +pager: +# Aliases allow you to create nicknames for gh commands +aliases: + co: pr checkout +# The path to a unix socket through which send HTTP connections. If blank, HTTP traffic will be handled by net/http.DefaultTransport. +http_unix_socket: +# What web browser gh should use when opening URLs. If blank, will refer to environment. +browser: +` + type ConfigOption struct { Key string Description string @@ -283,43 +305,41 @@ type ConfigOption struct { AllowedValues []string } -var configOptions = []ConfigOption{ - { - Key: "git_protocol", - Description: "the protocol to use for git clone and push operations", - DefaultValue: "https", - AllowedValues: []string{"https", "ssh"}, - }, - { - Key: "editor", - Description: "the text editor program to use for authoring text", - DefaultValue: "", - }, - { - Key: "prompt", - Description: "toggle interactive prompting in the terminal", - DefaultValue: "enabled", - AllowedValues: []string{"enabled", "disabled"}, - }, - { - Key: "pager", - Description: "the terminal pager program to send standard output to", - DefaultValue: "", - }, - { - Key: "http_unix_socket", - Description: "the path to a Unix socket through which to make an HTTP connection", - DefaultValue: "", - }, - { - Key: "browser", - Description: "the web browser to use for opening URLs", - DefaultValue: "", - }, -} - func ConfigOptions() []ConfigOption { - return configOptions + return []ConfigOption{ + { + Key: "git_protocol", + Description: "the protocol to use for git clone and push operations", + DefaultValue: "https", + AllowedValues: []string{"https", "ssh"}, + }, + { + Key: "editor", + Description: "the text editor program to use for authoring text", + DefaultValue: "", + }, + { + Key: "prompt", + Description: "toggle interactive prompting in the terminal", + DefaultValue: "enabled", + AllowedValues: []string{"enabled", "disabled"}, + }, + { + Key: "pager", + Description: "the terminal pager program to send standard output to", + DefaultValue: "", + }, + { + Key: "http_unix_socket", + Description: "the path to a Unix socket through which to make an HTTP connection", + DefaultValue: "", + }, + { + Key: "browser", + Description: "the web browser to use for opening URLs", + DefaultValue: "", + }, + } } func HomeDirPath(subdir string) (string, error) { diff --git a/internal/config/config_test.go b/internal/config/config_test.go index df948a279..349a0db0b 100644 --- a/internal/config/config_test.go +++ b/internal/config/config_test.go @@ -14,6 +14,23 @@ func newTestConfig() *cfg { } } +func TestNewConfigProvidesFallback(t *testing.T) { + var spiedCfg *ghConfig.Config + ghConfig.Read = func(fallback *ghConfig.Config) (*ghConfig.Config, error) { + spiedCfg = fallback + return fallback, nil + } + _, err := NewConfig() + require.NoError(t, err) + requireKeyWithValue(t, spiedCfg, []string{"git_protocol"}, "https") + requireKeyWithValue(t, spiedCfg, []string{"editor"}, "") + requireKeyWithValue(t, spiedCfg, []string{"prompt"}, "enabled") + requireKeyWithValue(t, spiedCfg, []string{"pager"}, "") + requireKeyWithValue(t, spiedCfg, []string{"aliases", "co"}, "pr checkout") + requireKeyWithValue(t, spiedCfg, []string{"http_unix_socket"}, "") + requireKeyWithValue(t, spiedCfg, []string{"browser"}, "") +} + func TestGetNonExistentKey(t *testing.T) { // Given we have no top level configuration cfg := newTestConfig() @@ -133,3 +150,15 @@ func TestGetOrDefaultNotFoundAndNoDefault(t *testing.T) { require.ErrorAs(t, err, &keyNotFoundError) require.Empty(t, val) } + +func TestFallbackConfig(t *testing.T) { + cfg := fallbackConfig() + requireKeyWithValue(t, cfg, []string{"git_protocol"}, "https") + requireKeyWithValue(t, cfg, []string{"editor"}, "") + requireKeyWithValue(t, cfg, []string{"prompt"}, "enabled") + requireKeyWithValue(t, cfg, []string{"pager"}, "") + requireKeyWithValue(t, cfg, []string{"aliases", "co"}, "pr checkout") + requireKeyWithValue(t, cfg, []string{"http_unix_socket"}, "") + requireKeyWithValue(t, cfg, []string{"browser"}, "") + requireNoKey(t, cfg, []string{"unknown"}) +} diff --git a/internal/config/stub.go b/internal/config/stub.go index 5e37a8ccb..871cf1a16 100644 --- a/internal/config/stub.go +++ b/internal/config/stub.go @@ -10,24 +10,7 @@ import ( ) func NewBlankConfig() *ConfigMock { - defaultStr := ` -# What protocol to use when performing git operations. Supported values: ssh, https -git_protocol: https -# What editor gh should run when creating issues, pull requests, etc. If blank, will refer to environment. -editor: -# When to interactively prompt. This is a global config that cannot be overridden by hostname. Supported values: enabled, disabled -prompt: enabled -# A pager program to send command output to, e.g. "less". Set the value to "cat" to disable the pager. -pager: -# Aliases allow you to create nicknames for gh commands -aliases: - co: pr checkout -# The path to a unix socket through which send HTTP connections. If blank, HTTP traffic will be handled by net/http.DefaultTransport. -http_unix_socket: -# What web browser gh should use when opening URLs. If blank, will refer to environment. -browser: -` - return NewFromString(defaultStr) + return NewFromString(defaultConfigStr) } func NewFromString(cfgStr string) *ConfigMock { From ce7d89de0cdc8f2e63021f2d2e252e3d7ff7f3b6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 26 Oct 2023 08:44:31 +0200 Subject: [PATCH 095/527] build(deps): bump google.golang.org/grpc from 1.53.0 to 1.56.3 (#8251) Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.53.0 to 1.56.3. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](https://github.com/grpc/grpc-go/compare/v1.53.0...v1.56.3) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: direct:production ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- go.mod | 8 ++++---- go.sum | 20 ++++++++++---------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/go.mod b/go.mod index 91bfac2ad..e7840350b 100644 --- a/go.mod +++ b/go.mod @@ -40,8 +40,8 @@ require ( golang.org/x/sync v0.1.0 golang.org/x/term v0.13.0 golang.org/x/text v0.13.0 - google.golang.org/grpc v1.53.0 - google.golang.org/protobuf v1.28.1 + google.golang.org/grpc v1.56.3 + google.golang.org/protobuf v1.30.0 gopkg.in/h2non/gock.v1 v1.1.2 gopkg.in/yaml.v3 v3.0.1 ) @@ -59,7 +59,7 @@ require ( github.com/fatih/color v1.7.0 // indirect github.com/gdamore/encoding v1.0.0 // indirect github.com/godbus/dbus/v5 v5.1.0 // indirect - github.com/golang/protobuf v1.5.2 // indirect + github.com/golang/protobuf v1.5.3 // 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 @@ -84,6 +84,6 @@ require ( github.com/yuin/goldmark-emoji v1.0.1 // indirect golang.org/x/net v0.17.0 // indirect golang.org/x/sys v0.13.0 // indirect - google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f // indirect + google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 // indirect gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect ) diff --git a/go.sum b/go.sum index d77e0ef20..00aca879a 100644 --- a/go.sum +++ b/go.sum @@ -57,8 +57,8 @@ github.com/gdamore/tcell/v2 v2.5.4/go.mod h1:dZgRy5v4iMobMEcWNYBtREnDZAT9DYmfqIk github.com/godbus/dbus/v5 v5.1.0 h1:4KLkAxT3aOY8Li4FRJe/KvhoNFFxo0m6fNuFUO8QJUk= github.com/godbus/dbus/v5 v5.1.0/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/golang/protobuf v1.5.0/go.mod h1:FsONVRAS9T7sI+LIUmWTfcYkHO4aIWwzhcaSAoJOfIk= -github.com/golang/protobuf v1.5.2 h1:ROPKBNFfQgOUMifHyP+KYbvpjbdoFNs+aK7DXlji0Tw= -github.com/golang/protobuf v1.5.2/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= +github.com/golang/protobuf v1.5.3 h1:KhyjKVUg7Usr/dYsdSqoFveMYd5ko72D+zANwlG1mmg= +github.com/golang/protobuf v1.5.3/go.mod h1:XVQd3VNwM+JqD3oG2Ue2ip4fOMUkwXdXDdiuN0vRsmY= 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= @@ -186,8 +186,8 @@ golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug golang.org/x/net v0.0.0-20221002022538-bcab6841153b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= -golang.org/x/oauth2 v0.4.0 h1:NF0gk8LVPg1Ml7SSbGyySuoxdsXitj7TvgvuRxIMc/M= -golang.org/x/oauth2 v0.4.0/go.mod h1:RznEsdpjGAINPTOF0UH/t+xJ75L18YO3Ho6Pyn+uRec= +golang.org/x/oauth2 v0.7.0 h1:qe6s0zUXlPX80/dITx3440hWZ7GwMwgDDyrSGTPJG/g= +golang.org/x/oauth2 v0.7.0/go.mod h1:hPLQkd9LyjfXTiRohC/41GhcFqxisoUQ99sCUOHO9x4= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= @@ -232,14 +232,14 @@ golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8T golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c= google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= -google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f h1:BWUVssLB0HVOSY78gIdvk1dTVYtT1y8SBWtPYuTJ/6w= -google.golang.org/genproto v0.0.0-20230110181048-76db0878b65f/go.mod h1:RGgjbofJ8xD9Sq1VVhDM1Vok1vRONV+rg+CjzG4SZKM= -google.golang.org/grpc v1.53.0 h1:LAv2ds7cmFV/XTS3XG1NneeENYrXGmorPxsBbptIjNc= -google.golang.org/grpc v1.53.0/go.mod h1:OnIrk0ipVdj4N5d9IUoFUx72/VlD7+jUsHwZgwSMQpw= +google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 h1:KpwkzHKEF7B9Zxg18WzOa7djJ+Ha5DzthMyZYQfEn2A= +google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1/go.mod h1:nKE/iIaLqn2bQwXBg8f1g2Ylh6r5MN5CmZvuzZCgsCU= +google.golang.org/grpc v1.56.3 h1:8I4C0Yq1EjstUzUJzpcRVbuYA2mODtEmpWiQoN/b2nc= +google.golang.org/grpc v1.56.3/go.mod h1:I9bI3vqKfayGqPUAwGdOSu7kt6oIJLixfffKrpXqQ9s= google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw= google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc= -google.golang.org/protobuf v1.28.1 h1:d0NfwRgPtno5B1Wa6L2DAG+KivqkdutMf1UhdNx175w= -google.golang.org/protobuf v1.28.1/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= +google.golang.org/protobuf v1.30.0 h1:kPPoIgf3TsEvrm0PFe15JQ+570QVxYzEvvHqChK+cng= +google.golang.org/protobuf v1.30.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo= gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= From 792487831557c64be86059f937d982556b91cbda Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Fri, 27 Oct 2023 15:42:05 +0200 Subject: [PATCH 096/527] Fix git protocol and refactor Config interface (#8246) --- internal/config/auth_config_test.go | 28 +-- internal/config/config.go | 105 +++++++---- internal/config/config_mock.go | 280 ++++++++++++++++++++++++---- internal/config/config_test.go | 44 ++--- internal/config/stub.go | 33 +++- internal/prompter/prompter_mock.go | 44 ++--- pkg/cmd/auth/refresh/refresh.go | 2 +- pkg/cmd/auth/status/status.go | 2 +- pkg/cmd/extension/manager.go | 2 +- pkg/cmd/factory/default.go | 4 +- pkg/cmd/gist/clone/clone.go | 2 +- pkg/cmd/pr/checkout/checkout.go | 2 +- pkg/cmd/pr/create/create.go | 2 +- pkg/cmd/repo/clone/clone.go | 4 +- pkg/cmd/repo/create/create.go | 6 +- pkg/cmd/repo/fork/fork.go | 2 +- pkg/cmd/repo/rename/rename.go | 2 +- pkg/cmdutil/legacy.go | 2 +- 18 files changed, 407 insertions(+), 159 deletions(-) diff --git a/internal/config/auth_config_test.go b/internal/config/auth_config_test.go index 6d7e73c5c..afa47fbfd 100644 --- a/internal/config/auth_config_test.go +++ b/internal/config/auth_config_test.go @@ -158,17 +158,6 @@ func TestUserNotLoggedIn(t *testing.T) { require.ErrorAs(t, err, &keyNotFoundError) } -func TestGitProtocolNotLoggedInDefaults(t *testing.T) { - // Given we have not logged in - authCfg := newTestAuthConfig(t) - - // When we get the git protocol - gitProtocol := authCfg.GitProtocol("github.com") - - // Then it returns the default - require.Equal(t, "https", gitProtocol) -} - func TestHostsIncludesEnvVar(t *testing.T) { // Given the GH_HOST env var is set authCfg := newTestAuthConfig(t) @@ -217,7 +206,7 @@ func TestDefaultHostLoggedInToOnlyOneHost(t *testing.T) { // Then the returned host is that logged in host and the source is the hosts config require.Equal(t, "ghe.io", defaultHost) - require.Equal(t, "hosts", source) + require.Equal(t, hostsKey, source) } func TestLoginSecureStorageUsesKeyring(t *testing.T) { @@ -241,14 +230,14 @@ func TestLoginSecureStorageRemovesOldInsecureConfigToken(t *testing.T) { // Given a usable keyring and an oauth token in the config keyring.MockInit() authCfg := newTestAuthConfig(t) - authCfg.cfg.Set([]string{hosts, "github.com", oauthToken}, "old-token") + authCfg.cfg.Set([]string{hostsKey, "github.com", oauthTokenKey}, "old-token") // When we login with secure storage _, err := authCfg.Login("github.com", "test-user", "test-token", "", true) // Then it returns success, having also removed the old token from the config require.NoError(t, err) - requireNoKey(t, authCfg.cfg, []string{hosts, "github.com", oauthToken}) + requireNoKey(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}) } func TestLoginSecureStorageWithErrorFallsbackAndReports(t *testing.T) { @@ -263,7 +252,7 @@ func TestLoginSecureStorageWithErrorFallsbackAndReports(t *testing.T) { require.NoError(t, err) require.True(t, insecureStorageUsed, "expected to use insecure storage") - requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", oauthToken}, "test-token") + requireKeyWithValue(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}, "test-token") } func TestLoginInsecureStorage(t *testing.T) { @@ -277,7 +266,7 @@ func TestLoginInsecureStorage(t *testing.T) { require.NoError(t, err) require.True(t, insecureStorageUsed, "expected to use insecure storage") - requireKeyWithValue(t, authCfg.cfg, []string{hosts, "github.com", oauthToken}, "test-token") + requireKeyWithValue(t, authCfg.cfg, []string{hostsKey, "github.com", oauthTokenKey}, "test-token") } func TestLoginSetsUserForProvidedHost(t *testing.T) { @@ -302,10 +291,11 @@ func TestLoginSetsGitProtocolForProvidedHost(t *testing.T) { require.NoError(t, err) // When we get the git protocol - gitProtocol := authCfg.GitProtocol("github.com") + protocol, err := authCfg.cfg.Get([]string{hostsKey, "github.com", gitProtocolKey}) + require.NoError(t, err) // Then it returns the git protocol we provided on login - require.Equal(t, "ssh", gitProtocol) + require.Equal(t, "ssh", protocol) } func TestLoginAddsHostIfNotAlreadyAdded(t *testing.T) { @@ -334,7 +324,7 @@ func TestLogoutRemovesHostAndKeyringToken(t *testing.T) { // Then we return success, and the host and token are removed from the config and keyring require.NoError(t, err) - requireNoKey(t, authCfg.cfg, []string{hosts, "github.com"}) + requireNoKey(t, authCfg.cfg, []string{hostsKey, "github.com"}) _, err = keyring.Get(keyringServiceName("github.com"), "") require.ErrorIs(t, err, keyring.ErrNotFound) } diff --git a/internal/config/config.go b/internal/config/config.go index 32475a5d8..4e48c8a83 100644 --- a/internal/config/config.go +++ b/internal/config/config.go @@ -10,22 +10,33 @@ import ( ) const ( - aliases = "aliases" - hosts = "hosts" - oauthToken = "oauth_token" + aliasesKey = "aliases" + browserKey = "browser" + editorKey = "editor" + gitProtocolKey = "git_protocol" + hostsKey = "hosts" + httpUnixSocketKey = "http_unix_socket" + oauthTokenKey = "oauth_token" + pagerKey = "pager" + promptKey = "prompt" ) // This interface describes interacting with some persistent configuration for gh. // //go:generate moq -rm -out config_mock.go . Config type Config interface { - Get(string, string) (string, error) GetOrDefault(string, string) (string, error) Set(string, string, string) Write() error Aliases() *AliasConfig Authentication() *AuthConfig + Browser(string) string + Editor(string) string + GitProtocol(string) string + HTTPUnixSocket(string) string + Pager(string) string + Prompt(string) string } func NewConfig() (Config, error) { @@ -43,7 +54,7 @@ type cfg struct { func (c *cfg) Get(hostname, key string) (string, error) { if hostname != "" { - val, err := c.cfg.Get([]string{hosts, hostname, key}) + val, err := c.cfg.Get([]string{hostsKey, hostname, key}) if err == nil { return val, err } @@ -70,7 +81,7 @@ func (c *cfg) Set(hostname, key, value string) { c.cfg.Set([]string{key}, value) return } - c.cfg.Set([]string{hosts, hostname, key}, value) + c.cfg.Set([]string{hostsKey, hostname, key}, value) } func (c *cfg) Write() error { @@ -85,6 +96,36 @@ func (c *cfg) Authentication() *AuthConfig { return &AuthConfig{cfg: c.cfg} } +func (c *cfg) Browser(hostname string) string { + val, _ := c.GetOrDefault(hostname, browserKey) + return val +} + +func (c *cfg) Editor(hostname string) string { + val, _ := c.GetOrDefault(hostname, editorKey) + return val +} + +func (c *cfg) GitProtocol(hostname string) string { + val, _ := c.GetOrDefault(hostname, gitProtocolKey) + return val +} + +func (c *cfg) HTTPUnixSocket(hostname string) string { + val, _ := c.GetOrDefault(hostname, httpUnixSocketKey) + return val +} + +func (c *cfg) Pager(hostname string) string { + val, _ := c.GetOrDefault(hostname, pagerKey) + return val +} + +func (c *cfg) Prompt(hostname string) string { + val, _ := c.GetOrDefault(hostname, promptKey) + return val +} + func defaultFor(key string) (string, bool) { for _, co := range ConfigOptions() { if co.Key == key { @@ -159,25 +200,7 @@ func (c *AuthConfig) TokenFromKeyring(hostname string) (string, error) { // User will retrieve the username for the logged in user at the given hostname. func (c *AuthConfig) User(hostname string) (string, error) { - return c.cfg.Get([]string{hosts, hostname, "user"}) -} - -// GitProtocol will retrieve the git protocol for the logged in user at the given hostname. -// If none is set it will return the default value. -func (c *AuthConfig) GitProtocol(hostname string) string { - key := "git_protocol" - if val, err := c.cfg.Get([]string{hosts, hostname, key}); err == nil { - return val - } - - if val, ok := defaultFor(key); ok { - return val - } - - // This should not happen, as we know there is a default value for this key. - // Perhaps it says something about our current default abstraction being not quite right? - // The defaults are also currently used to provide information about the config options. - return "" + return c.cfg.Get([]string{hostsKey, hostname, "user"}) } func (c *AuthConfig) Hosts() []string { @@ -218,19 +241,19 @@ func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secure if secureStorage { if setErr = keyring.Set(keyringServiceName(hostname), "", token); setErr == nil { // Clean up the previous oauth_token from the config file. - _ = c.cfg.Remove([]string{hosts, hostname, oauthToken}) + _ = c.cfg.Remove([]string{hostsKey, hostname, oauthTokenKey}) } } insecureStorageUsed := false if !secureStorage || setErr != nil { - c.cfg.Set([]string{hosts, hostname, oauthToken}, token) + c.cfg.Set([]string{hostsKey, hostname, oauthTokenKey}, token) insecureStorageUsed = true } - c.cfg.Set([]string{hosts, hostname, "user"}, username) + c.cfg.Set([]string{hostsKey, hostname, "user"}, username) if gitProtocol != "" { - c.cfg.Set([]string{hosts, hostname, "git_protocol"}, gitProtocol) + c.cfg.Set([]string{hostsKey, hostname, gitProtocolKey}, gitProtocol) } return insecureStorageUsed, ghConfig.Write(c.cfg) } @@ -238,7 +261,7 @@ func (c *AuthConfig) Login(hostname, username, token, gitProtocol string, secure // Logout will remove user, git protocol, and auth token for the given hostname. // It will remove the auth token from the encrypted storage if it exists there. func (c *AuthConfig) Logout(hostname string) error { - _ = c.cfg.Remove([]string{hosts, hostname}) + _ = c.cfg.Remove([]string{hostsKey, hostname}) _ = keyring.Delete(keyringServiceName(hostname), "") return ghConfig.Write(c.cfg) } @@ -252,25 +275,25 @@ type AliasConfig struct { } func (a *AliasConfig) Get(alias string) (string, error) { - return a.cfg.Get([]string{aliases, alias}) + return a.cfg.Get([]string{aliasesKey, alias}) } func (a *AliasConfig) Add(alias, expansion string) { - a.cfg.Set([]string{aliases, alias}, expansion) + a.cfg.Set([]string{aliasesKey, alias}, expansion) } func (a *AliasConfig) Delete(alias string) error { - return a.cfg.Remove([]string{aliases, alias}) + return a.cfg.Remove([]string{aliasesKey, alias}) } func (a *AliasConfig) All() map[string]string { out := map[string]string{} - keys, err := a.cfg.Keys([]string{aliases}) + keys, err := a.cfg.Keys([]string{aliasesKey}) if err != nil { return out } for _, key := range keys { - val, _ := a.cfg.Get([]string{aliases, key}) + val, _ := a.cfg.Get([]string{aliasesKey, key}) out[key] = val } return out @@ -308,34 +331,34 @@ type ConfigOption struct { func ConfigOptions() []ConfigOption { return []ConfigOption{ { - Key: "git_protocol", + Key: gitProtocolKey, Description: "the protocol to use for git clone and push operations", DefaultValue: "https", AllowedValues: []string{"https", "ssh"}, }, { - Key: "editor", + Key: editorKey, Description: "the text editor program to use for authoring text", DefaultValue: "", }, { - Key: "prompt", + Key: promptKey, Description: "toggle interactive prompting in the terminal", DefaultValue: "enabled", AllowedValues: []string{"enabled", "disabled"}, }, { - Key: "pager", + Key: pagerKey, Description: "the terminal pager program to send standard output to", DefaultValue: "", }, { - Key: "http_unix_socket", + Key: httpUnixSocketKey, Description: "the path to a Unix socket through which to make an HTTP connection", DefaultValue: "", }, { - Key: "browser", + Key: browserKey, Description: "the web browser to use for opening URLs", DefaultValue: "", }, diff --git a/internal/config/config_mock.go b/internal/config/config_mock.go index 6fd76dc55..aff4cb9d4 100644 --- a/internal/config/config_mock.go +++ b/internal/config/config_mock.go @@ -23,12 +23,27 @@ var _ Config = &ConfigMock{} // AuthenticationFunc: func() *AuthConfig { // panic("mock out the Authentication method") // }, -// GetFunc: func(s1 string, s2 string) (string, error) { -// panic("mock out the Get method") +// BrowserFunc: func(s string) string { +// panic("mock out the Browser method") +// }, +// EditorFunc: func(s string) string { +// panic("mock out the Editor method") // }, // GetOrDefaultFunc: func(s1 string, s2 string) (string, error) { // panic("mock out the GetOrDefault method") // }, +// GitProtocolFunc: func(s string) string { +// panic("mock out the GitProtocol method") +// }, +// HTTPUnixSocketFunc: func(s string) string { +// panic("mock out the HTTPUnixSocket method") +// }, +// PagerFunc: func(s string) string { +// panic("mock out the Pager method") +// }, +// PromptFunc: func(s string) string { +// panic("mock out the Prompt method") +// }, // SetFunc: func(s1 string, s2 string, s3 string) { // panic("mock out the Set method") // }, @@ -48,12 +63,27 @@ type ConfigMock struct { // AuthenticationFunc mocks the Authentication method. AuthenticationFunc func() *AuthConfig - // GetFunc mocks the Get method. - GetFunc func(s1 string, s2 string) (string, error) + // BrowserFunc mocks the Browser method. + BrowserFunc func(s string) string + + // EditorFunc mocks the Editor method. + EditorFunc func(s string) string // GetOrDefaultFunc mocks the GetOrDefault method. GetOrDefaultFunc func(s1 string, s2 string) (string, error) + // GitProtocolFunc mocks the GitProtocol method. + GitProtocolFunc func(s string) string + + // HTTPUnixSocketFunc mocks the HTTPUnixSocket method. + HTTPUnixSocketFunc func(s string) string + + // PagerFunc mocks the Pager method. + PagerFunc func(s string) string + + // PromptFunc mocks the Prompt method. + PromptFunc func(s string) string + // SetFunc mocks the Set method. SetFunc func(s1 string, s2 string, s3 string) @@ -68,12 +98,15 @@ type ConfigMock struct { // Authentication holds details about calls to the Authentication method. Authentication []struct { } - // Get holds details about calls to the Get method. - Get []struct { - // S1 is the s1 argument value. - S1 string - // S2 is the s2 argument value. - S2 string + // Browser holds details about calls to the Browser method. + Browser []struct { + // S is the s argument value. + S string + } + // Editor holds details about calls to the Editor method. + Editor []struct { + // S is the s argument value. + S string } // GetOrDefault holds details about calls to the GetOrDefault method. GetOrDefault []struct { @@ -82,6 +115,26 @@ type ConfigMock struct { // S2 is the s2 argument value. S2 string } + // GitProtocol holds details about calls to the GitProtocol method. + GitProtocol []struct { + // S is the s argument value. + S string + } + // HTTPUnixSocket holds details about calls to the HTTPUnixSocket method. + HTTPUnixSocket []struct { + // S is the s argument value. + S string + } + // Pager holds details about calls to the Pager method. + Pager []struct { + // S is the s argument value. + S string + } + // Prompt holds details about calls to the Prompt method. + Prompt []struct { + // S is the s argument value. + S string + } // Set holds details about calls to the Set method. Set []struct { // S1 is the s1 argument value. @@ -97,8 +150,13 @@ type ConfigMock struct { } lockAliases sync.RWMutex lockAuthentication sync.RWMutex - lockGet sync.RWMutex + lockBrowser sync.RWMutex + lockEditor sync.RWMutex lockGetOrDefault sync.RWMutex + lockGitProtocol sync.RWMutex + lockHTTPUnixSocket sync.RWMutex + lockPager sync.RWMutex + lockPrompt sync.RWMutex lockSet sync.RWMutex lockWrite sync.RWMutex } @@ -157,39 +215,67 @@ func (mock *ConfigMock) AuthenticationCalls() []struct { return calls } -// Get calls GetFunc. -func (mock *ConfigMock) Get(s1 string, s2 string) (string, error) { - if mock.GetFunc == nil { - panic("ConfigMock.GetFunc: method is nil but Config.Get was just called") +// Browser calls BrowserFunc. +func (mock *ConfigMock) Browser(s string) string { + if mock.BrowserFunc == nil { + panic("ConfigMock.BrowserFunc: method is nil but Config.Browser was just called") } callInfo := struct { - S1 string - S2 string + S string }{ - S1: s1, - S2: s2, + S: s, } - mock.lockGet.Lock() - mock.calls.Get = append(mock.calls.Get, callInfo) - mock.lockGet.Unlock() - return mock.GetFunc(s1, s2) + mock.lockBrowser.Lock() + mock.calls.Browser = append(mock.calls.Browser, callInfo) + mock.lockBrowser.Unlock() + return mock.BrowserFunc(s) } -// GetCalls gets all the calls that were made to Get. +// BrowserCalls gets all the calls that were made to Browser. // Check the length with: // -// len(mockedConfig.GetCalls()) -func (mock *ConfigMock) GetCalls() []struct { - S1 string - S2 string +// len(mockedConfig.BrowserCalls()) +func (mock *ConfigMock) BrowserCalls() []struct { + S string } { var calls []struct { - S1 string - S2 string + S string } - mock.lockGet.RLock() - calls = mock.calls.Get - mock.lockGet.RUnlock() + mock.lockBrowser.RLock() + calls = mock.calls.Browser + mock.lockBrowser.RUnlock() + return calls +} + +// Editor calls EditorFunc. +func (mock *ConfigMock) Editor(s string) string { + if mock.EditorFunc == nil { + panic("ConfigMock.EditorFunc: method is nil but Config.Editor was just called") + } + callInfo := struct { + S string + }{ + S: s, + } + mock.lockEditor.Lock() + mock.calls.Editor = append(mock.calls.Editor, callInfo) + mock.lockEditor.Unlock() + return mock.EditorFunc(s) +} + +// EditorCalls gets all the calls that were made to Editor. +// Check the length with: +// +// len(mockedConfig.EditorCalls()) +func (mock *ConfigMock) EditorCalls() []struct { + S string +} { + var calls []struct { + S string + } + mock.lockEditor.RLock() + calls = mock.calls.Editor + mock.lockEditor.RUnlock() return calls } @@ -229,6 +315,134 @@ func (mock *ConfigMock) GetOrDefaultCalls() []struct { return calls } +// GitProtocol calls GitProtocolFunc. +func (mock *ConfigMock) GitProtocol(s string) string { + if mock.GitProtocolFunc == nil { + panic("ConfigMock.GitProtocolFunc: method is nil but Config.GitProtocol was just called") + } + callInfo := struct { + S string + }{ + S: s, + } + mock.lockGitProtocol.Lock() + mock.calls.GitProtocol = append(mock.calls.GitProtocol, callInfo) + mock.lockGitProtocol.Unlock() + return mock.GitProtocolFunc(s) +} + +// GitProtocolCalls gets all the calls that were made to GitProtocol. +// Check the length with: +// +// len(mockedConfig.GitProtocolCalls()) +func (mock *ConfigMock) GitProtocolCalls() []struct { + S string +} { + var calls []struct { + S string + } + mock.lockGitProtocol.RLock() + calls = mock.calls.GitProtocol + mock.lockGitProtocol.RUnlock() + return calls +} + +// HTTPUnixSocket calls HTTPUnixSocketFunc. +func (mock *ConfigMock) HTTPUnixSocket(s string) string { + if mock.HTTPUnixSocketFunc == nil { + panic("ConfigMock.HTTPUnixSocketFunc: method is nil but Config.HTTPUnixSocket was just called") + } + callInfo := struct { + S string + }{ + S: s, + } + mock.lockHTTPUnixSocket.Lock() + mock.calls.HTTPUnixSocket = append(mock.calls.HTTPUnixSocket, callInfo) + mock.lockHTTPUnixSocket.Unlock() + return mock.HTTPUnixSocketFunc(s) +} + +// HTTPUnixSocketCalls gets all the calls that were made to HTTPUnixSocket. +// Check the length with: +// +// len(mockedConfig.HTTPUnixSocketCalls()) +func (mock *ConfigMock) HTTPUnixSocketCalls() []struct { + S string +} { + var calls []struct { + S string + } + mock.lockHTTPUnixSocket.RLock() + calls = mock.calls.HTTPUnixSocket + mock.lockHTTPUnixSocket.RUnlock() + return calls +} + +// Pager calls PagerFunc. +func (mock *ConfigMock) Pager(s string) string { + if mock.PagerFunc == nil { + panic("ConfigMock.PagerFunc: method is nil but Config.Pager was just called") + } + callInfo := struct { + S string + }{ + S: s, + } + mock.lockPager.Lock() + mock.calls.Pager = append(mock.calls.Pager, callInfo) + mock.lockPager.Unlock() + return mock.PagerFunc(s) +} + +// PagerCalls gets all the calls that were made to Pager. +// Check the length with: +// +// len(mockedConfig.PagerCalls()) +func (mock *ConfigMock) PagerCalls() []struct { + S string +} { + var calls []struct { + S string + } + mock.lockPager.RLock() + calls = mock.calls.Pager + mock.lockPager.RUnlock() + return calls +} + +// Prompt calls PromptFunc. +func (mock *ConfigMock) Prompt(s string) string { + if mock.PromptFunc == nil { + panic("ConfigMock.PromptFunc: method is nil but Config.Prompt was just called") + } + callInfo := struct { + S string + }{ + S: s, + } + mock.lockPrompt.Lock() + mock.calls.Prompt = append(mock.calls.Prompt, callInfo) + mock.lockPrompt.Unlock() + return mock.PromptFunc(s) +} + +// PromptCalls gets all the calls that were made to Prompt. +// Check the length with: +// +// len(mockedConfig.PromptCalls()) +func (mock *ConfigMock) PromptCalls() []struct { + S string +} { + var calls []struct { + S string + } + mock.lockPrompt.RLock() + calls = mock.calls.Prompt + mock.lockPrompt.RUnlock() + return calls +} + // Set calls SetFunc. func (mock *ConfigMock) Set(s1 string, s2 string, s3 string) { if mock.SetFunc == nil { diff --git a/internal/config/config_test.go b/internal/config/config_test.go index 349a0db0b..6acc32245 100644 --- a/internal/config/config_test.go +++ b/internal/config/config_test.go @@ -22,13 +22,13 @@ func TestNewConfigProvidesFallback(t *testing.T) { } _, err := NewConfig() require.NoError(t, err) - requireKeyWithValue(t, spiedCfg, []string{"git_protocol"}, "https") - requireKeyWithValue(t, spiedCfg, []string{"editor"}, "") - requireKeyWithValue(t, spiedCfg, []string{"prompt"}, "enabled") - requireKeyWithValue(t, spiedCfg, []string{"pager"}, "") - requireKeyWithValue(t, spiedCfg, []string{"aliases", "co"}, "pr checkout") - requireKeyWithValue(t, spiedCfg, []string{"http_unix_socket"}, "") - requireKeyWithValue(t, spiedCfg, []string{"browser"}, "") + requireKeyWithValue(t, spiedCfg, []string{gitProtocolKey}, "https") + requireKeyWithValue(t, spiedCfg, []string{editorKey}, "") + requireKeyWithValue(t, spiedCfg, []string{promptKey}, "enabled") + requireKeyWithValue(t, spiedCfg, []string{pagerKey}, "") + requireKeyWithValue(t, spiedCfg, []string{aliasesKey, "co"}, "pr checkout") + requireKeyWithValue(t, spiedCfg, []string{httpUnixSocketKey}, "") + requireKeyWithValue(t, spiedCfg, []string{browserKey}, "") } func TestGetNonExistentKey(t *testing.T) { @@ -101,12 +101,12 @@ func TestGetOrDefaultApplicationDefaults(t *testing.T) { key string expectedDefault string }{ - {"git_protocol", "https"}, - {"editor", ""}, - {"prompt", "enabled"}, - {"pager", ""}, - {"http_unix_socket", ""}, - {"browser", ""}, + {gitProtocolKey, "https"}, + {editorKey, ""}, + {promptKey, "enabled"}, + {pagerKey, ""}, + {httpUnixSocketKey, ""}, + {browserKey, ""}, } for _, tt := range tests { @@ -127,10 +127,10 @@ func TestGetOrDefaultApplicationDefaults(t *testing.T) { func TestGetOrDefaultExistingKey(t *testing.T) { // Given have a top level config entry cfg := newTestConfig() - cfg.Set("", "git_protocol", "ssh") + cfg.Set("", gitProtocolKey, "ssh") // When we get that key - val, err := cfg.GetOrDefault("", "git_protocol") + val, err := cfg.GetOrDefault("", gitProtocolKey) // Then it returns successfully with the correct value, and doesn't fall back // to the default @@ -153,12 +153,12 @@ func TestGetOrDefaultNotFoundAndNoDefault(t *testing.T) { func TestFallbackConfig(t *testing.T) { cfg := fallbackConfig() - requireKeyWithValue(t, cfg, []string{"git_protocol"}, "https") - requireKeyWithValue(t, cfg, []string{"editor"}, "") - requireKeyWithValue(t, cfg, []string{"prompt"}, "enabled") - requireKeyWithValue(t, cfg, []string{"pager"}, "") - requireKeyWithValue(t, cfg, []string{"aliases", "co"}, "pr checkout") - requireKeyWithValue(t, cfg, []string{"http_unix_socket"}, "") - requireKeyWithValue(t, cfg, []string{"browser"}, "") + requireKeyWithValue(t, cfg, []string{gitProtocolKey}, "https") + requireKeyWithValue(t, cfg, []string{editorKey}, "") + requireKeyWithValue(t, cfg, []string{promptKey}, "enabled") + requireKeyWithValue(t, cfg, []string{pagerKey}, "") + requireKeyWithValue(t, cfg, []string{aliasesKey, "co"}, "pr checkout") + requireKeyWithValue(t, cfg, []string{httpUnixSocketKey}, "") + requireKeyWithValue(t, cfg, []string{browserKey}, "") requireNoKey(t, cfg, []string{"unknown"}) } diff --git a/internal/config/stub.go b/internal/config/stub.go index 871cf1a16..143c9b870 100644 --- a/internal/config/stub.go +++ b/internal/config/stub.go @@ -17,9 +17,6 @@ func NewFromString(cfgStr string) *ConfigMock { c := ghConfig.ReadFromString(cfgStr) cfg := cfg{c} mock := &ConfigMock{} - mock.GetFunc = func(host, key string) (string, error) { - return cfg.Get(host, key) - } mock.GetOrDefaultFunc = func(host, key string) (string, error) { return cfg.GetOrDefault(host, key) } @@ -39,15 +36,39 @@ func NewFromString(cfgStr string) *ConfigMock { return "github.com", "default" }, hostsOverride: func() []string { - keys, _ := c.Keys([]string{"hosts"}) + keys, _ := c.Keys([]string{hostsKey}) return keys }, tokenOverride: func(hostname string) (string, string) { - token, _ := c.Get([]string{hosts, hostname, oauthToken}) - return token, "oauth_token" + token, _ := c.Get([]string{hostsKey, hostname, oauthTokenKey}) + return token, oauthTokenKey }, } } + mock.BrowserFunc = func(hostname string) string { + val, _ := cfg.GetOrDefault(hostname, browserKey) + return val + } + mock.EditorFunc = func(hostname string) string { + val, _ := cfg.GetOrDefault(hostname, editorKey) + return val + } + mock.GitProtocolFunc = func(hostname string) string { + val, _ := cfg.GetOrDefault(hostname, gitProtocolKey) + return val + } + mock.HTTPUnixSocketFunc = func(hostname string) string { + val, _ := cfg.GetOrDefault(hostname, httpUnixSocketKey) + return val + } + mock.PagerFunc = func(hostname string) string { + val, _ := cfg.GetOrDefault(hostname, pagerKey) + return val + } + mock.PromptFunc = func(hostname string) string { + val, _ := cfg.GetOrDefault(hostname, promptKey) + return val + } return mock } diff --git a/internal/prompter/prompter_mock.go b/internal/prompter/prompter_mock.go index 9a59a7bd1..b817a491f 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) ([]int, error) { +// MultiSelectFunc: func(prompt string, defaults []string, options []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) ([]int, error) + MultiSelectFunc func(prompt string, defaults []string, options []string) ([]int, 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 { - // S is the s argument value. - S string - // Strings1 is the strings1 argument value. - Strings1 []string - // Strings2 is the strings2 argument value. - Strings2 []string + // Prompt is the prompt argument value. + Prompt string + // Defaults is the defaults argument value. + Defaults []string + // Options is the options argument value. + Options []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(s string, strings1 []string, strings2 []string) ([]int, error) { +func (mock *PrompterMock) MultiSelect(prompt string, defaults []string, options []string) ([]int, error) { if mock.MultiSelectFunc == nil { panic("PrompterMock.MultiSelectFunc: method is nil but Prompter.MultiSelect was just called") } callInfo := struct { - S string - Strings1 []string - Strings2 []string + Prompt string + Defaults []string + Options []string }{ - S: s, - Strings1: strings1, - Strings2: strings2, + Prompt: prompt, + Defaults: defaults, + Options: options, } mock.lockMultiSelect.Lock() mock.calls.MultiSelect = append(mock.calls.MultiSelect, callInfo) mock.lockMultiSelect.Unlock() - return mock.MultiSelectFunc(s, strings1, strings2) + return mock.MultiSelectFunc(prompt, defaults, options) } // MultiSelectCalls gets all the calls that were made to MultiSelect. @@ -372,14 +372,14 @@ func (mock *PrompterMock) MultiSelect(s string, strings1 []string, strings2 []st // // len(mockedPrompter.MultiSelectCalls()) func (mock *PrompterMock) MultiSelectCalls() []struct { - S string - Strings1 []string - Strings2 []string + Prompt string + Defaults []string + Options []string } { var calls []struct { - S string - Strings1 []string - Strings2 []string + Prompt string + Defaults []string + Options []string } mock.lockMultiSelect.RLock() calls = mock.calls.MultiSelect diff --git a/pkg/cmd/auth/refresh/refresh.go b/pkg/cmd/auth/refresh/refresh.go index 30b5a3ff0..870871284 100644 --- a/pkg/cmd/auth/refresh/refresh.go +++ b/pkg/cmd/auth/refresh/refresh.go @@ -178,7 +178,7 @@ func refreshRun(opts *RefreshOptions) error { Prompter: opts.Prompter, GitClient: opts.GitClient, } - gitProtocol := authCfg.GitProtocol(hostname) + gitProtocol := cfg.GitProtocol(hostname) if opts.Interactive && gitProtocol == "https" { if err := credentialFlow.Prompt(hostname); err != nil { return err diff --git a/pkg/cmd/auth/status/status.go b/pkg/cmd/auth/status/status.go index bde74306a..a064aabc2 100644 --- a/pkg/cmd/auth/status/status.go +++ b/pkg/cmd/auth/status/status.go @@ -139,7 +139,7 @@ func statusRun(opts *StatusOptions) error { } addMsg("%s Logged in to %s as %s (%s)", cs.SuccessIcon(), hostname, cs.Bold(username), tokenSource) - proto := authCfg.GitProtocol(hostname) + proto := cfg.GitProtocol(hostname) if proto != "" { addMsg("%s Git operations for %s configured to use %s protocol.", cs.SuccessIcon(), hostname, cs.Bold(proto)) diff --git a/pkg/cmd/extension/manager.go b/pkg/cmd/extension/manager.go index b19175880..a8d0db844 100644 --- a/pkg/cmd/extension/manager.go +++ b/pkg/cmd/extension/manager.go @@ -346,7 +346,7 @@ func writeManifest(dir, name string, data []byte) (writeErr error) { } func (m *Manager) installGit(repo ghrepo.Interface, target string) error { - protocol, _ := m.config.GetOrDefault(repo.RepoHost(), "git_protocol") + protocol := m.config.GitProtocol(repo.RepoHost()) cloneURL := ghrepo.FormatRemoteURL(repo, protocol) var commitSHA string diff --git a/pkg/cmd/factory/default.go b/pkg/cmd/factory/default.go index a24dc20fb..dc5b37138 100644 --- a/pkg/cmd/factory/default.go +++ b/pkg/cmd/factory/default.go @@ -184,7 +184,7 @@ func ioStreams(f *cmdutil.Factory) *iostreams.IOStreams { if _, ghPromptDisabled := os.LookupEnv("GH_PROMPT_DISABLED"); ghPromptDisabled { io.SetNeverPrompt(true) - } else if prompt, _ := cfg.GetOrDefault("", "prompt"); prompt == "disabled" { + } else if prompt := cfg.Prompt(""); prompt == "disabled" { io.SetNeverPrompt(true) } @@ -194,7 +194,7 @@ func ioStreams(f *cmdutil.Factory) *iostreams.IOStreams { // 3. PAGER if ghPager, ghPagerExists := os.LookupEnv("GH_PAGER"); ghPagerExists { io.SetPager(ghPager) - } else if pager, _ := cfg.Get("", "pager"); pager != "" { + } else if pager := cfg.Pager(""); pager != "" { io.SetPager(pager) } diff --git a/pkg/cmd/gist/clone/clone.go b/pkg/cmd/gist/clone/clone.go index cd477a745..d83560f40 100644 --- a/pkg/cmd/gist/clone/clone.go +++ b/pkg/cmd/gist/clone/clone.go @@ -80,7 +80,7 @@ func cloneRun(opts *CloneOptions) error { return err } hostname, _ := cfg.Authentication().DefaultHost() - protocol := cfg.Authentication().GitProtocol(hostname) + protocol := cfg.GitProtocol(hostname) gistURL = formatRemoteURL(hostname, gistURL, protocol) } diff --git a/pkg/cmd/pr/checkout/checkout.go b/pkg/cmd/pr/checkout/checkout.go index b91fb1765..389d554be 100644 --- a/pkg/cmd/pr/checkout/checkout.go +++ b/pkg/cmd/pr/checkout/checkout.go @@ -84,7 +84,7 @@ func checkoutRun(opts *CheckoutOptions) error { if err != nil { return err } - protocol := cfg.Authentication().GitProtocol(baseRepo.RepoHost()) + protocol := cfg.GitProtocol(baseRepo.RepoHost()) remotes, err := opts.Remotes() if err != nil { diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index 81b2c05f3..890171860 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -761,7 +761,7 @@ func handlePush(opts CreateOptions, ctx CreateContext) error { return err } - cloneProtocol := cfg.Authentication().GitProtocol(headRepo.RepoHost()) + cloneProtocol := cfg.GitProtocol(headRepo.RepoHost()) headRepoURL := ghrepo.FormatRemoteURL(headRepo, cloneProtocol) gitClient := ctx.GitClient origin, _ := remotes.FindByName("origin") diff --git a/pkg/cmd/repo/clone/clone.go b/pkg/cmd/repo/clone/clone.go index 298ca30de..b6def2edd 100644 --- a/pkg/cmd/repo/clone/clone.go +++ b/pkg/cmd/repo/clone/clone.go @@ -129,7 +129,7 @@ func cloneRun(opts *CloneOptions) error { return err } - protocol = cfg.Authentication().GitProtocol(repo.RepoHost()) + protocol = cfg.GitProtocol(repo.RepoHost()) } wantsWiki := strings.HasSuffix(repo.RepoName(), ".wiki") @@ -163,7 +163,7 @@ func cloneRun(opts *CloneOptions) error { // If the repo is a fork, add the parent as an upstream remote and set the parent as the default repo. if canonicalRepo.Parent != nil { - protocol := cfg.Authentication().GitProtocol(canonicalRepo.Parent.RepoHost()) + protocol := cfg.GitProtocol(canonicalRepo.Parent.RepoHost()) upstreamURL := ghrepo.FormatRemoteURL(canonicalRepo.Parent, protocol) upstreamName := opts.UpstreamName diff --git a/pkg/cmd/repo/create/create.go b/pkg/cmd/repo/create/create.go index c96aeb3f9..a2e7b82c8 100644 --- a/pkg/cmd/repo/create/create.go +++ b/pkg/cmd/repo/create/create.go @@ -395,7 +395,7 @@ func createFromScratch(opts *CreateOptions) error { } if opts.Clone { - protocol := cfg.Authentication().GitProtocol(repo.RepoHost()) + protocol := cfg.GitProtocol(repo.RepoHost()) remoteURL := ghrepo.FormatRemoteURL(repo, protocol) if !opts.AddReadme && opts.LicenseTemplate == "" && opts.GitIgnoreTemplate == "" && opts.Template == "" { @@ -492,7 +492,7 @@ func createFromTemplate(opts *CreateOptions) error { } if opts.Clone { - protocol := cfg.Authentication().GitProtocol(repo.RepoHost()) + protocol := cfg.GitProtocol(repo.RepoHost()) remoteURL := ghrepo.FormatRemoteURL(repo, protocol) if err := cloneWithRetry(opts, remoteURL, templateRepoMainBranch); err != nil { @@ -614,7 +614,7 @@ func createFromLocal(opts *CreateOptions) error { fmt.Fprintln(stdout, repo.URL) } - protocol := cfg.Authentication().GitProtocol(repo.RepoHost()) + protocol := cfg.GitProtocol(repo.RepoHost()) remoteURL := ghrepo.FormatRemoteURL(repo, protocol) if opts.Interactive { diff --git a/pkg/cmd/repo/fork/fork.go b/pkg/cmd/repo/fork/fork.go index e31a6a3c9..73fa906a6 100644 --- a/pkg/cmd/repo/fork/fork.go +++ b/pkg/cmd/repo/fork/fork.go @@ -243,7 +243,7 @@ func forkRun(opts *ForkOptions) error { if err != nil { return err } - protocol, _ := cfg.Get(repoToFork.RepoHost(), "git_protocol") + protocol := cfg.GitProtocol(repoToFork.RepoHost()) gitClient := opts.GitClient ctx := context.Background() diff --git a/pkg/cmd/repo/rename/rename.go b/pkg/cmd/repo/rename/rename.go index 8dbc1326d..d15f2efdf 100644 --- a/pkg/cmd/repo/rename/rename.go +++ b/pkg/cmd/repo/rename/rename.go @@ -149,7 +149,7 @@ func updateRemote(repo ghrepo.Interface, renamed ghrepo.Interface, opts *RenameO return nil, err } - protocol := cfg.Authentication().GitProtocol(repo.RepoHost()) + protocol := cfg.GitProtocol(repo.RepoHost()) remotes, err := opts.Remotes() if err != nil { diff --git a/pkg/cmdutil/legacy.go b/pkg/cmdutil/legacy.go index 19400f1cc..1f247d4e6 100644 --- a/pkg/cmdutil/legacy.go +++ b/pkg/cmdutil/legacy.go @@ -16,7 +16,7 @@ func DetermineEditor(cf func() (config.Config, error)) (string, error) { if err != nil { return "", fmt.Errorf("could not read config: %w", err) } - editorCommand, _ = cfg.Get("", "editor") + editorCommand = cfg.Editor("") } return editorCommand, nil From 500f3595921d65d2c866ca4c003b7d4b83e673b7 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Mon, 30 Oct 2023 11:22:38 -0700 Subject: [PATCH 097/527] Don't poll for addition codespace permissions if user chooses to create without them (#8267) --- internal/codespaces/api/api.go | 3 +- pkg/cmd/codespace/common.go | 2 +- pkg/cmd/codespace/create.go | 51 ++++++++++++++++++---------------- pkg/cmd/codespace/mock_api.go | 14 +++------- 4 files changed, 33 insertions(+), 37 deletions(-) diff --git a/internal/codespaces/api/api.go b/internal/codespaces/api/api.go index 950a8ea52..9e79eafe1 100644 --- a/internal/codespaces/api/api.go +++ b/internal/codespaces/api/api.go @@ -640,7 +640,7 @@ func (a *API) GetCodespacesMachines(ctx context.Context, repoID int, branch, loc } // GetCodespacesPermissionsCheck returns a bool indicating whether the user has accepted permissions for the given repo and devcontainer path. -func (a *API) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) { +func (a *API) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) { reqURL := fmt.Sprintf("%s/repositories/%d/codespaces/permissions_check", a.githubAPI, repoID) req, err := http.NewRequest(http.MethodGet, reqURL, nil) if err != nil { @@ -648,7 +648,6 @@ func (a *API) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, bra } q := req.URL.Query() - q.Add("location", location) q.Add("ref", branch) q.Add("devcontainer_path", devcontainerPath) req.URL.RawQuery = q.Encode() diff --git a/pkg/cmd/codespace/common.go b/pkg/cmd/codespace/common.go index 78dae09e4..99d1f339c 100644 --- a/pkg/cmd/codespace/common.go +++ b/pkg/cmd/codespace/common.go @@ -77,7 +77,7 @@ type apiClient interface { EditCodespace(ctx context.Context, codespaceName string, params *api.EditCodespaceParams) (*api.Codespace, error) GetRepository(ctx context.Context, nwo string) (*api.Repository, error) GetCodespacesMachines(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*api.Machine, error) - GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) + GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) GetCodespaceRepositoryContents(ctx context.Context, codespace *api.Codespace, path string) ([]byte, error) ListDevContainers(ctx context.Context, repoID int, branch string, limit int) (devcontainers []api.DevContainerEntry, err error) GetCodespaceRepoSuggestions(ctx context.Context, partialSearch string, params api.RepoSearchParameters) ([]string, error) diff --git a/pkg/cmd/codespace/create.go b/pkg/cmd/codespace/create.go index 485f8e57c..fa484173d 100644 --- a/pkg/cmd/codespace/create.go +++ b/pkg/cmd/codespace/create.go @@ -312,7 +312,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { return fmt.Errorf("error creating codespace: %w", err) } - codespace, err = a.handleAdditionalPermissions(ctx, createParams, aerr.AllowPermissionsURL, userInputs.Location) + codespace, err = a.handleAdditionalPermissions(ctx, createParams, aerr.AllowPermissionsURL) if err != nil { // this error could be a cmdutil.SilentError (in the case that the user opened the browser) so we don't want to wrap it return err @@ -336,7 +336,7 @@ func (a *App) Create(ctx context.Context, opts createOptions) error { return nil } -func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api.CreateCodespaceParams, allowPermissionsURL string, location string) (*api.Codespace, error) { +func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api.CreateCodespaceParams, allowPermissionsURL string) (*api.Codespace, error) { var ( isInteractive = a.io.CanPrompt() cs = a.io.ColorScheme() @@ -380,17 +380,39 @@ func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api if err := a.browser.Browse(allowPermissionsURL); err != nil { return nil, fmt.Errorf("error opening browser: %w", err) } + + // Poll until the user has accepted the permissions or timeout + if err := a.pollForPermissions(ctx, createParams); err != nil { + return nil, fmt.Errorf("error polling for permissions: %w", err) + } } - // Poll until the user has accepted the permissions or timeout - err := a.RunWithProgress("Waiting for permissions to be accepted in the browser", func() (err error) { + // if the user chose to create the codespace without the permissions, + // we can continue with the create opting out of the additional permissions + createParams.PermissionsOptOut = true + + var codespace *api.Codespace + err := a.RunWithProgress("Creating codespace", func() (err error) { + codespace, err = a.apiClient.CreateCodespace(ctx, createParams) + return + }) + + if err != nil { + return nil, fmt.Errorf("error creating codespace: %w", err) + } + + return codespace, nil +} + +func (a *App) pollForPermissions(ctx context.Context, createParams *api.CreateCodespaceParams) error { + return a.RunWithProgress("Waiting for permissions to be accepted in the browser", func() (err error) { ctx, cancel := context.WithTimeout(ctx, permissionsPollingTimeout) defer cancel() done := make(chan error, 1) go func() { for { - accepted, err := a.apiClient.GetCodespacesPermissionsCheck(ctx, createParams.RepositoryID, createParams.Branch, location, createParams.DevContainerPath) + accepted, err := a.apiClient.GetCodespacesPermissionsCheck(ctx, createParams.RepositoryID, createParams.Branch, createParams.DevContainerPath) if err != nil { done <- err return @@ -413,25 +435,6 @@ func (a *App) handleAdditionalPermissions(ctx context.Context, createParams *api return fmt.Errorf("timed out waiting for permissions to be accepted in the browser") } }) - if err != nil { - return nil, fmt.Errorf("error polling for permissions: %w", err) - } - - // if the user chose to create the codespace without the permissions, - // we can continue with the create opting out of the additional permissions - createParams.PermissionsOptOut = true - - var codespace *api.Codespace - err = a.RunWithProgress("Creating codespace", func() (err error) { - codespace, err = a.apiClient.CreateCodespace(ctx, createParams) - return - }) - - if err != nil { - return nil, fmt.Errorf("error creating codespace: %w", err) - } - - return codespace, nil } // showStatus polls the codespace for a list of post create states and their status. It will keep polling diff --git a/pkg/cmd/codespace/mock_api.go b/pkg/cmd/codespace/mock_api.go index d6cf37eeb..e4de0ae7a 100644 --- a/pkg/cmd/codespace/mock_api.go +++ b/pkg/cmd/codespace/mock_api.go @@ -41,7 +41,7 @@ import ( // GetCodespacesMachinesFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) { // panic("mock out the GetCodespacesMachines method") // }, -// GetCodespacesPermissionsCheckFunc: func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) { +// GetCodespacesPermissionsCheckFunc: func(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) { // panic("mock out the GetCodespacesPermissionsCheck method") // }, // GetOrgMemberCodespaceFunc: func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) { @@ -103,7 +103,7 @@ type apiClientMock struct { GetCodespacesMachinesFunc func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) ([]*codespacesAPI.Machine, error) // GetCodespacesPermissionsCheckFunc mocks the GetCodespacesPermissionsCheck method. - GetCodespacesPermissionsCheckFunc func(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) + GetCodespacesPermissionsCheckFunc func(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) // GetOrgMemberCodespaceFunc mocks the GetOrgMemberCodespace method. GetOrgMemberCodespaceFunc func(ctx context.Context, orgName string, userName string, codespaceName string) (*codespacesAPI.Codespace, error) @@ -216,8 +216,6 @@ type apiClientMock struct { RepoID int // Branch is the branch argument value. Branch string - // Location is the location argument value. - Location string // DevcontainerPath is the devcontainerPath argument value. DevcontainerPath string } @@ -632,7 +630,7 @@ func (mock *apiClientMock) GetCodespacesMachinesCalls() []struct { } // GetCodespacesPermissionsCheck calls GetCodespacesPermissionsCheckFunc. -func (mock *apiClientMock) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, location string, devcontainerPath string) (bool, error) { +func (mock *apiClientMock) GetCodespacesPermissionsCheck(ctx context.Context, repoID int, branch string, devcontainerPath string) (bool, error) { if mock.GetCodespacesPermissionsCheckFunc == nil { panic("apiClientMock.GetCodespacesPermissionsCheckFunc: method is nil but apiClient.GetCodespacesPermissionsCheck was just called") } @@ -640,19 +638,17 @@ func (mock *apiClientMock) GetCodespacesPermissionsCheck(ctx context.Context, re Ctx context.Context RepoID int Branch string - Location string DevcontainerPath string }{ Ctx: ctx, RepoID: repoID, Branch: branch, - Location: location, DevcontainerPath: devcontainerPath, } mock.lockGetCodespacesPermissionsCheck.Lock() mock.calls.GetCodespacesPermissionsCheck = append(mock.calls.GetCodespacesPermissionsCheck, callInfo) mock.lockGetCodespacesPermissionsCheck.Unlock() - return mock.GetCodespacesPermissionsCheckFunc(ctx, repoID, branch, location, devcontainerPath) + return mock.GetCodespacesPermissionsCheckFunc(ctx, repoID, branch, devcontainerPath) } // GetCodespacesPermissionsCheckCalls gets all the calls that were made to GetCodespacesPermissionsCheck. @@ -663,14 +659,12 @@ func (mock *apiClientMock) GetCodespacesPermissionsCheckCalls() []struct { Ctx context.Context RepoID int Branch string - Location string DevcontainerPath string } { var calls []struct { Ctx context.Context RepoID int Branch string - Location string DevcontainerPath string } mock.lockGetCodespacesPermissionsCheck.RLock() From 09b81ff5450a4597200a52b5c4052fa307728917 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 31 Oct 2023 09:44:31 +0100 Subject: [PATCH 098/527] Create private discussion for issues labelled discuss (#8264) --- .github/workflows/discussion-triage.yml | 32 +++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/discussion-triage.yml diff --git a/.github/workflows/discussion-triage.yml b/.github/workflows/discussion-triage.yml new file mode 100644 index 000000000..78f357ba1 --- /dev/null +++ b/.github/workflows/discussion-triage.yml @@ -0,0 +1,32 @@ +name: Discussion Triage +run-name: ${{ github.event.issue.title }} +on: + issues: + types: + - labeled +jobs: + add-comment: + if: github.event.label.name == 'discuss' + runs-on: ubuntu-latest + steps: + - name: Create a discussion in github/cli + run: | + export DISCUSSION_TITLE="Triage: ${ISSUE_TITLE} (#${ISSUE_NUMBER})" + gh api graphql -f query=' + mutation($repositoryId: String!, $categoryId: String!, $title: String!, $body: String!) { + createDiscussion( + input: {repositoryId: $repositoryId, categoryId: $categoryId, title: $title, body: $body} + ) { + discussion { + id + } + } + }' -f title="${DISCUSSION_TITLE}" -f body="@${LABELLER} added the discuss label to #${ISSUE_NUMBER}" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_CLI_DISCUSSION_TRIAGE_TOKEN }} + ISSUE_TITLE: ${{ github.event.issue.title }} + ISSUE_NUMBER: ${{ github.event.issue.number }} + LABELLER: ${{ github.event.sender.login }} + GITHUB_CLI_REPOSITORY_ID: "R_kgDODAqwpw" + TRIAGE_CATEGORY_ID: "DIC_kwDODAqwp84CajJa" + From 4213e3e2b4799d1fec99b2208c2252b01a08db01 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 31 Oct 2023 09:49:46 +0100 Subject: [PATCH 099/527] Update secret name to not be prefixed with GITHUB Apparently this isn't allowed --- .github/workflows/discussion-triage.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/discussion-triage.yml b/.github/workflows/discussion-triage.yml index 78f357ba1..8fc49cea9 100644 --- a/.github/workflows/discussion-triage.yml +++ b/.github/workflows/discussion-triage.yml @@ -5,7 +5,7 @@ on: types: - labeled jobs: - add-comment: + create-discussion: if: github.event.label.name == 'discuss' runs-on: ubuntu-latest steps: @@ -23,7 +23,7 @@ jobs: } }' -f title="${DISCUSSION_TITLE}" -f body="@${LABELLER} added the discuss label to #${ISSUE_NUMBER}" env: - GITHUB_TOKEN: ${{ secrets.GITHUB_CLI_DISCUSSION_TRIAGE_TOKEN }} + GITHUB_TOKEN: ${{ secrets.CLI_DISCUSSION_TRIAGE_TOKEN }} ISSUE_TITLE: ${{ github.event.issue.title }} ISSUE_NUMBER: ${{ github.event.issue.number }} LABELLER: ${{ github.event.sender.login }} From 6782120254a2fc17877281586ee7073bd5851004 Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 31 Oct 2023 09:55:29 +0100 Subject: [PATCH 100/527] Update discussion triage types to ID --- .github/workflows/discussion-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/discussion-triage.yml b/.github/workflows/discussion-triage.yml index 8fc49cea9..41cbb997e 100644 --- a/.github/workflows/discussion-triage.yml +++ b/.github/workflows/discussion-triage.yml @@ -13,7 +13,7 @@ jobs: run: | export DISCUSSION_TITLE="Triage: ${ISSUE_TITLE} (#${ISSUE_NUMBER})" gh api graphql -f query=' - mutation($repositoryId: String!, $categoryId: String!, $title: String!, $body: String!) { + mutation($repositoryId: ID!, $categoryId: ID!, $title: String!, $body: String!) { createDiscussion( input: {repositoryId: $repositoryId, categoryId: $categoryId, title: $title, body: $body} ) { From b2c445f4b96fb05bfa3c909379b968e36ee9a87e Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 31 Oct 2023 09:58:30 +0100 Subject: [PATCH 101/527] Ensure variables get passed in discussion triage --- .github/workflows/discussion-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/discussion-triage.yml b/.github/workflows/discussion-triage.yml index 41cbb997e..3999f7f74 100644 --- a/.github/workflows/discussion-triage.yml +++ b/.github/workflows/discussion-triage.yml @@ -21,7 +21,7 @@ jobs: id } } - }' -f title="${DISCUSSION_TITLE}" -f body="@${LABELLER} added the discuss label to #${ISSUE_NUMBER}" + }' -f repositoryId="${GITHUB_CLI_REPOSITORY_ID}" -f categoryId="${TRIAGE_CATEGORY_ID}" -f title="${DISCUSSION_TITLE}" -f body="@${LABELLER} added the discuss label to #${ISSUE_NUMBER}" env: GITHUB_TOKEN: ${{ secrets.CLI_DISCUSSION_TRIAGE_TOKEN }} ISSUE_TITLE: ${{ github.event.issue.title }} From ede1705bf24c55e2d37364fe24d225f8f505f8ee Mon Sep 17 00:00:00 2001 From: William Martin Date: Tue, 31 Oct 2023 10:02:42 +0100 Subject: [PATCH 102/527] Ensure good link in triage discussion --- .github/workflows/discussion-triage.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/discussion-triage.yml b/.github/workflows/discussion-triage.yml index 3999f7f74..9397e5103 100644 --- a/.github/workflows/discussion-triage.yml +++ b/.github/workflows/discussion-triage.yml @@ -21,7 +21,7 @@ jobs: id } } - }' -f repositoryId="${GITHUB_CLI_REPOSITORY_ID}" -f categoryId="${TRIAGE_CATEGORY_ID}" -f title="${DISCUSSION_TITLE}" -f body="@${LABELLER} added the discuss label to #${ISSUE_NUMBER}" + }' -f repositoryId="${GITHUB_CLI_REPOSITORY_ID}" -f categoryId="${TRIAGE_CATEGORY_ID}" -f title="${DISCUSSION_TITLE}" -f body="@${LABELLER} added the discuss label to https://github.com/cli/cli/issues/${ISSUE_NUMBER}" env: GITHUB_TOKEN: ${{ secrets.CLI_DISCUSSION_TRIAGE_TOKEN }} ISSUE_TITLE: ${{ github.event.issue.title }} From 351c5f1cd5bb2ccd5695c22b84e4ec854924580e Mon Sep 17 00:00:00 2001 From: Adarsh Jha <31096082+adarshjhaa100@users.noreply.github.com> Date: Tue, 31 Oct 2023 22:18:49 +0530 Subject: [PATCH 103/527] feat: modified choice input to take option list opposed to blank text (#8180) --- pkg/cmd/workflow/run/run.go | 21 ++++- pkg/cmd/workflow/run/run_test.go | 132 +++++++++++++++++++++++++++++++ 2 files changed, 151 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/workflow/run/run.go b/pkg/cmd/workflow/run/run.go index 009c48182..86b24ed64 100644 --- a/pkg/cmd/workflow/run/run.go +++ b/pkg/cmd/workflow/run/run.go @@ -217,7 +217,18 @@ func collectInputs(p iprompter, yamlContent []byte) (map[string]string, error) { for _, input := range inputs { var answer string - if input.Required { + + if input.Type == "choice" { + name := input.Name + if input.Required { + name += " (required)" + } + selected, err := p.Select(name, input.Default, input.Options) + if err != nil { + return nil, err + } + answer = input.Options[selected] + } else if input.Required { for answer == "" { answer, err = p.Input(input.Name+" (required)", input.Default) if err != nil { @@ -234,7 +245,6 @@ func collectInputs(p iprompter, yamlContent []byte) (map[string]string, error) { providedInputs[input.Name] = answer } - return providedInputs, nil } @@ -331,6 +341,8 @@ type WorkflowInput struct { Required bool Default string Description string + Type string + Options []string } func findInputs(yamlContent []byte) ([]WorkflowInput, error) { @@ -412,11 +424,16 @@ func findInputs(yamlContent []byte) ([]WorkflowInput, error) { } for name, input := range m { + if input.Type == "choice" && len(input.Options) == 0 { + return nil, fmt.Errorf("workflow input %q is of type choice, but has no options", name) + } out = append(out, WorkflowInput{ Name: name, Default: input.Default, Description: input.Description, Required: input.Required, + Options: input.Options, + Type: input.Type, }) } diff --git a/pkg/cmd/workflow/run/run_test.go b/pkg/cmd/workflow/run/run_test.go index 70fea8aa7..ee1bc5a1e 100644 --- a/pkg/cmd/workflow/run/run_test.go +++ b/pkg/cmd/workflow/run/run_test.go @@ -350,6 +350,50 @@ jobs: encodedYAMLContent := base64.StdEncoding.EncodeToString(yamlContent) + yamlContentChoiceIp := []byte(` +name: choice inputs +on: + workflow_dispatch: + inputs: + name: + type: choice + description: Who to greet + default: monalisa + options: + - monalisa + - cschleiden + favourite-animal: + type: choice + description: What's your favourite animal + required: true + options: + - dog + - cat +jobs: + greet: + runs-on: ubuntu-latest + steps: + - name: Send greeting + run: echo "${{ github.event.inputs.message }} ${{ fromJSON('["", "🥳"]')[github.event.inputs.use-emoji == 'true'] }} ${{ github.event.inputs.name }}"`) + encodedYAMLContentChoiceIp := base64.StdEncoding.EncodeToString(yamlContentChoiceIp) + + yamlContentMissingChoiceIp := []byte(` +name: choice missing inputs +on: + workflow_dispatch: + inputs: + name: + type: choice + description: Who to greet + options: +jobs: + greet: + runs-on: ubuntu-latest + steps: + - name: Send greeting + run: echo "${{ github.event.inputs.message }} ${{ fromJSON('["", "🥳"]')[github.event.inputs.use-emoji == 'true'] }} ${{ github.event.inputs.name }}"`) + encodedYAMLContentMissingChoiceIp := base64.StdEncoding.EncodeToString(yamlContentMissingChoiceIp) + stubs := func(reg *httpmock.Registry) { reg.Register( httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/workflow.yml"), @@ -640,6 +684,94 @@ jobs: }, wantOut: "✓ Created workflow_dispatch event for workflow.yml at trunk\n\nTo see runs for this workflow, try: gh run list --workflow=workflow.yml\n", }, + { + name: "prompt, workflow choice input", + tty: true, + opts: &RunOptions{ + Prompt: true, + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows"), + httpmock.JSONResponse(shared.WorkflowsPayload{ + Workflows: []shared.Workflow{ + { + Name: "choice inputs", + ID: 12345, + State: shared.Active, + Path: ".github/workflows/workflow.yml", + }, + }, + })) + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/contents/.github/workflows/workflow.yml"), + httpmock.JSONResponse(struct{ Content string }{ + Content: encodedYAMLContentChoiceIp, + })) + reg.Register( + httpmock.REST("POST", "repos/OWNER/REPO/actions/workflows/12345/dispatches"), + httpmock.StatusStringResponse(204, "cool")) + }, + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow", []string{"choice inputs (workflow.yml)"}, func(_, _ string, opts []string) (int, error) { + return 0, nil + }) + pm.RegisterSelect("favourite-animal (required)", []string{"dog", "cat"}, func(_, _ string, opts []string) (int, error) { + return 0, nil + }) + pm.RegisterSelect("name", []string{"monalisa", "cschleiden"}, func(_, _ string, opts []string) (int, error) { + return 0, nil + }) + + }, + wantBody: map[string]interface{}{ + "inputs": map[string]interface{}{ + "name": "monalisa", + "favourite-animal": "dog", + }, + "ref": "trunk", + }, + wantOut: "✓ Created workflow_dispatch event for workflow.yml at trunk\n\nTo see runs for this workflow, try: gh run list --workflow=workflow.yml\n", + }, + { + name: "prompt, workflow choice missing input", + tty: true, + opts: &RunOptions{ + Prompt: true, + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows"), + httpmock.JSONResponse(shared.WorkflowsPayload{ + Workflows: []shared.Workflow{ + { + Name: "choice missing inputs", + ID: 12345, + State: shared.Active, + Path: ".github/workflows/workflow.yml", + }, + }, + })) + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/contents/.github/workflows/workflow.yml"), + httpmock.JSONResponse(struct{ Content string }{ + Content: encodedYAMLContentMissingChoiceIp, + })) + reg.Register( + httpmock.REST("POST", "repos/OWNER/REPO/actions/workflows/12345/dispatches"), + httpmock.StatusStringResponse(204, "cool")) + }, + promptStubs: func(pm *prompter.MockPrompter) { + pm.RegisterSelect("Select a workflow", []string{"choice missing inputs (workflow.yml)"}, func(_, _ string, opts []string) (int, error) { + return 0, nil + }) + pm.RegisterSelect("name", []string{}, func(_, _ string, opts []string) (int, error) { + return 0, nil + }) + }, + wantErr: true, + errOut: "workflow input \"name\" is of type choice, but has no options", + }, } for _, tt := range tests { From 581b6652e258bc7487ac85ab49919a3a3c365cf9 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 31 Oct 2023 12:19:14 -0700 Subject: [PATCH 104/527] Resolve race condition in codespaces connection --- internal/codespaces/connection/connection.go | 48 +++++++++++++++++-- .../codespaces/connection/connection_test.go | 6 +++ .../portforwarder/port_forwarder.go | 17 ++----- .../codespaces/rpc/test/port_forwarder.go | 4 +- internal/codespaces/states.go | 1 + pkg/cmd/codespace/jupyter.go | 1 + pkg/cmd/codespace/logs.go | 1 + pkg/cmd/codespace/ports.go | 3 ++ pkg/cmd/codespace/rebuild.go | 1 + pkg/cmd/codespace/ssh.go | 5 +- 10 files changed, 67 insertions(+), 20 deletions(-) diff --git a/internal/codespaces/connection/connection.go b/internal/codespaces/connection/connection.go index 5eea89a76..09ca43b48 100644 --- a/internal/codespaces/connection/connection.go +++ b/internal/codespaces/connection/connection.go @@ -16,10 +16,15 @@ const ( clientName = "gh" ) +type TunnelClient struct { + *tunnels.Client + connected bool +} + type CodespaceConnection struct { tunnelProperties api.TunnelProperties TunnelManager *tunnels.Manager - TunnelClient *tunnels.Client + TunnelClient *TunnelClient Options *tunnels.TunnelRequestOptions Tunnel *tunnels.Tunnel AllowedPortPrivacySettings []string @@ -74,6 +79,38 @@ func NewCodespaceConnection(ctx context.Context, codespace *api.Codespace, httpC }, nil } +// Connect connects the client to the tunnel. +func (c *CodespaceConnection) Connect(ctx context.Context) error { + // If already connected, return + if c.TunnelClient.connected { + return nil + } + + // Connect to the tunnel + if err := c.TunnelClient.Client.Connect(ctx, ""); err != nil { + return fmt.Errorf("error connecting to tunnel: %w", err) + } + + // Set the connected flag so we know we're connected + c.TunnelClient.connected = true + + return nil +} + +// Close closes the underlying tunnel client SSH connection. +func (c *CodespaceConnection) Close() error { + // Don't close if we're not connected + if c.TunnelClient != nil && c.TunnelClient.connected { + if err := c.TunnelClient.Close(); err != nil { + return fmt.Errorf("failed to close tunnel client connection: %w", err) + } + + c.TunnelClient.connected = false + } + + return nil +} + // getTunnelManager creates a tunnel manager for the given codespace. // The tunnel manager is used to get the tunnel hosted in the codespace that we // want to connect to and perform operations on ports (add, remove, list, etc.). @@ -96,7 +133,7 @@ func getTunnelManager(tunnelProperties api.TunnelProperties, httpClient *http.Cl // getTunnelClient creates a tunnel client for the given tunnel. // The tunnel client is used to connect to the the tunnel and allows // for ports to be forwarded locally. -func getTunnelClient(ctx context.Context, tunnelManager *tunnels.Manager, tunnel *tunnels.Tunnel, options *tunnels.TunnelRequestOptions) (tunnelClient *tunnels.Client, err error) { +func getTunnelClient(ctx context.Context, tunnelManager *tunnels.Manager, tunnel *tunnels.Tunnel, options *tunnels.TunnelRequestOptions) (tunnelClient *TunnelClient, err error) { // Get the tunnel that we want to connect to codespaceTunnel, err := tunnelManager.GetTunnel(ctx, tunnel, options) if err != nil { @@ -107,10 +144,15 @@ func getTunnelClient(ctx context.Context, tunnelManager *tunnels.Manager, tunnel codespaceTunnel.AccessTokens = tunnel.AccessTokens // We need to pass false for accept local connections because we don't want to automatically connect to all forwarded ports - tunnelClient, err = tunnels.NewClient(log.New(io.Discard, "", log.LstdFlags), codespaceTunnel, false) + client, err := tunnels.NewClient(log.New(io.Discard, "", log.LstdFlags), codespaceTunnel, false) if err != nil { return nil, fmt.Errorf("error creating tunnel client: %w", err) } + tunnelClient = &TunnelClient{ + Client: client, + connected: false, + } + return tunnelClient, nil } diff --git a/internal/codespaces/connection/connection_test.go b/internal/codespaces/connection/connection_test.go index e7ebd2788..a444b8cc6 100644 --- a/internal/codespaces/connection/connection_test.go +++ b/internal/codespaces/connection/connection_test.go @@ -41,6 +41,12 @@ func TestNewCodespaceConnection(t *testing.T) { t.Fatalf("NewCodespaceConnection returned an error: %v", err) } + // Verify closing before connected doesn't throw + err = conn.Close() + if err != nil { + t.Fatalf("Close returned an error: %v", err) + } + // Check that the connection was created successfully if conn == nil { t.Fatal("NewCodespaceConnection returned nil") diff --git a/internal/codespaces/portforwarder/port_forwarder.go b/internal/codespaces/portforwarder/port_forwarder.go index 44838a6be..b62d13715 100644 --- a/internal/codespaces/portforwarder/port_forwarder.go +++ b/internal/codespaces/portforwarder/port_forwarder.go @@ -48,7 +48,7 @@ type PortForwarder interface { UpdatePortVisibility(ctx context.Context, remotePort int, visibility string) error KeepAlive(reason string) GetKeepAliveReason() string - CloseSSHConnection() + Close() error } // NewPortForwarder returns a new PortForwarder for the specified codespace. @@ -66,9 +66,6 @@ func (fwd *CodespacesPortForwarder) ForwardPortToListener(ctx context.Context, o return fmt.Errorf("error forwarding port: %w", err) } - // Close the SSH connection when we're done - defer fwd.CloseSSHConnection() - done := make(chan error) go func() { // Convert the port number to a uint16 @@ -151,7 +148,7 @@ func (fwd *CodespacesPortForwarder) ForwardPort(ctx context.Context, opts Forwar } // Connect to the tunnel - err = fwd.connection.TunnelClient.Connect(ctx, "") + err = fwd.connection.Connect(ctx) if err != nil { return fmt.Errorf("connect failed: %v", err) } @@ -159,7 +156,6 @@ func (fwd *CodespacesPortForwarder) ForwardPort(ctx context.Context, opts Forwar // Inform the host that we've forwarded the port locally err = fwd.connection.TunnelClient.RefreshPorts(ctx) if err != nil { - fwd.CloseSSHConnection() return fmt.Errorf("refresh ports failed: %v", err) } @@ -257,15 +253,12 @@ func (fwd *CodespacesPortForwarder) UpdatePortVisibility(ctx context.Context, re done := make(chan error) go func() { // Connect to the tunnel - err = fwd.connection.TunnelClient.Connect(ctx, "") + err = fwd.connection.Connect(ctx) if err != nil { done <- fmt.Errorf("connect failed: %v", err) return } - // Close the SSH connection when we're done - defer fwd.CloseSSHConnection() - // Inform the host that we've deleted the port err = fwd.connection.TunnelClient.RefreshPorts(ctx) if err != nil { @@ -316,8 +309,8 @@ func (fwd *CodespacesPortForwarder) GetKeepAliveReason() string { } // Close closes the port forwarder's tunnel client connection. -func (fwd *CodespacesPortForwarder) CloseSSHConnection() { - _ = fwd.connection.TunnelClient.Close() +func (fwd *CodespacesPortForwarder) Close() error { + return fwd.connection.Close() } // AccessControlEntriesToVisibility converts the access control entries used by Dev Tunnels to a friendly visibility value. diff --git a/internal/codespaces/rpc/test/port_forwarder.go b/internal/codespaces/rpc/test/port_forwarder.go index 4993ac0a1..6930988cc 100644 --- a/internal/codespaces/rpc/test/port_forwarder.go +++ b/internal/codespaces/rpc/test/port_forwarder.go @@ -13,8 +13,8 @@ import ( type PortForwarder struct{} // Close implements portforwarder.PortForwarder. -func (PortForwarder) CloseSSHConnection() { - panic("unimplemented") +func (PortForwarder) Close() error { + return nil } // ConnectToForwardedPort implements portforwarder.PortForwarder. diff --git a/internal/codespaces/states.go b/internal/codespaces/states.go index afbdf4673..ab673dd2c 100644 --- a/internal/codespaces/states.go +++ b/internal/codespaces/states.go @@ -47,6 +47,7 @@ func PollPostCreateStates(ctx context.Context, progress progressIndicator, apiCl if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } + defer safeClose(fwd, &err) // Ensure local port is listening before client (getPostCreateOutput) connects. listen, localPort, err := ListenTCP(0, false) diff --git a/pkg/cmd/codespace/jupyter.go b/pkg/cmd/codespace/jupyter.go index 3546837fa..a27a34271 100644 --- a/pkg/cmd/codespace/jupyter.go +++ b/pkg/cmd/codespace/jupyter.go @@ -48,6 +48,7 @@ func (a *App) Jupyter(ctx context.Context, selector *CodespaceSelector) (err err if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } + defer safeClose(fwd, &err) var ( invoker rpc.Invoker diff --git a/pkg/cmd/codespace/logs.go b/pkg/cmd/codespace/logs.go index 13d5ce185..37b301217 100644 --- a/pkg/cmd/codespace/logs.go +++ b/pkg/cmd/codespace/logs.go @@ -51,6 +51,7 @@ func (a *App) Logs(ctx context.Context, selector *CodespaceSelector, follow bool if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } + defer safeClose(fwd, &err) // Ensure local port is listening before client (getPostCreateOutput) connects. listen, localPort, err := codespaces.ListenTCP(0, false) diff --git a/pkg/cmd/codespace/ports.go b/pkg/cmd/codespace/ports.go index 3903da6cb..0608f0732 100644 --- a/pkg/cmd/codespace/ports.go +++ b/pkg/cmd/codespace/ports.go @@ -66,6 +66,7 @@ func (a *App) ListPorts(ctx context.Context, selector *CodespaceSelector, export if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } + defer safeClose(fwd, &err) var ports []*tunnels.TunnelPort err = a.RunWithProgress("Fetching ports", func() (err error) { @@ -246,6 +247,7 @@ func (a *App) UpdatePortVisibility(ctx context.Context, selector *CodespaceSelec if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } + defer safeClose(fwd, &err) // TODO: check if port visibility can be updated in parallel instead of sequentially for _, port := range ports { @@ -337,6 +339,7 @@ func (a *App) ForwardPorts(ctx context.Context, selector *CodespaceSelector, por if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } + defer safeClose(fwd, &err) opts := portforwarder.ForwardPortOpts{ Port: pair.remote, diff --git a/pkg/cmd/codespace/rebuild.go b/pkg/cmd/codespace/rebuild.go index 464c58502..93d43bf29 100644 --- a/pkg/cmd/codespace/rebuild.go +++ b/pkg/cmd/codespace/rebuild.go @@ -60,6 +60,7 @@ func (a *App) Rebuild(ctx context.Context, selector *CodespaceSelector, full boo if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } + defer safeClose(fwd, &err) invoker, err := rpc.CreateInvoker(ctx, fwd) if err != nil { diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go index 42571b52e..384b92bb8 100644 --- a/pkg/cmd/codespace/ssh.go +++ b/pkg/cmd/codespace/ssh.go @@ -202,6 +202,7 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e if err != nil { return fmt.Errorf("failed to create port forwarder: %w", err) } + defer safeClose(fwd, &err) var ( invoker rpc.Invoker @@ -238,9 +239,6 @@ func (a *App) SSH(ctx context.Context, sshArgs []string, opts sshOptions) (err e return fmt.Errorf("failed to forward port: %w", err) } - // Close the SSH connection when we're done - defer fwd.CloseSSHConnection() - // Connect to the forwarded port err = fwd.ConnectToForwardedPort(ctx, stdio, opts) if err != nil { @@ -584,6 +582,7 @@ func (a *App) printOpenSSHConfig(ctx context.Context, opts sshOptions) (err erro sshUsers <- result return } + defer safeClose(fwd, &err) invoker, err := rpc.CreateInvoker(ctx, fwd) if err != nil { From b566ea670c8a87561ae865e630b485bab39507ff Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 31 Oct 2023 13:01:24 -0700 Subject: [PATCH 105/527] Add mutex for connect --- internal/codespaces/connection/connection.go | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/internal/codespaces/connection/connection.go b/internal/codespaces/connection/connection.go index 09ca43b48..eaffa1862 100644 --- a/internal/codespaces/connection/connection.go +++ b/internal/codespaces/connection/connection.go @@ -7,6 +7,7 @@ import ( "log" "net/http" "net/url" + "sync" "github.com/cli/cli/v2/internal/codespaces/api" "github.com/microsoft/dev-tunnels/go/tunnels" @@ -19,6 +20,7 @@ const ( type TunnelClient struct { *tunnels.Client connected bool + connectMu sync.Mutex } type CodespaceConnection struct { @@ -81,6 +83,9 @@ func NewCodespaceConnection(ctx context.Context, codespace *api.Codespace, httpC // Connect connects the client to the tunnel. func (c *CodespaceConnection) Connect(ctx context.Context) error { + // Lock the mutex to prevent connection races + c.TunnelClient.connectMu.Lock() + // If already connected, return if c.TunnelClient.connected { return nil @@ -94,6 +99,9 @@ func (c *CodespaceConnection) Connect(ctx context.Context) error { // Set the connected flag so we know we're connected c.TunnelClient.connected = true + // Unlock the mutex + c.TunnelClient.connectMu.Unlock() + return nil } From 1bcf92438a48872a532033d09d04f55a9ee2ebc6 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 31 Oct 2023 13:08:34 -0700 Subject: [PATCH 106/527] Defer the mutex unlock --- internal/codespaces/connection/connection.go | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/internal/codespaces/connection/connection.go b/internal/codespaces/connection/connection.go index eaffa1862..320817cca 100644 --- a/internal/codespaces/connection/connection.go +++ b/internal/codespaces/connection/connection.go @@ -85,6 +85,7 @@ func NewCodespaceConnection(ctx context.Context, codespace *api.Codespace, httpC func (c *CodespaceConnection) Connect(ctx context.Context) error { // Lock the mutex to prevent connection races c.TunnelClient.connectMu.Lock() + defer c.TunnelClient.connectMu.Unlock() // If already connected, return if c.TunnelClient.connected { @@ -99,9 +100,6 @@ func (c *CodespaceConnection) Connect(ctx context.Context) error { // Set the connected flag so we know we're connected c.TunnelClient.connected = true - // Unlock the mutex - c.TunnelClient.connectMu.Unlock() - return nil } From d04a9d941f1155a8a3a70ca1bfe80fe6e9a59988 Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 31 Oct 2023 13:11:28 -0700 Subject: [PATCH 107/527] Lock the `Close` func --- internal/codespaces/connection/connection.go | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/internal/codespaces/connection/connection.go b/internal/codespaces/connection/connection.go index 320817cca..2528b28ed 100644 --- a/internal/codespaces/connection/connection.go +++ b/internal/codespaces/connection/connection.go @@ -20,7 +20,7 @@ const ( type TunnelClient struct { *tunnels.Client connected bool - connectMu sync.Mutex + mu sync.Mutex } type CodespaceConnection struct { @@ -84,8 +84,8 @@ func NewCodespaceConnection(ctx context.Context, codespace *api.Codespace, httpC // Connect connects the client to the tunnel. func (c *CodespaceConnection) Connect(ctx context.Context) error { // Lock the mutex to prevent connection races - c.TunnelClient.connectMu.Lock() - defer c.TunnelClient.connectMu.Unlock() + c.TunnelClient.mu.Lock() + defer c.TunnelClient.mu.Unlock() // If already connected, return if c.TunnelClient.connected { @@ -105,6 +105,10 @@ func (c *CodespaceConnection) Connect(ctx context.Context) error { // Close closes the underlying tunnel client SSH connection. func (c *CodespaceConnection) Close() error { + // Lock the mutex to prevent connection races + c.TunnelClient.mu.Lock() + defer c.TunnelClient.mu.Unlock() + // Don't close if we're not connected if c.TunnelClient != nil && c.TunnelClient.connected { if err := c.TunnelClient.Close(); err != nil { From d22c6f33e9c828e89bf5ecd4abf4b5436e7306cd Mon Sep 17 00:00:00 2001 From: David Gardiner Date: Tue, 31 Oct 2023 13:12:25 -0700 Subject: [PATCH 108/527] Update comment --- internal/codespaces/connection/connection.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/internal/codespaces/connection/connection.go b/internal/codespaces/connection/connection.go index 2528b28ed..7eda95e50 100644 --- a/internal/codespaces/connection/connection.go +++ b/internal/codespaces/connection/connection.go @@ -83,7 +83,7 @@ func NewCodespaceConnection(ctx context.Context, codespace *api.Codespace, httpC // Connect connects the client to the tunnel. func (c *CodespaceConnection) Connect(ctx context.Context) error { - // Lock the mutex to prevent connection races + // Lock the mutex to prevent race conditions with the underlying SSH connection c.TunnelClient.mu.Lock() defer c.TunnelClient.mu.Unlock() @@ -105,7 +105,7 @@ func (c *CodespaceConnection) Connect(ctx context.Context) error { // Close closes the underlying tunnel client SSH connection. func (c *CodespaceConnection) Close() error { - // Lock the mutex to prevent connection races + // Lock the mutex to prevent race conditions with the underlying SSH connection c.TunnelClient.mu.Lock() defer c.TunnelClient.mu.Unlock() From 534f6d79780eafe94027ccf0806ee5b497ef1424 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 1 Nov 2023 10:34:47 +0100 Subject: [PATCH 109/527] build(deps): bump github.com/creack/pty from 1.1.18 to 1.1.20 (#8265) Bumps [github.com/creack/pty](https://github.com/creack/pty) from 1.1.18 to 1.1.20. - [Release notes](https://github.com/creack/pty/releases) - [Commits](https://github.com/creack/pty/compare/v1.1.18...v1.1.20) --- updated-dependencies: - dependency-name: github.com/creack/pty dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: William Martin --- go.mod | 2 +- go.sum | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/go.mod b/go.mod index e7840350b..af82ce97e 100644 --- a/go.mod +++ b/go.mod @@ -13,7 +13,7 @@ require ( github.com/cli/oauth v1.0.1 github.com/cli/safeexec v1.0.1 github.com/cpuguy83/go-md2man/v2 v2.0.3 - github.com/creack/pty v1.1.18 + github.com/creack/pty v1.1.20 github.com/gabriel-vasile/mimetype v1.4.3 github.com/gdamore/tcell/v2 v2.5.4 github.com/google/go-cmp v0.5.9 diff --git a/go.sum b/go.sum index 00aca879a..d4ffca835 100644 --- a/go.sum +++ b/go.sum @@ -37,8 +37,8 @@ github.com/cpuguy83/go-md2man/v2 v2.0.3 h1:qMCsGGgs+MAzDFyp9LpAe1Lqy/fY/qCovCm0q github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= 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/creack/pty v1.1.20 h1:VIPb/a2s17qNeQgDnkfZC35RScx+blkKF8GV68n80J4= +github.com/creack/pty v1.1.20/go.mod h1:MOBLtS5ELjhRRrroQr9kyvTxUAFNvYEK993ew/Vr4O4= 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= From 5eff7a529adcf2fd1813af76efdcf977629947fa Mon Sep 17 00:00:00 2001 From: Arun Sathiya Date: Wed, 1 Nov 2023 07:17:05 -0700 Subject: [PATCH 110/527] fix(release create): Handle latest flag value when updating the release after assets are uploaded (#8207) Signed-off-by: Arun Co-authored-by: William Martin --- pkg/cmd/release/create/create.go | 2 +- pkg/cmd/release/create/create_test.go | 63 +++++++++++++++++++++++++++ pkg/cmd/release/create/http.go | 6 ++- 3 files changed, 69 insertions(+), 2 deletions(-) diff --git a/pkg/cmd/release/create/create.go b/pkg/cmd/release/create/create.go index a0307d34a..6110d9c6a 100644 --- a/pkg/cmd/release/create/create.go +++ b/pkg/cmd/release/create/create.go @@ -499,7 +499,7 @@ func createRun(opts *CreateOptions) error { } if draftWhileUploading { - rel, err := publishRelease(httpClient, newRelease.APIURL, opts.DiscussionCategory) + rel, err := publishRelease(httpClient, newRelease.APIURL, opts.DiscussionCategory, opts.IsLatest) if err != nil { return cleanupDraftRelease(err) } diff --git a/pkg/cmd/release/create/create_test.go b/pkg/cmd/release/create/create_test.go index 644177aba..6dccf9f20 100644 --- a/pkg/cmd/release/create/create_test.go +++ b/pkg/cmd/release/create/create_test.go @@ -754,6 +754,69 @@ func Test_createRun(t *testing.T) { wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3-final\n", wantStderr: ``, }, + { + name: "publish after uploading files, but do not mark as latest", + isTTY: true, + opts: CreateOptions{ + TagName: "v1.2.3", + Name: "", + Body: "", + BodyProvided: true, + Draft: false, + IsLatest: boolPtr(false), + Target: "", + Assets: []*shared.AssetForUpload{ + { + Name: "ball.tgz", + Open: func() (io.ReadCloser, error) { + return io.NopCloser(bytes.NewBufferString(`TARBALL`)), nil + }, + }, + }, + Concurrency: 1, + }, + runStubs: func(rs *run.CommandStubber) { + rs.Register(`git tag --list`, 0, "") + }, + httpStubs: func(t *testing.T, reg *httpmock.Registry) { + reg.Register(httpmock.REST("HEAD", "repos/OWNER/REPO/releases/tags/v1.2.3"), httpmock.StatusStringResponse(404, ``)) + reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases"), httpmock.RESTPayload(201, `{ + "url": "https://api.github.com/releases/123", + "upload_url": "https://api.github.com/assets/upload", + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3" + }`, func(params map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "tag_name": "v1.2.3", + "draft": true, + "prerelease": false, + "make_latest": "false", + }, params) + })) + reg.Register(httpmock.REST("POST", "assets/upload"), func(req *http.Request) (*http.Response, error) { + q := req.URL.Query() + assert.Equal(t, "ball.tgz", q.Get("name")) + assert.Equal(t, "", q.Get("label")) + return &http.Response{ + StatusCode: 201, + Request: req, + Body: io.NopCloser(bytes.NewBufferString(`{}`)), + Header: map[string][]string{ + "Content-Type": {"application/json"}, + }, + }, nil + }) + reg.Register(httpmock.REST("PATCH", "releases/123"), httpmock.RESTPayload(201, `{ + "html_url": "https://github.com/OWNER/REPO/releases/tag/v1.2.3-final" + }`, func(params map[string]interface{}) { + assert.Equal(t, map[string]interface{}{ + "draft": false, + "make_latest": "false", + }, params) + })) + }, + wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3-final\n", + wantStderr: ``, + }, { name: "upload files but release already exists", isTTY: true, diff --git a/pkg/cmd/release/create/http.go b/pkg/cmd/release/create/http.go index f970d46f1..84e95710f 100644 --- a/pkg/cmd/release/create/http.go +++ b/pkg/cmd/release/create/http.go @@ -189,12 +189,16 @@ func createRelease(httpClient *http.Client, repo ghrepo.Interface, params map[st return &newRelease, err } -func publishRelease(httpClient *http.Client, releaseURL string, discussionCategory string) (*shared.Release, error) { +func publishRelease(httpClient *http.Client, releaseURL string, discussionCategory string, isLatest *bool) (*shared.Release, error) { params := map[string]interface{}{"draft": false} if discussionCategory != "" { params["discussion_category_name"] = discussionCategory } + if isLatest != nil { + params["make_latest"] = fmt.Sprintf("%v", *isLatest) + } + bodyBytes, err := json.Marshal(params) if err != nil { return nil, err From 8a9eb7bfc265d7ac79f9b742f44fd2e52d62647e Mon Sep 17 00:00:00 2001 From: William Martin Date: Wed, 1 Nov 2023 17:40:29 +0100 Subject: [PATCH 111/527] Add tests for issue and PR project items query building --- api/query_builder_test.go | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/api/query_builder_test.go b/api/query_builder_test.go index 7048b63fb..e39b08269 100644 --- a/api/query_builder_test.go +++ b/api/query_builder_test.go @@ -33,6 +33,11 @@ func TestPullRequestGraphQL(t *testing.T) { fields: []string{"isPinned", "stateReason", "number"}, want: "number", }, + { + name: "projectItems", + fields: []string{"projectItems"}, + want: `projectItems(first:100){nodes{id, project{id,title}, status:fieldValueByName(name: "Status") { ... on ProjectV2ItemFieldSingleSelectValue{optionId,name}}},totalCount}`, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { @@ -69,6 +74,11 @@ func TestIssueGraphQL(t *testing.T) { fields: []string{"files"}, want: "files(first: 100) {nodes {additions,deletions,path}}", }, + { + name: "projectItems", + fields: []string{"projectItems"}, + want: `projectItems(first:100){nodes{id, project{id,title}, status:fieldValueByName(name: "Status") { ... on ProjectV2ItemFieldSingleSelectValue{optionId,name}}},totalCount}`, + }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { From b0252989eb3f0019565d06aac95a2a58990de7d1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 2 Nov 2023 14:18:44 +0000 Subject: [PATCH 112/527] build(deps): bump github.com/henvic/httpretty from 0.1.2 to 0.1.3 Bumps [github.com/henvic/httpretty](https://github.com/henvic/httpretty) from 0.1.2 to 0.1.3. - [Commits](https://github.com/henvic/httpretty/compare/v0.1.2...v0.1.3) --- updated-dependencies: - dependency-name: github.com/henvic/httpretty dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- go.mod | 2 +- go.sum | 18 ++++-------------- 2 files changed, 5 insertions(+), 15 deletions(-) diff --git a/go.mod b/go.mod index af82ce97e..5738ffe5f 100644 --- a/go.mod +++ b/go.mod @@ -21,7 +21,7 @@ require ( github.com/gorilla/websocket v1.4.2 github.com/hashicorp/go-multierror v1.1.1 github.com/hashicorp/go-version v1.3.0 - github.com/henvic/httpretty v0.1.2 + github.com/henvic/httpretty v0.1.3 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 diff --git a/go.sum b/go.sum index d4ffca835..a69d3dbf6 100644 --- a/go.sum +++ b/go.sum @@ -76,8 +76,8 @@ github.com/hashicorp/go-multierror v1.1.1 h1:H5DkEtf6CXdFp0N0Em5UCwQpXMWke8IA0+l github.com/hashicorp/go-multierror v1.1.1/go.mod h1:iw975J/qwKPdAO1clOe2L8331t/9/fmwbPZ6JB6eMoM= github.com/hashicorp/go-version v1.3.0 h1:McDWVJIU/y+u1BRV06dPaLfLCaT7fUTJLp5r04x7iNw= github.com/hashicorp/go-version v1.3.0/go.mod h1:fltr4n8CU8Ke44wwGCBoEymUuxUHl09ZGVZPK5anwXA= -github.com/henvic/httpretty v0.1.2 h1:EQo556sO0xeXAjP10eB+BZARMuvkdGqtfeS4Ntjvkiw= -github.com/henvic/httpretty v0.1.2/go.mod h1:ViEsly7wgdugYtymX54pYp6Vv2wqZmNHayJ6q8tlKCc= +github.com/henvic/httpretty v0.1.3 h1:4A6vigjz6Q/+yAfTD4wqipCv+Px69C7Th/NhT0ApuU8= +github.com/henvic/httpretty v0.1.3/go.mod h1:UUEv7c2kHZ5SPQ51uS3wBpzPDibg2U3Y+IaXyHy5GBg= github.com/hinshun/vt10x v0.0.0-20220119200601-820417d04eec h1:qv2VnGeEQHchGaZ/u7lxST/RaJw+cv273q79D81Xbog= github.com/hinshun/vt10x v0.0.0-20220119200601-820417d04eec/go.mod h1:Q48J4R4DvxnHolD5P8pOtXigYlRuPLGl6moFx3ulM68= github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc= @@ -165,7 +165,6 @@ github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXl 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.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= -github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= github.com/yuin/goldmark v1.5.2 h1:ALmeCk/px5FSm1MAcFBAsVKZjDuMVj8Tm7FFIlMJnqU= github.com/yuin/goldmark v1.5.2/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= @@ -177,11 +176,9 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= golang.org/x/crypto v0.14.0 h1:wBqGXzWJW6m1XrIKlAH0Hs1JJ7+9KBwnIO8v66Q9cHc= golang.org/x/crypto v0.14.0/go.mod h1:MVFd36DqK4CsrnJYDkBA3VC4m2GkXAM0PvzMCn4JQf4= -golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2K1YbXdKPJLVgG5VJdoTa1poYQBtP1AY= golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= -golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= golang.org/x/net v0.0.0-20221002022538-bcab6841153b/go.mod h1:YDH+HFinaLZZlnHAfSS6ZXJJ9M9t4Dl22yv3iI2vPwk= golang.org/x/net v0.17.0 h1:pVaXccu2ozPjCXewfr1S7xza/zcXTity9cCdXQYSjIM= @@ -189,18 +186,15 @@ golang.org/x/net v0.17.0/go.mod h1:NxSsAGuq816PNPmqtQdLE42eU2Fs7NoRIZrHJAlaCOE= golang.org/x/oauth2 v0.7.0 h1:qe6s0zUXlPX80/dITx3440hWZ7GwMwgDDyrSGTPJG/g= golang.org/x/oauth2 v0.7.0/go.mod h1:hPLQkd9LyjfXTiRohC/41GhcFqxisoUQ99sCUOHO9x4= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/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-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= 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= @@ -214,7 +208,6 @@ golang.org/x/term v0.13.0 h1:bb+I9cTfFazGW51MZqBVmZy7+JEJMouUHTUSKVQLBek= golang.org/x/term v0.13.0/go.mod h1:LTmsnFJwVN6bCy1rVCoS+qHT1HhALEFxKncY3WNNh4U= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= 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= @@ -222,14 +215,11 @@ golang.org/x/text v0.13.0 h1:ablQoSUd0tRdKxZewP80B+BaqeKJuVhuRxj/dkrun3k= golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.1.10/go.mod h1:Uh6Zz+xoGYZom868N8YTex3t7RhtHDBrE8Gzo9bV56E= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= -golang.org/x/tools v0.6.0 h1:BOw41kyTf3PuCW1pVQf8+Cyg8pMlkYB1oo9iJ6D/lKM= -golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/tools v0.14.0 h1:jvNa2pY0M4r62jkRQ6RwEZZyPcymeL9XZMLBbV7U2nc= +golang.org/x/tools v0.14.0/go.mod h1:uYBEerGOWcJyEORxN+Ek8+TT266gXkNlHdJBwexUsBg= golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c= google.golang.org/appengine v1.6.7/go.mod h1:8WjMMxjGQR8xUklV/ARdw2HLXBOI7O7uCIDZVag1xfc= google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 h1:KpwkzHKEF7B9Zxg18WzOa7djJ+Ha5DzthMyZYQfEn2A= From ccf45cc7c6caa8686b608bd156b57ba1b9d939f0 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Mon, 6 Nov 2023 15:59:03 +0800 Subject: [PATCH 113/527] Improve `gh release download` doc (#8294) * Improve `gh release download` doc When downloading latest release assets, `gh release download --archive=(zip|tar.gz)` works too. Sync doc with no-arguments warning. * Apply suggestion from code review Co-authored-by: Sam Coe --------- Co-authored-by: Sam Coe --- pkg/cmd/release/download/download.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pkg/cmd/release/download/download.go b/pkg/cmd/release/download/download.go index bab6bd19b..02519e146 100644 --- a/pkg/cmd/release/download/download.go +++ b/pkg/cmd/release/download/download.go @@ -50,7 +50,8 @@ func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobr Download assets from a GitHub release. Without an explicit tag name argument, assets are downloaded from the - latest release in the project. In this case, '--pattern' is required. + latest release in the project. In this case, "--pattern" or "--archive" + is required. `), Example: heredoc.Doc(` # download all assets from a specific release From 83643010178a086ee96e60da45cf0acb376940aa Mon Sep 17 00:00:00 2001 From: William Martin Date: Mon, 6 Nov 2023 11:59:19 +0100 Subject: [PATCH 114/527] Simplify run view annotation fetch error handling --- pkg/cmd/run/view/view.go | 15 +++------------ pkg/cmd/run/view/view_test.go | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+), 12 deletions(-) diff --git a/pkg/cmd/run/view/view.go b/pkg/cmd/run/view/view.go index bc40b66ee..e77def23a 100644 --- a/pkg/cmd/run/view/view.go +++ b/pkg/cmd/run/view/view.go @@ -305,23 +305,14 @@ func runView(opts *ViewOptions) error { } var annotations []shared.Annotation - - var annotationErr error - var as []shared.Annotation for _, job := range jobs { - as, annotationErr = shared.GetAnnotations(client, repo, job) - if annotationErr != nil { - break + as, err := shared.GetAnnotations(client, repo, job) + if err != nil { + return fmt.Errorf("failed to get annotations: %w", err) } annotations = append(annotations, as...) } - opts.IO.StopProgressIndicator() - - if annotationErr != nil { - return fmt.Errorf("failed to get annotations: %w", annotationErr) - } - out := opts.IO.Out fmt.Fprintln(out) diff --git a/pkg/cmd/run/view/view_test.go b/pkg/cmd/run/view/view_test.go index 86aab619b..ac318b0c9 100644 --- a/pkg/cmd/run/view/view_test.go +++ b/pkg/cmd/run/view/view_test.go @@ -1279,6 +1279,40 @@ func TestViewRun(t *testing.T) { }, wantOut: "fetched 5 jobs\n", }, + { + name: "Returns error when failing to get annotations", + opts: &ViewOptions{ + RunID: "1234", + ExitStatus: true, + }, + httpStubs: func(reg *httpmock.Registry) { + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234"), + httpmock.JSONResponse(shared.FailedRun)) + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/workflows/123"), + httpmock.JSONResponse(shared.TestWorkflow)) + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/actions/runs/1234/artifacts"), + httpmock.StringResponse(`{}`)) + reg.Register( + httpmock.GraphQL(`query PullRequestForRun`), + httpmock.StringResponse(``)) + reg.Register( + httpmock.REST("GET", "runs/1234/jobs"), + httpmock.JSONResponse(shared.JobsPayload{ + Jobs: []shared.Job{ + shared.FailedJob, + }, + })) + reg.Register( + httpmock.REST("GET", "repos/OWNER/REPO/check-runs/20/annotations"), + httpmock.StatusStringResponse(500, "internal server error"), + ) + }, + errMsg: "failed to get annotations: HTTP 500 (https://api.github.com/repos/OWNER/REPO/check-runs/20/annotations)", + wantErr: true, + }, } for _, tt := range tests { From ebcf3a10225a9b7c9422f6b63ff798d695f7f0a2 Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Mon, 6 Nov 2023 15:22:32 +0100 Subject: [PATCH 115/527] Set default Accept header for api command when one is not specified (#8303) --- api/client_test.go | 7 ++--- api/http_client.go | 18 +++++------- api/http_client_test.go | 59 ++++++++++++++++++---------------------- pkg/cmd/api/api.go | 15 +++++----- pkg/cmd/api/api_test.go | 55 +++++++++++++++++++++++++++++++++++++ pkg/cmd/api/http.go | 3 ++ pkg/cmd/api/http_test.go | 34 +++++++++++++++++------ 7 files changed, 127 insertions(+), 64 deletions(-) diff --git a/api/client_test.go b/api/client_test.go index 0f36e3f69..1701a17a9 100644 --- a/api/client_test.go +++ b/api/client_test.go @@ -234,10 +234,9 @@ func TestHTTPHeaders(t *testing.T) { ios, _, _, stderr := iostreams.Test() httpClient, err := NewHTTPClient(HTTPClientOptions{ - AppVersion: "v1.2.3", - Config: tinyConfig{ts.URL[7:] + ":oauth_token": "MYTOKEN"}, - Log: ios.ErrOut, - SkipAcceptHeaders: false, + AppVersion: "v1.2.3", + Config: tinyConfig{ts.URL[7:] + ":oauth_token": "MYTOKEN"}, + Log: ios.ErrOut, }) assert.NoError(t, err) client := NewClientFromHTTP(httpClient) diff --git a/api/http_client.go b/api/http_client.go index 9f2d59ce3..fcf036008 100644 --- a/api/http_client.go +++ b/api/http_client.go @@ -17,14 +17,13 @@ type tokenGetter interface { } type HTTPClientOptions struct { - AppVersion string - CacheTTL time.Duration - Config tokenGetter - EnableCache bool - Log io.Writer - LogColorize bool - LogVerboseHTTP bool - SkipAcceptHeaders bool + AppVersion string + CacheTTL time.Duration + Config tokenGetter + EnableCache bool + Log io.Writer + LogColorize bool + LogVerboseHTTP bool } func NewHTTPClient(opts HTTPClientOptions) (*http.Client, error) { @@ -50,9 +49,6 @@ func NewHTTPClient(opts HTTPClientOptions) (*http.Client, error) { headers := map[string]string{ userAgent: fmt.Sprintf("GitHub CLI %s", opts.AppVersion), } - if opts.SkipAcceptHeaders { - headers[accept] = "" - } clientOpts.Headers = headers if opts.EnableCache { diff --git a/api/http_client_test.go b/api/http_client_test.go index b1e84e582..f8fe28d40 100644 --- a/api/http_client_test.go +++ b/api/http_client_test.go @@ -20,7 +20,6 @@ func TestNewHTTPClient(t *testing.T) { type args struct { config tokenGetter appVersion string - setAccept bool logVerboseHTTP bool } tests := []struct { @@ -31,11 +30,10 @@ func TestNewHTTPClient(t *testing.T) { wantStderr string }{ { - name: "github.com with Accept header", + name: "github.com", args: args{ config: tinyConfig{"github.com:oauth_token": "MYTOKEN"}, appVersion: "v1.2.3", - setAccept: true, logVerboseHTTP: false, }, host: "github.com", @@ -47,18 +45,16 @@ func TestNewHTTPClient(t *testing.T) { wantStderr: "", }, { - name: "github.com no Accept header", + name: "GHES", args: args{ - config: tinyConfig{"github.com:oauth_token": "MYTOKEN"}, - appVersion: "v1.2.3", - setAccept: false, - logVerboseHTTP: false, + config: tinyConfig{"example.com:oauth_token": "GHETOKEN"}, + appVersion: "v1.2.3", }, - host: "github.com", + host: "example.com", wantHeader: map[string]string{ - "authorization": "token MYTOKEN", + "authorization": "token GHETOKEN", "user-agent": "GitHub CLI v1.2.3", - "accept": "", + "accept": "application/vnd.github.merge-info-preview+json, application/vnd.github.nebula-preview", }, wantStderr: "", }, @@ -67,7 +63,6 @@ func TestNewHTTPClient(t *testing.T) { args: args{ config: tinyConfig{"example.com:oauth_token": "MYTOKEN"}, appVersion: "v1.2.3", - setAccept: true, logVerboseHTTP: false, }, host: "github.com", @@ -78,12 +73,26 @@ func TestNewHTTPClient(t *testing.T) { }, wantStderr: "", }, + { + name: "GHES no authentication token", + args: args{ + config: tinyConfig{"github.com:oauth_token": "MYTOKEN"}, + appVersion: "v1.2.3", + logVerboseHTTP: false, + }, + host: "example.com", + wantHeader: map[string]string{ + "authorization": "", + "user-agent": "GitHub CLI v1.2.3", + "accept": "application/vnd.github.merge-info-preview+json, application/vnd.github.nebula-preview", + }, + wantStderr: "", + }, { name: "github.com in verbose mode", args: args{ config: tinyConfig{"github.com:oauth_token": "MYTOKEN"}, appVersion: "v1.2.3", - setAccept: true, logVerboseHTTP: true, }, host: "github.com", @@ -109,21 +118,6 @@ func TestNewHTTPClient(t *testing.T) { * Request took `), }, - { - name: "GHES Accept header", - args: args{ - config: tinyConfig{"example.com:oauth_token": "GHETOKEN"}, - appVersion: "v1.2.3", - setAccept: true, - }, - host: "example.com", - wantHeader: map[string]string{ - "authorization": "token GHETOKEN", - "user-agent": "GitHub CLI v1.2.3", - "accept": "application/vnd.github.merge-info-preview+json, application/vnd.github.nebula-preview", - }, - wantStderr: "", - }, } var gotReq *http.Request @@ -137,11 +131,10 @@ func TestNewHTTPClient(t *testing.T) { t.Run(tt.name, func(t *testing.T) { ios, _, _, stderr := iostreams.Test() client, err := NewHTTPClient(HTTPClientOptions{ - AppVersion: tt.args.appVersion, - Config: tt.args.config, - Log: ios.ErrOut, - SkipAcceptHeaders: !tt.args.setAccept, - LogVerboseHTTP: tt.args.logVerboseHTTP, + AppVersion: tt.args.appVersion, + Config: tt.args.config, + Log: ios.ErrOut, + LogVerboseHTTP: tt.args.logVerboseHTTP, }) require.NoError(t, err) diff --git a/pkg/cmd/api/api.go b/pkg/cmd/api/api.go index 38b6278b4..610f2f830 100644 --- a/pkg/cmd/api/api.go +++ b/pkg/cmd/api/api.go @@ -298,14 +298,13 @@ func apiRun(opts *ApiOptions) error { log = opts.IO.Out } opts := api.HTTPClientOptions{ - AppVersion: opts.AppVersion, - CacheTTL: opts.CacheTTL, - Config: cfg.Authentication(), - EnableCache: opts.CacheTTL > 0, - Log: log, - LogColorize: opts.IO.ColorEnabled(), - LogVerboseHTTP: opts.Verbose, - SkipAcceptHeaders: true, + AppVersion: opts.AppVersion, + CacheTTL: opts.CacheTTL, + Config: cfg.Authentication(), + EnableCache: opts.CacheTTL > 0, + Log: log, + LogColorize: opts.IO.ColorEnabled(), + LogVerboseHTTP: opts.Verbose, } return api.NewHTTPClient(opts) } diff --git a/pkg/cmd/api/api_test.go b/pkg/cmd/api/api_test.go index 178bebd86..3ffc6a0b3 100644 --- a/pkg/cmd/api/api_test.go +++ b/pkg/cmd/api/api_test.go @@ -1455,3 +1455,58 @@ func Test_parseErrorResponse(t *testing.T) { }) } } + +func Test_apiRun_acceptHeader(t *testing.T) { + tests := []struct { + name string + options ApiOptions + wantAcceptHeader string + }{ + { + name: "sets default accept header", + options: ApiOptions{}, + wantAcceptHeader: "*/*", + }, + { + name: "does not override user accept header", + options: ApiOptions{ + RequestHeaders: []string{"Accept: testing"}, + }, + wantAcceptHeader: "testing", + }, + { + name: "does not override preview names", + options: ApiOptions{ + Previews: []string{"nebula"}, + }, + wantAcceptHeader: "application/vnd.github.nebula-preview+json", + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + ios, _, _, _ := iostreams.Test() + tt.options.IO = ios + + tt.options.Config = func() (config.Config, error) { + return config.NewBlankConfig(), nil + } + + var gotReq *http.Request + tt.options.HttpClient = func() (*http.Client, error) { + var tr roundTripper = func(req *http.Request) (*http.Response, error) { + gotReq = req + resp := &http.Response{ + StatusCode: 200, + Request: req, + Body: io.NopCloser(bytes.NewBufferString("")), + } + return resp, nil + } + return &http.Client{Transport: tr}, nil + } + + assert.NoError(t, apiRun(&tt.options)) + assert.Equal(t, tt.wantAcceptHeader, gotReq.Header.Get("Accept")) + }) + } +} diff --git a/pkg/cmd/api/http.go b/pkg/cmd/api/http.go index 3d6bb240e..b1b503cc2 100644 --- a/pkg/cmd/api/http.go +++ b/pkg/cmd/api/http.go @@ -74,6 +74,9 @@ func httpRequest(client *http.Client, hostname string, method string, p string, if bodyIsJSON && req.Header.Get("Content-Type") == "" { req.Header.Set("Content-Type", "application/json; charset=utf-8") } + if req.Header.Get("Accept") == "" { + req.Header.Set("Accept", "*/*") + } return client.Do(req) } diff --git a/pkg/cmd/api/http_test.go b/pkg/cmd/api/http_test.go index f63566490..2778ea38c 100644 --- a/pkg/cmd/api/http_test.go +++ b/pkg/cmd/api/http_test.go @@ -126,7 +126,25 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://api.github.com/repos/octocat/spoon-knife", body: "", - headers: "", + headers: "Accept: */*\r\n", + }, + }, + { + name: "GET with accept header", + args: args{ + client: &httpClient, + host: "github.com", + method: "GET", + p: "repos/octocat/spoon-knife", + params: nil, + headers: []string{"Accept: testing"}, + }, + wantErr: false, + want: expects{ + method: "GET", + u: "https://api.github.com/repos/octocat/spoon-knife", + body: "", + headers: "Accept: testing\r\n", }, }, { @@ -144,7 +162,7 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://api.github.com/repos/octocat/spoon-knife", body: "", - headers: "", + headers: "Accept: */*\r\n", }, }, { @@ -162,7 +180,7 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://api.github.com/repos/octocat/spoon-knife", body: "", - headers: "", + headers: "Accept: */*\r\n", }, }, { @@ -180,7 +198,7 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://example.org/api/v3/repos/octocat/spoon-knife", body: "", - headers: "", + headers: "Accept: */*\r\n", }, }, { @@ -200,7 +218,7 @@ func Test_httpRequest(t *testing.T) { method: "GET", u: "https://api.github.com/repos/octocat/spoon-knife?a=b", body: "", - headers: "", + headers: "Accept: */*\r\n", }, }, { @@ -220,7 +238,7 @@ func Test_httpRequest(t *testing.T) { method: "POST", u: "https://api.github.com/repos", body: `{"a":"b"}`, - headers: "Content-Type: application/json; charset=utf-8\r\n", + headers: "Accept: */*\r\nContent-Type: application/json; charset=utf-8\r\n", }, }, { @@ -240,7 +258,7 @@ func Test_httpRequest(t *testing.T) { method: "POST", u: "https://api.github.com/graphql", body: `{"variables":{"a":"b"}}`, - headers: "Content-Type: application/json; charset=utf-8\r\n", + headers: "Accept: */*\r\nContent-Type: application/json; charset=utf-8\r\n", }, }, { @@ -258,7 +276,7 @@ func Test_httpRequest(t *testing.T) { method: "POST", u: "https://example.org/api/graphql", body: `{}`, - headers: "Content-Type: application/json; charset=utf-8\r\n", + headers: "Accept: */*\r\nContent-Type: application/json; charset=utf-8\r\n", }, }, { From 5e14987d65a7ba0d7841ac0ec2f653e393597c52 Mon Sep 17 00:00:00 2001 From: Qiming Xu <33349132+xqm32@users.noreply.github.com> Date: Tue, 14 Nov 2023 16:26:19 +0800 Subject: [PATCH 116/527] Fix determining executable location in PATH (#8238) --- pkg/cmdutil/factory.go | 10 ++++++- pkg/cmdutil/factory_test.go | 58 +++++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+), 1 deletion(-) diff --git a/pkg/cmdutil/factory.go b/pkg/cmdutil/factory.go index 223d30eb2..b48dceed3 100644 --- a/pkg/cmdutil/factory.go +++ b/pkg/cmdutil/factory.go @@ -82,7 +82,15 @@ func executable(fallbackName string) string { if p == exe { return p } else if f.Mode()&os.ModeSymlink != 0 { - if t, err := os.Readlink(p); err == nil && t == exe { + realP, err := filepath.EvalSymlinks(p) + if err != nil { + continue + } + realExe, err := filepath.EvalSymlinks(exe) + if err != nil { + continue + } + if realP == realExe { return p } } diff --git a/pkg/cmdutil/factory_test.go b/pkg/cmdutil/factory_test.go index eb87ce360..0103a04f1 100644 --- a/pkg/cmdutil/factory_test.go +++ b/pkg/cmdutil/factory_test.go @@ -55,6 +55,64 @@ func Test_executable(t *testing.T) { } } +func Test_executable_relative(t *testing.T) { + testExe, err := os.Executable() + if err != nil { + t.Fatal(err) + } + + testExeName := filepath.Base(testExe) + + // Create 3 extra PATH entries that each contain an executable with the same name as the running test + // process. The first is a relative symlink, but to an unrelated executable, the second is a relative + // symlink to our test process and thus represents the result we want, and the third one is an unrelated + // executable. + dir := t.TempDir() + bin1 := filepath.Join(dir, "bin1") + bin1Exe := filepath.Join(bin1, testExeName) + bin2 := filepath.Join(dir, "bin2") + bin2Exe := filepath.Join(bin2, testExeName) + bin3 := filepath.Join(dir, "bin3") + bin3Exe := filepath.Join(bin3, testExeName) + + if err := os.MkdirAll(bin1, 0755); err != nil { + t.Fatal(err) + } + if err := os.MkdirAll(bin2, 0755); err != nil { + t.Fatal(err) + } + if err := os.MkdirAll(bin3, 0755); err != nil { + t.Fatal(err) + } + + if f, err := os.OpenFile(bin3Exe, os.O_CREATE, 0755); err == nil { + f.Close() + } else { + t.Fatal(err) + } + bin2Rel, err := filepath.Rel(bin2, testExe) + if err != nil { + t.Fatal(err) + } + if err := os.Symlink(bin2Rel, bin2Exe); err != nil { + t.Fatal(err) + } + bin1Rel, err := filepath.Rel(bin1, bin3Exe) + if err != nil { + t.Fatal(err) + } + if err := os.Symlink(bin1Rel, bin1Exe); err != nil { + t.Fatal(err) + } + + oldPath := os.Getenv("PATH") + t.Setenv("PATH", strings.Join([]string{bin1, bin2, bin3, oldPath}, string(os.PathListSeparator))) + + if got := executable(""); got != bin2Exe { + t.Errorf("executable() = %q, want %q", got, bin2Exe) + } +} + func Test_Executable_override(t *testing.T) { override := strings.Join([]string{"C:", "cygwin64", "home", "gh.exe"}, string(os.PathSeparator)) t.Setenv("GH_PATH", override) From 3f37d7e372857c17141f290aeac404babc0282cc Mon Sep 17 00:00:00 2001 From: Sam Coe Date: Tue, 14 Nov 2023 17:27:50 +0100 Subject: [PATCH 117/527] Fix query for project item status field (#8332) --- api/queries_issue.go | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/api/queries_issue.go b/api/queries_issue.go index b971845b9..fdef7783f 100644 --- a/api/queries_issue.go +++ b/api/queries_issue.go @@ -107,9 +107,9 @@ type ProjectV2Item struct { Title string `json:"title"` } Status struct { - OptionID string `json:"optionId"` - Name string `json:"name"` - } + OptionID string `json:"optionId" graphql:"... on ProjectV2ItemFieldSingleSelectValue{optionId}"` + Name string `json:"name" graphql:"... on ProjectV2ItemFieldSingleSelectValue{name}"` + } `graphql:"status:fieldValueByName(name: \"Status\")"` } func (p ProjectCards) ProjectNames() []string { From 17d336e005e45e3d9e3b37173dce96f487ffb6f5 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Fri, 10 Nov 2023 14:52:57 +0800 Subject: [PATCH 118/527] Wrap cli flags in backticks uniformly --- pkg/cmd/alias/set/set.go | 6 +++--- pkg/cmd/auth/logout/logout.go | 6 +++--- pkg/cmd/auth/refresh/refresh.go | 10 +++++----- pkg/cmd/extension/command.go | 12 ++++++------ pkg/cmd/gist/create/create.go | 6 +++--- pkg/cmd/issue/view/view.go | 6 +++--- pkg/cmd/label/clone.go | 6 +++--- pkg/cmd/label/create.go | 6 +++--- pkg/cmd/pr/diff/diff.go | 6 +++--- pkg/cmd/pr/merge/merge.go | 6 +++--- pkg/cmd/pr/ready/ready.go | 6 +++--- pkg/cmd/pr/view/view.go | 6 +++--- pkg/cmd/project/item-edit/item_edit.go | 6 +++--- pkg/cmd/release/download/download.go | 8 ++++---- pkg/cmd/repo/edit/edit.go | 2 +- pkg/cmd/ruleset/check/check.go | 6 +++--- pkg/cmd/ruleset/list/list.go | 10 +++++----- pkg/cmd/ruleset/view/view.go | 6 +++--- pkg/cmd/workflow/run/run.go | 6 +++--- 19 files changed, 63 insertions(+), 63 deletions(-) diff --git a/pkg/cmd/alias/set/set.go b/pkg/cmd/alias/set/set.go index 77de9ca5d..840df5770 100644 --- a/pkg/cmd/alias/set/set.go +++ b/pkg/cmd/alias/set/set.go @@ -35,7 +35,7 @@ func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command cmd := &cobra.Command{ Use: "set ", Short: "Create a shortcut for a gh command", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Define a word that will expand to a full gh command when invoked. The expansion may specify additional arguments and flags. If the expansion includes @@ -46,10 +46,10 @@ func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command Use "-" as expansion argument to read the expansion string from standard input. This is useful to avoid quoting issues when defining expansions. - If the expansion starts with "!" or if "--shell" was given, the expansion is a shell + If the expansion starts with "!" or if %[1]s--shell%[1]s was given, the expansion is a shell expression that will be evaluated through the "sh" interpreter when the alias is invoked. This allows for chaining multiple commands via piping and redirection. - `), + `, "`"), Example: heredoc.Doc(` # note: Command Prompt on Windows requires using double quotes for arguments $ gh alias set pv 'pr view' diff --git a/pkg/cmd/auth/logout/logout.go b/pkg/cmd/auth/logout/logout.go index c871a5333..b2afc9a6c 100644 --- a/pkg/cmd/auth/logout/logout.go +++ b/pkg/cmd/auth/logout/logout.go @@ -33,11 +33,11 @@ func NewCmdLogout(f *cmdutil.Factory, runF func(*LogoutOptions) error) *cobra.Co Use: "logout", Args: cobra.ExactArgs(0), Short: "Log out of a GitHub host", - Long: heredoc.Doc(`Remove authentication for a GitHub host. + Long: heredoc.Docf(`Remove authentication for a GitHub host. This command removes the authentication configuration for a host either specified - interactively or via --hostname. - `), + interactively or via %[1]s--hostname%[1]s. + `, "`"), Example: heredoc.Doc(` $ gh auth logout # => select what host to log out of via a prompt diff --git a/pkg/cmd/auth/refresh/refresh.go b/pkg/cmd/auth/refresh/refresh.go index 870871284..a74bd18fb 100644 --- a/pkg/cmd/auth/refresh/refresh.go +++ b/pkg/cmd/auth/refresh/refresh.go @@ -60,19 +60,19 @@ func NewCmdRefresh(f *cmdutil.Factory, runF func(*RefreshOptions) error) *cobra. Use: "refresh", Args: cobra.ExactArgs(0), Short: "Refresh stored authentication credentials", - Long: heredoc.Doc(`Expand or fix the permission scopes for stored credentials. + Long: heredoc.Docf(`Expand or fix the permission scopes for stored credentials. - The --scopes flag accepts a comma separated list of scopes you want + The %[1]s--scopes%[1]s flag accepts a comma separated list of scopes you want your gh credentials to have. If no scopes are provided, the command maintains previously added scopes. - The --remove-scopes flag accepts a comma separated list of scopes you + The %[1]s--remove-scopes%[1]s flag accepts a comma separated list of scopes you want to remove from your gh credentials. Scope removal is idempotent. The minimum set of scopes ("repo", "read:org" and "gist") cannot be removed. - The --reset-scopes flag resets the scopes for your gh credentials to + The %[1]s--reset-scopes%[1]s flag resets the scopes for your gh credentials to the default set of scopes for your auth flow. - `), + `, "`"), Example: heredoc.Doc(` $ gh auth refresh --scopes write:org,read:public_key # => open a browser to add write:org and read:public_key scopes diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index c2ed18985..e8e4ecc0b 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -93,12 +93,12 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "search []", Short: "Search extensions to the GitHub CLI", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Search for gh extensions. With no arguments, this command prints out the first 30 extensions available to install sorted by number of stars. More extensions can - be fetched by specifying a higher limit with the --limit flag. + be fetched by specifying a higher limit with the %[1]s--limit%[1]s flag. When connected to a terminal, this command prints out three columns. The first has a ✓ if the extension is already installed locally. The @@ -122,7 +122,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { see: gh ext list - `), + `, "`"), Example: heredoc.Doc(` # List the first 30 extensions sorted by star count, descending $ gh ext search @@ -431,7 +431,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "browse", Short: "Enter a UI for browsing, adding, and removing extensions", - Long: heredoc.Doc(` + Long: heredoc.Docf(` This command will take over your terminal and run a fully interactive interface for browsing, adding, and removing gh extensions. A terminal width greater than 100 columns is recommended. @@ -441,7 +441,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { Press q to quit. - Running this command with --single-column should make this command + Running this command with %[1]s--single-column%[1]s should make this command more intelligible for users who rely on assistive technology like screen readers or high zoom. @@ -450,7 +450,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { gh ext search along with gh ext install, gh ext remove, and gh repo view. - `), + `, "`"), Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { if !io.CanPrompt() { diff --git a/pkg/cmd/gist/create/create.go b/pkg/cmd/gist/create/create.go index 4154acf9c..29f46b9ff 100644 --- a/pkg/cmd/gist/create/create.go +++ b/pkg/cmd/gist/create/create.go @@ -50,14 +50,14 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "create [... | -]", Short: "Create a new gist", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Create a new GitHub gist with given contents. Gists can be created from one or multiple files. Alternatively, pass "-" as file name to read from standard input. - By default, gists are secret; use '--public' to make publicly listed ones. - `), + By default, gists are secret; use %[1]s--public%[1]s to make publicly listed ones. + `, "`"), Example: heredoc.Doc(` # publish file 'hello.py' as a public gist $ gh gist create --public hello.py diff --git a/pkg/cmd/issue/view/view.go b/pkg/cmd/issue/view/view.go index 83132291f..58341a98e 100644 --- a/pkg/cmd/issue/view/view.go +++ b/pkg/cmd/issue/view/view.go @@ -48,11 +48,11 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "view { | }", Short: "View an issue", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Display the title, body, and other information about an issue. - With '--web', open the issue in a web browser instead. - `), + With %[1]s--web%[1]s, open the issue in a web browser instead. + `, "`"), Args: cobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { // support `-R, --repo` override diff --git a/pkg/cmd/label/clone.go b/pkg/cmd/label/clone.go index 302de145a..81ab76958 100644 --- a/pkg/cmd/label/clone.go +++ b/pkg/cmd/label/clone.go @@ -34,7 +34,7 @@ func newCmdClone(f *cmdutil.Factory, runF func(*cloneOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "clone ", Short: "Clones labels from one repository to another", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Clones labels from a source repository to a destination repository on GitHub. By default, the destination repository is the current repository. @@ -44,8 +44,8 @@ func newCmdClone(f *cmdutil.Factory, runF func(*cloneOptions) error) *cobra.Comm Labels from the source repository that already exist in the destination repository will be skipped. You can overwrite existing labels in the - destination repository using the --force flag. - `), + destination repository using the %[1]s--force%[1]s flag. + `, "`"), Example: heredoc.Doc(` # clone and overwrite labels from cli/cli repository into the current repository $ gh label clone cli/cli --force diff --git a/pkg/cmd/label/create.go b/pkg/cmd/label/create.go index 0a88fbcab..784b8f40f 100644 --- a/pkg/cmd/label/create.go +++ b/pkg/cmd/label/create.go @@ -57,14 +57,14 @@ func newCmdCreate(f *cmdutil.Factory, runF func(*createOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "create ", Short: "Create a new label", - Long: heredoc.Doc(` - Create a new label on GitHub, or updates an existing one with --force. + Long: heredoc.Docf(` + Create a new label on GitHub, or updates an existing one with %[1]s--force%[1]s. Must specify name for the label. The description and color are optional. If a color isn't provided, a random one will be chosen. The label color needs to be 6 character hex value. - `), + `, "`"), Example: heredoc.Doc(` # create new bug label $ gh label create bug --description "Something isn't working" --color E99695 diff --git a/pkg/cmd/pr/diff/diff.go b/pkg/cmd/pr/diff/diff.go index ff09c6388..c837a530a 100644 --- a/pkg/cmd/pr/diff/diff.go +++ b/pkg/cmd/pr/diff/diff.go @@ -50,14 +50,14 @@ func NewCmdDiff(f *cmdutil.Factory, runF func(*DiffOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "diff [ | | ]", Short: "View changes in a pull request", - Long: heredoc.Doc(` + Long: heredoc.Docf(` View changes in a pull request. Without an argument, the pull request that belongs to the current branch is selected. - With '--web', open the pull request diff in a web browser instead. - `), + With %[1]s--web%[1]s flag, open the pull request diff in a web browser instead. + `, "`"), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Finder = shared.NewFinder(f) diff --git a/pkg/cmd/pr/merge/merge.go b/pkg/cmd/pr/merge/merge.go index a23dc7390..d03d55089 100644 --- a/pkg/cmd/pr/merge/merge.go +++ b/pkg/cmd/pr/merge/merge.go @@ -78,7 +78,7 @@ func NewCmdMerge(f *cmdutil.Factory, runF func(*MergeOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "merge [ | | ]", Short: "Merge a pull request", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Merge a pull request on GitHub. Without an argument, the pull request that belongs to the current branch @@ -87,8 +87,8 @@ func NewCmdMerge(f *cmdutil.Factory, runF func(*MergeOptions) error) *cobra.Comm When targeting a branch that requires a merge queue, no merge strategy is required. If required checks have not yet passed, AutoMerge will be enabled. If required checks have passed, the pull request will be added to the merge queue. - To bypass a merge queue and merge directly, pass the '--admin' flag. - `), + To bypass a merge queue and merge directly, pass the %[1]s--admin%[1]s flag. + `, "`"), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Finder = shared.NewFinder(f) diff --git a/pkg/cmd/pr/ready/ready.go b/pkg/cmd/pr/ready/ready.go index ee0cfe2fd..0b98bb548 100644 --- a/pkg/cmd/pr/ready/ready.go +++ b/pkg/cmd/pr/ready/ready.go @@ -31,14 +31,14 @@ func NewCmdReady(f *cmdutil.Factory, runF func(*ReadyOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "ready [ | | ]", Short: "Mark a pull request as ready for review", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Mark a pull request as ready for review. Without an argument, the pull request that belongs to the current branch is marked as ready. - If supported by your plan, convert to draft with --undo - `), + If supported by your plan, convert to draft with %[1]s--undo%[1]s + `, "`"), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Finder = shared.NewFinder(f) diff --git a/pkg/cmd/pr/view/view.go b/pkg/cmd/pr/view/view.go index 4a69de2f4..9a1eb0a8f 100644 --- a/pkg/cmd/pr/view/view.go +++ b/pkg/cmd/pr/view/view.go @@ -42,14 +42,14 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "view [ | | ]", Short: "View a pull request", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Display the title, body, and other information about a pull request. Without an argument, the pull request that belongs to the current branch is displayed. - With '--web', open the pull request in a web browser instead. - `), + With %[1]s--web%[1]s, open the pull request in a web browser instead. + `, "`"), Args: cobra.MaximumNArgs(1), RunE: func(cmd *cobra.Command, args []string) error { opts.Finder = shared.NewFinder(f) diff --git a/pkg/cmd/project/item-edit/item_edit.go b/pkg/cmd/project/item-edit/item_edit.go index c21548a4a..dcddac8f9 100644 --- a/pkg/cmd/project/item-edit/item_edit.go +++ b/pkg/cmd/project/item-edit/item_edit.go @@ -62,13 +62,13 @@ func NewCmdEditItem(f *cmdutil.Factory, runF func(config editItemConfig) error) editItemCmd := &cobra.Command{ Use: "item-edit", Short: "Edit an item in a project", - Long: heredoc.Doc(` + Long: heredoc.Docf(` 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. - Remove project item field value using "--clear" flag. - `), + Remove project item field value using %[1]s--clear%[1]s flag. + `, "`"), Example: heredoc.Doc(` # edit an item's text field value gh project item-edit --id --field-id --project-id --text "new text" diff --git a/pkg/cmd/release/download/download.go b/pkg/cmd/release/download/download.go index 02519e146..7c2d88a6a 100644 --- a/pkg/cmd/release/download/download.go +++ b/pkg/cmd/release/download/download.go @@ -46,13 +46,13 @@ func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobr cmd := &cobra.Command{ Use: "download []", Short: "Download release assets", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Download assets from a GitHub release. Without an explicit tag name argument, assets are downloaded from the - latest release in the project. In this case, "--pattern" or "--archive" - is required. - `), + latest release in the project. In this case, %[1]s--pattern%[1]s + or %[1]s--archive%[1]s is required. + `, "`"), Example: heredoc.Doc(` # download all assets from a specific release $ gh release download v1.2.3 diff --git a/pkg/cmd/repo/edit/edit.go b/pkg/cmd/repo/edit/edit.go index 112aa5131..508dea06c 100644 --- a/pkg/cmd/repo/edit/edit.go +++ b/pkg/cmd/repo/edit/edit.go @@ -101,7 +101,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(options *EditOptions) error) *cobr Long: heredoc.Docf(` Edit repository settings. - To toggle a setting off, use the %[1]s--flag=false%[1]s syntax. + To toggle a setting off, use the %[1]s--=false%[1]s syntax. Note that changing repository visibility to private will cause loss of stars and watchers. `, "`"), diff --git a/pkg/cmd/ruleset/check/check.go b/pkg/cmd/ruleset/check/check.go index 3007fe36a..7d82990c4 100644 --- a/pkg/cmd/ruleset/check/check.go +++ b/pkg/cmd/ruleset/check/check.go @@ -43,7 +43,7 @@ func NewCmdCheck(f *cmdutil.Factory, runF func(*CheckOptions) error) *cobra.Comm cmd := &cobra.Command{ Use: "check []", Short: "View rules that would apply to a given branch", - Long: heredoc.Doc(` + Long: heredoc.Docf(` View information about GitHub rules that apply to a given branch. The provided branch name does not need to exist; rules will be displayed that would apply @@ -51,9 +51,9 @@ func NewCmdCheck(f *cmdutil.Factory, runF func(*CheckOptions) error) *cobra.Comm If no branch name is provided, then the current branch will be used. - The --default flag can be used to view rules that apply to the default branch of the + The %[1]s--default%[1]s flag can be used to view rules that apply to the default branch of the repository. - `), + `, "`"), Example: heredoc.Doc(` # View all rules that apply to the current branch $ gh ruleset check diff --git a/pkg/cmd/ruleset/list/list.go b/pkg/cmd/ruleset/list/list.go index a4b52073d..e5932d170 100644 --- a/pkg/cmd/ruleset/list/list.go +++ b/pkg/cmd/ruleset/list/list.go @@ -40,18 +40,18 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "list", Short: "List rulesets for a repository or organization", - Long: heredoc.Doc(` + Long: heredoc.Docf(` List GitHub rulesets for a repository or organization. If no options are provided, the current repository's rulesets are listed. You can query a different - repository's rulesets by using the --repo flag. You can also use the --org flag to list rulesets + repository's rulesets by using the %[1]s--repo%[1]s flag. You can also use the %[1]s--org%[1]s flag to list rulesets configured for the provided organization. - Use the --parents flag to control whether rulesets configured at higher levels that also apply to the provided + Use the %[1]s--parents%[1]s flag to control whether rulesets configured at higher levels that also apply to the provided repository or organization should be returned. The default is true. - Your access token must have the admin:org scope to use the --org flag, which can be granted by running "gh auth refresh -s admin:org". - `), + Your access token must have the admin:org scope to use the %[1]s--org%[1]s flag, which can be granted by running "gh auth refresh -s admin:org". + `, "`"), Example: heredoc.Doc(` # List rulesets in the current repository $ gh ruleset list diff --git a/pkg/cmd/ruleset/view/view.go b/pkg/cmd/ruleset/view/view.go index 0b79302e5..1359b1b56 100644 --- a/pkg/cmd/ruleset/view/view.go +++ b/pkg/cmd/ruleset/view/view.go @@ -44,16 +44,16 @@ func NewCmdView(f *cmdutil.Factory, runF func(*ViewOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "view []", Short: "View information about a ruleset", - Long: heredoc.Doc(` + Long: heredoc.Docf(` View information about a GitHub ruleset. If no ID is provided, an interactive prompt will be used to choose the ruleset to view. - Use the --parents flag to control whether rulesets configured at higher + Use the %[1]s--parents%[1]s flag to control whether rulesets configured at higher levels that also apply to the provided repository or organization should be returned. The default is true. - `), + `, "`"), Example: heredoc.Doc(` # Interactively choose a ruleset to view from all rulesets that apply to the current repository $ gh ruleset view diff --git a/pkg/cmd/workflow/run/run.go b/pkg/cmd/workflow/run/run.go index 86b24ed64..9d73502e1 100644 --- a/pkg/cmd/workflow/run/run.go +++ b/pkg/cmd/workflow/run/run.go @@ -53,7 +53,7 @@ func NewCmdRun(f *cmdutil.Factory, runF func(*RunOptions) error) *cobra.Command cmd := &cobra.Command{ Use: "run [ | ]", Short: "Run a workflow by creating a workflow_dispatch event", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Create a workflow_dispatch event for a given workflow. This command will trigger GitHub Actions to run a given workflow file. The given workflow file must @@ -62,9 +62,9 @@ func NewCmdRun(f *cmdutil.Factory, runF func(*RunOptions) error) *cobra.Command If the workflow file supports inputs, they can be specified in a few ways: - Interactively - - via -f or -F flags + - via %[1]s-f/--raw-field%[1]s or %[1]s-F/--field%[1]s flags - As JSON, via STDIN - `), + `, "`"), Example: heredoc.Doc(` # Have gh prompt you for what workflow you'd like to run and interactively collect inputs $ gh workflow run From 896101678faf5dabbc4b3e9619a63fef700c2db4 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Fri, 10 Nov 2023 15:07:34 +0800 Subject: [PATCH 119/527] Wrap cli commands in backticks uniformly --- pkg/cmd/alias/alias.go | 6 +++--- pkg/cmd/alias/imports/import.go | 8 ++++---- pkg/cmd/extension/command.go | 6 +++--- pkg/cmd/gist/clone/clone.go | 6 +++--- pkg/cmd/issue/create/create.go | 6 +++--- pkg/cmd/issue/edit/edit.go | 6 +++--- pkg/cmd/pr/create/create.go | 2 +- pkg/cmd/pr/edit/edit.go | 6 +++--- pkg/cmd/root/help_topic.go | 10 +++++----- pkg/cmd/ruleset/list/list.go | 2 +- pkg/cmd/variable/variable.go | 6 +++--- 11 files changed, 32 insertions(+), 32 deletions(-) diff --git a/pkg/cmd/alias/alias.go b/pkg/cmd/alias/alias.go index 713e7d1db..d91b4dc2d 100644 --- a/pkg/cmd/alias/alias.go +++ b/pkg/cmd/alias/alias.go @@ -14,11 +14,11 @@ func NewCmdAlias(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "alias ", Short: "Create command shortcuts", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Aliases can be used to make shortcuts for gh commands or to compose multiple commands. - Run "gh help alias set" to learn more. - `), + Run %[1]sgh help alias set%[1]s to learn more. + `, "`"), } cmdutil.DisableAuthCheck(cmd) diff --git a/pkg/cmd/alias/imports/import.go b/pkg/cmd/alias/imports/import.go index ef2176d45..ee0457b78 100644 --- a/pkg/cmd/alias/imports/import.go +++ b/pkg/cmd/alias/imports/import.go @@ -34,7 +34,7 @@ func NewCmdImport(f *cmdutil.Factory, runF func(*ImportOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "import [ | -]", Short: "Import aliases from a YAML file", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Import aliases from the contents of a YAML file. Aliases should be defined as a map in YAML, where the keys represent aliases and @@ -49,10 +49,10 @@ func NewCmdImport(f *cmdutil.Factory, runF func(*ImportOptions) error) *cobra.Co Use "-" to read aliases (in YAML format) from standard input. - The output from the gh command "alias list" can be used to produce a YAML file + The output from %[1]sgh alias list%[1]s can be used to produce a YAML file containing your aliases, which you can use to import them from one machine to - another. Run "gh help alias list" to learn more. - `), + another. Run %[1]sgh help alias list%[1]s to learn more. + `, "`"), Example: heredoc.Doc(` # Import aliases from a file $ gh alias import aliases.yml diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index e8e4ecc0b..1908ed5e5 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -109,13 +109,13 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { word "installed" but otherwise the order and content of the columns is the same. - This command behaves similarly to 'gh search repos' but does not + This command behaves similarly to %[1]sgh search repos%[1]s but does not support as many search qualifiers. For a finer grained search of extensions, try using: gh search repos --topic "gh-extension" - and adding qualifiers as needed. See 'gh help search repos' to learn + and adding qualifiers as needed. See %[1]sgh help search repos%[1]s to learn more about repository search. For listing just the extensions that are already installed locally, @@ -449,7 +449,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { gh ext search - along with gh ext install, gh ext remove, and gh repo view. + along with %[1]sgh ext install%[1]s, %[1]sgh ext remove%[1]s, and %[1]sgh repo view%[1]s. `, "`"), Args: cobra.NoArgs, RunE: func(cmd *cobra.Command, args []string) error { diff --git a/pkg/cmd/gist/clone/clone.go b/pkg/cmd/gist/clone/clone.go index d83560f40..a18538ae3 100644 --- a/pkg/cmd/gist/clone/clone.go +++ b/pkg/cmd/gist/clone/clone.go @@ -40,15 +40,15 @@ func NewCmdClone(f *cmdutil.Factory, runF func(*CloneOptions) error) *cobra.Comm Use: "clone [] [-- ...]", Args: cmdutil.MinimumArgs(1, "cannot clone: gist argument required"), Short: "Clone a gist locally", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Clone a GitHub gist locally. A gist can be supplied as argument in either of the following formats: - by ID, e.g. 5b0e0062eb8e9654adad7bb1d81cc75f - by URL, e.g. "https://gist.github.com/OWNER/5b0e0062eb8e9654adad7bb1d81cc75f" - Pass additional 'git clone' flags by listing them after '--'. - `), + Pass additional %[1]sgit clone%[1]s flags by listing them after '--'. + `, "`"), RunE: func(cmd *cobra.Command, args []string) error { opts.Gist = args[0] opts.GitArgs = args[1:] diff --git a/pkg/cmd/issue/create/create.go b/pkg/cmd/issue/create/create.go index 577f08728..39fc21842 100644 --- a/pkg/cmd/issue/create/create.go +++ b/pkg/cmd/issue/create/create.go @@ -56,12 +56,12 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "create", Short: "Create a new issue", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Create an issue on GitHub. Adding an issue to projects requires authorization with the "project" scope. - To authorize, run "gh auth refresh -s project". - `), + To authorize, run %[1]sgh auth refresh -s project%[1]s. + `, "`"), Example: heredoc.Doc(` $ gh issue create --title "I found a bug" --body "Nothing works" $ gh issue create --label "bug,help wanted" diff --git a/pkg/cmd/issue/edit/edit.go b/pkg/cmd/issue/edit/edit.go index 53400fb63..3e85813f6 100644 --- a/pkg/cmd/issue/edit/edit.go +++ b/pkg/cmd/issue/edit/edit.go @@ -50,12 +50,12 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "edit { | }", Short: "Edit issues", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Edit one or more issues within the same repository. Editing issues' projects requires authorization with the "project" scope. - To authorize, run "gh auth refresh -s project". - `), + To authorize, run %[1]sgh auth refresh -s project%[1]s. + `, "`"), Example: heredoc.Doc(` $ gh issue edit 23 --title "I found a bug" --body "Nothing works" $ gh issue edit 23 --add-label "bug,help wanted" --remove-label "core" diff --git a/pkg/cmd/pr/create/create.go b/pkg/cmd/pr/create/create.go index 890171860..cecc32fe0 100644 --- a/pkg/cmd/pr/create/create.go +++ b/pkg/cmd/pr/create/create.go @@ -119,7 +119,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co head branch of the pull request. Disable this with %[1]s--no-maintainer-edit%[1]s. Adding a pull request to projects requires authorization with the "project" scope. - To authorize, run "gh auth refresh -s project". + To authorize, run %[1]sgh auth refresh -s project%[1]s. `, "`"), Example: heredoc.Doc(` $ gh pr create --title "The bug is fixed" --body "Everything works again" diff --git a/pkg/cmd/pr/edit/edit.go b/pkg/cmd/pr/edit/edit.go index c606ae6bb..502b1b384 100644 --- a/pkg/cmd/pr/edit/edit.go +++ b/pkg/cmd/pr/edit/edit.go @@ -47,15 +47,15 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman cmd := &cobra.Command{ Use: "edit [ | | ]", Short: "Edit a pull request", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Edit a pull request. Without an argument, the pull request that belongs to the current branch is selected. Editing a pull request's projects requires authorization with the "project" scope. - To authorize, run "gh auth refresh -s project". - `), + To authorize, run %[1]sgh auth refresh -s project%[1]s. + `, "`"), Example: heredoc.Doc(` $ gh pr edit 23 --title "I found a bug" --body "Nothing works" $ gh pr edit 23 --add-label "bug,help wanted" --remove-label "core" diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go index 7db694668..7fe88f866 100644 --- a/pkg/cmd/root/help_topic.go +++ b/pkg/cmd/root/help_topic.go @@ -21,7 +21,7 @@ var HelpTopics = []helpTopic{ { name: "mintty", short: "Information about using gh with MinTTY", - long: heredoc.Doc(` + long: heredoc.Docf(` MinTTY is the terminal emulator that comes by default with Git for Windows. It has known issues with gh's ability to prompt a user for input. @@ -31,12 +31,12 @@ var HelpTopics = []helpTopic{ - Reinstall Git for Windows, checking "Enable experimental support for pseudo consoles". - Use a different terminal emulator with Git for Windows like Windows Terminal. - You can run "C:\Program Files\Git\bin\bash.exe" from any terminal emulator to continue + You can run %[1]sC:\Program Files\Git\bin\bash.exe%[1]s from any terminal emulator to continue using all of the tooling in Git For Windows without MinTTY. - - Prefix invocations of gh with winpty, eg: "winpty gh auth login". + - Prefix invocations of gh with winpty, eg: %[1]swinpty gh auth login%[1]s. NOTE: this can lead to some UI bugs. - `), + `, "`"), }, { name: "environment", @@ -99,7 +99,7 @@ var HelpTopics = []helpTopic{ GH_PATH: set the path to the gh executable, useful for when gh can not properly determine its own path such as in the cygwin terminal. - `), + `, "`"), }, { name: "reference", diff --git a/pkg/cmd/ruleset/list/list.go b/pkg/cmd/ruleset/list/list.go index e5932d170..010fa315c 100644 --- a/pkg/cmd/ruleset/list/list.go +++ b/pkg/cmd/ruleset/list/list.go @@ -50,7 +50,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman Use the %[1]s--parents%[1]s flag to control whether rulesets configured at higher levels that also apply to the provided repository or organization should be returned. The default is true. - Your access token must have the admin:org scope to use the %[1]s--org%[1]s flag, which can be granted by running "gh auth refresh -s admin:org". + Your access token must have the admin:org scope to use the %[1]s--org%[1]s flag, which can be granted by running %[1]sgh auth refresh -s admin:org%[1]s. `, "`"), Example: heredoc.Doc(` # List rulesets in the current repository diff --git a/pkg/cmd/variable/variable.go b/pkg/cmd/variable/variable.go index 50a61f4e9..f064a81e3 100644 --- a/pkg/cmd/variable/variable.go +++ b/pkg/cmd/variable/variable.go @@ -13,10 +13,10 @@ func NewCmdVariable(f *cmdutil.Factory) *cobra.Command { cmd := &cobra.Command{ Use: "variable ", Short: "Manage GitHub Actions variables", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Variables can be set at the repository, environment or organization level for use in - GitHub Actions or Dependabot. Run "gh help variable set" to learn how to get started. - `), + GitHub Actions or Dependabot. Run %[1]sgh help variable set%[1]s to learn how to get started. + `, "`"), } cmdutil.EnableRepoOverride(cmd, f) From 5c4cb5023177ad73a111bc0667ac7562e0ff31e5 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Fri, 10 Nov 2023 15:38:46 +0800 Subject: [PATCH 120/527] Wrap env variables in backticks uniformly --- pkg/cmd/root/help_topic.go | 42 +++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go index 7fe88f866..4b5841d8e 100644 --- a/pkg/cmd/root/help_topic.go +++ b/pkg/cmd/root/help_topic.go @@ -41,63 +41,63 @@ var HelpTopics = []helpTopic{ { name: "environment", short: "Environment variables that can be used with gh", - long: heredoc.Doc(` - GH_TOKEN, GITHUB_TOKEN (in order of precedence): an authentication token for github.com + long: heredoc.Docf(` + %[1]sGH_TOKEN%[1]s, %[1]sGITHUB_TOKEN%[1]s (in order of precedence): an authentication token for github.com API requests. Setting this avoids being prompted to authenticate and takes precedence over previously stored credentials. - GH_ENTERPRISE_TOKEN, GITHUB_ENTERPRISE_TOKEN (in order of precedence): an authentication - token for API requests to GitHub Enterprise. When setting this, also set GH_HOST. + %[1]sGH_ENTERPRISE_TOKEN%[1]s, %[1]sGITHUB_ENTERPRISE_TOKEN%[1]s (in order of precedence): an authentication + token for API requests to GitHub Enterprise. When setting this, also set %[1]sGH_HOST%[1]s. - GH_HOST: specify the GitHub hostname for commands that would otherwise assume the + %[1]sGH_HOST%[1]s: specify the GitHub hostname for commands that would otherwise assume the "github.com" host when not in a context of an existing repository. When setting this, - also set GH_ENTERPRISE_TOKEN. + also set %[1]sGH_ENTERPRISE_TOKEN%[1]s. - GH_REPO: specify the GitHub repository in the "[HOST/]OWNER/REPO" format for commands + %[1]sGH_REPO%[1]s: specify the GitHub repository in the "[HOST/]OWNER/REPO" format for commands that otherwise operate on a local repository. - GH_EDITOR, GIT_EDITOR, VISUAL, EDITOR (in order of precedence): the editor tool to use + %[1]sGH_EDITOR%[1]s, %[1]sGIT_EDITOR%[1]s, %[1]sVISUAL%[1]s, %[1]sEDITOR%[1]s (in order of precedence): the editor tool to use for authoring text. - GH_BROWSER, BROWSER (in order of precedence): the web browser to use for opening links. + %[1]sGH_BROWSER%[1]s, %[1]sBROWSER%[1]s (in order of precedence): the web browser to use for opening links. - GH_DEBUG: set to a truthy value to enable verbose output on standard error. Set to "api" + %[1]sGH_DEBUG%[1]s: set to a truthy value to enable verbose output on standard error. Set to "api" to additionally log details of HTTP traffic. - DEBUG (deprecated): set to "1", "true", or "yes" to enable verbose output on standard + %[1]sDEBUG%[1]s (deprecated): set to "1", "true", or "yes" to enable verbose output on standard error. - GH_PAGER, PAGER (in order of precedence): a terminal paging program to send standard output + %[1]sGH_PAGER%[1]s, %[1]sPAGER%[1]s (in order of precedence): a terminal paging program to send standard output to, e.g. "less". - GLAMOUR_STYLE: the style to use for rendering Markdown. See + %[1]sGLAMOUR_STYLE%[1]s: the style to use for rendering Markdown. See - NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output. + %[1]sNO_COLOR%[1]s: set to any value to avoid printing ANSI escape sequences for color output. - CLICOLOR: set to "0" to disable printing ANSI colors in output. + %[1]sCLICOLOR%[1]s: set to "0" to disable printing ANSI colors in output. - CLICOLOR_FORCE: set to a value other than "0" to keep ANSI colors in output + %[1]sCLICOLOR_FORCE%[1]s: set to a value other than "0" to keep ANSI colors in output even when the output is piped. - GH_FORCE_TTY: set to any value to force terminal-style output even when the output is + %[1]sGH_FORCE_TTY%[1]s: set to any value to force terminal-style output even when the output is redirected. When the value is a number, it is interpreted as the number of columns available in the viewport. When the value is a percentage, it will be applied against the number of columns available in the current viewport. - GH_NO_UPDATE_NOTIFIER: set to any value to disable update notifications. By default, gh + %[1]sGH_NO_UPDATE_NOTIFIER%[1]s: set to any value to disable update notifications. By default, gh checks for new releases once every 24 hours and displays an upgrade notice on standard error if a newer version was found. - GH_CONFIG_DIR: the directory where gh will store configuration files. If not specified, + %[1]sGH_CONFIG_DIR%[1]s: the directory where gh will store configuration files. If not specified, the default value will be one of the following paths (in order of precedence): - "$XDG_CONFIG_HOME/gh" (if $XDG_CONFIG_HOME is set), - "$AppData/GitHub CLI" (on Windows if $AppData is set), or - "$HOME/.config/gh". - GH_PROMPT_DISABLED: set to any value to disable interactive prompting in the terminal. + %[1]sGH_PROMPT_DISABLED%[1]s: set to any value to disable interactive prompting in the terminal. - GH_PATH: set the path to the gh executable, useful for when gh can not properly determine + %[1]sGH_PATH%[1]s: set the path to the gh executable, useful for when gh can not properly determine its own path such as in the cygwin terminal. `, "`"), }, From b70c28ba2039a064e9064b7dbb30d6d96cad1e73 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Fri, 10 Nov 2023 15:35:53 +0800 Subject: [PATCH 121/527] Misc docs improvements --- pkg/cmd/alias/set/set.go | 2 +- pkg/cmd/codespace/ssh.go | 8 ++++---- pkg/cmd/extension/command.go | 4 ++-- pkg/cmd/gist/clone/clone.go | 2 +- pkg/cmd/pr/merge/merge.go | 2 +- pkg/cmd/ruleset/list/list.go | 2 +- pkg/cmd/run/rerun/rerun.go | 2 +- pkg/cmd/workflow/run/run.go | 6 +++--- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/pkg/cmd/alias/set/set.go b/pkg/cmd/alias/set/set.go index 840df5770..2f6eef395 100644 --- a/pkg/cmd/alias/set/set.go +++ b/pkg/cmd/alias/set/set.go @@ -47,7 +47,7 @@ func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command is useful to avoid quoting issues when defining expansions. If the expansion starts with "!" or if %[1]s--shell%[1]s was given, the expansion is a shell - expression that will be evaluated through the "sh" interpreter when the alias is + expression that will be evaluated through the %[1]ssh%[1]s interpreter when the alias is invoked. This allows for chaining multiple commands via piping and redirection. `, "`"), Example: heredoc.Doc(` diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go index 384b92bb8..ab44cf692 100644 --- a/pkg/cmd/codespace/ssh.go +++ b/pkg/cmd/codespace/ssh.go @@ -80,11 +80,11 @@ func newSSHCmd(app *App) *cobra.Command { install it in your Dockerfile or, for codespaces that use Debian-based images, you can add the following to your devcontainer.json: - "features": { - "ghcr.io/devcontainers/features/sshd:1": { - "version": "latest" + "features": { + "ghcr.io/devcontainers/features/sshd:1": { + "version": "latest" + } } - } `), Example: heredoc.Doc(` $ gh codespace ssh diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index 1908ed5e5..3f22066da 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -102,7 +102,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { When connected to a terminal, this command prints out three columns. The first has a ✓ if the extension is already installed locally. The - second is the full name of the extension repository in NAME/OWNER + second is the full name of the extension repository in "NAME/OWNER" format. The third is the extension's description. When not connected to a terminal, the ✓ character is rendered as the @@ -300,7 +300,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { Long: heredoc.Doc(` Install a GitHub repository locally as a GitHub CLI extension. - The repository argument can be specified in "owner/repo" format as well as a full URL. + The repository argument can be specified in "OWNER/REPO" format as well as a full URL. The URL format is useful when the repository is not hosted on github.com. To install an extension in development from the current directory, use "." as the diff --git a/pkg/cmd/gist/clone/clone.go b/pkg/cmd/gist/clone/clone.go index a18538ae3..5360080e8 100644 --- a/pkg/cmd/gist/clone/clone.go +++ b/pkg/cmd/gist/clone/clone.go @@ -47,7 +47,7 @@ func NewCmdClone(f *cmdutil.Factory, runF func(*CloneOptions) error) *cobra.Comm - by ID, e.g. 5b0e0062eb8e9654adad7bb1d81cc75f - by URL, e.g. "https://gist.github.com/OWNER/5b0e0062eb8e9654adad7bb1d81cc75f" - Pass additional %[1]sgit clone%[1]s flags by listing them after '--'. + Pass additional %[1]sgit clone%[1]s flags by listing them after "--". `, "`"), RunE: func(cmd *cobra.Command, args []string) error { opts.Gist = args[0] diff --git a/pkg/cmd/pr/merge/merge.go b/pkg/cmd/pr/merge/merge.go index d03d55089..9582ab695 100644 --- a/pkg/cmd/pr/merge/merge.go +++ b/pkg/cmd/pr/merge/merge.go @@ -85,7 +85,7 @@ func NewCmdMerge(f *cmdutil.Factory, runF func(*MergeOptions) error) *cobra.Comm is selected. When targeting a branch that requires a merge queue, no merge strategy is required. - If required checks have not yet passed, AutoMerge will be enabled. + If required checks have not yet passed, auto-merge will be enabled. If required checks have passed, the pull request will be added to the merge queue. To bypass a merge queue and merge directly, pass the %[1]s--admin%[1]s flag. `, "`"), diff --git a/pkg/cmd/ruleset/list/list.go b/pkg/cmd/ruleset/list/list.go index 010fa315c..91f5e765f 100644 --- a/pkg/cmd/ruleset/list/list.go +++ b/pkg/cmd/ruleset/list/list.go @@ -50,7 +50,7 @@ func NewCmdList(f *cmdutil.Factory, runF func(*ListOptions) error) *cobra.Comman Use the %[1]s--parents%[1]s flag to control whether rulesets configured at higher levels that also apply to the provided repository or organization should be returned. The default is true. - Your access token must have the admin:org scope to use the %[1]s--org%[1]s flag, which can be granted by running %[1]sgh auth refresh -s admin:org%[1]s. + Your access token must have the "admin:org" scope to use the %[1]s--org%[1]s flag, which can be granted by running %[1]sgh auth refresh -s admin:org%[1]s. `, "`"), Example: heredoc.Doc(` # List rulesets in the current repository diff --git a/pkg/cmd/run/rerun/rerun.go b/pkg/cmd/run/rerun/rerun.go index 56580c642..005e3443d 100644 --- a/pkg/cmd/run/rerun/rerun.go +++ b/pkg/cmd/run/rerun/rerun.go @@ -46,7 +46,7 @@ func NewCmdRerun(f *cmdutil.Factory, runF func(*RerunOptions) error) *cobra.Comm 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. + %[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: diff --git a/pkg/cmd/workflow/run/run.go b/pkg/cmd/workflow/run/run.go index 9d73502e1..4f2f14b9f 100644 --- a/pkg/cmd/workflow/run/run.go +++ b/pkg/cmd/workflow/run/run.go @@ -54,10 +54,10 @@ func NewCmdRun(f *cmdutil.Factory, runF func(*RunOptions) error) *cobra.Command Use: "run [ | ]", Short: "Run a workflow by creating a workflow_dispatch event", Long: heredoc.Docf(` - Create a workflow_dispatch event for a given workflow. + Create a %[1]sworkflow_dispatch%[1]s event for a given workflow. This command will trigger GitHub Actions to run a given workflow file. The given workflow file must - support a workflow_dispatch 'on' trigger in order to be run in this way. + support a %[1]son.workflow_dispatch%[1]s trigger in order to be run in this way. If the workflow file supports inputs, they can be specified in a few ways: @@ -129,7 +129,7 @@ func NewCmdRun(f *cmdutil.Factory, runF func(*RunOptions) error) *cobra.Command }, } cmd.Flags().StringVarP(&opts.Ref, "ref", "r", "", "The branch or tag name which contains the version of the workflow file you'd like to run") - cmd.Flags().StringArrayVarP(&opts.MagicFields, "field", "F", nil, "Add a string parameter in `key=value` format, respecting @ syntax") + cmd.Flags().StringArrayVarP(&opts.MagicFields, "field", "F", nil, "Add a string parameter in `key=value` format, respecting @ syntax (see \"gh help api\").") cmd.Flags().StringArrayVarP(&opts.RawFields, "raw-field", "f", nil, "Add a string parameter in `key=value` format") cmd.Flags().BoolVar(&opts.JSON, "json", false, "Read workflow inputs as JSON via STDIN") From 8eec3e8040108d32b4e8aef22d7f13cafe7a3733 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Thu, 16 Nov 2023 23:08:02 +0800 Subject: [PATCH 122/527] Wrap path to file in backticks --- pkg/cmd/codespace/ssh.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go index ab44cf692..f44c09958 100644 --- a/pkg/cmd/codespace/ssh.go +++ b/pkg/cmd/codespace/ssh.go @@ -712,7 +712,7 @@ func newCpCmd(app *App) *cobra.Command { provided by untrusted users; see for discussion. By default, the 'cp' command will create a public/private ssh key pair to authenticate with - the codespace inside the ~/.ssh directory. + the codespace inside the %[1]s~/.ssh directory%[1]s. `, "`"), Example: heredoc.Doc(` $ gh codespace cp -e README.md 'remote:/workspaces/$RepositoryName/' From 5612d2864ef49dbc6b7bf9da9fbda6d45b83b415 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Thu, 16 Nov 2023 23:10:46 +0800 Subject: [PATCH 123/527] Add leftovers --- pkg/cmd/codespace/ssh.go | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go index f44c09958..1086cfa56 100644 --- a/pkg/cmd/codespace/ssh.go +++ b/pkg/cmd/codespace/ssh.go @@ -53,39 +53,39 @@ func newSSHCmd(app *App) *cobra.Command { sshCmd := &cobra.Command{ Use: "ssh [...] [-- ...] []", Short: "SSH into a codespace", - Long: heredoc.Doc(` - The 'ssh' command is used to SSH into a codespace. In its simplest form, you can - run 'gh cs ssh', select a codespace interactively, and connect. + Long: heredoc.Docf(` + The %[1]sssh%[1]s command is used to SSH into a codespace. In its simplest form, you can + run %[1]sgh cs ssh%[1]s, select a codespace interactively, and connect. - The 'ssh' command will automatically create a public/private ssh key pair in the - ~/.ssh directory if you do not have an existing valid key pair. When selecting the + The %[1]sssh%[1]s command will automatically create a public/private ssh key pair in the + %[1]s~/.ssh%[1]s directory if you do not have an existing valid key pair. When selecting the key pair to use, the preferred order is: - 1. Key specified by -i in + 1. Key specified by %[1]s-i%[1]s in %[1]s%[1]s 2. Automatic key, if it already exists - 3. First valid key pair in ssh config (according to ssh -G) + 3. First valid key pair in ssh config (according to %[1]sssh -G%[1]s) 4. Automatic key, newly created - The 'ssh' command also supports deeper integration with OpenSSH using a '--config' + The %[1]sssh%[1]s command also supports deeper integration with OpenSSH using a %[1]s--config%[1]s option that generates per-codespace ssh configuration in OpenSSH format. - Including this configuration in your ~/.ssh/config improves the user experience - of tools that integrate with OpenSSH, such as bash/zsh completion of ssh hostnames, - remote path completion for scp/rsync/sshfs, git ssh remotes, and so on. + Including this configuration in your %[1]s~/.ssh/config%[1]s improves the user experience + of tools that integrate with OpenSSH, such as Bash/Zsh completion of ssh hostnames, + remote path completion for %[1]sscp%[1]s/%[1]srsync%[1]s/%[1]ssshfs%[1]s, git ssh remotes, and so on. Once that is set up (see the second example below), you can ssh to codespaces as - if they were ordinary remote hosts (using 'ssh', not 'gh cs ssh'). + if they were ordinary remote hosts (using %[1]sssh%[1]s, not %[1]sgh cs ssh%[1]s). Note that the codespace you are connecting to must have an SSH server pre-installed. If the docker image being used for the codespace does not have an SSH server, install it in your Dockerfile or, for codespaces that use Debian-based images, - you can add the following to your devcontainer.json: + you can add the following to your %[1]sdevcontainer.json%[1]s: "features": { "ghcr.io/devcontainers/features/sshd:1": { "version": "latest" } } - `), + `, "`"), Example: heredoc.Doc(` $ gh codespace ssh @@ -693,7 +693,7 @@ func newCpCmd(app *App) *cobra.Command { Use: "cp [-e] [-r] [-- [...]] ... ", Short: "Copy files between local and remote file systems", Long: heredoc.Docf(` - The cp command copies files between the local and remote file systems. + The %[1]scp%[1]s command copies files between the local and remote file systems. As with the UNIX %[1]scp%[1]s command, the first argument specifies the source and the last specifies the destination; additional sources may be specified after the first, @@ -711,7 +711,7 @@ func newCpCmd(app *App) *cobra.Command { environment variables, and backticks. For security, do not use this flag with arguments provided by untrusted users; see for discussion. - By default, the 'cp' command will create a public/private ssh key pair to authenticate with + By default, the %[1]scp%[1]s command will create a public/private ssh key pair to authenticate with the codespace inside the %[1]s~/.ssh directory%[1]s. `, "`"), Example: heredoc.Doc(` From 21bf1babdf576561b38ad3b73117a70e8d4218c7 Mon Sep 17 00:00:00 2001 From: Yukai Chou Date: Fri, 17 Nov 2023 01:31:37 +0800 Subject: [PATCH 124/527] Proof-reading --- pkg/cmd/alias/set/set.go | 2 +- pkg/cmd/api/api.go | 10 +++++----- pkg/cmd/codespace/ssh.go | 2 +- pkg/cmd/extension/command.go | 2 +- pkg/cmd/gist/clone/clone.go | 2 +- pkg/cmd/gist/create/create.go | 2 +- pkg/cmd/release/download/download.go | 4 ++-- pkg/cmd/release/upload/upload.go | 6 +++--- pkg/cmd/root/help_topic.go | 8 ++++---- pkg/cmd/run/rerun/rerun.go | 2 +- pkg/cmd/search/code/code.go | 2 +- pkg/cmd/secret/secret.go | 6 +++--- pkg/cmd/workflow/run/run.go | 4 ++-- 13 files changed, 26 insertions(+), 26 deletions(-) diff --git a/pkg/cmd/alias/set/set.go b/pkg/cmd/alias/set/set.go index 2f6eef395..13dc6c61c 100644 --- a/pkg/cmd/alias/set/set.go +++ b/pkg/cmd/alias/set/set.go @@ -43,7 +43,7 @@ func NewCmdSet(f *cmdutil.Factory, runF func(*SetOptions) error) *cobra.Command inserted appropriately. Otherwise, extra arguments will be appended to the expanded command. - Use "-" as expansion argument to read the expansion string from standard input. This + Use %[1]s-%[1]s as expansion argument to read the expansion string from standard input. This is useful to avoid quoting issues when defining expansions. If the expansion starts with "!" or if %[1]s--shell%[1]s was given, the expansion is a shell diff --git a/pkg/cmd/api/api.go b/pkg/cmd/api/api.go index 610f2f830..6432cd302 100644 --- a/pkg/cmd/api/api.go +++ b/pkg/cmd/api/api.go @@ -75,7 +75,7 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command Placeholder values "{owner}", "{repo}", and "{branch}" in the endpoint argument will get replaced with values from the repository of the current - directory or the repository specified in the GH_REPO environment variable. + directory or the repository specified in the %[1]sGH_REPO%[1]s environment variable. Note that in some shells, for example PowerShell, you may need to enclose any value that contains "{...}" in quotes to prevent the shell from applying special meaning to curly braces. @@ -85,8 +85,8 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command Pass one or more %[1]s-f/--raw-field%[1]s values in "key=value" format to add static string parameters to the request payload. To add non-string or placeholder-determined values, see - %[1]s--field%[1]s below. Note that adding request parameters will automatically switch the - request method to POST. To send the parameters as a GET query string instead, use + %[1]s-F/--field%[1]s below. Note that adding request parameters will automatically switch the + request method to "POST". To send the parameters as a "GET" query string instead, use %[1]s--method GET%[1]s. The %[1]s-F/--field%[1]s flag has magic type conversion based on the format of the value: @@ -96,7 +96,7 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command - placeholder values "{owner}", "{repo}", and "{branch}" get populated with values from the repository of the current directory; - if the value starts with "@", the rest of the value is interpreted as a - filename to read the value from. Pass "-" to read from standard input. + filename to read the value from. Pass %[1]s-%[1]s to read from standard input. For GraphQL requests, all fields other than "query" and "operationName" are interpreted as GraphQL variables. @@ -107,7 +107,7 @@ func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command value. To pass pre-constructed JSON or payloads in other formats, a request body may be read - from file specified by %[1]s--input%[1]s. Use "-" to read from standard input. When passing the + from file specified by %[1]s--input%[1]s. Use %[1]s-%[1]s to read from standard input. When passing the request body this way, any parameters specified via field flags are added to the query string of the endpoint URL. diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go index 1086cfa56..45c828ce4 100644 --- a/pkg/cmd/codespace/ssh.go +++ b/pkg/cmd/codespace/ssh.go @@ -70,7 +70,7 @@ func newSSHCmd(app *App) *cobra.Command { option that generates per-codespace ssh configuration in OpenSSH format. Including this configuration in your %[1]s~/.ssh/config%[1]s improves the user experience of tools that integrate with OpenSSH, such as Bash/Zsh completion of ssh hostnames, - remote path completion for %[1]sscp%[1]s/%[1]srsync%[1]s/%[1]ssshfs%[1]s, git ssh remotes, and so on. + remote path completion for %[1]sscp/rsync/sshfs%[1]s, git ssh remotes, and so on. Once that is set up (see the second example below), you can ssh to codespaces as if they were ordinary remote hosts (using %[1]sssh%[1]s, not %[1]sgh cs ssh%[1]s). diff --git a/pkg/cmd/extension/command.go b/pkg/cmd/extension/command.go index 3f22066da..8693a6c5d 100644 --- a/pkg/cmd/extension/command.go +++ b/pkg/cmd/extension/command.go @@ -102,7 +102,7 @@ func NewCmdExtension(f *cmdutil.Factory) *cobra.Command { When connected to a terminal, this command prints out three columns. The first has a ✓ if the extension is already installed locally. The - second is the full name of the extension repository in "NAME/OWNER" + second is the full name of the extension repository in "OWNER/REPO" format. The third is the extension's description. When not connected to a terminal, the ✓ character is rendered as the diff --git a/pkg/cmd/gist/clone/clone.go b/pkg/cmd/gist/clone/clone.go index 5360080e8..ee853f96d 100644 --- a/pkg/cmd/gist/clone/clone.go +++ b/pkg/cmd/gist/clone/clone.go @@ -47,7 +47,7 @@ func NewCmdClone(f *cmdutil.Factory, runF func(*CloneOptions) error) *cobra.Comm - by ID, e.g. 5b0e0062eb8e9654adad7bb1d81cc75f - by URL, e.g. "https://gist.github.com/OWNER/5b0e0062eb8e9654adad7bb1d81cc75f" - Pass additional %[1]sgit clone%[1]s flags by listing them after "--". + Pass additional %[1]sgit clone%[1]s flags by listing them after %[1]s--%[1]s. `, "`"), RunE: func(cmd *cobra.Command, args []string) error { opts.Gist = args[0] diff --git a/pkg/cmd/gist/create/create.go b/pkg/cmd/gist/create/create.go index 29f46b9ff..5dec11cb7 100644 --- a/pkg/cmd/gist/create/create.go +++ b/pkg/cmd/gist/create/create.go @@ -53,7 +53,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co Long: heredoc.Docf(` Create a new GitHub gist with given contents. - Gists can be created from one or multiple files. Alternatively, pass "-" as + Gists can be created from one or multiple files. Alternatively, pass %[1]s-%[1]s as file name to read from standard input. By default, gists are secret; use %[1]s--public%[1]s to make publicly listed ones. diff --git a/pkg/cmd/release/download/download.go b/pkg/cmd/release/download/download.go index 7c2d88a6a..56e6ac72a 100644 --- a/pkg/cmd/release/download/download.go +++ b/pkg/cmd/release/download/download.go @@ -50,8 +50,8 @@ func NewCmdDownload(f *cmdutil.Factory, runF func(*DownloadOptions) error) *cobr Download assets from a GitHub release. Without an explicit tag name argument, assets are downloaded from the - latest release in the project. In this case, %[1]s--pattern%[1]s - or %[1]s--archive%[1]s is required. + latest release in the project. In this case, %[1]s--pattern%[1]s or %[1]s--archive%[1]s + is required. `, "`"), Example: heredoc.Doc(` # download all assets from a specific release diff --git a/pkg/cmd/release/upload/upload.go b/pkg/cmd/release/upload/upload.go index 12cba4542..20d087a58 100644 --- a/pkg/cmd/release/upload/upload.go +++ b/pkg/cmd/release/upload/upload.go @@ -38,12 +38,12 @@ func NewCmdUpload(f *cmdutil.Factory, runF func(*UploadOptions) error) *cobra.Co cmd := &cobra.Command{ Use: "upload ...", Short: "Upload assets to a release", - Long: heredoc.Doc(` + Long: heredoc.Docf(` Upload asset files to a GitHub Release. - To define a display label for an asset, append text starting with '#' after the + To define a display label for an asset, append text starting with %[1]%#%[1]% after the file name. - `), + `, "`"), Args: cobra.MinimumNArgs(2), RunE: func(cmd *cobra.Command, args []string) error { // support `-R, --repo` override diff --git a/pkg/cmd/root/help_topic.go b/pkg/cmd/root/help_topic.go index 4b5841d8e..537702005 100644 --- a/pkg/cmd/root/help_topic.go +++ b/pkg/cmd/root/help_topic.go @@ -91,9 +91,9 @@ var HelpTopics = []helpTopic{ %[1]sGH_CONFIG_DIR%[1]s: the directory where gh will store configuration files. If not specified, the default value will be one of the following paths (in order of precedence): - - "$XDG_CONFIG_HOME/gh" (if $XDG_CONFIG_HOME is set), - - "$AppData/GitHub CLI" (on Windows if $AppData is set), or - - "$HOME/.config/gh". + - %[1]s$XDG_CONFIG_HOME/gh%[1]s (if %[1]s$XDG_CONFIG_HOME%[1]s is set), + - %[1]s$AppData/GitHub CLI%[1]s (on Windows if %[1]s$AppData%[1]s is set), or + - %[1]s$HOME/.config/gh%[1]s. %[1]sGH_PROMPT_DISABLED%[1]s: set to any value to disable interactive prompting in the terminal. @@ -138,7 +138,7 @@ var HelpTopics = []helpTopic{ - %[1]stablerow ...%[1]s: aligns fields in output vertically as a table - %[1]stablerender%[1]s: renders fields added by tablerow in place - %[1]stimeago