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

Update error messages and test repo handling in agent-task create

Browse source 
Replaces 'problem statement' with 'task description' in error messages for clarity. Refactors tests to use a BaseRepo function instead of direct repo objects, and adds a test for missing task description error.
This commit is contained in:
Kynan Ware 2025-09-03 14:25:38 -06:00
parent 21ccabc832
commit a821b408d4
2 changed files with 17 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

6
pkg/cmd/agent-task/create/create.go
View file

@ -39,7 +39,7 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
// TODO: We'll support prompting for the problem statement if not provided
// and from file flags, later.
if len(args) == 0 {
return cmdutil.FlagErrorf("a problem statement is required")
return cmdutil.FlagErrorf("a task description is required")
}
opts.ProblemStatement = args[0]
@ -75,13 +75,13 @@ func NewCmdCreate(f *cmdutil.Factory, runF func(*CreateOptions) error) *cobra.Co
func createRun(opts *CreateOptions) error {
if opts.ProblemStatement == "" {
return cmdutil.FlagErrorf("a problem statement is required")
return cmdutil.FlagErrorf("a task description is required")
}
if opts.BaseRepo == nil {
return errors.New("failed to resolve repository")
}
repo, err := opts.BaseRepo()
if err != nil || repo == nil || repo.RepoOwner() == "" || repo.RepoName() == "" {
if err != nil || repo == nil {
// Not printing the error that came back from BaseRepo() here because we want
// something clear, human friendly, and actionable.
return fmt.Errorf("a repository is required; re-run in a repository or supply one with --repo owner/name")

28
pkg/cmd/agent-task/create/create_test.go
View file

@ -53,8 +53,7 @@ func Test_createRun(t *testing.T) {
tests := []struct {
name string
stubs func(*httpmock.Registry)
baseRepo ghrepo.Interface
baseRepoErr error
baseRepoFunc func() (ghrepo.Interface, error)
problemStatement string
wantStdout string
wantStdErr string
@ -62,7 +61,7 @@ func Test_createRun(t *testing.T) {
}{
{
name: "get job API failure surfaces error",
baseRepo: ghrepo.New("OWNER", "REPO"),
baseRepoFunc: func() (ghrepo.Interface, error) { return ghrepo.New("OWNER", "REPO"), nil },
problemStatement: "Do the thing",
stubs: func(reg *httpmock.Registry) {
reg.Register(
@ -79,7 +78,7 @@ func Test_createRun(t *testing.T) {
},
{
name: "success with immediate PR",
baseRepo: ghrepo.New("OWNER", "REPO"),
baseRepoFunc: func() (ghrepo.Interface, error) { return ghrepo.New("OWNER", "REPO"), nil },
problemStatement: "Do the thing",
stubs: func(reg *httpmock.Registry) {
reg.Register(
@ -91,7 +90,7 @@ func Test_createRun(t *testing.T) {
},
{
name: "success with delayed PR after polling",
baseRepo: ghrepo.New("OWNER", "REPO"),
baseRepoFunc: func() (ghrepo.Interface, error) { return ghrepo.New("OWNER", "REPO"), nil },
problemStatement: "Do the thing",
stubs: func(reg *httpmock.Registry) {
reg.Register(
@ -107,7 +106,7 @@ func Test_createRun(t *testing.T) {
},
{
name: "fallback after timeout returns link to global agents page",
baseRepo: ghrepo.New("OWNER", "REPO"),
baseRepoFunc: func() (ghrepo.Interface, error) { return ghrepo.New("OWNER", "REPO"), nil },
problemStatement: "Do the thing",
stubs: func(reg *httpmock.Registry) {
reg.Register(
@ -127,12 +126,12 @@ func Test_createRun(t *testing.T) {
{
name: "missing repo returns error",
problemStatement: "task",
baseRepo: ghrepo.New("", ""),
baseRepoFunc: func() (ghrepo.Interface, error) { return nil, nil },
wantErr: "a repository is required; re-run in a repository or supply one with --repo owner/name",
},
{
name: "create task API failure returns error",
baseRepo: ghrepo.New("OWNER", "REPO"),
baseRepoFunc: func() (ghrepo.Interface, error) { return ghrepo.New("OWNER", "REPO"), nil },
problemStatement: "do the thing",
stubs: func(reg *httpmock.Registry) {
reg.Register(
@ -142,7 +141,12 @@ func Test_createRun(t *testing.T) {
},
wantErr: "failed to create job: some API error",
},
// Removed test case that previously expected fallback after polling error.
{
name: "missing task description returns error",
baseRepoFunc: func() (ghrepo.Interface, error) { return ghrepo.New("OWNER", "REPO"), nil },
problemStatement: "",
wantErr: "a task description is required",
},
}
for _, tt := range tests {
@ -151,11 +155,7 @@ func Test_createRun(t *testing.T) {
opts := &CreateOptions{
IO: ios,
ProblemStatement: tt.problemStatement,
}
if tt.baseRepo != nil || tt.baseRepoErr != nil {
br, bre := tt.baseRepo, tt.baseRepoErr
opts.BaseRepo = func() (ghrepo.Interface, error) { return br, bre }
BaseRepo: tt.baseRepoFunc,
}
// A backoff with no internal between retries to keep tests fast,