source setup and teardown

HISTORY

@@ -7,22 +7,6 @@ Version 0.0.7
 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
 
-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).
 
 Version 0.0.6
 ---------------------

TODO

@@ -19,11 +19,6 @@ Hmm or maybe there's a compromise: Tell people to mount /tmp as a tmpfs so
 that temp files are fast. Maybe allow people to set some other directory as
 the temporary file place, in case they want a different tmpfs location.
 
-In order to run things in parallel, we have to change how we do the
-stdout_file. I think it's easiest to create separate files for each test and
-to save them in testroot/.urchin/stdout/$filename. The test root would be
-defined as the closest ancestor containing a .urchin directory.
-
 Options
 -------------
 I want long options. For example, there's presently -f and -e.
@@ -144,13 +139,6 @@ on the nvm tests. I wound up running this instead.
 The Molly guard would be assessed, and the corresponding setup, setup_dir,
 teardown, and teardown_dir files would be run in the appropriate order.
 
-In order to know how far up the tree to evaluate the setup, &c. files,
-I think it would make sense to require that a ".urchin" file be placed in the
-root of the tests. Urchin would keep going up until it sees this file, and it
-would evaluate the appropriate setup, &c. files from there down to the
-particular test file of interest. We would also use this for testing
-directtories more correctly.
-
 Running automated tasks
 -------------------------
 Urchin might be appropriate for if you have lots of tasks that you want to run

tests/.urchin/.gitignore

@@ -1,2 +0,0 @@
-*
-!.gitignore

tests/Test root contains .urchin./.meta-assess

@@ -1,6 +0,0 @@
-#!/bin/sh
-
-observed=$(../../urchin "$1" .testsuite/a/b)
-expected=.testsuite/a/b/../..
-
-test "$observed" = "$expected"

tests/Test root contains .urchin./.testsuite/.urchin/.gitignore

@@ -1,2 +0,0 @@
-*
-!.gitignore

tests/Test root contains .urchin./.testsuite/a/b/c/testcase

@@ -1 +0,0 @@
-#!/usr/bin/env true

tests/Test root contains .urchin./Assess root on a file.

@@ -1,2 +0,0 @@
-#!/bin/sh
-../../urchin --root .testsuite/a/b/c/testcase

tests/Test root contains .urchin./Assess root with --root.

@@ -1,2 +0,0 @@
-#!/bin/sh
-./.meta-assess --root

tests/Test root contains .urchin./Assess root with -r.

@@ -1,2 +0,0 @@
-#!/bin/sh
-./.meta-assess -r

tests/Test root contains .urchin./No root set

@@ -1,2 +0,0 @@
-#!/bin/sh
-../../urchin --root /bin 2>&1 | grep "'/bin/.urchin'"

tests/Test root contains .urchin./Wrong filename

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

tests/get_stdout_file/t

@@ -1,4 +0,0 @@
-#!/bin/sh
-
-I_AM_SOURCING_URCHIN_IN_A_TEST=true . ../../urchin
-test $(get_stdout_file t) = aoeu

tests/skip/.test/fail

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

tests/skip/.test/skip

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

tests/skip/.test/succeed

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

tests/skip/Skip on exit code 3.

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

urchin

@@ -7,7 +7,7 @@
 # No part of urchin, including this file, may be copied, modified, propagated,
 # or distributed except according to the terms contained in the COPYING file.
 
-set +e
+
 
 # Make sure that CDPATH isn't set, as it causes `cd` to behave unpredictably -
 # notably, it can produce output, which breaks fullpath().
@@ -16,42 +16,11 @@ unset CDPATH
 # Urchin version number
 VERSION=0.0.6
 
-urchin_root() {
-  # Call recursively but remember the original argument.
-  current="$(remove_trailing_slash "$1")"
-  if test -n "$2"; then
-    orig="$2"
-  else
-    orig="$1"
-  fi
-
-  if test "$(readlink -f -- "$1")" = /; then
-    # Stop traversing upwards at /
-    if test -d "$orig"; then
-      origdir="$orig"
-    else
-      origdir=$(dirname "$orig")
-    fi
-    echo "You need to create the .urchin directory in the root of your tests,
-maybe like this:
-
-  mkdir '$(readlink -f -- "$(remove_trailing_slash "$origdir")")/.urchin'
-" >&2
-    return 1
-  elif ! test -e "$current"; then
-    echo "$current: No such file or directory">&2
-    return 1
-  elif test -f "$current"; then
-    urchin_root "$(dirname "$current")" "$orig"
-  elif test -d "$current"/.urchin; then
-    remove_trailing_slash "$current"
-  elif test "$current" != . && test "$current" != .. &&
-    echo "$current" | grep '^\.' && > /dev/null; then
-    # Stop traversing upwards at hidden directories.
-    urchin_root / "$orig"
-  else
-    urchin_root "$current"/.. "$orig"
-  fi
+fullpath() {
+  (
+    cd -- "$1"
+    pwd
+  )
 }
 
 indent() {
@@ -61,40 +30,16 @@ indent() {
   fi
 }
 
-remove_trailing_slash() {
-  echo "$1" | sed s/\\/$//
-}
-
-escape_slashes() {
-  echo "$1" | sed s+/+\\\\/+g
-}
-
-get_stdout_file() {
-  root="$(readlink -f -- "$(urchin_root "$1")")"
-  test_file="$(readlink -f -- "$1")"
-  eroot="$(escape_slashes "$root")"
-  base="$(echo "$test_file" | sed "s/^$eroot/$eroot\/.urchin/")"
-  if test -d "$1"; then
-    echo "$base"/.index
-  else
-    echo "$base"
-  fi
-}
-
 recurse() {
   potential_test="$1"
   indent_level="$2"
   shell_for_sh_tests="$3"
 
-  [ "$potential_test" = '.urchin' ] && return
   [ "$potential_test" = 'setup_dir' ] && return
   [ "$potential_test" = 'teardown_dir' ] && return
   [ "$potential_test" = 'setup' ] && return
   [ "$potential_test" = 'teardown' ] && return
 
-  stdout_file="$(get_stdout_file "$potential_test")"
-  mkdir -p "$(dirname "$stdout_file")"
-
   [ $indent_level -eq 0 ] && : > "$stdout_file"
 
   if [ -d "$potential_test" ]
@@ -110,7 +55,7 @@ recurse() {
 
     (
       cd -- "$potential_test"
-      [ -f setup_dir ] && [ -x setup_dir ] && ./setup_dir >> "$stdout_file"
+      [ -f setup_dir ] && [ -x setup_dir ] && . ./setup_dir >> "$stdout_file"
 
       if [ -n "$ZSH_VERSION" ]; then
         # avoid "no matches found: *" error when directories are empty
@@ -119,23 +64,21 @@ recurse() {
 
       for test in *
         do
-        [ -f setup ] && [ -x setup ] && ./setup >> "$stdout_file"
+        [ -f setup ] && [ -x setup ] && . ./setup >> "$stdout_file"
 
         # $2 instead of $indent_level so it doesn't clash
-        set +e
-        recurse "${test}" "$(( $2 + 1 ))" "$shell_for_sh_tests"
+        recurse "${test}" $(( $2 + 1 )) "$shell_for_sh_tests"
         exit_code=$?
-        set -e
 
         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"
+          [ -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"
+        [ -f teardown ] && [ -x teardown ] && . ./teardown >> "$stdout_file"
       done
-      [ -f teardown_dir ] && [ -x teardown_dir ] && ./teardown_dir >> "$stdout_file"
+      [ -f teardown_dir ] && [ -x teardown_dir ] && . ./teardown_dir >> "$stdout_file"
     )
     if $tap_format; then
       indent $indent_level | sed 's/  /#/g'
@@ -146,7 +89,7 @@ recurse() {
   else
     if [ -x "$potential_test" ]
       then
-      [ -f setup ] && [ -x setup ] && ./setup >> "$stdout_file"
+      [ -f setup ] && [ -x setup ] && . ./setup >> "$stdout_file"
 
       # Run the test
       if [ -n "$shell_for_sh_tests" ] && has_sh_or_no_shebang_line ./"$potential_test"
@@ -157,11 +100,9 @@ recurse() {
       fi
       exit_code="$?"
 
-      [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
+      [ -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
@@ -218,6 +159,7 @@ recurse() {
       return 1
     fi
   fi
+  [ $indent_level -eq 0 ] && rm "$stdout_file"
 }
 
 has_sh_or_no_shebang_line() {
@@ -247,7 +189,6 @@ $USAGE
             contain the word "test".
 -t          Format output in Test Anything Protocol (TAP)
 -h, --help  This help.
--r, --root  Print the Urchin root for a particular file or directory.
 -v          Display the version number.
 
 Go to https://github.com/tlevine/urchin for documentation on writing tests.
@@ -268,11 +209,12 @@ plural () {
 }
 
 urchin_go() {
+  rm -f "$logfile"
   if "$tap_format"; then
     printf \#\ 
   fi
   echo Running tests at $(date +%Y-%m-%dT%H:%M:%S)
-  start="$(date +%s)"
+  start=$(date +%s)
 
   # Determine the environment variable to define for test scripts
   # that reflects the specified or implied shell to use for shell-code tests.
@@ -287,10 +229,7 @@ urchin_go() {
     TEST_SHELL='/bin/sh'
   fi
 
-  # 1 test folder
-  # 2 indentation level
-  # 3 shell to invoke test scripts with
-  recurse "$1" 0 "$2"
+  recurse "$1" 0 "$2"  # test folder -- indentation level -- [shell to invoke test scripts with]
 
   finish=$(date +%s)
   elapsed=$(($finish - $start))
@@ -312,7 +251,7 @@ urchin_go() {
     printf '%s\n' "$failed $(plural test "$failed") failed."
     printf '\033[m'
   fi
-# rm -f "$logfile"
+  rm -f "$logfile"
   test -z "$failed" || test "$failed" -eq '0'
 }
 
@@ -328,57 +267,51 @@ urchin_molly_guard() {
   exit 1
 }
 
-if test -z "$I_AM_SOURCING_URCHIN_IN_A_TEST"; then
-  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;;
-          -r|--root)
-            shift
-            urchin_root "$1"
+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
+          } ;;
+        -t) tap_format=true;;
+        -h|--help) urchin_help
+          exit 0;;
+        -v) echo "$VERSION"
             exit;;
-          -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 11
-            } ;;
-          -t) tap_format=true;;
-          -h|--help) urchin_help
-            exit 0;;
-          -v) echo "$VERSION"
-              exit;;
-          -*) urchin_help >&2
-              exit 1;;
-          *)  break;;
-      esac
-      shift
-  done
+        -*) urchin_help >&2
+            exit 1;;
+        *)  break;;
+    esac
+    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 11
-  fi
-
-  # Run or present the Molly guard.
-  if ! urchin_root "$1" > /dev/null; then
-    exit 1
-  elif basename "$(readlink -f -- "$(urchin_root "$1")")" |
-    grep -Fi 'test' > /dev/null || $force; then
-    logfile="$(readlink -f -- "$(urchin_root "$1")/.urchin/.log")"
-    printf '' > "$logfile"
-    urchin_go "$1" "$shell_for_sh_tests"
-  else
-    urchin_molly_guard
-  fi
+# 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
+  then
+  urchin_go "$1" "$shell_for_sh_tests"
+else
+  urchin_molly_guard
 fi