blarg

HISTORY

@@ -4,9 +4,40 @@ HISTORY
 Version 0.0.7
 ---------------------
 
+### Molly-guard
 The Molly-guard is now more accepting. For example, you no longer need to
 pass -f in this case: https://github.com/creationix/nvm/issues/357
 
+### Skipping tests
+Previously, tests were run if they were executable and were otherwise marked
+as skipped. Now, an executable script can indicate that it is skipped by
+exiting with code 3.  For example, if a test requires some dependancy, it
+might look for the dependency and then skip if it does not see the dependency.
+It might look like this.
+
+    #!/bin/sh
+    if which inkscape; then
+      exit 3 # status code 3 for skip
+    fi
+    inkscape blah blah ...
+
+I chose status code 3 sort of arbitrarily at first, but it turns out that it
+would the appropriate status code if these tests were Nagios plugins, as the
+concept of skipping a test is similar to the Nagios concept of unknown service
+status (https://nagios-plugins.org/doc/guidelines.html#AEN78).
+
+### Run on a file
+It is now possible to run urchin on a single file.
+This occurred to me when I wanted to run
+
+    urchin test/fast/Unit\ tests/nvm_ls_current
+
+on the nvm tests. I wound up running this instead.
+
+    urchin test/fast/Unit\ tests/ | grep nvm_ls_current
+
+The Molly guard is assessed, and the corresponding setup, setup_dir,
+teardown, and teardown_dir files are run in the appropriate order.
 
 Version 0.0.6
 ---------------------

TODO

@@ -1,18 +1,6 @@
 Things I want
 =============
 
-Skip tests
--------------
-I want tests to be able to decide to skip themselves. For example, if a test
-requires some dependancy, it might look for the dependency and then skip if it
-does not see the dependency. It might look like this.
-
-    #!/bin/sh
-    if which parallel > /dev/null; then
-      exit 3 # status code 3 for skip
-    fi
-    parallel blah blah ...
-
 Test speed
 -------------
 Make tests run faster.
@@ -135,22 +123,6 @@ cleanly create and teardown temporary files.
 On the other hand, this could just be sourced explicitly in the test file,
 without the special setup and teardown feature.
 
-Run on a file
-----------------
-Presently you can run urchin only on a directory.
-It would be neat if you could run it on a file as well.
-
-This occurred to me when I wanted to run
-
-    urchin test/fast/Unit\ tests/nvm_ls_current
-
-on the nvm tests. I wound up running this instead.
-
-    urchin test/fast/Unit\ tests/ | grep nvm_ls_current
-
-The Molly guard would be assessed, and the corresponding setup, setup_dir,
-teardown, and teardown_dir files would be run in the appropriate order.
-
 Running automated tasks
 -------------------------
 Urchin might be appropriate for if you have lots of tasks that you want to run

tests/Single file/.wrappers/setup

@@ -0,0 +1 @@
+echo setup

tests/Single file/.wrappers/setup_dir

@@ -0,0 +1 @@
+echo setup_dir

tests/Single file/.wrappers/teardown

@@ -0,0 +1 @@
+echo teardown

tests/Single file/.wrappers/teardown_dir

@@ -0,0 +1 @@
+echo teardown_dir

tests/Single file/.wrappers/thetest

@@ -0,0 +1,2 @@
+echo thetest
+exit 1

tests/Single file/Run on a single file.

@@ -0,0 +1,3 @@
+#!/bin/sh
+../../urchin .test
+# This will exit 0 if it worked.

tests/Single file/The file must exist.

@@ -0,0 +1,2 @@
+#!/bin/sh
+! ../../urchin not-a-file

tests/Single file/The wrappers should be run.

@@ -0,0 +1,4 @@
+tmp=$(mktemp)
+echo "Using temp file $tmp"
+../../urchin .wrappers > $tmp
+diff $tmp .wrapper-expectation

tests/skip/.test/fail

@@ -0,0 +1 @@
+exit 1

tests/skip/.test/skip

@@ -0,0 +1 @@
+exit 3

tests/skip/.test/succeed

@@ -0,0 +1 @@
+exit 0

tests/skip/Skip on exit code 3.

@@ -0,0 +1 @@
+test $(../../urchin -t .test/ | grep -c SKIP) -eq 1

urchin

@@ -16,13 +16,6 @@ unset CDPATH
 # Urchin version number
 VERSION=0.0.6
 
-fullpath() {
-  (
-    cd -- "$1"
-    pwd
-  )
-}
-
 indent() {
   level="$1"
   if test "$level" -gt 0; then
@@ -103,6 +96,8 @@ recurse() {
       [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
       if [ $exit_code -eq 0 ]; then
         result=success
+      elif [ $exit_code -eq 3 ]; then
+        result=skip
       else
         result=fail
       fi
@@ -282,7 +277,7 @@ do
           which "$shell_for_sh_tests" > /dev/null || {
             echo "Cannot find specified shell: '$shell_for_sh_tests'" >&2
             urchin_help >&2
-            exit 2
+            exit 11
           } ;;
         -t) tap_format=true;;
         -h|--help) urchin_help
@@ -296,21 +291,17 @@ do
     shift
 done
 
-# Verify argument for main stuff
-if [ "$#" != '1' ] || [ ! -d "$1" ]
-  then
-  [ -n "$1" ] && [ ! -d "$1" ] && echo "Not a directory: '$1'" >&2
-  echo "$USAGE" >&2
-  exit 2
-fi
-
-# Constants
-logfile=$(fullpath "$1")/.urchin.log
-stdout_file=$(fullpath "$1")/.urchin_stdout
-
 # Run or present the Molly guard.
-if fullpath "$1" | grep -Fi 'test' > /dev/null || $force
+thetest=$(readlink -f "$1")
-  then
+if echo "$thetest" | grep -Fi 'test' > /dev/null || $force; then
+  if test -d "$1"; then
+    d="$thetest"
+  else
+    d=$(echo "$thetest" | sed 's/\/[^\/]\{1,\}$//')
+    cd "$d"
+  fi
+  logfile="$d/.urchin.log"
+  stdout_file="$d/.urchin_stdout"
   urchin_go "$1" "$shell_for_sh_tests"
 else
   urchin_molly_guard