Refactor versioning and release

Some parts got a bit confusing over time, also there was repetition.

In this commit:

 *  the release fact gathering routines have been moved to separate
    module,

 *  some less useful routines have been removed,

 *  some internal interfaces have been changed to allow for more
    readable code.

src/include/build.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 
-. "$MKIT_DIR/include/ini.sh" || die "cannot import ini.sh"
+. "$MKIT_DIR/include/ini.sh"   || die "cannot import ini.sh"
+. "$MKIT_DIR/include/facts.sh" || die "cannot import facts.sh"
 
 
 _build1() {
@@ -78,7 +79,7 @@ _expand_variables() {
         echo "s|__MKIT_PROJ_CODENAME__|$(ini 1value project:codename)|g;"
         echo "s|__MKIT_PROJ_PKGNAME__|$(ini 1value project:pkgname)|g;"
         echo "s|__MKIT_PROJ_TAGLINE__|$(ini 1value project:tagline)|g;"
-        echo "s|__MKIT_PROJ_VERSION__|$(get_version)|g;"
+        echo "s|__MKIT_PROJ_VERSION__|$(semver)|g;"
         echo "s|__MKIT_SELF_VERSION__|$MKIT_VERSION|g;"
     } >> "$script"
     perl -wp "$script" || die "_expand_variables failed"
@@ -144,7 +145,7 @@ debstuff() {
     #
     # Build Debian stuff (eamed tarball, debian dir)
     #
-    local version="$(get_version)"
+    local version="$(semver)"
 
     # tarball - we should already have by means of 'dist'
     #
@@ -177,7 +178,7 @@ dist() {
     #FIXME: lacking Makefile skills, we do this step twice fot
     #       rpmstuff, hence -f hack for gzip
     #
-    local version=$(get_version)
+    local version=$(semver)
     local dirname=$MKIT_PROJ_PKGNAME-$version
     mkdir -p "$dirname"
     ini values "lists:dist" | xargs -I DIST_ITEM cp -R DIST_ITEM "$dirname"
@@ -189,88 +190,6 @@ dist() {
     rm -rf "$dirname"
 }
 
-get_version() {
-    #
-    # Build semver version string with build metadata
-    #
-    # Build version string from available info using following
-    # logic:
-    #
-    #  1. use project.version (from mkit.ini)
-    #  2. if we are in git, override the version with last tag
-    #  3. if set, add project:prerl (from mkit.ini) as pre-release ID
-    #     (afer dash)
-    #  4. if we are at a later commit than the last tag, add branch
-    #     name and commit sha1 to build metadata (after plus sign)
-    #  5. if the tree is "dirty", i.e. has uncommited changes,
-    #     add "dirty" to build metadata
-    #
-    # The version is compatible with SemVer 2.0.0.
-    #
-    # Examples:
-    #
-    #     myprog v1.0.7                         # all clear
-    #     myprog v1.0.7-alpha                   # mkit.ini: project:prerl="alpha"
-    #     myprog v1.0.7-alpha+g1aef811.master   # ^^ + some commits after
-    #     myprog v1.0.7-alpha+gf14fc4f.api2     # ^^ + on a feature branch
-    #     myprog v1.0.7-alpha+gf14fc4f.api2.dirty  # ^^ + tree edited
-    #     myprog v1.0.7-alpha+dirty             # tag OK but tree edited
-    #     myprog v1.0.7+dirty                   # ^^ but no pre-release id
-    #
-    # Note that versions with "dirty" should be perceived as kind of
-    # dangerous outside developer's own machine.  Versions with sha1 are
-    # safer but must not be released.
-    #
-    # I have considered decorating the git commit refs to make them
-    # sort of sortable (e.g. "r1.g1aef811"), but on second thought,
-    # I don't think it's good idea to give *any* semantics to meta-data
-    # at all.  First, there is no rule that r1<r2<r3; a commit can be
-    # removing what other just added and one change can be split to
-    # multiple commits.  Also, the whole thing breaks anyway once you
-    # rebase your branch (no, it's not a sin).  The sole purpose of
-    # meta-data is to *identify* the code, and provide safe path back
-    # to tree; commit refs are already perfect for that.
-    #
-    # FIXME:  Using project:prerl for release IDs may not be compatible with
-    #         release strategy implemented in release.sh
-    #
-    local version=$(ini 1value project:version)
-    local prerl=$(ini 1value project:prerl)
-    grep ":" <<<"$prerl" && warn "colon in project:prerl may corrupt version data: $prerl"
-    if git rev-parse HEAD >&/dev/null;
-    then    # we are in git repo... so we can get smart
-        local latest_tag=$(
-            git log --format="%D" \
-              | sed 's/,/\n/g' \
-              | sed 's/^[[:blank:]]*//; ' \
-              | grep -E '^tag: v[[:digit:]]+\.' \
-              | cut -d' ' -f2 \
-              | head -1
-        )
-        if ! git describe --tags --exact-match HEAD >&/dev/null;
-        then    # we are at a later commit than the last tag
-            local sha=g$(git log -1 --pretty=format:%h HEAD)
-            local curbranch=$(git rev-parse --abbrev-ref HEAD)
-            local commit="$curbranch.$sha"
-        fi
-        if test "$(git diff --shortstat 2>/dev/null)" != "";
-        then    # the tree is "dirty", i.e. has been edited
-            local dirty=dirty
-        fi
-        test -n "$latest_tag" && version=${latest_tag:1}
-        local suffix=""
-        case "$commit:$dirty" in
-            :)       suffix=""                ;;
-            :dirty)  suffix="+$dirty"         ;;
-            *:)      suffix="+$commit"        ;;
-            *:dirty) suffix="+$commit.$dirty" ;;
-        esac
-        test -b "$prerl" && suffix="-$prerl$suffix"
-        version="$version$suffix"
-    fi
-    echo "$version"
-}
-
 rpmstuff() {
     #
     # Build specfile

src/include/facts.sh

@@ -0,0 +1,130 @@
+#!/bin/bash
+
+. "$MKIT_DIR/include/ini.sh" || die "cannot import ini.sh"
+
+git_fact() {
+    #
+    # Get git fact $1
+    #
+    local fact_name="$1"
+    git_present || warn "can't give fact outside git repo: $fact_name"
+    case "$fact_name" in
+        latest_tag)
+            git log --format="%D" \
+              | sed 's/,/\n/g' \
+              | sed 's/^[[:blank:]]*//; ' \
+              | grep -E '^tag: v[[:digit:]]+\.' \
+              | cut -d' ' -f2 \
+              | head -1
+            ;;
+        latest_version)
+            git_fact latest_tag | git_tag2ver
+            ;;
+        current_branch)
+            git rev-parse --abbrev-ref HEAD
+            ;;
+        reldiff)
+            git log --oneline "$(git_fact latest_tag)..HEAD" --name-only
+            ;;
+        latest_sha)
+            git log -1 --pretty=format:%h HEAD
+            ;;
+        *)
+            warn "unknown git fact asked: $fact_name"
+            ;;
+    esac
+}
+
+git_present() {
+    #
+    # True if we're in a git repo
+    #
+    git rev-parse HEAD >&/dev/null
+}
+
+git_tag2ver() {
+    #
+    # Convert tag to version
+    #
+    sed s/^v//
+}
+
+git_ver2tag() {
+    #
+    # Convert version to tag
+    #
+    sed s/^/v/
+}
+
+semver() {
+    #
+    # Build semver version string with build metadata
+    #
+    # Build version string from available info using following
+    # logic:
+    #
+    #  1. use project.version (from mkit.ini)
+    #  2. if we are in git, override the version with last tag
+    #  3. if set, add project:prerl (from mkit.ini) as pre-release ID
+    #     (afer dash)
+    #  4. if we are at a later commit than the last tag, add branch
+    #     name and commit sha1 to build metadata (after plus sign)
+    #  5. if the tree is "dirty", i.e. has uncommited changes,
+    #     add "dirty" to build metadata
+    #
+    # The version is compatible with SemVer 2.0.0.
+    #
+    # Examples:
+    #
+    #     myprog v1.0.7                         # all clear
+    #     myprog v1.0.7-alpha                   # mkit.ini: project:prerl="alpha"
+    #     myprog v1.0.7-alpha+g1aef811.master   # ^^ + some commits after
+    #     myprog v1.0.7-alpha+gf14fc4f.api2     # ^^ + on a feature branch
+    #     myprog v1.0.7-alpha+gf14fc4f.api2.dirty  # ^^ + tree edited
+    #     myprog v1.0.7-alpha+dirty             # tag OK but tree edited
+    #     myprog v1.0.7+dirty                   # ^^ but no pre-release id
+    #
+    # Note that versions with "dirty" should be perceived as kind of
+    # dangerous outside developer's own machine.  Versions with sha1 are
+    # safer but must not be released.
+    #
+    # I have considered decorating the git commit refs to make them
+    # sort of sortable (e.g. "r1.g1aef811"), but on second thought,
+    # I don't think it's good idea to give *any* semantics to meta-data
+    # at all.  First, there is no rule that r1<r2<r3; a commit can be
+    # removing what other just added and one change can be split to
+    # multiple commits.  Also, the whole thing breaks anyway once you
+    # rebase your branch (no, it's not a sin).  The sole purpose of
+    # meta-data is to *identify* the code, and provide safe path back
+    # to tree; commit refs are already perfect for that.
+    #
+    # FIXME:  Using project:prerl for release IDs may not be compatible with
+    #         release strategy implemented in release.sh
+    #
+    local version=$(ini 1value project:version)
+    local prerl=$(ini 1value project:prerl)
+    grep ":" <<<"$prerl" && warn "colon in project:prerl may corrupt version data: $prerl"
+    if git_present;
+    then    # we are in git repo... so we can get smart
+        local latest_tag=$(git_fact latest_tag)
+        if ! git describe --tags --exact-match HEAD >&/dev/null;
+        then    # we are at a later commit than the last tag
+            local commit="$(git_fact current_branch).g$(git_fact latest_sha)"
+        fi
+        if test "$(git diff --shortstat 2>/dev/null)" != "";
+        then    # the tree is "dirty", i.e. has been edited
+            local dirty=dirty
+        fi
+        test -n "$latest_tag" && version=${latest_tag:1}
+        local suffix=""
+        case "$commit:$dirty" in
+            :)       suffix=""                ;;
+            :dirty)  suffix="+$dirty"         ;;
+            *:)      suffix="+$commit"        ;;
+            *:dirty) suffix="+$commit.$dirty" ;;
+        esac
+        test -b "$prerl" && suffix="-$prerl$suffix"
+        version="$version$suffix"
+    fi
+    echo "$version"
+}

src/include/ini.sh

@@ -121,3 +121,24 @@ ini() {
     esac
     <"$MKIT_INI" $fn "$arg" | $limit
 }
+
+update_version() {
+    #
+    # Change project.version in mkit.ini at path $2 to version $1
+    #
+    local version="$1"
+    local inifile="$2"
+    local tmp=$(mktemp -t mkit.update_version.XXXXXXXX)
+    <"$inifile" perl -e '
+        my $hit = 0;
+        my $done = 0;
+        foreach (<STDIN>) {
+            if      ($done) { print; next; }
+            elsif   (m/\[project\]/) { $hit++; print; next; }
+            elsif   (m/\[/) { $hit = 0; print; next; }
+            elsif   ($hit) { s/\bversion\b *=.*/version = $ARGV[0]/ and $done++; print; }
+            else { print; next; }
+        }
+    ' "$version" >"$tmp" || die "failed to update version in mkit.ini"
+    mv "$tmp" "$inifile"
+}

src/include/mkit.sh

@@ -92,27 +92,6 @@ route() {
     fi
 }
 
-update_version() {
-    #
-    # Change project.version in mkit.ini at path $2 to version $1
-    #
-    local version="$1"
-    local inifile="$2"
-    local tmp=$(mktemp -t mkit.update_version.XXXXXXXX)
-    <"$inifile" perl -e '
-        my $hit = 0;
-        my $done = 0;
-        foreach (<STDIN>) {
-            if      ($done) { print; next; }
-            elsif   (m/\[project\]/) { $hit++; print; next; }
-            elsif   (m/\[/) { $hit = 0; print; next; }
-            elsif   ($hit) { s/\bversion\b *=.*/version = $ARGV[0]/ and $done++; print; }
-            else { print; next; }
-        }
-    ' "$version" >"$tmp" || die "failed to update version in mkit.ini"
-    mv "$tmp" "$inifile"
-}
-
 warn() {
     #
     # Print warning message

src/include/release.sh

@@ -1,92 +1,78 @@
 #!/bin/bash
 
-_die_if() {
+. "$MKIT_DIR/include/ini.sh"   || die "cannot import ini.sh"
+. "$MKIT_DIR/include/facts.sh" || die "cannot import facts.sh"
+
+_bump_version() {
+    #
+    # Bump version on stdin by level $1 (x, y or z)
+    #
+    local rlevel=$1
+    local old
+    read -r old
+    local oldx=${old%.*.*}
+    local oldz=${old#*.*.}
+    local tmpy=${old%.*}
+    local oldy=${tmpy#*.}
+    local new=""
+    case $rlevel in
+        x) new="$((oldx+1)).0.0"            ;;
+        y) new="$oldx.$((oldy+1)).0"        ;;
+        z) new="$oldx.$oldy.$((oldz+1))"    ;;
+        *) die "invalid release level: $1"  ;;
+    esac
+    echo "$new"
+}
+
+_relck() {
     #
     # Die if blocking condition $1 is detected
     #
     local condition="$1"
     local x
     case "$condition" in
-        nogit)
+        git_present)
             git rev-parse HEAD >&/dev/null\
              || die "cannot do this outside git repo"
             ;;
-        norelbr)
+        at_relsrc)
             local relsrc=$(ini 1value project:relsrc)
-            _git_info curbranch \
+            git_fact current_branch \
               | grep -qFx "$relsrc" \
              || die "you are not on release source branch: $relsrc"
             ;;
-        dirty)
+        not_dirty)
             git diff --shortstat 2>/dev/null \
               | grep -q . \
              && die "tree is dirty: $dirt"
             ;;
-        novertag)
-            _git_info lasttag \
+        tags_ok)
+            git_fact latest_tag \
               | grep -q . \
-             || die "cannot find last tag"
+             || die "cannot find latest tag"
             ;;
-        nobump)
+        vbump_hot)
             git diff-tree --no-commit-id --name-only -r HEAD \
               | grep -qFx mkit.ini \
              || die "last change must be version bump in mkit.ini"
             ;;
-        wip)
-            _git_info reldiff \
+        no_wip)
+            git_fact reldiff \
               | grep '^....... WIP ' \
-             && die "WIP commit since $(_git_info lasttag)"
+             && die "WIP commit since $(git_fact latest_tag)"
             ;;
-        old_c)
-            x=$(_ver_info nextver_g)
-            _ver_info currver_c \
-              | grep -qFx "$x" \
-             || die "new version not in mkit.ini: $x"
+        ini_version)
+            local oracle=$(git_fact latest_version | _bump_version "$rlevel")
+            ini 1value project:version  \
+              | grep -qFx "$oracle" \
+             || die "new version not in mkit.ini: $oracle"
+            ;;
+        *)
+            die "unknown release check: $condition"
             ;;
     esac
 }
 
-_git_info() {
-    #
-    # Get git info $1
-    #
-    local info="$1"
-    case "$info" in
-        lasttag)    git tag | grep ^v | sort -V | tail -n1  ;;
-        curbranch)  git rev-parse --abbrev-ref HEAD         ;;
-        reldiff)    git log --oneline "$(_git_info lasttag)..HEAD" --name-only ;;
-    esac
-}
-
-_git_msg_vbump() {
-    echo "Bump version"
-    echo ""
-    echo "Overview of changes:"
-    echo ""
-    _git_info reldiff \
-      | sed '
-            s/^[a-f0-9]\{7\} / *  &/; t PATHS
-            s/^/        /
-            :PATHS
-        '
-}
-
-_make_ver() {
-    local level=$1
-    local old=$2
-    local oldx=${old%.*.*}
-    local oldz=${old#*.*.}
-    local tmpy=${old%.*}
-    local oldy=${tmpy#*.}
-    case $level in
-        x) new="$((oldx+1)).0.0"            ;;
-        y) new="$oldx.$((oldy+1)).0"        ;;
-        z) new="$oldx.$oldy.$((oldz+1))"    ;;
-        *) die "invalid release level: $1"  ;;
-    esac
-    echo "$new"
-}
-
 _release() {
     #
     # Prepare release
@@ -94,21 +80,21 @@ _release() {
     # Span release routines: make a signed tag, check branch
     # and update release branch
     #
-    # FIXME: Using project:prerl as build.sh:get_version() does may not be
+    # FIXME: Using project:prerl as build.sh:semver() does may not be
     #        compatible with this release strategy
     #
-    local level=$1
+    local rlevel=$1
     local newtag
 
-    _die_if nogit
-    _die_if norelbr
-    _die_if dirty
-    _die_if novertag
-    _die_if nobump
-    _die_if wip
-    _die_if old_c
+    _relck git_present
+    _relck at_relsrc
+    _relck not_dirty
+    _relck tags_ok
+    _relck vbump_hot
+    _relck no_wip
+    _relck ini_version
 
-    newtag=v$(_ver_info nextver_g)
+    newtag=$(git_fact latest_version | _bump_version "$rlevel" | git_ver2tag )
     set -e
     debug_var newtag
     $MKIT_DRY && return
@@ -117,34 +103,33 @@ _release() {
 }
 
 _vbump() {
-    local level="$1"
+    local rlevel="$1"
     local lastver   # current from mkit.ini
     local nextver   # after the bump
-    _die_if nogit
-    _die_if norelbr
-    _die_if dirty
-    lastver=$(_ver_info currver_c)
-    nextver=$(_ver_info nextver_c)
+    _relck git_present
+    _relck at_relsrc
+    _relck not_dirty
+    nextver=$(ini 1value project:version | _bump_version "$rlevel")
     debug_var lastver nextver
     $MKIT_DRY && return
     update_version "$nextver" mkit.ini \
       || die "failed to update version in mkit.ini"
     git add mkit.ini \
       || die "failed to add mkit.ini to the index"
-    git commit -e -m "$(_git_msg_vbump)"
+    git commit -e -m "$(_vbump_gitmsg)"
 }
 
-_ver_info() {
-    #
-    # Get git info $1
-    #
-    local info="$1"
-    case "$info" in
-        lastver_g)  _git_info lasttag | sed s/^v// ;;
-        nextver_g)  _make_ver "$level" "$(_ver_info lastver_g)" ;;
-        currver_c)  ini 1value project:version ;;
-        nextver_c)  _make_ver "$level" "$(_ver_info currver_c)" ;;
-    esac
+_vbump_gitmsg() {
+    echo "Bump version"
+    echo ""
+    echo "Overview of changes:"
+    echo ""
+    git_fact reldiff \
+      | sed '
+            s/^[a-f0-9]\{7\} / *  &/; t PATHS
+            s/^/        /
+            :PATHS
+        '
 }
 
 release_x() {