Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/zerver/webhooks/jira/tests.py

251 lines
12 KiB
Python
Raw Normal View History

jira tests: Test ignored events.
2020-08-22 00:11:59 +02:00
from unittest.mock import patch
webhooks/jira: Decode stream name on our end. Recently, one of our users reported that a JIRA webhook was not able to send messages to a stream with a space character in its name. Turns out that JIRA does something weird with webhook URLs, such that escaped space characters (%20) are escaped again, so that when the request gets to Zulip, the double escaped %20 is evaluated as the literal characters `%20`, and not as a space. We fix this by unescaping the stream name on our end before sending the message forward!
2018-11-06 17:07:04 +01:00
from urllib.parse import quote, unquote
tests: Split out ZulipTestCase and WebhookTestCase to a separate file. Fixes #1671.
2016-11-10 19:30:09 +01:00
from zerver.lib.test_classes import WebhookTestCase
users: Get all API keys via wrapper method. Now reading API keys from a user is done with the get_api_key wrapper method, rather than directly fetching it from the user object. Also, every place where an action should be done for each API key is now using get_all_api_keys. This method returns for the moment a single-item list, containing the specified user's API key. This commit is the first step towards allowing users have multiple API keys.
2018-08-01 10:53:40 +02:00
from zerver.lib.users import get_api_key
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
python: Sort webhooks imports with isort.
2020-01-14 22:06:24 +01:00
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
class JiraHookTests(WebhookTestCase):
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
STREAM_NAME = "jira"
python: Modernize legacy Python 2 syntax with pyupgrade. Generated by `pyupgrade --py3-plus --keep-percent-format` on all our Python code except `zthumbor` and `zulip-ec2-configure-interfaces`, followed by manual indentation fixes. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-09 21:51:58 +02:00
URL_TEMPLATE = "/api/v1/external/jira?api_key={api_key}&stream={stream}"
webhook: Rename FIXTURE_DIR_NAME to WEBHOOK_DIR_NAME. Since FIXTURE_DIR_NAME is the name of the folder that contains the view and tests modules of the webhook and another folder called "fixtures" that store the fixtures, it is more appropriate to call it WEBHOOK_DIR_NAME, especially when we want to refer to the view module using this variable.
2021-06-26 09:18:33 +02:00
WEBHOOK_DIR_NAME = "jira"
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_custom_stream(self) -> None:
users: Get all API keys via wrapper method. Now reading API keys from a user is done with the get_api_key wrapper method, rather than directly fetching it from the user object. Also, every place where an action should be done for each API key is now using get_all_api_keys. This method returns for the moment a single-item list, containing the specified user's API key. This commit is the first step towards allowing users have multiple API keys.
2018-08-01 10:53:40 +02:00
api_key = get_api_key(self.test_user)
webhook tests: Remove stream_name parameter. Having an optional stream_name parameter makes it confusing to read the code if you know your webhook is sending private messages. And then the other two callers are already checking topics, so they might as well check stream names, too. We also have the two stream-oriented callers make their own call to "subscribe". And we future-proof this by making sure the exception for no-message-being-sent calls out that gotcha. Somewhat in passing, we now assert that self.STREAM_NAME is not None in the main helper. This is partly to satisfy mypy, but it's also a good sanity check. This also sets the stage for the next commit, where I'll add an assert_stream_message helper.
2020-08-23 19:30:12 +02:00
self.subscribe(self.test_user, "jira_custom")
python: Convert percent formatting to Python 3.6 f-strings. Generated by pyupgrade --py36-plus. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-10 06:41:04 +02:00
url = f"/api/v1/external/jira?api_key={api_key}&stream=jira_custom"
webhook tests: Rename helper to send_webhook_payload. Not all webhook payloads are json, so send_json_payload was a bit misleading. In passing I also remove "bytes" from the Union type for "payload" parameter.
2020-08-23 19:09:27 +02:00
msg = self.send_webhook_payload(
self.test_user,
url,
self.get_body("created_v2"),
content_type="application/json",
)
webhook tests: Extract assert_stream_message. This forces us to be a bit more explicit about testing the three key values in any stream message, and it also de-clutters the code a bit. I eventually want to phase out do_test_topic and friends, since they have the pitfall that you can call them and have them do nothing, because they don't actually require values to be be passed in. I also clean up the code a bit for the tests that have two new messages arriving.
2020-08-24 14:21:58 +02:00
expected_content = """
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
Leo Franchi created [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15):
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
* **Priority**: Major
* **Assignee**: no one
""".strip()
webhook tests: Extract assert_stream_message. This forces us to be a bit more explicit about testing the three key values in any stream message, and it also de-clutters the code a bit. I eventually want to phase out do_test_topic and friends, since they have the pitfall that you can call them and have them do nothing, because they don't actually require values to be be passed in. I also clean up the code a bit for the tests that have two new messages arriving.
2020-08-24 14:21:58 +02:00
self.assert_stream_message(
message=msg,
stream_name="jira_custom",
topic_name="BUG-15: New bug with hook",
content=expected_content,
)
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_created(self) -> None:
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "BUG-15: New bug with hook"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """
Leo Franchi created [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15):
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
* **Priority**: Major
* **Assignee**: no one
""".strip()
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("created_v1", expected_topic, expected_message)
self.check_webhook("created_v2", expected_topic, expected_message)
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
jira tests: Test ignored events.
2020-08-22 00:11:59 +02:00
def test_ignored_events(self) -> None:
ignored_actions = [
"attachment_created",
"issuelink_created",
"issuelink_deleted",
jira: Ignore version_released event.
2020-08-22 14:37:45 +02:00
"jira:version_released",
jira: Ignore worklog_updated event.
2020-08-22 15:15:07 +02:00
"jira:worklog_updated",
jira tests: Test ignored events.
2020-08-22 00:11:59 +02:00
"sprint_closed",
"sprint_started",
"worklog_created",
"worklog_updated",
]
for action in ignored_actions:
url = self.build_webhook_url()
payload = dict(webhookEvent=action)
with patch("zerver.webhooks.jira.view.check_send_webhook_message") as m:
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
result = self.client_post(url, payload, content_type="application/json")
jira tests: Test ignored events.
2020-08-22 00:11:59 +02:00
self.assertFalse(m.called)
self.assert_json_success(result)
webhooks/jira: Decode stream name on our end. Recently, one of our users reported that a JIRA webhook was not able to send messages to a stream with a space character in its name. Turns out that JIRA does something weird with webhook URLs, such that escaped space characters (%20) are escaped again, so that when the request gets to Zulip, the double escaped %20 is evaluated as the literal characters `%20`, and not as a space. We fix this by unescaping the stream name on our end before sending the message forward!
2018-11-06 17:07:04 +01:00
def test_created_with_stream_with_spaces_escaped(self) -> None:
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
self.STREAM_NAME = quote("jira alerts")
webhooks/jira: Decode stream name on our end. Recently, one of our users reported that a JIRA webhook was not able to send messages to a stream with a space character in its name. Turns out that JIRA does something weird with webhook URLs, such that escaped space characters (%20) are escaped again, so that when the request gets to Zulip, the double escaped %20 is evaluated as the literal characters `%20`, and not as a space. We fix this by unescaping the stream name on our end before sending the message forward!
2018-11-06 17:07:04 +01:00
self.url = self.build_webhook_url()
self.subscribe(self.test_user, unquote(self.STREAM_NAME))
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
payload = self.get_body("created_v1")
result = self.client_post(self.url, payload, content_type="application/json")
webhooks/jira: Decode stream name on our end. Recently, one of our users reported that a JIRA webhook was not able to send messages to a stream with a space character in its name. Turns out that JIRA does something weird with webhook URLs, such that escaped space characters (%20) are escaped again, so that when the request gets to Zulip, the double escaped %20 is evaluated as the literal characters `%20`, and not as a space. We fix this by unescaping the stream name on our end before sending the message forward!
2018-11-06 17:07:04 +01:00
self.assert_json_success(result)
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "BUG-15: New bug with hook"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """
Leo Franchi created [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15):
webhooks/jira: Decode stream name on our end. Recently, one of our users reported that a JIRA webhook was not able to send messages to a stream with a space character in its name. Turns out that JIRA does something weird with webhook URLs, such that escaped space characters (%20) are escaped again, so that when the request gets to Zulip, the double escaped %20 is evaluated as the literal characters `%20`, and not as a space. We fix this by unescaping the stream name on our end before sending the message forward!
2018-11-06 17:07:04 +01:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
* **Priority**: Major
* **Assignee**: no one
""".strip()
webhooks/jira: Test double-escaped stream names with spaces. A recent change to check_send_webhook_message allows webhooks to unescape stream names before sending a message. This commit adds a test for the edge case where the webhook URL is escaped twice by a third-party.
2018-11-07 01:14:21 +01:00
msg = self.get_last_message()
self.assertEqual(msg.content, expected_message)
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
self.assertEqual(msg.topic_name(), expected_topic)
webhooks/jira: Test double-escaped stream names with spaces. A recent change to check_send_webhook_message allows webhooks to unescape stream names before sending a message. This commit adds a test for the edge case where the webhook URL is escaped twice by a third-party.
2018-11-07 01:14:21 +01:00
def test_created_with_stream_with_spaces_double_escaped(self) -> None:
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
self.STREAM_NAME = quote(quote("jira alerts"))
webhooks/jira: Test double-escaped stream names with spaces. A recent change to check_send_webhook_message allows webhooks to unescape stream names before sending a message. This commit adds a test for the edge case where the webhook URL is escaped twice by a third-party.
2018-11-07 01:14:21 +01:00
self.url = self.build_webhook_url()
self.subscribe(self.test_user, unquote(unquote(self.STREAM_NAME)))
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
payload = self.get_body("created_v1")
result = self.client_post(self.url, payload, content_type="application/json")
webhooks/jira: Test double-escaped stream names with spaces. A recent change to check_send_webhook_message allows webhooks to unescape stream names before sending a message. This commit adds a test for the edge case where the webhook URL is escaped twice by a third-party.
2018-11-07 01:14:21 +01:00
self.assert_json_success(result)
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "BUG-15: New bug with hook"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """
Leo Franchi created [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15):
webhooks/jira: Test double-escaped stream names with spaces. A recent change to check_send_webhook_message allows webhooks to unescape stream names before sending a message. This commit adds a test for the edge case where the webhook URL is escaped twice by a third-party.
2018-11-07 01:14:21 +01:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
* **Priority**: Major
* **Assignee**: no one
""".strip()
webhooks/jira: Decode stream name on our end. Recently, one of our users reported that a JIRA webhook was not able to send messages to a stream with a space character in its name. Turns out that JIRA does something weird with webhook URLs, such that escaped space characters (%20) are escaped again, so that when the request gets to Zulip, the double escaped %20 is evaluated as the literal characters `%20`, and not as a space. We fix this by unescaping the stream name on our end before sending the message forward!
2018-11-06 17:07:04 +01:00
msg = self.get_last_message()
self.assertEqual(msg.content, expected_message)
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
self.assertEqual(msg.topic_name(), expected_topic)
webhooks/jira: Decode stream name on our end. Recently, one of our users reported that a JIRA webhook was not able to send messages to a stream with a space character in its name. Turns out that JIRA does something weird with webhook URLs, such that escaped space characters (%20) are escaped again, so that when the request gets to Zulip, the double escaped %20 is evaluated as the literal characters `%20`, and not as a space. We fix this by unescaping the stream name on our end before sending the message forward!
2018-11-06 17:07:04 +01:00
webhooks/jira: Decode topics on our end. The problem addressed in 006e47198c5db5e6dd40170100f1831b7114dc18 resurfaces with topics when a user provides a custom topic in the webhook URL.
2018-12-04 01:59:39 +01:00
def test_created_with_topic_with_spaces_double_escaped(self) -> None:
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
self.url = self.build_webhook_url(topic=quote(quote("alerts test")))
webhooks/jira: Decode topics on our end. The problem addressed in 006e47198c5db5e6dd40170100f1831b7114dc18 resurfaces with topics when a user provides a custom topic in the webhook URL.
2018-12-04 01:59:39 +01:00
expected_topic = "alerts test"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """
Leo Franchi created [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15):
webhooks/jira: Decode topics on our end. The problem addressed in 006e47198c5db5e6dd40170100f1831b7114dc18 resurfaces with topics when a user provides a custom topic in the webhook URL.
2018-12-04 01:59:39 +01:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
* **Priority**: Major
* **Assignee**: no one
""".strip()
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("created_v1", expected_topic, expected_message)
webhooks/jira: Decode topics on our end. The problem addressed in 006e47198c5db5e6dd40170100f1831b7114dc18 resurfaces with topics when a user provides a custom topic in the webhook URL.
2018-12-04 01:59:39 +01:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_created_with_unicode(self) -> None:
python: Modernize legacy Python 2 syntax with pyupgrade. Generated by `pyupgrade --py3-plus --keep-percent-format` on all our Python code except `zthumbor` and `zulip-ec2-configure-interfaces`, followed by manual indentation fixes. Signed-off-by: Anders Kaseorg <anders@zulipchat.com>
2020-04-09 21:51:58 +02:00
expected_topic = "BUG-15: New bug with à hook"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """
Leo Franchià created [BUG-15: New bug with à hook](http://lfranchi.com:8080/browse/BUG-15):
jira integration: Add support for unicode chars. Fixes: #3967
2017-03-15 21:23:51 +01:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
* **Priority**: Major
* **Assignee**: no one
""".strip()
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("created_with_unicode_v1", expected_topic, expected_message)
self.check_webhook("created_with_unicode_v2", expected_topic, expected_message)
jira integration: Add support for unicode chars. Fixes: #3967
2017-03-15 21:23:51 +01:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_created_assignee(self) -> None:
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "TEST-4: Test Created Assignee"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """
Leonardo Franchi [Administrator] created [TEST-4: Test Created Assignee](https://zulipp.atlassian.net/browse/TEST-4):
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
* **Priority**: Major
* **Assignee**: Leonardo Franchi [Administrator]
""".strip()
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("created_assignee_v1", expected_topic, expected_message)
self.check_webhook("created_assignee_v2", expected_topic, expected_message)
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_commented(self) -> None:
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "BUG-15: New bug with hook"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """
Leo Franchi commented on [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15) (assigned to **Othello, the Moor of Venice**):
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
``` quote
Adding a comment. Oh, what a comment it is!
```
""".strip()
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("commented_v1", expected_topic, expected_message)
self.check_webhook("commented_v2", expected_topic, expected_message)
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
webhooks/jira: Fix markup conversion of full links. This commit modifies the regex used when parsing JIRA's full links of the form `[text|link]` so that if you have two in a message, Zulip markup conversion doesn't think that the first link extends to the closing `]` of the second link.
2019-05-23 10:17:17 +02:00
def test_commented_with_two_full_links(self) -> None:
expected_topic = "BUG-15: New bug with hook"
expected_message = """
Leo Franchi commented on [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15) (assigned to **Othello, the Moor of Venice**):
``` quote
This is the [first link](https://google.com) and this is the [second link](https://google.com) and this is the end.
```
""".strip()
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("commented_v2_with_two_full_links", expected_topic, expected_message)
webhooks/jira: Fix markup conversion of full links. This commit modifies the regex used when parsing JIRA's full links of the form `[text|link]` so that if you have two in a message, Zulip markup conversion doesn't think that the first link extends to the closing `]` of the second link.
2019-05-23 10:17:17 +02:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_comment_edited(self) -> None:
tools: Upgrade Pycodestyle and fix new linter errors. Here, we are upgrading pycodestyle version from 2.4.0 to 2.5.0. Fixes: #11396.
2019-01-31 14:32:37 +01:00
expected_topic = "BUG-15: New bug with hook"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """
Leo Franchi edited a comment on [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15) (assigned to **Othello, the Moor of Venice**):
Change way of handling comments event in jira integration.
2017-01-03 18:44:13 +01:00
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
``` quote
Adding a comment. Oh, what a comment it is!
```
""".strip()
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("comment_edited_v2", expected_topic, expected_message)
Change way of handling comments event in jira integration.
2017-01-03 18:44:13 +01:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_comment_deleted(self) -> None:
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "TOM-1: New Issue"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = "Tomasz Kolek deleted a comment from [TOM-1: New Issue](https://zuliptomek.atlassian.net/browse/TOM-1) (assigned to **kolaszek@go2.pl**)."
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("comment_deleted_v2", expected_topic, expected_message)
Change way of handling comments event in jira integration.
2017-01-03 18:44:13 +01:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_commented_markup(self) -> None:
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "TEST-7: Testing of rich text"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """Leonardo Franchi [Administrator] commented on [TEST-7: Testing of rich text](https://zulipp.atlassian.net/browse/TEST-7):\n\n``` quote\nThis is a comment that likes to **exercise** a lot of _different_ `conventions` that `jira uses`.\r\n\r\n~~~\n\r\nthis code is not highlighted, but monospaced\r\n\n~~~\r\n\r\n~~~\n\r\ndef python():\r\n print "likes to be formatted"\r\n\n~~~\r\n\r\n[http://www.google.com](http://www.google.com) is a bare link, and [Google](http://www.google.com) is given a title.\r\n\r\nThanks!\r\n\r\n~~~ quote\n\r\nSomeone said somewhere\r\n\n~~~\n```"""
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("commented_markup_v1", expected_topic, expected_message)
self.check_webhook("commented_markup_v2", expected_topic, expected_message)
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_deleted(self) -> None:
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "BUG-15: New bug with hook"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = "Leo Franchi deleted [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15)."
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("deleted_v1", expected_topic, expected_message)
self.check_webhook("deleted_v2", expected_topic, expected_message)
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_reassigned(self) -> None:
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "BUG-15: New bug with hook"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """Leo Franchi updated [BUG-15: New bug with hook](http://lfranchi.com:8080/browse/BUG-15) (assigned to **Othello, the Moor of Venice**):
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
messages: Strip trailing whitespace in message contents. I dug into why we never did this before, and it turns out we did, but using `$.trim()` (which removes leading whitespace as well!). When removing the `$.trim()` usage. Fixes #3294.
2017-02-12 04:22:13 +01:00
* Changed assignee to **Othello, the Moor of Venice**"""
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("reassigned_v1", expected_topic, expected_message)
self.check_webhook("reassigned_v2", expected_topic, expected_message)
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_priority_updated(self) -> None:
Sweep tests for expected_subject -> expected_topic. This is all in the webhooks tests, including some docs for how to write those tests.
2018-11-09 20:33:58 +01:00
expected_topic = "TEST-1: Fix That"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """Leonardo Franchi [Administrator] updated [TEST-1: Fix That](https://zulipp.atlassian.net/browse/TEST-1) (assigned to **leo@zulip.com**):
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
messages: Strip trailing whitespace in message contents. I dug into why we never did this before, and it turns out we did, but using `$.trim()` (which removes leading whitespace as well!). When removing the `$.trim()` usage. Fixes #3294.
2017-02-12 04:22:13 +01:00
* Changed priority from **Critical** to **Major**"""
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("updated_priority_v1", expected_topic, expected_message)
self.check_webhook("updated_priority_v2", expected_topic, expected_message)
Add support for old Jira API's version to Jira integration.
2017-01-30 19:26:48 +01:00
zerver/webhooks: Use python 3 syntax for typing. Tweaked by tabbott to fix various line-wrapping issues.
2017-11-04 07:47:46 +01:00
def test_status_changed(self) -> None:
tools: Upgrade Pycodestyle and fix new linter errors. Here, we are upgrading pycodestyle version from 2.4.0 to 2.5.0. Fixes: #11396.
2019-01-31 14:32:37 +01:00
expected_topic = "TEST-1: Fix That"
webhooks/jira: Improve punctuation and message formatting.
2019-05-09 03:40:38 +02:00
expected_message = """Leonardo Franchi [Administrator] updated [TEST-1: Fix That](https://zulipp.atlassian.net/browse/TEST-1):
Add support for old Jira API's version to Jira integration.
2017-01-30 19:26:48 +01:00
messages: Strip trailing whitespace in message contents. I dug into why we never did this before, and it turns out we did, but using `$.trim()` (which removes leading whitespace as well!). When removing the `$.trim()` usage. Fixes #3294.
2017-02-12 04:22:13 +01:00
* Changed status from **To Do** to **In Progress**"""
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("change_status_v1", expected_topic, expected_message)
self.check_webhook("change_status_v2", expected_topic, expected_message)
Split test_hooks file into one test file per hook.
2016-09-20 22:51:11 +02:00
webhooks/jira: Update webhook to support improved comment events. Atlassian announced that it will no longer provide information about comments along with their "issue" type event payloads for Jira. So we must now update the Jira integration to appropriately respond to "comment" type events (the reason why we didn't do this before was that initially, the "comment" type event payloads didn't contain sufficient information about their issues, but this payload has since been improved). Note: This commit does *not* remove support for the older "issue" type event payloads where information about comments was included. This way we can maintain compatibility with old self-hosted versions of self hosted Jira (2016 and before). Source: https://developer.atlassian.com/cloud/jira/platform/change-notice- removal-of-comments-from-issue-webhooks/ Fixes #13012
2019-08-16 17:20:07 +02:00
def test_comment_event_comment_created(self) -> None:
expected_topic = "SP-1: Add support for newer format Jira issue comment events"
expected_message = """Hemanth V. Alluri commented on issue: *"Add support for newer format Jira issue comment events"*\n``` quote\nSounds like it’s pretty important. I’ll get this fixed ASAP!\n```"""
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("comment_created", expected_topic, expected_message)
webhooks/jira: Update webhook to support improved comment events. Atlassian announced that it will no longer provide information about comments along with their "issue" type event payloads for Jira. So we must now update the Jira integration to appropriately respond to "comment" type events (the reason why we didn't do this before was that initially, the "comment" type event payloads didn't contain sufficient information about their issues, but this payload has since been improved). Note: This commit does *not* remove support for the older "issue" type event payloads where information about comments was included. This way we can maintain compatibility with old self-hosted versions of self hosted Jira (2016 and before). Source: https://developer.atlassian.com/cloud/jira/platform/change-notice- removal-of-comments-from-issue-webhooks/ Fixes #13012
2019-08-16 17:20:07 +02:00
jira: Handle comment_created events without issue details. I'm not sure what causes some Jira webhook events to not include the metadata that other events do, but it's definitely a format sent by real installations of Jira (likely a very old version, since this has fields missing from what modern Jira does) and we've seen it in production. The best we can do is encourage users to upgrade Jira for better data.
2020-02-26 22:10:25 +01:00
def test_comment_event_comment_created_no_issue_details(self) -> None:
expected_topic = "10000: Upgrade Jira to get the issue title here."
expected_message = """Hemanth V. Alluri commented on issue: *"Upgrade Jira to get the issue title here."*\n``` quote\nSounds like it’s pretty important. I’ll get this fixed ASAP!\n```"""
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("comment_created_no_issue_details", expected_topic, expected_message)
jira: Handle comment_created events without issue details. I'm not sure what causes some Jira webhook events to not include the metadata that other events do, but it's definitely a format sent by real installations of Jira (likely a very old version, since this has fields missing from what modern Jira does) and we've seen it in production. The best we can do is encourage users to upgrade Jira for better data.
2020-02-26 22:10:25 +01:00
webhooks/jira: Update webhook to support improved comment events. Atlassian announced that it will no longer provide information about comments along with their "issue" type event payloads for Jira. So we must now update the Jira integration to appropriately respond to "comment" type events (the reason why we didn't do this before was that initially, the "comment" type event payloads didn't contain sufficient information about their issues, but this payload has since been improved). Note: This commit does *not* remove support for the older "issue" type event payloads where information about comments was included. This way we can maintain compatibility with old self-hosted versions of self hosted Jira (2016 and before). Source: https://developer.atlassian.com/cloud/jira/platform/change-notice- removal-of-comments-from-issue-webhooks/ Fixes #13012
2019-08-16 17:20:07 +02:00
def test_comment_event_comment_edited(self) -> None:
expected_topic = "SP-1: Add support for newer format Jira issue comment events"
expected_message = """Hemanth V. Alluri updated their comment on issue: *"Add support for newer format Jira issue comment events"*\n``` quote\nThis is a very important issue! I’m on it!\n```"""
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("comment_updated", expected_topic, expected_message)
webhooks/jira: Update webhook to support improved comment events. Atlassian announced that it will no longer provide information about comments along with their "issue" type event payloads for Jira. So we must now update the Jira integration to appropriately respond to "comment" type events (the reason why we didn't do this before was that initially, the "comment" type event payloads didn't contain sufficient information about their issues, but this payload has since been improved). Note: This commit does *not* remove support for the older "issue" type event payloads where information about comments was included. This way we can maintain compatibility with old self-hosted versions of self hosted Jira (2016 and before). Source: https://developer.atlassian.com/cloud/jira/platform/change-notice- removal-of-comments-from-issue-webhooks/ Fixes #13012
2019-08-16 17:20:07 +02:00
def test_comment_event_comment_deleted(self) -> None:
expected_topic = "SP-1: Add support for newer format Jira issue comment events"
expected_message = """Hemanth V. Alluri deleted their comment on issue: *"Add support for newer format Jira issue comment events"*\n``` quote\n~~This is a very important issue! I’m on it!~~\n```"""
webhook tests: Rename main helper to check_webhook. Almost all webhook tests use this helper, except a few webhooks that write to private streams. Being concise is important here, and the name `self.send_and_test_stream_message` always confused me, since it sounds you're sending a stream message, and it leaves out the webhook piece. We should consider renaming `send_and_test_private_message` to something like `check_webhook_private`, but I couldn't decide on a great name, and it's very rarely used. So for now I just made sure the docstrings of the two sibling functions reference each other.
2020-08-23 15:49:24 +02:00
self.check_webhook("comment_deleted", expected_topic, expected_message)
webhooks/jira: Handle anomalous payloads properly. We recently ran into a payload in production that didn't contain an event type at all. A payload where we can't figure out the event type is quite rare. Instead of letting these payloads run amok, we should raise a more informative exception for such unusual payloads. If we encounter too many of these, then we can choose to conduct a deeper investigation on a case-by-case basis. With some changes by Tim Abbott.
2021-09-13 20:23:54 +02:00
def test_anomalous_webhook_payload_error(self) -> None:
with self.assertRaises(AssertionError) as e:
self.check_webhook(
fixture_name="example_anomalous_payload",
expected_topic="",
expected_message="",
expect_noop=True,
)
self.assertIn(
"Unable to parse request: Did Jira generate this event?",
e.exception.args[0],
)