busser-bats 0.6.0 → 0.7.0

data/vendor/bats/LICENSE.md

@@ -0,0 +1,53 @@
+Copyright (c) 2017 bats-core contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+* [bats-core] is a continuation of [bats]. Copyright for portions of the
+  bats-core project are held by Sam Stephenson, 2014 as part of the project
+  [bats], licensed under MIT:
+
+Copyright (c) 2014 Sam Stephenson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+For details, please see the [version control history][commits].
+
+[bats-core]: https://github.com/bats-core/bats-core
+[bats]:https://github.com/sstephenson/bats
+[commits]:https://github.com/bats-core/bats-core/commits/master

data/vendor/bats/README.md

@@ -1,12 +1,26 @@
-# Bats: Bash Automated Testing System
+[![Latest release](https://img.shields.io/github/release/bats-core/bats-core.svg)](https://github.com/bats-core/bats-core/releases/latest)
+[![npm package](https://img.shields.io/npm/v/bats.svg)](https://www.npmjs.com/package/bats)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/bats-core/bats-core/blob/master/LICENSE.md)
+[![Continuous integration status](https://github.com/bats-core/bats-core/workflows/Tests/badge.svg)](https://github.com/bats-core/bats-core/actions?query=workflow%3ATests)
+[![Read the docs status](https://readthedocs.org/projects/bats-core/badge/)](https://bats-core.readthedocs.io)
 
-Bats is a [TAP](http://testanything.org)-compliant testing framework
-for Bash. It provides a simple way to verify that the UNIX programs
-you write behave as expected.
+[![Join the chat in bats-core/bats-core on gitter](https://badges.gitter.im/bats-core/bats-core.svg)][gitter]
 
-A Bats test file is a Bash script with special syntax for defining
-test cases. Under the hood, each test case is just a function with a
-description.
+<div align="center">
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="docs/source/assets/dark_mode_cube.svg">
+  <img alt="" src="docs/source/assets/light_mode_cube.svg">
+</picture>
+</div>
+
+# Bats-core: Bash Automated Testing System
+
+Bats is a [TAP](https://testanything.org/)-compliant testing framework for Bash
+3.2 or above.  It provides a simple way to verify that the UNIX programs you
+write behave as expected.
+
+A Bats test file is a Bash script with special syntax for defining test cases.
+Under the hood, each test case is just a function with a description.
 
 ```bash
 #!/usr/bin/env bats
@@ -22,272 +36,100 @@ description.
 }
 ```
 
-Bats is most useful when testing software written in Bash, but you can
-use it to test any UNIX program.
-
-Test cases consist of standard shell commands. Bats makes use of
-Bash's `errexit` (`set -e`) option when running test cases. If every
-command in the test case exits with a `0` status code (success), the
-test passes. In this way, each line is an assertion of truth.
-
-
-## Running tests
-
-To run your tests, invoke the `bats` interpreter with a path to a test
-file. The file's test cases are run sequentially and in isolation. If
-all the test cases pass, `bats` exits with a `0` status code. If there
-are any failures, `bats` exits with a `1` status code.
-
-When you run Bats from a terminal, you'll see output as each test is
-performed, with a check-mark next to the test's name if it passes or
-an "X" if it fails.
-
-    $ bats addition.bats
-     ✓ addition using bc
-     ✓ addition using dc
-
-    2 tests, 0 failures
-
-If Bats is not connected to a terminal—in other words, if you
-run it from a continuous integration system, or redirect its output to
-a file—the results are displayed in human-readable, machine-parsable
-[TAP format](http://testanything.org).
-
-You can force TAP output from a terminal by invoking Bats with the
-`--tap` option.
-
-    $ bats --tap addition.bats
-    1..2
-    ok 1 addition using bc
-    ok 2 addition using dc
+Bats is most useful when testing software written in Bash, but you can use it to
+test any UNIX program.
 
-### Test suites
+Test cases consist of standard shell commands. Bats makes use of Bash's
+`errexit` (`set -e`) option when running test cases. If every command in the
+test case exits with a `0` status code (success), the test passes. In this way,
+each line is an assertion of truth.
 
-You can invoke the `bats` interpreter with multiple test file
-arguments, or with a path to a directory containing multiple `.bats`
-files. Bats will run each test file individually and aggregate the
-results. If any test case fails, `bats` exits with a `1` status code.
+## Table of contents
 
+**NOTE** The documentation has moved to <https://bats-core.readthedocs.io>
 
-## Writing tests
+<!-- toc -->
 
-Each Bats test file is evaluated _n+1_ times, where _n_ is the number of
-test cases in the file. The first run counts the number of test cases,
-then iterates over the test cases and executes each one in its own
-process.
+- [Testing](#testing)
+- [Support](#support)
+- [Contributing](#contributing)
+- [Contact](#contact)
+- [Version history](#version-history)
+- [Background](#background)
+  * [What's the plan and why?](#whats-the-plan-and-why)
+  * [Why was this fork created?](#why-was-this-fork-created)
+- [Copyright](#copyright)
 
-For more details about how Bats evaluates test files, see 
-[Bats Evaluation Process](https://github.com/sstephenson/bats/wiki/Bats-Evaluation-Process)
-on the wiki.
-
-### `run`: Test other commands
+<!-- tocstop -->
 
-Many Bats tests need to run a command and then make assertions about
-its exit status and output. Bats includes a `run` helper that invokes
-its arguments as a command, saves the exit status and output into
-special global variables, and then returns with a `0` status code so
-you can continue to make assertions in your test case.
+## Testing
 
-For example, let's say you're testing that the `foo` command, when
-passed a nonexistent filename, exits with a `1` status code and prints
-an error message.
-
-```bash
-@test "invoking foo with a nonexistent file prints an error" {
-  run foo nonexistent_filename
-  [ "$status" -eq 1 ]
-  [ "$output" = "foo: no such file 'nonexistent_filename'" ]
-}
+```sh
+bin/bats --tap test
 ```
 
-The `$status` variable contains the status code of the command, and
-the `$output` variable contains the combined contents of the command's
-standard output and standard error streams.
-
-A third special variable, the `$lines` array, is available for easily
-accessing individual lines of output. For example, if you want to test
-that invoking `foo` without any arguments prints usage information on
-the first line:
+See also the [CI](./.github/workflows/tests.yml) settings for the current test environment and
+scripts.
 
-```bash
-@test "invoking foo without arguments prints usage" {
-  run foo
-  [ "$status" -eq 1 ]
-  [ "${lines[0]}" = "usage: foo <filename>" ]
-}
-```
-
-### `load`: Share common code
-
-You may want to share common code across multiple test files. Bats
-includes a convenient `load` command for sourcing a Bash source file
-relative to the location of the current test file. For example, if you
-have a Bats test in `test/foo.bats`, the command
-
-```bash
-load test_helper
-```
-
-will source the script `test/test_helper.bash` in your test file. This
-can be useful for sharing functions to set up your environment or load
-fixtures.
-
-### `skip`: Easily skip tests
-
-Tests can be skipped by using the `skip` command at the point in a
-test you wish to skip.
-
-```bash
-@test "A test I don't want to execute for now" {
-  skip
-  run foo
-  [ "$status" -eq 0 ]
-}
-```
-
-Optionally, you may include a reason for skipping:
-
-```bash
-@test "A test I don't want to execute for now" {
-  skip "This command will return zero soon, but not now"
-  run foo
-  [ "$status" -eq 0 ]
-}
-```
+## Support
 
-Or you can skip conditionally:
+The Bats source code repository is [hosted on
+GitHub](https://github.com/bats-core/bats-core). There you can file bugs on the
+issue tracker or submit tested pull requests for review.
 
-```bash
-@test "A test which should run" {
-  if [ foo != bar ]; then
-    skip "foo isn't bar"
-  fi
+For real-world examples from open-source projects using Bats, see [Projects
+Using Bats](https://github.com/bats-core/bats-core/wiki/Projects-Using-Bats) on
+the wiki.
 
-  run foo
-  [ "$status" -eq 0 ]
-}
-```
+To learn how to set up your editor for Bats syntax highlighting, see [Syntax
+Highlighting](https://github.com/bats-core/bats-core/wiki/Syntax-Highlighting)
+on the wiki.
 
-### `setup` and `teardown`: Pre- and post-test hooks
+## Contributing
 
-You can define special `setup` and `teardown` functions, which run
-before and after each test case, respectively. Use these to load
-fixtures, set up your environment, and clean up when you're done.
+For now see the [`docs`](docs) folder for project guides, work with us on the wiki
+or look at the other communication channels.
 
-### Code outside of test cases
+## Contact
 
-You can include code in your test file outside of `@test` functions.
-For example, this may be useful if you want to check for dependencies
-and fail immediately if they're not present. However, any output that
-you print in code outside of `@test`, `setup` or `teardown` functions
-must be redirected to `stderr` (`>&2`). Otherwise, the output may
-cause Bats to fail by polluting the TAP stream on `stdout`.
+- You can find and chat with us on our [Gitter].
 
-### Special variables
+## Version history
 
-There are several global variables you can use to introspect on Bats
-tests:
+See `docs/CHANGELOG.md`.
 
-* `$BATS_TEST_FILENAME` is the fully expanded path to the Bats test
-file.
-* `$BATS_TEST_DIRNAME` is the directory in which the Bats test file is
-located.
-* `$BATS_TEST_NAMES` is an array of function names for each test case.
-* `$BATS_TEST_NAME` is the name of the function containing the current
-test case.
-* `$BATS_TEST_DESCRIPTION` is the description of the current test
-case.
-* `$BATS_TEST_NUMBER` is the (1-based) index of the current test case
-in the test file.
-* `$BATS_TMPDIR` is the location to a directory that may be used to
-store temporary files.
+## Background
 
+<!-- markdownlint-disable MD026 -->
+### Why was this fork created?
+<!-- markdownlint-enable MD026 -->
 
-## Installing Bats from source
+There was an initial [call for maintainers][call-maintain] for the original Bats repository, but write access to it could not be obtained. With development activity stalled, this fork allowed ongoing maintenance and forward progress for Bats.
 
-Check out a copy of the Bats repository. Then, either add the Bats
-`bin` directory to your `$PATH`, or run the provided `install.sh`
-command with the location to the prefix in which you want to install
-Bats. For example, to install Bats into `/usr/local`,
+**Tuesday, September 19, 2017:** This was forked from [Bats][bats-orig] at
+commit [0360811][].  It was created via `git clone --bare` and `git push
+--mirror`.
 
-    $ git clone https://github.com/sstephenson/bats.git
-    $ cd bats
-    $ ./install.sh /usr/local
+As of **Thursday, April 29, 2021:** the original [Bats][bats-orig] has been
+archived by the owner and is now read-only.
 
-Note that you may need to run `install.sh` with `sudo` if you do not
-have permission to write to the installation prefix.
+This [bats-core](https://github.com/bats-core/bats-core) repo is now the community-maintained Bats project.
 
+[call-maintain]: https://github.com/sstephenson/bats/issues/150
+[bats-orig]: https://github.com/sstephenson/bats
+[0360811]: https://github.com/sstephenson/bats/commit/03608115df2071fff4eaaff1605768c275e5f81f
 
-## Support
+## Copyright
 
-The Bats source code repository is [hosted on
-GitHub](https://github.com/sstephenson/bats). There you can file bugs
-on the issue tracker or submit tested pull requests for review.
+The Bats Logo was created by [Vukory](https://www.artstation.com/vukory) ([Github](https://github.com/vukory)) and sponsored by [SethFalco](https://github.com/SethFalco). If you want to use our logo, have a look at our [guidelines](./docs/source/assets/README.md#Usage-Guide-for-Third-Parties).
 
-For real-world examples from open-source projects using Bats, see
-[Projects Using Bats](https://github.com/sstephenson/bats/wiki/Projects-Using-Bats)
-on the wiki.
+© 2017-2024 bats-core organization
 
-To learn how to set up your editor for Bats syntax highlighting, see
-[Syntax Highlighting](https://github.com/sstephenson/bats/wiki/Syntax-Highlighting)
-on the wiki.
+© 2011-2016 Sam Stephenson
 
+Bats is released under an MIT-style license; see `LICENSE.md` for details.
 
-## Version history
+See the [parent project](https://github.com/bats-core) at GitHub or the
+[AUTHORS](AUTHORS) file for the current project maintainer team.
 
-*0.4.0* (August 13, 2014)
-
-* Improved the display of failing test cases. Bats now shows the
-  source code of failing test lines, along with full stack traces
-  including function names, filenames, and line numbers.
-* Improved the display of the pretty-printed test summary line to
-  include the number of skipped tests, if any.
-* Improved the speed of the preprocessor, dramatically shortening test
-  and suite startup times.
-* Added support for absolute pathnames to the `load` helper.
-* Added support for single-line `@test` definitions.
-* Added bats(1) and bats(7) manual pages.
-* Modified the `bats` command to default to TAP output when the `$CI`
-  variable is set, to better support environments such as Travis CI.
-
-*0.3.1* (October 28, 2013)
-
-* Fixed an incompatibility with the pretty formatter in certain
-  environments such as tmux.
-* Fixed a bug where the pretty formatter would crash if the first line
-  of a test file's output was invalid TAP.
-
-*0.3.0* (October 21, 2013)
-
-* Improved formatting for tests run from a terminal. Failing tests
-  are now colored in red, and the total number of failing tests is
-  displayed at the end of the test run. When Bats is not connected to
-  a terminal (e.g. in CI runs), or when invoked with the `--tap` flag,
-  output is displayed in standard TAP format.
-* Added the ability to skip tests using the `skip` command.
-* Added a message to failing test case output indicating the file and
-  line number of the statement that caused the test to fail.
-* Added "ad-hoc" test suite support. You can now invoke `bats` with
-  multiple filename or directory arguments to run all the specified
-  tests in aggregate.
-* Added support for test files with Windows line endings.
-* Fixed regular expression warnings from certain versions of Bash.
-* Fixed a bug running tests containing lines that begin with `-e`.
-
-*0.2.0* (November 16, 2012)
-
-* Added test suite support. The `bats` command accepts a directory
-  name containing multiple test files to be run in aggregate.
-* Added the ability to count the number of test cases in a file or
-  suite by passing the `-c` flag to `bats`.
-* Preprocessed sources are cached between test case runs in the same
-  file for better performance.
-
-*0.1.0* (December 30, 2011)
-
-* Initial public release.
-
----
-
-© 2014 Sam Stephenson. Bats is released under an MIT-style license;
-see `LICENSE` for details.
+[gitter]: https://gitter.im/bats-core/bats-core

data/vendor/bats/VERSION.txt

@@ -1 +1 @@
-https://github.com/sstephenson/bats/archive/v0.4.0.tar.gz
+https://github.com/bats-core/bats-core/archive/refs/tags/v1.14.0.tar.gz

data/vendor/bats/bin/bats

@@ -0,0 +1,75 @@
+#!/usr/bin/env bash
+
+set -euo pipefail
+
+# Note: We first need to use POSIX's `[ ... ]' instead of Bash's `[[ ... ]]'
+# because this is the check for Bash, where the shell may not be Bash.  Once we
+# confirm that we are in Bash, we can use [[ ... ]] and (( ... )).  Note that
+# these [[ ... ]] and (( ... )) do not cause syntax errors in POSIX shells,
+# though they can be parsed differently.
+if [ -z "${BASH_VERSION-}" ] ||
+    [[ -z "${BASH_VERSINFO-}" ]] ||
+    ((BASH_VERSINFO[0] < 3 || (BASH_VERSINFO[0] == 3 && BASH_VERSINFO[1] < 2)))
+then
+  printf 'bats: this program needs to be run by Bash >= 3.2\n' >&2
+  exit 1
+fi
+
+if command -v greadlink >/dev/null; then
+  bats_readlinkf() {
+    greadlink -f "$1"
+  }
+else
+  bats_readlinkf() {
+    readlink -f "$1"
+  }
+fi
+
+fallback_to_readlinkf_posix() {
+  bats_readlinkf() {
+    [ "${1:-}" ] || return 1
+    max_symlinks=40
+    CDPATH='' # to avoid changing to an unexpected directory
+
+    target=$1
+    [ -e "${target%/}" ] || target=${1%"${1##*[!/]}"} # trim trailing slashes
+    [ -d "${target:-/}" ] && target="$target/"
+
+    cd -P . 2>/dev/null || return 1
+    while [ "$max_symlinks" -ge 0 ] && max_symlinks=$((max_symlinks - 1)); do
+      if [ ! "$target" = "${target%/*}" ]; then
+        case $target in
+        /*) cd -P "${target%/*}/" 2>/dev/null || break ;;
+        *) cd -P "./${target%/*}" 2>/dev/null || break ;;
+        esac
+        target=${target##*/}
+      fi
+
+      if [ ! -L "$target" ]; then
+        target="${PWD%/}${target:+/}${target}"
+        printf '%s\n' "${target:-/}"
+        return 0
+      fi
+
+      # `ls -dl` format: "%s %u %s %s %u %s %s -> %s\n",
+      #   <file mode>, <number of links>, <owner name>, <group name>,
+      #   <size>, <date and time>, <pathname of link>, <contents of link>
+      # https://pubs.opengroup.org/onlinepubs/9699919799/utilities/ls.html
+      link=$(ls -dl -- "$target" 2>/dev/null) || break
+      target=${link#*" $target -> "}
+    done
+    return 1
+  }
+}
+
+if ! BATS_PATH=$(bats_readlinkf "${BASH_SOURCE[0]}" 2>/dev/null); then
+  fallback_to_readlinkf_posix
+  BATS_PATH=$(bats_readlinkf "${BASH_SOURCE[0]}")
+fi
+
+export BATS_SAVED_PATH=$PATH
+BATS_BASE_LIBDIR=lib # this will be patched with the true value in install.sh
+
+export BATS_ROOT=${BATS_PATH%/*/*}
+export -f bats_readlinkf
+exec env BATS_ROOT="$BATS_ROOT" BATS_LIBDIR="${BATS_BASE_LIBDIR:-lib}" "$BATS_ROOT/libexec/bats-core/bats" "$@"

data/vendor/bats/install.sh

@@ -1,37 +1,29 @@
 #!/usr/bin/env bash
-set -e
-
-resolve_link() {
-  $(type -p greadlink readlink | head -1) "$1"
-}
-
-abs_dirname() {
-  local cwd="$(pwd)"
-  local path="$1"
 
-  while [ -n "$path" ]; do
-    cd "${path%/*}"
-    local name="${path##*/}"
-    path="$(resolve_link "$name" || true)"
-  done
+set -e
 
-  pwd
-  cd "$cwd"
-}
+BATS_ROOT="${0%/*}"
+PREFIX="${1%/}"
+LIBDIR="${2:-lib}"
 
-PREFIX="$1"
-if [ -z "$1" ]; then
-  { echo "usage: $0 <prefix>"
-    echo "  e.g. $0 /usr/local"
-  } >&2
+if [[ -z "$PREFIX" ]]; then
+  printf '%s\n' \
+    "usage: $0 <prefix> [base_libdir]" \
+    "  e.g. $0 /usr/local" \
+    "       $0 /usr/local lib64" >&2
   exit 1
 fi
 
-BATS_ROOT="$(abs_dirname "$0")"
-mkdir -p "$PREFIX"/{bin,libexec,share/man/man{1,7}}
-cp -R "$BATS_ROOT"/bin/* "$PREFIX"/bin
-cp -R "$BATS_ROOT"/libexec/* "$PREFIX"/libexec
-cp "$BATS_ROOT"/man/bats.1 "$PREFIX"/share/man/man1
-cp "$BATS_ROOT"/man/bats.7 "$PREFIX"/share/man/man7
+install -d -m 755 "$PREFIX"/{bin,libexec/bats-core,"${LIBDIR}"/bats-core,share/man/man{1,7}}
+
+install -m 755 "$BATS_ROOT/bin"/* "$PREFIX/bin"
+install -m 755 "$BATS_ROOT/libexec/bats-core"/* "$PREFIX/libexec/bats-core"
+install -m 755 "$BATS_ROOT/lib/bats-core"/* "$PREFIX/${LIBDIR}/bats-core"
+install -m 644 "$BATS_ROOT/man/bats.1" "$PREFIX/share/man/man1"
+install -m 644 "$BATS_ROOT/man/bats.7" "$PREFIX/share/man/man7"
+
+read -rd '' BATS_EXE_CONTENTS <"$PREFIX/bin/bats" || true
+BATS_EXE_CONTENTS=${BATS_EXE_CONTENTS/"BATS_BASE_LIBDIR=lib"/"BATS_BASE_LIBDIR=${LIBDIR}"}
+printf "%s" "$BATS_EXE_CONTENTS" >| "$PREFIX/bin/bats"
 
 echo "Installed Bats to $PREFIX/bin/bats"