Alpha tests (#3)

* tests

* update pyproject include dev dependencies

* Update tests to use fixtures, add new tests

* remove unused fixture

Author: zachspar

pyproject.toml

@@ -4,21 +4,21 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "FireFrame"
-version = "0.0.0-alpha.7"
+version = "0.0.0-alpha.8"
 authors = [
   { name="Zachary Spar", email="[email protected]" },
 ]
 description = "A firebase python web framework with ORM support."
 readme = "README.md"
-requires-python = ">=3.6"
+requires-python = ">=3.7"
 classifiers = [
     "Development Status :: 2 - Pre-Alpha",
     "Intended Audience :: Developers",
-    "Programming Language :: Python :: 3.6",
     "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
     "License :: OSI Approved :: BSD License",
     "Operating System :: OS Independent",
 ]
@@ -29,6 +29,16 @@ dependencies = [
     "pydantic==2.5.2",
 ]
 
+[project.optional-dependencies]
+dev = [
+    "black==23.11.0",
+    "build==1.0.3",
+    "httpx==0.25.2",
+    "pytest==7.4.3",
+    "pytest-xdist==3.5.0",
+    "twine==4.0.2",
+]
+
 [project.scripts]
 fireframe = "fireframe.cli:cli"
 

src/fireframe/cli/__init__.py

@@ -2,5 +2,4 @@
 
 from .project import project_cli
 
-
 cli = click.CommandCollection(sources=[project_cli])

src/fireframe/cli/project.py

@@ -1,7 +1,8 @@
-import click
 import os
 from pathlib import Path
 
+import click
+
 
 @click.group()
 @click.pass_context

src/fireframe/core/mixins.py

@@ -2,8 +2,8 @@
 Commonly used FireFrame mixins.
 """
 from fastapi import APIRouter
-from .views import *
 
+from .views import *
 
 __all__ = [
     "crud_router",

src/fireframe/core/serializers.py

@@ -5,10 +5,8 @@
 
 from pydantic import BaseModel as BaseSerialzer, create_model
 from pydantic.fields import FieldInfo
-
 from .models import Model
 
-
 __all__ = [
     "ModelSerializer",
 ]

src/fireframe/core/views.py

@@ -5,7 +5,6 @@
 
 from fastapi import APIRouter, HTTPException
 from fireo.queries.errors import ReferenceDocNotExist
-
 from .serializers import ModelSerializer
 
 __all__ = [

tests/views/__init__.py

@@ -0,0 +1,16 @@
+from uuid import uuid4
+
+import pytest
+
+__all__ = [
+    "test_thread",
+]
+
+
+@pytest.fixture(autouse=True)
+def test_thread() -> str:
+    """
+    Generate a unique thread id for each test.
+    """
+    test_thread = uuid4()
+    yield str(test_thread)

tests/views/_fixtures.py

@@ -0,0 +1,37 @@
+"""
+Test base API view class.
+"""
+import pytest
+
+from fireframe.core.models import Model
+from fireframe.core.serializers import ModelSerializer
+from fireframe.core.views import BaseAPIView
+
+
+class TestBaseAPIView:
+    def test_view_no_serializer(self):
+        """
+        Test the BaseAPIView raises NotImplementedError when
+        _generate_routes method is not implemented.
+        """
+
+        class TestBadView(BaseAPIView):
+            pass
+
+        with pytest.raises(TypeError):
+            TestBadView()
+
+    def test_view_no_generate_routes(self):
+        class TestModel(Model):
+            example: str
+
+        class TestSerializer(ModelSerializer):
+            class Meta:
+                model = TestModel
+                fields = ["example"]
+
+        class TestBadView(BaseAPIView):
+            serializer_class = TestSerializer
+
+        with pytest.raises(NotImplementedError):
+            TestBadView()

tests/views/test_base_api_view.py

@@ -0,0 +1,70 @@
+"""
+Tests for the CreateAPIView class.
+"""
+
+import pytest
+from fastapi.testclient import TestClient
+from fireframe.core.api import FireFrameAPI
+from fireframe.core.models import Model
+from fireframe.core.serializers import ModelSerializer
+from fireframe.core.views import BaseCreateAPIView
+from ._fixtures import test_thread
+
+
+class TestCreateAPIView:
+    def test_view_no_serializer(self):
+        """
+        Test the BaseCreateAPIView raises TypeError when
+        serializer_class is not a subclass of ModelSerializer.
+        """
+
+        class TestBadView(BaseCreateAPIView):
+            pass
+
+        with pytest.raises(TypeError):
+            TestBadView()
+
+    @pytest.fixture(scope="function")
+    def _TestModel(self, test_thread) -> Model:
+        """
+        Cleanup the test collection after the test is done.
+        """
+
+        class TestModel(Model):
+            example: str
+            flag: bool
+            price: float
+
+            class Meta:
+                collection_name = f"test_collection_example_{test_thread}"
+
+        yield TestModel
+
+        # cleanup test collection
+        TestModel.collection.delete_every(child=True)
+
+    def test_create_view_ok(self, test_thread, _TestModel):
+        """
+        Test the BaseCreateAPIView works as expected.
+        """
+
+        class TestSerializer(ModelSerializer):
+            class Meta:
+                model = _TestModel
+                fields = ["example", "flag", "price"]
+
+        class TestCreateView(BaseCreateAPIView):
+            serializer_class = TestSerializer
+
+        app = FireFrameAPI()
+        app.include_router(TestCreateView.as_router())
+        client = TestClient(app)
+        response = client.post(
+            "/", json={"example": "This is a test from test_create_view_ok method", "flag": True, "price": 10.0}
+        )
+        assert response.status_code == 201
+        assert response.json() == {
+            "example": "This is a test from test_create_view_ok method",
+            "flag": True,
+            "price": 10.0,
+        }