Copilot instructions

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