Merge pull request #157 from mbland/improvements

Small improvements, add `@go.test_compgen`, make `cmd-desc/from-file` test faster

Author: mbland

.gitignore

@@ -1,5 +1,5 @@
-.*.swp
-.DS_Store
+# Are your editor's temp files, OS metadata files, etc. showing up in `git
+# status`? Try adding them to `$HOME/.config/git/ignore` instead.
 tests/bats/
 tests/coverage/
 tests/kcov/

go-core.bash

@@ -112,6 +112,9 @@ declare _GO_IMPORTED_MODULE_CALLERS=()
 # Path to the project's script directory
 declare _GO_SCRIPTS_DIR=
 
+# Directory containing Bats tests, relative to `_GO_ROOTDIR`
+declare -r -x _GO_TEST_DIR="${_GO_TEST_DIR:-tests}"
+
 # Path to the main ./go script in the project's root directory
 declare -r -x _GO_SCRIPT="$_GO_ROOTDIR/${0##*/}"
 

lib/bats-main

@@ -40,9 +40,6 @@
 # make the Bats repository a submodule if so desired. The Bats version so cloned
 # may be set by overriding `_GO_BATS_VERSION`.
 
-# Directory containing Bats tests, relative to `_GO_ROOTDIR`
-export _GO_TEST_DIR="${_GO_TEST_DIR:-tests}"
-
 # Directory in which kcov will be built
 export _GO_KCOV_DIR="${_GO_KCOV_DIR:-$_GO_TEST_DIR/kcov}"
 

lib/complete

@@ -15,7 +15,7 @@
 # `-f` or `-d` options to generate file or directory paths.
 #
 # Arguments:
-#   ...:  Arguments passed directly ot the builtin `compgen`
+#   ...:  Arguments passed directly to the builtin `compgen`
 @go.compgen() {
   local add_slashes
   local compreply=()

lib/testing/environment

@@ -108,3 +108,19 @@ test-go() {
     @go.create_test_command_script "$parent.d/$subcommand"
   done
 }
+
+# Assigns the results of `@go.compgen` to a caller-defined test data array
+#
+# While more compact than writing a `while` loop by hand, it's also faster
+# thanks to the fact that it disables the Bats function tracing mechanism.
+#
+# Arguments:
+#   result:  Name of the caller-declared output array
+#   ...:     Arguments passed directly to `@go.compgen`
+@go.test_compgen() {
+  . "$_GO_CORE_DIR/lib/bats/assertions"
+  set "$BATS_ASSERTION_DISABLE_SHELL_OPTIONS"
+  . "$_GO_USE_MODULES" 'complete' 'strings'
+  @go.split $'\n' "$(@go.compgen "${@:2}")" "$1"
+  return_from_bats_assertion
+}

lib/testing/stack-trace-item

@@ -5,8 +5,6 @@
 # DO NOT USE THIS FILE DIRECTLY! Source `_GO_CORE_DIR/lib/testing/stack-trace`
 # and use the `stack_trace_item` function instead.
 
-. "$_GO_CORE_DIR/lib/bats/helpers"
-
 __@go.stack_trace_item() {
   local filepath="$1"
   local function_name="$2"

scripts/test

@@ -26,7 +26,8 @@
 # Passes all arguments through to `@go.bats_main` from `lib/bats-main`.
 _test_main() {
   local _GO_BATS_COVERAGE_INCLUDE
-  _GO_BATS_COVERAGE_INCLUDE=('go' 'go-core.bash' 'lib/' 'libexec/' 'scripts/')
+  _GO_BATS_COVERAGE_INCLUDE=('go' 'go-core.bash' 'go-template'
+    'lib/' 'libexec/' 'scripts/')
   local _GO_COVERALLS_URL='https://coveralls.io/github/mbland/go-script-bash'
 
   . "$_GO_USE_MODULES" 'bats-main'

tests/command-descriptions/from-file.bats

@@ -5,8 +5,18 @@ load ../environment
 TEST_COMMAND_SCRIPT_PATH="$TEST_GO_SCRIPTS_DIR/test-command"
 
 setup() {
-  . 'lib/internal/command_descriptions'
+  test_filter
+
+  @go.create_test_go_script \
+    ". '$_GO_CORE_DIR/lib/internal/command_descriptions'" \
+    'declare __go_cmd_desc=""' \
+    '"$@"' \
+    'declare result="$?"' \
+    'printf "%s\n" "$__go_cmd_desc"' \
+    'exit "$result"'
+}
 
+create_script_with_description() {
   local script='#
 # Command that does something in {{root}}
 #
@@ -51,14 +61,14 @@ teardown() {
 
 @test "$SUITE: return error if there's an error reading" {
   skip_if_cannot_trigger_file_permission_failure
+  printf '\n' >"$TEST_COMMAND_SCRIPT_PATH"
   chmod ugo-r "$TEST_COMMAND_SCRIPT_PATH"
 
-  run _@go.command_summary "$TEST_COMMAND_SCRIPT_PATH"
+  run "$TEST_GO_SCRIPT" _@go.command_summary "$TEST_COMMAND_SCRIPT_PATH"
   assert_failure
   assert_output_matches "ERROR: problem reading $TEST_COMMAND_SCRIPT_PATH\$"
 
-  output=''
-  run _@go.command_description "$TEST_COMMAND_SCRIPT_PATH"
+  run "$TEST_GO_SCRIPT" _@go.command_description "$TEST_COMMAND_SCRIPT_PATH"
   assert_failure
   assert_output_matches "ERROR: problem reading $TEST_COMMAND_SCRIPT_PATH\$"
 }
@@ -67,39 +77,32 @@ teardown() {
   @go.create_test_command_script 'test-command' \
     'echo "This script has no description"'
 
-  local __go_cmd_desc=''
-  _@go.command_summary "$TEST_COMMAND_SCRIPT_PATH"
-  assert_equal 'No description available' "$__go_cmd_desc" 'command summary'
+  run "$TEST_GO_SCRIPT" _@go.command_summary "$TEST_COMMAND_SCRIPT_PATH"
+  assert_success 'No description available'
 
   __go_cmd_desc=''
-  _@go.command_description "$TEST_COMMAND_SCRIPT_PATH"
-  assert_equal 'No description available' "$__go_cmd_desc" 'command description'
+  run "$TEST_GO_SCRIPT" _@go.command_description "$TEST_COMMAND_SCRIPT_PATH"
+  assert_success 'No description available'
 }
 
 @test "$SUITE: parse summary from command script" {
-  _GO_ROOTDIR='/foo/bar'
-  _@go.command_summary "$TEST_COMMAND_SCRIPT_PATH"
-  assert_equal 'Command that does something in /foo/bar' "$__go_cmd_desc" \
-    'command summary'
+  create_script_with_description
+  run "$TEST_GO_SCRIPT" _@go.command_summary "$TEST_COMMAND_SCRIPT_PATH"
+  assert_success "Command that does something in $TEST_GO_ROOTDIR"
 }
 
 @test "$SUITE: one-line description from command script has no trailing space" {
   echo '# Command that does something in {{root}}' > "$TEST_COMMAND_SCRIPT_PATH"
-  _GO_ROOTDIR='/foo/bar'
-  COLUMNS=40
-
-  _@go.command_description "$TEST_COMMAND_SCRIPT_PATH"
-  assert_equal 'Command that does something in /foo/bar' "$__go_cmd_desc" \
-    'one-line command description'
+  COLUMNS=40 run "$TEST_GO_SCRIPT" _@go.command_description \
+    "$TEST_COMMAND_SCRIPT_PATH"
+  assert_success "Command that does something in $TEST_GO_ROOTDIR"
 }
 
 @test "$SUITE: parse description from command script" {
-  _GO_CMD='test-go'
-  _GO_ROOTDIR='/foo/bar'
-  COLUMNS=40
-  _@go.command_description "$TEST_COMMAND_SCRIPT_PATH"
+  create_script_with_description
+  COLUMNS=40 run test-go _@go.command_description "$TEST_COMMAND_SCRIPT_PATH"
 
-  local expected='Command that does something in /foo/bar
+  local expected='Command that does something in TEST_GO_ROOTDIR
 
 Usage: test-go test-command [args...]
 
@@ -125,13 +128,12 @@ Indented lines that look like tables (there are two or more adjacent spaces afte
   xyzzy  all work and no play makes
            mike a Dull Boy.
   plugh  all werk and no play makes
-           mike a dull Boy
-'
+           mike a dull Boy'
 
   # With this test, I learned that you _do_ have to quote strings even inside of
   # '[[' and ']]' in case the strings themselves contain '[' or ']', as with
   # '[args...]' above.
-  assert_equal "$expected" "$__go_cmd_desc" 'command description'
+  assert_success "${expected/TEST_GO_ROOTDIR/$TEST_GO_ROOTDIR}"
 }
 
 @test "$SUITE: format subcommand description" {
@@ -144,15 +146,9 @@ Indented lines that look like tables (there are two or more adjacent spaces afte
 echo The command script starts now.
 '
 
-  local _GO_CMD='test-go'
-  local expected=("Leaf command that does something in $_GO_ROOTDIR"
-    ''
-    "Usage: $_GO_CMD root-command node-command leaf-command [args...]"
-    '')
-  local __go_cmd_desc
-  _@go.command_description \
+  run test-go _@go.command_description \
     "$TEST_GO_SCRIPTS_DIR/root-command.d/node-command.d/leaf-command"
-
-  local IFS=$'\n'
-  assert_equal "${expected[*]}" "$__go_cmd_desc"
+  assert_success "Leaf command that does something in $TEST_GO_ROOTDIR" \
+    '' \
+    "Usage: test-go root-command node-command leaf-command [args...]"
 }

tests/complete.bats

@@ -70,7 +70,7 @@ teardown() {
 
   while IFS= read -r item; do
     expected+=("${item#$TEST_GO_ROOTDIR/}")
-  done<<<"$(@go.compgen -d "$TEST_GO_SCRIPTS_DIR/")"
+  done < <(@go.compgen -d "$TEST_GO_SCRIPTS_DIR/")
 
   run "$TEST_GO_SCRIPT" complete 1 cd 'scripts/'
   assert_success "${expected[@]}"
@@ -85,16 +85,12 @@ teardown() {
   touch "${files[@]/#/$TEST_GO_SCRIPTS_DIR/}"
 
   local top_level=()
-  local all_scripts_entries=()
-  local item
-
-  while IFS= read -r item; do
-    top_level+=("${item#$TEST_GO_ROOTDIR/}")
-  done <<<"$(@go.compgen -f "$TEST_GO_ROOTDIR/")"
+  @go.test_compgen top_level -f "$TEST_GO_ROOTDIR/"
+  top_level=("${top_level[@]#$TEST_GO_ROOTDIR/}")
 
-  while IFS= read -r item; do
-    all_scripts_entries+=("${item#$TEST_GO_ROOTDIR/}")
-  done <<<"$(@go.compgen -f "$TEST_GO_SCRIPTS_DIR/")"
+  local all_scripts_entries=()
+  @go.test_compgen all_scripts_entries -f "$TEST_GO_SCRIPTS_DIR/"
+  all_scripts_entries=("${all_scripts_entries[@]#$TEST_GO_ROOTDIR/}")
 
   run "$TEST_GO_SCRIPT" complete 1 edit ''
   assert_success "${top_level[@]}"

tests/get/file.bats

@@ -26,12 +26,7 @@ teardown() {
   assert_success '-f'
 
   local expected=()
-  local item
-
-  . "$_GO_USE_MODULES" 'complete'
-  while IFS= read -r item; do
-    expected+=("$item")
-  done <<<"$(@go.compgen -f -- "$TEST_GO_ROOTDIR/")"
+  @go.test_compgen expected -f -- "$TEST_GO_ROOTDIR/"
 
   run "$TEST_GO_SCRIPT" get file --complete 1 -f
   assert_success "${expected[@]#$TEST_GO_ROOTDIR/}"