oncall-engine/engine/apps/api/tests
Michael Derynck b5a8b8b168
Add webhook presets (#2996)
# What this PR does
Add a system similar to how we select integrations when creating
webhooks so that the user has a description of what webhookds do and
does not have to write complex templates for common webhook use cases.
Presets allow us to create the contents of the webhooks in code and
define which fields are controlled by the preset. Some specifics:

- Newly created webhooks must choose between Simple, Advanced or another
predefined system
- Simple is always an escalation step and will post the entire payload
to the given URL
- Advanced is the same as no preset which is our current view where all
fields are available
- There are no changes for all existing webhooks with empty preset
fields
- Once a webhook is created with a preset the preset cannot be changed
- Fields in the webhook that are populated by code will give a
validation error if they are modified
- In the public API webhooks with presets are returned for viewing but
cannot be created or modified. This restriction is in place because the
Web UI provides the context for which fields to use with a preset. The
public API is for interacting with webhooks where all fields are
defined.

To define a preset create a file with metadata and an override function.
The metadata drives validation and what to display in the UI. There are
two functions one is connected to the pre_save hook of the Webhook model
for persistent changes, the other replaces parameters at execution time
for ephemeral changes. See the simple and advanced presets as an
example. The file must be listed in settings in
`INSTALLED_WEBHOOK_PRESETS` to be enabled at runtime..

## Which issue(s) this PR fixes

## 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] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)

---------

Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
2023-09-27 07:22:52 -06:00
..
__init__.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
conftest.py Improve Slack error handling (#3000) 2023-09-12 09:49:16 +00:00
test_alert_group.py Trigger alert group signal after transaction commit (#3001) 2023-09-11 14:28:37 +00:00
test_alert_receive_channel.py Improve getting/updating contact points for Grafana Alerting integration (#2742) 2023-08-18 12:12:29 +02:00
test_alert_receive_channel_template.py Fix 500 on templates when slack or tg integration is disabled (#2064) 2023-05-31 08:22:58 +00:00
test_auth.py Reworked slack login pipeline errors (#2526) 2023-07-18 13:31:11 +00:00
test_channel_filter.py Minor formatting changes (#2641) 2023-07-26 14:45:44 +01:00
test_custom_button.py use CustomURLValidator in custom_button (#1398) 2023-03-23 12:21:17 +00:00
test_escalation_chain.py Allow changing team for escalation chains (#1658) 2023-03-30 10:43:00 +01:00
test_escalation_policy.py Fix build escalation snapshot (#2954) 2023-09-04 11:10:28 +00:00
test_features.py remove two unused feature flags (#2734) 2023-08-02 14:07:47 -04:00
test_integration_heartbeat.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_live_settings.py Telegram long polling (#2250) 2023-08-24 09:12:24 +02:00
test_oncall_shift.py Add schedule shift type validation on create/preview (#2789) 2023-08-15 14:24:11 +00:00
test_organization.py Make field rbac_enabled readonly for organization endpoint (#2782) 2023-08-11 13:37:44 +00:00
test_paging.py Direct paging: page if acked or silenced, show warning when resolved (#2639) 2023-07-26 13:25:26 +01:00
test_permissions.py shift swap requests model + CRUD endpoints (#2597) 2023-07-21 19:35:19 +00:00
test_postmortem_messages.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_preview_template_options.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
test_public_api_tokens.py only grant admins read/write access to public api keys (#952) 2022-12-06 13:02:53 +01:00
test_route_regex_debugger.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
test_schedule_export.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_schedules.py Refactoring/optimizing some bits in schedule views (#3039) 2023-09-20 11:49:58 +00:00
test_set_general_log_channel.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_shift_swaps.py Notify user when their shift swap request is taken (#2992) 2023-09-07 14:59:54 +00:00
test_slack_channels.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_slack_team_settings.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_team.py Minor formatting changes (#2641) 2023-07-26 14:45:44 +01:00
test_telegram_channel.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_user.py add rbac_permissions to current-user response + rbac_enabled to current-org response (#2611) 2023-07-21 11:38:58 -04:00
test_user_groups.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_user_notification_policy.py Fix duplicate orders for user notification policies (#2278) 2023-06-21 11:13:56 +00:00
test_user_schedule_export.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
test_webhook_presets.py Add webhook presets (#2996) 2023-09-27 07:22:52 -06:00
test_webhooks.py Add webhook presets (#2996) 2023-09-27 07:22:52 -06:00