Merge pull request #7003 from Ruminateer/unarchive
feature: add command `gh repo unarchive`
This commit is contained in:
Nate Smith
GitHub
commit
3a22869439
4 changed files with 335 additions and 0 deletions
|
|
@ -15,6 +15,7 @@ import (
|
|||
repoRenameCmd "github.com/cli/cli/v2/pkg/cmd/repo/rename"
|
||||
repoDefaultCmd "github.com/cli/cli/v2/pkg/cmd/repo/setdefault"
|
||||
repoSyncCmd "github.com/cli/cli/v2/pkg/cmd/repo/sync"
|
||||
repoUnarchiveCmd "github.com/cli/cli/v2/pkg/cmd/repo/unarchive"
|
||||
repoViewCmd "github.com/cli/cli/v2/pkg/cmd/repo/view"
|
||||
"github.com/cli/cli/v2/pkg/cmdutil"
|
||||
"github.com/spf13/cobra"
|
||||
|
|
@ -55,6 +56,7 @@ func NewCmdRepo(f *cmdutil.Factory) *cobra.Command {
|
|||
deployKeyCmd.NewCmdDeployKey(f),
|
||||
repoRenameCmd.NewCmdRename(f, nil),
|
||||
repoArchiveCmd.NewCmdArchive(f, nil),
|
||||
repoUnarchiveCmd.NewCmdUnarchive(f, nil),
|
||||
repoDeleteCmd.NewCmdDelete(f, nil),
|
||||
creditsCmd.NewCmdRepoCredits(f, nil),
|
||||
gardenCmd.NewCmdGarden(f, nil),
|
||||
|
|
|
|||
28
pkg/cmd/repo/unarchive/http.go
Normal file
28
pkg/cmd/repo/unarchive/http.go
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
package unarchive
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
"github.com/cli/cli/v2/api"
|
||||
"github.com/shurcooL/githubv4"
|
||||
)
|
||||
|
||||
func unarchiveRepo(client *http.Client, repo *api.Repository) error {
|
||||
var mutation struct {
|
||||
UnarchiveRepository struct {
|
||||
Repository struct {
|
||||
ID string
|
||||
}
|
||||
} `graphql:"unarchiveRepository(input: $input)"`
|
||||
}
|
||||
|
||||
variables := map[string]interface{}{
|
||||
"input": githubv4.UnarchiveRepositoryInput{
|
||||
RepositoryID: repo.ID,
|
||||
},
|
||||
}
|
||||
|
||||
gql := api.NewClientFromHTTP(client)
|
||||
err := gql.Mutate(repo.RepoHost(), "UnarchiveRepository", &mutation, variables)
|
||||
return err
|
||||
}
|
||||
137
pkg/cmd/repo/unarchive/unarchive.go
Normal file
137
pkg/cmd/repo/unarchive/unarchive.go
Normal file
|
|
@ -0,0 +1,137 @@
|
|||
package unarchive
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/MakeNowJust/heredoc"
|
||||
"github.com/cli/cli/v2/api"
|
||||
"github.com/cli/cli/v2/internal/config"
|
||||
"github.com/cli/cli/v2/internal/ghrepo"
|
||||
"github.com/cli/cli/v2/internal/prompter"
|
||||
"github.com/cli/cli/v2/pkg/cmdutil"
|
||||
"github.com/cli/cli/v2/pkg/iostreams"
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
type UnarchiveOptions struct {
|
||||
HttpClient func() (*http.Client, error)
|
||||
Config func() (config.Config, error)
|
||||
BaseRepo func() (ghrepo.Interface, error)
|
||||
Confirmed bool
|
||||
IO *iostreams.IOStreams
|
||||
RepoArg string
|
||||
Prompter prompter.Prompter
|
||||
}
|
||||
|
||||
func NewCmdUnarchive(f *cmdutil.Factory, runF func(*UnarchiveOptions) error) *cobra.Command {
|
||||
opts := &UnarchiveOptions{
|
||||
IO: f.IOStreams,
|
||||
HttpClient: f.HttpClient,
|
||||
Config: f.Config,
|
||||
BaseRepo: f.BaseRepo,
|
||||
Prompter: f.Prompter,
|
||||
}
|
||||
|
||||
cmd := &cobra.Command{
|
||||
Use: "unarchive [<repository>]",
|
||||
Short: "Unarchive a repository",
|
||||
Long: heredoc.Doc(`Unarchive a GitHub repository.
|
||||
|
||||
With no argument, unarchives the current repository.`),
|
||||
Args: cobra.MaximumNArgs(1),
|
||||
RunE: func(cmd *cobra.Command, args []string) error {
|
||||
if len(args) > 0 {
|
||||
opts.RepoArg = args[0]
|
||||
}
|
||||
|
||||
if !opts.Confirmed && !opts.IO.CanPrompt() {
|
||||
return cmdutil.FlagErrorf("--yes required when not running interactively")
|
||||
}
|
||||
|
||||
if runF != nil {
|
||||
return runF(opts)
|
||||
}
|
||||
|
||||
return unarchiveRun(opts)
|
||||
},
|
||||
}
|
||||
|
||||
cmd.Flags().BoolVar(&opts.Confirmed, "confirm", false, "Skip the confirmation prompt")
|
||||
_ = cmd.Flags().MarkDeprecated("confirm", "use `--yes` instead")
|
||||
cmd.Flags().BoolVarP(&opts.Confirmed, "yes", "y", false, "Skip the confirmation prompt")
|
||||
return cmd
|
||||
}
|
||||
|
||||
func unarchiveRun(opts *UnarchiveOptions) error {
|
||||
cs := opts.IO.ColorScheme()
|
||||
httpClient, err := opts.HttpClient()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
apiClient := api.NewClientFromHTTP(httpClient)
|
||||
|
||||
var toUnarchive ghrepo.Interface
|
||||
|
||||
if opts.RepoArg == "" {
|
||||
toUnarchive, err = opts.BaseRepo()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else {
|
||||
repoSelector := opts.RepoArg
|
||||
if !strings.Contains(repoSelector, "/") {
|
||||
cfg, err := opts.Config()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
hostname, _ := cfg.Authentication().DefaultHost()
|
||||
|
||||
currentUser, err := api.CurrentLoginName(apiClient, hostname)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
repoSelector = currentUser + "/" + repoSelector
|
||||
}
|
||||
|
||||
toUnarchive, err = ghrepo.FromFullName(repoSelector)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
fields := []string{"name", "owner", "isArchived", "id"}
|
||||
repo, err := api.FetchRepository(apiClient, toUnarchive, fields)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
fullName := ghrepo.FullName(toUnarchive)
|
||||
if !repo.IsArchived {
|
||||
fmt.Fprintf(opts.IO.ErrOut, "%s Repository %s is not archived\n", cs.WarningIcon(), fullName)
|
||||
return nil
|
||||
}
|
||||
|
||||
if !opts.Confirmed {
|
||||
confirmed, err := opts.Prompter.Confirm(fmt.Sprintf("Unarchive %s?", fullName), false)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if !confirmed {
|
||||
return cmdutil.CancelError
|
||||
}
|
||||
}
|
||||
|
||||
err = unarchiveRepo(httpClient, repo)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if opts.IO.IsStdoutTTY() {
|
||||
fmt.Fprintf(opts.IO.Out, "%s Unarchived repository %s\n", cs.SuccessIcon(), fullName)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
168
pkg/cmd/repo/unarchive/unarchive_test.go
Normal file
168
pkg/cmd/repo/unarchive/unarchive_test.go
Normal file
|
|
@ -0,0 +1,168 @@
|
|||
package unarchive
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"testing"
|
||||
|
||||
"github.com/cli/cli/v2/internal/ghrepo"
|
||||
"github.com/cli/cli/v2/internal/prompter"
|
||||
"github.com/cli/cli/v2/pkg/cmdutil"
|
||||
"github.com/cli/cli/v2/pkg/httpmock"
|
||||
"github.com/cli/cli/v2/pkg/iostreams"
|
||||
"github.com/google/shlex"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestNewCmdUnarchive(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
input string
|
||||
wantErr bool
|
||||
output UnarchiveOptions
|
||||
errMsg string
|
||||
}{
|
||||
{
|
||||
name: "no arguments no tty",
|
||||
input: "",
|
||||
errMsg: "--yes required when not running interactively",
|
||||
wantErr: true,
|
||||
},
|
||||
{
|
||||
name: "repo argument tty",
|
||||
input: "OWNER/REPO --confirm",
|
||||
output: UnarchiveOptions{RepoArg: "OWNER/REPO", Confirmed: true},
|
||||
},
|
||||
}
|
||||
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 *UnarchiveOptions
|
||||
cmd := NewCmdUnarchive(f, func(opts *UnarchiveOptions) error {
|
||||
gotOpts = opts
|
||||
return nil
|
||||
})
|
||||
cmd.SetArgs(argv)
|
||||
cmd.SetIn(&bytes.Buffer{})
|
||||
cmd.SetOut(&bytes.Buffer{})
|
||||
cmd.SetErr(&bytes.Buffer{})
|
||||
|
||||
_, err = cmd.ExecuteC()
|
||||
if tt.wantErr {
|
||||
assert.Error(t, err)
|
||||
return
|
||||
}
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.output.RepoArg, gotOpts.RepoArg)
|
||||
assert.Equal(t, tt.output.Confirmed, gotOpts.Confirmed)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func Test_UnarchiveRun(t *testing.T) {
|
||||
queryResponse := `{ "data": { "repository": { "id": "THE-ID","isArchived": %s} } }`
|
||||
tests := []struct {
|
||||
name string
|
||||
opts UnarchiveOptions
|
||||
httpStubs func(*httpmock.Registry)
|
||||
prompterStubs func(*prompter.PrompterMock)
|
||||
isTTY bool
|
||||
wantStdout string
|
||||
wantStderr string
|
||||
}{
|
||||
{
|
||||
name: "archived repo tty",
|
||||
wantStdout: "✓ Unarchived repository OWNER/REPO\n",
|
||||
prompterStubs: func(pm *prompter.PrompterMock) {
|
||||
pm.ConfirmFunc = func(p string, d bool) (bool, error) {
|
||||
if p == "Unarchive OWNER/REPO?" {
|
||||
return true, nil
|
||||
}
|
||||
return false, prompter.NoSuchPromptErr(p)
|
||||
}
|
||||
},
|
||||
isTTY: true,
|
||||
opts: UnarchiveOptions{RepoArg: "OWNER/REPO"},
|
||||
httpStubs: func(reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`query RepositoryInfo\b`),
|
||||
httpmock.StringResponse(fmt.Sprintf(queryResponse, "true")))
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`mutation UnarchiveRepository\b`),
|
||||
httpmock.StringResponse(`{}`))
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "infer base repo",
|
||||
wantStdout: "✓ Unarchived repository OWNER/REPO\n",
|
||||
opts: UnarchiveOptions{},
|
||||
prompterStubs: func(pm *prompter.PrompterMock) {
|
||||
pm.ConfirmFunc = func(p string, d bool) (bool, error) {
|
||||
if p == "Unarchive OWNER/REPO?" {
|
||||
return true, nil
|
||||
}
|
||||
return false, prompter.NoSuchPromptErr(p)
|
||||
}
|
||||
},
|
||||
isTTY: true,
|
||||
httpStubs: func(reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`query RepositoryInfo\b`),
|
||||
httpmock.StringResponse(fmt.Sprintf(queryResponse, "true")))
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`mutation UnarchiveRepository\b`),
|
||||
httpmock.StringResponse(`{}`))
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "unarchived repo tty",
|
||||
wantStderr: "! Repository OWNER/REPO is not archived\n",
|
||||
opts: UnarchiveOptions{RepoArg: "OWNER/REPO"},
|
||||
httpStubs: func(reg *httpmock.Registry) {
|
||||
reg.Register(
|
||||
httpmock.GraphQL(`query RepositoryInfo\b`),
|
||||
httpmock.StringResponse(fmt.Sprintf(queryResponse, "false")))
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
repo, _ := ghrepo.FromFullName("OWNER/REPO")
|
||||
reg := &httpmock.Registry{}
|
||||
if tt.httpStubs != nil {
|
||||
tt.httpStubs(reg)
|
||||
}
|
||||
|
||||
tt.opts.BaseRepo = func() (ghrepo.Interface, error) {
|
||||
return repo, nil
|
||||
}
|
||||
tt.opts.HttpClient = func() (*http.Client, error) {
|
||||
return &http.Client{Transport: reg}, nil
|
||||
}
|
||||
ios, _, stdout, stderr := iostreams.Test()
|
||||
tt.opts.IO = ios
|
||||
|
||||
pm := &prompter.PrompterMock{}
|
||||
if tt.prompterStubs != nil {
|
||||
tt.prompterStubs(pm)
|
||||
}
|
||||
tt.opts.Prompter = pm
|
||||
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
defer reg.Verify(t)
|
||||
ios.SetStdoutTTY(tt.isTTY)
|
||||
ios.SetStderrTTY(tt.isTTY)
|
||||
|
||||
err := unarchiveRun(&tt.opts)
|
||||
assert.NoError(t, err)
|
||||
assert.Equal(t, tt.wantStdout, stdout.String())
|
||||
assert.Equal(t, tt.wantStderr, stderr.String())
|
||||
})
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue