change tests that need series flag to be series

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

@@ -0,0 +1,164 @@
+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.
+https://github.com/bike-barn/hermit/issues/62
+
+First, easier thing is probably to run tests in parallel.
+
+Second, also easier thing is to tell people to save things to RAM rather than
+disk whenever they can.
+
+Third, harder thing is to put the test suite in RAM automatically. Maybe the
+whole test directory, which includes fixtures, gets copied to a tmpfs if one
+exists.
+
+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.
+
+Options
+-------------
+I want long options. For example, there's presently -f and -e.
+I want to make them -f|--force and -e|--exit.
+
+Environment variables
+-------------
+Do something to make it easier to debug environment variables, because that is
+often confusing.
+https://github.com/creationix/nvm/issues/719
+https://github.com/creationix/nvm/issues/589
+
+Documenting that people should run "env" when their tests fail might be good
+enough.
+
+Licensing and copyright
+------------------------
+* Reference all owners and years in the Copyright file
+* Consider copyleft licenses
+* Add license notices to other files if necessary
+
+Packaging
+------------
+Package for package managers.
+
+* I want NixOS, of course.
+* Debian is probably the big one.
+
+Other interesting package managers
+
+* Update the npm package
+* Homebrew (for Mac)
+
+Windows
+----------
+Try running Urchin in Windows somehow. Interpreters include
+
+* CygWin (https://www.cygwin.com/)
+* MSYS (http://mingw.org/wiki/msys)
+* GNU on Windows (https://github.com/bmatzelle/gow/wiki)
+* Git for Windows (https://git-scm.com/download/win)
+* win-bash (http://win-bash.sourceforge.net/)
+
+Consider copyleft licenses
+----------
+ScraperWiki owns the original version of Urchin (Thomas Levine did the early
+work as part of his work for ScraperWiki.) and originally licensed it under an
+MIT-style license. Other people made changes after this original ScraperWiki
+version. As of January 2016, they are just Thomas Levine (when he wasn't
+working for ScraperWiki) and Michael Klement.
+
+The original license was MIT just because that's what ScraperWiki put on
+everything. Should we change the license?
+
+The MIT-style license grants pretty much all rights. It says that you need
+to attribute when you redistribute source code, but you don't
+necessarily have to redistribute source code.
+
+A copyleft license adds the restriction that modified versions of the
+code need to be licensed under the same license. GNU licenses in
+particular require that source code be released if non-source versions are
+released, and the different GNU licenses differ in what how the
+non-source version is defined. (The original, GPL, discusses compiled
+binaries.) Copyleft doesn't mean anything specific for commercial use.
+
+MIT-licensed code can be modified and then licensed as GPL, because MIT
+license allows that, but GPL code can't be modified as MIT, because MIT
+doesn't allow that. And if we get all of the authors to agree on it, we
+can always add whatever crazy license we want, regardless of what we
+have already.
+
+The distinction between MIT-style and GNU-something might matter quite little
+in the case of Urchin.
+
+1. Urchin is written in an interpreted language (shell), so it might be
+   hard to distribute usefully without providing the source code.
+2. Urchin just runs tests; it doesn't get compiled with the rest of the
+   code (also because it's in shell). Thus, I think a GPL license on
+   Urchin wouldn't infect the code being tested.
+
+This is as far as I have gotten with contemplating license changes. For now
+we're sticking with the original MIT-style license, but it's easy to change
+licenses later.
+
+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

cross-shell-tests

@@ -2,7 +2,7 @@
 # Run urchin in a bunch of different shells,
 # including a shell that isn't quite POSIX-compatible (zsh)
 
-for shell in dash bash ksh zsh; do
+for shell in dash bash mksh ksh zsh; do
   if which $shell > /dev/null 2> /dev/null; then
     echo
     echo Running urchin tests in $shell

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.
@@ -169,9 +169,3 @@ It does something similar, but the interface may be more intuitive.
 ## 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/Exit on fail if -e is passed.

@@ -1,5 +1,5 @@
 tmp=$(mktemp)
-../urchin -e -f ./.die-on-fail > $tmp
+../urchin -e -b -f ./.die-on-fail > $tmp
 result=$?
 
 grep '1 should run.' $tmp

tests/TAP/Running with -t should produce TAP output.

@@ -1,4 +1,4 @@
 tmp=$(mktemp)
 
-../../urchin -t .testsuite/ | sed 1d > $tmp
+../../urchin -b -t .testsuite/ | sed 1d > $tmp
 diff $tmp .expected-output

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
+#!/usr/bin/env true
-
-exit 0

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,
+# This file is part of urchin. It is subject to the license terms in the
-# which breaks fullpath().
+# 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
@@ -16,7 +25,9 @@ fullpath() {
 
 indent() {
   level="$1"
-  printf "%$((2 * ${level}))s"
+  if test "$level" -gt 0; then
+    printf "%$((2 * ${level}))s"
+  fi
 }
 
 recurse() {
@@ -56,17 +67,23 @@ 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"
+        (
-        exit_code=$?
+          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"
+          exit $exit_code
-          return 1
+        ) &
-        fi
 
-        [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
+        if $single_process; then
+          wait $!
+          exit_code=$?
+          if $exit_on_fail && test $exit_code -ne 0; then
+            [ -f teardown_dir ] && [ -x teardown_dir ] && ./teardown_dir >> "$stdout_file"
+            return 1
+          fi
+        fi
       done
+      wait
       [ -f teardown_dir ] && [ -x teardown_dir ] && ./teardown_dir >> "$stdout_file"
     )
     if $tap_format; then
@@ -87,6 +104,7 @@ recurse() {
       else
         TEST_SHELL="$TEST_SHELL" ./"$potential_test" > "$stdout_file" 2>&1
       fi
+
       exit_code="$?"
 
       [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
@@ -131,7 +149,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'
         ;;
@@ -149,8 +170,13 @@ recurse() {
 }
 
 has_sh_or_no_shebang_line() {
-  head -n 1 "$1" | grep -vqE '^#!' && return 0 # no shebang line at all
+  # 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
+  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
 }
 
@@ -163,6 +189,8 @@ $USAGE
 
 -s <shell>  Invoke test scripts that either have no shebang line at all or
             have shebang line "#!/bin/sh" with the specified shell.
+-b, --series   Run all tests in series in a single process. The default
+               is to run tests from the same directory in parallel.
 -e          Stop running if any single test fails. This is helpful if you want
             to use Urchin to run things other than tests, such as a set of
             configuration scripts.
@@ -225,7 +253,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
@@ -245,6 +276,7 @@ urchin_molly_guard() {
   exit 1
 }
 
+single_process=false
 shell_for_sh_tests=
 force=false
 exit_on_fail=false
@@ -252,13 +284,17 @@ tap_format=false
 while [ $# -gt 0 ]
 do
     case "$1" in
+        -b|--series) single_process=true;;
         -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; }
+          which "$shell_for_sh_tests" > /dev/null || {
-          ;;
+            echo "Cannot find specified shell: '$shell_for_sh_tests'" >&2
+            urchin_help >&2
+            exit 3
+          } ;;
         -t) tap_format=true;;
         -h|--help) urchin_help
           exit 0;;
@@ -276,7 +312,12 @@ if [ "$#" != '1' ] || [ ! -d "$1" ]
   then
   [ -n "$1" ] && [ ! -d "$1" ] && echo "Not a directory: '$1'" >&2
   echo "$USAGE" >&2
-  exit 2
+  exit 3
+fi
+
+if $exit_on_fail && ! $single_process; then
+  echo 'You must specify -b/--series in order to use -e.' >&2
+  exit 3
 fi
 
 # Constants
@@ -284,7 +325,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