getsentry / getsentry/sentry-python

Better Test structure

Open
#4,480 1 comment 0 reactions 0 assignees View on GitHub
Improvement Python Quality Improvement
Dominant language
Python
Stars
2.2k
Forks
669
Avg merge
1d 1h
Merged PRs (30d)
213

Description

Right now it is hard to get tests right and there is a lot of magic in `conftest.py` (and probably other places) and the isolation of tests is alo lacking (resulting in use of pytest.mark.forked usage)

Idea of a better test structure:

```python

def test_something(sentry_init):
sentry_client = sentry_init(dsn, ...)

# do something

sentry_client.transport.envelopes
# -> array of envelopes

sentry_client.transport.events
# -> array of captured events
```

There is a custom transport on the client that collects data on class internal arrays that can be accessed via properties.

Those arrays should be cleaned after each test run. Should also work in async, and gevent, and eventlet code.

Basically just have one fixture for testing most of the stuff

Also tests should never alter the global state so they are self contained and can run in parallel without pytest markers.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.