From 3b4a8eb10c185a65619b72264a1df4ac643451fc Mon Sep 17 00:00:00 2001
From: Brandon Philips <brandon@ifup.org>
Date: Wed, 25 Oct 2006 23:04:33 -0700
Subject: [PATCH] Initial commit of the test library

Signed-off-by: Brandon Philips <brandon@ifup.org>
---
 t/Makefile       |   24 ++++++
 t/README         |  183 +++++++++++++++++++++++++++++++++++++++++++
 t/t0000-basic.sh |   27 +++++++
 t/test-lib.sh    |  228 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 462 insertions(+), 0 deletions(-)

diff --git a/t/Makefile b/t/Makefile
new file mode 100644
index 0000000..5567b15
--- /dev/null
+++ b/t/Makefile
@@ -0,0 +1,24 @@
+# Run tests
+#
+# Copyright (c) 2005 Junio C Hamano
+#
+
+SHELL_PATH ?= $(SHELL)
+TAR ?= $(TAR)
+
+# Shell quote;
+SHELL_PATH_SQ = $(subst ','\'',$(SHELL_PATH))
+
+T = $(wildcard t[0-9][0-9][0-9][0-9]-*.sh)
+
+all: $(T) clean
+
+$(T):
+	@echo "*** $@ ***"; '$(SHELL_PATH_SQ)' $@
+
+clean:
+	rm -fr trash
+
+.PHONY: $(T) clean
+.NOTPARALLEL:
+
diff --git a/t/README b/t/README
new file mode 100644
index 0000000..cfa5bbc
--- /dev/null
+++ b/t/README
@@ -0,0 +1,183 @@
+chunkfs Tests
+=============
+
+This directory may hold many test scripts for chunkfs in the future.  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".  This runs all
+the tests.
+
+	*** t0000-basic.sh ***
+	chunkfs initialized with 3 chunks
+	*   ok 1: create file foo
+	*   ok 2: rm file foo
+	* passed all 2 test(s)
+
+Or you can run each test individually from command line, like
+this:
+
+	$ ./t0000-basic.sh
+	chunkfs initialized with 3 chunks
+	*   ok 1: create file foo
+	*   ok 2: rm file foo
+	* passed all 2 test(s)
+
+
+You can pass --verbose (or -v), --debug (or -d), and --immediate
+(or -i) command line argument to the test.
+
+--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.
+
+
+Naming Tests
+------------
+
+TODO: decide on the naming scheme.
+
+The test files are named as:
+
+	tNNNN-commandname-details.sh
+
+where N is a decimal digit.
+
+First digit tells the family:
+
+	0 - 
+	1 -
+	2 -
+	3 -
+	4 -
+	5 -
+	6 -
+	7 -
+
+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 t/ 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 the variables
+'test_description' and 'chunk_sizes', like this:
+
+	#!/bin/sh
+	#
+	# Copyright (c) 2006 Brandon Philips
+	#
+
+	test_description='xxx test
+
+	This test does some fancy filesystems type stuff'
+
+	chunk_sizes=(1 1 1) # Create three one block chunks
+
+
+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 a directory with a disk/ and mnt/ chdir into mnt/ after creating and
+   mounting the disks.  This directory is 't/trash' 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_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 \
+        	'create file foo' \
+	        'touch foo'
+
+
+ - test_expect_failure <message> <script>
+
+   This is the opposite of test_expect_success.  If <script> yields success,
+   test is considered a failure.
+
+   Example:
+
+	test_expect_failure\
+        	'rm file does_not_exist' \
+	        'rm does_not_exist'
+
+
+ - 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, unmount the chunkfs and
+   exit with an appropriate error code.
+
+Credits
+-------
+The chunkfs testing framework is based on Junio C Hamano framework for git.
+	http://www.kernel.org/pub/software/scm/git
diff --git a/t/t0000-basic.sh b/t/t0000-basic.sh
new file mode 100755
index 0000000..9aca9fd
--- /dev/null
+++ b/t/t0000-basic.sh
@@ -0,0 +1,27 @@
+#!/bin/sh
+#
+# Copyright (c) 2006 Brandon Philips
+#
+
+test_description='Test the basics, adding and removing a file
+'
+
+chunk_sizes=(1 1 1)
+
+. ./test-lib.sh
+
+test_expect_success \
+	'create file foo' \
+	'touch foo'
+
+test_remount_chunks
+
+test_expect_success \
+	'rm file foo' \
+	'rm foo'
+
+test_expect_failure \
+	'rm file does_not_exist' \
+	'rm does_not_exist'
+
+test_done
diff --git a/t/test-lib.sh b/t/test-lib.sh
new file mode 100755
index 0000000..57d3399
--- /dev/null
+++ b/t/test-lib.sh
@@ -0,0 +1,228 @@
+#!/bin/sh
+#
+# Copyright (c) 2005 Junio C Hamano
+# Copyright (c) 2006 Brandon Philips <brandon@ifup.org>
+#
+
+# For repeatability, reset the environment to known value.
+LANG=C
+LC_ALL=C
+PAGER=cat
+TZ=UTC
+export LANG LC_ALL PAGER TZ
+EDITOR=:
+VISUAL=:
+export EDITOR VISUAL
+
+export TEST=trash
+export DISKS=disks
+export MNT=mnt
+
+# Each test should start with something like this, after copyright notices:
+#
+# test_description='Description of this test...
+# This test checks if command xyzzy does the right thing...
+# '
+# . ./test-lib.sh
+
+error () {
+	echo "* error: $*"
+	trap - exit
+	exit 1
+}
+
+say () {
+	echo "* $*"
+}
+
+test "${test_description}" != "" ||
+error "Test script did not set test_description."
+
+while test "$#" -ne 0
+do
+	case "$1" in
+	-d|--d|--de|--deb|--debu|--debug)
+		debug=t; shift ;;
+	-i|--i|--im|--imm|--imme|--immed|--immedi|--immedia|--immediat|--immediate)
+		immediate=t; shift ;;
+	-h|--h|--he|--hel|--help)
+		echo "$test_description"
+		exit 0 ;;
+	-v|--v|--ve|--ver|--verb|--verbo|--verbos|--verbose)
+		verbose=t; shift ;;
+	*)
+		break ;;
+	esac
+done
+
+exec 5>&1
+if test "$verbose" = "t"
+then
+	exec 4>&2 3>&1
+else
+	exec 4>/dev/null 3>/dev/null
+fi
+
+test_failure=0
+test_count=0
+
+trap 'echo >&5 "FATAL: Unexpected exit with code $?"; exit 1' exit
+
+
+# You are not expected to call test_ok_ and test_failure_ directly, use
+# the text_expect_* functions instead.
+
+test_ok_ () {
+	test_count=$(expr "$test_count" + 1)
+	say "  ok $test_count: $@"
+}
+
+test_failure_ () {
+	test_count=$(expr "$test_count" + 1)
+	test_failure=$(expr "$test_failure" + 1);
+	say "FAIL $test_count: $1"
+	shift
+	echo "$@" | sed -e 's/^/	/'
+	test "$immediate" = "" || { trap - exit; exit 1; }
+}
+
+
+test_debug () {
+	test "$debug" = "" || eval "$1"
+}
+
+test_run_ () {
+	eval >&3 2>&4 "$1"
+	eval_ret="$?"
+	return 0
+}
+
+test_expect_failure () {
+	test "$#" = 2 ||
+	error "bug in the test script: not 2 parameters to test-expect-failure"
+	say >&3 "expecting failure: $2"
+	test_run_ "$2"
+	if [ "$?" = 0 -a "$eval_ret" != 0 ]
+	then
+		test_ok_ "$1"
+	else
+		test_failure_ "$@"
+	fi
+}
+
+test_expect_success () {
+	test "$#" = 2 ||
+	error "bug in the test script: not 2 parameters to test-expect-success"
+	say >&3 "expecting success: $2"
+	test_run_ "$2"
+	if [ "$?" = 0 -a "$eval_ret" = 0 ]
+	then
+		test_ok_ "$1"
+	else
+		test_failure_ "$@"
+	fi
+}
+
+test_expect_code () {
+	test "$#" = 3 ||
+	error "bug in the test script: not 3 parameters to test-expect-code"
+	say >&3 "expecting exit code $1: $3"
+	test_run_ "$3"
+	if [ "$?" = 0 -a "$eval_ret" = "$1" ]
+	then
+		test_ok_ "$2"
+	else
+		test_failure_ "$@"
+	fi
+}
+
+test_create_chunks() {
+	test "$#" = 1 ||
+	error "bug in the test script: not 2 parameters to test-create-chunks"
+	chunk_sizes=$1
+	i=0
+	while [ "$i" -lt "${#chunk_sizes[@]}" ]
+	do
+		test_create_chunk "disk$i.img" ${chunk_sizes[i]} 
+		let "i = $i + 1"
+	done
+}
+
+test_create_chunk() {
+	test "$#" = 2 ||
+	error "bug in the test script: not 2 parameters to test-create-chunk"
+	disk="$1"
+	size="$2"
+	dd if=/dev/zero of=$disk seek=1024 count=$size bs=1K status=noxfer \
+		> /dev/null 2> /dev/null || 
+	error "Cannot create disk"
+	yes y | mkfs.ext2 -q $disk > /dev/null 2> /dev/null
+}
+
+# Most tests can use the created repository, but some amy need to create more.
+# Usage: test_create_repo <directory>
+test_mount_chunks () {
+	test "$#" = 2 ||
+	error "bug in the test script: not 2 parameter to test-mount-chunks"
+	chunks="-o chunks="
+
+	n=`ls $1 | wc -l` 
+	for disk in `ls $1`
+	do
+		let "n = n - 1"
+		chunks="$chunks$PWD/$1/$disk"
+		if [ $n -ne 0 ]
+		then 
+			chunks="$chunks:"
+		fi
+	done
+	test_debug "echo mounting: chunkfs $chunks $2 &"
+	chunkfs $chunks $2 >> chunkfs.log &
+	sleep 1 # XXX FIX THIS- need to have a chunkfs flag to mount and background 
+}
+
+test_remount_chunks () {
+	cd .. && fusermount -u $MNT && sleep 1 && test_mount_chunks $DISKS $MNT && cd $MNT
+}
+	
+test_done () {
+	trap - exit
+	cd .. && fusermount -u $MNT 
+	case "$test_failure" in
+	0)
+		# We could:
+		# cd .. && rm -fr trash
+		# but that means we forbid any tests that use their own
+		# subdirectory from calling test_done without coming back
+		# to where they started from.
+		# The Makefile provided will clean this test area so
+		# we will leave things as they are.
+
+		say "passed all $test_count test(s)"
+		exit 0 ;;
+
+	*)
+		say "failed $test_failure among $test_count test(s)"
+		exit 1 ;;
+	esac
+
+}
+
+# Test the binaries we have just built.  The tests are kept in
+# t/ subdirectory and are run in trash subdirectory.
+PATH=$(pwd)/..:$PATH
+
+# Test directory
+rm -fr "$TEST"
+mkdir $TEST
+cd "$TEST"
+
+mkdir $DISKS
+mkdir $MNT
+
+cd $DISKS
+test_create_chunks $chunk_sizes
+cd ..
+
+test_mount_chunks $DISKS $MNT
+cd $MNT
-- 
1.4.4.1