SDK-1299: Add test coverage for DocScanClient

Author: MrBurtyyy

yoti_python_sdk/docs/exception/doc_scan_exception.py

@@ -11,9 +11,21 @@ def __init__(self, message, response):
         :param response: the http response
         :type response: requests.Response
         """
-        Exception.__init__(self, message)
+        Exception.__init__(self)
+
+        self.__message = message
         self.__response = response
 
+    @property
+    def message(self):
+        """
+        Get the specific exception message
+
+        :return: the exception message
+        :rtype: str
+        """
+        return self.__message
+
     @property
     def status_code(self):
         """
@@ -43,3 +55,6 @@ def content(self):
         :rtype: bytearray or None
         """
         return self.__response.content
+
+    def __str__(self):
+        return self.__message

yoti_python_sdk/tests/conftest.py

@@ -1,6 +1,8 @@
 # -*- coding: utf-8 -*-
 import io
-from os.path import dirname, join, abspath
+from os.path import abspath
+from os.path import dirname
+from os.path import join
 
 import pytest
 

yoti_python_sdk/tests/docs/__init__.py

@@ -0,0 +1,20 @@
+from os.path import abspath
+from os.path import dirname
+from os.path import join
+
+import pytest
+
+from yoti_python_sdk.docs.client import DocScanClient
+
+FIXTURES_DIR = join(dirname(abspath(__file__)), "..", "fixtures")
+PEM_FILE_PATH = join(FIXTURES_DIR, "sdk-test.pem")
+
+YOTI_CLIENT_SDK_ID = "737204aa-d54e-49a4-8bde-26ddbe6d880c"
+
+
+@pytest.fixture(scope="module")
+def doc_scan_client():
+    """
+    :rtype: DocScanClient
+    """
+    return DocScanClient(YOTI_CLIENT_SDK_ID, PEM_FILE_PATH)

yoti_python_sdk/tests/docs/conftest.py

@@ -0,0 +1 @@
+{"error": "MALFORMED_REQUEST"}

yoti_python_sdk/tests/docs/fixtures/failed_request.txt

@@ -0,0 +1 @@
+{"session_id":"someSessionId"}

yoti_python_sdk/tests/docs/fixtures/retrieve_session_success.txt

@@ -0,0 +1 @@
+{"session_id": "someSessionId", "client_session_token": "someClientSessionToken", "client_session_token_ttl": 299}

yoti_python_sdk/tests/docs/fixtures/session_create_success.txt

@@ -0,0 +1,45 @@
+from os.path import abspath
+from os.path import dirname
+from os.path import join
+
+from yoti_python_sdk.tests.mocks import MockResponse
+
+FIXTURES_DIR = join(dirname(abspath(__file__)), "fixtures")
+
+
+def mocked_request_successful_session_creation():
+    with open(FIXTURES_DIR + "/session_create_success.txt", "r") as f:
+        response = f.read()
+    return MockResponse(status_code=201, text=response)
+
+
+def mocked_request_failed_session_creation():
+    with open(FIXTURES_DIR + "/failed_request.txt", "r") as f:
+        response = f.read()
+    return MockResponse(status_code=400, text=response)
+
+
+def mocked_request_successful_session_retrieval():
+    with open(FIXTURES_DIR + "/retrieve_session_success.txt", "r") as f:
+        response = f.read()
+    return MockResponse(status_code=200, text=response)
+
+
+def mocked_request_failed_session_retrieval():
+    return MockResponse(status_code=400, text="")
+
+
+def mocked_request_media_content():
+    return MockResponse(
+        status_code=200,
+        text=b"someContent",
+        headers={"Content-Type": "application/json"},
+    )
+
+
+def mocked_request_missing_content():
+    return MockResponse(status_code=404, text="")
+
+
+def mocked_request_server_error():
+    return MockResponse(status_code=500, text="")

yoti_python_sdk/tests/docs/mocks.py

@@ -0,0 +1,150 @@
+import pytest
+
+from yoti_python_sdk.docs.client import DocScanClient  # noqa: F401
+from yoti_python_sdk.docs.exception import DocScanException
+from yoti_python_sdk.docs.session.create.session_spec import SessionSpec
+from yoti_python_sdk.docs.session.retrieve.create_session_result import (
+    CreateSessionResult,
+)
+from yoti_python_sdk.docs.session.retrieve.get_session_result import GetSessionResult
+from yoti_python_sdk.tests.docs.mocks import mocked_request_failed_session_creation
+from yoti_python_sdk.tests.docs.mocks import mocked_request_failed_session_retrieval
+from yoti_python_sdk.tests.docs.mocks import mocked_request_media_content
+from yoti_python_sdk.tests.docs.mocks import mocked_request_missing_content
+from yoti_python_sdk.tests.docs.mocks import mocked_request_server_error
+from yoti_python_sdk.tests.docs.mocks import mocked_request_successful_session_creation
+from yoti_python_sdk.tests.docs.mocks import mocked_request_successful_session_retrieval
+
+try:
+    from unittest import mock
+except ImportError:
+    import mock
+
+SOME_SESSION_ID = "someSessionId"
+SOME_MEDIA_ID = "someMediaId"
+
+
+@mock.patch(
+    "yoti_python_sdk.http.SignedRequest.execute",
+    side_effect=mocked_request_successful_session_creation,
+)
+def test_should_return_create_session_result(_, doc_scan_client):
+    """
+    :type doc_scan_client: DocScanClient
+    :return:
+    :rtype:
+    """
+    session_spec_mock = mock.Mock(spec=SessionSpec)
+    session_spec_mock.to_json.return_value = {}
+
+    create_session_result = doc_scan_client.create_session(session_spec_mock)
+
+    assert isinstance(create_session_result, CreateSessionResult)
+
+
+@mock.patch(
+    "yoti_python_sdk.http.SignedRequest.execute",
+    side_effect=mocked_request_failed_session_creation,
+)
+def test_should_raise_doc_scan_exception_for_session_creation(_, doc_scan_client):
+    """
+    :type doc_scan_client: DocScanClient
+    """
+    session_spec_mock = mock.Mock(spec=SessionSpec)
+    session_spec_mock.to_json.return_value = {}
+
+    with pytest.raises(DocScanException) as ex:
+        doc_scan_client.create_session(session_spec_mock)
+
+    assert "Failed to create session" in str(ex.value)
+
+
+@mock.patch(
+    "yoti_python_sdk.http.SignedRequest.execute",
+    side_effect=mocked_request_successful_session_retrieval,
+)
+def test_should_return_get_session_result(_, doc_scan_client):
+    """
+    :type doc_scan_client: DocScanClient
+    """
+    session_result = doc_scan_client.get_session(SOME_SESSION_ID)
+
+    assert isinstance(session_result, GetSessionResult)
+
+
+@mock.patch(
+    "yoti_python_sdk.http.SignedRequest.execute",
+    side_effect=mocked_request_failed_session_retrieval,
+)
+def test_should_raise_doc_scan_exception_for_session_retrieval(_, doc_scan_client):
+    """
+    :type doc_scan_client: DocScanClient
+    """
+    with pytest.raises(DocScanException) as ex:
+        doc_scan_client.get_session(SOME_SESSION_ID)
+
+    doc_scan_exception = ex.value  # type: DocScanException
+    assert "Failed to retrieve session" in str(doc_scan_exception)
+    assert doc_scan_exception.status_code == 400
+
+
+@mock.patch(
+    "yoti_python_sdk.http.SignedRequest.execute",
+    side_effect=mocked_request_server_error,
+)
+def test_should_raise_exception_for_delete_session(_, doc_scan_client):
+    """
+    :type doc_scan_client: DocScanClient
+    """
+    with pytest.raises(DocScanException) as ex:
+        doc_scan_client.delete_session(SOME_SESSION_ID)
+
+    doc_scan_exception = ex.value  # type: DocScanException
+    assert "Failed to delete session" in str(doc_scan_exception)
+    assert doc_scan_exception.status_code == 500
+
+
+@mock.patch(
+    "yoti_python_sdk.http.SignedRequest.execute",
+    side_effect=mocked_request_missing_content,
+)
+def test_should_raise_exception_for_invalid_content(_, doc_scan_client):
+    """
+    :type doc_scan_client: DocScanClient
+    """
+    with pytest.raises(DocScanException) as ex:
+        doc_scan_client.get_media_content(SOME_SESSION_ID, SOME_MEDIA_ID)
+
+    doc_scan_exception = ex.value  # type: DocScanException
+    assert "Failed to retrieve media content" in str(doc_scan_exception)
+    assert doc_scan_exception.status_code == 404
+
+
+@mock.patch(
+    "yoti_python_sdk.http.SignedRequest.execute",
+    side_effect=mocked_request_media_content,
+)
+def test_should_return_media_value(_, doc_scan_client):
+    """
+    :type doc_scan_client: DocScanClient
+    """
+    media = doc_scan_client.get_media_content(SOME_SESSION_ID, SOME_MEDIA_ID)
+
+    assert media.mime_type == "application/json"
+    assert media.content == b"someContent"
+
+
+@mock.patch(
+    "yoti_python_sdk.http.SignedRequest.execute",
+    side_effect=mocked_request_missing_content,
+)
+def test_should_throw_exception_for_delete_media(_, doc_scan_client):
+    """
+    :type doc_scan_client: DocScanClient
+    """
+    with pytest.raises(DocScanException) as ex:
+        doc_scan_client.delete_media_content(SOME_SESSION_ID, SOME_MEDIA_ID)
+
+    doc_scan_exception = ex.value  # type: DocScanException
+    assert "Failed to delete media content" in str(doc_scan_exception)
+    assert 404 == doc_scan_exception.status_code

yoti_python_sdk/tests/docs/test_doc_scan_client.py

@@ -1,11 +1,16 @@
+import base64
 from uuid import UUID
-from yoti_python_sdk.http import RequestHandler, SignedRequest
+
+from yoti_python_sdk.http import RequestHandler
+from yoti_python_sdk.http import SignedRequest
 from yoti_python_sdk.http import YotiResponse
-import base64
 
 
 class MockResponse(YotiResponse):
-    def __init__(self, status_code, text, headers={}):
+    def __init__(self, status_code, text, headers=None):
+        if headers is None:
+            headers = dict()
+
         super(MockResponse, self).__init__(status_code, text, headers)
 
     @property