Merge pull request #347 from TheYorkshireDev/bugfix/support-forward-slash

Support Escapable Characters in Prefix With BATs Testing

Author: anothrNick

.github/workflows/test.yml

@@ -202,3 +202,31 @@ jobs:
             exit 1
           fi
 
+  test-bats:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+          fetch-depth: '0'
+
+      - name: Install Dependencies
+        run: npm install -g semver
+
+      - name: Setup Bats
+        id: setup-bats
+        uses: bats-core/[email protected]
+        with:
+          support-path: "${{ github.workspace }}/tests/bats-support"
+          assert-path: "${{ github.workspace }}/tests/bats-assert"
+          detik-install: false
+          file-install: false
+
+      - name: Run tests
+        shell: bash
+        env:
+          BATS_LIB_PATH: ${{ steps.setup-bats.outputs.lib-path }}
+        run: |
+          echo "Prefix Tests:"
+          bats test/test_prefix.bats 

.gitignore

@@ -0,0 +1,18 @@
+# macOS
+.DS_Store
+
+# VSCode
+.vscode/
+
+# Rider/JetBrains IDE
+.idea/
+*.sln.iml
+*.user
+*.suo
+*.sln.docstates
+.idea_modules/
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf

entrypoint.sh

@@ -172,7 +172,7 @@ if [ -z "$tagPrefix" ]
 then
   current_tag=${tag}
 else
-  current_tag="$(echo ${tag}| sed "s/${tagPrefix}//g")"
+  current_tag="$(echo ${tag}| sed "s;${tagPrefix};;g")"
 fi
 case "$log" in
     *$major_string_token* ) new=${tagPrefix}$(semver -i major "${current_tag}"); part="major";;

test/test_prefix.bats

@@ -0,0 +1,126 @@
+#!/usr/bin/env bats
+export BATS_LIB_PATH=${BATS_LIB_PATH:-"/usr/lib"}
+bats_load_library bats-support
+bats_load_library bats-assert
+
+setup() {
+  TMP=$(mktemp -d)
+  cd "$TMP"
+  git init -b main >/dev/null
+  git config user.name "Test"
+  git config user.email "[email protected]"
+  touch README && git add README && git commit -m "initial" >/dev/null
+
+  SOURCE="../../../../..$(pwd)" # Workaround for "GITHUB_WORKSPACE" prefix in script
+}
+
+teardown() {
+  rm -rf "$TMP"
+}
+
+run_entry() {
+  bash "$BATS_TEST_DIRNAME/../entrypoint.sh"
+}
+
+@test "Creates a new tag with default settings (no prefix)" {
+  # Arrange
+  export SOURCE="$SOURCE"
+  export DRY_RUN="true"
+
+  # Act
+  run run_entry
+
+  # Assert
+  assert_success
+  assert_line "Bumping tag 0.0.0 - New tag 0.1.0"
+}
+
+@test "Bumps a tag with default settings (no prefix)" {
+  # Arrange
+  export SOURCE="$SOURCE"
+  export DRY_RUN="true"
+  git tag "1.0.0" && git commit -m "bump" --allow-empty >/dev/null
+
+  # Act
+  run run_entry
+
+  # Assert
+  assert_success
+  assert_line "Bumping tag 1.0.0 - New tag 1.1.0"
+}
+
+@test "Creates a new tag with 'v' prefix" {
+  # Arrange
+  export SOURCE="$SOURCE"
+  export DRY_RUN="true"
+  export TAG_PREFIX="v"
+
+  # Act
+  run run_entry
+
+  # Assert
+  assert_success
+  assert_line "Bumping tag v0.0.0 - New tag v0.1.0"
+}
+
+@test "Bumps a tag with 'v' prefix" {
+  # Arrange
+  export SOURCE="$SOURCE"
+  export DRY_RUN="true"
+  export TAG_PREFIX="v"
+  git tag "v1.0.0" && git commit -m "bump" --allow-empty >/dev/null
+
+  # Act
+  run run_entry
+
+  # Assert
+  assert_success
+  assert_line "Bumping tag v1.0.0 - New tag v1.1.0"
+}
+
+@test "Creates a new tag with '/' prefix" {
+  # Arrange
+  export SOURCE="$SOURCE"
+  export DRY_RUN="true"
+  export TAG_PREFIX="infra/"
+
+  # Act
+  run run_entry
+
+  # Assert
+  assert_success
+  assert_line "Bumping tag infra/0.0.0 - New tag infra/0.1.0"
+}
+
+@test "Bumps a tag with '/' prefix" {
+  # Arrange
+  export SOURCE="$SOURCE"
+  export DRY_RUN="true"
+  export TAG_PREFIX="infra/"
+  git tag "infra/1.0.0" && git commit -m "bump" --allow-empty >/dev/null
+
+  # Act
+  run run_entry
+
+  # Assert
+  assert_success
+  assert_line "Bumping tag infra/1.0.0 - New tag infra/1.1.0"
+}
+
+@test "Bumps only matching prefix tag" {
+  # Arrange
+  export SOURCE="$SOURCE"
+  export DRY_RUN="true"
+  export TAG_PREFIX="infra/"
+  git tag "2.0.0" && git commit -m "bump-no-prefix-1" --allow-empty >/dev/null
+  git tag "infra/1.7.0" && git commit -m "bump-prefix-1" --allow-empty >/dev/null
+  git tag "2.1.0" && git commit -m "bump-no-prefix-2" --allow-empty >/dev/null
+
+  # Act
+  run run_entry
+
+  # Assert
+  assert_success
+  assert_line "Bumping tag infra/1.7.0 - New tag infra/1.8.0"
+  refute_line "Bumping tag 2.1.0 - New tag 2.2.0"
+}