upstream-zulip/zerver/webhooks/grafana/tests.py

from zerver.lib.test_classes import WebhookTestCase


class GrafanaHookTests(WebhookTestCase):
    def test_alert_v7(self) -> None:
        expected_topic_name = "[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()

        self.check_webhook(
            "alert_v7",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_no_data_alert_v7(self) -> None:
        expected_topic_name = "[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()

        self.check_webhook(
            "no_data_alert_v7",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_no_message_alert_v7(self) -> None:
        expected_topic_name = "[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()

        self.check_webhook(
            "no_message_alert_v7",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_alert_ok_v7(self) -> None:
        expected_topic_name = "[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()

        self.check_webhook(
            "alert_ok_v7",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_alert_paused_v7(self) -> None:
        expected_topic_name = "[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()

        self.check_webhook(
            "alert_paused_v7",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_alert_pending_v7(self) -> None:
        expected_topic_name = "[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_v7",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_alert_v8(self) -> None:
        expected_topic_name = "[TestAlert]"
        expected_message = """
:checkbox: **RESOLVED**

**TestAlert**

This alert was fired at <time:2022-08-31T05:54:04+00:00>.

This alert was resolved at <time:2022-08-31T10:30:00+00:00>.

Labels:
- alertname: TestAlert
- instance: Grafana

Values:
[ metric='foo' labels={instance=bar} value=10 ]

Annotations:
- summary: Notification test

[Silence](https://zuliptestingwh2.grafana.net/alerting/silence/new?alertmanager=grafana&matcher=alertname%3DTestAlert&matcher=instance%3DGrafana)
""".strip()

        self.check_webhook(
            "alert_v8",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_alert_multiple_v8(self) -> None:
        expected_topic_name_1 = "[High memory usage]"
        expected_topic_name_2 = "[High CPU usage]"
        expected_message_1 = """
:alert: **FIRING**

**High memory usage**

This alert was fired at <time:2021-10-12T09:51:03+02:00>.

Labels:
- alertname: High memory usage
- team: blue
- zone: us-1

Values:
[ metric='' labels={} value=14151.331895396988 ]

Annotations:
- description: The system has high memory usage
- runbook_url: https://myrunbook.com/runbook/1234
- summary: This alert was triggered for zone us-1

[Generator](https://play.grafana.org/alerting/1afz29v7z/edit)
[Silence](https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT2%2Cteam%3Dblue%2Czone%3Dus-1)
""".strip()
        expected_message_2 = """
:alert: **FIRING**

**High CPU usage**

This alert was fired at <time:2021-10-12T09:56:03+02:00>.

Labels:
- alertname: High CPU usage
- team: blue
- zone: eu-1

Values:
[ metric='' labels={} value=47043.702386305304 ]

Annotations:
- description: The system has high CPU usage
- runbook_url: https://myrunbook.com/runbook/1234
- summary: This alert was triggered for zone eu-1

[Generator](https://play.grafana.org/alerting/d1rdpdv7k/edit)
[Silence](https://play.grafana.org/alerting/silence/new?alertmanager=grafana&matchers=alertname%3DT1%2Cteam%3Dblue%2Czone%3Deu-1)
""".strip()

        self.subscribe(self.test_user, self.channel_name)
        payload = self.get_body("alert_multiple_v8")

        msg = self.send_webhook_payload(
            self.test_user,
            self.url,
            payload,
            content_type="application/json",
        )

        msg = self.get_second_to_last_message()
        self.assert_channel_message(
            message=msg,
            channel_name=self.channel_name,
            topic_name=expected_topic_name_1,
            content=expected_message_1,
        )

        msg = self.get_last_message()
        self.assert_channel_message(
            message=msg,
            channel_name=self.channel_name,
            topic_name=expected_topic_name_2,
            content=expected_message_2,
        )

    def test_alert_values_v11(self) -> None:
        expected_topic_name = "[Memory (copy)]"  # alertname
        expected_message = """
:alert: **FIRING**

**Memory (copy)**

This alert was fired at <time:2024-03-01T02:09:00+00:00>.

Labels:
- alertname: Memory (copy)
- debug: true
- grafana_folder: device

Values:
- A: 2473545728
- B: 0
- C: 1
- minute: 9

Annotations:
- summary: High memory usage

[Generator](https://play.grafana.org/alerting/grafana/dd2f0260-3cfc-4c65-a4c4-f3f632c551f4/view?orgId=1)
[Silence](https://play.grafana.org/alerting/silence/new?alertmanager=grafana\u0026matcher=alertname%3DMemory+%28copy%29\u0026matcher=debug%3Dtrue\u0026matcher=grafana_folder%3Ddevice\u0026orgId=1)
[Image](https://grafana.com/assets/img/blog/mixed_styles.png)
""".strip()

        self.check_webhook(
            "alert_values_v11",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_alert_no_alertname_v11(self) -> None:
        expected_topic_name = "[e6349a25f5ef0e9e]"  # fingerprint
        expected_message = """
:alert: **FIRING**

This alert was fired at <time:2024-03-01T02:09:00+00:00>.

Labels:
- debug: true
- grafana_folder: device

Values:
- A: 2473545728
- B: 0
- C: 1
- minute: 9

Annotations:
- summary: High memory usage

[Generator](https://play.grafana.org/alerting/grafana/dd2f0260-3cfc-4c65-a4c4-f3f632c551f4/view?orgId=1)
[Silence](https://play.grafana.org/alerting/silence/new?alertmanager=grafana\u0026matcher=alertname%3DMemory+%28copy%29\u0026matcher=debug%3Dtrue\u0026matcher=grafana_folder%3Ddevice\u0026orgId=1)
[Image](https://grafana.com/assets/img/blog/mixed_styles.png)
""".strip()

        self.check_webhook(
            "alert_no_alertname_v11",
            expected_topic_name,
            expected_message,
            content_type="application/x-www-form-urlencoded",
        )

    def test_anomalous_webhook_payload_test_notification(self) -> None:
        with self.assertRaises(AssertionError) as e:
            self.check_webhook(
                fixture_name="alert_test_anomalous_notification",
                expected_topic_name="",
                expected_message="",
                expect_noop=True,
            )

        self.assertIn(
            "Unable to parse request: Did Grafana generate this event?",
            e.exception.args[0],
        )