Skip to content

Commit

Permalink
Add inbound email address in integration API (#2113)
Browse files Browse the repository at this point in the history 
# What this PR does

Allows fetching inbound email address for an integration using public
API. There's a new field `inbound_email` that's only defined for inbound
email integration and `null` for any other integration types.

## Which issue(s) this PR fixes

#1989

## 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)
  • Loading branch information
@vstpme
vstpme authored Jun 6, 2023
1 parent cf949ac commit 3ec01c2
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Added

- Allow mobile app to consume "internal" schedules API endpoints by @joeyorlando ([#2109](https://github.com/grafana/oncall/pull/2109))
- Add inbound email address in integration API by @vadimkerr ([#2113](https://github.com/grafana/oncall/pull/2113))

### Fixed

Expand Down
4 changes: 4 additions & 0 deletions docs/sources/oncall-api-reference/integrations.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The above command returns JSON structured in the following way:
"name": "Grafana :blush:",
"team_id": null,
"link": "{{API_URL}}/integrations/v1/grafana/mReAoNwDm0eMwKo1mTeTwYo/",
"inbound_email": null,
"type": "grafana",
"default_route": {
"id": "RVBE4RKQSCGJ2",
Expand Down Expand Up @@ -96,6 +97,7 @@ The above command returns JSON structured in the following way:
"name": "Grafana :blush:",
"team_id": null,
"link": "{{API_URL}}/integrations/v1/grafana/mReAoNwDm0eMwKo1mTeTwYo/",
"inbound_email": null,
"type": "grafana",
"default_route": {
"id": "RVBE4RKQSCGJ2",
Expand Down Expand Up @@ -171,6 +173,7 @@ The above command returns JSON structured in the following way:
"name": "Grafana :blush:",
"team_id": null,
"link": "{{API_URL}}/integrations/v1/grafana/mReAoNwDm0eMwKo1mTeTwYo/",
"inbound_email": null,
"type": "grafana",
"default_route": {
"id": "RVBE4RKQSCGJ2",
Expand Down Expand Up @@ -252,6 +255,7 @@ The above command returns JSON structured in the following way:
"name": "Grafana :blush:",
"team_id": null,
"link": "{{API_URL}}/integrations/v1/grafana/mReAoNwDm0eMwKo1mTeTwYo/",
"inbound_email": null,
"type": "grafana",
"default_route": {
"id": "RVBE4RKQSCGJ2",
Expand Down
3 changes: 3 additions & 0 deletions engine/apps/alerts/models/alert_receive_channel.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -398,6 +398,9 @@ def integration_url(self):

@property
def inbound_email(self):
if self.integration != AlertReceiveChannel.INTEGRATION_INBOUND_EMAIL:
return None

return f"{self.token}@{live_settings.INBOUND_EMAIL_DOMAIN}"

@property
Expand Down
2 changes: 2 additions & 0 deletions engine/apps/public_api/serializers/integrations.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ class IntegrationSerializer(EagerLoadingMixin, serializers.ModelSerializer, Main
name = serializers.CharField(required=False, source="verbal_name")
team_id = TeamPrimaryKeyRelatedField(required=False, allow_null=True, source="team")
link = serializers.ReadOnlyField(source="integration_url")
inbound_email = serializers.ReadOnlyField()
type = IntegrationTypeField(source="integration")
templates = serializers.DictField(required=False)
default_route = serializers.DictField(required=False)
Expand All @@ -93,6 +94,7 @@ class Meta:
"description_short",
"team_id",
"link",
"inbound_email",
"type",
"default_route",
"templates",
Expand Down
57 changes: 57 additions & 0 deletions engine/apps/public_api/tests/test_integrations.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ def test_get_list_integrations(
"name": "grafana",
"description_short": "Some description",
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -165,6 +166,7 @@ def test_update_integration_template(
"name": "grafana",
"description_short": None,
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -227,6 +229,7 @@ def test_update_integration_template_messaging_backend(
"name": "grafana",
"description_short": None,
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -305,6 +308,7 @@ def test_update_resolve_signal_template(
"name": "grafana",
"description_short": None,
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -415,6 +419,7 @@ def test_update_sms_template_with_empty_dict(
"name": "grafana",
"description_short": None,
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -477,6 +482,7 @@ def test_update_integration_name(
"name": "grafana_updated",
"description_short": None,
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -539,6 +545,7 @@ def test_update_integration_name_and_description_short(
"name": "grafana_updated",
"description_short": "Some description",
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -604,6 +611,7 @@ def test_set_default_template(
"name": "grafana",
"description_short": None,
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -672,6 +680,7 @@ def test_set_default_messaging_backend_template(
"name": "grafana",
"description_short": None,
"link": integration.integration_url,
"inbound_email": None,
"type": "grafana",
"default_route": {
"escalation_chain_id": None,
Expand Down Expand Up @@ -734,3 +743,51 @@ def test_get_list_integrations_direct_paging_hidden(
# Check no direct paging integrations in the response
assert response.status_code == status.HTTP_200_OK
assert response.json()["results"] == []


@pytest.mark.django_db
def test_get_list_integrations_link_and_inbound_email(
make_organization_and_user_with_token,
make_alert_receive_channel,
make_channel_filter,
make_integration_heartbeat,
settings,
):
"""
Check that "link" and "inbound_email" fields are populated correctly for different integration types.
"""

settings.BASE_URL = "https://test.com"
settings.INBOUND_EMAIL_DOMAIN = "test.com"

organization, user, token = make_organization_and_user_with_token()

for integration in AlertReceiveChannel._config:
make_alert_receive_channel(organization, integration=integration.slug, token="test123")

client = APIClient()
url = reverse("api-public:integrations-list")

response = client.get(url, HTTP_AUTHORIZATION=f"{token}")
assert response.status_code == status.HTTP_200_OK

for integration in response.json()["results"]:
integration_type, integration_link, integration_inbound_email = (
integration["type"],
integration["link"],
integration["inbound_email"],
)

if integration_type in [
AlertReceiveChannel.INTEGRATION_MANUAL,
AlertReceiveChannel.INTEGRATION_SLACK_CHANNEL,
AlertReceiveChannel.INTEGRATION_MAINTENANCE,
]:
assert integration_link is None
assert integration_inbound_email is None
elif integration_type == AlertReceiveChannel.INTEGRATION_INBOUND_EMAIL:
assert integration_link is None
assert integration_inbound_email == "test123@test.com"
else:
assert integration_link == f"https://test.com/integrations/v1/{integration_type}/test123/"
assert integration_inbound_email is None

0 comments on commit 3ec01c2

Please sign in to comment.