Setup and structure for testing

-Multiple databases that are switched using an environment variable so the db server is not needed during testing
-Clean up some dev/prod setup for starting the server so gunicorn/docker are not needed in dev/testing

Author: jessehartloff

api/.env

@@ -0,0 +1,2 @@
+API_MODE=dev
+DB=relational

api/config/config.py

@@ -4,7 +4,7 @@
 
 
 class Config:
-    """Configuration class for MOJ api server, stores current configuration state of flask api"""
+    """Configuration class for MOH api server, stores current configuration state of flask api"""
 
     def __init__(self):
         self.API_MODE = os.getenv("API_MODE", "Can not find mode")

api/database/IQueue.py

@@ -0,0 +1,12 @@
+from abc import ABC, abstractmethod
+
+
+class IQueue(ABC):
+
+    @abstractmethod
+    def enqueue_student(self, student):
+        raise NotImplementedError()
+
+    @abstractmethod
+    def dequeue_student(self):
+        raise NotImplementedError()

api/database/IRatings.py

@@ -0,0 +1,8 @@
+
+from abc import ABC, abstractmethod
+
+class IRatings:
+
+    @abstractmethod
+    def rate_student(self, student, rating, feedback):
+        raise NotImplementedError()

api/database/db.py

@@ -0,0 +1,22 @@
+import os
+
+from api.database.relational_db.RelationalDB import RelationalDB
+from api.database.testing_db.TestingDB import TestingDB
+from api.database.mock_db.MockDB import MockDB
+
+
+def create_db():
+    db_type = os.getenv("DB")
+    match db_type:
+        case "relational":
+            return RelationalDB()
+        case "testing":
+            return TestingDB()
+        case "mock":
+            return MockDB()
+        case None:
+            raise EnvironmentError("environment variable \"DB\" not set")
+        case _:
+            raise ModuleNotFoundError("Could not find database named " + db_type)
+
+db = create_db()

api/database/interface.py

@@ -0,0 +1,12 @@
+from abc import ABC, abstractmethod
+
+from IQueue import IQueue
+from IRatings import IRatings
+
+class DBInterface(IQueue, IRatings, ABC):
+
+    # All database implements must extend this class
+
+    @abstractmethod
+    def connect(self):
+        pass

api/database/mock_db/MockDB.py

@@ -0,0 +1,7 @@
+from api.database.mock_db.MockDBQueue import MockDBQueue
+from api.database.mock_db.MockDBRatings import MockDBRatings
+
+
+class MockDB(MockDBQueue, MockDBRatings):
+
+    pass

api/database/mock_db/MockDBQueue.py

@@ -0,0 +1,8 @@
+from api.database.IQueue import IQueue
+
+
+class MockDBQueue(IQueue):
+
+    def enqueue_student(self, student):
+        pass
+        # do database stuff

api/database/mock_db/MockDBRatings.py

@@ -0,0 +1,8 @@
+from api.database.IRatings import IRatings
+
+
+class MockDBRatings(IRatings):
+
+    def rate_student(self, student, rating, feedback):
+        pass
+        # do database stuff

api/database/relational_db/RelationalDB.py

@@ -0,0 +1,7 @@
+from api.database.relational_db.RelationalDBQueue import RelationalDBQueue
+from api.database.relational_db.RelationalDBRatings import RelationalDBRatings
+
+
+class RelationalDB(RelationalDBQueue, RelationalDBRatings):
+
+    pass