Merge pull request Bash-it#2002 from gaelicWizard/bats

NoahGorny · web-flow · commit 4ec1b5f3e767 · 2022-01-09T01:04:12.000+02:00
tests: path quoting and boilerplate
diff --git a/clean_files.txt b/clean_files.txt
@@ -122,7 +122,9 @@ plugins/available/zoxide.plugin.bash
 # tests
 #
 test/plugins/alias-completion.plugin.bats
+test/run
 test/test_helper.bash
+test/test_helper_libs.bash
 
 # themes
 #
diff --git a/test/bash_it/bash_it.bats b/test/bash_it/bash_it.bats
@@ -1,7 +1,6 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
 
 function local_setup {
   setup_test_fixture
diff --git a/test/completion/bash-it.completion.bats b/test/completion/bash-it.completion.bats
@@ -1,7 +1,6 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
 load ../../completion/available/bash-it.completion
 
 function local_setup {
diff --git a/test/install/install.bats b/test/install/install.bats
@@ -1,7 +1,6 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
 
 # Determine which config file to use based on OS.
 case $OSTYPE in
diff --git a/test/install/uninstall.bats b/test/install/uninstall.bats
@@ -1,7 +1,6 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
 
 # Determine which config file to use based on OS.
 case $OSTYPE in
diff --git a/test/lib/composure.bats b/test/lib/composure.bats
@@ -1,7 +1,6 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
 
 @test "lib composure: _composure_keywords()" {
   run _composure_keywords
diff --git a/test/lib/helpers.bats b/test/lib/helpers.bats
@@ -1,14 +1,7 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
-load ../../lib/log
-load ../../lib/utilities
-load ../../lib/search
-
-cite _about _param _example _group _author _version
-
-load ../../lib/helpers
+load ../test_helper_libs
 load ../../plugins/available/base.plugin
 
 function local_setup {
diff --git a/test/lib/log.bats b/test/lib/log.bats
@@ -1,10 +1,8 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
-load ../../lib/appearance
+load ../../themes/colors.theme
 
-cite _about _param _example _group _author _version
 load ../../lib/log
 load ../../lib/helpers
 load ../../plugins/available/base.plugin
diff --git a/test/lib/search.bats b/test/lib/search.bats
@@ -1,13 +1,7 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
-load ../../lib/log
-load ../../lib/helpers
-load ../../lib/utilities
-load ../../lib/search
-
-cite _about _param _example _group _author _version
+load ../test_helper_libs
 
 load ../../plugins/available/base.plugin
 load ../../aliases/available/git.aliases
diff --git a/test/lib/utilities.bats b/test/lib/utilities.bats
@@ -1,93 +1,84 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
-load ../../lib/helpers
-load ../../lib/utilities
-load ../../lib/search
-
-cite _about _param _example _group _author _version
+load ../test_helper_libs
 
 function local_setup {
   setup_test_fixture
 }
 
-function has_match() {
-  $(_bash-it-array-contains-element ${@}) && echo "has" "$1"
-}
-
-function item_enabled() {
-  $(_bash-it-component-item-is-enabled ${@}) && echo "$1" "$2" "is enabled"
-}
-
-function item_disabled() {
-  $(_bash-it-component-item-is-disabled ${@}) && echo "$1" "$2" "is disabled"
-}
-
 @test "_bash-it-component-item-is-enabled() - for a disabled item" {
-  run item_enabled aliases svn
-  assert_line -n 0 ''
+  run _bash-it-component-item-is-enabled aliases svn
+  assert_failure
 }
 
 @test "_bash-it-component-item-is-enabled() - for an enabled/disabled item" {
   run bash-it enable alias svn
   assert_line -n 0 'svn enabled with priority 150.'
 
-  run item_enabled alias svn
-  assert_line -n 0 'alias svn is enabled'
+  run _bash-it-component-item-is-enabled alias svn
+  assert_success
+  run _bash-it-component-item-is-disabled alias svn
+  assert_failure
 
   run bash-it disable alias svn
   assert_line -n 0 'svn disabled.'
 
-  run item_enabled alias svn
-  assert_line -n 0 ''
+  run _bash-it-component-item-is-enabled alias svn
+  assert_failure
+  run _bash-it-component-item-is-disabled alias svn
+  assert_success
 }
 
 @test "_bash-it-component-item-is-disabled() - for a disabled item" {
-  run item_disabled alias svn
-  assert_line -n 0 'alias svn is disabled'
+  run _bash-it-component-item-is-disabled alias svn
+  assert_success
 }
 
 @test "_bash-it-component-item-is-disabled() - for an enabled/disabled item" {
   run bash-it enable alias svn
   assert_line -n 0 'svn enabled with priority 150.'
 
-  run item_disabled alias svn
-  assert_line -n 0 ''
+  run _bash-it-component-item-is-disabled alias svn
+  assert_failure
+  run _bash-it-component-item-is-enabled alias svn
+  assert_success
 
   run bash-it disable alias svn
   assert_line -n 0 'svn disabled.'
 
-  run item_disabled alias svn
-  assert_line -n 0 'alias svn is disabled'
+  run _bash-it-component-item-is-disabled alias svn
+  assert_success
+  run _bash-it-component-item-is-enabled alias svn
+  assert_failure
 }
 
 @test "_bash-it-array-contains-element() - when match is found, and is the first" {
   declare -a fruits=(apple pear orange mandarin)
-  run has_match apple "${fruits[@]}"
-  assert_line -n 0 'has apple'
+  run _bash-it-array-contains-element apple "${fruits[@]}"
+  assert_success
 }
 
 @test "_bash-it-array-contains-element() - when match is found, and is the last" {
   declare -a fruits=(apple pear orange mandarin)
-  run has_match mandarin "${fruits[@]}"
-  assert_line -n 0 'has mandarin'
+  run _bash-it-array-contains-element mandarin "${fruits[@]}"
+  assert_success
 }
 
 @test "_bash-it-array-contains-element() - when match is found, and is in the middle" {
   declare -a fruits=(apple pear orange mandarin)
-  run has_match pear "${fruits[@]}"
-  assert_line -n 0 'has pear'
+  run _bash-it-array-contains-element pear "${fruits[@]}"
+  assert_success
 }
 
 @test "_bash-it-array-contains-element() - when match is found, and it has spaces" {
   declare -a fruits=(apple pear orange mandarin "yellow watermelon")
-  run has_match "yellow watermelon" "${fruits[@]}"
-  assert_line -n 0 'has yellow watermelon'
+  run _bash-it-array-contains-element "yellow watermelon" "${fruits[@]}"
+  assert_success
 }
 
 @test "_bash-it-array-contains-element() - when match is not found" {
   declare -a fruits=(apple pear orange mandarin)
-  run has_match xyz "${fruits[@]}"
-  assert_line -n 0 ''
+  run _bash-it-array-contains-element xyz "${fruits[@]}"
+  assert_failure
 }
diff --git a/test/plugins/alias-completion.plugin.bats b/test/plugins/alias-completion.plugin.bats
@@ -1,11 +1,7 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
-load ../../lib/log
-load ../../lib/helpers
-
-cite _about _param _example _group _author _version
+load ../test_helper_libs
 
 load ../../completion/available/capistrano.completion
 
diff --git a/test/plugins/base.plugin.bats b/test/plugins/base.plugin.bats
@@ -1,9 +1,7 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
-load ../../lib/log
-load ../../lib/helpers
+load ../test_helper_libs
 load ../../plugins/available/base.plugin
 
 @test 'plugins base: ips()' {
diff --git a/test/plugins/battery.plugin.bats b/test/plugins/battery.plugin.bats
@@ -1,11 +1,7 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
-load "${BASH_IT}/lib/log.bash"
-load "${BASH_IT}/lib/helpers.bash"
-
-cite _about _param _example _group _author _version
+load ../test_helper_libs
 
 load ../../plugins/available/battery.plugin
 
diff --git a/test/plugins/cmd-returned-notify.plugin.bats b/test/plugins/cmd-returned-notify.plugin.bats
@@ -1,8 +1,8 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load ../../lib/helpers
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
+load ../test_helper_libs
+load ../../vendor/init.d/preexec
 
 load ../../plugins/available/cmd-returned-notify.plugin
 
diff --git a/test/plugins/go.plugin.bats b/test/plugins/go.plugin.bats
@@ -1,8 +1,7 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load ../../lib/helpers
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
+load ../test_helper_libs
 
 # We test `go version` in each test to account for users with goenv and no system go.
 
diff --git a/test/plugins/ruby.plugin.bats b/test/plugins/ruby.plugin.bats
@@ -1,9 +1,7 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load ../../lib/helpers
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
-load ../../plugins/available/ruby.plugin
+load ../test_helper_libs
 
 function local_setup {
   setup_test_fixture
@@ -18,17 +16,21 @@ function local_teardown {
 }
 
 @test "plugins ruby: remove_gem is defined" {
+  load ../../plugins/available/ruby.plugin
+
   run type remove_gem
   assert_line -n 1 "remove_gem () "
 }
 
 @test "plugins ruby: PATH includes ~/.gem/ruby/bin" {
-  if ! which ruby >/dev/null; then
+  if ! type ruby >/dev/null; then
     skip 'ruby not installed'
   fi
 
+  mkdir -p "$(ruby -e 'print Gem.user_dir')/bin"
+
   load ../../plugins/available/ruby.plugin
 
-  local last_path_entry=$(echo $PATH | tr ":" "\n" | tail -1)
-  [[ "${last_path_entry}" == "${HOME}"/.gem/ruby/*/bin ]]
+  local last_path_entry="$(tail -1 <<<"${PATH//:/$'\n'}")"
+  [[ "${last_path_entry}" == "$(ruby -e 'print Gem.user_dir')/bin" ]]
 }
diff --git a/test/plugins/xterm.plugin.bats b/test/plugins/xterm.plugin.bats
@@ -1,8 +1,7 @@
 #!/usr/bin/env bats
 
 load ../test_helper
-load ../../lib/helpers
-load "${BASH_IT}/vendor/github.com/erichs/composure/composure.sh"
+load ../test_helper_libs
 
 load ../../plugins/available/xterm.plugin
 
@@ -21,30 +20,30 @@ function local_setup {
 
 @test "plugins xterm: shorten command output" {
     export SHORT_TERM_LINE=true
-    run _short-command ${BASH_IT}/test/fixtures/plugin/xterm/files/*
+    run _short-command "${BASH_IT}/test/fixtures/plugin/xterm/files"/*
     assert_success
-    assert_output ${BASH_IT}/test/fixtures/plugin/xterm/files/arg0
+    assert_output "${BASH_IT}/test/fixtures/plugin/xterm/files/arg0"
 }
 
 @test "plugins xterm: full command output" {
     export SHORT_TERM_LINE=false
-    run _short-command ${BASH_IT}/test/fixtures/plugin/xterm/files/*
+    run _short-command "${BASH_IT}/test/fixtures/plugin/xterm/files"/*
     assert_success
-    assert_output "$(echo ${BASH_IT}/test/fixtures/plugin/xterm/files/*)"
+    assert_output "$(echo "${BASH_IT}/test/fixtures/plugin/xterm/files"/*)"
 }
 
 @test "plugins xterm: shorten dirname output" {
     export SHORT_TERM_LINE=true
     run _short-dirname
     assert_success
-    assert_output "$(basename $PWD)"
+    assert_output "$(basename "${PWD}")"
 }
 
 @test "plugins xterm: full dirname output" {
     export SHORT_TERM_LINE=false
     run _short-dirname
     assert_success
-    assert_output $PWD
+    assert_output "${PWD}"
 }
 
 @test "plugins xterm: set xterm title" {
diff --git a/test/run b/test/run
diff --git a/test/test_helper.bash b/test/test_helper.bash
diff --git a/test/test_helper_libs.bash b/test/test_helper_libs.bash
diff --git a/test/themes/base.theme.bats b/test/themes/base.theme.bats
diff --git a/test/themes/base.theme.git.bats b/test/themes/base.theme.git.bats
diff --git a/test/themes/base.theme.svn.bats b/test/themes/base.theme.svn.bats

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,9 @@ plugins/available/zoxide.plugin.bash`
`122`	`122`	`# tests`
`123`	`123`	`#`
`124`	`124`	`test/plugins/alias-completion.plugin.bats`
	`125`	`+test/run`
`125`	`126`	`test/test_helper.bash`
	`127`	`+test/test_helper_libs.bash`
`126`	`128`
`127`	`129`	`# themes`
`128`	`130`	`#`