👷 Add CI (#57)

Author: Kludex

.github/workflows/ci.yaml

@@ -0,0 +1,71 @@
+name: CI
+
+on: [push]
+
+jobs:
+  tests:
+    name: Setup
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:12
+        env:
+          POSTGRES_USER: user
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: app
+        ports:
+          - 5432:5432
+      redis:
+        image: redis:alpine
+        ports:
+          - 6379:6379
+    steps:
+      - name: Checkout working branch
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Cache pip
+        uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Set environment variables
+        run: |
+          echo "PYTHONPATH=$(pwd)/users" >> $GITHUB_ENV
+          echo "POSTGRES_DB=app" >> $GITHUB_ENV
+          echo "POSTGRES_HOST=localhost:5432" >> $GITHUB_ENV
+          echo "POSTGRES_USER=user" >> $GITHUB_ENV
+          echo "POSTGRES_PASSWORD=password" >> $GITHUB_ENV
+          echo "PROJECT_NAME=Project" >> $GITHUB_ENV
+          echo "FIRST_USER_EMAIL=user@user.com" >> $GITHUB_ENV
+          echo "FIRST_USER_PASSWORD=user" >> $GITHUB_ENV
+          echo "SECRET_KEY=secret" >> $GITHUB_ENV
+          echo "ACCESS_TOKEN_EXPIRE_MINUTES=10" >> $GITHUB_ENV
+          echo "REDIS_HOST=localhost" >> $GITHUB_ENV
+          echo "REDIS_PORT=6379" >> $GITHUB_ENV
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r users/requirements.txt
+
+      - name: Lint
+        run: make lint
+
+      - name: Database migrations
+        run: |
+          cd users
+          alembic upgrade head
+
+      - name: Create initial data
+        run: python users/scripts/initial_data.py
+
+      - name: Test
+        run: pytest users/tests --cov users/app --cov-report=term-missing:skip-covered --cov-report=xml --cov-fail-under 69

Makefile

@@ -38,7 +38,7 @@ format:  ## Format code
 tests:  ## Run tests
 	@echo "🍜 Running tests..."
 	@$(eval POD=$(shell sh -c 'kubectl get pod -l app=users -o jsonpath="{.items[0].metadata.name}"'))
-	@kubectl exec $(POD) -- pytest -v tests
+	@kubectl exec $(POD) -- pytest -v tests --cov app --cov-report=term-missing:skip-covered --cov-report=xml --cov-fail-under 69
 
 
 .PHONY: migrations

README.md

@@ -47,6 +47,8 @@ The only one that I've used for that purpose for a long time was the mentioned "
 * [Asynchronous I/O (asyncio) SQLALchemy documentation](https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html)
 * [Full Stack FastAPI and PostgreSQL - Base Project Generator](https://github.com/tiangolo/full-stack-fastapi-postgresql)
 * [The inner working of ARQ](https://threeofwands.com/the-inner-workings-of-arq/)
+* [How we set up a production CI workflow with GitHub actions](https://insights.project-a.com/how-we-set-up-a-production-ci-workflow-with-github-actions-cc1e2aacd9da)
+* [Using GitHub to deploy kubernetes](https://insights.project-a.com/using-github-actions-to-deploy-to-kubernetes-122c653c0b09)
 
 ## License
 

setup.cfg

@@ -11,3 +11,7 @@ per-file-ignores =
 
 [mypy]
 follow_imports = skip
+
+# Reference: https://github.com/nedbat/coveragepy/issues/1082
+[coverage:run]
+concurrency = greenlet

users/app/core/config.py

@@ -17,7 +17,7 @@ class Settings(BaseSettings):
     def validate_postgres_conn(cls, v: Optional[str], values: Dict[str, Any]) -> str:
         if isinstance(v, str):
             return v
-        password: SecretStr = values.get("POSTGRES_PASSWORD")
+        password: SecretStr = values.get("POSTGRES_PASSWORD", SecretStr(""))
         return "{scheme}://{user}:{password}@{host}/{db}".format(
             scheme="postgresql+asyncpg",
             user=values.get("POSTGRES_USER"),

users/requirements.txt

@@ -14,6 +14,7 @@ uvloop==0.15.2
 # TODO(Marcelo): Add dev requirements.
 pytest==6.2.3
 pytest-asyncio==0.15.0
+pytest-cov==2.11.1
 flake8==3.9.1
 isort==5.8.0
 black==20.8b1

users/tests/test_login.py

@@ -11,6 +11,6 @@ async def test_login(client: AsyncSession):
         "password": settings.FIRST_USER_PASSWORD.get_secret_value(),
     }
     res = await client.post("/api/v1/login/", data=login_data)
-    assert res.status_code == 200
+    assert res.status_code == 200, res.json()
     assert res.json().get("token_type") == "bearer"
     assert "access_token" in res.json().keys()