bats poc

README.md

bats poc

resources

• bats-core:
  • https://advancedweb.hu/testing-bash-scripts-with-the-bats-testing-framework/
  • https://bats-core.readthedocs.io/en/latest/writing-tests.html
• pre-bats-core:
  • https://opensource.com/article/19/2/testing-bash-bats
  • https://medium.com/@pimterry/testing-your-shell-scripts-with-bats-abfca9bdc5b9
• TAP:
  • https://github.com/codewars/raku-tap2codewars

setup

mkdir bats
cd bats
git init
git submodule init
git submodule add https://github.com/bats-core/bats-core test/libs/bats
git submodule add https://github.com/ztombol/bats-assert test/libs/bats-assert
git submodule add https://github.com/ztombol/bats-support test/libs/bats-support
git add .
git commit -m 'installed bats'

tree

$ tree -L 2
.
├── greeter.sh
├── README.md
└── test
    ├── greeter.bats
    ├── test-helper.sh
    └── libs

2 directories, 4 files

TAP output

$ ./test/libs/bats/bin/bats -t test/greeter.bats
1..2
# [LOG] testing a debug log from the solution code
not ok 1 with name provided
# (from function `assert_output' in file test/libs/bats-assert/src/assert.bash, line 239,
#  in test file test/greeter.bats, line 24)
#   `assert_output "Hello, John!"' failed
# 
# -- output differs --
# expected : Hello, John!
# actual   : Hello, john!
# --
# 
# [LOG] testing a debug log from the solution code
# [LOG] testing log from within a test case
ok 2 without name provided

greeter.bats

#!/usr/bin/env ./libs/bats/bin/bats

load "libs/bats-support/load"
load "libs/bats-assert/load"
load "test-helper.sh"

#fixtures suite

#setup_file() {
#  echo "# setup file" >&3
#}
#setup() {
#  echo "# setup test" >&3
#}
#teardown() {
#  echo "# teardown test" >&3
#}
#teardown_file() {
#  echo "# teardown file" >&3
#}

@test "with name provided" {
  run bash greeter.sh greet john
  assert_output "Hello, John!"
}

@test "without name provided" {
  run bash greeter.sh greet
  debug "testing log from within a test case"
  assert_output "Hello there!"
}

greeter.sh

#!/usr/bin/env bash

greet() {
  debug "testing a debug log from the solution code"

  if [ -z $1 ]; then
    echo "Hello there!"
  else   
    echo "Hello, $1!"
  fi
}

"$@"

test-helper.sh

#!/usr/bin/env bash

debug() {
  # https://bats-core.readthedocs.io/en/latest/writing-tests.html#printing-to-the-terminal
  echo "# [LOG] ${*}" >&3
}

export -f debug