Merge pull request #18 from saitho/feature/gitea-support

Gitea support

Author: tf

README.md

@@ -2,18 +2,21 @@
 
 [![Build Status](https://travis-ci.org/tf/redmine_merge_request_links.svg?branch=master)](https://travis-ci.org/tf/redmine_merge_request_links)
 
-Display links to associated GitLab merge requests and GitHub pull
-requests on Redmine's issue page.
+Display links to associated merge requests and pull requests on Redmine's issue page.
 
-Intercepts webhooks and parses merge request descriptions for
-mentioned issue ids.
+Intercepts webhooks and parses merge request descriptions for mentioned issue ids.
+
+The following platforms are supported:
+
+* GitHub
+* GitLab
+* Gitea
 
 
 ## Requirements
 
 * Redmine 3 (tested with 3.4.6)
 
-
 ## Installation
 
 Copy plugin directoy to `{RAILS_APP}/plugins` on your Redmine
@@ -82,6 +85,24 @@ Create a webhook in GitLab or GitHub as described here:
 
 * Click "Add webhook".
 
+### Gitea
+
+* Go to the webhook page of a project or organization.
+
+* Enter the URL of your Redmine instance
+  `https://redmine.example.com/merge_requests/event`.
+
+* Select `application/json` as content type.
+
+* Enter the secret token you defined in environment variable
+  `REDMINE_MERGE_REQUEST_LINKS_GITEA_WEBHOOK_TOKEN`.
+
+* Choose "Custom events...".
+
+* Check the "Pull requests" event.
+
+* Click "Add webhook".
+
 ### Redmine
 
 To display associated merge requests on issue pages:
@@ -101,7 +122,7 @@ on the issue's Redmine page.
 
 ## Known Issues
 
-* Gitlab only passes the author id as part of the merge request
+* GitLab only passes the author id as part of the merge request
   webhook not a display name. It does include the username of the user
   whose action triggered the webhook, though. To prevent having to
   fetch the author name in a separate REST API call, this username is

lib/redmine_merge_request_links.rb

@@ -3,9 +3,11 @@
 module RedmineMergeRequestLinks
   github_token = ENV['REDMINE_MERGE_REQUEST_LINKS_GITHUB_WEBHOOK_TOKEN']
   gitlab_token = ENV['REDMINE_MERGE_REQUEST_LINKS_GITLAB_WEBHOOK_TOKEN']
+  gitea_token  = ENV['REDMINE_MERGE_REQUEST_LINKS_GITEA_WEBHOOK_TOKEN']
 
   mattr_accessor :event_handlers
   self.event_handlers = [
+    RedmineMergeRequestLinks::EventHandlers::Gitea.new(token: gitea_token),
     RedmineMergeRequestLinks::EventHandlers::Github.new(token: github_token),
     RedmineMergeRequestLinks::EventHandlers::Gitlab.new(token: gitlab_token)
   ]

lib/redmine_merge_request_links/event_handlers/gitea.rb

@@ -0,0 +1,51 @@
+module RedmineMergeRequestLinks
+  module EventHandlers
+    class Gitea
+      def initialize(token:)
+        @token = token
+      end
+
+      def matches?(request)
+        request.headers['X-Gitea-Event'] == 'pull_request'
+      end
+
+      def verify(request)
+        request.body.rewind
+        payload = request.body.read
+
+        signature = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'),
+                                            @token,
+                                            payload)
+
+        Rack::Utils.secure_compare(signature,
+                                   request.headers['X-Gitea-Signature'])
+      end
+
+      def parse_params(params)
+        params
+          .require(:pull_request)
+          .permit(:state, :merged, :html_url, :title, :body, :number,
+                  user: :login,
+                  base: { repo: :full_name }).tap do |attributes|
+
+          merged = attributes.delete(:merged)
+          user = attributes.delete(:user) || {}
+          base = attributes.delete(:base) || {}
+          repo = base.fetch(:repo, {})
+
+          if attributes[:state] == 'closed' && merged
+            attributes[:state] = 'merged'
+          end
+
+          attributes[:provider] = 'gitea'
+          attributes[:url] = attributes.delete(:html_url)
+          attributes[:description] = attributes.delete(:body)
+          attributes[:author_name] = "@#{user[:login]}"
+
+          attributes[:display_id] =
+            "#{repo[:full_name]}##{attributes.delete(:number)}"
+        end
+      end
+    end
+  end
+end

test/functional/merge_requests_controller_test.rb

@@ -10,6 +10,7 @@ class MergeRequestsControllerTest < ActionController::TestCase
 
   def setup
     RedmineMergeRequestLinks.event_handlers = [
+      RedmineMergeRequestLinks::EventHandlers::Gitea.new(token: TOKEN),
       RedmineMergeRequestLinks::EventHandlers::Github.new(token: TOKEN),
       RedmineMergeRequestLinks::EventHandlers::Gitlab.new(token: TOKEN)
     ]
@@ -348,6 +349,164 @@ def test_sets_state_to_merged_if_closed_and_merged
     assert_equal 'merged', merge_request.state
   end
 
+  def test_gitea_pull_request_event_creates_merge_request
+    url = 'https://gitea.com/Codertocat/Hello-World/pull/1'
+
+    payload = {
+      pull_request: {
+        html_url: url,
+        title: 'Some pull request',
+        state: 'closed',
+        number: 12,
+        user: {
+          login: 'someuser'
+        },
+        base: {
+          repo: {
+            full_name: 'group/project'
+          }
+        }
+      }
+    }
+    request.headers['X-Gitea-Event'] = 'pull_request'
+    request.headers['X-GitHub-Event'] = 'pull_request'
+    request.headers['X-Gogs-Event'] = 'pull_request'
+    request.headers['X-Gitea-Signature'] = gitea_signature(payload)
+    request.headers['X-Gogs-Signature'] = gitea_signature(payload)
+
+    post(:event, payload)
+
+    assert_response :success
+
+    merge_request = MergeRequest.where(url: url).first
+    assert merge_request.present?
+    assert_equal 'closed', merge_request.state
+    assert_equal 'Some pull request', merge_request.title
+    assert_equal 'group/project#12', merge_request.display_id
+    assert_equal '@someuser', merge_request.author_name
+    assert_equal 'gitea', merge_request.provider
+  end
+
+  def test_responds_with_forbidden_if_gitea_signature_is_incorrect
+    request.headers['X-Gitea-Event'] = 'pull_request'
+    request.headers['X-Gitea-Signature'] = 'wrong'
+    request.headers['X-Gogs-Event'] = 'pull_request'
+    request.headers['X-Gogs-Signature'] = 'wrong'
+    post(:event, pull_request: {
+           html_url: 'https://gitea.com/Codertocat/Hello-World/pull/1',
+           title: 'Some pull request',
+           state: 'closed',
+           number: 12,
+           user: {
+             login: 'someuser'
+           },
+           base: {
+             repo: {
+               full_name: 'group/project'
+             }
+           }
+         })
+
+    assert_response :forbidden
+  end
+
+  def test_associates_issues_mentioned_in_gitea_pr_body
+    url = 'https://gitea.com/Codertocat/Hello-World/pull/1'
+    issue = Issue.last
+
+    payload = {
+      pull_request: {
+        html_url: url,
+        title: 'Some pull request',
+        state: 'closed',
+        body: "Talks about ##{issue.id}",
+        number: 12,
+        user: {
+          login: 'someuser'
+        },
+        base: {
+          repo: {
+            full_name: 'group/project'
+          }
+        }
+      }
+    }
+    request.headers['X-Gitea-Event'] = 'pull_request'
+    request.headers['X-GitHub-Event'] = 'pull_request'
+    request.headers['X-Gogs-Event'] = 'pull_request'
+    request.headers['X-Gitea-Signature'] = gitea_signature(payload)
+    request.headers['X-Gogs-Signature'] = gitea_signature(payload)
+    post(:event, payload)
+
+    merge_request = MergeRequest.where(url: url).first
+    assert_includes(merge_request.issues, issue)
+  end
+
+  def test_associates_issues_mentioned_in_gitea_pr_title
+    url = 'https://gitea.com/Codertocat/Hello-World/pull/1'
+    issue = Issue.last
+
+    payload = {
+      pull_request: {
+        html_url: url,
+        title: "Some pull request (##{issue.id})",
+        state: 'closed',
+        body: 'Some text',
+        number: 12,
+        user: {
+          login: 'someuser'
+        },
+        base: {
+          repo: {
+            full_name: 'group/project'
+          }
+        }
+      }
+    }
+    request.headers['X-Gitea-Event'] = 'pull_request'
+    request.headers['X-GitHub-Event'] = 'pull_request'
+    request.headers['X-Gogs-Event'] = 'pull_request'
+    request.headers['X-Gitea-Signature'] = gitea_signature(payload)
+    request.headers['X-Gogs-Signature'] = gitea_signature(payload)
+    post(:event, payload)
+
+    merge_request = MergeRequest.where(url: url).first
+    assert_includes(merge_request.issues, issue)
+  end
+
+  def test_sets_state_to_merged_if_gitea_pr_is_closed_and_merged
+    url = 'https://gitea.com/Codertocat/Hello-World/pull/1'
+
+    payload = {
+      pull_request: {
+        html_url: url,
+        title: 'Some pull request',
+        state: 'closed',
+        merged: true,
+        number: 12,
+        user: {
+          login: 'someuser'
+        },
+        base: {
+          repo: {
+            full_name: 'group/project'
+          }
+        }
+      }
+    }
+    request.headers['X-Gitea-Event'] = 'pull_request'
+    request.headers['X-GitHub-Event'] = 'pull_request'
+    request.headers['X-Gogs-Event'] = 'pull_request'
+    request.headers['X-Gitea-Signature'] = gitea_signature(payload)
+    request.headers['X-Gogs-Signature'] = gitea_signature(payload)
+    post(:event, payload)
+
+    assert_response :success
+
+    merge_request = MergeRequest.where(url: url).first
+    assert_equal 'merged', merge_request.state
+  end
+
   def test_responds_with_bad_request_if_unknown_event
     post(:event)
 
@@ -361,4 +520,10 @@ def hub_signature(payload)
                                       TOKEN,
                                       payload.to_query)
   end
+
+  def gitea_signature(payload)
+    OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'),
+                                      TOKEN,
+                                      payload.to_query)
+  end
 end