feat: add litestar benchmark target (#23)

Author: JacobCoffee

.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# Code owner settings for `api-performance-tests`
+# @maintainers should be assigned to all reviews.
+# Most specific assignment takes precedence though, so if you add a more specific thing than the `*` glob, you must also add @maintainers
+# For more info about code owners see https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners#codeowners-file-example
+
+# Global Assignment
+*      @litestar-org/maintainers @litestar-org/members

.github/dependabot.yaml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/workflows/ci.yml

@@ -0,0 +1,62 @@
+name: CI
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+      - name: Install Pre-Commit
+        run: python -m pip install pre-commit && pre-commit install
+      - name: Load cached Pre-Commit Dependencies
+        id: cached-pre-commit-dependencies
+        uses: actions/cache@v3
+        with:
+          path: ~/.cache/pre-commit/
+          key: pre-commit|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml') }}
+      - name: Execute Pre-Commit
+        run: pre-commit run --show-diff-on-failure --color=always --all-files
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: true
+      matrix:
+        python-version: ["3.11"]
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+      - name: Set up python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: true
+          virtualenvs-in-project: true
+          installer-parallel: true
+      - name: Load cached venv
+        id: cached-poetry-dependencies
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: v1-venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: poetry install --no-interaction
+      - name: Set pythonpath
+        run: echo "PYTHONPATH=$PWD" >> $GITHUB_ENV
+      - name: Test with Coverage
+        if: matrix.python-version == '3.11'
+        run: poetry run pytest --cov=. --cov-report=xml
+      - uses: actions/upload-artifact@v3
+        if: matrix.python-version == '3.11'
+        with:
+          name: coverage-xml
+          path: coverage.xml

Makefile

@@ -0,0 +1,23 @@
+.PHONY: install
+install:  ## Install all dependencies
+	poetry install --extras test --with lint
+	pre-commit install
+
+.PHONY: sourcery
+sourcery:  ## Run sourcery
+	poetry run sourcery review --fix .
+
+.PHONY: tests
+test:  ## Run tests
+	pytest tests
+
+.PHONY: clean
+clean:  ## Remove all generated files
+	rm -rf .mypy_cache
+	find . -type d -name ".pytest_cache" -exec rm -rf {} +
+	rm -rf .ruff_cache
+	rm -rf results
+
+.PHONY: lint
+lint:  ## Run linters
+	poetry run pre-commit run --all-files

README.md

@@ -67,7 +67,7 @@ Serializing a dictionary into JSON
 
 ##### Serialization
 
-(only supported by `Litestar` and `FastAPI`)
+(only supported by `Litestar`, `Starlite`, and `FastAPI`)
 
 - Serializing 50 dataclass objects each referencing 2 more dataclass objects
 - Serializing 100 dataclass objects each referencing 5 more dataclass objects
@@ -97,8 +97,8 @@ All responses return "No Content"
 (not supported by `Starlette`)
 
 - Resolving 3 nested synchronous dependencies
-- Resolving 3 nested asynchronous dependencies (only supported by `Litestar` and `FastAPI`)
-- Resolving 3 nested synchronous, and 3 nested asynchronous dependencies (only supported by `Litestar` and `FastAPI`)
+- Resolving 3 nested asynchronous dependencies (only supported by `Litestar`, `Starlite`, and `FastAPI`)
+- Resolving 3 nested synchronous, and 3 nested asynchronous dependencies (only supported by `Litestar`, `Starlite`, and `FastAPI`)
 
 #### Modifying responses
 
@@ -127,11 +127,11 @@ After the run, the results will be stored in `results/run_<run_mumber>.json`
 
 To select a framework, simply pass its name to the `run command`:
 
-`bench run --rps litestar starlette fastapi`
+`bench run --rps litestar starlite starlette fastapi`
 
 ##### Selecting a framework version
 
-- A version available on PyPi: `bench run --rps litestar@v1.40.0`
+- A version available on PyPi: `bench run --rps litestar@v2.0.0`
 - A version from git: `bench run --rps litestar@git+branch_or_tag_name`
 - A version from a specific git repository: `bench run --rps litestar@git+https://github.com/litestar-org/litestar.git@branch_or_tag_name`
 - A local file: `bench run --rps litestar@file+/path/to/litestar`

asgi_bench/cli.py

@@ -7,12 +7,12 @@
 from asgi_bench.types import BenchmarkMode, EndpointCategory, EndpointMode
 
 
-@click.group()
+@click.group(help="ASGI benchmarking tool", context_settings={"help_option_names": ["-h", "--help"]})
 def cli() -> None:
     pass
 
 
-@cli.command()
+@cli.command(help="run benchmarks")
 @click.argument("frameworks", nargs=-1)
 @click.option("--rebuild", is_flag=True, show_default=True, help="rebuild images")
 @click.option("-w", "--warmup", default=5, show_default=True)
@@ -86,7 +86,7 @@ def run(
     runner.run()
 
 
-@cli.command("results")
+@cli.command("results", help="generate result tables and plots")
 @click.option("-r", "--run", "run_name", type=int, help="run to analyze (defaults to latest run)")
 @click.option(
     "-f",

asgi_bench/runner.py

@@ -204,7 +204,7 @@ def provide_service(self, spec: FrameworkSpec) -> Generator[bool, None, None]:
             try:
                 container.kill()
             except APIError as error:
-                if not (error.status_code == 409 and "not running" in error.explanation):
+                if error.status_code != 409 or "not running" not in error.explanation:
                     # the container stopped for reasons
                     raise error
             yield False

asgi_bench/spec.py

@@ -201,7 +201,7 @@ def make_spec(
     rate_limit: int | None = None,
     benchmark_modes: tuple[BenchmarkMode, ...] | BenchmarkMode,
     test_name: str | None = None,
-) -> list[FrameworkSpec]:
+) -> list[FrameworkSpec]:  # sourcery skip: low-code-quality
     if isinstance(endpoint_modes, str):
         endpoint_modes = (endpoint_modes,)
     if isinstance(categories, str):

asgi_bench/types.py

@@ -116,9 +116,7 @@ def pip_package(self) -> str:
             from .spec import FRAMEWORK_REPOS
 
             return f"git+{FRAMEWORK_REPOS[self.name]}@{version}"
-        if prefix == "file":
-            return version
-        return f"{self.name}=={self.version}"
+        return version if prefix == "file" else f"{self.name}=={self.version}"
 
     @property
     def extra_requirements(self) -> list[str]:

tests/test_types.py

@@ -37,7 +37,7 @@ def test_spec_targets(
     version_name: str,
 ):
     spec = FrameworkSpec(name="litestar", version=version, path=Path(), tests=[])
-    if pip_package:
+    if pip_package:  # sourcery skip: no-conditionals-in-tests
         assert spec.pip_package == pip_package
     assert spec.typed_version == (type_, clean_version)
     assert spec.image_tag == f"litestar-bench:{image_tag}"