test-lib: Also check completion exit code.

The completion may unexpectedly abort somewhere.

Additionally, reformat the failure messages (don't prepend a "*", this should be reserved to mark the individual test runs) and use "compreply" instead of "output", so that it's already clear from the diff output that the completion is being tested.

tests/README

@@ -125,10 +125,10 @@ Writing Tests
 -------------
 
 The test script is written as a shell script.  It should start
-with the standard "#!/bin/sh" with copyright notices, and an
+with the standard "#!/bin/bash" with copyright notices, and an
 assignment to variable 'test_description', like this:
 
-	#!/bin/sh
+	#!/bin/bash
 	#
 	# Copyright (c) 2005 Junio C Hamano
 	#
@@ -186,6 +186,17 @@ library for your script to use.
    expected output.  (See below for how to generate transcripts
    easily.)
 
+ - test_todo_completion <message> <cmdline> <completions>
+
+   This takes three strings as parameter.  Based on <cmdline>,
+   the todo_completion script is triggered in the current test
+   environment and completions are compared with <completions>,
+   which should be a space-separated list.  Include a trailing
+   space in <cmdline> when you want to check new argument
+   completion; otherwise, completion is triggered with the
+   context of the last argument.  <message> should state what it
+   is testing.
+
  - test_tick [interval]
 
    The test harness has an internal view of time which is

tests/t0000-config.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='todo.sh configuration file location
 

tests/t0001-null.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='todo.sh basic null functionality test.
 

tests/t0002-actions.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='todo.sh actions.d
 

tests/t0100-code-nobacktick.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='no old-style backtick command substitution
 

tests/t1000-addlist.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic add and list functionality
 

tests/t1010-add-date.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='test the date on add feature
 

tests/t1020-addtolistfile.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic addto and list functionality
 

tests/t1030-addto-date.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='test the date on addto feature
 

tests/t1100-replace.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic replace functionality
 

tests/t1200-pri.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic priority functionality
 '

tests/t1250-listpri.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='list priority functionality
 '

tests/t1260-listprj.sh

@@ -1,42 +0,0 @@
-#!/bin/sh
-
-test_description='list project functionality
-'
-. ./test-lib.sh
-
-cat > todo.txt <<EOF
-(B) smell the uppercase Roses +roses @outside +shared
-(C) notice the sunflowers +sunflowers @garden +shared +landscape
-stop
-EOF
-test_todo_session 'basic listproj' <<EOF
->>> todo.sh listproj
-+landscape
-+roses
-+shared
-+sunflowers
-EOF
-
-test_todo_session 'listproj with context' <<EOF
->>> todo.sh listproj @garden
-+landscape
-+shared
-+sunflowers
-EOF
-
-TEST_TODO_CUSTOM=todo-custom.cfg
-cat todo.cfg > "$TEST_TODO_CUSTOM"
-cat >> "$TEST_TODO_CUSTOM" <<'EOF'
-export DEFAULT='</color>'
-export PRI_B='<color type=green>'
-export PRI_C='<color type=blue>'
-export TODOTXT_FINAL_FILTER='grep -i roses'
-EOF
-test_todo_session 'listproj with context special cases' <<EOF
->>> todo.sh -+ -d "$TEST_TODO_CUSTOM" listproj @garden
-+landscape
-+shared
-+sunflowers
-EOF
-
-test_done

tests/t1300-ls.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 
 test_description='list functionality

tests/t1310-listcon.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 
 test_description='listcon functionality
@@ -55,4 +55,23 @@ test_todo_session 'listcon e-mail address test' <<EOF
 @con02
 EOF
 
+cat > todo.txt <<EOF
+@con01 -- Some context 1 task
+EOF
+cat > done.txt <<EOF
+x 2012-02-21 @done01 -- Some context 1 done task
+x 2012-02-21 @done02 -- Some context 2 done task
+EOF
+test_todo_session 'listcon from done tasks' <<'EOF'
+>>> TODOTXT_SOURCEVAR=\$DONE_FILE todo.sh listcon
+@done01
+@done02
+EOF
+test_todo_session 'listcon from combined open + done tasks' <<'EOF'
+>>> TODOTXT_SOURCEVAR='("$TODO_FILE" "$DONE_FILE")' todo.sh listcon
+@con01
+@done01
+@done02
+EOF
+
 test_done

tests/t1320-listproj.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 
 test_description='listproj functionality
@@ -55,4 +55,63 @@ test_todo_session 'listproj embedded + test' <<EOF
 +prj02
 EOF
 
+cat > todo.txt <<EOF
+(B) smell the uppercase Roses +roses @outside +shared
+(C) notice the sunflowers +sunflowers @garden +shared +landscape
+stop
+EOF
+test_todo_session 'basic listproj' <<EOF
+>>> todo.sh listproj
++landscape
++roses
++shared
++sunflowers
+EOF
+
+test_todo_session 'listproj with context' <<EOF
+>>> todo.sh listproj @garden
++landscape
++shared
++sunflowers
+EOF
+
+TEST_TODO_CUSTOM=todo-custom.cfg
+cat todo.cfg > "$TEST_TODO_CUSTOM"
+cat >> "$TEST_TODO_CUSTOM" <<'EOF'
+export DEFAULT='</color>'
+export PRI_B='<color type=green>'
+export PRI_C='<color type=blue>'
+export TODOTXT_FINAL_FILTER='grep -i roses'
+EOF
+test_todo_session 'listproj with context special cases' <<EOF
+>>> todo.sh -+ -d "$TEST_TODO_CUSTOM" listproj @garden
++landscape
++shared
++sunflowers
+EOF
+
+
+cat > todo.txt <<EOF
++prj01 -- Some project 1 task
+EOF
+cat > done.txt <<EOF
+x 2012-02-21 +done01 -- Special project 1 done task
+x 2012-02-21 +done02 -- Some project 2 done task
+EOF
+test_todo_session 'listproj from done tasks' <<'EOF'
+>>> TODOTXT_SOURCEVAR=\$DONE_FILE todo.sh listproj
++done01
++done02
+EOF
+test_todo_session 'listproj from done tasks with filtering' <<'EOF'
+>>> TODOTXT_SOURCEVAR=\$DONE_FILE todo.sh listproj Special
++done01
+EOF
+test_todo_session 'listproj from combined open + done tasks' <<'EOF'
+>>> TODOTXT_SOURCEVAR='("$TODO_FILE" "$DONE_FILE")' todo.sh listproj
++done01
++done02
++prj01
+EOF
+
 test_done

tests/t1330-ls-highlighting.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 
 test_description='list highlighting

tests/t1350-listall.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='listall functionality
 '

tests/t1400-prepend.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic prepend functionality
 '

tests/t1500-do.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='do functionality
 '

tests/t1600-append.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic append functionality
 

tests/t1700-depri.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic depriority functionality
 '

tests/t1800-del.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic del functionality
 '

tests/t1900-archive.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='archive functionality
 

tests/t1910-deduplicate.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='deduplicate functionality
 

tests/t1950-report.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='report functionality
 

tests/t2000-multiline.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='Multi-line functionality'
 
@@ -8,18 +8,18 @@ test_description='Multi-line functionality'
 # Create the expected file
 echo "1 smell the cheese
 TODO: Replaced task with:
-1 eat apples eat oranges drink milk">$HOME/expect.multi
+1 eat apples eat oranges drink milk">"$HOME/expect.multi"
 
 test_expect_success 'multiline squash item replace' '
 (
 # Prepare single line todo file
-cat /dev/null > $HOME/todo.txt
+cat /dev/null > "$HOME/todo.txt"
 "$HOME/bin/todo.sh" add smell the cheese
 
 # Run replace
 "$HOME/bin/todo.sh" replace 1 "eat apples
 eat oranges
-drink milk" > $HOME/output.multi
+drink milk" > "$HOME/output.multi"
 
 # Test output against expected
 diff "$HOME/output.multi" "$HOME/expect.multi"
@@ -34,18 +34,18 @@ fi
 ## Add test
 # Create the expected file
 echo "2 eat apples eat oranges drink milk
-TODO: 2 added.">$HOME/expect.multi
+TODO: 2 added.">"$HOME/expect.multi"
 
 test_expect_success 'multiline squash item add' '
 (
 # Prepare single line todo file
-cat /dev/null > $HOME/todo.txt
+cat /dev/null > "$HOME/todo.txt"
 "$HOME/bin/todo.sh" add smell the cheese
 
 # Run add
 "$HOME/bin/todo.sh" add "eat apples
 eat oranges
-drink milk" > $HOME/output.multi
+drink milk" > "$HOME/output.multi"
 
 # Test output against expected
 diff "$HOME/output.multi" "$HOME/expect.multi"
@@ -59,18 +59,18 @@ fi
 
 ## Append test
 # Create the expected file
-echo "1 smell the cheese eat apples eat oranges drink milk">$HOME/expect.multi
+echo "1 smell the cheese eat apples eat oranges drink milk">"$HOME/expect.multi"
 
 test_expect_success 'multiline squash item append' '
 (
 # Prepare single line todo file
-cat /dev/null > $HOME/todo.txt
+cat /dev/null > "$HOME/todo.txt"
 "$HOME/bin/todo.sh" add smell the cheese
 
 # Run append
 "$HOME/bin/todo.sh" append 1 "eat apples
 eat oranges
-drink milk" > $HOME/output.multi
+drink milk" > "$HOME/output.multi"
 
 # Test output against expected
 diff "$HOME/output.multi" "$HOME/expect.multi"
@@ -84,18 +84,18 @@ fi
 
 ## Prepend test
 # Create the expected file
-echo "1 eat apples eat oranges drink milk smell the cheese">$HOME/expect.multi
+echo "1 eat apples eat oranges drink milk smell the cheese">"$HOME/expect.multi"
 
 test_expect_success 'multiline squash item prepend' '
 (
 # Prepare single line todo file
-cat /dev/null > $HOME/todo.txt
+cat /dev/null > "$HOME/todo.txt"
 "$HOME/bin/todo.sh" add smell the cheese
 
 # Run prepend
 "$HOME/bin/todo.sh" prepend 1 "eat apples
 eat oranges
-drink milk" > $HOME/output.multi
+drink milk" > "$HOME/output.multi"
 
 # Test output against expected
 diff "$HOME/output.multi" "$HOME/expect.multi"
@@ -110,18 +110,18 @@ fi
 ## Multiple line addition
 # Create the expected file
 echo "2 eat apples
-TODO: 2 added." > $HOME/expect.multi
+TODO: 2 added." > "$HOME/expect.multi"
 echo "3 eat oranges
-TODO: 3 added." >>$HOME/expect.multi
+TODO: 3 added." >>"$HOME/expect.multi"
 echo "4 drink milk
-TODO: 4 added." >> $HOME/expect.multi
+TODO: 4 added." >>"$HOME/expect.multi"
 
 test_expect_success 'actual multiline add' '
 (
 # Run addm
 "$HOME/bin/todo.sh" addm "eat apples
 eat oranges
-drink milk" > $HOME/output.multi
+drink milk" > "$HOME/output.multi"
 
 # Test output against expected
 diff "$HOME/output.multi" "$HOME/expect.multi"

tests/t6000-completion.sh

@@ -0,0 +1,18 @@
+#!/bin/bash
+#
+
+test_description='Bash completion functionality
+
+This test checks basic todo_completion of actions and options
+'
+. ./test-lib.sh
+
+readonly ACTIONS='add a addto addm append app archive command del rm depri dp do help list ls listall lsa listcon lsc listfile lf listpri lsp listproj lsprj move mv prepend prep pri p replace report shorthelp'
+readonly OPTIONS='-@ -@@ -+ -++ -d -f -h -p -P -PP -a -n -t -v -vv -V -x'
+
+test_todo_completion 'all arguments' 'todo.sh ' "$ACTIONS $OPTIONS"
+test_todo_completion 'arguments beginning with a' 'todo.sh a' 'add a addto addm append app archive'
+test_todo_completion 'all options' 'todo.sh -' "$OPTIONS"
+test_todo_completion 'all actions after command action' 'todo.sh command ' "$ACTIONS"
+
+test_done

tests/t6010-completion-contexts.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+#
+
+test_description='Bash context completion functionality
+
+This test checks todo_completion of contexts
+'
+. ./test-lib.sh
+
+cat > todo.txt <<EOF
+(B) smell the +roses @outside @outdoor +shared
+notice the sunflowers +sunflowers @outside @garden +shared +landscape
+stop
+EOF
+cat > done.txt <<EOF
+x 2012-02-21 +herbs @oriental buy spices
+x 2012-02-21 +slack @home watch tv
+EOF
+test_todo_completion 'all contexts' 'todo.sh list @' '@garden @outdoor @outside'
+test_todo_completion 'contexts beginning with o' 'todo.sh list @o' '@outdoor @outside'
+test_todo_completion 'contexts beginning with outs' 'todo.sh list @outs' '@outside'
+test_todo_completion 'contexts beginning with x' 'todo.sh list @x' ''
+
+test_todo_completion 'contexts from done tasks beginning with h' 'todo.sh list @h' '@home'
+test_todo_completion 'contexts from done tasks beginning with or' 'todo.sh list @or' '@oriental'
+
+test_done

tests/t6020-completion-projects.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+#
+
+test_description='Bash project completion functionality
+
+This test checks todo_completion of projects
+'
+. ./test-lib.sh
+
+cat > todo.txt <<EOF
+(B) smell the +roses @outside @outdoor +shared
+notice the sunflowers +sunflowers @outside @garden +shared +landscape
+stop
+EOF
+cat > done.txt <<EOF
+x 2012-02-21 +herbs @oriental buy spices
+x 2012-02-21 +slack @home watch tv
+EOF
+test_todo_completion 'all projects' 'todo.sh list +' '+landscape +roses +shared +sunflowers'
+test_todo_completion 'projects beginning with s' 'todo.sh list +s' '+shared +sunflowers'
+test_todo_completion 'projects beginning with ro' 'todo.sh list +ro' '+roses'
+test_todo_completion 'projects beginning with x' 'todo.sh list +x' ''
+
+test_todo_completion 'projects from done tasks beginning with h' 'todo.sh list +h' '+herbs'
+test_todo_completion 'projects from done tasks beginning with sl' 'todo.sh list +sl' '+slack'
+
+test_done

tests/t8000-actions.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='custom actions functionality
 

tests/t9999-testsuite_example.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='basic tests imported from previous framework
 '

tests/test-lib.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 #
 # Copyright (c) 2005 Junio C Hamano
 #
@@ -305,7 +305,7 @@ $cmp_output"
 		else
 			cmp_output=$(test_cmp expect output)
 			test_failure_ "$2" "$3" "
-* expected exit code $1, actual ${eval_ret}${cmp_output:+
+expected exit code $1, actual ${eval_ret}${cmp_output:+
 }${cmp_output}"
 		fi
 	fi
@@ -324,7 +324,7 @@ test_expect_code () {
 			test_ok_ "$2"
 		else
 			test_failure_ "$2" "$3" "
-* expected exit code $1, actual ${eval_ret}"
+expected exit code $1, actual ${eval_ret}"
 		fi
 	fi
 	echo >&3 ""
@@ -632,6 +632,59 @@ EOF
 	exit 0
 }
 
+test_todo_completion () {
+	test "$#" = 3 ||
+	error "bug in the test script: not 3 parameters to test_todo_completion"
+	if ! test_skip "$@"
+	then
+		description=$1
+		expected=$3
+
+		if [ "${2: -1}" = ' ' ]
+		then
+			offset=0
+			say >&3 "expecting completions after: '$2'"
+		else
+			offset=1
+			say >&3 "expecting context completions for: '$2'"
+		fi
+
+		SAVEIFS=$IFS
+		IFS=' ' set -- $2
+		COMP_WORDS=("$@")
+		COMP_CWORD=$(($# - $offset))
+		IFS=' ' set -- $expected
+		EXPECT=("$@")
+
+		source "$TEST_DIRECTORY/../todo_completion"
+		_todo
+		ret=$?
+		if [ "$ret" = 0 ]
+		then
+			IFS=$'\n'
+			printf "%s${EXPECT:+\\n}" "${EXPECT[*]}" > expect
+			printf "%s${COMPREPLY:+\\n}" "${COMPREPLY[*]}" > compreply
+			IFS=$SAVEIFS
+
+			if [ ${#COMPREPLY[@]} -eq ${#EXPECT[@]} ]
+			then
+				if [ "${COMPREPLY[*]}" = "${EXPECT[*]}" ]
+				then
+					test_ok_ "$description"
+				else
+					test_failure_ "$description" "$(test_cmp expect compreply)"
+				fi
+			else
+				test_failure_ "$description" "expected ${#EXPECT[@]} completion(s), got ${#COMPREPLY[@]}:
+$(test_cmp expect compreply)"
+			fi
+		else
+			test_failure_ "$description" "expected completions, actual exit code $ret"
+		fi
+	fi
+	echo >&3 ""
+}
+
 test_init_todo "$test"
 # Use -P to resolve symlinks in our working directory so that the pwd
 # in subprocesses equals our $PWD (for pathname comparisons).

tests/testshell.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 test_description='Providing an interactive shell in the proper environment'
 . ./test-lib.sh

todo.sh

@@ -136,7 +136,7 @@ help()
 
 	EndOptionsHelp
 
-    [ $TODOTXT_VERBOSE -gt 1 ] && cat <<-EndVerboseHelp
+    [ $TODOTXT_VERBOSE -gt 1 ] && cat <<-'EndVerboseHelp'
 		  Environment variables:
 		    TODOTXT_AUTO_ARCHIVE            is same as option -a (0)/-A (1)
 		    TODOTXT_CFG_FILE=CONFIG_FILE    is same as option -d CONFIG_FILE
@@ -149,6 +149,7 @@ help()
 		    TODOTXT_DEFAULT_ACTION=""       run this when called with no arguments
 		    TODOTXT_SORT_COMMAND="sort ..." customize list output
 		    TODOTXT_FINAL_FILTER="sed ..."  customize list after color, P@+ hiding
+		    TODOTXT_SOURCEVAR=\$DONE_FILE   use another source for listcon, listproj
 
 
 	EndVerboseHelp
@@ -1128,12 +1129,16 @@ case $action in
     ;;
 
 "listcon" | "lsc" )
-    grep -o '[^ ]*@[^ ]\+' "$TODO_FILE" | grep '^@' | sort -u
+    FILE=$TODO_FILE
+    [ "$TODOTXT_SOURCEVAR" ] && eval "FILE=$TODOTXT_SOURCEVAR"
+    grep -ho '[^ ]*@[^ ]\+' "${FILE[@]}" | grep '^@' | sort -u
     ;;
 
 "listproj" | "lsprj" )
+    FILE=$TODO_FILE
+    [ "$TODOTXT_SOURCEVAR" ] && eval "FILE=$TODOTXT_SOURCEVAR"
     shift
-    eval "$(filtercommand 'cat "$TODO_FILE"' '' "$@")" | grep -o '[^ ]*+[^ ]\+' | grep '^+' | sort -u
+    eval "$(filtercommand 'cat "${FILE[@]}"' '' "$@")" | grep -o '[^ ]*+[^ ]\+' | grep '^+' | sort -u
     ;;
 
 "listpri" | "lsp" )

todo_completion

@@ -35,8 +35,18 @@ _todo()
                 completions=$(TODOTXT_VERBOSE=0 todo.sh command listfile);;
             -*) completions="$allCommands $OPTS";;
             *)  case "$cur" in
-                    +*) completions=$(TODOTXT_VERBOSE=0 todo.sh command listproj);;
-                    @*) completions=$(TODOTXT_VERBOSE=0 todo.sh command listcon);;
+                    +*) completions=$(TODOTXT_VERBOSE=0 todo.sh command listproj)
+                        COMPREPLY=( $( compgen -W "$completions" -- $cur ))
+                        [ ${#COMPREPLY[@]} -gt 0 ] && return 0
+                        # Fall back to projects extracted from done tasks.
+                        completions=$(TODOTXT_VERBOSE=0 TODOTXT_SOURCEVAR=\$DONE_FILE todo.sh command listproj)
+                        ;;
+                    @*) completions=$(TODOTXT_VERBOSE=0 todo.sh command listcon)
+                        COMPREPLY=( $( compgen -W "$completions" -- $cur ))
+                        [ ${#COMPREPLY[@]} -gt 0 ] && return 0
+                        # Fall back to contexts extracted from done tasks.
+                        completions=$(TODOTXT_VERBOSE=0 TODOTXT_SOURCEVAR=\$DONE_FILE todo.sh command listcon)
+                        ;;
                     *)  if [[ "$cur" =~ ^[0-9]+$ ]]; then
                             # Remove the (padded) task number; we prepend the
                             # user-provided $cur instead.