Merge pull request #66 from grillazz/3-add-patch-to-update-document

3 add patch to update document

Author: grillazz

.github/workflows/build-and-test.yml

@@ -23,15 +23,14 @@ jobs:
       UP: up
       DOWN: down
       WEB_SERVER: web_server
-      MONGODB_HOST: mongodb
+      MONGODB_HOST: 127.0.0.1
       MONGODB_PORT: 27017
       MONGODB_USER: farmer
       MONGODB_PASSWORD: tractor
       MONGODB_DATABASE: greenhouse
       MONGODB_COLLECTION: greens
       MONGODB_TEST: farmland
-      MONGODB_PARAMS: retryWrites=true&w=majority
-      MONGO_URL: mongodb://farmer:[email protected]:27017/?retryWrites=true&w=majority
+      MONGODB_PARAMS: ?authSource=admin&authMechanism=SCRAM-SHA-1&retryWrites=true&w=majority
 
     services:
       mongodb:

Makefile

@@ -18,6 +18,10 @@ down: ## Reset project containers with compose
 test:	## Run project tests
 	docker-compose run --rm web pytest -vv
 
+.PHONY: test-snapshot
+test-snapshot:	## Run project tests
+	docker-compose run --rm web pytest -vv --inline-snapshot=create
+
 .PHONY: mypy
 mypy:	## mypy check.
 	mypy --ignore-missing-imports .
@@ -33,4 +37,9 @@ safety:  ## apply safety check in project.
 .PHONY: format
 format:  ## format project code.
 	black --line-length=120 .
-	isort -rc -m 3 --tc .
+	isort -rc -m 3 --tc .
+
+.PHONY: clean
+clean: ## Clean Reset project containers and volumes with compose
+	docker-compose down -v --remove-orphans | true
+	docker-compose rm -f

docker-compose.yml

@@ -19,7 +19,7 @@ services:
       - mongodb
 
   mongodb:
-    image: mongo:latest
+    image: mongo:7.0.8
     env_file:
       - .env
     ports:

greens/config.py

@@ -7,13 +7,13 @@
 
 class Settings(BaseSettings):
     """Settings for the application"""
+
     environment: str = os.getenv("ENVIRONMENT", "local")
     testing: str = os.getenv("TESTING", "0")
     up: str = os.getenv("UP", "up")
     down: str = os.getenv("DOWN", "down")
     web_server: str = os.getenv("WEB_SERVER", "web_server")
 
-    db_url: str = os.getenv("MONGO_URL", "")
     mongodb_database: str = os.getenv("MONGODB_DATABASE", "")
     mongodb_collection: str = os.getenv("MONGODB_COLLECTION", "")
     mongodb_test: str = os.getenv("MONGODB_TEST", "")
@@ -33,8 +33,7 @@ def mongodb_url(self) -> MongoDsn:
             port=self.MONGODB_PORT,
             username=self.MONGODB_USER,
             password=self.MONGODB_PASSWORD,
-
-            path=self.MONGODB_PARAMS
+            path=self.MONGODB_PARAMS,
         )
 
 

greens/main.py

@@ -15,16 +15,20 @@
 async def lifespan(app: FastAPI):
     app.state.logger = get_logger(__name__)
     app.state.logger.info("Starting greens on your farmland...mmm")
-    app.state.mongo_client, app.state.mongo_db, app.state.mongo_collection = await init_mongo(
-        global_settings.mongodb_database, global_settings.mongodb_url, global_settings.mongodb_collection
+    app.state.mongo_client, app.state.mongo_db, app.state.mongo_collection = (
+        await init_mongo(
+            global_settings.mongodb_database,
+            global_settings.mongodb_url.unicode_string(),
+            global_settings.mongodb_collection,
+        )
     )
     try:
         yield
     finally:
         app.state.logger.info("Parking tractors in garage...")
 
 
-app = FastAPI(lifespan=lifespan, title="Greens API", version="0.4.0")
+app = FastAPI(lifespan=lifespan, title="Greens API", version="0.5.0")
 
 app.include_router(v1, prefix="/api/v1")
 

greens/routers/v1/vegs.py

@@ -47,4 +47,5 @@ async def get_document(object_id: ObjectIdField):
     except (ValueError, TypeError) as exception:
         raise NotFoundHTTPException(msg=str(exception)) from exception
 
+
 # TODO: PUT for replace aka set PATCH for update ?

greens/services/repository.py

@@ -19,7 +19,9 @@ async def retrieve_document(document_id: str, collection: str) -> dict:
     :return:
     """
     document_filter = {"_id": ObjectId(document_id)}
-    if document := await greens.app.state.mongo_collection[collection].find_one(document_filter):
+    if document := await greens.app.state.mongo_collection[collection].find_one(
+        document_filter
+    ):
         return await document_id_helper(document)
     else:
         raise ValueError(f"No document found for {document_id=} in {collection=}")
@@ -33,8 +35,9 @@ async def create_document(document, collection: str) -> InsertOneResult:
     :return:
     """
     try:
-        document: InsertOneResult = await greens.app.state.mongo_collection[collection].insert_one(
-            document.model_dump())
+        document: InsertOneResult = await greens.app.state.mongo_collection[
+            collection
+        ].insert_one(document.model_dump())
         return document
     except WriteError as e:
         # TODO: this not make sense as id from mongo will be always unique if we not pass it
@@ -45,6 +48,12 @@ async def get_mongo_meta() -> dict:
     list_databases = await greens.app.state.mongo_client.list_database_names()
     list_of_collections = {}
     for db in list_databases:
-        list_of_collections[db] = await greens.app.state.mongo_client[db].list_collection_names()
+        list_of_collections[db] = await greens.app.state.mongo_client[
+            db
+        ].list_collection_names()
     mongo_meta = await greens.app.state.mongo_client.server_info()
-    return {"version": mongo_meta["version"], "databases": list_databases, "collections": list_of_collections}
+    return {
+        "version": mongo_meta["version"],
+        "databases": list_databases,
+        "collections": list_of_collections,
+    }

greens/utils.py

@@ -19,8 +19,14 @@ def get_logger(module_name):
 
     """
     logger = logging.getLogger(module_name)
-    handler = RichHandler(rich_tracebacks=True, console=console, tracebacks_show_locals=True)
-    handler.setFormatter(logging.Formatter("%(name)s - [ %(threadName)s:%(funcName)s:%(lineno)d ] - %(message)s"))
+    handler = RichHandler(
+        rich_tracebacks=True, console=console, tracebacks_show_locals=True
+    )
+    handler.setFormatter(
+        logging.Formatter(
+            "%(name)s - [ %(threadName)s:%(funcName)s:%(lineno)d ] - %(message)s"
+        )
+    )
     logger.addHandler(handler)
     logger.setLevel(logging.DEBUG)
     return logger

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fastapi-mongodb"
-version = "0.4.0"
+version = "0.5.0"
 description = ""
 authors = ["Jakub Miazek <[email protected]>"]
 readme = "README.md"
@@ -20,6 +20,7 @@ rich = "^13.7.1"
 uvloop = "^0.19.0"
 httptools = "^0.6.1"
 ruff = "^0.3.7"
+inline-snapshot = "^0.8.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]