Extract DAL from time_tracker_api #50

ioet · EliuX · Apr 8, 2020 · Mar 31, 2020 · Apr 2, 2020 · Apr 7, 2020
commit 0bb037198cbc5b42914c41eaef690600b7eaf611
diff --git a/.env.template b/.env.template
@@ -1,5 +1,8 @@
-# Package where the app is located
+# API
+## Package where the app is located
 export FLASK_APP=time_tracker_api
 
-# The database connection URI. Check out the README.md for more details
+
+# Common attributes
+## The database connection URI. Check out the README.md for more details
 DATABASE_URI=mssql+pyodbc://<user>:<password>@time-tracker-srv.database.windows.net/<database>?driver\=ODBC Driver 17 for SQL Server
diff --git a/Dockerfile b/Dockerfile
@@ -27,4 +27,4 @@ ENV FLASK_APP time_tracker_api
 
 EXPOSE 5000
 
-CMD ["gunicorn", "-b 0.0.0.0:5000", "run:app"]
+CMD ["gunicorn", "-b 0.0.0.0:5000", "api:app"]
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # time-tracker-api
 
-The API of the TSheets killer app.
+This is the mono-repository for the backend services and common codebase
 
 ## Getting started
 Follow the following instructions to get the project ready to use ASAP.
@@ -30,10 +30,16 @@ automatically [pip](https://pip.pypa.io/en/stable/) as well.
 
 - Install the requirements:
     ```
-    python3 -m pip install -r requirements/<stage>.txt
+    python3 -m pip install -r requirements/<app>/<stage>.txt
     ```
 
-    The `stage` can be `dev` or `prod`. 
+    Where <app> is one of the executable app namespace, e.g. `time_tracker_api`.
+    The `stage` can be 
+
+    * `dev`: Used for working locally
+    * `prod`: For anything deployed
+
+
     Remember to do it with Python 3.
 
 

diff --git a/run.py → api.py b/run.py → api.py
diff --git a/tests/activities/__init__.py → commons/__init__.py b/tests/activities/__init__.py → commons/__init__.py
diff --git a/tests/projects/__init__.py → commons/data_access_layer/__init__.py b/tests/projects/__init__.py → commons/data_access_layer/__init__.py
diff --git a/tests/time_entries/__init__.py → commons/data_access_layer/azure/__init__.py b/tests/time_entries/__init__.py → commons/data_access_layer/azure/__init__.py
diff --git a/time_tracker_api/sql_repository.py → ...data_access_layer/azure/sql_repository.py b/time_tracker_api/sql_repository.py → ...data_access_layer/azure/sql_repository.py
diff --git a/requirements/sql_db_serverless.txt b/requirements/sql_db_serverless.txt
@@ -0,0 +1,12 @@
+# requirements/sql_db_serverless.txt
+
+# For SQL database serverless (MS SQL)
+
+
+# SQL Server driver
+pyodbc==4.0.30
+
+# ORM
+SQLAlchemy==1.3.15
+SQLAlchemy-Utils==0.36.3
+flask_sqlalchemy==2.4.1
diff --git a/requirements/dev.txt → requirements/time_tracker_api/dev.txt b/requirements/dev.txt → requirements/time_tracker_api/dev.txt
@@ -1,5 +1,6 @@
-# requirements/dev.txt
+# requirements/time_tracker_api/dev.txt
 
+# Include the prod resources
 -r prod.txt
 
 # For development

diff --git a/requirements/prod.txt → requirements/time_tracker_api/prod.txt b/requirements/prod.txt → requirements/time_tracker_api/prod.txt
@@ -1,4 +1,8 @@
-# requirements/prod.txt
+# requirements/time_tracker_api/prod.txt
+
+# Dependencies
+-r ../sql_db_serverless.txt
+
 
 # For production releases
 
@@ -21,12 +25,6 @@ Faker==4.0.2
 #CLI support
 Flask-Script==2.0.6
 
-# SQL database (MS SQL)
-pyodbc==4.0.30
-SQLAlchemy==1.3.15
-SQLAlchemy-Utils==0.36.3
-flask_sqlalchemy==2.4.1
-
 # Handling requests
 requests==2.23.0
 

diff --git a/tests/commons/__init__.py b/tests/commons/__init__.py
diff --git a/tests/commons/data_access_layer/__init__.py b/tests/commons/data_access_layer/__init__.py
diff --git a/tests/commons/data_access_layer/azure/__init__.py b/tests/commons/data_access_layer/azure/__init__.py
diff --git a/tests/resources.py → ...mons/data_access_layer/azure/resources.py b/tests/resources.py → ...mons/data_access_layer/azure/resources.py
@@ -1,4 +1,4 @@
-from time_tracker_api.sql_repository import db, AuditedSQLModel
+from commons.data_access_layer.azure.sql_repository import db, AuditedSQLModel
 
 from sqlalchemy_utils import UUIDType
 import uuid

diff --git a/tests/sql_repository_test.py → ...access_layer/azure/sql_repository_test.py b/tests/sql_repository_test.py → ...access_layer/azure/sql_repository_test.py
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,13 +1,12 @@
 import pytest
-from _pytest.fixtures import FixtureRequest
 from flask import Flask
 from flask.testing import FlaskClient
 
 from time_tracker_api import create_app
 
 
 @pytest.fixture(scope='session')
-def app(request: FixtureRequest) -> Flask:
+def app() -> Flask:
     return create_app("time_tracker_api.config.TestConfig")
 
 
@@ -18,15 +17,16 @@ def client(app: Flask) -> FlaskClient:
 
 
 @pytest.fixture(scope="module")
-def sql_repository():
-    from .resources import PersonSQLModel
-    from time_tracker_api.sql_repository import db
+def sql_repository(app: Flask):
+    with app.test_client():
+        from tests.commons.data_access_layer.azure.resources import PersonSQLModel
+        from commons.data_access_layer.azure.sql_repository import db
 
-    db.metadata.create_all(bind=db.engine, tables=[PersonSQLModel.__table__])
-    print("Test models created!")
+        db.metadata.create_all(bind=db.engine, tables=[PersonSQLModel.__table__])
+        print("Test models created!")
 
-    from time_tracker_api.sql_repository import SQLRepository
-    yield SQLRepository(PersonSQLModel)
+        from commons.data_access_layer.azure.sql_repository import SQLRepository
+        yield SQLRepository(PersonSQLModel)
 
-    db.metadata.drop_all(bind=db.engine, tables=[PersonSQLModel.__table__])
-    print("Test models removed!")
+        db.metadata.drop_all(bind=db.engine, tables=[PersonSQLModel.__table__])
+        print("Test models removed!")
diff --git a/tests/time_tracker_api/__init__.py b/tests/time_tracker_api/__init__.py
diff --git a/tests/time_tracker_api/activities/__init__.py b/tests/time_tracker_api/activities/__init__.py
diff --git a/...s/activities/activities_namespace_test.py → ...i/activities/activities_namespace_test.py b/...s/activities/activities_namespace_test.py → ...i/activities/activities_namespace_test.py
diff --git a/tests/time_tracker_api/projects/__init__.py b/tests/time_tracker_api/projects/__init__.py
diff --git a/tests/projects/projects_namespace_test.py → ...r_api/projects/projects_namespace_test.py b/tests/projects/projects_namespace_test.py → ...r_api/projects/projects_namespace_test.py
diff --git a/tests/smoke_test.py → tests/time_tracker_api/smoke_test.py b/tests/smoke_test.py → tests/time_tracker_api/smoke_test.py
diff --git a/tests/time_tracker_api/time_entries/__init__.py b/tests/time_tracker_api/time_entries/__init__.py
diff --git a/...me_entries/time_entries_namespace_test.py → ...me_entries/time_entries_namespace_test.py b/...me_entries/time_entries_namespace_test.py → ...me_entries/time_entries_namespace_test.py
diff --git a/time_tracker_api/activities/activities_model.py b/time_tracker_api/activities/activities_model.py
@@ -6,10 +6,10 @@ class ActivityDao(CRUDDao):
 
 
 def create_dao() -> ActivityDao:
-    from time_tracker_api.sql_repository import db
-    from time_tracker_api.sql_repository import SQLCRUDDao
     from sqlalchemy_utils import UUIDType
     import uuid
+    from commons.data_access_layer.azure.sql_repository import db
+    from commons.data_access_layer.azure.sql_repository import SQLCRUDDao
 
     class ActivitySQLModel(db.Model):
         __tablename__ = 'activity'

diff --git a/time_tracker_api/config.py b/time_tracker_api/config.py
@@ -21,9 +21,10 @@ class DevelopmentConfig(Config):
 
 
 class SQLConfig(Config):
-    SQLALCHEMY_DATABASE_URI = Config.DATABASE_URI
     SQLALCHEMY_COMMIT_ON_TEARDOWN = True
     SQLALCHEMY_TRACK_MODIFICATIONS = False
+    DATABASE_URI = os.environ.get('DATABASE_URI')
+    SQLALCHEMY_DATABASE_URI = DATABASE_URI
 
 
 class TestConfig(SQLConfig):
@@ -41,7 +42,7 @@ class ProductionConfig(Config):
 
 
 class AzureConfig(SQLConfig):
-    DATABASE_URI = os.environ.get('DATABASE_URI', os.environ.get('SQLAZURECONNSTR_DATABASE_URI'))
+    DATABASE_URI = os.environ.get('SQLAZURECONNSTR_DATABASE_URI', SQLConfig.DATABASE_URI)
     SQLALCHEMY_DATABASE_URI = DATABASE_URI
 
 

diff --git a/time_tracker_api/database.py b/time_tracker_api/database.py
@@ -52,7 +52,7 @@ def __call__(self, *args, **kwargs):
 
 
 def init_app(app: Flask) -> None:
-    from time_tracker_api.sql_repository import init_app, SQLSeeder
+    from commons.data_access_layer.azure.sql_repository import init_app, SQLSeeder
     init_app(app)
     global seeder
     seeder = SQLSeeder()
diff --git a/time_tracker_api/projects/projects_model.py b/time_tracker_api/projects/projects_model.py
@@ -17,11 +17,12 @@ class ProjectDao(CRUDDao):
 
 
 def create_dao() -> ProjectDao:
-    from time_tracker_api.sql_repository import db
+    from commons.data_access_layer.azure.sql_repository import db
     from time_tracker_api.database import COMMENTS_MAX_LENGTH
     from time_tracker_api.sql_repository import SQLCRUDDao
     from sqlalchemy_utils import UUIDType
     import uuid
+    from commons.data_access_layer.azure.sql_repository import SQLCRUDDao, AuditedSQLModel
 
     class ProjectSQLModel(db.Model):
         __tablename__ = 'project'

diff --git a/time_tracker_api/time_entries/time_entries_model.py b/time_tracker_api/time_entries/time_entries_model.py
@@ -8,11 +8,11 @@ class TimeEntriesDao(CRUDDao):
 
 
 def create_dao() -> TimeEntriesDao:
-    from time_tracker_api.sql_repository import db
+    from commons.data_access_layer.azure.sql_repository import db
     from time_tracker_api.database import COMMENTS_MAX_LENGTH
-    from time_tracker_api.sql_repository import SQLCRUDDao
     from sqlalchemy_utils import UUIDType
     import uuid
+    from commons.data_access_layer.azure.sql_repository import SQLCRUDDao
 
     class TimeEntrySQLModel(db.Model):
         __tablename__ = 'time_entry'
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,4 +27,4 @@ ENV FLASK_APP time_tracker_api

		EXPOSE 5000

		CMD ["gunicorn", "-b 0.0.0.0:5000", "run:app"]
		CMD ["gunicorn", "-b 0.0.0.0:5000", "api:app"]