kcov: Add final test cases

The `kcov` lib is now completely covered. In the future, I'll try to extract it
into a plugin and support non-Ubuntu/Debian platforms.

Author: mbland

scripts/lib/kcov

@@ -54,7 +54,7 @@ run_kcov() {
       @go.printf 'Coverage results sent to:\n  %s\n' "$coveralls_url"
     fi
   else
-    @go.printf 'kcov exited with errors\n'
+    @go.printf 'kcov exited with errors.\n'
     return 1
   fi
 }

tests/kcov.bats

@@ -5,6 +5,23 @@ load assertions
 load script_helper
 
 FAKE_BIN_DIR="$TEST_GO_ROOTDIR/fake-bin"
+KCOV_DIR='tests/kcov'
+KCOV_COVERAGE_DIR='tests/coverage'
+KCOV_INCLUDE_PATTERNS='include/,pattern'
+KCOV_EXCLUDE_PATTERNS='exclude/,pattern'
+KCOV_COVERALLS_URL='https://coveralls.io/github/mbland/go-script-bash'
+RUN_KCOV_ARGV=(
+  "$KCOV_DIR"
+  "$KCOV_COVERAGE_DIR"
+  "$KCOV_INCLUDE_PATTERNS"
+  "$KCOV_EXCLUDE_PATTERNS"
+  "$KCOV_COVERALLS_URL")
+KCOV_PATH="$KCOV_DIR/src/kcov"
+KCOV_ARGV_START=(
+  "$KCOV_PATH"
+  "--include-pattern=$KCOV_INCLUDE_PATTERNS"
+  "--exclude-pattern=$KCOV_EXCLUDE_PATTERNS"
+)
 
 setup() {
   local fake_binaries=(
@@ -37,6 +54,13 @@ write_kcov_go_script() {
   create_test_go_script "${go_script[@]}"
 }
 
+write_kcov_dummy() {
+  local kcov_dummy="$TEST_GO_ROOTDIR/$KCOV_PATH"
+  mkdir -p "${kcov_dummy%/*}"
+  printf "#! /usr/bin/env bash\n%s\n" "$*" >"$kcov_dummy"
+  chmod 700 "$kcov_dummy"
+}
+
 @test "$SUITE: check dev packages installed" {
   write_kcov_go_script check_kcov_dev_packages_installed
   run "$TEST_GO_SCRIPT"
@@ -158,3 +182,125 @@ write_kcov_go_script() {
   run env TRAVIS_OS_NAME='linux' "$TEST_GO_SCRIPT"
   assert_success 'Building kcov...'
 }
+
+@test "$SUITE: fail to run kcov on non-Linux/apt-get platforms" {
+  # Force the script not to find `apt-get` by forcing an empty `PATH`.
+  write_kcov_go_script "PATH=; run_kcov ${RUN_KCOV_ARGV[*]}"
+  run "$TEST_GO_SCRIPT"
+  assert_failure 'Coverage is only available on Linux platforms with apt-get.'
+}
+
+@test "$SUITE: fail to run kcov if coverage dir already exists" {
+  mkdir -p "$TEST_GO_ROOTDIR/$KCOV_COVERAGE_DIR"
+  write_kcov_go_script "run_kcov ${RUN_KCOV_ARGV[*]}"
+
+  run "$TEST_GO_SCRIPT"
+  local expected=("The $KCOV_COVERAGE_DIR directory already exists."
+    'Please move or remove this directory first.')
+  assert_failure "${expected[*]}"
+}
+
+@test "$SUITE: fail to run kcov if not present and can't be built" {
+  write_kcov_go_script 'clone_and_build_kcov() { echo "KCOV: $*"; return 1; }' \
+    "run_kcov ${RUN_KCOV_ARGV[*]}"
+  run "$TEST_GO_SCRIPT"
+  assert_failure "KCOV: $KCOV_DIR"
+}
+
+@test "$SUITE: success when kcov already built" {
+  write_kcov_dummy "IFS=\$'\\n'; echo \"\$*\""
+  write_kcov_go_script "run_kcov ${RUN_KCOV_ARGV[*]} foo bar/baz"
+
+  local kcov_argv=("${KCOV_ARGV_START[@]}" "$KCOV_COVERAGE_DIR"
+    "$TEST_GO_SCRIPT" 'test' 'foo' 'bar/baz')
+  local expected_output=(
+    'Starting coverage run:'
+    "  ${kcov_argv[*]}"
+    "${kcov_argv[@]:1}"
+    'Coverage results located in:'
+    "  $TEST_GO_ROOTDIR/$KCOV_COVERAGE_DIR")
+  local IFS=$'\n'
+
+  run env TRAVIS_JOB_ID= "$TEST_GO_SCRIPT"
+  assert_success "${expected_output[*]}"
+}
+
+@test "$SUITE: success after building kcov" {
+  local go_script=(
+    'clone_and_build_kcov() {'
+    "  mkdir -p '${KCOV_PATH%/*}'"
+    "  printf '#! /usr/bin/env bash\n' >'$KCOV_PATH'"
+    "  chmod 700 '$KCOV_PATH'"
+    '}'
+    "run_kcov ${RUN_KCOV_ARGV[*]} foo bar/baz")
+  write_kcov_go_script "${go_script[@]}"
+
+  local kcov_argv=("${KCOV_ARGV_START[@]}" "$KCOV_COVERAGE_DIR"
+    "$TEST_GO_SCRIPT" 'test' 'foo' 'bar/baz')
+  local expected_output=(
+    'Starting coverage run:'
+    "  ${kcov_argv[*]}"
+    'Coverage results located in:'
+    "  $TEST_GO_ROOTDIR/$KCOV_COVERAGE_DIR")
+  local IFS=$'\n'
+
+  run env TRAVIS_JOB_ID= "$TEST_GO_SCRIPT"
+  assert_success "${expected_output[*]}"
+}
+
+@test "$SUITE: failure if kcov returns an error status" {
+  write_kcov_dummy "printf 'Oh noes!\n' >&2; exit 1"
+  write_kcov_go_script "run_kcov ${RUN_KCOV_ARGV[*]} foo bar/baz"
+
+  local kcov_argv=("${KCOV_ARGV_START[@]}" "$KCOV_COVERAGE_DIR"
+    "$TEST_GO_SCRIPT" 'test' 'foo' 'bar/baz')
+  local expected_output=(
+    'Starting coverage run:'
+    "  ${kcov_argv[*]}"
+    'kcov exited with errors.')
+  local IFS=$'\n'
+
+  run env TRAVIS_JOB_ID= "$TEST_GO_SCRIPT"
+  assert_failure "${expected_output[*]}"
+}
+
+@test "$SUITE: send results to Coveralls when running on Travis" {
+  write_kcov_dummy
+  write_kcov_go_script "run_kcov ${RUN_KCOV_ARGV[*]} foo bar/baz"
+
+  local kcov_argv=("${KCOV_ARGV_START[@]}"
+    "--coveralls-id=666" "$KCOV_COVERAGE_DIR"
+    "$TEST_GO_SCRIPT" 'test' 'foo' 'bar/baz')
+  local expected_output=(
+    'Starting coverage run:'
+    "  ${kcov_argv[*]}"
+    'Coverage results sent to:'
+    "  $KCOV_COVERALLS_URL")
+  local IFS=$'\n'
+
+  run env TRAVIS_JOB_ID=666 "$TEST_GO_SCRIPT"
+  assert_success "${expected_output[*]}"
+}
+
+@test "$SUITE: don't send to Coveralls when URL is missing" {
+  local run_kcov_argv=(
+    "$KCOV_DIR"
+    "$KCOV_COVERAGE_DIR"
+    "$KCOV_INCLUDE_PATTERNS"
+    "$KCOV_EXCLUDE_PATTERNS")
+  write_kcov_dummy
+  # Note that the coveage_url argument is the empty string.
+  write_kcov_go_script "run_kcov ${run_kcov_argv[*]} '' foo bar/baz"
+
+  local kcov_argv=("${KCOV_ARGV_START[@]}" "$KCOV_COVERAGE_DIR"
+    "$TEST_GO_SCRIPT" 'test' 'foo' 'bar/baz')
+  local expected_output=(
+    'Starting coverage run:'
+    "  ${kcov_argv[*]}"
+    'Coverage results located in:'
+    "  $TEST_GO_ROOTDIR/$KCOV_COVERAGE_DIR")
+  local IFS=$'\n'
+
+  run env TRAVIS_JOB_ID=666 "$TEST_GO_SCRIPT"
+  assert_success "${expected_output[*]}"
+}