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

resolve conflicts with trunk

Browse source
This commit is contained in:
Gowtham Munukutla 2021-12-15 13:25:36 +05:30
commit 759e8a9ca9
20 changed files with 1159 additions and 94 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -29,6 +29,7 @@ type BrowseOptions struct {
HttpClient func() (*http.Client, error)
IO *iostreams.IOStreams
PathFromRepoRoot func() string
GitClient gitClient
SelectorArg string
@ -46,6 +47,7 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co
HttpClient: f.HttpClient,
IO: f.IOStreams,
PathFromRepoRoot: git.PathFromRepoRoot,
GitClient: &localGitClient{},
}
cmd := &cobra.Command{
@ -97,6 +99,9 @@ func NewCmdBrowse(f *cmdutil.Factory, runF func(*BrowseOptions) error) *cobra.Co
); err != nil {
return err
}
if cmd.Flags().Changed("repo") {
opts.GitClient = &remoteGitClient{opts.BaseRepo, opts.HttpClient}
}
if runF != nil {
return runF(opts)
@ -123,10 +128,11 @@ func runBrowse(opts *BrowseOptions) error {
}
if opts.CommitFlag {
commit, err := git.LastCommit()
if err == nil {
opts.Branch = commit.Sha
commit, err := opts.GitClient.LastCommit()
if err != nil {
return err
}
opts.Branch = commit.Sha
}
section, err := parseSection(baseRepo, opts)
@ -245,3 +251,33 @@ func isNumber(arg string) bool {
_, err := strconv.Atoi(arg)
return err == nil
}
// gitClient is used to implement functions that can be performed on both local and remote git repositories
type gitClient interface {
LastCommit() (*git.Commit, error)
}
type localGitClient struct{}
type remoteGitClient struct {
repo func() (ghrepo.Interface, error)
httpClient func() (*http.Client, error)
}
func (gc *localGitClient) LastCommit() (*git.Commit, error) { return git.LastCommit() }
func (gc *remoteGitClient) LastCommit() (*git.Commit, error) {
httpClient, err := gc.httpClient()
if err != nil {
return nil, err
}
repo, err := gc.repo()
if err != nil {
return nil, err
}
commit, err := api.LastCommit(api.NewClientFromHTTP(httpClient), repo)
if err != nil {
return nil, err
}
return &git.Commit{Sha: commit.OID}, nil
}

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

@ -143,6 +143,7 @@ func TestNewCmdBrowse(t *testing.T) {
assert.Equal(t, tt.wants.WikiFlag, opts.WikiFlag)
assert.Equal(t, tt.wants.NoBrowserFlag, opts.NoBrowserFlag)
assert.Equal(t, tt.wants.SettingsFlag, opts.SettingsFlag)
assert.Equal(t, tt.wants.CommitFlag, opts.CommitFlag)
})
}
}
@ -156,6 +157,12 @@ func setGitDir(t *testing.T, dir string) {
})
}
type testGitClient struct{}
func (gc *testGitClient) LastCommit() (*git.Commit, error) {
return &git.Commit{Sha: "6f1a2405cace1633d89a79c74c65f22fe78f9659"}, nil
}
func Test_runBrowse(t *testing.T) {
s := string(os.PathSeparator)
setGitDir(t, "../../../git/fixtures/simple.git")
@ -354,6 +361,7 @@ func Test_runBrowse(t *testing.T) {
name: "open last commit",
opts: BrowseOptions{
CommitFlag: true,
GitClient: &testGitClient{},
},
baseRepo: ghrepo.New("vilmibm", "gh-user-status"),
wantsErr: false,
@ -364,6 +372,7 @@ func Test_runBrowse(t *testing.T) {
opts: BrowseOptions{
CommitFlag: true,
SelectorArg: "main.go",
GitClient: &testGitClient{},
},
baseRepo: ghrepo.New("vilmibm", "gh-user-status"),
wantsErr: false,

2
pkg/cmd/gist/edit/edit.go
View file

@ -44,7 +44,7 @@ func NewCmdEdit(f *cmdutil.Factory, runF func(*EditOptions) error) *cobra.Comman
editorCmd,
"*."+filename,
defaultContent,
io.In, io.Out, io.ErrOut, nil)
io.In, io.Out, io.ErrOut)
},
}

29
pkg/cmd/issue/edit/edit_test.go
View file

@ -8,6 +8,7 @@ import (
"path/filepath"
"testing"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/ghrepo"
prShared "github.com/cli/cli/v2/pkg/cmd/pr/shared"
"github.com/cli/cli/v2/pkg/cmdutil"
@ -286,6 +287,11 @@ func Test_editRun(t *testing.T) {
Value: "GA",
Edited: true,
},
Metadata: api.RepoMetadataResult{
Labels: []api.RepoLabel{
{Name: "docs", ID: "DOCSID"},
},
},
},
FetchOptions: prShared.FetchOptions,
},
@ -293,6 +299,7 @@ func Test_editRun(t *testing.T) {
mockIssueGet(t, reg)
mockRepoMetadata(t, reg)
mockIssueUpdate(t, reg)
mockIssueUpdateLabels(t, reg)
},
stdout: "https://github.com/OWNER/REPO/issue/123\n",
},
@ -386,7 +393,8 @@ func mockRepoMetadata(_ *testing.T, reg *httpmock.Registry) {
"nodes": [
{ "name": "feature", "id": "FEATUREID" },
{ "name": "TODO", "id": "TODOID" },
{ "name": "bug", "id": "BUGID" }
{ "name": "bug", "id": "BUGID" },
{ "name": "docs", "id": "DOCSID" }
],
"pageInfo": { "hasNextPage": false }
} } } }
@ -429,9 +437,22 @@ func mockIssueUpdate(t *testing.T, reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`mutation IssueUpdate\b`),
httpmock.GraphQLMutation(`
{ "data": { "updateIssue": { "issue": {
"id": "123"
} } } }`,
{ "data": { "updateIssue": { "__typename": "" } } }`,
func(inputs map[string]interface{}) {}),
)
}
func mockIssueUpdateLabels(t *testing.T, reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`mutation LabelAdd\b`),
httpmock.GraphQLMutation(`
{ "data": { "addLabelsToLabelable": { "__typename": "" } } }`,
func(inputs map[string]interface{}) {}),
)
reg.Register(
httpmock.GraphQL(`mutation LabelRemove\b`),
httpmock.GraphQLMutation(`
{ "data": { "removeLabelsFromLabelable": { "__typename": "" } } }`,
func(inputs map[string]interface{}) {}),
)
}

16
pkg/cmd/pr/edit/edit.go
View file

@ -13,6 +13,7 @@ import (
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/shurcooL/githubv4"
"github.com/spf13/cobra"
"golang.org/x/sync/errgroup"
)
type EditOptions struct {
@ -214,16 +215,19 @@ func editRun(opts *EditOptions) error {
}
func updatePullRequest(httpClient *http.Client, repo ghrepo.Interface, id string, editable shared.Editable) error {
if err := shared.UpdateIssue(httpClient, repo, id, true, editable); err != nil {
return err
var wg errgroup.Group
wg.Go(func() error {
return shared.UpdateIssue(httpClient, repo, id, true, editable)
})
if editable.Reviewers.Edited {
wg.Go(func() error {
return updatePullRequestReviews(httpClient, repo, id, editable)
})
}
return updatePullRequestReviews(httpClient, repo, id, editable)
return wg.Wait()
}
func updatePullRequestReviews(httpClient *http.Client, repo ghrepo.Interface, id string, editable shared.Editable) error {
if !editable.Reviewers.Edited {
return nil
}
userIds, teamIds, err := editable.ReviewerIds()
if err != nil {
return err

22
pkg/cmd/pr/edit/edit_test.go
View file

@ -357,6 +357,7 @@ func Test_editRun(t *testing.T) {
mockRepoMetadata(t, reg, false)
mockPullRequestUpdate(t, reg)
mockPullRequestReviewersUpdate(t, reg)
mockPullRequestUpdateLabels(t, reg)
},
stdout: "https://github.com/OWNER/REPO/pull/123\n",
},
@ -387,7 +388,7 @@ func Test_editRun(t *testing.T) {
Edited: true,
},
Labels: shared.EditableSlice{
Value: []string{"feature", "TODO", "bug"},
Add: []string{"feature", "TODO", "bug"},
Remove: []string{"docs"},
Edited: true,
},
@ -406,6 +407,7 @@ func Test_editRun(t *testing.T) {
httpStubs: func(t *testing.T, reg *httpmock.Registry) {
mockRepoMetadata(t, reg, true)
mockPullRequestUpdate(t, reg)
mockPullRequestUpdateLabels(t, reg)
},
stdout: "https://github.com/OWNER/REPO/pull/123\n",
},
@ -490,7 +492,8 @@ func mockRepoMetadata(_ *testing.T, reg *httpmock.Registry, skipReviewers bool)
"nodes": [
{ "name": "feature", "id": "FEATUREID" },
{ "name": "TODO", "id": "TODOID" },
{ "name": "bug", "id": "BUGID" }
{ "name": "bug", "id": "BUGID" },
{ "name": "docs", "id": "DOCSID" }
],
"pageInfo": { "hasNextPage": false }
} } } }
@ -554,6 +557,21 @@ func mockPullRequestReviewersUpdate(t *testing.T, reg *httpmock.Registry) {
httpmock.StringResponse(`{}`))
}
func mockPullRequestUpdateLabels(t *testing.T, reg *httpmock.Registry) {
reg.Register(
httpmock.GraphQL(`mutation LabelAdd\b`),
httpmock.GraphQLMutation(`
{ "data": { "addLabelsToLabelable": { "__typename": "" } } }`,
func(inputs map[string]interface{}) {}),
)
reg.Register(
httpmock.GraphQL(`mutation LabelRemove\b`),
httpmock.GraphQLMutation(`
{ "data": { "removeLabelsFromLabelable": { "__typename": "" } } }`,
func(inputs map[string]interface{}) {}),
)
}
type testFetcher struct{}
type testSurveyor struct {
skipReviewers bool

2
pkg/cmd/pr/merge/merge.go
View file

@ -494,7 +494,7 @@ func (e *userEditor) Edit(filename, startingText string) (string, error) {
return "", err
}
return surveyext.Edit(editorCommand, filename, startingText, e.io.In, e.io.Out, e.io.ErrOut, nil)
return surveyext.Edit(editorCommand, filename, startingText, e.io.In, e.io.Out, e.io.ErrOut)
}
// blockedReason translates various MergeStateStatus GraphQL values into human-readable reason

4
pkg/cmd/pr/shared/commentable.go
View file

@ -151,7 +151,7 @@ func CommentableInteractiveEditSurvey(cf func() (config.Config, error), io *iost
cs := io.ColorScheme()
fmt.Fprintf(io.Out, "- %s to draft your comment in %s... ", cs.Bold("Press Enter"), cs.Bold(editorCommand))
_ = waitForEnter(io.In)
return surveyext.Edit(editorCommand, "*.md", "", io.In, io.Out, io.ErrOut, nil)
return surveyext.Edit(editorCommand, "*.md", "", io.In, io.Out, io.ErrOut)
}
}
@ -161,7 +161,7 @@ func CommentableEditSurvey(cf func() (config.Config, error), io *iostreams.IOStr
if err != nil {
return "", err
}
return surveyext.Edit(editorCommand, "*.md", "", io.In, io.Out, io.ErrOut, nil)
return surveyext.Edit(editorCommand, "*.md", "", io.In, io.Out, io.ErrOut)
}
}

29
pkg/cmd/pr/shared/editable.go
View file

@ -120,21 +120,6 @@ func (e Editable) AssigneeIds(client *api.Client, repo ghrepo.Interface) (*[]str
return &a, err
}
func (e Editable) LabelIds() (*[]string, error) {
if !e.Labels.Edited {
return nil, nil
}
if len(e.Labels.Add) != 0 || len(e.Labels.Remove) != 0 {
s := set.NewStringSet()
s.AddValues(e.Labels.Default)
s.AddValues(e.Labels.Add)
s.RemoveValues(e.Labels.Remove)
e.Labels.Value = s.ToSlice()
}
l, err := e.Metadata.LabelsToIDs(e.Labels.Value)
return &l, err
}
func (e Editable) ProjectIds() (*[]string, error) {
if !e.Projects.Edited {
return nil, nil
@ -189,10 +174,22 @@ func EditFieldsSurvey(editable *Editable, editorCommand string) error {
}
}
if editable.Labels.Edited {
editable.Labels.Value, err = multiSelectSurvey("Labels", editable.Labels.Default, editable.Labels.Options)
editable.Labels.Add, err = multiSelectSurvey("Labels", editable.Labels.Default, editable.Labels.Options)
if err != nil {
return err
}
for _, prev := range editable.Labels.Default {
var found bool
for _, selected := range editable.Labels.Add {
if prev == selected {
found = true
break
}
}
if !found {
editable.Labels.Remove = append(editable.Labels.Remove, prev)
}
}
}
if editable.Projects.Edited {
editable.Projects.Value, err = multiSelectSurvey("Projects", editable.Projects.Default, editable.Projects.Options)

109
pkg/cmd/pr/shared/editable_http.go
View file

@ -9,19 +9,47 @@ import (
"github.com/cli/cli/v2/internal/ghrepo"
graphql "github.com/cli/shurcooL-graphql"
"github.com/shurcooL/githubv4"
"golang.org/x/sync/errgroup"
)
func UpdateIssue(httpClient *http.Client, repo ghrepo.Interface, id string, isPR bool, options Editable) error {
title := ghString(options.TitleValue())
body := ghString(options.BodyValue())
var wg errgroup.Group
apiClient := api.NewClientFromHTTP(httpClient)
assigneeIds, err := options.AssigneeIds(apiClient, repo)
if err != nil {
return err
// Labels are updated through discrete mutations to avoid having to replace the entire list of labels
// and risking race conditions.
if options.Labels.Edited {
if len(options.Labels.Add) > 0 {
wg.Go(func() error {
addedLabelIds, err := options.Metadata.LabelsToIDs(options.Labels.Add)
if err != nil {
return err
}
return addLabels(httpClient, id, repo, addedLabelIds)
})
}
if len(options.Labels.Remove) > 0 {
wg.Go(func() error {
removeLabelIds, err := options.Metadata.LabelsToIDs(options.Labels.Remove)
if err != nil {
return err
}
return removeLabels(httpClient, id, repo, removeLabelIds)
})
}
}
labelIds, err := options.LabelIds()
if dirtyExcludingLabels(options) {
wg.Go(func() error {
return replaceIssueFields(httpClient, repo, id, isPR, options)
})
}
return wg.Wait()
}
func replaceIssueFields(httpClient *http.Client, repo ghrepo.Interface, id string, isPR bool, options Editable) error {
apiClient := api.NewClientFromHTTP(httpClient)
assigneeIds, err := options.AssigneeIds(apiClient, repo)
if err != nil {
return err
}
@ -39,10 +67,9 @@ func UpdateIssue(httpClient *http.Client, repo ghrepo.Interface, id string, isPR
if isPR {
params := githubv4.UpdatePullRequestInput{
PullRequestID: id,
Title: title,
Body: body,
Title: ghString(options.TitleValue()),
Body: ghString(options.BodyValue()),
AssigneeIDs: ghIds(assigneeIds),
LabelIDs: ghIds(labelIds),
ProjectIDs: ghIds(projectIds),
MilestoneID: ghId(milestoneId),
}
@ -52,23 +79,65 @@ func UpdateIssue(httpClient *http.Client, repo ghrepo.Interface, id string, isPR
return updatePullRequest(httpClient, repo, params)
}
return updateIssue(httpClient, repo, githubv4.UpdateIssueInput{
params := githubv4.UpdateIssueInput{
ID: id,
Title: title,
Body: body,
Title: ghString(options.TitleValue()),
Body: ghString(options.BodyValue()),
AssigneeIDs: ghIds(assigneeIds),
LabelIDs: ghIds(labelIds),
ProjectIDs: ghIds(projectIds),
MilestoneID: ghId(milestoneId),
})
}
return updateIssue(httpClient, repo, params)
}
func dirtyExcludingLabels(e Editable) bool {
return e.Title.Edited ||
e.Body.Edited ||
e.Base.Edited ||
e.Reviewers.Edited ||
e.Assignees.Edited ||
e.Projects.Edited ||
e.Milestone.Edited
}
func addLabels(httpClient *http.Client, id string, repo ghrepo.Interface, labels []string) error {
params := githubv4.AddLabelsToLabelableInput{
LabelableID: id,
LabelIDs: *ghIds(&labels),
}
var mutation struct {
AddLabelsToLabelable struct {
Typename string `graphql:"__typename"`
} `graphql:"addLabelsToLabelable(input: $input)"`
}
variables := map[string]interface{}{"input": params}
gql := graphql.NewClient(ghinstance.GraphQLEndpoint(repo.RepoHost()), httpClient)
return gql.MutateNamed(context.Background(), "LabelAdd", &mutation, variables)
}
func removeLabels(httpClient *http.Client, id string, repo ghrepo.Interface, labels []string) error {
params := githubv4.RemoveLabelsFromLabelableInput{
LabelableID: id,
LabelIDs: *ghIds(&labels),
}
var mutation struct {
RemoveLabelsFromLabelable struct {
Typename string `graphql:"__typename"`
} `graphql:"removeLabelsFromLabelable(input: $input)"`
}
variables := map[string]interface{}{"input": params}
gql := graphql.NewClient(ghinstance.GraphQLEndpoint(repo.RepoHost()), httpClient)
return gql.MutateNamed(context.Background(), "LabelRemove", &mutation, variables)
}
func updateIssue(httpClient *http.Client, repo ghrepo.Interface, params githubv4.UpdateIssueInput) error {
var mutation struct {
UpdateIssue struct {
Issue struct {
ID string
}
Typename string `graphql:"__typename"`
} `graphql:"updateIssue(input: $input)"`
}
variables := map[string]interface{}{"input": params}
@ -79,9 +148,7 @@ func updateIssue(httpClient *http.Client, repo ghrepo.Interface, params githubv4
func updatePullRequest(httpClient *http.Client, repo ghrepo.Interface, params githubv4.UpdatePullRequestInput) error {
var mutation struct {
UpdatePullRequest struct {
PullRequest struct {
ID string
}
Typename string `graphql:"__typename"`
} `graphql:"updatePullRequest(input: $input)"`
}
variables := map[string]interface{}{"input": params}

126
pkg/cmd/release/create/create.go
View file

@ -4,8 +4,8 @@ import (
"bytes"
"errors"
"fmt"
"io"
"net/http"
"os"
"strings"
"github.com/AlecAivazis/survey/v2"
@ -28,6 +28,7 @@ type CreateOptions struct {
Config func() (config.Config, error)
HttpClient func() (*http.Client, error)
BaseRepo func() (ghrepo.Interface, error)
Edit func(string, string, string, io.Reader, io.Writer, io.Writer) (string, error)
TagName string
Target string
@ -43,14 +44,12 @@ type CreateOptions struct {
SubmitAction string
// for interactive flow
ReleaseNotesAction string
// the value from the --repo flag
RepoOverride string
// maximum number of simultaneous uploads
Concurrency int
Concurrency int
DiscussionCategory string
GenerateNotes bool
}
func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Command {
@ -58,6 +57,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
IO: f.IOStreams,
HttpClient: f.HttpClient,
Config: f.Config,
Edit: surveyext.Edit,
}
var notesFile string
@ -65,7 +65,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
cmd := &cobra.Command{
DisableFlagsInUseLine: true,
Use: "create <tag> [<files>...]",
Use: "create [<tag>] [<files>...]",
Short: "Create a new release",
Long: heredoc.Docf(`
Create a new GitHub Release for a repository.
@ -79,14 +79,24 @@ 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.
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
automatically generated notes by using the notes parameter.
`, "`"),
Example: heredoc.Doc(`
Interactively create a release
$ gh release create
Interactively create a release from specific tag
$ gh release create v1.2.3
Non-interactively create a release
$ gh release create v1.2.3 --notes "bugfix release"
Use automatically generated release notes
$ gh release create v1.2.3 --generate-notes
Use release notes from a file
$ gh release create v1.2.3 -F changelog.md
@ -99,27 +109,32 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
Create a release and start a discussion
$ gh release create v1.2.3 --discussion-category "General"
`),
Args: cmdutil.MinimumArgs(1, "could not create: no tag name provided"),
RunE: func(cmd *cobra.Command, args []string) error {
if cmd.Flags().Changed("discussion-category") && opts.Draft {
return errors.New("Discussions for draft releases not supported")
return errors.New("discussions for draft releases not supported")
}
// support `-R, --repo` override
opts.BaseRepo = f.BaseRepo
opts.RepoOverride, _ = cmd.Flags().GetString("repo")
opts.TagName = args[0]
var err error
opts.Assets, err = shared.AssetsFromArgs(args[1:])
if err != nil {
return err
if len(args) > 0 {
opts.TagName = args[0]
opts.Assets, err = shared.AssetsFromArgs(args[1:])
if err != nil {
return err
}
}
if opts.TagName == "" && !opts.IO.CanPrompt() {
return cmdutil.FlagErrorf("tag required when not running interactively")
}
opts.Concurrency = 5
opts.BodyProvided = cmd.Flags().Changed("notes")
opts.BodyProvided = cmd.Flags().Changed("notes") || opts.GenerateNotes
if notesFile != "" {
b, err := cmdutil.ReadFile(notesFile, opts.IO.In)
if err != nil {
@ -143,6 +158,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
cmd.Flags().StringVarP(&opts.Body, "notes", "n", "", "Release notes")
cmd.Flags().StringVarP(&notesFile, "notes-file", "F", "", "Read release notes from `file` (use \"-\" to read from standard input)")
cmd.Flags().StringVarP(&opts.DiscussionCategory, "discussion-category", "", "", "Start a discussion of the specified category")
cmd.Flags().BoolVarP(&opts.GenerateNotes, "generate-notes", "", false, "Automatically generate title and notes for the release")
return cmd
}
@ -158,15 +174,67 @@ func createRun(opts *CreateOptions) error {
return err
}
if opts.TagName == "" {
tags, err := getTags(httpClient, baseRepo, 5)
if err != nil {
return err
}
if len(tags) != 0 {
options := make([]string, len(tags))
for i, tag := range tags {
options[i] = tag.Name
}
createNewTagOption := "Create a new tag"
options = append(options, createNewTagOption)
var tag string
q := &survey.Select{
Message: "Choose a tag",
Options: options,
Default: options[0],
}
err := prompt.SurveyAskOne(q, &tag)
if err != nil {
return fmt.Errorf("could not prompt: %w", err)
}
if tag != createNewTagOption {
opts.TagName = tag
}
}
if opts.TagName == "" {
q := &survey.Input{
Message: "Tag name",
}
err := prompt.SurveyAskOne(q, &opts.TagName)
if err != nil {
return fmt.Errorf("could not prompt: %w", err)
}
}
}
if !opts.BodyProvided && opts.IO.CanPrompt() {
editorCommand, err := cmdutil.DetermineEditor(opts.Config)
if err != nil {
return err
}
var generatedNotes *releaseNotes
var tagDescription string
var generatedChangelog string
if opts.RepoOverride == "" {
params := map[string]interface{}{
"tag_name": opts.TagName,
}
if opts.Target != "" {
params["target_commitish"] = opts.Target
}
generatedNotes, err = generateReleaseNotes(httpClient, baseRepo, params)
if err != nil && !errors.Is(err, notImplementedError) {
return err
}
if opts.RepoOverride == "" && generatedNotes == nil {
headRef := opts.TagName
tagDescription, _ = gitTagInfo(opts.TagName)
if tagDescription == "" {
@ -177,7 +245,6 @@ func createRun(opts *CreateOptions) error {
headRef = "HEAD"
}
}
if prevTag, err := detectPreviousTag(headRef); err == nil {
commits, _ := changelogForRange(fmt.Sprintf("%s..%s", prevTag, headRef))
generatedChangelog = generateChangelog(commits)
@ -185,6 +252,9 @@ func createRun(opts *CreateOptions) error {
}
editorOptions := []string{"Write my own"}
if generatedNotes != nil {
editorOptions = append(editorOptions, "Write using generated notes as template")
}
if generatedChangelog != "" {
editorOptions = append(editorOptions, "Write using commit log as template")
}
@ -193,12 +263,16 @@ func createRun(opts *CreateOptions) error {
}
editorOptions = append(editorOptions, "Leave blank")
defaultName := opts.Name
if defaultName == "" && generatedNotes != nil {
defaultName = generatedNotes.Name
}
qs := []*survey.Question{
{
Name: "name",
Prompt: &survey.Input{
Message: "Title (optional)",
Default: opts.Name,
Default: defaultName,
},
},
{
@ -220,6 +294,9 @@ func createRun(opts *CreateOptions) error {
switch opts.ReleaseNotesAction {
case "Write my own":
openEditor = true
case "Write using generated notes as template":
openEditor = true
editorContents = generatedNotes.Body
case "Write using commit log as template":
openEditor = true
editorContents = generatedChangelog
@ -233,8 +310,8 @@ func createRun(opts *CreateOptions) error {
}
if openEditor {
// TODO: consider using iostreams here
text, err := surveyext.Edit(editorCommand, "*.md", editorContents, os.Stdin, os.Stdout, os.Stderr, nil)
text, err := opts.Edit(editorCommand, "*.md", editorContents,
opts.IO.In, opts.IO.Out, opts.IO.ErrOut)
if err != nil {
return err
}
@ -298,8 +375,12 @@ func createRun(opts *CreateOptions) error {
"tag_name": opts.TagName,
"draft": opts.Draft,
"prerelease": opts.Prerelease,
"name": opts.Name,
"body": opts.Body,
}
if opts.Name != "" {
params["name"] = opts.Name
}
if opts.Body != "" {
params["body"] = opts.Body
}
if opts.Target != "" {
params["target_commitish"] = opts.Target
@ -307,6 +388,9 @@ func createRun(opts *CreateOptions) error {
if opts.DiscussionCategory != "" {
params["discussion_category_name"] = opts.DiscussionCategory
}
if opts.GenerateNotes {
params["generate_release_notes"] = true
}
hasAssets := len(opts.Assets) > 0

283
pkg/cmd/release/create/create_test.go
View file

@ -11,11 +11,13 @@ import (
"path/filepath"
"testing"
"github.com/cli/cli/v2/internal/config"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmd/release/shared"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/httpmock"
"github.com/cli/cli/v2/pkg/iostreams"
"github.com/cli/cli/v2/pkg/prompt"
"github.com/google/shlex"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
@ -42,6 +44,29 @@ func Test_NewCmdCreate(t *testing.T) {
want CreateOptions
wantErr string
}{
{
name: "no arguments tty",
args: "",
isTTY: true,
want: CreateOptions{
TagName: "",
Target: "",
Name: "",
Body: "",
BodyProvided: false,
Draft: false,
Prerelease: false,
RepoOverride: "",
Concurrency: 5,
Assets: []*shared.AssetForUpload(nil),
},
},
{
name: "no arguments notty",
args: "",
isTTY: false,
wantErr: "tag required when not running interactively",
},
{
name: "only tag name",
args: "v1.2.3",
@ -154,12 +179,6 @@ func Test_NewCmdCreate(t *testing.T) {
Assets: []*shared.AssetForUpload(nil),
},
},
{
name: "no arguments",
args: "",
isTTY: true,
wantErr: "could not create: no tag name provided",
},
{
name: "discussion category",
args: "v1.2.3 --discussion-category 'General'",
@ -182,7 +201,25 @@ func Test_NewCmdCreate(t *testing.T) {
name: "discussion category for draft release",
args: "v1.2.3 -d --discussion-category 'General'",
isTTY: true,
wantErr: "Discussions for draft releases not supported",
wantErr: "discussions for draft releases not supported",
},
{
name: "generate release notes",
args: "v1.2.3 --generate-notes",
isTTY: true,
want: CreateOptions{
TagName: "v1.2.3",
Target: "",
Name: "",
Body: "",
BodyProvided: true,
Draft: false,
Prerelease: false,
RepoOverride: "",
Concurrency: 5,
Assets: []*shared.AssetForUpload(nil),
GenerateNotes: true,
},
},
}
for _, tt := range tests {
@ -308,8 +345,6 @@ func Test_createRun(t *testing.T) {
},
wantParams: map[string]interface{}{
"tag_name": "v1.2.3",
"name": "",
"body": "",
"draft": false,
"prerelease": false,
"target_commitish": "main",
@ -330,8 +365,6 @@ func Test_createRun(t *testing.T) {
},
wantParams: map[string]interface{}{
"tag_name": "v1.2.3",
"name": "",
"body": "",
"draft": true,
"prerelease": false,
},
@ -352,8 +385,6 @@ func Test_createRun(t *testing.T) {
},
wantParams: map[string]interface{}{
"tag_name": "v1.2.3",
"name": "",
"body": "",
"draft": true,
"prerelease": false,
"discussion_category_name": "general",
@ -361,6 +392,26 @@ func Test_createRun(t *testing.T) {
wantErr: "X Discussions not supported with draft releases",
wantStdout: "",
},
{
name: "with generate notes",
isTTY: true,
opts: CreateOptions{
TagName: "v1.2.3",
Name: "",
Body: "",
Target: "",
BodyProvided: true,
GenerateNotes: true,
},
wantParams: map[string]interface{}{
"tag_name": "v1.2.3",
"draft": false,
"prerelease": false,
"generate_release_notes": true,
},
wantStdout: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n",
wantErr: "",
},
{
name: "publish after uploading files",
isTTY: true,
@ -383,8 +434,6 @@ func Test_createRun(t *testing.T) {
},
wantParams: map[string]interface{}{
"tag_name": "v1.2.3",
"name": "",
"body": "",
"draft": true,
"prerelease": false,
},
@ -451,3 +500,207 @@ func Test_createRun(t *testing.T) {
})
}
}
func Test_createRun_interactive(t *testing.T) {
tests := []struct {
name string
httpStubs func(*httpmock.Registry)
askStubs func(*prompt.AskStubber)
opts *CreateOptions
wantParams map[string]interface{}
wantOut string
wantErr string
}{
{
name: "create a release from existing tag",
opts: &CreateOptions{},
askStubs: func(as *prompt.AskStubber) {
as.StubOne("v1.2.3") // Tag prompt
as.Stub([]*prompt.QuestionStub{
{
Name: "name",
Value: "title",
},
{
Name: "releaseNotesAction",
Value: "Leave blank",
},
})
as.Stub([]*prompt.QuestionStub{
{
Name: "prerelease",
Value: false,
},
{
Name: "submitAction",
Value: "Publish release",
},
})
},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(httpmock.REST("GET", "repos/OWNER/REPO/tags"), httpmock.StatusStringResponse(200, `[
{ "name": "v1.2.3" }, { "name": "v1.2.2" }, { "name": "v1.0.0" }, { "name": "v0.1.2" }
]`))
reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases/generate-notes"),
httpmock.StatusStringResponse(200, `{
"name": "generated name",
"body": "generated body"
}`))
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"
}`))
},
wantOut: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n",
},
{
name: "create a release from new tag",
opts: &CreateOptions{},
askStubs: func(as *prompt.AskStubber) {
as.StubOne("Create a new tag") // Tag prompt
as.StubOne("v1.2.3") // New tag prompt
as.Stub([]*prompt.QuestionStub{
{
Name: "name",
Value: "title",
},
{
Name: "releaseNotesAction",
Value: "Leave blank",
},
})
as.Stub([]*prompt.QuestionStub{
{
Name: "prerelease",
Value: false,
},
{
Name: "submitAction",
Value: "Publish release",
},
})
},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(httpmock.REST("GET", "repos/OWNER/REPO/tags"), httpmock.StatusStringResponse(200, `[
{ "name": "v1.2.2" }, { "name": "v1.0.0" }, { "name": "v0.1.2" }
]`))
reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases/generate-notes"),
httpmock.StatusStringResponse(200, `{
"name": "generated name",
"body": "generated body"
}`))
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"
}`))
},
wantOut: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n",
},
{
name: "create a release using generated notes",
opts: &CreateOptions{
TagName: "v1.2.3",
},
askStubs: func(as *prompt.AskStubber) {
as.Stub([]*prompt.QuestionStub{
{
Name: "name",
Value: "title",
},
{
Name: "releaseNotesAction",
Value: "Write using generated notes as template",
},
})
as.Stub([]*prompt.QuestionStub{
{
Name: "prerelease",
Value: false,
},
{
Name: "submitAction",
Value: "Publish release",
},
})
},
httpStubs: func(reg *httpmock.Registry) {
reg.Register(httpmock.REST("POST", "repos/OWNER/REPO/releases/generate-notes"),
httpmock.StatusStringResponse(200, `{
"name": "generated name",
"body": "generated body"
}`))
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"
}`))
},
wantParams: map[string]interface{}{
"body": "generated body",
"draft": false,
"name": "title",
"prerelease": false,
"tag_name": "v1.2.3",
},
wantOut: "https://github.com/OWNER/REPO/releases/tag/v1.2.3\n",
},
}
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
}
as, teardown := prompt.InitAskStubber()
defer teardown()
if tt.askStubs != nil {
tt.askStubs(as)
}
t.Run(tt.name, func(t *testing.T) {
err := createRun(tt.opts)
if tt.wantErr != "" {
require.EqualError(t, err, tt.wantErr)
return
} else {
require.NoError(t, err)
}
if tt.wantParams != nil {
bb, err := ioutil.ReadAll(reg.Requests[1].Body)
assert.NoError(t, err)
var params map[string]interface{}
err = json.Unmarshal(bb, &params)
assert.NoError(t, err)
assert.Equal(t, tt.wantParams, params)
}
assert.Equal(t, tt.wantOut, stdout.String())
assert.Equal(t, "", stderr.String())
})
}
}

85
pkg/cmd/release/create/http.go
View file

@ -3,7 +3,9 @@ package create
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"io"
"io/ioutil"
"net/http"
@ -13,6 +15,89 @@ import (
"github.com/cli/cli/v2/pkg/cmd/release/shared"
)
type tag struct {
Name string `json:"name"`
}
type releaseNotes struct {
Name string `json:"name"`
Body string `json:"body"`
}
var notImplementedError = errors.New("not implemented")
func getTags(httpClient *http.Client, repo ghrepo.Interface, limit int) ([]tag, error) {
path := fmt.Sprintf("repos/%s/%s/tags?per_page=%d", repo.RepoOwner(), repo.RepoName(), limit)
url := ghinstance.RESTPrefix(repo.RepoHost()) + path
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return nil, err
}
req.Header.Set("Content-Type", "application/json; charset=utf-8")
resp, err := httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
success := resp.StatusCode >= 200 && resp.StatusCode < 300
if !success {
return nil, api.HandleHTTPError(resp)
}
b, err := io.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var tags []tag
err = json.Unmarshal(b, &tags)
return tags, err
}
func generateReleaseNotes(httpClient *http.Client, repo ghrepo.Interface, params map[string]interface{}) (*releaseNotes, error) {
bodyBytes, err := json.Marshal(params)
if err != nil {
return nil, err
}
path := fmt.Sprintf("repos/%s/%s/releases/generate-notes", repo.RepoOwner(), repo.RepoName())
url := ghinstance.RESTPrefix(repo.RepoHost()) + path
req, err := http.NewRequest("POST", url, bytes.NewBuffer(bodyBytes))
if err != nil {
return nil, err
}
req.Header.Set("Accept", "application/vnd.github.v3+json")
req.Header.Set("Content-Type", "application/json; charset=utf-8")
resp, err := httpClient.Do(req)
if err != nil {
return nil, err
}
defer resp.Body.Close()
if resp.StatusCode == 404 {
return nil, notImplementedError
}
success := resp.StatusCode >= 200 && resp.StatusCode < 300
if !success {
return nil, api.HandleHTTPError(resp)
}
b, err := ioutil.ReadAll(resp.Body)
if err != nil {
return nil, err
}
var rn releaseNotes
err = json.Unmarshal(b, &rn)
return &rn, err
}
func createRelease(httpClient *http.Client, repo ghrepo.Interface, params map[string]interface{}) (*shared.Release, error) {
bodyBytes, err := json.Marshal(params)
if err != nil {

218
pkg/cmd/repo/edit/edit.go Normal file
View file

@ -0,0 +1,218 @@
package edit
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"github.com/MakeNowJust/heredoc"
"github.com/cli/cli/v2/api"
"github.com/cli/cli/v2/internal/ghinstance"
"github.com/cli/cli/v2/internal/ghrepo"
"github.com/cli/cli/v2/pkg/cmdutil"
"github.com/cli/cli/v2/pkg/set"
"github.com/spf13/cobra"
"golang.org/x/sync/errgroup"
)
type EditOptions struct {
HTTPClient *http.Client
Repository ghrepo.Interface
Edits EditRepositoryInput
AddTopics []string
RemoveTopics []string
}
type EditRepositoryInput struct {
Description *string `json:"description,omitempty"`
Homepage *string `json:"homepage,omitempty"`
Visibility *string `json:"visibility,omitempty"`
EnableIssues *bool `json:"has_issues,omitempty"`
EnableProjects *bool `json:"has_projects,omitempty"`
EnableWiki *bool `json:"has_wiki,omitempty"`
IsTemplate *bool `json:"is_template,omitempty"`
DefaultBranch *string `json:"default_branch,omitempty"`
EnableSquashMerge *bool `json:"allow_squash_merge,omitempty"`
EnableMergeCommit *bool `json:"allow_merge_commit,omitempty"`
EnableRebaseMerge *bool `json:"allow_rebase_merge,omitempty"`
EnableAutoMerge *bool `json:"allow_auto_merge,omitempty"`
DeleteBranchOnMerge *bool `json:"delete_branch_on_merge,omitempty"`
AllowForking *bool `json:"allow_forking,omitempty"`
}
func NewCmdEdit(f *cmdutil.Factory, runF func(options *EditOptions) error) *cobra.Command {
opts := &EditOptions{}
cmd := &cobra.Command{
Use: "edit [<repository>]",
Short: "Edit repository settings",
Annotations: map[string]string{
"help:arguments": heredoc.Doc(`
A repository can be supplied as an argument in any of the following formats:
- "OWNER/REPO"
- by URL, e.g. "https://github.com/OWNER/REPO"
`),
},
Args: cobra.MaximumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if cmd.Flags().NFlag() == 0 {
return cmdutil.FlagErrorf("at least one flag is required")
}
if len(args) > 0 {
var err error
opts.Repository, err = ghrepo.FromFullName(args[0])
if err != nil {
return err
}
} else {
var err error
opts.Repository, err = f.BaseRepo()
if err != nil {
return err
}
}
if httpClient, err := f.HttpClient(); err == nil {
opts.HTTPClient = httpClient
} else {
return err
}
if runF != nil {
return runF(opts)
}
return editRun(cmd.Context(), opts)
},
}
cmdutil.NilStringFlag(cmd, &opts.Edits.Description, "description", "d", "Description of the repository")
cmdutil.NilStringFlag(cmd, &opts.Edits.Homepage, "homepage", "h", "Repository home page `URL`")
cmdutil.NilStringFlag(cmd, &opts.Edits.DefaultBranch, "default-branch", "", "Set the default branch `name` for the repository")
cmdutil.NilStringFlag(cmd, &opts.Edits.Visibility, "visibility", "", "Change the visibility of the repository to {public,private,internal}")
cmdutil.NilBoolFlag(cmd, &opts.Edits.IsTemplate, "template", "", "Make the repository available as a template repository")
cmdutil.NilBoolFlag(cmd, &opts.Edits.EnableIssues, "enable-issues", "", "Enable issues in the repository")
cmdutil.NilBoolFlag(cmd, &opts.Edits.EnableProjects, "enable-projects", "", "Enable projects in the repository")
cmdutil.NilBoolFlag(cmd, &opts.Edits.EnableWiki, "enable-wiki", "", "Enable wiki in the repository")
cmdutil.NilBoolFlag(cmd, &opts.Edits.EnableMergeCommit, "enable-merge-commit", "", "Enable merging pull requests via merge commit")
cmdutil.NilBoolFlag(cmd, &opts.Edits.EnableSquashMerge, "enable-squash-merge", "", "Enable merging pull requests via squashed commit")
cmdutil.NilBoolFlag(cmd, &opts.Edits.EnableRebaseMerge, "enable-rebase-merge", "", "Enable merging pull requests via rebase")
cmdutil.NilBoolFlag(cmd, &opts.Edits.EnableAutoMerge, "enable-auto-merge", "", "Enable auto-merge functionality")
cmdutil.NilBoolFlag(cmd, &opts.Edits.DeleteBranchOnMerge, "delete-branch-on-merge", "", "Delete head branch when pull requests are merged")
cmdutil.NilBoolFlag(cmd, &opts.Edits.AllowForking, "allow-forking", "", "Allow forking of an organization repository")
cmd.Flags().StringSliceVar(&opts.AddTopics, "add-topic", nil, "Add repository topic")
cmd.Flags().StringSliceVar(&opts.RemoveTopics, "remove-topic", nil, "Remove repository topic")
return cmd
}
func editRun(ctx context.Context, opts *EditOptions) error {
repo := opts.Repository
apiPath := fmt.Sprintf("repos/%s/%s", repo.RepoOwner(), repo.RepoName())
body := &bytes.Buffer{}
enc := json.NewEncoder(body)
if err := enc.Encode(opts.Edits); err != nil {
return err
}
g := errgroup.Group{}
if body.Len() > 3 {
g.Go(func() error {
apiClient := api.NewClientFromHTTP(opts.HTTPClient)
_, err := api.CreateRepoTransformToV4(apiClient, repo.RepoHost(), "PATCH", apiPath, body)
return err
})
}
if len(opts.AddTopics) > 0 || len(opts.RemoveTopics) > 0 {
g.Go(func() error {
existingTopics, err := getTopics(ctx, opts.HTTPClient, repo)
if err != nil {
return err
}
oldTopics := set.NewStringSet()
oldTopics.AddValues(existingTopics)
newTopics := set.NewStringSet()
newTopics.AddValues(existingTopics)
newTopics.AddValues(opts.AddTopics)
newTopics.RemoveValues(opts.RemoveTopics)
if oldTopics.Equal(newTopics) {
return nil
}
return setTopics(ctx, opts.HTTPClient, repo, newTopics.ToSlice())
})
}
return g.Wait()
}
func getTopics(ctx context.Context, httpClient *http.Client, repo ghrepo.Interface) ([]string, error) {
apiPath := fmt.Sprintf("repos/%s/%s/topics", repo.RepoOwner(), repo.RepoName())
req, err := http.NewRequestWithContext(ctx, "GET", ghinstance.RESTPrefix(repo.RepoHost())+apiPath, nil)
if err != nil {
return nil, err
}
// "mercy-preview" is still needed for some GitHub Enterprise versions
req.Header.Set("Accept", "application/vnd.github.mercy-preview+json")
res, err := httpClient.Do(req)
if err != nil {
return nil, err
}
if res.StatusCode != http.StatusOK {
return nil, api.HandleHTTPError(res)
}
var responseData struct {
Names []string `json:"names"`
}
dec := json.NewDecoder(res.Body)
err = dec.Decode(&responseData)
return responseData.Names, err
}
func setTopics(ctx context.Context, httpClient *http.Client, repo ghrepo.Interface, topics []string) error {
payload := struct {
Names []string `json:"names"`
}{
Names: topics,
}
body := &bytes.Buffer{}
dec := json.NewEncoder(body)
if err := dec.Encode(&payload); err != nil {
return err
}
apiPath := fmt.Sprintf("repos/%s/%s/topics", repo.RepoOwner(), repo.RepoName())
req, err := http.NewRequestWithContext(ctx, "PUT", ghinstance.RESTPrefix(repo.RepoHost())+apiPath, body)
if err != nil {
return err
}
req.Header.Set("Content-type", "application/json")
// "mercy-preview" is still needed for some GitHub Enterprise versions
req.Header.Set("Accept", "application/vnd.github.mercy-preview+json")
res, err := httpClient.Do(req)
if err != nil {
return err
}
if res.StatusCode != http.StatusOK {
return api.HandleHTTPError(res)
}
if res.Body != nil {
_, _ = io.Copy(ioutil.Discard, res.Body)
}
return nil
}

160
pkg/cmd/repo/edit/edit_test.go Normal file
View file

@ -0,0 +1,160 @@
package edit
import (
"bytes"
"context"
"io/ioutil"
"net/http"
"testing"
"github.com/cli/cli/v2/internal/ghrepo"
"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"
"github.com/stretchr/testify/require"
)
func TestNewCmdEdit(t *testing.T) {
tests := []struct {
name string
args string
wantOpts EditOptions
wantErr string
}{
{
name: "no argument",
args: "",
wantErr: "at least one flag is required",
},
{
name: "change repo description",
args: "--description hello",
wantOpts: EditOptions{
Repository: ghrepo.NewWithHost("OWNER", "REPO", "github.com"),
Edits: EditRepositoryInput{
Description: sp("hello"),
},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
io, _, _, _ := iostreams.Test()
io.SetStdoutTTY(true)
io.SetStdinTTY(true)
io.SetStderrTTY(true)
f := &cmdutil.Factory{
IOStreams: io,
BaseRepo: func() (ghrepo.Interface, error) {
return ghrepo.New("OWNER", "REPO"), nil
},
HttpClient: func() (*http.Client, error) {
return nil, nil
},
}
argv, err := shlex.Split(tt.args)
assert.NoError(t, err)
var gotOpts *EditOptions
cmd := NewCmdEdit(f, func(opts *EditOptions) error {
gotOpts = opts
return nil
})
cmd.Flags().BoolP("help", "x", false, "")
cmd.SetArgs(argv)
cmd.SetIn(&bytes.Buffer{})
cmd.SetOut(ioutil.Discard)
cmd.SetErr(ioutil.Discard)
_, err = cmd.ExecuteC()
if tt.wantErr != "" {
assert.EqualError(t, err, tt.wantErr)
return
}
require.NoError(t, err)
assert.Equal(t, ghrepo.FullName(tt.wantOpts.Repository), ghrepo.FullName(gotOpts.Repository))
assert.Equal(t, tt.wantOpts.Edits, gotOpts.Edits)
})
}
}
func Test_editRun(t *testing.T) {
tests := []struct {
name string
opts EditOptions
httpStubs func(*testing.T, *httpmock.Registry)
wantsStderr string
wantsErr string
}{
{
name: "change name and description",
opts: EditOptions{
Repository: ghrepo.NewWithHost("OWNER", "REPO", "github.com"),
Edits: EditRepositoryInput{
Homepage: sp("newURL"),
Description: sp("hello world!"),
},
},
httpStubs: func(t *testing.T, r *httpmock.Registry) {
r.Register(
httpmock.REST("PATCH", "repos/OWNER/REPO"),
httpmock.RESTPayload(200, `{}`, func(payload map[string]interface{}) {
assert.Equal(t, 2, len(payload))
assert.Equal(t, "newURL", payload["homepage"])
assert.Equal(t, "hello world!", payload["description"])
}))
},
},
{
name: "add and remove topics",
opts: EditOptions{
Repository: ghrepo.NewWithHost("OWNER", "REPO", "github.com"),
AddTopics: []string{"topic1", "topic2"},
RemoveTopics: []string{"topic3"},
},
httpStubs: func(t *testing.T, r *httpmock.Registry) {
r.Register(
httpmock.REST("GET", "repos/OWNER/REPO/topics"),
httpmock.StringResponse(`{"names":["topic2", "topic3", "go"]}`))
r.Register(
httpmock.REST("PUT", "repos/OWNER/REPO/topics"),
httpmock.RESTPayload(200, `{}`, func(payload map[string]interface{}) {
assert.Equal(t, 1, len(payload))
assert.Equal(t, []interface{}{"topic2", "go", "topic1"}, payload["names"])
}))
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
httpReg := &httpmock.Registry{}
defer httpReg.Verify(t)
if tt.httpStubs != nil {
tt.httpStubs(t, httpReg)
}
opts := &tt.opts
opts.HTTPClient = &http.Client{Transport: httpReg}
err := editRun(context.Background(), opts)
if tt.wantsErr == "" {
require.NoError(t, err)
} else {
assert.EqualError(t, err, tt.wantsErr)
return
}
})
}
}
func sp(v string) *string {
return &v
}

2
pkg/cmd/repo/repo.go
View file

@ -7,6 +7,7 @@ import (
repoCreateCmd "github.com/cli/cli/v2/pkg/cmd/repo/create"
creditsCmd "github.com/cli/cli/v2/pkg/cmd/repo/credits"
repoDeleteCmd "github.com/cli/cli/v2/pkg/cmd/repo/delete"
repoEditCmd "github.com/cli/cli/v2/pkg/cmd/repo/edit"
repoForkCmd "github.com/cli/cli/v2/pkg/cmd/repo/fork"
gardenCmd "github.com/cli/cli/v2/pkg/cmd/repo/garden"
repoListCmd "github.com/cli/cli/v2/pkg/cmd/repo/list"
@ -41,6 +42,7 @@ func NewCmdRepo(f *cmdutil.Factory) *cobra.Command {
cmd.AddCommand(repoForkCmd.NewCmdFork(f, nil))
cmd.AddCommand(repoCloneCmd.NewCmdClone(f, nil))
cmd.AddCommand(repoCreateCmd.NewCmdCreate(f, nil))
cmd.AddCommand(repoEditCmd.NewCmdEdit(f, nil))
cmd.AddCommand(repoListCmd.NewCmdList(f, nil))
cmd.AddCommand(repoSyncCmd.NewCmdSync(f, nil))
cmd.AddCommand(creditsCmd.NewCmdRepoCredits(f, nil))

77
pkg/cmdutil/flags.go Normal file
View file

@ -0,0 +1,77 @@
package cmdutil
import (
"strconv"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
// NilStringFlag defines a new flag with a string pointer receiver. This is useful for differentiating
// between the flag being set to a blank value and the flag not being passed at all.
func NilStringFlag(cmd *cobra.Command, p **string, name string, shorthand string, usage string) *pflag.Flag {
return cmd.Flags().VarPF(newStringValue(p), name, shorthand, usage)
}
// NilBoolFlag defines a new flag with a bool pointer receiver. This is useful for differentiating
// between the flag being explicitly set to a false value and the flag not being passed at all.
func NilBoolFlag(cmd *cobra.Command, p **bool, name string, shorthand string, usage string) *pflag.Flag {
f := cmd.Flags().VarPF(newBoolValue(p), name, shorthand, usage)
f.NoOptDefVal = "true"
return f
}
type stringValue struct {
string **string
}
func newStringValue(p **string) *stringValue {
return &stringValue{p}
}
func (s *stringValue) Set(value string) error {
*s.string = &value
return nil
}
func (s *stringValue) String() string {
if s.string == nil || *s.string == nil {
return ""
}
return **s.string
}
func (s *stringValue) Type() string {
return "string"
}
type boolValue struct {
bool **bool
}
func newBoolValue(p **bool) *boolValue {
return &boolValue{p}
}
func (b *boolValue) Set(value string) error {
v, err := strconv.ParseBool(value)
*b.bool = &v
return err
}
func (b *boolValue) String() string {
if b.bool == nil || *b.bool == nil {
return "false"
} else if **b.bool {
return "true"
}
return "false"
}
func (b *boolValue) Type() string {
return "bool"
}
func (b *boolValue) IsBoolFlag() bool {
return true
}

14
pkg/set/string_set.go
View file

@ -67,3 +67,17 @@ func (s *stringSet) Len() int {
func (s *stringSet) ToSlice() []string {
return s.v
}
func (s1 *stringSet) Equal(s2 *stringSet) bool {
if s1.Len() != s2.Len() {
return false
}
isEqual := true
for _, v := range s1.v {
if !s2.Contains(v) {
isEqual = false
break
}
}
return isEqual
}

4
pkg/surveyext/editor_manual.go
View file

@ -15,8 +15,8 @@ type showable interface {
Show()
}
func Edit(editorCommand, fn, initialValue string, stdin io.Reader, stdout io.Writer, stderr io.Writer, cursor showable) (string, error) {
return edit(editorCommand, fn, initialValue, stdin, stdout, stderr, cursor, defaultLookPath)
func Edit(editorCommand, fn, initialValue string, stdin io.Reader, stdout io.Writer, stderr io.Writer) (string, error) {
return edit(editorCommand, fn, initialValue, stdin, stdout, stderr, nil, defaultLookPath)
}
func defaultLookPath(name string) ([]string, []string, error) {