Fixes #25 Tests sql repository

Author: EliuX

README.md

@@ -36,6 +36,35 @@ automatically [pip](https://pip.pypa.io/en/stable/) as well.
     
     The `stage` can be `dev` or `prod`. 
     Remember to do it with Python 3.
+    
+    
+- Install the [Microsoft ODBC Driver for SQL Server](https://docs.microsoft.com/en-us/sql/connect/odbc/microsoft-odbc-driver-for-sql-server?view=sql-server-ver15) 
+in your operative system. Then you have to check out how is called the SQL Driver installation. 
+Check it out with:
+
+```bash
+vim /usr/local/etc/odbcinst.ini
+```
+
+It may display something like
+
+```.ini
+[ODBC Driver 17 for SQL Server] 
+Description=Microsoft ODBC Driver 17 for SQL Server 
+Driver=/usr/local/lib/libmsodbcsql.17.dylib 
+UsageCount=2
+```
+
+Then when you specify the driver name, e.g. _DBC Driver 17 for SQL Server_ in the `DATABASE_URI`. E.g. 
+
+```.dotenv
+DATABASE_URI=mssql+pyodbc://<user>:<password>@time-tracker-srv.database.windows.net/<database>?driver\=ODBC Driver 17 for SQL Server
+```
+
+To troubleshoot issues regarding this part please check out:
+- [Install the Microsoft ODBC driver for SQL Server (macOS)](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/install-microsoft-odbc-driver-sql-server-macos?view=sql-server-ver15).
+- Github issue [odbcinst: SQLRemoveDriver failed with Unable to find component name](https://github.com/Microsoft/homebrew-mssql-preview/issues/2).
+- Stack overflow solution to [Can't open lib 'ODBC Driver 13 for SQL Server'? Sym linking issue?](https://stackoverflow.com/questions/44527452/cant-open-lib-odbc-driver-13-for-sql-server-sym-linking-issue).
 
 ### How to use it
 - Set the env var `FLASK_APP` to `time_tracker_api` and start the app:
@@ -122,7 +151,6 @@ the win.
 [API import restrictions and known issues](https://docs.microsoft.com/en-us/azure/api-management/api-management-api-import-restrictions)
 in Azure.
 
-
 ## License
 
 Copyright 2020 ioet Inc. All Rights Reserved.

tests/conftest.py

@@ -21,8 +21,8 @@ def client(app: Flask) -> FlaskClient:
         return c
 
 
-@pytest.fixture()
-def repository(app: Flask):
+@pytest.fixture(scope="module")
+def sql_repository(app: Flask):
     with app.app_context():
         from .resources import TestModel
         from time_tracker_api.sql_repository import db
@@ -31,4 +31,7 @@ def repository(app: Flask):
         print("Models for test created!")
 
         from time_tracker_api.sql_repository import SQLRepository
-        return SQLRepository(TestModel)
+        yield SQLRepository(TestModel)
+
+        print("Models for test removed!")
+        db.drop_all()

tests/sql_repository_test.py

@@ -1,15 +1,83 @@
 from faker import Faker
-from flask import Flask
 
 fake = Faker()
 
+existing_elements_registry = []
+last_deleted_element = None
 
-def test_create_entry(repository, app: Flask):
+
+def test_create(sql_repository):
     """Should create a new Entry"""
-    assert repository is not None
     from .resources import TestModel
-    sample_model = TestModel(name=fake.name(),
-                             email=fake.safe_email(),
-                             age = fake.pyint(min_value=10, max_value=80))
+    global sample_element
+    sample_element = TestModel(name=fake.name(),
+                               email=fake.safe_email(),
+                               age=fake.pyint(min_value=10, max_value=80))
+
+    result = sql_repository.create(sample_element)
+
+    assert result is not None
+    assert result.id is not None
+
+    existing_elements_registry.append(result)
+
+
+def test_find(sql_repository):
+    """Should find created element"""
+    existing_element = existing_elements_registry[0]
+
+    found_element = sql_repository.find(existing_element.id)
+
+    assert found_element is not None
+    assert found_element.id is not None
+
+
+def test_update(sql_repository):
+    """Updates an existing element"""
+    existing_element = existing_elements_registry[0]
+
+    updated_element = sql_repository.update(existing_element.id,
+                                            dict(name="Jon Snow", age=34))
+
+    assert updated_element is not None
+    assert updated_element.id == existing_element.id
+    assert updated_element.name == "Jon Snow"
+    assert updated_element.age == 34
+
+
+def test_find_all(sql_repository):
+    """Find all existing elements"""
+    existing_elements = sql_repository.find_all()
+
+    assert all(e in existing_elements_registry for e in existing_elements)
+
+
+def test_find_all_that_contains_property_with_string(sql_repository):
+    """Find all elements that have a property that partially contains a string (case-insensitive)"""
+    from .resources import TestModel
+    new_element = TestModel(name='Ramsay Snow',
+                            email=fake.safe_email(),
+                            age=fake.pyint(min_value=10, max_value=80))
+    sql_repository.create(new_element)
+    existing_elements_registry.append(new_element)
+
+    search_snow_result = sql_repository.find_all_contain_str('name', 'Snow')
+    assert len(search_snow_result) == 2
+
+    search_jon_result = sql_repository.find_all_contain_str('name', 'Jon')
+    assert len(search_jon_result) == 1
+
+    search_ram_result = sql_repository.find_all_contain_str('name', 'RAM')
+    assert search_ram_result[0] is new_element
+
+
+def test_delete_existing_element(sql_repository):
+    """Should delete created element"""
+    existing_element = existing_elements_registry[0]
+
+    result = sql_repository.remove(existing_element.id)
+
+    assert result is None
 
-    repository.create(sample_model)
+    global last_deleted_model
+    last_deleted_model = existing_elements_registry.pop()

time_tracker_api/sql_repository.py

@@ -1,5 +1,3 @@
-import urllib.parse
-
 from flask import Flask
 from flask_sqlalchemy import SQLAlchemy
 
@@ -16,12 +14,31 @@ class SQLRepository():
     def __init__(self, model_type: type):
         self.model_type = model_type
 
-    def create(self, model: dict) -> dict:
-        db.session.add(model)
+    def create(self, element: dict) -> dict:
+        db.session.add(element)
         db.session.commit()
+        return element
+
+    def find(self, id: int) -> dict:
+        return self.model_type.query.filter_by(id=id).first_or_404()
 
-    def find_all(self):
+    def find_all(self) -> list:
         return self.model_type.query.all()
 
+    def update(self, id: int, new_data: dict) -> dict:
+        model = self.model_type.query.filter_by(id=id)
+        model.update(new_data)
+        return model.first_or_404()
+
+    def remove(self, id: int) -> None:
+        found_element = self.find(id)
+        db.session.delete(found_element)
+        db.session.commit()
+
+    def find_all_contain_str(self, property, text) -> list:
+        return self.model_type.query\
+            .filter(getattr(self.model_type, property).contains(text))\
+            .all()
+
 
 repository_model = SQLRepository