Add API endpoints related to robot comments

Jakub Sarzyński · Jakub Sarzyński · commit c0357e304f03 · 2022-09-09T17:09:13.000+02:00
diff --git a/changes.go b/changes.go
@@ -673,6 +673,15 @@ func (s *ChangesService) ListChangeComments(changeID string) (*map[string][]Comm
 	return s.getCommentInfoMapResponse(u)
 }
 
+// Lists the robot comments of all revisions of the change.
+// Return a map that maps the file path to a list of RobotCommentInfo entries. The entries in the map are sorted by file path.
+//
+// Gerrit API docs: https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#list-change-robot-comments
+func (s *ChangesService) ListChangeRobotComments(changeID string) (map[string][]RobotCommentInfo, *Response, error) {
+	u := fmt.Sprintf("changes/%s/robotcomments", changeID)
+	return s.getRobotCommentInfoMapSliceResponse(u)
+}
+
 // ListChangeDrafts lLists the draft comments of all revisions of the change that belong to the calling user.
 // The entries in the map are sorted by file path, and the comments for each path are sorted by patch set number.
 // Each comment has the patch_set field set, and no author.
@@ -741,6 +750,22 @@ func (s *ChangesService) getCommentInfoMapSliceResponse(u string) (*map[string][
 	return v, resp, err
 }
 
+// getRobotCommentInfoMapSliceResponse retrieved a map with a slice of RobotCommentInfo Response for a GET request
+func (s *ChangesService) getRobotCommentInfoMapSliceResponse(u string) (map[string][]RobotCommentInfo, *Response, error) {
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	var v map[string][]RobotCommentInfo
+	resp, err := s.client.Do(req, &v)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return v, resp, err
+}
+
 // CreateChange creates a new change.
 //
 // The change input ChangeInput entity must be provided in the request body.
diff --git a/changes_revision.go b/changes_revision.go
@@ -201,6 +201,26 @@ func (s *ChangesService) GetComment(changeID, revisionID, commentID string) (*Co
 	return s.getCommentInfoResponse(u)
 }
 
+// GetRobotComment retrieves a robot comment of a revision.
+//
+// Gerrit API docs: https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#get-robot-comment
+func (s *ChangesService) GetRobotComment(changeID, revisionID, commentID string) (*RobotCommentInfo, *Response, error) {
+	u := fmt.Sprintf("changes/%s/revisions/%s/robotcomments/%s", changeID, revisionID, commentID)
+
+	req, err := s.client.NewRequest("GET", u, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	v := new(RobotCommentInfo)
+	resp, err := s.client.Do(req, v)
+	if err != nil {
+		return nil, resp, err
+	}
+
+	return v, resp, err
+}
+
 // GetSubmitType gets the method the server will use to submit (merge) the change.
 //
 // Gerrit API docs: https://gerrit-review.googlesource.com/Documentation/rest-api-changes.html#get-submit-type
@@ -313,6 +333,11 @@ func (s *ChangesService) ListRevisionComments(changeID, revisionID string) (*map
 	return s.getCommentInfoMapSliceResponse(u)
 }
 
+func (s *ChangesService) ListRevisionRobotComments(changeID, revisionID string) (map[string][]RobotCommentInfo, *Response, error) {
+	u := fmt.Sprintf("changes/%s/revisions/%s/robotcomments", changeID, revisionID)
+	return s.getRobotCommentInfoMapSliceResponse(u)
+}
+
 // ListFiles lists the files that were modified, added or deleted in a revision.
 // As result a map is returned that maps the file path to a list of FileInfo entries.
 // The entries in the map are sorted by file path.
diff --git a/changes_revision_test.go b/changes_revision_test.go
@@ -6,6 +6,7 @@ import (
 	"net/http/httptest"
 	"reflect"
 	"testing"
+	"time"
 
 	"github.com/andygrunwald/go-gerrit"
 )
@@ -79,3 +80,235 @@ func TestChangesService_ListFilesReviewed(t *testing.T) {
 		t.Errorf("client.Changes.ListFilesReviewed:\ngot:  %q\nwant: %q", got, want)
 	}
 }
+
+func TestChangesService_ListRevisionRobotComment(t *testing.T) {
+	listRobotCommentResponse := `)]}'
+		{
+		  "main.c": [
+		    {
+		      "robot_id": "robot",
+		      "robot_run_id": "1",
+		      "fix_suggestions": [
+		        {
+		          "fix_id": "c3302a6f_1578ee9e",
+		          "description": "suggestion",
+		          "replacements": [
+		            {
+		              "path": "main.c",
+		              "range": {
+		                "start_line": 3,
+		                "start_character": 0,
+		                "end_line": 5,
+		                "end_character": 1
+		              },
+		              "replacement": "int main() { printf(\"Hello world!\"); }"
+		            }
+		          ]
+		        }
+		      ],
+		      "author": {
+		        "_account_id": 1000000,
+		        "name": "Jhon Smith",
+		        "username": "jhon"
+		      },
+		      "change_message_id": "517e6c92e4bd105f1e611294a3010ea177771551",
+		      "patch_set": 1,
+		      "id": "f7d3d07f_bf17b66e",
+		      "line": 5,
+		      "range": {
+		        "start_line": 3,
+		        "start_character": 0,
+		        "end_line": 5,
+		        "end_character": 1
+		      },
+		      "updated": "2022-07-05 13:44:34.000000000",
+		      "message": "[clang-format] fix suggestion",
+		      "commit_id": "be8ce493368f2ce0fa73b56f5e2bd0dc17ca4359"
+		    }
+		  ]
+		}`
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path != "/changes/changeID/revisions/revisionID/robotcomments" {
+			t.Errorf("%s != /changes/changeID/revisions/revisionID/robotcomments", r.URL.Path)
+		}
+		if r.Method != "GET" {
+			t.Error("Method != GET")
+		}
+		fmt.Fprint(w, listRobotCommentResponse)
+	}))
+	defer ts.Close()
+
+	client, err := gerrit.NewClient(ts.URL, nil)
+	if err != nil {
+		t.Error(err)
+	}
+
+	got, _, err := client.Changes.ListRevisionRobotComments("changeID", "revisionID")
+	if err != nil {
+		t.Errorf("Changes.ListRevisionRobotComments returned error: %v", err)
+	}
+
+	want := map[string][]gerrit.RobotCommentInfo{
+		"main.c": {
+			{
+				CommentInfo: gerrit.CommentInfo{
+					PatchSet: 1,
+					ID:       "f7d3d07f_bf17b66e",
+					Line:     5,
+					Range: &gerrit.CommentRange{
+						StartLine:      3,
+						StartCharacter: 0,
+						EndLine:        5,
+						EndCharacter:   1,
+					},
+					Message: "[clang-format] fix suggestion",
+					Updated: &gerrit.Timestamp{
+						Time: time.Date(2022, 7, 5, 13, 44, 34, 0, time.UTC),
+					},
+					Author: gerrit.AccountInfo{
+						AccountID: 1000000,
+						Name:      "Jhon Smith",
+						Username:  "jhon",
+					},
+				},
+				RobotID:    "robot",
+				RobotRunID: "1",
+				FixSuggestions: []gerrit.FixSuggestionInfo{
+					{
+						FixID:       "c3302a6f_1578ee9e",
+						Description: "suggestion",
+						Replacements: []gerrit.FixReplacementInfo{
+							{
+								Path: "main.c",
+								Range: gerrit.CommentRange{
+									StartLine:      3,
+									StartCharacter: 0,
+									EndLine:        5,
+									EndCharacter:   1,
+								},
+								Replacement: "int main() { printf(\"Hello world!\"); }",
+							},
+						},
+					},
+				},
+			},
+		},
+	}
+
+	if !reflect.DeepEqual(got, want) {
+		t.Errorf("Change.ListRevisionRobotComments:\ngot: %+v\nwant: %+v", got, want)
+	}
+}
+
+func TestChangesService_GetRobotComment(t *testing.T) {
+	getRobotCommentResponse := `)]}'
+		{
+		  "robot_id": "robot",
+		  "robot_run_id": "1",
+		  "fix_suggestions": [
+		    {
+		      "fix_id": "c3302a6f_1578ee9e",
+		      "description": "suggestion",
+		      "replacements": [
+		        {
+		          "path": "main.c",
+		          "range": {
+		            "start_line": 3,
+		            "start_character": 0,
+		            "end_line": 5,
+		            "end_character": 1
+		          },
+		          "replacement": "int main() { printf(\"Hello world!\"); }"
+		        }
+		      ]
+		    }
+		  ],
+		  "author": {
+		    "_account_id": 1000000,
+		    "name": "Jhon Smith",
+		    "username": "jhon"
+		  },
+		  "change_message_id": "517e6c92e4bd105f1e611294a3010ea177771551",
+		  "patch_set": 1,
+		  "id": "f7d3d07f_bf17b66e",
+		  "line": 5,
+		  "range": {
+		    "start_line": 3,
+		    "start_character": 0,
+		    "end_line": 5,
+		    "end_character": 1
+		  },
+		  "updated": "2022-07-05 13:44:34.000000000",
+		  "message": "[clang-format] fix suggestion",
+		  "commit_id": "be8ce493368f2ce0fa73b56f5e2bd0dc17ca4359"
+		}`
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.URL.Path != "/changes/changeID/revisions/revisionID/robotcomments/commentID" {
+			t.Errorf("%s != /changes/changeID/revisions/revisionID/robotcomments/commentID", r.URL.Path)
+		}
+		if r.Method != "GET" {
+			t.Error("Method != GET")
+		}
+		fmt.Fprint(w, getRobotCommentResponse)
+	}))
+	defer ts.Close()
+
+	client, err := gerrit.NewClient(ts.URL, nil)
+	if err != nil {
+		t.Error(err)
+	}
+
+	got, _, err := client.Changes.GetRobotComment("changeID", "revisionID", "commentID")
+	if err != nil {
+		t.Errorf("Changes.GetRobotComment returned error: %v", err)
+	}
+
+	want := &gerrit.RobotCommentInfo{
+		CommentInfo: gerrit.CommentInfo{
+			PatchSet: 1,
+			ID:       "f7d3d07f_bf17b66e",
+			Line:     5,
+			Range: &gerrit.CommentRange{
+				StartLine:      3,
+				StartCharacter: 0,
+				EndLine:        5,
+				EndCharacter:   1,
+			},
+			Message: "[clang-format] fix suggestion",
+			Updated: &gerrit.Timestamp{
+				Time: time.Date(2022, 7, 5, 13, 44, 34, 0, time.UTC),
+			},
+			Author: gerrit.AccountInfo{
+				AccountID: 1000000,
+				Name:      "Jhon Smith",
+				Username:  "jhon",
+			},
+		},
+		RobotID:    "robot",
+		RobotRunID: "1",
+		FixSuggestions: []gerrit.FixSuggestionInfo{
+			{
+				FixID:       "c3302a6f_1578ee9e",
+				Description: "suggestion",
+				Replacements: []gerrit.FixReplacementInfo{
+					{
+						Path: "main.c",
+						Range: gerrit.CommentRange{
+							StartLine:      3,
+							StartCharacter: 0,
+							EndLine:        5,
+							EndCharacter:   1,
+						},
+						Replacement: "int main() { printf(\"Hello world!\"); }",
+					},
+				},
+			},
+		},
+	}
+
+	if !reflect.DeepEqual(got, want) {
+		t.Errorf("Change.GetRobotComment:\ngot: %+v\nwant: %+v", got, want)
+	}
+}
diff --git a/changes_test.go b/changes_test.go
