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

Merge pull request #1436 from cli/move-ask-stubber

Browse source 
move survey helper and test helpers to prompt pkg
This commit is contained in:
Nate Smith 2020-07-28 11:49:19 -05:00 • committed by GitHub
commit 43318fd8e8
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 102 additions and 90 deletions
Download patch file Download diff file Expand all files Collapse all files

3
command/pr.go
View file

@ -16,6 +16,7 @@ import (
"github.com/cli/cli/git"
"github.com/cli/cli/internal/ghrepo"
"github.com/cli/cli/pkg/cmdutil"
"github.com/cli/cli/pkg/prompt"
"github.com/cli/cli/pkg/text"
"github.com/cli/cli/utils"
"github.com/spf13/cobra"
@ -619,7 +620,7 @@ func prInteractiveMerge(deleteLocalBranch bool, crossRepoPR bool) (api.PullReque
DeleteBranch bool
}{}
err := SurveyAsk(qs, &answers)
err := prompt.SurveyAsk(qs, &answers)
if err != nil {
return 0, false, fmt.Errorf("could not prompt: %w", err)
}

19
command/pr_create_test.go
View file

@ -11,6 +11,7 @@ import (
"github.com/cli/cli/git"
"github.com/cli/cli/internal/ghrepo"
"github.com/cli/cli/pkg/httpmock"
"github.com/cli/cli/pkg/prompt"
"github.com/cli/cli/test"
"github.com/stretchr/testify/assert"
)
@ -602,10 +603,10 @@ func TestPRCreate_survey_defaults_multicommit(t *testing.T) {
cs.Stub("") // git rev-parse
cs.Stub("") // git push
as, surveyTeardown := initAskStubber()
as, surveyTeardown := prompt.InitAskStubber()
defer surveyTeardown()
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "title",
Default: true,
@ -615,7 +616,7 @@ func TestPRCreate_survey_defaults_multicommit(t *testing.T) {
Default: true,
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "confirmation",
Value: 0,
@ -687,10 +688,10 @@ func TestPRCreate_survey_defaults_monocommit(t *testing.T) {
cs.Stub("") // git rev-parse
cs.Stub("") // git push
as, surveyTeardown := initAskStubber()
as, surveyTeardown := prompt.InitAskStubber()
defer surveyTeardown()
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "title",
Default: true,
@ -700,7 +701,7 @@ func TestPRCreate_survey_defaults_monocommit(t *testing.T) {
Default: true,
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "confirmation",
Value: 0,
@ -896,10 +897,10 @@ func TestPRCreate_defaults_error_interactive(t *testing.T) {
cs.Stub("") // git push
cs.Stub("") // browser open
as, surveyTeardown := initAskStubber()
as, surveyTeardown := prompt.InitAskStubber()
defer surveyTeardown()
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "title",
Default: true,
@ -909,7 +910,7 @@ func TestPRCreate_defaults_error_interactive(t *testing.T) {
Value: "social distancing",
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "confirmation",
Value: 1,

7
command/pr_review.go
View file

@ -9,6 +9,7 @@ import (
"github.com/spf13/cobra"
"github.com/cli/cli/api"
"github.com/cli/cli/pkg/prompt"
"github.com/cli/cli/pkg/surveyext"
"github.com/cli/cli/utils"
)
@ -166,7 +167,7 @@ func reviewSurvey(cmd *cobra.Command) (*api.PullRequestReviewInput, error) {
},
}
err = SurveyAsk(typeQs, &typeAnswers)
err = prompt.SurveyAsk(typeQs, &typeAnswers)
if err != nil {
return nil, err
}
@ -207,7 +208,7 @@ func reviewSurvey(cmd *cobra.Command) (*api.PullRequestReviewInput, error) {
},
}
err = SurveyAsk(bodyQs, &bodyAnswers)
err = prompt.SurveyAsk(bodyQs, &bodyAnswers)
if err != nil {
return nil, err
}
@ -237,7 +238,7 @@ func reviewSurvey(cmd *cobra.Command) (*api.PullRequestReviewInput, error) {
},
}
err = SurveyAsk(confirmQs, &confirm)
err = prompt.SurveyAsk(confirmQs, &confirm)
if err != nil {
return nil, err
}

25
command/pr_review_test.go
View file

@ -7,6 +7,7 @@ import (
"regexp"
"testing"
"github.com/cli/cli/pkg/prompt"
"github.com/cli/cli/test"
"github.com/stretchr/testify/assert"
)
@ -337,22 +338,22 @@ func TestPRReview_interactive(t *testing.T) {
] } } } }
`))
http.StubResponse(200, bytes.NewBufferString(`{"data": {} }`))
as, teardown := initAskStubber()
as, teardown := prompt.InitAskStubber()
defer teardown()
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "reviewType",
Value: "Approve",
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "body",
Value: "cool story",
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "confirm",
Value: true,
@ -399,22 +400,22 @@ func TestPRReview_interactive_no_body(t *testing.T) {
] } } } }
`))
http.StubResponse(200, bytes.NewBufferString(`{"data": {} }`))
as, teardown := initAskStubber()
as, teardown := prompt.InitAskStubber()
defer teardown()
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "reviewType",
Value: "Request changes",
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "body",
Default: true,
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "confirm",
Value: true,
@ -443,22 +444,22 @@ func TestPRReview_interactive_blank_approve(t *testing.T) {
] } } } }
`))
http.StubResponse(200, bytes.NewBufferString(`{"data": {} }`))
as, teardown := initAskStubber()
as, teardown := prompt.InitAskStubber()
defer teardown()
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "reviewType",
Value: "Approve",
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "body",
Default: true,
},
})
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "confirm",
Value: true,

5
command/pr_test.go
View file

@ -11,6 +11,7 @@ import (
"github.com/cli/cli/api"
"github.com/cli/cli/internal/run"
"github.com/cli/cli/pkg/httpmock"
"github.com/cli/cli/pkg/prompt"
"github.com/cli/cli/test"
"github.com/google/go-cmp/cmp"
"github.com/stretchr/testify/assert"
@ -1618,10 +1619,10 @@ func TestPRMerge_interactive(t *testing.T) {
cs.Stub("") // git push origin --delete blueberries
cs.Stub("") // git branch -d
as, surveyTeardown := initAskStubber()
as, surveyTeardown := prompt.InitAskStubber()
defer surveyTeardown()
as.Stub([]*QuestionStub{
as.Stub([]*prompt.QuestionStub{
{
Name: "mergeMethod",
Value: 0,

54
command/testing.go
View file

@ -4,10 +4,7 @@ import (
"bytes"
"errors"
"fmt"
"reflect"
"github.com/AlecAivazis/survey/v2"
"github.com/AlecAivazis/survey/v2/core"
"github.com/cli/cli/api"
"github.com/cli/cli/context"
"github.com/cli/cli/internal/config"
@ -23,57 +20,6 @@ const defaultTestConfig = `hosts:
oauth_token: "1234567890"
`
type askStubber struct {
Asks [][]*survey.Question
Count int
Stubs [][]*QuestionStub
}
func initAskStubber() (*askStubber, func()) {
origSurveyAsk := SurveyAsk
as := askStubber{}
SurveyAsk = func(qs []*survey.Question, response interface{}, opts ...survey.AskOpt) error {
as.Asks = append(as.Asks, qs)
count := as.Count
as.Count += 1
if count >= len(as.Stubs) {
panic(fmt.Sprintf("more asks than stubs. most recent call: %v", qs))
}
// actually set response
stubbedQuestions := as.Stubs[count]
for i, sq := range stubbedQuestions {
q := qs[i]
if q.Name != sq.Name {
panic(fmt.Sprintf("stubbed question mismatch: %s != %s", q.Name, sq.Name))
}
if sq.Default {
defaultValue := reflect.ValueOf(q.Prompt).Elem().FieldByName("Default")
_ = core.WriteAnswer(response, q.Name, defaultValue)
} else {
_ = core.WriteAnswer(response, q.Name, sq.Value)
}
}
return nil
}
teardown := func() {
SurveyAsk = origSurveyAsk
}
return &as, teardown
}
type QuestionStub struct {
Name string
Value interface{}
Default bool
}
func (as *askStubber) Stub(stubbedQuestions []*QuestionStub) {
// A call to .Ask takes a list of questions; a stub is then a list of questions in the same order.
as.Stubs = append(as.Stubs, stubbedQuestions)
}
func initBlankContext(cfg, repo, branch string) {
initContext = func() context.Context {
ctx := context.NewBlank()

15
command/title_body_survey.go
View file

@ -7,6 +7,7 @@ import (
"github.com/cli/cli/api"
"github.com/cli/cli/internal/ghrepo"
"github.com/cli/cli/pkg/githubtemplate"
"github.com/cli/cli/pkg/prompt"
"github.com/cli/cli/pkg/surveyext"
"github.com/cli/cli/utils"
"github.com/spf13/cobra"
@ -54,10 +55,6 @@ const (
noMilestone = "(none)"
)
var SurveyAsk = func(qs []*survey.Question, response interface{}, opts ...survey.AskOpt) error {
return survey.Ask(qs, response, opts...)
}
func confirmSubmission(allowPreview bool, allowMetadata bool) (Action, error) {
const (
submitLabel = "Submit"
@ -88,7 +85,7 @@ func confirmSubmission(allowPreview bool, allowMetadata bool) (Action, error) {
},
}
err := SurveyAsk(confirmQs, &confirmAnswers)
err := prompt.SurveyAsk(confirmQs, &confirmAnswers)
if err != nil {
return -1, fmt.Errorf("could not prompt: %w", err)
}
@ -130,7 +127,7 @@ func selectTemplate(nonLegacyTemplatePaths []string, legacyTemplatePath *string,
},
},
}
if err := SurveyAsk(selectQs, &templateResponse); err != nil {
if err := prompt.SurveyAsk(selectQs, &templateResponse); err != nil {
return "", fmt.Errorf("could not prompt: %w", err)
}
@ -201,7 +198,7 @@ func titleBodySurvey(cmd *cobra.Command, issueState *issueMetadataState, apiClie
qs = append(qs, bodyQuestion)
}
err = SurveyAsk(qs, issueState)
err = prompt.SurveyAsk(qs, issueState)
if err != nil {
return fmt.Errorf("could not prompt: %w", err)
}
@ -232,7 +229,7 @@ func titleBodySurvey(cmd *cobra.Command, issueState *issueMetadataState, apiClie
}
extraFieldsOptions = append(extraFieldsOptions, "Assignees", "Labels", "Projects", "Milestone")
err = SurveyAsk([]*survey.Question{
err = prompt.SurveyAsk([]*survey.Question{
{
Name: "metadata",
Prompt: &survey.MultiSelect{
@ -364,7 +361,7 @@ func titleBodySurvey(cmd *cobra.Command, issueState *issueMetadataState, apiClie
}
}
values := metadataValues{}
err = SurveyAsk(mqs, &values, survey.WithKeepFilter(true))
err = prompt.SurveyAsk(mqs, &values, survey.WithKeepFilter(true))
if err != nil {
return fmt.Errorf("could not prompt: %w", err)
}

4
pkg/prompt/prompt.go
View file

@ -20,3 +20,7 @@ var Confirm = func(prompt string, result *bool) error {
}
return survey.AskOne(p, result)
}
var SurveyAsk = func(qs []*survey.Question, response interface{}, opts ...survey.AskOpt) error {
return survey.Ask(qs, response, opts...)
}

60
pkg/prompt/stubber.go Normal file
View file

@ -0,0 +1,60 @@
package prompt
import (
"fmt"
"reflect"
"github.com/AlecAivazis/survey/v2"
"github.com/AlecAivazis/survey/v2/core"
)
type askStubber struct {
Asks [][]*survey.Question
Count int
Stubs [][]*QuestionStub
}
func InitAskStubber() (*askStubber, func()) {
origSurveyAsk := SurveyAsk
as := askStubber{}
SurveyAsk = func(qs []*survey.Question, response interface{}, opts ...survey.AskOpt) error {
as.Asks = append(as.Asks, qs)
count := as.Count
as.Count += 1
if count >= len(as.Stubs) {
panic(fmt.Sprintf("more asks than stubs. most recent call: %v", qs))
}
// actually set response
stubbedQuestions := as.Stubs[count]
for i, sq := range stubbedQuestions {
q := qs[i]
if q.Name != sq.Name {
panic(fmt.Sprintf("stubbed question mismatch: %s != %s", q.Name, sq.Name))
}
if sq.Default {
defaultValue := reflect.ValueOf(q.Prompt).Elem().FieldByName("Default")
_ = core.WriteAnswer(response, q.Name, defaultValue)
} else {
_ = core.WriteAnswer(response, q.Name, sq.Value)
}
}
return nil
}
teardown := func() {
SurveyAsk = origSurveyAsk
}
return &as, teardown
}
type QuestionStub struct {
Name string
Value interface{}
Default bool
}
func (as *askStubber) Stub(stubbedQuestions []*QuestionStub) {
// A call to .Ask takes a list of questions; a stub is then a list of questions in the same order.
as.Stubs = append(as.Stubs, stubbedQuestions)
}