Automatic commit with j

HISTORY

@@ -4,11 +4,9 @@ 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
@@ -26,19 +24,6 @@ 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

@@ -19,6 +19,11 @@ 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.
@@ -123,6 +128,29 @@ 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.
+
+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

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

tests/Single file/.wrappers/setup

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

tests/Single file/.wrappers/setup_dir

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

tests/Single file/.wrappers/teardown

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

tests/Single file/.wrappers/teardown_dir

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

tests/Single file/.wrappers/thetest

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

tests/Single file/Run on a single file.

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

tests/Single file/The file must exist.

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

tests/Single file/The wrappers should be run.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,8 @@
+#!/bin/sh
+set -e
+
+tmp=$(mktemp -d)
+../../urchin --root $tmp 2>&1 | grep suppress
+../../urchin --root $tmp 2>&1 | grep "'$tmp/.urchin'"
+../../urchin --root $tmp
+rm -R "$tmp"

tests/Test root contains .urchin./Wrong filename

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

urchin

@@ -7,7 +7,8 @@
 # No part of urchin, including this file, may be copied, modified, propagated,
 # or distributed except according to the terms contained in the COPYING file.
 
-
+# Stop on error.
+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,6 +17,39 @@ unset CDPATH
 # Urchin version number
 VERSION=0.0.6
 
+urchin_root() {
+  # Call recursively but remember the original argument.
+  current="$1"
+  if test -n "$2"; then
+    orig="$2"
+  else
+    orig="$1"
+  fi
+
+  if ! test -e "$current"; then
+    echo "$current: No such file or directory">&2
+    exit 1
+  elif test -f "$current"; then
+    urchin_root "$(dirname "$current")" "$orig"
+  elif test -d "$current"/.urchin; then
+    echo "$current"
+  elif test "$(readlink -f "$current")" = /; then
+    if test -d "$orig"; then
+      origdir="$orig"
+    else
+      origdir=$(dirname "$orig")
+    fi
+    echo "You must create a .urchin directory to specify the urchin root.
+Run something like this, and then run urchin again.
+
+  mkdir '$origdir/.urchin'
+" >&2
+    exit 1
+  else
+    urchin_root "$current"/.. "$orig"
+  fi
+}
+
 indent() {
   level="$1"
   if test "$level" -gt 0; then
@@ -23,16 +57,36 @@ indent() {
   fi
 }
 
+escape_slashes() {
+  echo "$1" | sed s+/+\\\\/+g
+}
+
+get_stdout_file() {
+  root="$(readlink -f "$1")"
+  test_file="$(readlink -f "$2")"
+  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"
+  root="$4"
 
   [ "$potential_test" = 'setup_dir' ] && return
   [ "$potential_test" = 'teardown_dir' ] && return
   [ "$potential_test" = 'setup' ] && return
   [ "$potential_test" = 'teardown' ] && return
 
+  stdout_file="$(get_stdout_file "$root" "$potential_test")"
+  mkdir -p "$(dirname "$stdout_file")"
+
   [ $indent_level -eq 0 ] && : > "$stdout_file"
 
   if [ -d "$potential_test" ]
@@ -60,7 +114,7 @@ recurse() {
         [ -f setup ] && [ -x setup ] && ./setup >> "$stdout_file"
 
         # $2 instead of $indent_level so it doesn't clash
-        recurse "${test}" $(( $2 + 1 )) "$shell_for_sh_tests"
+        recurse "${test}" "$(( $2 + 1 ))" "$shell_for_sh_tests" "$root"
         exit_code=$?
 
         if $exit_on_fail && test $exit_code -ne 0; then
@@ -154,7 +208,6 @@ recurse() {
       return 1
     fi
   fi
-  [ $indent_level -eq 0 ] && rm "$stdout_file"
 }
 
 has_sh_or_no_shebang_line() {
@@ -184,6 +237,7 @@ $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.
@@ -203,53 +257,6 @@ plural () {
   fi
 }
 
-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)
-
-  # Determine the environment variable to define for test scripts
-  # that reflects the specified or implied shell to use for shell-code tests.
-  #  - Set it to the shell specified via -s, if any.
-  #  - Otherwise, use its present value, if non-empty.
-  #  - Otherwise, default to '/bin/sh'.
-  if [ -n "$2" ]
-    then
-    TEST_SHELL="$2"
-  elif [ -z "$TEST_SHELL" ]
-    then
-    TEST_SHELL='/bin/sh'
-  fi
-
-  recurse "$1" 0 "$2"  # test folder -- indentation level -- [shell to invoke test scripts with]
-
-  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."
-    printf '%s\n' "$skipped $(plural test "$skipped") skipped."
-
-    # If tests failed, print the message in red, otherwise in green.
-    [ $failed -gt 0 ] && printf '\033[31m' || printf '\033[32m'
-
-    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() {
   {
     echo
@@ -271,6 +278,10 @@ do
     case "$1" in
         -e) exit_on_fail=true;;
         -f) force=true;;
+        -r|--root)
+          shift
+          urchin_root "$1"
+          exit;;
         -s)
           shift
           shell_for_sh_tests=$1
@@ -291,18 +302,67 @@ 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 11
+fi
+
 # Run or present the Molly guard.
-thetest=$(readlink -f "$1")
-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"
+root="$(urchin_root "$1")"
+if basename "$(readlink -f "$root")" |
+  grep -Fi 'test' > /dev/null || $force; then
+  logfile="$(readlink -f "$root")/.urchin/.log"
+  echo > "$logfile"
+
+  if "$tap_format"; then
+    printf \#\ 
   fi
-  logfile="$d/.urchin.log"
-  stdout_file="$d/.urchin_stdout"
-  urchin_go "$1" "$shell_for_sh_tests"
+  echo Running tests at $(date +%Y-%m-%dT%H:%M:%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.
+  #  - Set it to the shell specified via -s, if any.
+  #  - Otherwise, use its present value, if non-empty.
+  #  - Otherwise, default to '/bin/sh'.
+  if [ -n "$shell_for_sh_tests" ]; then
+    TEST_SHELL="$shell_for_sh_tests"
+  elif [ -z "$TEST_SHELL" ]; then
+    TEST_SHELL='/bin/sh'
+  fi
+
+  # 1 test folder
+  # 2 indentation level
+  # 3 shell to invoke test scripts with
+  # 4 urchin root
+  recurse "$1" 0 "$shell_for_sh_tests" "$root"
+
+  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."
+    printf '%s\n' "$skipped $(plural test "$skipped") skipped."
+
+    # If tests failed, print the message in red, otherwise in green.
+    [ $failed -gt 0 ] && printf '\033[31m' || printf '\033[32m'
+
+    printf '%s\n' "$failed $(plural test "$failed") failed."
+    printf '\033[m'
+  fi
+  rm -f "$logfile"
+  test -z "$failed" || test "$failed" -eq '0'
+
 else
   urchin_molly_guard
 fi