|
|
- # coding: utf-8
-
- from datetime import timedelta as td
- import json
- from unittest.mock import patch, Mock
-
- from django.core import mail
- from django.utils.timezone import now
- from hc.api.models import Channel, Check, Notification, TokenBucket
- from hc.test import BaseTestCase
- from requests.exceptions import ConnectionError, Timeout
- from django.test.utils import override_settings
-
-
- class NotifyTestCase(BaseTestCase):
- def _setup_data(self, kind, value, status="down", email_verified=True):
- self.check = Check(project=self.project)
- self.check.status = status
- self.check.last_ping = now() - td(minutes=61)
- self.check.save()
-
- self.channel = Channel(project=self.project)
- self.channel.kind = kind
- self.channel.value = value
- self.channel.email_verified = email_verified
- self.channel.save()
- self.channel.checks.add(self.check)
-
- @patch("hc.api.transports.requests.request")
- def test_webhook(self, mock_get):
- definition = {
- "method_down": "GET",
- "url_down": "http://example",
- "body_down": "",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- mock_get.return_value.status_code = 200
-
- self.channel.notify(self.check)
- mock_get.assert_called_with(
- "get",
- "http://example",
- headers={"User-Agent": "healthchecks.io"},
- timeout=5,
- )
-
- @patch("hc.api.transports.requests.request", side_effect=Timeout)
- def test_webhooks_handle_timeouts(self, mock_get):
- definition = {
- "method_down": "GET",
- "url_down": "http://example",
- "body_down": "",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.channel.notify(self.check)
-
- # The transport should have retried 3 times
- self.assertEqual(mock_get.call_count, 3)
-
- n = Notification.objects.get()
- self.assertEqual(n.error, "Connection timed out")
-
- self.channel.refresh_from_db()
- self.assertEqual(self.channel.last_error, "Connection timed out")
-
- @patch("hc.api.transports.requests.request", side_effect=ConnectionError)
- def test_webhooks_handle_connection_errors(self, mock_get):
- definition = {
- "method_down": "GET",
- "url_down": "http://example",
- "body_down": "",
- "headers_down": {},
- }
- self._setup_data("webhook", json.dumps(definition))
- self.channel.notify(self.check)
-
- # The transport should have retried 3 times
- self.assertEqual(mock_get.call_count, 3)
-
- n = Notification.objects.get()
- self.assertEqual(n.error, "Connection failed")
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_handle_500(self, mock_get):
- definition = {
- "method_down": "GET",
- "url_down": "http://example",
- "body_down": "",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- mock_get.return_value.status_code = 500
-
- self.channel.notify(self.check)
-
- # The transport should have retried 3 times
- self.assertEqual(mock_get.call_count, 3)
-
- n = Notification.objects.get()
- self.assertEqual(n.error, "Received status code 500")
-
- @patch("hc.api.transports.requests.request", side_effect=Timeout)
- def test_webhooks_dont_retry_when_sending_test_notifications(self, mock_get):
- definition = {
- "method_down": "GET",
- "url_down": "http://example",
- "body_down": "",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.channel.notify(self.check, is_test=True)
-
- # is_test flag is set, the transport should not retry:
- self.assertEqual(mock_get.call_count, 1)
-
- n = Notification.objects.get()
- self.assertEqual(n.error, "Connection timed out")
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_support_variables(self, mock_get):
- definition = {
- "method_down": "GET",
- "url_down": "http://host/$CODE/$STATUS/$TAG1/$TAG2/?name=$NAME",
- "body_down": "",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.check.name = "Hello World"
- self.check.tags = "foo bar"
- self.check.save()
-
- self.channel.notify(self.check)
-
- url = "http://host/%s/down/foo/bar/?name=Hello%%20World" % self.check.code
-
- args, kwargs = mock_get.call_args
- self.assertEqual(args[0], "get")
- self.assertEqual(args[1], url)
- self.assertEqual(kwargs["headers"], {"User-Agent": "healthchecks.io"})
- self.assertEqual(kwargs["timeout"], 5)
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_handle_variable_variables(self, mock_get):
- definition = {
- "method_down": "GET",
- "url_down": "http://host/$$NAMETAG1",
- "body_down": "",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.check.tags = "foo bar"
- self.check.save()
-
- self.channel.notify(self.check)
-
- # $$NAMETAG1 should *not* get transformed to "foo"
- args, kwargs = mock_get.call_args
- self.assertEqual(args[1], "http://host/$TAG1")
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_support_post(self, mock_request):
- definition = {
- "method_down": "POST",
- "url_down": "http://example.com",
- "body_down": "The Time Is $NOW",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.check.save()
-
- self.channel.notify(self.check)
- args, kwargs = mock_request.call_args
- self.assertEqual(args[0], "post")
- self.assertEqual(args[1], "http://example.com")
-
- # spaces should not have been urlencoded:
- payload = kwargs["data"].decode()
- self.assertTrue(payload.startswith("The Time Is 2"))
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_dollarsign_escaping(self, mock_get):
- # If name or tag contains what looks like a variable reference,
- # that should be left alone:
- definition = {
- "method_down": "GET",
- "url_down": "http://host/$NAME",
- "body_down": "",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.check.name = "$TAG1"
- self.check.tags = "foo"
- self.check.save()
-
- self.channel.notify(self.check)
-
- url = "http://host/%24TAG1"
- mock_get.assert_called_with(
- "get", url, headers={"User-Agent": "healthchecks.io"}, timeout=5
- )
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_handle_up_events(self, mock_get):
- definition = {
- "method_up": "GET",
- "url_up": "http://bar",
- "body_up": "",
- "headers_up": {},
- }
- self._setup_data("webhook", json.dumps(definition), status="up")
-
- self.channel.notify(self.check)
-
- mock_get.assert_called_with(
- "get", "http://bar", headers={"User-Agent": "healthchecks.io"}, timeout=5
- )
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_handle_noop_up_events(self, mock_get):
- definition = {
- "method_up": "GET",
- "url_up": "",
- "body_up": "",
- "headers_up": {},
- }
-
- self._setup_data("webhook", json.dumps(definition), status="up")
- self.channel.notify(self.check)
-
- self.assertFalse(mock_get.called)
- self.assertEqual(Notification.objects.count(), 0)
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_handle_unicode_post_body(self, mock_request):
- definition = {
- "method_down": "POST",
- "url_down": "http://foo.com",
- "body_down": "(╯°□°)╯︵ ┻━┻",
- "headers_down": {},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.check.save()
-
- self.channel.notify(self.check)
- args, kwargs = mock_request.call_args
-
- # unicode should be encoded into utf-8
- self.assertIsInstance(kwargs["data"], bytes)
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_handle_post_headers(self, mock_request):
- definition = {
- "method_down": "POST",
- "url_down": "http://foo.com",
- "body_down": "data",
- "headers_down": {"Content-Type": "application/json"},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.channel.notify(self.check)
-
- headers = {"User-Agent": "healthchecks.io", "Content-Type": "application/json"}
- mock_request.assert_called_with(
- "post", "http://foo.com", data=b"data", headers=headers, timeout=5
- )
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_handle_get_headers(self, mock_request):
- definition = {
- "method_down": "GET",
- "url_down": "http://foo.com",
- "body_down": "",
- "headers_down": {"Content-Type": "application/json"},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.channel.notify(self.check)
-
- headers = {"User-Agent": "healthchecks.io", "Content-Type": "application/json"}
- mock_request.assert_called_with(
- "get", "http://foo.com", headers=headers, timeout=5
- )
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_allow_user_agent_override(self, mock_request):
- definition = {
- "method_down": "GET",
- "url_down": "http://foo.com",
- "body_down": "",
- "headers_down": {"User-Agent": "My-Agent"},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.channel.notify(self.check)
-
- headers = {"User-Agent": "My-Agent"}
- mock_request.assert_called_with(
- "get", "http://foo.com", headers=headers, timeout=5
- )
-
- @patch("hc.api.transports.requests.request")
- def test_webhooks_support_variables_in_headers(self, mock_request):
- definition = {
- "method_down": "GET",
- "url_down": "http://foo.com",
- "body_down": "",
- "headers_down": {"X-Message": "$NAME is DOWN"},
- }
-
- self._setup_data("webhook", json.dumps(definition))
- self.check.name = "Foo"
- self.check.save()
-
- self.channel.notify(self.check)
-
- headers = {"User-Agent": "healthchecks.io", "X-Message": "Foo is DOWN"}
- mock_request.assert_called_with(
- "get", "http://foo.com", headers=headers, timeout=5
- )
-
- @patch("hc.api.transports.requests.request")
- def test_pd(self, mock_post):
- self._setup_data("pd", "123")
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["json"]
- self.assertEqual(payload["event_type"], "trigger")
- self.assertEqual(payload["service_key"], "123")
-
- @patch("hc.api.transports.requests.request")
- def test_pd_complex(self, mock_post):
- self._setup_data("pd", json.dumps({"service_key": "456"}))
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["json"]
- self.assertEqual(payload["event_type"], "trigger")
- self.assertEqual(payload["service_key"], "456")
-
- @patch("hc.api.transports.requests.request")
- def test_pagertree(self, mock_post):
- self._setup_data("pagertree", "123")
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["json"]
- self.assertEqual(payload["event_type"], "trigger")
-
- @patch("hc.api.transports.requests.request")
- def test_pagerteam(self, mock_post):
- self._setup_data("pagerteam", "123")
-
- self.channel.notify(self.check)
- self.assertFalse(mock_post.called)
- self.assertEqual(Notification.objects.count(), 0)
-
- @patch("hc.api.transports.requests.request")
- def test_slack(self, mock_post):
- self._setup_data("slack", "123")
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["json"]
- attachment = payload["attachments"][0]
- fields = {f["title"]: f["value"] for f in attachment["fields"]}
- self.assertEqual(fields["Last Ping"], "an hour ago")
-
- @patch("hc.api.transports.requests.request")
- def test_slack_with_complex_value(self, mock_post):
- v = json.dumps({"incoming_webhook": {"url": "123"}})
- self._setup_data("slack", v)
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- self.assertEqual(args[1], "123")
-
- @patch("hc.api.transports.requests.request")
- def test_slack_handles_500(self, mock_post):
- self._setup_data("slack", "123")
- mock_post.return_value.status_code = 500
-
- self.channel.notify(self.check)
-
- n = Notification.objects.get()
- self.assertEqual(n.error, "Received status code 500")
-
- @patch("hc.api.transports.requests.request", side_effect=Timeout)
- def test_slack_handles_timeout(self, mock_post):
- self._setup_data("slack", "123")
-
- self.channel.notify(self.check)
-
- n = Notification.objects.get()
- self.assertEqual(n.error, "Connection timed out")
-
- @patch("hc.api.transports.requests.request")
- def test_slack_with_tabs_in_schedule(self, mock_post):
- self._setup_data("slack", "123")
- self.check.kind = "cron"
- self.check.schedule = "*\t* * * *"
- self.check.save()
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- self.assertEqual(Notification.objects.count(), 1)
- self.assertTrue(mock_post.called)
-
- @patch("hc.api.transports.requests.request")
- def test_hipchat(self, mock_post):
- self._setup_data("hipchat", "123")
-
- self.channel.notify(self.check)
- self.assertFalse(mock_post.called)
- self.assertEqual(Notification.objects.count(), 0)
-
- @patch("hc.api.transports.requests.request")
- def test_opsgenie_with_legacy_value(self, mock_post):
- self._setup_data("opsgenie", "123")
- mock_post.return_value.status_code = 202
-
- self.channel.notify(self.check)
- n = Notification.objects.first()
- self.assertEqual(n.error, "")
-
- self.assertEqual(mock_post.call_count, 1)
- args, kwargs = mock_post.call_args
- self.assertIn("api.opsgenie.com", args[1])
- payload = kwargs["json"]
- self.assertIn("DOWN", payload["message"])
-
- @patch("hc.api.transports.requests.request")
- def test_opsgenie_up(self, mock_post):
- self._setup_data("opsgenie", "123", status="up")
- mock_post.return_value.status_code = 202
-
- self.channel.notify(self.check)
- n = Notification.objects.first()
- self.assertEqual(n.error, "")
-
- self.assertEqual(mock_post.call_count, 1)
- args, kwargs = mock_post.call_args
- method, url = args
- self.assertTrue(str(self.check.code) in url)
-
- @patch("hc.api.transports.requests.request")
- def test_opsgenie_with_json_value(self, mock_post):
- self._setup_data("opsgenie", json.dumps({"key": "456", "region": "eu"}))
- mock_post.return_value.status_code = 202
-
- self.channel.notify(self.check)
- n = Notification.objects.first()
- self.assertEqual(n.error, "")
-
- self.assertEqual(mock_post.call_count, 1)
- args, kwargs = mock_post.call_args
- self.assertIn("api.eu.opsgenie.com", args[1])
-
- @patch("hc.api.transports.requests.request")
- def test_opsgenie_returns_error(self, mock_post):
- self._setup_data("opsgenie", "123")
- mock_post.return_value.status_code = 403
- mock_post.return_value.json.return_value = {"message": "Nice try"}
-
- self.channel.notify(self.check)
- n = Notification.objects.first()
- self.assertEqual(n.error, 'Received status code 403 with a message: "Nice try"')
-
- @patch("hc.api.transports.requests.request")
- def test_pushover(self, mock_post):
- self._setup_data("po", "123|0")
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["data"]
- self.assertIn("DOWN", payload["title"])
-
- @patch("hc.api.transports.requests.request")
- def test_pushover_up_priority(self, mock_post):
- self._setup_data("po", "123|0|2", status="up")
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["data"]
- self.assertIn("UP", payload["title"])
- self.assertEqual(payload["priority"], 2)
- self.assertIn("retry", payload)
- self.assertIn("expire", payload)
-
- @patch("hc.api.transports.requests.request")
- def test_victorops(self, mock_post):
- self._setup_data("victorops", "123")
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["json"]
- self.assertEqual(payload["message_type"], "CRITICAL")
-
- @patch("hc.api.transports.requests.request")
- def test_discord(self, mock_post):
- v = json.dumps({"webhook": {"url": "123"}})
- self._setup_data("discord", v)
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["json"]
- attachment = payload["attachments"][0]
- fields = {f["title"]: f["value"] for f in attachment["fields"]}
- self.assertEqual(fields["Last Ping"], "an hour ago")
-
- @patch("hc.api.transports.requests.request")
- def test_discord_rewrites_discordapp_com(self, mock_post):
- v = json.dumps({"webhook": {"url": "https://discordapp.com/foo"}})
- self._setup_data("discord", v)
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- url = args[1]
-
- # discordapp.com is deprecated. For existing webhook URLs, wwe should
- # rewrite discordapp.com to discord.com:
- self.assertEqual(url, "https://discord.com/foo/slack")
-
- @patch("hc.api.transports.requests.request")
- def test_pushbullet(self, mock_post):
- self._setup_data("pushbullet", "fake-token")
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- _, kwargs = mock_post.call_args
- self.assertEqual(kwargs["json"]["type"], "note")
- self.assertEqual(kwargs["headers"]["Access-Token"], "fake-token")
-
- @patch("hc.api.transports.requests.request")
- def test_telegram(self, mock_post):
- v = json.dumps({"id": 123})
- self._setup_data("telegram", v)
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["json"]
- self.assertEqual(payload["chat_id"], 123)
- self.assertTrue("The check" in payload["text"])
-
- @patch("hc.api.transports.requests.request")
- def test_telegram_returns_error(self, mock_post):
- self._setup_data("telegram", json.dumps({"id": 123}))
- mock_post.return_value.status_code = 400
- mock_post.return_value.json.return_value = {"description": "Hi"}
-
- self.channel.notify(self.check)
- n = Notification.objects.first()
- self.assertEqual(n.error, 'Received status code 400 with a message: "Hi"')
-
- def test_telegram_obeys_rate_limit(self):
- self._setup_data("telegram", json.dumps({"id": 123}))
-
- TokenBucket.objects.create(value="tg-123", tokens=0)
-
- self.channel.notify(self.check)
- n = Notification.objects.first()
- self.assertEqual(n.error, "Rate limit exceeded")
-
- @patch("hc.api.transports.requests.request")
- def test_call(self, mock_post):
- self.profile.call_limit = 1
- self.profile.save()
-
- value = {"label": "foo", "value": "+1234567890"}
- self._setup_data("call", json.dumps(value))
- self.check.last_ping = now() - td(hours=2)
-
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
-
- args, kwargs = mock_post.call_args
- payload = kwargs["data"]
- self.assertEqual(payload["To"], "+1234567890")
-
- n = Notification.objects.get()
- callback_path = f"/api/v1/notifications/{n.code}/status"
- self.assertTrue(payload["StatusCallback"].endswith(callback_path))
-
- @patch("hc.api.transports.requests.request")
- def test_call_limit(self, mock_post):
- # At limit already:
- self.profile.last_call_date = now()
- self.profile.calls_sent = 50
- self.profile.save()
-
- definition = {"value": "+1234567890"}
- self._setup_data("call", json.dumps(definition))
-
- self.channel.notify(self.check)
- self.assertFalse(mock_post.called)
-
- n = Notification.objects.get()
- self.assertTrue("Monthly phone call limit exceeded" in n.error)
-
- # And email should have been sent
- self.assertEqual(len(mail.outbox), 1)
-
- email = mail.outbox[0]
- self.assertEqual(email.to[0], "[email protected]")
- self.assertEqual(email.subject, "Monthly Phone Call Limit Reached")
-
- @patch("hc.api.transports.requests.request")
- def test_call_limit_reset(self, mock_post):
- # At limit, but also into a new month
- self.profile.calls_sent = 50
- self.profile.last_call_date = now() - td(days=100)
- self.profile.save()
-
- self._setup_data("sms", "+1234567890")
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- self.assertTrue(mock_post.called)
-
- @patch("apprise.Apprise")
- @override_settings(APPRISE_ENABLED=True)
- def test_apprise_enabled(self, mock_apprise):
- self._setup_data("apprise", "123")
-
- mock_aobj = Mock()
- mock_aobj.add.return_value = True
- mock_aobj.notify.return_value = True
- mock_apprise.return_value = mock_aobj
- self.channel.notify(self.check)
- self.assertEqual(Notification.objects.count(), 1)
-
- self.check.status = "up"
- self.assertEqual(Notification.objects.count(), 1)
-
- @patch("apprise.Apprise")
- @override_settings(APPRISE_ENABLED=False)
- def test_apprise_disabled(self, mock_apprise):
- self._setup_data("apprise", "123")
-
- mock_aobj = Mock()
- mock_aobj.add.return_value = True
- mock_aobj.notify.return_value = True
- mock_apprise.return_value = mock_aobj
- self.channel.notify(self.check)
- self.assertEqual(Notification.objects.count(), 1)
-
- def test_not_implimented(self):
- self._setup_data("webhook", "http://example")
- self.channel.kind = "invalid"
-
- with self.assertRaises(NotImplementedError):
- self.channel.notify(self.check)
-
- @patch("hc.api.transports.requests.request")
- def test_msteams(self, mock_post):
- self._setup_data("msteams", "http://example.com/webhook")
- mock_post.return_value.status_code = 200
-
- self.check.name = "_underscores_ & more"
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["json"]
- self.assertEqual(payload["@type"], "MessageCard")
-
- # summary and title should be the same, except
- # title should have any special HTML characters escaped
- self.assertEqual(payload["summary"], "“_underscores_ & more” is DOWN.")
- self.assertEqual(payload["title"], "“_underscores_ & more” is DOWN.")
-
- @patch("hc.api.transports.requests.request")
- def test_msteams_escapes_html_and_markdown_in_desc(self, mock_post):
- self._setup_data("msteams", "http://example.com/webhook")
- mock_post.return_value.status_code = 200
-
- self.check.desc = """
- TEST _underscore_ `backticks` <u>underline</u> \\backslash\\ "quoted"
- """
-
- self.channel.notify(self.check)
-
- args, kwargs = mock_post.call_args
- text = kwargs["json"]["sections"][0]["text"]
-
- self.assertIn(r"\_underscore\_", text)
- self.assertIn(r"\`backticks\`", text)
- self.assertIn("<u>underline</u>", text)
- self.assertIn(r"\\backslash\\ ", text)
- self.assertIn(""quoted"", text)
-
- @patch("hc.api.transports.os.system")
- @override_settings(SHELL_ENABLED=True)
- def test_shell(self, mock_system):
- definition = {"cmd_down": "logger hello", "cmd_up": ""}
- self._setup_data("shell", json.dumps(definition))
- mock_system.return_value = 0
-
- self.channel.notify(self.check)
- mock_system.assert_called_with("logger hello")
-
- @patch("hc.api.transports.os.system")
- @override_settings(SHELL_ENABLED=True)
- def test_shell_handles_nonzero_exit_code(self, mock_system):
- definition = {"cmd_down": "logger hello", "cmd_up": ""}
- self._setup_data("shell", json.dumps(definition))
- mock_system.return_value = 123
-
- self.channel.notify(self.check)
- n = Notification.objects.get()
- self.assertEqual(n.error, "Command returned exit code 123")
-
- @patch("hc.api.transports.os.system")
- @override_settings(SHELL_ENABLED=True)
- def test_shell_supports_variables(self, mock_system):
- definition = {"cmd_down": "logger $NAME is $STATUS ($TAG1)", "cmd_up": ""}
- self._setup_data("shell", json.dumps(definition))
- mock_system.return_value = 0
-
- self.check.name = "Database"
- self.check.tags = "foo bar"
- self.check.save()
- self.channel.notify(self.check)
-
- mock_system.assert_called_with("logger Database is down (foo)")
-
- @patch("hc.api.transports.os.system")
- @override_settings(SHELL_ENABLED=False)
- def test_shell_disabled(self, mock_system):
- definition = {"cmd_down": "logger hello", "cmd_up": ""}
- self._setup_data("shell", json.dumps(definition))
-
- self.channel.notify(self.check)
- self.assertFalse(mock_system.called)
-
- n = Notification.objects.get()
- self.assertEqual(n.error, "Shell commands are not enabled")
-
- @patch("hc.api.transports.requests.request")
- def test_zulip(self, mock_post):
- definition = {
- "bot_email": "[email protected]",
- "api_key": "fake-key",
- "mtype": "stream",
- "to": "general",
- }
- self._setup_data("zulip", json.dumps(definition))
- mock_post.return_value.status_code = 200
-
- self.channel.notify(self.check)
- assert Notification.objects.count() == 1
-
- args, kwargs = mock_post.call_args
- payload = kwargs["data"]
- self.assertIn("DOWN", payload["topic"])
-
- @patch("hc.api.transports.requests.request")
- def test_zulip_returns_error(self, mock_post):
- definition = {
- "bot_email": "[email protected]",
- "api_key": "fake-key",
- "mtype": "stream",
- "to": "general",
- }
- self._setup_data("zulip", json.dumps(definition))
- 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.first()
- self.assertEqual(n.error, 'Received status code 403 with a message: "Nice try"')
|