Merge pull request #49 from cloudblue/testing_tools

Add testing tools and move to mkdocs.

Author: ffaraone

.github/workflows/build.yml

@@ -52,7 +52,7 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install poetry
-          poetry install
+          poetry install --no-root
       - name: Testing
         run: |
           poetry run pytest

.github/workflows/deploy.yml

@@ -17,7 +17,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install poetry
-        poetry install
+        poetry install --no-root
     - name: Linting
       run: |
         poetry run flake8

.readthedocs.yaml

@@ -0,0 +1,16 @@
+# Required
+version: 2
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+python:
+   install:
+    - requirements: requirements/docs.txt
+    - method: pip
+      path: .

connect/client/testing/__init__.py

@@ -0,0 +1,6 @@
+#
+# This file is part of the Ingram Micro CloudBlue Connect Python OpenAPI Client.
+#
+# Copyright (c) 2021 Ingram Micro. All Rights Reserved.
+#
+from connect.client.testing.fluent import AsyncConnectClientMocker, ConnectClientMocker  # noqa

connect/client/testing/fixtures.py

@@ -0,0 +1,37 @@
+import pytest
+
+from connect.client.testing import AsyncConnectClientMocker, ConnectClientMocker
+
+
+@pytest.fixture
+def client_mocker_factory(request):
+    mocker = None
+
+    def _wrapper(base_url='http://localhost'):
+        mocker = ConnectClientMocker(base_url)
+        mocker.start()
+        return mocker
+
+    def _finalizer():
+        if mocker:  # pragma: no cover
+            mocker.reset()
+
+    request.addfinalizer(_finalizer)
+    return _wrapper
+
+
+@pytest.fixture
+def async_client_mocker_factory(request):
+    mocker = None
+
+    def _wrapper(base_url='http://localhost'):
+        mocker = AsyncConnectClientMocker(base_url)
+        mocker.start()
+        return mocker
+
+    def _finalizer():
+        if mocker:  # pragma: no cover
+            mocker.reset()
+
+    request.addfinalizer(_finalizer)
+    return _wrapper

connect/client/testing/fluent.py

@@ -0,0 +1,178 @@
+#
+# This file is part of the Ingram Micro CloudBlue Connect Python OpenAPI Client.
+#
+# Copyright (c) 2021 Ingram Micro. All Rights Reserved.
+#
+import httpx
+
+import responses
+
+from pytest import MonkeyPatch
+
+from pytest_httpx import HTTPXMock
+from pytest_httpx._httpx_mock import _PytestAsyncTransport
+
+from connect.client.fluent import _ConnectClientBase
+from connect.client.testing.models import CollectionMock, NSMock
+
+
+class ConnectClientMocker(_ConnectClientBase):
+    def __init__(self, base_url):
+        super().__init__('api_key', endpoint=base_url)
+        self._mocker = responses.RequestsMock()
+
+    def get(
+        self,
+        url,
+        status_code=200,
+        return_value=None,
+        headers=None,
+    ):
+        return self.mock(
+            'get',
+            url,
+            status_code=status_code,
+            return_value=return_value,
+            headers=headers,
+        )
+
+    def create(
+        self,
+        url,
+        status_code=201,
+        return_value=None,
+        headers=None,
+    ):
+
+        return self.mock(
+            'post',
+            url,
+            status_code=status_code,
+            return_value=return_value,
+            headers=headers,
+        )
+
+    def update(
+        self,
+        url,
+        status_code=201,
+        return_value=None,
+        headers=None,
+    ):
+
+        return self.mock(
+            'put',
+            url,
+            status_code=status_code,
+            return_value=return_value,
+            headers=headers,
+        )
+
+    def delete(
+        self,
+        url,
+        status_code=204,
+        return_value=None,
+        headers=None,
+    ):
+
+        return self.mock(
+            'delete',
+            url,
+            status_code=status_code,
+            return_value=return_value,
+            headers=headers,
+        )
+
+    def mock(
+        self,
+        method,
+        path,
+        status_code=200,
+        return_value=None,
+        headers=None,
+    ):
+        url = f'{self.endpoint}/{path}'
+
+        kwargs = {
+            'method': method.upper(),
+            'url': url,
+            'status': status_code,
+            'headers': headers,
+        }
+
+        if isinstance(return_value, (dict, list, tuple)):
+            kwargs['json'] = return_value
+        else:
+            kwargs['body'] = return_value
+
+        self._mocker.add(**kwargs)
+
+    def start(self):
+        self._mocker.start()
+
+    def reset(self, success=True):
+        self._mocker.stop(allow_assert=success)
+        self._mocker.reset()
+
+    def __enter__(self):
+        self.start()
+        return self
+
+    def __exit__(self, exc_type, value, traceback):
+        self.reset(success=exc_type is None)
+
+    def _get_collection_class(self):
+        return CollectionMock
+
+    def _get_namespace_class(self):
+        return NSMock
+
+
+class AsyncConnectClientMocker(ConnectClientMocker):
+    def __init__(self, base_url):
+        super().__init__(base_url)
+        self._monkeypatch = None
+        self._mocker = None
+
+    def start(self):
+        self._monkeypatch = MonkeyPatch()
+        self._mocker = HTTPXMock()
+
+        mocker = self._mocker
+
+        self._monkeypatch.setattr(
+            httpx.AsyncClient,
+            '_transport_for_url',
+            lambda self, url: _PytestAsyncTransport(mocker),
+        )
+
+    def reset(self, success=True):
+        self._mocker.reset(success)
+        self._monkeypatch.undo()
+        self._mocker = None
+        self._monkeypatch = None
+
+    def mock(
+        self,
+        method,
+        path,
+        status_code=200,
+        return_value=None,
+        headers=None,
+    ):
+        url = f'{self.endpoint}/{path}'
+
+        kwargs = {
+            'method': method.upper(),
+            'url': url,
+            'status_code': status_code,
+            'headers': headers,
+        }
+
+        if isinstance(return_value, (dict, list, tuple)):
+            kwargs['json'] = return_value
+        else:
+            kwargs['content'] = return_value.encode() if return_value else None
+
+        self._mocker.add_response(**kwargs)

connect/client/testing/models/__init__.py

@@ -0,0 +1,11 @@
+#
+# This file is part of the Ingram Micro CloudBlue Connect Python OpenAPI Client.
+#
+# Copyright (c) 2021 Ingram Micro. All Rights Reserved.
+#
+from connect.client.testing.models.base import (  # noqa
+    ActionMock,
+    CollectionMock,
+    NSMock,
+    ResourceMock,
+)

connect/client/testing/models/base.py

@@ -0,0 +1,43 @@
+#
+# This file is part of the Ingram Micro CloudBlue Connect Python OpenAPI Client.
+#
+# Copyright (c) 2021 Ingram Micro. All Rights Reserved.
+#
+from connect.client.models.base import _ActionBase, _CollectionBase, _NSBase, _ResourceBase
+from connect.client.testing.models.mixins import (
+    ActionMixin,
+    CollectionMixin,
+    ResourceMixin,
+)
+from connect.client.testing.models.resourceset import ResourceSetMock
+
+
+class NSMock(_NSBase):
+    def _get_collection_class(self):
+        return CollectionMock
+
+    def _get_namespace_class(self):
+        return NSMock
+
+
+class CollectionMock(_CollectionBase, CollectionMixin):
+    def _get_resource_class(self):
+        return ResourceMock
+
+    def _get_resourceset_class(self):
+        return ResourceSetMock
+
+    def _get_action_class(self):
+        return ActionMock
+
+
+class ResourceMock(_ResourceBase, ResourceMixin):
+    def _get_collection_class(self):
+        return CollectionMock
+
+    def _get_action_class(self):
+        return ActionMock
+
+
+class ActionMock(_ActionBase, ActionMixin):
+    pass