Add inline review support0.2.8

Added API to send inline review

Change-Id: Ifdcfbaea6ae4d8723d9566eaaf3c5dba5ff35617

2 files changed, 124 insertions, 0 deletions

diff --git a/pygerrit/rest/__init__.py b/pygerrit/rest/__init__.py
index 5b197a0..c5d0ea1 100644
--- a/pygerrit/rest/__init__.py
+++ b/pygerrit/rest/__init__.py
@@ -154,3 +154,88 @@ class GerritRestAPI(object):
         kwargs.update(self.kwargs.copy())
         response = self.session.delete(self.make_url(endpoint), **kwargs)
         return _decode_response(response)
+
+    def review(self, change_id, revision, review):
+        """ Send HTTP POST with review parameters.
+
+        Return JSON decoded result.
+
+        Raise requests.RequestException on timeout or connection error.
+
+        """
+
+        endpoint = "changes/%s/revisions/%s/review" % (change_id, revision)
+        self.post(endpoint, data=str(review))
+
+
+class GerritReview(object):
+
+    """Class to handle inline reviews."""
+
+    def __init__(self, message=None, labels=None, comments=None):
+        """ Initialization.
+
+        Format Eg:
+        labels :
+        {'Verified': 1, 'Code-Review': -1}
+        comments :
+        [{'filename': 'Makefile', 'line': 10, 'message': 'inline message'}]
+
+        """
+        self.message = message if message else ""
+        if labels:
+            if not isinstance(labels, dict):
+                raise ValueError("labels must be a dict.")
+            self.labels = labels
+        else:
+            self.labels = {}
+        if comments:
+            if not isinstance(comments, list):
+                raise ValueError("comments must be a list.")
+            self.comments = {}
+            self.add_comments(comments)
+        else:
+            self.comments = {}
+
+    def set_message(self, message):
+        """Set review message."""
+        self.message = message
+
+    def add_labels(self, labels):
+        """Set Labels.
+
+        Format Eg:  {'Verified': 1, 'Code-Review': -1}
+
+        """
+        self.labels.update(labels)
+
+    def add_comments(self, comments):
+        """Add inline comments.
+
+        Format Eg:
+        [{'filename': 'Makefile', 'line': 10, 'message': 'inline message'}]
+
+        """
+        for comment in comments:
+            if 'filename' and 'line' and 'message' in comment.keys():
+                line_msg = {"line": comment['line'],
+                            "message": comment['message']}
+                file_comment = {comment['filename']: [line_msg]}
+                if self.comments:
+                    if comment['filename'] in self.comments.keys():
+                        self.comments[comment['filename']].append(line_msg)
+                    else:
+                        self.comments.update(file_comment)
+                else:
+                    self.comments.update(file_comment)
+
+    def __str__(self):
+        """Return review in str format."""
+        review_input = {}
+        if self.message:
+            review_input.update({'message': self.message})
+        if self.labels:
+            review_input.update({'labels': self.labels})
+        if self.comments:
+            review_input.update({'comments': self.comments})
+        return json.dumps(review_input)
diff --git a/unittests.py b/unittests.py
index d70b3d6..4c962cb 100755
--- a/unittests.py
+++ b/unittests.py
@@ -36,6 +36,7 @@ from pygerrit.events import PatchsetCreatedEvent, \
     ErrorEvent, MergeFailedEvent, ReviewerAddedEvent, TopicChangedEvent
 from pygerrit.client import GerritClient
 from pygerrit import GerritReviewMessageFormatter
+from pygerrit.rest import GerritReview
 
 EXPECTED_TEST_CASE_FIELDS = ['header', 'footer', 'paragraphs', 'result']
 
@@ -427,5 +428,43 @@ class TestGerritReviewMessageFormatter(unittest.TestCase):
                              "Formatted message does not match expected "
                              "result in test case #%d:\n[%s]" % (i, m))
 
+
+class TestGerritReview(unittest.TestCase):
+
+    """ Test that the GerritReview class behaves properly. """
+
+    def test_str(self):
+        """ Test for str function. """
+        obj = GerritReview()
+        self.assertEqual(str(obj), '{}')
+
+        obj2 = GerritReview(labels={'Verified': 1, 'Code-Review': -1})
+        self.assertEqual(
+            str(obj2),
+            '{"labels": {"Verified": 1, "Code-Review": -1}}')
+
+        obj3 = GerritReview(comments=[{'filename': 'Makefile',
+                                      'line': 10, 'message': 'test'}])
+        self.assertEqual(
+            str(obj3),
+            '{"comments": {"Makefile": [{"line": 10, "message": "test"}]}}')
+
+        obj4 = GerritReview(labels={'Verified': 1, 'Code-Review': -1},
+                            comments=[{'filename': 'Makefile', 'line': 10,
+                                       'message': 'test'}])
+        self.assertEqual(
+            str(obj4),
+            '{"labels": {"Verified": 1, "Code-Review": -1},'
+            ' "comments": {"Makefile": [{"line": 10, "message": "test"}]}}')
+
+        obj5 = GerritReview(comments=[{'filename': 'Makefile', 'line': 15,
+                            'message': 'test'}, {'filename': 'Make',
+                            'line': 10, 'message': 'test1'}])
+        self.assertEqual(
+            str(obj5),
+            '{"comments": {"Make": [{"line": 10, "message": "test1"}],'
+            ' "Makefile": [{"line": 15, "message": "test"}]}}')
+
+
 if __name__ == '__main__':
     unittest.main()