bfcc0b9f29
# What this PR does
Introduces a new class,
`apps.grafana_plugin.ui_url_builder.UIURLBuilder`, which is responsible
for... building UI URLs (😄). The class mainly does two things:
- it will decide if the URL should point to `grafana-oncall-app` or
`grafana-irm-app` based on the value of
`organization.is_grafana_irm_enabled` (**NOTE**: this value isn't yet
being set + defaults to `False`; logic for setting this value will be
done in a subsequent PR)
- Adds `enum`s, `OnCallPage` and `IncidentPage` to DRYify hardcoded UI
URLs (in case we decide to change these slightly in the near future)
## Checklist
- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] Added the relevant release notes label (see labels prefixed w/
`release:`). These labels dictate how your PR will
show up in the autogenerated release notes.
439 lines
16 KiB
Python
439 lines
16 KiB
Python
import json
|
|
from unittest.mock import call, patch
|
|
|
|
import pytest
|
|
from django.conf import settings
|
|
from rest_framework import status
|
|
from rest_framework.test import APIClient
|
|
|
|
from apps.slack.scenarios.manage_responders import ManageRespondersUserChange
|
|
from apps.slack.scenarios.paging import OnPagingTeamChange, StartDirectPaging
|
|
from apps.slack.scenarios.schedules import EditScheduleShiftNotifyStep
|
|
from apps.slack.scenarios.shift_swap_requests import AcceptShiftSwapRequestStep
|
|
from apps.slack.types import PayloadType
|
|
from common.constants.plugin_ids import PluginID
|
|
|
|
EVENT_TRIGGER_ID = "5333959822612.4122782784722.4734ff484b2ac4d36a185bb242ee9932"
|
|
WARNING_TEXT = (
|
|
"OnCall is not able to process this action because one of the following scenarios: \n"
|
|
"1. The Slack chatops integration was disconnected from the instance that the Alert Group belongs "
|
|
"to, BUT the Slack workspace is still connected to another instance as well. In this case, simply log "
|
|
"in to the OnCall web interface and re-install the Slack Integration with this workspace again.\n"
|
|
"2. (Less likely) The Grafana instance belonging to this Alert Group was deleted. In this case the Alert Group is orphaned and cannot be acted upon."
|
|
)
|
|
|
|
SLACK_TEAM_ID = "T043LP0P2M8"
|
|
SLACK_ACCESS_TOKEN = "asdfasdf"
|
|
SLACK_BOT_ACCESS_TOKEN = "cmncvmnvcnm"
|
|
SLACK_BOT_USER_ID = "mncvnmvcmnvcmncv,,cx,"
|
|
|
|
SLACK_USER_ID = "iurtiurituritu"
|
|
|
|
|
|
def _make_request(payload, predefined_org=None):
|
|
headers = {
|
|
"HTTP_X_SLACK_SIGNATURE": "asdfasdf",
|
|
"HTTP_X_SLACK_REQUEST_TIMESTAMP": "xxcxcvx",
|
|
}
|
|
if predefined_org:
|
|
headers["HTTP_X_CHATOPS_STACK_ID"] = predefined_org.stack_id
|
|
return APIClient().post(
|
|
"/slack/interactive_api_endpoint/",
|
|
format="json",
|
|
data=payload,
|
|
**headers,
|
|
)
|
|
|
|
|
|
@pytest.fixture
|
|
def slack_team_identity(make_slack_team_identity):
|
|
return make_slack_team_identity(
|
|
slack_id=SLACK_TEAM_ID,
|
|
detected_token_revoked=None,
|
|
access_token=SLACK_ACCESS_TOKEN,
|
|
bot_access_token=SLACK_BOT_ACCESS_TOKEN,
|
|
bot_user_id=SLACK_BOT_USER_ID,
|
|
)
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch("apps.slack.views.SlackEventApiEndpointView._open_warning_window_if_needed")
|
|
@pytest.mark.django_db
|
|
def test_no_user_in_organization_for_slack_team_identity(
|
|
mock_open_warning_window_if_needed,
|
|
_mock_verify_signature,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
slack_team_identity,
|
|
):
|
|
# only create SlackUserIdentity, not actual OnCall user
|
|
make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
organization = make_organization(slack_team_identity=slack_team_identity, grafana_url="https://test.com")
|
|
|
|
event_payload = {
|
|
"type": PayloadType.BLOCK_ACTIONS,
|
|
"trigger_id": EVENT_TRIGGER_ID,
|
|
"user": {"id": SLACK_USER_ID},
|
|
"team": {"id": SLACK_TEAM_ID},
|
|
"actions": [{"value": json.dumps({"organization_id": organization.id})}],
|
|
}
|
|
|
|
response = _make_request(event_payload)
|
|
assert response.status_code == status.HTTP_200_OK
|
|
|
|
mock_open_warning_window_if_needed.assert_called_once_with(
|
|
event_payload,
|
|
slack_team_identity,
|
|
f"Permission denied. Please connect your Slack account to OnCall: https://test.com/a/{PluginID.ONCALL}/users/me",
|
|
)
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch("apps.slack.views.SlackEventApiEndpointView._open_warning_window_if_needed")
|
|
@pytest.mark.django_db
|
|
def test_organization_not_found_scenario_properly_handled(
|
|
mock_open_warning_window_if_needed,
|
|
_mock_verify_signature,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
slack_team_identity,
|
|
):
|
|
# SCENARIO 1
|
|
# two orgs connected to same slack workspace, the one belonging to the alert group/slack message
|
|
# is no longer connected to the slack workspace, but another org still is
|
|
make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
|
|
make_organization(slack_team_identity=slack_team_identity)
|
|
org2 = make_organization()
|
|
event_payload_actions = [
|
|
{
|
|
"value": json.dumps({"organization_id": org2.id}),
|
|
}
|
|
]
|
|
|
|
event_payload = {
|
|
"type": PayloadType.BLOCK_ACTIONS,
|
|
"trigger_id": EVENT_TRIGGER_ID,
|
|
"user": {
|
|
"id": SLACK_USER_ID,
|
|
},
|
|
"team": {
|
|
"id": SLACK_TEAM_ID,
|
|
},
|
|
"actions": event_payload_actions,
|
|
}
|
|
|
|
response = _make_request(event_payload)
|
|
assert response.status_code == status.HTTP_200_OK
|
|
|
|
# SCENARIO 2
|
|
# the org that was associated w/ the alert group, has since been deleted
|
|
# and the slack message is now orphaned
|
|
org2.hard_delete()
|
|
|
|
response = _make_request(event_payload)
|
|
assert response.status_code == status.HTTP_200_OK
|
|
|
|
mock_call = call(event_payload, slack_team_identity, WARNING_TEXT)
|
|
mock_open_warning_window_if_needed.assert_has_calls([mock_call, mock_call])
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch("apps.slack.views.SlackEventApiEndpointView._open_warning_window_if_needed")
|
|
@pytest.mark.django_db
|
|
def test_organization_not_found_scenario_doesnt_break_slash_commands(
|
|
mock_open_warning_window_if_needed,
|
|
_mock_verify_signature,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
slack_team_identity,
|
|
):
|
|
make_organization(slack_team_identity=slack_team_identity)
|
|
make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
|
|
response = _make_request(
|
|
{
|
|
"token": "axvnc,mvc,mv,mcvmnxcmnxc",
|
|
"team_id": SLACK_TEAM_ID,
|
|
"team_domain": "testingtest-nim4013",
|
|
"channel_id": "C043HQ70QMB",
|
|
"channel_name": "testy-testing",
|
|
"user_id": "U043HQ3VABF",
|
|
"user_name": "bob.smith",
|
|
"command": settings.SLACK_DIRECT_PAGING_SLASH_COMMAND,
|
|
"text": "potato",
|
|
"api_app_id": "A0909234092340293402934234234234234234",
|
|
"is_enterprise_install": "False",
|
|
"response_url": "https://hooks.slack.com/commands/cvcv/cvcv/cvcv",
|
|
"trigger_id": "asdfasdf.4122782784722.cvcv",
|
|
}
|
|
)
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
mock_open_warning_window_if_needed.assert_not_called()
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch.object(OnPagingTeamChange, "process_scenario")
|
|
@pytest.mark.django_db
|
|
def test_organization_not_found_scenario_doesnt_break_direct_paging(
|
|
mock_on_paging_team_change,
|
|
_,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
make_user,
|
|
slack_team_identity,
|
|
):
|
|
"""
|
|
Check OnPagingTeamChange.process_scenario gets called when a user changes the team in direct paging dialog.
|
|
"""
|
|
organization = make_organization(slack_team_identity=slack_team_identity)
|
|
slack_user_identity = make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
make_user(organization=organization, slack_user_identity=slack_user_identity)
|
|
|
|
response = _make_request(
|
|
{
|
|
"team_id": SLACK_TEAM_ID,
|
|
"user_id": SLACK_USER_ID,
|
|
"type": "block_actions",
|
|
"actions": [{"action_id": OnPagingTeamChange.routing_uid(), "type": "static_select"}],
|
|
"view": {"type": "modal"},
|
|
}
|
|
)
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
mock_on_paging_team_change.assert_called_once()
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch.object(ManageRespondersUserChange, "process_scenario")
|
|
@pytest.mark.django_db
|
|
def test_organization_not_found_scenario_doesnt_break_manage_responders(
|
|
mock_process_scenario,
|
|
_,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
make_user,
|
|
slack_team_identity,
|
|
):
|
|
"""
|
|
Check ManageRespondersUserChange.process_scenario is called when user is notified in manage responders dialog.
|
|
"""
|
|
organization = make_organization(slack_team_identity=slack_team_identity)
|
|
slack_user_identity = make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
make_user(organization=organization, slack_user_identity=slack_user_identity)
|
|
|
|
response = _make_request(
|
|
{
|
|
"team_id": SLACK_TEAM_ID,
|
|
"user_id": SLACK_USER_ID,
|
|
"type": "block_actions",
|
|
"actions": [{"action_id": ManageRespondersUserChange.routing_uid(), "type": "static_select"}],
|
|
"view": {"type": "modal"},
|
|
}
|
|
)
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
mock_process_scenario.assert_called_once()
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch.object(EditScheduleShiftNotifyStep, "process_scenario")
|
|
@pytest.mark.django_db
|
|
def test_organization_not_found_scenario_doesnt_break_edit_schedule_notifications(
|
|
mock_edit_schedule_notifications,
|
|
_,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
make_user,
|
|
slack_team_identity,
|
|
):
|
|
"""
|
|
Check EditScheduleShiftNotifyStep.process_scenario gets called when a user clicks settings in shift notification.
|
|
"""
|
|
organization = make_organization(slack_team_identity=slack_team_identity)
|
|
slack_user_identity = make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
make_user(organization=organization, slack_user_identity=slack_user_identity)
|
|
|
|
response = _make_request(
|
|
{
|
|
"team_id": SLACK_TEAM_ID,
|
|
"user_id": SLACK_USER_ID,
|
|
"type": "block_actions",
|
|
"actions": [{"action_id": EditScheduleShiftNotifyStep.routing_uid(), "type": "button"}],
|
|
}
|
|
)
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
mock_edit_schedule_notifications.assert_called_once()
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch.object(AcceptShiftSwapRequestStep, "process_scenario")
|
|
@pytest.mark.django_db
|
|
def test_accept_shift_swap_request(
|
|
mock_process_scenario,
|
|
_mock_verify_signature,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
make_user,
|
|
slack_team_identity,
|
|
):
|
|
organization = make_organization(slack_team_identity=slack_team_identity)
|
|
slack_user_identity = make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
make_user(organization=organization, slack_user_identity=slack_user_identity)
|
|
|
|
payload = {
|
|
"type": "block_actions",
|
|
"user": {
|
|
"id": SLACK_USER_ID,
|
|
},
|
|
"team": {
|
|
"id": SLACK_TEAM_ID,
|
|
},
|
|
"actions": [
|
|
{
|
|
"action_id": "AcceptShiftSwapRequestStep",
|
|
"block_id": "G0ec",
|
|
"text": {"type": "plain_text", "text": ":heavy_check_mark: Accept Shift Swap Request", "emoji": True},
|
|
"value": f'{{"shift_swap_request_pk": 5, "organization_id": {organization.pk}}}',
|
|
"style": "primary",
|
|
"type": "button",
|
|
"action_ts": "1693208812.474860",
|
|
}
|
|
],
|
|
}
|
|
|
|
response = _make_request(payload)
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
mock_process_scenario.assert_called_once_with(slack_user_identity, slack_team_identity, payload)
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch.object(StartDirectPaging, "process_scenario")
|
|
@pytest.mark.django_db
|
|
def test_grafana_escalate(
|
|
mock_process_scenario,
|
|
_mock_verify_signature,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
make_user,
|
|
slack_team_identity,
|
|
):
|
|
"""
|
|
Check StartDirectPaging.process_scenario gets called when a user types /grafana escalate.
|
|
UnifiedSlackApp commands are prefixed with /grafana.
|
|
"""
|
|
organization = make_organization(slack_team_identity=slack_team_identity)
|
|
slack_user_identity = make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
make_user(organization=organization, slack_user_identity=slack_user_identity)
|
|
|
|
payload = {
|
|
"token": "gIkuvaNzQIHg97ATvDxqgjtO",
|
|
"team_id": slack_team_identity.slack_id,
|
|
"team_domain": "example",
|
|
"enterprise_id": "E0001",
|
|
"enterprise_name": "Globular%20Construct%20Inc",
|
|
"channel_id": "C2147483705",
|
|
"channel_name": "test",
|
|
"user_id": slack_user_identity.slack_id,
|
|
"user_name": "Steve",
|
|
"command": "/grafana",
|
|
"text": "escalate",
|
|
"response_url": "https://hooks.slack.com/commands/1234/5678",
|
|
"trigger_id": "13345224609.738474920.8088930838d88f008e0",
|
|
"api": "api_value",
|
|
}
|
|
response = _make_request(payload)
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
mock_process_scenario.assert_called_once_with(
|
|
slack_user_identity, slack_team_identity, payload, predefined_org=None
|
|
)
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch.object(StartDirectPaging, "process_scenario")
|
|
@pytest.mark.django_db
|
|
def test_grafana_escalate_with_org_from_chatops_proxy_defines_org(
|
|
mock_process_scenario,
|
|
_mock_verify_signature,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
make_user,
|
|
slack_team_identity,
|
|
):
|
|
"""
|
|
Check StartDirectPaging.process_scenario gets called when a user types /grafana escalate.
|
|
UnifiedSlackApp commands are prefixed with /grafana.
|
|
"""
|
|
organization = make_organization(slack_team_identity=slack_team_identity)
|
|
slack_user_identity = make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
make_user(organization=organization, slack_user_identity=slack_user_identity)
|
|
|
|
payload = {
|
|
"token": "gIkuvaNzQIHg97ATvDxqgjtO",
|
|
"team_id": slack_team_identity.slack_id,
|
|
"team_domain": "example",
|
|
"enterprise_id": "E0001",
|
|
"enterprise_name": "Globular%20Construct%20Inc",
|
|
"channel_id": "C2147483705",
|
|
"channel_name": "test",
|
|
"user_id": slack_user_identity.slack_id,
|
|
"user_name": "Steve",
|
|
"command": "/grafana",
|
|
"text": "escalate",
|
|
"response_url": "https://hooks.slack.com/commands/1234/5678",
|
|
"trigger_id": "13345224609.738474920.8088930838d88f008e0",
|
|
"api": "api_value",
|
|
}
|
|
response = _make_request(payload, predefined_org=organization)
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
mock_process_scenario.assert_called_once_with(
|
|
slack_user_identity, slack_team_identity, payload, predefined_org=organization
|
|
)
|
|
|
|
|
|
@patch("apps.slack.views.SlackEventApiEndpointView.verify_signature", return_value=True)
|
|
@patch.object(StartDirectPaging, "process_scenario")
|
|
@pytest.mark.django_db
|
|
def test_escalate(
|
|
mock_process_scenario,
|
|
_mock_verify_signature,
|
|
make_organization,
|
|
make_slack_user_identity,
|
|
make_user,
|
|
slack_team_identity,
|
|
):
|
|
"""
|
|
Check StartDirectPaging.process_scenario gets called when a user types /escalate.
|
|
/escalate was used before Unified Slack App
|
|
"""
|
|
organization = make_organization(slack_team_identity=slack_team_identity)
|
|
slack_user_identity = make_slack_user_identity(slack_team_identity=slack_team_identity, slack_id=SLACK_USER_ID)
|
|
make_user(organization=organization, slack_user_identity=slack_user_identity)
|
|
|
|
payload = {
|
|
"token": "gIkuvaNzQIHg97ATvDxqgjtO",
|
|
"team_id": slack_team_identity.slack_id,
|
|
"team_domain": "example",
|
|
"enterprise_id": "E0001",
|
|
"enterprise_name": "Globular%20Construct%20Inc",
|
|
"channel_id": "C2147483705",
|
|
"channel_name": "test",
|
|
"user_id": slack_user_identity.slack_id,
|
|
"user_name": "Steve",
|
|
"command": "/escalate",
|
|
"text": "",
|
|
"response_url": "https://hooks.slack.com/commands/1234/5678",
|
|
"trigger_id": "13345224609.738474920.8088930838d88f008e0",
|
|
"api": "api_value",
|
|
}
|
|
response = _make_request(payload)
|
|
|
|
assert response.status_code == status.HTTP_200_OK
|
|
mock_process_scenario.assert_called_once_with(
|
|
slack_user_identity, slack_team_identity, payload, predefined_org=None
|
|
)
|