Merge pull request #3 from OpenMatchmaking/feature-sage-utils-tests

Tests for sage-utils library

Author: Relrin

.gitignore

@@ -15,6 +15,7 @@ __pycache__/
 env/
 build/
 develop-eggs/
+.pytest_cache/
 dist/
 downloads/
 eggs/

Dockerfile

@@ -0,0 +1,8 @@
+FROM openmatchmaking/docker-base-python-image:3.6
+RUN apt-get update && apt-get -y install make
+
+COPY requirements-dev.txt /requirements-dev.txt
+RUN pip install -r requirements-dev.txt
+
+COPY ./ /app
+WORKDIR /app

Makefile

@@ -0,0 +1,8 @@
+flake:
+	flake8 sage_utils tests
+
+develop:
+	python setup.py develop
+
+test:
+	py.test -q -s --cov sage_utils --cov-report term-missing --tb=native

docker-compose.dev.yml

@@ -0,0 +1,41 @@
+version: "2"
+
+networks:
+  app-tier:
+    driver: bridge
+
+services:
+
+  app:
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+    image: sage-utils-dev
+    environment:
+      - APP_HOST=0.0.0.0
+      - APP_DEBUG=False
+      - APP_SERVER=none
+      - WAIT_FOR_RABBITMQ=30
+      - AMQP_USERNAME=user
+      - AMQP_PASSWORD=password
+      - AMQP_HOST=rabbitmq
+      - AMQP_VIRTUAL_HOST=/
+    volumes:
+      - ./:/app/
+    depends_on:
+      - rabbitmq
+    networks:
+      - app-tier
+    tty: true
+
+  rabbitmq:
+    image: bitnami/rabbitmq:latest
+    ports:
+      - 5672:5672
+      - 15672:15672
+    environment:
+      - RABBITMQ_USERNAME=user
+      - RABBITMQ_PASSWORD=password
+      - RABBITMQ_VHOST=/
+    networks:
+      - app-tier

requirements-dev.txt

@@ -0,0 +1,5 @@
+flake8==3.5.0
+pytest==3.5.0
+pytest-asyncio==0.8.0
+pytest-cov==2.5.1
+pudb==2015.4.1

sage_utils/amqp/extension.py

@@ -6,6 +6,7 @@
 
 
 class AmqpExtension(BaseExtension):
+    extension_name = 'amqp'
     app_attribute = 'amqp'
     workers = []
     active_tasks = []
@@ -31,6 +32,7 @@ async def connect(self):
     async def init(self, loop):
         if not hasattr(self.app, 'extensions'):
             setattr(self.app, 'extensions', {})
+        setattr(self.app, self.app_attribute, self)
         self.app.extensions[self.extension_name] = self
 
         for worker in self.workers:

setup.cfg

@@ -0,0 +1,5 @@
+[wheel]
+universal = 1
+
+[flake8]
+max-line-length = 100

tests/amqp/__init__.py

@@ -0,0 +1,59 @@
+import asyncio
+
+import pytest
+from sage_utils.amqp.extension import AmqpExtension
+from sage_utils.amqp.base import AmqpWorker
+
+from tests.fixtures import Application, FakeConfig
+
+
+class CustomWorker(AmqpWorker):
+
+    async def run(self, *args, **kwargs):
+        await self.connect()
+
+
+@pytest.mark.asyncio
+async def test_extension_without_workers(event_loop):
+    app = Application()
+    extension = AmqpExtension(app)
+
+    await extension.init(event_loop)
+    assert 'extensions' in app.__dict__
+    assert isinstance(app.extensions, dict)
+    assert len(app.extensions.keys()) == 1
+    assert extension.extension_name in app.extensions.keys()
+    assert app.extensions[extension.extension_name] == extension
+    assert len(extension.active_tasks) == 0
+
+    await asyncio.sleep(0.1)
+
+    await extension.deinit(event_loop)
+    assert 'extensions' in app.__dict__
+    assert extension.extension_name not in app.extensions.keys()
+    assert getattr(app, AmqpExtension.app_attribute) is None
+    assert len(extension.active_tasks) == 0
+
+
+@pytest.mark.asyncio
+async def test_extension_init_with_workers(event_loop):
+    app = Application(config=FakeConfig())
+    amqp_worker = CustomWorker(app)
+    extension = AmqpExtension(app)
+    extension.register_worker(amqp_worker)
+
+    await extension.init(event_loop)
+    assert 'extensions' in app.__dict__
+    assert isinstance(app.extensions, dict)
+    assert len(app.extensions.keys()) == 1
+    assert extension.extension_name in app.extensions.keys()
+    assert app.extensions[extension.extension_name] == extension
+    assert len(extension.active_tasks) == 1
+
+    await asyncio.sleep(0.1)
+
+    await extension.deinit(event_loop)
+    assert 'extensions' in app.__dict__
+    assert extension.extension_name not in app.extensions.keys()
+    assert getattr(app, AmqpExtension.app_attribute) is None
+    assert len(extension.active_tasks) == 1

tests/amqp/test_extension.py

@@ -0,0 +1,71 @@
+import pytest
+from sage_utils.amqp.clients import RpcAmqpClient
+from sage_utils.amqp.extension import AmqpExtension
+from sage_utils.constants import VALIDATION_ERROR
+from sage_utils.wrappers import Response
+
+from tests.fixtures import Application, FakeConfig, FakeRegisterMicroserviceWorker
+
+
+REQUEST_QUEUE = FakeRegisterMicroserviceWorker.QUEUE_NAME
+REQUEST_EXCHANGE = FakeRegisterMicroserviceWorker.REQUEST_EXCHANGE_NAME
+RESPONSE_EXCHANGE_NAME = FakeRegisterMicroserviceWorker.RESPONSE_EXCHANGE_NAME
+VALIDATION_ERROR_DECR = FakeRegisterMicroserviceWorker.ERROR_DESCRIPTION
+
+
+@pytest.mark.asyncio
+async def test_rpc_amqp_client_returns_ok(event_loop):
+    app = Application(config=FakeConfig(), loop=event_loop)
+    register_worker = FakeRegisterMicroserviceWorker(app)
+    extension = AmqpExtension(app)
+    extension.register_worker(register_worker)
+
+    await extension.init(event_loop)
+
+    client = RpcAmqpClient(
+        app=app,
+        routing_key=REQUEST_QUEUE,
+        request_exchange=REQUEST_EXCHANGE,
+        response_queue='',
+        response_exchange=RESPONSE_EXCHANGE_NAME
+    )
+    response = await client.send(payload={'name': 'microservice', 'version': '1.0.0'})
+
+    assert Response.CONTENT_FIELD_NAME in response.keys()
+    assert response[Response.CONTENT_FIELD_NAME] == 'OK'
+
+    assert Response.EVENT_FIELD_NAME in response.keys()
+    assert response[Response.EVENT_FIELD_NAME] is None
+
+    await extension.deinit(event_loop)
+
+
+@pytest.mark.asyncio
+async def test_rpc_amqp_client_returns_an_error(event_loop):
+    app = Application(config=FakeConfig(), loop=event_loop)
+    register_worker = FakeRegisterMicroserviceWorker(app)
+    extension = AmqpExtension(app)
+    extension.register_worker(register_worker)
+
+    await extension.init(event_loop)
+
+    client = RpcAmqpClient(
+        app=app,
+        routing_key=REQUEST_QUEUE,
+        request_exchange=REQUEST_EXCHANGE,
+        response_queue='',
+        response_exchange=RESPONSE_EXCHANGE_NAME
+    )
+    response = await client.send(payload={})
+
+    assert Response.ERROR_FIELD_NAME in response.keys()
+    assert 'message' in response[Response.ERROR_FIELD_NAME].keys()
+    assert response[Response.ERROR_FIELD_NAME]['message'] == VALIDATION_ERROR_DECR
+
+    assert 'type' in response[Response.ERROR_FIELD_NAME].keys()
+    assert response[Response.ERROR_FIELD_NAME]['type'] == VALIDATION_ERROR
+
+    assert Response.EVENT_FIELD_NAME in response.keys()
+    assert response[Response.EVENT_FIELD_NAME] is None
+
+    await extension.deinit(event_loop)

tests/amqp/test_rpc_client.py

@@ -0,0 +1,103 @@
+from unittest import mock
+
+import pytest
+from sage_utils.amqp.extension import AmqpExtension
+from sage_utils.amqp.workers import BaseRegisterWorker
+
+from tests.fixtures import Application, FakeConfig, FakeRegisterMicroserviceWorker
+
+
+REQUEST_QUEUE = FakeRegisterMicroserviceWorker.QUEUE_NAME
+REQUEST_EXCHANGE = FakeRegisterMicroserviceWorker.REQUEST_EXCHANGE_NAME
+RESPONSE_EXCHANGE_NAME = FakeRegisterMicroserviceWorker.RESPONSE_EXCHANGE_NAME
+
+
+def valid_microservice_data(_app):
+    return {'name': 'microservice', 'version': '1.0.0'}
+
+
+def invalid_microservice_data(_app):
+    return {}
+
+
+def test_default_implementation_raises_an_error_when_getting_data():
+    with pytest.raises(NotImplementedError):
+        app = Application(config=FakeConfig())
+        instance = BaseRegisterWorker(app)
+        instance.get_microservice_data(app)
+
+
+@pytest.mark.asyncio
+async def test_microservice_has_been_registered_successfully(event_loop):
+    app = Application(config=FakeConfig(), loop=event_loop)
+    register_worker = FakeRegisterMicroserviceWorker(app)
+    extension = AmqpExtension(app)
+    extension.register_worker(register_worker)
+
+    await extension.init(event_loop)
+
+    instance = BaseRegisterWorker(app)
+    instance.REQUEST_QUEUE_NAME = REQUEST_QUEUE
+    instance.REQUEST_EXCHANGE_NAME = REQUEST_EXCHANGE
+    instance.RESPONSE_EXCHANGE_NAME = RESPONSE_EXCHANGE_NAME
+
+    with mock.patch(
+        target='sage_utils.amqp.workers.BaseRegisterWorker.get_microservice_data',
+        side_effect=valid_microservice_data
+    ):
+        result = await instance.run()
+        assert result is None
+
+    await extension.deinit(event_loop)
+
+
+@pytest.mark.asyncio
+async def test_register_worker_raises_an_error_with_invalid_response(event_loop):
+    app = Application(config=FakeConfig(), loop=event_loop)
+    register_worker = FakeRegisterMicroserviceWorker(app)
+    extension = AmqpExtension(app)
+    extension.register_worker(register_worker)
+
+    await extension.init(event_loop)
+
+    instance = BaseRegisterWorker(app)
+    instance.REQUEST_QUEUE_NAME = REQUEST_QUEUE
+    instance.REQUEST_EXCHANGE_NAME = REQUEST_EXCHANGE
+    instance.RESPONSE_EXCHANGE_NAME = RESPONSE_EXCHANGE_NAME
+    instance.RETRY_TIMEOUT = 0.1
+    instance.MAX_RETRIES = 1
+
+    with mock.patch(
+        target='sage_utils.amqp.workers.BaseRegisterWorker.get_microservice_data',
+        side_effect=invalid_microservice_data
+    ):
+        with pytest.raises(ConnectionError):
+            await instance.run()
+
+    await extension.deinit(event_loop)
+
+
+@pytest.mark.asyncio
+async def test_register_worker_raises_an_error(event_loop):
+    app = Application(config=FakeConfig(), loop=event_loop)
+    register_worker = FakeRegisterMicroserviceWorker(app)
+    extension = AmqpExtension(app)
+    extension.register_worker(register_worker)
+
+    await extension.init(event_loop)
+
+    instance = BaseRegisterWorker(app)
+    instance.REQUEST_QUEUE_NAME = 'invalid.queue.name'
+    instance.REQUEST_EXCHANGE_NAME = 'some.request.exchange'
+    instance.RESPONSE_EXCHANGE_NAME = 'some.response.exchange'
+    instance.RETRY_TIMEOUT = 0.1
+    instance.MAX_RETRIES = 1
+
+    with mock.patch(
+        target='sage_utils.amqp.workers.BaseRegisterWorker.get_microservice_data',
+        side_effect=valid_microservice_data
+    ):
+        with pytest.raises(ConnectionError):
+            await instance.run()
+
+    await extension.deinit(event_loop)