Re-split the env configs into different modules

- Configurations for different environments all existed in the
user_service.config.config module. Python will execute this file
from top to bottom, regardless of the configs (and environment) in use.
- This brought along "cross contamination" between environments. For
example, when in the test environment, TestConfig is used and the value
for SQLALCHEMY_DATABASE_URI is a hardcoded string that points to sqlite3
memory database, so there is no need to set the SQLALCHEMY_DATABASE_URI
environment variable, right?
- Wrong. DevConfig which previously existed in the same module as
TestConfig was fetching its value for SQLALCHEMY_DATABASE_URI from an
environment variable, but because this has not been set for the test
environment the tests would fail with a KeyError
(from os.environ['SQLALCHEMY_DATABASE_URI']).
- The tests were failing because of an environment variable that is not
needed.
- Splitting the configurations into different modules should fix this
issue.

Author: lewisemm

.github/workflows/continuous-integration.yaml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     env:
       SERVER_NAME: 'localhost:5000'
-      SECRET_KEY: ${{ secrets.SECRET_KEY }}
+      JWT_SECRET_KEY: ${{ secrets.JWT_SECRET_KEY }}
       REDIS_HOST: 'redis-host-has-been-mocked'
       REDIS_PORT: 1234
     steps:

user_service/api.py

@@ -16,7 +16,7 @@
 def create_app(test_config=False):
     app = Flask(__name__)
     if test_config:
-        app.config.from_object('user_service.config.config.TestConfig')
+        app.config.from_object('user_service.config.test.TestConfig')
     else:
         app.config.from_object(os.environ['USER_SERVICE_CONFIG_MODULE'])
 

user_service/config/base.py

@@ -0,0 +1,5 @@
+import os
+
+
+class CommonConfig(object):
+    SQLALCHEMY_TRACK_MODIFICATIONS = False

user_service/config/config.py renamed to user_service/config/dev.py

@@ -1,9 +1,7 @@
-import os
 import datetime
+import os
 
-
-class CommonConfig(object):
-    SQLALCHEMY_TRACK_MODIFICATIONS = False
+from user_service.config.base import CommonConfig
 
 
 class DevConfig(CommonConfig):
@@ -12,10 +10,3 @@ class DevConfig(CommonConfig):
     JWT_ACCESS_TOKEN_EXPIRES = datetime.timedelta(
         minutes=int(os.environ['JWT_ACCESS_TOKEN_EXPIRES_MINUTES'])
     )
-
-
-class TestConfig(CommonConfig):
-    TESING = True
-    JWT_SECRET_KEY = 'super secret'
-    SQLALCHEMY_DATABASE_URI = 'sqlite:///:memory:'
-    SERVER_NAME = os.environ['SERVER_NAME']

user_service/config/test.py

@@ -0,0 +1,9 @@
+import os
+
+from user_service.config.base import CommonConfig
+
+class TestConfig(CommonConfig):
+    TESING = True
+    JWT_SECRET_KEY = os.environ['JWT_SECRET_KEY']
+    SQLALCHEMY_DATABASE_URI = 'sqlite:///:memory:'
+    SERVER_NAME = os.environ['SERVER_NAME']