Merge pull request #2 from obytes/tests

Chore: Add Test Command ✨

Author: yezz123

.env.example

@@ -1,2 +1,4 @@
-SECRET_KEY=
-QUEUE=
+SECRET_KEY
+QUEUE
+DATABASE_URL
+ACCESS_TOKEN_EXPIRE_SECONDS

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  # Enable version updates for pip
+  - package-ecosystem: "pip"
+    directory: "/"
+    # Check for updates everyday
+    schedule:
+      interval: "weekly"
+
+  # Enable version updates for Docker
+  - package-ecosystem: "docker"
+    # Look for a `Dockerfile` in the `root` directory
+    directory: "/"
+    # Check for updates once a week
+    schedule:
+      interval: "weekly"

.github/workflows/build.yml

@@ -1,6 +1,10 @@
 name: Build and Test
 
-on: [push, pull_request]
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
 
 jobs:
   build:
@@ -9,8 +13,8 @@ jobs:
     steps:
       - uses: actions/checkout@v1
       - name: pull latest
-        run: make pull
+        run: docker-compose pull
       - name: Build image
-        run: make build
+        run: docker-compose build
       - name: Test code format -- pre-commit
         run: make lint

Dockerfile

@@ -1,14 +1,19 @@
-FROM python:3.9.2
-
-WORKDIR /app
+FROM tiangolo/uvicorn-gunicorn-fastapi:python3.8
 
 ENV PYTHONDONTWRITEBYTECODE 1
 ENV PYTHONUNBUFFERED 1
 
+RUN apt update && apt upgrade -y
+
+RUN apt install -y -q build-essential python3-pip python3-dev
+RUN pip3 install -U pip setuptools wheel
+RUN pip3 install gunicorn uvloop httptools
+
 COPY . /app/
 
 RUN pip install -r requirements.txt
 
+ENV ACCESS_LOG=${ACCESS_LOG:-/proc/1/fd/1}
+ENV ERROR_LOG=${ERROR_LOG:-/proc/1/fd/2}
 
-ENV PYTHONPATH=/app
 EXPOSE 8000 8000

Makefile

@@ -9,23 +9,18 @@ help:
 	@echo "    make clean"
 	@echo "    make clean-test"
 
-test:
-	docker-compose run --rm backend pytest
-
-start:
+up:
 	docker-compose up -d
 
 down:
 	docker-compose down
 
-pull:
-	docker-compose pull db
-	docker-compose pull queue
-	docker-compose pull backend
-
 build:
 	docker-compose build
 
+bash:
+	docker-compose run --rm backend bash
+
 lint:
 	docker-compose run --rm backend pre-commit run --all-files
 

README.md

@@ -73,13 +73,17 @@ $ make build
 $ make start
 ```
 
-__Note__: Running the test on the Container CLI `pytest` or when you use the command `make start` the container will be started and the tests will be run before the Uvicorn server is started.
+### Testing
+
+While i use `HTTPX` an HTTP client for Python 3, to test the API, most of the tests are using a live log thats why need before to run a server using `uvicorn` and migrate the database, then you will have the ability to run the tests. To have a clean environment, recommended to use Docker for that, when you start the containers try to open the application container and then run `pytest` to test the API.
 
 ### Environment variables
 
 ```sh
-SECRET_KEY= #secret key for JWT token
-QUEUE= #rabbitMQ queue name
+SECRET_KEY #Secret Key
+QUEUE # RabbitMQ Link
+DATABASE_URL # Database URL
+ACCESS_TOKEN_EXPIRE_SECONDS # Access Token Expire Seconds
 ```
 
 > change all the environment variables in the `.env.example` and don't forget to rename it to `.env`.

core/rabbit.py

@@ -8,7 +8,7 @@
 
 async def produceblog(blog_id: int):
     connection = await aio_pika.connect(
-        f"amqp://guest:guest@{config.queue}/", loop=asyncio.get_event_loop()
+        f"{config.queue}", loop=asyncio.get_event_loop()
     )
 
     async with connection:

database/config.py

@@ -1,14 +1,13 @@
 from decouple import config
 from pydantic import BaseSettings
 
-Key = config("SECRET_KEY")
 queue = config("QUEUE")
 
 
-class Settings((BaseSettings)):
-    SECRET_KEY = Key
-    ACCESS_TOKEN_EXPIRE_SECONDS: int = 60 * 60 * 24
-    SQLALCHEMY_DATABASE_URI = "postgresql://postgres:password@db/fastql"
+class Settings(((BaseSettings))):
+    SECRET_KEY = config("SECRET_KEY")
+    ACCESS_TOKEN_EXPIRE_SECONDS: int = config("ACCESS_TOKEN_EXPIRE_SECONDS", cast=int)
+    SQLALCHEMY_DATABASE_URI = config("DATABASE_URL")
     SQLALCHEMY_DATABASE_SSL = False
     SQLALCHEMY_DATABASE_MIN_POOL = 1
     SQLALCHEMY_DATABASE_MAX_POOL = 20

docker-compose.yml

@@ -5,9 +5,9 @@ services:
     ports:
       - "5432:5432"
     environment:
-      - POSTGRES_DB=fastql
+      - POSTGRES_DB=postgres
       - POSTGRES_USER=postgres
-      - POSTGRES_PASSWORD=password
+      - POSTGRES_PASSWORD=postgres
   queue:
     image: rabbitmq:3-management
     environment:
@@ -33,7 +33,9 @@ services:
         uvicorn main:app --host 0.0.0.0 --port 8000 --reload
     environment:
       - SECRET_KEY=GITHUBACTIONKEY
-      - QUEUE=queue
+      - QUEUE=amqp://guest:guest@rabbit:5672
+      - DATABASE_URL=postgresql://postgres:postgres@db:5432/postgres
+      - ACCESS_TOKEN_EXPIRE_SECONDS=3600
     ports:
       - "8000:8000"
     image: fastql

pytest.ini

@@ -1,2 +1,8 @@
 [pytest]
-norecursedirs = .gihtub *.egg-info .git appdir .tox
+norecursedirs = .gihtub *.egg-info .git appdir .tox
+log_cli = 1
+log_cli_level = INFO
+log_cli_format = %(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(lineno)s)
+log_cli_date_format=%Y-%m-%d %H:%M:%S
+testpaths =
+    tests/