Merge pull request #45 from ks6088ts-labs/feature/issue-40_add-tests-docs

add local tests

Author: ks6088ts

Makefile

@@ -1,6 +1,7 @@
 # Git
 GIT_REVISION ?= $(shell git rev-parse --short HEAD)
 GIT_TAG ?= $(shell git describe --tags --abbrev=0 --always | sed -e s/v//g)
+LOG_LEVEL ?= "INFO"
 
 .PHONY: help
 help:
@@ -41,7 +42,7 @@ lint: ## lint
 
 .PHONY: test
 test: ## run tests
-	poetry run pytest
+	poetry run pytest --log-cli-level=$(LOG_LEVEL)
 
 .PHONY: ci-test
 ci-test: install-deps-dev format-check lint test ## run CI tests

README.md

@@ -45,6 +45,18 @@ make docker-run
 make ci-test-docker
 ```
 
+### Run local test
+
+Currently almost all tests won't run on CI because it consumes Azure resources.
+To run the tests locally, follow the steps below.
+
+```shell
+# Run test if RUN_TEST is defined
+export RUN_TEST=1
+
+make test
+```
+
 ## Deployment instructions
 
 ### Docker compose

backend/routers/azure_storage_queue.py

@@ -41,22 +41,22 @@ async def create_queue(
 
 
 @router.delete(
-    "/queues",
+    "/queues/{queue_name}",
     response_model=azure_storage_queue_schemas.DeleteQueueResponse,
     status_code=200,
 )
 async def delete_queue(
-    body: azure_storage_queue_schemas.DeleteQueueRequest,
+    queue_name: str,
 ):
     try:
         client.delete_queue(
-            queue_name=body.queue_name,
+            queue_name=queue_name,
         )
     except Exception as e:
         logger.error(f"Failed to delete queue: {e}")
         raise
     return azure_storage_queue_schemas.DeleteQueueResponse(
-        queue_name=body.queue_name,
+        queue_name=queue_name,
     )
 
 

backend/schemas/azure_storage_queue.py

@@ -13,10 +13,6 @@ class CreateQueueResponse(BaseModel):
     queue_name: str
 
 
-class DeleteQueueRequest(BaseModel):
-    queue_name: str
-
-
 class DeleteQueueResponse(BaseModel):
     queue_name: str
 

docs/README.md

@@ -16,6 +16,7 @@
 - [FastAPI > UploadFile class](https://fastapi.tiangolo.com/reference/uploadfile/)
 - [FastAPI > Extending OpenAPI](https://fastapi.tiangolo.com/how-to/extending-openapi/)
 - [Get started with Azure Blob Storage and Python](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-blob-python-get-started?tabs=sas-token)
+- [FastAPI で実装した様々なエンドポイントのテストを書く（フォームデータの送信、クッキーの確認、ファイルのアップロード等）](https://qiita.com/kurumaebi65/items/d5cda239ef601f4c36ef#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%82%92%E3%82%A2%E3%83%83%E3%83%97%E3%83%AD%E3%83%BC%E3%83%89%E3%83%80%E3%82%A6%E3%83%B3%E3%83%AD%E3%83%BC%E3%83%89)
 - [Quickstart: Azure Queue Storage client library for Python](https://learn.microsoft.com/en-us/azure/storage/queues/storage-quickstart-queues-python?tabs=passwordless%2Croles-azure-portal%2Cenvironment-variable-windows%2Csign-in-azure-cli)
 - [Azure Event Grid client library for Python - version 4.19.0](https://learn.microsoft.com/en-us/python/api/overview/azure/eventgrid-readme?view=azure-python)
 - [Azure Event Grid Client Library Python Samples](https://learn.microsoft.com/en-us/samples/azure/azure-sdk-for-python/eventgrid-samples/)

tests/__init__.py

@@ -0,0 +1,8 @@
+from tests.utilities import client
+
+
+def test_main():
+    response = client.get("/openapi.json")
+    assert response.status_code == 200
+    json_response = response.json()
+    assert json_response["openapi"] == "3.0.0"

tests/test_main.py

@@ -0,0 +1,24 @@
+from logging import getLogger
+
+import pytest
+
+from tests.utilities import RUN_TEST, client, image
+
+logger = getLogger(__name__)
+
+
+@pytest.mark.skipif(RUN_TEST, reason="need to launch the backend server first")
+def test_azure_ai_document_intelligence():
+    path_format = "/azure_ai_document_intelligence/{0}"
+    response = client.post(
+        url=path_format.format("analyze_document"),
+        files={
+            "file": (
+                "test.png",
+                image,
+                "application/octet-stream",
+            )
+        },
+    )
+    assert response.status_code == 200
+    logger.info(f"response: {response.json()}")

tests/test_smoke.py

@@ -0,0 +1,41 @@
+from logging import getLogger
+
+import pytest
+
+from tests.utilities import RUN_TEST, client, image
+
+logger = getLogger(__name__)
+
+
+@pytest.mark.skipif(RUN_TEST, reason="need to launch the backend server first")
+def test_azure_ai_vision_image_analyze():
+    path_format = "/azure_ai_vision/{0}"
+    response = client.post(
+        url=path_format.format("image/analyze"),
+        files={
+            "file": (
+                "test.png",
+                image,
+                "application/octet-stream",
+            )
+        },
+    )
+    assert response.status_code == 200
+    logger.info(f"response: {response.json()}")
+
+
+@pytest.mark.skipif(RUN_TEST, reason="need to launch the backend server first")
+def test_azure_ai_vision_image_vectorize():
+    path_format = "/azure_ai_vision/{0}"
+    response = client.post(
+        url=path_format.format("image/vectorize"),
+        files={
+            "file": (
+                "test.png",
+                image,
+                "application/octet-stream",
+            )
+        },
+    )
+    assert response.status_code == 200
+    logger.info(f"response: {response.json()}")