put mksh in the cross-shell-tests

It previously just showed the last three lines. It needs to show the
last four lines now because urchin now displays skipped tests.

AUTHORS

@@ -0,0 +1,9 @@
+Authors
+-------
+David Jones
+Michael Klement
+Thomas Levine
+
+Maintainer
+-------
+Thomas Levine <_@thomaslevine.com>

HISTORY

@@ -1,5 +1,28 @@
 HISTORY
--------
+=======
+
+Version 0.0.6
+---------------------
+
+* Produce TAP output with the -t flag.
+* Add a + sign in front of directories in the normal output so that they
+  line up with non-directories.
+* Display skipped tests in the normal output and in the TAP output.
+* Correct some things in the documentation.
+* Rearrange things in the documentation to be more clear.
+* Pass the -e flag to exit urchin if any single test fails.
+* Remove the undocumented, experimental -x flag now that shall exists.
+* Display version number with the -v flag.
+* Document why Urchin is called "Urchin"
+
+These changes are made somewhat separately in the branches "exit-on-fail",
+"remove-urchin-x", "tap", and "update-readme". They are rebased into one
+branch, "tlevine-2016-02", for merging into "master".
+
+Version 0.0.5
+---------------------
+* urchin now unsets `CDPATH`.
+* The documentation for `urchin -x` was removed because it was confusing.
 
 Version 0.0.4
 ---------------------

alternatives

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

cross-shell-tests

@@ -2,11 +2,11 @@
 # Run urchin in a bunch of different shells,
 # including a shell that isn't quite POSIX-compatible (zsh)
 
-for shell in dash bash ksh zsh; do
+for shell in dash bash mksh ksh zsh; do
   if which $shell > /dev/null 2> /dev/null; then
     echo
     echo Running urchin tests in $shell
-    $shell urchin tests | tail -n 3
+    $shell urchin -s $shell tests | tail -n 4
   else
     echo
     echo Skipping $shell because it is not in the PATH

package.json

@@ -1,6 +1,6 @@
 {
   "name": "urchin",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "description": "Test framework for shell",
   "main": "urchin",
   "directories": {
@@ -24,10 +24,9 @@
     {"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",
-  "readmeFilename": "readme.md"
+  "license": "BSD"
 }

readme.md

@@ -4,22 +4,26 @@
     / /_/ / /  / /__/ / / / / / / /
     \__,_/_/   \___/_/ /_/_/_/ /_/ 
 
-Urchin is a test framework for shell. It is implemented in
-portable /bin/sh and should work on GNU/Linux, Mac OS X, and
-other Unix platforms.
+Urchin is a file-based test harness, normally used for testing shell programs.
+It is written in portable shell and should thus work on GNU/Linux, BSD
+(including Mac OS X), and other Unix-like platforms.
+
+Urchin is called "Urchin" because
+[sea urchins](https://en.wikipedia.org/wiki/Sea_urchin)
+have shells called "tests".
 
 ## Try it out
 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/scraperwiki/urchin.git
+    git clone git://github.com/tlevine/urchin.git
 
 Run the tests
 
     cd urchin
     ./urchin tests
 
-The above command will run the tests in your systems default
+The above command will run the tests in your system's 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:
@@ -27,14 +31,15 @@ run this:
     cd urchin
     ./cross-shell-tests
 
-## Globally
-Download Urchin like so (as root) (or use npm, below):
+## Install
+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/scraperwiki/urchin/master/urchin
+    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,6 +91,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.
 
+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
+
 ### Writing cross-shell compatibility tests for testing shell code
 
 While you could write your test scripts to explicitly invoke the functionality
@@ -97,17 +110,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.
 
 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
-`TEST_SHELL` specifying the shell to test with, e.g.: `TEST_SHELL=zsh urchin ./tests`.  
+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
+
 To test with multiple shells in sequence, use something like:
 
     for shell in sh bash ksh zsh; do
@@ -115,14 +131,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.)
@@ -138,20 +160,18 @@ 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
-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.
+Also consider using [shall](https://github.com/mklement0/shall).
+It does something similar, but the interface may be more intuitive.
 
-    #!/usr/bin/env urchin -x
-    test a = a
-
-It might make sense if you do this.
-
-    export TEST_SHELL=zsh && urchin -x
-    export TEST_SHELL=bash && urchin -x
+    #!/usr/bin/env shall
+    echo This is a test file.
 
 ## 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/.die-on-fail/2 should run.

@@ -0,0 +1 @@
+false

tests/.die-on-fail/3 should not run.

@@ -0,0 +1 @@
+false

tests/.die-on-fail/4 should not run.

@@ -0,0 +1 @@
+false

tests/A nonempty CDPATH should not break urchin.

@@ -0,0 +1,6 @@
+#!/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,5 +1,3 @@
-#!/usr/bin/awk -f
-
-# This script will only succeed if it is indeed processed by awk.
-
-BEGIN { print "ok" }
+#!/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 

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

@@ -1,4 +0,0 @@
-#! ../../../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,6 +3,5 @@
 # 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

@@ -1,3 +0,0 @@
-#!/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.

@@ -1,3 +0,0 @@
-#!/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

@@ -1,3 +0,0 @@
-#!/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

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

tests/Exit on fail if -e is passed.

@@ -0,0 +1,11 @@
+tmp=$(mktemp)
+../urchin -e -f ./.die-on-fail > $tmp
+result=$?
+
+grep '1 should run.' $tmp
+grep '2 should run.' $tmp
+grep -v '3 should not run.' $tmp
+grep -v '4 should not run.' $tmp
+
+rm $tmp
+exit $result

tests/Print version on -v.

@@ -0,0 +1,2 @@
+#!/bin/sh
+../urchin -v | grep '[0-9.]\{3,\}'

tests/TAP/.expected-output

@@ -0,0 +1,10 @@
+# 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

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

tests/TAP/.testsuite/b

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

tests/TAP/.testsuite/c

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

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

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

urchin

@@ -1,5 +1,12 @@
 #!/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
+
+# Urchin version number
+VERSION=0.0.6
+
 fullpath() {
   (
     cd -- "$1"
@@ -26,9 +33,16 @@ 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}"
+      echo "+ ${potential_test}"
+    fi
+
+    (
       cd -- "$potential_test"
       [ -f setup_dir ] && [ -x setup_dir ] && ./setup_dir >> "$stdout_file"
 
@@ -43,44 +57,92 @@ recurse() {
 
         # $2 instead of $indent_level so it doesn't clash
         recurse "${test}" $(( $2 + 1 )) "$shell_for_sh_tests"
+        exit_code=$?
+
+        if $exit_on_fail && test $exit_code -ne 0; then
+          [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
+          [ -f teardown_dir ] && [ -x teardown_dir ] && ./teardown_dir >> "$stdout_file"
+          return 1
+        fi
 
         [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
       done
       [ -f teardown_dir ] && [ -x teardown_dir ] && ./teardown_dir >> "$stdout_file"
-      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
+    if $tap_format; then
+      indent $indent_level | sed 's/  /#/g'
+      echo "# End - ${potential_test}"
     else
-      TEST_SHELL="$TEST_SHELL" ./"$potential_test" > "$stdout_file" 2>&1
+      echo
     fi
-    exit_code="$?"
-
-
-    [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
-
-    indent $indent_level
-    if [ $exit_code -eq 0 ]
+  else
+    if [ -x "$potential_test" ]
       then
-      # On success, print a green '✓'
-      printf '\033[32m✓ \033[0m'
-      printf '%s\n' "${potential_test}"
-      printf '%s\n' "${potential_test} passed" >> "$logfile"
+      [ -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
     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'
+      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
+    fi
+
+    if $exit_on_fail && test 0 -ne $exit_code; then
+      return 1
     fi
   fi
   [ $indent_level -eq 0 ] && rm "$stdout_file"
@@ -95,19 +157,24 @@ has_sh_or_no_shebang_line() {
 USAGE="usage: $0 [<options>] <test directory>"
 
 urchin_help() {
-  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
+  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.
+-e          Stop running if any single test fails. This is helpful if you want
+            to use Urchin to run things other than tests, such as a set of
+            configuration scripts.
+-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, --help  This help.
+-v          Display the version number.
+
+Go to https://github.com/tlevine/urchin for documentation on writing tests.
+
+EOF
 }
 
 plural () {
@@ -123,7 +190,11 @@ plural () {
 }
 
 urchin_go() {
-  echo Running tests at $(date +%Y-%m-%dT%H:%M:%S) | tee "$logfile"
+  rm -f "$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
@@ -143,13 +214,23 @@ urchin_go() {
 
   finish=$(date +%s)
   elapsed=$(($finish - $start))
-  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"
+
+  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'
 }
 
 urchin_molly_guard() {
@@ -166,24 +247,23 @@ urchin_molly_guard() {
 
 shell_for_sh_tests=
 force=false
+exit_on_fail=false
+tap_format=false
 while [ $# -gt 0 ]
 do
     case "$1" in
+        -e) exit_on_fail=true;;
         -f) force=true;;
         -s)
           shift
           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; }
           ;;
-        -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 $?;;
+        -t) tap_format=true;;
         -h|--help) urchin_help
           exit 0;;
+        -v) echo "$VERSION"
+            exit;;
         -*) urchin_help >&2
             exit 1;;
         *)  break;;