Add tests and move formatting to api level

.github/workflows/backend.yml

@@ -20,18 +20,18 @@ jobs:
         with:
           python-version: "3.10"
       - name: Install Python dependencies
-        working-directory: ./backend
+        working-directory: ./backend/src
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt
       - name: Format check
-        working-directory: ./backend
+        working-directory: ./backend/src
         run: make fmt-check
       - name: Isort check
-        working-directory: ./backend
+        working-directory: ./backend/src
         run: make isort-check
       - name: Pylint
-        working-directory: ./backend
+        working-directory: ./backend/src
         run: make pylint
   test:
     runs-on: ubuntu-latest

backend/README.md

@@ -12,4 +12,4 @@
 ```
 cd src
 uvicorn api.index:app --reload
-```
+```

backend/src/.gitignore

@@ -0,0 +1 @@
+venv

backend/src/Makefile

@@ -7,3 +7,18 @@ test-cov:
 test-cov-ci:
 	python -m pytest --junitxml=pytest.xml --cov=./ --cov-report term-missing | tee pytest-coverage.txt
 
+fmt-write:
+	black .
+fmt-check:
+	black . --check
+isort-write:
+	isort .
+isort-check:
+	isort . --check
+pylint:
+	pylint --recursive=y .
+mypy:
+	mypy .
+
+fmt: fmt-write isort-write
+lint: fmt-check isort-check pylint

backend/src/api/index.py

@@ -47,7 +47,9 @@ def list_products(next_token: str = None):
 
 @app.post("/products", status_code=201, response_model=models.ProductResponse)
 def post_product(payload: models.CreatePayload):
-    res = dynamo.create_product(stores=payload.stores, name=payload.name)
+    res = dynamo.create_product(
+        stores=payload.stores, name=payload.name, categories=payload.categories
+    )
     return res
 
 
@@ -69,6 +71,7 @@ def update_product(product_id: str, payload: models.UpdatePayload):
             product_id=product_id,
             stores=payload.stores,
             name=payload.name,
+            categories=payload.categories,
         )
     except dynamo.ProductNotFoundError as err:
         raise HTTPException(status_code=404, detail="Product not found") from err
@@ -120,9 +123,14 @@ def bulk_upload(payload: models.ProductsBulkUploadRequest):
                     product_id=existing_products[0]["id"],
                     stores=product.stores,
                     name=product.name,
+                    categories=product.categories,
                 )
             except dynamo.ProductNotFoundError:
-                dynamo.create_product(stores=product.stores, name=product.name)
+                dynamo.create_product(
+                    stores=product.stores,
+                    name=product.name,
+                    categories=product.categories,
+                )
 
     except Exception as err:
         print(err)

backend/src/api/lib/dynamo.py

@@ -18,14 +18,15 @@ class ProductNotFoundError(Error):
     pass
 
 
-def create_product(name: str, stores: list[str]) -> dict:
+def create_product(name: str, stores: list[str], categories: list[str]) -> dict:
     print("Creating product")
 
     item = {
         "id": str(uuid4()),
         "name": name,
         "stores": stores,
         "images": [],
+        "categories": categories,
         "created_at": datetime.now().isoformat(),
         "updated_at": datetime.now().isoformat(),
     }
@@ -62,7 +63,12 @@ def get_products_by_name(name: str) -> dict:
     return response["Items"]
 
 
-def update_product(product_id: str, stores: list[str] = None, name: str = None) -> dict:
+def update_product(
+    product_id: str,
+    stores: list[str] = None,
+    name: str = None,
+    categories: list[str] = None,
+) -> dict:
     expr = []
     attr_values = {}
     attr_names = {}
@@ -72,6 +78,11 @@ def update_product(product_id: str, stores: list[str] = None, name: str = None)
         attr_values[":k"] = stores
         attr_names["#K"] = "stores"
 
+    if categories is not None:
+        expr.append("#C=:c")
+        attr_values[":c"] = categories
+        attr_names["#C"] = "categories"
+
     if name is not None:
         expr.append("#N=:n")
         attr_values[":n"] = name

backend/src/api/models/models.py

@@ -9,17 +9,20 @@ class ProductResponse(BaseModel):
     stores: list[str]
     images: list[str]
     image_urls: dict[str, str] = {}
+    categories: list[str]
     header_image: str = None
 
 
 class CreatePayload(BaseModel):
     name: str
     stores: list[str]
+    categories: list[str]
 
 
 class UpdatePayload(BaseModel):
     name: Optional[str]
     stores: Optional[list[str]]
+    categories: Optional[list[str]]
 
 
 class ProductsListResponse(BaseModel):

backend/pyproject.toml → backend/src/pyproject.toml

@@ -1,5 +1,6 @@
 [tool.isort]
 profile = "black"
-src_paths = ["src", "serverless_backend", "app.py"]
+src_paths = ["."]
 [tool.pylint]
 disable = ["C0114", "C0116", "C0115", "E0401", "W0511"]
+ignore = ["venv"]

backend/src/requirements-dev.txt

@@ -1,6 +1,10 @@
 pytest==8.0.2
 uvicorn[standard]
-boto3
+boto3~=1.34.61
 httpx==0.27.0
 pytest-env==1.1.3
 pytest-cov==4.1.0
+moto==5.0.3
+black==24.2.0
+isort==5.13.2
+pylint==3.0.3

backend/src/tests/conftest.py

@@ -0,0 +1,29 @@
+import os
+
+import boto3
+import pytest
+from moto import mock_aws
+
+
+@pytest.fixture(scope="function", name="aws_credentials")
+def fixture_aws_credentials():
+    """Mocked AWS Credentials for moto."""
+    os.environ["AWS_ACCESS_KEY_ID"] = "testing"
+    os.environ["AWS_SECRET_ACCESS_KEY"] = "testing"
+    os.environ["AWS_SECURITY_TOKEN"] = "testing"
+    os.environ["AWS_SESSION_TOKEN"] = "testing"
+    os.environ["AWS_DEFAULT_REGION"] = "us-east-2"
+
+
+@pytest.fixture(scope="function")
+# pylint: disable-next=unused-argument
+def dynamodb_client(aws_credentials):
+    with mock_aws():
+        yield boto3.client("dynamodb", region_name="us-east-2")
+
+
+@pytest.fixture(scope="function")
+# pylint: disable-next=unused-argument
+def s3_client(aws_credentials):
+    with mock_aws():
+        yield boto3.client("s3")