Added Feature: Code Coverage & Code Quality

.gitignore

@@ -1,3 +1,5 @@
 __pycache__
 env
-.idea
+.idea
+.coverage
+htmlcov

project/.coveragerc

@@ -0,0 +1,3 @@
+[run]
+omit = tests/*
+branch = True

project/.dockerignore

@@ -0,0 +1,2 @@
+.coverage
+htmlcov

project/Dockerfile.prod

@@ -0,0 +1,43 @@
+# pull official base image
+FROM python:3.8.8-slim-buster
+
+# create directory for the app user
+RUN mkdir -p /home/app
+
+# create the app user
+RUN addgroup --system app && adduser --system --group app
+
+# create the appropriate directories
+ENV HOME=/home/app
+ENV APP_HOME=/home/app/web
+RUN mkdir $APP_HOME
+WORKDIR $APP_HOME
+
+# set environment variables
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONUNBUFFERED 1
+ENV ENVIRONMENT prod
+ENV TESTING 0
+
+# install system dependencies
+RUN apt-get update \
+  && apt-get -y install netcat gcc postgresql \
+  && apt-get clean
+
+# install python dependencies
+RUN pip install --upgrade pip
+COPY ./requirements.txt .
+RUN pip install -r requirements.txt
+RUN pip install "uvicorn[standard]==0.13.4"
+
+# add app
+COPY . .
+
+# chown all the files to the app user
+RUN chown -R app:app $APP_HOME
+
+# change to the app user
+USER app
+
+# run gunicorn
+CMD gunicorn --bind 0.0.0.0:$PORT app.main:app -k uvicorn.workers.UvicornWorker

project/app/api/crud.py

@@ -0,0 +1,31 @@
+# project/app/api/crud.py
+
+
+from typing import List, Union
+
+from app.models.pydanticSchemas import SummaryPayloadSchema
+from app.models.tortoiseORM import TextSummary
+
+
+async def post(payload: SummaryPayloadSchema) -> int:
+    summary = TextSummary(
+        url=payload.url,
+        summary="dummy summary",
+    )
+    await summary.save()
+    return summary.id
+
+
+async def get(id: int) -> Union[dict, None]:
+    summary = await TextSummary.filter(id=id).first().values()
+    if summary:
+        return summary[0]
+    return None
+
+
+async def get_all() -> Union[List, None]:
+    summaries = await TextSummary.all().values()
+
+    if not summaries:
+        return None
+    return summaries

project/app/api/ping.py

@@ -3,8 +3,7 @@
 
 from fastapi import APIRouter, Depends
 
-from app.config import get_settings, Settings
-
+from app.config import Settings, get_settings
 
 router = APIRouter()
 
@@ -14,5 +13,5 @@ async def pong(settings: Settings = Depends(get_settings)):
     return {
         "ping": "pong!",
         "environment": settings.environment,
-        "testing": settings.testing
-    }
+        "testing": settings.testing,
+    }

project/app/api/summaries.py

@@ -0,0 +1,38 @@
+# project/app/api/summaries.py
+
+import logging
+
+log = logging.getLogger("uvicorn")
+
+from typing import List, Union
+
+from fastapi import APIRouter, HTTPException
+
+from app.api import crud
+from app.models.pydanticSchemas import (SummaryPayloadSchema,
+                                        SummaryResponseSchema)
+from app.models.tortoiseORM import SummarySchema
+
+router = APIRouter()
+
+
+@router.post("/", response_model=SummaryResponseSchema, status_code=201)
+async def create_summary(payload: SummaryPayloadSchema) -> SummaryResponseSchema:
+    summary_id = await crud.post(payload)
+    log.info("inside post method")
+    response_object = {"id": summary_id, "url": payload.url}
+    return response_object
+
+
+@router.get("/{id}/", response_model=SummarySchema)
+async def read_summary(id: int) -> SummarySchema:
+    summary = await crud.get(id)
+    if not summary:
+        raise HTTPException(status_code=404, detail="Summary not found")
+
+    return summary
+
+
+@router.get("/", response_model=List[SummarySchema])
+async def read_all_summaries() -> List[SummarySchema]:
+    return await crud.get_all()

project/app/config.py

@@ -5,8 +5,7 @@
 import os
 from functools import lru_cache
 
-from pydantic import BaseSettings, AnyUrl
-
+from pydantic import AnyUrl, BaseSettings
 
 log = logging.getLogger("uvicorn")
 
@@ -20,4 +19,4 @@ class Settings(BaseSettings):
 @lru_cache()
 def get_settings() -> BaseSettings:
     log.info("Loading config settings from the environment...")
-    return Settings()
+    return Settings()

project/app/db.py

@@ -19,20 +19,20 @@ def init_db(app: FastAPI) -> None:
         generate_schemas=False,
         add_exception_handlers=False,
     )
-    Tortoise.init_models(['app.models.tortoiseORM'], 'models')
+    Tortoise.init_models(["app.models.tortoiseORM"], "models")
+
 
 async def generate_schema() -> None:
     log.info("Initializing Tortoise...")
 
     await Tortoise.init(
         db_url=os.environ.get("DATABASE_URL"),
-        modules={"models": ["app.models.tortoiseORM"]},
+        modules={"models": ["models.tortoiseORM"]},
     )
     log.info("Generating database schema via Tortoise...")
     await Tortoise.generate_schemas()
     await Tortoise.close_connections()
 
 
-# run_async(generate_schema())
 if __name__ == "__main__":
-    run_async(generate_schema())
+    run_async(generate_schema())

project/app/main.py

@@ -2,21 +2,21 @@
 
 
 import logging
-import asyncio
 
 from fastapi import FastAPI
 
 from app.api import ping, summaries  # updated
 from app.db import init_db
 
-
 log = logging.getLogger("uvicorn")
 
 
 def create_application() -> FastAPI:
     application = FastAPI()
     application.include_router(ping.router)
-    application.include_router(summaries.router, prefix="/summaries", tags=["summaries"])  # new
+    application.include_router(
+        summaries.router, prefix="/summaries", tags=["summaries"]
+    )  # new
 
     return application
 
@@ -32,4 +32,4 @@ async def startup_event():
 
 @app.on_event("shutdown")
 async def shutdown_event():
-    log.info("Shutting down...")
+    log.info("Shutting down...")

project/app/models/pydanticSchemas.py

@@ -0,0 +1,12 @@
+# project/app/models/pydanticSchemas.py
+
+
+from pydantic import BaseModel
+
+
+class SummaryPayloadSchema(BaseModel):
+    url: str
+
+
+class SummaryResponseSchema(SummaryPayloadSchema):
+    id: int

project/app/models/tortoiseORM.py

@@ -0,0 +1,17 @@
+# project/app/models/tortoise.py
+
+
+from tortoise import fields, models
+from tortoise.contrib.pydantic import pydantic_model_creator  # new
+
+
+class TextSummary(models.Model):
+    url = fields.TextField()
+    summary = fields.TextField()
+    created_at = fields.DatetimeField(auto_now_add=True)
+
+    def __str__(self):
+        return self.url
+
+
+SummarySchema = pydantic_model_creator(TextSummary)  # new

project/requirements.txt

@@ -3,4 +3,9 @@ uvicorn==0.13.4
 asyncpg==0.22.0
 tortoise-orm==0.16.21
 pytest==6.2.2
-requests==2.25.1
+requests==2.25.1
+gunicorn==20.0.4
+pytest-cov==2.11.1
+flake8===3.8.4
+black==20.8b1
+isort==5.7.0

project/setup.cfg

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 119

project/tests/conftest.py

@@ -2,10 +2,10 @@
 
 import pytest
 from starlette.testclient import TestClient
+from tortoise.contrib.fastapi import register_tortoise
 
+from app.config import Settings, get_settings
 from app.main import create_application
-from app.config import get_settings, Settings
-from tortoise.contrib.fastapi import register_tortoise
 
 
 def get_settings_override():
@@ -43,4 +43,4 @@ def test_app_with_db():
         # testing
         yield test_client
 
-    # tear down
+    # tear down

project/tests/test_ping.py

@@ -3,7 +3,8 @@
 
 from app import main
 
+
 def test_ping(test_app):
     response = test_app.get("/ping")
     assert response.status_code == 200
-    assert response.json() == {"environment": "dev", "ping": "pong!", "testing": True}
+    assert response.json() == {"environment": "dev", "ping": "pong!", "testing": True}

project/tests/test_read_all_summaries.py

@@ -0,0 +1,19 @@
+import json
+import logging
+
+log = logging.getLogger("uvicorn")
+
+
+def test_read_all_summaries(test_app_with_db):
+    response = test_app_with_db.post(
+        "/summaries/", data=json.dumps({"url": "https://foo.bar"})
+    )
+    summary_id = response.json()["id"]
+
+    response = test_app_with_db.get("/summaries/")
+    assert response.status_code == 200
+
+    log.info(response)
+
+    response_list = response.json()
+    assert len(list(filter(lambda d: d["id"] == summary_id, response_list))) == 1

project/tests/test_read_summary.py

@@ -0,0 +1,17 @@
+import json
+
+
+def test_read_summary(test_app_with_db):
+    response = test_app_with_db.post(
+        "/summaries/", data=json.dumps({"url": "https://foo.bar"})
+    )
+    summary_id = response.json()["id"]
+
+    response = test_app_with_db.get(f"/summaries/{summary_id}/")
+    assert response.status_code == 200
+
+    response_dict = response.json()
+    assert response_dict["id"] == summary_id
+    assert response_dict["url"] == "https://foo.bar"
+    assert response_dict["summary"]
+    assert response_dict["created_at"]

project/tests/test_read_summary_incorrect_id.py

@@ -0,0 +1,4 @@
+def test_read_summary_incorrect_id(test_app_with_db):
+    response = test_app_with_db.get("/summaries/999/")
+    assert response.status_code == 404
+    assert response.json()["detail"] == "Summary not found"

project/tests/test_summaries.py

@@ -0,0 +1,29 @@
+# project/tests/test_summaries.py
+
+
+import json
+
+import pytest
+
+
+def test_create_summary(test_app_with_db):
+    response = test_app_with_db.post(
+        "/summaries/", data=json.dumps({"url": "https://foo.bar"})
+    )
+
+    assert response.status_code == 201
+    assert response.json()["url"] == "https://foo.bar"
+
+
+def test_create_summaries_invalid_json(test_app):
+    response = test_app.post("/summaries/", data=json.dumps({}))
+    assert response.status_code == 422
+    assert response.json() == {
+        "detail": [
+            {
+                "loc": ["body", "url"],
+                "msg": "field required",
+                "type": "value_error.missing",
+            }
+        ]
+    }