Add ruff linter and fix formatting.

Author: alfredeen

.env.example

@@ -1,2 +1,2 @@
 DEFAULT_TEMPERATURE=0
-WEBUI_TOKEN=
+WEBUI_TOKEN=

.github/workflows/ci.yml

@@ -0,0 +1,21 @@
+name: CI
+
+on:
+  push:
+    branches-ignore:
+      - main
+  pull_request:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Ruff (lint)
+        uses: astral-sh/ruff-action@v3
+
+      - name: Ruff (format check)
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: "format --check --diff"

README.md

@@ -64,9 +64,17 @@ Run this test with 2 users for 1 minute.
 locust -f ./tests/test_owui_api.py --users 2 --run-time 1m
 ```
 
-
 ### Verify setup of Locust
 
 ```bash
 locust --headless -f ./tests/test_verify_setup.py --users 1 --run-time 10s
 ```
+
+## Development
+
+Install and use ruff
+```bash
+python -m pip install -U ruff
+ruff check .
+ruff format --check .
+```

common/cli_args.py

@@ -1,5 +1,6 @@
 from locust import events
 
+
 def _has_option(parser, option_string: str) -> bool:
     return any(option_string in action.option_strings for action in parser._actions)
 

common/utils.py

@@ -3,7 +3,6 @@
 import os
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
 
 from locust import events
 from locust.html import get_html_report
@@ -35,11 +34,11 @@ def write_locust_html_report(
     *,
     environment,
     report_prefix: str,
-    model: Optional[str] = None,
+    model: str | None = None,
     reports_dir: str = "reports",
-    timestamp: Optional[str] = None,
+    timestamp: str | None = None,
     enabled: bool = True,
-) -> Optional[str]:
+) -> str | None:
     """
     Create a Locust HTML report and write it to disk.
 

locust.conf

@@ -9,4 +9,4 @@ spawn-rate = 1
 run-time = 1m
 #tags = [Critical, Normal]
 #csv = stats/locust
-loglevel = INFO
+loglevel = INFO

pyproject.toml

@@ -0,0 +1,5 @@
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP"]

tests/test_owui_api.py

@@ -1,11 +1,10 @@
 """Locust test file to test Open WebUI."""
 
-import os
-from dotenv import load_dotenv
-
 import logging
+import os
 import warnings
 
+from dotenv import load_dotenv
 from locust import HttpUser, between, events, tag, task
 
 import common.cli_args  # noqa: F401  (registers common args)
@@ -36,20 +35,18 @@ def on_test_stop(environment, **kwargs):
 
 
 class ApiClientUser(HttpUser):
-    """The main purpose of this test user is to test the API endpoints.
-    """
+    """The main purpose of this test user is to test the API endpoints."""
 
     wait_time = between(2, 4)
 
-    @tag('api', 'health')
+    @tag("api", "health")
     @task()
     def get_health(self):
         self.client.get("/health")
 
-    @tag('api')
+    @tag("api")
     @task()
     def get_models_list(self):
-
         bearer_token = os.getenv("WEBUI_TOKEN")
 
         headers = {
@@ -63,7 +60,6 @@ def get_models_list(self):
             else:
                 response.failure(f"Failed: {response.status_code}")
 
-
     def on_start(self):
         self.client.verify = False  # Don't to check if certificate is valid
         logger.info("ONSTART new user of type ApiClientUser")

tests/test_owui_web.py

@@ -1,6 +1,5 @@
 """Locust test file to test Open WebUI."""
 
-import os
 import logging
 import warnings
 
@@ -31,24 +30,22 @@ def on_test_stop(environment, **kwargs):
         print("[locust] Report creation disabled")
 
 
-
 class WebUser(HttpUser):
-    """The main purpose of this test user is to test the web pages.
-    """
+    """The main purpose of this test user is to test the web pages."""
 
     wait_time = between(1, 2)
 
-    @tag('web')
+    @tag("web")
     @task(4)
     def browse_homepage(self):
         self.client.get("/")
 
-    @tag('web')
+    @tag("web")
     @task
     def browse_workspace_models(self):
         self.client.get("/workspace/models")
 
-    @tag('web')
+    @tag("web")
     @task
     def browse_notes(self):
         self.client.get("/notes")

tests/test_verify_setup.py

@@ -12,6 +12,7 @@
 
 class VerifyLocustUser(HttpUser):
     """The main purpose of this test user is to verify the setup of the Locust test framework."""
+
     wait_time = between(1, 2)
 
     @task