0
0
Fork 0
mirror of https://github.com/healthchecks/healthchecks.git synced 2025-04-07 14:15:34 +00:00
healthchecks_healthchecks/hc/api/tests/test_notify_zulip.py
2022-10-09 11:23:14 +03:00

129 lines
4.1 KiB
Python

# coding: utf-8
from datetime import timedelta as td
import json
from unittest.mock import Mock, patch
from django.test.utils import override_settings
from django.utils.timezone import now
from hc.api.models import Channel, Check, Notification
from hc.test import BaseTestCase
class NotifyZulipTestCase(BaseTestCase):
def setUp(self):
super().setUp()
self.check = Check(project=self.project)
self.check.name = "Foobar"
self.check.status = "down"
self.check.last_ping = now() - td(minutes=61)
self.check.save()
self.channel = Channel(project=self.project)
self.channel.kind = "zulip"
self.channel.value = json.dumps(self.definition())
self.channel.save()
self.channel.checks.add(self.check)
def definition(self, **kwargs):
d = {
"bot_email": "bot@example.org",
"api_key": "fake-key",
"mtype": "stream",
"to": "general",
}
d.update(kwargs)
return d
@patch("hc.api.transports.curl.request")
def test_it_works(self, mock_post):
mock_post.return_value.status_code = 200
self.channel.notify(self.check)
assert Notification.objects.count() == 1
args, kwargs = mock_post.call_args
method, url = args
self.assertEqual(url, "https://example.org/api/v1/messages")
payload = kwargs["data"]
self.assertEqual(payload["topic"], "Foobar is DOWN")
# payload should not contain check's code
serialized = json.dumps(payload)
self.assertNotIn(str(self.check.code), serialized)
@patch("hc.api.transports.curl.request")
def test_it_uses_custom_topic(self, mock_post):
self.channel.value = json.dumps(self.definition(topic="foo"))
self.channel.save()
mock_post.return_value.status_code = 200
self.channel.notify(self.check)
args, kwargs = mock_post.call_args
payload = kwargs["data"]
self.assertEqual(payload["topic"], "foo")
@patch("hc.api.transports.curl.request")
def test_it_returns_error(self, mock_post):
mock_post.return_value.status_code = 403
mock_post.return_value.json.return_value = {"msg": "Nice try"}
self.channel.notify(self.check)
n = Notification.objects.get()
self.assertEqual(n.error, 'Received status code 403 with a message: "Nice try"')
@patch("hc.api.transports.curl.request")
def test_it_handles_non_json_error_response(self, mock_post):
mock_post.return_value.status_code = 403
mock_post.return_value.json = Mock(side_effect=ValueError)
self.channel.notify(self.check)
n = Notification.objects.get()
self.assertEqual(n.error, "Received status code 403")
@patch("hc.api.transports.curl.request")
def test_it_uses_site_parameter(self, mock_post):
mock_post.return_value.status_code = 200
definition = {
"bot_email": "bot@example.org",
"site": "https://custom.example.org",
"api_key": "fake-key",
"mtype": "stream",
"to": "general",
}
self.channel.value = json.dumps(definition)
self.channel.notify(self.check)
assert Notification.objects.count() == 1
args, kwargs = mock_post.call_args
method, url = args
self.assertEqual(url, "https://custom.example.org/api/v1/messages")
payload = kwargs["data"]
self.assertIn("DOWN", payload["topic"])
@override_settings(ZULIP_ENABLED=False)
def test_it_requires_zulip_enabled(self):
self.channel.notify(self.check)
n = Notification.objects.get()
self.assertEqual(n.error, "Zulip notifications are not enabled.")
@patch("hc.api.transports.curl.request")
def test_it_does_not_escape_topic(self, mock_post):
mock_post.return_value.status_code = 200
self.check.name = "Foo & Bar"
self.check.save()
self.channel.notify(self.check)
args, kwargs = mock_post.call_args
payload = kwargs["data"]
self.assertEqual(payload["topic"], "Foo & Bar is DOWN")