Merge pull request #39 from wednesday-solutions/feat/load-testing

feat - load testing added
wednesday-solutions · Mar 20, 2024 · 9788299 · 9788299 · github-actions · Mar 20, 2024
2 parents f1ded38 + 1ba7693
commit 9788299
Show file tree

Hide file tree

Showing 9 changed files with 56 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -6,6 +6,7 @@ This repository provides a template for creating and deploying a FastAPI project
 
 - [Features](#features)
 - [Getting started](#getting-started)
+- [Advanced Usage](#advanced-usage)
 
 ### Features
 
@@ -28,6 +29,8 @@ This repository provides a template for creating and deploying a FastAPI project
 - Application monitoring using Signoz
 - Feature flagging added - User can enabled/disabled
 - Database Monitoring using percona
+- Loadtests using locust
+
 ### Getting Started
 
 #### Requirements:
@@ -144,7 +147,9 @@ async def external_service_endpoint():
         raise HTTPException(status_code=503, detail="Service temporarily unavailable")
 ```
 
-# Using Signoz Monitoring Tool
+### Advanced Usage
+
+#### Using Signoz Monitoring Tool
 
 To utilize Signoz for monitoring your applications, follow these steps:
 
@@ -179,7 +184,7 @@ To utilize Signoz for monitoring your applications, follow these steps:
      OTEL_EXPORTER_OTLP_PROTOCOL=
      ```
 
-## Logging with Signoz
+#### Logging with Signoz
 
 To enable logging with Signoz, follow these steps:
 
@@ -196,7 +201,8 @@ To enable logging with Signoz, follow these steps:
    - Follow the instructions provided to configure log sending to Signoz.
 
 By following these steps, you can effectively set up application monitoring and logging using Signoz for your Python FastAPI applications.
-### Database Monitoring Using Percona
+
+#### Database Monitoring Using Percona
 
 To monitor your database using Percona, follow these steps:
 
@@ -230,8 +236,15 @@ To monitor your database using Percona, follow these steps:
 
 By following these steps, you'll successfully configure Percona to monitor your MySQL database.
 
-### Dashboard Links
+#### Dashboard Links
 - Percona: https://localhost:443
 - flower: http://localhost:5556
 - server: http://localhost:8000
+- locust: http://localhost:8089
 - server-healthcheck: http://localhost:8000/home
+
+
+#### Useful scripts
+- Tests - scripts/run_tests.sh
+- Linting & Formatting - scripts/lint_and_format.sh
+- Load tests - scripts/load_tests.sh (Change [locust.conf](https://docs.locust.io/en/stable/configuration.html) accordinly)
diff --git a/app/middlewares/rate_limiter_middleware.py b/app/middlewares/rate_limiter_middleware.py
@@ -6,7 +6,7 @@
 
 from app.config.redis_config import get_redis_pool
 
-MAX_REQUESTS = 10
+MAX_REQUESTS = 10000
 TIME_WINDOW = 60
 
 

diff --git a/app/routes/users/users.py b/app/routes/users/users.py
@@ -12,7 +12,6 @@
 from app.daos.users import get_user as get_user_dao
 from app.daos.users import list_users as list_users_dao
 from app.daos.users import login as signin
-from app.middlewares.request_id_injection import request_id_contextvar
 from app.schemas.users.users_request import CreateUser
 from app.schemas.users.users_request import Login
 from app.schemas.users.users_response import UserOutResponse

diff --git a/compose.yaml b/compose.yaml
@@ -101,7 +101,22 @@ services:
       - /:/host:ro
     networks:
       - fast-api-network
-
+  locust-master:
+    image: locustio/locust
+    ports:
+      - "8089:8089"  # Expose Locust's web interface on port 8089
+    volumes:
+      - ./loadtests:/mnt/locust  # Mount the loadtests directory into the container
+    command: -f /mnt/locust --master -H http://app:"${SERVER_PORT}"  # Start Locust in master mode, pointing to your FastAPI application
+    networks:
+      - fast-api-network
+  locust-worker:
+    image: locustio/locust
+    volumes:
+      - ./loadtests:/mnt/locust  # Mount the loadtests directory into the container
+    command: -f /mnt/locust --worker --master-host locust-master
+    networks:
+      - fast-api-network
 networks:
   fast-api-network:
     driver: bridge

diff --git a/loadtests/__init__.py b/loadtests/__init__.py
diff --git a/loadtests/home.py b/loadtests/home.py
@@ -0,0 +1,10 @@
+from __future__ import annotations
+
+from locust import HttpUser
+from locust import task
+
+
+class Home(HttpUser):
+    @task
+    def home_endpoint(self):
+        self.client.get("/api/home/")
diff --git a/locust.conf b/locust.conf
@@ -0,0 +1,8 @@
+locustfile = ./loadtests
+headless = true
+master = false
+expect-workers = 5
+host = http://0.0.0.0:8000
+users = 100
+spawn-rate = 10
+run-time = 10m
diff --git a/requirements.txt b/requirements.txt
@@ -43,6 +43,7 @@ iniconfig==2.0.0
 itsdangerous
 joblib==1.2.0
 langchain
+locust>=2.0
 lxml==4.9.2
 lz4==4.3.2
 Markdown==3.4.3

diff --git a/scripts/load_tests.sh b/scripts/load_tests.sh
@@ -0,0 +1,3 @@
+echo "Running load tests"
+echo
+locust
File	Stmts	Miss	Cover	Missing
app
app.py	37	28	24%	12–67
app/config
__init__.py	3	1	67%	6
base.py	37	2	95%	53–54
celery_config.py	17	17	0%	1–27
celery_utils.py	21	21	0%	1–30
redis_config.py	5	2	60%	8–9
app/constants
jwt_utils.py	16	11	31%	11–23
app/daos
home.py	10	5	50%	11–18
users.py	70	62	11%	12–133
app/middlewares
cache_middleware.py	51	51	0%	1–67
rate_limiter_middleware.py	25	25	0%	1–35
request_id_injection.py	17	17	0%	1–25
app/models
__init__.py	3	3	0%	1–5
users.py	27	27	0%	1–38
app/routes
__init__.py	12	12	0%	1–15
app/routes/cache_router
__init__.py	3	3	0%	1–5
cache_samples.py	12	12	0%	1–18
app/routes/celery_router
__init__.py	3	3	0%	1–5
celery_samples.py	12	12	0%	1–17
app/routes/home
__init__.py	3	3	0%	1–5
home.py	33	33	0%	1–45
app/routes/users
__init__.py	3	3	0%	1–5
users.py	37	37	0%	1–56
app/schemas/users
users_request.py	42	42	0%	1–73
users_response.py	10	10	0%	1–14
app/sessions
db.py	53	53	0%	1–82
app/tests
test_basic.py	20	15	25%	10–34
test_daos_home.py	23	10	57%	15–22, 28–37, 41
test_daos_users.py	110	95	14%	19–208
app/utils
exception_handler.py	19	19	0%	1–36
redis_utils.py	4	4	0%	1–7
slack_notification_utils.py	14	14	0%	1–32
user_utils.py	25	25	0%	1–36
app/wrappers
cache_wrappers.py	26	26	0%	1–32
TOTAL	820	703	14%