test: deprecate return false in test#21296
Merged
MikeMcQuaid merged 1 commit intomainfrom Dec 21, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR deprecates the use of return false to indicate test failure in Homebrew formula tests, encouraging the use of explicit exceptions instead. This is part of a gradual migration (allowing for an odeprecate cycle) to phase out this legacy behavior.
- Adds deprecation warning when a test returns
false, guiding users to useraiseinstead - Updates type signatures from
T.nilable(T::Boolean)orT.untypedtoBasicObjectto support the transition period - Includes TODO comments marking where code can be simplified once the deprecation cycle is complete
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| Library/Homebrew/test.rb | Adds detection and deprecation warning for return false in tests, along with TODOs for future cleanup |
| Library/Homebrew/formula.rb | Updates type signatures for run_test, test methods to use BasicObject instead of boolean types, with TODOs for reverting to void after deprecation cycle |
| Library/Homebrew/debrew.rb | Updates type signature for the test method override to match the new BasicObject return type |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Alternatives like `raise` are more informative than `return false`. Dropping this simplifies typing where we have to allow arbitrary return types just so we can handle FalseClass.
f45666e to
53f0e46
Compare
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
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.
brew lgtm(style, typechecking and tests) with your changes locally?Replacement for #21291 to allow odeprecate cycle.
Using BasicObject as we have no control over what a formula test block returns and we need something that supports
==.