refactor: structure web to group files by feature

Author: eoaksnes

api/src/app.py

@@ -18,7 +18,7 @@
 
 description_md = """
 ### Description
-A RESTful API for handling todo items.
+A RESTful API for handling todos items.
 
 Anyone in Equinor are authorized to run these calculations.
  * Click **Authorize** to login and start testing.

api/src/data_providers/get_repository.py

@@ -19,6 +19,6 @@
 
 def get_todo_repository():
     mongo_database_client = MongoDatabaseClient(
-        collection_name="todo", database_name=config.MONGODB_DATABASE, client=MONGO_CLIENT
+        collection_name="todos", database_name=config.MONGODB_DATABASE, client=MONGO_CLIENT
     )
     return TodoRepository(client=mongo_database_client)

api/src/tests/conftest.py

@@ -17,7 +17,7 @@
 def test_client():
     mongo_test_client = mongomock.MongoClient()
     client = MongoDatabaseClient(
-        collection_name="todo", database_name=mongo_test_client.TestDB.name, client=mongo_test_client
+        collection_name="todos", database_name=mongo_test_client.TestDB.name, client=mongo_test_client
     )
     yield client
     client.wipe_db()

api/src/tests/unit/data_providers/repositories/test_TodoRepository.py

@@ -12,52 +12,52 @@ def _setup_repository(self, test_client: MongoDatabaseClient):
         self.repository = TodoRepository(client=test_client)
 
     def test_create(self):
-        todo_item = TodoItem(id="1234", title="todo 1")
+        todo_item = TodoItem(id="1234", title="todos 1")
         self.repository.create(todo_item)
         assert len(self.repository.get_all()) == 1
 
     def test_create_already_exists(self):
-        todo_item_1 = TodoItem(id="1234", title="todo 1")
+        todo_item_1 = TodoItem(id="1234", title="todos 1")
         self.repository.create(todo_item_1)
         with pytest.raises(ValidationException):
-            todo_item_2 = TodoItem(id="1234", title="todo 1")
+            todo_item_2 = TodoItem(id="1234", title="todos 1")
             self.repository.create(todo_item_2)
 
     def test_find_item_that_exist(self):
         documents = [
-            {"_id": "81549300", "title": "todo 1"},
-            {"_id": "1a2b", "title": "todo 2"},
-            {"_id": "987321", "title": "todo 3"},
+            {"_id": "81549300", "title": "todos 1"},
+            {"_id": "1a2b", "title": "todos 2"},
+            {"_id": "987321", "title": "todos 3"},
             {
                 "_id": "987456",
-                "title": "todo 4",
+                "title": "todos 4",
             },
         ]
         self.repository.client.insert_many(documents)
-        todo_item = self.repository.find_one({"title": "todo 2"})
+        todo_item = self.repository.find_one({"title": "todos 2"})
         assert todo_item.id == "1a2b"
 
     def test_find_item_that_does_not_exist(self):
         documents = [
-            {"_id": "81549300", "title": "todo 1"},
-            {"_id": "1a2b", "title": "todo 2"},
-            {"_id": "987321", "title": "todo 3"},
+            {"_id": "81549300", "title": "todos 1"},
+            {"_id": "1a2b", "title": "todos 2"},
+            {"_id": "987321", "title": "todos 3"},
             {
                 "_id": "987456",
-                "title": "todo 4",
+                "title": "todos 4",
             },
         ]
         self.repository.client.insert_many(documents)
         assert self.repository.find_one({"_id": "invalid"}) is None
 
     def test_get_item_that_does_exist(self):
         documents = [
-            {"_id": "81549300", "title": "todo 1"},
-            {"_id": "1a2b", "title": "todo 2"},
-            {"_id": "987321", "title": "todo 3"},
+            {"_id": "81549300", "title": "todos 1"},
+            {"_id": "1a2b", "title": "todos 2"},
+            {"_id": "987321", "title": "todos 3"},
             {
                 "_id": "987456",
-                "title": "todo 4",
+                "title": "todos 4",
             },
         ]
         self.repository.client.insert_many(documents)
@@ -66,20 +66,20 @@ def test_get_item_that_does_exist(self):
 
     def test_get_item_that_does_not_exist(self):
         documents = [
-            {"_id": "81549300", "title": "todo 1"},
-            {"_id": "1a2b", "title": "todo 2"},
-            {"_id": "987321", "title": "todo 3"},
+            {"_id": "81549300", "title": "todos 1"},
+            {"_id": "1a2b", "title": "todos 2"},
+            {"_id": "987321", "title": "todos 3"},
             {
                 "_id": "987456",
-                "title": "todo 4",
+                "title": "todos 4",
             },
         ]
         self.repository.client.insert_many(documents)
         with pytest.raises(NotFoundException):
             self.repository.get("invalid")
 
     def test_update_item(self):
-        todo_item = TodoItem(id="81549300", title="todo 1")
+        todo_item = TodoItem(id="81549300", title="todos 1")
         self.repository.create(todo_item)
         todo_item_to_update = TodoItem(id="81549300", title="Updated title")
         self.repository.update(todo_item=todo_item_to_update)
@@ -91,15 +91,15 @@ def test_update_item_that_does_not_exist(self):
             self.repository.update(todo_item_to_update)
 
     def test_delete(self):
-        documents = [{"_id": "81549300", "title": "todo 1"}, {"_id": "1a2b", "title": "todo 2"}]
+        documents = [{"_id": "81549300", "title": "todos 1"}, {"_id": "1a2b", "title": "todos 2"}]
         self.repository.client.insert_many(documents)
         assert len(self.repository.get_all()) == 2
         self.repository.delete("81549300")
         assert len(self.repository.get_all()) == 1
         assert self.repository.get_all() == [self.repository.get("1a2b")]
 
     def test_delete_all(self):
-        documents = [{"_id": "81549300", "title": "todo 1"}, {"_id": "1a2b", "title": "todo 2"}]
+        documents = [{"_id": "81549300", "title": "todos 1"}, {"_id": "1a2b", "title": "todos 2"}]
         self.repository.client.insert_many(documents)
         assert len(self.repository.get_all()) == 2
         self.repository.delete_all()

api/src/tests/unit/features/todo/use_cases/test_delete_todo_by_id.py

@@ -20,3 +20,4 @@ def test_delete_todo_should_return_not_success(todo_repository: TodoRepositoryIn
     id = "unkown"
     with pytest.raises(NotFoundException):
         delete_todo_use_case(id=id, todo_repository=todo_repository)
+        assert error.message == "The todos item you specified does not exist."

api/src/tests/unit/features/todo/use_cases/test_get_todo_by_id.py

@@ -22,3 +22,4 @@ def test_get_todo_by_id_should_throw_todo_not_found_error(todo_repository: TodoR
     id = "unknown"
     with pytest.raises(NotFoundException):
         get_todo_by_id_use_case(id, todo_repository=todo_repository)
+        assert error.message == "The todos item you specified does not exist."

api/src/tests/yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+