todorb 0.2.1 → 1.0.0

data/tests/Makefile

@@ -0,0 +1,2 @@
+test:
+	$(MAKE) -C .. test

data/tests/README

@@ -0,0 +1,313 @@
+todorb.rb tests
+===============
+
+This directory holds test scripts for todorb.rb .  The
+first part of this short document describes how to run the tests
+and read their output.
+
+When fixing the tools or adding enhancements, you are strongly
+encouraged to add tests in this directory to cover what you are
+trying to fix or enhance.  The later part of this short document
+describes how your test scripts should be organized.
+
+
+Running Tests
+-------------
+
+The easiest way to run tests is to say "make test" from the top-level.
+This runs all the tests.
+
+    rm -rf tests/test-results "tests/trash directory"*
+    cd tests && sh t0000-config.sh 
+    *   ok 1: no config file
+    *   ok 2: config file (default location 1)
+    *   ok 3: config file (default location 2)
+    *   ok 4: config file (command line)
+    *   ok 5: config file (env variable)
+    * passed all 5 test(s)
+    cd tests && sh t0001-null.sh 
+    *   ok 1: null ls
+    * passed all 1 test(s)
+    rm -rf tests/test-results
+
+Or you can run each test individually from command line, like
+this:
+
+    $ ./t0001-null.sh 
+    *   ok 1: null ls
+    * passed all 1 test(s)
+
+You can pass --verbose (or -v), --debug (or -d), and --immediate
+(or -i) command line argument to the test, or by setting GIT_TEST_OPTS
+appropriately before running "make".
+
+--verbose::
+	This makes the test more verbose.  Specifically, the
+	command being run and their output if any are also
+	output.
+
+--debug::
+	This may help the person who is developing a new test.
+	It causes the command defined with test_debug to run.
+
+--immediate::
+	This causes the test to immediately exit upon the first
+	failed test.
+
+--long-tests::
+	This causes additional long-running tests to be run (where
+	available), for more exhaustive testing.
+
+--tee::
+	In addition to printing the test output to the terminal,
+	write it to files named 't/test-results/$TEST_NAME.out'.
+	As the names depend on the tests' file names, it is safe to
+	run the tests with this option in parallel.
+
+Skipping Tests
+--------------
+
+In some environments, certain tests have no way of succeeding
+due to platform limitation, such as lack of 'unzip' program, or
+filesystem that do not allow arbitrary sequence of non-NUL bytes
+as pathnames.
+
+You should be able to say something like
+
+    $ SKIP_TESTS=t0000.2 sh ./t0000-config.sh
+
+and even:
+
+    $ SKIP_TESTS='t[0-4]??? t91?? t9200.8' make
+
+to omit such tests.  The value of the environment variable is a
+SP separated list of patterns that tells which tests to skip,
+and either can match the "t[0-9]{4}" part to skip the whole
+test, or t[0-9]{4} followed by ".$number" to say which
+particular test to skip.
+
+Note that some tests in the existing test suite rely on previous
+test item, so you cannot arbitrarily disable one and expect the
+remainder of test to check what the test originally was intended
+to check.
+
+
+Naming Tests
+------------
+
+The test files are named as:
+
+	tNNNN-commandname-details.sh
+
+where N is a decimal digit.
+
+First digit tells the family:
+
+	0 - the absolute basics and global stuff
+	1 - basic every-day usage
+        2 - add ins
+
+Second digit tells the particular command we are testing.
+
+Third digit (optionally) tells the particular switch or group of switches
+we are testing.
+
+If you create files under tests/ directory (i.e. here) that is not
+the top-level test script, never name the file to match the above
+pattern.  The Makefile here considers all such files as the
+top-level test script and tries to run all of them.  A care is
+especially needed if you are creating a common test library
+file, similar to test-lib.sh, because such a library file may
+not be suitable for standalone execution.
+
+
+Writing Tests
+-------------
+
+The test script is written as a shell script.  It should start
+with the standard "#!/bin/sh" with copyright notices, and an
+assignment to variable 'test_description', like this:
+
+	#!/bin/sh
+	#
+	# Copyright (c) 2005 Junio C Hamano
+	#
+
+	test_description='xxx test (option --frotz)
+
+	This test registers the following structure in the cache
+	and tries to run git-ls-files with option --frotz.'
+
+
+Source 'test-lib.sh'
+--------------------
+
+After assigning test_description, the test script should source
+test-lib.sh like this:
+
+	. ./test-lib.sh
+
+This test harness library does the following things:
+
+ - If the script is invoked with command line argument --help
+   (or -h), it shows the test_description and exits.
+
+ - Creates an empty test directory with an empty todo file
+   database and chdir(2) into it.  This directory is 't/trash directory'
+   if you must know, but I do not think you care.
+
+ - Defines standard test helper functions for your scripts to
+   use.  These functions are designed to make all scripts behave
+   consistently when command line arguments --verbose (or -v),
+   --debug (or -d), and --immediate (or -i) is given.
+
+
+End with test_done
+------------------
+
+Your script will be a sequence of tests, using helper functions
+from the test harness library.  At the end of the script, call
+'test_done'.
+
+
+Test harness library
+--------------------
+
+There are a handful helper functions defined in the test harness
+library for your script to use.
+
+ - test_todo_session <message> < transcript
+
+   This takes a single string as a parameter, which is treated
+   as a base description of what is being tested, and then
+   reads from standard input a transcript of todorb.rb  commands
+   and expected output.  Each command is run in the current
+   test environment and the output is compared with the
+   expected output.  (See below for how to generate transcripts
+   easily.)
+
+ - test_tick [interval]
+
+   The test harness has an internal view of time which is
+   implemented by wrapping the date command.  This takes a single
+   optional positive integer parameter which indicates how much
+   to advance the internal time.  The default value is one day.
+
+ - test_expect_success <message> <script>
+
+   This takes two strings as parameter, and evaluates the
+   <script>.  If it yields success, test is considered
+   successful.  <message> should state what it is testing.
+
+   Example:
+
+	test_expect_success \
+	    'git-write-tree should be able to write an empty tree.' \
+	    'tree=$(git-write-tree)'
+
+ - test_expect_failure <message> <script>
+
+   This is NOT the opposite of test_expect_success, but is used
+   to mark a test that demonstrates a known breakage.  Unlike
+   the usual test_expect_success tests, which say "ok" on
+   success and "FAIL" on failure, this will say "FIXED" on
+   success and "still broken" on failure.  Failures from these
+   tests won't cause -i (immediate) to stop.
+
+ - test_debug <script>
+
+   This takes a single argument, <script>, and evaluates it only
+   when the test script is started with --debug command line
+   argument.  This is primarily meant for use during the
+   development of a new test script.
+
+ - test_done
+
+   Your test script must have test_done at the end.  Its purpose
+   is to summarize successes and failures in the test script and
+   exit with an appropriate error code.
+
+
+Generating test transcripts
+---------------------------
+
+You can generate test scripts from screenshots as following:
+
+    $ ./testshell.sh
+
+You'll be in a special test environment with an empty TODO2.txt
+and the dates and timestamps will be artificially fixed.
+
+Then the session can be used to make a unit test thanks to
+test_todo_session, see the existing tests as examples.
+
+Be careful to replace all occurences of the full path to the test
+directory by $HOME as testshell.sh will explain you when you execute it
+otherwise the tests will work properly only on your own computer.
+
+Don't use "script" as this would log every keystroke, not only what's
+visible!!
+
+***NOTE***
+
+I am not clear how to generate transcripts using the above.
+The script rtest2.sh actually generates a fully working test case/suite.
+You may interactively enter actions and the action and result will get 
+written into a test script.
+-- rkumar 2009-12-21 23:43 
+
+Credits
+-------
+
+This test framework was derived from the framework used by
+git itself, written originally by Junio Hamano and licensed
+for use under the GPL.  It was specialized for todo.txt-cli
+by Emil Sit and Philippe Teuwen.
+Further modified for todorb.rb  by Rahul Kumar.
+
+./rtest2.sh --load dataset1.txt "listing"
+  then type commands in there.
+NOTE that a blank line in output terminates what "expect" file gets so test will fail.
+
+
+Issues and Drawbacks with this framework
+----------------------------------------
+
+This framework uses the standard output of a command as the expected
+result. This usually means the message reported to the user on success or 
+failure. If we change the message, the test breaks. Similarly, any
+change to the formatting of a listing breaks *many* tests.
+
+The actual result in the file is not being checked, only the informational
+message. To circumvent the problem of recreating test cases whenever output
+changes, one may pipe the commands from a broken test file to rtest2.sh and create
+a fresh file.
+   grep '^>>> ' t0001-broken.sh \
+    | sed 's/^>>> *//' \
+    | ./rtest2.sh --load data1.txt "listing"
+
+Note that any data created on top of the broken test file, is to be saved and passed 
+in the --load parameter to rtest2.sh.
+
+Date related:
+-------------
+This script works fine with shell scripts that use "date" to derive
+date. There's a nice hack in the bin directorythat is created at runtime
+in the trash folder. However, my ruby prog does not use "date". It uses
+Time.now(). So the add method which appends a date appends actual date
+not the fake date 12345000.
+
+Fix for ruby programs:
+    t = Time.now
+    ut = ENV["TODO_TEST_TIME"]
+    t = Time.at(ut.to_i) if ut
+
+Add the line of picking up unix time stamp from env and using that, if it's there.
+
+Testing for failure returned by method
+=== 1
+=== -1
+prior to output
+PLEASE be sure to unset any TODO_ env variables prior to test, such as
+TODO_SHOW_ALL or else tests will fail when its not set!
+## vim:tw=72:ai:formatoptions=tcqln:nocindent

data/tests/aggregate-results.sh

@@ -0,0 +1,34 @@
+#!/bin/sh
+
+fixed=0
+success=0
+failed=0
+broken=0
+total=0
+
+for file
+do
+	while read type value
+	do
+		case $type in
+		'')
+			continue ;;
+		fixed)
+			fixed=$(($fixed + $value)) ;;
+		success)
+			success=$(($success + $value)) ;;
+		failed)
+			failed=$(($failed + $value)) ;;
+		broken)
+			broken=$(($broken + $value)) ;;
+		total)
+			total=$(($total + $value)) ;;
+		esac
+	done <"$file"
+done
+
+printf "%-8s%d\n" fixed $fixed
+printf "%-8s%d\n" success $success
+printf "%-8s%d\n" failed $failed
+printf "%-8s%d\n" broken $broken
+printf "%-8s%d\n" total $total

data/tests/clean.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+rm -rf trashdir*
+rm -rf test-results/

data/tests/dataset1.txt

@@ -0,0 +1,14 @@
+  1	[x] if no TODO file give proper message to add task (2010-06-14)
+  2	[x] what if no serial_number file? (2010-06-14)
+  3	[x] Add a close for status close (2010-06-14)
+    3.1	[ ] hello there new a u 3 (2010-06-15)
+        3.1.1	[ ] hello there new a u 3 (2010-06-15)
+        3.1.2	[ ] hello there new a u 3 (2010-06-15)
+        3.1.3	[ ] hello there new a u 3 (2010-06-15)
+    3.2	[ ] hello there new a u 3.2 (2010-06-15)
+        3.2.1	[ ] hello there new a u 3.2.1 (2010-06-15)
+            3.2.1.1	[ ] hello there new a u 3.2.1.1 (2010-06-15)
+  4	[ ] start rubyforge project for todorb (2010-06-14)
+  5	[ ] list: if dir given then show full path of TODO2.txt at end (2010-06-14)
+  6	[ ] allow for ENV VARS such as verbose, plain, force (2010-06-15)
+  7	[ ] list: search terms with - + and = (2010-06-15)

data/tests/recreate.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+#*******************************************************#
+#                 recreate.sh
+#                 written by Rahul Kumar                #
+#                    2009/12/01                         #
+#  recreate a failed test - pass the name of the earlier#
+#  test program. In some cases, you may have to rename  #
+#  transcript.txt to the testcase since cp -i failes    #
+#*******************************************************#
+
+# oldfile is the old test cases such as t0001-add.sh
+oldfile="$1"
+[ ! -f "$oldfile" ] && { echo "Could not find $oldfile"; exit -1 ; }
+
+LOADSTR=
+if grep -q CATEOF "$oldfile"; then
+   sed -n '/<<CATEOF/,/^CATEOF/p' "$oldfile" | grep -v "CATEOF" > data.1
+   LOADSTR='--load data.1'
+   echo found data, saved as data.1
+   wc -l data.1
+fi
+str=$( echo "$oldfile" | sed 's/^t[0-9]*-//;s/.sh$//' )
+echo "Using suffix:$str"
+read -p "press enter "
+grep '^>>> ' "$oldfile" | sed 's/^>>> //' 
+read -p "press enter "
+grep '^>>> ' "$oldfile" | sed 's/^>>> //' | ./rtest2.sh $LOADSTR "$str"
+
+echo
+echo renaming old file with O prefix
+mv "$oldfile" O$oldfile
+echo "If you don't find a test case, then rename transcript.txt to $oldfile"
+echo "cp transcript.txt $oldfile"

data/tests/rtest2.sh

@@ -0,0 +1,124 @@
+#!/bin/bash
+#*******************************************************#
+#                       gentest.sh                      #
+#                 written by Rahul Kumar                #
+#                    December 21, 2009                  #
+#                                                       #
+#                  generates a test case                #
+#*******************************************************#
+# @param - test descriptor - short name
+#+ will be used in test_desc and filename suffix
+#
+# If testing for error, and command returns 1
+#+ place "=== 1" on first line or result
+
+while [[ $1 = -* ]]; do
+case "$1" in                    
+   -L|--load)
+   # load a file containing TODO2.txt data to test against
+      dataset=../$2
+      shift
+      shift
+      ;;
+   *)
+      echo "Error: Unknown option: $1" >&2   # rem _
+      exit 1
+      ;;
+esac
+done
+
+if [[ -z "$1" ]]; then
+   echo -n "Test Description (short, no spaces): " 1>&2
+   read td
+else
+   td="$1"
+fi
+# for generating a serial number
+APP="todorb-test"
+
+PS1=">>>"
+out="$(pwd)/transcript.txt"
+test_description="Testing of $td"
+filesuffix=$( echo "$td" | sed 's/ /_/g' )
+
+
+. ./test-lib.sh
+trap - EXIT
+if [[ ! -z "$dataset" ]]; then
+   if [[ ! -f "$dataset" ]]; then
+      echo "Can't find file $dataset"
+      exit 1
+   else
+      wc -l "$dataset"
+   fi
+fi
+if [[ ! -z "$dataset" ]]; then
+   cp "${dataset}" TODO2.txt
+   pre+=$( echo -e "cat > TODO2.txt <<CATEOF")
+   pre+="\n"
+   pre+=$(cat TODO2.txt)
+   pre+=$( echo -e "\nCATEOF\n" )
+fi
+str=""
+> "$out"
+
+history -r .rtest2.history
+## get user input, stop when user enters 'bye'
+while read -ep ">>> " line
+do
+#   echo -n ">>> "
+#   read line
+   [ -z "$line" ] && { echo "bye to quit"; continue; }
+   [[ "$line" = "bye" ]] && break;
+   [ -n "$line" ] && history -s "$line"
+
+   ## user can execute test_tick in current shell
+   [[ "$line" = *test_tick* ]] && {
+      times=$( expr "$line" : 'test_tick \(.*\)' )
+      # should be multiples of 86400 or at least more than 86400
+      test_tick $times;
+   }
+
+   if grep -q "^list" <<< "$line"; then
+      line=$( echo "$line" | sed 's/^list/t --sort-serial list/')
+   fi
+   if grep -q "^ls" <<< "$line"; then
+      line=$( echo "$line" | sed 's/^ls/t --sort-serial --no-colors list/')
+   fi
+   line=$(echo "$line" | sed 's/--ss /--sort-serial /')
+   line=$(echo "$line" | sed 's/--nc /--no-colors /')
+   #[[ "$line" = "list" ]] && line="t --sort-serial list";
+   #[[ "$line" = "ls" ]] && line="t --sort-serial --no-colors list";
+   line=$(echo "$line" | sed 's/^t /todorb /')
+   echo ">>> $line" >> $out
+   eval "$line" | tee -a "$out"
+   echo "" >> $out
+done
+
+## generate the test case transcript
+str="$( cat $out )"
+> "$out"
+cat > "$out" <<EOF
+#!/bin/sh
+test_description="Testing out $td "
+. ./test-lib.sh
+
+
+EOF
+echo -e "$pre" >> "$out"
+echo "" >> "$out"
+echo "test_todo_session \"Testing of $td\" <<EOF" >> "$out"
+echo "$str" >> "$out"
+echo "" >> "$out"
+echo "EOF" >> "$out"
+echo "test_done" >> "$out"
+
+# try to create a decent file name
+serno=$( get_serial_number -a "$APP" -d "../"  )
+serno=$( printf "%04s" "$serno" )
+filename="../t${serno}-${filesuffix}.sh"
+echo "trying to copy $out to $filename"
+chmod +x "$out"
+cp -i "$out" "$filename" < /dev/tty
+chmod +x "$filename"
+echo "Please rename $filename to prevent possible overwriting"