source setup and teardown

add Thomas Levine and Michael Klement

.gitignore

@@ -1 +0,0 @@
-.urchin_stdout

AUTHORS

@@ -0,0 +1,9 @@
+Authors
+-------
+David Jones
+Michael Klement
+Thomas Levine
+
+Maintainer
+-------
+Thomas Levine <_@thomaslevine.com>

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,18 +1,59 @@
-History
+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
 
 
-Not done
+Version 0.0.6
-------
+---------------------
-We made the colors brighter.
 
-We allowed for multiple tests to be written in a file
+* Produce TAP output with the -t flag.
+* Add a + sign in front of directories in the normal output so that they
+  line up with non-directories.
+* Display skipped tests in the normal output and in the TAP output.
+* Correct some things in the documentation.
+* Rearrange things in the documentation to be more clear.
+* Pass the -e flag to exit urchin if any single test fails.
+* 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.
 
-We added flags for verbosity and for Molly guards
+These changes are made somewhat separately in the branches "exit-on-fail",
+"remove-urchin-x", "tap", and "update-readme". They are rebased into one
+branch, "tlevine-2016-02", for merging into "master".
 
-Done
+Version 0.0.5
------
+---------------------
+* urchin now unsets `CDPATH`.
+* The documentation for `urchin -x` was removed because it was confusing.
 
-We adjusted the input parameters so it is harder to accidentally run all executible files in your home directory.
+Version 0.0.4
+---------------------
+* Switch urchin -x to urchin -sh and fix some problems with it
+* Documentation
+
+Version 0.0.3
+---------------------
+General tidying
+
+Run with different shells in three ways
+
+* urchin -s
+* $TEST_SHELL variable with $TEST_SHELL
+* $TEST_SHELL variable with urchin -sh
+
+Set NULL_GLOB so zsh doesn't print a warning.
+
+Before version 0.0.3
+----------------------
+We adjusted the input parameters so it is harder to accidentally run all executable files in you
+r home directory.
 
 We added directory-based indents.

TODO

@@ -0,0 +1,152 @@
+Things I want
+=============
+
+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

@@ -0,0 +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,11 +2,11 @@
 # 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
-    $shell urchin tests | tail -n 2
+    $shell urchin -s $shell tests | tail -n 4
   else
     echo
     echo Skipping $shell because it is not in the PATH

package.json

@@ -1,26 +1,32 @@
 {
   "name": "urchin",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "description": "Test framework for shell",
   "main": "urchin",
   "directories": {
     "test": "tests"
   },
   "scripts": {
-    "test": "./urchin tests"
+    "test": "export PATH=\"$PWD:$PATH\" && urchin tests"
   },
   "bin": "./urchin",
   "repository": {
     "type": "git",
-    "url": "git://github.com/scraperwiki/urchin.git"
+    "url": "git://github.com/tlevine/urchin.git"
   },
   "keywords": [
     "shell",
     "test",
     "testing"
   ],
-  "author": "ScraperWiki Limited <feedback@scraperwiki.com>",
+  "author": "Thomas Levine <_@thomaslevine.com>",
-  "license": "BSD",
+  "contributors": [
-  "readmeFilename": "readme.md",
+    {"name": "Thomas Levine", "email": "_@thomaslevine.com"},
-  "gitHead": "015052dcfd7152a0df037bef1bc5452e0c956695"
+    {"name": "David Jones", "email": "drj@pobox.com"},
+    {"name": "Francis Irving", "email": "francis@flourish.org"},
+    {"name": "Zarino Zappia", "email": "mail@zarino.co.uk"},
+    {"name": "Tom Mortimer-Jones", "email": "tom@morty.co.uk"},
+    {"name": "Michael Klement", "email": "mklement0@gmail.com"}
+  ],
+  "license": "BSD"
 }

readme.md

@@ -4,37 +4,42 @@
     / /_/ / /  / /__/ / / / / / / /
     \__,_/_/   \___/_/ /_/_/_/ /_/ 
 
-Urchin is a test framework for shell. It is implemented in
+Urchin is a file-based test harness, normally used for testing shell programs.
-portable /bin/sh and should work on GNU/Linux, Mac OS X, and
+It is written in portable shell and should thus work on GNU/Linux, BSD
-other Unix platforms.
+(including Mac OS X), and other Unix-like platforms.
+
+Urchin is called "Urchin" because
+[sea urchins](https://en.wikipedia.org/wiki/Sea_urchin)
+have shells called "tests".
 
 ## Try it out
 Urchin's tests are written in Urchin, so you can run them to see what Urchin
 is like. Clone the repository
 
-    git clone git://github.com/scraperwiki/urchin.git
+    git clone git://github.com/tlevine/urchin.git
 
 Run the tests
 
     cd urchin
     ./urchin tests
 
-The above command will run the tests in your systems default
+The above command will run the tests in your system's default
 shell, /bin/sh (on recent Ubuntu this is dash, but it could be
-ksh or bash on other systems); to test cross-shell compatibility,
+ksh or bash on other systems); to test urchin's cross-shell compatibility,
 run this:
 
     cd urchin
     ./cross-shell-tests
 
-## Globally
+## Install
-Download Urchin like so (as root) (or use npm, below):
+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/scraperwiki/urchin/master/urchin
+    wget https://raw.githubusercontent.com/tlevine/urchin/v0.0.6/urchin
     chmod +x urchin
 
-Can be installed with npm too:
+Urchin can be installed with npm too.
 
     npm install -g urchin
 
@@ -42,6 +47,8 @@ Now you can run it.
 
     urchin <test directory>
 
+Run `urchin -h` to get command-line help.
+
 ## Writing tests
 Make a root directory for your tests. Inside it, put executable files that
 exit `0` on success and something else on fail. Non-executable files and hidden
@@ -83,3 +90,82 @@ within the particular directory, and the `teardown` file is run right after.
 Files are only run if they are executable, and files beginning with `.` are
 ignored. Thus, fixtures and libraries can be included sloppily within the test
 directory tree. The test passes if the file exits 0; otherwise, it fails.
+
+Tests files and subdirectories are run in ASCIIbetical order within each
+directory; that is,
+urchin looks for files within a directory in the following manner.
+
+    for file in *; do
+      do_something_with_test_file $file
+    done
+
+### Writing cross-shell compatibility tests for testing shell code
+
+While you could write your test scripts to explicitly invoke the functionality
+to test with various shells, Urchin facilitates a more flexible approach.
+
+The specific approach depends on your test scenario:
+
+* (a) Your test scripts _invoke_ scripts containing portable shell code.
+* (b) Your scripts _source_ scripts containing portable shell code.
+
+#### (a) Cross-shell tests with test scripts that _invoke_ shell scripts
+Urchin sets the `TEST_SHELL` environment variable so that you may change the
+shell with which your tests call other shell programs. To run your test
+scripts in multiple shells you must call `$TEST_SHELL` in your tests and then
+run urchin with the appropriate option.
+
+In your test scripts, invoke the shell scripts to test via the shell
+specified in environment variable `TEST_SHELL` rather than directly;
+e.g.: `$TEST_SHELL ../foo bar` (rather than just `../foo bar`).  
+
+On invocation of Urchin, prepend a definition of environment variable
+`TEST_SHELL` specifying the shell to test with, e.g.,
+
+    TEST_SHELL=zsh urchin ./tests
+
+To test with multiple shells in sequence, use something like:
+
+    for shell in sh bash ksh zsh; do
+      TEST_SHELL=$shell urchin ./tests
+    done
+
+If `TEST_SHELL` has no value, Urchin defines it as `/bin/sh`, so the test
+scripts can rely on `$TEST_SHELL` always containing a value when Urchin runs
+them.
+
+That said, we still recommand that you account for the possibility that
+`$TEST_SHELL` does not contain a value so that you may run your test scripts
+without Urchin. Supporting this case is very simple; when you invoke scripts
+that happen to be in the current directory, be sure to use the prefix `./`,
+e.g., `$TEST_SHELL ./baz` rather than `$TEST_SHELL baz`.
+
+#### (b) Cross-shell tests with test scripts that _source_ shell scripts
+If you _source_ shell code in your test scripts, it is the test scripts
+themselves that must be run with the shell specified.
+
+Urchin supports the `-s <shell>` option, which instructs
+Urchin to invoke the test scripts with the specified shell; e.g., `-s bash`.  
+(In addition, Urchin sets environment variable `TEST_SHELL` to the specified
+shell.)
+
+Note that only test scripts that either have no shebang line at all or
+have shebang line `#!/bin/sh` are invoked with the specified shell.
+This allows non-shell test scripts or test scripts for specific
+shells to coexist with those whose invocation should be controlled by `-s`.
+
+To test with multiple shells in sequence, use something like:
+
+    for shell in sh bash ksh zsh; do
+      urchin -s $shell ./tests
+    done
+
+Also consider using [shall](https://github.com/mklement0/shall).
+It does something similar, but the interface may be more intuitive.
+
+    #!/usr/bin/env shall
+    echo This is a test file.
+
+## Alternatives to Urchin
+Alternatives to Urchin are discussed in
+[this blog post](https://blog.scraperwiki.com/2012/12/how-to-test-shell-scripts/).

tests/.die-on-fail/2 should run.

@@ -0,0 +1 @@
+false

tests/.die-on-fail/3 should not run.

@@ -0,0 +1 @@
+false

tests/.die-on-fail/4 should not run.

@@ -0,0 +1 @@
+false

tests/.gitignore

@@ -1 +1,2 @@
 .urchin.log
+.urchin_stdout

tests/.print-arg-3

@@ -0,0 +1 @@
+echo $3

tests/A nonempty CDPATH should not break urchin.

@@ -0,0 +1,6 @@
+#!/bin/sh
+
+cd ..
+export CDPATH=$PWD
+./urchin -f 'tests/urchin exit code' >/dev/null
+

tests/Command-line help contents/The -s option should be documented.

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+../../urchin -h | grep -- -s

tests/Command-line help contents/XSD output (-xsd flag) should be documented.

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-../../urchin -h|grep -i xsd

tests/Cross-shell test support/.test-TEST_SHELL-passed-through/$TEST_SHELL should be bash.

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Assuming that urchin was invoked with `TEST_SHELL=bash urchin ...`, $TEST_SHELL should contain 'bash'.
+
+echo "\$TEST_SHELL: $TEST_SHELL"
+
+[ "$TEST_SHELL" = 'bash' ]

tests/Cross-shell test support/.test-TEST_SHELL-undefined_or_empty/Invoking a command with $TEST_SHELL should work

@@ -0,0 +1,4 @@
+#!/bin/sh
+
+# Invoke a simple test command with $TEST_SHELL as the executable.
+[ "$($TEST_SHELL -c 'echo $0')" = "$TEST_SHELL" ]

tests/Cross-shell test support/.test-run-by-specified-shell/With -s, a non-sh test script should be invoked directly.

@@ -0,0 +1,3 @@
+#!/usr/bin/env true
+true will processed the contents of this script, but that
+means that nothing will happen and the script will exit 0 

tests/Cross-shell test support/.test-run-by-specified-shell/With -s, a sh test script should be invoked with the specified shell.

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+# Assuming that urchin was invoked with `-s bash`, this script should be being run with bash.
+
+this_shell=$(ps -o comm= -p $$ && :)
+
+echo "Running shell: $this_shell"
+
+[  "$this_shell" = 'bash' ]
+

tests/Cross-shell test support/.test-run-by-specified-shell/With -s, a shebang-less test script should be invoked with the specified shell.

@@ -0,0 +1,10 @@
+# By design, this file has no shebang line.
+
+# Assuming that urchin was invoked with `-s bash`, this script should be being run with bash.
+
+this_shell=$(ps -o comm= -p $$ && :)
+
+echo "Running shell: $this_shell"
+
+[  "$this_shell" = 'bash' ]
+

tests/Cross-shell test support/.test-run-by-specified-shell/With -s, the TEST_SHELL environment variable should be set to the specified shell too.

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+# Assuming that urchin was invoked with `-s bash`, $TEST_SHELL should contain 'bash'.
+
+echo "Running shell: $(ps -o comm= -p $$ && :)"
+
+echo "\$TEST_SHELL: $TEST_SHELL"
+
+[  "$TEST_SHELL" = 'bash' ]

tests/Cross-shell test support/Environment variable TEST_SHELL should be passed through.

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+# Tests support for either passing through or defining a default value for environment variable TEST_SHELL.
+# (for test scripts that want to invoke shell scripts with a specified shell).
+
+which bash 2>/dev/null || { echo "Cannot test -s option: bash cannot be located." >&2; exit 1; }
+
+# Test if $TEST_SHELL, when placed in urchin's environment, is passed through to the test scripts.
+TEST_SHELL=bash ../../urchin ./.test-TEST_SHELL-passed-through

tests/Cross-shell test support/Environment variable TEST_SHELL should default to sh if empty.

@@ -0,0 +1,8 @@
+#!/bin/sh
+
+# Tests support for either passing through or defining a default value for environment variable TEST_SHELL.
+# (for test scripts that want to invoke shell scripts with a specified shell).
+
+# Test if $TEST_SHELL - if *defined, but empty* - is exported with value '/bin/sh' by urchin
+# and thus has that value inside the scripts.
+TEST_SHELL= ../../urchin ./.test-TEST_SHELL-undefined_or_empty

tests/Cross-shell test support/Environment variable TEST_SHELL should default to sh if unset.

@@ -0,0 +1,9 @@
+#!/bin/sh
+
+# Tests support for either passing through or defining a default value for environment variable TEST_SHELL.
+# (for test scripts that want to invoke shell scripts with a specified shell).
+
+# Test if $TEST_SHELL - if *undefined* - is exported with value '/bin/sh' by urchin
+# and thus has that value inside test scripts.
+unset -v TEST_SHELL
+../../urchin ./.test-TEST_SHELL-undefined_or_empty

tests/Cross-shell test support/The -s option should invoke tests with the specified shell.

@@ -0,0 +1,7 @@
+#!/bin/sh
+
+# Tests the `-s <shell> option, which invokes shebang-less and sh-shebang-line test scripts with the specified shell (for testing *sourced* shell code).
+
+which bash >/dev/null || { echo "Cannot test -s option: bash cannot be located." >&2; exit 2; }
+
+../../urchin -s bash ./.test-run-by-specified-shell

tests/Exit on fail if -e is passed.

@@ -0,0 +1,11 @@
+tmp=$(mktemp)
+../urchin -e -f ./.die-on-fail > $tmp
+result=$?
+
+grep '1 should run.' $tmp
+grep '2 should run.' $tmp
+grep -v '3 should not run.' $tmp
+grep -v '4 should not run.' $tmp
+
+rm $tmp
+exit $result

tests/Print version on -v.

@@ -0,0 +1,2 @@
+#!/bin/sh
+../urchin -v | grep '[0-9.]\{3,\}'

tests/TAP/.expected-output

@@ -0,0 +1,10 @@
+# Begin - .testsuite/
+not ok 1 - a
+# ------------ Begin output ------------
+# This is stdout from a.
+# ------------ End output ------------
+ok 2 - b
+ok 3 - # SKIP c
+# End - .testsuite/
+# Took 0 seconds.
+1..3

tests/TAP/.testsuite/a

@@ -0,0 +1,4 @@
+#!/bin/sh
+echo This is stderr from a. > /dev/stderr
+echo This is stdout from a. > /dev/stdout
+false

tests/TAP/.testsuite/b

@@ -0,0 +1,4 @@
+#!/bin/sh
+echo This is stderr from b. > /dev/stderr
+echo This is stdout from b. > /dev/stdout
+true

tests/TAP/.testsuite/c

@@ -0,0 +1 @@
+This should not be run.

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

@@ -0,0 +1,4 @@
+tmp=$(mktemp)
+
+../../urchin -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,4 +1,5 @@
 #!/bin/sh
 
-mkdir /tmp/urchintmp
+tmp=$(mktemp -d)/blah
-! ../../urchin /tmp/urchintmp
+echo '#!/usr/bin/env true' > $tmp
+! ../../urchin $tmp

tests/XSD output should work./.fixture/fail

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

tests/XSD output should work./.fixture/pass

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

tests/XSD output should work./XSD output should produce XML.

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-../../urchin .fixture | grep 'http://www.w3.org/2001/XMLSchema'

tests/setup

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-export variable_set_in_setup='value'

tests/urchin exit code/non zero exit code when a test fails

@@ -0,0 +1,13 @@
+#!/bin/sh
+
+# Borrow this test which has a failure in it (3 in fact), and
+# run it using urchin:
+../../urchin "../Counts should be kept of successes and failures./.test" > /dev/null
+
+# Now invert the result, we want _this_ test to fail if the exit
+# code was 0.
+case $? in
+  0) exit 8;;
+  *) exit 0;;
+esac
+

tests/urchin exit code/zero exit code when tests all pass

@@ -0,0 +1 @@
+../../urchin .test > /dev/null

urchin

@@ -1,5 +1,21 @@
 #!/bin/sh
 
+# 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
+VERSION=0.0.6
+
 fullpath() {
   (
     cd -- "$1"
@@ -9,81 +25,175 @@ fullpath() {
 
 indent() {
   level="$1"
+  if test "$level" -gt 0; then
     printf "%$((2 * ${level}))s"
+  fi
 }
 
 recurse() {
   potential_test="$1"
   indent_level="$2"
+  shell_for_sh_tests="$3"
 
   [ "$potential_test" = 'setup_dir' ] && return
   [ "$potential_test" = 'teardown_dir' ] && return
   [ "$potential_test" = 'setup' ] && return
   [ "$potential_test" = 'teardown' ] && return
 
-  echo > "$stdout_file"
+  [ $indent_level -eq 0 ] && : > "$stdout_file"
 
   if [ -d "$potential_test" ]
     then
-    (
+
+    if $tap_format; then
+      indent $indent_level | sed 's/  /#/g'
+      echo "# Begin - ${potential_test}"
+    else
       indent $indent_level
-      echo "  ${potential_test}"
+      echo "+ ${potential_test}"
+    fi
+
+    (
       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
+        setopt NULL_GLOB
+      fi
+
       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 ))
+        recurse "${test}" $(( $2 + 1 )) "$shell_for_sh_tests"
+        exit_code=$?
 
-        [ -f teardown ] && [ -x teardown ] && ./teardown >> "$stdout_file"
+        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"
+          return 1
+        fi
+
+        [ -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"
-      echo
     )
-  elif [ -x "$potential_test" ]
+    if $tap_format; then
+      indent $indent_level | sed 's/  /#/g'
+      echo "# End - ${potential_test}"
+    else
+      echo
+    fi
+  else
+    if [ -x "$potential_test" ]
       then
-
+      [ -f setup ] && [ -x setup ] && . ./setup >> "$stdout_file"
-    [ -f setup ] && [ -x setup ] && ./setup >> "$stdout_file"
 
       # Run the test
-    ./"$potential_test" > "$stdout_file" 2>&1
+      if [ -n "$shell_for_sh_tests" ] && has_sh_or_no_shebang_line ./"$potential_test"
+        then    
+        TEST_SHELL="$TEST_SHELL" "$shell_for_sh_tests" ./"$potential_test" > "$stdout_file" 2>&1
+      else
+        TEST_SHELL="$TEST_SHELL" ./"$potential_test" > "$stdout_file" 2>&1
+      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
+        result=fail
+      fi
+    else
+      result=skip
+    fi
 
+    echo "${result}" >> "$logfile"
+    if $tap_format; then
+      n=$(grep -ce '^\(success\|fail\|skip\)' "$logfile")
+
+      if [ "$result" == fail ]; then
+        not='not '
+      else
+        not=''
+      fi
+      if [ "$result" == skip ]; then
+        skip='# SKIP '
+      else
+        skip=''
+      fi
+      echo "${not}ok $n - ${skip}${potential_test}"
+      if [ "$result" == fail ]; then
+        echo '# ------------ Begin output ------------'
+        sed 's/^/# /' "$stdout_file"
+        echo '# ------------ End output ------------'
+      fi
+    else
       indent $indent_level
-    if [ "$exit_code" = '0' ]
+      case "$result" in
-      then
+        success)
-      # On success, print a '✓'
+          # On success, print a green '✓'
           printf '\033[32m✓ \033[0m'
           printf '%s\n' "${potential_test}"
-      printf '%s\n' "${potential_test} passed" >> "$logfile"
+        ;;
-    else
+        fail)
           # On fail, print a red '✗'
           printf '\033[31m✗ \033[0m'
           printf '%s\n' "${potential_test}"
-      printf '%s\n' "${potential_test} failed" >> "$logfile"
+
+          # Print output captured from failed test in red.
+          printf '\033[31m'
+
           cat "$stdout_file"
+          printf '\033[0m'
+        ;;
+        skip)
+          printf '  %s\n' "${potential_test}"
+        ;;
+      esac
     fi
-    rm "$stdout_file"
+
+    if $exit_on_fail && test 0 -ne $exit_code; then
+      return 1
     fi
+  fi
+  [ $indent_level -eq 0 ] && rm "$stdout_file"
 }
 
-USAGE="usage: $0 <test directory>"
+has_sh_or_no_shebang_line() {
+  # 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
+}
+
+USAGE="usage: $0 [<options>] <test directory>"
 
 urchin_help() {
-  echo
+  cat <<EOF
-  echo "$USAGE"
+
-  echo
+$USAGE
-  echo '-f      Force urchin to run on directories not named "test".'
+
-  echo '-h      This help'
+-s <shell>  Invoke test scripts that either have no shebang line at all or
-  echo
+            have shebang line "#!/bin/sh" with the specified shell.
-  echo '--xsd   Output xUnit XML schema for an integration server.'
+-e          Stop running if any single test fails. This is helpful if you want
-  echo
+            to use Urchin to run things other than tests, such as a set of
-  echo 'Go to http://www.urchin.sh for documentation on writing tests.'
+            configuration scripts.
-  echo
+-f          Force running even if the test directory's name does not
+            contain the word "test".
+-t          Format output in Test Anything Protocol (TAP)
+-h, --help  This help.
+-v          Display the version number.
+
+Go to https://github.com/tlevine/urchin for documentation on writing tests.
+
+EOF
 }
 
 plural () {
@@ -99,61 +209,109 @@ 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)
 
-  echo > "$logfile"
+  # Determine the environment variable to define for test scripts
-  recurse "$1" 0
+  # 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))
-  echo Done, took $elapsed $(plural second $elapsed)
+
-  set -- $(grep -e 'passed$' "$logfile"|wc -l) $(grep -e 'failed$' "$logfile"|wc -l)
+  passed=$(grep -c '^success' "$logfile")
-  printf '%s\n' "$1 $(plural test "$1") passed."
+  failed=$(grep -c '^fail' "$logfile")
-  printf '%s\n' "$2 $(plural test "$2") failed."
+  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
-  echo 'The directory on which you are running urchin is not'
+    echo 'The name of the directory on which you are running urchin'
-  echo 'called "test", so I am not running in case that'
+    echo 'does not contain the word "test", so I am not running,'
-  echo 'was an accident. Use the -f flag if you really want'
+    echo 'in case that was an accident. Use the -f flag if you really'
-  echo 'to run urchin on that directory.'
+    echo 'want to run urchin on that directory.'
     echo
+  } >&2
   exit 1
 }
 
-FORCE=false
+shell_for_sh_tests=
+force=false
+exit_on_fail=false
+tap_format=false
 while [ $# -gt 0 ]
 do
     case "$1" in
-        -f) FORCE=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
+          } ;;
+        -t) tap_format=true;;
         -h|--help) urchin_help
           exit 0;;
-#       --xsd) action=testsuite;;
+        -v) echo "$VERSION"
-#       --) shift; break;;
+            exit;;
-        -*) urchin_help 1>&2
+        -*) 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 2
+fi
+
 # Constants
 logfile=$(fullpath "$1")/.urchin.log
 stdout_file=$(fullpath "$1")/.urchin_stdout
 
-# Verify argument for main stuff
-if [ "$#" != '1' ] && [ ! -d "$1" ]
-  then
-  echo "$USAGE"
-  exit 1
-fi
-
 # Run or present the Molly guard.
-if basename "$(fullpath "$1")" | grep test > /dev/null || $FORCE
+if fullpath "$1" | grep -Fi 'test' > /dev/null || $force
   then
-  urchin_go "$1"
+  urchin_go "$1" "$shell_for_sh_tests"
 else
   urchin_molly_guard
 fi