Define smoke tests & add tests manual

Author: heykarimoff

Makefile

@@ -28,6 +28,9 @@ test-integration:
 test-unit:
 	docker-compose run --rm --no-deps --entrypoint=pytest app /tests/unit -v -s
 
+test-smoke:
+	docker-compose run --rm --no-deps --entrypoint=pytest app /tests -vv -s -m smoke
+
 check-black:
 	black --line-length 80 --diff --check .
 

README.md

@@ -5,3 +5,31 @@ Example application code for the [Architecture Patterns with Python](https://www
 [![DeepSource](https://deepsource.io/gh/heykarimoff/cosmicpython-code.svg/?label=active+issues&show_trend=true&token=Q8CoowvMEAg9gbFgHrXaVOmX)](https://deepsource.io/gh/heykarimoff/cosmicpython-code/?ref=repository-badge)
 
 Visit [API documentation](https://documenter.getpostman.com/view/14594760/Tz5iA1Vc) to see available endpoints.
+
+### Installation
+Install dependencies:
+```sh
+pip install -r requirements.txt
+```
+
+### Tests
+Run all tests:
+```sh
+make test
+```
+Run only unit tests:
+```sh
+make test-unit
+```
+Run only integration tests:
+```sh
+make test-integration
+```
+Run only end-to-end tests:
+```sh
+make test-e2e
+```
+Run only smoke tests:
+```sh
+make test-smoke
+```

tests/e2e/test_api.py

@@ -7,6 +7,7 @@
 pytestmark = pytest.mark.e2e
 
 
+@pytest.mark.smoke
 @pytest.mark.usefixtures("postgres_db")
 @pytest.mark.usefixtures("restart_api")
 def test_add_batch(url, random_sku, random_batchref):
@@ -38,6 +39,7 @@ def test_add_batch(url, random_sku, random_batchref):
     assert response.json()["message"] == "OK"
 
 
+@pytest.mark.smoke
 @pytest.mark.usefixtures("restart_api")
 def test_allocate_returns_200_and_allocated_batchref(
     url,
@@ -113,6 +115,7 @@ def test_allocate_returns_400_invalid_sku_message(
     assert response.status_code == 404, response.text
 
 
+@pytest.mark.smoke
 @pytest.mark.usefixtures("restart_api")
 def test_deallocate(
     url,
@@ -155,6 +158,7 @@ def test_deallocate(
     assert response.status_code == 200, response.text
 
 
+@pytest.mark.smoke
 @pytest.mark.usefixtures("restart_api")
 def test_change_batch_quantity_leading_to_reallocation(
     post_to_add_batch,

tests/integration/test_orm.py

@@ -1,5 +1,6 @@
 from datetime import date
 
+import pytest
 from allocation.domain import model
 
 
@@ -27,6 +28,7 @@ def test_orderline_mapper_can_save_lines(session):
     assert rows == [("order1", "DECORATIVE-WIDGET", 12)]
 
 
+@pytest.mark.smoke
 def test_retrieving_products(session):
     session.execute(
         "INSERT INTO products (sku) VALUES ('RED-CHAIR'), ('RED-TABLE')"
@@ -39,6 +41,7 @@ def test_retrieving_products(session):
     assert session.query(model.Product).all() == expected
 
 
+@pytest.mark.smoke
 def test_saving_products(session):
     product = model.Product("sku1", [])
     session.add(product)

tests/integration/test_views.py

@@ -19,6 +19,7 @@ def messagebus(session_factory):
     return bus
 
 
+@pytest.mark.smoke
 def test_allocations_view(messagebus, random_orderid):
     orderid = random_orderid()
     messagebus.handle(commands.CreateBatch("sku1batch", "sku1", 50, None))

tests/pytest.ini

@@ -2,4 +2,5 @@
 addopts = --tb=short
 markers =
     e2e: end-to-end tests.
-    unit: fast-running tests.
+    unit: fast-running tests.
+    smoke: thorough tests.

tests/unit/test_batches.py

@@ -1,5 +1,6 @@
 from datetime import date, timedelta
 
+import pytest
 from allocation.domain.model import Batch, OrderLine
 
 today = date.today()
@@ -14,6 +15,7 @@ def make_batch_and_line(sku, batch_qty, line_qty):
     )
 
 
+@pytest.mark.smoke
 def test_allocating_to_a_batch_reduces_the_available_quantity():
     batch, line = make_batch_and_line("SMALL-TABLE", 20, 10)
 
@@ -22,18 +24,21 @@ def test_allocating_to_a_batch_reduces_the_available_quantity():
     assert batch.available_quantity == 10
 
 
+@pytest.mark.smoke
 def test_can_allocate_if_available_greater_than_required():
     large_batch, small_line = make_batch_and_line("SMALL-TABLE", 20, 2)
 
     assert large_batch.can_allocate(small_line)
 
 
+@pytest.mark.smoke
 def test_cannot_allocate_if_available_smaller_than_required():
     small_batch, large_line = make_batch_and_line("SMALL-TABLE", 10, 20)
 
     assert not small_batch.can_allocate(large_line)
 
 
+@pytest.mark.smoke
 def test_can_allocate_if_available_equal_to_required():
     batch, line = make_batch_and_line("SMALL-TABLE", 20, 20)
 

tests/unit/test_handlers.py

@@ -63,6 +63,7 @@ def messagebus():
     return bus
 
 
+@pytest.mark.smoke
 def test_add_batch_for_new_product(messagebus):
     message = commands.CreateBatch(
         reference="batch1", sku="COMPLICATED-LAMP", qty=100
@@ -76,6 +77,7 @@ def test_add_batch_for_new_product(messagebus):
     assert messagebus.uow.committed
 
 
+@pytest.mark.smoke
 def test_add_batch_for_existing_product(messagebus):
     history = [
         commands.CreateBatch(
@@ -96,6 +98,7 @@ def test_add_batch_for_existing_product(messagebus):
     assert messagebus.uow.committed
 
 
+@pytest.mark.smoke
 def test_allocate_returns_allocation(messagebus):
     message = commands.CreateBatch(
         reference="batch1", sku="COMPLICATED-LAMP", qty=100
@@ -124,6 +127,7 @@ def test_allocate_errors_for_invalid_sku(messagebus):
         messagebus.handle(message)
 
 
+@pytest.mark.smoke
 def test_deallocate(messagebus):
     message = commands.CreateBatch(
         reference="batch1", sku="COMPLICATED-LAMP", qty=100
@@ -149,6 +153,7 @@ def test_deallocate(messagebus):
     assert messagebus.uow.committed
 
 
+@pytest.mark.smoke
 def test_changes_available_quantity(messagebus):
     message = commands.CreateBatch(
         reference="batch1", sku="ADORABLE-SETTEE", qty=100

tests/unit/test_product.py

@@ -1,5 +1,6 @@
 from datetime import date, timedelta
 
+import pytest
 from allocation.domain.events import OutOfStock
 from allocation.domain.model import Batch, OrderLine, Product
 
@@ -8,6 +9,7 @@
 later = tomorrow + timedelta(days=10)
 
 
+@pytest.mark.smoke
 def test_prefers_warehouse_batches_to_shipments():
     in_stock_batch = Batch("batch-001", "BIG-SOFA", qty=20, eta=None)
     shipment_batch = Batch("batch-002", "BIG-SOFA", qty=20, eta=today)
@@ -31,6 +33,7 @@ def test_returns_allocated_batch_reference():
     assert allocation == in_stock_batch.reference
 
 
+@pytest.mark.smoke
 def test_prefers_earlier_batches():
     tomorrows_batch = Batch("batch-001", "MINI-SPOON", qty=20, eta=tomorrow)
     upcoming_batch = Batch("batch-001", "MINI-SPOON", qty=20, eta=later)