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

review feedback

Browse source
This commit is contained in:
vilmibm 2020-08-12 12:02:58 -05:00
parent f7ee39dfeb
commit 2f1e9ecc7a
2 changed files with 16 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

35
pkg/cmd/auth/refresh/refresh.go
View file

@ -19,40 +19,34 @@ type RefreshOptions struct {
Hostname string
Scopes []string
AuthFlow func(config.Config, string, []string) error
}
func NewCmdRefresh(f *cmdutil.Factory, runF func(*RefreshOptions) error) *cobra.Command {
opts := &RefreshOptions{
IO: f.IOStreams,
Config: f.Config,
AuthFlow: func(cfg config.Config, hostname string, scopes []string) error {
_, err := config.AuthFlowWithConfig(cfg, hostname, "", scopes)
return err
},
}
cmd := &cobra.Command{
Use: "refresh",
Args: cobra.ExactArgs(0),
Short: "Request new scopes for a token",
Long: heredoc.Doc(`Expand the permission scopes for a given host's token.
Short: "Refresh stored authentication credentials",
Long: heredoc.Doc(`Expand or fix the permission scopes for stored credentials
This command allows you to add additional scopes to an existing authentication token via a web
browser. This enables gh to access more of the GitHub API, which may be required as gh adds
features or as you use the gh api command.
Unfortunately at this time there is no way to add scopes without a web browser's involvement
due to how GitHub authentication works.
The --hostname flag allows you to operate on a GitHub host other than github.com.
The --scopes flag accepts a comma separated list of scopes you want to add to a token. If
absent, this command ensures that a host's token has the default set of scopes required by gh.
Note that if GITHUB_TOKEN is in the current environment, this command will not work.
The --scopes flag accepts a comma separated list of scopes you want your gh credentials to have. If
absent, this command ensures that gh has access to a minimum set of scopes.
`),
Example: heredoc.Doc(`
$ gh auth refresh --scopes write:org,read:public_key
# => open a browser to add write:org and read:public_key scopes for use with gh api
$ gh auth refresh
# => ensure that the required minimum scopes are enabled for a token and open a browser to add if not
# => open a browser to ensure your authentication credentials have the correct minimum scopes
`),
RunE: func(cmd *cobra.Command, args []string) error {
if runF != nil {
@ -64,7 +58,7 @@ func NewCmdRefresh(f *cmdutil.Factory, runF func(*RefreshOptions) error) *cobra.
}
cmd.Flags().StringVarP(&opts.Hostname, "hostname", "h", "", "The GitHub host to use for authentication")
cmd.Flags().StringSliceVarP(&opts.Scopes, "scopes", "s", []string{}, "Additional scopes to add to a token")
cmd.Flags().StringSliceVarP(&opts.Scopes, "scopes", "s", nil, "Additional authentication scopes for gh to have")
return cmd
}
@ -118,10 +112,5 @@ func refreshRun(opts *RefreshOptions) error {
}
}
return doAuthFlow(cfg, hostname, opts.Scopes)
}
var doAuthFlow = func(cfg config.Config, hostname string, scopes []string) error {
_, err := config.AuthFlowWithConfig(cfg, hostname, "", scopes)
return err
return opts.AuthFlow(cfg, hostname, opts.Scopes)
}

13
pkg/cmd/auth/refresh/refresh_test.go
View file

@ -25,7 +25,6 @@ func Test_NewCmdRefresh(t *testing.T) {
name: "no arguments",
wants: RefreshOptions{
Hostname: "",
Scopes: []string{},
},
},
{
@ -33,7 +32,6 @@ func Test_NewCmdRefresh(t *testing.T) {
cli: "-h aline.cedrac",
wants: RefreshOptions{
Hostname: "aline.cedrac",
Scopes: []string{},
},
},
{
@ -136,11 +134,10 @@ func Test_refreshRun(t *testing.T) {
},
opts: &RefreshOptions{
Hostname: "obed.morton",
Scopes: []string{},
},
wantAuthArgs: authArgs{
hostname: "obed.morton",
scopes: []string{},
scopes: nil,
},
},
{
@ -150,11 +147,10 @@ func Test_refreshRun(t *testing.T) {
},
opts: &RefreshOptions{
Hostname: "",
Scopes: []string{},
},
wantAuthArgs: authArgs{
hostname: "github.com",
scopes: []string{},
scopes: nil,
},
},
{
@ -165,14 +161,13 @@ func Test_refreshRun(t *testing.T) {
},
opts: &RefreshOptions{
Hostname: "",
Scopes: []string{},
},
askStubs: func(as *prompt.AskStubber) {
as.StubOne("github.com")
},
wantAuthArgs: authArgs{
hostname: "github.com",
scopes: []string{},
scopes: nil,
},
},
{
@ -192,7 +187,7 @@ func Test_refreshRun(t *testing.T) {
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
aa := authArgs{}
doAuthFlow = func(_ config.Config, hostname string, scopes []string) error {
tt.opts.AuthFlow = func(_ config.Config, hostname string, scopes []string) error {
aa.hostname = hostname
aa.scopes = scopes
return nil