2
1
mirror of https://github.com/kdabir/has.git synced 2024-11-10 21:26:50 +01:00

🎨 follow Bats coding style for tests

- [x] renamed working directory variable to `HAS_TMPDIR`
- [x] explicitly calling has binary
- [x] Only using `[[ ]]` for regex matches
This commit is contained in:
Virgil 2019-05-21 07:00:23 +10:00
parent 1f7dd61324
commit 0e92f29a24

View File

@ -1,26 +1,35 @@
#!/usr/bin/env bats #!/usr/bin/env bats
INSTALL_DIR= INSTALL_DIR=
BATS_TMPDIR=${BATS_TMPDIR:-/tmp} BATS_TMPDIR="${BATS_TMPDIR:-/tmp}"
fancyx='✗' fancyx='✗'
checkmark='✓' checkmark='✓'
## We need to create a new directory so that .hasrc file in the root does not get read by the `has` instance under test ## We need to create a new directory so that .hasrc file in the root does not get read by the `has` instance under test
setup() { setup() {
export BATS_TEST_TMPDIR="$BATS_TMPDIR/tmp-for-test" export HAS_TMPDIR="${BATS_TMPDIR}/tmp-for-test"
mkdir -p "$BATS_TEST_TMPDIR" mkdir -p "${HAS_TMPDIR}"
cp -f has "$BATS_TEST_TMPDIR" cp -f "${BATS_TEST_DIRNAME}"/has "${HAS_TMPDIR}"
cd "$BATS_TEST_TMPDIR" cd "${HAS_TMPDIR}" || return
export has="${HAS_TMPDIR}/has"
} }
teardown() { teardown() {
if [[ -n "$BATS_TEST_TMPDIR" ]]; then if [[ -d "${HAS_TMPDIR}" ]]; then
rm -rf "$BATS_TEST_TMPDIR" rm -rf "${HAS_TMPDIR}"
fi fi
} }
@test "invoking 'has' without arguments prints usage" {
run $has
[ "$status" -eq 0 ]
[ "${lines[0]%% *}" = 'has' ]
[ "${lines[1]%%:*}" = 'USAGE' ]
[ "${lines[2]}" = 'EXAMPLE: has git curl node' ]
}
@test "make install creates a valid installation" { @test "make install creates a valid installation" {
INSTALL_DIR="${BATS_TEST_TMPDIR}/.local" INSTALL_DIR="${HAS_TMPDIR}/.local"
cd "${BATS_TEST_DIRNAME}" cd "${BATS_TEST_DIRNAME}"
run make PREFIX="${INSTALL_DIR}" install run make PREFIX="${INSTALL_DIR}" install
[ "$status" -eq 0 ] [ "$status" -eq 0 ]
@ -30,13 +39,14 @@ teardown() {
cd "${INSTALL_DIR}" cd "${INSTALL_DIR}"
run "${INSTALL_DIR}/bin/has" run "${INSTALL_DIR}/bin/has"
[ "$status" -eq 0 ] [ "$status" -eq 0 ]
[ "${lines[0]%% *}" == 'has' ] [ "${lines[0]%% *}" = 'has' ]
[ "${lines[1]%%:*}" == 'USAGE' ] [ "${lines[1]%%:*}" = 'USAGE' ]
rm -rf ${INSTALL_DIR} [ "${lines[2]}" = 'EXAMPLE: has git curl node' ]
# [ "${lines[2]%%:*}" = 'EXAMPLE' ]
} }
@test "..even if 'has' is missing from directory" { @test "..even if 'has' is missing from directory" {
INSTALL_DIR="${BATS_TEST_TMPDIR}/system_local" INSTALL_DIR="${HAS_TMPDIR}/system_local"
cd "${BATS_TEST_DIRNAME}" cd "${BATS_TEST_DIRNAME}"
mv has has-been mv has has-been
run make PREFIX="${INSTALL_DIR}" install run make PREFIX="${INSTALL_DIR}" install
@ -44,102 +54,91 @@ teardown() {
[ -x "${INSTALL_DIR}/bin/has" ] [ -x "${INSTALL_DIR}/bin/has" ]
cd "${BATS_TEST_DIRNAME}" cd "${BATS_TEST_DIRNAME}"
mv has-been has mv has-been has
rm -rf ${INSTALL_DIR}
} }
@test "make update runs git fetch" { @test "make update runs git fetch" {
cd "${BATS_TEST_DIRNAME}" cd "${BATS_TEST_DIRNAME}"
skip "make update overwrites my changes"
run make update run make update
[[ "$status" -eq 0 ]] [ "$status" -eq 0 ]
[[ "${lines[@]}" =~ "git fetch --verbose" ]] [ "${lines[*]}" =~ "git fetch --verbose" ]
}
@test "has prints help" {
run bash has
[[ "$(echo "${output}" | grep "has")" ]]
[[ "$(echo "${output}" | grep "USAGE:")" ]]
[[ "$(echo "${output}" | grep "EXAMPLE:")" ]]
} }
@test "works with single command check" { @test "works with single command check" {
run bash has git run $has git
[[ "$status" -eq 0 ]] [ "$status" -eq 0 ]
[[ "$(echo "${output}" | grep ${checkmark} | grep "git")" ]] [ "$(echo "${lines[0]}" | grep "git")" ]
} }
@test "safely tells about tools not configured" { @test "'has' warns about tools not configured" {
run bash has foobar run $has foobar
[[ "$status" -eq 1 ]] [ "$status" -eq 1 ]
[[ "$(echo "${output}" | grep ${fancyx} | grep "foobar not understood")" ]] [ "$(echo "${output}" | grep ${fancyx} | grep "foobar not understood")" ]
} }
@test "env var lets override safety check" { @test "env var 'HAS_ALLOW_UNSAFE' overrides safety check" {
HAS_ALLOW_UNSAFE=y run bash has foobar HAS_ALLOW_UNSAFE=y run $has foobar
[[ "$status" -eq 1 ]] [ "$status" -eq 1 ]
[[ "$(echo "${output}" | grep ${fancyx} | grep "foobar")" ]] [ "$(echo "${output}" | grep ${fancyx} | grep "foobar")" ]
} }
@test "status code reflects number of failed commands" { @test "status code reflects number of failed commands" {
HAS_ALLOW_UNSAFE=y run bash has foobar bc git barbaz HAS_ALLOW_UNSAFE=y run $has foobar bc git barbaz
[[ "$status" -eq 2 ]] [ "$status" -eq 2 ]
[[ "$(echo "${output}" | grep ${fancyx} | grep "foobar")" ]] [ "$(echo "${output}" | grep ${fancyx} | grep "foobar")" ]
[[ "$(echo "${output}" | grep ${fancyx} | grep "barbaz")" ]] [ "$(echo "${output}" | grep ${fancyx} | grep "barbaz")" ]
} }
@test "status code reflects number of failed commands up to 126" { @test "status code reflects number of failed commands up to 126" {
run bash has $(for i in {1..256}; do echo foo; done) run $has $(for i in {1..256}; do echo foo; done)
[[ "$status" -eq 126 ]] [ "$status" -eq 126 ]
} }
@test "loads commands from .hasrc file and excludes comments" { @test "loads commands from .hasrc file and excludes comments" {
printf "bash\n#comment\nmake\n" >> .hasrc printf "bash\n#comment\nmake\n" >> .hasrc
run bash has run $has
[[ "$status" -eq 0 ]] [ "$status" -eq 0 ]
[ "$(echo "${output}" | grep ${checkmark} | grep "bash")" ]
[[ "$(echo "${output}" | grep ${checkmark} | grep "bash")" ]] [ "$(echo "${output}" | grep ${checkmark} | grep "make")" ]
[[ "$(echo "${output}" | grep ${checkmark} | grep "make")" ]]
} }
@test "loads commands from .hasrc file and honors CLI args as well" { @test "loads commands from .hasrc file and honors CLI args as well" {
printf "bash\nmake\ngit" >> .hasrc printf "bash\nmake\ngit" >> .hasrc
HAS_ALLOW_UNSAFE=y run bash has git bc HAS_ALLOW_UNSAFE=y run $has git bc
[[ "$status" -eq 0 ]] [ "$status" -eq 0 ]
[ "$(echo "${output}" | grep ${checkmark} | grep "bash")" ]
[[ "$(echo "${output}" | grep ${checkmark} | grep "bash")" ]] [ "$(echo "${output}" | grep ${checkmark} | grep "make")" ]
[[ "$(echo "${output}" | grep ${checkmark} | grep "make")" ]] [ "$(echo "${output}" | grep ${checkmark} | grep "git")" ]
[[ "$(echo "${output}" | grep ${checkmark} | grep "git")" ]] [ "$(echo "${output}" | grep ${checkmark} | grep "bc")" ]
[[ "$(echo "${output}" | grep ${checkmark} | grep "bc")" ]]
} }
@test "testing PASS output with unicode" { @test "testing PASS output with unicode" {
run bash has git run $has git
[[ "$status" -eq 0 ]] [ "$status" -eq 0 ]
[[ "printf '%b\n' ${lines[0]}" =~ '✓' ]] [[ "printf '%b\n' ${lines[0]}" =~ '✓' ]]
} }
@test "testing FAIL output with unicode" { @test "testing FAIL output with unicode" {
run bash has foobar run $has foobar
[[ "$status" -eq 1 ]] [ "$status" -eq 1 ]
[[ "printf '%b\n' ${lines[0]}" =~ '✗' ]] [[ "printf '%b\n' ${lines[0]}" =~ '✗' ]]
} }
@test "fail count 3: testing output with and without unicode" { @test "fail count 3: testing output with and without unicode" {
run bash has git foobar barbaz barfoo run $has git foobar barbaz barfoo
[[ "$status" -eq 3 ]] [ "$status" -eq 3 ]
[[ "printf '%b\n' ${lines[0]}" =~ "${checkmark}" ]] [[ "printf '%b\n' ${lines[0]}" =~ "${checkmark}" ]]
[[ "printf '%b\n' ${lines[2]}" =~ '✗' ]] [[ "printf '%b\n' ${lines[2]}" =~ '✗' ]]
} }