Add Bats tests

Author: Vampire

.github/workflows/build.yaml

@@ -37,7 +37,9 @@ jobs:
             qtbase5-dev
 
       - name: 'Checkout Git branch'
-        uses: actions/checkout@v2.0.0
+        uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - name: 'Configure'
         run: |-
@@ -47,6 +49,10 @@ jobs:
         run: |-
           make
 
+      - name: 'Test'
+        run: |-
+          ./test.sh --no-make
+
       - name: 'Install'
         run: |-
           set -e

.gitignore

@@ -2,4 +2,6 @@ Makefile
 *~
 *.o
 svn-all-fast-export
+svn-all-fast-export.exe
 src/local-config.pri
+/build/

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "test/libs/bats-core"]
+	path = test/libs/bats-core
+	url = https://github.com/bats-core/bats-core
+[submodule "test/libs/bats-assert"]
+	path = test/libs/bats-assert
+	url = https://github.com/bats-core/bats-assert
+[submodule "test/libs/bats-support"]
+	path = test/libs/bats-support
+	url = https://github.com/bats-core/bats-support
+[submodule "test/libs/bats-file"]
+	path = test/libs/bats-file
+	url = https://github.com/tralston/bats-file

README.md

@@ -33,6 +33,19 @@ Run `qmake && make`.  You get `./svn-all-fast-export`.
 You will need to have some packages to compile it. For Ubuntu distros, use this command to install them all:
 `sudo apt-get install build-essential subversion git qtchooser qt5-default libapr1 libapr1-dev libsvn-dev`
 
+To run all tests you can simply call the `test.sh` script in the root directory.
+This will run all [Bats](https://github.com/bats-core/bats-core) based tests
+found in `.bats` files in the directory `test`. Running the script will automatically
+execute `qmake` and `make` first to build the current code if necessary.
+If you want to run tests without running make, you can give `--no-make` as first parameter.
+If you want to only run a subset of the tests, you can specify the base-name of one
+or multiple `.bats` files to only run these tests like `./test.sh command-line svn-ignore`.
+If you want to investigate the temporary files generated during a test run,
+you can set the environment variables `BATSLIB_TEMP_PRESERVE=1` or `BATSLIB_TEMP_PRESERVE_ON_FAILURE=1`.
+So if for example some test in `svn-ignore.bats` failed, you can investigate the failed case like
+`BATSLIB_TEMP_PRESERVE_ON_FAILURE=1 ./test.sh --no-make svn-ignore` and then look
+in `build/tmp` to investigate the situation.
+
 KDE
 ---
 there is a repository kde-ruleset which has several example files and one file that should become the final ruleset for the whole of KDE called 'kde-rules-main'.

test.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+
+set -euo pipefail
+
+# Ensure needed tools are present
+svn --version >/dev/null
+git --version >/dev/null
+
+# Determine SCRIPT_DIR
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ]; do
+    ls=$(ls -ld "$PRG")
+    link=$(expr "$ls" : '.*-> \(.*\)$')
+    if expr "$link" : '/.*' >/dev/null; then
+        PRG="$link"
+    else
+        PRG=$(dirname "$PRG")"/$link"
+    fi
+done
+cd "$(dirname "$PRG")/" >/dev/null
+SCRIPT_DIR="$(pwd -P)"
+
+if [ "${1-}" == "--no-make" ]; then
+    shift
+else
+    qmake
+    make
+fi
+
+if [ $# -eq 0 ]; then
+    set -- test
+else
+    set -- "${@/#/test/}"
+    set -- "${@/%/.bats}"
+fi
+
+mkdir -p "$SCRIPT_DIR/build/tmp"
+TMPDIR="$SCRIPT_DIR/build/tmp" test/libs/bats-core/bin/bats "$@"

test/base-fixture/README.txt

@@ -0,0 +1,5 @@
+This is a Subversion repository; use the 'svnadmin' and 'svnlook' 
+tools to examine it.  Do not add, delete, or modify files here 
+unless you know how to avoid corrupting the repository.
+
+Visit http://subversion.apache.org/ for more information.

test/base-fixture/db/current

@@ -0,0 +1 @@
+0

test/base-fixture/db/format

@@ -0,0 +1,3 @@
+7
+layout sharded 1000
+addressing logical

test/base-fixture/db/fs-type

@@ -0,0 +1 @@
+fsfs

test/base-fixture/db/min-unpacked-rev

@@ -0,0 +1 @@
+0

test/base-fixture/db/revprops/0/0

@@ -0,0 +1,5 @@
+K 8
+svn:date
+V 27
+2020-04-14T02:34:44.217594Z
+END

test/base-fixture/db/revs/0/0

@@ -0,0 +1 @@
+0

test/base-fixture/db/transactions/.gitignore

@@ -0,0 +1,2 @@
+800c7d3e-7df8-11ea-8a4d-cdbd2a1a7b77
+800c7e56-7df8-11ea-8a4d-cdbd2a1a7b77

test/base-fixture/db/txn-current

@@ -0,0 +1 @@
+5

test/base-fixture/db/txn-current-lock

@@ -0,0 +1,3 @@
+This file is not used by Subversion 1.3.x or later.
+However, its existence is required for compatibility with
+Subversion 1.2.x or earlier.

test/base-fixture/db/txn-protorevs/.gitignore

@@ -0,0 +1,3 @@
+This file is not used by Subversion 1.3.x or later.
+However, its existence is required for compatibility with
+Subversion 1.2.x or earlier.

test/base-fixture/db/uuid

@@ -0,0 +1,57 @@
+load 'common'
+
+setup() {
+    : # suppress common setup, no repository needed
+}
+
+@test 'specifying version parameter should output version and exit with 0 no matter what' {
+    run svn2git --version --non-existing repo-a repo-b
+    assert_success
+    assert_output --partial 'Git version:'
+
+    run svn2git --non-existing repo-a --version repo-b
+    assert_success
+    assert_output --partial 'Git version:'
+
+    run svn2git --non-existing repo-a repo-b --version
+    assert_success
+    assert_output --partial 'Git version:'
+
+    run svn2git -v --non-existing repo-a repo-b
+    assert_success
+    assert_output --partial 'Git version:'
+
+    run svn2git --non-existing repo-a -v repo-b
+    assert_success
+    assert_output --partial 'Git version:'
+
+    run svn2git --non-existing repo-a repo-b -v
+    assert_success
+    assert_output --partial 'Git version:'
+}
+
+@test 'specifying help parameter should output usage and exit with 0 no matter what' {
+    run svn2git --help --non-existing repo-a repo-b
+    assert_success
+    assert_output --partial 'Usage:'
+
+    run svn2git --non-existing repo-a --help repo-b
+    assert_success
+    assert_output --partial 'Usage:'
+
+    run svn2git --non-existing repo-a repo-b --help
+    assert_success
+    assert_output --partial 'Usage:'
+
+    run svn2git -h --non-existing repo-a repo-b
+    assert_success
+    assert_output --partial 'Usage:'
+
+    run svn2git --non-existing repo-a -h repo-b
+    assert_success
+    assert_output --partial 'Usage:'
+
+    run svn2git --non-existing repo-a repo-b -h
+    assert_success
+    assert_output --partial 'Usage:'
+}

test/base-fixture/db/write-lock

@@ -0,0 +1,34 @@
+load 'libs/bats-support/load'
+load 'libs/bats-assert/load'
+load 'libs/bats-file/load'
+
+setup() {
+    commonSetup
+}
+
+commonSetup() {
+    TEST_TEMP_DIR="$(temp_make --prefix 'svn2git-')"
+    BATSLIB_FILE_PATH_REM="#${TEST_TEMP_DIR}"
+    BATSLIB_FILE_PATH_ADD='<temp>'
+
+    SVN_REPO="$TEST_TEMP_DIR/svn-repo"
+    SVN_WORKTREE="$TEST_TEMP_DIR/svn-worktree"
+
+    cp -a "$BATS_TEST_DIRNAME/base-fixture" "$SVN_REPO"
+    svn checkout "file:///$SVN_REPO" "$SVN_WORKTREE"
+    cd "$SVN_WORKTREE"
+}
+
+teardown() {
+    commonTeardown
+}
+
+commonTeardown() {
+    if [ -n "${TEST_TEMP_DIR-}" ]; then
+        temp_del "$TEST_TEMP_DIR"
+    fi
+}
+
+svn2git() {
+    "$BATS_TEST_DIRNAME/../svn-all-fast-export" "$@"
+}

test/base-fixture/format

@@ -0,0 +1,53 @@
+load 'common'
+
+@test 'svn:ignore entries should only ignore matching direct children' {
+    svn mkdir dir-a
+    svn commit -m 'add dir-a'
+    svn update
+    svn propset svn:ignore $'ignore-a\nignore-b' dir-a
+    svn commit -m 'ignore ignore-a and ignore-b on dir-a'
+
+    cd "$TEST_TEMP_DIR"
+    svn2git "$SVN_REPO" --svn-ignore --rules <(echo "
+        create repository git-repo
+        end repository
+
+        match /([^/]+(/|$))
+            repository git-repo
+            branch master
+            prefix \1
+        end match
+    ")
+
+    assert_equal "$(git -C git-repo show master:dir-a/.gitignore)" "$(cat <<-EOF
+			/ignore-a
+			/ignore-b
+		EOF
+    )"
+}
+
+@test 'svn:global-ignores entries should ignore all matching descendents' {
+    svn mkdir dir-a
+    svn commit -m 'add dir-a'
+    svn update
+    svn propset svn:global-ignores $'ignore-a\nignore-b' dir-a
+    svn commit -m 'ignore ignore-a and ignore-b on dir-a and descendents'
+
+    cd "$TEST_TEMP_DIR"
+    svn2git "$SVN_REPO" --svn-ignore --rules <(echo "
+        create repository git-repo
+        end repository
+
+        match /([^/]+(/|$))
+            repository git-repo
+            branch master
+            prefix \1
+        end match
+    ")
+
+    assert_equal "$(git -C git-repo show master:dir-a/.gitignore)" "$(cat <<-EOF
+			ignore-a
+			ignore-b
+		EOF
+    )"
+}