From fd6f03093e76019922cba6a7659a81368d49a024 Mon Sep 17 00:00:00 2001
From: Torsten Long <torsten.long@de.bosch.com>
Date: Thu, 7 Nov 2024 08:20:08 +0100
Subject: [PATCH] Patch release 0.9.2

Signed-off-by: Torsten Long <torsten.long@de.bosch.com>
---
 .github/workflows/test-lint-deploy.yml |  4 ++--
 Makefile                               | 33 +++++++++++++-------------
 README.md                              | 15 ++++++------
 bin/mock_exe.sh                        |  6 +++--
 docs/quickstart.md                     |  3 +--
 docs/usage.md                          |  5 ++--
 tests/main.bats                        | 18 ++++++++++++++
 7 files changed, 51 insertions(+), 33 deletions(-)

diff --git a/.github/workflows/test-lint-deploy.yml b/.github/workflows/test-lint-deploy.yml
index 945b05f..bbc1302 100644
--- a/.github/workflows/test-lint-deploy.yml
+++ b/.github/workflows/test-lint-deploy.yml
@@ -92,8 +92,8 @@ jobs:
           chmod +x mdslw
           sudo mv mdslw /usr/local/bin
         env:
-          MDSLW_VERSION: 0.11.1
-          MDSLW_SHA256: 75a172e9d9a59793a4dbb5adb0e0dd0778171c6aa07188fc0733bb20c6889e1e
+          MDSLW_VERSION: 0.12.4
+          MDSLW_SHA256: 2899399d14c230f3bc3e4d8b275a1e7a61f061e65fc58e79a0ef1802c1c534bf
           BASE_URL: "https://github.com/razziel89/mdslw/releases/download"
 
       - uses: actions/checkout@v3
diff --git a/Makefile b/Makefile
index 5fa5b24..6f00f29 100644
--- a/Makefile
+++ b/Makefile
@@ -29,15 +29,25 @@ check-dependencies:
 	command -v shellcheck &>/dev/null || (echo "ERROR, please install shellcheck" >&2; exit 1)
 	command -v shfmt &>/dev/null || (echo "ERROR, please install shfmt" >&2; exit 1)
 	command -v jq &>/dev/null || (echo "ERROR, please install jq" >&2; exit 1)
-	command -v kcov &>/dev/null || (echo "ERROR, please install kcov " >&2; exit 1)
+	command -v kcov &>/dev/null || (echo "ERROR, please install kcov" >&2; exit 1)
+	command -v mdslw &>/dev/null || (echo "ERROR, please install mdslw" >&2; exit 1)
 
-SHELLCHECK_OPTS := --enable=add-default-case,avoid-nullary-conditions,quote-safe-variables,require-variable-braces
-export SHELLCHECK_OPTS
+SHELLCHECK_OPTS := --external-sources --enable=add-default-case,avoid-nullary-conditions,quote-safe-variables,require-variable-braces
+SHFMT_OPTS := --space-redirects --binary-next-line --indent 2
+MDSLW_OPTS := --upstream="prettier --parser=markdown"
 
 .PHONY: lint
 lint:
-	shellcheck ./bin/* ./lib/* ./tests/*
-	$(MAKE) check-format
+	shellcheck $(SHELLCHECK_OPTS) ./bin/* ./lib/* ./tests/*
+	shfmt --diff $(SHFMT_OPTS) --language-dialect bash ./bin/* ./lib/*
+	shfmt --diff $(SHFMT_OPTS) --language-dialect bats ./tests/*
+	mdslw --mode=check $(MDSLW_OPTS) .
+
+format:
+	shfmt --write --simplify $(SHFMT_OPTS) --language-dialect bash ./bin/* ./lib/*
+	shfmt --write --simplify $(SHFMT_OPTS) --language-dialect bats ./tests/*
+	mdslw --mode=format --upstream="prettier --parser=markdown" .
+	shellcheck --format=diff $(SHELLCHECK_OPTS) bin/* lib/* tests/* | git apply --allow-empty
 
 # Run tests under all possible combinations of some shell options.
 .PHONY: test
@@ -57,7 +67,7 @@ build-bash-version:
 	# Ensure that the arguments have been set.
 	[[ -n "$(BASH_VERSION)" && -n "$(BASH_PATH)" ]]
 	cd "$(BASH_PATH)" && \
-	curl -sSfL -o bash.tar.gz "$(DOWNLOAD_URL_PREFIX)/bash-$(BASH_VERSION).tar.gz" && \
+	curl -fL -o bash.tar.gz "$(DOWNLOAD_URL_PREFIX)/bash-$(BASH_VERSION).tar.gz" && \
 	tar -xvzf bash.tar.gz && \
 	cd "bash-$(BASH_VERSION)" && \
 	./configure && \
@@ -122,17 +132,6 @@ coverage: test
 	    } \
 	  }' < <(jq < $$(ls -d1 .coverage/bats.*/coverage.json) | sed 's/,$$//')
 
-format:
-	shfmt -w -s -bn -i 2 -sr -ln bash ./bin/* ./lib/*
-	shfmt -w -s -bn -i 2 -sr -ln bats ./tests/*
-	mdslw --mode=format --upstream="prettier --parser=markdown" .
-	shellcheck --format=diff bin/* lib/* tests/* | git apply --allow-empty
-
-check-format:
-	shfmt -d -s -bn -i 2 -sr -ln bash ./bin/* ./lib/*
-	shfmt -d -s -bn -i 2 -sr -ln bats ./tests/*
-	mdslw --mode=check --upstream="prettier --parser=markdown" .
-
 build:
 	./generate_deployable.sh
 
diff --git a/README.md b/README.md
index d1a2dd3..bb472a9 100644
--- a/README.md
+++ b/README.md
@@ -127,21 +127,20 @@ But we are eager to hear your feedback on how we could improve!
 Shellmock is open-sourced under the Apache-2.0 license.
 See the [LICENSE](./LICENSE) file for details.
 
-> Copyright (c) 2022 - for information on the respective copyright owner
-> see the NOTICE file or the repository
-> https://github.com/boschresearch/shellmock
+> Copyright (c) 2022 - for information on the respective copyright owner see the
+> NOTICE file or the repository https://github.com/boschresearch/shellmock
 >
 > Licensed under the Apache License, Version 2.0 (the "License"); you may not
-> use this file except in compliance with the License. You may obtain a copy of
-> the License at
+> use this file except in compliance with the License.
+> You may obtain a copy of the License at
 >
 > http://www.apache.org/licenses/LICENSE-2.0
 >
 > Unless required by applicable law or agreed to in writing, software
 > distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-> WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-> License for the specific language governing permissions and limitations under
-> the License.
+> WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+> See the License for the specific language governing permissions and
+> limitations under the License.
 
 <!---
   Copyright (c) 2022 - for information on the respective copyright owner
diff --git a/bin/mock_exe.sh b/bin/mock_exe.sh
index 24bb1f8..ce60c72 100755
--- a/bin/mock_exe.sh
+++ b/bin/mock_exe.sh
@@ -297,6 +297,8 @@ provide_output() {
 
 run_hook() {
   local cmd_spec="$1"
+  shift
+  local args=("$@")
   # If a hook function was specified, run it. It has to be exported for this to
   # work.
   local hook_env_var
@@ -306,7 +308,7 @@ run_hook() {
       && [[ $(type -t "${!hook_env_var-}") == function ]]
   then
     # Run hook in sub-shell to reduce its influence on the mock.
-    if ! ("${!hook_env_var}"); then
+    if ! ("${!hook_env_var}" "${args[@]}"); then
       # Not using errecho because we want this to always show up in the test's
       # output. Anything output via errecho will end up in a file that is only
       # looked at when asserting expectations.
@@ -388,7 +390,7 @@ main() {
     forward "${cmd}" "$@"
   else
     provide_output "${cmd_spec}"
-    run_hook "${cmd_spec}"
+    run_hook "${cmd_spec}" "$@"
     return_with_code "${cmd_spec}"
   fi
 }
diff --git a/docs/quickstart.md b/docs/quickstart.md
index af7ec5d..d178c94 100644
--- a/docs/quickstart.md
+++ b/docs/quickstart.md
@@ -97,8 +97,7 @@ What happens in details:
      That is, the mock has not been called with at least one set of arguments
      that match a previous call to `shellmock config`.
 
-Please have a look at the [full command reference](./usage.md) for all
-details.
+Please have a look at the [full command reference](./usage.md) for all details.
 You can also have a look at [this detailed example](./example.md) or
 [shellmock's own tests][shellmock-tests].
 You may also check out our [how-to for creating tests](./howto.md).
diff --git a/docs/usage.md b/docs/usage.md
index d3e3e97..60793ad 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -146,6 +146,7 @@ Any error calling the hook will be considered an error (also see
 A hook can be used to perform additional assertions or record additional data.
 Since the hook function is run in a sub-process, it cannot modify any shell
 variables and has access only to environment variables.
+The hook function receives all the arguments that the mock has been called with.
 
 Every following argument to the `config` command is a so-called `argspec` (see
 below).
@@ -412,8 +413,8 @@ There are three recommended ways for defining multi-line output, namely
 
 - adding literal line breaks to the string, or
 - using a here-document, or
-- [having bash interpret escape sequences][bash-ansi-escape] using a
-  character sequence of the form `$'string'`.
+- [having bash interpret escape sequences][bash-ansi-escape] using a character
+  sequence of the form `$'string'`.
 
 [bash-ansi-escape]: https://www.gnu.org/software/bash/manual/html_node/ANSI_002dC-Quoting.html#ANSI_002dC-Quoting
 
diff --git a/tests/main.bats b/tests/main.bats
index f6fe89e..a463af0 100644
--- a/tests/main.bats
+++ b/tests/main.bats
@@ -541,6 +541,24 @@ indices, cannot continue: 2 1"
   run ! shellmock config my_exe 0 hook:_missing_hook
 }
 
+@test "hook matched on arguments and getting arguments" {
+  shellmock new my_exe
+  _hook_matched() {
+    echo "$*" > "${BATS_TEST_TMPDIR}/matched"
+  }
+  shellmock config my_exe 0 1:some-arg
+  shellmock config my_exe 0 hook:_hook_matched 1:another-arg
+
+  run -0 my_exe some-arg
+  [[ ! -s "${BATS_TEST_TMPDIR}/matched" ]]
+
+  run -0 my_exe another-arg
+  [[ -s "${BATS_TEST_TMPDIR}/matched" ]]
+  [[ $(cat "${BATS_TEST_TMPDIR}/matched") == another-arg ]]
+
+  shellmock assert expectations my_exe
+}
+
 @test "removing and re-creating a mock after creating one" {
   # Not defined at first.
   run ! my_exe