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

49 lines
2.2 KiB
Python
Raw Normal View History

integrations: Add Gocd webhook integration. Fixes #38.
2018-01-28 18:09:08 +01:00
from zerver.lib.test_classes import WebhookTestCase
python: Sort webhooks imports with isort.
2020-01-14 22:06:24 +01:00
integrations: Add Gocd webhook integration. Fixes #38.
2018-01-28 18:09:08 +01:00
class GocdHookTests(WebhookTestCase):
webhooks: Rename STREAM_NAME to CHANNEL_NAME in tests.
2024-05-04 22:02:50 +02:00
CHANNEL_NAME = "gocd"
integrations: Add Gocd webhook integration. Fixes #38.
2018-01-28 18:09:08 +01:00
URL_TEMPLATE = "/api/v1/external/gocd?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 = "gocd"
integrations: Update GoCD integration. Previously, the GoCD integration relied on GoCD's integration with bug tracking and monitoring tools through the users' Config XML file [1]. However, this feature no longer works as expected, as it cannot send HTTPS payloads to an external endpoint. This commit updates our GoCD integration to use Sentry's WebHook notifier GoCD plugin [2] to send webhook payloads from users GoCD server to Zulip. We are using an older version of the plugin—v0.0.6—because the newer version—v0.0.9—doesn't work at this time. Additionally, this change reformats the notifications to include more details on the GoCD event, such as lists of passed and failed jobs. Fixes #21224. Co-authored-by: Pieter CK <pieterceka123@gmail.com> [1]: https://docs.gocd.org/current/integration/#integration-with-bug-tracking-and-story-management-tools [2]: https://github.com/getsentry/gocd-webhook-notification-plugin/releases/tag/v0.0.6
2024-01-30 02:11:11 +01:00
def test_building_pipeline(self) -> None:
expected_topic = "Pipeline / Stage"
expected_message = """**Pipeline building**: Pipeline / Stage
- **Commit**: [`59f3c6e4540`](https://github.com/swayam0322/Test/commit/59f3c6e4540) on branch `main`
- **Started**: Feb 1, 2024, 1:58:13 AM"""
integrations: Add Gocd webhook integration. Fixes #38.
2018-01-28 18:09:08 +01: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(
integrations: Update GoCD integration. Previously, the GoCD integration relied on GoCD's integration with bug tracking and monitoring tools through the users' Config XML file [1]. However, this feature no longer works as expected, as it cannot send HTTPS payloads to an external endpoint. This commit updates our GoCD integration to use Sentry's WebHook notifier GoCD plugin [2] to send webhook payloads from users GoCD server to Zulip. We are using an older version of the plugin—v0.0.6—because the newer version—v0.0.9—doesn't work at this time. Additionally, this change reformats the notifications to include more details on the GoCD event, such as lists of passed and failed jobs. Fixes #21224. Co-authored-by: Pieter CK <pieterceka123@gmail.com> [1]: https://docs.gocd.org/current/integration/#integration-with-bug-tracking-and-story-management-tools [2]: https://github.com/getsentry/gocd-webhook-notification-plugin/releases/tag/v0.0.6
2024-01-30 02:11:11 +01:00
"pipeline_building",
expected_topic,
integrations: Add Gocd webhook integration. Fixes #38.
2018-01-28 18:09:08 +01:00
expected_message,
)
integrations: Update GoCD integration. Previously, the GoCD integration relied on GoCD's integration with bug tracking and monitoring tools through the users' Config XML file [1]. However, this feature no longer works as expected, as it cannot send HTTPS payloads to an external endpoint. This commit updates our GoCD integration to use Sentry's WebHook notifier GoCD plugin [2] to send webhook payloads from users GoCD server to Zulip. We are using an older version of the plugin—v0.0.6—because the newer version—v0.0.9—doesn't work at this time. Additionally, this change reformats the notifications to include more details on the GoCD event, such as lists of passed and failed jobs. Fixes #21224. Co-authored-by: Pieter CK <pieterceka123@gmail.com> [1]: https://docs.gocd.org/current/integration/#integration-with-bug-tracking-and-story-management-tools [2]: https://github.com/getsentry/gocd-webhook-notification-plugin/releases/tag/v0.0.6
2024-01-30 02:11:11 +01:00
def test_completed_pipeline_success(self) -> None:
expected_topic = "Pipeline / Stage"
expected_message = """:green_circle: **Build passed**: Pipeline / Stage
- **Commit**: [`59f3c6e4540`](https://github.com/swayam0322/Test/commit/59f3c6e4540) on branch `main`
- **Started**: Feb 1, 2024, 1:58:13 AM
- **Finished**: Feb 1, 2024, 1:58:40 AM
- **Passed**: `Job`"""
integrations: Add Gocd webhook integration. Fixes #38.
2018-01-28 18:09:08 +01:00
integrations: Update GoCD integration. Previously, the GoCD integration relied on GoCD's integration with bug tracking and monitoring tools through the users' Config XML file [1]. However, this feature no longer works as expected, as it cannot send HTTPS payloads to an external endpoint. This commit updates our GoCD integration to use Sentry's WebHook notifier GoCD plugin [2] to send webhook payloads from users GoCD server to Zulip. We are using an older version of the plugin—v0.0.6—because the newer version—v0.0.9—doesn't work at this time. Additionally, this change reformats the notifications to include more details on the GoCD event, such as lists of passed and failed jobs. Fixes #21224. Co-authored-by: Pieter CK <pieterceka123@gmail.com> [1]: https://docs.gocd.org/current/integration/#integration-with-bug-tracking-and-story-management-tools [2]: https://github.com/getsentry/gocd-webhook-notification-plugin/releases/tag/v0.0.6
2024-01-30 02:11:11 +01:00
self.check_webhook("pipeline_passed", expected_topic, expected_message)
def test_completed_pipeline_fail(self) -> None:
expected_topic = "pipeline-one / stage-two"
expected_message = """:red_circle: **Build failed**: pipeline-one / stage-two
- **Commit**: [`963eb239c7b`](https://github.com/PieterCK/getting-started-repo.git/commit/963eb239c7b) on branch `master`
- **Started**: Aug 28, 2024, 9:30:19 PM
- **Finished**: Aug 28, 2024, 9:31:00 PM
- **Failed**: `task-two`"""
self.check_webhook("pipeline_failed", expected_topic, expected_message)
def test_completed_pipeline_with_mixed_result(self) -> None:
expected_topic = "test-pipeline / backend-tests"
expected_message = """:red_circle: **Build failed**: test-pipeline / backend-tests
- **Commit**: [`963eb239c7b`](https://github.com/PieterCK/getting-started-repo.git/commit/963eb239c7b) on branch `master`
- **Started**: Aug 29, 2024, 3:59:18 PM
- **Finished**: Aug 29, 2024, 4:00:15 PM
- **Failed**: `check-backend-lints`, `test-frontend-js`
- **Passed**: `check-backend-tests`, `zulip-ci-debian-12`"""
self.check_webhook("pipeline_with_mixed_job_result", expected_topic, expected_message)