Cursor rule

1---
2description: Pytest Tests
3globs: tests/**/*.py
4alwaysApply: false
5---
6## Pytest Tests
7 
8 
9- Look first to `app.factories.*` instead of `app.models.*` to generate any required database state
10  - For example, to create and persist a `Distribution` record `DistributionFactory.save()`
11  - If a factory doesn't exist for the model you are working with, create one.
12  - You can customize one or more params in a factory using `DistributionFactory.save(host="custom_host.com)`
13- Use `faker` factory to generate emails, etc.
14- Do not mock or patch unless I instruct you to. Test as much of the application stack as possible in each test.
15- If you get lazy attribute errors, or need a database session to share across logic, use the `db_session` fixture to fix the issue.
16  - Note that when writing route tests a `db_session` is not needed for the logic inside of the route.
17- When testing Stripe, use the sandbox API. Never mock out Stripe interactions unless explicitly told to.
18- Omit obvious docstrs and comments. Add comments for non-obvious but easy-to-miss lines that are key to what the test is checking.
19- If a docstring needs formatting, use markdown. Use Google Style.
20 
21### Example Test
22 
23Below is an example test, you'll notice the following:
24 
25- Docstr is omitted since the purpose of the test is obvious
26- Comment about the `county` is added since it's the main point of the test
27- Newline between test setup, functionality under test, and assertions against result
28- `api_app_url_path_for` helper is used instead of hardcoded routes
29 
30```python
31from app.generated.fastapi_typed_routes import api_app_url_path_for
32import json
33 
34def test_calculate_quote_unknown_county(client):
35    payload = {
36        "subscriber": {"age": 35, "gender": "M"},
37        # fake county to ensure error is thrown
38        "county": "NotACounty",
39    }
40 
41    response = client.post(
42        api_app_url_path_for("composite_quote"),
43        json=payload,
44    )
45 
46    assert_status(response, status.HTTP_422_UNPROCESSABLE_CONTENT)
47```
48 
49### File Structure
50 
51* If there's more than a handful of tests in a folder, you should probably create subfolders.
52* File name should be related to the file or primary class / functionality the test is covering. Do not add a component to the test name that exists in the test file path.
53  * Example: `app/routes/unauthenticated/quote.py` should be `tests/routes/unauthenticated/quote_test.py`
54* `tests/routes/{unauthenticated,authenticated}` and a handful of top-level test files for fastapi API route testing.
55* `tests/integration/` for browser tests
56