feat: TT-418 merge with master changes

Author: mandres2015

V2/Makefile

@@ -1,10 +1,11 @@
 .PHONY: help
 help:
 		@echo "---------------HELP-----------------"
-		@echo "To install the dependencies type make install"
-		@echo "To test the project type make test"
-		@echo "To run the local database type make start-local"
-		@echo "To run all comands type make ci"
+		@echo "- make install --> Install the dependencies"
+		@echo "- make test --> Run all tests"
+		@echo "- make test specific_test=<name_of_the_test> --> Run specific test"
+		@echo "- make start-local --> Run local database"
+		@echo "- make ci --> Install the dependencies and run all tests"
 		@echo "------------------------------------"
 
 .PHONY: install
@@ -17,13 +18,16 @@ install:
 
 .PHONY: test
 test: export ENVIRONMENT = test
-test: export TEST_DB_CONNECTION = sqlite:///:memory:
 test:
 		@echo "=========================================Lint with flake8========================================="
 		flake8 . --show-source --statistics
 		@echo "Completed flake8!"
 		@echo "=========================================Test with pytest========================================="
-		python -m pytest -v
+		@if [ "$(specific_test)" ]; then \
+		python -m pytest -vv -s -k $(specific_test);\
+		else \
+		python -m pytest -v;\
+		fi
 		@echo "Completed test!"
 
 start-local:

V2/README.md

@@ -1,23 +1,108 @@
-# time-tracker-api V2
+# **Time-tracker-api V2 Architecture**
+Architecture
+The application follows a DDD approach with a hexagonal clean architecture. BIG WORDS!, what does it mean? it means the following:
 
-Refer to [Serverless docs](https://serverless.com/framework/docs/providers/azure/guide/intro/) for more information.
+We have a directory for each domain entitiy (i.e. time entries, technologies, activities, etc)
+Inside each entity directory we have other 3 directories (application, domain and infrastructure)
+I'll leave this drawing to understand how these three folders work and what logic should be included in these directories
 
-## Requirements to use makefile
+![ddd.png](https://raw.githubusercontent.com/eguezgustavo/time_tracker_app_skeleton/master/ddd.png)
+More information  [Here](https://github.com/eguezgustavo/time_tracker_app_skeleton)
 
-- Python version 3.6 or 3.7.
+## **Stack Technologies**
+  - [Serverless](https://serverless.com/framework/docs/providers/azure/guide/intro/)
+  - Python
+  - Pytest
+  - Docker Compose
+ 
+Recommended link [tdd_dojo](https://github.com/eguezgustavo/tdd_dojo)
 
-- Use an environment to install requirements (pyenv).
+## **Setup environment**
 
-## How to use makefile
+### **Requeriments**
+
+- Install python 3.6 or 3.7 (recommendation to install python [pyenv](https://github.com/pyenv/pyenv))
+- Install node (recommendation to install node [nvm](https://www.digitalocean.com/community/tutorials/how-to-install-node-js-on-ubuntu-20-04-es#:~:text=de%20Node.js.-,Opci%C3%B3n%203%3A%20Instalar%20Node%20usando%20el%20administrador%20de%20versiones%20de%20Node,-Otra%20forma%20de))
+
+### **Add variables**
+In the root directory /time-tracker-backend create a file .env with these values
+
+```
+export MS_AUTHORITY=XXX
+export MS_CLIENT_ID=XXX
+export MS_SCOPE=XXX
+export MS_SECRET=XXX
+export MS_ENDPOINT=XXX
+export DATABASE_ACCOUNT_URI=XXX
+export DATABASE_MASTER_KEY=XXX
+export DATABASE_NAME=XXX
+export FLASK_APP=XXX
+export FLASK_ENV=XXX
+export AZURE_APP_CONFIGURATION_CONNECTION_STRING=XXX
+export USERID=XXX
+export FLASK_DEBUG=True
+export PYTHONPATH=XXX
+export DB_CONNECTION=XXX
+export ENVIRONMENT=XXX
+```
+
+In the  directory /V2 create a file .env with these values
+```
+DB_USER=XXX
+DB_PASS=XXX
+DB_NAME=XXX
+```
+
+### **Install dependencies**
+In the Directory /V2
+```
+make install
+```
+
+## **Start Project**
+In the directory /V2
+```
+npm run offline 
+docker compose up or make start-local
+```
+
+
+## **Makefile to run a locally CI**
 
 Execute the next command to show makefile help:
 
 ```shell
-make help
+$ make help
 ```
 
 - To install the dependencies type the command ```make install```
-
 - To test the project type the command ```make test```
-
 - To run the local database type the command ```make start-local```
+
+## **How to contribute to the project**
+Clone the repository and from the master branch create a new branch for each new task.
+### **Branch names format**
+For example if your task in Jira is **TT-48 implement semantic versioning** your branch name is:
+```
+   TT-48-implement-semantic-versioning
+```
+### **Commit messages format**
+
+
+  Below there are some common examples you can use for your commit messages [semantic version](https://semver.org/) :
+
+  - **feat**: A new feature.
+  - **fix**: A bug fix.
+  - **perf**: A code change that improves performance.
+  - **build**: Changes that affect the build system or external dependencies (example scopes: npm, ts configuration).
+  - **ci**: Changes to our CI or CD configuration files and scripts (example scopes: Azure devops, github actions).
+  - **docs**: Documentation only changes.
+  - **refactor**: A code change that neither fixes a bug nor adds a feature.
+               It is important to mention that this key is not related to css styles.
+  - **test**: Adding missing tests or correcting existing tests.
+
+  ### Example
+    fix: TT-48 implement semantic versioning
+
+    Prefix to use in the space fix:
+    `(fix: |feat: |perf: |build: |ci: |docs: |refactor: |style: |test: )`

V2/serverless.yml

@@ -157,4 +157,3 @@ functions:
 #endregion Fin Customer
 
 #endregion Fin Funciones
-            

V2/tests/api/azure/activity_azure_endpoints_test.py

@@ -17,8 +17,6 @@ def test__activity_azure_endpoint__returns_all_activities(
         insert_activity(existent_activities[1], test_db).__dict__
     ]
 
-    azure_activities._get_activities.DATABASE = test_db
-
     req = func.HttpRequest(method='GET', body=None, url=ACTIVITY_URL)
     response = azure_activities._get_activities.get_activities(req)
     activities_json_data = response.get_body().decode("utf-8")
@@ -33,7 +31,6 @@ def test__activity_azure_endpoint__returns_an_activity__when_activity_matches_it
     existent_activity = activity_factory()
     inserted_activity = insert_activity(existent_activity, test_db).__dict__
 
-    azure_activities._get_activities.DATABASE = test_db
     req = func.HttpRequest(
         method='GET',
         body=None,
@@ -54,7 +51,6 @@ def test__activity_azure_endpoint__returns_an_activity_with_inactive_status__whe
     existent_activity = activity_factory()
     inserted_activity = insert_activity(existent_activity, test_db).__dict__
 
-    azure_activities._delete_activity.DATABASE = test_db
     req = func.HttpRequest(
         method='DELETE',
         body=None,
@@ -76,7 +72,6 @@ def test__update_activity_azure_endpoint__returns_an_activity__when_found_an_act
     existent_activity = activity_factory()
     inserted_activity = insert_activity(existent_activity, test_db).__dict__
 
-    azure_activities._update_activity.DATABASE = test_db
     activity_body = {"description": Faker().sentence()}
     req = func.HttpRequest(
         method='PUT',

V2/tests/integration/daos/activities_sql_dao_test.py renamed to V2/tests/integration/daos/activities_dao_test.py

@@ -9,15 +9,15 @@
 
 @pytest.fixture(name='create_fake_dao')
 def _create_fake_dao() -> domain.ActivitiesDao:
-    db_fake = DB('sqlite:///:memory:')
+    db_fake = DB()
     dao = infrastructure.ActivitiesSQLDao(db_fake)
     return dao
 
 
 @pytest.fixture(name='clean_database', autouse=True)
 def _clean_database():
     yield
-    db_fake = DB('sqlite:///:memory:')
+    db_fake = DB()
     dao = infrastructure.ActivitiesSQLDao(db_fake)
     query = dao.activity.delete()
     dao.db.get_session().execute(query)

V2/time_tracker/activities/_application/_activities/_create_activity.py

@@ -8,11 +8,10 @@
 from ... import _infrastructure
 from time_tracker._infrastructure import DB
 
-DATABASE = DB()
-
 
 def create_activity(req: func.HttpRequest) -> func.HttpResponse:
-    activity_dao = _infrastructure.ActivitiesSQLDao(DATABASE)
+    database = DB()
+    activity_dao = _infrastructure.ActivitiesSQLDao(database)
     activity_service = _domain.ActivityService(activity_dao)
     use_case = _domain._use_cases.CreateActivityUseCase(activity_service)
 

V2/time_tracker/activities/_application/_activities/_delete_activity.py

@@ -7,8 +7,6 @@
 from ... import _infrastructure
 from time_tracker._infrastructure import DB
 
-DATABASE = DB()
-
 
 def delete_activity(req: func.HttpRequest) -> func.HttpResponse:
     logging.info(
@@ -29,8 +27,9 @@ def delete_activity(req: func.HttpRequest) -> func.HttpResponse:
 
 
 def _delete(activity_id: int) -> str:
+    database = DB()
     activity_use_case = _domain._use_cases.DeleteActivityUseCase(
-        _create_activity_service(DATABASE)
+        _create_activity_service(database)
     )
     activity = activity_use_case.delete_activity(activity_id)
     return json.dumps(activity.__dict__) if activity else b'Not found'

V2/time_tracker/activities/_application/_activities/_get_activities.py

@@ -7,10 +7,9 @@
 from ... import _infrastructure
 from time_tracker._infrastructure import DB
 
-DATABASE = DB()
-
 
 def get_activities(req: func.HttpRequest) -> func.HttpResponse:
+    database = DB()
     logging.info(
         'Python HTTP trigger function processed a request to get an activity.'
     )
@@ -19,11 +18,11 @@ def get_activities(req: func.HttpRequest) -> func.HttpResponse:
 
     try:
         if activity_id:
-            response = _get_by_id(int(activity_id))
+            response = _get_by_id(int(activity_id), database)
             if response == b'Not Found':
                 status_code = 404
         else:
-            response = _get_all()
+            response = _get_all(database)
 
         return func.HttpResponse(
             body=response, status_code=status_code, mimetype="application/json"
@@ -34,18 +33,18 @@ def get_activities(req: func.HttpRequest) -> func.HttpResponse:
         )
 
 
-def _get_by_id(activity_id: int) -> str:
+def _get_by_id(activity_id: int, database: DB) -> str:
     activity_use_case = _domain._use_cases.GetActivityUseCase(
-        _create_activity_service(DATABASE)
+        _create_activity_service(database)
     )
     activity = activity_use_case.get_activity_by_id(activity_id)
 
     return json.dumps(activity.__dict__) if activity else b'Not Found'
 
 
-def _get_all() -> str:
+def _get_all(database: DB) -> str:
     activities_use_case = _domain._use_cases.GetActivitiesUseCase(
-        _create_activity_service(DATABASE)
+        _create_activity_service(database)
     )
     return json.dumps(
         [

V2/time_tracker/activities/_application/_activities/_update_activity.py

@@ -8,8 +8,6 @@
 from ... import _infrastructure
 from time_tracker._infrastructure import DB
 
-DATABASE = DB()
-
 
 def update_activity(req: func.HttpRequest) -> func.HttpResponse:
     logging.info(
@@ -37,8 +35,9 @@ def update_activity(req: func.HttpRequest) -> func.HttpResponse:
 
 
 def _update(activity_id: int, activity_data: dict) -> str:
+    database = DB()
     activity_use_case = _domain._use_cases.UpdateActivityUseCase(
-        _create_activity_service(DATABASE)
+        _create_activity_service(database)
     )
     activity = activity_use_case.update_activity(
         activity_id, activity_data.get("name"),

V2/time_tracker/activities/_infrastructure/_data_persistence/__init__.py

@@ -1,2 +1,2 @@
 # flake8: noqa
-from ._activities_sql_dao import ActivitiesSQLDao
+from ._activities_dao import ActivitiesSQLDao