introduction paragraph

* move shall reference to the right place
* further explain cross-shell testing methods

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

readme.md

@@ -4,9 +4,9 @@
     / /_/ / /  / /__/ / / / / / / /
     \__,_/_/   \___/_/ /_/_/_/ /_/ 
 
-Urchin is a test framework for shell. It is implemented in
+Urchin is a file-based test harness, normally used for testing shell programs.
-portable /bin/sh and should work on GNU/Linux, Mac OS X, and
+It is written in portable shell and should thus work on GNU/Linux, BSD
-other Unix platforms.
+(including Mac OS X), and other Unix-like platforms.
 
 ## Try it out
 Urchin's tests are written in Urchin, so you can run them to see what Urchin
@@ -27,14 +27,15 @@ run this:
     cd urchin
     ./cross-shell-tests
 
-## Globally
+## Install
-Download Urchin like so (as root) (or use npm, below):
+Urchin is contained in a single file, so you can install it by copying it to a
+directory in your `PATH`. For example, you can run the following as root.
 
     cd /usr/local/bin
     wget https://raw.github.com/tlevine/urchin/master/urchin
     chmod +x urchin
 
-Can be installed with npm too:
+Urchin can be installed with npm too.
 
     npm install -g urchin
 
@@ -86,15 +87,14 @@ 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
+Tests files and subdirectories are run in ASCIIbetical order within each
+directory; that is,
 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
@@ -106,24 +106,20 @@ The specific approach depends on your test scenario:
 * (b) Your scripts _source_ scripts containing portable shell code.
 
 #### (a) Cross-shell tests with test scripts that _invoke_ shell scripts
+Urchin sets the `TEST_SHELL` environment variable so that you may change the
+shell with which your tests call other shell programs. To run your test
+scripts in multiple shells you must call `$TEST_SHELL` in your tests and then
+run urchin with the appropriate option.
 
-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`).  
-Note that if you alsow want your test scripts to work when run directly,
-outside of Urchin, be sure to target scripts that happen to be in the 
-current directory with prefix `./`; e.g., `$TEST_SHELL ./baz`
-(rather than `$TEST_SHELL baz`).
 
-Then, on invocation of Urchin, prepend a definition of environment variable
+On invocation of Urchin, prepend a definition of environment variable
-`TEST_SHELL` specifying the shell to test with, e.g.: `TEST_SHELL=zsh urchin ./tests`.  
+`TEST_SHELL` specifying the shell to test with, e.g.,
+
+    TEST_SHELL=zsh urchin ./tests
+
 To test with multiple shells in sequence, use something like:
 
     for shell in sh bash ksh zsh; do
@@ -131,14 +127,20 @@ To test with multiple shells in sequence, use something like:
     done
 
 If `TEST_SHELL` has no value, Urchin defines it as `/bin/sh`, so the test
-scripts can rely on `$TEST_SHELL` always containing a value.
+scripts can rely on `$TEST_SHELL` always containing a value when Urchin runs
+them.
+
+That said, we still recommand that you account for the possibility that
+`$TEST_SHELL` does not contain a value so that you may run your test scripts
+without Urchin. Supporting this case is very simple; when you invoke scripts
+that happen to be in the current directory, be sure to use the prefix `./`,
+e.g., `$TEST_SHELL ./baz` rather than `$TEST_SHELL baz`.
 
 #### (b) Cross-shell tests with test scripts that _source_ shell scripts
-
 If you _source_ shell code in your test scripts, it is the test scripts
 themselves that must be run with the shell specified.
 
-To that end, Urchin supports the `-s <shell>` option, which instructs
+Urchin supports the `-s <shell>` option, which instructs
 Urchin to invoke the test scripts with the specified shell; e.g., `-s bash`.  
 (In addition, Urchin sets environment variable `TEST_SHELL` to the specified
 shell.)
@@ -154,21 +156,12 @@ To test with multiple shells in sequence, use something like:
       urchin -s $shell ./tests
     done
 
-<!--
+Also consider using [shall](https://github.com/mklement0/shall).
-#### (c) Cross shell tests with `urchin -x` (experimental)
+It does something similar, but the interface may be more intuitive.
-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
-be as if you ran `/bin/sh`. Putting this in she shebang line might
-eventually work out to be a cleaner way of doing cross-shell testing.
 
-    #!/usr/bin/env urchin -x
+    #!/usr/bin/env shall
-    test a = a
+    echo This is a test file.
 
-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/).

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
+#!/usr/bin/awk -f
-true will processed the contents of this script, but that
+
-means that nothing will happen and the script will exit 0 
+# This script will only succeed if it is indeed processed by awk.
+
+BEGIN { print "ok" }

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/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

tests/urchin -x should start the $TEST_SHELL.

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

urchin

@@ -30,16 +30,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,15 +51,9 @@ 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
-    fi
+    )
-  else
+  elif [ -x "$potential_test" ]
-    if [ -x "$potential_test" ]
     then
 
     [ -f setup ] && [ -x setup ] && ./setup >> "$stdout_file"
@@ -82,55 +69,22 @@ recurse() {
 
 
     [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
-      if [ $exit_code -eq 0 ]; then
-        result=success
-      else
-        result=fail
-      fi
-    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
+    if [ $exit_code -eq 0 ]
-        success)
+      then
       # On success, print a green '✓'
       printf '\033[32m✓ \033[0m'
       printf '%s\n' "${potential_test}"
-        ;;
+      printf '%s\n' "${potential_test} passed" >> "$logfile"
-        fail)
+    else
       # 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'
-        ;;
-        skip)
-          printf '  %s\n' "${potential_test}"
-        ;;
-      esac
     fi
   fi
   [ $indent_level -eq 0 ] && rm "$stdout_file"
@@ -153,12 +107,15 @@ $USAGE
             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
+  # [Experimental -x option left undocumented for now.]
+  # -x          [Experimental; not meant for direct invocation, but for use in
+  #             the shebang line of test scripts]
+  #             Run with "\$TEST_SHELL", falling back on /bin/sh.
 }
 
 plural () {
@@ -174,11 +131,7 @@ plural () {
 }
 
 urchin_go() {
-  rm -f "$logfile"
+  echo Running tests at $(date +%Y-%m-%dT%H:%M:%S) | tee "$logfile"
-  if "$tap_format"; then
-    printf \#\ 
-  fi
-  echo Running tests at $(date +%Y-%m-%dT%H:%M:%S)
   start=$(date +%s)
 
   # Determine the environment variable to define for test scripts
@@ -198,23 +151,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."
+  set -- $(grep -e 'passed$' "$logfile"|wc -l) $(grep -e 'failed$' "$logfile"|wc -l)
-    printf '%s\n' "$skipped $(plural test "$skipped") skipped."
+  printf '%s\n' "$1 $(plural test "$1") passed."
-    [ $failed -gt 0 ] && printf '\033[31m' || printf '\033[32m' # If tests failed, print the message in red, otherwise in green.
+  [ $2 -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 '%s\n' "$2 $(plural test "$2") failed."
   printf '\033[m'
-  fi
+  return "$2"
-  rm -f "$logfile"
-  test -z "$failed" || test "$failed" -eq '0'
 }
 
 urchin_molly_guard() {
@@ -231,7 +174,6 @@ urchin_molly_guard() {
 
 shell_for_sh_tests=
 force=false
-tap_format=false
 while [ $# -gt 0 ]
 do
     case "$1" in
@@ -241,7 +183,11 @@ 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) # [EXPERIMENTAL; UNDOCUMENTED FOR NOW] `urchin -x <test-script>` in a test script's shebang line is equivalent to invoking that script with `"$TEST_SHELL" <test-script>`
+          shift
+          urchinsh=${TEST_SHELL:-/bin/sh}
+          "$urchinsh" "$@"
+          exit $?;;
         -h|--help) urchin_help
           exit 0;;
         -*) urchin_help >&2