tests: pin render width suite-wide so --help asserts match CI#147
Merged
Conversation
The fixed_render_size fixture (COLUMNS=80/LINES=40) was opt-in, used only by
the snapshot modules. The ~20 other test files that assert against --help or
rendered CLI output ran at whatever width the environment supplied. Rich's
no-clip help table ellipsizes a long flag name ("--end-of-turn-c…") once its
column overflows, so a substring assert like `"--with-api-key" in help` passes
at a contributor's wide local terminal and fails at CI's narrower width.
That gap cost one PR three CI rounds on a single test
(test_api_key_flag_is_hidden_from_help). Making the fixture autouse pins the
render width for every test, so a local green is a CI green for output tests.
Tests that need a different width still override it per call
(runner.invoke(app, argv, env={"COLUMNS": "300"})).
Document the lesson in tests/AGENTS.md.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The fixed_render_size fixture (COLUMNS=80/LINES=40) was opt-in, used only by
the snapshot modules. The ~20 other test files that assert against --help or
rendered CLI output ran at whatever width the environment supplied. Rich's
no-clip help table ellipsizes a long flag name ("--end-of-turn-c…") once its
column overflows, so a substring assert like
"--with-api-key" in helppassesat a contributor's wide local terminal and fails at CI's narrower width.
That gap cost one PR three CI rounds on a single test
(test_api_key_flag_is_hidden_from_help). Making the fixture autouse pins the
render width for every test, so a local green is a CI green for output tests.
Tests that need a different width still override it per call
(runner.invoke(app, argv, env={"COLUMNS": "300"})).
Document the lesson in tests/AGENTS.md.