CI day3

.github/workflows/main.yaml

@@ -0,0 +1,45 @@
+name: CI
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - "*"
+  workflow_dispatch:
+
+jobs:
+  test:
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ['3.8', '3.10']
+        os: [ubuntu-latest]
+    runs-on: ${{matrix.os}}
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: ${{matrix.python-version}}
+      - name: Install Poetry
+        run: pip install --upgrade pip && pip install poetry
+
+      - name: Install Project
+        run: poetry install
+
+      - name: Look for style errors
+        run: poetry run flake8 beerlog
+
+      - name: Look for auto format errors
+        run: poetry run black -l 79 --check --diff beerlog tests
+
+      - name: Run tests
+        run: poetry run pytest -v --junitxml=test-result.xml
+
+      - name: publish junit results
+        uses: EnricoMi/publish-unit-test-result-action@v1
+        if: always()
+        with:
+          files: test-result.xml
+          check_name: Test Result (Python ${{matrix.python-version}})

beerlog/api.py

@@ -1,10 +1,11 @@
-from typing import Optional, List
+from typing import List, Optional
+
 from fastapi import FastAPI, Response, status
+
 from beerlog.core import get_beers_from_database
-from beerlog.serializers import BeerIn, BeerOut
-from beerlog.models import Beer
 from beerlog.database import get_session
-
+from beerlog.models import Beer
+from beerlog.serializers import BeerIn, BeerOut
 
 api = FastAPI(title="beerlog ")
 

beerlog/cli.py

@@ -1,12 +1,12 @@
-import typer
 from typing import Optional
+
+import typer
+from rich import print
 from rich.console import Console
 from rich.table import Table
-from rich import print
 
 from beerlog.core import add_beer_to_database, get_beers_from_database
 
-
 main = typer.Typer(help="Beer Management Application")
 console = Console()
 

beerlog/config.py

@@ -1,6 +1,6 @@
 import os
-from dynaconf import Dynaconf
 
+from dynaconf import Dynaconf
 
 settings = Dynaconf(
     envvar_prefix="BEERLOG",

beerlog/core.py

@@ -1,5 +1,7 @@
-from typing import Optional, List
+from typing import List, Optional
+
 from sqlmodel import select
+
 from beerlog.database import get_session
 from beerlog.models import Beer
 

beerlog/database.py

@@ -1,17 +1,17 @@
 import warnings
+
 from sqlalchemy.exc import SAWarning
+from sqlmodel import Session, create_engine
 from sqlmodel.sql.expression import Select, SelectOfScalar
 
+from beerlog import models
+from beerlog.config import settings
+
 warnings.filterwarnings("ignore", category=SAWarning)
 SelectOfScalar.inherit_cache = True
 Select.inherit_cache = True
 
 
-from sqlmodel import create_engine, Session
-
-from beerlog import models
-from beerlog.config import settings
-
 engine = create_engine(settings.database.url, echo=False)
 models.SQLModel.metadata.create_all(engine)
 

beerlog/models.py

@@ -1,8 +1,9 @@
-from sqlmodel import SQLModel, Field
 from datetime import datetime
+from statistics import mean  # NEW
 from typing import Optional
+
 from pydantic import validator  # NEW
-from statistics import mean  # NEW
+from sqlmodel import Field, SQLModel
 
 
 class Beer(SQLModel, table=True):

beerlog/serializers.py

@@ -1,6 +1,7 @@
 from datetime import datetime
-from pydantic import BaseModel, validator
+
 from fastapi import HTTPException, status
+from pydantic import BaseModel, validator
 
 
 class BeerOut(BaseModel):

conftest.py

@@ -0,0 +1,14 @@
+import pytest
+from unittest.mock import patch
+from sqlmodel import create_engine
+from beerlog import models
+
+
+@pytest.fixture(autouse=True, scope="function")
+def each_test_uses_separate_database(request):
+    tmpdir = request.getfixturevalue("tmpdir")
+    test_db = tmpdir.join("beerlog.test.db")
+    engine = create_engine(f"sqlite:///{test_db}")
+    models.SQLModel.metadata.create_all(bind=engine)
+    with patch("beerlog.database.engine", engine):
+        yield

tests/test_functional_api.py

@@ -0,0 +1,23 @@
+from fastapi.testclient import TestClient
+
+from beerlog.api import api
+
+
+client = TestClient(api)
+
+
+def test_create_beer_via_api():
+    response = client.post(
+        "/beers",
+        json={
+            "name": "Skol",
+            "style": "KornPA",
+            "flavor": 1,
+            "image": 1,
+            "cost": 2,
+        },
+    )
+    assert response.status_code == 201
+    result = response.json()
+    assert result["name"] == "Skol"
+    assert result["id"] == 1

tests/test_functional_cli.py

@@ -0,0 +1,13 @@
+from typer.testing import CliRunner
+
+from beerlog.cli import main
+
+runner = CliRunner()
+
+
+def test_add_beer():
+    result = runner.invoke(
+        main, ["add", "Skol", "KornPA", "--flavor=1", "--image=1", "--cost=2"]
+    )
+    assert result.exit_code == 0
+    assert "Beer added" in result.stdout

tests/test_unit_core.py

@@ -0,0 +1,14 @@
+from beerlog.core import get_beers_from_database, add_beer_to_database
+
+
+def test_add_beer_to_database():
+    assert add_beer_to_database("Blue Moon", "Witbier", 10, 3, 6)
+
+
+def test_get_beers_from_database():
+    # Arrange
+    add_beer_to_database("Blue Moon", "Witbier", 10, 3, 6)
+    # Act
+    results = get_beers_from_database()
+    # Assert
+    assert len(results) > 0