so 0.3.6 (new formula) #57520
so 0.3.6 (new formula) #57520
Conversation
Formula/so.rb
Outdated
| end | ||
|
|
||
| test do | ||
| system "#{bin}/so", "--help" |
There was a problem hiding this comment.
We need a test that exercises the some of the functionality of the app. Version checks or usage checks (foo --version or foo --help) are not sufficient, as explained in the formula cookbook.
In most cases, a good test would involve running a simple test case: run #{bin}/foo input.txt.
- Then you can check that the output is as expected (with assert_equal or assert_match on the output of shell_output)
- You can also check that an output file was created, if that is expected: assert_predicate testpath/"output.txt", :exist?
Some advice for specific cases:
- If the formula is a library, compile and run some simple code that links against it. It could be taken from upstream's documentation / source examples.
- If the formula is for a GUI program, try to find some function that runs as command-line only, like a format conversion, reading or displaying a config file, etc.
- If the software cannot function without credentials, a test could be to try to connect with invalid credentials (or without credentials) and confirm that it fails as expected.
- Same if the software requires a virtual machine, docker instance, etc. to be running.
There was a problem hiding this comment.
Thanks @SMillerDev. I've updated the PR with a more substantial test of the typical usage.
|
Huh that's weird. That failed test on 5e7cb17 isn't running on the updated code... perhaps a caching issue? It still thinks line 25 is 120 characters long... and |
|
Could you rename your commit to the PR title please |
|
You mean rebase it so that all the changes are a single commit with message |
|
Yes please |
There was a problem hiding this comment.
Thanks @samtay ! Without contributions like yours it'd be impossible to keep homebrew going with the high standards that users have come to expect from the project. You can feel good knowing that you've made the world a tiny bit better for homebrew users around the world! 👍 🎉
brew install --build-from-source <formula>, where<formula>is the name of the formula you're submitting?brew test <formula>, where<formula>is the name of the formula you're submitting?brew audit --strict <formula>(after doingbrew install <formula>)?Adds a formula for so v0.3.6.