64898b2c79
Some checks failed
Code scanning / CodeQL (push) Failing after 15s
Zulip production suite / Ubuntu 22.04 production build (push) Failing after 26s
Zulip production suite / Debian 12 production install with custom db name and user (push) Has been skipped
Zulip production suite / Ubuntu 22.04 production install and PostgreSQL upgrade with pgroonga (push) Has been skipped
Zulip production suite / Ubuntu 24.04 production install (push) Has been skipped
Zulip production suite / Ubuntu 26.04 production install (push) Has been skipped
Zulip production suite / Debian 13 production install (push) Has been skipped
Zulip production suite / 7.0 Version Upgrade (push) Has been skipped
Zulip production suite / 8.0 Version Upgrade (push) Has been skipped
Zulip production suite / 6.0 Version Upgrade (push) Has been skipped
Zulip production suite / 10.0 Version Upgrade (push) Has been skipped
Zulip production suite / 9.0 Version Upgrade (push) Has been skipped
Zulip production suite / 12.0 Version Upgrade (push) Has been skipped
Zulip production suite / 11.0 Version Upgrade (push) Has been skipped
GitHub Actions Security Analysis with zizmor / zizmor (push) Failing after 3s
Zulip CI / Debian 12 (Python 3.11, backend + documentation) (push) Failing after 26s
Zulip CI / Ubuntu 22.04 (Python 3.10, backend + frontend) (push) Failing after 3s
Zulip CI / Ubuntu 24.04 (Python 3.12, backend) (push) Failing after 25s
Zulip CI / Ubuntu 26.04 (Python 3.14, backend) (push) Failing after 25s
Zulip CI / Debian 13 (Python 3.13, backend) (push) Failing after 28s
Zulip production suite / Required jobs (push) Has been cancelled
Zulip CI / Required jobs (push) Has been cancelled
API Documentation Update Check / check-feature-level-updated (push) Has been cancelled
API Documentation Update Check / notify-if-api-docs-changed (push) Has been cancelled
34 lines
1.2 KiB
Markdown
34 lines
1.2 KiB
Markdown
---
|
|
paths:
|
|
- "zerver/tests/**"
|
|
- "zerver/webhooks/**"
|
|
- "web/tests/**"
|
|
---
|
|
|
|
# Testing Philosophy
|
|
|
|
- Write end-to-end tests when possible verifying what's important, not
|
|
internal APIs.
|
|
- Tests must work offline. Use fixtures (in `zerver/tests/fixtures`) for
|
|
external service testing and `responses` for simpler things.
|
|
- Use time_machine and similar libraries to mock time.
|
|
- Read `zerver/tests/test_example.py` for patterns.
|
|
- A good failing test before implementing is good practice so your
|
|
test and code can jointly verify each other.
|
|
- Remember to always assert state is correctly updated, not just "success".
|
|
- In tests, don't assert on `assertLogs` output with
|
|
`any(phrase in line for line in mock_log.output)`; pin the full line
|
|
against `mock_log.output`, or a substring to a specific `mock_log.output[i]`.
|
|
|
|
A common failure mode is failing to have test coverage for error
|
|
conditions that require coverage (note `tools/coveragerc` excludes
|
|
asserts). Run `test-backend --coverage FooTest` and check the coverage
|
|
data to confirm that the new lines you added are in fact run by the
|
|
tests.
|
|
|
|
## For webhooks
|
|
|
|
```bash
|
|
./tools/test-backend zerver/webhooks/<integration>
|
|
```
|