oncall-engine/engine/apps/public_api/tests/test_escalation_chain.py
Joey Orlando 767c5352fa
augment API response pagination attributes (#2471)
# What this PR does

This PR:
- adds a few attributes to paginated API responses
- removes channel filter "send demo alert" internal API endpoint + tests
(this endpoint was marked as deprecated + not consumed by the web UI)

With the new paginated API response schema, the web UI will no longer
need to:
- hardcode `ITEMS_PER_PAGE` for each table
- manually calculate total number of pages

(these two things ☝️ will be done in
https://github.com/grafana/oncall/issues/2476)

For `GET /api/internal/v1/alertgroups` the response will now look like
this:
```diff
{
    "next": <url> | None,
    "previous": <url> | None,
    "results": [],
++  "page_size": <int>
}
```

For all other paginated API responses, the response will now look like:
```diff
{
    "count": <int>,
    "next": <url> | None,
    "previous": <url> | None,
    "results": [],
++  "page_size": <int>,
++  "current_page_number": <int>,
++  "total_pages": <int>
}
```

## TODO
- [x] update public API docs to include these new attributes

## 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)
2023-07-14 11:19:40 -04:00

78 lines
2.4 KiB
Python

import pytest
from django.urls import reverse
from rest_framework import status
from rest_framework.test import APIClient
@pytest.mark.django_db
def test_get_escalation_chains(make_organization_and_user_with_token):
organization, user, token = make_organization_and_user_with_token()
escalation_chain = organization.escalation_chains.create(name="test")
client = APIClient()
url = reverse("api-public:escalation_chains-list")
response = client.get(url, format="json", HTTP_AUTHORIZATION=token)
expected_data = {
"count": 1,
"next": None,
"previous": None,
"results": [
{
"id": escalation_chain.public_primary_key,
"team_id": None,
"name": "test",
}
],
"current_page_number": 1,
"page_size": 50,
"total_pages": 1,
}
assert response.status_code == status.HTTP_200_OK
assert response.data == expected_data
@pytest.mark.django_db
def test_create_escalation_chain(make_organization_and_user_with_token):
organization, user, token = make_organization_and_user_with_token()
data = {"name": "test", "team_id": None}
client = APIClient()
url = reverse("api-public:escalation_chains-list")
response = client.post(url, data=data, format="json", HTTP_AUTHORIZATION=token)
escalation_chain = organization.escalation_chains.get(name="test")
expected_data = {
"id": escalation_chain.public_primary_key,
"team_id": None,
"name": "test",
}
assert response.status_code == status.HTTP_201_CREATED
assert response.data == expected_data
@pytest.mark.django_db
def test_change_name(make_organization_and_user_with_token):
organization, user, token = make_organization_and_user_with_token()
escalation_chain = organization.escalation_chains.create(name="test")
data = {
"id": escalation_chain.public_primary_key,
"name": "changed",
}
client = APIClient()
url = reverse("api-public:escalation_chains-detail", kwargs={"pk": escalation_chain.public_primary_key})
response = client.put(url, data=data, format="json", HTTP_AUTHORIZATION=token)
expected_data = {
"id": escalation_chain.public_primary_key,
"team_id": None,
"name": "changed",
}
assert response.status_code == status.HTTP_200_OK
assert response.data == expected_data