test-report: Use color highlighting as in test-lib.

The test aggregate results are easy to miss when running the entire test suite via "make test", as the status of the last test case is highlighted, but the aggregate results appear in an unformatted, uncolored block of text.
Copy the say_color() function from test-lib.sh. (Sorry for the duplication, I found no simple way to import or share just this piece of functionality without adding much complexity.)
Successes, errors and broken summaries will now be highlighted in the appropriate colors (unless --no-color is given or output is not to a terminal), but only if the number is more than zero.

tests/aggregate-results.sh

@@ -1,4 +1,57 @@
-#!/bin/sh
+#!/bin/bash
+
+[ "x$TERM" != "xdumb" ] && (
+		export TERM &&
+		[ -t 1 ] &&
+		tput bold >/dev/null 2>&1 &&
+		tput setaf 1 >/dev/null 2>&1 &&
+		tput sgr0 >/dev/null 2>&1
+	) &&
+	color=t
+
+case "$1" in
+--no-color)
+	color=; shift ;;
+esac
+
+if test -n "$color"; then
+	say_color () {
+		(
+		export TERM
+		case "$1" in
+			error) tput bold; tput setaf 1;; # bold red
+			skip)  tput bold; tput setaf 2;; # bold green
+			pass)  tput setaf 2;;            # green
+			info)  tput setaf 3;;            # brown
+			*) test -n "$quiet" && return;;
+		esac
+		shift
+		printf "* %s" "$*"
+		tput sgr0
+		echo
+		)
+	}
+else
+	say_color() {
+		test -z "$1" && test -n "$quiet" && return
+		shift
+		echo "* $*"
+	}
+fi
+
+get_color()
+{
+	# Only use the supplied color if there are actually instances of that
+	# type, so that a clean test run does not distract the user by the
+	# appearance of the error highlighting.
+	if [ ${1:?} -eq 0 ]
+	then
+		echo 'info'
+	else
+		echo "${2:-info}"
+	fi
+}
+
 
 fixed=0
 success=0
@@ -27,8 +80,8 @@ do
 	done <"$file"
 done
 
-printf "%-8s%d\n" fixed $fixed
+say_color 'info'                           "$(printf "%-8s%d\n" fixed $fixed)"
-printf "%-8s%d\n" success $success
+say_color "$(get_color "$success" 'pass')" "$(printf "%-8s%d\n" success $success)"
-printf "%-8s%d\n" failed $failed
+say_color "$(get_color "$failed" 'error')" "$(printf "%-8s%d\n" failed $failed)"
-printf "%-8s%d\n" broken $broken
+say_color "$(get_color "$broken" 'error')" "$(printf "%-8s%d\n" broken $broken)"
-printf "%-8s%d\n" total $total
+say_color 'info'                           "$(printf "%-8s%d\n" total $total)"

tests/t1900-archive.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+
+test_description='archive functionality
+
+Ensure we can archive items successfully.
+'
+. ./test-lib.sh
+
+cat > todo.txt <<EOF
+one
+two
+three
+one
+x done
+four
+EOF
+
+test_todo_session 'archive with duplicates' <<EOF
+>>> todo.sh archive
+x done
+TODO: $HOME/todo.txt archived.
+EOF
+
+test_todo_session 'list after archive' <<EOF
+>>> todo.sh ls
+5 four
+1 one
+4 one
+3 three
+2 two
+--
+TODO: 5 of 5 tasks shown
+EOF
+
+test_done

tests/t1910-deduplicate.sh

@@ -0,0 +1,103 @@
+#!/bin/sh
+
+test_description='deduplicate functionality
+
+Ensure we can deduplicate items successfully.
+'
+. ./test-lib.sh
+
+cat > todo.txt <<EOF
+duplicated
+two
+x done
+duplicated
+double task
+double task
+three
+EOF
+
+test_todo_session 'deduplicate and preserve line numbers' <<EOF
+>>> todo.sh deduplicate
+TODO: 2 duplicate task(s) removed
+
+>>> todo.sh -p ls
+5 double task
+1 duplicated
+7 three
+2 two
+3 x done
+--
+TODO: 5 of 5 tasks shown
+EOF
+
+test_todo_session 'deduplicate without duplicates' <<EOF
+>>> todo.sh deduplicate
+TODO: No duplicate tasks found
+EOF
+
+cat > todo.txt <<EOF
+duplicated
+two
+x done
+duplicated
+double task
+double task
+three
+EOF
+test_todo_session 'deduplicate and delete lines' <<EOF
+>>> todo.sh -n deduplicate
+TODO: 2 duplicate task(s) removed
+
+>>> todo.sh -p ls
+4 double task
+1 duplicated
+5 three
+2 two
+3 x done
+--
+TODO: 5 of 5 tasks shown
+EOF
+
+cat > todo.txt <<EOF
+one
+duplicated
+three
+duplicated
+duplicated
+six
+duplicated
+EOF
+test_todo_session 'deduplicate more than two occurrences' <<EOF
+>>> todo.sh deduplicate
+TODO: 3 duplicate task(s) removed
+
+>>> todo.sh -p ls
+2 duplicated
+1 one
+6 six
+3 three
+--
+TODO: 4 of 4 tasks shown
+EOF
+
+cat > todo.txt <<EOF
+normal task
+a bold task
+something else
+a bold task
+something more
+EOF
+test_todo_session 'deduplicate with non-printable duplicates' <<EOF
+>>> todo.sh deduplicate
+TODO: 1 duplicate task(s) removed
+
+>>> todo.sh -p ls
+2 a bold task
+1 normal task
+3 something else
+5 something more
+--
+TODO: 4 of 4 tasks shown
+EOF
+
+test_done

tests/t1950-report.sh

@@ -0,0 +1,96 @@
+#!/bin/sh
+
+test_description='report functionality
+
+This test checks the reporting and the format of the report file.
+'
+. ./test-lib.sh
+
+cat > todo.txt <<EOF
+(B) smell the uppercase Roses +flowers @outside
+stop and think
+smell the coffee +wakeup
+make the coffee +wakeup
+visit http://example.com
+EOF
+
+test_todo_session 'create new report' <<EOF
+>>> todo.sh report
+TODO: $HOME/todo.txt archived.
+2009-02-13T04:40:00 5 0
+TODO: Report file updated.
+
+>>> todo.sh -p list
+1 (B) smell the uppercase Roses +flowers @outside
+4 make the coffee +wakeup
+3 smell the coffee +wakeup
+2 stop and think
+5 visit http://example.com
+--
+TODO: 5 of 5 tasks shown
+EOF
+
+test_todo_session 'report of done tasks' <<EOF
+>>> todo.sh -A do 3
+3 x 2009-02-13 smell the coffee +wakeup
+TODO: 3 marked as done.
+x 2009-02-13 smell the coffee +wakeup
+TODO: $HOME/todo.txt archived.
+
+>>> todo.sh report
+TODO: $HOME/todo.txt archived.
+2009-02-13T04:40:00 4 1
+TODO: Report file updated.
+
+>>> todo.sh -p list
+1 (B) smell the uppercase Roses +flowers @outside
+3 make the coffee +wakeup
+2 stop and think
+4 visit http://example.com
+--
+TODO: 4 of 4 tasks shown
+EOF
+
+test_todo_session 'report performs archiving' <<EOF
+>>> todo.sh -a do 3
+3 x 2009-02-13 make the coffee +wakeup
+TODO: 3 marked as done.
+
+>>> todo.sh report
+x 2009-02-13 make the coffee +wakeup
+TODO: $HOME/todo.txt archived.
+2009-02-13T04:40:00 3 2
+TODO: Report file updated.
+
+>>> todo.sh -p list
+1 (B) smell the uppercase Roses +flowers @outside
+2 stop and think
+3 visit http://example.com
+--
+TODO: 3 of 3 tasks shown
+
+>>> todo.sh -p listfile done.txt
+2 x 2009-02-13 make the coffee +wakeup
+1 x 2009-02-13 smell the coffee +wakeup
+--
+DONE: 2 of 2 tasks shown
+EOF
+
+test_todo_session 'report is unchanged when no changes' <<EOF
+>>> cat report.txt
+2009-02-13T04:40:00 5 0
+2009-02-13T04:40:00 4 1
+2009-02-13T04:40:00 3 2
+
+>>> todo.sh report
+TODO: $HOME/todo.txt archived.
+2009-02-13T04:40:00 3 2
+TODO: Report file is up-to-date.
+
+>>> cat report.txt
+2009-02-13T04:40:00 5 0
+2009-02-13T04:40:00 4 1
+2009-02-13T04:40:00 3 2
+EOF
+
+test_done

tests/t9999-testsuite_example.sh

@@ -85,13 +85,9 @@ TODO: $HOME/todo.txt archived.
 TODO: 5 of 5 tasks shown
 
 >>> todo.sh report
+TODO: $HOME/todo.txt archived.
+2009-02-13T04:40:00 5 1
 TODO: Report file updated.
-2009-02-13-04:40:00 5 1
-
->>> todo.sh report
-TODO: Report file updated.
-2009-02-13-04:40:00 5 1
-2009-02-13-04:40:00 5 1
 
 >>> todo.sh append g a
 usage: todo.sh append ITEM# "TEXT TO APPEND"

tests/test-lib.sh

@@ -180,7 +180,7 @@ test_failure_ () {
 	test_failure=$(($test_failure + 1))
 	say_color error "FAIL $test_count: $1"
 	shift
-	echo "$@" | sed -e 's/^/	/'
+	echo "$@"
 	test "$immediate" = "" || { trap - EXIT; exit 1; }
 }
 
@@ -199,8 +199,9 @@ test_debug () {
 }
 
 test_run_ () {
-	eval >&3 2>&4 "$1"
+	eval > output 2>&1 "$1"
 	eval_ret="$?"
+	cat >&3 output
 	return 0
 }
 
@@ -260,6 +261,57 @@ test_expect_success () {
 	echo >&3 ""
 }
 
+test_expect_output () {
+	test "$#" = 2 ||
+	error "bug in the test script: not 2 parameters to test-expect-output"
+	if ! test_skip "$@"
+	then
+		say >&3 "expecting success and output: $2"
+		test_run_ "$2"
+		if [ "$?" = 0 -a "$eval_ret" = 0 ]
+		then
+			cmp_output=$(test_cmp expect output)
+			if [ "$?" = 0 ]
+			then
+				test_ok_ "$1"
+			else
+				test_failure_ "$@" "
+$cmp_output"
+			fi
+		else
+			test_failure_ "$@"
+		fi
+	fi
+	echo >&3 ""
+}
+
+test_expect_code_and_output () {
+	test "$#" = 3 ||
+	error "bug in the test script: not 3 parameters to test-expect-code-and-output"
+	if ! test_skip "$@"
+	then
+		say >&3 "expecting exit code $1 and output: $3"
+		test_run_ "$3"
+		if [ "$?" = 0 -a "$eval_ret" = "$1" ]
+		then
+			cmp_output=$(test_cmp expect output)
+			if [ "$?" = 0 ]
+			then
+				test_ok_ "$2"
+			else
+				test_failure_ "$2" "$3" "
+$cmp_output"
+			fi
+		else
+			cmp_output=$(test_cmp expect output)
+			test_failure_ "$2" "$3" "
+* expected exit code $1, actual ${eval_ret}${cmp_output:+
+}${cmp_output}"
+		fi
+	fi
+	echo >&3 ""
+}
+
 test_expect_code () {
 	test "$#" = 3 ||
 	error "bug in the test script: not 3 parameters to test-expect-code"
@@ -271,7 +323,8 @@ test_expect_code () {
 		then
 			test_ok_ "$2"
 		else
-			test_failure_ "$@"
+			test_failure_ "$2" "$3" "
+* expected exit code $1, actual ${eval_ret}"
 		fi
 	fi
 	echo >&3 ""
@@ -542,9 +595,9 @@ test_todo_session () {
 	"")
 	    if [ ! -z "$cmd" ]; then
 		if [ $status = 0 ]; then
-		    test_expect_success "$1 $subnum" "$cmd > output && test_cmp expect output"
+		    test_expect_output "$1 $subnum" "$cmd"
 		else
-		    test_expect_success "$1 $subnum" "$cmd > output ; test \$? = $status && test_cmp expect output"
+		    test_expect_code_and_output "$status" "$1 $subnum" "$cmd"
 		fi
 
 		subnum=$(($subnum + 1))
@@ -560,9 +613,9 @@ test_todo_session () {
     done
     if [ ! -z "$cmd" ]; then
 	if [ $status = 0 ]; then
-	    test_expect_success "$1 $subnum" "$cmd > output && test_cmp expect output"
+	    test_expect_output "$1 $subnum" "$cmd"
 	else
-	    test_expect_success "$1 $subnum" "$cmd > output ; test \$? = $status && test_cmp expect output"
+	    test_expect_code_and_output "$status" "$1 $subnum" "$cmd"
 	fi
     fi
 }

todo.sh

@@ -50,6 +50,7 @@ shorthelp()
 		    append|app ITEM# "TEXT TO APPEND"
 		    archive
 		    command [ACTIONS]
+		    deduplicate
 		    del|rm ITEM# [TERM]
 		    depri|dp ITEM#[, ITEM#, ITEM#, ...]
 		    do ITEM#[, ITEM#, ITEM#, ...]
@@ -181,6 +182,9 @@ help()
 		      Runs the remaining arguments using only todo.sh builtins.
 		      Will not call any .todo.actions.d scripts.
 
+		    deduplicate
+		      Removes duplicate lines from todo.txt.
+
 		    del ITEM# [TERM]
 		    rm ITEM# [TERM]
 		      Deletes the task on line ITEM# in todo.txt.
@@ -363,20 +367,6 @@ getNewtodo()
     [ -z "$newtodo" ] && die "$(getPrefix "$2"): No updated task $item."
 }
 
-archive()
-{
-    #defragment blank lines
-    sed -i.bak -e '/./!d' "$TODO_FILE"
-    [ $TODOTXT_VERBOSE -gt 0 ] && grep "^x " "$TODO_FILE"
-    grep "^x " "$TODO_FILE" >> "$DONE_FILE"
-    sed -i.bak '/^x /d' "$TODO_FILE"
-    cp "$TODO_FILE" "$TMP_FILE"
-    sed -n 'G; s/\n/&&/; /^\([ ~-]*\n\).*\n\1/d; s/\n//; h; P' "$TMP_FILE" > "$TODO_FILE"
-    if [ $TODOTXT_VERBOSE -gt 0 ]; then
-	echo "TODO: $TODO_FILE archived."
-    fi
-}
-
 replaceOrPrepend()
 {
   action=$1; shift
@@ -948,7 +938,15 @@ case $action in
     ;;
 
 "archive" )
-    archive;;
+    # defragment blank lines
+    sed -i.bak -e '/./!d' "$TODO_FILE"
+    [ $TODOTXT_VERBOSE -gt 0 ] && grep "^x " "$TODO_FILE"
+    grep "^x " "$TODO_FILE" >> "$DONE_FILE"
+    sed -i.bak '/^x /d' "$TODO_FILE"
+    if [ $TODOTXT_VERBOSE -gt 0 ]; then
+	echo "TODO: $TODO_FILE archived."
+    fi
+    ;;
 
 "del" | "rm" )
     # replace deleted line with a blank line when TODOTXT_PRESERVE_LINE_NUMBERS is 1
@@ -1050,7 +1048,9 @@ case $action in
     done
 
     if [ $TODOTXT_AUTO_ARCHIVE = 1 ]; then
-        archive
+        # Recursively invoke the script to allow overriding of the archive
+        # action.
+        "$TODO_FULL_SH" archive
     fi
     ;;
 
@@ -1216,21 +1216,68 @@ note: PRIORITY must be anywhere from A to Z."
 
 "report" )
     # archive first
-    sed '/^x /!d' "$TODO_FILE" >> "$DONE_FILE"
+    # Recursively invoke the script to allow overriding of the archive
-    sed -i.bak '/^x /d' "$TODO_FILE"
+    # action.
+    "$TODO_FULL_SH" archive
 
-    NUMLINES=$( sed -n '$ =' "$TODO_FILE" )
-    if [ ${NUMLINES:-0} = "0" ]; then
-         echo "datetime todos dones" >> "$REPORT_FILE"
-    fi
-    #now report
     TOTAL=$( sed -n '$ =' "$TODO_FILE" )
     TDONE=$( sed -n '$ =' "$DONE_FILE" )
-    TECHO=$(echo $(date +%Y-%m-%d-%T); echo ' '; echo ${TOTAL:-0}; echo ' ';
+    NEWDATA="${TOTAL:-0} ${TDONE:-0}"
-    echo ${TDONE:-0})
+    LASTREPORT=$(sed -ne '$p' "$REPORT_FILE")
-    echo $TECHO >> "$REPORT_FILE"
+    LASTDATA=${LASTREPORT#* }   # Strip timestamp.
+    if [ "$LASTDATA" = "$NEWDATA" ]; then
+        echo "$LASTREPORT"
+        [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file is up-to-date."
+    else
+        NEWREPORT="$(date +%Y-%m-%dT%T) ${NEWDATA}"
+        echo "${NEWREPORT}" >> "$REPORT_FILE"
+        echo "${NEWREPORT}"
         [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file updated."
-    cat "$REPORT_FILE"
+    fi
+    ;;
+
+"deduplicate" )
+    if [ $TODOTXT_PRESERVE_LINE_NUMBERS = 0 ]; then
+        deduplicateSedCommand='d'
+    else
+        deduplicateSedCommand='s/^.*//; p'
+    fi
+
+    # To determine the difference when deduplicated lines are preserved, only
+    # non-empty lines must be counted.
+    originalTaskNum=$( sed -e '/./!d' "$TODO_FILE" | sed -n '$ =' )
+
+    # Look for duplicate lines and discard the second occurrence.
+    # We start with an empty hold space on the first line.  For each line:
+    #   G - appends newline + hold space to the pattern space
+    #   s/\n/&&/; - double up the first new line so we catch adjacent dups
+    #   /^\([^\n]*\n\).*\n\1/b dedup
+    #       If the first line of the hold space shows up again later as an
+    #       entire line, it's a duplicate. Jump to the "dedup" label, where
+    #       either of the following is executed, depending on whether empty
+    #       lines should be preserved:
+    #       d           - Delete the current pattern space, quit this line and
+    #                     move on to the next, or:
+    #       s/^.*//; p  - Clear the task text, print this line and move on to
+    #                     the next.
+    #   s/\n//;   - else (no duplicate), drop the doubled newline
+    #   h;        - replace the hold space with the expanded pattern space
+    #   P;        - print up to the first newline (that is, the input line)
+    #   b         - end processing of the current line
+    sed -i.bak -n \
+        -e 'G; s/\n/&&/; /^\([^\n]*\n\).*\n\1/b dedup' \
+        -e 's/\n//; h; P; b' \
+        -e ':dedup' \
+        -e "$deduplicateSedCommand" \
+        "$TODO_FILE"
+
+    newTaskNum=$( sed -e '/./!d' "$TODO_FILE" | sed -n '$ =' )
+    deduplicateNum=$(( originalTaskNum - newTaskNum ))
+    if [ $deduplicateNum -eq 0 ]; then
+        echo "TODO: No duplicate tasks found"
+    else
+        echo "TODO: $deduplicateNum duplicate task(s) removed"
+    fi
     ;;
 
 * )