valicek/bats
1
0
Fork 0
mirror of https://github.com/sstephenson/bats.git synced 2024-12-25 14:09:43 +01:00
Code Issues Releases Wiki Activity

add Manpages

Browse Source 
- add bats.1
- add bats.7
- tweak install.sh to install manpages
This commit is contained in:
Jakukyo Friel 2013-11-09 16:09:26 +08:00
parent ddd03ab852
commit b1eee9f455
8 changed files with 1070 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
install.sh
View File

@ -31,5 +31,7 @@ BATS_ROOT="$(abs_dirname "$0")"
mkdir -p "$PREFIX"/{bin,libexec}
cp -R "$BATS_ROOT"/bin/* "$PREFIX"/bin
cp -R "$BATS_ROOT"/libexec/* "$PREFIX"/libexec
cp "$BATS_ROOT"/man/bats.1 "$PREFIX"/share/man/man1
cp "$BATS_ROOT"/man/bats.7 "$PREFIX"/share/man/man7
echo "Installed Bats to $PREFIX/bin/bats"

86
man/bats.1 Normal file
View File

@ -0,0 +1,86 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BATS" "1" "November 2013" "" ""
.
.SH "NAME"
\fBbats\fR \- Bash Automated Testing System
.
.SH "SYNOPSIS"
bats [\-c] [\-p | \-t] \fItest\fR [\fItest\fR \.\.\.]
.
.SH "DESCRIPTION"
Bats is a TAP\-compliant testing framework for Bash\. It provides a simple way to verify that the UNIX programs you write behave as expected\.
.
.P
Bats is most useful when testing software written in Bash, but you can use it to test any UNIX program\.
.
.SH "FILES"
To run your tests, invoke the \fBbats\fR interpreter with a path to a test file\. The file\'s test cases are run sequentially and in isolation\. If all the test cases pass, \fBbats\fR exits with a \fB0\fR status code\. If there are any failures, \fBbats\fR exits with a \fB1\fR status code\.
.
.P
You can invoke the \fBbats\fR interpreter with multiple test file arguments, or with a path to a directory containing multiple \fB\.bats\fR files\. Bats will run each test file individually and aggregate the results\. If any test case fails, \fBbats\fR exits with a \fB1\fR status code\.
.
.SH "OPTIONS"
.
.TP
\fB\-c\fR, \fB\-\-count\fR
Count the number of test cases without running any tests
.
.TP
\fB\-h\fR, \fB\-\-help\fR
Display this help message
.
.TP
\fB\-p\fR, \fB\-\-pretty\fR
Show results in pretty format (default for terminals)
.
.TP
\fB\-t\fR, \fB\-\-tap\fR
Show results in TAP format
.
.TP
\fB\-v\fR, \fB\-\-version\fR
Display the version number
.
.SH "EXAMPLES"
When you run Bats from a terminal, you\'ll see output as each test is performed, with a check\-mark next to the test\'s name if it passes or an "X" if it fails\.
.
.IP "" 4
.
.nf
$ bats addition\.bats
✓ addition using bc
✓ addition using dc
2 tests, 0 failures
.
.fi
.
.IP "" 0
.
.P
If Bats is not connected to a terminal—in other words, if you run it from a continuous integration system or redirect its output to a file—the results are displayed in human\-readable, machine\-parsable TAP format \fIhttp://testanything\.org/wiki/index\.php/TAP_specification#THE_TAP_FORMAT\fR\. You can force TAP output from a terminal by invoking Bats with the \fB\-\-tap\fR option\.
.
.IP "" 4
.
.nf
$ bats \-\-tap addition\.bats
1\.\.2
ok 1 addition using bc
ok 2 addition using dc
.
.fi
.
.IP "" 0
.
.SH "COPYRIGHT"
(c) 2013 Sam Stephenson\.
.
.P
Bats is released under an MIT\-style license
.
.SH "SEE ALSO"
bats(7)

156
man/bats.1.html Normal file
View File

@ -0,0 +1,156 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>bats(1) - Bash Automated Testing System</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#FILES">FILES</a>
<a href="#OPTIONS">OPTIONS</a>
<a href="#EXAMPLES">EXAMPLES</a>
<a href="#COPYRIGHT">COPYRIGHT</a>
<a href="#SEE-ALSO">SEE ALSO</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>bats(1)</li>
<li class='tc'></li>
<li class='tr'>bats(1)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>bats</code> - <span class="man-whatis">Bash Automated Testing System</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<p>bats [-c] [-p | -t] <var>test</var> [<var>test</var> ...]</p>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>Bats is a TAP-compliant testing framework for Bash.
It provides a simple way to verify that the UNIX programs you write behave as expected.</p>
<p>Bats is most useful when testing software written in Bash, but you can use it to test any UNIX program.</p>
<h2 id="FILES">FILES</h2>
<p>To run your tests, invoke the <code>bats</code> interpreter with a path to a test
file. The file's test cases are run sequentially and in isolation. If
all the test cases pass, <code>bats</code> exits with a <code>0</code> status code. If there
are any failures, <code>bats</code> exits with a <code>1</code> status code.</p>
<p>You can invoke the <code>bats</code> interpreter with multiple test file
arguments, or with a path to a directory containing multiple <code>.bats</code>
files. Bats will run each test file individually and aggregate the
results. If any test case fails, <code>bats</code> exits with a <code>1</code> status code.</p>
<h2 id="OPTIONS">OPTIONS</h2>
<dl>
<dt><code>-c</code>, <code>--count</code></dt><dd>Count the number of test cases without running any tests</dd>
<dt><code>-h</code>, <code>--help</code></dt><dd>Display this help message</dd>
<dt><code>-p</code>, <code>--pretty</code></dt><dd>Show results in pretty format (default for terminals)</dd>
<dt><code>-t</code>, <code>--tap</code></dt><dd>Show results in TAP format</dd>
<dt><code>-v</code>, <code>--version</code></dt><dd>Display the version number</dd>
</dl>
<h2 id="EXAMPLES">EXAMPLES</h2>
<p>When you run Bats from a terminal, you'll see output as each test is
performed, with a check-mark next to the test's name if it passes or
an "X" if it fails.</p>
<pre><code>$ bats addition.bats
✓ addition using bc
✓ addition using dc
2 tests, 0 failures
</code></pre>
<p>If Bats is not connected to a terminal—in other words, if you
run it from a continuous integration system or redirect its output to
a file—the results are displayed in human-readable, machine-parsable
<a href="http://testanything.org/wiki/index.php/TAP_specification#THE_TAP_FORMAT">TAP format</a>.
You can force TAP output from a terminal by invoking Bats with the
<code>--tap</code> option.</p>
<pre><code>$ bats --tap addition.bats
1..2
ok 1 addition using bc
ok 2 addition using dc
</code></pre>
<h2 id="COPYRIGHT">COPYRIGHT</h2>
<p>(c) 2013 Sam Stephenson.</p>
<p>Bats is released under an MIT-style license</p>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p><a class="man-ref" href="bats.7.html">bats<span class="s">(7)</span></a></p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>November 2013</li>
<li class='tr'>bats(1)</li>
</ol>
</div>
</body>
</html>

87
man/bats.1.ronn Normal file
View File

@ -0,0 +1,87 @@
bats(1) -- Bash Automated Testing System
========================================
SYNOPSIS
--------
bats [-c] [-p | -t] <test> [<test> ...]
DESCRIPTION
-----------
Bats is a TAP-compliant testing framework for Bash.
It provides a simple way to verify that the UNIX programs you write behave as expected.
Bats is most useful when testing software written in Bash, but you can use it to test any UNIX program.
FILES
-----
To run your tests, invoke the `bats` interpreter with a path to a test
file. The file's test cases are run sequentially and in isolation. If
all the test cases pass, `bats` exits with a `0` status code. If there
are any failures, `bats` exits with a `1` status code.
You can invoke the `bats` interpreter with multiple test file
arguments, or with a path to a directory containing multiple `.bats`
files. Bats will run each test file individually and aggregate the
results. If any test case fails, `bats` exits with a `1` status code.
OPTIONS
-------
* `-c`, `--count`:
Count the number of test cases without running any tests
* `-h`, `--help`:
Display this help message
* `-p`, `--pretty`:
Show results in pretty format (default for terminals)
* `-t`, `--tap`:
Show results in TAP format
* `-v`, `--version`:
Display the version number
EXAMPLES
--------
When you run Bats from a terminal, you'll see output as each test is
performed, with a check-mark next to the test's name if it passes or
an "X" if it fails.
$ bats addition.bats
✓ addition using bc
✓ addition using dc
2 tests, 0 failures
If Bats is not connected to a terminal—in other words, if you
run it from a continuous integration system or redirect its output to
a file—the results are displayed in human-readable, machine-parsable
[TAP format](http://testanything.org/wiki/index.php/TAP_specification#THE_TAP_FORMAT).
You can force TAP output from a terminal by invoking Bats with the
`--tap` option.
$ bats --tap addition.bats
1..2
ok 1 addition using bc
ok 2 addition using dc
COPYRIGHT
---------
(c) 2013 Sam Stephenson.
Bats is released under an MIT-style license
SEE ALSO
--------
bats(7)

235
man/bats.7 Normal file
View File

@ -0,0 +1,235 @@
.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "BATS" "7" "November 2013" "" ""
.
.SH "NAME"
\fBbats\fR \- Bats test file format
.
.SH "SYNOPSIS"
.
.nf
load test_helper
setup() {
# set up your environment
# run before and after each test case
}
teardown() {
# clean up your environment
# run before and after each test case
}
code_outside_of_test_cases () {
# For example, check for dependencies
# and fail immediatelyif they\'re not present\.
# Output must be redirected to `stderr` (`>&2`)
}
@test "test description" {
run foo arguments
[ "$status" \-eq 1 ]
[ "$output" = "expected output" ]
}
@test "test description" {
run foo arguments
[ "$status" \-eq 1 ]
[ "${lines[0]}" = "first line of expected output" ]
}
@test "A test I don\'t want to execute for now" {
skip "This command will return zero soon, but not now"
run foo
[ "$status" \-eq 0 ]
}
@test "A test which should run" {
if [ foo != bar ]; then
skip "foo isn\'t bar"
fi
run foo
[ "$status" \-eq 0 ]
}
.
.fi
.
.SH "DESCRIPTION"
A Bats test file is a Bash script with special syntax for defining test cases\. Under the hood, each test case is just a function with a description\.
.
.IP "" 4
.
.nf
#!/usr/bin/env bats
@test "addition using bc" {
result="$(echo 2+2 | bc)"
[ "$result" \-eq 4 ]
}
@test "addition using dc" {
result="$(echo 2 2+p | dc)"
[ "$result" \-eq 4 ]
}
.
.fi
.
.IP "" 0
.
.P
Each Bats test file is evaulated n+1 times, where \fIn\fR is the number of test cases in the file\. The first run counts the number of test cases, then iterates over the test cases and executes each one in its own process\.
.
.P
For details about exactly how Bats evaluates test files, see Bats Evaluation Process: https://github\.com/sstephenson/bats/wiki/Bats\-Evaluation\-Process
.
.SH "THE <code>_RUN_</code> HELPER"
Many Bats tests need to run a command and then make assertions about its exit status and output\. Bats includes a \fBrun\fR helper that invokes its arguments as a command, saves the exit status and output into special global variables, and then returns with a \fB0\fR status code so you can continue to make assertions in your test case\.
.
.P
For example, let\'s say you\'re testing that the \fBfoo\fR command, when passed a nonexistent filename, exits with a \fB1\fR status code and prints an error message\.
.
.IP "" 4
.
.nf
@test "invoking foo with a nonexistent file prints an error" {
run foo nonexistent_filename
[ "$status" \-eq 1 ]
[ "$output" = "foo: no such file \'nonexistent_filename\'" ]
}
.
.fi
.
.IP "" 0
.
.P
The \fB$status\fR variable contains the status code of the command, and the \fB$output\fR variable contains the combined contents of the command\'s standard output and standard error streams\.
.
.P
A third special variable, the \fB$lines\fR array, is available for easily accessing individual lines of output\. For example, if you want to test that invoking \fBfoo\fR without any arguments prints usage information on the first line:
.
.IP "" 4
.
.nf
@test "invoking foo without arguments prints usage" { run foo
[ "$status" \-eq 1 ]
[ "${lines[0]}" = "usage: foo <filename>" ]
}
.
.fi
.
.IP "" 0
.
.SH "THE <code>_LOAD_</code> COMMAND"
You may want to share common code across multiple test files\. Bats includes a convenient \fBload\fR command for sourcing a Bash source file relative to the location of the current test file\. For example, if you have a Bats test in \fBtest/foo\.bats\fR, the command
.
.IP "" 4
.
.nf
load test_helper
.
.fi
.
.IP "" 0
.
.P
will source the script \fBtest/test_helper\.bash\fR in your test file\. This can be useful for sharing functions to set up your environment or load fixtures\.
.
.SH "THE <code>_SKIP_</code> COMMAND"
Tests can be skipped by using the \fBskip\fR command at the point in a test you wish to skip\.
.
.IP "" 4
.
.nf
@test "A test I don\'t want to execute for now" {
skip
run foo
[ "$status" \-eq 0 ]
}
.
.fi
.
.IP "" 0
.
.P
Optionally, you may include a reason for skipping:
.
.IP "" 4
.
.nf
@test "A test I don\'t want to execute for now" {
skip "This command will return zero soon, but not now"
run foo
[ "$status" \-eq 0 ]
}
.
.fi
.
.IP "" 0
.
.P
Or you can skip conditionally:
.
.IP "" 4
.
.nf
@test "A test which should run" {
if [ foo != bar ]; then
skip "foo isn\'t bar"
fi
run foo
[ "$status" \-eq 0 ]
}
.
.fi
.
.IP "" 0
.
.SH "SETUP AND TEARDOWN FUNCTIONS"
You can define special \fBsetup\fR and \fBteardown\fR functions which run before and after each test case, respectively\. Use these to load fixtures, set up your environment, and clean up when you\'re done\.
.
.SH "CODE OUTSIDE OF TEST CASES"
You can include code in your test file outside of \fB@test\fR functions\. For example, this may be useful if you want to check for dependencies and fail immediately if they\'re not present\. However, any output that you print in code outside of \fB@test\fR, \fBsetup\fR or \fBteardown\fR functions must be redirected to \fBstderr\fR (\fB>&2\fR)\. Otherwise, the output may cause Bats to fail by polluting the TAP stream on \fBstdout\fR\.
.
.SH "SPECIAL VARIABLES"
There are several global variables you can use to introspect on Bats tests:
.
.IP "\(bu" 4
\fB$BATS_TEST_FILENAME\fR is the fully expanded path to the Bats test file\.
.
.IP "\(bu" 4
\fB$BATS_TEST_DIRNAME\fR is the directory in which the Bats test file is located\.
.
.IP "\(bu" 4
\fB$BATS_TEST_NAMES\fR is an array of function names for each test case\.
.
.IP "\(bu" 4
\fB$BATS_TEST_NAME\fR is the name of the function containing the current test case\.
.
.IP "\(bu" 4
\fB$BATS_TEST_DESCRIPTION\fR is the description of the current test case\.
.
.IP "\(bu" 4
\fB$BATS_TEST_NUMBER\fR is the (1\-based) index of the current test case in the test file\.
.
.IP "\(bu" 4
\fB$BATS_TMPDIR\fR is the location to a directory that may be used to store temporary files\.
.
.IP "" 0
.
.SH "SEE ALSO"
bats(1)

290
man/bats.7.html Normal file
View File

@ -0,0 +1,290 @@
<!DOCTYPE html>
<html>
<head>
<meta http-equiv='content-type' value='text/html;charset=utf8'>
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
<title>bats(7) - Bats test file format</title>
<style type='text/css' media='all'>
/* style: man */
body#manpage {margin:0}
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
.mp h2 {margin:10px 0 0 0}
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
.mp h3 {margin:0 0 0 4ex}
.mp dt {margin:0;clear:left}
.mp dt.flush {float:left;width:8ex}
.mp dd {margin:0 0 0 9ex}
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
.mp pre {margin-bottom:20px}
.mp pre+h2,.mp pre+h3 {margin-top:22px}
.mp h2+pre,.mp h3+pre {margin-top:5px}
.mp img {display:block;margin:auto}
.mp h1.man-title {display:none}
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
.mp h2 {font-size:16px;line-height:1.25}
.mp h1 {font-size:20px;line-height:2}
.mp {text-align:justify;background:#fff}
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
.mp u {text-decoration:underline}
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
.mp b.man-ref {font-weight:normal;color:#434241}
.mp pre {padding:0 4ex}
.mp pre code {font-weight:normal;color:#434241}
.mp h2+pre,h3+pre {padding-left:0}
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
ol.man-decor {width:100%}
ol.man-decor li.tl {text-align:left}
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
ol.man-decor li.tr {text-align:right;float:right}
</style>
</head>
<!--
The following styles are deprecated and will be removed at some point:
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
.man-navigation should be used instead.
-->
<body id='manpage'>
<div class='mp' id='man'>
<div class='man-navigation' style='display:none'>
<a href="#NAME">NAME</a>
<a href="#SYNOPSIS">SYNOPSIS</a>
<a href="#DESCRIPTION">DESCRIPTION</a>
<a href="#THE-_RUN_-HELPER">THE _RUN_ HELPER</a>
<a href="#THE-_LOAD_-COMMAND">THE _LOAD_ COMMAND</a>
<a href="#THE-_SKIP_-COMMAND">THE _SKIP_ COMMAND</a>
<a href="#SETUP-AND-TEARDOWN-FUNCTIONS">SETUP AND TEARDOWN FUNCTIONS</a>
<a href="#CODE-OUTSIDE-OF-TEST-CASES">CODE OUTSIDE OF TEST CASES</a>
<a href="#SPECIAL-VARIABLES">SPECIAL VARIABLES</a>
<a href="#SEE-ALSO">SEE ALSO</a>
</div>
<ol class='man-decor man-head man head'>
<li class='tl'>bats(7)</li>
<li class='tc'></li>
<li class='tr'>bats(7)</li>
</ol>
<h2 id="NAME">NAME</h2>
<p class="man-name">
<code>bats</code> - <span class="man-whatis">Bats test file format</span>
</p>
<h2 id="SYNOPSIS">SYNOPSIS</h2>
<pre><code>load test_helper
setup() {
# set up your environment
# run before and after each test case
}
teardown() {
# clean up your environment
# run before and after each test case
}
code_outside_of_test_cases () {
# For example, check for dependencies
# and fail immediatelyif they're not present.
# Output must be redirected to `stderr` (`&gt;&amp;2`)
}
@test "test description" {
run foo arguments
[ "$status" -eq 1 ]
[ "$output" = "expected output" ]
}
@test "test description" {
run foo arguments
[ "$status" -eq 1 ]
[ "${lines[0]}" = "first line of expected output" ]
}
@test "A test I don't want to execute for now" {
skip "This command will return zero soon, but not now"
run foo
[ "$status" -eq 0 ]
}
@test "A test which should run" {
if [ foo != bar ]; then
skip "foo isn't bar"
fi
run foo
[ "$status" -eq 0 ]
}
</code></pre>
<h2 id="DESCRIPTION">DESCRIPTION</h2>
<p>A Bats test file is a Bash script with special syntax for defining
test cases. Under the hood, each test case is just a function with a
description.</p>
<pre><code>#!/usr/bin/env bats
@test "addition using bc" {
result="$(echo 2+2 | bc)"
[ "$result" -eq 4 ]
}
@test "addition using dc" {
result="$(echo 2 2+p | dc)"
[ "$result" -eq 4 ]
}
</code></pre>
<p>Each Bats test file is evaulated n+1 times, where <em>n</em> is the number of
test cases in the file. The first run counts the number of test cases,
then iterates over the test cases and executes each one in its own
process.</p>
<p>For details about exactly how Bats evaluates test files, see
Bats Evaluation Process:
https://github.com/sstephenson/bats/wiki/Bats-Evaluation-Process</p>
<h2 id="THE-_RUN_-HELPER">THE <code>_RUN_</code> HELPER</h2>
<p>Many Bats tests need to run a command and then make assertions about
its exit status and output. Bats includes a <code>run</code> helper that invokes
its arguments as a command, saves the exit status and output into
special global variables, and then returns with a <code>0</code> status code so
you can continue to make assertions in your test case.</p>
<p>For example, let's say you're testing that the <code>foo</code> command, when
passed a nonexistent filename, exits with a <code>1</code> status code and prints
an error message.</p>
<pre><code>@test "invoking foo with a nonexistent file prints an error" {
run foo nonexistent_filename
[ "$status" -eq 1 ]
[ "$output" = "foo: no such file 'nonexistent_filename'" ]
}
</code></pre>
<p>The <code>$status</code> variable contains the status code of the command, and
the <code>$output</code> variable contains the combined contents of the command's
standard output and standard error streams.</p>
<p>A third special variable, the <code>$lines</code> array, is available for easily
accessing individual lines of output. For example, if you want to test
that invoking <code>foo</code> without any arguments prints usage information on
the first line:</p>
<pre><code>@test "invoking foo without arguments prints usage" { run foo
[ "$status" -eq 1 ]
[ "${lines[0]}" = "usage: foo &lt;filename>" ]
}
</code></pre>
<h2 id="THE-_LOAD_-COMMAND">THE <code>_LOAD_</code> COMMAND</h2>
<p>You may want to share common code across multiple test files. Bats
includes a convenient <code>load</code> command for sourcing a Bash source file
relative to the location of the current test file. For example, if you
have a Bats test in <code>test/foo.bats</code>, the command</p>
<pre><code>load test_helper
</code></pre>
<p>will source the script <code>test/test_helper.bash</code> in your test file. This
can be useful for sharing functions to set up your environment or load
fixtures.</p>
<h2 id="THE-_SKIP_-COMMAND">THE <code>_SKIP_</code> COMMAND</h2>
<p>Tests can be skipped by using the <code>skip</code> command at the point in a
test you wish to skip.</p>
<pre><code>@test "A test I don't want to execute for now" {
skip
run foo
[ "$status" -eq 0 ]
}
</code></pre>
<p>Optionally, you may include a reason for skipping:</p>
<pre><code>@test "A test I don't want to execute for now" {
skip "This command will return zero soon, but not now"
run foo
[ "$status" -eq 0 ]
}
</code></pre>
<p>Or you can skip conditionally:</p>
<pre><code>@test "A test which should run" {
if [ foo != bar ]; then
skip "foo isn't bar"
fi
run foo
[ "$status" -eq 0 ]
}
</code></pre>
<h2 id="SETUP-AND-TEARDOWN-FUNCTIONS">SETUP AND TEARDOWN FUNCTIONS</h2>
<p>You can define special <code>setup</code> and <code>teardown</code> functions which run
before and after each test case, respectively. Use these to load
fixtures, set up your environment, and clean up when you're done.</p>
<h2 id="CODE-OUTSIDE-OF-TEST-CASES">CODE OUTSIDE OF TEST CASES</h2>
<p>You can include code in your test file outside of <code>@test</code> functions.
For example, this may be useful if you want to check for dependencies
and fail immediately if they're not present. However, any output that
you print in code outside of <code>@test</code>, <code>setup</code> or <code>teardown</code> functions
must be redirected to <code>stderr</code> (<code>&gt;&amp;2</code>). Otherwise, the output may
cause Bats to fail by polluting the TAP stream on <code>stdout</code>.</p>
<h2 id="SPECIAL-VARIABLES">SPECIAL VARIABLES</h2>
<p>There are several global variables you can use to introspect on Bats
tests:</p>
<ul>
<li><code>$BATS_TEST_FILENAME</code> is the fully expanded path to the Bats test
file.</li>
<li><code>$BATS_TEST_DIRNAME</code> is the directory in which the Bats test file is
located.</li>
<li><code>$BATS_TEST_NAMES</code> is an array of function names for each test case.</li>
<li><code>$BATS_TEST_NAME</code> is the name of the function containing the current
test case.</li>
<li><code>$BATS_TEST_DESCRIPTION</code> is the description of the current test
case.</li>
<li><code>$BATS_TEST_NUMBER</code> is the (1-based) index of the current test case
in the test file.</li>
<li><code>$BATS_TMPDIR</code> is the location to a directory that may be used to
store temporary files.</li>
</ul>
<h2 id="SEE-ALSO">SEE ALSO</h2>
<p><a class="man-ref" href="bats.1.html">bats<span class="s">(1)</span></a></p>
<ol class='man-decor man-foot man foot'>
<li class='tl'></li>
<li class='tc'>November 2013</li>
<li class='tr'>bats(7)</li>
</ol>
</div>
</body>
</html>

211
man/bats.7.ronn Normal file
View File

@ -0,0 +1,211 @@
bats(7) -- Bats test file format
================================
SYNOPSIS
--------
load test_helper
setup() {
# set up your environment
# run before and after each test case
}
teardown() {
# clean up your environment
# run before and after each test case
}
code_outside_of_test_cases () {
# For example, check for dependencies
# and fail immediatelyif they're not present.
# Output must be redirected to `stderr` (`>&2`)
}
@test "test description" {
run foo arguments
[ "$status" -eq 1 ]
[ "$output" = "expected output" ]
}
@test "test description" {
run foo arguments
[ "$status" -eq 1 ]
[ "${lines[0]}" = "first line of expected output" ]
}
@test "A test I don't want to execute for now" {
skip "This command will return zero soon, but not now"
run foo
[ "$status" -eq 0 ]
}
@test "A test which should run" {
if [ foo != bar ]; then
skip "foo isn't bar"
fi
run foo
[ "$status" -eq 0 ]
}
DESCRIPTION
-----------
A Bats test file is a Bash script with special syntax for defining
test cases. Under the hood, each test case is just a function with a
description.
#!/usr/bin/env bats
@test "addition using bc" {
result="$(echo 2+2 | bc)"
[ "$result" -eq 4 ]
}
@test "addition using dc" {
result="$(echo 2 2+p | dc)"
[ "$result" -eq 4 ]
}
Each Bats test file is evaulated n+1 times, where _n_ is the number of
test cases in the file. The first run counts the number of test cases,
then iterates over the test cases and executes each one in its own
process.
For details about exactly how Bats evaluates test files, see
Bats Evaluation Process:
https://github.com/sstephenson/bats/wiki/Bats-Evaluation-Process
THE `_RUN_` HELPER
------------------
Many Bats tests need to run a command and then make assertions about
its exit status and output. Bats includes a `run` helper that invokes
its arguments as a command, saves the exit status and output into
special global variables, and then returns with a `0` status code so
you can continue to make assertions in your test case.
For example, let's say you're testing that the `foo` command, when
passed a nonexistent filename, exits with a `1` status code and prints
an error message.
@test "invoking foo with a nonexistent file prints an error" {
run foo nonexistent_filename
[ "$status" -eq 1 ]
[ "$output" = "foo: no such file 'nonexistent_filename'" ]
}
The `$status` variable contains the status code of the command, and
the `$output` variable contains the combined contents of the command's
standard output and standard error streams.
A third special variable, the `$lines` array, is available for easily
accessing individual lines of output. For example, if you want to test
that invoking `foo` without any arguments prints usage information on
the first line:
@test "invoking foo without arguments prints usage" { run foo
[ "$status" -eq 1 ]
[ "${lines[0]}" = "usage: foo <filename>" ]
}
THE `_LOAD_` COMMAND
------------------
You may want to share common code across multiple test files. Bats
includes a convenient `load` command for sourcing a Bash source file
relative to the location of the current test file. For example, if you
have a Bats test in `test/foo.bats`, the command
load test_helper
will source the script `test/test_helper.bash` in your test file. This
can be useful for sharing functions to set up your environment or load
fixtures.
THE `_SKIP_` COMMAND
------------------
Tests can be skipped by using the `skip` command at the point in a
test you wish to skip.
@test "A test I don't want to execute for now" {
skip
run foo
[ "$status" -eq 0 ]
}
Optionally, you may include a reason for skipping:
@test "A test I don't want to execute for now" {
skip "This command will return zero soon, but not now"
run foo
[ "$status" -eq 0 ]
}
Or you can skip conditionally:
@test "A test which should run" {
if [ foo != bar ]; then
skip "foo isn't bar"
fi
run foo
[ "$status" -eq 0 ]
}
SETUP AND TEARDOWN FUNCTIONS
----------------------------
You can define special `setup` and `teardown` functions which run
before and after each test case, respectively. Use these to load
fixtures, set up your environment, and clean up when you're done.
CODE OUTSIDE OF TEST CASES
--------------------------
You can include code in your test file outside of `@test` functions.
For example, this may be useful if you want to check for dependencies
and fail immediately if they're not present. However, any output that
you print in code outside of `@test`, `setup` or `teardown` functions
must be redirected to `stderr` (`>&2`). Otherwise, the output may
cause Bats to fail by polluting the TAP stream on `stdout`.
SPECIAL VARIABLES
-----------------
There are several global variables you can use to introspect on Bats
tests:
* `$BATS_TEST_FILENAME` is the fully expanded path to the Bats test
file.
* `$BATS_TEST_DIRNAME` is the directory in which the Bats test file is
located.
* `$BATS_TEST_NAMES` is an array of function names for each test case.
* `$BATS_TEST_NAME` is the name of the function containing the current
test case.
* `$BATS_TEST_DESCRIPTION` is the description of the current test
case.
* `$BATS_TEST_NUMBER` is the (1-based) index of the current test case
in the test file.
* `$BATS_TMPDIR` is the location to a directory that may be used to
store temporary files.
SEE ALSO
--------
bats(1)

3
man/index.txt Normal file
View File

@ -0,0 +1,3 @@
# manuals
bats(1) bats.1.ronn
bats(7) bats.7.ronn