Added initial gitlab integration

Signed-off-by: Michael Engel <mengel@redhat.com>

Author: engelmi

requirements.txt

@@ -5,6 +5,7 @@ fedmsg
 fedora-messaging
 PyGithub
 pypandoc_binary
+python-gitlab
 urllib3
 jinja2
 flask

sync2jira/api/gitlab_client.py

@@ -0,0 +1,39 @@
+from gitlab import Gitlab
+
+
+class GitlabClient:
+
+    def __init__(self, url, token, project):
+        self.url = url
+        self.token = token
+        self.project = project
+        self._client = Gitlab(url=url, private_token=token)
+        self._project = self._client.get(self.project)
+
+    def fetch_issue(self, iid):
+        return self._project.issues.get(iid)
+
+    def fetch_notes_for_issue(self, iid):
+        issue = self.fetch_issue(iid)
+        return GitlabClient.map_notes_to_intermediary(issue.notes.list(all=True))
+
+    def fetch_mr(self, iid):
+        return self._project.mergerequests.get(iid)
+
+    def fetch_notes_for_mr(self, iid):
+        mr = self.fetch_mr(iid)
+        return GitlabClient.map_notes_to_intermediary(mr.notes.list(all=True))
+
+    @staticmethod
+    def map_notes_to_intermediary(notes):
+        return [
+            {
+                "author": note.author.username,
+                "name": note.author.name,
+                "body": note.body,
+                "id": note.id,
+                "date_created": note.created_at,
+                "changed": note.updated_at,
+            }
+            for note in notes
+        ]

sync2jira/handler/base.py

@@ -0,0 +1,23 @@
+import logging
+
+# Local Modules
+import sync2jira.handler.github as gh
+import sync2jira.handler.gitlab as gl
+
+log = logging.getLogger("sync2jira")
+
+
+def get_handler_for(suffix, topic, idx):
+    """
+    Function to check if a handler for given suffix is configured
+    :param String suffix: Incoming suffix
+    :param String topic: Topic of incoming message
+    :param String idx: Id of incoming message
+    :returns: Handler function if configured for suffix. Otherwise None.
+    """
+    if suffix.startswith("github"):
+        return gh.get_handler_for(suffix, topic, idx)
+    elif suffix.startswith("gitlab"):
+        return gl.get_handler_for(suffix, topic, idx)
+    log.info("Unsupported datasource %r", suffix)
+    return None

sync2jira/handler/github.py

@@ -10,10 +10,11 @@
 log = logging.getLogger("sync2jira")
 
 
-def handle_issue_msg(body, suffix, config):
+def handle_issue_msg(body, headers, suffix, config):
     """
     Function to handle incoming github issue message
     :param Dict body: Incoming message body
+    :param Dict headers: Incoming message headers
     :param String suffix: Incoming suffix
     :param Dict config: Config dict
     """
@@ -44,10 +45,11 @@ def handle_issue_msg(body, suffix, config):
             log.info("Not handling Issue update -- not configured")
 
 
-def handle_pr_msg(body, suffix, config):
+def handle_pr_msg(body, headers, suffix, config):
     """
     Function to handle incoming github PR message
     :param Dict body: Incoming message body
+    :param Dict headers: Incoming message headers
     :param String suffix: Incoming suffix
     :param Dict config: Config dict
     """
@@ -104,5 +106,5 @@ def get_handler_for(suffix, topic, idx):
         return issue_handlers.get(suffix)
     elif suffix in pr_handlers:
         return pr_handlers.get(suffix)
-    log.info("No handler for %r %r %r", suffix, topic, idx)
+    log.info("No github handler for %r %r %r", suffix, topic, idx)
     return None

sync2jira/handler/gitlab.py

@@ -0,0 +1,136 @@
+import logging
+
+from sync2jira.api.gitlab_client import GitlabClient
+import sync2jira.downstream_issue as d_issue
+import sync2jira.downstream_pr as d_pr
+
+# Local Modules
+import sync2jira.intermediary as i
+
+log = logging.getLogger("sync2jira")
+
+
+def should_sync(upstream, labels, config, event_type):
+    mapped_repos = config["sync2jira"]["map"]["gitlab"]
+    if upstream not in mapped_repos:
+        log.debug("%r not in Gitlab map: %r", upstream, mapped_repos.keys())
+        return None
+    if event_type not in mapped_repos[upstream].get("sync", []):
+        log.debug(
+            "%r not in Gitlab sync map: %r",
+            event_type,
+            mapped_repos[upstream].get("sync", []),
+        )
+        return None
+
+    _filter = config["sync2jira"].get("filters", {}).get("gitlab", {}).get(upstream, {})
+    for key, expected in _filter.items():
+        if key == "labels":
+            if labels.isdisjoint(expected):
+                log.debug("Labels %s not found on issue: %s", expected, upstream)
+                return None
+
+
+def handle_gitlab_issue(body, headers, config, suffix):
+    """
+    Handle GitLab issue from FedMsg.
+
+    :param Dict body: FedMsg Message body
+    :param Dict body: FedMsg Message headers
+    :param Dict config: Config File
+    :param Bool is_pr: msg refers to a pull request
+    """
+    upstream = body["project"]["path_with_namespace"]
+    url = headers["x-gitlab-instance"]
+    token = config["sync2jira"].get("github_token")
+    labels = {label["title"] for label in body.get("labels", [])}
+    iid = body.get("object_attributes").get("iid")
+
+    if should_sync(upstream, labels, config, "issue"):
+        sync_gitlab_issue(GitlabClient(url, token, upstream), iid, upstream, config)
+
+
+def handle_gitlab_note(body, headers, config, suffix):
+    """
+    Handle Gitlab note from FedMsg.
+
+    :param Dict body: FedMsg Message body
+    :param Dict body: FedMsg Message headers
+    :param Dict config: Config File
+    :param String suffix: FedMsg suffix
+    """
+    upstream = body["project"]["path_with_namespace"]
+    url = headers["x-gitlab-instance"]
+    token = config["sync2jira"].get("github_token")
+
+    if "merge_request" in body:
+        labels = {
+            label["title"] for label in body.get("merge_request").get("labels", [])
+        }
+        iid = body.get("merge_request").get("iid")
+
+        if should_sync(upstream, labels, config, "issue"):
+            sync_gitlab_mr(GitlabClient(url, token, upstream), iid, upstream)
+    if "issue" in body:
+        labels = {label["title"] for label in body.get("issue").get("labels", [])}
+        iid = body.get("issue").get("iid")
+
+        if should_sync(upstream, labels, config, "pullrequest"):
+            sync_gitlab_issue(GitlabClient(url, token, upstream), iid, upstream)
+    log.info("Note was not added to an issue or merge request. Skipping note event.")
+
+
+def handle_gitlab_mr(body, headers, config, suffix):
+    """
+    Handle Gitlab merge request from FedMsg.
+
+    :param Dict body: FedMsg Message body
+    :param Dict body: FedMsg Message headers
+    :param Dict config: Config File
+    :param String suffix: FedMsg suffix
+    """
+    upstream = body["project"]["path_with_namespace"]
+    url = headers["x-gitlab-instance"]
+    token = config["sync2jira"].get("github_token")
+    labels = {label["title"] for label in body.get("labels", [])}
+    iid = body.get("object_attributes").get("iid")
+
+    if should_sync(upstream, labels, config, "pullrequest"):
+        sync_gitlab_mr(GitlabClient(url, token, upstream), iid, upstream, config)
+
+
+def sync_gitlab_issue(client, iid, upstream, config):
+    gitlab_issue = client.fetch_issue(iid)
+    comments = gitlab_issue.notes.list(all=True)
+
+    issue = i.Issue.from_gitlab(gitlab_issue, comments, upstream, config)
+    d_issue.sync_with_jira(issue, config)
+
+
+def sync_gitlab_mr(client, iid, upstream, config):
+    gitlab_mr = client.fetch_mr(iid)
+    comments = gitlab_mr.notes.list(all=True)
+
+    mr = i.PR.from_gitlab(gitlab_mr, comments, upstream, config)
+    d_pr.sync_with_jira(mr, config)
+
+
+handlers = {
+    "gitlab.issues": handle_gitlab_issue,
+    "gitlab.issue_comment": handle_gitlab_mr,
+    "gitlab.note": handle_gitlab_note,
+}
+
+
+def get_handler_for(suffix, topic, idx):
+    """
+    Function to check if a handler for given suffix is configured
+    :param String suffix: Incoming suffix
+    :param String topic: Topic of incoming message
+    :param String idx: Id of incoming message
+    :returns: Handler function if configured for suffix. Otherwise None.
+    """
+    if suffix in handlers:
+        return handlers.get(suffix)
+    log.info("No gitlab handler for %r %r %r", suffix, topic, idx)
+    return None

sync2jira/intermediary.py

@@ -86,7 +86,7 @@ def upstream_title(self):
 
     @classmethod
     def from_github(cls, upstream, issue, config):
-        """Helper function to create an intermediary Issue object."""
+        """Helper function to create an intermediary Issue object from Github."""
         upstream_source = "github"
         comments = reformat_github_comments(issue)
 
@@ -131,6 +131,41 @@ def from_github(cls, upstream, issue, config):
             issue_type=issue_type,
         )
 
+    @classmethod
+    def from_gitlab(cls, issue, comments, upstream, config):
+        """Helper function to create an intermediary Issue object from Gitlab."""
+        upstream_source = "gitlab"
+
+        # Reformat the state field
+        issue_status = issue.state
+        if issue_status == "open":
+            issue_status = "Open"
+        elif issue_status == "closed":
+            issue_status = "Closed"
+
+        return cls(
+            source=upstream_source,
+            title=issue.title,
+            url=issue.web_url,
+            upstream=upstream,
+            config=config,
+            comments=reformat_gitlab_comments(comments),
+            tags=issue.labels,
+            fixVersion="" if not issue.milestone else issue.milestone.id,
+            priority="",
+            content=issue.description,
+            reporter={"login": issue.author.username, "fullname": issue.author.name},
+            assignee=[
+                {"login": entry.username, "fullname": entry.name}
+                for entry in issue.assignees
+            ],
+            status=issue_status,
+            id_=issue.id,
+            storypoints="",
+            upstream_id=issue.iid,
+            issue_type=issue.type,
+        )
+
     def __repr__(self):
         return f"<Issue {self.url} >"
 
@@ -248,6 +283,54 @@ def from_github(cls, upstream, pr, suffix, config):
             match=match,
         )
 
+    @classmethod
+    def from_gitlab(cls, pr, comments, upstream, config):
+        """Helper function to create an intermediary PR object from gitlab"""
+        upstream_source = "github"
+        reformatted_comments = reformat_gitlab_comments(comments)
+
+        # Match to a JIRA
+        match = matcher(pr.description, reformatted_comments)
+
+        # Return our PR object
+        return cls(
+            source=upstream_source,
+            jira_key=match,
+            title=pr.title,
+            url=pr.web_url,
+            upstream=upstream,
+            config=config,
+            comments=reformatted_comments,
+            # tags=issue['labels'],
+            # fixVersion=[issue['milestone']],
+            priority=None,
+            content=pr.description,
+            reporter=pr.author.name,
+            assignee={
+                "login": pr.assignee.username
+            },  # used like this in jira sync code
+            # GitHub PRs do not have status
+            status=None,
+            id_=pr.iid,
+            # upstream_id=issue['number'],
+            suffix=pr.state,
+            match=match,
+        )
+
+
+def reformat_gitlab_comments(comments):
+    return [
+        {
+            "author": comment.author.name,
+            "name": comment.author.username,
+            "body": trim_string(comment.body),
+            "id": comment.id,
+            "date_created": comment.created_at,
+            "changed": comment.updated_at,
+        }
+        for comment in comments
+    ]
+
 
 def reformat_github_comments(issue):
     return [