blarg

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,44 @@
 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
+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).
+
+### 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
 ---------------------
 
@@ -14,6 +52,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.
@@ -109,3 +102,35 @@ in the case of Urchin.
 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.
+
+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/Single file/.wrappers/setup

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

tests/Single file/.wrappers/setup_dir

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

tests/Single file/.wrappers/teardown

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

tests/Single file/.wrappers/teardown_dir

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

tests/Single file/.wrappers/thetest

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

tests/Single file/Run on a single file.

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

tests/Single file/The file must exist.

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

tests/Single file/The wrappers should be run.

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

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

tests/skip/.test/fail

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

tests/skip/.test/skip

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

tests/skip/.test/succeed

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

tests/skip/Skip on exit code 3.

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

urchin

@@ -1,22 +1,26 @@
 #!/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
 VERSION=0.0.6
 
-fullpath() {
-  (
-    cd -- "$1"
-    pwd
-  )
-}
-
 indent() {
   level="$1"
-  printf "%$((2 * ${level}))s"
+  if test "$level" -gt 0; then
+    printf "%$((2 * ${level}))s"
+  fi
 }
 
 recurse() {
@@ -92,6 +96,8 @@ recurse() {
       [ -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
@@ -131,7 +137,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 +158,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
 }
 
@@ -225,7 +239,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
@@ -257,8 +274,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 11
+          } ;;
         -t) tap_format=true;;
         -h|--help) urchin_help
           exit 0;;
@@ -271,21 +291,17 @@ 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 2
-fi
-
-# Constants
-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
+thetest=$(readlink -f "$1")
-  then
+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"
+  fi
+  logfile="$d/.urchin.log"
+  stdout_file="$d/.urchin_stdout"
   urchin_go "$1" "$shell_for_sh_tests"
 else
   urchin_molly_guard