Fix #526 -- Add a webhook system (#1073)

- [x] Data model
- [x] UI
- [x] Fire hooks
- [x] Unit tests
- [x] Display logs
- [x] API to modify hooks
- [x] Documentation
- [x] More hooks!

src/tests/control/test_checkins.py

@@ -262,7 +262,7 @@ def test_manual_checkins(client, checkin_list_env):
     })
     assert checkin_list_env[5][3].checkins.exists()
     assert LogEntry.objects.filter(
-        action_type='pretix.control.views.checkin', object_id=checkin_list_env[5][3].order.pk
+        action_type='pretix.event.checkin', object_id=checkin_list_env[5][3].order.pk
     ).exists()
 
 
@@ -279,10 +279,10 @@ def test_manual_checkins_revert(client, checkin_list_env):
     })
     assert not checkin_list_env[5][3].checkins.exists()
     assert LogEntry.objects.filter(
-        action_type='pretix.control.views.checkin', object_id=checkin_list_env[5][3].order.pk
+        action_type='pretix.event.checkin', object_id=checkin_list_env[5][3].order.pk
     ).exists()
     assert LogEntry.objects.filter(
-        action_type='pretix.control.views.checkin.reverted', object_id=checkin_list_env[5][3].order.pk
+        action_type='pretix.event.checkin.reverted', object_id=checkin_list_env[5][3].order.pk
     ).exists()
 
 

src/tests/control/test_permissions.py

@@ -137,6 +137,10 @@ organizer_urls = [
     'organizer/abc/device/1/edit',
     'organizer/abc/device/1/connect',
     'organizer/abc/device/1/revoke',
+    'organizer/abc/webhooks',
+    'organizer/abc/webhook/add',
+    'organizer/abc/webhook/1/edit',
+    'organizer/abc/webhook/1/logs',
 ]
 
 
@@ -378,6 +382,15 @@ organizer_permission_urls = [
     ("can_change_teams", "organizer/dummy/team/1/delete", 200),
     ("can_change_organizer_settings", "organizer/dummy/edit", 200),
     ("can_change_organizer_settings", "organizer/dummy/settings/display", 200),
+    ("can_change_organizer_settings", "organizer/dummy/devices", 200),
+    ("can_change_organizer_settings", "organizer/dummy/device/add", 200),
+    ("can_change_organizer_settings", "organizer/dummy/device/1/edit", 404),
+    ("can_change_organizer_settings", "organizer/dummy/device/1/connect", 404),
+    ("can_change_organizer_settings", "organizer/dummy/device/1/revoke", 404),
+    ("can_change_organizer_settings", "organizer/dummy/webhooks", 200),
+    ("can_change_organizer_settings", "organizer/dummy/webhook/add", 200),
+    ("can_change_organizer_settings", "organizer/dummy/webhook/1/edit", 404),
+    ("can_change_organizer_settings", "organizer/dummy/webhook/1/logs", 404),
 ]
 
 

src/tests/control/test_views.py

@@ -100,6 +100,7 @@ def logged_in_client(client, event):
     ('/control/organizer/{orga}/edit', 200),
     ('/control/organizer/{orga}/teams', 200),
     ('/control/organizer/{orga}/devices', 200),
+    ('/control/organizer/{orga}/webhooks', 200),
 
     ('/control/events/', 200),
     ('/control/events/add', 200),

src/tests/control/test_webhooks.py

@@ -0,0 +1,101 @@
+import pytest
+from django.utils.timezone import now
+
+from pretix.api.models import WebHook
+from pretix.base.models import Event, Organizer, Team, User
+
+
+@pytest.fixture
+def organizer():
+    return Organizer.objects.create(name='Dummy', slug='dummy')
+
+
+@pytest.fixture
+def event(organizer):
+    event = Event.objects.create(
+        organizer=organizer, name='Dummy', slug='dummy',
+        date_from=now()
+    )
+    return event
+
+
+@pytest.fixture
+def webhook(organizer, event):
+    wh = organizer.webhooks.create(
+        enabled=True,
+        target_url='https://google.com',
+        all_events=False
+    )
+    wh.limit_events.add(event)
+    wh.listeners.create(action_type='pretix.event.order.placed')
+    wh.listeners.create(action_type='pretix.event.order.paid')
+    return wh
+
+
+@pytest.fixture
+def admin_user(admin_team):
+    u = User.objects.create_user('dummy@dummy.dummy', 'dummy')
+    admin_team.members.add(u)
+    return u
+
+
+@pytest.fixture
+def admin_team(organizer):
+    return Team.objects.create(organizer=organizer, can_change_organizer_settings=True, name='Admin team')
+
+
+@pytest.mark.django_db
+def test_list_of_webhooks(event, admin_user, client, webhook):
+    client.login(email='dummy@dummy.dummy', password='dummy')
+    resp = client.get('/control/organizer/dummy/webhooks')
+    assert 'https://google.com' in resp.rendered_content
+
+
+@pytest.mark.django_db
+def test_create_webhook(event, admin_user, admin_team, client):
+    client.login(email='dummy@dummy.dummy', password='dummy')
+    client.post('/control/organizer/dummy/webhook/add', {
+        'target_url': 'https://google.com',
+        'enabled': 'on',
+        'events': 'pretix.event.order.paid',
+        'limit_events': str(event.pk),
+    }, follow=True)
+    w = WebHook.objects.last()
+    assert w.target_url == "https://google.com"
+    assert w.limit_events.count() == 1
+    assert list(w.listeners.values_list('action_type', flat=True)) == ['pretix.event.order.paid']
+    assert not w.all_events
+
+
+@pytest.mark.django_db
+def test_update_webhook(event, admin_user, admin_team, webhook, client):
+    client.login(email='dummy@dummy.dummy', password='dummy')
+    client.post('/control/organizer/dummy/webhook/{}/edit'.format(webhook.pk), {
+        'target_url': 'https://google.com',
+        'enabled': 'on',
+        'events': ['pretix.event.order.paid', 'pretix.event.order.canceled'],
+        'limit_events': str(event.pk),
+    }, follow=True)
+    webhook.refresh_from_db()
+    assert webhook.target_url == "https://google.com"
+    assert webhook.limit_events.count() == 1
+    assert list(webhook.listeners.values_list('action_type', flat=True)) == ['pretix.event.order.canceled',
+                                                                             'pretix.event.order.paid']
+    assert not webhook.all_events
+
+
+@pytest.mark.django_db
+def test_webhook_logs(event, admin_user, admin_team, webhook, client):
+    client.login(email='dummy@dummy.dummy', password='dummy')
+    webhook.calls.create(
+        webhook=webhook,
+        action_type='pretix.event.order.paid',
+        target_url=webhook.target_url,
+        is_retry=False,
+        execution_time=2,
+        return_code=0,
+        payload='foo',
+        response_body='bar'
+    )
+    resp = client.get('/control/organizer/dummy/webhook/{}/logs'.format(webhook.pk))
+    assert 'pretix.event.order.paid' in resp.rendered_content