Fix commit message (#24)

* add logs

* fix vars in parsing for proper logging

* update to use BASH_ENV to pass env vars

* fix SC2002

* disable SC2018

* update test

* call with correct args

* disable shellcheck rules

* fix validation of test

* fix case where PR is present

* fix test

* fix test

* fix test

* fix test

Author: trevor-coleman

scripts/pack-and-publish.sh

@@ -13,6 +13,14 @@ PackAndPublish() {
     version_suffix="$1"
   fi
 
+  # Generate a random 4-letter suffix with LC_ALL=C specifically for tr
+  # disable "lower" shellcheck rule because we only want a-z
+  # shellcheck disable=SC2018
+  random_suffix=$(LC_ALL=C tr -dc 'a-z' < /dev/urandom | fold -w 4 | head -n 1)
+
+  # Append the random suffix to version_suffix
+  version_suffix="${version_suffix}-${random_suffix}"
+
   rm -f "$output_path"
   circleci orb pack "$source_path" > "$output_path"
   circleci orb validate "$output_path" || { echo "Orb validation failed"; exit 1; }

src/scripts/commit_and_push_to_target.sh

@@ -18,5 +18,6 @@ fi
 
 ORB_TEST_ENV="bats-core"
 if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
+  echo "Final Commit Message: '$FINAL_COMMIT_MESSAGE'"
   CommitAndPushToTarget
 fi

src/scripts/parse_commit_info.sh

@@ -1,5 +1,13 @@
 #! /bin/bash
 
+# Global variable declarations
+COMMIT_MESSAGE=""
+COMMIT_HASH=""
+REPO_URL=""
+REPO_NAME=""
+PR_NUMBER=""
+final_commit_message=""
+
 FetchCommitMessage() {
   git log -1 --pretty=%B || { echo "Fetching commit message failed"; exit 1; }
 }
@@ -21,30 +29,48 @@ ExtractPRNumber() {
 }
 
 ConstructCommitMessage() {
+  local REPO_NAME="$1"
+  local COMMIT_MESSAGE="$2"
+  local PR_NUMBER="$3"
+  local COMMIT_HASH="$4"
+
   if [ -n "$PR_NUMBER" ]; then
     PR_LINK="https://github.com/infinitered/$REPO_NAME/pull/$PR_NUMBER"
-    echo "orb: $REPO_NAME -- $COMMIT_MESSAGE -- $PR_LINK"
+    echo "orb($REPO_NAME): $COMMIT_MESSAGE $PR_LINK"
   else
     COMMIT_LINK="https://github.com/infinitered/$REPO_NAME/commit/$COMMIT_HASH"
-    echo "orb: $REPO_NAME -- $COMMIT_MESSAGE -- $COMMIT_LINK"
+    echo "orb($REPO_NAME): $COMMIT_MESSAGE $COMMIT_LINK"
   fi
 }
 
 ParseCommitInfo() {
   cd "$SOURCE_REPO_DIRECTORY" || { echo "Changing directory failed"; exit 1; }
+
+  # Diagnostic output
+  echo "Current directory: $(pwd)"
+  ls -al
+
   COMMIT_MESSAGE=$(FetchCommitMessage)
   COMMIT_HASH=$(FetchCommitHash)
   REPO_URL=$(FetchRepoURL)
   REPO_NAME=$(ParseRepoName)
   PR_NUMBER=$(ExtractPRNumber)
-
-  final_commit_message=$(ConstructCommitMessage)
-  echo "$final_commit_message"
+  final_commit_message=$(ConstructCommitMessage "$REPO_NAME" "$COMMIT_MESSAGE" "$PR_NUMBER" "$COMMIT_HASH")
+  echo "Final constructed message: $final_commit_message"
 }
 
 ORB_TEST_ENV="bats-core"
 if [ "${0#*"$ORB_TEST_ENV"}" = "$0" ]; then
   final_commit_message="$(ParseCommitInfo)"
+
+  # Logging statements to inspect variables
+  echo "COMMIT_MESSAGE: $COMMIT_MESSAGE"
+  echo "COMMIT_HASH: $COMMIT_HASH"
+  echo "REPO_URL: $REPO_URL"
+  echo "REPO_NAME: $REPO_NAME"
+  echo "PR_NUMBER: $PR_NUMBER"
+  echo "final_commit_message: $final_commit_message"
+
   export FINAL_COMMIT_MESSAGE=$final_commit_message
+  echo "export FINAL_COMMIT_MESSAGE='$final_commit_message'" >> "$BASH_ENV"
 fi
-

src/tests/parse_commit_info.bats

@@ -1,11 +1,15 @@
 #! /bin/bash
+# shellcheck disable=SC2031
+# shellcheck disable=SC2030
 
-COMMIT_MESSAGE_WITH_PR="Fix: Commit for testing (#42)"
+setup() {
+  export COMMIT_MESSAGE_WITH_PR="Fix: Commit for testing (#42)"
+}
 
 # Mocking git commands and basename
 git() {
   case "$1" in
-    log) echo $COMMIT_MESSAGE_WITH_PR;;
+    log) echo "$COMMIT_MESSAGE_WITH_PR";;
     rev-parse) echo "1234567890abcdef";;
     config) echo "https://github.com/infinitered/sample-repo.git";;
     *) return 1;;
@@ -21,32 +25,33 @@ source ./src/scripts/parse_commit_info.sh
 
 @test "It fetches the last commit message" {
   run FetchCommitMessage
-  echo "Debug: Output = '$output'"  # Verbose log
+  >&2 echo "Debug: Output = '$output'"  # Verbose log
   [[ $output =~ Fix:\ Commit\ for\ testing\ \(#42\) ]]
 }
 
 @test "It fetches the commit hash" {
   run FetchCommitHash
-  echo "Debug: Output = '$output'"  # Verbose log
+  >&2 echo "Debug: Output = '$output'"  # Verbose log
   [[ $output =~ 1234567890abcdef ]]
 }
 
 @test "It fetches the repo URL" {
   run FetchRepoURL
-  echo "Debug: Output = '$output'"  # Verbose log
+  >&2 echo "Debug: Output = '$output'"  # Verbose log
   [[ $output =~ https://github.com/infinitered/sample-repo.git ]]
 }
 
 @test "It fetches the repo name" {
   run ParseRepoName
-  echo "Debug: Output = '$output'"  # Verbose log
+  >&2 echo "Debug: Output = '$output'"  # Verbose log
   [[ $output =~ sample-repo ]]
 }
 
 @test "It fetches PR number from commit message" {
+  # shellcheck disable=SC2030
   export COMMIT_MESSAGE=$COMMIT_MESSAGE_WITH_PR
   run ExtractPRNumber
-  echo "Debug: Output = '$output'"  # Verbose log
+  >&2 echo "Debug: Output = '$output'"  # Verbose log
   [[ $output =~ \42 ]]
 }
 
@@ -57,10 +62,9 @@ source ./src/scripts/parse_commit_info.sh
   export REPO_NAME="sample-repo"
   export COMMIT_MESSAGE="Fix: Commit for testing (#42)"
 
-  run ConstructCommitMessage
-  echo "Debug: Output = '$output'"  # Verbose log
-  [[ $output =~ https://github.com/infinitered/sample-repo/pull/42 ]]
-  [[ $output =~ orb:\ sample-repo\ --\ Fix:\ Commit\ for\ testing\ \(#42\)\ --\ https://github.com/infinitered/sample-repo/pull/42 ]]
+  run ConstructCommitMessage "$REPO_NAME" "$COMMIT_MESSAGE" "$PR_NUMBER" "$COMMIT_HASH"
+  >&2 echo "Debug: Output = '$output'"  # Verbose log
+  [[ $output == "orb(sample-repo): Fix: Commit for testing (#42) https://github.com/infinitered/sample-repo/pull/42" ]]
   unset PR_NUMBER
   unset REPO_NAME
   unset COMMIT_MESSAGE
@@ -69,23 +73,32 @@ source ./src/scripts/parse_commit_info.sh
 @test "It constructs commit link and commit message when PR number is absent" {
   # Unset PR number to simulate absence
   unset PR_NUMBER
-  # shellcheck disable=SC2031
   export REPO_NAME="sample-repo"
   export COMMIT_HASH="1234567890abcdef"
   export COMMIT_MESSAGE="Fix: Commit for testing"
 
-  run ConstructCommitMessage
-  echo "Debug: Output = '$output'"  # Verbose log
-  [[ $output =~ https://github.com/infinitered/sample-repo/commit/1234567890abcdef ]]
-  [[ $output =~ orb:\ sample-repo\ --\ Fix:\ Commit\ for\ testing\ --\ https://github.com/infinitered/sample-repo/commit/1234567890abcdef ]]
+  run ConstructCommitMessage "$REPO_NAME" "$COMMIT_MESSAGE" "$PR_NUMBER" "$COMMIT_HASH"
+  [[ $output =~ orb\(sample-repo\):\ Fix:\ Commit\ for\ testing\ https://github.com/infinitered/sample-repo/commit/$COMMIT_HASH ]]
+  >&2 echo "Debug: Output = '$output'"  # Verbose log
+
   unset REPO_NAME
   unset COMMIT_HASH
   unset COMMIT_MESSAGE
 }
 
 @test "It parses and constructs the final commit message" {
   run ParseCommitInfo
-  echo "Debug: Output = '$output'"  # Verbose log
-  [[ $output == "orb: sample-repo -- Fix: Commit for testing (#42) -- https://github.com/infinitered/sample-repo/pull/42" ]]
+  final_msg=$(echo "$output" | grep "^Final constructed message:" | cut -d ':' -f 2- | xargs)
+  >&2 echo "Debug: Extracted Final Commit Message = '$final_msg'"
+  [[ $final_msg == "orb(sample-repo): Fix: Commit for testing (#42) https://github.com/infinitered/sample-repo/pull/42" ]]
 }
 
+
+teardown() {
+  unset COMMIT_MESSAGE_WITH_PR
+  unset PR_NUMBER
+  unset REPO_NAME
+  unset COMMIT_MESSAGE
+  unset COMMIT_HASH
+  unset final_msg
+}