chore: replace psql with mongo; feat: add new proxy with lets encrypt

nickatnight · nickatnight · commit a3cc81e36510 · 2021-06-04T20:47:27.000-07:00
diff --git a/.env_example b/.env_example
@@ -1,10 +1,16 @@
 ENV=dev
-PROJECT_NAME=
+PROJECT_NAME=fastapi_backend_base
+VERSION=v1
 
-POSTGRES_DB=
-POSTGRES_USER=
-POSTGRES_PASSWORD=
-POSTGRES_HOST=db
+MONGODB_USER=fastapibackendbase
+MONGODB_PASS=fastapibackendbase1234
+MONGODB_HOST=mongodb
+MONGODB_DATABASE=fastapibackendbase
+MONGODB_PORT=27017
+
+MONGO_INITDB_ROOT_USERNAME=admin
+MONGO_INITDB_ROOT_PASSWORD=admin1234
+MONGO_INITDB_DATABASE=fastapibackendbase
 
 NGINX_HOST=localhost
 UPSTREAMS=/:backend:8000
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -7,11 +7,11 @@ on:
 
 jobs:
   linter:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-20.04
     name: Check python linting
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Start linter
         run: |
-          docker run --rm -w="/code/backend" -v $(pwd):/code alpine/flake8:3.5.0 .
+          docker run --rm -w="/code/backend" -v $(pwd):/code alpine/flake8:3.9.2 .
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,9 @@
 .env
 
 __pycache__
+.pytest_cache
+*.out
+
+htmlcov/
+coverage.xml
+.coverage
diff --git a/backend/Dockerfile b/backend/Dockerfile
@@ -1,24 +1,24 @@
-FROM python:3.8-slim-buster
+FROM alpine:3.11
+
+LABEL maintainer Nick <nick@night.com>
 
 ARG env
-ARG requirements_file
-ENV REQUIREMENTS_FILE ${requirements_file:-dev.txt}
+ENV REQUIREMENTS_FILE ${env:-dev}.txt
+ENV PYTHONPATH "${PYTHONPATH}:/code/backend/src"
 
-RUN apt-get update &&\
-    apt-get install --yes --no-install-recommends \
-    gcc \
-    musl-dev \
-    postgresql-client \
-    postgresql-contrib \
+RUN apk add --no-cache \
+    bash \
     python3-dev \
-    python3-pip &&\
-    apt-get clean &&\
-    rm -rf /var/lib/apt/lists/*
-
-RUN pip3 install --no-cache-dir --upgrade pip
+    py3-pip \
+    gcc \
+    musl-dev &&\
+    pip3 install --upgrade pip &&\
+    rm -rf /tmp/*
 
 ADD /requirements/base.txt /requirements/$REQUIREMENTS_FILE /tmp/
 RUN pip3 install --no-cache-dir -r /tmp/$REQUIREMENTS_FILE
 
 ADD . /code/
 WORKDIR /code/
+
+EXPOSE 8000
diff --git a/backend/logconfig.yml b/backend/logconfig.yml
@@ -0,0 +1,36 @@
+version: 1
+disable_existing_loggers: False
+formatters:
+  default:
+    "()": uvicorn.logging.DefaultFormatter
+    format: '[%(asctime)s] - %(name)s - %(levelname)s - %(message)s'
+    datefmt: "%d/%b/%Y %H:%M:%S"
+  access:
+    "()": uvicorn.logging.AccessFormatter
+    format: '[%(asctime)s] - %(name)s - %(levelname)s - %(message)s'
+    datefmt: "%d/%b/%Y %H:%M:%S"
+handlers:
+  default:
+    formatter: default
+    class: logging.StreamHandler
+    stream: ext://sys.stderr
+  access:
+    formatter: access
+    class: logging.StreamHandler
+    stream: ext://sys.stdout
+loggers:
+  uvicorn.error:
+    level: INFO
+    handlers:
+      - default
+    propagate: yes
+  uvicorn.access:
+    level: INFO
+    handlers:
+      - access
+    propagate: no
+  src.utils.runbot:
+    level: DEBUG
+    propogate: no
+    handlers:
+      - default
diff --git a/backend/pyproject.toml b/backend/pyproject.toml
@@ -0,0 +1,13 @@
+[tool.black]
+line-length = 100
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+)/
+'''
diff --git a/backend/requirements/base.txt b/backend/requirements/base.txt
@@ -1,10 +1,11 @@
 # api
 fastapi==0.65.1
 uvicorn==0.13.4
-requests==2.25.1
 
 # database
-databases[postgresql]==0.4.3
-psycopg2-binary==2.8.6
 SQLAlchemy==1.3.24
-asyncpg==0.23.0
+pydantic==1.8.2
+motor==2.4.0
+
+# utils
+PyYAML==5.4.1
diff --git a/backend/requirements/dev.txt b/backend/requirements/dev.txt
@@ -3,3 +3,4 @@
 pytest==6.2.3
 black==21.5b1
 flake8==3.9.2
+pytest-cov==2.12.0
diff --git a/backend/src/api/routes.py b/backend/src/api/routes.py
@@ -1,7 +1,16 @@
-from fastapi import APIRouter
+from fastapi import APIRouter, status
+from fastapi.responses import PlainTextResponse
 
 from src.api.v1 import health
 
 
+home_router = APIRouter()
+
+
+@home_router.get("/", response_description="Homepage", include_in_schema=False)
+async def home():
+    return PlainTextResponse("127.0.0.1", status_code=status.HTTP_200_OK)
+
+
 api_router = APIRouter()
 api_router.include_router(health.router)
diff --git a/backend/src/api/v1/health.py b/backend/src/api/v1/health.py
@@ -4,7 +4,7 @@
 router = APIRouter()
 
 
-@router.get("/ping")
+@router.get("/ping", tags=["health"])
 async def pong():
     # some async operation could happen here
     # example: `data = await get_all_datas()`
diff --git a/backend/src/app.py b/backend/src/app.py
diff --git a/backend/src/config.py b/backend/src/config.py
@@ -1,25 +1,25 @@
-import os
 import secrets
-from typing import List
+from typing import List, Optional
 
-from pydantic import AnyHttpUrl, BaseSettings
+from pydantic import AnyHttpUrl, BaseSettings, Field
 
 
 class Settings(BaseSettings):
-    API_V1_STR: str = "/api/v1"
+    API_V1_STR: str = "/v1"
     SECRET_KEY: str = secrets.token_urlsafe(32)
     # 60 minutes * 24 hours * 8 days = 8 days
     ACCESS_TOKEN_EXPIRE_MINUTES: int = 60 * 24 * 8
-    SERVER_NAME: str = os.getenv("NGINX_HOST", "localhost")
+    SERVER_NAME: Optional[str] = Field(..., env="NGINX_HOST")
     BACKEND_CORS_ORIGINS: List[AnyHttpUrl] = []
 
-    PROJECT_NAME: str = os.getenv("PROJECT_NAME", "")
+    PROJECT_NAME: str = Field(..., env="PROJECT_NAME")
 
-    POSTGRES_DB: str = os.getenv("POSTGRES_DB", "")
-    POSTGRES_USER: str = os.getenv("POSTGRES_USER", "")
-    POSTGRES_PASSWORD: str = os.getenv("POSTGRES_PASSWORD", "")
-    POSTGRES_DB: str = os.getenv("POSTGRES_DB", "db")
-    POSTGRES_URL: str = os.getenv("POSTGRES_URL", "")
+    MONGODB_HOST: str = Field(..., env="MONGODB_HOST")
+    MONGODB_USER: str = Field(..., env="MONGODB_USER")
+    MONGODB_PASS: str = Field(..., env="MONGODB_PASS")
+    MONGODB_DATABASE: str = Field(..., env="MONGODB_DATABASE")
+
+    VERSION: str = Field(..., env="VERSION")
 
 
 settings = Settings()
diff --git a/backend/src/db.py b/backend/src/db.py
@@ -1,12 +1,24 @@
-from databases import Database
-from sqlalchemy import create_engine, MetaData
-
+from motor.motor_asyncio import AsyncIOMotorClient
 from src.config import settings
 
 
-# SQLAlchemy
-engine = create_engine(settings.POSTGRES_URL, pool_size=3, max_overflow=0)
-metadata = MetaData()
+MONGODB_URL = f"mongodb://{settings.MONGODB_USER}:{settings.MONGODB_PASS}@mongodb:27017/{settings.MONGODB_DATABASE}"  # noqa
+
+
+class DataBase:
+    client: AsyncIOMotorClient = None
+
+
+db = DataBase()
+
+
+async def get_database() -> AsyncIOMotorClient:
+    return db.client[settings.MONGODB_DATABASE]
+
+
+async def connect_to_mongo():
+    db.client = AsyncIOMotorClient(MONGODB_URL, maxPoolSize=3, minPoolSize=0)
+
 
-# databases query builder
-database = Database(settings.POSTGRES_URL)
+async def close_mongo_connection():
+    db.client.close()
diff --git a/backend/src/main.py b/backend/src/main.py
@@ -0,0 +1,30 @@
+from fastapi import FastAPI
+from fastapi.middleware.cors import CORSMiddleware
+
+from src.api import routes
+from src.config import settings
+from src.db import close_mongo_connection, connect_to_mongo
+
+
+tags_metadata = [
+    {
+        "name": "health",
+        "description": "Health check for api",
+    },
+]
+
+app = FastAPI(
+    title="fastapi-backend-base",
+    description="base project for fastapi backend",
+    version=settings.VERSION,
+    openapi_tags=tags_metadata,
+)
+
+
+app.add_middleware(CORSMiddleware, allow_origins=["*"])
+
+app.add_event_handler("startup", connect_to_mongo)
+app.add_event_handler("shutdown", close_mongo_connection)
+
+app.include_router(routes.home_router)
+app.include_router(routes.api_router, prefix=settings.API_V1_STR)
diff --git a/backend/src/tests/test_routes.py b/backend/src/tests/test_routes.py
@@ -1,12 +1,12 @@
 from fastapi.testclient import TestClient
 
-from src.app import app
+from src.main import app
 
 
 client = TestClient(app)
 
 
 def test_health():
-    response = client.get("/api/v1/ping")
+    response = client.get("/v1/ping")
     assert response.status_code == 200
     assert response.json() == {"ping": "pong!"}
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -2,18 +2,22 @@ version: '3'
 
 volumes:
   base-data:
-  db-data:
+  mongodb-data:
+  proxy-data:
 
 services:
-  db:
+  mongodb:
+    restart: always
     env_file:
       - .env
-    image: postgres:12
+    build:
+      context: ./mongodb
+      dockerfile: ./Dockerfile
     expose:
-      - "5432"
+      - "27017"
     volumes:
-      - db-data:/var/lib/postgresql/data
-    
+      - mongodb-data:/data/db
+
   backend:
     restart: always
     env_file:
@@ -23,23 +27,26 @@ services:
       dockerfile: ./Dockerfile
       args:
         env: ${ENV}
-        requirements_file: '${ENV}.txt'
     ports:
       - '8000:8000'
     command: |
-        bash -c "while !</dev/tcp/db/5432; do sleep 1; done; uvicorn src.app:app --reload --workers 1 --host 0.0.0.0 --port 8000"
+        bash -c "while !</dev/tcp/mongodb/27017; do sleep 1; done; uvicorn src.main:app --reload --workers 1 --host 0.0.0.0 --port 8000 --log-config=logconfig.yml"
     depends_on:
-      - db
+      - mongodb
     environment:
       - PYTHONUNBUFFERED=0
-      - POSTGRES_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@db/${POSTGRES_DB}
     volumes:
       - base-data:/data
       - ./backend/:/code
 
   proxy:
-    image: tivix/docker-nginx:v6
+    restart: always
     ports:
       - '0.0.0.0:80:80'
     env_file:
-      - .env
+      - .env
+    build:
+      context: ./proxy
+      dockerfile: ./Dockerfile
+    volumes:
+        - proxy-data:/etc/letsencrypt
diff --git a/mongodb/Dockerfile b/mongodb/Dockerfile
@@ -0,0 +1,8 @@
+FROM mongo:latest
+
+LABEL maintainer Nick <nick@night.com>
+
+# TODO: make read only
+COPY ./scripts/mongo-init.sh /docker-entrypoint-initdb.d/
+
+EXPOSE 27017
diff --git a/mongodb/scripts/mongo-init.sh b/mongodb/scripts/mongo-init.sh
diff --git a/proxy/Dockerfile b/proxy/Dockerfile
diff --git a/proxy/docker-entrypoint.sh b/proxy/docker-entrypoint.sh
diff --git a/proxy/templates/nginx.conf.j2 b/proxy/templates/nginx.conf.j2
diff --git a/proxy/templates/site.conf.j2 b/proxy/templates/site.conf.j2
