not working

unnecessary now that shall exists

HISTORY

@@ -1,6 +1,11 @@
 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

@@ -0,0 +1,2 @@
+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 tests | tail -n 3
+    $shell urchin -s $shell 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.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": "Zarino Zappia", "email": "mail@zarino.co.uk"},
-    {"name": "Tom Mortimer-Jones", "email": "tom@morty.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/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:
@@ -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/scraperwiki/urchin/master/urchin
+    wget https://raw.github.com/tlevine/urchin/master/urchin
     chmod +x urchin
 
 Can be installed with npm too:
@@ -86,6 +86,15 @@ 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
@@ -98,6 +107,13 @@ 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`).  
@@ -138,6 +154,7 @@ 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
@@ -151,7 +168,13 @@ 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/.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-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/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/Die on fail.

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

urchin

@@ -1,5 +1,9 @@
 #!/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"
@@ -43,6 +47,13 @@ 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
@@ -63,7 +74,6 @@ recurse() {
     fi
     exit_code="$?"
 
-
     [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
 
     indent $indent_level
@@ -82,6 +92,10 @@ recurse() {
       cat "$stdout_file"
       printf '\033[0m'
     fi
+
+    if $exit_on_fail && test 0 -ne $exit_code; then
+      return 1
+    fi
   fi
   [ $indent_level -eq 0 ] && rm "$stdout_file"
 }
@@ -95,19 +109,22 @@ has_sh_or_no_shebang_line() {
 USAGE="usage: $0 [<options>] <test directory>"
 
 urchin_help() {
-  echo
+  cat <<EOF
-  echo "$USAGE"
+
-  echo
+$USAGE
-  echo '-s <shell>  Invoke test scripts that either have no shebang line or'
+
-  echo '            shebang line "#!/bin/sh" with the specified shell.'
+-s <shell>  Invoke test scripts that either have no shebang line at all or
-  echo '-f          Force running even if the test directory'\''s name does not'
+            have shebang line "#!/bin/sh" with the specified shell.
-  echo '            contain the word "test".'
+-e          Stop running if any single test fails. This is helpful if you want
-  echo '-x          Run "$TEST_SHELL", falling back on /bin/sh. This might be'
+            to use Urchin to run things other than tests, such as a set of
-  echo '            useful in the shebang line (experimental).'
+            configuration scripts.
-  echo '-h          This help.'
+-f          Force running even if the test directory's name does not
-  echo
+            contain the word "test".
-  echo 'Go to https://github.com/tlevine/urchin for documentation on writing tests.'
+-h          This help.
-  echo
+
+Go to https://github.com/tlevine/urchin for documentation on writing tests.
+
+EOF
 }
 
 plural () {
@@ -166,22 +183,17 @@ urchin_molly_guard() {
 
 shell_for_sh_tests=
 force=false
+exit_on_fail=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 $?;;
         -h|--help) urchin_help
           exit 0;;
         -*) urchin_help >&2