diff --git a/tests/bats/bats-assert/.github/workflows/sync-master.yml b/tests/bats/bats-assert/.github/workflows/sync-master.yml new file mode 100644 index 0000000..4577123 --- /dev/null +++ b/tests/bats/bats-assert/.github/workflows/sync-master.yml @@ -0,0 +1,8 @@ +name: Sync Master +on: + push: { branches: main } + workflow_dispatch: + +jobs: + sync: + uses: bats-core/.github/.github/workflows/sync-master.yml@v1 diff --git a/tests/bats/bats-assert/.github/workflows/test.yml b/tests/bats/bats-assert/.github/workflows/test.yml new file mode 100644 index 0000000..6c95ce2 --- /dev/null +++ b/tests/bats/bats-assert/.github/workflows/test.yml @@ -0,0 +1,9 @@ +name: Test +on: + push: + pull_request: + workflow_dispatch: + +jobs: + test: + uses: bats-core/.github/.github/workflows/test.yml@v1 diff --git a/tests/bats/bats-assert/.gitignore b/tests/bats/bats-assert/.gitignore new file mode 100644 index 0000000..41a3ee1 --- /dev/null +++ b/tests/bats/bats-assert/.gitignore @@ -0,0 +1,3 @@ +/node_modules +/yarn.lock +/bats-assert-*.tgz diff --git a/tests/bats/bats-assert/LICENSE b/tests/bats/bats-assert/LICENSE new file mode 100644 index 0000000..670154e --- /dev/null +++ b/tests/bats/bats-assert/LICENSE @@ -0,0 +1,116 @@ +CC0 1.0 Universal + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator and +subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for the +purpose of contributing to a commons of creative, cultural and scientific +works ("Commons") that the public can reliably and without fear of later +claims of infringement build upon, modify, incorporate in other works, reuse +and redistribute as freely as possible in any form whatsoever and for any +purposes, including without limitation commercial purposes. These owners may +contribute to the Commons to promote the ideal of a free culture and the +further production of creative, cultural and scientific works, or to gain +reputation or greater distribution for their Work in part through the use and +efforts of others. + +For these and/or other purposes and motivations, and without any expectation +of additional consideration or compensation, the person associating CC0 with a +Work (the "Affirmer"), to the extent that he or she is an owner of Copyright +and Related Rights in the Work, voluntarily elects to apply CC0 to the Work +and publicly distribute the Work under its terms, with knowledge of his or her +Copyright and Related Rights in the Work and the meaning and intended legal +effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not limited +to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, communicate, + and translate a Work; + + ii. moral rights retained by the original author(s) and/or performer(s); + + iii. publicity and privacy rights pertaining to a person's image or likeness + depicted in a Work; + + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + + v. rights protecting the extraction, dissemination, use and reuse of data in + a Work; + + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation thereof, + including any amended or successor version of such directive); and + + vii. other similar, equivalent or corresponding rights throughout the world + based on applicable law or treaty, and any national implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention of, +applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and +unconditionally waives, abandons, and surrenders all of Affirmer's Copyright +and Related Rights and associated claims and causes of action, whether now +known or unknown (including existing as well as future claims and causes of +action), in the Work (i) in all territories worldwide, (ii) for the maximum +duration provided by applicable law or treaty (including future time +extensions), (iii) in any current or future medium and for any number of +copies, and (iv) for any purpose whatsoever, including without limitation +commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes +the Waiver for the benefit of each member of the public at large and to the +detriment of Affirmer's heirs and successors, fully intending that such Waiver +shall not be subject to revocation, rescission, cancellation, termination, or +any other legal or equitable action to disrupt the quiet enjoyment of the Work +by the public as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason be +judged legally invalid or ineffective under applicable law, then the Waiver +shall be preserved to the maximum extent permitted taking into account +Affirmer's express Statement of Purpose. In addition, to the extent the Waiver +is so judged Affirmer hereby grants to each affected person a royalty-free, +non transferable, non sublicensable, non exclusive, irrevocable and +unconditional license to exercise Affirmer's Copyright and Related Rights in +the Work (i) in all territories worldwide, (ii) for the maximum duration +provided by applicable law or treaty (including future time extensions), (iii) +in any current or future medium and for any number of copies, and (iv) for any +purpose whatsoever, including without limitation commercial, advertising or +promotional purposes (the "License"). The License shall be deemed effective as +of the date CC0 was applied by Affirmer to the Work. Should any part of the +License for any reason be judged legally invalid or ineffective under +applicable law, such partial invalidity or ineffectiveness shall not +invalidate the remainder of the License, and in such case Affirmer hereby +affirms that he or she will not (i) exercise any of his or her remaining +Copyright and Related Rights in the Work or (ii) assert any associated claims +and causes of action with respect to the Work, in either case contrary to +Affirmer's express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + + b. Affirmer offers the Work as-is and makes no representations or warranties + of any kind concerning the Work, express, implied, statutory or otherwise, + including without limitation warranties of title, merchantability, fitness + for a particular purpose, non infringement, or the absence of latent or + other defects, accuracy, or the present or absence of errors, whether or not + discoverable, all to the greatest extent permissible under applicable law. + + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without limitation + any person's Copyright and Related Rights in the Work. Further, Affirmer + disclaims responsibility for obtaining any necessary consents, permissions + or other rights required for any use of the Work. + + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to this + CC0 or use of the Work. + +For more information, please see + diff --git a/tests/bats/bats-assert/README.md b/tests/bats/bats-assert/README.md new file mode 100644 index 0000000..6f1f80e --- /dev/null +++ b/tests/bats/bats-assert/README.md @@ -0,0 +1,788 @@ +# bats-assert + +[![License](https://img.shields.io/npm/l/bats-assert.svg)](https://github.com/bats-core/bats-assert/blob/master/LICENSE) +[![GitHub release](https://img.shields.io/github/release/bats-core/bats-assert.svg)](https://github.com/bats-core/bats-assert/releases/latest) +[![npm release](https://img.shields.io/npm/v/bats-assert.svg)](https://www.npmjs.com/package/bats-assert) +[![Tests](https://github.com/bats-core/bats-assert/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/bats-core/bats-assert/actions/workflows/test.yml) + +`bats-assert` is a helper library providing common assertions for [Bats][bats]. + +- [Install](#install) +- [Usage](#usage) +- [Options](#options) +- [Full Assertion API](#full-assertion-api) + +In the context of this project, an [assertion][wikipedia-assertions] is a function that perform a test and returns `1` on failure or `0` on success. +To make debugging easier, the assertion also outputs relevant information on failure. +The output is [formatted][bats-support-output] for readability. +To make assertions usable outside of `@test` blocks, the output is sent to [stderr][wikipedia-stderr]. + +The most recent invocation of Bats' `run` function is used for testing assertions on output and status code. + +[wikipedia-assertions]: https://en.wikipedia.org/wiki/Assertion_(software_development) +[wikipedia-stderr]: https://en.wikipedia.org/wiki/Standard_streams#Standard_error_(stderr) + +## Install + +This project has one dependency, for output formatting: [`bats-support`][bats-support] + +Read the [shared documentation][bats-docs] to learn how to install and load both libraries. + +## Usage + +This project provides the following functions: + + - [assert](#assert) / [refute](#refute) Assert a given expression evaluates to `true` or `false`. + - [assert_equal](#assert_equal) Assert two parameters are equal. + - [assert_not_equal](#assert_not_equal) Assert two parameters are not equal. + - [assert_success](#assert_success) / [assert_failure](#assert_failure) Assert exit status is `0` or `1`. + - [assert_output](#assert_output) / [refute_output](#refute_output) Assert output does (or does not) contain given content. + - [assert_line](#assert_line) / [refute_line](#refute_line) Assert a specific line of output does (or does not) contain given content. + - [assert_regex](#assert_regex) / [refute_regex](#refute_regex) Assert a parameter does (or does not) match given pattern. + +These commands are described in more detail below. + +## Options + +For functions that have options, `--` disables option parsing for the remaining arguments to allow using arguments identical to one of the allowed options. + +```bash +assert_output -- '-p' +``` + +Specifying `--` as an argument is similarly simple. + +```bash +refute_line -- '--' +``` + + +## Full Assertion API + +### `assert` + +Fail if the given expression evaluates to false. + +> _**Note**: +> The expression must be a simple command. +> [Compound commands][bash-comp-cmd], such as `[[`, can be used only when executed with `bash -c`._ + +```bash +@test 'assert()' { + assert [ 1 -lt 0 ] +} +``` + +On failure, the failed expression is displayed. + +``` +-- assertion failed -- +expression : [ 1 -lt 0 ] +-- +``` + + +### `refute` + +Fail if the given expression evaluates to true. + +> _**Note** +> The expression must be a simple command. +> [Compound commands][bash-comp-cmd], such as `[[`, can be used only when executed with `bash -c`._ + +```bash +@test 'refute()' { + refute [ 1 -gt 0 ] +} +``` + +On failure, the successful expression is displayed. + +``` +-- assertion succeeded, but it was expected to fail -- +expression : [ 1 -gt 0 ] +-- +``` + + +### `assert_equal` + +Fail if the two parameters, actual and expected value respectively, do not equal. + +```bash +@test 'assert_equal()' { + assert_equal 'have' 'want' +} +``` + +On failure, the expected and actual values are displayed. + +``` +-- values do not equal -- +expected : want +actual : have +-- +``` + +If either value is longer than one line both are displayed in *multi-line* format. + + +### `assert_not_equal` + +Fail if the two parameters, actual and unexpected value respectively, are equal. + +```bash +@test 'assert_not_equal()' { + assert_not_equal 'foobar' 'foobar' +} +``` + +On failure, the expected and actual values are displayed. + +``` +-- values should not be equal -- +unexpected : foobar +actual : foobar +-- +``` + +If either value is longer than one line both are displayed in *multi-line* format. + + +### `assert_success` + +Fail if `$status` is not 0. + +```bash +@test 'assert_success() status only' { + run bash -c "echo 'Error!'; exit 1" + assert_success +} +``` + +On failure, `$status` and `$output` are displayed. + +``` +-- command failed -- +status : 1 +output : Error! +-- +``` + +If `$output` is longer than one line, it is displayed in *multi-line* format. + + +### `assert_failure` + +Fail if `$status` is 0. + +```bash +@test 'assert_failure() status only' { + run echo 'Success!' + assert_failure +} +``` + +On failure, `$output` is displayed. + +``` +-- command succeeded, but it was expected to fail -- +output : Success! +-- +``` + +If `$output` is longer than one line, it is displayed in *multi-line* format. + +#### Expected status + +When one parameter is specified, fail if `$status` does not equal the expected status specified by the parameter. + +```bash +@test 'assert_failure() with expected status' { + run bash -c "echo 'Error!'; exit 1" + assert_failure 2 +} +``` + +On failure, the expected and actual status, and `$output` are displayed. + +``` +-- command failed as expected, but status differs -- +expected : 2 +actual : 1 +output : Error! +-- +``` + +If `$output` is longer than one line, it is displayed in *multi-line* format. + + +### `assert_output` + +This function helps to verify that a command or function produces the correct output by checking that the specified expected output matches the actual output. +Matching can be literal (default), partial or regular expression. +This function is the logical complement of `refute_output`. + +#### Literal matching + +By default, literal matching is performed. +The assertion fails if `$output` does not equal the expected output. + +```bash +@test 'assert_output()' { + run echo 'have' + assert_output 'want' +} +``` + +On failure, the expected and actual output are displayed. + +``` +-- output differs -- +expected : want +actual : have +-- +``` + +If either value is longer than one line both are displayed in *multi-line* format. + +#### Existence + +To assert that any (non-empty) output exists at all, simply omit the matching argument. + +```bash +@test 'assert_output()' { + run echo 'have' + assert_output +} +``` + +On failure, an error message is displayed. + +``` +-- no output -- +expected non-empty output, but output was empty +-- +``` + +#### Partial matching + +Partial matching can be enabled with the `--partial` option (`-p` for short). +When used, the assertion fails if the expected *substring* is not found in `$output`. + +```bash +@test 'assert_output() partial matching' { + run echo 'ERROR: no such file or directory' + assert_output --partial 'SUCCESS' +} +``` + +On failure, the substring and the output are displayed. + +``` +-- output does not contain substring -- +substring : SUCCESS +output : ERROR: no such file or directory +-- +``` + +This option and regular expression matching (`--regexp` or `-e`) are mutually exclusive. +An error is displayed when used simultaneously. + +#### Regular expression matching + +Regular expression matching can be enabled with the `--regexp` option (`-e` for short). +When used, the assertion fails if the *extended regular expression* does not match `$output`. + +> _**Note**: +> The anchors `^` and `$` bind to the beginning and the end of the entire output (not individual lines), respectively._ + +```bash +@test 'assert_output() regular expression matching' { + run echo 'Foobar 0.1.0' + assert_output --regexp '^Foobar v[0-9]+\.[0-9]+\.[0-9]$' +} +``` + +On failure, the regular expression and the output are displayed. + +``` +-- regular expression does not match output -- +regexp : ^Foobar v[0-9]+\.[0-9]+\.[0-9]$ +output : Foobar 0.1.0 +-- +``` + +An error is displayed if the specified extended regular expression is invalid. + +This option and partial matching (`--partial` or `-p`) are mutually exclusive. +An error is displayed when used simultaneously. + +#### Standard Input, HereDocs and HereStrings + +The expected output can be specified via standard input (also heredoc/herestring) with the `-`/`--stdin` option. + +```bash +@test 'assert_output() with pipe' { + run echo 'hello' + echo 'hello' | assert_output - +} + +@test 'assert_output() with herestring' { + run echo 'hello' + assert_output - <<< hello +} +``` + + +### `refute_output` + +This function helps to verify that a command or function produces the correct output by checking that the specified unexpected output does not match the actual output. +Matching can be literal (default), partial or regular expression. +This function is the logical complement of `assert_output`. + +#### Literal matching + +By default, literal matching is performed. +The assertion fails if `$output` equals the unexpected output. + +```bash +@test 'refute_output()' { + run echo 'want' + refute_output 'want' +} +``` + +On failure, the output is displayed. + +``` +-- output equals, but it was expected to differ -- +output : want +-- +``` + +If output is longer than one line it is displayed in *multi-line* format. + +#### Existence + +To assert that there is no output at all, simply omit the matching argument. + +```bash +@test 'refute_output()' { + run foo --silent + refute_output +} +``` + +On failure, an error message is displayed. + +``` +-- unexpected output -- +expected no output, but output was non-empty +-- +``` + +#### Partial matching + +Partial matching can be enabled with the `--partial` option (`-p` for short). +When used, the assertion fails if the unexpected *substring* is found in `$output`. + +```bash +@test 'refute_output() partial matching' { + run echo 'ERROR: no such file or directory' + refute_output --partial 'ERROR' +} +``` + +On failure, the substring and the output are displayed. + +``` +-- output should not contain substring -- +substring : ERROR +output : ERROR: no such file or directory +-- +``` + +This option and regular expression matching (`--regexp` or `-e`) are mutually exclusive. +An error is displayed when used simultaneously. + +#### Regular expression matching + +Regular expression matching can be enabled with the `--regexp` option (`-e` for short). +When used, the assertion fails if the *extended regular expression* matches `$output`. + +> _**Note**: +> The anchors `^` and `$` bind to the beginning and the end of the entire output (not individual lines), respectively._ + +```bash +@test 'refute_output() regular expression matching' { + run echo 'Foobar v0.1.0' + refute_output --regexp '^Foobar v[0-9]+\.[0-9]+\.[0-9]$' +} +``` + +On failure, the regular expression and the output are displayed. + +``` +-- regular expression should not match output -- +regexp : ^Foobar v[0-9]+\.[0-9]+\.[0-9]$ +output : Foobar v0.1.0 +-- +``` + +An error is displayed if the specified extended regular expression is invalid. + +This option and partial matching (`--partial` or `-p`) are mutually exclusive. +An error is displayed when used simultaneously. + +#### Standard Input, HereDocs and HereStrings + +The unexpected output can be specified via standard input (also heredoc/herestring) with the `-`/`--stdin` option. + +```bash +@test 'refute_output() with pipe' { + run echo 'hello' + echo 'world' | refute_output - +} + +@test 'refute_output() with herestring' { + run echo 'hello' + refute_output - <<< world +} +``` + + +### `assert_line` + +Similarly to `assert_output`, this function helps to verify that a command or function produces the correct output. +It checks that the expected line appears in the output (default) or in a specific line of it. +Matching can be literal (default), partial or regular expression. +This function is the logical complement of `refute_line`. + +> _**Warning**: +> Due to a [bug in Bats][bats-93], empty lines are discarded from `${lines[@]}`, +> causing line indices to change and preventing testing for empty lines._ + +[bats-93]: https://github.com/sstephenson/bats/pull/93 + +#### Looking for a line in the output + +By default, the entire output is searched for the expected line. +The assertion fails if the expected line is not found in `${lines[@]}`. + +```bash +@test 'assert_line() looking for line' { + run echo $'have-0\nhave-1\nhave-2' + assert_line 'want' +} +``` + +On failure, the expected line and the output are displayed. + +> _**Warning**: +> The output displayed does not contain empty lines. +> See the Warning above for more._ + +``` +-- output does not contain line -- +line : want +output (3 lines): + have-0 + have-1 + have-2 +-- +``` + +If output is not longer than one line, it is displayed in *two-column* format. + +#### Matching a specific line + +When the `--index ` option is used (`-n ` for short), the expected line is matched only against the line identified by the given index. +The assertion fails if the expected line does not equal `${lines[]}`. + +```bash +@test 'assert_line() specific line' { + run echo $'have-0\nhave-1\nhave-2' + assert_line --index 1 'want-1' +} +``` + +On failure, the index and the compared lines are displayed. + +``` +-- line differs -- +index : 1 +expected : want-1 +actual : have-1 +-- +``` + +#### Partial matching + +Partial matching can be enabled with the `--partial` option (`-p` for short). +When used, a match fails if the expected *substring* is not found in the matched line. + +```bash +@test 'assert_line() partial matching' { + run echo $'have 1\nhave 2\nhave 3' + assert_line --partial 'want' +} +``` + +On failure, the same details are displayed as for literal matching, except that the substring replaces the expected line. + +``` +-- no output line contains substring -- +substring : want +output (3 lines): + have 1 + have 2 + have 3 +-- +``` + +This option and regular expression matching (`--regexp` or `-e`) are mutually exclusive. +An error is displayed when used simultaneously. + +#### Regular expression matching + +Regular expression matching can be enabled with the `--regexp` option (`-e` for short). +When used, a match fails if the *extended regular expression* does not match the line being tested. + +> _**Note**: +> As expected, the anchors `^` and `$` bind to the beginning and the end of the matched line, respectively._ + +```bash +@test 'assert_line() regular expression matching' { + run echo $'have-0\nhave-1\nhave-2' + assert_line --index 1 --regexp '^want-[0-9]$' +} +``` + +On failure, the same details are displayed as for literal matching, except that the regular expression replaces the expected line. + +``` +-- regular expression does not match line -- +index : 1 +regexp : ^want-[0-9]$ +line : have-1 +-- +``` + +An error is displayed if the specified extended regular expression is invalid. + +This option and partial matching (`--partial` or `-p`) are mutually exclusive. +An error is displayed when used simultaneously. + + +### `refute_line` + +Similarly to `refute_output`, this function helps to verify that a command or function produces the correct output. +It checks that the unexpected line does not appear in the output (default) or in a specific line of it. +Matching can be literal (default), partial or regular expression. +This function is the logical complement of `assert_line`. + +> _**Warning**: +> Due to a [bug in Bats][bats-93], empty lines are discarded from `${lines[@]}`, +> causing line indices to change and preventing testing for empty lines._ + +[bats-93]: https://github.com/sstephenson/bats/pull/93 + +#### Looking for a line in the output + +By default, the entire output is searched for the unexpected line. +The assertion fails if the unexpected line is found in `${lines[@]}`. + +```bash +@test 'refute_line() looking for line' { + run echo $'have-0\nwant\nhave-2' + refute_line 'want' +} +``` + +On failure, the unexpected line, the index of its first match and the output with the matching line highlighted are displayed. + +> _**Warning**: +> The output displayed does not contain empty lines. +> See the Warning above for more._ + +``` +-- line should not be in output -- +line : want +index : 1 +output (3 lines): + have-0 +> want + have-2 +-- +``` + +If output is not longer than one line, it is displayed in *two-column* format. + +#### Matching a specific line + +When the `--index ` option is used (`-n ` for short), the unexpected line is matched only against the line identified by the given index. +The assertion fails if the unexpected line equals `${lines[]}`. + +```bash +@test 'refute_line() specific line' { + run echo $'have-0\nwant-1\nhave-2' + refute_line --index 1 'want-1' +} +``` + +On failure, the index and the unexpected line are displayed. + +``` +-- line should differ -- +index : 1 +line : want-1 +-- +``` + +#### Partial matching + +Partial matching can be enabled with the `--partial` option (`-p` for short). +When used, a match fails if the unexpected *substring* is found in the matched line. + +```bash +@test 'refute_line() partial matching' { + run echo $'have 1\nwant 2\nhave 3' + refute_line --partial 'want' +} +``` + +On failure, in addition to the details of literal matching, the substring is also displayed. +When used with `--index ` the substring replaces the unexpected line. + +``` +-- no line should contain substring -- +substring : want +index : 1 +output (3 lines): + have 1 +> want 2 + have 3 +-- +``` + +This option and regular expression matching (`--regexp` or `-e`) are mutually exclusive. +An error is displayed when used simultaneously. + +#### Regular expression matching + +Regular expression matching can be enabled with the `--regexp` option (`-e` for short). +When used, a match fails if the *extended regular expression* matches the line being tested. + +> _**Note**: +> As expected, the anchors `^` and `$` bind to the beginning and the end of the matched line, respectively._ + +```bash +@test 'refute_line() regular expression matching' { + run echo $'Foobar v0.1.0\nRelease date: 2015-11-29' + refute_line --index 0 --regexp '^Foobar v[0-9]+\.[0-9]+\.[0-9]$' +} +``` + +On failure, in addition to the details of literal matching, the regular expression is also displayed. +When used with `--index ` the regular expression replaces the unexpected line. + +``` +-- regular expression should not match line -- +index : 0 +regexp : ^Foobar v[0-9]+\.[0-9]+\.[0-9]$ +line : Foobar v0.1.0 +-- +``` + +An error is displayed if the specified extended regular expression is invalid. + +This option and partial matching (`--partial` or `-p`) are mutually exclusive. +An error is displayed when used simultaneously. + +### `assert_regex` + +This function is similar to `assert_equal` but uses pattern matching instead of +equality, by wrapping `[[ value =~ pattern ]]`. + +Fail if the value (first parameter) does not match the pattern (second +parameter). + +```bash +@test 'assert_regex()' { + assert_regex 'what' 'x$' +} +``` + +On failure, the value and the pattern are displayed. + +``` +-- values does not match regular expression -- +value : what +pattern : x$ +-- +``` + +If the value is longer than one line then it is displayed in *multi-line* +format. + +An error is displayed if the specified extended regular expression is invalid. + +For description of the matching behavior, refer to the documentation of the +`=~` operator in the [Bash manual][bash-conditional]. + +> _**Note**: +> the `BASH_REMATCH` array is available immediately after the assertion succeeds but is fragile; +> i.e. prone to being overwritten as a side effect of other actions._ + +### `refute_regex` + +This function is similar to `refute_equal` but uses pattern matching instead of +equality, by wrapping `! [[ value =~ pattern ]]`. + +Fail if the value (first parameter) matches the pattern (second parameter). + +```bash +@test 'refute_regex()' { + refute_regex 'WhatsApp' 'Threema' +} +``` + +On failure, the value, the pattern and the match are displayed. + +``` +@test 'refute_regex()' { + refute_regex 'WhatsApp' 'What.' +} + +-- value matches regular expression -- +value : WhatsApp +pattern : What. +match : Whats +case : sensitive +-- +``` + +If the value or pattern is longer than one line then it is displayed in +*multi-line* format. + +An error is displayed if the specified extended regular expression is invalid. + +For description of the matching behavior, refer to the documentation of the +`=~` operator in the [Bash manual][bash-conditional]. + +> _**Note**: +> the `BASH_REMATCH` array is available immediately after the assertion fails but is fragile; +> i.e. prone to being overwritten as a side effect of other actions like calling `run`. +> Thus, it's good practice to avoid using `BASH_REMATCH` in conjunction with `refute_regex()`. +> The valuable information the array contains is the matching part of the value which is printed in the failing test log, as mentioned above._ + + + +[bats]: https://github.com/bats-core/bats-core +[bash-comp-cmd]: https://www.gnu.org/software/bash/manual/bash.html#Compound-Commands +[bash-conditional]: https://www.gnu.org/software/bash/manual/bash.html#Conditional-Constructs + +[bats-docs]: https://bats-core.readthedocs.io/ +[bats-support-output]: https://github.com/bats-core/bats-support#output-formatting +[bats-support]: https://github.com/bats-core/bats-support diff --git a/tests/bats/bats-assert/load.bash b/tests/bats/bats-assert/load.bash new file mode 100644 index 0000000..c67d9e8 --- /dev/null +++ b/tests/bats/bats-assert/load.bash @@ -0,0 +1,33 @@ +# bats-assert - Common assertions for Bats +# +# Written in 2016 by Zoltan Tombol +# +# To the extent possible under law, the author(s) have dedicated all +# copyright and related and neighboring rights to this software to the +# public domain worldwide. This software is distributed without any +# warranty. +# +# You should have received a copy of the CC0 Public Domain Dedication +# along with this software. If not, see +# . +# +# Assertions are functions that perform a test and output relevant +# information on failure to help debugging. They return 1 on failure +# and 0 otherwise. +# +# All output is formatted for readability using the functions of +# `output.bash' and sent to the standard error. + +# shellcheck disable=1090 +source "$(dirname "${BASH_SOURCE[0]}")/src/assert.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/refute.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/assert_equal.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/assert_not_equal.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/assert_success.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/assert_failure.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/assert_output.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/refute_output.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/assert_line.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/refute_line.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/assert_regex.bash" +source "$(dirname "${BASH_SOURCE[0]}")/src/refute_regex.bash" diff --git a/tests/bats/bats-assert/package-lock.json b/tests/bats/bats-assert/package-lock.json new file mode 100644 index 0000000..8f0dcc6 --- /dev/null +++ b/tests/bats/bats-assert/package-lock.json @@ -0,0 +1,36 @@ +{ + "name": "bats-assert", + "version": "2.1.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "bats-assert", + "version": "2.1.0", + "license": "CC0-1.0", + "devDependencies": { + "bats": "^1", + "bats-support": "^0.3" + }, + "peerDependencies": { + "bats": "0.4 || ^1", + "bats-support": "^0.3" + } + }, + "node_modules/bats": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/bats/-/bats-1.9.0.tgz", + "integrity": "sha512-Z5BJaAmmHv/ujj7obhjEzJ//OL+ZtjVq0iRnHu+2fE9OeUaPMbJpBgYiOdNbDrG3E2hqe84/AXNnS/UiXl/UcA==", + "dev": true, + "bin": { + "bats": "bin/bats" + } + }, + "node_modules/bats-support": { + "version": "0.3.0", + "resolved": "git+ssh://git@github.com/jasonkarns/bats-support.git#24a72e14349690bcbf7c151b9d2d1cdd32d36eb1", + "integrity": "sha512-42f2THEaN02dVj7Zhj0C4AM5FdePq3YPlXvnu/fKUQwCv1qM2dyACBKFXQkLw9QMzhDmwuFcke90XwHMUsBjGQ==", + "dev": true + } + } +} diff --git a/tests/bats/bats-assert/package.json b/tests/bats/bats-assert/package.json new file mode 100644 index 0000000..7048995 --- /dev/null +++ b/tests/bats/bats-assert/package.json @@ -0,0 +1,48 @@ +{ + "name": "bats-assert", + "version": "2.1.0", + "description": "Common assertions for Bats", + "homepage": "https://github.com/bats-core/bats-assert", + "license": "CC0-1.0", + "author": "Zoltán Tömböl (https://github.com/ztombol)", + "contributors": [ + "Sam Stephenson (http://sstephenson.us/)", + "Jason Karns (http://jason.karns.name)", + "Mislav Marohnić (http://mislav.net/)", + "Tim Pope (https://github.com/tpope)" + ], + "repository": "github:bats-core/bats-assert", + "bugs": "https://github.com/bats-core/bats-assert/issues", + "directories": { + "lib": "src", + "test": "test" + }, + "files": [ + "load.bash", + "src" + ], + "scripts": { + "test": "bats ${CI+-t} test", + "postversion": "npm publish", + "prepublishOnly": "npm run publish:github", + "publish:github": "git push --follow-tags" + }, + "devDependencies": { + "bats": "^1", + "bats-support": "^0.3" + }, + "peerDependencies": { + "bats": "0.4 || ^1", + "bats-support": "^0.3" + }, + "keywords": [ + "bats", + "bash", + "shell", + "test", + "unit", + "assert", + "assertion", + "helper" + ] +} diff --git a/tests/bats/bats-assert/src/assert.bash b/tests/bats/bats-assert/src/assert.bash new file mode 100644 index 0000000..0260ce2 --- /dev/null +++ b/tests/bats/bats-assert/src/assert.bash @@ -0,0 +1,42 @@ +# assert +# ====== +# +# Summary: Fail if the given expression evaluates to false. +# +# Usage: assert + +# Options: +# The expression to evaluate for truthiness. +# *__Note:__ The expression must be a simple command. +# [Compound commands](https://www.gnu.org/software/bash/manual/bash.html#Compound-Commands), +# such as `[[`, can be used only when executed with `bash -c`.* +# +# IO: +# STDERR - the failed expression, on failure +# Globals: +# none +# Returns: +# 0 - if expression evaluates to true +# 1 - otherwise +# +# ```bash +# @test 'assert()' { +# touch '/var/log/test.log' +# assert [ -e '/var/log/test.log' ] +# } +# ``` +# +# On failure, the failed expression is displayed. +# +# ``` +# -- assertion failed -- +# expression : [ -e /var/log/test.log ] +# -- +# ``` +assert() { + if ! "$@"; then + batslib_print_kv_single 10 'expression' "$*" \ + | batslib_decorate 'assertion failed' \ + | fail + fi +} diff --git a/tests/bats/bats-assert/src/assert_equal.bash b/tests/bats/bats-assert/src/assert_equal.bash new file mode 100644 index 0000000..4ef1297 --- /dev/null +++ b/tests/bats/bats-assert/src/assert_equal.bash @@ -0,0 +1,42 @@ +# assert_equal +# ============ +# +# Summary: Fail if the actual and expected values are not equal. +# +# Usage: assert_equal +# +# Options: +# The value being compared. +# The value to compare against. +# +# ```bash +# @test 'assert_equal()' { +# assert_equal 'have' 'want' +# } +# ``` +# +# IO: +# STDERR - expected and actual values, on failure +# Globals: +# none +# Returns: +# 0 - if values equal +# 1 - otherwise +# +# On failure, the expected and actual values are displayed. +# +# ``` +# -- values do not equal -- +# expected : want +# actual : have +# -- +# ``` +assert_equal() { + if [[ $1 != "$2" ]]; then + batslib_print_kv_single_or_multi 8 \ + 'expected' "$2" \ + 'actual' "$1" \ + | batslib_decorate 'values do not equal' \ + | fail + fi +} diff --git a/tests/bats/bats-assert/src/assert_failure.bash b/tests/bats/bats-assert/src/assert_failure.bash new file mode 100644 index 0000000..d906059 --- /dev/null +++ b/tests/bats/bats-assert/src/assert_failure.bash @@ -0,0 +1,78 @@ +# assert_failure +# ============== +# +# Summary: Fail if `$status` is 0; or is not equal to the optionally provided status. +# +# Usage: assert_failure [] +# +# Options: +# The specific status code to check against. +# If not provided, simply asserts status is != 0. +# +# IO: +# STDERR - `$output`, on failure; +# - also, `$status` and `expected_status`, if provided +# Globals: +# status +# output +# Returns: +# 0 - if `$status' is 0, +# or if expected_status is provided but does not equal `$status' +# 1 - otherwise +# +# ```bash +# @test 'assert_failure() status only' { +# run echo 'Success!' +# assert_failure +# } +# ``` +# +# On failure, `$output` is displayed. +# +# ``` +# -- command succeeded, but it was expected to fail -- +# output : Success! +# -- +# ``` +# +# ## Expected status +# +# When `expected_status` is provided, fail if `$status` does not equal the `expected_status`. +# +# ```bash +# @test 'assert_failure() with expected status' { +# run bash -c "echo 'Error!'; exit 1" +# assert_failure 2 +# } +# ``` +# +# On failure, both the expected and actual statuses, and `$output` are displayed. +# +# ``` +# -- command failed as expected, but status differs -- +# expected : 2 +# actual : 1 +# output : Error! +# -- +# ``` +assert_failure() { + : "${output?}" + : "${status?}" + + (( $# > 0 )) && local -r expected="$1" + if (( status == 0 )); then + batslib_print_kv_single_or_multi 6 'output' "$output" \ + | batslib_decorate 'command succeeded, but it was expected to fail' \ + | fail + elif (( $# > 0 )) && (( status != expected )); then + { local -ir width=8 + batslib_print_kv_single "$width" \ + 'expected' "$expected" \ + 'actual' "$status" + batslib_print_kv_single_or_multi "$width" \ + 'output' "$output" + } \ + | batslib_decorate 'command failed as expected, but status differs' \ + | fail + fi +} diff --git a/tests/bats/bats-assert/src/assert_line.bash b/tests/bats/bats-assert/src/assert_line.bash new file mode 100644 index 0000000..ee05bb8 --- /dev/null +++ b/tests/bats/bats-assert/src/assert_line.bash @@ -0,0 +1,248 @@ +# assert_line +# =========== +# +# Summary: Fail if the expected line is not found in the output (default) or at a specific line number. +# +# Usage: assert_line [-n index] [-p | -e] [--] +# +# Options: +# -n, --index Match the th line +# -p, --partial Match if `expected` is a substring of `$output` or line +# -e, --regexp Treat `expected` as an extended regular expression +# The expected line string, substring, or regular expression +# +# IO: +# STDERR - details, on failure +# error message, on error +# Globals: +# output +# lines +# Returns: +# 0 - if matching line found +# 1 - otherwise +# +# Similarly to `assert_output`, this function verifies that a command or function produces the expected output. +# (It is the logical complement of `refute_line`.) +# It checks that the expected line appears in the output (default) or at a specific line number. +# Matching can be literal (default), partial or regular expression. +# +# *__Warning:__ +# Due to a [bug in Bats][bats-93], empty lines are discarded from `${lines[@]}`, +# causing line indices to change and preventing testing for empty lines.* +# +# [bats-93]: https://github.com/sstephenson/bats/pull/93 +# +# ## Looking for a line in the output +# +# By default, the entire output is searched for the expected line. +# The assertion fails if the expected line is not found in `${lines[@]}`. +# +# ```bash +# @test 'assert_line() looking for line' { +# run echo $'have-0\nhave-1\nhave-2' +# assert_line 'want' +# } +# ``` +# +# On failure, the expected line and the output are displayed. +# +# ``` +# -- output does not contain line -- +# line : want +# output (3 lines): +# have-0 +# have-1 +# have-2 +# -- +# ``` +# +# ## Matching a specific line +# +# When the `--index ` option is used (`-n ` for short), the expected line is matched only against the line identified by the given index. +# The assertion fails if the expected line does not equal `${lines[]}`. +# +# ```bash +# @test 'assert_line() specific line' { +# run echo $'have-0\nhave-1\nhave-2' +# assert_line --index 1 'want-1' +# } +# ``` +# +# On failure, the index and the compared lines are displayed. +# +# ``` +# -- line differs -- +# index : 1 +# expected : want-1 +# actual : have-1 +# -- +# ``` +# +# ## Partial matching +# +# Partial matching can be enabled with the `--partial` option (`-p` for short). +# When used, a match fails if the expected *substring* is not found in the matched line. +# +# ```bash +# @test 'assert_line() partial matching' { +# run echo $'have 1\nhave 2\nhave 3' +# assert_line --partial 'want' +# } +# ``` +# +# On failure, the same details are displayed as for literal matching, except that the substring replaces the expected line. +# +# ``` +# -- no output line contains substring -- +# substring : want +# output (3 lines): +# have 1 +# have 2 +# have 3 +# -- +# ``` +# +# ## Regular expression matching +# +# Regular expression matching can be enabled with the `--regexp` option (`-e` for short). +# When used, a match fails if the *extended regular expression* does not match the line being tested. +# +# *__Note__: +# As expected, the anchors `^` and `$` bind to the beginning and the end (respectively) of the matched line.* +# +# ```bash +# @test 'assert_line() regular expression matching' { +# run echo $'have-0\nhave-1\nhave-2' +# assert_line --index 1 --regexp '^want-[0-9]$' +# } +# ``` +# +# On failure, the same details are displayed as for literal matching, except that the regular expression replaces the expected line. +# +# ``` +# -- regular expression does not match line -- +# index : 1 +# regexp : ^want-[0-9]$ +# line : have-1 +# -- +# ``` +# FIXME(ztombol): Display `${lines[@]}' instead of `$output'! +assert_line() { + local -i is_match_line=0 + local -i is_mode_partial=0 + local -i is_mode_regexp=0 + : "${lines?}" + + # Handle options. + while (( $# > 0 )); do + case "$1" in + -n|--index) + if (( $# < 2 )) || ! [[ $2 =~ ^-?([0-9]|[1-9][0-9]+)$ ]]; then + echo "\`--index' requires an integer argument: \`$2'" \ + | batslib_decorate 'ERROR: assert_line' \ + | fail + return $? + fi + is_match_line=1 + local -ri idx="$2" + shift 2 + ;; + -p|--partial) is_mode_partial=1; shift ;; + -e|--regexp) is_mode_regexp=1; shift ;; + --) shift; break ;; + *) break ;; + esac + done + + if (( is_mode_partial )) && (( is_mode_regexp )); then + echo "\`--partial' and \`--regexp' are mutually exclusive" \ + | batslib_decorate 'ERROR: assert_line' \ + | fail + return $? + fi + + # Arguments. + local -r expected="$1" + + if (( is_mode_regexp == 1 )) && [[ '' =~ $expected ]] || (( $? == 2 )); then + echo "Invalid extended regular expression: \`$expected'" \ + | batslib_decorate 'ERROR: assert_line' \ + | fail + return $? + fi + + # Matching. + if (( is_match_line )); then + # Specific line. + if (( is_mode_regexp )); then + if ! [[ ${lines[$idx]} =~ $expected ]]; then + batslib_print_kv_single 6 \ + 'index' "$idx" \ + 'regexp' "$expected" \ + 'line' "${lines[$idx]}" \ + | batslib_decorate 'regular expression does not match line' \ + | fail + fi + elif (( is_mode_partial )); then + if [[ ${lines[$idx]} != *"$expected"* ]]; then + batslib_print_kv_single 9 \ + 'index' "$idx" \ + 'substring' "$expected" \ + 'line' "${lines[$idx]}" \ + | batslib_decorate 'line does not contain substring' \ + | fail + fi + else + if [[ ${lines[$idx]} != "$expected" ]]; then + batslib_print_kv_single 8 \ + 'index' "$idx" \ + 'expected' "$expected" \ + 'actual' "${lines[$idx]}" \ + | batslib_decorate 'line differs' \ + | fail + fi + fi + else + # Contained in output. + if (( is_mode_regexp )); then + local -i idx + for (( idx = 0; idx < ${#lines[@]}; ++idx )); do + [[ ${lines[$idx]} =~ $expected ]] && return 0 + done + { local -ar single=( 'regexp' "$expected" ) + local -ar may_be_multi=( 'output' "$output" ) + local -ir width="$( batslib_get_max_single_line_key_width "${single[@]}" "${may_be_multi[@]}" )" + batslib_print_kv_single "$width" "${single[@]}" + batslib_print_kv_single_or_multi "$width" "${may_be_multi[@]}" + } \ + | batslib_decorate 'no output line matches regular expression' \ + | fail + elif (( is_mode_partial )); then + local -i idx + for (( idx = 0; idx < ${#lines[@]}; ++idx )); do + [[ ${lines[$idx]} == *"$expected"* ]] && return 0 + done + { local -ar single=( 'substring' "$expected" ) + local -ar may_be_multi=( 'output' "$output" ) + local -ir width="$( batslib_get_max_single_line_key_width "${single[@]}" "${may_be_multi[@]}" )" + batslib_print_kv_single "$width" "${single[@]}" + batslib_print_kv_single_or_multi "$width" "${may_be_multi[@]}" + } \ + | batslib_decorate 'no output line contains substring' \ + | fail + else + local -i idx + for (( idx = 0; idx < ${#lines[@]}; ++idx )); do + [[ ${lines[$idx]} == "$expected" ]] && return 0 + done + { local -ar single=( 'line' "$expected" ) + local -ar may_be_multi=( 'output' "$output" ) + local -ir width="$( batslib_get_max_single_line_key_width "${single[@]}" "${may_be_multi[@]}" )" + batslib_print_kv_single "$width" "${single[@]}" + batslib_print_kv_single_or_multi "$width" "${may_be_multi[@]}" + } \ + | batslib_decorate 'output does not contain line' \ + | fail + fi + fi +} diff --git a/tests/bats/bats-assert/src/assert_not_equal.bash b/tests/bats/bats-assert/src/assert_not_equal.bash new file mode 100644 index 0000000..933bb71 --- /dev/null +++ b/tests/bats/bats-assert/src/assert_not_equal.bash @@ -0,0 +1,42 @@ +# assert_not_equal +# ============ +# +# Summary: Fail if the actual and unexpected values are equal. +# +# Usage: assert_not_equal +# +# Options: +# The value being compared. +# The value to compare against. +# +# ```bash +# @test 'assert_not_equal()' { +# assert_not_equal 'foo' 'foo' +# } +# ``` +# +# IO: +# STDERR - expected and actual values, on failure +# Globals: +# none +# Returns: +# 0 - if actual does not equal unexpected +# 1 - otherwise +# +# On failure, the unexpected and actual values are displayed. +# +# ``` +# -- values should not be equal -- +# unexpected : foo +# actual : foo +# -- +# ``` +assert_not_equal() { + if [[ "$1" == "$2" ]]; then + batslib_print_kv_single_or_multi 10 \ + 'unexpected' "$2" \ + 'actual' "$1" \ + | batslib_decorate 'values should not be equal' \ + | fail + fi +} diff --git a/tests/bats/bats-assert/src/assert_output.bash b/tests/bats/bats-assert/src/assert_output.bash new file mode 100644 index 0000000..82d0a0c --- /dev/null +++ b/tests/bats/bats-assert/src/assert_output.bash @@ -0,0 +1,197 @@ +# assert_output +# ============= +# +# Summary: Fail if `$output' does not match the expected output. +# +# Usage: assert_output [-p | -e] [- | [--] ] +# +# Options: +# -p, --partial Match if `expected` is a substring of `$output` +# -e, --regexp Treat `expected` as an extended regular expression +# -, --stdin Read `expected` value from STDIN +# The expected value, substring or regular expression +# +# IO: +# STDIN - [=$1] expected output +# STDERR - details, on failure +# error message, on error +# Globals: +# output +# Returns: +# 0 - if output matches the expected value/partial/regexp +# 1 - otherwise +# +# This function verifies that a command or function produces the expected output. +# (It is the logical complement of `refute_output`.) +# Output matching can be literal (the default), partial or by regular expression. +# The expected output can be specified either by positional argument or read from STDIN by passing the `-`/`--stdin` flag. +# +# ## Literal matching +# +# By default, literal matching is performed. +# The assertion fails if `$output` does not equal the expected output. +# +# ```bash +# @test 'assert_output()' { +# run echo 'have' +# assert_output 'want' +# } +# +# @test 'assert_output() with pipe' { +# run echo 'hello' +# echo 'hello' | assert_output - +# } +# +# @test 'assert_output() with herestring' { +# run echo 'hello' +# assert_output - <<< hello +# } +# ``` +# +# On failure, the expected and actual output are displayed. +# +# ``` +# -- output differs -- +# expected : want +# actual : have +# -- +# ``` +# +# ## Existence +# +# To assert that any output exists at all, omit the `expected` argument. +# +# ```bash +# @test 'assert_output()' { +# run echo 'have' +# assert_output +# } +# ``` +# +# On failure, an error message is displayed. +# +# ``` +# -- no output -- +# expected non-empty output, but output was empty +# -- +# ``` +# +# ## Partial matching +# +# Partial matching can be enabled with the `--partial` option (`-p` for short). +# When used, the assertion fails if the expected _substring_ is not found in `$output`. +# +# ```bash +# @test 'assert_output() partial matching' { +# run echo 'ERROR: no such file or directory' +# assert_output --partial 'SUCCESS' +# } +# ``` +# +# On failure, the substring and the output are displayed. +# +# ``` +# -- output does not contain substring -- +# substring : SUCCESS +# output : ERROR: no such file or directory +# -- +# ``` +# +# ## Regular expression matching +# +# Regular expression matching can be enabled with the `--regexp` option (`-e` for short). +# When used, the assertion fails if the *extended regular expression* does not match `$output`. +# +# *__Note__: +# The anchors `^` and `$` bind to the beginning and the end (respectively) of the entire output; +# not individual lines.* +# +# ```bash +# @test 'assert_output() regular expression matching' { +# run echo 'Foobar 0.1.0' +# assert_output --regexp '^Foobar v[0-9]+\.[0-9]+\.[0-9]$' +# } +# ``` +# +# On failure, the regular expression and the output are displayed. +# +# ``` +# -- regular expression does not match output -- +# regexp : ^Foobar v[0-9]+\.[0-9]+\.[0-9]$ +# output : Foobar 0.1.0 +# -- +# ``` +assert_output() { + local -i is_mode_partial=0 + local -i is_mode_regexp=0 + local -i is_mode_nonempty=0 + local -i use_stdin=0 + : "${output?}" + + # Handle options. + if (( $# == 0 )); then + is_mode_nonempty=1 + fi + + while (( $# > 0 )); do + case "$1" in + -p|--partial) is_mode_partial=1; shift ;; + -e|--regexp) is_mode_regexp=1; shift ;; + -|--stdin) use_stdin=1; shift ;; + --) shift; break ;; + *) break ;; + esac + done + + if (( is_mode_partial )) && (( is_mode_regexp )); then + echo "\`--partial' and \`--regexp' are mutually exclusive" \ + | batslib_decorate 'ERROR: assert_output' \ + | fail + return $? + fi + + # Arguments. + local expected + if (( use_stdin )); then + expected="$(cat -)" + else + expected="${1-}" + fi + + # Matching. + if (( is_mode_nonempty )); then + if [ -z "$output" ]; then + echo 'expected non-empty output, but output was empty' \ + | batslib_decorate 'no output' \ + | fail + fi + elif (( is_mode_regexp )); then + if [[ '' =~ $expected ]] || (( $? == 2 )); then + echo "Invalid extended regular expression: \`$expected'" \ + | batslib_decorate 'ERROR: assert_output' \ + | fail + elif ! [[ $output =~ $expected ]]; then + batslib_print_kv_single_or_multi 6 \ + 'regexp' "$expected" \ + 'output' "$output" \ + | batslib_decorate 'regular expression does not match output' \ + | fail + fi + elif (( is_mode_partial )); then + if [[ $output != *"$expected"* ]]; then + batslib_print_kv_single_or_multi 9 \ + 'substring' "$expected" \ + 'output' "$output" \ + | batslib_decorate 'output does not contain substring' \ + | fail + fi + else + if [[ $output != "$expected" ]]; then + batslib_print_kv_single_or_multi 8 \ + 'expected' "$expected" \ + 'actual' "$output" \ + | batslib_decorate 'output differs' \ + | fail + fi + fi +} diff --git a/tests/bats/bats-assert/src/assert_regex.bash b/tests/bats/bats-assert/src/assert_regex.bash new file mode 100644 index 0000000..17a7057 --- /dev/null +++ b/tests/bats/bats-assert/src/assert_regex.bash @@ -0,0 +1,56 @@ +# `assert_regex` +# +# This function is similar to `assert_equal` but uses pattern matching instead +# of equality, by wrapping `[[ value =~ pattern ]]`. +# +# Fail if the value (first parameter) does not match the pattern (second +# parameter). +# +# ```bash +# @test 'assert_regex()' { +# assert_regex 'what' 'x$' +# } +# ``` +# +# On failure, the value and the pattern are displayed. +# +# ``` +# -- values does not match regular expression -- +# value : what +# pattern : x$ +# -- +# ``` +# +# If the value is longer than one line then it is displayed in *multi-line* +# format. +# +# An error is displayed if the specified extended regular expression is invalid. +# +# For description of the matching behavior, refer to the documentation of the +# `=~` operator in the +# [Bash manual]: https://www.gnu.org/software/bash/manual/html_node/Conditional-Constructs.html. +# Note that the `BASH_REMATCH` array is available immediately after the +# assertion succeeds but is fragile, i.e. prone to being overwritten as a side +# effect of other actions. +assert_regex() { + local -r value="${1}" + local -r pattern="${2}" + + if [[ '' =~ ${pattern} ]]; (( ${?} == 2 )); then + echo "Invalid extended regular expression: \`${pattern}'" \ + | batslib_decorate 'ERROR: assert_regex' \ + | fail + elif ! [[ "${value}" =~ ${pattern} ]]; then + if shopt -p nocasematch &>/dev/null; then + local case_sensitive=insensitive + else + local case_sensitive=sensitive + fi + batslib_print_kv_single_or_multi 8 \ + 'value' "${value}" \ + 'pattern' "${pattern}" \ + 'case' "${case_sensitive}" \ + | batslib_decorate 'value does not match regular expression' \ + | fail + fi +} diff --git a/tests/bats/bats-assert/src/assert_success.bash b/tests/bats/bats-assert/src/assert_success.bash new file mode 100644 index 0000000..a8b2a38 --- /dev/null +++ b/tests/bats/bats-assert/src/assert_success.bash @@ -0,0 +1,44 @@ +# assert_success +# ============== +# +# Summary: Fail if `$status` is not 0. +# +# Usage: assert_success +# +# IO: +# STDERR - `$status` and `$output`, on failure +# Globals: +# status +# output +# Returns: +# 0 - if `$status' is 0 +# 1 - otherwise +# +# ```bash +# @test 'assert_success() status only' { +# run bash -c "echo 'Error!'; exit 1" +# assert_success +# } +# ``` +# +# On failure, `$status` and `$output` are displayed. +# +# ``` +# -- command failed -- +# status : 1 +# output : Error! +# -- +# ``` +assert_success() { + : "${output?}" + : "${status?}" + + if (( status != 0 )); then + { local -ir width=6 + batslib_print_kv_single "$width" 'status' "$status" + batslib_print_kv_single_or_multi "$width" 'output' "$output" + } \ + | batslib_decorate 'command failed' \ + | fail + fi +} diff --git a/tests/bats/bats-assert/src/refute.bash b/tests/bats/bats-assert/src/refute.bash new file mode 100644 index 0000000..e7c47da --- /dev/null +++ b/tests/bats/bats-assert/src/refute.bash @@ -0,0 +1,42 @@ +# refute +# ====== +# +# Summary: Fail if the given expression evaluates to true. +# +# Usage: refute +# +# Options: +# The expression to evaluate for falsiness. +# *__Note:__ The expression must be a simple command. +# [Compound commands](https://www.gnu.org/software/bash/manual/bash.html#Compound-Commands), +# such as `[[`, can be used only when executed with `bash -c`.* +# +# IO: +# STDERR - the successful expression, on failure +# Globals: +# none +# Returns: +# 0 - if expression evaluates to false +# 1 - otherwise +# +# ```bash +# @test 'refute()' { +# rm -f '/var/log/test.log' +# refute [ -e '/var/log/test.log' ] +# } +# ``` +# +# On failure, the successful expression is displayed. +# +# ``` +# -- assertion succeeded, but it was expected to fail -- +# expression : [ -e /var/log/test.log ] +# -- +# ``` +refute() { + if "$@"; then + batslib_print_kv_single 10 'expression' "$*" \ + | batslib_decorate 'assertion succeeded, but it was expected to fail' \ + | fail + fi +} diff --git a/tests/bats/bats-assert/src/refute_line.bash b/tests/bats/bats-assert/src/refute_line.bash new file mode 100644 index 0000000..689bea1 --- /dev/null +++ b/tests/bats/bats-assert/src/refute_line.bash @@ -0,0 +1,271 @@ +# refute_line +# =========== +# +# Summary: Fail if the unexpected line is found in the output (default) or at a specific line number. +# +# Usage: refute_line [-n index] [-p | -e] [--] +# +# Options: +# -n, --index Match the th line +# -p, --partial Match if `unexpected` is a substring of `$output` or line +# -e, --regexp Treat `unexpected` as an extended regular expression +# The unexpected line string, substring, or regular expression. +# +# IO: +# STDERR - details, on failure +# error message, on error +# Globals: +# output +# lines +# Returns: +# 0 - if match not found +# 1 - otherwise +# +# Similarly to `refute_output`, this function verifies that a command or function does not produce the unexpected output. +# (It is the logical complement of `assert_line`.) +# It checks that the unexpected line does not appear in the output (default) or at a specific line number. +# Matching can be literal (default), partial or regular expression. +# +# *__Warning:__ +# Due to a [bug in Bats][bats-93], empty lines are discarded from `${lines[@]}`, +# causing line indices to change and preventing testing for empty lines.* +# +# [bats-93]: https://github.com/sstephenson/bats/pull/93 +# +# ## Looking for a line in the output +# +# By default, the entire output is searched for the unexpected line. +# The assertion fails if the unexpected line is found in `${lines[@]}`. +# +# ```bash +# @test 'refute_line() looking for line' { +# run echo $'have-0\nwant\nhave-2' +# refute_line 'want' +# } +# ``` +# +# On failure, the unexpected line, the index of its first match and the output with the matching line highlighted are displayed. +# +# ``` +# -- line should not be in output -- +# line : want +# index : 1 +# output (3 lines): +# have-0 +# > want +# have-2 +# -- +# ``` +# +# ## Matching a specific line +# +# When the `--index ` option is used (`-n ` for short), the unexpected line is matched only against the line identified by the given index. +# The assertion fails if the unexpected line equals `${lines[]}`. +# +# ```bash +# @test 'refute_line() specific line' { +# run echo $'have-0\nwant-1\nhave-2' +# refute_line --index 1 'want-1' +# } +# ``` +# +# On failure, the index and the unexpected line are displayed. +# +# ``` +# -- line should differ -- +# index : 1 +# line : want-1 +# -- +# ``` +# +# ## Partial matching +# +# Partial matching can be enabled with the `--partial` option (`-p` for short). +# When used, a match fails if the unexpected *substring* is found in the matched line. +# +# ```bash +# @test 'refute_line() partial matching' { +# run echo $'have 1\nwant 2\nhave 3' +# refute_line --partial 'want' +# } +# ``` +# +# On failure, in addition to the details of literal matching, the substring is also displayed. +# When used with `--index ` the substring replaces the unexpected line. +# +# ``` +# -- no line should contain substring -- +# substring : want +# index : 1 +# output (3 lines): +# have 1 +# > want 2 +# have 3 +# -- +# ``` +# +# ## Regular expression matching +# +# Regular expression matching can be enabled with the `--regexp` option (`-e` for short). +# When used, a match fails if the *extended regular expression* matches the line being tested. +# +# *__Note__: +# As expected, the anchors `^` and `$` bind to the beginning and the end (respectively) of the matched line.* +# +# ```bash +# @test 'refute_line() regular expression matching' { +# run echo $'Foobar v0.1.0\nRelease date: 2015-11-29' +# refute_line --index 0 --regexp '^Foobar v[0-9]+\.[0-9]+\.[0-9]$' +# } +# ``` +# +# On failure, in addition to the details of literal matching, the regular expression is also displayed. +# When used with `--index ` the regular expression replaces the unexpected line. +# +# ``` +# -- regular expression should not match line -- +# index : 0 +# regexp : ^Foobar v[0-9]+\.[0-9]+\.[0-9]$ +# line : Foobar v0.1.0 +# -- +# ``` +# FIXME(ztombol): Display `${lines[@]}' instead of `$output'! +refute_line() { + local -i is_match_line=0 + local -i is_mode_partial=0 + local -i is_mode_regexp=0 + : "${lines?}" + + # Handle options. + while (( $# > 0 )); do + case "$1" in + -n|--index) + if (( $# < 2 )) || ! [[ $2 =~ ^-?([0-9]|[1-9][0-9]+)$ ]]; then + echo "\`--index' requires an integer argument: \`$2'" \ + | batslib_decorate 'ERROR: refute_line' \ + | fail + return $? + fi + is_match_line=1 + local -ri idx="$2" + shift 2 + ;; + -p|--partial) is_mode_partial=1; shift ;; + -e|--regexp) is_mode_regexp=1; shift ;; + --) shift; break ;; + *) break ;; + esac + done + + if (( is_mode_partial )) && (( is_mode_regexp )); then + echo "\`--partial' and \`--regexp' are mutually exclusive" \ + | batslib_decorate 'ERROR: refute_line' \ + | fail + return $? + fi + + # Arguments. + local -r unexpected="$1" + + if (( is_mode_regexp == 1 )) && [[ '' =~ $unexpected ]] || (( $? == 2 )); then + echo "Invalid extended regular expression: \`$unexpected'" \ + | batslib_decorate 'ERROR: refute_line' \ + | fail + return $? + fi + + # Matching. + if (( is_match_line )); then + # Specific line. + if (( is_mode_regexp )); then + if [[ ${lines[$idx]} =~ $unexpected ]]; then + batslib_print_kv_single 6 \ + 'index' "$idx" \ + 'regexp' "$unexpected" \ + 'line' "${lines[$idx]}" \ + | batslib_decorate 'regular expression should not match line' \ + | fail + fi + elif (( is_mode_partial )); then + if [[ ${lines[$idx]} == *"$unexpected"* ]]; then + batslib_print_kv_single 9 \ + 'index' "$idx" \ + 'substring' "$unexpected" \ + 'line' "${lines[$idx]}" \ + | batslib_decorate 'line should not contain substring' \ + | fail + fi + else + if [[ ${lines[$idx]} == "$unexpected" ]]; then + batslib_print_kv_single 5 \ + 'index' "$idx" \ + 'line' "${lines[$idx]}" \ + | batslib_decorate 'line should differ' \ + | fail + fi + fi + else + # Line contained in output. + if (( is_mode_regexp )); then + local -i idx + for (( idx = 0; idx < ${#lines[@]}; ++idx )); do + if [[ ${lines[$idx]} =~ $unexpected ]]; then + { local -ar single=( 'regexp' "$unexpected" 'index' "$idx" ) + local -a may_be_multi=( 'output' "$output" ) + local -ir width="$( batslib_get_max_single_line_key_width "${single[@]}" "${may_be_multi[@]}" )" + batslib_print_kv_single "$width" "${single[@]}" + if batslib_is_single_line "${may_be_multi[1]}"; then + batslib_print_kv_single "$width" "${may_be_multi[@]}" + else + may_be_multi[1]="$( printf '%s' "${may_be_multi[1]}" | batslib_prefix | batslib_mark '>' "$idx" )" + batslib_print_kv_multi "${may_be_multi[@]}" + fi + } \ + | batslib_decorate 'no line should match the regular expression' \ + | fail + return $? + fi + done + elif (( is_mode_partial )); then + local -i idx + for (( idx = 0; idx < ${#lines[@]}; ++idx )); do + if [[ ${lines[$idx]} == *"$unexpected"* ]]; then + { local -ar single=( 'substring' "$unexpected" 'index' "$idx" ) + local -a may_be_multi=( 'output' "$output" ) + local -ir width="$( batslib_get_max_single_line_key_width "${single[@]}" "${may_be_multi[@]}" )" + batslib_print_kv_single "$width" "${single[@]}" + if batslib_is_single_line "${may_be_multi[1]}"; then + batslib_print_kv_single "$width" "${may_be_multi[@]}" + else + may_be_multi[1]="$( printf '%s' "${may_be_multi[1]}" | batslib_prefix | batslib_mark '>' "$idx" )" + batslib_print_kv_multi "${may_be_multi[@]}" + fi + } \ + | batslib_decorate 'no line should contain substring' \ + | fail + return $? + fi + done + else + local -i idx + for (( idx = 0; idx < ${#lines[@]}; ++idx )); do + if [[ ${lines[$idx]} == "$unexpected" ]]; then + { local -ar single=( 'line' "$unexpected" 'index' "$idx" ) + local -a may_be_multi=( 'output' "$output" ) + local -ir width="$( batslib_get_max_single_line_key_width "${single[@]}" "${may_be_multi[@]}" )" + batslib_print_kv_single "$width" "${single[@]}" + if batslib_is_single_line "${may_be_multi[1]}"; then + batslib_print_kv_single "$width" "${may_be_multi[@]}" + else + may_be_multi[1]="$( printf '%s' "${may_be_multi[1]}" | batslib_prefix | batslib_mark '>' "$idx" )" + batslib_print_kv_multi "${may_be_multi[@]}" + fi + } \ + | batslib_decorate 'line should not be in output' \ + | fail + return $? + fi + done + fi + fi +} diff --git a/tests/bats/bats-assert/src/refute_output.bash b/tests/bats/bats-assert/src/refute_output.bash new file mode 100644 index 0000000..92d7e8f --- /dev/null +++ b/tests/bats/bats-assert/src/refute_output.bash @@ -0,0 +1,199 @@ +# refute_output +# ============= +# +# Summary: Fail if `$output' matches the unexpected output. +# +# Usage: refute_output [-p | -e] [- | [--] ] +# +# Options: +# -p, --partial Match if `unexpected` is a substring of `$output` +# -e, --regexp Treat `unexpected` as an extended regular expression +# -, --stdin Read `unexpected` value from STDIN +# The unexpected value, substring, or regular expression +# +# IO: +# STDIN - [=$1] unexpected output +# STDERR - details, on failure +# error message, on error +# Globals: +# output +# Returns: +# 0 - if output matches the unexpected value/partial/regexp +# 1 - otherwise +# +# This function verifies that a command or function does not produce the unexpected output. +# (It is the logical complement of `assert_output`.) +# Output matching can be literal (the default), partial or by regular expression. +# The unexpected output can be specified either by positional argument or read from STDIN by passing the `-`/`--stdin` flag. +# +# ## Literal matching +# +# By default, literal matching is performed. +# The assertion fails if `$output` equals the unexpected output. +# +# ```bash +# @test 'refute_output()' { +# run echo 'want' +# refute_output 'want' +# } +# +# @test 'refute_output() with pipe' { +# run echo 'hello' +# echo 'world' | refute_output - +# } +# +# @test 'refute_output() with herestring' { +# run echo 'hello' +# refute_output - <<< world +# } +# ``` +# +# On failure, the output is displayed. +# +# ``` +# -- output equals, but it was expected to differ -- +# output : want +# -- +# ``` +# +# ## Existence +# +# To assert that there is no output at all, omit the matching argument. +# +# ```bash +# @test 'refute_output()' { +# run foo --silent +# refute_output +# } +# ``` +# +# On failure, an error message is displayed. +# +# ``` +# -- unexpected output -- +# expected no output, but output was non-empty +# -- +# ``` +# +# ## Partial matching +# +# Partial matching can be enabled with the `--partial` option (`-p` for short). +# When used, the assertion fails if the unexpected _substring_ is found in `$output`. +# +# ```bash +# @test 'refute_output() partial matching' { +# run echo 'ERROR: no such file or directory' +# refute_output --partial 'ERROR' +# } +# ``` +# +# On failure, the substring and the output are displayed. +# +# ``` +# -- output should not contain substring -- +# substring : ERROR +# output : ERROR: no such file or directory +# -- +# ``` +# +# ## Regular expression matching +# +# Regular expression matching can be enabled with the `--regexp` option (`-e` for short). +# When used, the assertion fails if the *extended regular expression* matches `$output`. +# +# *__Note__: +# The anchors `^` and `$` bind to the beginning and the end (respectively) of the entire output; +# not individual lines.* +# +# ```bash +# @test 'refute_output() regular expression matching' { +# run echo 'Foobar v0.1.0' +# refute_output --regexp '^Foobar v[0-9]+\.[0-9]+\.[0-9]$' +# } +# ``` +# +# On failure, the regular expression and the output are displayed. +# +# ``` +# -- regular expression should not match output -- +# regexp : ^Foobar v[0-9]+\.[0-9]+\.[0-9]$ +# output : Foobar v0.1.0 +# -- +# ``` +refute_output() { + local -i is_mode_partial=0 + local -i is_mode_regexp=0 + local -i is_mode_empty=0 + local -i use_stdin=0 + : "${output?}" + + # Handle options. + if (( $# == 0 )); then + is_mode_empty=1 + fi + + while (( $# > 0 )); do + case "$1" in + -p|--partial) is_mode_partial=1; shift ;; + -e|--regexp) is_mode_regexp=1; shift ;; + -|--stdin) use_stdin=1; shift ;; + --) shift; break ;; + *) break ;; + esac + done + + if (( is_mode_partial )) && (( is_mode_regexp )); then + echo "\`--partial' and \`--regexp' are mutually exclusive" \ + | batslib_decorate 'ERROR: refute_output' \ + | fail + return $? + fi + + # Arguments. + local unexpected + if (( use_stdin )); then + unexpected="$(cat -)" + else + unexpected="${1-}" + fi + + if (( is_mode_regexp == 1 )) && [[ '' =~ $unexpected ]] || (( $? == 2 )); then + echo "Invalid extended regular expression: \`$unexpected'" \ + | batslib_decorate 'ERROR: refute_output' \ + | fail + return $? + fi + + # Matching. + if (( is_mode_empty )); then + if [ -n "$output" ]; then + batslib_print_kv_single_or_multi 6 \ + 'output' "$output" \ + | batslib_decorate 'output non-empty, but expected no output' \ + | fail + fi + elif (( is_mode_regexp )); then + if [[ $output =~ $unexpected ]]; then + batslib_print_kv_single_or_multi 6 \ + 'regexp' "$unexpected" \ + 'output' "$output" \ + | batslib_decorate 'regular expression should not match output' \ + | fail + fi + elif (( is_mode_partial )); then + if [[ $output == *"$unexpected"* ]]; then + batslib_print_kv_single_or_multi 9 \ + 'substring' "$unexpected" \ + 'output' "$output" \ + | batslib_decorate 'output should not contain substring' \ + | fail + fi + else + if [[ $output == "$unexpected" ]]; then + batslib_print_kv_single_or_multi 6 \ + 'output' "$output" \ + | batslib_decorate 'output equals, but it was expected to differ' \ + | fail + fi + fi +} diff --git a/tests/bats/bats-assert/src/refute_regex.bash b/tests/bats/bats-assert/src/refute_regex.bash new file mode 100644 index 0000000..0918793 --- /dev/null +++ b/tests/bats/bats-assert/src/refute_regex.bash @@ -0,0 +1,66 @@ +# `refute_regex` +# +# This function is similar to `refute_equal` but uses pattern matching instead +# of equality, by wrapping `! [[ value =~ pattern ]]`. +# +# Fail if the value (first parameter) matches the pattern (second parameter). +# +# ```bash +# @test 'refute_regex()' { +# refute_regex 'WhatsApp' 'Threema' +# } +# ``` +# +# On failure, the value, the pattern and the match are displayed. +# +# ``` +# @test 'refute_regex()' { +# refute_regex 'WhatsApp' 'What.' +# } +# +# -- value matches regular expression -- +# value : WhatsApp +# pattern : What. +# match : Whats +# case : sensitive +# -- +# ``` +# +# If the value or pattern is longer than one line then it is displayed in +# *multi-line* format. +# +# An error is displayed if the specified extended regular expression is invalid. +# +# For description of the matching behavior, refer to the documentation of the +# `=~` operator in the +# [Bash manual]: https://www.gnu.org/software/bash/manual/html_node/Conditional-Constructs.html. +# +# Note that the `BASH_REMATCH` array is available immediately after the +# assertion fails but is fragile, i.e. prone to being overwritten as a side +# effect of other actions like calling `run`. Thus, it's good practice to avoid +# using `BASH_REMATCH` in conjunction with `refute_regex()`. The valuable +# information the array contains is the matching part of the value which is +# printed in the failing test log, as mentioned above. +refute_regex() { + local -r value="${1}" + local -r pattern="${2}" + + if [[ '' =~ ${pattern} ]] || (( ${?} == 2 )); then + echo "Invalid extended regular expression: \`${pattern}'" \ + | batslib_decorate 'ERROR: refute_regex' \ + | fail + elif [[ "${value}" =~ ${pattern} ]]; then + if shopt -p nocasematch &>/dev/null; then + local case_sensitive=insensitive + else + local case_sensitive=sensitive + fi + batslib_print_kv_single_or_multi 8 \ + 'value' "${value}" \ + 'pattern' "${pattern}" \ + 'match' "${BASH_REMATCH[0]}" \ + 'case' "${case_sensitive}" \ + | batslib_decorate 'value matches regular expression' \ + | fail + fi +} diff --git a/tests/bats/bats-assert/test/assert.bats b/tests/bats/bats-assert/test/assert.bats new file mode 100755 index 0000000..d1a34a2 --- /dev/null +++ b/tests/bats/bats-assert/test/assert.bats @@ -0,0 +1,19 @@ +#!/usr/bin/env bats + +load test_helper + +@test 'assert() : returns 0 if evaluates to TRUE' { + run assert true + assert_test_pass +} + +@test 'assert() : returns 1 and displays if it evaluates to FALSE' { + run assert false + + assert_test_fail <<'ERR_MSG' + +-- assertion failed -- +expression : false +-- +ERR_MSG +} diff --git a/tests/bats/bats-assert/test/assert_equal.bats b/tests/bats/bats-assert/test/assert_equal.bats new file mode 100755 index 0000000..7d3fc86 --- /dev/null +++ b/tests/bats/bats-assert/test/assert_equal.bats @@ -0,0 +1,62 @@ +#!/usr/bin/env bats + +load test_helper + +@test 'assert_equal() : returns 0 if equals ' { + run assert_equal 'a' 'a' + assert_test_pass +} + +@test 'assert_equal() : returns 1 and displays details if does not equal ' { + run assert_equal 'a' 'b' + + assert_test_fail <<'ERR_MSG' + +-- values do not equal -- +expected : b +actual : a +-- +ERR_MSG +} + +@test 'assert_equal() : displays details in multi-line format if is longer than one line' { + run assert_equal $'a 0\na 1' 'b' + + assert_test_fail <<'ERR_MSG' + +-- values do not equal -- +expected (1 lines): + b +actual (2 lines): + a 0 + a 1 +-- +ERR_MSG +} + +@test 'assert_equal() : displays details in multi-line format if is longer than one line' { + run assert_equal 'a' $'b 0\nb 1' + + assert_test_fail <<'ERR_MSG' + +-- values do not equal -- +expected (2 lines): + b 0 + b 1 +actual (1 lines): + a +-- +ERR_MSG +} + +@test 'assert_equal() : performs literal matching' { + run assert_equal 'a' '*' + + assert_test_fail <<'ERR_MSG' + +-- values do not equal -- +expected : * +actual : a +-- +ERR_MSG +} diff --git a/tests/bats/bats-assert/test/assert_failure.bats b/tests/bats/bats-assert/test/assert_failure.bats new file mode 100755 index 0000000..6291afe --- /dev/null +++ b/tests/bats/bats-assert/test/assert_failure.bats @@ -0,0 +1,75 @@ +#!/usr/bin/env bats + +load test_helper + +@test "assert_failure(): returns 0 if \`\$status' is not 0" { + run false + run assert_failure + assert_test_pass +} + +@test "assert_failure(): returns 1 and displays details if \`\$status' is 0" { + run bash -c 'echo "a" + exit 0' + run assert_failure + + assert_test_fail <<'ERR_MSG' + +-- command succeeded, but it was expected to fail -- +output : a +-- +ERR_MSG +} + +@test "assert_failure(): displays \`\$output' in multi-line format if it is longer then one line" { + run bash -c 'printf "a 0\na 1" + exit 0' + run assert_failure + + assert_test_fail <<'ERR_MSG' + +-- command succeeded, but it was expected to fail -- +output (2 lines): + a 0 + a 1 +-- +ERR_MSG +} + +@test "assert_failure() : returns 0 if \`\$status' equals " { + run bash -c 'exit 1' + run assert_failure 1 + assert_test_pass +} + +@test "assert_failure() : returns 1 and displays details if \`\$status' does not equal " { + run bash -c 'echo "a" + exit 1' + run assert_failure 2 + + assert_test_fail <<'ERR_MSG' + +-- command failed as expected, but status differs -- +expected : 2 +actual : 1 +output : a +-- +ERR_MSG +} + +@test "assert_failure() : displays \`\$output' in multi-line format if it is longer then one line" { + run bash -c 'printf "a 0\na 1" + exit 1' + run assert_failure 2 + + assert_test_fail <<'ERR_MSG' + +-- command failed as expected, but status differs -- +expected : 2 +actual : 1 +output (2 lines): + a 0 + a 1 +-- +ERR_MSG +} diff --git a/tests/bats/bats-assert/test/assert_line.bats b/tests/bats/bats-assert/test/assert_line.bats new file mode 100755 index 0000000..151f688 --- /dev/null +++ b/tests/bats/bats-assert/test/assert_line.bats @@ -0,0 +1,351 @@ +#!/usr/bin/env bats + +load test_helper + + +############################################################################### +# Containing a line +############################################################################### + +# +# Literal matching +# + +# Correctness +@test "assert_line() : returns 0 if is a line in \`\${lines[@]}'" { + run printf 'a\nb\nc' + run assert_line 'b' + assert_test_pass +} + +@test "assert_line() : returns 1 and displays details if is not a line in \`\${lines[@]}'" { + run echo 'b' + run assert_line 'a' + + assert_test_fail <<'ERR_MSG' + +-- output does not contain line -- +line : a +output : b +-- +ERR_MSG +} + +# Output formatting +@test "assert_line() : displays \`\$output' in multi-line format if it is longer than one line" { + run printf 'b 0\nb 1' + run assert_line 'a' + + assert_test_fail <<'ERR_MSG' + +-- output does not contain line -- +line : a +output (2 lines): + b 0 + b 1 +-- +ERR_MSG +} + +# Options +@test 'assert_line() : performs literal matching by default' { + run echo 'a' + run assert_line '*' + + assert_test_fail <<'ERR_MSG' + +-- output does not contain line -- +line : * +output : a +-- +ERR_MSG +} + + +# +# Partial matching: `-p' and `--partial' +# + +# Options +@test 'assert_line() -p : enables partial matching' { + run printf 'a\n_b_\nc' + run assert_line -p 'b' + assert_test_pass +} + +@test 'assert_line() --partial : enables partial matching' { + run printf 'a\n_b_\nc' + run assert_line --partial 'b' + assert_test_pass +} + +# Correctness +@test "assert_line() --partial : returns 0 if is a substring in any line in \`\${lines[@]}'" { + run printf 'a\n_b_\nc' + run assert_line --partial 'b' + assert_test_pass +} + +@test "assert_line() --partial : returns 1 and displays details if is not a substring in any lines in \`\${lines[@]}'" { + run echo 'b' + run assert_line --partial 'a' + + assert_test_fail <<'ERR_MSG' + +-- no output line contains substring -- +substring : a +output : b +-- +ERR_MSG +} + +# Output formatting +@test "assert_line() --partial : displays \`\$output' in multi-line format if it is longer than one line" { + run printf 'b 0\nb 1' + run assert_line --partial 'a' + + assert_test_fail <<'ERR_MSG' + +-- no output line contains substring -- +substring : a +output (2 lines): + b 0 + b 1 +-- +ERR_MSG +} + + +# +# Regular expression matching: `-e' and `--regexp' +# + +# Options +@test 'assert_line() -e : enables regular expression matching' { + run printf 'a\n_b_\nc' + run assert_line -e '^.b' + assert_test_pass +} + +@test 'assert_line() --regexp : enables regular expression matching' { + run printf 'a\n_b_\nc' + run assert_line --regexp '^.b' + assert_test_pass +} + +# Correctness +@test "assert_line() --regexp : returns 0 if matches any line in \`\${lines[@]}'" { + run printf 'a\n_b_\nc' + run assert_line --regexp '^.b' + assert_test_pass +} + +@test "assert_line() --regexp : returns 1 and displays details if does not match any lines in \`\${lines[@]}'" { + run echo 'b' + run assert_line --regexp '^.a' + + assert_test_fail <<'ERR_MSG' + +-- no output line matches regular expression -- +regexp : ^.a +output : b +-- +ERR_MSG +} + +# Output formatting +@test "assert_line() --regexp : displays \`\$output' in multi-line format if longer than one line" { + run printf 'b 0\nb 1' + run assert_line --regexp '^.a' + + assert_test_fail <<'ERR_MSG' + +-- no output line matches regular expression -- +regexp : ^.a +output (2 lines): + b 0 + b 1 +-- +ERR_MSG +} + + +############################################################################### +# Matching single line: `-n' and `--index' +############################################################################### + +# Options +@test 'assert_line() -n : matches against the -th line only' { + run printf 'a\nb\nc' + run assert_line -n 1 'b' + assert_test_pass +} + +@test 'assert_line() --index : matches against the -th line only' { + run printf 'a\nb\nc' + run assert_line --index 1 'b' + assert_test_pass +} + +@test 'assert_line() --index : returns 1 and displays an error message if is not an integer' { + run assert_line --index 1a + + assert_test_fail <<'ERR_MSG' + +-- ERROR: assert_line -- +`--index' requires an integer argument: `1a' +-- +ERR_MSG +} + + +# +# Literal matching +# + +# Correctness +@test "assert_line() --index : returns 0 if equals \`\${lines[]}'" { + run printf 'a\nb\nc' + run assert_line --index 1 'b' + assert_test_pass +} + +@test "assert_line() --index : returns 1 and displays details if does not equal \`\${lines[]}'" { + run printf 'a\nb\nc' + run assert_line --index 1 'a' + + assert_test_fail <<'ERR_MSG' + +-- line differs -- +index : 1 +expected : a +actual : b +-- +ERR_MSG +} + +# Options +@test 'assert_line() --index : performs literal matching by default' { + run printf 'a\nb\nc' + run assert_line --index 1 '*' + + assert_test_fail <<'ERR_MSG' + +-- line differs -- +index : 1 +expected : * +actual : b +-- +ERR_MSG +} + + +# +# Partial matching: `-p' and `--partial' +# + +# Options +@test 'assert_line() --index -p : enables partial matching' { + run printf 'a\n_b_\nc' + run assert_line --index 1 -p 'b' + assert_test_pass +} + +@test 'assert_line() --index --partial : enables partial matching' { + run printf 'a\n_b_\nc' + run assert_line --index 1 --partial 'b' + assert_test_pass +} + +# Correctness +@test "assert_line() --index --partial : returns 0 if is a substring in \`\${lines[]}'" { + run printf 'a\n_b_\nc' + run assert_line --index 1 --partial 'b' + assert_test_pass +} + +@test "assert_line() --index --partial : returns 1 and displays details if is not a substring in \`\${lines[]}'" { + run printf 'b 0\nb 1' + run assert_line --index 1 --partial 'a' + + assert_test_fail <<'ERR_MSG' + +-- line does not contain substring -- +index : 1 +substring : a +line : b 1 +-- +ERR_MSG +} + + +# +# Regular expression matching: `-e' and `--regexp' +# + +# Options +@test 'assert_line() --index -e : enables regular expression matching' { + run printf 'a\n_b_\nc' + run assert_line --index 1 -e '^.b' + assert_test_pass +} + +@test 'assert_line() --index --regexp : enables regular expression matching' { + run printf 'a\n_b_\nc' + run assert_line --index 1 --regexp '^.b' + assert_test_pass +} + +# Correctness +@test "assert_line() --index --regexp : returns 0 if matches \`\${lines[]}'" { + run printf 'a\n_b_\nc' + run assert_line --index 1 --regexp '^.b' + assert_test_pass +} + +@test "assert_line() --index --regexp : returns 1 and displays details if does not match \`\${lines[]}'" { + run printf 'a\nb\nc' + run assert_line --index 1 --regexp '^.a' + + assert_test_fail <<'ERR_MSG' + +-- regular expression does not match line -- +index : 1 +regexp : ^.a +line : b +-- +ERR_MSG +} + + +############################################################################### +# Common +############################################################################### + +@test "assert_line(): \`--partial' and \`--regexp' are mutually exclusive" { + run assert_line --partial --regexp + + assert_test_fail <<'ERR_MSG' + +-- ERROR: assert_line -- +`--partial' and `--regexp' are mutually exclusive +-- +ERR_MSG +} + +@test 'assert_line() --regexp : returns 1 and displays an error message if is not a valid extended regular expression' { + run assert_line --regexp '[.*' + + assert_test_fail <<'ERR_MSG' + +-- ERROR: assert_line -- +Invalid extended regular expression: `[.*' +-- +ERR_MSG +} + +@test "assert_line(): \`--' stops parsing options" { + run printf 'a\n-p\nc' + run assert_line -- '-p' + assert_test_pass +} diff --git a/tests/bats/bats-assert/test/assert_not_equal.bats b/tests/bats/bats-assert/test/assert_not_equal.bats new file mode 100644 index 0000000..42b5315 --- /dev/null +++ b/tests/bats/bats-assert/test/assert_not_equal.bats @@ -0,0 +1,57 @@ +#!/usr/bin/env bats + +load test_helper + +@test 'assert_not_equal() : returns 0 if does not equal ' { + run assert_not_equal foo bar + assert_test_pass + + run assert_not_equal "foo" "bar" + assert_test_pass + + run assert_not_equal "foo" "" + assert_test_pass + + run assert_not_equal "" "foo" + assert_test_pass +} + +@test 'assert_not_equal() : returns 1 and displays details if equals ' { + run assert_not_equal 'foobar' 'foobar' + assert_test_fail <<'ERR_MSG' + +-- values should not be equal -- +unexpected : foobar +actual : foobar +-- +ERR_MSG + + run assert_not_equal 1 1 + assert_test_fail <<'ERR_MSG' + +-- values should not be equal -- +unexpected : 1 +actual : 1 +-- +ERR_MSG +} + +@test 'assert_not_equal() : displays details in multi-line format if and are longer than one line' { + run assert_not_equal $'foo\nbar' $'foo\nbar' + assert_test_fail <<'ERR_MSG' + +-- values should not be equal -- +unexpected (2 lines): + foo + bar +actual (2 lines): + foo + bar +-- +ERR_MSG +} + +@test 'assert_not_equal() : performs literal matching' { + run assert_not_equal 'a' '*' + assert_test_pass +} \ No newline at end of file diff --git a/tests/bats/bats-assert/test/assert_output.bats b/tests/bats/bats-assert/test/assert_output.bats new file mode 100755 index 0000000..e9609e0 --- /dev/null +++ b/tests/bats/bats-assert/test/assert_output.bats @@ -0,0 +1,285 @@ +#!/usr/bin/env bats + +load test_helper + +# +# Literal matching +# + +# Correctness +@test "assert_output() : returns 0 if equals \`\$output'" { + run echo 'a' + run assert_output 'a' + assert_test_pass +} + +@test "assert_output() : returns 1 and displays details if does not equal \`\$output'" { + run echo 'b' + run assert_output 'a' + + assert_test_fail <<'ERR_MSG' + +-- output differs -- +expected : a +actual : b +-- +ERR_MSG +} + +@test 'assert_output(): succeeds if output is non-empty' { + run echo 'a' + run assert_output + + assert_test_pass +} + +@test 'assert_output(): fails if output is empty' { + run echo '' + run assert_output + + assert_test_fail <<'ERR_MSG' + +-- no output -- +expected non-empty output, but output was empty +-- +ERR_MSG +} + +@test 'assert_output() - : reads from STDIN' { + run echo 'a' + run assert_output - < from STDIN' { + run echo 'a' + run assert_output --stdin <: displays details in multi-line format if \`\$output' is longer than one line" { + run printf 'b 0\nb 1' + run assert_output 'a' + + assert_test_fail <<'ERR_MSG' + +-- output differs -- +expected (1 lines): + a +actual (2 lines): + b 0 + b 1 +-- +ERR_MSG +} + +@test 'assert_output() : displays details in multi-line format if is longer than one line' { + run echo 'b' + run assert_output $'a 0\na 1' + + assert_test_fail <<'ERR_MSG' + +-- output differs -- +expected (2 lines): + a 0 + a 1 +actual (1 lines): + b +-- +ERR_MSG +} + +# Options +@test 'assert_output() : performs literal matching by default' { + run echo 'a' + run assert_output '*' + + assert_test_fail <<'ERR_MSG' + +-- output differs -- +expected : * +actual : a +-- +ERR_MSG +} + + +# +# Partial matching: `-p' and `--partial' +# + +@test 'assert_output() -p : enables partial matching' { + run echo 'abc' + run assert_output -p 'b' + assert_test_pass +} + +@test 'assert_output() --partial : enables partial matching' { + run echo 'abc' + run assert_output --partial 'b' + assert_test_pass +} + +# Correctness +@test "assert_output() --partial : returns 0 if is a substring in \`\$output'" { + run printf 'a\nb\nc' + run assert_output --partial 'b' + assert_test_pass +} + +@test "assert_output() --partial : returns 1 and displays details if is not a substring in \`\$output'" { + run echo 'b' + run assert_output --partial 'a' + + assert_test_fail <<'ERR_MSG' + +-- output does not contain substring -- +substring : a +output : b +-- +ERR_MSG +} + +# Output formatting +@test "assert_output() --partial : displays details in multi-line format if \`\$output' is longer than one line" { + run printf 'b 0\nb 1' + run assert_output --partial 'a' + + assert_test_fail <<'ERR_MSG' + +-- output does not contain substring -- +substring (1 lines): + a +output (2 lines): + b 0 + b 1 +-- +ERR_MSG +} + +@test 'assert_output() --partial : displays details in multi-line format if is longer than one line' { + run echo 'b' + run assert_output --partial $'a 0\na 1' + + assert_test_fail <<'ERR_MSG' + +-- output does not contain substring -- +substring (2 lines): + a 0 + a 1 +output (1 lines): + b +-- +ERR_MSG +} + + +# +# Regular expression matching: `-e' and `--regexp' +# + +@test 'assert_output() -e : enables regular expression matching' { + run echo 'abc' + run assert_output -e '^a' + assert_test_pass +} + +@test 'assert_output() --regexp : enables regular expression matching' { + run echo 'abc' + run assert_output --regexp '^a' + assert_test_pass +} + +# Correctness +@test "assert_output() --regexp : returns 0 if matches \`\$output'" { + run printf 'a\nb\nc' + run assert_output --regexp '.*b.*' + assert_test_pass +} + +@test "assert_output() --regexp : returns 1 and displays details if does not match \`\$output'" { + run echo 'b' + run assert_output --regexp '.*a.*' + + assert_test_fail <<'ERR_MSG' + +-- regular expression does not match output -- +regexp : .*a.* +output : b +-- +ERR_MSG +} + +# Output formatting +@test "assert_output() --regexp : displays details in multi-line format if \`\$output' is longer than one line" { + run printf 'b 0\nb 1' + run assert_output --regexp '.*a.*' + + assert_test_fail <<'ERR_MSG' + +-- regular expression does not match output -- +regexp (1 lines): + .*a.* +output (2 lines): + b 0 + b 1 +-- +ERR_MSG +} + +@test 'assert_output() --regexp : displays details in multi-line format if is longer than one line' { + run echo 'b' + run assert_output --regexp $'.*a\nb.*' + + assert_test_fail <<'ERR_MSG' + +-- regular expression does not match output -- +regexp (2 lines): + .*a + b.* +output (1 lines): + b +-- +ERR_MSG +} + +# Error handling +@test 'assert_output() --regexp : returns 1 and displays an error message if is not a valid extended regular expression' { + run assert_output --regexp '[.*' + + assert_test_fail <<'ERR_MSG' + +-- ERROR: assert_output -- +Invalid extended regular expression: `[.*' +-- +ERR_MSG +} + + +# +# Common +# + +@test "assert_output(): \`--partial' and \`--regexp' are mutually exclusive" { + run assert_output --partial --regexp + + assert_test_fail <<'ERR_MSG' + +-- ERROR: assert_output -- +`--partial' and `--regexp' are mutually exclusive +-- +ERR_MSG +} + +@test "assert_output(): \`--' stops parsing options" { + run echo '-p' + run assert_output -- '-p' + assert_test_pass +} diff --git a/tests/bats/bats-assert/test/assert_regex.bats b/tests/bats/bats-assert/test/assert_regex.bats new file mode 100644 index 0000000..0a9c902 --- /dev/null +++ b/tests/bats/bats-assert/test/assert_regex.bats @@ -0,0 +1,87 @@ +#!/usr/bin/env bats + +load test_helper + +# +# Literal matching +# + +# Correctness +@test "assert_regex() : succeeds if a substring matches extended regular expression " { + run assert_regex 'abc' '^[a-z]b[c-z]+' + assert_test_pass +} + +@test "assert_regex() : fails if no substring matches extended regular expression " { + run assert_regex 'bcd' '^[a-z]b[c-z]+' + assert_test_fail <<'ERR_MSG' + +-- value does not match regular expression -- +value : bcd +pattern : ^[a-z]b[c-z]+ +case : sensitive +-- +ERR_MSG +} + +@test "assert_regex() : provides results in BASH_REMATCH" { + unset -v BASH_REMATCH + + assert_regex 'abcd' 'b.d' + declare -p BASH_REMATCH + [ "${BASH_REMATCH[0]}" = 'bcd' ] +} + +@test "assert_regex() : matches case-insensitively when 'nocasematch' is set" { + shopt -s nocasematch + + assert_regex 'aBc' 'ABC' +} + +@test "assert_regex() : outputs multi-line nicely when it fails" { + run assert_regex $'bcd\n123' '^[a-z]b[c-z]+' + assert_test_fail <<'ERR_MSG' + +-- value does not match regular expression -- +value (2 lines): + bcd + 123 +pattern (1 lines): + ^[a-z]b[c-z]+ +case (1 lines): + sensitive +-- +ERR_MSG + + shopt -s nocasematch + run assert_regex $'bcd\n123' '^[a-z]b[c-z]+' + assert_test_fail <<'ERR_MSG' + +-- value does not match regular expression -- +value (2 lines): + bcd + 123 +pattern (1 lines): + ^[a-z]b[c-z]+ +case (1 lines): + insensitive +-- +ERR_MSG +} + +# Error handling +@test "assert_regex() : returns 1 and displays an error message if is not a valid extended regular expression" { + run assert_regex value '[.*' + + assert_test_fail <<'ERR_MSG' + +-- ERROR: assert_regex -- +Invalid extended regular expression: `[.*' +-- +ERR_MSG +} + +@test "assert_regex allows regex matching empty string (see #53)" { + run assert_regex any_value '.*' + assert_success +} diff --git a/tests/bats/bats-assert/test/assert_success.bats b/tests/bats/bats-assert/test/assert_success.bats new file mode 100755 index 0000000..66f5aa7 --- /dev/null +++ b/tests/bats/bats-assert/test/assert_success.bats @@ -0,0 +1,40 @@ +#!/usr/bin/env bats + +load test_helper + +@test "assert_success(): returns 0 if \`\$status' is 0" { + run true + run assert_success + + assert_test_pass +} + +@test "assert_success(): returns 1 and displays details if \`\$status' is not 0" { + run bash -c 'echo "a" + exit 1' + run assert_success + + assert_test_fail <<'ERR_MSG' + +-- command failed -- +status : 1 +output : a +-- +ERR_MSG +} + +@test "assert_success(): displays \`\$output' in multi-line format if it is longer than one line" { + run bash -c 'printf "a 0\na 1" + exit 1' + run assert_success + + assert_test_fail <<'ERR_MSG' + +-- command failed -- +status : 1 +output (2 lines): + a 0 + a 1 +-- +ERR_MSG +} diff --git a/tests/bats/bats-assert/test/refute.bats b/tests/bats/bats-assert/test/refute.bats new file mode 100755 index 0000000..f9e2737 --- /dev/null +++ b/tests/bats/bats-assert/test/refute.bats @@ -0,0 +1,18 @@ +#!/usr/bin/env bats + +load test_helper + +@test 'refute() : returns 0 if evaluates to FALSE' { + run refute false + assert_test_pass +} + +@test 'refute() : returns 1 and displays if it evaluates to TRUE' { + run refute true + assert_test_fail <<'ERR_MSG' + +-- assertion succeeded, but it was expected to fail -- +expression : true +-- +ERR_MSG +} diff --git a/tests/bats/bats-assert/test/refute_line.bats b/tests/bats/bats-assert/test/refute_line.bats new file mode 100755 index 0000000..fd6221c --- /dev/null +++ b/tests/bats/bats-assert/test/refute_line.bats @@ -0,0 +1,344 @@ +#!/usr/bin/env bats + +load test_helper + + +############################################################################### +# Containing a line +############################################################################### + +# +# Literal matching +# + +# Correctness +@test "refute_line() : returns 0 if is not a line in \`\${lines[@]}'" { + run printf 'a\nb\nc' + run refute_line 'd' + assert_test_pass +} + +@test "refute_line() : returns 1 and displays details if is not a line in \`\${lines[@]}'" { + run echo 'a' + run refute_line 'a' + + assert_test_fail <<'ERR_MSG' + +-- line should not be in output -- +line : a +index : 0 +output : a +-- +ERR_MSG +} + +# Output formatting +@test "refute_line() : displays \`\$output' in multi-line format if it is longer than one line" { + run printf 'a 0\na 1\na 2' + run refute_line 'a 1' + + assert_test_fail <<'ERR_MSG' + +-- line should not be in output -- +line : a 1 +index : 1 +output (3 lines): + a 0 +> a 1 + a 2 +-- +ERR_MSG +} + +# Options +@test 'refute_line() : performs literal matching by default' { + run echo 'a' + run refute_line '*' + assert_test_pass +} + + +# +# Partial matching: `-p' and `--partial' +# + +# Options +@test 'refute_line() -p : enables partial matching' { + run printf 'a\nb\nc' + run refute_line -p 'd' + assert_test_pass +} + +@test 'refute_line() --partial : enables partial matching' { + run printf 'a\nb\nc' + run refute_line --partial 'd' + assert_test_pass +} + +# Correctness +@test "refute_line() --partial : returns 0 if is not a substring in any line in \`\${lines[@]}'" { + run printf 'a\nb\nc' + run refute_line --partial 'd' + assert_test_pass +} + +@test "refute_line() --partial : returns 1 and displays details if is a substring in any line in \`\${lines[@]}'" { + run echo 'a' + run refute_line --partial 'a' + + assert_test_fail <<'ERR_MSG' + +-- no line should contain substring -- +substring : a +index : 0 +output : a +-- +ERR_MSG +} + +# Output formatting +@test "refute_line() --partial : displays \`\$output' in multi-line format if it is longer than one line" { + run printf 'a\nabc\nc' + run refute_line --partial 'b' + + assert_test_fail <<'ERR_MSG' + +-- no line should contain substring -- +substring : b +index : 1 +output (3 lines): + a +> abc + c +-- +ERR_MSG +} + + +# +# Regular expression matching: `-e' and `--regexp' +# + +# Options +@test 'refute_line() -e : enables regular expression matching' { + run printf 'a\nb\nc' + run refute_line -e '^.d' + assert_test_pass +} + +@test 'refute_line() --regexp : enables regular expression matching' { + run printf 'a\nb\nc' + run refute_line --regexp '^.d' + assert_test_pass +} + +# Correctness +@test "refute_line() --regexp : returns 0 if does not match any line in \`\${lines[@]}'" { + run printf 'a\nb\nc' + run refute_line --regexp '.*d.*' + assert_test_pass +} + +@test "refute_line() --regexp : returns 1 and displays details if matches any lines in \`\${lines[@]}'" { + run echo 'a' + run refute_line --regexp '.*a.*' + + assert_test_fail <<'ERR_MSG' + +-- no line should match the regular expression -- +regexp : .*a.* +index : 0 +output : a +-- +ERR_MSG +} + +# Output formatting +@test "refute_line() --regexp : displays \`\$output' in multi-line format if longer than one line" { + run printf 'a\nabc\nc' + run refute_line --regexp '.*b.*' + + assert_test_fail <<'ERR_MSG' + +-- no line should match the regular expression -- +regexp : .*b.* +index : 1 +output (3 lines): + a +> abc + c +-- +ERR_MSG +} + + +############################################################################### +# Matching single line: `-n' and `--index' +############################################################################### + +# Options +@test 'refute_line() -n : matches against the -th line only' { + run printf 'a\nb\nc' + run refute_line -n 1 'd' + assert_test_pass +} + +@test 'refute_line() --index : matches against the -th line only' { + run printf 'a\nb\nc' + run refute_line --index 1 'd' + assert_test_pass +} + +@test 'refute_line() --index : returns 1 and displays an error message if is not an integer' { + run refute_line --index 1a + + assert_test_fail <<'ERR_MSG' + +-- ERROR: refute_line -- +`--index' requires an integer argument: `1a' +-- +ERR_MSG +} + + +# +# Literal matching +# + +# Correctness +@test "refute_line() --index : returns 0 if does not equal \`\${lines[]}'" { + run printf 'a\nb\nc' + run refute_line --index 1 'd' + assert_test_pass +} + +@test "refute_line() --index : returns 1 and displays details if equals \`\${lines[]}'" { + run printf 'a\nb\nc' + run refute_line --index 1 'b' + + assert_test_fail <<'ERR_MSG' + +-- line should differ -- +index : 1 +line : b +-- +ERR_MSG +} + +# Options +@test 'refute_line() --index : performs literal matching by default' { + run printf 'a\nb\nc' + run refute_line --index 1 '*' + assert_test_pass +} + + +# +# Partial matching: `-p' and `--partial' +# + +# Options +@test 'refute_line() --index -p : enables partial matching' { + run printf 'a\nb\nc' + run refute_line --index 1 -p 'd' + assert_test_pass +} + +@test 'refute_line() --index --partial : enables partial matching' { + run printf 'a\nb\nc' + run refute_line --index 1 --partial 'd' + assert_test_pass +} + +# Correctness +@test "refute_line() --index --partial : returns 0 if is not a substring in \`\${lines[]}'" { + run printf 'a\nabc\nc' + run refute_line --index 1 --partial 'd' + assert_test_pass +} + +@test "refute_line() --index --partial : returns 1 and displays details if is a substring in \`\${lines[]}'" { + run printf 'a\nabc\nc' + run refute_line --index 1 --partial 'b' + + assert_test_fail <<'ERR_MSG' + +-- line should not contain substring -- +index : 1 +substring : b +line : abc +-- +ERR_MSG +} + + +# +# Regular expression matching: `-e' and `--regexp' +# + +# Options +@test 'refute_line() --index -e : enables regular expression matching' { + run printf 'a\nb\nc' + run refute_line --index 1 -e '^.b' + assert_test_pass +} + +@test 'refute_line() --index --regexp : enables regular expression matching' { + run printf 'a\nb\nc' + run refute_line --index 1 --regexp '^.b' + assert_test_pass +} + +# Correctness +@test "refute_line() --index --regexp : returns 0 if does not match \`\${lines[]}'" { + run printf 'a\nabc\nc' + run refute_line --index 1 --regexp '.*d.*' + assert_test_pass +} + +@test "refute_line() --index --regexp : returns 1 and displays details if matches \`\${lines[]}'" { + run printf 'a\nabc\nc' + run refute_line --index 1 --regexp '.*b.*' + + assert_test_fail <<'ERR_MSG' + +-- regular expression should not match line -- +index : 1 +regexp : .*b.* +line : abc +-- +ERR_MSG +} + + +############################################################################### +# Common +############################################################################### + +@test "refute_line(): \`--partial' and \`--regexp' are mutually exclusive" { + run refute_line --partial --regexp + + assert_test_fail <<'ERR_MSG' + +-- ERROR: refute_line -- +`--partial' and `--regexp' are mutually exclusive +-- +ERR_MSG +} + +@test 'refute_line() --regexp : returns 1 and displays an error message if is not a valid extended regular expression' { + run refute_line --regexp '[.*' + + assert_test_fail <<'ERR_MSG' + +-- ERROR: refute_line -- +Invalid extended regular expression: `[.*' +-- +ERR_MSG +} + +@test "refute_line(): \`--' stops parsing options" { + run printf 'a\n--\nc' + run refute_line -- '-p' + assert_test_pass +} diff --git a/tests/bats/bats-assert/test/refute_output.bats b/tests/bats/bats-assert/test/refute_output.bats new file mode 100755 index 0000000..9d8711d --- /dev/null +++ b/tests/bats/bats-assert/test/refute_output.bats @@ -0,0 +1,230 @@ +#!/usr/bin/env bats + +load test_helper + + +# +# Literal matching +# + +# Correctness +@test "refute_output() : returns 0 if does not equal \`\$output'" { + run echo 'b' + run refute_output 'a' + assert_test_pass +} + +@test "refute_output() : returns 1 and displays details if equals \`\$output'" { + run echo 'a' + run refute_output 'a' + + assert_test_fail <<'ERR_MSG' + +-- output equals, but it was expected to differ -- +output : a +-- +ERR_MSG +} + +@test 'refute_output(): succeeds if output is empty' { + run echo '' + run refute_output + + assert_test_pass +} + +@test 'refute_output(): fails if output is non-empty' { + run echo 'a' + run refute_output + + assert_test_fail <<'ERR_MSG' + +-- output non-empty, but expected no output -- +output : a +-- +ERR_MSG +} + +@test 'refute_output() - : reads from STDIN' { + run echo '-' + run refute_output - < from STDIN' { + run echo '--stdin' + run refute_output --stdin <: displays details in multi-line format if necessary' { + run printf 'a 0\na 1' + run refute_output $'a 0\na 1' + + assert_test_fail <<'ERR_MSG' + +-- output equals, but it was expected to differ -- +output (2 lines): + a 0 + a 1 +-- +ERR_MSG +} + +# Options +@test 'refute_output() : performs literal matching by default' { + run echo 'a' + run refute_output '*' + assert_test_pass +} + + +# +# Partial matching: `-p' and `--partial' +# + +# Options +@test 'refute_output() -p : enables partial matching' { + run echo 'abc' + run refute_output -p 'd' + assert_test_pass +} + +@test 'refute_output() --partial : enables partial matching' { + run echo 'abc' + run refute_output --partial 'd' + assert_test_pass +} + +# Correctness +@test "refute_output() --partial : returns 0 if is not a substring in \`\$output'" { + run printf 'a\nb\nc' + run refute_output --partial 'd' + assert_test_pass +} + +@test "refute_output() --partial : returns 1 and displays details if is a substring in \`\$output'" { + run echo 'a' + run refute_output --partial 'a' + + assert_test_fail <<'ERR_MSG' + +-- output should not contain substring -- +substring : a +output : a +-- +ERR_MSG +} + +# Output formatting +@test 'refute_output() --partial : displays details in multi-line format if necessary' { + run printf 'a 0\na 1' + run refute_output --partial 'a' + + assert_test_fail <<'ERR_MSG' + +-- output should not contain substring -- +substring (1 lines): + a +output (2 lines): + a 0 + a 1 +-- +ERR_MSG +} + + +# +# Regular expression matching: `-e' and `--regexp' +# + +# Options +@test 'refute_output() -e : enables regular expression matching' { + run echo 'abc' + run refute_output -e '^d' + assert_test_pass +} + +@test 'refute_output() --regexp : enables regular expression matching' { + run echo 'abc' + run refute_output --regexp '^d' + assert_test_pass +} + +# Correctness +@test "refute_output() --regexp : returns 0 if does not match \`\$output'" { + run printf 'a\nb\nc' + run refute_output --regexp '.*d.*' + assert_test_pass +} + +@test "refute_output() --regexp : returns 1 and displays details if matches \`\$output'" { + run echo 'a' + run refute_output --regexp '.*a.*' + + assert_test_fail <<'ERR_MSG' + +-- regular expression should not match output -- +regexp : .*a.* +output : a +-- +ERR_MSG +} + +# Output formatting +@test 'refute_output() --regexp : displays details in multi-line format if necessary' { + run printf 'a 0\na 1' + run refute_output --regexp '.*a.*' + + assert_test_fail <<'ERR_MSG' + +-- regular expression should not match output -- +regexp (1 lines): + .*a.* +output (2 lines): + a 0 + a 1 +-- +ERR_MSG +} + +# Error handling +@test 'refute_output() --regexp : returns 1 and displays an error message if is not a valid extended regular expression' { + run refute_output --regexp '[.*' + + assert_test_fail <<'ERR_MSG' + +-- ERROR: refute_output -- +Invalid extended regular expression: `[.*' +-- +ERR_MSG +} + + +# +# Common +# + +@test "refute_output(): \`--partial' and \`--regexp' are mutually exclusive" { + run refute_output --partial --regexp + + assert_test_fail <<'ERR_MSG' + +-- ERROR: refute_output -- +`--partial' and `--regexp' are mutually exclusive +-- +ERR_MSG +} + +@test "refute_output(): \`--' stops parsing options" { + run echo '--' + run refute_output -- '-p' + assert_test_pass +} diff --git a/tests/bats/bats-assert/test/refute_regex.bats b/tests/bats/bats-assert/test/refute_regex.bats new file mode 100644 index 0000000..c1fd1b2 --- /dev/null +++ b/tests/bats/bats-assert/test/refute_regex.bats @@ -0,0 +1,98 @@ +#!/usr/bin/env bats + +load test_helper + +# +# Literal matching +# + +# Correctness +@test "refute_regex() : fails if a substring matches extended regular expression " { + run refute_regex 'abc' '^[a-z]b' + assert_test_fail <<'ERR_MSG' + +-- value matches regular expression -- +value : abc +pattern : ^[a-z]b +match : ab +case : sensitive +-- +ERR_MSG +} + +@test "refute_regex() : succeeds if no substring matches extended regular expression " { + run refute_regex 'bcd' '^[a-z]b[c-z]+' + assert_test_pass +} + +@test "refute_regex() : provides results in BASH_REMATCH on failure" { + unset -v BASH_REMATCH + + refute_regex 'abcd' 'b.d' \ + || { + declare -p BASH_REMATCH && \ + [ "${BASH_REMATCH[0]}" = 'bcd' ] + } +} + +@test "refute_regex() : matches case-insensitively when 'nocasematch' is set" { + shopt -s nocasematch + + run refute_regex 'aBc' 'ABC' + assert_test_fail <<'ERR_MSG' + +-- value matches regular expression -- +value : aBc +pattern : ABC +match : aBc +case : insensitive +-- +ERR_MSG +} + +@test "refute_regex() : outputs multi-line nicely when it fails" { + run refute_regex $'abc\n123' '^[a-z]b[c-z]+' + assert_test_fail <<'ERR_MSG' + +-- value matches regular expression -- +value (2 lines): + abc + 123 +pattern (1 lines): + ^[a-z]b[c-z]+ +match (1 lines): + abc +case (1 lines): + sensitive +-- +ERR_MSG + + shopt -s nocasematch + run refute_regex $'aBc\n123' '^[a-z]b[c-z]+' + assert_test_fail <<'ERR_MSG' + +-- value matches regular expression -- +value (2 lines): + aBc + 123 +pattern (1 lines): + ^[a-z]b[c-z]+ +match (1 lines): + aBc +case (1 lines): + insensitive +-- +ERR_MSG +} + +# Error handling +@test "refute_regex() : returns 1 and displays an error message if is not a valid extended regular expression" { + run refute_regex value '[.*' + + assert_test_fail <<'ERR_MSG' + +-- ERROR: refute_regex -- +Invalid extended regular expression: `[.*' +-- +ERR_MSG +} diff --git a/tests/bats/bats-assert/test/test_helper.bash b/tests/bats/bats-assert/test/test_helper.bash new file mode 100644 index 0000000..8d476a8 --- /dev/null +++ b/tests/bats/bats-assert/test/test_helper.bash @@ -0,0 +1,28 @@ +# Load dependencies. +BATS_LIB_PATH=$PWD/node_modules:${BATS_LIB_PATH-} +bats_load_library 'bats-support' + +# Load library. +load '../load' + +# validate that bats-assert is safe to use under -u +set -u + +: "${status:=}" +: "${lines:=}" +: "${output:=}" + +assert_test_pass() { + test "$status" -eq 0 + test "${#lines[@]}" -eq 0 +} + +assert_test_fail() { + local err_msg="${1-$(cat -)}" + local num_lines + num_lines="$(printf '%s' "$err_msg" | wc -l)" + + test "$status" -eq 1 + test "${#lines[@]}" -eq "$num_lines" + test "$output" == "$err_msg" +} diff --git a/tests/bats/bats-core/.codespellrc b/tests/bats/bats-core/.codespellrc new file mode 100644 index 0000000..3564ae7 --- /dev/null +++ b/tests/bats/bats-core/.codespellrc @@ -0,0 +1,3 @@ +[codespell] +skip = .git,*.pdf,*.svg +ignore-words-list = dne diff --git a/tests/bats/bats-core/.devcontainer/Dockerfile b/tests/bats/bats-core/.devcontainer/Dockerfile new file mode 100644 index 0000000..2deb1d1 --- /dev/null +++ b/tests/bats/bats-core/.devcontainer/Dockerfile @@ -0,0 +1,17 @@ +ARG bashver=latest + +FROM bash:${bashver} + +# Install parallel and accept the citation notice (we aren't using this in a +# context where it make sense to cite GNU Parallel). +RUN echo "@edgecomm http://dl-cdn.alpinelinux.org/alpine/edge/community" >> /etc/apk/repositories && \ + apk update && \ + apk add --no-cache parallel ncurses shellcheck@edgecomm && \ + mkdir -p ~/.parallel && touch ~/.parallel/will-cite && \ + curl -sSfL https://github.com/shenwei356/rush/releases/download/v0.5.0/rush_linux_amd64.tar.gz | tar xzf - -C /usr/local/bin && \ + chmod +x /usr/local/bin/rush + +RUN ln -s /opt/bats/bin/bats /usr/sbin/bats +COPY . /opt/bats/ + +ENTRYPOINT ["bash", "/usr/sbin/bats"] diff --git a/tests/bats/bats-core/.devcontainer/devcontainer.json b/tests/bats/bats-core/.devcontainer/devcontainer.json new file mode 100644 index 0000000..2b81e3f --- /dev/null +++ b/tests/bats/bats-core/.devcontainer/devcontainer.json @@ -0,0 +1,5 @@ +{ + "name": "Bats core development environment", + "dockerFile": "Dockerfile", + "build": {"args": {"bashver": "4.3"}} +} \ No newline at end of file diff --git a/tests/bats/bats-core/.editorconfig b/tests/bats/bats-core/.editorconfig new file mode 100644 index 0000000..457107e --- /dev/null +++ b/tests/bats/bats-core/.editorconfig @@ -0,0 +1,35 @@ +root = true + +[*] +end_of_line = lf +indent_style = space +indent_size = 2 +insert_final_newline = true +max_line_length = 80 +trim_trailing_whitespace = true + +# The JSON files contain newlines inconsistently +[*.json] +indent_size = 2 +insert_final_newline = ignore + +# YAML +[*.{yml,yaml}] +indent_style = space +indent_size = 2 + +# Makefiles always use tabs for recipe indentation +[{Makefile,*.mak}] +indent_style = tab + +# Markdown +[*.{md,rmd,mkd,mkdn,mdwn,mdown,markdown,litcoffee}] +max_line_length = 80 +# tabs behave as if they were replaced by spaces with a tab stop of 4 characters +tab_width = 4 +# trailing spaces indicates word wrap +trim_trailing_spaces = false +trim_trailing_whitespace = false + +[test/fixtures/bats/*_no_shellcheck.bats] +ignore = true \ No newline at end of file diff --git a/tests/bats/bats-core/.gitattributes b/tests/bats/bats-core/.gitattributes new file mode 100755 index 0000000..20cad1f --- /dev/null +++ b/tests/bats/bats-core/.gitattributes @@ -0,0 +1,3 @@ +* text=auto +*.sh eol=lf +libexec/* eol=lf diff --git a/tests/bats/bats-core/.github/ISSUE_TEMPLATE/bug_report.md b/tests/bats/bats-core/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..fbf9cba --- /dev/null +++ b/tests/bats/bats-core/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: 'Priority: NeedsTriage, Type: Bug' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: + +1. Create example `file.bats` with following contents +2. run `bats --foo file.bats` +3. ... + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Environment (please complete the following information):** + - Bats version [e.g. 1.4.0 or commit hash if applicable] + - operating system (including version): [e.g. Linux (please name your distribution!), FreeBSD, MacOS] + - `bash --version`: [e.g. 5.1] + - Install method: [e.g. git submodule, distribution package manager, npm, homebrew, ...] + +**Additional context** +Add any other context about the problem here. diff --git a/tests/bats/bats-core/.github/ISSUE_TEMPLATE/feature_request.md b/tests/bats/bats-core/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..506b98b --- /dev/null +++ b/tests/bats/bats-core/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: 'Priority: NeedsTriage, Type: Enhancement' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context about the feature request here. diff --git a/tests/bats/bats-core/.github/dependabot.yml b/tests/bats/bats-core/.github/dependabot.yml new file mode 100644 index 0000000..15feb35 --- /dev/null +++ b/tests/bats/bats-core/.github/dependabot.yml @@ -0,0 +1,47 @@ +version: 2 +updates: + - package-ecosystem: docker + directory: /.devcontainer + schedule: + interval: daily + labels: + - docker + - devcontainer + - dependencies + - no changelog + + - package-ecosystem: github-actions + directory: / + schedule: + interval: daily + labels: + - github-actions + - dependencies + - no changelog + + - package-ecosystem: docker + directory: / + schedule: + interval: daily + labels: + - docker + - dependencies + - no changelog + + - package-ecosystem: pip + directory: /docs/source + schedule: + interval: daily + labels: + - pip + - dependencies + - no changelog + + - package-ecosystem: npm + directory: / + schedule: + interval: daily + labels: + - npm + - dependencies + - no changelog diff --git a/tests/bats/bats-core/.github/workflows/check_pr_label.sh b/tests/bats/bats-core/.github/workflows/check_pr_label.sh new file mode 100755 index 0000000..2ff5723 --- /dev/null +++ b/tests/bats/bats-core/.github/workflows/check_pr_label.sh @@ -0,0 +1,10 @@ +#!/usr/bin/bash + +get_pr_json() { + curl -s -H "Accept: application/vnd.github.v3+json" "https://api.github.com/repos/bats-core/bats-core/pulls/$1" +} + +PR_NUMBER="$1" +LABEL="$2" + +get_pr_json "$PR_NUMBER" | jq .labels[].name | grep "$LABEL" diff --git a/tests/bats/bats-core/.github/workflows/codespell.yml b/tests/bats/bats-core/.github/workflows/codespell.yml new file mode 100644 index 0000000..d9e6dd4 --- /dev/null +++ b/tests/bats/bats-core/.github/workflows/codespell.yml @@ -0,0 +1,22 @@ +--- +name: Codespell + +on: + push: + branches: [master] + pull_request: + branches: [master] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Codespell + uses: codespell-project/actions-codespell@94259cd8be02ad2903ba34a22d9c13de21a74461 # v2.0 diff --git a/tests/bats/bats-core/.github/workflows/dependency-review.yml b/tests/bats/bats-core/.github/workflows/dependency-review.yml new file mode 100644 index 0000000..375e9b3 --- /dev/null +++ b/tests/bats/bats-core/.github/workflows/dependency-review.yml @@ -0,0 +1,22 @@ +# Dependency Review Action +# +# This Action will scan dependency manifest files that change as part of a Pull Request, +# surfacing known-vulnerable versions of the packages declared or updated in the PR. +# Once installed, if the workflow run is marked as required, +# PRs introducing known-vulnerable packages will be blocked from merging. +# +# Source repository: https://github.com/actions/dependency-review-action +name: 'Dependency Review' +on: [pull_request] + +permissions: + contents: read + +jobs: + dependency-review: + runs-on: ubuntu-latest + steps: + - name: 'Checkout Repository' + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: 'Dependency Review' + uses: actions/dependency-review-action@0fa40c3c10055986a88de3baa0d6ec17c5a894b3 # v4.2.3 diff --git a/tests/bats/bats-core/.github/workflows/release.yml b/tests/bats/bats-core/.github/workflows/release.yml new file mode 100644 index 0000000..28b0eec --- /dev/null +++ b/tests/bats/bats-core/.github/workflows/release.yml @@ -0,0 +1,35 @@ +name: Release + +on: + release: { types: [published] } + workflow_dispatch: + +permissions: + contents: read + +jobs: + npmjs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + with: + registry-url: "https://registry.npmjs.org" + - run: npm publish --ignore-scripts + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} + + github-npm: + runs-on: ubuntu-latest + permissions: + packages: write + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + with: + registry-url: "https://npm.pkg.github.com" + - name: scope package name as required by GitHub Packages + run: npm init -y --scope ${{ github.repository_owner }} + - run: npm publish --ignore-scripts + env: + NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/tests/bats/bats-core/.github/workflows/release_dockerhub.yml b/tests/bats/bats-core/.github/workflows/release_dockerhub.yml new file mode 100644 index 0000000..9feec62 --- /dev/null +++ b/tests/bats/bats-core/.github/workflows/release_dockerhub.yml @@ -0,0 +1,59 @@ +name: Release to docker hub + +on: + release: { types: [published] } + workflow_dispatch: + inputs: + version: + description: 'Version to simulate for deploy' + required: true + +permissions: + contents: read + +jobs: + dockerhub: + runs-on: ubuntu-latest + permissions: + packages: write + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + + - id: version + run: | + EXPECTED_VERSION=${{ github.event.inputs.version }} + TAG_VERSION=${GITHUB_REF#refs/tags/v} # refs/tags/v1.2.3 -> 1.2.3 + echo ::set-output name=version::${EXPECTED_VERSION:-$TAG_VERSION} + - name: Set up QEMU + uses: docker/setup-qemu-action@68827325e0b33c7199eb31dd4e31fbe9023e06e3 # v3.0.0 + + + - name: Login to DockerHub + uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d # v3.0.0 + with: + username: ${{ secrets.DOCKER_USERNAME }} + password: ${{ secrets.DOCKER_PASSWORD }} + + - name: Log in to the GitHub Container registry + uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Set up Docker Buildx + id: buildx + uses: docker/setup-buildx-action@2b51285047da1547ffb1b2203d8be4c0af6b1f20 # v3.2.0 + + - uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56 # v5.1.0 + with: + platforms: linux/amd64,linux/arm64,linux/ppc64le,linux/s390x,linux/386,linux/arm/v7,linux/arm/v6 + tags: ${{ secrets.DOCKER_USERNAME }}/bats:${{ steps.version.outputs.version }},${{ secrets.DOCKER_USERNAME }}/bats:latest + push: true + + - uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56 # v5.1.0 + with: + platforms: linux/amd64,linux/arm64,linux/ppc64le,linux/s390x,linux/386,linux/arm/v7,linux/arm/v6 + tags: ${{ secrets.DOCKER_USERNAME }}/bats:${{ steps.version.outputs.version }}-no-faccessat2,${{ secrets.DOCKER_USERNAME }}/bats:latest-no-faccessat2 + push: true + build-args: bashver=5.1.4 diff --git a/tests/bats/bats-core/.github/workflows/scorecard.yml b/tests/bats/bats-core/.github/workflows/scorecard.yml new file mode 100644 index 0000000..e96ea07 --- /dev/null +++ b/tests/bats/bats-core/.github/workflows/scorecard.yml @@ -0,0 +1,72 @@ +# This workflow uses actions that are not certified by GitHub. They are provided +# by a third-party and are governed by separate terms of service, privacy +# policy, and support documentation. + +name: Scorecard supply-chain security +on: + # For Branch-Protection check. Only the default branch is supported. See + # https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection + branch_protection_rule: + # To guarantee Maintained check is occasionally updated. See + # https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained + schedule: + - cron: '44 10 * * 6' + push: + branches: [ "master" ] + +# Declare default permissions as read only. +permissions: read-all + +jobs: + analysis: + name: Scorecard analysis + runs-on: ubuntu-latest + permissions: + # Needed to upload the results to code-scanning dashboard. + security-events: write + # Needed to publish results and get a badge (see publish_results below). + id-token: write + # Uncomment the permissions below if installing in a private repository. + # contents: read + # actions: read + + steps: + - name: "Checkout code" + uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + with: + persist-credentials: false + + - name: "Run analysis" + uses: ossf/scorecard-action@0864cf19026789058feabb7e87baa5f140aac736 # v2.3.1 + with: + results_file: results.sarif + results_format: sarif + # (Optional) "write" PAT token. Uncomment the `repo_token` line below if: + # - you want to enable the Branch-Protection check on a *public* repository, or + # - you are installing Scorecard on a *private* repository + # To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat. + # repo_token: ${{ secrets.SCORECARD_TOKEN }} + + # Public repositories: + # - Publish results to OpenSSF REST API for easy access by consumers + # - Allows the repository to include the Scorecard badge. + # - See https://github.com/ossf/scorecard-action#publishing-results. + # For private repositories: + # - `publish_results` will always be set to `false`, regardless + # of the value entered here. + publish_results: true + + # Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF + # format to the repository Actions tab. + - name: "Upload artifact" + uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0 + with: + name: SARIF file + path: results.sarif + retention-days: 5 + + # Upload the results to GitHub's code scanning dashboard. + - name: "Upload to code-scanning" + uses: github/codeql-action/upload-sarif@1b1aada464948af03b950897e5eb522f92603cc2 # v3.24.9 + with: + sarif_file: results.sarif diff --git a/tests/bats/bats-core/.github/workflows/set_nounset.bash b/tests/bats/bats-core/.github/workflows/set_nounset.bash new file mode 100644 index 0000000..8925c2d --- /dev/null +++ b/tests/bats/bats-core/.github/workflows/set_nounset.bash @@ -0,0 +1 @@ +set -u diff --git a/tests/bats/bats-core/.github/workflows/tests.yml b/tests/bats/bats-core/.github/workflows/tests.yml new file mode 100644 index 0000000..5e8f164 --- /dev/null +++ b/tests/bats/bats-core/.github/workflows/tests.yml @@ -0,0 +1,333 @@ +name: Tests + +# Controls when the action will run. +on: [push, pull_request, workflow_dispatch] + +permissions: + contents: read + +jobs: + changelog: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Check that PR is mentioned in Changelog + run: | + if ! ./.github/workflows/check_pr_label.sh "${{github.event.pull_request.number}}" "no changelog"; then + grep "#${{github.event.pull_request.number}}" docs/CHANGELOG.md + fi + if: ${{github.event.pull_request}} + + shfmt: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - run: | + curl https://github.com/mvdan/sh/releases/download/v3.5.1/shfmt_v3.5.1_linux_amd64 -o shfmt + chmod a+x shfmt + - run: ./shfmt --diff . + + # Ensure we detect when a change disables Bats from reporting failure. + # This would not be detectable by Bats' selftests. + failsafe: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v4 + - name: Check failing tests fail suite, + run: "! bin/bats test/fixtures/bats/failing.bats" + + shellcheck: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Run shellcheck + run: | + sudo apt-get update -y + sudo apt-get install shellcheck + ./shellcheck.sh + + linux: + strategy: + matrix: + os: ['ubuntu-20.04', 'ubuntu-22.04'] + env_vars: + - '' + # allow for some parallelity without GNU parallel, since it is not installed by default + - 'BATS_NO_PARALLELIZE_ACROSS_FILES=1 BATS_NUMBER_OF_PARALLEL_JOBS=2' + - 'BATS_PARALLEL_BINARY_NAME=rush' + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Install rush + run: | + curl -sSfL https://github.com/shenwei356/rush/releases/download/v0.5.0/rush_linux_amd64.tar.gz | sudo tar xzf - -C /usr/local/bin + if: contains(matrix.env_vars, 'rush') + - name: Run test on OS ${{ matrix.os }} + shell: 'script -q -e -c "bash {0}"' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + run: | + bash --version + bash -c "time ${{ matrix.env_vars }} bin/bats --print-output-on-failure --formatter tap test" + + unset_variables: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Check unset variables + shell: 'script -q -e -c "bash {0}"' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + BASH_ENV: ${GITHUB_WORKSPACE}/.github/workflows/set_nounset.bash + run: bin/bats test --print-output-on-failure + + npm_on_linux: + strategy: + matrix: + os: ['ubuntu-20.04', 'ubuntu-22.04'] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + - name: Run test on OS ${{ matrix.os }} + shell: 'script -q -e -c "bash {0}"' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + run: | + npm pack ./ + sudo npm install -g ./bats-*.tgz + bats test --print-output-on-failure + + windows: + runs-on: windows-2019 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Check failing tests fail suite, + run: bash -c "! bin/bats test/fixtures/bats/failing.bats" + - run: | + bash --version + bash -c "time bin/bats --print-output-on-failure --formatter tap test" + + npm_on_windows: + strategy: + matrix: + os: ['windows-2019'] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + - run: npm pack ./ + - run: npm install -g (get-item .\bats-*.tgz).FullName + - run: bats -T --print-output-on-failure test + + macos: + strategy: + matrix: + os: ['macos-11', 'macos-12'] + env_vars: + - '' + # allow for some parallelity without GNU parallel, since it is not installed by default + - 'BATS_NO_PARALLELIZE_ACROSS_FILES=1 BATS_NUMBER_OF_PARALLEL_JOBS=2' + - 'BATS_PARALLEL_BINARY_NAME=rush' + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Install unbuffer via expect + run: brew install expect + - name: Install rush + run: | + curl -sSfL https://github.com/shenwei356/rush/releases/download/v0.5.0/rush_darwin_amd64.tar.gz | sudo tar xzf - -C /usr/local/bin + if: contains(matrix.env_vars, 'rush') + + - name: Check failing tests fail suite, + shell: 'unbuffer bash {0}' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + run: bash -c '! bin/bats test/fixtures/bats/failing.bats' + + - name: Run test on OS ${{ matrix.os }} + shell: 'unbuffer bash {0}' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + run: | + bash --version + bash -c "time ${{ matrix.env_vars }} bin/bats --print-output-on-failure --formatter tap test" + + npm_on_macos: + strategy: + matrix: + os: ['macos-11', 'macos-12'] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 + - name: Install unbuffer via expect + run: brew install expect + - name: Run test on OS ${{ matrix.os }} + shell: 'unbuffer bash {0}' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + run: | + npm pack ./ + # somehow there is already an installed bats version around + npm install --force -g ./bats-*.tgz + bats --print-output-on-failure test + + bash-version: + strategy: + matrix: + version: ['3.2', '4.0', '4.1', '4.2', '4.3', '4.4', '4', '5.0', '5.1', '5', 'rc'] + env_vars: + - '' + # also test running (recursively!) in parallel + - '-e BATS_NUMBER_OF_PARALLEL_JOBS=2' + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Run test on bash version ${{ matrix.version }} + shell: 'script -q -e -c "bash {0}"' # work around tty issues + run: | + set -e + docker build --build-arg bashver="${{ matrix.version }}" --tag "bats/bats:bash-${{ matrix.version }}" . + docker run -it "bash:${{ matrix.version }}" --version + time docker run -it ${{ matrix.env_vars }} "bats/bats:bash-${{ matrix.version }}" --print-output-on-failure --tap /opt/bats/test + + alpine: + runs-on: ubuntu-latest + container: alpine:latest + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - name: Install dependencies + run: apk add bash ncurses util-linux + - name: Run test on bash version ${{ matrix.version }} + shell: 'script -q -e -c "bash {0}"' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + run: + time ./bin/bats --print-output-on-failure test/ + + freebsd: + runs-on: ubuntu-latest + strategy: + matrix: + packages: + - flock + - "" + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - uses: vmactions/freebsd-vm@35a5b20a98476a681c7576a344775be7e7f77f06 # v1.0.6 + with: + prepare: pkg install -y bash parallel ${{ matrix.packages }} + run: | + time ./bin/bats --print-output-on-failure test/ + + find_broken_symlinks: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + # list symlinks that are broken and force non-zero exit if there are any + - run: "! find . -xtype l | grep ." + + rpm: + runs-on: ubuntu-latest + container: almalinux:8 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - run: dnf install -y rpm-build rpmdevtools + - name: Build and install RPM and dependencies + run: | + rpmdev-setuptree + version=$(rpmspec -q --qf '%{version}' contrib/rpm/bats.spec) + tar --transform "s,^,bats-core-${version}/," -cf /github/home/rpmbuild/SOURCES/v${version}.tar.gz ./ + rpmbuild -v -bb ./contrib/rpm/bats.spec + ls -al /github/home/rpmbuild/RPMS/noarch/ + dnf install -y /github/home/rpmbuild/RPMS/noarch/bats-*.rpm + dnf -y install procps-ng # avoid timeout failure + - name: Run tests + shell: 'script -q -e -c "bash {0}"' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + run: bats --print-output-on-failure --filter-tags !dep:install_sh test/ + + dockerfile: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + + - name: Set up Docker Buildx + id: buildx + uses: docker/setup-buildx-action@2b51285047da1547ffb1b2203d8be4c0af6b1f20 # v3.2.0 + + - uses: docker/build-push-action@4a13e500e55cf31b7a5d59a38ab2040ab0f42f56 # v5.1.0 + with: + platforms: linux/amd64 + tags: bats:test + load: true + + - run: docker run -itv "$PWD":/code bats:test --tap --print-output-on-failure test/ + shell: 'script -q -e -c "bash {0}"' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + with: + repository: bats-core/bats-assert + path: bats-assert + + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + with: + repository: bats-core/bats-support + path: bats-support + + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + with: + repository: bats-core/bats-file + path: bats-file + + - run: | + <test.sh + apk add sudo python3 # install bats-file's dependencies + ln -sf python3 /usr/bin/python # bats-file uses python without version + bats --tap --print-output-on-failure bats-*/test/ + EOF + docker run -itv "$PWD":/code --entrypoint bash bats:test test.sh + shell: 'script -q -e -c "bash {0}"' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + + coverage: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 + - run: | + wget https://github.com/SimonKagstrom/kcov/releases/download/v40/kcov-amd64.tar.gz + tar -xf kcov-amd64.tar.gz + - run: | + ./usr/local/bin/kcov --exclude-path=/tmp $PWD/coverage ./bin/bats --filter-tags '!no-kcov' test/ + shell: 'script -q -e -c "bash {0}"' # work around tty issues + env: + TERM: linux # fix tput for tty issue work around + + - name: Archive code coverage results + uses: actions/upload-artifact@26f96dfa697d77e81fd5907df203aa23a56210a8 # v4.3.0 + with: + name: code-coverage-report + path: coverage/* + + - name: Print the Total Coverage + id: coverage-percent + shell: bash + env: + minimum_coverage: 86.40 + run: | + value=$(jq '.percent_covered' + int=${1%.*} + decimals=${1#*.} + echo $int${decimals::2} + } + echo "Coverage: $value%" | tee "$GITHUB_STEP_SUMMARY" + if (( $(fixed_point $value) < $(fixed_point $expected) )); then + echo " is below required minimum coverage ($minimum_coverage%)." | tee -a "$GITHUB_STEP_SUMMARY" + exit 1 + fi diff --git a/tests/bats/bats-core/.gitignore b/tests/bats/bats-core/.gitignore new file mode 100644 index 0000000..9895e9f --- /dev/null +++ b/tests/bats/bats-core/.gitignore @@ -0,0 +1,10 @@ +/docker-compose.override.yml +/docs/build + +# npm +/bats-*.tgz +# we don't have any deps; un-ignore if that changes +/package-lock.json +test/.bats/run-logs/ +# scratch file that should never be committed +/test.bats \ No newline at end of file diff --git a/tests/bats/bats-core/.pre-commit-config.yaml b/tests/bats/bats-core/.pre-commit-config.yaml new file mode 100644 index 0000000..d8562a4 --- /dev/null +++ b/tests/bats/bats-core/.pre-commit-config.yaml @@ -0,0 +1,14 @@ +repos: +- repo: https://github.com/gitleaks/gitleaks + rev: v8.16.3 + hooks: + - id: gitleaks +- repo: https://github.com/jumanjihouse/pre-commit-hooks + rev: 3.0.0 + hooks: + - id: shellcheck +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.4.0 + hooks: + - id: end-of-file-fixer + - id: trailing-whitespace diff --git a/tests/bats/bats-core/.readthedocs.yml b/tests/bats/bats-core/.readthedocs.yml new file mode 100644 index 0000000..e111967 --- /dev/null +++ b/tests/bats/bats-core/.readthedocs.yml @@ -0,0 +1,13 @@ +version: 2 + +sphinx: + configuration: docs/source/conf.py + +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +python: + install: + - requirements: docs/source/requirements.txt diff --git a/tests/bats/bats-core/AUTHORS b/tests/bats/bats-core/AUTHORS new file mode 100644 index 0000000..71df331 --- /dev/null +++ b/tests/bats/bats-core/AUTHORS @@ -0,0 +1,4 @@ +Andrew Martin (https://control-plane.io/) +Bianca Tamayo (https://biancatamayo.me/) +Jason Karns (http://jasonkarns.com/) +Mike Bland (https://mike-bland.com/) diff --git a/tests/bats/bats-core/Dockerfile b/tests/bats/bats-core/Dockerfile new file mode 100644 index 0000000..c4ac2db --- /dev/null +++ b/tests/bats/bats-core/Dockerfile @@ -0,0 +1,43 @@ +ARG bashver=latest + +FROM bash:${bashver} +ARG TINI_VERSION=v0.19.0 +ARG TARGETPLATFORM +ARG LIBS_VER_SUPPORT=0.3.0 +ARG LIBS_VER_FILE=0.4.0 +ARG LIBS_VER_ASSERT=2.1.0 +ARG LIBS_VER_DETIK=1.3.0 +ARG UID=1001 +ARG GID=115 + + +# https://github.com/opencontainers/image-spec/blob/main/annotations.md +LABEL maintainer="Bats-core Team" +LABEL org.opencontainers.image.authors="Bats-core Team" +LABEL org.opencontainers.image.title="Bats" +LABEL org.opencontainers.image.description="Bash Automated Testing System" +LABEL org.opencontainers.image.url="https://hub.docker.com/r/bats/bats" +LABEL org.opencontainers.image.source="https://github.com/bats-core/bats-core" +LABEL org.opencontainers.image.base.name="docker.io/bash" + +COPY ./docker /tmp/docker +# default to amd64 when not running in buildx environment that provides target platform +RUN /tmp/docker/install_tini.sh "${TARGETPLATFORM-linux/amd64}" +# Install bats libs +RUN /tmp/docker/install_libs.sh support ${LIBS_VER_SUPPORT} +RUN /tmp/docker/install_libs.sh file ${LIBS_VER_FILE} +RUN /tmp/docker/install_libs.sh assert ${LIBS_VER_ASSERT} +RUN /tmp/docker/install_libs.sh detik ${LIBS_VER_DETIK} + +# Install parallel and accept the citation notice (we aren't using this in a +# context where it make sense to cite GNU Parallel). +RUN apk add --no-cache parallel ncurses && \ + mkdir -p ~/.parallel && touch ~/.parallel/will-cite \ + && mkdir /code + +RUN ln -s /opt/bats/bin/bats /usr/local/bin/bats +COPY . /opt/bats/ + +WORKDIR /code/ + +ENTRYPOINT ["/tini", "--", "bash", "bats"] diff --git a/tests/bats/bats-core/LICENSE.md b/tests/bats/bats-core/LICENSE.md new file mode 100644 index 0000000..0c74299 --- /dev/null +++ b/tests/bats/bats-core/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 diff --git a/tests/bats/bats-core/README.md b/tests/bats/bats-core/README.md new file mode 100644 index 0000000..4ccc248 --- /dev/null +++ b/tests/bats/bats-core/README.md @@ -0,0 +1,135 @@ +[![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) + +[![Join the chat in bats-core/bats-core on gitter](https://badges.gitter.im/bats-core/bats-core.svg)][gitter] + +
+ + + + +
+ +# 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 + +@test "addition using bc" { + result="$(echo 2+2 | bc)" + [ "$result" -eq 4 ] +} + +@test "addition using dc" { + result="$(echo 2 2+p | dc)" + [ "$result" -eq 4 ] +} +``` + +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. + +## Table of contents + +**NOTE** The documentation has moved to + + + +- [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) + + + +## Testing + +```sh +bin/bats --tap test +``` + +See also the [CI](./.github/workflows/tests.yml) settings for the current test environment and +scripts. + +## Support + +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. + +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. + +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. + +## Contributing + +For now see the [`docs`](docs) folder for project guides, work with us on the wiki +or look at the other communication channels. + +## Contact + +- You can find and chat with us on our [Gitter]. + +## Version history + +See `docs/CHANGELOG.md`. + +## Background + + +### Why was this fork created? + + +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. + +**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`. + +As of **Thursday, April 29, 2021:** the original [Bats][bats-orig] has been +archived by the owner and is now read-only. + +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 + +## Copyright + +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). + +© 2017-2024 bats-core organization + +© 2011-2016 Sam Stephenson + +Bats is released under an MIT-style license; see `LICENSE.md` for details. + +See the [parent project](https://github.com/bats-core) at GitHub or the +[AUTHORS](AUTHORS) file for the current project maintainer team. + +[gitter]: https://gitter.im/bats-core/bats-core diff --git a/tests/bats/bats-core/SECURITY.md b/tests/bats/bats-core/SECURITY.md new file mode 100644 index 0000000..a716344 --- /dev/null +++ b/tests/bats/bats-core/SECURITY.md @@ -0,0 +1,9 @@ +# Security Policy + +## Supported Versions + +Only the greatest published version (according to semver) will be supported. + +## Reporting a Vulnerability + +Use GitHub's builtin reporting mechanism under https://github.com/bats-core/bats-core/security/advisories/new diff --git a/tests/bats/bats-core/bin/bats b/tests/bats/bats-core/bin/bats new file mode 100755 index 0000000..25ad051 --- /dev/null +++ b/tests/bats/bats-core/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", + # , , , , + # , , , + # 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" "$@" diff --git a/tests/bats/bats-core/contrib/release.sh b/tests/bats/bats-core/contrib/release.sh new file mode 100755 index 0000000..2e4805e --- /dev/null +++ b/tests/bats/bats-core/contrib/release.sh @@ -0,0 +1,178 @@ +#!/usr/bin/env bash +# +# bats-core git releaser +# +## Usage: %SCRIPT_NAME% [options] +## +## Options: +## --major Major version bump +## --minor Minor version bump +## --patch Patch version bump +## +## -v, --version Print version +## --debug Enable debug mode +## -h, --help Display this message +## + +set -Eeuo pipefail + +DIR=$(cd "$(dirname "${0}")" && pwd) +THIS_SCRIPT="${DIR}/$(basename "${0}")" +BATS_VERSION=$( + # shellcheck disable=SC1090 + source <(grep '^export BATS_VERSION=' libexec/bats-core/bats) + echo "${BATS_VERSION}" +) +declare -r DIR +declare -r THIS_SCRIPT +declare -r BATS_VERSION + +BUMP_INTERVAL="" +NEW_BATS_VERSION="" + +main() { + handle_arguments "${@}" + + if [[ "${BUMP_INTERVAL:-}" == "" ]]; then + echo "${BATS_VERSION}" + exit 0 + fi + + local NEW_BATS_VERSION + NEW_BATS_VERSION=$(semver bump "${BUMP_INTERVAL}" "${BATS_VERSION}") + declare -r NEW_BATS_VERSION + + local BATS_RELEASE_NOTES="/tmp/bats-release-${NEW_BATS_VERSION}" + + echo "Releasing: ${BATS_VERSION} to ${NEW_BATS_VERSION}" + echo + + echo "Ensure docs/CHANGELOG.md is correctly updated" + + replace_in_files + + write_changelog + + git diff --staged + + cat </dev/null + +get_version() { + echo "${THIS_SCRIPT_VERSION:-0.1}" +} + +main "${@}" diff --git a/tests/bats/bats-core/contrib/rpm/bats.spec b/tests/bats/bats-core/contrib/rpm/bats.spec new file mode 100644 index 0000000..f9d4ef5 --- /dev/null +++ b/tests/bats/bats-core/contrib/rpm/bats.spec @@ -0,0 +1,66 @@ +%global provider github.com +%global project bats-core +%global repo bats-core + +Name: bats +Version: 1.11.0 +Release: 1%{?dist} +Summary: Bash Automated Testing System + +Group: Development/Libraries +License: MIT +URL: https://%{provider}/%{project}/%{repo} +Source0: https://%{provider}/%{project}/%{repo}/archive/v%{version}.tar.gz + +BuildArch: noarch + +Requires: bash + +%description +Bats is a TAP-compliant testing framework for Bash. +It provides a simple way to verify that the UNIX programs you write behave as expected. +Bats is most useful when testing software written in Bash, but you can use it to test any UNIX program. + +%prep +%setup -q -n %{repo}-%{version} + +%install +mkdir -p ${RPM_BUILD_ROOT}%{_prefix} ${RPM_BUILD_ROOT}%{_libexecdir} ${RPM_BUILD_ROOT}%{_mandir} +./install.sh ${RPM_BUILD_ROOT}%{_prefix} + +%clean +rm -rf $RPM_BUILD_ROOT + +%check + +%files +%doc README.md LICENSE.md +%{_bindir}/%{name} +%{_libexecdir}/%{repo} +%{_mandir}/man1/%{name}.1.gz +%{_mandir}/man7/%{name}.7.gz +/usr/lib/%{repo}/common.bash +/usr/lib/%{repo}/formatter.bash +/usr/lib/%{repo}/preprocessing.bash +/usr/lib/%{repo}/semaphore.bash +/usr/lib/%{repo}/test_functions.bash +/usr/lib/%{repo}/tracing.bash +/usr/lib/%{repo}/validator.bash +/usr/lib/%{repo}/warnings.bash + +%changelog +* Wed Sep 07 2022 Marcel Hecko - 1.2.0-1 +- Fix and test RPM build on Rocky Linux release 8.6 + +* Sun Jul 08 2018 mbland - 1.1.0-1 +- Increase version to match upstream release + +* Mon Jun 18 2018 pixdrift - 1.0.2-1 +- Increase version to match upstream release +- Relocate libraries to bats-core subdirectory + +* Sat Jun 09 2018 pixdrift - 1.0.1-1 +- Increase version to match upstream release + +* Fri Jun 08 2018 pixdrift - 1.0.0-1 +- Initial package build of forked (bats-core) github project diff --git a/tests/bats/bats-core/contrib/semver b/tests/bats/bats-core/contrib/semver new file mode 100755 index 0000000..ab75586 --- /dev/null +++ b/tests/bats/bats-core/contrib/semver @@ -0,0 +1,358 @@ +#!/usr/bin/env bash + +# v3.0.0 +# https://github.com/fsaintjacques/semver-tool + +set -o errexit -o nounset -o pipefail + +NAT='0|[1-9][0-9]*' +ALPHANUM='[0-9]*[A-Za-z-][0-9A-Za-z-]*' +IDENT="$NAT|$ALPHANUM" +FIELD='[0-9A-Za-z-]+' + +SEMVER_REGEX="\ +^[vV]?\ +($NAT)\\.($NAT)\\.($NAT)\ +(\\-(${IDENT})(\\.(${IDENT}))*)?\ +(\\+${FIELD}(\\.${FIELD})*)?$" + +PROG=semver +PROG_VERSION="3.0.0" + +USAGE="\ +Usage: + $PROG bump (major|minor|patch|release|prerel |build ) + $PROG compare + $PROG get (major|minor|patch|release|prerel|build) + $PROG --help + $PROG --version + +Arguments: + A version must match the following regular expression: + \"${SEMVER_REGEX}\" + In English: + -- The version must match X.Y.Z[-PRERELEASE][+BUILD] + where X, Y and Z are non-negative integers. + -- PRERELEASE is a dot separated sequence of non-negative integers and/or + identifiers composed of alphanumeric characters and hyphens (with + at least one non-digit). Numeric identifiers must not have leading + zeros. A hyphen (\"-\") introduces this optional part. + -- BUILD is a dot separated sequence of identifiers composed of alphanumeric + characters and hyphens. A plus (\"+\") introduces this optional part. + + See definition. + + A string as defined by PRERELEASE above. + + A string as defined by BUILD above. + +Options: + -v, --version Print the version of this tool. + -h, --help Print this help message. + +Commands: + bump Bump by one of major, minor, patch; zeroing or removing + subsequent parts. \"bump prerel\" sets the PRERELEASE part and + removes any BUILD part. \"bump build\" sets the BUILD part. + \"bump release\" removes any PRERELEASE or BUILD parts. + The bumped version is written to stdout. + + compare Compare with , output to stdout the + following values: -1 if is newer, 0 if equal, 1 if + older. The BUILD part is not used in comparisons. + + get Extract given part of , where part is one of major, minor, + patch, prerel, build, or release. + +See also: + https://semver.org -- Semantic Versioning 2.0.0" + +function error { + echo -e "$1" >&2 + exit 1 +} + +function usage-help { + error "$USAGE" +} + +function usage-version { + echo -e "${PROG}: $PROG_VERSION" + exit 0 +} + +function validate-version { + local version=$1 + if [[ "$version" =~ $SEMVER_REGEX ]]; then + # if a second argument is passed, store the result in var named by $2 + if [ "$#" -eq "2" ]; then + local major=${BASH_REMATCH[1]} + local minor=${BASH_REMATCH[2]} + local patch=${BASH_REMATCH[3]} + local prere=${BASH_REMATCH[4]} + local build=${BASH_REMATCH[8]} + eval "$2=(\"$major\" \"$minor\" \"$patch\" \"$prere\" \"$build\")" + else + echo "$version" + fi + else + error "version $version does not match the semver scheme 'X.Y.Z(-PRERELEASE)(+BUILD)'. See help for more information." + fi +} + +function is-nat { + [[ "$1" =~ ^($NAT)$ ]] +} + +function is-null { + [ -z "$1" ] +} + +function order-nat { + [ "$1" -lt "$2" ] && { + echo -1 + return + } + [ "$1" -gt "$2" ] && { + echo 1 + return + } + echo 0 +} + +function order-string { + [[ $1 < $2 ]] && { + echo -1 + return + } + [[ $1 > $2 ]] && { + echo 1 + return + } + echo 0 +} + +# given two (named) arrays containing NAT and/or ALPHANUM fields, compare them +# one by one according to semver 2.0.0 spec. Return -1, 0, 1 if left array ($1) +# is less-than, equal, or greater-than the right array ($2). The longer array +# is considered greater-than the shorter if the shorter is a prefix of the longer. +# +function compare-fields { + local l="$1[@]" + local r="$2[@]" + local leftfield=("${!l}") + local rightfield=("${!r}") + local left + local right + + local i=$((-1)) + local order=$((0)) + + while true; do + [ $order -ne 0 ] && { + echo $order + return + } + + : $((i++)) + left="${leftfield[$i]}" + right="${rightfield[$i]}" + + is-null "$left" && is-null "$right" && { + echo 0 + return + } + is-null "$left" && { + echo -1 + return + } + is-null "$right" && { + echo 1 + return + } + + is-nat "$left" && is-nat "$right" && { + order=$(order-nat "$left" "$right") + continue + } + is-nat "$left" && { + echo -1 + return + } + is-nat "$right" && { + echo 1 + return + } + { + order=$(order-string "$left" "$right") + continue + } + done +} + +# shellcheck disable=SC2206 # checked by "validate"; ok to expand prerel id's into array +function compare-version { + local order + validate-version "$1" V + validate-version "$2" V_ + + # compare major, minor, patch + + local left=("${V[0]}" "${V[1]}" "${V[2]}") + local right=("${V_[0]}" "${V_[1]}" "${V_[2]}") + + order=$(compare-fields left right) + [ "$order" -ne 0 ] && { + echo "$order" + return + } + + # compare pre-release ids when M.m.p are equal + + local prerel="${V[3]:1}" + local prerel_="${V_[3]:1}" + local left=(${prerel//./ }) + local right=(${prerel_//./ }) + + # if left and right have no pre-release part, then left equals right + # if only one of left/right has pre-release part, that one is less than simple M.m.p + + [ -z "$prerel" ] && [ -z "$prerel_" ] && { + echo 0 + return + } + [ -z "$prerel" ] && { + echo 1 + return + } + [ -z "$prerel_" ] && { + echo -1 + return + } + + # otherwise, compare the pre-release id's + + compare-fields left right +} + +function command-bump { + local new + local version + local sub_version + local command + + case $# in + 2) case $1 in + major | minor | patch | release) + command=$1 + version=$2 + ;; + *) usage-help ;; + esac ;; + 3) case $1 in + prerel | build) + command=$1 + sub_version=$2 version=$3 + ;; + *) usage-help ;; + esac ;; + *) usage-help ;; + esac + + validate-version "$version" parts + # shellcheck disable=SC2154 + local major="${parts[0]}" + local minor="${parts[1]}" + local patch="${parts[2]}" + local prere="${parts[3]}" + local build="${parts[4]}" + + case "$command" in + major) new="$((major + 1)).0.0" ;; + minor) new="${major}.$((minor + 1)).0" ;; + patch) new="${major}.${minor}.$((patch + 1))" ;; + release) new="${major}.${minor}.${patch}" ;; + prerel) new=$(validate-version "${major}.${minor}.${patch}-${sub_version}") ;; + build) new=$(validate-version "${major}.${minor}.${patch}${prere}+${sub_version}") ;; + *) usage-help ;; + esac + + echo "$new" + exit 0 +} + +function command-compare { + local v + local v_ + + case $# in + 2) + v=$(validate-version "$1") + v_=$(validate-version "$2") + ;; + *) usage-help ;; + esac + + set +u # need unset array element to evaluate to null + compare-version "$v" "$v_" + exit 0 +} + +# shellcheck disable=SC2034 +function command-get { + local part version + + if [[ "$#" -ne "2" ]] || [[ -z "$1" ]] || [[ -z "$2" ]]; then + usage-help + exit 0 + fi + + part="$1" + version="$2" + + validate-version "$version" parts + local major="${parts[0]}" + local minor="${parts[1]}" + local patch="${parts[2]}" + local prerel="${parts[3]:1}" + local build="${parts[4]:1}" + local release="${major}.${minor}.${patch}" + + case "$part" in + major | minor | patch | release | prerel | build) echo "${!part}" ;; + *) usage-help ;; + esac + + exit 0 +} + +case $# in +0) + echo "Unknown command: $*" + usage-help + ;; +esac + +case $1 in +--help | -h) + echo -e "$USAGE" + exit 0 + ;; +--version | -v) usage-version ;; +bump) + shift + command-bump "$@" + ;; +get) + shift + command-get "$@" + ;; +compare) + shift + command-compare "$@" + ;; +*) + echo "Unknown arguments: $*" + usage-help + ;; +esac diff --git a/tests/bats/bats-core/docker-compose.override.dist b/tests/bats/bats-core/docker-compose.override.dist new file mode 100644 index 0000000..f2b1ed8 --- /dev/null +++ b/tests/bats/bats-core/docker-compose.override.dist @@ -0,0 +1,8 @@ +# Copy this file to docker-compose.override.yml +version: '3.6' +services: + bats: + entrypoint: + - "bash" +networks: + default: diff --git a/tests/bats/bats-core/docker-compose.yml b/tests/bats/bats-core/docker-compose.yml new file mode 100644 index 0000000..21cd994 --- /dev/null +++ b/tests/bats/bats-core/docker-compose.yml @@ -0,0 +1,13 @@ +version: '3.6' +services: + bats: + build: + context: "." + dockerfile: "Dockerfile" + networks: + - "default" + user: "root" + volumes: + - "./:/opt/bats" +networks: + default: diff --git a/tests/bats/bats-core/docker/install_libs.sh b/tests/bats/bats-core/docker/install_libs.sh new file mode 100755 index 0000000..4558653 --- /dev/null +++ b/tests/bats/bats-core/docker/install_libs.sh @@ -0,0 +1,51 @@ +#!/usr/bin/env bash + +set -o errexit +set -o nounset + + +LIBNAME="${1:-support}" +LIVERSION="${2:-0.3.0}" +BASEURL='https://github.com/bats-core' +DESTDIR="${BATS_LIBS_DEST_DIR:-/usr/lib/bats}" +TMPDIR=$(mktemp -d -t bats-libs-XXXXXX) +USAGE="Please provide the bats libe name and version \nFor example: install_libs.sh support 2.0.0\n" + +trap 'test -d "${TMPDIR}" && rm -fr "${TMPDIR}"' EXIT ERR SIGINT SIGTERM + +[[ $# -ne 2 ]] && { _log FATAL "$USAGE"; exit 1; } + +_log() { + printf "$(date "+%Y-%m-%d %H:%M:%S") - %s - %s\n" "${1}" "${2}" +} + +create_temp_dirs() { + mkdir -p "${TMPDIR}/${1}" + if [[ ${LIBNAME} != "detik" ]]; then + mkdir -p "${DESTDIR}/bats-${1}/src" + else + _log INFO "Skipping src 'cause Detik does not need it" + fi +} + +download_extract_source() { + wget -qO- ${BASEURL}/bats-"${1}"/archive/refs/tags/v"${2}".tar.gz | tar xz -C "${TMPDIR}/${1}" --strip-components 1 +} + +install_files() { + if [[ ${LIBNAME} != "detik" ]]; then + install -Dm755 "${TMPDIR}/${1}/load.bash" "${DESTDIR}/bats-${1}/load.bash" + for fn in "${TMPDIR}/${1}/src/"*.bash; do install -Dm755 "$fn" "${DESTDIR}/bats-${1}/src/$(basename "$fn")"; done + else + for fn in "${TMPDIR}/${1}/lib/"*.bash; do install -Dm755 "$fn" "${DESTDIR}/bats-${1}/$(basename "$fn")"; done + fi +} + +_log INFO "Starting to install ${LIBNAME} ver ${LIVERSION}" +_log INFO "Creating directories" +create_temp_dirs "${LIBNAME}" +_log INFO "Downloading" +download_extract_source "${LIBNAME}" "${LIVERSION}" +_log INFO "Installation" +install_files "${LIBNAME}" +_log INFO "Done, cleaning.." diff --git a/tests/bats/bats-core/docker/install_tini.sh b/tests/bats/bats-core/docker/install_tini.sh new file mode 100755 index 0000000..8d98da1 --- /dev/null +++ b/tests/bats/bats-core/docker/install_tini.sh @@ -0,0 +1,30 @@ +#!/usr/bin/env bash + +set -e + +case ${1#linux/} in +386) + TINI_PLATFORM=i386 + ;; +arm/v7) + TINI_PLATFORM=armhf + ;; +arm/v6) + TINI_PLATFORM=armel + ;; +*) + TINI_PLATFORM=${1#linux/} + ;; +esac + +echo "Installing tini for $TINI_PLATFORM" + +wget "https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini-static-${TINI_PLATFORM}" -O /tini +wget "https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini-static-${TINI_PLATFORM}.asc" -O /tini.asc + +chmod +x /tini + +apk add gnupg +gpg --import = 3.2 (#873) + +### Fixed + +* `install.sh` now works for deviating `lib/` dirs (like `lib32`,`lib64`) (#487) +* catch unset `BATS_TEST_SOURCE` in `lib/bats-core/tracing.bash` so + `set -u`/`set -o nounset` works as expected (#827) +* fix `--gather-test-outputs-in` fails on tests with multiple `/` (#789) +* install does not create unused `/usr/share/bats` anymore (#857) +* ensure IFS is unchanged in `{setup,teardown}{_suite,_file,}`, `@test` and free code (#879) +* junit formatter: remove ANSI Codes to avoid invalid XML character (#886) + +### Changed + +* update Docker image with the latest `bats-file` version 0.4.0 (#780) +* update Docker image with the latest `bats-detik` version 1.3.0 (#876) + +#### Documentation + +* clarify docker usage (#741) +* update Arch Linux package URL in installation.rst (#821) +* rename bash-bats to bats for Arch Linux in installation.rst (#836) +* fix FAQ entry about setup-/teardown_suite, as they are available now (#861) +* added logo (#881) + +## [1.10.0] - 2023-07-15 + +### Added + +* add `${BATS_TEST_TAGS[@]}` for querying the tags during a test (#705) +* print tags on failing tests (#705) +* test for negative arguments to `--jobs` (#693) +* add tests for `--formatter cat` (#710) +* test coverage in CI (#718) +* Support for [rush](https://github.com/shenwei356/rush) as alternative to GNU parallel (#729) +* add `bats_pipe` helper function for `run` that executes `\|` as pipes (#663) +* publish docker images to ghcr.io (additionally to Dockerhub) (#740) + +### Documentation + +* clarify use cases of `--formatter cat` (#710) + +### Fixed + +* fix `run` with options overwriting the value of `i` (#726, #727) +* fix `${BATS_TEST_NAMES[@]}` containing only `--tags` instead of test name since Bats v1.8.0 (#705) +* fix `run --keep-empty-lines` counting trailing `\n` as (empty) new line (#711) +* fix short flag unpacker creating bogus command lines with valued flags (#732) +* fix formatter becoming confused with retries (#734) +* fix `--gather-test-outputs-in` fails on tests with `/` (#735) +* fix overriding `date` breaks `--timing` (#736) + +#### Documentation + +* typos, minor edits (#704) +* simplified contributing.md (#718) + +## [1.9.0] - 2023-02-12 + +### Added + +* add installation instructions for Debian, Fedora, Gentoo, and OpenSUSE (#659) +* add `--line-reference-format` to switch file/line references in stack traces (#665) + * `comma_line` (default): `file.bats, line 1` + * `colon`: `file.bats:1` + * `uri`: `file:///path/to/file.bats:1` + * `custom`: define your own formatter in `bats_format_file_line_reference_custom` +* add `bats:focus` tag to run only focused tests (#679) +* add bats-support, bats-assert, bats-file and bats-detik to Dockerfile (#674) + +### Documentation + +* add `--help` text and `man` page content for `--filter-tags` (#679) + +### Fixed + +* explicitly check for GNU parallel (#691) +* wait for report-formatter to finish before ending `bats`' execution, + to fix empty files with `--report-fomatter junit` under Docker (#692) + +#### Documentation + +* improved clarity of section about output in free code (#671) +* fixed typos (#673) +* clarify use cases of `run` (#366) + +## [1.8.2] - 2022-10-19 + +### Fixed + +* fix non zero return code on successful retried tests (#670) +* fix `skip` in `setup_file` failing test suite (#687) + +## [1.8.1] - 2022-10-19 + +### Fixed + +* `shfmt` all files and enforce via CI (#651) +* avoid kernel warning flood/hang with CTRL+C on Bash 5.2 RC (#656) +* Fix infinite wait with (invalid) `-j` (without space) (#657) + +## [1.8.0] - 2022-09-15 + +### Added + +* using external formatters via `--formatter ` (also works for + `--report-formatter`) (#602) +* running only tests that failed in the last run via `--filter-status failed` (#483) +* variable `BATS_TEST_RETRIES` that specifies how often a test should be + reattempted before it is considered failed (#618) +* Docker tags `latest-no-faccessat2` and `-no-faccessat2` for + avoiding `bash: bats: No such file or directory` on `docker<20.10` (or + `runc`/`# bats file_tags=` and + `--filter-tags ` for tagging tests for execution filters (#642) +* warning BW03: inform about `setup_suite` in wrong file (`.bats` instead of `setup_suite.bash`) (#652) + +#### Documentation + +* update gotcha about negated statements: Recommend using `run !` on Bats + versions >=1.5.0 (#593) +* add documentation for `bats_require_minimum_version` (#595) +* improve documentation about `setup_suite` (#652) + +### Fixed + +* added missing shebang (#597) +* remaining instances of `run -` being incorrectly documented as `run =` (#599) +* allow `--gather-test-outputs-in ` to work with existing, empty + directories (#603) + * also add `--clean-and-gather-test-outputs-in ` for improved UX +* double slashes in paths derived from TMPDIR on MacOS (#607) +* fix `load` in `teardown` marking failed tests as not run (#612) +* fix unset variable errors (with set -u) and add regression test (#621) +* `teardown_file` errors don't swallow `setup_file` errors anymore, the behavior + is more like `teardown`'s now (only `return`/last command can trigger `teardown` + errors) (#623) +* upgraded from deprecated CI envs for MacOS (10 -> 11,12) and Ubuntu + (18.04 -> 22.04) (#630) +* add `/usr/lib/bats` as default value for `BATS_LIB_PATH` (#628) +* fix unset variable in `bats-formatter-junit` when `setup_file` fails (#632) +* unify error behavior of `teardown`/`teardown_file`/`teardown_suite` functions: + only fail via return code, not via ERREXIT (#633) +* fix unbound variable errors with `set -u` on `setup_suite` failures (#643) +* fix `load` not being available in `setup_suite` (#644) +* fix RPM spec, add regression test (#648) +* fix handling of `IFS` by `run` (#650) +* only print `setup_suite`'s stderr on errors (#649) + +#### Documentation + +* fix typos, spelling and links (#596, #604, #619, #627) +* fix redirection order of an example in the tutorial (#617) + +## [1.7.0] - 2022-05-14 + +### Added + +* Pretty formatter print filename when entering file (#561) +* BATS_TEST_NAME_PREFIX allows prefixing test names on stdout and in reports (#561) +* setup_suite and teardown_suite (#571, #585) +* out-of-band warning infrastructure, with following warnings: + * BW01: run command not found (exit code 127) (#586) + * BW02: run uses flags without proper `bats_require_minimum_version` guard (#587) +* `bats_require_minimum_version` to guard code that would not run on older + versions (#587) + +#### Documentation + +* document `$BATS_VERSION` (#557) +* document new warning infrastructure (#589, #587, #586) + +### Fixed + +* unbound variable errors in formatters when using `SHELLOPTS=nounset` (`-u`) (#558) +* don't require `flock` *and* `shlock` for parallel mode test (#554) +* print name of failing test when using TAP13 with timing information (#559, #555) +* removed broken symlink, added regression test (#560) +* don't show empty lines as `#` with pretty formatter (#561) +* prevent `teardown`, `teardown_file`, and `teardown_suite` from overriding bats' + exit code by setting `$status` (e.g. via calling `run`) (#581, #575) + * **CRITICAL**: this can return exit code 0 despite failed tests, thus preventing + your CI from reporting test failures! The regression happened in version 1.6.0. +* `run --keep-empty-lines` now reports 0 lines on empty `$output` (#583) + +#### Documentation + +* remove 2018 in title, update copyright dates in README.md (#567) +* fix broken links (#568) +* corrected invalid documentation of `run -N` (had `=N` instead) (#579) + * **CRITICAL**: using the incorrect form can lead to silent errors. See + [issue #578](https://github.com/bats-core/bats-core/issues/578) for more + details and how to find out if your tests are affected. + +## [1.6.1] - 2022-05-14 + +### Fixed + +* prevent `teardown`, `teardown_file`, and `teardown_suite` from overriding bats' + exit code by setting `$status` (e.g. via calling `run`) (#581, #575) + * **CRITICAL**: this can return exit code 0 despite failed tests, thus preventing + your CI from reporting test failures! The regression happened in version 1.6.0. + +#### Documentation + +* corrected invalid documentation of `run -N` (had `=N` instead) (#579) + * **CRITICAL**: using the incorrect form can lead to silent errors. See + [issue #578](https://github.com/bats-core/bats-core/issues/578) for more + details and how to find out if your tests are affected. + +## [1.6.0] - 2022-02-24 + +### Added + +* new flag `--code-quote-style` (and `$BATS_CODE_QUOTE_STYLE`) to customize +quotes around code blocks in error output (#506) +* an example/regression test for running background tasks without blocking the + test run (#525, #535) +* `bats_load_library` for loading libraries from the search path + `$BATS_LIB_PATH` (#548) + +### Fixed + +* improved error trace for some broken cases (#279) +* removed leftover debug file `/tmp/latch` in selftest suite + (single use latch) (#516) +* fix recurring errors on CTRL+C tests with NPM on Windows in selftest suite (#516) +* fixed leaking of local variables from debug trap (#520) +* don't mark FD3 output from `teardown_file` as `` in junit output (#532) +* fix unbound variable error with Bash pre 4.4 (#550) + +#### Documentation + +* remove links to defunct freenode IRC channel (#515) +* improved grammar (#534) +* fixed link to TAP spec (#537) + +## [1.5.0] - 2021-10-22 + +### Added + +* new command line flags (#488) + * `--verbose-run`: Make `run` print `$output` by default + * `-x`, `--trace`: Print test commands as they are executed (like `set -x`)` + * `--show-output-of-passing-tests`: Print output of passing tests + * `--print-output-on-failure`: Automatically print the value of `$output` on + failed tests + * `--gather-test-outputs-in `: Gather the output of failing **and** + passing tests as files in directory +* Experimental: add return code checks to `run` via `!`/`-` (#367, #507) +* `install.sh` and `uninstall.sh` take an optional second parameter for the lib + folder name to allow for multilib install, e.g. into lib64 (#452) +* add `run` flag `--keep-empty-lines` to retain empty lines in `${lines[@]}` (#224, + a894fbfa) +* add `run` flag `--separate-stderr` which also fills `$stderr` and + `$stderr_lines` (#47, 5c9b173d, #507) + +### Fixed + +* don't glob `run`'s `$output` when splitting into `${lines[@]}` + (#151, #152, #158, #156, #281, #289) +* remove empty line after test with pretty formatter on some terminals (#481) +* don't run setup_file/teardown_file on files without tests, e.g. due to + filtering (#484) +* print final line without newline on Bash 3.2 for midtest (ERREXIT) failures + too (#495, #145) +* abort with error on missing flock/shlock when running in parallel mode (#496) +* improved `set -u` test and fixed some unset variable accesses (#498, #501) +* shorten suite/file/test temporary folder paths to leave enough space even on + restricted systems (#503) + +#### Documentation + +* minor edits (#478) + +## [1.4.1] - 2021-07-24 + +### Added + +* Docker image architectures amd64, 386, arm64, arm/v7, arm/v6, ppc64le, s390x (#438) + +### Fixed + +* automatic push to Dockerhub (#438) + +## [1.4.0] - 2021-07-23 + +### Added + +* added BATS_TEST_TMPDIR, BATS_FILE_TMPDIR, BATS_SUITE_TMPDIR (#413) +* added checks and improved documentation for `$BATS_TMPDIR` (#410) +* the docker container now uses [tini](https://github.com/krallin/tini) as the + container entrypoint to improve signal forwarding (#407) +* script to uninstall bats from a given prefix (#400) +* replace preprocessed file path (e.g. `/tmp/bats-run-22908-NP0f9h/bats.23102.src`) + with original filename in stdout/err (but not FD3!) (#429) +* print aborted command on SIGINT/CTRL+C (#368) +* print error message when BATS_RUN_TMPDIR could not be created (#422) + +#### Documentation + +* added tutorial for new users (#397) +* fixed example invocation of docker container (#440) +* minor edits (#431, #439, #445, #463, #464, #465) + +### Fixed + +* fix `bats_tap_stream_unknown: command not found` with pretty formatter, when + writing non compliant extended output (#412) +* avoid collisions on `$BATS_RUN_TMPDIR` with `--no-tempdir-cleanup` and docker + by using `mktemp` additionally to PID (#409) +* pretty printer now puts text that is printed to FD 3 below the test name (#426) +* `rm semaphores/slot-: No such file or directory` in parallel mode on MacOS + (#434, #433) +* fix YAML blocks in TAP13 formatter using `...` instead of `---` to start + a block (#442) +* fixed some typos in comments (#441, #447) +* ensure `/code` exists in docker container, to make examples work again (#440) +* also display error messages from free code (#429) +* npm installed version on Windows: fix broken internal LIBEXEC paths (#459) + +## [1.3.0] - 2021-03-08 + +### Added + +* custom test-file extension via `BATS_FILE_EXTENSION` when searching for test + files in a directory (#376) +* TAP13 formatter, including millisecond timing (#337) +* automatic release to NPM via GitHub Actions (#406) + +#### Documentation + +* added documentation about overusing `run` (#343) +* improved documentation of `load` (#332) + +### Changed + +* recursive suite mode will follow symlinks now (#370) +* split options for (file-) `--report-formatter` and (stdout) `--formatter` (#345) + * **WARNING**: This changes the meaning of `--formatter junit`. + stdout will now show unified xml instead of TAP. From now on, please use + `--report-formatter junit` to obtain the `.xml` report file! +* removed `--parallel-preserve-environment` flag, as this is the default + behavior (#324) +* moved CI from Travis/AppVeyor to GitHub Actions (#405) +* preprocessed files are no longer removed if `--no-tempdir-cleanup` is + specified (#395) + +#### Documentation + +* moved documentation to [readthedocs](https://bats-core.readthedocs.io/en/latest/) + +### Fixed + +#### Correctness + +* fix internal failures due to unbound variables when test files use `set -u` (#392) +* fix internal failures due to changes to `$PATH` in test files (#387) +* fix test duration always being 0 on busybox installs (#363) +* fix hangs on CTRL+C (#354) +* make `BATS_TEST_NUMBER` count per file again (#326) +* include `lib/` in npm package (#352) + +#### Performance + +* don't fork bomb in parallel mode (#339) +* preprocess each file only once (#335) +* avoid running duplicate files n^2 times (#338) + +#### Documentation + +* fix documentation for `--formatter junit` (#334) +* fix documentation for `setup_file` variables (#333) +* fix link to examples page (#331) +* fix link to "File Descriptor 3" section (#301) + +## [1.2.1] - 2020-07-06 + +### Added + +* JUnit output and extensible formatter rewrite (#246) +* `load` function now reads from absolute and relative paths, and $PATH (#282) +* Beginner-friendly examples in /docs/examples (#243) +* @peshay's `bats-file` fork contributed to `bats-core/bats-file` (#276) + +### Changed + +* Duplicate test names now error (previous behaviour was to issue a warning) (#286) +* Changed default formatter in Docker to pretty by adding `ncurses` to + Dockerfile, override with `--tap` (#239) +* Replace "readlink -f" dependency with Bash solution (#217) + +## [1.2.0] - 2020-04-25 + +Support parallel suite execution and filtering by test name. + +### Added + +* docs/CHANGELOG.md and docs/releasing.md (#122) +* The `-f, --filter` flag to run only the tests matching a regular expression (#126) +* Optimize stack trace capture (#138) +* `--jobs n` flag to support parallel execution of tests with GNU parallel (#172) + +### Changed + +* AppVeyor builds are now semver-compliant (#123) +* Add Bash 5 as test target (#181) +* Always use upper case signal names to avoid locale dependent err… (#215) +* Fix for tests reading from stdin (#227) +* Fix wrong line numbers of errors in bash < 4.4 (#229) +* Remove preprocessed source after test run (#232) + +## [1.1.0] - 2018-07-08 + +This is the first release with new features relative to the original Bats 0.4.0. + +### Added + +* The `-r, --recursive` flag to scan directory arguments recursively for + `*.bats` files (#109) +* The `contrib/rpm/bats.spec` file to build RPMs (#111) + +### Changed + +* Travis exercises latest versions of Bash from 3.2 through 4.4 (#116, #117) +* Error output highlights invalid command line options (#45, #46, #118) +* Replaced `echo` with `printf` (#120) + +### Fixed + +* Fixed `BATS_ERROR_STATUS` getting lost when `bats_error_trap` fired multiple + times under Bash 4.2.x (#110) +* Updated `bin/bats` symlink resolution, handling the case on CentOS where + `/bin` is a symlink to `/usr/bin` (#113, #115) + +## [1.0.2] - 2018-06-18 + +* Fixed sstephenson/bats#240, whereby `skip` messages containing parentheses + were truncated (#48) +* Doc improvements: + * Docker usage (#94) + * Better README badges (#101) + * Better installation instructions (#102, #104) +* Packaging/installation improvements: + * package.json update (#100) + * Moved `libexec/` files to `libexec/bats-core/`, improved `install.sh` (#105) + +## [1.0.1] - 2018-06-09 + +* Fixed a `BATS_CWD` bug introduced in #91 whereby it was set to the parent of + `PWD`, when it should've been set to `PWD` itself (#98). This caused file + names in stack traces to contain the basename of `PWD` as a prefix, when the + names should've been purely relative to `PWD`. +* Ensure the last line of test output prints when it doesn't end with a newline + (#99). This was a quasi-bug introduced by replacing `sed` with `while` in #88. + +## [1.0.0] - 2018-06-08 + +`1.0.0` generally preserves compatibility with `0.4.0`, but with some Bash +compatibility improvements and a massive performance boost. In other words: + +* all existing tests should remain compatible +* tests that might've failed or exhibited unexpected behavior on earlier + versions of Bash should now also pass or behave as expected + +Changes: + +* Added support for Docker. +* Added support for test scripts that have the [unofficial strict + mode](http://redsymbol.net/articles/unofficial-bash-strict-mode/) enabled. +* Improved stability on Windows and macOS platforms. +* Massive performance improvements, especially on Windows (#8) +* Workarounds for inconsistent behavior between Bash versions (#82) +* Workaround for preserving stack info after calling an exported function under + Bash < 4.4 (#87) +* Fixed TAP compliance for skipped tests +* Added support for tabs in test names. +* `bin/bats` and `install.sh` now work reliably on Windows (#91) + +## [0.4.0] - 2014-08-13 + +* 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] - 2013-10-28 + +* 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] - 2013-10-21 + +* 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] - 2012-11-16 + +* 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] - 2011-12-30 + +* Initial public release. + +[Unreleased]: https://github.com/bats-core/bats-core/compare/v1.7.0...HEAD +[1.7.0]: https://github.com/bats-core/bats-core/compare/v1.6.1...v1.7.0 +[1.6.1]: https://github.com/bats-core/bats-core/compare/v1.6.0...v1.6.1 +[1.6.0]: https://github.com/bats-core/bats-core/compare/v1.5.0...v1.6.0 +[1.5.0]: https://github.com/bats-core/bats-core/compare/v1.4.1...v1.5.0 +[1.4.1]: https://github.com/bats-core/bats-core/compare/v1.4.0...v1.4.1 +[1.4.0]: https://github.com/bats-core/bats-core/compare/v1.3.0...v1.4.0 +[1.3.0]: https://github.com/bats-core/bats-core/compare/v1.2.1...v1.3.0 +[1.2.1]: https://github.com/bats-core/bats-core/compare/v1.2.0...v1.2.1 +[1.2.0]: https://github.com/bats-core/bats-core/compare/v1.1.0...v1.2.0 +[1.1.0]: https://github.com/bats-core/bats-core/compare/v1.0.2...v1.1.0 +[1.0.2]: https://github.com/bats-core/bats-core/compare/v1.0.1...v1.0.2 +[1.0.1]: https://github.com/bats-core/bats-core/compare/v1.0.0...v1.0.1 +[1.0.0]: https://github.com/bats-core/bats-core/compare/v0.4.0...v1.0.0 +[0.4.0]: https://github.com/bats-core/bats-core/compare/v0.3.1...v0.4.0 +[0.3.1]: https://github.com/bats-core/bats-core/compare/v0.3.0...v0.3.1 +[0.3.0]: https://github.com/bats-core/bats-core/compare/v0.2.0...v0.3.0 +[0.2.0]: https://github.com/bats-core/bats-core/compare/v0.1.0...v0.2.0 +[0.1.0]: https://github.com/bats-core/bats-core/commits/v0.1.0 + diff --git a/tests/bats/bats-core/docs/CODEOWNERS b/tests/bats/bats-core/docs/CODEOWNERS new file mode 100644 index 0000000..2eb2333 --- /dev/null +++ b/tests/bats/bats-core/docs/CODEOWNERS @@ -0,0 +1,4 @@ +# This enables automatic code review requests per: +# - https://help.github.com/articles/about-codeowners/ +# - https://help.github.com/articles/enabling-required-reviews-for-pull-requests/ +* @bats-core/bats-core diff --git a/tests/bats/bats-core/docs/CODE_OF_CONDUCT.md b/tests/bats/bats-core/docs/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..d8d6972 --- /dev/null +++ b/tests/bats/bats-core/docs/CODE_OF_CONDUCT.md @@ -0,0 +1,92 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting one of the current [project maintainers](#project-maintainers) listed below. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Project Maintainers + +### Current Maintainers + +* [Bianca Tamayo][bt-gh] +* [Mike Bland][mb-gh] +* [Jason Karns][jk-gh] +* [Andrew Martin][am-gh] + +### Past Maintainers + +* Sam Stephenson <> (Original author) + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[bt-gh]: https://github.com/btamayo +[mb-gh]: https://github.com/mbland +[jk-gh]: https://github.com/jasonkarns +[am-gh]: https://github.com/sublimino + +[homepage]: https://contributor-covenant.org +[version]: https://contributor-covenant.org/version/1/4/ diff --git a/tests/bats/bats-core/docs/CONTRIBUTING.md b/tests/bats/bats-core/docs/CONTRIBUTING.md new file mode 100644 index 0000000..f1a7e34 --- /dev/null +++ b/tests/bats/bats-core/docs/CONTRIBUTING.md @@ -0,0 +1,232 @@ +# Contributing Guidelines + +## Welcome! + +Thank you for considering contributing to this project's +development and/or documentation. Just a reminder: if you're new to this project +or to OSS and want to find issues to work on, please check the following labels +on issues: + +- [help wanted][helpwantedlabel] +- [docs][docslabel] +- [good first issue][goodfirstissuelabel] + +[docslabel]: https://github.com/bats-core/bats-core/labels/docs +[helpwantedlabel]: https://github.com/bats-core/bats-core/labels/help%20wanted +[goodfirstissuelabel]: https://github.com/bats-core/bats-core/labels/good%20first%20issue + +To see all labels and their meanings, [check this wiki page][labelswiki]. + +[labelswiki]: https://github.com/bats-core/bats-core/wiki/GitHub-Issue-Labels + +## Table of contents + +* [Contributing Guidelines](#contributing-guidelines) + * [Welcome!](#welcome) + * [Table of contents](#table-of-contents) + * [Quick links](#quick-links) + * [Code of conduct](#code-of-conduct) + * [Asking questions](#asking-questions) + * [Updating documentation](#updating-documentation) + * [Testing](#testing) + * [Coding conventions](#coding-conventions) + * [Function declarations](#function-declarations) + * [Variable and parameter declarations](#variable-and-parameter-declarations) + * [Command substitution](#command-substitution) + * [Process substitution](#process-substitution) + * [Conditionals and loops](#conditionals-and-loops) + * [Generating output](#generating-output) + * [Signal names](#signal-names) + * [Gotchas](#gotchas) + * [Open Source License](#open-source-license) + * [Credits](#credits) + +## Quick links + +- [Gitter channel →][gitterurl]: Feel free to come chat with us on Gitter +- [README →][README] +- [Code of conduct →][CODE_OF_CONDUCT] +- [License information →][LICENSE] +- [Original repository →][repohome] +- [Issues →][repoissues] +- [Pull requests →][repoprs] +- [Milestones →][repomilestones] +- [Projects →][repoprojects] + +[README]: https://github.com/bats-core/bats-core/blob/master/README.md +[CODE_OF_CONDUCT]: https://github.com/bats-core/bats-core/blob/master/docs/CODE_OF_CONDUCT.md +[LICENSE]: https://github.com/bats-core/bats-core/blob/master/LICENSE.md + +## Code of conduct + +Harassment or rudeness of any kind will not be tolerated, period. For +specifics, see the [CODE_OF_CONDUCT][] file. + +## Asking questions + +Please check the [documentation][documentation] or existing [discussions][] and [issues][repoissues] first. + +If you cannot find an answer to your question, please feel free to hop on our +[Gitter][gitterurl]. [![Gitter](https://badges.gitter.im/bats-core/bats-core.svg)](https://gitter.im/bats-core/bats-core) + +## Updating documentation + +We love documentation and people who love documentation! + +If you love writing clear, accessible docs, please don't be shy about pull +requests. Remember: docs are just as important as code. + +Also: _no typo is too small to fix!_ Really. Of course, batches of fixes are +preferred, but even one nit is one nit too many. + +## Testing + +- Continuous integration status: [![Tests](https://github.com/bats-core/bats-core/workflows/Tests/badge.svg)](https://github.com/bats-core/bats-core/actions?query=workflow%3ATests) + +To run all tests: +```sh +bin/bats test +``` + +To run a single test file: +```sh +bin/bats test/file.bats +``` + +When running from a terminal, Bats uses the *pretty* formatter by default. +However, to debug Bats you might need to see the raw test output. +The **cat** formatter is intended as an internal debugging tool because +it does not process test outputs. +To use it, run Bats with the `--formatter cat` option. + +## Coding conventions + +Use (`shfmt`)[https://github.com/mvdan/sh#shfmt] and [ShellCheck](https://www.shellcheck.net/). The CI will enforce this. + +Use `snake_case` for all identifiers. + +### Function declarations + +- Declare functions without the `function` keyword. +- Strive to always use `return`, never `exit`, unless an error condition is + severe enough to warrant it. + - Calling `exit` makes it difficult for the caller to recover from an error, + or to compose new commands from existing ones. + +### Variable and parameter declarations + +- Declare all variables inside functions using `local`. +- Declare temporary file-level variables using `declare`. Use `unset` to remove + them when finished. +- Don't use `local -r`, as a readonly local variable in one scope can cause a + conflict when it calls a function that declares a `local` variable of the same + name. +- Don't use type flags with `declare` or `local`. Assignments to integer + variables in particular may behave differently, and it has no effect on array + variables. +- For most functions, the first lines should use `local` declarations to + assign the original positional parameters to more meaningful names, e.g.: + ```bash + format_summary() { + local cmd_name="$1" + local summary="$2" + local longest_name_len="$3" + ``` + For very short functions, this _may not_ be necessary, e.g.: + ```bash + has_spaces() { + [[ "$1" != "${1//[[:space:]]/}" ]] + } + ``` + +### Command substitution + +- If possible, don't. While this capability is one of Bash's core strengths, + every new process created by Bats makes the framework slower, and speed is + critical to encouraging the practice of automated testing. (This is especially + true on Windows, [where process creation is one or two orders of magnitude + slower][win-slow]. See [bats-core/bats-core#8][pr-8] for an illustration of + the difference avoiding subshells makes.) Bash is quite powerful; see if you + can do what you need in pure Bash first. +- If you need to capture the output from a function, store the output using + `printf -v` instead if possible. `-v` specifies the name of the variable into + which to write the result; the caller can supply this name as a parameter. +- If you must use command substitution, use `$()` instead of backticks, as it's + more robust, more searchable, and can be nested. + +[win-slow]: https://rufflewind.com/2014-08-23/windows-bash-slow +[pr-8]: https://github.com/bats-core/bats-core/pull/8 + +### Process substitution + +- If possible, don't use it. See the advice on avoiding subprocesses and using + `printf -v` in the **Command substitution** section above. +- Use wherever necessary and possible, such as when piping input into a `while` + loop (which avoids having the loop body execute in a subshell) or running a + command taking multiple filename arguments based on output from a function or + pipeline (e.g. `diff`). +- *Warning*: It is impossible to directly determine the exit status of a process + substitution; emitting an exit status as the last line of output is a possible + workaround. + +### Conditionals and loops + +- Always use `[[` and `]]` for evaluating variables. Per the guideline under + **Formatting**, quote variables and strings within the brackets, but not + regular expressions (or variables containing regular expressions) appearing + on the right side of the `=~` operator. + +### Generating output + +- Use `printf` instead of `echo`. Both are Bash builtins, and there's no + perceptible performance difference when running Bats under the `time` builtin. + However, `printf` provides a more consistent experience in general, as `echo` + has limitations to the arguments it accepts, and even the same version of Bash + may produce different results for `echo` based on how the binary was compiled. + See [Stack Overflow: Why is printf better than echo?][printf-vs-echo] for + excruciating details. + +[printf-vs-echo]: https://unix.stackexchange.com/a/65819 + +### Signal names + +Always use upper case signal names (e.g. `trap - INT EXIT`) to avoid locale +dependent errors. In some locales (for example Turkish, see +[Turkish dotless i](https://en.wikipedia.org/wiki/Dotted_and_dotless_I)) lower +case signal names cause Bash to error. An example of the problem: + +```bash +$ echo "tr_TR.UTF-8 UTF-8" >> /etc/locale.gen && locale-gen tr_TR.UTF-8 # Ubuntu derivatives +$ LC_CTYPE=tr_TR.UTF-8 LC_MESSAGES=C bash -c 'trap - int && echo success' +bash: line 0: trap: int: invalid signal specification +$ LC_CTYPE=tr_TR.UTF-8 LC_MESSAGES=C bash -c 'trap - INT && echo success' +success +``` + + +## Credits + +The [official bash logo](https://github.com/odb/official-bash-logo) is copyrighted +by the [Free Software Foundation](https://www.fsf.org/), 2016 under the [Free Art License](http://artlibre.org/licence/lal/en/) + +This guide borrows **heavily** from [@mbland's go-script-bash][gsb] (with some +sections directly quoted), which in turn was +drafted with tips from [Wrangling Web Contributions: How to Build +a CONTRIBUTING.md][moz] and with some inspiration from [the Atom project's +CONTRIBUTING.md file][atom]. + +[gsb]: https://github.com/mbland/go-script-bash/blob/master/CONTRIBUTING.md +[moz]: https://mozillascience.github.io/working-open-workshop/contributing/ +[atom]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md + +[discussions]: https://github.com/bats-core/bats-core/discussions +[documentation]: https://bats-core.readthedocs.io/ +[repoprojects]: https://github.com/bats-core/bats-core/projects +[repomilestones]: https://github.com/bats-core/bats-core/milestones +[repoprs]: https://github.com/bats-core/bats-core/pulls +[repoissues]: https://github.com/bats-core/bats-core/issues +[repohome]: https://github.com/bats-core/bats-core + +[osmit]: https://opensource.org/licenses/MIT + +[gitterurl]: https://gitter.im/bats-core/bats-core diff --git a/tests/bats/bats-core/docs/Makefile b/tests/bats/bats-core/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/tests/bats/bats-core/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/tests/bats/bats-core/docs/PULL_REQUEST_TEMPLATE.md b/tests/bats/bats-core/docs/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c7c58d5 --- /dev/null +++ b/tests/bats/bats-core/docs/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ +- [ ] I have reviewed the [Contributor Guidelines][contributor]. +- [ ] I have reviewed the [Code of Conduct][coc] and agree to abide by it + +[contributor]: https://github.com/bats-core/bats-core/blob/master/docs/CONTRIBUTING.md +[coc]: https://github.com/bats-core/bats-core/blob/master/docs/CODE_OF_CONDUCT.md diff --git a/tests/bats/bats-core/docs/examples/README.md b/tests/bats/bats-core/docs/examples/README.md new file mode 100644 index 0000000..5ef5134 --- /dev/null +++ b/tests/bats/bats-core/docs/examples/README.md @@ -0,0 +1,6 @@ +# Examples + +This directory contains example .bats files. +See the [bats-core wiki][examples] for more details. + +[examples]: https://github.com/bats-core/bats-core/wiki/Examples \ No newline at end of file diff --git a/tests/bats/bats-core/docs/examples/package-tarball b/tests/bats/bats-core/docs/examples/package-tarball new file mode 100644 index 0000000..b51cffd --- /dev/null +++ b/tests/bats/bats-core/docs/examples/package-tarball @@ -0,0 +1,16 @@ +#!/usr/bin/env bash + +# "unofficial" bash strict mode +# See: http://redsymbol.net/articles/unofficial-bash-strict-mode +set -o errexit # Exit when simple command fails 'set -e' +set -o errtrace # Exit on error inside any functions or subshells. +set -o nounset # Trigger error when expanding unset variables 'set -u' +set -o pipefail # Do not hide errors within pipes 'set -o pipefail' +set -o xtrace # Display expanded command and arguments 'set -x' +IFS=$'\n\t' # Split words on \n\t rather than spaces + +main() { + tar -czf "$dst_tarball" -C "$src_dir" . +} + +main "$@" diff --git a/tests/bats/bats-core/docs/examples/package-tarball.bats b/tests/bats/bats-core/docs/examples/package-tarball.bats new file mode 100755 index 0000000..144318a --- /dev/null +++ b/tests/bats/bats-core/docs/examples/package-tarball.bats @@ -0,0 +1,51 @@ +#!/usr/bin/env bats + +setup() { + export dst_tarball="${BATS_TMPDIR}/dst.tar.gz" + export src_dir="${BATS_TMPDIR}/src_dir" + + rm -rf "${dst_tarball}" "${src_dir}" + mkdir "${src_dir}" + touch "${src_dir}"/{a,b,c} +} + +main() { + bash "${BATS_TEST_DIRNAME}"/package-tarball +} + +@test "fail when \$src_dir and \$dst_tarball are unbound" { + unset src_dir dst_tarball + + run main + [ "${status}" -ne 0 ] +} + +@test "fail when \$src_dir is a non-existent directory" { + # shellcheck disable=SC2030 + src_dir='not-a-dir' + + run main + [ "${status}" -ne 0 ] +} + +# shellcheck disable=SC2016 +@test "pass when \$src_dir directory is empty" { + # shellcheck disable=SC2031,SC2030 + rm -rf "${src_dir:?}/*" + + run main + echo "$output" + [ "${status}" -eq 0 ] +} + +# shellcheck disable=SC2016 +@test "files in \$src_dir are added to tar archive" { + run main + [ "${status}" -eq 0 ] + + run tar tf "$dst_tarball" + [ "${status}" -eq 0 ] + [[ "${output}" =~ a ]] + [[ "${output}" =~ b ]] + [[ "${output}" =~ c ]] +} diff --git a/tests/bats/bats-core/docs/list-links.py b/tests/bats/bats-core/docs/list-links.py new file mode 100644 index 0000000..e8651ad --- /dev/null +++ b/tests/bats/bats-core/docs/list-links.py @@ -0,0 +1,4 @@ +import pickle +with open("build/doctrees/environment.pickle", "rb") as f: + dat = pickle.load(f) +print(dat.domaindata['std']['labels']) diff --git a/tests/bats/bats-core/docs/make.bat b/tests/bats/bats-core/docs/make.bat new file mode 100644 index 0000000..9534b01 --- /dev/null +++ b/tests/bats/bats-core/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/tests/bats/bats-core/docs/releasing.md b/tests/bats/bats-core/docs/releasing.md new file mode 100644 index 0000000..cd0717b --- /dev/null +++ b/tests/bats/bats-core/docs/releasing.md @@ -0,0 +1,127 @@ +# Releasing a new Bats version + +These notes reflect the current process. There's a lot more we could do, in +terms of automation and expanding the number of platforms to which we formally +release (see #103). + +## Update docs/CHANGELOG.md + +Create a new entry at the top of `docs/CHANGELOG.md` that enumerates the +significant updates to the new version. + +## Bumping the version number + +Bump the version numbers in the following files: + +- contrib/rpm/bats.spec +- libexec/bats-core/bats +- package.json + +Commit these changes (including the `docs/CHANGELOG.md` changes) in a commit +with the message `Bats `, where `` is the new version number. + +Create a new signed, annotated tag with: + +```bash +$ git tag -a -s +``` + +Include the `docs/CHANGELOG.md` notes corresponding to the new version as the +tag annotation, except the first line should be: `Bats - YYYY-MM-DD` +and any Markdown headings should become plain text, e.g.: + +```md +### Added +``` + +should become: + +```md +Added: +``` + +## Create a GitHub release + +Push the new version commit and tag to GitHub via the following: + +```bash +$ git push --follow-tags +``` + +Then visit https://github.com/bats-core/bats-core/releases, and: + +* Click **Draft a new release**. +* Select the new version tag. +* Name the release: `Bats `. +* Paste the same notes from the version tag annotation as the description, + except change the first line to read: `Released: YYYY-MM-DD`. +* Click **Publish release**. + +For more on `git push --follow-tags`, see: + +* [git push --follow-tags in the online manual][ft-man] +* [Stack Overflow: How to push a tag to a remote repository using Git?][ft-so] + +[ft-man]: https://git-scm.com/docs/git-push#git-push---follow-tags +[ft-so]: https://stackoverflow.com/a/26438076 + +## NPM + +`npm publish`. Pretty easy! + +For the paranoid, use `npm pack` and install the resulting tarball locally with +`npm install` before publishing. + +## Homebrew + +The basic instructions are in the [Submit a new version of an existing +formula][brew] section of the Homebrew docs. + +[brew]: https://github.com/Homebrew/brew/blob/master/docs/How-To-Open-a-Homebrew-Pull-Request.md#submit-a-new-version-of-an-existing-formula + +An example using v1.1.0 (notice that this uses the sha256 sum of the tarball): + +```bash +$ curl -LOv https://github.com/bats-core/bats-core/archive/v1.1.0.tar.gz +$ openssl sha256 v1.1.0.tar.gz +SHA256(v1.1.0.tar.gz)=855d8b8bed466bc505e61123d12885500ef6fcdb317ace1b668087364717ea82 + +# Add the --dry-run flag to see the individual steps without executing. +$ brew bump-formula-pr \ + --url=https://github.com/bats-core/bats-core/archive/v1.1.0.tar.gz \ + --sha256=855d8b8bed466bc505e61123d12885500ef6fcdb317ace1b668087364717ea82 +``` +This resulted in https://github.com/Homebrew/homebrew-core/pull/29864, which was +automatically merged once the build passed. + +## Alpine Linux + +An example using v1.1.0 (notice that this uses the sha512 sum of the Zip file): + +```bash +$ curl -LOv https://github.com/bats-core/bats-core/archive/v1.1.0.zip +$ openssl sha512 v1.1.0.zip +SHA512(v1.1.0.zip)=accd83cfec0025a2be40982b3f9a314c2bbf72f5c85daffa9e9419611904a8d34e376919a5d53e378382e0f3794d2bd781046d810225e2a77812474e427bed9e +``` + +After cloning alpinelinux/aports, I used the above information to create: +https://github.com/alpinelinux/aports/pull/4696 + +**Note:** Currently users must enable the `edge` branch of the `community` repo +by adding/uncommenting the corresponding entry in `/etc/apk/repositories`. + +## Announce + +It's worth making a brief announcement like [the v1.1.0 announcement via +Gitter][gitter]: + +[gitter]: https://gitter.im/bats-core/bats-core?at=5b42c9a57b811a6d63daacb5 + +``` +v1.1.0 is now available via Homebrew and npm: +https://github.com/bats-core/bats-core/releases/tag/v1.1.0 + +It'll eventually be available in Alpine via the edge branch of the community +repo once alpinelinux/aports#4696 gets merged. (Check /etc/apk/repositories to +ensure this repo is enabled.) +``` diff --git a/tests/bats/bats-core/docs/source/_static/.gitkeep b/tests/bats/bats-core/docs/source/_static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/bats/bats-core/docs/source/_templates/.gitkeep b/tests/bats/bats-core/docs/source/_templates/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tests/bats/bats-core/docs/source/assets/README.md b/tests/bats/bats-core/docs/source/assets/README.md new file mode 100644 index 0000000..cfa3904 --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/README.md @@ -0,0 +1,24 @@ +# Our Logo + +
+ + + + +
+ +## Usage Guide for Third Parties + +There may be cases where you want to use our logo. Please follow these rules: + +**DO** use our logo as a part of thumbnails, banners/images in articles, or on a README in reference to the this project. + +**DO** use our logo to relate resources back to the Bats project, like file associations or links to the project page. + +**DO NOT** use our logo as the face of a third-party tool or extension that is not affiliated with the Bats project or Bats maintainers. + +If in doubt, ask if your intended usecase is approved. + +## Credits + +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). diff --git a/tests/bats/bats-core/docs/source/assets/dark_mode_bat.svg b/tests/bats/bats-core/docs/source/assets/dark_mode_bat.svg new file mode 100644 index 0000000..1e70621 --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/dark_mode_bat.svg @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/bats/bats-core/docs/source/assets/dark_mode_cube.svg b/tests/bats/bats-core/docs/source/assets/dark_mode_cube.svg new file mode 100644 index 0000000..2d324ae --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/dark_mode_cube.svg @@ -0,0 +1,98 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/bats/bats-core/docs/source/assets/dark_mode_wordmark_lowercase.svg b/tests/bats/bats-core/docs/source/assets/dark_mode_wordmark_lowercase.svg new file mode 100644 index 0000000..24df019 --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/dark_mode_wordmark_lowercase.svg @@ -0,0 +1,75 @@ + + + + + + + + + + + + + + + + + + + diff --git a/tests/bats/bats-core/docs/source/assets/dark_mode_wordmark_uppercase.svg b/tests/bats/bats-core/docs/source/assets/dark_mode_wordmark_uppercase.svg new file mode 100644 index 0000000..c2364bd --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/dark_mode_wordmark_uppercase.svg @@ -0,0 +1,80 @@ + + + + + + + + + + + + + + + + + + + diff --git a/tests/bats/bats-core/docs/source/assets/light_mode_bat.svg b/tests/bats/bats-core/docs/source/assets/light_mode_bat.svg new file mode 100644 index 0000000..915e447 --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/light_mode_bat.svg @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/bats/bats-core/docs/source/assets/light_mode_cube.svg b/tests/bats/bats-core/docs/source/assets/light_mode_cube.svg new file mode 100644 index 0000000..d4125ab --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/light_mode_cube.svg @@ -0,0 +1,90 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/tests/bats/bats-core/docs/source/assets/light_mode_wordmark_lowercase.svg b/tests/bats/bats-core/docs/source/assets/light_mode_wordmark_lowercase.svg new file mode 100644 index 0000000..8874ddc --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/light_mode_wordmark_lowercase.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + + + + + + + + diff --git a/tests/bats/bats-core/docs/source/assets/light_mode_wordmark_uppercase.svg b/tests/bats/bats-core/docs/source/assets/light_mode_wordmark_uppercase.svg new file mode 100644 index 0000000..b694f77 --- /dev/null +++ b/tests/bats/bats-core/docs/source/assets/light_mode_wordmark_uppercase.svg @@ -0,0 +1,48 @@ + + + + + + + + + + + + + + + + + + diff --git a/tests/bats/bats-core/docs/source/conf.py b/tests/bats/bats-core/docs/source/conf.py new file mode 100644 index 0000000..4c41910 --- /dev/null +++ b/tests/bats/bats-core/docs/source/conf.py @@ -0,0 +1,74 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'bats-core' +copyright = '2022, bats-core organization' +author = 'bats-core organization' + +# The full version, including alpha/beta/rc tags +release = '1' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'recommonmark', + 'sphinxcontrib.programoutput', + 'sphinx.ext.autosectionlabel' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +html_sidebars = { '**': [ + 'about.html', + 'navigation.html', + 'relations.html', + 'searchbox.html', + 'donate.html'] } + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +#html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static', 'assets'] +html_logo = "assets/light_mode_cube.svg" + +#man_pages = [ ('man.1', 'bats', 'bats documentation', ['bats-core Contributors'], 1)] + +def setup(app): + app.add_config_value('recommonmark_config', {'enable_eval_rst': True}, True) + import recommonmark + from recommonmark.transform import AutoStructify + app.add_transform(AutoStructify) diff --git a/tests/bats/bats-core/docs/source/docker-usage.md b/tests/bats/bats-core/docs/source/docker-usage.md new file mode 100644 index 0000000..16d7744 --- /dev/null +++ b/tests/bats/bats-core/docs/source/docker-usage.md @@ -0,0 +1,70 @@ +# Docker Usage Guide + +- [Docker Usage Guide](#docker-usage-guide) + * [Basic Usage](#basic-usage) + * [Basic Usage for bats project](#basic-usage-for-bats-project) + * [Docker Gotchas](#docker-gotchas) + * [Extending from the base image](#extending-from-the-base-image) + +## Basic Usage + +For test suites that are intended to run in isolation from their project code, you can mount the test directory and run the [official bats docker image](https://hub.docker.com/r/bats/bats): + +```bash +$ docker run -it -v "$PWD:/code" bats/bats:latest /code/test +``` + +This Docker image includes libraries like [bats-support](https://github.com/bats-core/bats-support) and [bats-assert](https://github.com/bats-core/bats-assert), which can be loaded in `setup` like this: + +```bash +setup() { + bats_load_library bats-support + bats_load_library bats-assert +} +``` + +## Basic Usage for Bats Project + +To build and run `bats`' own tests: +```bash +$ git clone https://github.com/bats-core/bats-core.git +Cloning into 'bats-core'... +remote: Counting objects: 1222, done. +remote: Compressing objects: 100% (53/53), done. +remote: Total 1222 (delta 34), reused 55 (delta 21), pack-reused 1146 +Receiving objects: 100% (1222/1222), 327.28 KiB | 1.70 MiB/s, done. +Resolving deltas: 100% (661/661), done. + +$ cd bats-core/ +$ docker build --tag bats/bats:latest . +... +$ docker run -it bats/bats:latest --formatter tap /opt/bats/test +``` + +To mount your tests into the container, first build the image as above. Then, for example with `bats`: +```bash +$ docker run -it -v "$PWD:/opt/bats" bats/bats:latest /opt/bats/test +``` +This runs the `test/` directory from the bats-core repository inside the bats Docker container. + +## Docker Gotchas + +Relying on functionality provided by your environment (ssh keys or agent, installed binaries, fixtures outside the mounted test directory) will fail when running inside Docker. + +`--interactive`/`-i` attaches an interactive terminal and is useful to kill hanging processes (otherwise has to be done via docker stop command). `--tty`/`-t` simulates a tty (often not used, but most similar to test runs from a Bash prompt). Interactivity is important to a user, but not a build, and TTYs are probably more important to a headless build. Everything's least-surprising to a new Docker use if both are used. + +## Extending from the base image + +Docker operates on a principle of isolation, and bundles all dependencies required into the Docker image. These can be mounted in at runtime (for test files, configuration, etc). For binary dependencies it may be better to extend the base Docker image with further tools and files. + +```dockerfile +FROM bats/bats + +RUN \ + apk \ + --no-cache \ + --update \ + add \ + openssh + +``` diff --git a/tests/bats/bats-core/docs/source/faq.rst b/tests/bats/bats-core/docs/source/faq.rst new file mode 100644 index 0000000..c1e24aa --- /dev/null +++ b/tests/bats/bats-core/docs/source/faq.rst @@ -0,0 +1,172 @@ +FAQ +=== + +How do I set the working directory? +----------------------------------- + +The working directory is simply the directory where you started when executing bats. +If you want to enforce a specific directory, you can use `cd` in the `setup_file`/`setup` functions. +However, be aware that code outside any function will run before any of these setup functions and might interfere with bats' internals. + + +How do I see the output of the command under `run` when a test fails? +--------------------------------------------------------------------- + +`run` captures stdout and stderr of its command and stores it in the `$output` and `${lines[@]}` variables. +If you want to see this output, you need to print it yourself, or use functions like `assert_output` that will reproduce it on failure. + +Can I use `--filter` to exclude files/tests? +-------------------------------------------- + +No, not directly. `--filter` uses a regex to match against test names. So you could try to invert the regex. +The filename won't be part of the strings that are tested, so you cannot filter against files. + +How can I exclude a single test from a test run? +------------------------------------------------ + +If you want to exclude only few tests from a run, you can either `skip` them: + +.. code-block:: bash + + @test "Testname" { + # yadayada + } + +becomes + +.. code-block:: bash + + @test "Testname" { + skip 'Optional skip message' + # yadayada + } + +or comment them out, e.g.: + +.. code-block:: bash + + @test "Testname" { + +becomes + +.. code-block:: bash + + disabled() { # @test "Testname" { + +For multiple tests or all tests of a file, this becomes tedious, so read on. + +How can I exclude all tests of a file from a test run? +-------------------------------------------------------- + +If you run your test suite by naming individual files like: + +.. code-block:: bash + + $ bats test/a.bats test/b.bats ... + +you can simply omit your file. When running a folder like + + +.. code-block:: bash + + $ bats test/ + +you can prevent test files from being picked up by changing their extension to something other than `.bats`. + +It is also possible to `skip` in `setup_file`/`setup` which will skip all tests in the file. + +How can I include my own `.sh` files for testing? +------------------------------------------------- + +You can simply `source .sh` files. However, be aware that `source`ing files with errors outside of any function (or inside `setup_file`) will trip up bats +and lead to hard to diagnose errors. +Therefore, it is safest to only `source` inside `setup` or the test functions themselves. + +How can I debug a failing test? +------------------------------- + +Short of using a bash debugger you should make sure to use appropriate asserts for your task instead of raw bash comparisons, e.g.: + +.. code-block:: bash + + @test test { + run echo test failed + assert_output "test" + # instead of + [ "$output" = "test" ] + } + +Because the former will print the output when the test fails while the latter won't. +Similarly, you should use `assert_success`/`assert_failure` instead of `[ "$status" -eq 0 ]` for return code checks. + +Is there a mechanism to add file/test specific functionality to a common setup function? +---------------------------------------------------------------------------------------- + +Often the setup consists of parts that are common between different files of a test suite and parts that are specific to each file. +There is no suite wide setup functionality yet, so you should extract these common setup steps into their own file (e.g. `common-test-setup.sh`) and function (e.g. `commonSetup() {}`), +which can be `source`d or `load`ed and call it in `setup_file` or `setup`. + +How can I use helper libraries like bats-assert? +------------------------------------------------ + +This is a short reproduction of https://github.com/ztombol/bats-docs. + +At first, you should make sure the library is installed. This is usually done in the `test_helper/` folders alongside the `.bats` files, giving you a filesystem layout like this: + +.. code-block:: + + test/ + test.bats + test_helper/ + bats-support/ + bats-assert/ + +Next, you should load those helper libraries: + +.. code-block:: bash + + setup() { + load 'test_helper/bats-support/load' # this is required by bats-assert! + load 'test_helper/bats-assert/load' + } + +Now, you should be able to use the functions from these helpers inside your tests, e.g.: + +.. code-block:: bash + + @test "test" { + run echo test + assert_output "test" + } + +Note that you obviously need to load the library before using it. +If you need the library inside `setup_file` or `teardown_file` you need to load it in `setup_file`. + +How to set a test timeout in bats? +---------------------------------- + +Set the variable `$BATS_TEST_TIMEOUT` before `setup()` starts. This means you can set it either on the command line, +in free code in the test file or in `setup_file()`. + +How can I lint/shell-format my bats tests? +------------------------------------------ + +Due to their custom syntax (`@test`), `.bats` files are not standard bash. This prevents most tools from working with bats. +However, there is an alternative syntax `function_name { # @test` to declare tests in a bash compliant manner. + +- shellcheck support since version 0.7 +- shfmt support since version 3.2.0 (using `-ln bats`) + + +How can I check if a test failed/succeeded during teardown? +----------------------------------------------------------- + +You can check `BATS_TEST_COMPLETED` which will be set to 1 if the test was successful or empty if it was not. +There is also `BATS_TEST_SKIPPED` which will be non-empty (contains the skip message or -1) when `skip` was called. + +How can I setup/cleanup before/after all tests? +----------------------------------------------- + +Setup/cleanup before/after all tests can be achieved using the special `setup_suite` and `teardown_suite` functions. +These functions must be placed into a dedicated `setup_suite.bash` file next to your `.bats` files. +For more information check out the :ref:`setup and teardown section `. diff --git a/tests/bats/bats-core/docs/source/gotchas.rst b/tests/bats/bats-core/docs/source/gotchas.rst new file mode 100644 index 0000000..485b675 --- /dev/null +++ b/tests/bats/bats-core/docs/source/gotchas.rst @@ -0,0 +1,132 @@ +Gotchas +======= + +My test fails although I return true? +------------------------------------- + +Using `return 1` to signify `true` for a success as is done often in other languages does not mesh well with Bash's +convention of using return code 0 to signify success and everything non-zero to indicate a failure. + +Please adhere to this idiom while using bats, or you will constantly work against your environment. + +My negated statement (e.g. ! true) does not fail the test, even when it should. +------------------------------------------------------------------------------- + +Bash deliberately excludes negated return values from causing a pipeline to exit (see bash's `-e` option). +Use `run !` on Bats 1.5.0 and above. For older bats versions, use one of `! x || false` or `run` with `[ $status != 0 ]`. + +If the negated command is the final statement in a test, that final statement's (negated) exit status will propagate through to the test's return code as usual. +Negated statements of one of the correct forms mentioned above will explicitly fail the test when the pipeline returns true, regardless of where they occur in the test. + +I cannot register a test multiple times via for loop. +----------------------------------------------------- + +The usual bats tests (`@test`) are preprocessed into functions. +Wrapping them into a for loop only redeclares this function. + +If you are interested in registering multiple calls to the same function, contribute your wishes to issue `#306 `_. + +I cannot pass parameters to test or .bats files. +------------------------------------------------ + +Especially while using bats via shebang: + +.. code-block:: bash + + #!/usr/bin/env bats + + @test "test" { + # ... + } + +You could be tempted to pass parameters to the test invocation like `./test.bats param1 param2`. +However, bats does not support passing parameters to files or tests. +If you need such a feature, please let us know about your usecase. + +As a workaround you can use environment variables to pass parameters. + +Why can't my function return results via a variable when using `run`? +--------------------------------------------------------------------- + +The `run` function executes its command in a subshell which means the changes to variables won't be available in the calling shell. + +If you want to test these functions, you should call them without `run`. + +`run` doesn't fail, although the same command without `run` does. +----------------------------------------------------------------- + +`run` is a wrapper that always succeeds. The wrapped command's exit code is stored in `$status` and the stdout/stderr in `$output`. +If you want to fail the test, you should explicitly check `$status` or omit `run`. See also `when not to use run `_. + +`load` won't load my `.sh` files. +--------------------------------- + +`load` is intended as an internal helper function that always loads `.bash` files (by appending this suffix). +If you want to load an `.sh` file, you can simple `source` it. + +I can't lint/shell-format my bats tests. +---------------------------------------- + +Bats uses a custom syntax for annotating tests (`@test`) that is not bash compliant. +Therefore, standard bash tooling won't be able to interact directly with `.bats` files. +Shellcheck supports bats' native syntax as of version 0.7. + +Additionally, there is bash compatible syntax for tests: + +.. code-block:: bash + + function bash_compliant_function_name_as_test_name { # @test + # your code + } + + +The output (stdout/err) from commands under `run` is not visible in failed tests. +--------------------------------------------------------------------------------- + +By default, `run` only stores stdout/stderr in `$output` (and `${lines[@]}`). +If you want to see this output, you either should use bat-assert's assertions or have to print `$output` before the check that fails. + +My piped command does not work under run. +----------------------------------------- + +Be careful with using pipes and with `run`. While your mind model of `run` might wrap the whole command behind it, bash's parser won't + +.. code-block:: bash + + run echo foo | grep bar + +Won't `run (echo foo | grep bar)` but will `(run echo foo) | grep bar`. If you need to incorporate pipes, you either should do + +.. code-block:: bash + + run bash -c 'echo foo | grep bar' + +or use a function to wrap the pipe in: + +.. code-block:: bash + + fun_with_pipes() { + echo foo | grep bar + } + + run fun_with_pipes + +`[[ ]]` (or `(( ))` did not fail my test +---------------------------------------- + +The `set -e` handling of `[[ ]]` and `(( ))` changed in Bash 4.1. Older versions, like 3.2 on MacOS, +don't abort the test when they fail, unless they are the last command before the (test) function returns, +making their exit code the return code. + +`[ ]` does not suffer from this, but is no replacement for all `[[ ]]` usecases. Appending ` || false` will work in all cases. + +Background tasks prevent the test run from terminating when finished +-------------------------------------------------------------------- + +When running a task in background, it will inherit the opened FDs of the process it was forked from. +This means that the background task forked from a Bats test will hold the FD for the pipe to the formatter that prints to the terminal, +thus keeping it open until the background task finished. +Due to implementation internals of Bats and bash, this pipe might be held in multiple FDs which all have to be closed by the background task. + +You can use `close_non_std_fds from `test/fixtures/bats/issue-205.bats` in the background job to close all FDs except stdin, stdout and stderr, thus solving the problem. +More details about the issue can be found in [#205](https://github.com/bats-core/bats-core/issues/205#issuecomment-973572596). diff --git a/tests/bats/bats-core/docs/source/index.rst b/tests/bats/bats-core/docs/source/index.rst new file mode 100644 index 0000000..b1867d6 --- /dev/null +++ b/tests/bats/bats-core/docs/source/index.rst @@ -0,0 +1,18 @@ +Welcome to bats-core's documentation! +===================================== + +Versions before v1.2.1 are documented over `there `_. + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + tutorial + installation + usage + docker-usage + writing-tests + gotchas + faq + warnings/index + support-matrix diff --git a/tests/bats/bats-core/docs/source/installation.rst b/tests/bats/bats-core/docs/source/installation.rst new file mode 100644 index 0000000..903650f --- /dev/null +++ b/tests/bats/bats-core/docs/source/installation.rst @@ -0,0 +1,138 @@ + +Installation +============ + +Linux: Distribition Package Manager +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Following Linux distributions provide Bats via their package manager: + +* Arch Linux: `extra/bats `__ +* Alpine Linux: `bats `__ +* Debian Linux: `shells/bats `__ +* Fedora Linux: `rpms/bats `__ +* Gentoo Linux `dev-util/bats `__ +* OpenSUSE Linux: `bats `__ +* Ubuntu Linux `shells/bats `__ + +**Note**: Bats versions pre 1.0 are from sstephenson's original project. +Consider using one of the other installation methods below to get the latest Bats release. +The test matrix above only applies to the latest Bats version. + +If your favorite distribution is not listed above, +you can try one of the following package managers or install from source. + +MacOS: Homebrew +^^^^^^^^^^^^^^^ + +On macOS, you can install `Homebrew `__ if you haven't already, +then run: + +.. code-block:: bash + + $ brew install bats-core + +Any OS: npm +^^^^^^^^^^^ + +You can install the `Bats npm package `__ via: + +.. code-block:: + + # To install globally: + $ npm install -g bats + + # To install into your project and save it as one of the "devDependencies" in + # your package.json: + $ npm install --save-dev bats + +Any OS: Installing Bats from source +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +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``\ , + +.. code-block:: + + $ git clone https://github.com/bats-core/bats-core.git + $ cd bats-core + $ ./install.sh /usr/local + + +**Note:** You may need to run ``install.sh`` with ``sudo`` if you do not have +permission to write to the installation prefix. + +Windows: Installing Bats from source via Git Bash +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Check out a copy of the Bats repository and install it to ``$HOME``. This +will place the ``bats`` executable in ``$HOME/bin``\ , which should already be +in ``$PATH``. + +.. code-block:: + + $ git clone https://github.com/bats-core/bats-core.git + $ cd bats-core + $ ./install.sh $HOME + + +Running Bats in Docker +^^^^^^^^^^^^^^^^^^^^^^ + +There is an official image on the Docker Hub: + +.. code-block:: + + $ docker run -it bats/bats:latest --version + + +Building a Docker image +~~~~~~~~~~~~~~~~~~~~~~~ + +Check out a copy of the Bats repository, then build a container image: + +.. code-block:: + + $ git clone https://github.com/bats-core/bats-core.git + $ cd bats-core + $ docker build --tag bats/bats:latest . + + +This creates a local Docker image called ``bats/bats:latest`` based on `Alpine +Linux `__ +(to push to private registries, tag it with another organisation, e.g. +``my-org/bats:latest``\ ). + +To run Bats' internal test suite (which is in the container image at +``/opt/bats/test``\ ): + +.. code-block:: + + $ docker run -it bats/bats:latest /opt/bats/test + + +To run a test suite from a directory called ``test`` in the current directory of +your local machine, mount in a volume and direct Bats to its path inside the +container: + +.. code-block:: + + $ docker run -it -v "${PWD}:/code" bats/bats:latest test + + +.. + + ``/code`` is the working directory of the Docker image. "${PWD}/test" is the + location of the test directory on the local machine. + + +This is a minimal Docker image. If more tools are required this can be used as a +base image in a Dockerfile using ``FROM ``. In the future there may +be images based on Debian, and/or with more tools installed (\ ``curl`` and ``openssl``\ , +for example). If you require a specific configuration please search and +1 an +issue or `raise a new issue `__. + +Further usage examples are in +`the wiki `__. diff --git a/tests/bats/bats-core/docs/source/requirements.txt b/tests/bats/bats-core/docs/source/requirements.txt new file mode 100644 index 0000000..b61574d --- /dev/null +++ b/tests/bats/bats-core/docs/source/requirements.txt @@ -0,0 +1,2 @@ +sphinxcontrib-programoutput +recommonmark \ No newline at end of file diff --git a/tests/bats/bats-core/docs/source/support-matrix.rst b/tests/bats/bats-core/docs/source/support-matrix.rst new file mode 100644 index 0000000..b67be42 --- /dev/null +++ b/tests/bats/bats-core/docs/source/support-matrix.rst @@ -0,0 +1,26 @@ +Support Matrix +============== + +Supported Bash versions +^^^^^^^^^^^^^^^^^^^^^^^ + +The following is a list of Bash versions that are currently supported by Bats and verified through automated tests: + + * 3.2.57(1) (macOS's highest bundled version) + * 4.0, 4.1, 4.2, 4.3, 4.4 + * 5.0, 5.1, 5.2 + +Supported Operating systems +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following Operating Systems are supported and tested automatically (CI) or manually during development: + + * Linux: Alpine (CI), Alma 8 (CI), Arch Linux (manual), Ubuntu 20.04/22.04 (CI) + * FreeBSD: 11 (CI) + * macOS: 11 (CI), 12 (CI) + * Windows: Server 2019 (CI), 10 (manual) + + * Git for Windows Bash (MSYS2 based) + * Windows Subsystem for Linux + * MSYS2 + * Cygwin diff --git a/tests/bats/bats-core/docs/source/tutorial.rst b/tests/bats/bats-core/docs/source/tutorial.rst new file mode 100644 index 0000000..72a5409 --- /dev/null +++ b/tests/bats/bats-core/docs/source/tutorial.rst @@ -0,0 +1,661 @@ +Tutorial +======== + +This tutorial is intended for beginners with bats and possibly bash. +Make sure to also read the list of gotchas and the faq. + +For this tutorial we are assuming you already have a project in a git repository and want to add tests. +Ultimately they should run in the CI environment but will also be started locally during development. + +.. + TODO: link to example repository? + +Quick installation +------------------ + +Since we already have an existing git repository, it is very easy to include bats and its libraries as submodules. +We are aiming for following filesystem structure: + +.. code-block:: + + src/ + project.sh + ... + test/ + bats/ <- submodule + test_helper/ + bats-support/ <- submodule + bats-assert/ <- submodule + test.bats + ... + +So we start from the project root: + +.. code-block:: console + + git submodule add https://github.com/bats-core/bats-core.git test/bats + git submodule add https://github.com/bats-core/bats-support.git test/test_helper/bats-support + git submodule add https://github.com/bats-core/bats-assert.git test/test_helper/bats-assert + +Your first test +--------------- + +Now we want to add our first test. + +In the tutorial repository, we want to build up our project in a TDD fashion. +Thus, we start with an empty project and our first test is to just run our (nonexistent) shell script. + +We start by creating a new test file `test/test.bats` + +.. code-block:: bash + + @test "can run our script" { + ./project.sh + } + +and run it by + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✗ can run our script + (in test file test/test.bats, line 2) + `./project.sh' failed with status 127 + /tmp/bats-run-19605/bats.19627.src: line 2: ./project.sh: No such file or directory + + 1 test, 1 failure + +Okay, our test is red. Obviously, the project.sh doesn't exist, so we create the file `src/project.sh`: + +.. code-block:: console + + mkdir src/ + echo '#!/usr/bin/env bash' > src/project.sh + chmod a+x src/project.sh + +A new test run gives us + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✗ can run our script + (in test file test/test.bats, line 2) + `./project.sh' failed with status 127 + /tmp/bats-run-19605/bats.19627.src: line 2: ./project.sh: No such file or directory + + 1 test, 1 failure + +Oh, we still used the wrong path. No problem, we just need to use the correct path to `project.sh`. +Since we're still in the same directory as when we started `bats`, we can simply do: + +.. code-block:: bash + + @test "can run our script" { + ./src/project.sh + } + +and get: + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✓ can run our script + + 1 test, 0 failures + +Yesss! But that victory feels shallow: What if somebody less competent than us starts bats from another directory? + +Let's do some setup +------------------- + +The obvious solution to becoming independent of `$PWD` is using some fixed anchor point in the filesystem. +We can use the path to the test file itself as an anchor and rely on the internal project structure. +Since we are lazy people and want to treat our project's files as first class citizens in the executable world, we will also put them on the `$PATH`. +Our new `test/test.bats` now looks like this: + +.. code-block:: bash + + setup() { + # get the containing directory of this file + # use $BATS_TEST_FILENAME instead of ${BASH_SOURCE[0]} or $0, + # as those will point to the bats executable's location or the preprocessed file respectively + DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )" + # make executables in src/ visible to PATH + PATH="$DIR/../src:$PATH" + } + + @test "can run our script" { + # notice the missing ./ + # As we added src/ to $PATH, we can omit the relative path to `src/project.sh`. + project.sh + } + +still giving us: + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✓ can run our script + + 1 test, 0 failures + +It still works as expected. This is because the newly added `setup` function put the absolute path to `src/` onto `$PATH`. +This setup function is automatically called before each test. +Therefore, our test could execute `project.sh` directly, without using a (relative) path. + +.. important:: + + The `setup` function will be called before each individual test in the file. + Each file can only define one setup function for all tests in the file. + However, the setup functions can differ between different files. + +Dealing with output +------------------- + +Okay, we have a green test but our executable does not do anything useful. +To keep things simple, let us start with an error message. Our new `src/project.sh` now reads: + +.. code-block:: bash + + #!/usr/bin/env bash + + echo "Welcome to our project!" + + echo "NOT IMPLEMENTED!" >&2 + exit 1 + +And gives is this test output: + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✗ can run our script + (in test file test/test.bats, line 11) + `project.sh' failed + Welcome to our project! + NOT IMPLEMENTED! + + 1 test, 1 failure + +Okay, our test failed, because we now exit with 1 instead of 0. +Additionally, we see the stdout and stderr of the failing program. + +Our goal now is to retarget our test and check that we get the welcome message. +bats-assert gives us some help with this, so we should now load it (and its dependency bats-support), +so we change `test/test.bats` to + +.. code-block:: bash + + setup() { + load 'test_helper/bats-support/load' + load 'test_helper/bats-assert/load' + # ... the remaining setup is unchanged + + # get the containing directory of this file + # use $BATS_TEST_FILENAME instead of ${BASH_SOURCE[0]} or $0, + # as those will point to the bats executable's location or the preprocessed file respectively + DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )" + # make executables in src/ visible to PATH + PATH="$DIR/../src:$PATH" + } + + @test "can run our script" { + run project.sh # notice `run`! + assert_output 'Welcome to our project!' + } + +which gives us the following test output: + +.. code-block:: console + + $ LANG=C ./test/bats/bin/bats test/test.bats + ✗ can run our script + (from function `assert_output' in file test/test_helper/bats-assert/src/assert_output.bash, line 194, + in test file test/test.bats, line 14) + `assert_output 'Welcome to our project!'' failed + + -- output differs -- + expected (1 lines): + Welcome to our project! + actual (2 lines): + Welcome to our project! + NOT IMPLEMENTED! + -- + + + 1 test, 1 failure + +The first change in this output is the failure description. We now fail on assert_output instead of the call itself. +We prefixed our call to `project.sh` with `run`, which is a function provided by bats that executes the command it gets passed as parameters. +Then, `run` sucks up the stdout and stderr of the command it ran and stores it in `$output`, stores the exit code in `$status` and returns 0. +This means `run` never fails the test and won't generate any context/output in the log of a failed test on its own. + +Marking the test as failed and printing context information is up to the consumers of `$status` and `$output`. +`assert_output` is such a consumer, it compares `$output` to the parameter it got and tells us quite succinctly that it did not match in this case. + +For our current test we don't care about any other output or the error message, so we want it gone. +`grep` is always at our fingertips, so we tape together this ramshackle construct + +.. code-block:: bash + + run project.sh 2>&1 | grep Welcome + +which gives us the following test result: + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✗ can run our script + (in test file test/test.bats, line 13) + `run project.sh | grep Welcome' failed + + 1 test, 1 failure + +Huh, what is going on? Why does it fail the `run` line again? + +This is a common mistake that can happen when our mind parses the file differently than the bash parser. +`run` is just a function, so the pipe won't actually be forwarded into the function. Bash reads this as `(run project.sh) | grep Welcome`, +instead of our intended `run (project.sh | grep Welcome)`. + +Unfortunately, the latter is not valid bash syntax, so we have to work around it, e.g. by using a function: + +.. code-block:: bash + + get_projectsh_welcome_message() { + project.sh 2>&1 | grep Welcome + } + + @test "Check welcome message" { + run get_projectsh_welcome_message + assert_output 'Welcome to our project!' + } + +Now our test passes again but having to write a function each time we want only a partial match does not accommodate our laziness. +Isn't there an app for that? Maybe we should look at the documentation? + + Partial matching can be enabled with the --partial option (-p for short). When used, the assertion fails if the expected substring is not found in $output. + + -- the documentation for `assert_output `_ + +Okay, so maybe we should try that: + +.. code-block:: bash + + @test "Check welcome message" { + run project.sh + assert_output --partial 'Welcome to our project!' + } + +Aaannnd ... the test stays green. Yay! + +There are many other asserts and options but this is not the place for all of them. +Skimming the documentation of `bats-assert `_ will give you a good idea what you can do. +You should also have a look at the other helper libraries `here `_ like `bats-file `_, +to avoid reinventing the wheel. + + +Cleaning up your mess +--------------------- + +Often our setup or tests leave behind some artifacts that clutter our test environment. +You can define a `teardown` function which will be called after each test, regardless whether it failed or not. + +For example, we now want our project.sh to only show the welcome message on the first invocation. +So we change our test to this: + +.. code-block:: bash + + @test "Show welcome message on first invocation" { + run project.sh + assert_output --partial 'Welcome to our project!' + + run project.sh + refute_output --partial 'Welcome to our project!' + } + +This test fails as expected: + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✗ Show welcome message on first invocation + (from function `refute_output' in file test/test_helper/bats-assert/src/refute_output.bash, line 189, + in test file test/test.bats, line 17) + `refute_output --partial 'Welcome to our project!'' failed + + -- output should not contain substring -- + substring (1 lines): + Welcome to our project! + output (2 lines): + Welcome to our project! + NOT IMPLEMENTED! + -- + + + 1 test, 1 failure + +Now, to get the test green again, we want to store the information that we already ran in the file `/tmp/bats-tutorial-project-ran`, +so our `src/project.sh` becomes: + +.. code-block:: bash + + #!/usr/bin/env bash + + FIRST_RUN_FILE=/tmp/bats-tutorial-project-ran + + if [[ ! -e "$FIRST_RUN_FILE" ]]; then + echo "Welcome to our project!" + touch "$FIRST_RUN_FILE" + fi + + echo "NOT IMPLEMENTED!" >&2 + exit 1 + +And our test says: + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✓ Show welcome message on first invocation + + 1 test, 0 failures + +Nice, we're done, or are we? Running the test again now gives: + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + ✗ Show welcome message on first invocation + (from function `assert_output' in file test/test_helper/bats-assert/src/assert_output.bash, line 186, + in test file test/test.bats, line 14) + `assert_output --partial 'Welcome to our project!'' failed + + -- output does not contain substring -- + substring : Welcome to our project! + output : NOT IMPLEMENTED! + -- + + + 1 test, 1 failure + +Now the first assert failed, because of the leftover `$FIRST_RUN_FILE` from the last test run. + +Luckily, bats offers the `teardown` function, which can take care of that, we add the following code to `test/test.bats`: + +.. code-block:: bash + + teardown() { + rm -f /tmp/bats-tutorial-project-ran + } + +Now running the test again first give us the same error, as the teardown has not run yet. +On the second try we get a clean `/tmp` folder again and our test passes consistently now. + +It is worth noting that we could do this `rm` in the test code itself but it would get skipped on failures. + +.. important:: + + A test ends at its first failure. None of the subsequent commands in this test will be executed. + The `teardown` function runs after each individual test in a file, regardless of test success or failure. + Similarly to `setup`, each `.bats` file can have its own `teardown` function which will be the same for all tests in the file. + +Test what you can +----------------- + +Sometimes tests rely on the environment to provide infrastructure that is needed for the test. +If not all test environments provide this infrastructure but we still want to test on them, +it would be unhelpful to get errors on parts that are not testable. + +Bats provides you with the `skip` command which can be used in `setup` and `test`. + +.. tip:: + + You should `skip` as early as you know it does not make sense to continue. + +In our example project we rewrite the welcome message test to `skip` instead of doing cleanup: + +.. code-block:: bash + + teardown() { + : # Look Ma! No cleanup! + } + + @test "Show welcome message on first invocation" { + if [[ -e /tmp/bats-tutorial-project-ran ]]; then + skip 'The FIRST_RUN_FILE already exists' + fi + + run project.sh + assert_output --partial 'Welcome to our project!' + + run project.sh + refute_output --partial 'Welcome to our project!' + } + +The first test run still works due to the cleanup from the last round. However, our second run gives us: + +.. code-block:: console + + $ ./test/bats/bin/bats test/test.bats + - Show welcome message on first invocation (skipped: The FIRST_RUN_FILE already exists) + + 1 test, 0 failures, 1 skipped + +.. important:: + + Skipped tests won't fail a test suite and are counted separately. + No test command after `skip` will be executed. If an error occurs before `skip`, the test will fail. + An optional reason can be passed to `skip` and will be printed in the test output. + +Setting up a multifile test suite +--------------------------------- + +With a growing project, putting all tests into one file becomes unwieldy. +For our example project, we will extract functionality into the additional file `src/helper.sh`: + +.. code-block:: bash + + #!/usr/bin/env bash + + _is_first_run() { + local FIRST_RUN_FILE=/tmp/bats-tutorial-project-ran + if [[ ! -e "$FIRST_RUN_FILE" ]]; then + touch "$FIRST_RUN_FILE" + return 0 + fi + return 1 + } + +This allows for testing it separately in a new file `test/helper.bats`: + +.. code-block:: bash + + setup() { + load 'test_helper/common-setup' + _common_setup + + source "$PROJECT_ROOT/src/helper.sh" + } + + teardown() { + rm -f "$NON_EXISTANT_FIRST_RUN_FILE" + rm -f "$EXISTING_FIRST_RUN_FILE" + } + + @test "Check first run" { + NON_EXISTANT_FIRST_RUN_FILE=$(mktemp -u) # only create the name, not the file itself + + assert _is_first_run + refute _is_first_run + refute _is_first_run + + EXISTING_FIRST_RUN_FILE=$(mktemp) + refute _is_first_run + refute _is_first_run + } + +Since the setup function would have duplicated much of the other files', we split that out into the file `test/test_helper/common-setup.bash`: + +.. code-block:: bash + + #!/usr/bin/env bash + + _common_setup() { + load 'test_helper/bats-support/load' + load 'test_helper/bats-assert/load' + # get the containing directory of this file + # use $BATS_TEST_FILENAME instead of ${BASH_SOURCE[0]} or $0, + # as those will point to the bats executable's location or the preprocessed file respectively + PROJECT_ROOT="$( cd "$( dirname "$BATS_TEST_FILENAME" )/.." >/dev/null 2>&1 && pwd )" + # make executables in src/ visible to PATH + PATH="$PROJECT_ROOT/src:$PATH" + } + +with the following `setup` in `test/test.bats`: + +.. code-block:: bash + + setup() { + load 'test_helper/common-setup' + _common_setup + } + +Please note, that we gave our helper the extension `.bash`, which is automatically appended by `load`. + +.. important:: + + `load` automatically tries to append `.bash` to its argument. + +In our new `test/helper.bats` we can see, that loading `.sh` is simply done via `source`. + +.. tip:: + + Avoid using `load` and `source` outside of any functions. + If there is an error in the test file's "free code", the diagnostics are much worse than for code in `setup` or `@test`. + +With the new changes in place, we can run our tests again. However, our previous run command does not include the new file. +You could add the new file to the parameter list, e.g. by running `./test/bats/bin/bats test/*.bats`. +However, bats also can handle directories: + +.. code-block:: console + + $ ./test/bats/bin/bats test/ + ✓ Check first run + - Show welcome message on first invocation (skipped: The FIRST_RUN_FILE already exists) + + 2 tests, 0 failures, 1 skipped + +In this mode, bats will pick up all `.bats` files in the directory it was given. There is an additional `-r` switch that will recursively search for more `.bats` files. +However, in our project layout this would pick up the test files of bats itself from `test/bats/test`. We don't have test subfolders anyways, so we can do without `-r`. + + +Avoiding costly repeated setups +------------------------------- + +We already have seen the `setup` function in use, which is called before each test. +Sometimes our setup is very costly, such as booting up a service just for testing. +If we can reuse the same setup across multiple tests, we might want to do only one setup before all these tests. + +This usecase is exactly what the `setup_file` function was created for. +It can be defined per file and will run before all tests of the respective file. +Similarly, we have `teardown_file`, which will run after all tests of the file, even when you abort a test run or a test failed. + +As an example, we want to add an echo server capability to our project. First, we add the following `server.bats` to our suite: + +.. code-block:: bash + + setup_file() { + load 'test_helper/common-setup' + _common_setup + PORT=$(project.sh start-echo-server 2>&1 >/dev/null) + export PORT + } + + @test "server is reachable" { + nc -z localhost "$PORT" + } + +Which will obviously fail: + +Note that `export PORT` to make it visible to the test! +Running this gives us: + +.. + TODO: Update this example with fixed test name reporting from setup_file? (instead of "✗ ") + +.. code-block:: console + + $ ./test/bats/bin/bats test/server.bats + ✗ + (from function `setup_file' in test file test/server.bats, line 4) + `PORT=$(project.sh start-echo-server >/dev/null 2>&1)' failed + + 1 test, 1 failure + +Now that we got our red test, we need to get it green again. +Our new `project.sh` now ends with: + +.. code-block:: bash + + case $1 in + start-echo-server) + echo "Starting echo server" + PORT=2000 + ncat -l $PORT -k -c 'xargs -n1 echo' 2>/dev/null & # don't keep open this script's stderr + echo $! > /tmp/project-echo-server.pid + echo "$PORT" >&2 + ;; + *) + echo "NOT IMPLEMENTED!" >&2 + exit 1 + ;; + esac + +and the tests now say + +.. code-block:: console + + $ LANG=C ./test/bats/bin/bats test/server.bats + ✓ server is reachable + + 1 test, 0 failures + +However, running this a second time gives: + +.. code-block:: console + + $ ./test/bats/bin/bats test/server.bats + ✗ server is reachable + (in test file test/server.bats, line 14) + `nc -z -w 2 localhost "$PORT"' failed + 2000 + Ncat: bind to :::2000: Address already in use. QUITTING. + nc: port number invalid: 2000 + Ncat: bind to :::2000: Address already in use. QUITTING. + + 1 test, 1 failure + +Obviously, we did not turn off our server after testing. +This is a task for `teardown_file` in `server.bats`: + +.. code-block:: bash + + teardown_file() { + project.sh stop-echo-server + } + +Our `project.sh` should also get the new command: + +.. code-block:: bash + + stop-echo-server) + kill "$(< "/tmp/project-echo-server.pid")" + rm /tmp/project-echo-server.pid + ;; + +Now starting our tests again will overwrite the .pid file with the new instance's, so we have to do manual cleanup once. +From now on, our test should clean up after itself. + +.. note:: + + `teardown_file` will run regardless of tests failing or succeeding. diff --git a/tests/bats/bats-core/docs/source/usage.md b/tests/bats/bats-core/docs/source/usage.md new file mode 100644 index 0000000..bdbe407 --- /dev/null +++ b/tests/bats/bats-core/docs/source/usage.md @@ -0,0 +1,114 @@ +# Usage + +Bats comes with two manual pages. After installation you can view them with `man +1 bats` (usage manual) and `man 7 bats` (writing test files manual). Also, you +can view the available command line options that Bats supports by calling Bats +with the `-h` or `--help` options. These are the options that Bats currently +supports: + +``` eval_rst +.. program-output:: ../../bin/bats --help +``` + +To run your tests, invoke the `bats` interpreter with one or more paths to test +files ending with the `.bats` extension, or paths to directories containing test +files. (`bats` will only execute `.bats` files at the top level of each +directory; it will not recurse unless you specify the `-r` flag.) + +Test cases from each file 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. + +```text +$ 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][tap-format]. + +You can force TAP output from a terminal by invoking Bats with the `--formatter tap` +option. + +```text +$ bats --formatter tap addition.bats +1..2 +ok 1 addition using bc +ok 2 addition using dc +``` + +With `--formatter junit`, it is possible +to output junit-compatible report files. + +```text +$ bats --formatter junit addition.bats +1..2 +ok 1 addition using bc +ok 2 addition using dc +``` + +If you have your own formatter, you can use an absolute path to the executable +to use it: + +```bash +$ bats --formatter /absolute/path/to/my-formatter addition.bats +addition using bc WORKED +addition using dc FAILED +``` + +You can also generate test report files via `--report-formatter` which accepts +the same options as `--formatter`. By default, the file is stored in the current +workdir. However, it may be placed elsewhere by specifying the `--output` flag. + +```text +$ bats --report-formatter junit addition.bats --output /tmp +1..2 +ok 1 addition using bc +ok 2 addition using dc + +$ cat /tmp/report.xml + + + + + + + +``` + +## Parallel Execution + +``` eval_rst +.. versionadded:: 1.0.0 +``` + +By default, Bats will execute your tests serially. However, Bats supports +parallel execution of tests (provided you have [GNU parallel][gnu-parallel] or +a compatible replacement installed) using the `--jobs` parameter. This can +result in your tests completing faster (depending on your tests and the testing +hardware). + +Ordering of parallelised tests is not guaranteed, so this mode may break suites +with dependencies between tests (or tests that write to shared locations). When +enabling `--jobs` for the first time be sure to re-run bats multiple times to +identify any inter-test dependencies or non-deterministic test behaviour. + +When parallelizing, the results of a file only become visible after it has been finished. +You can use `--no-parallelize-across-files` to get immediate output at the cost of reduced +overall parallelity, as parallelization will only happen within files and files will be run +sequentially. + +If you have files where tests within the file would interfere with each other, you can use +`--no-parallelize-within-files` to disable parallelization within all files. +If you want more fine-grained control, you can `export BATS_NO_PARALLELIZE_WITHIN_FILE=true` in `setup_file()` +or outside any function to disable parallelization only within the containing file. + +[tap-format]: https://testanything.org +[gnu-parallel]: https://www.gnu.org/software/parallel/ diff --git a/tests/bats/bats-core/docs/source/warnings/BW01.rst b/tests/bats/bats-core/docs/source/warnings/BW01.rst new file mode 100644 index 0000000..8ae8bb6 --- /dev/null +++ b/tests/bats/bats-core/docs/source/warnings/BW01.rst @@ -0,0 +1,17 @@ +BW01: `run`'s command `` exited with code 127, indicating 'Command not found'. Use run's return code checks, e.g. `run -127`, to fix this message. +=========================================================================================================================================================== + +Due to `run`'s default behavior of always succeeding, errors in the command string can remain hidden from the user, e.g.[here](https://github.com/bats-core/bats-core/issues/578). +As a proxy for this problem, the return code is checked for value 127 ("Command not found"). + +How to fix +---------- + +If your command should actually return code 127, then you can simply use `run -127 ` to state your intent and the message will go away. + +If your command should not return 127, you should fix the problem with the command. +Take a careful look at the command string in the warning message, to see if it contains code that you did not intend to run. + +If your command should sometimes return 127, but never 0, you can use `run ! `. + +If your command can sometimes return 127 and sometimes 0, the please submit an issue. \ No newline at end of file diff --git a/tests/bats/bats-core/docs/source/warnings/BW02.rst b/tests/bats/bats-core/docs/source/warnings/BW02.rst new file mode 100644 index 0000000..a58c395 --- /dev/null +++ b/tests/bats/bats-core/docs/source/warnings/BW02.rst @@ -0,0 +1,46 @@ +BW02: requires at least BATS_VERSION=. Use `bats_require_minimum_version ` to fix this message. +=========================================================================================================================== + +Using a feature that is only available starting with a certain version can be a problem when your tests also run on older versions of Bats. +In most cases, running this code in older versions will generate an error due to a missing command. +However, in cases like `run`'s where old version simply take all parameters as command to execute, the failure can be silent. + +How to fix BW02 +--------------- + +When you encounter this warning, you can simply guard your code with `bats_require_minimum_version ` as the message says. +For example, consider the following code: + +.. code-block:: bash + + @test test { + bats_require_minimum_version 1.5.0 + # pre 1.5.0 the flag --separate-stderr would be interpreted as command to run + run --separate-stderr some-command + [ $output = "blablabla" ] + } + + +The call to `bats_require_minimum_version` can be put anywhere before the warning generating command, even in `setup`, `setup_file`, or even outside any function. +This can be used to give fine control over the version dependencies: + +.. code-block:: bash + + @test test { + bats_require_minimum_version 1.5.0 + # pre 1.5.0 the flag --separate-stderr would be interpreted as command to run + run --separate-stderr some-command + [ $output = "blablabla" ] + } + + @test test2 { + run some-other-command # no problem executing on earlier version + } + + +If the above code is executed on a system with a `BATS_VERSION` pre 1.5.0, the first test will fail on `bats_require_minimum_version 1.5.0`. + +Instances: +---------- + +- run's non command parameters like `--keep-empty-lines` are only available since 1.5.0 \ No newline at end of file diff --git a/tests/bats/bats-core/docs/source/warnings/BW03.rst b/tests/bats/bats-core/docs/source/warnings/BW03.rst new file mode 100644 index 0000000..fb79d56 --- /dev/null +++ b/tests/bats/bats-core/docs/source/warnings/BW03.rst @@ -0,0 +1,15 @@ +BW03: `setup_suite` is visible to test file '', but was not executed. It belongs into 'setup_suite.bash' to be picked up automatically. +============================================================================================================================================= + +In contrast to the other setup functions, `setup_suite` must not be defined in `*.bats` files but in `setup_suite.bash`. +When a file is executed and sees `setup_suite` defined but not run before the tests, this warning will be printed. + +How to fix BW03 +--------------- + +The fix depends on your actual intention. There are basically two cases: + +1. You want a setup before all tests and accidentally put `setup_suite` into a test file instead of `setup_suite.bash`. + Simply move `setup_suite` (and `teardown_suite`!) into `setup_suite.bash`. +2. You did not mean to run a setup before any test but need to defined a function named `setup_suite` in your test file. + In this case, you can silence this warning by assigning `BATS_SETUP_SUITE_COMPLETED='suppress BW03'`. \ No newline at end of file diff --git a/tests/bats/bats-core/docs/source/warnings/index.rst b/tests/bats/bats-core/docs/source/warnings/index.rst new file mode 100644 index 0000000..957fc43 --- /dev/null +++ b/tests/bats/bats-core/docs/source/warnings/index.rst @@ -0,0 +1,28 @@ +Warnings +======== + +Starting with version 1.7.0 Bats shows warnings about issues it found during the test run. +They are printed on stderr after all other output: + +.. code-block:: bash + + BW01.bats + ✓ Trigger BW01 + + 1 test, 0 failures + + + The following warnings were encountered during tests: + BW01: `run`'s command `=0 actually-intended-command with some args` exited with code 127, indicating 'Command not found'. Use run's return code checks, e.g. `run -127`, to fix this message. + (from function `run' in file lib/bats-core/test_functions.bash, line 299, + in test file test/fixtures/warnings/BW01.bats, line 3) + +A warning will not make a successful run fail but should be investigated and taken seriously, since it hints at a possible error. + +Currently, Bats emits the following warnings: + +.. toctree:: + + BW01 + BW02 + BW03 \ No newline at end of file diff --git a/tests/bats/bats-core/docs/source/writing-tests.md b/tests/bats/bats-core/docs/source/writing-tests.md new file mode 100644 index 0000000..88cdf5d --- /dev/null +++ b/tests/bats/bats-core/docs/source/writing-tests.md @@ -0,0 +1,614 @@ +# Writing tests + +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. + +For more details about how Bats evaluates test files, see [Bats Evaluation +Process][bats-eval] on the wiki. + +For sample test files, see [examples](https://github.com/bats-core/bats-core/tree/master/docs/examples). + +[bats-eval]: https://github.com/bats-core/bats-core/wiki/Bats-Evaluation-Process + +## Tagging tests + +Starting with version 1.8.0, Bats comes with a tagging system that allows users +to categorize their tests and filter according to those categories. + +Each test has a list of tags attached to it. Without specification, this list is empty. +Tags can be defined in two ways. The first being `# bats test_tags=`: + +```bash +# bats test_tags=tag:1, tag:2, tag:3 +@test "first test" { + # ... +} + +@test "second test" { + # ... +} +``` + +These tags (`tag:1`, `tag:2`, `tag:3`) will be attached to the test `first test`. +The second test will have no tags attached. Values defined in the `# bats test_tags=` +directive will be assigned to the next `@test` that is being encountered in the +file and forgotten after that. Only the value of the last `# bats test_tags=` directive +before a given test will be used. + +Sometimes, we want to give all tests in a file a set of the same tags. This can +be achieved via `# bats file_tags=`. They will be added to all tests in the file +after that directive. An additional `# bats file_tags=` directive will override +the previously defined values: + +```bash +@test "Zeroth test" { + # will have no tags +} + +# bats file_tags=a:b +# bats test_tags=c:d + +@test "First test" { + # will be tagged a:b, c:d +} + +# bats file_tags= + +@test "Second test" { + # will have no tags +} +``` + +Tags are case sensitive and must only consist of alphanumeric characters and `_`, + `-`, or `:`. They must not contain whitespaces! +The colon is intended as a separator for (recursive) namespacing. + +Tag lists must be separated by commas and are allowed to contain whitespace. +They must not contain empty tags like `test_tags=,b` (first tag is empty), +`test_tags=a,,c`, `test_tags=a, ,c` (second tag is only whitespace/empty), +`test_tags=a,b,` (third tag is empty). + +Every tag starting with `bats:` (case insensitive!) is reserved for Bats' +internal use. + +### Special tags + +#### Focusing on tests with `bats:focus` tag + +If a test with the tag `bats:focus` is encountered in a test suite, +all other tests will be filtered out and only those tagged with this tag will be executed. + +In focus mode, the exit code of successful runs will be overridden to 1 to prevent CI from silently running on a subset of tests due to an accidentally committed `bats:focus` tag. +Should you require the true exit code, e.g. for a `git bisect` operation, you can disable this behavior by setting +`BATS_NO_FAIL_FOCUS_RUN=1` when running `bats`, but make sure not to commit this to CI! + +### Filtering execution + +Tags can be used for more finegrained filtering of which tests to run via `--filter-tags`. +This accepts a comma separated list of tags. Only tests that match all of these +tags will be executed. For example, `bats --filter-tags a,b,c` will pick up tests +with tags `a,b,c`, but not tests that miss one or more of those tags. + +Additionally, you can specify negative tags via `bats --filter-tags a,!b,c`, +which now won't match tests with tags `a,b,c`, due to the `b`, but will select `a,c`. +To put it more formally, `--filter-tags` is a boolean conjunction. + +To allow for more complex queries, you can specify multiple `--filter-tags`. +A test will be executed, if it matches at least one of them. +This means multiple `--filter-tags` form a boolean disjunction. + +A query of `--filter-tags a,!b --filter-tags b,c` can be translated to: +Execute only tests that (have tag a, but not tag b) or (have tag b and c). + +An empty tag list matches tests without tags. + +## Comment syntax + +External tools (like `shellcheck`, `shfmt`, and various IDE's) may not support +the standard `.bats` syntax. Because of this, we provide a valid `bash` +alternative: + +```bash +function invoking_foo_without_arguments_prints_usage { #@test + run foo + [ "$status" -eq 1 ] + [ "${lines[0]}" = "usage: foo " ] +} +``` + +When using this syntax, the function name will be the title in the result output +and the value checked when using `--filter`. + +## `run`: Test other commands + +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. + +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'" ] + [ "$BATS_RUN_COMMAND" = "foo nonexistent_filename" ] + +} +``` + +The `$status` variable contains the status code of the command, the +`$output` variable contains the combined contents of the command's standard +output and standard error streams, and the `$BATS_RUN_COMMAND` string contains the +command and command arguments passed to `run` for execution. + +If invoked with one of the following as the first argument, `run` +will perform an implicit check on the exit status of the invoked command: + +```pre + -N expect exit status N (0-255), fail if otherwise + ! expect nonzero exit status (1-255), fail if command succeeds +``` + +We can then write the above more elegantly as: + +```bash +@test "invoking foo with a nonexistent file prints an error" { + run -1 foo nonexistent_filename + [ "$output" = "foo: no such file 'nonexistent_filename'" ] +} +``` + +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: + +```bash +@test "invoking foo without arguments prints usage" { + run -1 foo + [ "${lines[0]}" = "usage: foo " ] +} +``` + +__Note:__ The `run` helper executes its argument(s) in a subshell, so if +writing tests against environmental side-effects like a variable's value +being changed, these changes will not persist after `run` completes. + +By default `run` leaves out empty lines in `${lines[@]}`. Use +`run --keep-empty-lines` to retain them. + +Additionally, you can use `--separate-stderr` to split stdout and stderr +into `$output`/`$stderr` and `${lines[@]}`/`${stderr_lines[@]}`. + +All additional parameters to run should come before the command. +If you want to run a command that starts with `-`, prefix it with `--` to +prevent `run` from parsing it as an option. + +### When not to use `run` + +In case you only need to check the command succeeded, it is better to not use `run`, since the following code + +```bash +run -0 command args ... +``` + +is equivalent to + +```bash +command args ... +``` + +(because bats sets `set -e` for all tests). + +__Note__: In contrast to the above, testing that a command failed is best done via + +```bash +run ! command args ... +``` + +because + +```bash +! command args ... +``` + +will only fail the test if it is the last command and thereby determines the test function's exit code. +This is due to Bash's decision to (counterintuitively?) not trigger `set -e` on `!` commands. +(See also [the associated gotcha](https://bats-core.readthedocs.io/en/stable/gotchas.html#my-negated-statement-e-g-true-does-not-fail-the-test-even-when-it-should)) + + +### `run` and pipes + +Don't fool yourself with pipes when using `run`. Bash parses the pipe outside of `run`, not internal to its command. Take this example: + +```bash +run command args ... | jq -e '.limit == 42' +``` + +Here, `jq` receives no input (which is captured by `run`), +executes no filters, and always succeeds, so the test does not work as +expected. + +Instead use a Bash subshell: + +```bash +run bash -c "command args ... | jq -e '.limit == 42'" +``` + +This subshell is a fresh Bash environment, and will only inherit variables +and functions that are exported into it. + +```bash +limit() { jq -e '.limit == 42'; } +export -f limit +run bash -c "command args ... | limit" +``` + + +## `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 files +relative to the current test file and from absolute paths. + +For example, if you have a Bats test in `test/foo.bats`, the command + +```bash +load test_helper.bash +``` + +will source the script `test/test_helper.bash` in your test file (limitations +apply, see below). This can be useful for sharing functions to set up your +environment or load fixtures. `load` delegates to Bash's `source` command after +resolving paths. + +If `load` encounters errors - e.g. because the targeted source file +errored - it will print a message with the failing library and Bats +exits. + +To allow to use `load` in conditions `bats_load_safe` has been added. +`bats_load_safe` prints a message and returns `1` if a source file cannot be +loaded instead of exiting Bats. +Aside from that `bats_load_safe` acts exactly like `load`. + +As pointed out by @iatrou in https://www.tldp.org/LDP/abs/html/declareref.html, +using the `declare` builtin restricts scope of a variable. Thus, since actual +`source`-ing is performed in context of the `load` function, `declare`d symbols +will _not_ be made available to callers of `load`. + +### `load` argument resolution + +`load` supports the following arguments: + +- absolute paths +- relative paths (to the current test file) + +> For backwards compatibility `load` first searches for a file ending in +> `.bash` (e.g. `load test_helper` searches for `test_helper.bash` before +> it looks for `test_helper`). This behaviour is deprecated and subject to +> change, please use exact filenames instead. + +If `argument` is an absolute path `load` tries to determine the load +path directly. + +If `argument` is a relative path or a name `load` looks for a matching +path in the directory of the current test. + +## `bats_load_library`: Load system wide libraries + +Some libraries are installed on the system, e.g. by `npm` or `brew`. +These should not be `load`ed, as their path depends on the installation method. +Instead, one should use `bats_load_library` together with setting +`BATS_LIB_PATH`, a `PATH`-like colon-delimited variable. + +`bats_load_library` has two modes of resolving requests: + +1. by relative path from the `BATS_LIB_PATH` to a file in the library +2. by library name, expecting libraries to have a `load.bash` entrypoint + +For example if your `BATS_LIB_PATH` is set to +`~/.bats/libs:/usr/lib/bats`, then `bats_load_library test_helper` +would look for existing files with the following paths: + +- `~/.bats/libs/test_helper` +- `~/.bats/libs/test_helper/load.bash` +- `/usr/lib/bats/test_helper` +- `/usr/lib/bats/test_helper/load.bash` + +The first existing file in this list will be sourced. + +If you want to load only part of a library or the entry point is not named `load.bash`, +you have to include it in the argument: +`bats_load_library library_name/file_to_load` will try + +- `~/.bats/libs/library_name/file_to_load` +- `~/.bats/libs/library_name/file_to_load/load.bash` +- `/usr/lib/bats/library_name/file_to_load` +- `/usr/lib/bats/library_name/file_to_load/load.bash` + +Apart from the changed lookup rules, `bats_load_library` behaves like `load`. + +__Note:__ As seen above `load.bash` is the entry point for libraries and +meant to load more files from its directory or other libraries. + +__Note:__ Obviously, the actual `BATS_LIB_PATH` is highly dependent on the environment. +To maintain a uniform location across systems, (distribution) package maintainers +are encouraged to use `/usr/lib/bats/` as the install path for libraries where possible. +However, if the package manager has another preferred location, like `npm` or `brew`, +you should use this instead. + +## `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 ] +} +``` + +Or you can skip conditionally: + +```bash +@test "A test which should run" { + if [ foo != bar ]; then + skip "foo isn't bar" + fi + + run foo + [ "$status" -eq 0 ] +} +``` + +__Note:__ `setup` and `teardown` hooks still run for skipped tests. + +## `setup` and `teardown`: Pre- and post-test hooks + +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. + +You can also define `setup_file` and `teardown_file`, which will run once before +the first test's `setup` and after the last test's `teardown` for the containing +file. Variables that are exported in `setup_file` will be visible to all following +functions (`setup`, the test itself, `teardown`, `teardown_file`). + +Similarly, there is `setup_suite` (and `teardown_suite`) which run once before (and +after) all tests of the test run. + +__Note:__ As `setup_suite` and `teardown_suite` are intended for all files in a suite, +they must be defined in a separate `setup_suite.bash` file. Automatic discovery works +by searching for `setup_suite.bash` in the folder of the first `*.bats` file of the suite. +If this automatism does not work for your usecase, you can work around by specifying +`--setup-suite-file` on the `bats` command. If you have a `setup_suite.bash`, it must define +`setup_suite`! However, defining `teardown_suite` is optional. + + +
+ Example of setup/{,_file,_suite} (and teardown{,_file,_suite}) call order +For example the following call order would result from two files (file 1 with +tests 1 and 2, and file 2 with test3) with a corresponding `setup_suite.bash` file being tested: + +```text +setup_suite # from setup_suite.bash + setup_file # from file 1, on entering file 1 + setup + test1 + teardown + setup + test2 + teardown + teardown_file # from file 1, on leaving file 1 + setup_file # from file 2, on enter file 2 + setup + test3 + teardown + teardown_file # from file 2, on leaving file 2 +teardown_suite # from setup_suite.bash +``` + +
+ + +Note that the `teardown*` functions can fail a test, if their return code is nonzero. +This means, using `return 1` or having the last command in teardown fail, will +fail the teardown. Unlike `@test`, failing commands within `teardown` won't +trigger failure as ERREXIT is disabled. + + +
+ Example of different teardown failure modes + +```bash +teardown() { + false # this will fail the test, as it determines the return code +} + +teardown() { + false # this won't fail the test ... + echo some more code # ... and this will be executed too! +} + +teardown() { + return 1 # this will fail the test, but the rest won't be executed + echo some more code +} + +teardown() { + if true; then + false # this will also fail the test, as it is the last command in this function + else + true + fi +} +``` + +
+ + +## `bats_require_minimum_version ` + +Added in [v1.7.0](https://github.com/bats-core/bats-core/releases/tag/v1.7.0) + +Code for newer versions of Bats can be incompatible with older versions. +In the best case this will lead to an error message and a failed test suite. +In the worst case, the tests will pass erroneously, potentially masking a failure. + +Use `bats_require_minimum_version ` to avoid this. +It communicates in a concise manner, that you intend the following code to be run +under the given Bats version or higher. + +Additionally, this function will communicate the current Bats version floor to +subsequent code, allowing e.g. Bats' internal warning to give more informed warnings. + +__Note__: By default, calling `bats_require_minimum_version` with versions before +Bats 1.7.0 will fail regardless of the required version as the function is not +available. However, you can use the +[bats-backports plugin](https://github.com/bats-core/bats-backports) to make +your code usable with older versions, e.g. during migration while your CI system +is not yet upgraded. + +## Code outside of test cases + +In general you should avoid code outside tests, because each test file will be evaluated many times. +However, there are situations in which this might be useful, e.g. when you want to check for dependencies +and fail immediately if they're not present. + +In general, you should avoid printing outside of `@test`, `setup*` or `teardown*` functions. +Have a look at section [printing to the terminal](#printing-to-the-terminal) for more details. +## File descriptor 3 (read this if Bats hangs) + +Bats makes a separation between output from the code under test and output that +forms the TAP stream (which is produced by Bats internals). This is done in +order to produce TAP-compliant output. In the [Printing to the +terminal](#printing-to-the-terminal) section, there are details on how to use +file descriptor 3 to print custom text properly. + +A side effect of using file descriptor 3 is that, under some circumstances, it +can cause Bats to block and execution to seem dead without reason. This can +happen if a child process is spawned in the background from a test. In this +case, the child process will inherit file descriptor 3. Bats, as the parent +process, will wait for the file descriptor to be closed by the child process +before continuing execution. If the child process takes a lot of time to +complete (eg if the child process is a `sleep 100` command or a background +service that will run indefinitely), Bats will be similarly blocked for the same +amount of time. + +**To prevent this from happening, close FD 3 explicitly when running any command +that may launch long-running child processes**, e.g. `command_name 3>&-` . + +## Printing to the terminal + +Bats produces output compliant with [version 12 of the TAP protocol](https://testanything.org/tap-specification.html). The +produced TAP stream is by default piped to a pretty formatter for human +consumption, but if Bats is called with the `-t` flag, then the TAP stream is +directly printed to the console. + +This has implications if you try to print custom text to the terminal. As +mentioned in [File descriptor 3](#file-descriptor-3-read-this-if-bats-hangs), +bats provides a special file descriptor, `&3`, that you should use to print +your custom text. Here are some detailed guidelines to refer to: + +- Printing **from within a test function**: + - First you should consider if you want the text to be always visible or only + when the test fails. Text that is output directly to stdout or stderr (file + descriptor 1 or 2), ie `echo 'text'` is considered part of the test function + output and is printed only on test failures for diagnostic purposes, + regardless of the formatter used (TAP or pretty). + - To have text printed unconditionally from within a test function you need to + redirect the output to file descriptor 3, eg `echo 'text' >&3`. This output + will become part of the TAP stream. You are encouraged to prepend text printed + this way with a hash (eg `echo '# text' >&3`) in order to produce 100% TAP compliant + output. Otherwise, depending on the 3rd-party tools you use to analyze the + TAP stream, you can encounter unexpected behavior or errors. + +- Printing **from within the `setup*` or `teardown*` functions**: The same hold + true as for printing with test functions. + +- Printing **outside test or `setup*`/`teardown*` functions**: + - You should avoid printing in free code: Due to the multiple executions + contexts (`setup_file`, multiple `@test`s) of test files, output + will be printed more than once. + + - Regardless of where text is redirected to (stdout, stderr or file descriptor 3) + text is immediately visible in the terminal, as it is not piped into the formatter. + + - Text printed to stdout may interfere with formatters as it can + make output non-compliant with the TAP spec. The reason for this is that + such output will be produced before the [_plan line_][tap-plan] is printed, + contrary to the spec that requires the _plan line_ to be either the first or + the last line of the output. + + - Due to internal pipes/redirects, output to stderr is always printed first. + +[tap-plan]: https://testanything.org/tap-specification.html#the-plan + +## Special variables + +There are several global variables you can use to introspect on Bats tests: + +- `$BATS_RUN_COMMAND` is the run command used in your test case. +- `$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_NAME_PREFIX` will be prepended to the description of each test on + stdout and in reports. +- `$BATS_TEST_DESCRIPTION` is the description of the current test case. +- `BATS_TEST_RETRIES` is the maximum number of additional attempts that will be + made on a failed test before it is finally considered failed. + The default of 0 means the test must pass on the first attempt. +- `BATS_TEST_TIMEOUT` is the number of seconds after which a test (including setup) + will be aborted and marked as failed. Updates to this value in `setup()` or `@test` + cannot change the running timeout countdown, so the latest useful update location + is `setup_file()`. +- `$BATS_TEST_NUMBER` is the (1-based) index of the current test case in the test file. +- `$BATS_SUITE_TEST_NUMBER` is the (1-based) index of the current test case in the test suite (over all files). +- `$BATS_TEST_TAGS` the tags of the current test. +- `$BATS_TMPDIR` is the base temporary directory used by bats to create its + temporary files / directories. + (default: `$TMPDIR`. If `$TMPDIR` is not set, `/tmp` is used.) +- `$BATS_RUN_TMPDIR` is the location to the temporary directory used by bats to + store all its internal temporary files during the tests. + (default: `$BATS_TMPDIR/bats-run-$BATS_ROOT_PID-XXXXXX`) +- `$BATS_FILE_EXTENSION` (default: `bats`) specifies the extension of test files that should be found when running a suite (via `bats [-r] suite_folder/`) +- `$BATS_SUITE_TMPDIR` is a temporary directory common to all tests of a suite. + Could be used to create files required by multiple tests. +- `$BATS_FILE_TMPDIR` is a temporary directory common to all tests of a test file. + Could be used to create files required by multiple tests in the same test file. +- `$BATS_TEST_TMPDIR` is a temporary directory unique for each test. + Could be used to create files required only for specific tests. +- `$BATS_VERSION` is the version of Bats running the test. + +## Libraries and Add-ons + +Bats supports loading external assertion libraries and helpers. Those under `bats-core` are officially supported libraries (integration tests welcome!): + +- - common assertions for Bats +- - supporting library for Bats test helpers +- - common filesystem assertions for Bats +- - e2e tests of applications in K8s environments + +and some external libraries, supported on a "best-effort" basis: + +- (still relevant? Requires review) +- (as per #147) +- (how is this different from grayhemp/bats-mock?) diff --git a/tests/bats/bats-core/docs/versions.md b/tests/bats/bats-core/docs/versions.md new file mode 100644 index 0000000..5113077 --- /dev/null +++ b/tests/bats/bats-core/docs/versions.md @@ -0,0 +1,9 @@ +Here are the docs of following versions: + +* [v1.2.0](../../v1.2.0/README.md) +* [v1.1.0](../../v1.1.0/README.md) +* [v1.0.2](../../v1.0.2/README.md) +* [v0.4.0](../../v0.4.0/README.md) +* [v0.3.1](../../v0.3.1/README.md) +* [v0.2.0](../../v0.2.0/README.md) +* [v0.1.0](../../v0.1.0/README.md) diff --git a/tests/bats/bats-core/install.sh b/tests/bats/bats-core/install.sh new file mode 100755 index 0000000..9d8f0be --- /dev/null +++ b/tests/bats/bats-core/install.sh @@ -0,0 +1,29 @@ +#!/usr/bin/env bash + +set -e + +BATS_ROOT="${0%/*}" +PREFIX="${1%/}" +LIBDIR="${2:-lib}" + +if [[ -z "$PREFIX" ]]; then + printf '%s\n' \ + "usage: $0 [base_libdir]" \ + " e.g. $0 /usr/local" \ + " $0 /usr/local lib64" >&2 + exit 1 +fi + +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" diff --git a/tests/bats/bats-core/lib/bats-core/common.bash b/tests/bats/bats-core/lib/bats-core/common.bash new file mode 100644 index 0000000..7426fa0 --- /dev/null +++ b/tests/bats/bats-core/lib/bats-core/common.bash @@ -0,0 +1,258 @@ +#!/usr/bin/env bash + +bats_prefix_lines_for_tap_output() { + while IFS= read -r line; do + printf '# %s\n' "$line" || break # avoid feedback loop when errors are redirected into BATS_OUT (see #353) + done + if [[ -n "$line" ]]; then + printf '# %s\n' "$line" + fi +} + +function bats_replace_filename() { + local line + while read -r line; do + printf "%s\n" "${line//$BATS_TEST_SOURCE/$BATS_TEST_FILENAME}" + done + if [[ -n "$line" ]]; then + printf "%s\n" "${line//$BATS_TEST_SOURCE/$BATS_TEST_FILENAME}" + fi +} + +bats_quote_code() { # + printf -v "$1" -- "%s%s%s" "$BATS_BEGIN_CODE_QUOTE" "$2" "$BATS_END_CODE_QUOTE" +} + +bats_check_valid_version() { + if [[ ! $1 =~ [0-9]+.[0-9]+.[0-9]+ ]]; then + printf "ERROR: version '%s' must be of format ..!\n" "$1" >&2 + exit 1 + fi +} + +# compares two versions. Return 0 when version1 < version2 +bats_version_lt() { # + bats_check_valid_version "$1" + bats_check_valid_version "$2" + + local -a version1_parts version2_parts + IFS=. read -ra version1_parts <<<"$1" + IFS=. read -ra version2_parts <<<"$2" + + local -i i + for i in {0..2}; do + if ((version1_parts[i] < version2_parts[i])); then + return 0 + elif ((version1_parts[i] > version2_parts[i])); then + return 1 + fi + done + # if we made it this far, they are equal -> also not less then + return 2 # use other failing return code to distinguish equal from gt +} + +# ensure a minimum version of bats is running or exit with failure +bats_require_minimum_version() { # + local required_minimum_version=$1 + + if bats_version_lt "$BATS_VERSION" "$required_minimum_version"; then + printf "BATS_VERSION=%s does not meet required minimum %s\n" "$BATS_VERSION" "$required_minimum_version" + exit 1 + fi + + if bats_version_lt "$BATS_GUARANTEED_MINIMUM_VERSION" "$required_minimum_version"; then + BATS_GUARANTEED_MINIMUM_VERSION="$required_minimum_version" + fi +} + +bats_binary_search() { # + if [[ $# -ne 2 ]]; then + printf "ERROR: bats_binary_search requires exactly 2 arguments: \n" >&2 + return 2 + fi + + local -r search_value=$1 array_name=$2 + + # we'd like to test if array is set but we cannot distinguish unset from empty arrays, so we need to skip that + + local start=0 mid end mid_value + # start is inclusive, end is exclusive ... + eval "end=\${#${array_name}[@]}" + + # so start == end means empty search space + while ((start < end)); do + mid=$(((start + end) / 2)) + eval "mid_value=\${${array_name}[$mid]}" + if [[ "$mid_value" == "$search_value" ]]; then + return 0 + elif [[ "$mid_value" < "$search_value" ]]; then + # This branch excludes equality -> +1 to skip the mid element. + # This +1 also avoids endless recursion on odd sized search ranges. + start=$((mid + 1)) + else + end=$mid + fi + done + + # did not find it -> its not there + return 1 +} + +# store the values in ascending (string!) order in result array +# Intended for short lists! (uses insertion sort) +bats_sort() { # + local -r result_name=$1 + shift + + if (($# == 0)); then + eval "$result_name=()" + return 0 + fi + + local -a sorted_array=() + local -i i + while (( $# > 0 )); do # loop over input values + local current_value="$1" + shift + for ((i = ${#sorted_array[@]}; i >= 0; --i)); do # loop over output array from end + if (( i == 0 )) || [[ ${sorted_array[i - 1]} < $current_value ]]; then + # shift bigger elements one position to the end + sorted_array[i]=$current_value + break + else + # insert new element at (freed) desired location + sorted_array[i]=${sorted_array[i - 1]} + fi + done + done + + eval "$result_name=(\"\${sorted_array[@]}\")" +} + +# check if all search values (must be sorted!) are in the (sorted!) array +# Intended for short lists/arrays! +bats_all_in() { # + local -r haystack_array=$1 + shift + + local -i haystack_length # just to appease shellcheck + eval "local -r haystack_length=\${#${haystack_array}[@]}" + + local -i haystack_index=0 # initialize only here to continue from last search position + local search_value haystack_value # just to appease shellcheck + local -i i + for ((i = 1; i <= $#; ++i)); do + eval "local search_value=${!i}" + for (( ; haystack_index < haystack_length; ++haystack_index)); do + eval "local haystack_value=\${${haystack_array}[$haystack_index]}" + if [[ $haystack_value > "$search_value" ]]; then + # we passed the location this value would have been at -> not found + return 1 + elif [[ $haystack_value == "$search_value" ]]; then + continue 2 # search value found -> try the next one + fi + done + return 1 # we ran of the end of the haystack without finding the value! + done + + # did not return from loop above -> all search values were found + return 0 +} + +# check if any search value (must be sorted!) is in the (sorted!) array +# intended for short lists/arrays +bats_any_in() { # + local -r haystack_array=$1 + shift + + local -i haystack_length # just to appease shellcheck + eval "local -r haystack_length=\${#${haystack_array}[@]}" + + local -i haystack_index=0 # initialize only here to continue from last search position + local search_value haystack_value # just to appease shellcheck + local -i i + for ((i = 1; i <= $#; ++i)); do + eval "local search_value=${!i}" + for (( ; haystack_index < haystack_length; ++haystack_index)); do + eval "local haystack_value=\${${haystack_array}[$haystack_index]}" + if [[ $haystack_value > "$search_value" ]]; then + continue 2 # search value not in array! -> try next + elif [[ $haystack_value == "$search_value" ]]; then + return 0 # search value found + fi + done + done + + # did not return from loop above -> no search value was found + return 1 +} + +bats_trim() { # + local -r bats_trim_ltrimmed=${2#"${2%%[![:space:]]*}"} # cut off leading whitespace + # shellcheck disable=SC2034 # used in eval! + local -r bats_trim_trimmed=${bats_trim_ltrimmed%"${bats_trim_ltrimmed##*[![:space:]]}"} # cut off trailing whitespace + eval "$1=\$bats_trim_trimmed" +} + +# a helper function to work around unbound variable errors with ${arr[@]} on Bash 3 +bats_append_arrays_as_args() { # -- + local -a trailing_args=() + while (($# > 0)) && [[ $1 != -- ]]; do + local array=$1 + shift + + if eval "(( \${#${array}[@]} > 0 ))"; then + eval "trailing_args+=(\"\${${array}[@]}\")" + fi + done + shift # remove -- separator + + if (($# == 0)); then + printf "Error: append_arrays_as_args is missing a command or -- separator\n" >&2 + return 1 + fi + + if ((${#trailing_args[@]} > 0)); then + "$@" "${trailing_args[@]}" + else + "$@" + fi +} + +bats_format_file_line_reference() { # + # shellcheck disable=SC2034 # will be used in subimplementation + local output="${1?}" + shift + "bats_format_file_line_reference_${BATS_LINE_REFERENCE_FORMAT?}" "$@" +} + +bats_format_file_line_reference_comma_line() { + printf -v "$output" "%s, line %d" "$@" +} + +bats_format_file_line_reference_colon() { + printf -v "$output" "%s:%d" "$@" +} + +# approximate realpath without subshell +bats_approx_realpath() { # + local output=$1 path=$2 + if [[ $path != /* ]]; then + path="$PWD/$path" + fi + # x/./y -> x/y + path=${path//\/.\//\/} + printf -v "$output" "%s" "$path" +} + +bats_format_file_line_reference_uri() { + local filename=${1?} line=${2?} + bats_approx_realpath filename "$filename" + printf -v "$output" "file://%s:%d" "$filename" "$line" +} + +# execute command with backed up path +# to prevent path mocks from interfering with our internals +bats_execute() { # + PATH="${BATS_SAVED_PATH?}" "$@" +} diff --git a/tests/bats/bats-core/lib/bats-core/formatter.bash b/tests/bats/bats-core/lib/bats-core/formatter.bash new file mode 100644 index 0000000..aaf8096 --- /dev/null +++ b/tests/bats/bats-core/lib/bats-core/formatter.bash @@ -0,0 +1,151 @@ +#!/usr/bin/env bash + +# reads (extended) bats tap streams from stdin and calls callback functions for each line +# +# Segmenting functions +# ==================== +# bats_tap_stream_plan -> when the test plan is encountered +# bats_tap_stream_suite -> when a new file is begun WARNING: extended only +# bats_tap_stream_begin -> when a new test is begun WARNING: extended only +# +# Test result functions +# ===================== +# If timing was enabled, BATS_FORMATTER_TEST_DURATION will be set to their duration in milliseconds +# bats_tap_stream_ok -> when a test was successful +# bats_tap_stream_not_ok -> when a test has failed. If the failure was due to a timeout, +# BATS_FORMATTER_TEST_TIMEOUT is set to the timeout duration in seconds +# bats_tap_stream_skipped -> when a test was skipped +# +# Context functions +# ================= +# bats_tap_stream_comment -> when a comment line was encountered, +# scope tells the last encountered of plan, begin, ok, not_ok, skipped, suite +# bats_tap_stream_unknown -> when a line is encountered that does not match the previous entries, +# scope @see bats_tap_stream_comment +# forwards all input as is, when there is no TAP test plan header +function bats_parse_internal_extended_tap() { + local header_pattern='[0-9]+\.\.[0-9]+' + IFS= read -r header + + if [[ "$header" =~ $header_pattern ]]; then + bats_tap_stream_plan "${header:3}" + else + # If the first line isn't a TAP plan, print it and pass the rest through + printf '%s\n' "$header" + exec cat + fi + + ok_line_regexpr="ok ([0-9]+) (.*)" + skip_line_regexpr="ok ([0-9]+) (.*) # skip( (.*))?$" + timeout_line_regexpr="not ok ([0-9]+) (.*) # timeout after ([0-9]+)s$" + not_ok_line_regexpr="not ok ([0-9]+) (.*)" + + timing_expr="in ([0-9]+)ms$" + local test_name begin_index last_begin_index try_index ok_index not_ok_index index scope + begin_index=0 + last_begin_index=-1 + try_index=0 + index=0 + scope=plan + while IFS= read -r line; do + unset BATS_FORMATTER_TEST_DURATION BATS_FORMATTER_TEST_TIMEOUT + case "$line" in + 'begin '*) # this might only be called in extended tap output + scope=begin + begin_index=${line#begin } + begin_index=${begin_index%% *} + if [[ $begin_index == "$last_begin_index" ]]; then + (( ++try_index )) + else + try_index=0 + fi + test_name="${line#begin "$begin_index" }" + bats_tap_stream_begin "$begin_index" "$test_name" + ;; + 'ok '*) + ((++index)) + if [[ "$line" =~ $ok_line_regexpr ]]; then + ok_index="${BASH_REMATCH[1]}" + test_name="${BASH_REMATCH[2]}" + if [[ "$line" =~ $skip_line_regexpr ]]; then + scope=skipped + test_name="${BASH_REMATCH[2]}" # cut off name before "# skip" + local skip_reason="${BASH_REMATCH[4]}" + if [[ "$test_name" =~ $timing_expr ]]; then + local BATS_FORMATTER_TEST_DURATION="${BASH_REMATCH[1]}" + test_name="${test_name% in "${BATS_FORMATTER_TEST_DURATION}"ms}" + bats_tap_stream_skipped "$ok_index" "$test_name" "$skip_reason" + else + bats_tap_stream_skipped "$ok_index" "$test_name" "$skip_reason" + fi + else + scope=ok + if [[ "$line" =~ $timing_expr ]]; then + local BATS_FORMATTER_TEST_DURATION="${BASH_REMATCH[1]}" + bats_tap_stream_ok "$ok_index" "${test_name% in "${BASH_REMATCH[1]}"ms}" + else + bats_tap_stream_ok "$ok_index" "$test_name" + fi + fi + else + printf "ERROR: could not match ok line: %s" "$line" >&2 + exit 1 + fi + ;; + 'not ok '*) + ((++index)) + scope=not_ok + if [[ "$line" =~ $not_ok_line_regexpr ]]; then + not_ok_index="${BASH_REMATCH[1]}" + test_name="${BASH_REMATCH[2]}" + if [[ "$line" =~ $timeout_line_regexpr ]]; then + not_ok_index="${BASH_REMATCH[1]}" + test_name="${BASH_REMATCH[2]}" + # shellcheck disable=SC2034 # used in bats_tap_stream_ok + local BATS_FORMATTER_TEST_TIMEOUT="${BASH_REMATCH[3]}" + fi + if [[ "$test_name" =~ $timing_expr ]]; then + # shellcheck disable=SC2034 # used in bats_tap_stream_ok + local BATS_FORMATTER_TEST_DURATION="${BASH_REMATCH[1]}" + test_name="${test_name% in "${BASH_REMATCH[1]}"ms}" + fi + bats_tap_stream_not_ok "$not_ok_index" "$test_name" + else + printf "ERROR: could not match not ok line: %s" "$line" >&2 + exit 1 + fi + ;; + '# '*) + bats_tap_stream_comment "${line:2}" "$scope" + ;; + '#') + bats_tap_stream_comment "" "$scope" + ;; + 'suite '*) + scope=suite + # pass on the + bats_tap_stream_suite "${line:6}" + ;; + *) + bats_tap_stream_unknown "$line" "$scope" + ;; + esac + done +} + +normalize_base_path() { # + # the relative path root to use for reporting filenames + # this is mainly intended for suite mode, where this will be the suite root folder + local base_path="$2" + # use the containing directory when --base-path is a file + if [[ ! -d "$base_path" ]]; then + base_path="$(dirname "$base_path")" + fi + # get the absolute path + base_path="$(cd "$base_path" && pwd)" + # ensure the path ends with / to strip that later on + if [[ "${base_path}" != *"/" ]]; then + base_path="$base_path/" + fi + printf -v "$1" "%s" "$base_path" +} diff --git a/tests/bats/bats-core/lib/bats-core/preprocessing.bash b/tests/bats/bats-core/lib/bats-core/preprocessing.bash new file mode 100644 index 0000000..020eb6a --- /dev/null +++ b/tests/bats/bats-core/lib/bats-core/preprocessing.bash @@ -0,0 +1,23 @@ +#!/usr/bin/env bash + +BATS_TMPNAME="$BATS_RUN_TMPDIR/bats.$$" +BATS_PARENT_TMPNAME="$BATS_RUN_TMPDIR/bats.$PPID" +# shellcheck disable=SC2034 +BATS_OUT="${BATS_TMPNAME}.out" # used in bats-exec-file + +bats_preprocess_source() { + # export to make it visible to bats_evaluate_preprocessed_source + # since the latter runs in bats-exec-test's bash while this runs in bats-exec-file's + export BATS_TEST_SOURCE="${BATS_TMPNAME}.src" + # shellcheck disable=SC2153 + CHECK_BATS_COMMENT_COMMANDS=1 "$BATS_ROOT/libexec/bats-core/bats-preprocess" "$BATS_TEST_FILENAME" >"$BATS_TEST_SOURCE" +} + +bats_evaluate_preprocessed_source() { + if [[ -z "${BATS_TEST_SOURCE:-}" ]]; then + BATS_TEST_SOURCE="${BATS_PARENT_TMPNAME}.src" + fi + # Dynamically loaded user files provided outside of Bats. + # shellcheck disable=SC1090 + source "$BATS_TEST_SOURCE" +} diff --git a/tests/bats/bats-core/lib/bats-core/semaphore.bash b/tests/bats/bats-core/lib/bats-core/semaphore.bash new file mode 100644 index 0000000..a196ac8 --- /dev/null +++ b/tests/bats/bats-core/lib/bats-core/semaphore.bash @@ -0,0 +1,113 @@ +#!/usr/bin/env bash + +bats_run_under_flock() { + flock "$BATS_SEMAPHORE_DIR" "$@" +} + +bats_run_under_shlock() { + local lockfile="$BATS_SEMAPHORE_DIR/shlock.lock" + while ! shlock -p $$ -f "$lockfile"; do + sleep 1 + done + # we got the lock now, execute the command + "$@" + local status=$? + # free the lock + rm -f "$lockfile" + return $status + } + +# setup the semaphore environment for the loading file +bats_semaphore_setup() { + export -f bats_semaphore_get_free_slot_count + export -f bats_semaphore_acquire_while_locked + export BATS_SEMAPHORE_DIR="$BATS_RUN_TMPDIR/semaphores" + + if command -v flock >/dev/null; then + BATS_LOCKING_IMPLEMENTATION=flock + elif command -v shlock >/dev/null; then + BATS_LOCKING_IMPLEMENTATION=shlock + else + printf "ERROR: flock/shlock is required for parallelization within files!\n" >&2 + exit 1 + fi +} + +# $1 - output directory for stdout/stderr +# $@ - command to run +# run the given command in a semaphore +# block when there is no free slot for the semaphore +# when there is a free slot, run the command in background +# gather the output of the command in files in the given directory +bats_semaphore_run() { + local output_dir=$1 + shift + local semaphore_slot + semaphore_slot=$(bats_semaphore_acquire_slot) + bats_semaphore_release_wrapper "$output_dir" "$semaphore_slot" "$@" & + printf "%d\n" "$!" +} + +# $1 - output directory for stdout/stderr +# $@ - command to run +# this wraps the actual function call to install some traps on exiting +bats_semaphore_release_wrapper() { + local output_dir="$1" + local semaphore_name="$2" + shift 2 # all other parameters will be use for the command to execute + + # shellcheck disable=SC2064 # we want to expand the semaphore_name right now! + trap "status=$?; bats_semaphore_release_slot '$semaphore_name'; exit $status" EXIT + + mkdir -p "$output_dir" + "$@" 2>"$output_dir/stderr" >"$output_dir/stdout" + local status=$? + + # bash bug: the exit trap is not called for the background process + bats_semaphore_release_slot "$semaphore_name" + trap - EXIT # avoid calling release twice + return $status +} + +bats_semaphore_acquire_while_locked() { + if [[ $(bats_semaphore_get_free_slot_count) -gt 0 ]]; then + local slot=0 + while [[ -e "$BATS_SEMAPHORE_DIR/slot-$slot" ]]; do + ((++slot)) + done + if [[ $slot -lt $BATS_SEMAPHORE_NUMBER_OF_SLOTS ]]; then + touch "$BATS_SEMAPHORE_DIR/slot-$slot" && printf "%d\n" "$slot" && return 0 + fi + fi + return 1 +} + +# block until a semaphore slot becomes free +# prints the number of the slot that it received +bats_semaphore_acquire_slot() { + mkdir -p "$BATS_SEMAPHORE_DIR" + # wait for a slot to become free + # TODO: avoid busy waiting by using signals -> this opens op prioritizing possibilities as well + while true; do + # don't lock for reading, we are fine with spuriously getting no free slot + if [[ $(bats_semaphore_get_free_slot_count) -gt 0 ]]; then + bats_run_under_"$BATS_LOCKING_IMPLEMENTATION" \ + bash -c bats_semaphore_acquire_while_locked \ + && break + fi + sleep 1 + done +} + +bats_semaphore_release_slot() { + # we don't need to lock this, since only our process owns this file + # and freeing a semaphore cannot lead to conflicts with others + rm "$BATS_SEMAPHORE_DIR/slot-$1" # this will fail if we had not acquired a semaphore! +} + +bats_semaphore_get_free_slot_count() { + # find might error out without returning something useful when a file is deleted, + # while the directory is traversed -> only continue when there was no error + until used_slots=$(find "$BATS_SEMAPHORE_DIR" -name 'slot-*' 2>/dev/null | wc -l); do :; done + echo $((BATS_SEMAPHORE_NUMBER_OF_SLOTS - used_slots)) +} diff --git a/tests/bats/bats-core/lib/bats-core/test_functions.bash b/tests/bats/bats-core/lib/bats-core/test_functions.bash new file mode 100644 index 0000000..6b6e513 --- /dev/null +++ b/tests/bats/bats-core/lib/bats-core/test_functions.bash @@ -0,0 +1,515 @@ +#!/usr/bin/env bash + +# this must be called for each test file! +_bats_test_functions_setup() { # + BATS_TEST_DIRNAME="${BATS_TEST_FILENAME%/*}" + BATS_TEST_NAMES=() + # shellcheck disable=SC2034 + BATS_TEST_NUMBER=${1?} +} + +# shellcheck source=lib/bats-core/warnings.bash +source "$BATS_ROOT/$BATS_LIBDIR/bats-core/warnings.bash" + +# find_in_bats_lib_path echoes the first recognized load path to +# a library in BATS_LIB_PATH or relative to BATS_TEST_DIRNAME. +# +# Libraries relative to BATS_TEST_DIRNAME take precedence over +# BATS_LIB_PATH. +# +# Library load paths are recognized using find_library_load_path. +# +# If no library is found find_in_bats_lib_path returns 1. +find_in_bats_lib_path() { # + local return_var="${1:?}" + local library_name="${2:?}" + + local -a bats_lib_paths + IFS=: read -ra bats_lib_paths <<<"$BATS_LIB_PATH" + + for path in "${bats_lib_paths[@]}"; do + if [[ -f "$path/$library_name" ]]; then + printf -v "$return_var" "%s" "$path/$library_name" + # A library load path was found, return + return 0 + elif [[ -f "$path/$library_name/load.bash" ]]; then + printf -v "$return_var" "%s" "$path/$library_name/load.bash" + # A library load path was found, return + return 0 + fi + done + + return 1 +} + +# bats_internal_load expects an absolute path that is a library load path. +# +# If the library load path points to a file (a library loader) it is +# sourced. +# +# If it points to a directory all files ending in .bash inside of the +# directory are sourced. +# +# If the sourcing of the library loader or of a file in a library +# directory fails bats_internal_load prints an error message and returns 1. +# +# If the passed library load path is not absolute or is not a valid file +# or directory bats_internal_load prints an error message and returns 1. +bats_internal_load() { + local library_load_path="${1:?}" + + if [[ "${library_load_path:0:1}" != / ]]; then + printf "Passed library load path is not an absolute path: %s\n" "$library_load_path" >&2 + return 1 + fi + + # library_load_path is a library loader + if [[ -f "$library_load_path" ]]; then + # shellcheck disable=SC1090 + if ! source "$library_load_path"; then + printf "Error while sourcing library loader at '%s'\n" "$library_load_path" >&2 + return 1 + fi + return 0 + fi + + printf "Passed library load path is neither a library loader nor library directory: %s\n" "$library_load_path" >&2 + return 1 +} + +# bats_load_safe accepts an argument called 'slug' and attempts to find and +# source a library based on the slug. +# +# A slug can be an absolute path, a library name or a relative path. +# +# If the slug is an absolute path bats_load_safe attempts to find the library +# load path using find_library_load_path. +# What is considered a library load path is documented in the +# documentation for find_library_load_path. +# +# If the slug is not an absolute path it is considered a library name or +# relative path. bats_load_safe attempts to find the library load path using +# find_in_bats_lib_path. +# +# If bats_load_safe can find a library load path it is passed to bats_internal_load. +# If bats_internal_load fails bats_load_safe returns 1. +# +# If no library load path can be found bats_load_safe prints an error message +# and returns 1. +bats_load_safe() { + local slug="${1:?}" + if [[ ${slug:0:1} != / ]]; then # relative paths are relative to BATS_TEST_DIRNAME + slug="$BATS_TEST_DIRNAME/$slug" + fi + + if [[ -f "$slug.bash" ]]; then + bats_internal_load "$slug.bash" + return $? + elif [[ -f "$slug" ]]; then + bats_internal_load "$slug" + return $? + fi + + # loading from PATH (retained for backwards compatibility) + if [[ ! -f "$1" ]] && type -P "$1" >/dev/null; then + # shellcheck disable=SC1090 + source "$1" + return $? + fi + + # No library load path can be found + printf "bats_load_safe: Could not find '%s'[.bash]\n" "$slug" >&2 + return 1 +} + +bats_load_library_safe() { # + local slug="${1:?}" library_path + + # Check for library load paths in BATS_TEST_DIRNAME and BATS_LIB_PATH + if [[ ${slug:0:1} != / ]]; then + if ! find_in_bats_lib_path library_path "$slug"; then + printf "Could not find library '%s' relative to test file or in BATS_LIB_PATH\n" "$slug" >&2 + return 1 + fi + else + # absolute paths are taken as is + library_path="$slug" + if [[ ! -f "$library_path" ]]; then + printf "Could not find library on absolute path '%s'\n" "$library_path" >&2 + return 1 + fi + fi + + bats_internal_load "$library_path" + return $? +} + +# immediately exit on error, use bats_load_library_safe to catch and handle errors +bats_load_library() { # + if ! bats_load_library_safe "$@"; then + exit 1 + fi +} + +# load acts like bats_load_safe but exits the shell instead of returning 1. +load() { + if ! bats_load_safe "$@"; then + exit 1 + fi +} + +bats_redirect_stderr_into_file() { + "$@" 2>>"$bats_run_separate_stderr_file" # use >> to see collisions' content +} + +bats_merge_stdout_and_stderr() { + "$@" 2>&1 +} + +# write separate lines from into +bats_separate_lines() { # + local -r output_array_name="$1" + local -r input_var_name="$2" + local input="${!input_var_name}" + if [[ $keep_empty_lines ]]; then + local bats_separate_lines_lines=() + if [[ -n "$input" ]]; then # avoid getting an empty line for empty input + # remove one trailing \n if it exists to compensate its addition by <<< + input=${input%$'\n'} + while IFS= read -r line; do + bats_separate_lines_lines+=("$line") + done <<<"${input}" + fi + eval "${output_array_name}=(\"\${bats_separate_lines_lines[@]}\")" + else + # shellcheck disable=SC2034,SC2206 + IFS=$'\n' read -d '' -r -a "$output_array_name" <<<"${!input_var_name}" || true # don't fail due to EOF + fi +} + +bats_pipe() { # [-N] [--] command0 [ \| command1 [ \| command2 [...]]] + # This will run each command given, piping them appropriately. + # Meant to be used in combination with `run` helper to allow piped commands + # to be used. + # Note that `\|` must be used, not `|`. + # By default, the exit code of this command will be the last failure in the + # chain of piped commands (similar to `set -o pipefail`). + # Supplying -N (e.g. -0) will instead always use the exit code of the command + # at that position in the chain. + # --returned-status=N could be used as an alternative to -N. This also allows + # for negative values (which count from the end in reverse order). + + local pipestatus_position= + + # parse options starting with - + while [[ $# -gt 0 ]] && [[ $1 == -* ]]; do + case "$1" in + -[0-9]*) + pipestatus_position="${1#-}" + ;; + --returned-status*) + if [ "$1" = "--returned-status" ]; then + pipestatus_position="$2" + shift + elif [[ "$1" =~ ^--returned-status= ]]; then + pipestatus_position="${1#--returned-status=}" + else + printf "Usage error: unknown flag '%s'" "$1" >&2 + return 1 + fi + ;; + --) + shift # eat the -- before breaking away + break + ;; + *) + printf "Usage error: unknown flag '%s'" "$1" >&2 + return 1 + ;; + esac + shift + done + + # parse and validate arguments, escape as necessary + local -a commands_and_args=("$@") + local -a escaped_args=() + local -i pipe_count=0 + local -i previous_pipe_index=-1 + local -i index=0 + for (( index = 0; index < $#; index++ )); do + local current_command_or_arg="${commands_and_args[$index]}" + local escaped_arg="$current_command_or_arg" + if [[ "$current_command_or_arg" != '|' ]]; then + # escape args to protect them when eval'd (e.g. if they contain whitespace). + printf -v escaped_arg "%q" "$current_command_or_arg" + elif [ "$current_command_or_arg" = "|" ]; then + if [ "$index" -eq 0 ]; then + printf "Usage error: Cannot have leading \`\\|\`.\n" >&2 + return 1 + fi + if (( (previous_pipe_index + 1) >= index )); then + printf "Usage error: Cannot have consecutive \`\\|\`. Found at argument position '%s'.\n" "$index" >&2 + return 1 + fi + (( ++pipe_count )) + previous_pipe_index="$index" + fi + escaped_args+=("$escaped_arg") + done + + if (( (previous_pipe_index > 0) && (previous_pipe_index == ($# - 1)) )); then + printf "Usage error: Cannot have trailing \`\\|\`.\n" >&2 + return 1 + fi + + if (( pipe_count == 0 )); then + # Don't allow for no pipes. This might be a typo in the test, + # e.g. `run bats_pipe command0 | command1` + # instead of `run bats_pipe command0 \| command1` + # Unfortunately, we can't catch `run bats_pipe command0 \| command1 | command2`. + # But this check is better than just allowing no pipes. + printf "Usage error: No \`\\|\`s found. Is this an error?\n" >&2 + return 1 + fi + + # there will be pipe_count + 1 entries in PIPE_STATUS (pipe_count number of \|'s between each entry). + # valid indices are [-(pipe_count + 1), pipe_count] + if [ -n "$pipestatus_position" ] && (( (pipestatus_position > pipe_count) || (-pipestatus_position > (pipe_count + 1)) )); then + printf "Usage error: Too large of -N argument (or --returned-status) given. Argument value: '%s'.\n" "$pipestatus_position" >&2 + return 1 + fi + + # run commands and return appropriate pipe status + local -a __bats_pipe_eval_pipe_status=() + eval "${escaped_args[*]}" '; __bats_pipe_eval_pipe_status=(${PIPESTATUS[@]})' + + local result_status= + if [ -z "$pipestatus_position" ]; then + # if we are performing default "last failure" behavior, + # iterate backwards through pipe_status to find the last error. + result_status=0 + for index in "${!__bats_pipe_eval_pipe_status[@]}"; do + # OSX bash doesn't support negative indexing. + local backward_iter_index="$((${#__bats_pipe_eval_pipe_status[@]} - index - 1))" + local status_at_backward_iter_index="${__bats_pipe_eval_pipe_status[$backward_iter_index]}" + if (( status_at_backward_iter_index != 0 )); then + result_status="$status_at_backward_iter_index" + break; + fi + done + elif (( pipestatus_position >= 0 )); then + result_status="${__bats_pipe_eval_pipe_status[$pipestatus_position]}" + else + # Must use positive values for some bash's (like OSX). + local backward_iter_index="$((${#__bats_pipe_eval_pipe_status[@]} + pipestatus_position))" + result_status="${__bats_pipe_eval_pipe_status[$backward_iter_index]}" + fi + + return "$result_status" +} + +run() { # [!|-N] [--keep-empty-lines] [--separate-stderr] [--] + # This has to be restored on exit from this function to avoid leaking our trap INT into surrounding code. + # Non zero exits won't restore under the assumption that they will fail the test before it can be aborted, + # which allows us to avoid duplicating the restore code on every exit path + trap bats_interrupt_trap_in_run INT + local expected_rc= + local keep_empty_lines= + local output_case=merged + local has_flags= + # parse options starting with - + while [[ $# -gt 0 ]] && [[ $1 == -* || $1 == '!' ]]; do + has_flags=1 + case "$1" in + '!') + expected_rc=-1 + ;; + -[0-9]*) + expected_rc=${1#-} + if [[ $expected_rc =~ [^0-9] ]]; then + printf "Usage error: run: '-NNN' requires numeric NNN (got: %s)\n" "$expected_rc" >&2 + return 1 + elif [[ $expected_rc -gt 255 ]]; then + printf "Usage error: run: '-NNN': NNN must be <= 255 (got: %d)\n" "$expected_rc" >&2 + return 1 + fi + ;; + --keep-empty-lines) + keep_empty_lines=1 + ;; + --separate-stderr) + output_case="separate" + ;; + --) + shift # eat the -- before breaking away + break + ;; + *) + printf "Usage error: unknown flag '%s'" "$1" >&2 + return 1 + ;; + esac + shift + done + + if [[ -n $has_flags ]]; then + bats_warn_minimum_guaranteed_version "Using flags on \`run\`" 1.5.0 + fi + + local pre_command= + + case "$output_case" in + merged) # redirects stderr into stdout and fills only $output/$lines + pre_command=bats_merge_stdout_and_stderr + ;; + separate) # splits stderr into own file and fills $stderr/$stderr_lines too + local bats_run_separate_stderr_file + bats_run_separate_stderr_file="$(mktemp "${BATS_TEST_TMPDIR}/separate-stderr-XXXXXX")" + pre_command=bats_redirect_stderr_into_file + ;; + esac + + local origFlags="$-" + set +eET + if [[ $keep_empty_lines ]]; then + # 'output', 'status', 'lines' are global variables available to tests. + # preserve trailing newlines by appending . and removing it later + # shellcheck disable=SC2034 + output="$( + "$pre_command" "$@" + status=$? + printf . + exit $status + )" && status=0 || status=$? + output="${output%.}" + else + # 'output', 'status', 'lines' are global variables available to tests. + # shellcheck disable=SC2034 + output="$("$pre_command" "$@")" && status=0 || status=$? + fi + + bats_separate_lines lines output + + if [[ "$output_case" == separate ]]; then + # shellcheck disable=SC2034 + read -d '' -r stderr <"$bats_run_separate_stderr_file" || true + bats_separate_lines stderr_lines stderr + fi + + # shellcheck disable=SC2034 + BATS_RUN_COMMAND="${*}" + set "-$origFlags" + + bats_run_print_output() { + if [[ -n "$output" ]]; then + printf "%s\n" "$output" + fi + if [[ "$output_case" == separate && -n "$stderr" ]]; then + printf "stderr:\n%s\n" "$stderr" + fi + } + + if [[ -n "$expected_rc" ]]; then + if [[ "$expected_rc" = "-1" ]]; then + if [[ "$status" -eq 0 ]]; then + BATS_ERROR_SUFFIX=", expected nonzero exit code!" + bats_run_print_output + return 1 + fi + elif [ "$status" -ne "$expected_rc" ]; then + # shellcheck disable=SC2034 + BATS_ERROR_SUFFIX=", expected exit code $expected_rc, got $status" + bats_run_print_output + return 1 + fi + elif [[ "$status" -eq 127 ]]; then # "command not found" + bats_generate_warning 1 "$BATS_RUN_COMMAND" + fi + + if [[ ${BATS_VERBOSE_RUN:-} ]]; then + bats_run_print_output + fi + + # don't leak our trap into surrounding code + trap bats_interrupt_trap INT +} + +setup() { + return 0 +} + +teardown() { + return 0 +} + +skip() { + # if this is a skip in teardown ... + if [[ -n "${BATS_TEARDOWN_STARTED-}" ]]; then + # ... we want to skip the rest of teardown. + # communicate to bats_exit_trap that the teardown was completed without error + # shellcheck disable=SC2034 + BATS_TEARDOWN_COMPLETED=1 + # if we are already in the exit trap (e.g. due to previous skip) ... + if [[ "$BATS_TEARDOWN_STARTED" == as-exit-trap ]]; then + # ... we need to do the rest of the tear_down_trap that would otherwise be skipped after the next call to exit + bats_exit_trap + # and then do the exit (at the end of this function) + fi + # if we aren't in exit trap, the normal exit handling should suffice + else + # ... this is either skip in test or skip in setup. + # Following variables are used in bats-exec-test which sources this file + # shellcheck disable=SC2034 + BATS_TEST_SKIPPED="${1:-1}" + # shellcheck disable=SC2034 + BATS_TEST_COMPLETED=1 + fi + exit 0 +} + +bats_test_function() { + local tags=() + while (( $# > 0 )); do + case "$1" in + --description) + local test_description= + # use eval to resolve variable references in test names + eval "printf -v test_description '%s' \"$2\"" + shift 2 + ;; + --tags) + IFS=',' read -ra tags <<<"$2" + shift 2 + ;; + --) + shift + break + ;; + *) + printf "ERROR: unknown option %s for bats_test_function" "$1" >&2 + exit 1 + ;; + esac + done + BATS_TEST_NAMES+=("$*") + local quoted_parameters + printf -v quoted_parameters " %q" "$@" + quoted_parameters=${quoted_parameters:1} # cut off leading space + + # if this is the currently selected test, set tags and name + # this should only be entered from bats-exec-test + if [[ ${BATS_TEST_NAME-} == "$quoted_parameters" ]]; then + # shellcheck disable=SC2034 + BATS_TEST_TAGS=("${tags[@]+${tags[@]}}") + export BATS_TEST_DESCRIPTION="${test_description-$*}" + # shellcheck disable=SC2034 + BATS_TEST_COMMAND=("$@") + fi +} + +# decides whether a failed test should be run again +bats_should_retry_test() { + # test try number starts at 1 + # 0 retries means run only first try + ((BATS_TEST_TRY_NUMBER <= BATS_TEST_RETRIES)) +} diff --git a/tests/bats/bats-core/lib/bats-core/tracing.bash b/tests/bats/bats-core/lib/bats-core/tracing.bash new file mode 100644 index 0000000..91f9cb4 --- /dev/null +++ b/tests/bats/bats-core/lib/bats-core/tracing.bash @@ -0,0 +1,421 @@ +#!/usr/bin/env bash + +# shellcheck source=lib/bats-core/common.bash +source "$BATS_ROOT/$BATS_LIBDIR/bats-core/common.bash" + +# set limit such that traces are only captured for calls at the same depth as this function in the calltree +bats_set_stacktrace_limit() { + BATS_STACK_TRACE_LIMIT=$(( ${#FUNCNAME[@]} - 1 )) # adjust by -1 to account for call to this functions +} + +bats_capture_stack_trace() { + local test_file + local funcname + local i + + BATS_DEBUG_LAST_STACK_TRACE=() + local limit=$(( ${#FUNCNAME[@]} - ${BATS_STACK_TRACE_LIMIT-0} )) + # TODO: why is the line number off by one in @test "--trace recurses into functions but not into run" + for ((i = 2; i < limit ; ++i)); do + # Use BATS_TEST_SOURCE if necessary to work around Bash < 4.4 bug whereby + # calling an exported function erases the test file's BASH_SOURCE entry. + test_file="${BASH_SOURCE[$i]:-$BATS_TEST_SOURCE}" + funcname="${FUNCNAME[$i]}" + BATS_DEBUG_LAST_STACK_TRACE+=("${BASH_LINENO[$((i - 1))]} $funcname $test_file") + done +} + +bats_get_failure_stack_trace() { + local stack_trace_var + # See bats_debug_trap for details. + if [[ -n "${BATS_DEBUG_LAST_STACK_TRACE_IS_VALID:-}" ]]; then + stack_trace_var=BATS_DEBUG_LAST_STACK_TRACE + else + stack_trace_var=BATS_DEBUG_LASTLAST_STACK_TRACE + fi + # shellcheck disable=SC2016 + eval "$(printf \ + '%s=(${%s[@]+"${%s[@]}"})' \ + "${1}" \ + "${stack_trace_var}" \ + "${stack_trace_var}")" +} + +bats_print_stack_trace() { + local frame + local index=1 + local count="${#@}" + local filename + local lineno + + for frame in "$@"; do + bats_frame_filename "$frame" 'filename' + bats_trim_filename "$filename" 'filename' + bats_frame_lineno "$frame" 'lineno' + + printf '%s' "${BATS_STACK_TRACE_PREFIX-# }" + if [[ $index -eq 1 ]]; then + printf '(' + else + printf ' ' + fi + + local fn + bats_frame_function "$frame" 'fn' + if [[ "$fn" != "${BATS_TEST_NAME-}" ]] && + # don't print "from function `source'"", + # when failing in free code during `source $test_file` from bats-exec-file + ! [[ "$fn" == 'source' && $index -eq $count ]]; then + local quoted_fn + bats_quote_code quoted_fn "$fn" + printf "from function %s " "$quoted_fn" + fi + + local reference + bats_format_file_line_reference reference "$filename" "$lineno" + if [[ $index -eq $count ]]; then + printf 'in test file %s)\n' "$reference" + else + printf 'in file %s,\n' "$reference" + fi + + ((++index)) + done +} + +bats_print_failed_command() { + local stack_trace=("${@}") + if [[ ${#stack_trace[@]} -eq 0 ]]; then + return 0 + fi + local frame="${stack_trace[${#stack_trace[@]} - 1]}" + local filename + local lineno + local failed_line + local failed_command + + bats_frame_filename "$frame" 'filename' + bats_frame_lineno "$frame" 'lineno' + bats_extract_line "$filename" "$lineno" 'failed_line' + bats_strip_string "$failed_line" 'failed_command' + local quoted_failed_command + bats_quote_code quoted_failed_command "$failed_command" + printf '# %s ' "${quoted_failed_command}" + + if [[ "${BATS_TIMED_OUT-NOTSET}" != NOTSET ]]; then + # the other values can be safely overwritten here, + # as the timeout is the primary reason for failure + BATS_ERROR_SUFFIX=" due to timeout" + fi + + if [[ "$BATS_ERROR_STATUS" -eq 1 ]]; then + printf 'failed%s\n' "$BATS_ERROR_SUFFIX" + else + printf 'failed with status %d%s\n' "$BATS_ERROR_STATUS" "$BATS_ERROR_SUFFIX" + fi +} + +bats_frame_lineno() { + printf -v "$2" '%s' "${1%% *}" +} + +bats_frame_function() { + local __bff_function="${1#* }" + printf -v "$2" '%s' "${__bff_function%% *}" +} + +bats_frame_filename() { + local __bff_filename="${1#* }" + __bff_filename="${__bff_filename#* }" + + if [[ "$__bff_filename" == "${BATS_TEST_SOURCE-}" ]]; then + __bff_filename="$BATS_TEST_FILENAME" + fi + printf -v "$2" '%s' "$__bff_filename" +} + +bats_extract_line() { + local __bats_extract_line_line + local __bats_extract_line_index=0 + + while IFS= read -r __bats_extract_line_line; do + if [[ "$((++__bats_extract_line_index))" -eq "$2" ]]; then + printf -v "$3" '%s' "${__bats_extract_line_line%$'\r'}" + break + fi + done <"$1" +} + +bats_strip_string() { + [[ "$1" =~ ^[[:space:]]*(.*)[[:space:]]*$ ]] + printf -v "$2" '%s' "${BASH_REMATCH[1]}" +} + +bats_trim_filename() { + printf -v "$2" '%s' "${1#"$BATS_CWD"/}" +} + +# normalize a windows path from e.g. C:/directory to /c/directory +# The path must point to an existing/accessible directory, not a file! +bats_normalize_windows_dir_path() { # + local output_var="$1" path="$2" + if [[ "$output_var" != NORMALIZED_INPUT ]]; then + local NORMALIZED_INPUT + fi + if [[ $path == ?:* ]]; then + NORMALIZED_INPUT="$( + cd "$path" || exit 1 + pwd + )" + else + NORMALIZED_INPUT="$path" + fi + printf -v "$output_var" "%s" "$NORMALIZED_INPUT" +} + +bats_emit_trace_context() { + local padding='$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$' + local reference + bats_format_file_line_reference reference "${file##*/}" "$line" + printf '%s [%s]\n' "${padding::${#BASH_LINENO[@]}-limit-3}" "$reference" >&4 +} + +bats_emit_trace_command() { + local padding='$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$' + printf '%s %s\n' "${padding::${#BASH_LINENO[@]}-limit-3}" "$BASH_COMMAND" >&4 + + # keep track of printed commands + BATS_LAST_BASH_COMMAND="$BASH_COMMAND" + BATS_LAST_BASH_LINENO="$line" +} + +BATS_EMIT_TRACE_LAST_STACK_DIFF=0 + +bats_emit_trace() { + if [[ ${BATS_TRACE_LEVEL:-0} -gt 0 ]]; then + local line=${BASH_LINENO[1]} limit=${BATS_STACK_TRACE_LIMIT-0} + # shellcheck disable=SC2016 + if (( ${#FUNCNAME[@]} > limit + 2 )) # only emit below BATS_STRACK_TRACE_LIMIT (adjust by 2 for trap+this function call) + # avoid printing the same line twice on errexit + [[ $BASH_COMMAND != "$BATS_LAST_BASH_COMMAND" || $line != "$BATS_LAST_BASH_LINENO" ]]; then + local file="${BASH_SOURCE[2]}" # index 2: skip over bats_emit_trace and bats_debug_trap + if [[ $file == "${BATS_TEST_SOURCE:-}" ]]; then + file="$BATS_TEST_FILENAME" + fi + # stack size difference since last call of this function + # <0: means new function call + # >0: means return + # =0: in same function as before (assuming we did not skip return/call) + local stack_diff=$(( BATS_LAST_STACK_DEPTH - ${#BASH_LINENO[@]} )) + # show context immediately when returning or on second command in new function + # as the first "command" is the function itself + if (( stack_diff > 0 )) || (( BATS_EMIT_TRACE_LAST_STACK_DIFF < 0 )); then + bats_emit_trace_context + fi + # only print command when moving up or staying in same function + # again, avoids printing the first command (the function itself) in new function + if (( stack_diff >= 0 )); then + bats_emit_trace_command + fi + + BATS_EMIT_TRACE_LAST_STACK_DIFF=$stack_diff + fi + # always update to detect stack depth changes regardless of printing + BATS_LAST_STACK_DEPTH="${#BASH_LINENO[@]}" + fi +} + +# bats_debug_trap tracks the last line of code executed within a test. This is +# necessary because $BASH_LINENO is often incorrect inside of ERR and EXIT +# trap handlers. +# +# Below are tables describing different command failure scenarios and the +# reliability of $BASH_LINENO within different the executed DEBUG, ERR, and EXIT +# trap handlers. Naturally, the behaviors change between versions of Bash. +# +# Table rows should be read left to right. For example, on bash version +# 4.0.44(2)-release, if a test executes `false` (or any other failing external +# command), bash will do the following in order: +# 1. Call the DEBUG trap handler (bats_debug_trap) with $BASH_LINENO referring +# to the source line containing the `false` command, then +# 2. Call the DEBUG trap handler again, but with an incorrect $BASH_LINENO, then +# 3. Call the ERR trap handler, but with a (possibly-different) incorrect +# $BASH_LINENO, then +# 4. Call the DEBUG trap handler again, but with $BASH_LINENO set to 1, then +# 5. Call the EXIT trap handler, with $BASH_LINENO set to 1. +# +# bash version 4.4.20(1)-release +# command | first DEBUG | second DEBUG | ERR | third DEBUG | EXIT +# -------------+-------------+--------------+---------+-------------+-------- +# false | OK | OK | OK | BAD[1] | BAD[1] +# [[ 1 = 2 ]] | OK | BAD[2] | BAD[2] | BAD[1] | BAD[1] +# (( 1 = 2 )) | OK | BAD[2] | BAD[2] | BAD[1] | BAD[1] +# ! true | OK | --- | BAD[4] | --- | BAD[1] +# $var_dne | OK | --- | --- | BAD[1] | BAD[1] +# source /dne | OK | --- | --- | BAD[1] | BAD[1] +# +# bash version 4.0.44(2)-release +# command | first DEBUG | second DEBUG | ERR | third DEBUG | EXIT +# -------------+-------------+--------------+---------+-------------+-------- +# false | OK | BAD[3] | BAD[3] | BAD[1] | BAD[1] +# [[ 1 = 2 ]] | OK | --- | BAD[3] | --- | BAD[1] +# (( 1 = 2 )) | OK | --- | BAD[3] | --- | BAD[1] +# ! true | OK | --- | BAD[3] | --- | BAD[1] +# $var_dne | OK | --- | --- | BAD[1] | BAD[1] +# source /dne | OK | --- | --- | BAD[1] | BAD[1] +# +# [1] The reported line number is always 1. +# [2] The reported source location is that of the beginning of the function +# calling the command. +# [3] The reported line is that of the last command executed in the DEBUG trap +# handler. +# [4] The reported source location is that of the call to the function calling +# the command. +bats_debug_trap() { + # on windows we sometimes get a mix of paths (when install via nmp install -g) + # which have C:/... or /c/... comparing them is going to be problematic. + # We need to normalize them to a common format! + local NORMALIZED_INPUT + bats_normalize_windows_dir_path NORMALIZED_INPUT "${1%/*}" + local file_excluded='' path + for path in "${BATS_DEBUG_EXCLUDE_PATHS[@]}"; do + if [[ "$NORMALIZED_INPUT" == "$path"* ]]; then + file_excluded=1 + break + fi + done + + # don't update the trace within library functions or we get backtraces from inside traps + # also don't record new stack traces while handling interruptions, to avoid overriding the interrupted command + if [[ -z "$file_excluded" && + "${BATS_INTERRUPTED-NOTSET}" == NOTSET && + "${BATS_TIMED_OUT-NOTSET}" == NOTSET ]]; then + BATS_DEBUG_LASTLAST_STACK_TRACE=( + ${BATS_DEBUG_LAST_STACK_TRACE[@]+"${BATS_DEBUG_LAST_STACK_TRACE[@]}"} + ) + + BATS_DEBUG_LAST_LINENO=(${BASH_LINENO[@]+"${BASH_LINENO[@]}"}) + BATS_DEBUG_LAST_SOURCE=(${BASH_SOURCE[@]+"${BASH_SOURCE[@]}"}) + bats_capture_stack_trace + bats_emit_trace + fi +} + +# For some versions of Bash, the `ERR` trap may not always fire for every +# command failure, but the `EXIT` trap will. Also, some command failures may not +# set `$?` properly. See #72 and #81 for details. +# +# For this reason, we call `bats_check_status_from_trap` at the very beginning +# of `bats_teardown_trap` and check the value of `$BATS_TEST_COMPLETED` before +# taking other actions. We also adjust the exit status value if needed. +# +# See `bats_exit_trap` for an additional EXIT error handling case when `$?` +# isn't set properly during `teardown()` errors. +bats_check_status_from_trap() { + local status="$?" + if [[ -z "${BATS_TEST_COMPLETED:-}" ]]; then + BATS_ERROR_STATUS="${BATS_ERROR_STATUS:-$status}" + if [[ "$BATS_ERROR_STATUS" -eq 0 ]]; then + BATS_ERROR_STATUS=1 + fi + trap - DEBUG + fi +} + +bats_add_debug_exclude_path() { # + if [[ -z "$1" ]]; then # don't exclude everything + printf "bats_add_debug_exclude_path: Exclude path must not be empty!\n" >&2 + return 1 + fi + if [[ "$OSTYPE" == cygwin || "$OSTYPE" == msys ]]; then + local normalized_dir + bats_normalize_windows_dir_path normalized_dir "$1" + BATS_DEBUG_EXCLUDE_PATHS+=("$normalized_dir") + else + BATS_DEBUG_EXCLUDE_PATHS+=("$1") + fi +} + +bats_setup_tracing() { + # Variables for capturing accurate stack traces. See bats_debug_trap for + # details. + # + # BATS_DEBUG_LAST_LINENO, BATS_DEBUG_LAST_SOURCE, and + # BATS_DEBUG_LAST_STACK_TRACE hold data from the most recent call to + # bats_debug_trap. + # + # BATS_DEBUG_LASTLAST_STACK_TRACE holds data from two bats_debug_trap calls + # ago. + # + # BATS_DEBUG_LAST_STACK_TRACE_IS_VALID indicates that + # BATS_DEBUG_LAST_STACK_TRACE contains the stack trace of the test's error. If + # unset, BATS_DEBUG_LAST_STACK_TRACE is unreliable and + # BATS_DEBUG_LASTLAST_STACK_TRACE should be used instead. + BATS_DEBUG_LASTLAST_STACK_TRACE=() + BATS_DEBUG_LAST_LINENO=() + BATS_DEBUG_LAST_SOURCE=() + BATS_DEBUG_LAST_STACK_TRACE=() + BATS_DEBUG_LAST_STACK_TRACE_IS_VALID= + BATS_ERROR_SUFFIX= + BATS_DEBUG_EXCLUDE_PATHS=() + # exclude some paths by default + bats_add_debug_exclude_path "$BATS_ROOT/$BATS_LIBDIR/" + bats_add_debug_exclude_path "$BATS_ROOT/libexec/" + + exec 4<&1 # used for tracing + if [[ "${BATS_TRACE_LEVEL:-0}" -gt 0 ]]; then + # avoid undefined variable errors + BATS_LAST_BASH_COMMAND= + BATS_LAST_BASH_LINENO= + BATS_LAST_STACK_DEPTH= + # try to exclude helper libraries if found, this is only relevant for tracing + while read -r path; do + bats_add_debug_exclude_path "$path" + done < <(find "$PWD" -type d -name bats-assert -o -name bats-support) + fi + + local exclude_paths path + # exclude user defined libraries + IFS=':' read -r exclude_paths <<<"${BATS_DEBUG_EXCLUDE_PATHS:-}" + for path in "${exclude_paths[@]}"; do + if [[ -n "$path" ]]; then + bats_add_debug_exclude_path "$path" + fi + done + + # turn on traps after setting excludes to avoid tracing the exclude setup + trap 'bats_debug_trap "$BASH_SOURCE"' DEBUG + trap 'bats_error_trap' ERR +} + +bats_error_trap() { + bats_check_status_from_trap + + # If necessary, undo the most recent stack trace captured by bats_debug_trap. + # See bats_debug_trap for details. + if [[ "${BASH_LINENO[*]}" = "${BATS_DEBUG_LAST_LINENO[*]:-}" && + "${BASH_SOURCE[*]}" = "${BATS_DEBUG_LAST_SOURCE[*]:-}" && + -z "$BATS_DEBUG_LAST_STACK_TRACE_IS_VALID" ]]; then + BATS_DEBUG_LAST_STACK_TRACE=( + ${BATS_DEBUG_LASTLAST_STACK_TRACE[@]+"${BATS_DEBUG_LASTLAST_STACK_TRACE[@]}"} + ) + fi + BATS_DEBUG_LAST_STACK_TRACE_IS_VALID=1 +} + +bats_interrupt_trap() { + # mark the interruption, to handle during exit + BATS_INTERRUPTED=true + BATS_ERROR_STATUS=130 + # debug trap fires before interrupt trap but gets wrong linenumber (line 1) + # -> use last stack trace instead of BATS_DEBUG_LAST_STACK_TRACE_IS_VALID=true +} + +# this is used inside run() +bats_interrupt_trap_in_run() { + # mark the interruption, to handle during exit + BATS_INTERRUPTED=true + BATS_ERROR_STATUS=130 + BATS_DEBUG_LAST_STACK_TRACE_IS_VALID=true + exit 130 +} diff --git a/tests/bats/bats-core/lib/bats-core/validator.bash b/tests/bats/bats-core/lib/bats-core/validator.bash new file mode 100644 index 0000000..59fc2c1 --- /dev/null +++ b/tests/bats/bats-core/lib/bats-core/validator.bash @@ -0,0 +1,37 @@ +#!/usr/bin/env bash + +bats_test_count_validator() { + trap '' INT # continue forwarding + header_pattern='[0-9]+\.\.[0-9]+' + IFS= read -r header + # repeat the header + printf "%s\n" "$header" + + # if we detect a TAP plan + if [[ "$header" =~ $header_pattern ]]; then + # extract the number of tests ... + local expected_number_of_tests="${header:3}" + # ... count the actual number of [not ] oks... + local actual_number_of_tests=0 + while IFS= read -r line; do + # forward line + printf "%s\n" "$line" + case "$line" in + 'ok '*) + ((++actual_number_of_tests)) + ;; + 'not ok'*) + ((++actual_number_of_tests)) + ;; + esac + done + # ... and error if they are not the same + if [[ "${actual_number_of_tests}" != "${expected_number_of_tests}" ]]; then + printf '# bats warning: Executed %s instead of expected %s tests\n' "$actual_number_of_tests" "$expected_number_of_tests" + return 1 + fi + else + # forward output unchanged + cat + fi +} diff --git a/tests/bats/bats-core/lib/bats-core/warnings.bash b/tests/bats/bats-core/lib/bats-core/warnings.bash new file mode 100644 index 0000000..5762d74 --- /dev/null +++ b/tests/bats/bats-core/lib/bats-core/warnings.bash @@ -0,0 +1,44 @@ +#!/usr/bin/env bash + +# shellcheck source=lib/bats-core/tracing.bash +source "$BATS_ROOT/$BATS_LIBDIR/bats-core/tracing.bash" + +# generate a warning report for the parent call's call site +bats_generate_warning() { # [--no-stacktrace] [...] + local warning_number="${1-}" padding="00" + shift + local no_stacktrace= + if [[ ${1-} == --no-stacktrace ]]; then + no_stacktrace=1 + shift + fi + if [[ $warning_number =~ [0-9]+ ]] && ((warning_number < ${#BATS_WARNING_SHORT_DESCS[@]})); then + { + printf "BW%s: ${BATS_WARNING_SHORT_DESCS[$warning_number]}\n" "${padding:${#warning_number}}${warning_number}" "$@" + if [[ -z "$no_stacktrace" ]]; then + bats_capture_stack_trace + BATS_STACK_TRACE_PREFIX=' ' bats_print_stack_trace "${BATS_DEBUG_LAST_STACK_TRACE[@]}" + fi + } >>"$BATS_WARNING_FILE" 2>&3 + else + printf "Invalid Bats warning number '%s'. It must be an integer between 1 and %d." "$warning_number" "$((${#BATS_WARNING_SHORT_DESCS[@]} - 1))" >&2 + exit 1 + fi +} + +# generate a warning if the BATS_GUARANTEED_MINIMUM_VERSION is not high enough +bats_warn_minimum_guaranteed_version() { # + if bats_version_lt "$BATS_GUARANTEED_MINIMUM_VERSION" "$2"; then + bats_generate_warning 2 "$1" "$2" "$2" + fi +} + +# put after functions to avoid line changes in tests when new ones get added +BATS_WARNING_SHORT_DESCS=( + # to start with 1 + 'PADDING' + # see issue #578 for context + "\`run\`'s command \`%s\` exited with code 127, indicating 'Command not found'. Use run's return code checks, e.g. \`run -127\`, to fix this message." + "%s requires at least BATS_VERSION=%s. Use \`bats_require_minimum_version %s\` to fix this message." + "\`setup_suite\` is visible to test file '%s', but was not executed. It belongs into 'setup_suite.bash' to be picked up automatically." +) diff --git a/tests/bats/bats-core/libexec/bats-core/bats b/tests/bats/bats-core/libexec/bats-core/bats new file mode 100755 index 0000000..0f32db2 --- /dev/null +++ b/tests/bats/bats-core/libexec/bats-core/bats @@ -0,0 +1,517 @@ +#!/usr/bin/env bash +set -e + +export BATS_VERSION='1.11.0' +VALID_FORMATTERS="pretty, junit, tap, tap13" + +version() { + printf 'Bats %s\n' "$BATS_VERSION" +} + +abort() { + local print_usage=1 + if [[ ${1:-} == --no-print-usage ]]; then + print_usage= + shift + fi + printf 'Error: %s\n' "$1" >&2 + if [[ -n $print_usage ]]; then + usage >&2 + fi + exit 1 +} + +usage() { + local cmd="${0##*/}" + local line + + cat < + ${cmd} [-h | -v] + +HELP_TEXT_HEADER + + cat <<'HELP_TEXT_BODY' + is the path to a Bats test file, or the path to a directory + containing Bats test files (ending with ".bats") + + -c, --count Count test cases without running any tests + --code-quote-style