debug src/Bash/handlePipelineFailure.bats flaky test (#122)

disabled src/Bash/handlePipelineFailure.bats on alpine

Author: fchastanet

.pre-commit-config-github.yaml

@@ -25,7 +25,7 @@ repos:
 
   - repo: https://github.com/executablebooks/mdformat
     # Do this before other tools "fixing" the line endings
-    rev: 0.7.21
+    rev: 0.7.22
     hooks:
       - id: mdformat
         name: Format Markdown
@@ -80,13 +80,13 @@ repos:
           )
 
   - repo: https://github.com/rhysd/actionlint
-    rev: v1.7.4
+    rev: v1.7.7
     hooks:
       - id: actionlint
         stages: [pre-commit, pre-push, manual]
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         args:
@@ -150,7 +150,7 @@ repos:
           )
 
   - repo: https://github.com/fchastanet/bash-tools-framework
-    rev: 6.1.1
+    rev: 6.2.1
     hooks:
       - id: fixShebangExecutionBit
       - id: awkLint
@@ -195,6 +195,6 @@ repos:
         stages: [manual] # GITHUB
 
   - repo: https://github.com/fchastanet/bash-compiler
-    rev: 3.1.3
+    rev: 3.1.4
     hooks:
       - id: buildBashBinaries

.pre-commit-config.yaml

@@ -20,7 +20,7 @@ repos:
 
   - repo: https://github.com/executablebooks/mdformat
     # Do this before other tools "fixing" the line endings
-    rev: 0.7.21
+    rev: 0.7.22
     hooks:
       - id: mdformat
         name: Format Markdown
@@ -75,13 +75,13 @@ repos:
           )
 
   - repo: https://github.com/rhysd/actionlint
-    rev: v1.7.4
+    rev: v1.7.7
     hooks:
       - id: actionlint
         stages: [pre-commit, pre-push, manual]
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.3.0
+    rev: v2.4.1
     hooks:
       - id: codespell
         args:
@@ -145,7 +145,7 @@ repos:
           )
 
   - repo: https://github.com/fchastanet/bash-tools-framework
-    rev: 6.1.1
+    rev: 6.2.1
     hooks:
       - id: fixShebangExecutionBit
       - id: awkLint
@@ -190,6 +190,6 @@ repos:
         stages: [] # GITHUB
 
   - repo: https://github.com/fchastanet/bash-compiler
-    rev: 3.1.3
+    rev: 3.1.4
     hooks:
       - id: buildBashBinaries

bin/dockerLint

@@ -334,6 +334,9 @@ Assert::tty() {
 # @arg $2 originalStatus:int[] (passed by reference) (optional) copy of original PIPESTATUS array
 # @env PIPESTATUS assuming that this function is called like in the example provided
 # @see https://unix.stackexchange.com/a/709880/582856
+# @see https://gitlab.alpinelinux.org/alpine/aports/-/issues/11152
+# @warning alpine does not support PIPESTATUS very well as execution order of piped process is
+# not guaranteed
 Bash::handlePipelineFailure() {
   local -a pipeStatusBackup=("${PIPESTATUS[@]}")
   local -n handlePipelineFailure_resultingStatusCode=$1

src/Bash/handlePipelineFailure.bats

@@ -7,12 +7,15 @@ source "$(cd "${BATS_TEST_DIRNAME}/.." && pwd)/batsHeaders.sh"
 # shellcheck source=src/Bash/handlePipelineFailure.sh
 source "${srcDir}/Bash/handlePipelineFailure.sh"
 
+# bats file_tags=ubuntu_only
+
 function Bash::handlePipelineFailure::withHead { #@test
   local resultingStatus=0
   local -a originalPipeStatus=()
   yes | head -n 1 || Bash::handlePipelineFailure resultingStatus originalPipeStatus
   [[ "${resultingStatus}" = "0" ]]
-  [[ "${originalPipeStatus[*]}" = "141 0" ]]
+  run echo "${originalPipeStatus[*]}"
+  assert_output "141 0"
 }
 
 function Bash::handlePipelineFailure::withHeadWithoutStatusArg { #@test
@@ -26,7 +29,8 @@ function Bash::handlePipelineFailure::unknownCommand { #@test
   local -a originalPipeStatus=()
   unknownCommand | head -n 1 || Bash::handlePipelineFailure resultingStatus originalPipeStatus || true
   [[ "${resultingStatus}" = "127" ]]
-  [[ "${originalPipeStatus[*]}" = "127 0" ]]
+  run echo "${originalPipeStatus[*]}"
+  assert_output "127 0"
 }
 
 function Bash::handlePipelineFailure::unknownCommandWithoutStatusArg { #@test
@@ -40,7 +44,8 @@ function Bash::handlePipelineFailure::shouldFail { #@test
   local -a originalPipeStatus=()
   echo "test" | grep -q "hello" || Bash::handlePipelineFailure resultingStatus originalPipeStatus || true
   [[ "${resultingStatus}" = "1" ]]
-  [[ "${originalPipeStatus[*]}" = "0 1" ]]
+  run echo "${originalPipeStatus[*]}"
+  assert_output "0 1"
 }
 
 function Bash::handlePipelineFailure::shouldFailWithoutStatusArg { #@test
@@ -54,8 +59,8 @@ function Bash::handlePipelineFailure::shouldWork { #@test
   local -a originalPipeStatus=()
   "${FRAMEWORK_ROOT_DIR}/bin/findShebangFiles" --help | grep -q DESCRIPTION || Bash::handlePipelineFailure resultingStatus originalPipeStatus || true
   [[ "${resultingStatus}" = "0" ]]
-  echo "${originalPipeStatus[*]}" >&3
-  [[ "${originalPipeStatus[*]}" = "141 0" ]]
+  run echo "${originalPipeStatus[*]}"
+  assert_output "141 0"
 }
 
 function Bash::handlePipelineFailure::shouldWorkWithoutStatusArg { #@test
@@ -69,29 +74,33 @@ function Bash::handlePipelineFailure::shouldWorkWith2Pipes { #@test
   local -a originalPipeStatus=()
   "${FRAMEWORK_ROOT_DIR}/bin/findShebangFiles" --help | grep -q DESCRIPTION | cat || Bash::handlePipelineFailure resultingStatus originalPipeStatus || true
   [[ "${resultingStatus}" = "0" ]]
-  [[ "${originalPipeStatus[*]}" = "141 0 0" ]]
+  run echo "${originalPipeStatus[*]}"
+  assert_output "141 0 0"
 }
 
 function Bash::handlePipelineFailure::shouldWorkWith2PipesBis { #@test
   local resultingStatus=0
   local -a originalPipeStatus=()
   echo "world" | "${FRAMEWORK_ROOT_DIR}/bin/findShebangFiles" --help | grep -q DESCRIPTION || Bash::handlePipelineFailure resultingStatus originalPipeStatus || true
   [[ "${resultingStatus}" = "0" ]]
-  [[ "${originalPipeStatus[*]}" = "0 141 0" ]]
+  run echo "${originalPipeStatus[*]}"
+  assert_output "0 141 0"
 }
 
 function Bash::handlePipelineFailure::shouldFailWith2Pipes { #@test
   local resultingStatus=0
   local -a originalPipeStatus=()
   echo "test" | grep t | grep -q "hello" || Bash::handlePipelineFailure resultingStatus originalPipeStatus || true
   [[ "${resultingStatus}" = "1" ]]
-  [[ "${originalPipeStatus[*]}" = "0 0 1" ]]
+  run echo "${originalPipeStatus[*]}"
+  assert_output "0 0 1"
 }
 
 function Bash::handlePipelineFailure::shouldFailWith2PipesBis { #@test
   local resultingStatus=0
   local -a originalPipeStatus=()
   echo "test" | grep -q "hello" | grep t || Bash::handlePipelineFailure resultingStatus originalPipeStatus || true
   [[ "${resultingStatus}" = "1" ]]
-  [[ "${originalPipeStatus[*]}" = "0 1 1" ]]
+  run echo "${originalPipeStatus[*]}"
+  assert_output "0 1 1"
 }

src/Bash/handlePipelineFailure.sh

@@ -10,6 +10,9 @@
 # @arg $2 originalStatus:int[] (passed by reference) (optional) copy of original PIPESTATUS array
 # @env PIPESTATUS assuming that this function is called like in the example provided
 # @see https://unix.stackexchange.com/a/709880/582856
+# @see https://gitlab.alpinelinux.org/alpine/aports/-/issues/11152
+# @warning alpine does not support PIPESTATUS very well as execution order of piped process is
+# not guaranteed
 Bash::handlePipelineFailure() {
   local -a pipeStatusBackup=("${PIPESTATUS[@]}")
   local -n handlePipelineFailure_resultingStatusCode=$1