Skip to content

Commit 4cb2fe5

Browse files
author
Pascal Grange
committed
Improve setup_suite documentation
1 parent 6acb51b commit 4cb2fe5

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,9 @@ You may write a *teardown_suite* function that will be executed only once after
170170

171171
If you write code outside of any bash function, this code will be executed once at test file loading time since
172172
your file is a bash script and *bash_unit* sources it before running your tests. It is suggested to write a
173-
*setup_suite* function and avoid any code outside a bash function.
173+
*setup_suite* function and avoid any code outside a bash function. you must not use any bash_unit assertion
174+
in setup_suite or use exit in setup_suite for teardown_suite to be run.
175+
See https://github.com/pgrange/bash_unit/issues/43[issue 43] for more details.
174176

175177
If you want to keep an eye on a test not yet implemented, prefix the name of the function by *todo* instead of test.
176178
Test to do are not executed and do not impact the global status of your test suite but are displayed in *bash_unit* output.

0 commit comments

Comments
 (0)