diff --git a/issue.go b/issue.go index 8890e67..9d9aa03 100644 --- a/issue.go +++ b/issue.go @@ -277,6 +277,11 @@ type CommentVisibility struct { Value string `json:"value,omitempty"` } +type SearchOptions struct { + StartAt int + MaxResults int +} + // searchResult is only a small wrapper arround the Search (with JQL) method // to be able to parse the results type searchResult struct { @@ -425,8 +430,15 @@ func (s *IssueService) AddLink(issueLink *IssueLink) (*Response, error) { // Search will search for tickets according to the jql // // JIRA API docs: https://developer.atlassian.com/jiradev/jira-apis/jira-rest-apis/jira-rest-api-tutorials/jira-rest-api-example-query-issues -func (s *IssueService) Search(jql string) ([]Issue, *Response, error) { - u := fmt.Sprintf("rest/api/2/search?jql=%s", url.QueryEscape(jql)) +func (s *IssueService) Search(jql string, options *SearchOptions) ([]Issue, *Response, error) { + var u string + if options == nil { + u = fmt.Sprintf("rest/api/2/search?jql=%s", url.QueryEscape(jql)) + } else { + u = fmt.Sprintf("rest/api/2/search?jql=%s&startAt=%d&maxResults=%d", url.QueryEscape(jql), + options.StartAt, options.MaxResults) + } + req, err := s.client.NewRequest("GET", u, nil) if err != nil { return []Issue{}, nil, err diff --git a/issue_test.go b/issue_test.go index 9bb3a08..37c2d98 100644 --- a/issue_test.go +++ b/issue_test.go @@ -316,11 +316,13 @@ func TestIssue_Search(t *testing.T) { defer teardown() testMux.HandleFunc("/rest/api/2/search", func(w http.ResponseWriter, r *http.Request) { testMethod(t, r, "GET") - testRequestURL(t, r, "/rest/api/2/search?jql=something") + testRequestURL(t, r, "/rest/api/2/search?jql=something&startAt=1&maxResults=40") w.WriteHeader(http.StatusOK) fmt.Fprint(w, `{"expand": "schema,names","startAt": 1,"maxResults": 40,"total": 6,"issues": [{"expand": "html","id": "10230","self": "http://kelpie9:8081/rest/api/2/issue/BULK-62","key": "BULK-62","fields": {"summary": "testing","timetracking": null,"issuetype": {"self": "http://kelpie9:8081/rest/api/2/issuetype/5","id": "5","description": "The sub-task of the issue","iconUrl": "http://kelpie9:8081/images/icons/issue_subtask.gif","name": "Sub-task","subtask": true},"customfield_10071": null}},{"expand": "html","id": "10004","self": "http://kelpie9:8081/rest/api/2/issue/BULK-47","key": "BULK-47","fields": {"summary": "Cheese v1 2.0 issue","timetracking": null,"issuetype": {"self": "http://kelpie9:8081/rest/api/2/issuetype/3","id": "3","description": "A task that needs to be done.","iconUrl": "http://kelpie9:8081/images/icons/task.gif","name": "Task","subtask": false}}}]}`) }) - _, resp, err := testClient.Issue.Search("something") + + opt := &SearchOptions{StartAt: 1, MaxResults: 40} + _, resp, err := testClient.Issue.Search("something", opt) if resp == nil { t.Errorf("Response given: %+v", resp) @@ -340,6 +342,37 @@ func TestIssue_Search(t *testing.T) { } } +func TestIssue_SearchWithoutPaging(t *testing.T) { + + setup() + defer teardown() + testMux.HandleFunc("/rest/api/2/search", func(w http.ResponseWriter, r *http.Request) { + testMethod(t, r, "GET") + testRequestURL(t, r, "/rest/api/2/search?jql=something") + w.WriteHeader(http.StatusOK) + fmt.Fprint(w, `{"expand": "schema,names","startAt": 0,"maxResults": 50,"total": 6,"issues": [{"expand": "html","id": "10230","self": "http://kelpie9:8081/rest/api/2/issue/BULK-62","key": "BULK-62","fields": {"summary": "testing","timetracking": null,"issuetype": {"self": "http://kelpie9:8081/rest/api/2/issuetype/5","id": "5","description": "The sub-task of the issue","iconUrl": "http://kelpie9:8081/images/icons/issue_subtask.gif","name": "Sub-task","subtask": true},"customfield_10071": null}},{"expand": "html","id": "10004","self": "http://kelpie9:8081/rest/api/2/issue/BULK-47","key": "BULK-47","fields": {"summary": "Cheese v1 2.0 issue","timetracking": null,"issuetype": {"self": "http://kelpie9:8081/rest/api/2/issuetype/3","id": "3","description": "A task that needs to be done.","iconUrl": "http://kelpie9:8081/images/icons/task.gif","name": "Task","subtask": false}}}]}`) + }) + + _, resp, err := testClient.Issue.Search("something", nil) + + if resp == nil { + t.Errorf("Response given: %+v", resp) + } + if err != nil { + t.Errorf("Error given: %s", err) + } + + if resp.StartAt != 0 { + t.Errorf("StartAt should populate with 0, %v given", resp.StartAt) + } + if resp.MaxResults != 50 { + t.Errorf("StartAt should populate with 50, %v given", resp.MaxResults) + } + if resp.Total != 6 { + t.Errorf("StartAt should populate with 6, %v given", resp.Total) + } +} + func Test_CustomFields(t *testing.T) { setup() defer teardown()