Title: Instructions in `CONTRIBUTING.md` lead to an incomplete environment · Issue #2760 · getsentry/sentry-python · GitHub
Open Graph Title: Instructions in `CONTRIBUTING.md` lead to an incomplete environment · Issue #2760 · getsentry/sentry-python
X Title: Instructions in `CONTRIBUTING.md` lead to an incomplete environment · Issue #2760 · getsentry/sentry-python
Description: How do you use Sentry? Self-hosted/on-premise Version 1.40.5 Steps to Reproduce Clone repo Run steps outlined in CONTRIBUTING.md#Development Environment Expected Result pytest tests/ comes up all green Actual Result A string of small iss...
Open Graph Description: How do you use Sentry? Self-hosted/on-premise Version 1.40.5 Steps to Reproduce Clone repo Run steps outlined in CONTRIBUTING.md#Development Environment Expected Result pytest tests/ comes up all g...
X Description: How do you use Sentry? Self-hosted/on-premise Version 1.40.5 Steps to Reproduce Clone repo Run steps outlined in CONTRIBUTING.md#Development Environment Expected Result pytest tests/ comes up all g...
Opengraph URL: https://github.com/getsentry/sentry-python/issues/2760
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Instructions in `CONTRIBUTING.md` lead to an incomplete environment","articleBody":"### How do you use Sentry?\n\nSelf-hosted/on-premise\n\n### Version\n\n1.40.5\n\n### Steps to Reproduce\n\n1. Clone repo\r\n1. Run steps outlined in [`CONTRIBUTING.md#Development Environment`](https://github.com/getsentry/sentry-python/blob/master/CONTRIBUTING.md#development-environment)\r\n\n\n### Expected Result\n\n`pytest tests/` comes up all green\r\n\n\n### Actual Result\n\nA string of small issues that leads from tests failing to even start to incompatible dependencies version to failures that should not be there.\r\n\r\n1. [`linter-requirements.txt`](https://github.com/getsentry/sentry-python/blame/master/linter-requirements.txt#L8) installs `pymongo`, which unmasks `pymongo` integration tests. They rely on `mockupdb` being installed, but it's only mentioned in `tox.ini` => `pytest` blows up on collection.\r\n After installing `mockupdb`, I get 4 errors and 18 warnings (linux aarch64).\r\n1. Errors are due to [`test-requirements.txt`](https://github.com/getsentry/sentry-python/blob/2eeb8c50a0fe987cf70ef254ea0d63bf422a1899/test-requirements.txt#L3) [not constrainting `pytest` version](https://github.com/getsentry/sentry-python/commit/5cab03f3fd6a9d264922355321eb3aa5e25ef6b5), triggering [bug in `pytest-forked` that is documented in `tox.ini`](https://github.com/getsentry/sentry-python/blob/2eeb8c50a0fe987cf70ef254ea0d63bf422a1899/tox.ini#L244-L247)\r\n1. Majority of warnings are due to `pytest-asyncio` not being installed by anything except for `tox` (and installing it without [version constraints from `tox.ini`](https://github.com/getsentry/sentry-python/blob/2eeb8c50a0fe987cf70ef254ea0d63bf422a1899/tox.ini#L243) causes exciting issues)\r\n\r\nNone of the issues above are serious, but combined they add quite a bit of annoyance to the (ideally) first step of contributing to the project: developer environment setup.\r\n\r\nGiven the number of additional constraints mentioned in `tox.ini`, I almost wonder if suggesting using it instead of just `pytest` might be a good idea (btw `tox` just worked for me — great job setting it up!)\r\n\r\nThere is a quick (but brittle) solution, which is to introduce a Yet Another Requirements File for dev env bringup (and maybe make it pull others internally), but if anyone on the team has Thoughts on dependency management management but no time to implement them I'd be happy to lend a hand.","author":{"url":"https://github.com/arr-ee","@type":"Person","name":"arr-ee"},"datePublished":"2024-02-25T06:23:25Z","url":"https://github.com/getsentry/sentry-python/issues/2760"}
| react-profiling | 0 |
| react-import-map | react,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322 |
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:b47fdd02-93c1-19ab-ccca-d5c50071a35c |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 8760:2433F1:3A58B2:4EAF4B:6B008B9B |
| html-safe-nonce | 53f0f85d57a90a612d5724616f81a2d6eb2ec29aebdc741de7111c3013e54db1 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI4NzYwOjI0MzNGMTozQTU4QjI6NEVBRjRCOjZCMDA4QjlCIiwidmlzaXRvcl9pZCI6IjY5NjE3NjU4MDEwMTU2NzU4MDQiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ== |
| visitor-hmac | 649be85d8c56576035914493e33e3740304afb36d134eb8efd936a9bc1345049 |
| hovercard-subject-tag | issue:2152622435 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/getsentry/sentry-python/2760/issue_layout |
| twitter:image | https://opengraph.githubassets.com/86bb8a3e368d345b29828e9e677679fa9887f5f41db8374803f4fdaa21092d7d/getsentry/sentry-python/issues/2760 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/86bb8a3e368d345b29828e9e677679fa9887f5f41db8374803f4fdaa21092d7d/getsentry/sentry-python/issues/2760 |
| og:image:alt | How do you use Sentry? Self-hosted/on-premise Version 1.40.5 Steps to Reproduce Clone repo Run steps outlined in CONTRIBUTING.md#Development Environment Expected Result pytest tests/ comes up all g... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | arr-ee |
| hostname | github.com |
| expected-hostname | github.com |
| None | c710a5cb5c47be60abfe6e8410436d409906979dbed614ef09f29c60f5535b08 |
| turbo-cache-control | no-preview |
| go-import | github.com/getsentry/sentry-python git https://github.com/getsentry/sentry-python.git |
| octolytics-dimension-user_id | 1396951 |
| octolytics-dimension-user_login | getsentry |
| octolytics-dimension-repository_id | 137814779 |
| octolytics-dimension-repository_nwo | getsentry/sentry-python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 137814779 |
| octolytics-dimension-repository_network_root_nwo | getsentry/sentry-python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | be616a2a6ec1c609d6e002896dff5352d5c5f28b |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
| react-app-name | issues |
Links:
Viewport: width=device-width