integrations: webhook, allow to set a custom header. Fixes #5384

rhodecode/integrations/types/webhook.py

@@ -29,6 +29,7 b' import colander'
 from celery.task import task
 from requests.packages.urllib3.util.retry import Retry
 
+import rhodecode
 from rhodecode import events
 from rhodecode.translation import _
 from rhodecode.integrations.types.base import IntegrationTypeBase
@@ -61,9 +62,10 b" URL_VARS = ', '.join('${' + x + '}' for "
 
 
 class WebhookHandler(object):
-    def __init__(self, template_url, secret_token):
+    def __init__(self, template_url, secret_token, headers):
         self.template_url = template_url
         self.secret_token = secret_token
+        self.headers = headers
 
     def get_base_parsed_template(self, data):
         """
@@ -117,18 +119,18 b' class WebhookHandler(object):'
                         # register per-commit call
                         log.debug(
                             'register webhook call(%s) to url %s', event, commit_url)
-                        url_cals.append((commit_url, self.secret_token, data))
+                        url_cals.append((commit_url, self.secret_token, self.headers, data))
 
                 else:
                     # register per-branch call
                     log.debug(
                         'register webhook call(%s) to url %s', event, branch_url)
-                    url_cals.append((branch_url, self.secret_token, data))
+                    url_cals.append((branch_url, self.secret_token, self.headers, data))
 
         else:
             log.debug(
                 'register webhook call(%s) to url %s', event, url)
-            url_cals.append((url, self.secret_token, data))
+            url_cals.append((url, self.secret_token, self.headers, data))
 
         return url_cals
 
@@ -136,7 +138,7 b' class WebhookHandler(object):'
         url = self.get_base_parsed_template(data)
         log.debug(
             'register webhook call(%s) to url %s', event, url)
-        return [(url, self.secret_token, data)]
+        return [(url, self.secret_token, self.headers, data)]
 
     def pull_request_event_handler(self, event, data):
         url = self.get_base_parsed_template(data)
@@ -145,7 +147,7 b' class WebhookHandler(object):'
         url = string.Template(url).safe_substitute(
             pull_request_id=data['pullrequest']['pull_request_id'],
             pull_request_url=data['pullrequest']['url'])
-        return [(url, self.secret_token, data)]
+        return [(url, self.secret_token, self.headers, data)]
 
     def __call__(self, event, data):
         if isinstance(event, events.RepoPushEvent):
@@ -178,11 +180,32 b' class WebhookSettingsSchema(colander.Sch'
     secret_token = colander.SchemaNode(
         colander.String(),
         title=_('Secret Token'),
-        description=_('String used to validate received payloads.'),
+        description=_('String used to validate received payloads. It will be '
+                      'sent together with event data in JSON'),
         default='',
         missing='',
         widget=deform.widget.TextInputWidget(
-            placeholder='secret_token'
+            placeholder='e.g. secret_token'
+        ),
+    )
+    custom_header_key = colander.SchemaNode(
+        colander.String(),
+        title=_('Custom Header Key'),
+        description=_('Custom Header name to be set when calling endpoint.'),
+        default='',
+        missing='',
+        widget=deform.widget.TextInputWidget(
+            placeholder='e.g.Authorization'
+        ),
+    )
+    custom_header_val = colander.SchemaNode(
+        colander.String(),
+        title=_('Custom Header Value'),
+        description=_('Custom Header value to be set when calling endpoint.'),
+        default='',
+        missing='',
+        widget=deform.widget.TextInputWidget(
+            placeholder='e.g. RcLogin auth=xxxx'
         ),
     )
     method_type = colander.SchemaNode(
@@ -245,7 +268,15 b' class WebhookIntegrationType(Integration'
         data = event.as_dict()
         template_url = self.settings['url']
 
-        handler = WebhookHandler(template_url, self.settings['secret_token'])
+        headers = {}
+        head_key = self.settings['custom_header_key']
+        head_val = self.settings['custom_header_val']
+        if head_key and head_val:
+            headers = {head_key: head_val}
+
+        handler = WebhookHandler(
+            template_url, self.settings['secret_token'], headers)
+
         url_calls = handler(event, data)
         log.debug('webhook: calling following urls: %s',
                   [x[0] for x in url_calls])
@@ -259,7 +290,12 b' def post_to_webhook(url_calls, settings)'
         total=max_retries,
         backoff_factor=0.15,
         status_forcelist=[500, 502, 503, 504])
-    for url, token, data in url_calls:
+    call_headers = {
+        'User-Agent': 'RhodeCode-webhook-caller/{}'.format(
+            rhodecode.__version__)
+    }  # updated below with custom ones, allows override
+
+    for url, token, headers, data in url_calls:
         req_session = requests.Session()
         req_session.mount(  # retry max N times
             'http://', requests.adapters.HTTPAdapter(max_retries=retries))
@@ -267,10 +303,14 b' def post_to_webhook(url_calls, settings)'
         method = settings.get('method_type') or 'post'
         call_method = getattr(req_session, method)
 
+        headers = headers or {}
+        call_headers.update(headers)
+
         log.debug('calling WEBHOOK with method: %s', call_method)
         resp = call_method(url, json={
             'token': token,
             'event': data
-        })
+        }, headers=call_headers)
         log.debug('Got WEBHOOK response: %s', resp)
+
         resp.raise_for_status()  # raise exception on a failed request

rhodecode/tests/integrations/test_webhook.py

@@ -44,7 +44,8 b' def base_data():'
 
 def test_webhook_parse_url_invalid_event():
     template_url = 'http://server.com/${repo_name}/build'
-    handler = WebhookHandler(template_url, 'secret_token')
+    handler = WebhookHandler(
+        template_url, 'secret_token', {'exmaple-header':'header-values'})
     with pytest.raises(ValueError) as err:
         handler(events.RepoDeleteEvent(''), {})
     assert str(err.value).startswith('event type not supported')
@@ -57,24 +58,32 b' def test_webhook_parse_url_invalid_event'
     ('http://server.com/${branch}/build', ['http://server.com/${branch}/build']),
 ])
 def test_webook_parse_url_for_create_event(base_data, template, expected_urls):
-    handler = WebhookHandler(template, 'secret_token')
+    headers = {'exmaple-header': 'header-values'}
+    handler = WebhookHandler(
+        template, 'secret_token', headers)
     urls = handler(events.RepoCreateEvent(''), base_data)
-    assert urls == [(url, 'secret_token', base_data) for url in expected_urls]
+    assert urls == [
+        (url, 'secret_token', headers, base_data) for url in expected_urls]
 
 
 @pytest.mark.parametrize('template,expected_urls', [
     ('http://server.com/${repo_name}/${pull_request_id}', ['http://server.com/foo/999']),
     ('http://server.com/${repo_name}/${pull_request_url}', ['http://server.com/foo/http://pr-url.com']),
 ])
-def test_webook_parse_url_for_pull_request_event(base_data, template, expected_urls):
+def test_webook_parse_url_for_pull_request_event(
+        base_data, template, expected_urls):
+
     base_data['pullrequest'] = {
         'pull_request_id': 999,
         'url': 'http://pr-url.com',
     }
-    handler = WebhookHandler(template, 'secret_token')
+    headers = {'exmaple-header': 'header-values'}
+    handler = WebhookHandler(
+        template, 'secret_token', headers)
     urls = handler(events.PullRequestCreateEvent(
         AttributeDict({'target_repo': 'foo'})), base_data)
-    assert urls == [(url, 'secret_token', base_data) for url in expected_urls]
+    assert urls == [
+        (url, 'secret_token', headers, base_data) for url in expected_urls]
 
 
 @pytest.mark.parametrize('template,expected_urls', [
@@ -85,7 +94,8 b' def test_webook_parse_url_for_pull_reque'
                                                   'http://server.com/dev/dev-xxx',
                                                   'http://server.com/dev/dev-yyy']),
 ])
-def test_webook_parse_url_for_push_event(pylonsapp, repo_push_event, base_data, template, expected_urls):
+def test_webook_parse_url_for_push_event(
+        pylonsapp, repo_push_event, base_data, template, expected_urls):
     base_data['push'] = {
         'branches': [{'name': 'stable'}, {'name': 'dev'}],
         'commits': [{'branch': 'stable', 'raw_id': 'stable-xxx'},
@@ -93,6 +103,9 b' def test_webook_parse_url_for_push_event'
                     {'branch': 'dev', 'raw_id': 'dev-xxx'},
                     {'branch': 'dev', 'raw_id': 'dev-yyy'}]
     }
-    handler = WebhookHandler(template, 'secret_token')
+    headers = {'exmaple-header': 'header-values'}
+    handler = WebhookHandler(
+        template, 'secret_token', headers)
     urls = handler(repo_push_event, base_data)
-    assert urls == [(url, 'secret_token', base_data) for url in expected_urls]
+    assert urls == [
+        (url, 'secret_token', headers, base_data) for url in expected_urls]