.github/workflows/build.yaml

@@ -0,0 +1,103 @@
+#
+# Copyright (C) 2020  Sebastian Pipping <sebastian@pipping.org>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+name: Build (Linux, Ubuntu)
+
+on:
+  pull_request:
+  push:
+  schedule:
+    - cron: '0 2 * * 5'  # Every Friday at 2am
+  workflow_dispatch:
+
+# Reduce permissions to minimum for security
+permissions:
+  contents: read
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - runs-on: ubuntu-24.04
+            qt_major: 6
+            qt_qmake: qmake6
+            qt_packages: qmake6 qt6-base-dev qt6-5compat-dev
+          - runs-on: ubuntu-24.04
+            qt_major: 5
+            qt_qmake: qmake
+            qt_packages: qt5-qmake qtbase5-dev
+          - runs-on: ubuntu-22.04
+            qt_major: 6
+            qt_qmake: qmake6
+            qt_packages: qmake6 qt6-base-dev libqt6core5compat6-dev
+          - runs-on: ubuntu-22.04
+            qt_major: 5
+            qt_qmake: qmake
+            qt_packages: qt5-qmake qtbase5-dev
+
+    name: Build (Linux, ${{ matrix.runs-on }}, Qt ${{ matrix.qt_major }})
+    runs-on: ${{ matrix.runs-on }}
+    steps:
+      - name: 'Install build dependencies'
+        run: |-
+          set -e
+          sudo apt-get update
+          sudo apt-get install --yes --no-install-recommends \
+            build-essential \
+            libapr1-dev \
+            libsvn-dev \
+            ${{ matrix.qt_packages }} \
+            subversion
+
+      - name: 'Checkout Git branch'
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: 'Configure'
+        env:
+          QMAKE: ${{ matrix.qt_qmake }}
+        run: |-
+          ${QMAKE}
+
+      - name: 'Build'
+        run: |-
+          make
+
+      - name: 'Test'
+        run: |-
+          ./test.sh --no-make
+
+      - name: 'Install'
+        run: |-
+          set -e
+          make INSTALL_ROOT="${PWD}"/ROOT install
+          find ROOT | sort
+
+  docker:
+    name: Check Dockerfile
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Git branch'
+        uses: actions/checkout@v3
+        with:
+          submodules: true
+
+      - name: 'Build'
+        run: |-
+          docker build .

.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

Dockerfile

@@ -0,0 +1,24 @@
+FROM ubuntu:22.04
+
+# Change locale to let svn handle international characters
+ENV LC_ALL C.UTF-8
+
+# Install dependencies
+RUN apt-get update && apt-get install --yes --no-install-recommends \
+    build-essential \
+    libapr1-dev \
+    libsvn-dev \
+    qt5-qmake \
+    qtbase5-dev \
+    git \
+    subversion \
+    && rm -rf /var/lib/apt/lists/*
+
+# Build the binary
+RUN mkdir /usr/local/svn2git
+ADD . /usr/local/svn2git
+RUN cd /usr/local/svn2git && qmake && make
+
+# Docker interface
+WORKDIR /workdir
+CMD /usr/local/svn2git/svn-all-fast-export

README.md

@@ -16,6 +16,15 @@ If you have a proper ruleset the tool will create the git repositories for you a
 
 After it is done you likely want to run `git repack -a -d -f` to compress the pack file as it can get quite big.
 
+Running as Docker image
+-----------------------
+Just mount your SVN folder, plus another working directory where Git repository will be created.
+Sample usage with input mounted in /tmp and output produced in /workdir:
+```
+docker build -t svn2git .
+docker run --rm -it -v `pwd`/workdir:/workdir -v /var/lib/svn/project1:/tmp/svn -v `pwd`/conf:/tmp/conf svn2git /usr/local/svn2git/svn-all-fast-export --identity-map /tmp/conf/project1.authors --rules /tmp/conf/project1.rules --add-metadata --svn-branches --debug-rules --svn-ignore --empty-dirs /tmp/svn/
+```
+
 Building the tool
 -----------------
 Run `qmake && make`.  You get `./svn-all-fast-export`.
@@ -24,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'.
@@ -33,11 +55,66 @@ Write the Rules
 You need to write a rules file that describes how to slice the Subversion history into Git repositories and branches. See https://techbase.kde.org/Projects/MoveToGit/UsingSvn2Git.
 The rules are also documented in the 'samples' directory of the svn2git repository. Feel free to add more documentation here as well.
 
+Rules
+-----
+### `create respository`
+
+```
+create repository REPOSITORY NAME
+  [PARAMETERS...]
+end repository
+```
+
+`PARAMETERS` is any number of:
+
+- `repository TARGET REPOSITORY` Creates a forwarding repository , which allows for redirecting to another repository, typically with some `prefix`.
+- `prefix PREFIX` prefixes each file with `PREFIX`, allowing for merging repositories.
+- `description DESCRIPTION TEXT` writes a `DESCRIPTION TEXT` to the `description` file in the repository
+
+### `match`
+
+```
+match REGEX
+  [PARAMETERS...]
+end match
+```
+
+Creates a rule that matches paths by `REGEX` and applies some `PARAMETERS` to them. Matching groups can be created, and the values used in the parameters.
+You need to make sure the regex matching a SVN directory path matches also the end slash (e.g. `./`) otherwise Git fast-import will crash with an `fatal: Empty path component found in input` errors.
+For example, the rule `/project/trunk/.*/myFolder`, should become `/project/trunk/.*/myFolder/`.
+
+
+
+`PARAMETERS` is any number of:
+
+- `repository TARGET REPOSITORY` determines the repository
+- `branch BRANCH NAME` determines which branch this path will be placed in. Can also be used to make lightweight tags with `refs/tags/TAG NAME` although note that tags in SVN are not always a single commit, and will not be created correctly unless they are a single copy from somewhere else, with no further changes. See also `annotate true` to make them annotated tags.
+- `[min|max] revision REVISION NUMBER` only match if revision is above/below the specified revision number
+- `prefix PREFIX` prefixes each file with `PREFIX`, allowing for merging repositories. Same as when used in a `create repository` stanza.
+  - Note that this will create a separate commit for each prefix matched, even if they were in the same SVN revision.
+- `substitute [repository|branch] s/PATTERN/REPLACEMENT/` performs a regex substitution on the repository or branch name. Useful when eliminating characters not supported in git branch names.
+- `action ACTION` determines the action to take, from the below three:
+
+  - `export` I have no idea what this does
+  - `ignore` ignores this path
+  - `recurse` tells svn2git to ignore this path and continue searching its children.
+
+- `annotated true` creates annotated tags instead of lightweight tags. You can see the commit log with `git tag -n`.
+
+### `include FILENAME`
+
+Include the contents of another rules file
+
+### `declare VAR=VALUE`
+
+Define variables that can be referenced later. `${VAR}` in any line will be replaced by `VALUE`.
+
+
 Work flow
 ---------
 Please feel free to fill this section in.
 
 Some SVN tricks
 ---------------
 You can access your newly rsynced SVN repo with commands like `svn ls file:///path/to/repo/trunk/KDE`.
-A common issue is tracking when an item left playground for kdereview and then went from kdereview to its final destination. There is no straightforward way to do this. So the following command comes in handy: `svn log -v file:///path/to/repo/kde-svn/kde/trunk/kdereview | grep /trunk/kdereview/mplayerthumbs -A 5 -B 5` This will print all commits relevant to the package you are trying to track. You can also pipe the above command to head or tail to see the the first and last commit it was in that directory.
+A common issue is tracking when an item left playground for kdereview and then went from kdereview to its final destination. There is no straightforward way to do this. So the following command comes in handy: `svn log -v file:///path/to/repo/kde-svn/kde/trunk/kdereview | grep /trunk/kdereview/mplayerthumbs -A 5 -B 5` This will print all commits relevant to the package you are trying to track. You can also pipe the above command to head or tail to see the first and last commit it was in that directory.

samples/ignore-branch.rules

@@ -12,7 +12,7 @@ end repository
 
 match /trunk/
   repository myproject
-  branch master
+  branch main
 end match
 
 # Ignore this branch:

samples/merged-branches-tags.rules

@@ -12,7 +12,7 @@ end repository
 
 match /trunk/
   repository myproject
-  branch master
+  branch main
 end match
 
 # Subversion doesn't understand the Git concept of tags

samples/min-max-revision.rules

@@ -28,7 +28,7 @@ end match
 
 match /trunk/
   repository myproject
-  branch master
+  branch main
 end match
 
 match /branches/([^/]+)/

samples/recurse.rules

@@ -15,7 +15,7 @@ end repository
 
 match /trunk/([^/]+)/
   repository \1
-  branch master
+  branch main
 end match
 
 #

samples/standardlayout.rules

@@ -12,7 +12,7 @@ end repository
 
 match /trunk/
   repository myproject
-  branch master
+  branch main
 end match
 
 match /branches/([^/]+)/

samples/two-projects.rules

@@ -15,12 +15,12 @@ end repository
 
 match /project1/trunk/
   repository project1
-  branch master
+  branch main
 end match
 
 match /project2/trunk/
   repository project2
-  branch master
+  branch main
 end match
 
 # Note how we can use regexp to capture the repository name

src/CommandLineParser.cpp

@@ -79,7 +79,7 @@ void CommandLineParser::Private::addDefinitions(const CommandLineOption * option
         QString option = QString::fromLatin1(options[i].specification);
         // options with optional params are written as "--option required[, optional]
         if (option.indexOf(QLatin1Char(',')) >= 0 && ( option.indexOf(QLatin1Char('[')) < 0 || option.indexOf(QLatin1Char(']')) < 0) ) {
-            QStringList optionParts = option.split(QLatin1Char(','), QString::SkipEmptyParts);
+            QStringList optionParts = option.split(QLatin1Char(','), Qt::SkipEmptyParts);
             if (optionParts.count() != 2) {
                 qWarning() << "WARN: option definition '" << option << "' is faulty; only one ',' allowed";
                 continue;
@@ -104,7 +104,7 @@ void CommandLineParser::Private::addDefinitions(const CommandLineOption * option
         if(definition.name.isEmpty())
             continue;
         if (option.indexOf(QLatin1Char(' ')) > 0) {
-            QStringList optionParts = definition.name.split(QLatin1Char(' '), QString::SkipEmptyParts);
+            QStringList optionParts = definition.name.split(QLatin1Char(' '), Qt::SkipEmptyParts);
             definition.name = optionParts[0];
             bool first = true;
             foreach (QString s, optionParts) {
@@ -137,7 +137,7 @@ void CommandLineParser::Private::setArgumentDefinition(const char *defs)
 {
     requiredArguments = 0;
     argumentDefinition = QString::fromLatin1(defs);
-    QStringList optionParts = argumentDefinition.split(QLatin1Char(' '), QString::SkipEmptyParts);
+    QStringList optionParts = argumentDefinition.split(QLatin1Char(' '), Qt::SkipEmptyParts);
     bool inArg = false;
     foreach (QString s, optionParts) {
         s = s.trimmed();
@@ -327,18 +327,22 @@ CommandLineParser::~CommandLineParser()
 
 void CommandLineParser::usage(const QString &name, const QString &argumentDescription)
 {
+#if QT_VERSION >= 0x060000
+    QTextStream cout(stdout, QIODeviceBase::WriteOnly);
+#else
     QTextStream cout(stdout, QIODevice::WriteOnly);
+#endif
     cout << "Usage: " << d->argumentStrings[0];
     if (! name.isEmpty())
         cout << " " << name;
     if (d->definitions.count())
         cout << " [OPTION]";
     if (! argumentDescription.isEmpty())
         cout << " " << argumentDescription;
-    cout << endl << endl;
+    cout << Qt::endl << Qt::endl;
 
     if (d->definitions.count() > 0)
-        cout << "Options:" << endl;
+        cout << "Options:" << Qt::endl;
     int commandLength = 0;
     foreach (Private::OptionDefinition definition, d->definitions)
         commandLength = qMax(definition.name.length(), commandLength);
@@ -352,7 +356,7 @@ void CommandLineParser::usage(const QString &name, const QString &argumentDescri
         cout << definition.name;
         for (int i = definition.name.length(); i <= commandLength; i++)
             cout << ' ';
-         cout << definition.comment <<endl;
+         cout << definition.comment << Qt::endl;
     }
 }