source setup and teardown

add Thomas Levine and Michael Klement

COPYING

@@ -1,3 +1,5 @@
+Copyright (c) 2013, 2014, 2015, 2016 Thomas Levine
+Copyright (c) 2014, Michael Klement
 Copyright (c) 2012, ScraperWiki Limited
 All rights reserved.
 

HISTORY

@@ -1,6 +1,13 @@
 HISTORY
 =======
 
+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
+
+
 Version 0.0.6
 ---------------------
 
@@ -14,6 +21,9 @@ Version 0.0.6
 * Remove the undocumented, experimental -x flag now that shall exists.
 * Display version number with the -v flag.
 * Document why Urchin is called "Urchin"
+* Update TODO
+* Support mksh (Change a printf command.)
+* Make long lines shorter.
 
 These changes are made somewhat separately in the branches "exit-on-fail",
 "remove-urchin-x", "tap", and "update-readme". They are rebased into one

TODO

@@ -1,13 +1,6 @@
 Things I want
 =============
 
-Molly guard
--------------
-The Molly-guard should be more accepting so that people don't have to use it
-all the time and thus get used to using it. For example, you shouldn't need to
-pass -f in this case.
-https://github.com/creationix/nvm/issues/357
-
 Test speed
 -------------
 Make tests run faster.
@@ -115,3 +108,45 @@ Nagios plugins
 It would be cool to run Nagios plugins with Urchin. This is already possible,
 actually, but it might be worth giving some special thought to it.
 https://nagios-plugins.org/doc/guidelines.html
+
+Source setup and teardown
+--------------------
+If setup and teardown are sourced instead of executed, maybe we can more
+cleanly create and teardown temporary files.
+
+    (
+      . ./setup
+      ./$thetestfile
+      . ./teardown
+    )
+
+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
+periodically; add an urchin call to your crontab, and call all of your other
+tasks with urchin. Here are some features that might make urchin better for
+this sort of thing.
+                                                      
+* Time how long each test/job takes
+* Optionally kill tests/jobs after a specific timeout threshold
+* Send output of different tests/jobs to different files for each file
+  descriptor (STDOUT, STDERR)

alternatives

@@ -1,2 +1,9 @@
 Totally different syntax and similar features, plus TAP output
 https://github.com/sstephenson/bats
+
+Relatively similar interface
+https://github.com/mlafeldt/sharness
+
+Lists of alternatives
+https://thomaslevine.com/!/shell-testing/
+https://github.com/mlafeldt/sharness#alternatives

readme.md

@@ -36,7 +36,7 @@ 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/tlevine/urchin/master/urchin
+    wget https://raw.githubusercontent.com/tlevine/urchin/v0.0.6/urchin
     chmod +x urchin
 
 Urchin can be installed with npm too.

tests/Urchin should do a sanity check so that directories like the user home are not specified as tests./.chainsaw/successful test

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-exit 0

tests/Urchin should do a sanity check so that directories like the user home are not specified as tests./.foo/test/bar/baz

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

tests/Urchin should do a sanity check so that directories like the user home are not specified as tests./.test/successful test

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

tests/Urchin should do a sanity check so that directories like the user home are not specified as tests./The Molly-guard should accept arguments that contain test in the middle.

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+../../urchin .foo/test/bar

tests/Urchin should do a sanity check so that directories like the user home are not specified as tests./Urchin should warn if it is run on something that does not look like a test.

@@ -1,3 +1,5 @@
 #!/bin/sh
 
-! ../../urchin ./.chainsaw
+tmp=$(mktemp -d)/blah
+echo '#!/usr/bin/env true' > $tmp
+! ../../urchin $tmp

urchin

@@ -1,7 +1,16 @@
 #!/bin/sh
 
-# Make sure that CDPATH isn't set, as it causes `cd` to behave unpredictably - notably, it can produce output,
-# which breaks fullpath().
+# This file is part of urchin. It is subject to the license terms in the
+# COPYING file found in the top-level directory of this distribution or at
+# https://raw.githubusercontent.com/tlevine/urchin/master/COPYING
+
+# No part of urchin, including this file, may be copied, modified, propagated,
+# or distributed except according to the terms contained in the COPYING file.
+
+
+
+# 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
@@ -46,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
@@ -55,21 +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
         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"
+          [ -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'
@@ -80,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"
@@ -91,7 +100,7 @@ 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
       else
@@ -133,7 +142,10 @@ recurse() {
           # 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.
+
+          # Print output captured from failed test in red.
+          printf '\033[31m'
+
           cat "$stdout_file"
           printf '\033[0m'
         ;;
@@ -151,8 +163,13 @@ recurse() {
 }
 
 has_sh_or_no_shebang_line() {
-  head -n 1 "$1" | grep -vqE '^#!' && return 0 # no shebang line at all
-  head -n 1 "$1" | grep -qE '^#![[:blank:]]*/bin/sh($|[[:blank:]])' && return 0  # shebang line is '#!/bin/sh' or legal variations thereof
+  # no shebang line at all
+  head -n 1 "$1" | grep -vqE '^#!' && return 0
+
+  # shebang line is '#!/bin/sh' or legal variations thereof
+  head -n 1 "$1" | grep -qE '^#![[:blank:]]*/bin/sh($|[[:blank:]])' &&
+    return 0  
+
   return 1
 }
 
@@ -227,7 +244,10 @@ urchin_go() {
     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.
+
+    # 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
@@ -259,8 +279,11 @@ do
         -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; }
-          ;;
+          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;;
@@ -286,7 +309,7 @@ logfile=$(fullpath "$1")/.urchin.log
 stdout_file=$(fullpath "$1")/.urchin_stdout
 
 # Run or present the Molly guard.
-if basename "$(fullpath "$1")" | grep -Fi 'test' > /dev/null || $force
+if fullpath "$1" | grep -Fi 'test' > /dev/null || $force
   then
   urchin_go "$1" "$shell_for_sh_tests"
 else