[BITBUCKET] Add support for Code Insights annotations (atlassian-api#786)

* [BITBUCKET] Add support for Code Insights annotations

This commit will allow users to extend Code Insight reports
with additional code annotations.

* fixup! [BITBUCKET] Add support for Code Insights annotations

* fixup! [BITBUCKET] Add support for Code Insights annotations

Author: KevinDeJong-TomTom

atlassian/bitbucket/__init__.py

@@ -1817,6 +1817,33 @@ def get_changelog(self, project_key, repository_slug, ref_from, ref_to, start=0,
             params["limit"] = limit
         return self._get_paged(url, params=params)
 
+    def _url_code_insights_annotations(self, project_key, repository_slug, commit_id, report_key):
+        return "{}/reports/{}/annotations".format(
+            self._url_commit(
+                project_key,
+                repository_slug,
+                commit_id,
+                api_root="rest/insights",
+                api_version="1.0",
+            ),
+            report_key,
+        )
+
+    def add_code_insights_annotations_to_report(self, project_key, repository_slug, commit_id, report_key, annotations):
+        """
+        Adds annotations to an existing insight report.
+        For further information visit:
+        https://docs.atlassian.com/bitbucket-server/rest/6.6.1/bitbucket-code-insights-rest.html
+        :project_key: str
+        :repository_slug: str
+        :commit_id: str
+        :report_key: str
+        :annotations: list
+        """
+        url = self._url_code_insights_annotations(project_key, repository_slug, commit_id, report_key)
+        data = {"annotations": annotations}
+        return self.post(url, data=data)
+
     def _url_code_insights_report(self, project_key, repository_slug, commit_id, report_key):
         return "{}/reports/{}".format(
             self._url_commit(

docs/bitbucket.rst

@@ -98,6 +98,42 @@ Manage repositories
     # Delete a repository (DANGER!)
     bitbucket.delete_repo(project_key, repository_slug)
 
+Manage Code Insights
+--------------------
+
+.. code-block:: python
+
+    # Delete an existing Code Insights report
+    bitbucket.delete_code_insights_report(project_key, repository_slug, commit_hash, report_key)
+
+    # Create a new Code Insights report
+    report = {
+        'details': 'This is an example report',
+        'result': 'FAIL',
+        'reporter': 'Anonymous',
+        'link': 'http://some-url',
+        'logo-url': 'http://some-url',
+        'data': [
+            {
+                'title': 'Example coverage',
+                'type': 'PERCENTAGE',
+                'value': 85
+            }
+        ]
+    }
+    bitbucket.create_code_insights_report(project_key, repository_slug, commit_hash, report_key, 'Code Insights Report', **report)
+
+    # Add annotations to a Code Insights report
+    annotations = [
+        {
+        'path': 'some/path/to/file',
+        'line': 32,
+        'message': 'Roses are red, Violets are blue, Unexpected { on line 32',
+        'severity': 'MEDIUM'
+        }
+    ]
+    bitbucket.add_code_insights_annotations_to_report(project_key, repository_slug, commit_hash, report_key, **annotations)
+
 Groups and admins
 -----------------