When call <FUNCTION> [ARGUMENTS...]

When run <FUNCTION | COMMAND> [ARGUMENTS...]

When run command <COMMAND> [ARGUMENTS...]

When run script <SCRIPT> [ARGUMENTS...]

When run source <SCRIPT> [ARGUMENTS...]

The [MODIFIER of...] <SUBJECT> should <MATCHER>
The [MODIFIER of...] <SUBJECT> should not <MATCHER>

Assert <FUNCTION> [ARGUMENTS...]

The stdout should equal "foo"
The output should equal "foo"

The stderr should equal "foo"
The error should equal "foo"

The status should be success

The line 1 of stdout should equal foo
The line 1 should equal foo # stdout omitted

The word 1 of stdout should equal foo
The word 1 should equal foo # stdout omitted

Path data-file=/tmp/data.txt
The path data-file should exist

The result of function foo should be successful
The result of "foo()" should be successful # shorthand

The value "foo" should equal "foo"

The variable var should equal "foo"

The line 1 of stdout should equal "line1"

The lines of stdout should equal 5

The word 2 of stdout should equal "word2"

The length of value "abcd" should equal 5

The contents of file "/tmp/file.txt" should equal "temp data"

get_version() {
  # The result of the evaluation is passed as arguments
  # $1: stdout, $2: stderr, $3: status
  echo "$1" | grep -o '[0-9.]*' | head -1
}

When call echo "GNU bash, version 4.4.20(1)-release (x86_64-pc-linux-gnu)"
The result of function get_version should equal "4.4.20"
The result of "get_version()" should equal "4.4.20" # shorthand

check_version() {
  # The result of the evaluation is passed as arguments
  # $1: stdout, $2: stderr, $3: status
  [ "$("$1" | grep -o '[0-9.]*' | head -1)" = "4.4.20" ]
}

When call echo "GNU bash, version 4.4.20(1)-release (x86_64-pc-linux-gnu)"
The result of function check_version should be successful
The result of "check_version()" should be successful # shorthand

satisfy <FUNCTION> [ARGUMENTS...]

value() {
  # The subject is stored in the same variable name as the function name
  test "${value:?}" "$1" "$2"
}

formula() {
  value=${formula:?}
  [ $(($1)) -eq 1 ]
}

When call echo "50"
The output should satisfy value -gt 10
The output should satisfy formula "10 <= value && value <= 100"

The path /target/path should exist

The path /target/path should be exist

The path /target/path should be file

The path /target/path should be directory
The path /target/path should be dir

The path /target/path should be empty file

The path /target/path should be empty directory
The path /target/path should be empty dir

The path /target/path should be symlink

The path /target/path should be pipe

The path /target/path should be socket

The path /target/path should be readable

The path /target/path should be writable

The path /target/path should be executable

The path /target/path should be block_device

The path /target/path should be character_device

The path /target/path should have setgid

The path /target/path should have setuid

The status should be success

The status should be failure

The output should equal <STRING>
The output should eq <STRING>

The output should start with <STRING>

The output should end with <STRING>

The output should include <STRING>

The output should match pattern <PATTERN>

The variable VAR should be defined

The variable VAR should be undefined

The variable VAR should be present

The variable VAR should be blank

The variable VAR should be exported

The variable VAR should be readonly

Data | tr 'abc' 'ABC' # comment
#|aaa
#|bbb
#|ccc
End

Describe 'Data helper'
  Example 'provide with Data helper block style'
    Data
      #|item1 123
      #|item2 456
      #|item3 789
    End
    When call awk '{total+=$2} END{print total}'
    The output should eq 1368
  End
End

Describe 'example'
  Parameters
    "#1" 1 2 3
    "#2" 1 2 3
  End

  Example "example $1"
    When call echo "$(($2 + $3))"
    The output should eq "$4"
  End
End

Parameters:value foo bar baz

Parameters:matrix
  foo bar
  1 2

  # expanded as follows
  #   foo 1
  #   foo 2
  #   bar 1
  #   bar 2
End

Parameters:dynamic
  for i in 1 2 3; do
    %data "#$i" 1 2 3
  done
End

% <VERNAME>: "<VALUE>"