Write snippets of code in your documentation and execute them as regression tests.

View project on GitHub

Conditional Execution

byexample allows conditional execution of an example.

Consider the following real situation:

byexample supports the execution of shell commands using different shells: dash, ksh and bash.

To prove this I should write three examples, each using a different shell.

But what happen if the environment where byexample is running does not have one of the shells?

Failing is not fun. Forcing the user to install all the shells just to run the documentation/test is not fun either.

To address this, byexample allows you to check if a condition matches before executing an example.

First, we test if a given shell exists and we capture the output:

$ hash ksh 2>/dev/null && echo "installed"

If the ksh shell is installed in the system, the <ksh-installed> tag will contain the non-empty string installed. If not, it will be empty.

Then we can write the conditional example:

$ byexample -l shell -o '+shell=ksh' test/ds/shell-example  # byexample: +if=ksh-installed
[PASS] Pass: 14 Fail: 0 Skip: 0

The +if option receives the name of a tag: if this capture tag is empty, the example is skipped, otherwise it is executed as usual.

The +on is an alias of +if; +unless works the same way but it negates the condition.

$ echo non-empty-string

$ echo executed         # byexample: +if=good

$ echo executed         # byexample: +on=good

$ echo not-executed     # byexample: +unless=good

New in byexample 8.1.0. This feature is marked as experimental.