test(helpdesk): validate response types and add HTTP status assertions

Author: jentyk

e2e_config.test.json

@@ -57,6 +57,7 @@
   "commerce.product.template.id": "TPL-1767-7355-0002",
   "commerce.user.id": "USR-4303-2348",
   "helpdesk.chat.id": "CHT-5064-0262-3671",
+  "helpdesk.channel.id": "CHL-5064-0262-3671",
   "commerce.subscription.agreement.id": "AGR-2473-3299-1721",
   "commerce.subscription.id": "SUB-3678-1831-2188",
   "commerce.subscription.product.item.id": "ITM-1767-7355-0001",

tests/e2e/helpdesk/cases/test_async_cases.py

@@ -1,6 +1,9 @@
+from http import HTTPStatus
+
 import pytest
 
 from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.resources.helpdesk.cases import Case
 
 pytestmark = [pytest.mark.flaky]
 
@@ -12,13 +15,12 @@ async def test_get_case(async_mpt_ops, async_created_case):
     assert result.id == async_created_case.id
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 async def test_list_cases(async_mpt_ops):
     limit = 1
 
     result = await async_mpt_ops.helpdesk.cases.fetch_page(limit=limit)
 
-    assert len(result) > 0
+    assert all(isinstance(case, Case) for case in result)
 
 
 @pytest.mark.skip(reason="Unskip after MPT-19124 completed")
@@ -65,7 +67,7 @@ async def test_complete_case(async_mpt_ops, async_created_case):
     assert result is not None
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 async def test_not_found(async_mpt_ops, invalid_case_id):
-    with pytest.raises(MPTAPIError):
+    with pytest.raises(MPTAPIError) as error:
         await async_mpt_ops.helpdesk.cases.get(invalid_case_id)
+    assert error.value.status_code == HTTPStatus.NOT_FOUND

tests/e2e/helpdesk/cases/test_sync_cases.py

@@ -1,6 +1,9 @@
+from http import HTTPStatus
+
 import pytest
 
 from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.resources.helpdesk.cases import Case
 
 pytestmark = [pytest.mark.flaky]
 
@@ -12,13 +15,12 @@ def test_get_case(mpt_ops, created_case):
     assert result.id == created_case.id
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_list_cases(mpt_ops):
     limit = 1
 
     result = mpt_ops.helpdesk.cases.fetch_page(limit=limit)
 
-    assert len(result) > 0
+    assert all(isinstance(case, Case) for case in result)
 
 
 @pytest.mark.skip(reason="Unskip after MPT-19124 completed")
@@ -65,7 +67,8 @@ def test_complete_case(mpt_ops, created_case):
     assert result is not None
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_not_found(mpt_ops, invalid_case_id):
-    with pytest.raises(MPTAPIError):
+    with pytest.raises(MPTAPIError) as error:
         mpt_ops.helpdesk.cases.get(invalid_case_id)
+
+    assert error.value.status_code == HTTPStatus.NOT_FOUND

tests/e2e/helpdesk/channels/conftest.py

@@ -8,7 +8,7 @@
 
 @pytest.fixture
 def channel_id(e2e_config):
-    return e2e_config["helpdesk.channel.id"]
+    return e2e_config["helpdesk.channel.id"]  # FIXME: seed data
 
 
 @pytest.fixture

tests/e2e/helpdesk/channels/messages/__init__.py

@@ -1 +0,0 @@
-

tests/e2e/helpdesk/channels/messages/test_async_messages.py

@@ -1,6 +1,9 @@
+from http import HTTPStatus
+
 import pytest
 
 from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.resources.helpdesk.chat_messages import ChatMessage
 
 pytestmark = [pytest.mark.flaky]
 
@@ -9,10 +12,11 @@
 async def test_list_channel_messages(async_channel_messages_service):
     result = await async_channel_messages_service.fetch_page(limit=1)
 
-    assert len(result) > 0
+    assert all(isinstance(message, ChatMessage) for message in result)
 
 
 @pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 async def test_list_channel_messages_not_found(async_mpt_ops, invalid_channel_id):
-    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+    with pytest.raises(MPTAPIError) as error:
         await async_mpt_ops.helpdesk.channels.messages(invalid_channel_id).fetch_page(limit=1)
+    assert error.value.status_code == HTTPStatus.NOT_FOUND

tests/e2e/helpdesk/channels/messages/test_sync_messages.py

@@ -1,6 +1,9 @@
+from http import HTTPStatus
+
 import pytest
 
 from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.resources.helpdesk.chat_messages import ChatMessage
 
 pytestmark = [pytest.mark.flaky]
 
@@ -9,10 +12,12 @@
 def test_list_channel_messages(channel_messages_service):
     result = channel_messages_service.fetch_page(limit=1)
 
-    assert len(result) > 0
+    assert all(isinstance(message, ChatMessage) for message in result)
 
 
 @pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_list_channel_messages_not_found(mpt_ops, invalid_channel_id):
-    with pytest.raises(MPTAPIError, match=r"404 Not Found"):
+    with pytest.raises(MPTAPIError) as error:
         mpt_ops.helpdesk.channels.messages(invalid_channel_id).fetch_page(limit=1)
+
+    assert error.value.status_code == HTTPStatus.NOT_FOUND

tests/e2e/helpdesk/channels/test_async_channels.py

@@ -1,11 +1,13 @@
+from http import HTTPStatus
+
 import pytest
 
 from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.resources.helpdesk.channels import Channel
 
-pytestmark = [pytest.mark.flaky]
+pytestmark = [pytest.mark.flaky, pytest.mark.skip(reason="Unskip after MPT-19124 completed")]
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 async def test_get_channel(async_mpt_ops, channel_id):
     service = async_mpt_ops.helpdesk.channels
 
@@ -14,23 +16,20 @@ async def test_get_channel(async_mpt_ops, channel_id):
     assert result.id == channel_id
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 async def test_list_channels(async_mpt_ops):
     service = async_mpt_ops.helpdesk.channels
 
     result = await service.fetch_page(limit=1)
 
-    assert len(result) > 0
+    assert all(isinstance(channel, Channel) for channel in result)
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_create_channel(async_created_channel):
     result = async_created_channel
 
     assert result.id is not None
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 async def test_update_channel(async_mpt_ops, async_created_channel, short_uuid):
     service = async_mpt_ops.helpdesk.channels
     new_name = f"E2E Updated Channel {short_uuid}"
@@ -41,7 +40,6 @@ async def test_update_channel(async_mpt_ops, async_created_channel, short_uuid):
     assert result.to_dict().get("name") == new_name
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 async def test_delete_channel(async_mpt_ops, async_created_channel):
     result = async_created_channel
 
@@ -51,5 +49,6 @@ async def test_delete_channel(async_mpt_ops, async_created_channel):
 async def test_not_found(async_mpt_ops, invalid_channel_id):
     service = async_mpt_ops.helpdesk.channels
 
-    with pytest.raises(MPTAPIError):
+    with pytest.raises(MPTAPIError) as error:
         await service.get(invalid_channel_id)
+    assert error.value.status_code == HTTPStatus.NOT_FOUND

tests/e2e/helpdesk/channels/test_sync_channels.py

@@ -1,11 +1,13 @@
+from http import HTTPStatus
+
 import pytest
 
 from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.resources.helpdesk.channels import Channel
 
-pytestmark = [pytest.mark.flaky]
+pytestmark = [pytest.mark.flaky, pytest.mark.skip(reason="Unskip after MPT-19124 completed")]
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_get_channel(mpt_ops, channel_id):
     service = mpt_ops.helpdesk.channels
 
@@ -14,23 +16,20 @@ def test_get_channel(mpt_ops, channel_id):
     assert result.id == channel_id
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_list_channels(mpt_ops):
     service = mpt_ops.helpdesk.channels
 
     result = service.fetch_page(limit=1)
 
-    assert len(result) > 0
+    assert all(isinstance(channel, Channel) for channel in result)
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_create_channel(created_channel):
     result = created_channel
 
     assert result.id is not None
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_update_channel(mpt_ops, created_channel, short_uuid):
     service = mpt_ops.helpdesk.channels
     new_name = f"E2E Updated Channel {short_uuid}"
@@ -41,7 +40,6 @@ def test_update_channel(mpt_ops, created_channel, short_uuid):
     assert result.to_dict().get("name") == new_name
 
 
-@pytest.mark.skip(reason="Unskip after MPT-19124 completed")
 def test_delete_channel(mpt_ops, created_channel):
     result = created_channel
 
@@ -51,5 +49,7 @@ def test_delete_channel(mpt_ops, created_channel):
 def test_not_found(mpt_ops, invalid_channel_id):
     service = mpt_ops.helpdesk.channels
 
-    with pytest.raises(MPTAPIError):
+    with pytest.raises(MPTAPIError) as error:
         service.get(invalid_channel_id)
+
+    assert error.value.status_code == HTTPStatus.NOT_FOUND

tests/e2e/helpdesk/chats/answers/parameters/test_async_parameters.py

@@ -1,6 +1,9 @@
+from http import HTTPStatus
+
 import pytest
 
 from mpt_api_client.exceptions import MPTAPIError
+from mpt_api_client.resources.helpdesk.chat_answer_parameters import ChatAnswerParameter
 
 pytestmark = [
     pytest.mark.flaky,
@@ -11,7 +14,7 @@
 async def test_list_chat_answer_parameters(async_chat_answer_parameters_service):
     result = await async_chat_answer_parameters_service.fetch_page(limit=20)
 
-    assert len(result) >= 0
+    assert all(isinstance(parameter, ChatAnswerParameter) for parameter in result)
 
 
 async def test_iterate_chat_answer_parameters(async_chat_answer_parameters_service):
@@ -24,5 +27,6 @@ async def test_iterate_chat_answer_parameters(async_chat_answer_parameters_servi
 async def test_not_found(async_mpt_ops, chat_id):
     service = async_mpt_ops.helpdesk.chats.answers(chat_id).parameters("ANS-0000-0000")
 
-    with pytest.raises(MPTAPIError):
+    with pytest.raises(MPTAPIError) as error:
         await service.fetch_page(limit=20)
+    assert error.value.status_code == HTTPStatus.NOT_FOUND