Add more appropriate unit tests

- 100% coverage
- no lint errors from flake8

Signed-off-by: Fred Phillips <[email protected]>

Author: Fred Phillips

github_webhook/__init__.py

@@ -8,7 +8,7 @@
     :license: Apache License, Version 2.0
 """
 
-from github_webhook.webhook import Webhook
+from github_webhook.webhook import Webhook  # noqa
 
 # -----------------------------------------------------------------------------
 # Copyright 2015 Bloomberg Finance L.P.

github_webhook/webhook.py

@@ -74,6 +74,7 @@ def _postreceive(self):
 
         return '', 204
 
+
 def _get_header(key):
     """Return message header"""
 
@@ -82,6 +83,7 @@ def _get_header(key):
     except KeyError:
         abort(400, 'Missing header: ' + key)
 
+
 EVENT_DESCRIPTIONS = {
     'commit_comment': '{comment[user][login]} commented on '
                       '{comment[commit_id]} in {repository[full_name]}',
@@ -110,7 +112,8 @@ def _get_header(key):
     'public': '{sender[login]} publicized {repository[full_name]}',
     'pull_request': '{sender[login]} {action} pull #{pull_request[number]} in '
                     '{repository[full_name]}',
-    'pull_request_review': '{sender[login]} {action} {review[state]} review on pull #{pull_request[number]} in '
+    'pull_request_review': '{sender[login]} {action} {review[state]} '
+                           'review on pull #{pull_request[number]} in '
                            '{repository[full_name]}',
     'pull_request_review_comment': '{comment[user][login]} {action} comment '
                                    'on pull #{pull_request[number]} in '
@@ -128,6 +131,7 @@ def _get_header(key):
              '{repository[full_name]}'
 }
 
+
 def _format_event(event_type, data):
     try:
         return EVENT_DESCRIPTIONS[event_type].format(**data)

tests/test_webhook.py

@@ -2,17 +2,51 @@
 
 from __future__ import print_function
 
+import pytest
+import werkzeug
 try:
-    from unittest.mock import Mock
+    from unittest import mock
 except ImportError:
-    from mock import Mock
+    import mock
 
 from github_webhook.webhook import Webhook
 
 
+@pytest.fixture
+def mock_request():
+    with mock.patch("github_webhook.webhook.request") as req:
+        req.headers = {
+            "X-Github-Delivery": ""
+        }
+        yield req
+
+
+@pytest.fixture
+def push_request(mock_request):
+    mock_request.headers["X-Github-Event"] = "push"
+    yield mock_request
+
+
+@pytest.fixture
+def app():
+    yield mock.Mock()
+
+
+@pytest.fixture
+def webhook(app):
+    yield Webhook(app)
+
+
+@pytest.fixture
+def handler(webhook):
+    handler = mock.Mock()
+    webhook.hook()(handler)
+    yield handler
+
+
 def test_constructor():
     # GIVEN
-    app = Mock()
+    app = mock.Mock()
 
     # WHEN
     webhook = Webhook(app)
@@ -24,6 +58,82 @@ def test_constructor():
         view_func=webhook._postreceive,
         methods=['POST'])
 
+
+def test_run_push_hook(webhook, handler, push_request):
+    # WHEN
+    webhook._postreceive()
+
+    # THEN
+    handler.assert_called_once_with(push_request.get_json.return_value)
+
+
+def test_do_not_run_push_hook_on_ping(webhook, handler, mock_request):
+    # GIVEN
+    mock_request.headers["X-Github-Event"] = "ping"
+
+    # WHEN
+    webhook._postreceive()
+
+    # THEN
+    handler.assert_not_called()
+
+
+def test_can_handle_zero_events(webhook, push_request):
+    # WHEN, THEN
+    webhook._postreceive()  # noop
+
+
+@pytest.mark.parametrize("secret", [
+    u"secret",
+    b"secret"
+])
+@mock.patch("github_webhook.webhook.hmac")
+def test_calls_if_signature_is_correct(mock_hmac, app, push_request, secret):
+    # GIVEN
+    webhook = Webhook(app, secret=secret)
+    push_request.headers["X-Hub-Signature"] = "sha1=hash_of_something"
+    push_request.data = b"something"
+    handler = mock.Mock()
+    mock_hmac.compare_digest.return_value = True
+
+    # WHEN
+    webhook.hook()(handler)
+    webhook._postreceive()
+
+    # THEN
+    handler.assert_called_once_with(push_request.get_json.return_value)
+
+
+@mock.patch("github_webhook.webhook.hmac")
+def test_does_not_call_if_signature_is_incorrect(mock_hmac, app, push_request):
+    # GIVEN
+    webhook = Webhook(app, secret="super_secret")
+    push_request.headers["X-Hub-Signature"] = "sha1=hash_of_something"
+    push_request.data = b"something"
+    handler = mock.Mock()
+    mock_hmac.compare_digest.return_value = False
+
+    # WHEN, THEN
+    webhook.hook()(handler)
+    with pytest.raises(werkzeug.exceptions.BadRequest):
+        webhook._postreceive()
+
+
+def test_request_has_no_data(webhook, handler, push_request):
+    # GIVEN
+    push_request.get_json.return_value = None
+
+    # WHEN, THEN
+    with pytest.raises(werkzeug.exceptions.BadRequest):
+        webhook._postreceive()
+
+
+def test_request_had_headers(webhook, handler, mock_request):
+    # WHEN, THEN
+    with pytest.raises(werkzeug.exceptions.BadRequest):
+        webhook._postreceive()
+
+
 # -----------------------------------------------------------------------------
 # Copyright 2015 Bloomberg Finance L.P.
 #

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py27,py36,pypy,pypy3
+envlist = py27,py36,pypy,pypy3,flake8
 
 [testenv]
 deps =
@@ -8,4 +8,11 @@ deps =
      flask
      six
      py{27,py}: mock
-commands = pytest -vl --cov=github_webhook --cov-report term-missing
+commands = pytest -vl --cov=github_webhook --cov-report term-missing --cov-fail-under 100
+
+[testenv:flake8]
+deps = flake8
+commands = flake8 github_webhook
+
+[flake8]
+max-line-length = 100