TEST_SHELL

HISTORY

@@ -1,11 +1,6 @@
 HISTORY
 -------
 
-Version 0.0.5
----------------------
-* urchin now unsets `CDPATH`.
-* The documentation for `urchin -x` was removed because it was confusing.
-
 Version 0.0.4
 ---------------------
 * Switch urchin -x to urchin -sh and fix some problems with it

alternatives

@@ -1,2 +0,0 @@
-Totally different syntax and similar features, plus TAP output
-https://github.com/sstephenson/bats

cross-shell-tests

@@ -6,7 +6,7 @@ for shell in dash bash ksh zsh; do
   if which $shell > /dev/null 2> /dev/null; then
     echo
     echo Running urchin tests in $shell
-    $shell urchin -s $shell tests | tail -n 3
+    $shell urchin tests | tail -n 3
   else
     echo
     echo Skipping $shell because it is not in the PATH

package.json

@@ -1,6 +1,6 @@
 {
   "name": "urchin",
-  "version": "0.0.5",
+  "version": "0.0.4",
   "description": "Test framework for shell",
   "main": "urchin",
   "directories": {
@@ -24,9 +24,10 @@
     {"name": "Thomas Levine", "email": "_@thomaslevine.com"},
     {"name": "David Jones", "email": "drj@pobox.com"},
     {"name": "Francis Irving", "email": "francis@flourish.org"},
-    {"name": "Zarino Zappia", "email": "mail@zarino.co.uk"},
-    {"name": "Tom Mortimer-Jones", "email": "tom@morty.co.uk"},
+    {"name": "Zarino Zappia", "email": "mail@zarino.co.uk"}
+    {"name": "Tom Mortimer-Jones", "email": "tom@morty.co.uk"}
     {"name": "Michael Klement", "email": "mklement0@gmail.com"}
   ],
-  "license": "BSD"
+  "license": "BSD",
+  "readmeFilename": "readme.md"
 }

readme.md

@@ -12,14 +12,14 @@ other Unix platforms.
 Urchin's tests are written in Urchin, so you can run them to see what Urchin
 is like. Clone the repository
 
-    git clone git://github.com/tlevine/urchin.git
+    git clone git://github.com/scraperwiki/urchin.git
 
 Run the tests
 
     cd urchin
     ./urchin tests
 
-The above command will run the tests in your system's default
+The above command will run the tests in your systems default
 shell, /bin/sh (on recent Ubuntu this is dash, but it could be
 ksh or bash on other systems); to test urchin's cross-shell compatibility,
 run this:
@@ -31,7 +31,7 @@ run this:
 Download Urchin like so (as root) (or use npm, below):
 
     cd /usr/local/bin
-    wget https://raw.github.com/tlevine/urchin/master/urchin
+    wget https://raw.github.com/scraperwiki/urchin/master/urchin
     chmod +x urchin
 
 Can be installed with npm too:
@@ -86,15 +86,6 @@ Files are only run if they are executable, and files beginning with `.` are
 ignored. Thus, fixtures and libraries can be included sloppily within the test
 directory tree. The test passes if the file exits 0; otherwise, it fails.
 
-In case you care about the order in which your tests execute, consider that
-urchin looks for files within a directory in the following manner.
-
-    for file in *; do
-      do_something_with_test_file $file
-    done
-
-Tests within a directory are executed in whatever order `*` returns.
-
 ### Writing cross-shell compatibility tests for testing shell code
 
 While you could write your test scripts to explicitly invoke the functionality
@@ -107,13 +98,6 @@ The specific approach depends on your test scenario:
 
 #### (a) Cross-shell tests with test scripts that _invoke_ shell scripts
 
-First, consider using [shall](https://github.com/mklement0/shall).
-
-    #!/usr/bin/env shall
-    echo This is a test file.
-
-Alternatively, you can use urchin's built-in recognition of the
-`TEST_SHELL` environment variable.
 In your test scripts, invoke the shell scripts to test via the shell
 specified in environment variable `TEST_SHELL` rather than directly;
 e.g.: `$TEST_SHELL ../foo bar` (rather than just `../foo bar`).  
@@ -154,7 +138,6 @@ To test with multiple shells in sequence, use something like:
       urchin -s $shell ./tests
     done
 
-<!--
 #### (c) Cross shell tests with `urchin -x` (experimental)
 If you run urchin with the `-x` flag, it will be as if you ran
 `$TEST_SHELL`. Unless `$TEST_SHELL` isn't set, in which case it'll
@@ -168,13 +151,7 @@ It might make sense if you do this.
 
     export TEST_SHELL=zsh && urchin -x
     export TEST_SHELL=bash && urchin -x
--->
+
 ## Alternatives to Urchin
 Alternatives to Urchin are discussed in
 [this blog post](https://blog.scraperwiki.com/2012/12/how-to-test-shell-scripts/).
-
-## Ideas for new features
-
-* Support [Nagios plugins](https://nagios-plugins.org/doc/guidelines.html)
-* Stop running if a test fails so one can use Urchin as a
-    [setup framework](https://github.com/tlevine/urchin/issues/16).

tests/A nonempty CDPATH should not break urchin.

@@ -1,6 +0,0 @@
-#!/bin/sh
-
-cd ..
-export CDPATH=$PWD
-./urchin -f 'tests/urchin exit code' >/dev/null
-

tests/Cross-shell test support/.test-run-by-specified-shell/With -s, a non-sh test script should be invoked directly.

@@ -1,3 +1,5 @@
-#!/usr/bin/env true
-true will processed the contents of this script, but that
-means that nothing will happen and the script will exit 0 
+#!/usr/bin/awk -f
+
+# This script will only succeed if it is indeed processed by awk.
+
+BEGIN { print "ok" }

tests/Cross-shell test support/.test-urchin-x/This should run as $TEST_SHELL

@@ -0,0 +1,4 @@
+#! ../../../urchin -x
+running=$(ps -o comm= -p $$ && :)
+echo "Running shell: $running"
+[ "$running" = bash ]

tests/Cross-shell test support/The -s option should invoke tests with the specified shell.

@@ -3,5 +3,6 @@
 # Tests the `-s <shell> option, which invokes shebang-less and sh-shebang-line test scripts with the specified shell (for testing *sourced* shell code).
 
 which bash >/dev/null || { echo "Cannot test -s option: bash cannot be located." >&2; exit 2; }
+which /usr/bin/awk >/dev/null || { echo "Cannot test -s option: /usr/bin/awk not found." >&2; exit 2; }
 
 ../../urchin -s bash ./.test-run-by-specified-shell

tests/Cross-shell test support/urchin -x should pass the $TEST_SHELL

@@ -0,0 +1,3 @@
+#!/bin/sh
+export TEST_SHELL=/bin/zsh
+echo '[ "$TEST_SHELL" = /bin/zsh ] ; exit $?' | ../../urchin -x

tests/Cross-shell test support/urchin -x should start a shell.

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+test c = $(../../urchin -x .print-arg-3 a 'b b b b' c d e)

tests/Cross-shell test support/urchin -x should start the $TEST_SHELL

@@ -0,0 +1,3 @@
+#!/bin/sh
+export TEST_SHELL=/bin/zsh
+echo 'test -n "$ZSH_VERSION"; exit $?' | ../../urchin -x

tests/Cross-shell test support/urchin should pass the $TEST_SHELL variable to urchin -x

@@ -0,0 +1,3 @@
+#!/bin/sh
+export TEST_SHELL=/bin/bash
+../../urchin .test-urchin-x

tests/TAP/.expected-output

@@ -1,10 +0,0 @@
-# Begin - .testsuite/
-not ok 1 - a
-# ------------ Begin output ------------
-# This is stdout from a.
-# ------------ End output ------------
-ok 2 - b
-ok 3 - # SKIP c
-# End - .testsuite/
-# Took 0 seconds.
-1..3

tests/TAP/.testsuite/a

@@ -1,4 +0,0 @@
-#!/bin/sh
-echo This is stderr from a. > /dev/stderr
-echo This is stdout from a. > /dev/stdout
-false

tests/TAP/.testsuite/b

@@ -1,4 +0,0 @@
-#!/bin/sh
-echo This is stderr from b. > /dev/stderr
-echo This is stdout from b. > /dev/stdout
-true

tests/TAP/.testsuite/c

@@ -1 +0,0 @@
-This should not be run.

tests/TAP/Running with -t should produce TAP output.

@@ -1,4 +0,0 @@
-tmp=$(mktemp)
-
-../../urchin -t .testsuite/ | sed 1d > $tmp
-diff $tmp .expected-output

urchin

@@ -1,9 +1,5 @@
 #!/bin/sh
 
-# Make sure that CDPATH isn't set, as it causes `cd` to behave unpredictably - notably, it can produce output,
-# which breaks fullpath().
-unset CDPATH
-
 fullpath() {
   (
     cd -- "$1"
@@ -30,16 +26,9 @@ recurse() {
 
   if [ -d "$potential_test" ]
     then
-
-    if $tap_format; then
-      indent $indent_level | sed 's/  /#/g'
-      echo "# Begin - ${potential_test}"
-    else
-      indent $indent_level
-      echo "+ ${potential_test}"
-    fi
-
     (
+      indent $indent_level
+      echo "  ${potential_test}"
       cd -- "$potential_test"
       [ -f setup_dir ] && [ -x setup_dir ] && ./setup_dir >> "$stdout_file"
 
@@ -58,79 +47,40 @@ recurse() {
         [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
       done
       [ -f teardown_dir ] && [ -x teardown_dir ] && ./teardown_dir >> "$stdout_file"
-    )
-    if $tap_format; then
-      indent $indent_level | sed 's/  /#/g'
-      echo "# End - ${potential_test}"
-    else
       echo
+    )
+  elif [ -x "$potential_test" ]
+    then
+
+    [ -f setup ] && [ -x setup ] && ./setup >> "$stdout_file"
+
+    # Run the test
+    if [ -n "$shell_for_sh_tests" ] && has_sh_or_no_shebang_line ./"$potential_test"
+      then    
+      TEST_SHELL="$TEST_SHELL" "$shell_for_sh_tests" ./"$potential_test" > "$stdout_file" 2>&1
+    else
+      TEST_SHELL="$TEST_SHELL" ./"$potential_test" > "$stdout_file" 2>&1
     fi
-  else
-    if [ -x "$potential_test" ]
+    exit_code="$?"
+
+
+    [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
+
+    indent $indent_level
+    if [ $exit_code -eq 0 ]
       then
-
-      [ -f setup ] && [ -x setup ] && ./setup >> "$stdout_file"
-
-      # Run the test
-      if [ -n "$shell_for_sh_tests" ] && has_sh_or_no_shebang_line ./"$potential_test"
-        then    
-        TEST_SHELL="$TEST_SHELL" "$shell_for_sh_tests" ./"$potential_test" > "$stdout_file" 2>&1
-      else
-        TEST_SHELL="$TEST_SHELL" ./"$potential_test" > "$stdout_file" 2>&1
-      fi
-      exit_code="$?"
-
-
-      [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
-      if [ $exit_code -eq 0 ]; then
-        result=success
-      else
-        result=fail
-      fi
+      # On success, print a green '✓'
+      printf '\033[32m✓ \033[0m'
+      printf '%s\n' "${potential_test}"
+      printf '%s\n' "${potential_test} passed" >> "$logfile"
     else
-      result=skip
-    fi
-
-    echo "${result}" >> "$logfile"
-    if $tap_format; then
-      n=$(grep -ce '^\(success\|fail\|skip\)' "$logfile")
-
-      if [ "$result" == fail ]; then
-        not='not '
-      else
-        not=''
-      fi
-      if [ "$result" == skip ]; then
-        skip='# SKIP '
-      else
-        skip=''
-      fi
-      echo "${not}ok $n - ${skip}${potential_test}"
-      if [ "$result" == fail ]; then
-        echo '# ------------ Begin output ------------'
-        sed 's/^/# /' "$stdout_file"
-        echo '# ------------ End output ------------'
-      fi
-    else
-      indent $indent_level
-      case "$result" in
-        success)
-          # On success, print a green '✓'
-          printf '\033[32m✓ \033[0m'
-          printf '%s\n' "${potential_test}"
-        ;;
-        fail)
-          # On fail, print a red '✗'
-          printf '\033[31m✗ \033[0m'
-          printf '%s\n' "${potential_test}"
-          printf '\033[31m' # Print output captured from failed test in red.
-          cat "$stdout_file"
-          printf '\033[0m'
-        ;;
-        skip)
-          printf '  %s\n' "${potential_test}"
-        ;;
-      esac
+      # On fail, print a red '✗'
+      printf '\033[31m✗ \033[0m'
+      printf '%s\n' "${potential_test}"
+      printf '%s\n' "${potential_test} failed" >> "$logfile"
+      printf '\033[31m' # Print output captured from failed test in red.
+      cat "$stdout_file"
+      printf '\033[0m'
     fi
   fi
   [ $indent_level -eq 0 ] && rm "$stdout_file"
@@ -145,20 +95,19 @@ has_sh_or_no_shebang_line() {
 USAGE="usage: $0 [<options>] <test directory>"
 
 urchin_help() {
-  cat <<EOF
-
-$USAGE
-
--s <shell>  Invoke test scripts that either have no shebang line at all or
-            have shebang line "#!/bin/sh" with the specified shell.
--f          Force running even if the test directory's name does not
-            contain the word "test".
--t          Format output in Test Anything Protocol (TAP)
--h          This help.
-
-Go to https://github.com/tlevine/urchin for documentation on writing tests.
-
-EOF
+  echo
+  echo "$USAGE"
+  echo
+  echo '-s <shell>  Invoke test scripts that either have no shebang line or'
+  echo '            shebang line "#!/bin/sh" with the specified shell.'
+  echo '-f          Force running even if the test directory'\''s name does not'
+  echo '            contain the word "test".'
+  echo '-x          Run "$TEST_SHELL", falling back on /bin/sh. This might be'
+  echo '            useful in the shebang line (experimental).'
+  echo '-h          This help.'
+  echo
+  echo 'Go to https://github.com/tlevine/urchin for documentation on writing tests.'
+  echo
 }
 
 plural () {
@@ -174,11 +123,7 @@ plural () {
 }
 
 urchin_go() {
-  rm -f "$logfile"
-  if "$tap_format"; then
-    printf \#\ 
-  fi
-  echo Running tests at $(date +%Y-%m-%dT%H:%M:%S)
+  echo Running tests at $(date +%Y-%m-%dT%H:%M:%S) | tee "$logfile"
   start=$(date +%s)
 
   # Determine the environment variable to define for test scripts
@@ -198,23 +143,13 @@ urchin_go() {
 
   finish=$(date +%s)
   elapsed=$(($finish - $start))
-
-  passed=$(grep -c '^success' "$logfile")
-  failed=$(grep -c '^fail' "$logfile")
-  skipped=$(grep -c '^skip' "$logfile")
-  if $tap_format; then
-    echo "# Took $elapsed $(plural second $elapsed)."
-    echo 1..$(($passed + $failed + $skipped))
-  else
-    echo "Done, took $elapsed $(plural second $elapsed)."
-    printf '%s\n' "$passed $(plural test "$passed") passed."
-    printf '%s\n' "$skipped $(plural test "$skipped") skipped."
-    [ $failed -gt 0 ] && printf '\033[31m' || printf '\033[32m' # If tests failed, print the message in red, otherwise in green.
-    printf '%s\n' "$failed $(plural test "$failed") failed."
-    printf '\033[m'
-  fi
-  rm -f "$logfile"
-  test -z "$failed" || test "$failed" -eq '0'
+  echo "Done, took $elapsed $(plural second $elapsed)."
+  set -- $(grep -e 'passed$' "$logfile"|wc -l) $(grep -e 'failed$' "$logfile"|wc -l)
+  printf '%s\n' "$1 $(plural test "$1") passed."
+  [ $2 -gt 0 ] && printf '\033[31m' || printf '\033[32m' # If tests failed, print the message in red, otherwise in green.
+  printf '%s\n' "$2 $(plural test "$2") failed."
+  printf '\033[m'
+  return "$2"
 }
 
 urchin_molly_guard() {
@@ -231,7 +166,6 @@ urchin_molly_guard() {
 
 shell_for_sh_tests=
 force=false
-tap_format=false
 while [ $# -gt 0 ]
 do
     case "$1" in
@@ -241,7 +175,13 @@ do
           shell_for_sh_tests=$1
           which "$shell_for_sh_tests" >/dev/null || { echo "Cannot find specified shell: '$shell_for_sh_tests'" >&2; urchin_help >&2; exit 2; }
           ;;
-        -t) tap_format=true;;
+        -x) # `urchin -sh` is equivalent to "$TEST_SHELL"
+          shift
+         #current_shell=$(ps -o comm= -p $$ && :)
+         #urchinsh=${TEST_SHELL:-$current_shell}
+          export TEST_SHELL=${TEST_SHELL:-/bin/sh}
+          "$TEST_SHELL" "$@"
+          exit $?;;
         -h|--help) urchin_help
           exit 0;;
         -*) urchin_help >&2