Merge pull request #1 from john0isaac/codespace-didactic-space-fishstick-rwgwpqp499x3qj9

Codespace didactic space fishstick rwgwpqp499x3qj9

Author: john0isaac

README.md

@@ -22,7 +22,7 @@ To run the Flask application, follow these steps:
     >**Note** - In Windows, the `venv` does not have a `bin` directory. Therefore, you'd use the analogous command shown below:
 
     ```bash
-    source venv\Scripts\activate
+    source .venv\Scripts\activate
     ```
 
 1. **Install the app as an editable package:**
@@ -44,12 +44,26 @@ To run the Flask application, follow these steps:
     python3 -m flask --app src.flaskapp run --reload
     ```
 
-### Run the tests
+### Development
 
-1. **Inside your virtual environment, execute the following command to run the tests**
+1. **Inside your virtual environment, execute the following command to install the development requirements:**
 
     ```bash
-    python flask_test.py
+    pip install -r requirements-dev.txt
+    ```
+
+1. **Execute the following command to install the pre commit hooks:**
+
+    ```bash
+    pre-commit install
+    ```
+
+### Testing
+
+1. **Execute the following command to run the tests**
+
+    ```bash
+    pytest
     ```
 
 ## API Documentation
@@ -212,5 +226,3 @@ The API will return these error types when the request fails:
     "total_executions": 10
 }
 ```
-
-

flask_test.py

@@ -15,6 +15,7 @@ extend-exclude = "src/flaskapp/migrations/"
 
 [tool.pytest.ini_options]
 addopts = "-ra --cov"
+testpaths = ["tests"] 
 pythonpath = ["src"]
 
 [tool.coverage.report]

pyproject.toml

@@ -0,0 +1,38 @@
+import os
+
+import pytest
+
+from flaskapp import create_app
+from flaskapp.database.models import db
+
+
+@pytest.fixture(scope="session")
+def app_with_db():
+    """Session-wide test `Flask` application."""
+    config_override = {
+        "TESTING": True,
+        # Allows for override of database to separate test from dev environments
+        "SQLALCHEMY_DATABASE_URI": os.environ.get("TEST_DATABASE_URL", os.environ.get("DATABASE_FILENAME")),
+    }
+    app = create_app(config_override)
+
+    with app.app_context():
+        engines = db.engines
+
+    engine_cleanup = []
+
+    for key, engine in engines.items():
+        connection = engine.connect()
+        transaction = connection.begin()
+        engines[key] = connection
+        engine_cleanup.append((key, engine, connection, transaction))
+
+    yield app
+
+    for key, engine, connection, transaction in engine_cleanup:
+        try:
+            transaction.rollback()
+            connection.close()
+        except Exception:
+            connection.close()
+        engines[key] = engine