diff --git a/examples/miniapps/fastapi-redis/Dockerfile b/examples/miniapps/fastapi-redis/Dockerfile new file mode 100644 index 00000000..4adbf329 --- /dev/null +++ b/examples/miniapps/fastapi-redis/Dockerfile @@ -0,0 +1,10 @@ +FROM python:3.8-buster + +ENV PYTHONUNBUFFERED=1 + +WORKDIR /code +COPY . /code/ + +RUN pip install -r requirements.txt + +CMD ["uvicorn", "fastapiredis.application:app", "--host", "0.0.0.0"] diff --git a/examples/miniapps/fastapi-redis/README.rst b/examples/miniapps/fastapi-redis/README.rst new file mode 100644 index 00000000..4871fd2f --- /dev/null +++ b/examples/miniapps/fastapi-redis/README.rst @@ -0,0 +1,89 @@ +FastAPI + Redis + Dependency Injector Example +============================================= + +This is a `FastAPI `_ ++ `Redis `_ ++ `Dependency Injector `_ example application. + +Run +--- + +Build the Docker image: + +.. code-block:: bash + + docker-compose build + +Run the docker-compose environment: + +.. code-block:: bash + + docker-compose up + +The output should be something like: + +.. code-block:: + + redis_1 | 1:C 04 Jan 2021 02:42:14.115 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo + redis_1 | 1:C 04 Jan 2021 02:42:14.115 # Redis version=6.0.9, bits=64, commit=00000000, modified=0, pid=1, just started + redis_1 | 1:C 04 Jan 2021 02:42:14.115 # Configuration loaded + redis_1 | 1:M 04 Jan 2021 02:42:14.116 * Running mode=standalone, port=6379. + redis_1 | 1:M 04 Jan 2021 02:42:14.116 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128. + redis_1 | 1:M 04 Jan 2021 02:42:14.116 # Server initialized + redis_1 | 1:M 04 Jan 2021 02:42:14.117 * Loading RDB produced by version 6.0.9 + redis_1 | 1:M 04 Jan 2021 02:42:14.117 * RDB age 1 seconds + redis_1 | 1:M 04 Jan 2021 02:42:14.117 * RDB memory usage when created 0.77 Mb + redis_1 | 1:M 04 Jan 2021 02:42:14.117 * DB loaded from disk: 0.000 seconds + redis_1 | 1:M 04 Jan 2021 02:42:14.117 * Ready to accept connections + redis_1 | 1:signal-handler (1609728137) Received SIGTERM scheduling shutdown... + redis_1 | 1:M 04 Jan 2021 02:42:17.984 # User requested shutdown... + redis_1 | 1:M 04 Jan 2021 02:42:17.984 # Redis is now ready to exit, bye bye... + redis_1 | 1:C 04 Jan 2021 02:42:22.035 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo + redis_1 | 1:C 04 Jan 2021 02:42:22.035 # Redis version=6.0.9, bits=64, commit=00000000, modified=0, pid=1, just started + redis_1 | 1:C 04 Jan 2021 02:42:22.035 # Configuration loaded + redis_1 | 1:M 04 Jan 2021 02:42:22.037 * Running mode=standalone, port=6379. + redis_1 | 1:M 04 Jan 2021 02:42:22.037 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128. + redis_1 | 1:M 04 Jan 2021 02:42:22.037 # Server initialized + redis_1 | 1:M 04 Jan 2021 02:42:22.037 * Loading RDB produced by version 6.0.9 + redis_1 | 1:M 04 Jan 2021 02:42:22.037 * RDB age 9 seconds + redis_1 | 1:M 04 Jan 2021 02:42:22.037 * RDB memory usage when created 0.77 Mb + redis_1 | 1:M 04 Jan 2021 02:42:22.037 * DB loaded from disk: 0.000 seconds + redis_1 | 1:M 04 Jan 2021 02:42:22.037 * Ready to accept connections + example_1 | INFO: Started server process [1] + example_1 | INFO: Waiting for application startup. + example_1 | INFO: Application startup complete. + example_1 | INFO: Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit) + +Test +---- + +This application comes with the unit tests. + +To run the tests do: + +.. code-block:: bash + + docker-compose run --rm example py.test fastapiredis/tests.py --cov=fastapiredis + +The output should be something like: + +.. code-block:: + + platform linux -- Python 3.8.6, pytest-6.2.1, py-1.10.0, pluggy-0.13.1 + rootdir: /code + plugins: cov-2.10.1, asyncio-0.14.0 + collected 1 item + + fastapiredis/tests.py . [100%] + + ----------- coverage: platform linux, python 3.8.6-final-0 ----------- + Name Stmts Miss Cover + ------------------------------------------------- + fastapiredis/__init__.py 0 0 100% + fastapiredis/application.py 15 0 100% + fastapiredis/containers.py 6 0 100% + fastapiredis/redis.py 7 4 43% + fastapiredis/services.py 7 3 57% + fastapiredis/tests.py 18 0 100% + ------------------------------------------------- + TOTAL 53 7 87% diff --git a/examples/miniapps/fastapi-redis/docker-compose.yml b/examples/miniapps/fastapi-redis/docker-compose.yml new file mode 100644 index 00000000..0bc9390a --- /dev/null +++ b/examples/miniapps/fastapi-redis/docker-compose.yml @@ -0,0 +1,21 @@ +version: "3.7" + +services: + + example: + build: . + environment: + REDIS_HOST: "redis" + REDIS_PASSWORD: "password" + ports: + - "8000:8000" + volumes: + - "./:/code" + depends_on: + - "redis" + + redis: + image: redis + command: ["redis-server", "--requirepass", "password"] + ports: + - "6379:6379" diff --git a/examples/miniapps/fastapi-redis/fastapiredis/__init__.py b/examples/miniapps/fastapi-redis/fastapiredis/__init__.py new file mode 100644 index 00000000..1c744ca5 --- /dev/null +++ b/examples/miniapps/fastapi-redis/fastapiredis/__init__.py @@ -0,0 +1 @@ +"""Top-level package.""" diff --git a/examples/miniapps/fastapi-redis/fastapiredis/application.py b/examples/miniapps/fastapi-redis/fastapiredis/application.py new file mode 100644 index 00000000..706b472f --- /dev/null +++ b/examples/miniapps/fastapi-redis/fastapiredis/application.py @@ -0,0 +1,25 @@ +"""Application module.""" + +import sys + +from fastapi import FastAPI, Depends +from dependency_injector.wiring import inject, Provide + +from .containers import Container +from .services import Service + + +app = FastAPI() + + +@app.api_route('/') +@inject +async def index(service: Service = Depends(Provide[Container.service])): + value = await service.process() + return {'result': value} + + +container = Container() +container.config.redis_host.from_env('REDIS_HOST', 'localhost') +container.config.redis_password.from_env('REDIS_PASSWORD', 'password') +container.wire(modules=[sys.modules[__name__]]) diff --git a/examples/miniapps/fastapi-redis/fastapiredis/containers.py b/examples/miniapps/fastapi-redis/fastapiredis/containers.py new file mode 100644 index 00000000..118bb339 --- /dev/null +++ b/examples/miniapps/fastapi-redis/fastapiredis/containers.py @@ -0,0 +1,21 @@ +"""Container module.""" + +from dependency_injector import containers, providers + +from . import redis, services + + +class Container(containers.DeclarativeContainer): + + config = providers.Configuration() + + redis_pool = providers.Resource( + redis.init_redis_pool, + host=config.redis_host, + password=config.redis_password, + ) + + service = providers.Factory( + services.Service, + redis=redis_pool, + ) diff --git a/examples/miniapps/fastapi-redis/fastapiredis/redis.py b/examples/miniapps/fastapi-redis/fastapiredis/redis.py new file mode 100644 index 00000000..99a549a6 --- /dev/null +++ b/examples/miniapps/fastapi-redis/fastapiredis/redis.py @@ -0,0 +1,13 @@ +"""Redis client module.""" + +from typing import AsyncIterator + +from aioredis import create_redis_pool, Redis + + +async def init_redis_pool(host: str, password: str) -> AsyncIterator[Redis]: + pool = await create_redis_pool(f'redis://{host}', password=password) + yield pool + pool.close() + await pool.wait_closed() + diff --git a/examples/miniapps/fastapi-redis/fastapiredis/services.py b/examples/miniapps/fastapi-redis/fastapiredis/services.py new file mode 100644 index 00000000..7d426433 --- /dev/null +++ b/examples/miniapps/fastapi-redis/fastapiredis/services.py @@ -0,0 +1,12 @@ +"""Services module.""" + +from aioredis import Redis + + +class Service: + def __init__(self, redis: Redis) -> None: + self._redis = redis + + async def process(self) -> str: + await self._redis.set('my-key', 'value') + return await self._redis.get('my-key', encoding='utf-8') diff --git a/examples/miniapps/fastapi-redis/fastapiredis/tests.py b/examples/miniapps/fastapi-redis/fastapiredis/tests.py new file mode 100644 index 00000000..6ac376e5 --- /dev/null +++ b/examples/miniapps/fastapi-redis/fastapiredis/tests.py @@ -0,0 +1,28 @@ +"""Tests module.""" + +from unittest import mock + +import pytest +from httpx import AsyncClient + +from .application import app, container +from .services import Service + + +@pytest.fixture +def client(event_loop): + client = AsyncClient(app=app, base_url='http://test') + yield client + event_loop.run_until_complete(client.aclose()) + + +@pytest.mark.asyncio +async def test_index(client): + service_mock = mock.AsyncMock(spec=Service) + service_mock.process.return_value = 'Foo' + + with container.service.override(service_mock): + response = await client.get('/') + + assert response.status_code == 200 + assert response.json() == {'result': 'Foo'} diff --git a/examples/miniapps/fastapi-redis/requirements.txt b/examples/miniapps/fastapi-redis/requirements.txt new file mode 100644 index 00000000..c217324a --- /dev/null +++ b/examples/miniapps/fastapi-redis/requirements.txt @@ -0,0 +1,10 @@ +dependency-injector +fastapi +uvicorn +aioredis + +# For testing: +pytest +pytest-asyncio +pytest-cov +httpx diff --git a/examples/miniapps/fastapi-redis/tests.py b/examples/miniapps/fastapi-redis/tests.py new file mode 100644 index 00000000..bf462eb7 --- /dev/null +++ b/examples/miniapps/fastapi-redis/tests.py @@ -0,0 +1,25 @@ +from unittest import mock + +import pytest +from httpx import AsyncClient + +from fastapi_redis_example import app, container, Service + + +@pytest.fixture +def client(event_loop): + client = AsyncClient(app=app, base_url='http://test') + yield client + event_loop.run_until_complete(client.aclose()) + + +@pytest.mark.asyncio +async def test_index(client): + service_mock = mock.AsyncMock(spec=Service) + service_mock.process.return_value = 'Foo' + + with container.service.override(service_mock): + response = await client.get('/') + + assert response.status_code == 200 + assert response.json() == {'result': 'Foo'}