Merge pull request #24 from ioet/feature/Create-configuration-and-database-routing#23

Close #24 - Create configuration and database routing

Author: Angeluz-07

README.md

@@ -63,7 +63,7 @@ We are using Pytest](https://docs.pytest.org/en/latest/index.html) for tests. Th
 
 To run the tests just execute:
 
-```
+```bash
 python3 -m pytest -v
 ```
 

requirements/dev.txt

@@ -5,7 +5,10 @@
 # For development
 
 # Tests
-pytest==4.1.1
+pytest==5.2.0
+
+# Mocking
+pytest-mock==2.0.0
 
 # Coverage
 coverage==4.5.1

tests/conftest.py

@@ -1,15 +1,18 @@
-
 import pytest
+from flask import Flask
+from flask.testing import FlaskClient
 
 from time_tracker_api import create_app
 
+
 @pytest.fixture(scope='session')
-def app():
+def app() -> Flask:
     """An instance of the app for tests"""
     return create_app()
 
+
 @pytest.fixture
-def client(app):
+def client(app: Flask) -> FlaskClient:
     """A test client for the app."""
     with app.test_client() as c:
-        return c
+        return c

tests/projects/projects_namespace_test.py

@@ -8,4 +8,4 @@ def test_list_should_return_nothing(client):
     assert 200 == response.status_code
 
     json_data = json.loads(response.data)
-    assert [] == json_data
+    assert [] == json_data

tests/time_entries/__init__.py

@@ -0,0 +1,17 @@
+from flask import json
+from flask.testing import FlaskClient
+from pytest_mock import MockFixture
+
+
+def test_list_should_return_empty_array(mocker: MockFixture, client: FlaskClient):
+    from time_tracker_api.time_entries.time_entries_namespace import model
+    """Should return an empty array"""
+    model_mock = mocker.patch.object(model, 'find_all', return_value=[])
+
+    response = client.get("/time-entries", follow_redirects=True)
+
+    assert 200 == response.status_code
+
+    json_data = json.loads(response.data)
+    assert [] == json_data
+    model_mock.assert_called_once()

tests/time_entries/time_enties_namespace_test.py

@@ -1,14 +1,38 @@
+import os
+
 from flask import Flask
 
 
-def create_app():
+def create_app(config_path='time_tracker_api.config.DefaultConfig',
+               config_data=None):
     flask_app = Flask(__name__)
 
+    init_app_config(flask_app, config_path, config_data)
     init_app(flask_app)
 
     return flask_app
 
 
+def init_app_config(app: Flask, config_path: str, config_data: dict = None):
+    if config_path:
+        app.config.from_object(config_path)
+    else:
+        # ensure the instance folder exists
+        try:
+            os.makedirs(app.instance_path)
+        except OSError:
+            pass
+
+        # Located in `/instance`
+        app.config.from_pyfile('config.py', silent=True)
+
+    if config_data:
+        app.config.update(config_data)
+
+
 def init_app(app: Flask):
+    from .database import init_app as init_database
+    init_database(app)
+
     from .api import api
     api.init_app(app)

time_tracker_api/__init__.py

@@ -4,7 +4,7 @@
 ns = Namespace('activities', description='API for activities')
 
 # Activity Model
-activity = ns.model('Activity', {
+activity_input = ns.model('ActivityInput', {
     'name': fields.String(
         required=True,
         title='Name',
@@ -27,24 +27,24 @@
 }
 activity_response_fields.update(audit_fields)
 
-activity_response = ns.inherit(
-    'ActivityResponse',
-    activity,
+activity = ns.inherit(
+    'Activity',
+    activity_input,
     activity_response_fields
 )
 
 
 @ns.route('')
 class Activities(Resource):
     @ns.doc('list_activities')
-    @ns.marshal_list_with(activity_response, code=200)
+    @ns.marshal_list_with(activity, code=200)
     def get(self):
         """List all available activities"""
         return []
 
     @ns.doc('create_activity')
-    @ns.expect(activity)
-    @ns.marshal_with(activity_response, code=201)
+    @ns.expect(activity_input)
+    @ns.marshal_with(activity, code=201)
     @ns.response(400, 'Invalid format of the attributes of the activity.')
     def post(self):
         """Create a single activity"""
@@ -56,7 +56,7 @@ def post(self):
 @ns.param('id', 'The unique identifier of the activity')
 class Activity(Resource):
     @ns.doc('get_activity')
-    @ns.marshal_with(activity_response)
+    @ns.marshal_with(activity)
     def get(self, id):
         """Retrieve all the data of a single activity"""
         return {}
@@ -69,8 +69,8 @@ def delete(self, id):
 
     @ns.doc('put_activity')
     @ns.response(400, 'Invalid format of the attributes of the activity.')
-    @ns.expect(activity)
-    @ns.marshal_with(activity_response)
+    @ns.expect(activity_input)
+    @ns.marshal_with(activity)
     def put(self, id):
         """Updates an activity"""
         return ns.payload

time_tracker_api/activities/activities_namespace.py

@@ -0,0 +1,12 @@
+class Config:
+    DEBUG = False
+
+
+class WhateverDevelopConfig(Config):
+    DEBUG = True
+    FLASK_DEBUG = True
+    FLASK_ENV = "develop"
+    DATABASE = "whatever"
+
+
+DefaultConfig = WhateverDevelopConfig

time_tracker_api/config.py

@@ -0,0 +1,28 @@
+"""
+Agnostic database assets
+
+Put here your utils and class independent of
+the database solution
+"""
+from flask import Flask
+
+RepositoryModel = None
+
+
+def init_app(app: Flask) -> None:
+    """Make the app ready to use the database"""
+    database_strategy_name = app.config['DATABASE']
+    with app.app_context():
+        module = globals()["use_%s" % database_strategy_name]()
+        global RepositoryModel
+        RepositoryModel = module.repository_model
+
+
+def create(model_name: str):
+    """Creates the repository instance for the chosen database"""
+    return RepositoryModel(model_name)
+
+
+def use_whatever():
+    from time_tracker_api import whatever_repository
+    return whatever_repository