Copilot instructions

1---
2applyTo: "tests/integration/**/*.py"
3---
4## Pytest Integration Tests
5 
6 
7- Look to `app/factories/` to generate any required database state
8  - Here's an example of how to create + persist a factory `DistributionFactory.save(domain=PYTHON_TEST_SERVER_HOST)`
9- Add the `server` factory to each test
10- Use the `faker` factory to generate emails, etc.
11- Don't add obvious `assert` descriptions
12- Do not use the `db_session` fixture here. Instead, use `with test_session():` if you need to setup complex database state
13- if a UI timeout is occuring, it could be because it cannot find a element because the rendering has changed. Check the failure screenshot and see if you can correct the test assertion.
14- The integration tests can take a very long time to run. Do not abort them if they are taking a long time.
15- Use `expect(page.get_by_text("Screening is fully booked")).to_be_visible()` instead of `expect(page.get_by_role("heading")).to_contain_text("Screening is fully booked")`. It's less brittle.
16- Do not use `client` fixtures in an integration test. Integration tests should only use the frontend of the website to interact with the application, not the API.
17- Use `with page.expect_response("https://example.com/resource") as response_info:` to assert against network activity.
18- Do not `next_button.evaluate("el => el.click()")` instead, just `locator.click()`. If this doesn't work, stop your work and let me know.
19- Only use `wait_for_loading(page)` if a `LONG_INTEGRATION_TEST_TIMEOUT` on an expectation does not work: `expect(page.get_by_text("Your Matched Doctors")).to_be_visible(timeout=LONG_INTEGRATION_TEST_TIMEOUT)`
20  - `LONG_INTEGRATION_TEST_TIMEOUT` should only be used as a last resort. If you have many of these in a test, let me know and I will debug it.
21- Prefer fewer integration tests that cover more functionality. Unlike unit tests, where each test is designed to test a very particular piece of functionality, I want integration tests to cover entire workflows. It's preferred to add more steps to an integration test to test an entire workflow.
22- Prefer simple locators. If a `filter`, `or_`, etc is required to capture a button in multiple states it indicates something is wrong in the code.
23- Use `react_router_url` to generate the frontend url path and do not set `base_url`.
24- End all Playwright tests with `from pytest_playwright_artifacts import assert_no_console_errors` and `assert_no_console_errors(request)` (capture is the plugin's `playwright_console_logging` fixture).
25  - Test-Specific Ignores: Pass `ignore=[...]` to `assert_no_console_errors` per `pytest-playwright-artifacts` (regex strings, compiled patterns, or `{"file": "...", "message": "..."}` dicts); add a comment explaining why.
26  - Global Ignores: Use `playwright_console_ignore` under `[tool.pytest.ini_options]` in `pyproject.toml` (see `pytest-playwright-artifacts` README).
27 
28### Example Integration Test
29 
30Below is an example test. Notice the following:
31 
32- Code comments are used to describe the key user steps that are being tested
33- We avoid long timeouts or wait commands
34- Fixtures and factories are generated at the beginning of the test
35- We assert against database state after each major user action
36- Some of the comments (i.e. comments on included fixtures) are included for instructional purposes only and should not be included in the tests you write
37 
38```python
39from pytest_playwright_artifacts import assert_no_console_errors
40 
41 
42def test_streaming_checkout_creates_user_and_links_order(
43    # this fixture ensures that the underlying python server is started
44    server,
45    faker,
46    page: Page,
47    # if you need to create objects (like factories) tied to a common session, include this fixture
48    db_truncate_session,
49    # for asserting against the console logs
50    request: FixtureRequest,
51) -> None:
52    distribution = DistributionWithWebhooksFactory.save()
53    test_email = clerk_test_email()
54 
55    # 1) Run through streaming checkout
56    page.goto(react_router_url("/streaming"))
57 
58    page.get_by_placeholder("your@email.com").first.fill(test_email)
59    page.get_by_placeholder("your@email.com").last.fill(test_email)
60 
61    # Check TOS
62    page.get_by_role("checkbox").last.check()
63 
64    fill_stripe_checkout(page)
65 
66    # 2) Complete checkout
67    # the stripe checkout form will expand and cause the purchase button to move below the screen
68    safely_scroll_then_click(page.get_by_role("button", name="Complete Purchase"))
69 
70    expect(page.get_by_role("heading", name="You're ready to watch!")).to_be_visible()
71    page.get_by_role("link", name="Login & Start Watching").click()
72 
73    # 3) Assert against database and Clerk state
74 
75    # One StreamingOrder should be created for this distribution and email
76    assert StreamingOrder.count() == 1
77    streaming_order = StreamingOrder.get(email=test_email)
78    assert streaming_order
79 
80    assert streaming_order.status.value == "completed"
81    assert streaming_order.user_id is not None
82 
83    # 4) Login to the app via the Clerk login page
84    clerk_login_and_verify(page, test_email)
85 
86    expect(page.get_by_text("Triumph of the Heart").first).to_be_visible()
87 
88    # 5) Play the video
89    page.get_by_role("button").filter(has_text="Play").click()
90 
91    # wait for the page to completely load
92    wait_for_loading(page)
93 
94    expect(page.get_by_text("Triumph of the Heart").first).to_be_visible()
95    expect(page.get_by_text("Play")).not_to_be_visible()
96 
97    assert_no_console_errors(
98        request,
99        ignore=[
100            {
101              # if there are console errors specific to the project, exclude them here. Match to the specific URL if you can.
102              "file": r"https://iframe.cloudflarestream.com/.*",
103              "message": "the server responded with a status of 403",
104            }
105        ],
106    )
107```
108