admin/brew
1
0
Fork 0
Code Issues Packages Projects Releases 6 Wiki Activity

Formula Cookbook: note $HOME override

Browse Source 
See https://github.com/Homebrew/homebrew/pull/50130#discussion_r56254860
This commit is contained in:
Alex Dunn 2016-03-16 10:01:43 -07:00 committed by Xu Cheng
parent 90774be2ee
commit 90246be60a
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
share/doc/homebrew/Formula-Cookbook.md
View File

@ -241,7 +241,15 @@ Check the top of the e.g. `./configure` output. Some configure scripts do not re
Please add a [`test do`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#test-class_method) block to the formula. This will be run by `brew test foo` and the [Brew Test Bot](Brew-Test-Bot.md).
The [`test do`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#test-class_method) block automatically creates and changes to a temporary directory which is deleted after run. You can access this [`Pathname`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Pathname) with the [`testpath`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#testpath-instance_method) function.
The
[`test do`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#test-class_method)
block automatically creates and changes to a temporary directory which
is deleted after run. You can access this
[`Pathname`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Pathname)
with the
[`testpath`](http://www.rubydoc.info/github/Homebrew/homebrew/master/Formula#testpath-instance_method)
function. The environment variable `HOME` is set to `testpath` within
the `test do` block.
We want tests that don't require any user input and test the basic functionality of the application. For example `foo build-foo input.foo` is a good test and (despite their widespread use) `foo --version` and `foo --help` are bad tests. However, a bad test is better than no test at all.