shell-scripting-templates/test/baseHelpers.bats

#!/usr/bin/env bats
#shellcheck disable

load 'test_helper/bats-support/load'
load 'test_helper/bats-file/load'
load 'test_helper/bats-assert/load'

######## SETUP TESTS ########
ROOTDIR="$(git rev-parse --show-toplevel)"
SOURCEFILE="${ROOTDIR}/utilities/baseHelpers.bash"
ALERTS="${ROOTDIR}/utilities/alerts.bash"

if test -f "${SOURCEFILE}" >&2; then
  source "${SOURCEFILE}"
else
  echo "Sourcefile not found: ${SOURCEFILE}" >&2
  printf "Can not run tests.\n" >&2
  exit 1
fi

if test -f "${ALERTS}" >&2; then
  source "${ALERTS}"
else
  echo "Sourcefile not found: ${ALERTS}" >&2
  printf "Can not run tests.\n" >&2
  exit 1
fi

setup() {

  TESTDIR="$(temp_make)"
  curPath="${PWD}"

  BATSLIB_FILE_PATH_REM="#${TEST_TEMP_DIR}"
  BATSLIB_FILE_PATH_ADD='<temp>'

  pushd "${TESTDIR}" >&2

  ######## DEFAULT FLAGS ########
  LOGFILE="${TESTDIR}/logs/log.txt"
  QUIET=false
  LOGLEVEL=ERROR
  VERBOSE=false
  FORCE=false
  DRYRUN=false
}

teardown() {
  popd >&2
  temp_del "${TESTDIR}"
}

######## RUN TESTS ########
@test "Sanity..." {
  run true

  assert_success
  assert_output ""
}

_testCheckBinary_() {
  @test "_checkBinary_: true" {
    run _checkBinary_ "vi"
    assert_success
  }

  @test "_checkBinary_: false" {
    run _checkBinary_ "someNonexistantBinary"
    assert_failure
  }
}

_testExecute_() {
  @test "_execute_: Debug command" {
    DRYRUN=true
    run _execute_ "rm testfile.txt"
    assert_success
    assert_output --partial "[ dryrun] rm testfile.txt"
  }

  @test "_execute_: No command" {
    run _execute_

    assert_failure
    assert_output --regexp "_execute_ needs a command$"
  }

  @test "_execute_: Bad command" {
    run _execute_ "rm nonexistant.txt"

    assert_failure
    assert_output --partial "[warning] rm nonexistant.txt"
  }

  @test "_execute_ -e: Bad command" {
    run _execute_ -e "rm nonexistant.txt"

    assert_failure
    assert_output "error: rm nonexistant.txt"
  }

  @test "_execute_ -p: Return 0 on bad command" {
    run _execute_ -p "rm nonexistant.txt"
    assert_success
    assert_output --partial "[warning] rm nonexistant.txt"
  }

  @test "_execute_: Good command" {
    touch "testfile.txt"
    run _execute_ "rm testfile.txt"
    assert_success
    assert_output --partial "[   info] rm testfile.txt"
    assert_file_not_exist "testfile.txt"
  }

  @test "_execute_: Good command - no output" {
    touch "testfile.txt"
    run _execute_ -q "rm testfile.txt"
    assert_success
    refute_output --partial "[   info] rm testfile.txt"
    assert_file_not_exist "testfile.txt"
  }

  @test "_execute_ -s: Good command" {
    touch "testfile.txt"
    run _execute_ -s "rm testfile.txt"
    assert_success
    assert_output --partial "[success] rm testfile.txt"
    assert_file_not_exist "testfile.txt"
  }

  @test "_execute_ -v: Good command" {
    touch "testfile.txt"
    run _execute_ -v "rm -v testfile.txt"

    assert_success
    assert_line --index 0 "removed 'testfile.txt'"
    assert_line --index 1 --partial "[   info] rm -v testfile.txt"
    assert_file_not_exist "testfile.txt"
  }

  @test "_execute_ -ev: Good command" {
    touch "testfile.txt"
    run _execute_ -ve "rm -v testfile.txt"

    assert_success
    assert_line --index 0 "removed 'testfile.txt'"
    assert_line --index 1 --partial "rm -v testfile.txt"
    assert_file_not_exist "testfile.txt"
  }
}

_testFindBaseDirectory_() {
  @test "_findBaseDir_" {
    run _findBaseDir_
    assert_output --regexp "^/usr/local/Cellar/bats-core/[0-9]\.[0-9]\.[0-9]"
  }
}

_testHaveFunction_() {

  @test "_haveFunction_: Success" {
    run _haveFunction_ "_haveFunction_"

    assert_success
  }

  @test "_haveFunction_: Failure" {
    run _haveFunction_ "_someUndefinedFunction_"

    assert_failure
  }
}

_testProgressBar_() {
  @test "_progressBar_: verbose" {
    verbose=true
    run _progressBar_ 100

    assert_success
    assert_output ""
    verbose=false
  }

  @test "_progressBar_: quiet" {
    quiet=true
    run _progressBar_ 100

    assert_success
    assert_output ""
    quiet=false
  }
}

_testSeekConfirmation_() {
  @test "_seekConfirmation_: yes" {
    run _seekConfirmation_ 'test' <<<"y"

    assert_success
    assert_output --partial "[  input] test"
  }

  @test "_seekConfirmation_: no" {
    run _seekConfirmation_ 'test' <<<"n"

    assert_failure
    assert_output --partial "[  input] test"
  }

  @test "_seekConfirmation_: Force" {
    FORCE=true

    run _seekConfirmation_ "test"
    assert_success
    assert_output --partial "test"
  }

  @test "_seekConfirmation_: Quiet" {
    QUIET=true
    run _seekConfirmation_ 'test' <<<"y"

    assert_success
    refute_output --partial "test"

    quiet=false
  }
}

_testSetPATH_() {
  @test "_setPATH_" {
    _setPATH_ "/testing/from/bats" "/testing/again"
    run echo "$PATH"
    assert_output --regexp "/testing/from/bats"
    assert_output --regexp "/testing/again"
  }
}

_testCheckBinary_
_testExecute_
_testFindBaseDirectory_
_testHaveFunction_
_testProgressBar_
_testSeekConfirmation_
_testSetPATH_