fixed UT flakiness

fchastanet · Jan 7, 2024 · 989ad1a · 989ad1a
1 parent f637e31
commit 989ad1a
Show file tree

Hide file tree

Showing 20 changed files with 72 additions and 33 deletions.
diff --git a/bin/cli b/bin/cli
@@ -1672,7 +1672,7 @@ cliCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/dbImport b/bin/dbImport
@@ -2194,7 +2194,7 @@ dbImportCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/dbImportProfile b/bin/dbImportProfile
@@ -1807,7 +1807,7 @@ dbImportProfileCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/dbImportStream b/bin/dbImportStream
@@ -2006,7 +2006,7 @@ dbImportStreamCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/dbQueryAllDatabases b/bin/dbQueryAllDatabases
@@ -1924,7 +1924,7 @@ dbQueryAllDatabasesCommand() {
     # shellcheck disable=SC2054
     helpArray=(specify\ the\ number\ of\ db\ to\ query\ in\ parallel)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: 1"
+    echo '    Default value: 1'
     echo -e "  ${__HELP_OPTION_COLOR}--bar${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-b${__HELP_NORMAL} {single}"
     local -a helpArray
     # shellcheck disable=SC2054
@@ -1935,7 +1935,7 @@ dbQueryAllDatabasesCommand() {
     # shellcheck disable=SC2054
     helpArray=(character\ to\ use\ to\ separate\ mysql\ column)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: |"
+    echo '    Default value: |'
     echo
     echo -e "${__HELP_TITLE_COLOR}QUERY OPTIONS:${__RESET_COLOR}"
     echo -e "  ${__HELP_OPTION_COLOR}--from-dsn${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-f <String>${__HELP_NORMAL} {single}"
@@ -1985,7 +1985,7 @@ dbQueryAllDatabasesCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/dbScriptAllDatabases b/bin/dbScriptAllDatabases
@@ -1891,7 +1891,7 @@ dbScriptAllDatabasesCommand() {
     # shellcheck disable=SC2054
     helpArray=(specify\ the\ number\ of\ db\ to\ query\ in\ parallel)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: 1"
+    echo '    Default value: 1'
     echo -e "  ${__HELP_OPTION_COLOR}--bar${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-b${__HELP_NORMAL} {single}"
     local -a helpArray
     # shellcheck disable=SC2054
@@ -1919,7 +1919,7 @@ dbScriptAllDatabasesCommand() {
     # shellcheck disable=SC2054
     helpArray=(if\ output\ dir\ provided\,\ will\ log\ each\ db\ result\ to\ log\ file)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: none"
+    echo '    Default value: none'
     echo '    Possible values: none|log'
     echo
     echo -e "${__HELP_TITLE_COLOR}GLOBAL OPTIONS:${__RESET_COLOR}"
@@ -1963,7 +1963,7 @@ dbScriptAllDatabasesCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/doc b/bin/doc
@@ -1650,7 +1650,7 @@ docCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/gitIsAncestorOf b/bin/gitIsAncestorOf
@@ -1400,7 +1400,7 @@ gitIsAncestorOfCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/gitIsBranch b/bin/gitIsBranch
@@ -1378,7 +1378,7 @@ gitIsBranchCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/gitRenameBranch b/bin/gitRenameBranch
@@ -1484,7 +1484,7 @@ gitRenameBranchCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/installRequirements b/bin/installRequirements
@@ -1445,7 +1445,7 @@ installRequirementsCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/mysql2puml b/bin/mysql2puml
@@ -1551,7 +1551,7 @@ mysql2pumlCommand() {
     # shellcheck disable=SC2054
     helpArray=(header\ configuration\ of\ the\ plant\ uml\ file)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo
     echo -e "${__HELP_TITLE_COLOR}GLOBAL OPTIONS:${__RESET_COLOR}"
     echo -e "  ${__HELP_OPTION_COLOR}--bash-framework-config <String>${__HELP_NORMAL} {single}"
@@ -1594,7 +1594,7 @@ mysql2pumlCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/postmanCli b/bin/postmanCli
@@ -1160,7 +1160,7 @@ Postman::api() {
         --header 'Accept: application/json' \
         --header "X-Api-Key: ${POSTMAN_API_KEY}" \
         --data @- \
-        --fail --silent --show-error || status=$?
+        --fail --silent --show-error || Bash::handlePipelineFailure status
 
     Postman::displayResponse "createCollectionFromFile" "${responseFile}"
 
@@ -1182,7 +1182,7 @@ Postman::api() {
         --header 'Accept: application/json' \
         --header "X-Api-Key: ${POSTMAN_API_KEY}" \
         --data @- \
-        --fail --silent --show-error || status=$?
+        --fail --silent --show-error || Bash::handlePipelineFailure status
 
     Postman::displayResponse "updateCollectionFromFile" "${responseFile}"
 
@@ -1217,6 +1217,36 @@ Postman::api() {
   esac
 }
 
+# @description ignore exit code 141 from simple command pipes
+# @example use with:
+#   local resultingStatus=0
+#   local -a originalPipeStatus=()
+#   cmd1 | cmd2 || handle_pipefails originalPipeStatus resultingStatus || true
+#   [[ "${resultingStatus}" = "0" ]]
+# @arg $1 originalStatus:int[] (passed by reference) (optional) copy of original PIPESTATUS array
+# @arg $2 resultingStatusCode:&int (passed by reference) (optional) resulting status code
+# @env PIPESTATUS assuming that this function is called like in the example provided
+# @see https://unix.stackexchange.com/a/709880/582856
+Bash::handlePipelineFailure() {
+  local -a pipeStatusBackup=("${PIPESTATUS[@]}")
+  local -n handlePipelineFailure_originalStatus=$1
+  local -n handlePipelineFailure_resultingStatusCode=$2
+  # shellcheck disable=SC2034
+  handlePipelineFailure_originalStatus=("${pipeStatusBackup[@]}")
+  handlePipelineFailure_resultingStatusCode=0
+  local statusCode
+  for statusCode in "${pipeStatusBackup[@]}"; do
+    if ((statusCode == 141)); then
+      return 0
+    elif ((statusCode > 0)); then
+      # shellcheck disable=SC2034
+      handlePipelineFailure_resultingStatusCode="${statusCode}"
+      break
+    fi
+  done
+  return "${handlePipelineFailure_resultingStatusCode}"
+}
+
 # @description log message to file
 # @arg $1 message:String the message to display
 Log::logSkipped() {
@@ -1978,7 +2008,7 @@ postmanCliCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/upgradeGithubRelease b/bin/upgradeGithubRelease
@@ -1759,7 +1759,7 @@ upgradeGithubReleaseCommand() {
     # shellcheck disable=SC2054
     helpArray=($'The argument that will be provided to the currently installed binary\n\n      to check the version of the software. \n\n      See options constraints below.')
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: --version"
+    echo '    Default value: --version'
     echo -e "  ${__HELP_OPTION_COLOR}--current-version${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-c <currentVersion>${__HELP_NORMAL} {single}"
     local -a helpArray
     # shellcheck disable=SC2054
@@ -1817,7 +1817,7 @@ upgradeGithubReleaseCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/waitForIt b/bin/waitForIt
@@ -1477,7 +1477,7 @@ waitForItCommand() {
     # shellcheck disable=SC2054
     helpArray=(Timeout\ in\ seconds\,\ zero\ for\ no\ timeout.)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: 15"
+    echo '    Default value: 15'
     echo -e "  ${__HELP_OPTION_COLOR}--host${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-i <hostOrIp>${__HELP_NORMAL} {single} (mandatory)"
     local -a helpArray
     # shellcheck disable=SC2054
@@ -1540,7 +1540,7 @@ waitForItCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/bin/waitForMysql b/bin/waitForMysql
@@ -1453,7 +1453,7 @@ waitForMysqlCommand() {
     # shellcheck disable=SC2054
     helpArray=(Timeout\ in\ seconds\,\ zero\ for\ no\ timeout.)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: 15"
+    echo '    Default value: 15'
     echo
     echo -e "${__HELP_TITLE_COLOR}GLOBAL OPTIONS:${__RESET_COLOR}"
     echo -e "  ${__HELP_OPTION_COLOR}--bash-framework-config <String>${__HELP_NORMAL} {single}"
@@ -1496,7 +1496,7 @@ waitForMysqlCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/install b/install
@@ -1351,7 +1351,7 @@ installCommand() {
     # shellcheck disable=SC2054
     helpArray=(choose\ color\ theme\ -\ default-force\ means\ colors\ will\ be\ produced\ even\ if\ command\ is\ piped)
     echo -e "    $(Array::wrap2 " " 76 4 "${helpArray[@]}")"
-    echo "    Default value: default"
+    echo '    Default value: default'
     echo '    Possible values: default|default-force|noColor'
     echo -e "  ${__HELP_OPTION_COLOR}--help${__HELP_NORMAL}, ${__HELP_OPTION_COLOR}-h${__HELP_NORMAL} {single}"
     local -a helpArray

diff --git a/src/Postman/Model/validate.bats b/src/Postman/Model/validate.bats
@@ -11,6 +11,10 @@ setup() {
   export BASH_FRAMEWORK_THEME="noColor"
 }
 
+teardown() {
+  chmod -R u+w "${BATS_TEST_TMPDIR}/pullMode" 2>/dev/null || true
+}
+
 function Postman::Model::validate::missingMode { #@test
   run Postman::Model::validate \
     "fileNotFound.json" "invalidMode"
@@ -89,17 +93,20 @@ function Postman::Model::validate::pushModeCollectionsWithErrors { #@test
 }
 
 function Postman::Model::validate::pullModeCollectionsWithErrors { #@test
+  cp -R "${BATS_TEST_DIRNAME}/testsData/pullMode" "${BATS_TEST_TMPDIR}"
+  chmod -w "${BATS_TEST_TMPDIR}/pullMode/GithubAPI/notWritableFile.json"
+  chmod -w "${BATS_TEST_TMPDIR}/pullMode"
   Postman::Model::getRelativeConfigDirectory() {
-    echo "${BATS_TEST_DIRNAME}/testsData/pullMode"
+    echo "${BATS_TEST_TMPDIR}/pullMode"
   }
-  local file="${BATS_TEST_DIRNAME}/testsData/pullMode/getCollectionRefs-collectionsWithErrors.json"
+  local file="${BATS_TEST_TMPDIR}/pullMode/getCollectionRefs-collectionsWithErrors.json"
   run Postman::Model::validate \
     "${file}" "pull"
 
   assert_failure 1
   assert_line --index 0 "ERROR   - File '${file}' - collection 0 - missing file property"
-  assert_line --index 1 "ERROR   - File '${file}' - collection fileNotWritable - collection file ${BATS_TEST_DIRNAME}/testsData/pullMode/GithubAPI/notWritableFile.json is not writable"
-  assert_line --index 2 "ERROR   - File '${file}' - collection dirNotWritable - config directory ${BATS_TEST_DIRNAME}/testsData/pullMode is not writable"
+  assert_line --index 1 "ERROR   - File '${file}' - collection fileNotWritable - collection file ${BATS_TEST_TMPDIR}/pullMode/GithubAPI/notWritableFile.json is not writable"
+  assert_line --index 2 "ERROR   - File '${file}' - collection dirNotWritable - config directory ${BATS_TEST_TMPDIR}/pullMode is not writable"
 
   assert_lines_count 3
 }

diff --git a/src/Postman/api.bats b/src/Postman/api.bats
@@ -4,6 +4,8 @@
 source "$(cd "${BATS_TEST_DIRNAME}/.." && pwd)/batsHeaders.sh"
 # shellcheck source=src/Postman/api.sh
 source "${rootDir}/src/Postman/api.sh"
+# shellcheck source=vendor/bash-tools-framework/src/Bash/handlePipelineFailure.sh
+source "${FRAMEWORK_ROOT_DIR}/src/Bash/handlePipelineFailure.sh"
 
 setup() {
   export BASH_FRAMEWORK_THEME="noColor"

diff --git a/src/Postman/api.sh b/src/Postman/api.sh
@@ -38,7 +38,7 @@ Postman::api() {
         --header 'Accept: application/json' \
         --header "X-Api-Key: ${POSTMAN_API_KEY}" \
         --data @- \
-        --fail --silent --show-error || status=$?
+        --fail --silent --show-error || Bash::handlePipelineFailure status
 
     Postman::displayResponse "createCollectionFromFile" "${responseFile}"
 
@@ -60,7 +60,7 @@ Postman::api() {
         --header 'Accept: application/json' \
         --header "X-Api-Key: ${POSTMAN_API_KEY}" \
         --data @- \
-        --fail --silent --show-error || status=$?
+        --fail --silent --show-error || Bash::handlePipelineFailure status
 
     Postman::displayResponse "updateCollectionFromFile" "${responseFile}"