STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #43 from bchadwic/trunk

Browse source 
Fixing issues in the pr
This commit is contained in:
Benjamin Chadwick 2021-06-11 08:04:09 -07:00 • committed by GitHub
commit 14a1f63f78
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 151 additions and 125 deletions
Download patch file Download diff file Expand all files Collapse all files

84
pkg/cmd/browse/browse.go
View file

@ -11,6 +11,7 @@ import (
"github.com/cli/cli/internal/ghrepo"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/iostreams"
"github.com/cli/cli/utils"
"github.com/spf13/cobra"
)
@ -45,8 +46,8 @@ func NewCmdBrowse(f *cmdutil.Factory) *cobra.Command {
cmd := &cobra.Command{
Long: "Open the GitHub repository in the web browser.",
Short: "Open the repository in the browser",
Use: "browse {<number> | <path>}",
Args: cobra.RangeArgs(0, 1),
Use: "browse [<number> | <path>]",
Args: cobra.MaximumNArgs(1),
Example: heredoc.Doc(`
$ gh browse
#=> Open the home page of the current repository
@ -116,52 +117,51 @@ func runBrowse(opts *BrowseOptions) error {
return fmt.Errorf("unable to create an http client: %w\nUse 'gh browse --help' for more information about browse\n", err)
}
apiClient := api.NewClientFromHTTP(httpClient)
branchName, err := api.RepoDefaultBranch(apiClient, baseRepo)
// if err != nil { //TODO resolve errors related to using this with tests
// return fmt.Errorf("unable to determine default branch for %s: %w", ghrepo.FullName(baseRepo), err)
// }
repoUrl := ghrepo.GenerateRepoURL(baseRepo, "")
hasArg := opts.SelectorArg != ""
hasFlag := opts.FlagAmount > 0
if opts.Branch != "" {
err, repoUrl = addBranch(opts, repoUrl)
repoUrl, err = addBranch(opts, repoUrl)
if err != nil {
return err
}
} else if hasArg && (!hasFlag || opts.RepoFlag) {
err, repoUrl = addArg(opts, repoUrl, branchName)
apiClient := api.NewClientFromHTTP(httpClient)
branchName, err := api.RepoDefaultBranch(apiClient, baseRepo)
if err != nil {
return fmt.Errorf("unable to determine default branch for %s: %w", ghrepo.FullName(baseRepo), err)
}
repoUrl, err = addArg(opts, repoUrl, branchName)
if err != nil {
return err
}
} else if !hasArg && hasFlag {
repoUrl = addFlag(opts, repoUrl)
} else {
fmt.Fprintf(opts.IO.Out, "now opening %s in browser . . .\n", repoUrl)
if opts.IO.IsStdoutTTY() {
fmt.Fprintf(opts.IO.Out, "Opening %s in your browser.\n", utils.DisplayURL(repoUrl))
}
}
opts.Browser.Browse(repoUrl)
return nil
}
func addBranch(opts *BrowseOptions, url string) (error, string) {
func addBranch(opts *BrowseOptions, url string) (string, error) {
if opts.SelectorArg == "" {
url += "/tree/" + opts.Branch
} else {
err, arr := parseFileArg(opts.SelectorArg)
arr, err := parseFileArg(opts.SelectorArg)
if err != nil {
return err, url
}
if len(arr) > 1 {
url += "/tree/" + opts.Branch + "/" + arr[0] + "#L" + arr[1]
} else {
url += "/tree/" + opts.Branch + "/" + arr[0]
return url, err
}
url += parsedUrl(arr, opts.Branch)
}
fmt.Fprintf(opts.IO.Out, "now opening %s in browser . . .\n", url)
return nil, url
if opts.IO.IsStdoutTTY() {
fmt.Fprintf(opts.IO.Out, "now opening %s in browser . . .\n", url)
}
return url, nil
}
func addFlag(opts *BrowseOptions, url string) string {
@ -172,38 +172,50 @@ func addFlag(opts *BrowseOptions, url string) string {
} else if opts.WikiFlag {
url += "/wiki"
}
fmt.Fprintf(opts.IO.Out, "now opening %s in browser . . .\n", url)
if opts.IO.IsStdoutTTY() {
fmt.Fprintf(opts.IO.Out, "now opening %s in browser . . .\n", url)
}
return url
}
func addArg(opts *BrowseOptions, url string, branchName string) (error, string) {
func addArg(opts *BrowseOptions, url string, branchName string) (string, error) {
if isNumber(opts.SelectorArg) {
url += "/issues/" + opts.SelectorArg
fmt.Fprintf(opts.IO.Out, "now opening issue/pr in browser . . .\n")
if opts.IO.IsStdoutTTY() {
fmt.Fprintf(opts.IO.Out, "now opening issue/pr in browser . . .\n")
}
} else {
err, arr := parseFileArg(opts.SelectorArg)
arr, err := parseFileArg(opts.SelectorArg)
if err != nil {
return err, url
return url, err
}
if len(arr) > 1 {
url += "/tree/" + branchName + "/" + arr[0] + "#L" + arr[1]
} else {
url += "/tree/" + branchName + "/" + arr[0]
url += parsedUrl(arr, branchName)
if opts.IO.IsStdoutTTY() {
fmt.Fprintf(opts.IO.Out, "now opening %s in browser . . .\n", url)
}
fmt.Fprintf(opts.IO.Out, "now opening %s in browser . . .\n", url)
}
return nil, url
return url, nil
}
func parseFileArg(fileArg string) (error, []string) {
func parsedUrl(arr []string, branchName string) string {
if len(arr) > 1 {
return "/tree/" + branchName + "/" + arr[0] + "#L" + arr[1]
} else {
return "/tree/" + branchName + "/" + arr[0]
}
}
func parseFileArg(fileArg string) ([]string, error) {
arr := strings.Split(fileArg, ":")
if len(arr) > 2 {
return fmt.Errorf("invalid use of colon\nUse 'gh browse --help' for more information about browse\n"), arr
return arr, fmt.Errorf("invalid use of colon\nUse 'gh browse --help' for more information about browse\n")
}
if len(arr) > 1 && !isNumber(arr[1]) {
return fmt.Errorf("invalid line number after colon\nUse 'gh browse --help' for more information about browse\n"), arr
return arr, fmt.Errorf("invalid line number after colon\nUse 'gh browse --help' for more information about browse\n")
}
return nil, arr
return arr, nil
}
func isNumber(arg string) bool {

191
pkg/cmd/browse/browse_test.go
View file

@ -51,98 +51,113 @@ func runCommand(rt http.RoundTripper, repo ghrepo.Interface, cli string) (*test.
BrowsedURL: browser.BrowsedURL(),
}, err
}
func TestNewCmdBrowse(t *testing.T) {
// func TestNewCmdBrowse(t *testing.T) {
type args struct {
repo ghrepo.Interface
cli string
// type args struct {
// repo ghrepo.Interface
// cli string
// }
// tests := []struct {
// name string
// args args
// errorExpected bool
// stdoutExpected string
// stderrExpected string
// urlExpected string
// }{
// {
// name: "multiple flag",
// args: args{
// repo: ghrepo.New("jessica", "cli"),
// cli: "--settings --projects",
// },
// errorExpected: true,
// stdoutExpected: "",
// stderrExpected: "these two flags are incompatible, see below for instructions",
// urlExpected: "",
// },
// {
// name: "settings flag",
// args: args{
// repo: ghrepo.New("husrav", "cli"),
// cli: "--settings",
// },
// errorExpected: false,
// stdoutExpected: "now opening https://github.com/husrav/cli/settings in browser . . .\n",
// stderrExpected: "",
// urlExpected: "https://github.com/husrav/cli/settings",
// },
// {
// name: "projects flag",
// args: args{
// repo: ghrepo.New("ben", "cli"),
// cli: "--projects",
// },
// errorExpected: false,
// stdoutExpected: "now opening https://github.com/ben/cli/projects in browser . . .\n",
// stderrExpected: "",
// urlExpected: "https://github.com/ben/cli/projects",
// },
// {
// name: "wiki flag",
// args: args{
// repo: ghrepo.New("thanh", "cli"),
// cli: "--wiki",
// },
// errorExpected: false,
// stdoutExpected: "now opening https://github.com/thanh/cli/wiki in browser . . .\n",
// stderrExpected: "",
// urlExpected: "https://github.com/thanh/cli/wiki",
// },
// }
// for _, tt := range tests {
// t.Run(tt.name, func(t *testing.T) {
// http := &httpmock.Registry{}
// // http.StubRepoInfoResponse(tt.args.repo.RepoHost(), tt.args.repo.RepoName(), "main")
// defer http.Verify(t)
// _, cmdTeardown := run.Stub()
// defer cmdTeardown(t)
// output, err := runCommand(http, tt.args.repo, tt.args.cli)
// if tt.errorExpected {
// assert.Equal(t, err.Error(), tt.stderrExpected)
// } else {
// assert.Equal(t, err, nil)
// }
// assert.Equal(t, tt.stdoutExpected, output.OutBuf.String())
// assert.Equal(t, tt.urlExpected, output.BrowsedURL)
// })
// }
// }
func TestBrowse(t *testing.T) {
tests := []BrowseOptions{
{
BaseRepo func() (ghrepo.Interface, error)
Browser browser
HttpClient func() (*http.Client, error)
IO *iostreams.IOStreams
FlagAmount int
SelectorArg string
Branch string
ProjectsFlag bool
RepoFlag bool
SettingsFlag bool
WikiFlag bool
},
}
for _,tt range tests {
tests := []struct {
name string
args args
errorExpected bool
stdoutExpected string
stderrExpected string
urlExpected string
}{
{
name: "multiple flag",
args: args{
repo: ghrepo.New("jessica", "cli"),
cli: "--settings --projects",
},
errorExpected: true,
stdoutExpected: "",
stderrExpected: "these two flags are incompatible, see below for instructions",
urlExpected: "",
},
{
name: "settings flag",
args: args{
repo: ghrepo.New("husrav", "cli"),
cli: "--settings",
},
errorExpected: false,
stdoutExpected: "now opening https://github.com/husrav/cli/settings in browser . . .\n",
stderrExpected: "",
urlExpected: "https://github.com/husrav/cli/settings",
},
{
name: "projects flag",
args: args{
repo: ghrepo.New("ben", "cli"),
cli: "--projects",
},
errorExpected: false,
stdoutExpected: "now opening https://github.com/ben/cli/projects in browser . . .\n",
stderrExpected: "",
urlExpected: "https://github.com/ben/cli/projects",
},
{
name: "wiki flag",
args: args{
repo: ghrepo.New("thanh", "cli"),
cli: "--wiki",
},
errorExpected: false,
stdoutExpected: "now opening https://github.com/thanh/cli/wiki in browser . . .\n",
stderrExpected: "",
urlExpected: "https://github.com/thanh/cli/wiki",
},
// {
// name: "branch flag",
// args: args{
// repo: ghrepo.New("ken", "cli"),
// cli: "--branch",
// },
// errorExpected: false,
// stdoutExpected: "",
// stderrExpected: "Aa",
// urlExpected: "",
// },
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
http := &httpmock.Registry{}
defer http.Verify(t)
_, cmdTeardown := run.Stub()
defer cmdTeardown(t)
output, err := runCommand(http, tt.args.repo, tt.args.cli)
if tt.errorExpected {
assert.Equal(t, err.Error(), tt.stderrExpected)
} else {
assert.Equal(t, err, nil)
}
assert.Equal(t, tt.stdoutExpected, output.OutBuf.String())
assert.Equal(t, tt.urlExpected, output.BrowsedURL)
})
}
}
func TestFileArgParsing(t *testing.T) {
tests := []struct {
name string
@ -173,7 +188,7 @@ func TestFileArgParsing(t *testing.T) {
},
}
for _, tt := range tests {
err, arr := parseFileArg(tt.arg)
arr, err := parseFileArg(tt.arg)
if tt.errorExpected {
assert.Equal(t, err.Error(), tt.stderrExpected)
} else {

1
pkg/cmd/root/help.go
View file

@ -15,7 +15,6 @@ import (
func rootUsageFunc(command *cobra.Command) error {
command.Printf("Usage: %s", command.UseLine())
// make sure commands isn't empty
subcommands := command.Commands()
if len(subcommands) > 0 {
command.Print("\n\nAvailable commands:\n")