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

584 lines
36 KiB
Python
Raw Normal View History

github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
from unittest.mock import patch
python: Sort imports in webhooks.
2017-11-16 00:43:10 +01:00
github tests: Extract test_ignored_pull_request_actions. We consolidate the tests and remove the fixtures, which just have a lot of noisy fields that we ignore. Also, pull_request__request_review_removed was named improperly.
2020-09-01 13:52:36 +02:00
import orjson
Add github webhook integration.
2016-10-25 14:50:42 +02:00
from zerver.lib.test_classes import WebhookTestCase
python: Sort imports in webhooks.
2017-11-16 00:43:10 +01:00
from zerver.lib.webhooks.git import COMMITS_LIMIT
Add github webhook integration.
2016-10-25 14:50:42 +02:00
webhook tests: Shorten topic constants. The "EXPECTED_" prefix and "_EVENTS" suffix usually provided more noise than signal. We also use module constants to avoid the "self." noise. It also makes it a bit more clear which constants actually have to be in the class (e.g. "FIXTURE_DIR_NAME") to do their job.
2020-08-22 17:16:32 +02:00
TOPIC_REPO = "public-repo"
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
TOPIC_ISSUE = "public-repo / issue #2 Spelling error in the README file"
webhook tests: Shorten topic constants. The "EXPECTED_" prefix and "_EVENTS" suffix usually provided more noise than signal. We also use module constants to avoid the "self." noise. It also makes it a bit more clear which constants actually have to be in the class (e.g. "FIXTURE_DIR_NAME") to do their job.
2020-08-22 17:16:32 +02:00
TOPIC_PR = "public-repo / PR #1 Update the README with new information"
TOPIC_DEPLOYMENT = "public-repo / Deployment on production"
TOPIC_ORGANIZATION = "baxterandthehackers organization"
TOPIC_BRANCH = "public-repo / changes"
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
TOPIC_WIKI = "public-repo / wiki pages"
webhooks: Add support for GitHub discussions messages. We aim to use Zulip topics thoughtfully in displaying messages from discussions, as well as linking to the discussion in every message so that it's easy to view them. Fixes #19938.
2021-10-18 13:33:38 +02:00
TOPIC_DISCUSSION = "public-repo discussion #90: Welcome to discussions!"
python: Sort webhooks imports with isort.
2020-01-14 22:06:24 +01:00
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
docs: Fix more capitalization issues. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-10-23 02:43:28 +02:00
class GitHubWebhookTest(WebhookTestCase):
python: Normalize quotes with Black. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:20:45 +01:00
STREAM_NAME = "github"
Add github dispatcher to have one elegant url for both github integrations. Dispatcher avoids to create new URL for github_webhook.
2016-11-14 21:06:39 +01:00
URL_TEMPLATE = "/api/v1/external/github?stream={stream}&api_key={api_key}"
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 = "github"
Add github webhook integration.
2016-10-25 14:50:42 +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_ping_event(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_message = "GitHub webhook has been successfully configured by TomaszKolek."
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("ping", TOPIC_REPO, expected_message)
Add ping event handling to github webhook integration.
2017-02-01 00:37:13 +01:00
webhooks/github: Add support for star events.
2019-06-06 06:51:38 +02:00
def test_star_event(self) -> None:
integrations: Add user url for star event in Github Integration. Fixes #25672.
2023-06-03 14:05:08 +02:00
expected_message = "[Codertocat](https://github.com/Codertocat) starred the repository [Codertocat/Hello-World](https://github.com/Codertocat/Hello-World)."
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 = "Hello-World"
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("star", expected_topic, expected_message)
webhooks/github: Add support for star events.
2019-06-06 06:51:38 +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_ping_organization_event(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_message = "GitHub webhook has been successfully configured by eeshangarg."
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("ping__organization", "zulip-test-org", expected_message)
github_webhook: Support "ping" events from organization webhooks. In addition to "ping" webhook payloads from repository-specific webhooks, we now also support "ping" events from organization-wide webhooks.
2017-07-17 04:03:54 +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_push_delete_branch(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_message = "eeshangarg [deleted](https://github.com/eeshangarg/public-repo/compare/2e8cf535fb38...000000000000) the branch feature."
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("push__delete_branch", "public-repo / feature", expected_message)
webhooks: Add support for a GitHub push event deleting a branch. Fixes: #4742.
2017-05-16 04:38:25 +02:00
integrations: Add force push fixtures for GitHub Integration. One fixture is just removing commits; the other removes some commits but adds others.
2023-05-04 17:12:59 +02:00
def test_push_force_1_commit(self) -> None:
integrations: Improve GitHub force push notifications. Previously, we didn't explicitly display something special for force-pushes. Fixes #21969.
2023-05-04 17:12:59 +02:00
expected_message = "sbansal1999 [force pushed](https://github.com/sbansal1999/zulip/compare/b6de8891fc10...971d76ca3094) 1 commit to branch temp.\n\n* log: Add important.txt which is useful for logging errors. ([971d76ca309](https://github.com/sbansal1999/zulip/commit/971d76ca309446a9c20381f6271cea8a59b4e40a))"
integrations: Add force push fixtures for GitHub Integration. One fixture is just removing commits; the other removes some commits but adds others.
2023-05-04 17:12:59 +02:00
self.check_webhook("push__force_1_commit", "zulip / temp", expected_message)
def test_push__force_remove_commits(self) -> None:
integrations: Improve GitHub force push notifications. Previously, we didn't explicitly display something special for force-pushes. Fixes #21969.
2023-05-04 17:12:59 +02:00
expected_message = "sbansal1999 [force pushed](https://github.com/sbansal1999/zulip/compare/2084a91af9ca...9a8749ea8fe7) the branch temp."
integrations: Add force push fixtures for GitHub Integration. One fixture is just removing commits; the other removes some commits but adds others.
2023-05-04 17:12:59 +02:00
self.check_webhook("push__force_remove_commits", "zulip / temp", expected_message)
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_push_local_branch_without_commits(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_message = "eeshangarg [pushed](https://github.com/eeshangarg/public-repo/compare/feature) the branch feature."
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(
"push__local_branch_without_commits", "public-repo / feature", expected_message
)
webhooks/github*: Support pushing a local branch without commits. Changes made to get_push_commits_event_message in zerver/lib/webhooks/git.py are common to all Git integrations that use get_push_commits_event_message. These include github, github_webhook, gitlab, gogs, bitbucket, bitbucket2. In some cases (for instance, gitlab), no further changes to gitlab/view.py will be required to support pushing a local branch without commits; adding a fixture and tests should suffice.
2017-05-17 02:19:33 +02:00
integrations: Ignore merge queue push events for GitHub Integration. Previosuly, the server would send a 500 whenever a merge queue push event was encountered. Fixes #25629.
2023-05-23 05:52:42 +02:00
def test_push_merege_queue_ignore(self) -> None:
self.url = self.build_webhook_url()
payload = self.get_body("push__merge_queue")
self.verify_post_is_ignored(payload, "push")
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_push_1_commit(self) -> None:
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
expected_message = "baxterthehacker [pushed](https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f) 1 commit to branch changes.\n\n* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))"
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("push__1_commit", TOPIC_BRANCH, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_push_1_commit_without_username(self) -> None:
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
expected_message = "eeshangarg [pushed](https://github.com/eeshangarg/public-repo/compare/0383613da871...2e8cf535fb38) 1 commit to branch changes. Commits by John Snow (1).\n\n* Update the README ([2e8cf535fb3](https://github.com/eeshangarg/public-repo/commit/2e8cf535fb38a3dab2476cdf856efda904ad4c94))"
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("push__1_commit_without_username", TOPIC_BRANCH, expected_message)
github_webhook: Use author's full name if username is not available. In cases where the webhook payload doesn't have the username for the author of a particular commit (this can happen if the author doesn't have a GitHub account or the author's email is not associated with their GitHub account), we now use the author's full name to format messages.
2017-04-29 08:16:07 +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_push_1_commit_filtered_by_branches(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("master,changes")
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
expected_message = "baxterthehacker [pushed](https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f) 1 commit to branch changes.\n\n* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))"
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("push__1_commit", TOPIC_BRANCH, expected_message)
github_webhook: Filter specific GitHub branches. Fixes: #4000
2017-03-25 03:23:15 +01:00
Fix typos caught by typos. https://github.com/crate-ci/typos Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-01-02 20:50:23 +01:00
def test_push_multiple_committers(self) -> None:
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
commits_info = "* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))\n"
expected_message = f"""baxterthehacker [pushed](https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f) 6 commits to branch changes. Commits by Tomasz (3), Ben (2) and baxterthehacker (1).\n\n{commits_info * 5}* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))"""
git integrations: Expand details in commit push notifications. We now show a few new things: (1) The number of commits pushed. (2) Who authored the commits (just counts, not which specific ones, for brevity). Add tests for case of multiple committers. Part of #3968.
2017-04-05 09:12:19 +02:00
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("push__multiple_committers", TOPIC_BRANCH, expected_message)
git integrations: Expand details in commit push notifications. We now show a few new things: (1) The number of commits pushed. (2) Who authored the commits (just counts, not which specific ones, for brevity). Add tests for case of multiple committers. Part of #3968.
2017-04-05 09:12:19 +02:00
Fix typos caught by typos. https://github.com/crate-ci/typos Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-01-02 20:50:23 +01:00
def test_push_multiple_committers_with_others(self) -> None:
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
commits_info = "* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))\n"
expected_message = f"""baxterthehacker [pushed](https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f) 10 commits to branch changes. Commits by Tomasz (4), Ben (3), James (2) and others (1).\n\n{commits_info * 9}* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))"""
git integrations: Expand details in commit push notifications. We now show a few new things: (1) The number of commits pushed. (2) Who authored the commits (just counts, not which specific ones, for brevity). Add tests for case of multiple committers. Part of #3968.
2017-04-05 09:12:19 +02:00
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("push__multiple_committers_with_others", TOPIC_BRANCH, expected_message)
git integrations: Expand details in commit push notifications. We now show a few new things: (1) The number of commits pushed. (2) Who authored the commits (just counts, not which specific ones, for brevity). Add tests for case of multiple committers. Part of #3968.
2017-04-05 09:12:19 +02:00
Fix typos caught by typos. https://github.com/crate-ci/typos Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-01-02 20:50:23 +01:00
def test_push_multiple_committers_filtered_by_branches(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("master,changes")
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
commits_info = "* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))\n"
expected_message = f"""baxterthehacker [pushed](https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f) 6 commits to branch changes. Commits by Tomasz (3), Ben (2) and baxterthehacker (1).\n\n{commits_info * 5}* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))"""
webhooks: Stop overriding build_webhook_url for URL query parameters.
2017-04-21 23:35:40 +02:00
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("push__multiple_committers", TOPIC_BRANCH, expected_message)
webhooks: Stop overriding build_webhook_url for URL query parameters.
2017-04-21 23:35:40 +02:00
Fix typos caught by typos. https://github.com/crate-ci/typos Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-01-02 20:50:23 +01:00
def test_push_multiple_committers_with_others_filtered_by_branches(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("master,changes")
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
commits_info = "* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))\n"
expected_message = f"""baxterthehacker [pushed](https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f) 10 commits to branch changes. Commits by Tomasz (4), Ben (3), James (2) and others (1).\n\n{commits_info * 9}* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))"""
webhooks: Stop overriding build_webhook_url for URL query parameters.
2017-04-21 23:35:40 +02:00
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("push__multiple_committers_with_others", TOPIC_BRANCH, expected_message)
webhooks: Stop overriding build_webhook_url for URL query parameters.
2017-04-21 23:35:40 +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_push_50_commits(self) -> None:
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
commit_info = "* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))\n"
python: Convert more "".format to Python 3.6 f-strings. Generated by pyupgrade --py36-plus --keep-percent-format, with more restrictions patched out. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-10 06:40:53 +02:00
expected_message = f"baxterthehacker [pushed](https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f) 50 commits to branch changes.\n\n{commit_info * COMMITS_LIMIT}[and 30 more commit(s)]"
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("push__50_commits", TOPIC_BRANCH, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_push_50_commits_filtered_by_branches(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(branches="master,changes")
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
commit_info = "* Update README.md ([0d1a26e67d8](https://github.com/baxterthehacker/public-repo/commit/0d1a26e67d8f5eaf1f6ba5c57fc3c7d91ac0fd1c))\n"
python: Convert more "".format to Python 3.6 f-strings. Generated by pyupgrade --py36-plus --keep-percent-format, with more restrictions patched out. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2020-06-10 06:40:53 +02:00
expected_message = f"baxterthehacker [pushed](https://github.com/baxterthehacker/public-repo/compare/9049f1265b7d...0d1a26e67d8f) 50 commits to branch changes.\n\n{commit_info * COMMITS_LIMIT}[and 30 more commit(s)]"
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("push__50_commits", TOPIC_BRANCH, expected_message)
github_webhook: Filter specific GitHub branches. Fixes: #4000
2017-03-25 03:23:15 +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_commit_comment_msg(self) -> None:
webhooks: Pick a more reasonable length for short sha. 7 characters are not enough for large projects, so we change it to reasonably longer. As an example, The Linux kernel needs at least 11 characters of sha in its shortened form to identify a revision. We pick 11 so it should work for most of the projects. Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:15:53 +01:00
expected_message = "baxterthehacker [commented](https://github.com/baxterthehacker/public-repo/commit/9049f1265b7d61be4a8904a9a27120d2064dab3b#commitcomment-11056394) on [9049f1265b7](https://github.com/baxterthehacker/public-repo/commit/9049f1265b7d61be4a8904a9a27120d2064dab3b):\n~~~ quote\nThis is a really good change! :+1:\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("commit_comment", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_create_msg(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_message = "baxterthehacker created tag 0.0.1."
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("create", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_delete_msg(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_message = "baxterthehacker deleted tag simple-tag."
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("delete", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_deployment_msg(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_message = "baxterthehacker created new deployment."
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("deployment", TOPIC_DEPLOYMENT, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_deployment_status_msg(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_message = "Deployment changed status to success."
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("deployment_status", TOPIC_DEPLOYMENT, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_fork_msg(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_message = "baxterandthehackers forked [public-repo](https://github.com/baxterandthehackers/public-repo)."
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("fork", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_issue_comment_msg(self) -> None:
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
expected_message = "baxterthehacker [commented](https://github.com/baxterthehacker/public-repo/issues/2#issuecomment-99262140) on [issue #2](https://github.com/baxterthehacker/public-repo/issues/2):\n\n~~~ quote\nYou are totally right! I'll get this fixed right away.\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("issue_comment", TOPIC_ISSUE, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
webhooks/github: Test and improve messages for issue comment deletion. This is a part of our efforts to get this webhook's coverage up to 100%. Note that apart from just testing an uncovered line of code, this commit also fixes a minor bug in the code for messages about issue comment deletion and editing.
2018-09-27 18:57:09 +02:00
def test_issue_comment_deleted_msg(self) -> None:
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
expected_topic = "Scheduler / issue #5 This is a new issue"
expected_message = "eeshangarg deleted a [comment](https://github.com/eeshangarg/Scheduler/issues/5#issuecomment-425164194) on [issue #5](https://github.com/eeshangarg/Scheduler/issues/5):\n\n~~~ quote\nThis is a comment on this new issue.\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("issue_comment__deleted", expected_topic, expected_message)
webhooks/github: Test and improve messages for issue comment deletion. This is a part of our efforts to get this webhook's coverage up to 100%. Note that apart from just testing an uncovered line of code, this commit also fixes a minor bug in the code for messages about issue comment deletion and editing.
2018-09-27 18:57:09 +02:00
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
def test_issue_comment_msg_with_custom_topic_in_url(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="notifications")
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 = "notifications"
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
expected_message = "baxterthehacker [commented](https://github.com/baxterthehacker/public-repo/issues/2#issuecomment-99262140) on [issue #2 Spelling error in the README file](https://github.com/baxterthehacker/public-repo/issues/2):\n\n~~~ quote\nYou are totally right! I'll get this fixed right away.\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("issue_comment", expected_topic, expected_message)
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
integrations: Add pull request comment fixture to GitHub Integration. Updated the repo name and pull request number/title for the new pull request commit fixture to be the same as the one used for the other pull request test fixtures (e.g. pull_request__opened) so that the TOPIC_PR can be used in the subsequent updates. Co-authored-by: Lauryn Menard <lauryn@zulip.com>
2023-07-11 22:16:06 +02:00
def test_issue_comment_pull_request_comment_msg(self) -> None:
integrations: Use correct type for GitHub pull request comment messages.
2023-07-11 22:47:36 +02:00
expected_message = "sbansal1999 [commented](https://github.com/sbansal1999/public-repo/pull/1#issuecomment-1631445420) on [PR #1](https://github.com/sbansal1999/public-repo/pull/1):\n\n~~~ quote\nSome comment\n~~~"
integrations: Send GitHub pull request comment alerts to correct topic. Pull request comment alerts were previously sent to a topic for an issue, which resulted in two different topics for the same PR. Fixes: #26086. Co-authored-by: Lauryn Menard <lauryn@zulip.com>
2023-07-11 22:18:48 +02:00
self.check_webhook("issue_comment__pull_request_comment", TOPIC_PR, expected_message)
integrations: Add pull request comment fixture to GitHub Integration. Updated the repo name and pull request number/title for the new pull request commit fixture to be the same as the one used for the other pull request test fixtures (e.g. pull_request__opened) so that the TOPIC_PR can be used in the subsequent updates. Co-authored-by: Lauryn Menard <lauryn@zulip.com>
2023-07-11 22:16:06 +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_issue_msg(self) -> None:
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
expected_message = "baxterthehacker opened [issue #2](https://github.com/baxterthehacker/public-repo/issues/2):\n\n~~~ quote\nIt looks like you accidentally spelled 'commit' with two 't's.\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("issues", TOPIC_ISSUE, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
def test_issue_msg_with_custom_topic_in_url(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="notifications")
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 = "notifications"
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
expected_message = "baxterthehacker opened [issue #2 Spelling error in the README file](https://github.com/baxterthehacker/public-repo/issues/2):\n\n~~~ quote\nIt looks like you accidentally spelled 'commit' with two 't's.\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("issues", expected_topic, expected_message)
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
webhooks: Add issue assigned fixture to GitHub Integration. This commit adds the fixture that is received when an issue is assigned. This fixture helps in testing the integration for that event.
2023-04-03 06:29:21 +02:00
def test_issue_assigned(self) -> None:
integrations: Reformat Github issue assigned message body. Instead of adding the assignee to the end of the message body, we update the message body where the verb is so that the link formatting at the end of the message is not broken, for example: "user_a assigned user_b to [issue #XXX title text is here](link)." Also updates the issue title in the test fixture so that it tests that only the first instance of "assigned" or "unassigned" in the issue title is updated for the assignee text. Also adds punctuation to the issue title in the test fixture to test the expected behavior for titles that end in a value from `string.punctuation`.
2023-11-22 04:17:21 +01:00
expected_message = "sbansal1999 assigned sbansal1999 to [issue #7](https://github.com/sbansal1999/testing-gh/issues/7)."
expected_topic = "testing-gh / issue #7 Testing when issue assigned!"
webhooks: Add issue assigned fixture to GitHub Integration. This commit adds the fixture that is received when an issue is assigned. This fixture helps in testing the integration for that event.
2023-04-03 06:29:21 +02:00
self.check_webhook("issues__assigned", expected_topic, expected_message)
def test_issue_assigned_with_custom_topic_in_url(self) -> None:
self.url = self.build_webhook_url(topic="notifications")
expected_topic = "notifications"
integrations: Reformat Github issue assigned message body. Instead of adding the assignee to the end of the message body, we update the message body where the verb is so that the link formatting at the end of the message is not broken, for example: "user_a assigned user_b to [issue #XXX title text is here](link)." Also updates the issue title in the test fixture so that it tests that only the first instance of "assigned" or "unassigned" in the issue title is updated for the assignee text. Also adds punctuation to the issue title in the test fixture to test the expected behavior for titles that end in a value from `string.punctuation`.
2023-11-22 04:17:21 +01:00
expected_message = "sbansal1999 assigned sbansal1999 to [issue #7 Testing when issue assigned!](https://github.com/sbansal1999/testing-gh/issues/7)"
webhooks: Add issue assigned fixture to GitHub Integration. This commit adds the fixture that is received when an issue is assigned. This fixture helps in testing the integration for that event.
2023-04-03 06:29:21 +02:00
self.check_webhook("issues__assigned", expected_topic, expected_message)
webhooks: Add issue unassigned fixture to GitHub Integration. This commit adds the fixture that is received when an issue is unassigned. This fixture helps in testing the integration for that event.
2023-04-21 15:58:42 +02:00
def test_issue_unassigned(self) -> None:
webhooks: Rephrase message for Issue Assigned and Unassigned Events. This commit rephrases the message for Issue assigned and unassigned events for GitHub Integration.
2023-04-21 20:27:50 +02:00
expected_message = "sbansal1999 unassigned sbansal1999 from [issue #9](https://github.com/sbansal1999/testing-gh/issues/9)."
webhooks: Add issue unassigned fixture to GitHub Integration. This commit adds the fixture that is received when an issue is unassigned. This fixture helps in testing the integration for that event.
2023-04-21 15:58:42 +02:00
expected_topic = "testing-gh / issue #9 idk man"
self.check_webhook("issues__unassigned", expected_topic, expected_message)
def test_issue_unassigned_with_custom_topic_in_url(self) -> None:
self.url = self.build_webhook_url(topic="notifications")
expected_topic = "notifications"
webhooks: Rephrase message for Issue Assigned and Unassigned Events. This commit rephrases the message for Issue assigned and unassigned events for GitHub Integration.
2023-04-21 20:27:50 +02:00
expected_message = "sbansal1999 unassigned sbansal1999 from [issue #9 idk man](https://github.com/sbansal1999/testing-gh/issues/9)."
webhooks: Add issue unassigned fixture to GitHub Integration. This commit adds the fixture that is received when an issue is unassigned. This fixture helps in testing the integration for that event.
2023-04-21 15:58:42 +02:00
self.check_webhook("issues__unassigned", expected_topic, expected_message)
integrations: Add issue labeled fixture to GitHub Integration.
2023-06-03 21:32:55 +02:00
def test_issue_labeled(self) -> None:
expected_topic = "testing-gh / issue #9 idk man"
integrations: Remove label URL from GitHub issue labeled notifications. The URL is not the correct one and redirects to an API page.
2023-06-29 12:24:27 +02:00
expected_message = "[sbansal1999](https://github.com/sbansal1999) added the bug label to [Issue #9](https://github.com/sbansal1999/testing-gh/issues/9)."
integrations: Add issue labeled fixture to GitHub Integration.
2023-06-03 21:32:55 +02:00
self.check_webhook("issues__labeled", expected_topic, expected_message)
def test_issue_labeled_with_custom_topic_in_url(self) -> None:
self.url = self.build_webhook_url(topic="notifications")
expected_topic = "notifications"
integrations: Remove label URL from GitHub issue labeled notifications. The URL is not the correct one and redirects to an API page.
2023-06-29 12:24:27 +02:00
expected_message = "[sbansal1999](https://github.com/sbansal1999) added the bug label to [Issue #9 idk man](https://github.com/sbansal1999/testing-gh/issues/9)."
integrations: Add issue labeled fixture to GitHub Integration.
2023-06-03 21:32:55 +02:00
self.check_webhook("issues__labeled", expected_topic, expected_message)
integrations: Add issue unlabeled fixture to GitHub Integration.
2023-06-03 21:33:22 +02:00
def test_issue_unlabeled(self) -> None:
expected_topic = "testing-gh / issue #9 idk man"
integrations: Remove label URL from GitHub issue labeled notifications. The URL is not the correct one and redirects to an API page.
2023-06-29 12:24:27 +02:00
expected_message = "[sbansal1999](https://github.com/sbansal1999) removed the bug label from [Issue #9](https://github.com/sbansal1999/testing-gh/issues/9)."
integrations: Add issue unlabeled fixture to GitHub Integration.
2023-06-03 21:33:22 +02:00
self.check_webhook("issues__unlabeled", expected_topic, expected_message)
integrations: Add issue milestoned fixture to GitHub Integration.
2023-06-10 13:39:20 +02:00
def test_issue_milestoned(self) -> None:
expected_topic = "testing-gh / issue #6 This is a sample issue to test GH I..."
integrations: Improve GitHub issue milestoned notifications. Earlier, the notifications had no information about the milestone that was added or removed.
2023-06-13 15:48:40 +02:00
expected_message = "[sbansal1999](https://github.com/sbansal1999) added milestone [some_random_milestone](https://github.com/sbansal1999/testing-gh/milestone/1) to [issue #6](https://github.com/sbansal1999/testing-gh/issues/6)."
integrations: Add issue milestoned fixture to GitHub Integration.
2023-06-10 13:39:20 +02:00
self.check_webhook("issues__milestoned", expected_topic, expected_message)
def test_issue_milestoned_with_custom_topic_in_url(self) -> None:
self.url = self.build_webhook_url(topic="notifications")
expected_topic = "notifications"
integrations: Improve GitHub issue milestoned notifications. Earlier, the notifications had no information about the milestone that was added or removed.
2023-06-13 15:48:40 +02:00
expected_message = "[sbansal1999](https://github.com/sbansal1999) added milestone [some_random_milestone](https://github.com/sbansal1999/testing-gh/milestone/1) to [issue #6 This is a sample issue to test GH Integration Func](https://github.com/sbansal1999/testing-gh/issues/6)."
integrations: Add issue milestoned fixture to GitHub Integration.
2023-06-10 13:39:20 +02:00
self.check_webhook("issues__milestoned", expected_topic, expected_message)
integrations: Add issue demilestoned fixture to GitHub Integration.
2023-06-10 13:42:55 +02:00
def test_issue_demilestoned(self) -> None:
expected_topic = "testing-gh / issue #6 This is a sample issue to test GH I..."
integrations: Improve GitHub issue milestoned notifications. Earlier, the notifications had no information about the milestone that was added or removed.
2023-06-13 15:48:40 +02:00
expected_message = "[sbansal1999](https://github.com/sbansal1999) removed milestone [some_random_milestone](https://github.com/sbansal1999/testing-gh/milestone/1) from [issue #6](https://github.com/sbansal1999/testing-gh/issues/6)."
integrations: Add issue demilestoned fixture to GitHub Integration.
2023-06-10 13:42:55 +02:00
self.check_webhook("issues__demilestoned", expected_topic, expected_message)
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_membership_msg(self) -> None:
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
expected_message = (
"baxterthehacker added [kdaigle](https://github.com/kdaigle) to the Contractors team."
)
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("membership", TOPIC_ORGANIZATION, expected_message)
webhooks/github: Restrict membership event scope to teams. According to GitHub's webhook docs, the scope of a membership event can only be limited to 'teams', which holds true when a new member is added to a team. However, we just found a payload in our logs that indicates that when a user is removed from a team, the scope of the membership is erroneously set to 'organization', not 'team'. This is most likely a bug on GitHub's end because such behaviour is a direct violation of their webhook API event specifications. We account for this by restricting membership events to teams explicitly, at least till GitHub's docs suggest otherwise.
2019-03-09 21:06:44 +01:00
def test_membership_removal_msg(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_message = "baxterthehacker removed [kdaigle](https://github.com/kdaigle) from the Contractors team."
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("membership__removal", TOPIC_ORGANIZATION, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_member_msg(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_message = "baxterthehacker added [octocat](https://github.com/octocat) to [public-repo](https://github.com/baxterthehacker/public-repo)."
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("member", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_pull_request_opened_msg(self) -> None:
integration: Modify branch names on pull request events. Previously when Github bot receives an update pull request event,it will produce the following message: user updated PR #1 Start writing unit tests from test to main "from test to main" is improper and causes unnecessary confusion. These changes will update the logic to remove the phrase from update events. These changes will also include the org: prefix to the branch names to keep it consistent with Github and further reduce confusions on branch names. Fixes #24536.
2023-03-13 21:54:41 +01:00
expected_message = "baxterthehacker opened [PR #1](https://github.com/baxterthehacker/public-repo/pull/1) from `baxterthehacker:changes` to `baxterthehacker:master`:\n\n~~~ quote\nThis is a pretty simple change that we need to pull into master.\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("pull_request__opened", TOPIC_PR, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
webhooks/github: Test pull requests with preassigned assignees. This is a part of our efforts to get this webhook up to 100% test coverage.
2018-09-26 02:45:29 +02:00
def test_pull_request_opened_with_preassigned_assignee_msg(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 = "Scheduler / PR #4 Improve README"
integration: Move assignee message to the end for git integrations. Previously, the assignee message would stick around in the middle of the event message. This doesn't look as good as if we put it to the end of the event message. These changes does just that and move the assignee messages towards the end of the event message to make it look better and cleaner for the readers.
2023-03-28 20:25:22 +02:00
expected_message = "eeshangarg opened [PR #4](https://github.com/eeshangarg/Scheduler/pull/4) from `eeshangarg:improve-readme-2` to `eeshangarg:master` (assigned to eeshangarg)."
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(
"pull_request__opened_with_preassigned_assignee", expected_topic, expected_message
)
webhooks/github: Test pull requests with preassigned assignees. This is a part of our efforts to get this webhook up to 100% test coverage.
2018-09-26 02:45:29 +02:00
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
def test_pull_request_opened_msg_with_custom_topic_in_url(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="notifications")
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 = "notifications"
integration: Modify branch names on pull request events. Previously when Github bot receives an update pull request event,it will produce the following message: user updated PR #1 Start writing unit tests from test to main "from test to main" is improper and causes unnecessary confusion. These changes will update the logic to remove the phrase from update events. These changes will also include the org: prefix to the branch names to keep it consistent with Github and further reduce confusions on branch names. Fixes #24536.
2023-03-13 21:54:41 +01:00
expected_message = "baxterthehacker opened [PR #1 Update the README with new information](https://github.com/baxterthehacker/public-repo/pull/1) from `baxterthehacker:changes` to `baxterthehacker:master`:\n\n~~~ quote\nThis is a pretty simple change that we need to pull into master.\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("pull_request__opened", expected_topic, expected_message)
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +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_pull_request_synchronized_msg(self) -> None:
integration: Modify branch names on pull request events. Previously when Github bot receives an update pull request event,it will produce the following message: user updated PR #1 Start writing unit tests from test to main "from test to main" is improper and causes unnecessary confusion. These changes will update the logic to remove the phrase from update events. These changes will also include the org: prefix to the branch names to keep it consistent with Github and further reduce confusions on branch names. Fixes #24536.
2023-03-13 21:54:41 +01:00
expected_message = "baxterthehacker updated [PR #1](https://github.com/baxterthehacker/public-repo/pull/1)."
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("pull_request__synchronized", TOPIC_PR, expected_message)
Add handling synchronize PR event to github webhook integration.
2017-02-02 20:09:57 +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_pull_request_closed_msg(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_message = "baxterthehacker closed without merge [PR #1](https://github.com/baxterthehacker/public-repo/pull/1)."
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("pull_request__closed", TOPIC_PR, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
def test_pull_request_closed_msg_with_custom_topic_in_url(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="notifications")
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 = "notifications"
expected_message = "baxterthehacker closed without merge [PR #1 Update the README with new information](https://github.com/baxterthehacker/public-repo/pull/1)."
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("pull_request__closed", expected_topic, expected_message)
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +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_pull_request_merged_msg(self) -> None:
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
expected_message = (
"baxterthehacker merged [PR #1](https://github.com/baxterthehacker/public-repo/pull/1)."
)
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("pull_request__merged", TOPIC_PR, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_public_msg(self) -> None:
webhooks/github: Include full repository name in notification messages. This changes the notification messages for events that currently just include the string `"the repository"` to also include the full (`org/repo`) name of the affected repository. Messages for the following events are changed: - `public` - `star` - `watch` - `repository` - `team_add` Background: we're using the GitHub integration for org-wide notifications for the [Bytecode Alliance Zulip](bytecodealliance.zulipchat.com/), and having all messages just say "the repository" isn't ideal. Even now one can hover over the link to see the repo's url, but it'd be much nicer if the message just contained the full name. I also changed the message for `star` to include a link to the repository, same as the `watch` notification.
2020-06-27 13:19:32 +02:00
expected_message = "baxterthehacker made the repository [baxterthehacker/public-repo](https://github.com/baxterthehacker/public-repo) public."
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("public", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_wiki_pages_msg(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_message = "jasonrudolph:\n* created [Home](https://github.com/baxterthehacker/public-repo/wiki/Home)\n* created [Home](https://github.com/baxterthehacker/public-repo/wiki/Home)"
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("gollum__wiki_pages", TOPIC_WIKI, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_watch_msg(self) -> None:
webhooks/github: Include full repository name in notification messages. This changes the notification messages for events that currently just include the string `"the repository"` to also include the full (`org/repo`) name of the affected repository. Messages for the following events are changed: - `public` - `star` - `watch` - `repository` - `team_add` Background: we're using the GitHub integration for org-wide notifications for the [Bytecode Alliance Zulip](bytecodealliance.zulipchat.com/), and having all messages just say "the repository" isn't ideal. Even now one can hover over the link to see the repo's url, but it'd be much nicer if the message just contained the full name. I also changed the message for `star` to include a link to the repository, same as the `watch` notification.
2020-06-27 13:19:32 +02:00
expected_message = "baxterthehacker starred the repository [baxterthehacker/public-repo](https://github.com/baxterthehacker/public-repo)."
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("watch__repository", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_repository_msg(self) -> None:
webhooks/github: Include full repository name in notification messages. This changes the notification messages for events that currently just include the string `"the repository"` to also include the full (`org/repo`) name of the affected repository. Messages for the following events are changed: - `public` - `star` - `watch` - `repository` - `team_add` Background: we're using the GitHub integration for org-wide notifications for the [Bytecode Alliance Zulip](bytecodealliance.zulipchat.com/), and having all messages just say "the repository" isn't ideal. Even now one can hover over the link to see the repo's url, but it'd be much nicer if the message just contained the full name. I also changed the message for `star` to include a link to the repository, same as the `watch` notification.
2020-06-27 13:19:32 +02:00
expected_message = "baxterthehacker created the repository [baxterandthehackers/public-repo](https://github.com/baxterandthehackers/public-repo)."
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("repository", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_team_add_msg(self) -> None:
webhooks/github: Include full repository name in notification messages. This changes the notification messages for events that currently just include the string `"the repository"` to also include the full (`org/repo`) name of the affected repository. Messages for the following events are changed: - `public` - `star` - `watch` - `repository` - `team_add` Background: we're using the GitHub integration for org-wide notifications for the [Bytecode Alliance Zulip](bytecodealliance.zulipchat.com/), and having all messages just say "the repository" isn't ideal. Even now one can hover over the link to see the repo's url, but it'd be much nicer if the message just contained the full name. I also changed the message for `star` to include a link to the repository, same as the `watch` notification.
2020-06-27 13:19:32 +02:00
expected_message = "The repository [baxterandthehackers/public-repo](https://github.com/baxterandthehackers/public-repo) was added to team github."
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("team_add", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +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_release_msg(self) -> None:
integrations: Use new function in Github releases. Use get_release_event_message from webhooks/git.py to format release events using the newly implemented release message template. Tweaked by tabbott to handle name=None. Builds on #14746. Proposed in #14934.
2020-05-12 02:39:57 +02:00
expected_message = "baxterthehacker published release [0.0.1](https://github.com/baxterthehacker/public-repo/releases/tag/0.0.1) for tag 0.0.1."
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("release", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
github: Strengthen types using WildValue.
2022-04-03 11:08:49 +02:00
def test_release_msg_with_name(self) -> None:
expected_message = "baxterthehacker published release [0.0.1](https://github.com/baxterthehacker/public-repo/releases/tag/0.0.1) for tag 0.0.1."
self.check_webhook("release__with_name", TOPIC_REPO, expected_message)
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_page_build_msg(self) -> None:
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
expected_message = (
"GitHub Pages build, triggered by baxterthehacker, has finished building."
)
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("page_build", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
github: Strengthen types using WildValue.
2022-04-03 11:08:49 +02:00
def test_page_build_errored_msg(self) -> None:
expected_message = "GitHub Pages build, triggered by baxterthehacker, has failed: \n~~~ quote\nSomething went wrong.\n~~~."
self.check_webhook("page_build__errored", TOPIC_REPO, expected_message)
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_msg(self) -> None:
webhooks: Use get_short_sha to get shortened sha. This unifies the length of the shortened SHA our integrations generate, and ensures that they are long enough for projects of various sizes with a chosen value defined in get_short_sha. Fixes #23475 Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:24:35 +01:00
expected_message = "[9049f1265b7](https://github.com/baxterthehacker/public-repo/commit/9049f1265b7d61be4a8904a9a27120d2064dab3b) changed its status to success."
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("status", TOPIC_REPO, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
webhooks/github: Test commit status payloads with target_url. It was a painful amount of work to generate the actual payload. Since the only difference was a small build URL, I manually edited the payload and used that for testing. This commit gets our GitHub webhook up to 100% test coverage.
2018-09-27 22:41:43 +02:00
def test_status_with_target_url_msg(self) -> None:
webhooks: Use get_short_sha to get shortened sha. This unifies the length of the shortened SHA our integrations generate, and ensures that they are long enough for projects of various sizes with a chosen value defined in get_short_sha. Fixes #23475 Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:24:35 +01:00
expected_message = "[9049f1265b7](https://github.com/baxterthehacker/public-repo/commit/9049f1265b7d61be4a8904a9a27120d2064dab3b) changed its status to [success](https://example.com/build/status)."
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("status__with_target_url", TOPIC_REPO, expected_message)
webhooks/github: Test commit status payloads with target_url. It was a painful amount of work to generate the actual payload. Since the only difference was a small build URL, I manually edited the payload and used that for testing. This commit gets our GitHub webhook up to 100% test coverage.
2018-09-27 22:41:43 +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_pull_request_review_msg(self) -> None:
webhooks: Add body to PR Review Event message for GitHub Integration. This commit passes the body of the PR Review as the message to the helper function that generates the message to be sent by the GitHub Integration. Previously when a PR Review was done the message sent would just include the link of the review but the message didn't include the body the review. After this commit, the message also includes the body of the review. Fixes #24676
2023-04-04 04:22:00 +02:00
expected_message = "baxterthehacker submitted [PR review](https://github.com/baxterthehacker/public-repo/pull/1#pullrequestreview-2626884):\n\n~~~ quote\nLooks great!\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("pull_request_review", TOPIC_PR, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
def test_pull_request_review_msg_with_custom_topic_in_url(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="notifications")
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 = "notifications"
webhooks: Add body to PR Review Event message for GitHub Integration. This commit passes the body of the PR Review as the message to the helper function that generates the message to be sent by the GitHub Integration. Previously when a PR Review was done the message sent would just include the link of the review but the message didn't include the body the review. After this commit, the message also includes the body of the review. Fixes #24676
2023-04-04 04:22:00 +02:00
expected_message = "baxterthehacker submitted [PR review for #1 Update the README with new information](https://github.com/baxterthehacker/public-repo/pull/1#pullrequestreview-2626884):\n\n~~~ quote\nLooks great!\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("pull_request_review", expected_topic, expected_message)
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
integrations: Allow null pull request review body in GitHub Integration. There are instances in which the pull request review body can be null. Fixes #26055.
2023-06-26 20:35:14 +02:00
def test_pull_request_review_msg_with_empty_body(self) -> None:
expected_topic = "groonga / PR #1581 grn_db_value_lock: unlock GRN_TYPE obj..."
expected_message = "kou submitted [PR review](https://github.com/groonga/groonga/pull/1581#pullrequestreview-1483047907)."
self.check_webhook("pull_request_review__empty_body", expected_topic, expected_message)
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_pull_request_review_comment_msg(self) -> None:
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
expected_message = "baxterthehacker created [PR review comment](https://github.com/baxterthehacker/public-repo/pull/1#discussion_r29724692):\n\n~~~ quote\nMaybe you should use more emojji on this line.\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("pull_request_review_comment", TOPIC_PR, expected_message)
Add github webhook integration.
2016-10-25 14:50:42 +02:00
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
def test_pull_request_review_comment_with_custom_topic_in_url(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="notifications")
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 = "notifications"
docs: Fix capitalization mistakes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-05-10 07:02:14 +02:00
expected_message = "baxterthehacker created [PR review comment on #1 Update the README with new information](https://github.com/baxterthehacker/public-repo/pull/1#discussion_r29724692):\n\n~~~ quote\nMaybe you should use more emojji on this line.\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("pull_request_review_comment", expected_topic, expected_message)
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
webhooks: Add support for more GitHub pull_request events. Add support for the locked, unlocked, auto-merge-enabled, and auto-merge-disabled actions for the pull_request event. Fixes #16258.
2021-03-01 23:16:08 +01:00
def test_pull_request_locked(self) -> None:
expected_message = "tushar912 has locked [PR #1](https://github.com/tushar912/public-repo/pull/1) as off-topic and limited conversation to collaborators."
self.check_webhook("pull_request__locked", TOPIC_PR, expected_message)
def test_pull_request_unlocked(self) -> None:
expected_message = (
"tushar912 has unlocked [PR #1](https://github.com/tushar912/public-repo/pull/1)."
)
self.check_webhook("pull_request__unlocked", TOPIC_PR, expected_message)
def test_pull_request_auto_merge_enabled(self) -> None:
expected_message = "tushar912 has enabled auto merge for [PR #1](https://github.com/tushar912/public-repo/pull/1)."
self.check_webhook("pull_request__auto_merge_enabled", TOPIC_PR, expected_message)
def test_pull_request_auto_merge_disabled(self) -> None:
expected_message = "tushar912 has disabled auto merge for [PR #1](https://github.com/tushar912/public-repo/pull/1)."
self.check_webhook("pull_request__auto_merge_disabled", TOPIC_PR, expected_message)
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_push_tag_msg(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_message = "baxterthehacker pushed tag abc."
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("push__tag", TOPIC_REPO, expected_message)
Add PR edited, assigned and unassigned to github webhook integration.
2017-02-08 20:41:43 +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_pull_request_edited_msg(self) -> None:
integration: Modify branch names on pull request events. Previously when Github bot receives an update pull request event,it will produce the following message: user updated PR #1 Start writing unit tests from test to main "from test to main" is improper and causes unnecessary confusion. These changes will update the logic to remove the phrase from update events. These changes will also include the org: prefix to the branch names to keep it consistent with Github and further reduce confusions on branch names. Fixes #24536.
2023-03-13 21:54:41 +01:00
expected_message = (
"baxterthehacker edited [PR #1](https://github.com/baxterthehacker/public-repo/pull/1)."
)
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("pull_request__edited", TOPIC_PR, expected_message)
Add PR edited, assigned and unassigned to github webhook integration.
2017-02-08 20:41:43 +01:00
webhooks/github: Fix repeating description for edits and updates. This change updates the GitHub Integration webhook get_opened_or_update_pull_request_body method so that the description is only printed if it actually changes. If the update event is a result of some other attribute update, such as an asignee change, then the description is not included in the message sent to the zulip stream. Fixes #16345
2020-11-23 09:15:42 +01:00
def test_pull_request_edited_with_body_change(self) -> None:
integration: Modify branch names on pull request events. Previously when Github bot receives an update pull request event,it will produce the following message: user updated PR #1 Start writing unit tests from test to main "from test to main" is improper and causes unnecessary confusion. These changes will update the logic to remove the phrase from update events. These changes will also include the org: prefix to the branch names to keep it consistent with Github and further reduce confusions on branch names. Fixes #24536.
2023-03-13 21:54:41 +01:00
expected_message = "cozyrohan edited [PR #1](https://github.com/cozyrohan/public-repo/pull/1):\n\n~~~ quote\nPR EDITED\n~~~"
webhooks/github: Fix repeating description for edits and updates. This change updates the GitHub Integration webhook get_opened_or_update_pull_request_body method so that the description is only printed if it actually changes. If the update event is a result of some other attribute update, such as an asignee change, then the description is not included in the message sent to the zulip stream. Fixes #16345
2020-11-23 09:15:42 +01:00
self.check_webhook("pull_request__edited_with_body_change", TOPIC_PR, expected_message)
def test_pull_request_synchronized_with_body(self) -> None:
integration: Modify branch names on pull request events. Previously when Github bot receives an update pull request event,it will produce the following message: user updated PR #1 Start writing unit tests from test to main "from test to main" is improper and causes unnecessary confusion. These changes will update the logic to remove the phrase from update events. These changes will also include the org: prefix to the branch names to keep it consistent with Github and further reduce confusions on branch names. Fixes #24536.
2023-03-13 21:54:41 +01:00
expected_message = "baxterthehacker updated [PR #1](https://github.com/baxterthehacker/public-repo/pull/1)."
webhooks/github: Fix repeating description for edits and updates. This change updates the GitHub Integration webhook get_opened_or_update_pull_request_body method so that the description is only printed if it actually changes. If the update event is a result of some other attribute update, such as an asignee change, then the description is not included in the message sent to the zulip stream. Fixes #16345
2020-11-23 09:15:42 +01:00
self.check_webhook("pull_request__synchronized_with_body", TOPIC_PR, expected_message)
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_pull_request_assigned_msg(self) -> None:
integrations: Reformat Github pull request assigned message body. Instead of adding the assignee to the end of the message body, we update the message body where the verb is so that the link formatting at the end of the message is not broken, for example: "user_a assigned user_b to [issue #XXX title text is here](link)." This matches the formatting for the issue assigned message body.
2023-11-22 16:33:57 +01:00
expected_message = "baxterthehacker assigned baxterthehacker to [PR #1](https://github.com/baxterthehacker/public-repo/pull/1)."
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("pull_request__assigned", TOPIC_PR, expected_message)
Add PR edited, assigned and unassigned to github webhook integration.
2017-02-08 20:41:43 +01:00
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
def test_pull_request_assigned_msg_with_custom_topic_in_url(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="notifications")
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 = "notifications"
integrations: Reformat Github pull request assigned message body. Instead of adding the assignee to the end of the message body, we update the message body where the verb is so that the link formatting at the end of the message is not broken, for example: "user_a assigned user_b to [issue #XXX title text is here](link)." This matches the formatting for the issue assigned message body.
2023-11-22 16:33:57 +01:00
expected_message = "baxterthehacker assigned baxterthehacker to [PR #1 Update the README with new information](https://github.com/baxterthehacker/public-repo/pull/1)."
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("pull_request__assigned", expected_topic, expected_message)
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +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_pull_request_unassigned_msg(self) -> None:
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
expected_message = (
"eeshangarg unassigned [PR #1](https://github.com/zulip-test-org/helloworld/pull/1)."
)
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(
"pull_request__unassigned",
"helloworld / PR #1 Mention that Zulip rocks!",
expected_message,
)
github: Add list and fixtures for ignored events to webhook.
2017-02-08 21:30:25 +01:00
webhooks/github: Add support for pull request ready for review. GitHub supports opening a draft/WIP pull request and then marking it as ready for review later on. This PR supports the ready_for_review action for pull_request events. Signed-off-by: Hemanth V. Alluri <hdrive1999@gmail.com>
2020-05-12 15:25:08 +02:00
def test_pull_request_ready_for_review_msg(self) -> None:
expected_message = "**Hypro999** has marked [PR #2](https://github.com/Hypro999/temp-test-github-webhook/pull/2) as ready for review."
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(
"pull_request__ready_for_review",
"temp-test-github-webhook / PR #2 Test",
expected_message,
)
webhooks/github: Add support for pull request ready for review. GitHub supports opening a draft/WIP pull request and then marking it as ready for review later on. This PR supports the ready_for_review action for pull_request events. Signed-off-by: Hemanth V. Alluri <hdrive1999@gmail.com>
2020-05-12 15:25:08 +02:00
webhooks/github: Add support for PR review requests. Fixes: #9732.
2018-07-01 20:40:08 +02:00
def test_pull_request_review_requested_msg(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_message = "**eeshangarg** requested [showell](https://github.com/showell) for a review on [PR #1](https://github.com/eeshangarg/Scheduler/pull/1)."
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(
"pull_request__review_requested",
"Scheduler / PR #1 This is just a test commit",
expected_message,
)
webhooks/github: Add support for PR review requests. Fixes: #9732.
2018-07-01 20:40:08 +02:00
webhooks: Add team reviewers support in github webhook. The github webhook implementation previously ignored the "team reviewers" part of pull_request events, resulting in inaccurate output. Fixes: #14096.
2020-03-11 00:29:59 +01:00
def test_pull_request__review_requested_team_reviewer_msg(self) -> None:
integrations: Fix bug with github multiple reviews requested on PR. Fixes a bug in which multiple of the same messages are posted when multiple reviewers are added to a PR. Fixes #18393.
2021-05-08 04:11:09 +02:00
expected_message = "**singhsourabh** requested [authority](https://github.com/orgs/test-org965/teams/authority) for a review on [PR #4](https://github.com/test-org965/webhook-test/pull/4)."
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(
"pull_request__review_requested_team_reviewer",
"webhook-test / PR #4 testing webhook",
expected_message,
)
webhooks: Add team reviewers support in github webhook. The github webhook implementation previously ignored the "team reviewers" part of pull_request events, resulting in inaccurate output. Fixes: #14096.
2020-03-11 00:29:59 +01:00
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
def test_pull_request_review_requested_with_custom_topic_in_url(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="notifications")
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 = "notifications"
expected_message = "**eeshangarg** requested [showell](https://github.com/showell) for a review on [PR #1 This is just a test commit](https://github.com/eeshangarg/Scheduler/pull/1)."
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("pull_request__review_requested", expected_topic, expected_message)
webhooks/github: Include title in message body if not in topic. This is a follow-up in response to Tim's comments on #9951. In instances where all messages from a GitHub integration are grouped under one user specified topic (specified in the URL), we should include the title of the issue/PR in the message body, since the availability of a user-specified topic precludes us from including it in the topic itself (which was the default behaviour).
2018-07-20 21:36:18 +02:00
webhook/github: Support check_run events. We only support notifications for events where a check run has completed. Notifications for when a check run has been queued or is in progress are not very informative and may be too noisy.
2019-02-19 21:16:41 +01:00
def test_check_run(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 = "hello-world / checks"
expected_message = """
webhooks: Use get_short_sha to get shortened sha. This unifies the length of the shortened SHA our integrations generate, and ensures that they are long enough for projects of various sizes with a chosen value defined in get_short_sha. Fixes #23475 Signed-off-by: Zixuan James Li <p359101898@gmail.com>
2022-11-07 21:24:35 +01:00
Check [randscape](http://github.com/github/hello-world/runs/4) completed (success). ([d6fde92930d](http://github.com/github/hello-world/commit/d6fde92930d4715a2b49857d24b940956b26d2d3))
webhook/github: Support check_run events. We only support notifications for events where a check run has completed. Notifications for when a check run has been queued or is in progress are not very informative and may be too noisy.
2019-02-19 21:16:41 +01:00
""".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("check_run__completed", expected_topic, expected_message)
webhook/github: Support check_run events. We only support notifications for events where a check run has completed. Notifications for when a check run has been queued or is in progress are not very informative and may be too noisy.
2019-02-19 21:16:41 +01:00
webhooks/github: Add a support for team/edited events. Signed-off-by: Hemanth V. Alluri <hdrive1999@gmail.com>
2020-05-14 14:20:05 +02:00
def test_team_edited_description(self) -> None:
expected_topic = "team Testing"
expected_message = """\
**Hypro999** changed the team description to:
```quote
A temporary team so that I can get some webhook fixtures!
```"""
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("team__edited_description", expected_topic, expected_message)
webhooks/github: Add a support for team/edited events. Signed-off-by: Hemanth V. Alluri <hdrive1999@gmail.com>
2020-05-14 14:20:05 +02:00
def test_team_edited_name(self) -> None:
expected_topic = "team Testing Team"
expected_message = """Team `Testing` was renamed to `Testing Team`."""
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("team__edited_name", expected_topic, expected_message)
webhooks/github: Add a support for team/edited events. Signed-off-by: Hemanth V. Alluri <hdrive1999@gmail.com>
2020-05-14 14:20:05 +02:00
def test_team_edited_privacy(self) -> None:
expected_topic = "team Testing Team"
expected_message = """Team visibility changed to `secret`"""
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("team__edited_privacy_secret", expected_topic, expected_message)
webhooks/github: Add a support for team/edited events. Signed-off-by: Hemanth V. Alluri <hdrive1999@gmail.com>
2020-05-14 14:20:05 +02:00
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
def verify_post_is_ignored(self, payload: str, http_x_github_event: str) -> None:
with patch("zerver.webhooks.github.view.check_send_webhook_message") as m:
result = self.client_post(
self.url,
payload,
HTTP_X_GITHUB_EVENT=http_x_github_event,
content_type="application/json",
)
self.assertFalse(m.called)
webhook/github: Support check_run events. We only support notifications for events where a check run has completed. Notifications for when a check run has been queued or is in progress are not very informative and may be too noisy.
2019-02-19 21:16:41 +01:00
self.assert_json_success(result)
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
def test_check_run_in_progress_ignore(self) -> None:
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("check_run__in_progress")
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
self.verify_post_is_ignored(payload, "check_run")
github tests: Extract test_ignored_pull_request_actions. We consolidate the tests and remove the fixtures, which just have a lot of noisy fields that we ignore. Also, pull_request__request_review_removed was named improperly.
2020-09-01 13:52:36 +02:00
def test_ignored_pull_request_actions(self) -> None:
ignored_actions = [
github webhook: Ignore more pull_request actions. See https://github.com/zulip/zulip/issues/16258 for possible follow up here. We now ignore the following two new pull_request actions (as well as the three existing ones from before): approved converted_to_draft As the issue above indicates, we may want to actually support "approved" if we can find somebody to work on the webhook. (And then the issue goes a little broader than what changed here.)
2020-09-01 14:19:33 +02:00
"approved",
"converted_to_draft",
github tests: Extract test_ignored_pull_request_actions. We consolidate the tests and remove the fixtures, which just have a lot of noisy fields that we ignore. Also, pull_request__request_review_removed was named improperly.
2020-09-01 13:52:36 +02:00
"labeled",
"review_request_removed",
"unlabeled",
]
for action in ignored_actions:
data = dict(action=action)
payload = orjson.dumps(data).decode()
self.verify_post_is_ignored(payload, "pull_request")
github_webhook: Filter specific GitHub branches. Fixes: #4000
2017-03-25 03:23:15 +01:00
github webhook: Explicitly ignore team actions.
2020-09-01 15:07:08 +02:00
def test_ignored_team_actions(self) -> None:
ignored_actions = [
"added_to_repository",
"created",
"deleted",
"removed_from_repository",
]
for action in ignored_actions:
data = dict(action=action)
payload = orjson.dumps(data).decode()
self.verify_post_is_ignored(payload, "team")
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
def test_push_1_commit_filtered_by_branches_ignore(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(branches="master,development")
payload = self.get_body("push__1_commit")
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
self.verify_post_is_ignored(payload, "push")
github_webhook: Filter specific GitHub branches. Fixes: #4000
2017-03-25 03:23:15 +01:00
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
def test_push_50_commits_filtered_by_branches_ignore(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(branches="master,development")
payload = self.get_body("push__50_commits")
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
self.verify_post_is_ignored(payload, "push")
webhooks: Stop overriding build_webhook_url for URL query parameters.
2017-04-21 23:35:40 +02:00
Fix typos caught by typos. https://github.com/crate-ci/typos Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-01-02 20:50:23 +01:00
def test_push_multiple_committers_filtered_by_branches_ignore(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(branches="master,development")
payload = self.get_body("push__multiple_committers")
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
self.verify_post_is_ignored(payload, "push")
webhooks: Stop overriding build_webhook_url for URL query parameters.
2017-04-21 23:35:40 +02:00
Fix typos caught by typos. https://github.com/crate-ci/typos Signed-off-by: Anders Kaseorg <anders@zulip.com>
2023-01-02 20:50:23 +01:00
def test_push_multiple_committers_with_others_filtered_by_branches_ignore(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(branches="master,development")
payload = self.get_body("push__multiple_committers_with_others")
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
self.verify_post_is_ignored(payload, "push")
webhooks/github: Ignore repository_vulnerability_alert event. This event isn't incredibly common/useful and errors for this event were cluttering up our webhook logs.
2019-02-19 20:17:40 +01:00
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
def test_repository_vulnerability_alert_ignore(self) -> None:
webhooks/github: Ignore repository_vulnerability_alert event. This event isn't incredibly common/useful and errors for this event were cluttering up our webhook logs.
2019-02-19 20:17:40 +01:00
self.url = self.build_webhook_url()
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("repository_vulnerability_alert")
github tests: Extract verify_post_is_ignored.
2020-08-22 15:50:15 +02:00
self.verify_post_is_ignored(payload, "repository_vulnerability_alert")
github tests: Add test_ignored_events.
2020-09-01 13:28:33 +02:00
def test_ignored_events(self) -> None:
# The payload for these events never gets looked at in the
# webhook itself; it only needs to be valid JSON.
payload = "{}"
ignored_events = [
"check_suite",
"label",
"meta",
"milestone",
"organization",
"project_card",
"repository_vulnerability_alert",
]
for event in ignored_events:
self.verify_post_is_ignored(payload, event)
github tests: Add test_team_edited_error_handling. This doesn't test much interesting yet, but it will soon.
2020-09-01 23:24:17 +02:00
github webhook: Always send messages for team edits. If there are unsupported keys, we still log an error, but we now also send a message to the stream. (This is a good tradeoff for the github webhook, since users can just turn off notifications if they find it spammy. Also, we intend to support "repository" soon.) This is a bit of an experiment to see how this plays in the field: * will customers notice the change? * will Sentry reports look any different?
2020-09-02 15:15:50 +02:00
def test_team_edited_with_unsupported_keys(self) -> None:
self.subscribe(self.test_user, self.STREAM_NAME)
github tests: Add test_team_edited_error_handling. This doesn't test much interesting yet, but it will soon.
2020-09-01 23:24:17 +02:00
event = "team"
payload = dict(
action="edited",
changes=dict(
bogus_key1={},
bogus_key2={},
),
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
team=dict(name="My Team"),
github tests: Add test_team_edited_error_handling. This doesn't test much interesting yet, but it will soon.
2020-09-01 23:24:17 +02:00
)
webhooks: Rename UnexpectedWebhookEventType to UnsupportedWebhookEventType. Any exception is an "unexpected event", which means talking about having an "unexpected event logger" or "unexpected event exception" is confusing. As the error message in `exceptions.py` already explains, this is about an _unsupported_ event type. This also switches the path that these exceptions are written to, accordingly.
2020-08-19 22:26:38 +02:00
log_mock = patch("zerver.decorator.webhook_unsupported_events_logger.exception")
github tests: Add test_team_edited_error_handling. This doesn't test much interesting yet, but it will soon.
2020-09-01 23:24:17 +02:00
with log_mock as m:
github webhook: Always send messages for team edits. If there are unsupported keys, we still log an error, but we now also send a message to the stream. (This is a good tradeoff for the github webhook, since users can just turn off notifications if they find it spammy. Also, we intend to support "repository" soon.) This is a bit of an experiment to see how this plays in the field: * will customers notice the change? * will Sentry reports look any different?
2020-09-02 15:15:50 +02:00
stream_message = self.send_webhook_payload(
self.test_user,
github tests: Add test_team_edited_error_handling. This doesn't test much interesting yet, but it will soon.
2020-09-01 23:24:17 +02:00
self.url,
payload,
HTTP_X_GITHUB_EVENT=event,
content_type="application/json",
)
github webhook: Always send messages for team edits. If there are unsupported keys, we still log an error, but we now also send a message to the stream. (This is a good tradeoff for the github webhook, since users can just turn off notifications if they find it spammy. Also, we intend to support "repository" soon.) This is a bit of an experiment to see how this plays in the field: * will customers notice the change? * will Sentry reports look any different?
2020-09-02 15:15:50 +02:00
self.assert_stream_message(
message=stream_message,
stream_name=self.STREAM_NAME,
topic_name="team My Team",
python: Reformat with Black, except quotes. Signed-off-by: Anders Kaseorg <anders@zulip.com>
2021-02-12 08:19:30 +01:00
content="Team has changes to `bogus_key1/bogus_key2` data.",
github webhook: Always send messages for team edits. If there are unsupported keys, we still log an error, but we now also send a message to the stream. (This is a good tradeoff for the github webhook, since users can just turn off notifications if they find it spammy. Also, we intend to support "repository" soon.) This is a bit of an experiment to see how this plays in the field: * will customers notice the change? * will Sentry reports look any different?
2020-09-02 15:15:50 +02:00
)
github tests: Add test_team_edited_error_handling. This doesn't test much interesting yet, but it will soon.
2020-09-01 23:24:17 +02:00
m.assert_called_once()
msg = m.call_args[0][0]
stack_info = m.call_args[1]["stack_info"]
github webhooks: Fix message for unsupported team payloads. The main thing fixed here is that we weren't turning on our keys into a list. And then I refined the message a bit more, including sorting the keys. I also avoid the unnecessary "else".
2020-09-02 14:23:52 +02:00
self.assertIn(
webhooks: Use 200 status code for unknown events. Because the third party might not be expecting a 400 from our webhooks, we now instead use 200 status code for unknown events, while sending back the error to Sentry. Because it is no longer an error response, the response type should now be "success". Fixes #24721.
2023-04-04 07:09:30 +02:00
"The 'team/edited (changes: bogus_key1/bogus_key2)' event isn't currently supported by the GitHub webhook; ignoring",
github webhooks: Fix message for unsupported team payloads. The main thing fixed here is that we weren't turning on our keys into a list. And then I refined the message a bit more, including sorting the keys. I also avoid the unnecessary "else".
2020-09-02 14:23:52 +02:00
msg,
)
github tests: Add test_team_edited_error_handling. This doesn't test much interesting yet, but it will soon.
2020-09-01 23:24:17 +02:00
self.assertTrue(stack_info)
webhooks: Add support for GitHub discussions messages. We aim to use Zulip topics thoughtfully in displaying messages from discussions, as well as linking to the discussion in every message so that it's easy to view them. Fixes #19938.
2021-10-18 13:33:38 +02:00
def test_discussion_msg(self) -> None:
webhooks/github: Include discussion ID in messages. We add discussion id and url in the comments and highlighted title to the body of disscussion message to make it more meaningful and accessible. Fixes #19938.
2021-10-23 18:59:57 +02:00
expected_message = "Codertocat created [discussion #90](https://github.com/baxterthehacker/public-repo/discussions/90) in General:\n```quote\n### Welcome to discussions!\nWe're glad to have you here!\n```"
webhooks: Add support for GitHub discussions messages. We aim to use Zulip topics thoughtfully in displaying messages from discussions, as well as linking to the discussion in every message so that it's easy to view them. Fixes #19938.
2021-10-18 13:33:38 +02:00
self.check_webhook("discussion", TOPIC_DISCUSSION, expected_message)
def test_discussion_comment_msg(self) -> None:
webhooks/github: Include discussion ID in messages. We add discussion id and url in the comments and highlighted title to the body of disscussion message to make it more meaningful and accessible. Fixes #19938.
2021-10-23 18:59:57 +02:00
expected_message = "Codertocat [commented](https://github.com/baxterthehacker/public-repo/discussions/90#discussioncomment-544078) on [discussion #90](https://github.com/baxterthehacker/public-repo/discussions/90):\n```quote\nI have so many questions to ask you!\n```"
webhooks: Add support for GitHub discussions messages. We aim to use Zulip topics thoughtfully in displaying messages from discussions, as well as linking to the discussion in every message so that it's easy to view them. Fixes #19938.
2021-10-18 13:33:38 +02:00
self.check_webhook("discussion_comment", TOPIC_DISCUSSION, expected_message)