tests: use Git's test framework

This allows tests to run in parallel as well as letting us use "prove"
or another TAP harness to run the tests.

Git's test framework requires Git to be fully built before letting any
tests run, so add a new target to the top-level Makefile which builds
all of Git instead of just libgit.a and make the "test" target depend on
that.

Signed-off-by: John Keeping <john@keeping.me.uk>

13 files changed, 239 insertions, 291 deletions

diff --git a/Makefile b/Makefile
index 59edab0..ed29b3a 100644
--- a/Makefile
+++ b/Makefile
@@ -66,7 +66,10 @@ all:: cgit
 cgit:
         $(QUIET_SUBDIR0)git $(QUIET_SUBDIR1) -f ../cgit.mk ../cgit NO_CURL=1
 
-test: all
+git:
+        $(QUIET_SUBDIR0)git $(QUIET_SUBDIR1) NO_CURL=1
+
+test: all git
         $(QUIET_SUBDIR0)tests $(QUIET_SUBDIR1) all
 
 install: all
@@ -145,7 +148,7 @@ get-git:
 tags:
         $(QUIET_TAGS)find . -name '*.[ch]' | xargs ctags
 
-.PHONY: all cgit get-git
+.PHONY: all cgit git get-git
 .PHONY: clean clean-doc cleanall
 .PHONY: doc doc-html doc-man doc-pdf
 .PHONY: install install-doc install-html install-man install-pdf
diff --git a/tests/setup.sh b/tests/setup.sh
index e3c6c17..81e7220 100755
--- a/tests/setup.sh
+++ b/tests/setup.sh
@@ -15,46 +15,48 @@
 # run_test 'repo index' 'cgit_url "/" | tidy -e'
 # run_test 'repo summary' 'cgit_url "/foo" | tidy -e'
 
-unset CDPATH
+: ${TEST_DIRECTORY=$(pwd)/../git/t}
+TEST_NO_CREATE_REPO=YesPlease
+. "$TEST_DIRECTORY"/test-lib.sh
+
+# Prepend the directory containing cgit to PATH.
+PATH="$(pwd)/../..:$PATH"
 
 mkrepo() {
         name=$1
         count=$2
-        dir=$PWD
-        test -d "$name" && return
-        printf "Creating testrepo %s\n" "$name"
-        mkdir -p "$name"
-        cd "$name"
-        git init
-        n=1
-        while test $n -le $count
-        do
-                echo $n >file-$n
-                git add file-$n
-                git commit -m "commit $n"
-                n=$(expr $n + 1)
-        done
-        if test "$3" = "testplus"
-        then
-                echo "hello" >a+b
-                git add a+b
-                git commit -m "add a+b"
-                git branch "1+2"
-        fi
-        cd "$dir"
+        test_create_repo "$name"
+        (
+                cd "$name"
+                n=1
+                while test $n -le $count
+                do
+                        echo $n >file-$n
+                        git add file-$n
+                        git commit -m "commit $n"
+                        n=$(expr $n + 1)
+                done
+                if test "$3" = "testplus"
+                then
+                        echo "hello" >a+b
+                        git add a+b
+                        git commit -m "add a+b"
+                        git branch "1+2"
+                fi
+        )
 }
 
 setup_repos()
 {
-        rm -rf trash/cache
-        mkdir -p trash/cache
-        mkrepo trash/repos/foo 5 >/dev/null
-        mkrepo trash/repos/bar 50 >/dev/null
-        mkrepo trash/repos/foo+bar 10 testplus >/dev/null
-        mkrepo "trash/repos/with space" 2 >/dev/null
-        cat >trash/cgitrc <<EOF
+        rm -rf cache
+        mkdir -p cache
+        mkrepo repos/foo 5 >/dev/null
+        mkrepo repos/bar 50 >/dev/null
+        mkrepo repos/foo+bar 10 testplus >/dev/null
+        mkrepo "repos/with space" 2 >/dev/null
+        cat >cgitrc <<EOF
 virtual-root=/
-cache-root=$PWD/trash/cache
+cache-root=$PWD/cache
 
 cache-size=1021
 snapshots=tar.gz tar.bz zip
@@ -66,83 +68,33 @@ summary-tags=5
 clone-url=git://example.org/\$CGIT_REPO_URL.git
 
 repo.url=foo
-repo.path=$PWD/trash/repos/foo/.git
+repo.path=$PWD/repos/foo/.git
 # Do not specify a description for this repo, as it then will be assigned
 # the constant value "[no description]" (which actually used to cause a
 # segfault).
 
 repo.url=bar
-repo.path=$PWD/trash/repos/bar/.git
+repo.path=$PWD/repos/bar/.git
 repo.desc=the bar repo
 
 repo.url=foo+bar
-repo.path=$PWD/trash/repos/foo+bar/.git
+repo.path=$PWD/repos/foo+bar/.git
 repo.desc=the foo+bar repo
 
 repo.url=with space
-repo.path=$PWD/trash/repos/with space/.git
+repo.path=$PWD/repos/with space/.git
 repo.desc=spaced repo
 EOF
 }
 
-prepare_tests()
-{
-        setup_repos
-        rm -f test-output.log 2>/dev/null
-        test_count=0
-        test_failed=0
-        echo "[$0]" "$@" >test-output.log
-        echo "$@" "($0)"
-}
-
-tests_done()
-{
-        printf "\n"
-        if test $test_failed -gt 0
-        then
-                printf "test: *** %s failure(s), logfile=%s\n" \
-                        $test_failed "$(pwd)/test-output.log"
-                false
-        fi
-}
-
-run_test()
-{
-        bug=0
-        if test "$1" = "BUG"
-        then
-                bug=1
-                shift
-        fi
-        desc=$1
-        script=$2
-        test_count=$(expr $test_count + 1)
-        printf "\ntest %d: name='%s'\n" $test_count "$desc" >>test-output.log
-        printf "test %d: eval='%s'\n" $test_count "$2" >>test-output.log
-        eval "$2" >>test-output.log 2>>test-output.log
-        res=$?
-        printf "test %d: exitcode=%d\n" $test_count $res >>test-output.log
-        if test $res = 0 -a $bug = 0
-        then
-                printf " %2d) %-60s [ok]\n" $test_count "$desc"
-        elif test $res = 0 -a $bug = 1
-        then
-                printf " %2d) %-60s [BUG FIXED]\n" $test_count "$desc"
-        elif test $bug = 1
-        then
-                printf " %2d) %-60s [KNOWN BUG]\n" $test_count "$desc"
-        else
-                test_failed=$(expr $test_failed + 1)
-                printf " %2d) %-60s [failed]\n" $test_count "$desc"
-        fi
-}
-
 cgit_query()
 {
-        CGIT_CONFIG="$PWD/trash/cgitrc" QUERY_STRING="$1" "$PWD/../cgit"
+        CGIT_CONFIG="$PWD/cgitrc" QUERY_STRING="$1" cgit
 }
 
 cgit_url()
 {
-        CGIT_CONFIG="$PWD/trash/cgitrc" QUERY_STRING="url=$1" "$PWD/../cgit"
+        CGIT_CONFIG="$PWD/cgitrc" QUERY_STRING="url=$1" cgit
 }
+
+test -z "$CGIT_TEST_NO_CREATE_REPOS" && setup_repos
diff --git a/tests/t0001-validate-git-versions.sh b/tests/t0001-validate-git-versions.sh
index 3378358..754046e 100755
--- a/tests/t0001-validate-git-versions.sh
+++ b/tests/t0001-validate-git-versions.sh
@@ -1,36 +1,36 @@
 #!/bin/sh
 
+test_description='Check Git version is correct'
+CGIT_TEST_NO_CREATE_REPOS=YesPlease
 . ./setup.sh
 
-prepare_tests 'Check Git version is correct'
-
-run_test 'extract Git version from Makefile' '
+test_expect_success 'extract Git version from Makefile' '
         sed -n -e "/^GIT_VER[   ]*=/ {
                 s/^GIT_VER[     ]*=[    ]*//
                 p
-        }" ../Makefile >trash/makefile_version
+        }" ../../Makefile >makefile_version
 '
 
-run_test 'test Git version matches Makefile' '
-        ( cat ../git/GIT-VERSION-FILE || echo "No GIT-VERSION-FILE" ) |
-        sed -e "s/GIT_VERSION[  ]*=[    ]*//" >trash/git_version &&
-        diff -u trash/git_version trash/makefile_version
+test_expect_success 'test Git version matches Makefile' '
+        ( cat ../../git/GIT-VERSION-FILE || echo "No GIT-VERSION-FILE" ) |
+        sed -e "s/GIT_VERSION[  ]*=[    ]*//" >git_version &&
+        test_cmp git_version makefile_version
 '
 
-run_test 'test submodule version matches Makefile' '
-        if ! test -e ../git/.git
+test_expect_success 'test submodule version matches Makefile' '
+        if ! test -e ../../git/.git
         then
                 echo "git/ is not a Git repository" >&2
         else
                 (
-                        cd .. &&
+                        cd ../.. &&
                         sm_sha1=$(git ls-files --stage -- git |
                                 sed -e "s/^[0-9]* \\([0-9a-f]*\\) [0-9] .*$/\\1/") &&
                         cd git &&
                         git describe --match "v[0-9]*" $sm_sha1
-                ) | sed -e "s/^v//" >trash/sm_version &&
-                diff -u trash/sm_version trash/makefile_version
+                ) | sed -e "s/^v//" >sm_version &&
+                test_cmp sm_version makefile_version
         fi
 '
 
-tests_done
+test_done
diff --git a/tests/t0010-validate-html.sh b/tests/t0010-validate-html.sh
index 3fe4800..5bd0a25 100755
--- a/tests/t0010-validate-html.sh
+++ b/tests/t0010-validate-html.sh
@@ -1,5 +1,6 @@
 #!/bin/sh
 
+test_description='Validate html with tidy'
 . ./setup.sh
 
 
@@ -7,9 +8,9 @@ test_url()
 {
         tidy_opt="-eq"
         test -z "$NO_TIDY_WARNINGS" || tidy_opt+=" --show-warnings no"
-        cgit_url "$1" >trash/tidy-$test_count || return
-        sed -ie "1,4d" trash/tidy-$test_count || return
-        "$tidy" $tidy_opt trash/tidy-$test_count
+        cgit_url "$1" >tidy-$test_count || return
+        sed -ie "1,4d" tidy-$test_count || return
+        "$tidy" $tidy_opt tidy-$test_count
         rc=$?
 
         # tidy returns with exitcode 1 on warnings, 2 on error
@@ -21,21 +22,19 @@ test_url()
         fi
 }
 
-prepare_tests 'Validate html with tidy'
-
-tidy=`which tidy`
+tidy=`which tidy 2>/dev/null`
 test -n "$tidy" || {
-        echo "Skipping tests: tidy not found"
-        tests_done
+        skip_all='Skipping html validation tests: tidy not found'
+        test_done
         exit
 }
 
-run_test 'index page' 'test_url ""'
-run_test 'foo' 'test_url "foo"'
-run_test 'foo/log' 'test_url "foo/log"'
-run_test 'foo/tree' 'test_url "foo/tree"'
-run_test 'foo/tree/file-1' 'test_url "foo/tree/file-1"'
-run_test 'foo/commit' 'test_url "foo/commit"'
-run_test 'foo/diff' 'test_url "foo/diff"'
+test_expect_success 'index page' 'test_url ""'
+test_expect_success 'foo' 'test_url "foo"'
+test_expect_success 'foo/log' 'test_url "foo/log"'
+test_expect_success 'foo/tree' 'test_url "foo/tree"'
+test_expect_success 'foo/tree/file-1' 'test_url "foo/tree/file-1"'
+test_expect_success 'foo/commit' 'test_url "foo/commit"'
+test_expect_success 'foo/diff' 'test_url "foo/diff"'
 
-tests_done
+test_done
diff --git a/tests/t0020-validate-cache.sh b/tests/t0020-validate-cache.sh
index 53ec2eb..1910b47 100755
--- a/tests/t0020-validate-cache.sh
+++ b/tests/t0020-validate-cache.sh
@@ -1,13 +1,12 @@
 #!/bin/sh
 
+test_description='Validate cache'
 . ./setup.sh
 
-prepare_tests 'Validate cache'
+test_expect_success 'verify cache-size=0' '
 
-run_test 'verify cache-size=0' '
-
-        rm -f trash/cache/* &&
-        sed -i -e "s/cache-size=1021$/cache-size=0/" trash/cgitrc &&
+        rm -f cache/* &&
+        sed -i -e "s/cache-size=1021$/cache-size=0/" cgitrc &&