Files
zulip/zerver/webhooks/grafana/tests.py
AdamVB bf49f962c0 integrations: Enhance Grafana integration with alert state.
Having the alert state in the message body is useful when alert topics 
are not defined by alert description but encoded in the url.

E.g. in large environments having a topic for each alert [alerting] and [ok] would 
make it harder to properly track if an alert has been resolved.

When each alert is in a single topic, so far, the alert state has been missing.

This change will add the current alert state and a fitting icon in front
of the alert name.(Similar to the prometheus alertmanager integration)

The test cases have been amended to cover all possible alert states, even
though realistically grafana only fires the ok and alerting states via
webhook.
2021-05-24 14:25:47 -07:00

138 lines
4.0 KiB
Python

from zerver.lib.test_classes import WebhookTestCase
class GrafanaHookTests(WebhookTestCase):
STREAM_NAME = "grafana"
URL_TEMPLATE = "/api/v1/external/grafana?&api_key={api_key}&stream={stream}"
FIXTURE_DIR_NAME = "grafana"
# Note: Include a test function per each distinct message condition your integration supports
def test_alert(self) -> None:
expected_topic = "[Alerting] Test notification"
expected_message = """
:alert: **ALERTING**
[Test rule](http://localhost:3000/)
Someone is testing the alert notification within grafana.
**High value:** 100
**Higher Value:** 200
[Click to view visualization](https://grafana.com/assets/img/blog/mixed_styles.png)
""".strip()
# use fixture named helloworld_hello
self.check_webhook(
"alert",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)
def test_no_data_alert(self) -> None:
expected_topic = "[Alerting] No Data alert"
expected_message = """
:alert: **ALERTING**
[No Data alert](http://localhost:3000/d/GG2qhR3Wz/alerttest?fullscreen&edit&tab=alert&panelId=6&orgId=1)
The panel has no data.
""".strip()
# use fixture named helloworld_hello
self.check_webhook(
"no_data_alert",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)
def test_no_message_alert(self) -> None:
expected_topic = "[Alerting] No Message alert"
expected_message = """
:alert: **ALERTING**
[No Message alert](http://localhost:3000/d/GG2qhR3Wz/alerttest?fullscreen&edit&tab=alert&panelId=8&orgId=1)
**A-series:** 21.573108436586445
""".strip()
# use fixture named helloworld_hello
self.check_webhook(
"no_message_alert",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)
# Note: Include a test function per each distinct message condition your integration supports
def test_alert_ok(self) -> None:
expected_topic = "[Ok] Test notification"
expected_message = """
:squared_ok: **OK**
[Test rule](http://localhost:3000/)
Someone is testing the alert notification within grafana.
**High value:** 0
[Click to view visualization](https://grafana.com/assets/img/blog/mixed_styles.png)
""".strip()
# use fixture named helloworld_hello
self.check_webhook(
"alert_ok",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)
# Note: Include a test function per each distinct message condition your integration supports
def test_alert_paused(self) -> None:
expected_topic = "[Paused] Test notification"
expected_message = """
:info: **PAUSED**
[Test rule](http://localhost:3000/)
Someone is testing the alert notification within grafana.
[Click to view visualization](https://grafana.com/assets/img/blog/mixed_styles.png)
""".strip()
# use fixture named helloworld_hello
self.check_webhook(
"alert_paused",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)
# Note: Include a test function per each distinct message condition your integration supports
def test_alert_pending(self) -> None:
expected_topic = "[Pending] Test notification"
expected_message = """
:info: **PENDING**
[Test rule](http://localhost:3000/)
Someone is testing the alert notification within grafana.
**High value:** 100
**Higher Value:** 200
[Click to view visualization](https://grafana.com/assets/img/blog/mixed_styles.png)
""".strip()
# use fixture named helloworld_hello
self.check_webhook(
"alert_pending",
expected_topic,
expected_message,
content_type="application/x-www-form-urlencoded",
)