python-trio / python-trio/trio

Should we expand our test suite by running some downstream projects tests in our CI?

Open
#923 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
7.3k
Forks
431
Avg merge
2d 17h
Merged PRs (30d)
6

Description

Apparently trio v0.11.0 broke trio-websocket, do to a subtle interaction between our deprecation logic and the import statement: https://github.com/HyperionGray/trio-websocket/issues/102

I can't think of any way we could have anticipated this particular issue. I mean, besides "be smarter", but "be smarter" is not a plan. It never occurred to us that supporting the exact statement import trio.ssl was part of our API, or if it was, that it was a part that could break.

One possible hedge against issues like this would be to have a CI job that runs the test suites for some downstream projects like trio-websocket, just to better align what we test versus what people use in the real world. No guarantees, but it'd give us a better chance of catching stuff like this in the future.

trio-websocket is an obvious candidate for this. What else? trio-asyncio, pytest-trio? hypercorn/quart-trio? (CC @pgjones) Of course we can pick a list now and then adjust it over time.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing CI setup and the downstream projects named in the issue: trio-websocket, trio-asyncio, pytest-trio, hypercorn, and quart-trio. Determine which projects and test suites should be included, then define a CI job whose successful runs demonstrate compatibility with the selected downstream projects.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, testing-qa
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.