mark tests as unit or integration

Author: pgorecki

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ repos:
           - --ignore-init-module-imports
 
   - repo: https://github.com/pycqa/isort
-    rev: 5.10.1
+    rev: 5.11.2
     hooks:
       - id: isort
         name: isort (python)

pyproject.toml

@@ -40,6 +40,11 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poe.tasks]
 test = { shell = "DATABASE_URL=postgresql://postgres:password@localhost:5433/postgres pytest src" }
+test_domain = "pytest -k domain"
+test_infrastructure = "pytest -k infrastructure"
+test_application = "pytest -k application"
+test_unit = "pytest -m unit"
+test_integration = "pytest -m 'not unit'"
 test_coverage = "pytest --cov=src --cov-report=html"
 start = "uvicorn src.api.main:app --reload"
 start_cli = { shell = "cd src && python -m cli" }

pytest.ini

@@ -1,2 +1,7 @@
 [pytest]
-norecursedirs = tmp
+norecursedirs = tmp
+
+markers =
+    unit: marks test as unit test i.e. not using any external services (deselect with '-m "not unit"') 
+    integration: marks tests as integration i.e. using a database (deselect with '-m "not integration"')
+    serial

src/api/routers/catalog.py

@@ -26,7 +26,7 @@ async def get_all_listings(
     query = GetAllListings()
     with module.unit_of_work():
         query_result = module.execute_query(query)
-        return dict(data=query_result.result)
+        return dict(data=query_result.payload)
 
 
 @router.get("/catalog/{listing_id}", tags=["catalog"], response_model=ListingReadModel)
@@ -41,7 +41,7 @@ async def get_listing_details(
     query = GetListingDetails(listing_id=listing_id)
     with module.unit_of_work():
         query_result = module.execute_query(query)
-        return query_result.result
+        return query_result.payload
 
 
 @router.post(
@@ -66,7 +66,7 @@ async def create_listing(
 
         query = GetListingDetails(listing_id=command_result.result)
         query_result = module.execute_query(query)
-        return query_result.result
+        return query_result.payload
 
 
 #

src/api/tests/test_catalog.py

@@ -1,13 +1,17 @@
+import pytest
+
 from modules.catalog.application.command import CreateListingDraftCommand
 from seedwork.domain.value_objects import Money
 
 
+@pytest.mark.integration
 def test_empty_catalog_list(api_client):
     response = api_client.get("/catalog")
     assert response.status_code == 200
     assert response.json() == {"data": []}
 
 
+@pytest.mark.integration
 def test_catalog_list_with_one_item(api, api_client):
     # arrange
     catalog_module = api.container.catalog_module()
@@ -28,7 +32,7 @@ def test_catalog_list_with_one_item(api, api_client):
     assert response.json() == {
         "data": [
             {
-                "id": str(command_result.result),
+                "id": str(command_result.entity_id),
                 "title": "Foo",
                 "description": "Bar",
                 "ask_price_amount": 10.0,
@@ -38,6 +42,7 @@ def test_catalog_list_with_one_item(api, api_client):
     }
 
 
+@pytest.mark.integration
 def test_catalog_list_with_two_items(api, api_client):
     # arrange
     catalog_module = api.container.catalog_module()

src/api/tests/test_common.py

@@ -1,15 +1,18 @@
+import pytest
 from fastapi.testclient import TestClient
 
 from api.main import app
 
 client = TestClient(app)
 
 
+@pytest.mark.integration
 def test_homepage_returns_200():
     response = client.get("/")
     assert response.status_code == 200
 
 
+@pytest.mark.integration
 def test_docs_page_returns_200():
     response = client.get("/docs")
     assert response.status_code == 200

src/modules/bidding/__init__.py

@@ -5,14 +5,6 @@
 )
 from seedwork.application.modules import BusinessModule
 
-#
-# @dataclass
-# class UnitOfWork:
-#     module: Any  # FIXME: type
-#     db_session: Session
-#     correlation_id: uuid.UUID
-#     listing_repository: ListingRepository
-
 
 class BiddingModule(BusinessModule):
     supported_commands = (PlaceBidCommand, RetractBidCommand)

src/modules/bidding/application/command/place_bid.py

@@ -23,6 +23,6 @@ def place_bid(
     bid = Bid(bidder=bidder, price=Money(command.amount))
 
     listing: Listing = listing_repository.get_by_id(id=command.listing_id)
-    events = listing.place_bid(bid)
+    listing.place_bid(bid)
 
-    return CommandResult.ok(events=events)
+    return CommandResult.ok()

src/modules/bidding/tests/test_module.py renamed to src/modules/bidding/tests/domain/__init__.py

@@ -8,6 +8,7 @@
 from seedwork.domain.value_objects import UUID
 
 
+@pytest.mark.unit
 def test_listing_initial_price():
     seller = Seller(id=UUID.v4())
     listing = Listing(
@@ -19,6 +20,7 @@ def test_listing_initial_price():
     assert listing.winning_bid is None
 
 
+@pytest.mark.unit
 def test_place_one_bid():
     now = datetime.utcnow()
     seller = Seller(id=UUID.v4())
@@ -34,6 +36,7 @@ def test_place_one_bid():
     assert listing.winning_bid == Bid(Money(20), bidder=bidder, placed_at=now)
 
 
+@pytest.mark.unit
 def test_place_two_bids():
     now = datetime.utcnow()
     seller = Seller(id=UUID.v4())
@@ -50,6 +53,7 @@ def test_place_two_bids():
     assert listing.winning_bid == Bid(Money(30), bidder=bidder2, placed_at=now)
 
 
+@pytest.mark.unit
 def test_place_two_bids_by_same_bidder():
     now = datetime.utcnow()
     seller = Seller(id=UUID.v4())
@@ -67,6 +71,7 @@ def test_place_two_bids_by_same_bidder():
     assert listing.winning_bid == Bid(price=Money(30), bidder=bidder, placed_at=now)
 
 
+@pytest.mark.unit
 def test_cannot_place_bid_if_listing_ended():
     seller = Seller(id=UUID.v4())
     bidder = Bidder(id=UUID.v4())
@@ -88,6 +93,7 @@ def test_cannot_place_bid_if_listing_ended():
         listing.place_bid(bid)
 
 
+@pytest.mark.unit
 def test_retract_bid():
     seller = Seller(id=UUID.v4())
     bidder = Bidder(id=UUID.v4())
@@ -107,6 +113,7 @@ def test_retract_bid():
         listing.retract_bid_of(bidder=bidder)
 
 
+@pytest.mark.unit
 def test_cancel_listing():
     now = datetime.utcnow()
     seller = Seller(id=UUID.v4())
@@ -122,6 +129,7 @@ def test_cancel_listing():
     assert listing.time_left_in_listing == timedelta()
 
 
+@pytest.mark.unit
 def test_can_cancel_listing_with_bids():
     now = datetime.utcnow()
     seller = Seller(id=UUID.v4())
@@ -144,6 +152,7 @@ def test_can_cancel_listing_with_bids():
     assert listing.time_left_in_listing == timedelta()
 
 
+@pytest.mark.unit
 def test_cannot_cancel_listing_with_bids():
     now = datetime.utcnow()
     seller = Seller(id=UUID.v4())