integrations: Add webhook code, API endpoint, and tests for solano labs.

zerver/lib/integrations.py

@@ -140,6 +140,7 @@ WEBHOOK_INTEGRATIONS = [
     WebhookIntegration('pivotal', display_name='Pivotal Tracker'),
     WebhookIntegration('semaphore'),
     WebhookIntegration('sentry'),
+    WebhookIntegration('solano', display_name='Solano Labs'),
     WebhookIntegration('stash'),
     WebhookIntegration('stripe', display_name='Stripe'),
     WebhookIntegration('taiga'),

zerver/tests/webhooks/test_solano.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+from typing import Text
+from six.moves import urllib
+from zerver.lib.test_classes import WebhookTestCase
+
+class SolanoHookTests(WebhookTestCase):
+    STREAM_NAME = 'solano labs'
+    URL_TEMPLATE = u"/api/v1/external/solano?api_key={api_key}"
+    FIXTURE_DIR_NAME = 'solano'
+
+    def test_solano_message_001(self):
+        # type: () -> None
+        """
+        Build notifications are generated by Solano Labs after build completes.
+        """
+        expected_topic = u'build update'
+        expected_message = (u"Author: solano-ci[bot]@users.noreply.github.com\n"
+                            u"Commit: [5f438401eb7cc7268cbc28438bfa70bb99f48a03]"
+                            u"(github.com/fazerlicourice7/solano/commit/5f438401eb7cc7268"
+                            u"cbc28438bfa70bb99f48a03)\nBuild status: failed :thumbsdown:\n"
+                            u"[Build Log](https://ci.solanolabs.com:443/reports/3316175)")
+
+        self.send_and_test_stream_message('build_001', expected_topic, expected_message,
+                                          content_type="application/x-www-form-urlencoded")
+
+    def test_solano_message_002(self):
+        # type: () -> None
+        """
+        Build notifications are generated by Solano Labs after build completes.
+        """
+        expected_topic = u'build update'
+        expected_message = (u"Author: Unknown\nCommit: [5d0b92e26448a9e91db794bfed4b8c3556eabc4e]"
+                            u"(bitbucket.org/fazerlicourice7/test/commits/5d0b92e26448a9e91db794bfed"
+                            u"4b8c3556eabc4e)\nBuild status: failed :thumbsdown:\n"
+                            u"[Build Log](https://ci.solanolabs.com:443/reports/3316723)")
+
+        self.send_and_test_stream_message('build_002', expected_topic, expected_message,
+                                          content_type="application/x-www-form-urlencoded")
+
+    def get_body(self, fixture_name):
+        # type: (Text) -> Text
+        return self.fixture_data(self.FIXTURE_DIR_NAME, fixture_name, file_type="json")

zerver/views/webhooks/solano.py

@@ -0,0 +1,65 @@
+# Webhooks for external integrations.
+from __future__ import absolute_import
+
+from django.http import HttpRequest, HttpResponse
+from django.utils.translation import ugettext as _
+
+from zerver.decorator import REQ, has_request_variables, api_key_only_webhook_view
+from zerver.lib.actions import check_send_message
+from zerver.lib.response import json_success, json_error
+from zerver.lib.validator import check_dict, check_list, check_string
+from zerver.models import UserProfile, Client
+
+from typing import Any, Callable, Optional
+import ujson
+
+
+@api_key_only_webhook_view('SolanoLabs')
+@has_request_variables
+def api_solano_webhook(request, user_profile, client,
+                       stream=REQ(default='solano labs'),
+                       topic=REQ(default='build update'),
+                       payload=REQ(argument_type='body')):
+    # type: (HttpRequest, UserProfile, Client, str, str, Dict[str, Any]) -> HttpResponse
+    try:
+        try:
+            author = payload['committers'][0]
+        except KeyError:
+            author = 'Unknown'
+        status = payload['status']
+        build_log = payload['url']
+        repository = payload['repository']['url']
+        commit_id = payload['commit_id']
+    except KeyError as e:
+        return json_error(_('Missing key {} in JSON').format(str(e)))
+
+    good_status = ['passed']
+    bad_status  = ['failed', 'error']
+    emoji = ''
+    if status in good_status:
+        emoji = ':thumbsup:'
+    elif status in bad_status:
+        emoji = ':thumbsdown:'
+    else:
+        emoji = "(No emoji specified for status '%s'.)" % (status)
+
+    template = (
+        u'Author: {}\n'
+        u'Commit: [{}]({})\n'
+        u'Build status: {} {}\n'
+        u'[Build Log]({})')
+
+    # If the service is not one of the following, the url is of the repository home, not the individual
+    # commit itself.
+    commit_url = repository.split('@')[1]
+    if 'github' in repository:
+        commit_url += '/commit/{}'.format(commit_id)
+    elif 'bitbucket' in repository:
+        commit_url += '/commits/{}'.format(commit_id)
+    elif 'gitlab' in repository:
+        commit_url += '/pipelines/{}'.format(commit_id)
+
+    body = template.format(author, commit_id, commit_url, status, emoji, build_log)
+
+    check_send_message(user_profile, client, 'stream', [stream], topic, body)
+    return json_success()