mirror of
https://github.com/zulip/zulip.git
synced 2025-11-11 17:36:27 +00:00
676f0ad63f
Adds a new webhook integration for WordPress blogs. Both WordPress.com and self-installed blogs are supported, with minor differences that are described in the documentation. It creates a new message for each action, the stream and topic may be specified or use default values. WordPress actions supported: publish_post: a new blog post was published publish_page: a new page was published user_register: a new user account was created wp_login: a user logged in Notes: comment_post only provides the id of the parent post, not title or link, so was not included. On further testing, I found edit_post is not very practical, it also fires while a new post is being written, and when posts are deleted. (I think it tracks drafts too.) I've removed it, as it seems more confusing than useful. Fixes #3245
102 lines
4.4 KiB
Python
102 lines
4.4 KiB
Python
# -*- coding: utf-8 -*-
|
|
from six import text_type
|
|
from zerver.lib.test_classes import WebhookTestCase
|
|
|
|
class WordPressHookTests(WebhookTestCase):
|
|
STREAM_NAME = 'wordpress'
|
|
URL_TEMPLATE = "/api/v1/external/wordpress?api_key={api_key}"
|
|
FIXTURE_DIR_NAME = 'wordpress'
|
|
|
|
def test_publish_post(self):
|
|
# type: () -> None
|
|
|
|
expected_topic = u"WordPress Post"
|
|
expected_message = u"New post published.\n[New Blog Post](http://example.com\n)"
|
|
|
|
self.send_and_test_stream_message('publish_post', expected_topic, expected_message,
|
|
content_type="application/x-www-form-urlencoded")
|
|
|
|
def test_publish_post_type_not_provided(self):
|
|
# type: () -> None
|
|
|
|
expected_topic = u"WordPress Post"
|
|
expected_message = u"New post published.\n[New Blog Post](http://example.com\n)"
|
|
|
|
self.send_and_test_stream_message('publish_post_type_not_provided',
|
|
expected_topic, expected_message,
|
|
content_type="application/x-www-form-urlencoded")
|
|
|
|
def test_publish_post_no_data_provided(self):
|
|
# type: () -> None
|
|
|
|
# Note: the fixture includes 'hook=publish_post' because it's always added by HookPress
|
|
expected_topic = u"WordPress Notification"
|
|
expected_message = u"New post published.\n" + "[New WordPress Post](WordPress Post URL)"
|
|
|
|
self.send_and_test_stream_message('publish_post_no_data_provided',
|
|
expected_topic, expected_message,
|
|
content_type="application/x-www-form-urlencoded")
|
|
|
|
def test_publish_page(self):
|
|
# type: () -> None
|
|
|
|
expected_topic = u"WordPress Page"
|
|
expected_message = u"New page published.\n" + "[New Blog Page](http://example.com\n)"
|
|
|
|
self.send_and_test_stream_message('publish_page', expected_topic, expected_message,
|
|
content_type="application/x-www-form-urlencoded")
|
|
|
|
def test_user_register(self):
|
|
# type: () -> None
|
|
|
|
expected_topic = u"New Blog Users"
|
|
expected_message = u"New blog user registered.\nName: test_user\nemail: test_user@example.com\n"
|
|
|
|
self.send_and_test_stream_message('user_register', expected_topic, expected_message,
|
|
content_type="application/x-www-form-urlencoded")
|
|
|
|
def test_wp_login(self):
|
|
# type: () -> None
|
|
|
|
expected_topic = u"New Login"
|
|
expected_message = u"User testuser logged in."
|
|
|
|
self.send_and_test_stream_message('wp_login', expected_topic, expected_message,
|
|
content_type="application/x-www-form-urlencoded")
|
|
|
|
def test_unknown_action_no_data(self):
|
|
# type: () -> None
|
|
|
|
# Mimic send_and_test_stream_message() to manually execute a negative test.
|
|
# Otherwise its call to send_json_payload() would assert on the non-success
|
|
# we are testing. The value of result is the error message the webhook should
|
|
# return if no params are sent. The fixture for this test is an empty file.
|
|
|
|
# subscribe to the target stream
|
|
self.subscribe_to_stream(self.TEST_USER_EMAIL, self.STREAM_NAME)
|
|
|
|
# post to the webhook url
|
|
post_params = {'stream_name': self.STREAM_NAME,
|
|
'content_type': 'application/x-www-form-urlencoded'}
|
|
result = self.client_post(self.url, 'unknown_action', **post_params)
|
|
|
|
# check that we got the expected error message
|
|
self.assert_json_error(result, "Unknown WordPress webhook action: WordPress Action")
|
|
|
|
def test_unknown_action_no_hook_provided(self):
|
|
# type: () -> None
|
|
|
|
# Similar to unknown_action_no_data, except the fixture contains valid blog post
|
|
# params but without the hook parameter. This should also return an error.
|
|
|
|
self.subscribe_to_stream(self.TEST_USER_EMAIL, self.STREAM_NAME)
|
|
post_params = {'stream_name': self.STREAM_NAME,
|
|
'content_type': 'application/x-www-form-urlencoded'}
|
|
result = self.client_post(self.url, 'unknown_action', **post_params)
|
|
|
|
self.assert_json_error(result, "Unknown WordPress webhook action: WordPress Action")
|
|
|
|
def get_body(self, fixture_name):
|
|
# type: (text_type) -> text_type
|
|
return self.fixture_data("wordpress", fixture_name, file_type="txt")
|