#11 REFACTOR: Moved all tests into test classes

pep8.bat

@@ -0,0 +1 @@
+autopep8 --exclude '*/.*/*' --in-place --recursive .

scripts/create_database.py

@@ -37,11 +37,6 @@ def create_connection(path: str, filename: str):
             conn.close()
 
 
-# Ensure a directory is created given a path to it
-if __name__ == "__main__":
-    run()
-
-
 def run():
     """ Create the database for the application"""
     dir = r"./data/"
@@ -55,3 +50,8 @@ def run():
         remove_file(dir + db_name)
 
     create_connection(dir, db_name)
+
+
+# Ensure a directory is created given a path to it
+if __name__ == "__main__":
+    run()

tests/__init__.py

@@ -1,28 +0,0 @@
-import pytest
-import os
-from scripts.create_database import run
-from app import app
-from dotenv import load_dotenv
-from flask.testing import FlaskClient
-
-
-# Setup test environment variables
-load_dotenv()
-
-# Capture environment variables at start of testing so we can
-# Monitor current setting during tests
-old_env = os.environ.get("ENVIRON")
-os.environ["ENVIRON"] = "test"
-
-run()
-
-
-@pytest.fixture(scope="module")
-def test_client() -> FlaskClient:
-    """ Enables tests to create requests to the web app
-    """
-    os.environ['CONFIG_TYPE'] = 'config.TestingConfig'
-
-    with app.test_client() as testing_client:
-        with app.app_context():
-            yield testing_client

tests/base_test.py

@@ -0,0 +1,39 @@
+import pytest
+import os
+from scripts.create_database import run
+from app import app
+from dotenv import load_dotenv
+from flask.testing import FlaskClient
+
+
+class TestBase:
+    """ Base test class that ensures environment variables
+        and test setup is complete before any other unit tests are run
+    """
+
+    def setup_class(self):
+        """ Setup class level resources or configurations
+            Setup test environment variables
+        """
+        load_dotenv()
+
+        # Capture environment variables at start of testing so we can
+        # Monitor current setting during tests
+        self.old_env = os.environ.get("ENVIRON")
+        os.environ["ENVIRON"] = "test"
+
+        run()
+
+    def teardown_class(self):
+        """ Teardown class level resources or configurations """
+        pass
+
+    @pytest.fixture(scope="class")
+    def test_client(self) -> FlaskClient:
+        """ Enables tests to create requests to the web app
+        """
+        os.environ['CONFIG_TYPE'] = 'config.TestingConfig'
+
+        with app.test_client() as testing_client:
+            with app.app_context():
+                yield testing_client

tests/endtoend/use_cases_test.py

@@ -1,9 +1,9 @@
-import pytest
 from bs4 import BeautifulSoup
-from tests import test_client
 from flask.testing import FlaskClient
+from tests.base_test import TestBase
 
 
-def test_use_case(test_client: FlaskClient):
+class TestFunctionalRequirements(TestBase):
+    def test_use_case(self, test_client: FlaskClient):
         response = test_client.get('/products/Car Parts')
         assert response.status_code == 200

tests/functional/test_homepage.py

@@ -1,39 +0,0 @@
-from flask.testing import FlaskClient
-from tests import test_client
-import pytest
-
-
-def test_homepage(test_client: FlaskClient):
-    """ Tests that the main homepage loads correctly
-        once the '/' endpoint is hit
-    """
-    response = test_client.get('/')
-    assert response.status_code == 302
-
-    response = test_client.get('/products')
-    assert response.status_code == 308
-
-
-def test_products(test_client: FlaskClient):
-    """ Tests that a product page is displayed when
-        hitting one of the product endpoints
-    """
-    response = test_client.get('/products/2')
-    assert response.status_code == 200
-
-    response = test_client.get('/products/50')
-    assert response.status_code == 302
-
-    response = test_client.get('/products/Books')
-    assert response.status_code == 200
-
-
-def test_admin(test_client: FlaskClient):
-    """ Tests that the admin pages can be reached and redirect
-        upon reaching
-    """
-    response = test_client.get('/admin/users/')
-    assert response.status_code == 302
-
-    response = test_client.get('/admin/products/')
-    assert response.status_code == 302

tests/functional/test_pages.py

@@ -0,0 +1,41 @@
+from flask.testing import FlaskClient
+from tests.base_test import TestBase
+
+
+class TestPages(TestBase):
+    """ Test class that encapsulates tests for
+        the main pages on the site
+    """
+
+    def test_homepage(self, test_client: FlaskClient):
+        """ Tests that the main homepage loads correctly
+            once the '/' endpoint is hit
+        """
+        response = test_client.get('/')
+        assert response.status_code == 302
+
+        response = test_client.get('/products')
+        assert response.status_code == 308
+
+    def test_products(self, test_client: FlaskClient):
+        """ Tests that a product page is displayed when
+            hitting one of the product endpoints
+        """
+        response = test_client.get('/products/2')
+        assert response.status_code == 200
+
+        response = test_client.get('/products/50')
+        assert response.status_code == 302
+
+        response = test_client.get('/products/Books')
+        assert response.status_code == 200
+
+    def test_admin(self, test_client: FlaskClient):
+        """ Tests that the admin pages can be reached and redirect
+            upon reaching
+        """
+        response = test_client.get('/admin/users/')
+        assert response.status_code == 302
+
+        response = test_client.get('/admin/products/')
+        assert response.status_code == 302

tests/unit/database/database_test_class.py

@@ -0,0 +1,8 @@
+from tests.base_test import TestBase
+
+
+class TestDatabase(TestBase):
+    """ Class that controls the
+        testing of the WMGZON database
+    """
+    pass

tests/unit/database/test_products.py

@@ -1,5 +1,4 @@
-import pytest
+from tests.unit.database.database_test_class import TestDatabase
-import sqlite3
 from datetime import datetime
 from controllers.database.product import ProductController
 from models.products.product import Product
@@ -15,34 +14,35 @@ product = Product(
     1
 )
 
-# Tests a new product can be created
 
+class TestProduct(TestDatabase):
+    """ Class that controls the
+        testing of the WMGZON database
+    """
 
-def test_create_product():
+    def test_create_product(self):
+        """Tests a new product can be created"""
         db = ProductController()
         db.create(product)
 
-# Tests the database maintains integrity when we try
+    def test_duplicate_product(self):
-# and add a product with the same details
+        """ Tests the database maintains integrity when we try
+            and add a product with the same detail
+        """
+        self.test_create_product()
 
-
+    def test_search_category(self):
-def test_duplicate_product():
+        """ Tests that products can be refined by category """
-    test_create_product()
-
-# Tests that products can be refined by category
-
-
-def test_search_category():
         db = ProductController()
 
         # Check each category for correct amount of test products
-    assert len(db.read_all("Car Parts")) == 9 + 2  # Added in previous tests
+        assert len(db.read_all("Car Parts")) == 9 + \
+            2  # Added in previous tests
         assert len(db.read_all("Books")) == 9
         assert db.read_all("Phones") is None
 
-
+    def test_search_term(self):
-# Tests that products can be refined by search term
+        """ Tests that products can be refined by search term"""
-def test_search_term():
         db = ProductController()
 
         # Check each search term for correct amount of test products
@@ -51,10 +51,8 @@ def test_search_term():
         assert len(db.read_all(search_term="fold")) == 8
         assert db.read_all(search_term="Twin") is None
 
-# Test we the same product details get returned from the database
+    def test_read_product(self):
-
+        """ Test we the same product details get returned from the database """
-
-def test_read_product():
         db = ProductController()
 
         # Test the same product is returned

tests/unit/database/test_users.py

@@ -1,5 +1,6 @@
 import pytest
 import sqlite3
+from tests.unit.database.database_test_class import TestDatabase
 from controllers.database.user import UserController
 from models.users.customer import Customer
 from models.users.seller import Seller
@@ -22,26 +23,27 @@ seller = Seller(
     "987654321"
 )
 
-# Tests a new user can be created
 
+class TestUsers(TestDatabase):
+    """ Class to encapsulate all of the user
+        datbase tests
+    """
 
-def test_create_user():
+    def test_create_user(self):
+        """ Tests a new user can be created """
         db = UserController()
         db.create(customer)
 
-# Tests the database maintains integrity when we try
+    def test_duplicate_user(self):
-# and add a user with the same details
+        """ Tests the database maintains integrity when we try
-
+            and add a user with the same details
-
+        """
-def test_duplicate_user():
         db = UserController()
         with pytest.raises(sqlite3.IntegrityError):
             db.create(customer)
 
-# Test we the same user details get returned from the database
+    def test_read_user(self):
-
+        """ Test we the same user details get returned from the database """
-
-def test_read_user():
         db = UserController()
 
         # Test the same user is returned
@@ -52,16 +54,15 @@ def test_read_user():
         customer.id = user.id
         assert user.__dict__ == customer.__dict__
 
-
+    def test_create_seller(self):
-# Tests a new seller can be created
+        """ Tests a new seller can be created """
-def test_create_seller():
         db = UserController()
         db.create(seller)
 
-# Test that the same seller details get returned from the database
+    def test_read_seller(self):
-
+        """ Test that the same seller details get
-
+            returned from the database
-def test_read_seller():
+        """
         db = UserController()
 
         # Test the same user is returned

tests/unit/general/test_env.py

@@ -1,31 +1,31 @@
+from tests.base_test import TestBase
 from os import environ
 from warnings import warn
-from tests import old_env
 
-# Tests environment variables used within the projects domain are
-# set in the correct environment
 
+class TestEnv(TestBase):
+    """ Tests environment variables used within the projects domain are
+        set in the correct environment
+    """
     VARS = ['ENVIRON', 'APPSECRET', 'FILESTORE']
 
     ENV_STATES = ['test', 'prod']
 
-
+    def test_env_vars(self):
-def test_env_vars():
         """ Test that required environment variables are set
             ahead of runtime
         """
-    for var in VARS:
+        for var in self.VARS:
             env = environ.get(var)
 
             # Check to see what variable we are comparing
             if env is None:
                 warn(f"Variable {var} is not set!")
 
-
+    def test_environment_var_state(self):
-def test_environment_var_state():
         """ Tests that the 'ENVIRON' Environment variable
             is in a correct state
         """
-    var = old_env
+        var = self.old_env
         assert var is not None
-    assert (var in ENV_STATES)
+        assert (var in self.ENV_STATES)

tests/unit/general/test_pep8.py

@@ -1,9 +1,11 @@
 import pycodestyle
+from tests.base_test import TestBase
 
 # Tests files to ensure they conform to pep8 standards
 
 
-def test_pep8_conformance():
+class TestPep8(TestBase):
+    def test_pep8_conformance(self):
         """Test that we conform to PEP8."""
         pep8style = pycodestyle.StyleGuide()
         dirs = ["./controllers", "./models", "./scripts", "./tests", "./utils"]

venv.bat

@@ -1 +0,0 @@
-./.venv/Scripts/activate