pax_global_header 0000666 0000000 0000000 00000000064 14737441462 0014526 g ustar 00root root 0000000 0000000 52 comment=785b38d6a6db3565de1d214e60cc295e9104e759
bash_unit-2.3.2/ 0000775 0000000 0000000 00000000000 14737441462 0013506 5 ustar 00root root 0000000 0000000 bash_unit-2.3.2/.gitattributes 0000664 0000000 0000000 00000000034 14737441462 0016376 0 ustar 00root root 0000000 0000000 bash_unit filter=insert_tag
bash_unit-2.3.2/.github/ 0000775 0000000 0000000 00000000000 14737441462 0015046 5 ustar 00root root 0000000 0000000 bash_unit-2.3.2/.github/FUNDING.yml 0000664 0000000 0000000 00000001257 14737441462 0016670 0 ustar 00root root 0000000 0000000 # These are supported funding model platforms
github: [pgrange]
# patreon: # Replace with a single Patreon username
# open_collective: # Replace with a single Open Collective username
# ko_fi: # Replace with a single Ko-fi username
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: bash_unit
# issuehunt: # Replace with a single IssueHunt username
# otechie: # Replace with a single Otechie username
# lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
# custom: https://liberapay.com/bash_unit/donate
bash_unit-2.3.2/.github/workflows/ 0000775 0000000 0000000 00000000000 14737441462 0017103 5 ustar 00root root 0000000 0000000 bash_unit-2.3.2/.github/workflows/bash_unit.yml 0000664 0000000 0000000 00000000423 14737441462 0021601 0 ustar 00root root 0000000 0000000 name: bash_unit tests
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
ubuntu:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Unit testing with bash_unit
run: FORCE_COLOR=true ./bash_unit tests/test*
bash_unit-2.3.2/.github/workflows/pre-commit.yml 0000664 0000000 0000000 00000004003 14737441462 0021677 0 ustar 00root root 0000000 0000000 ---
name: pre-commit
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
pre-commit:
runs-on: ubuntu-latest
env:
RAW_LOG: pre-commit.log
CS_XML: pre-commit.xml
steps:
- run: sudo apt-get update && sudo apt-get install cppcheck
if: false
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
if: false
with:
cache: pip
python-version: 3.12.1
- run: python -m pip install pre-commit regex
- uses: actions/cache/restore@v4
with:
path: |
~/.cache/pre-commit/
bash_unit
key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml')
}}
- name: Run pre-commit hooks
env:
SKIP: no-commit-to-branch
run: |
set -o pipefail
pre-commit gc
# Run default pre-commit hooks
pre-commit run --show-diff-on-failure --color=always --all-files | tee ${RAW_LOG}
# Run this version of bash_unit using it's current pre-commit-hook.yaml config
# Useful for testing that the current version works
pre-commit try-repo . --verbose --all-files | tee -a ${RAW_LOG}
- name: Convert Raw Log to annotations
uses: mdeweerd/logToCheckStyle@v2024.2.3
if: ${{ failure() }}
with:
in: ${{ env.RAW_LOG }}
# Out can be omitted if you do not need the xml output
# out: ${{ env.CS_XML }}
- uses: actions/cache/save@v4
if: ${{ always() }}
with:
path: |
~/.cache/pre-commit/
bash_unit
key: pre-commit-4|${{ env.pythonLocation }}|${{ hashFiles('.pre-commit-config.yaml')
}}
- name: Provide log as artifact
uses: actions/upload-artifact@v4
if: ${{ always() }}
with:
name: precommit-logs
path: |
${{ env.RAW_LOG }}
${{ env.CS_XML }}
retention-days: 2
bash_unit-2.3.2/.gitignore 0000664 0000000 0000000 00000000053 14737441462 0015474 0 ustar 00root root 0000000 0000000 *.swp
token
# BSD sed generated files
*-e
bash_unit-2.3.2/.pre-commit-config.yaml 0000664 0000000 0000000 00000005601 14737441462 0017771 0 ustar 00root root 0000000 0000000 ---
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: check-yaml
args: [--unsafe]
- id: check-json
- id: mixed-line-ending
- id: trailing-whitespace
exclude_types: [markdown]
- id: end-of-file-fixer
exclude: ^docs/man/.*$
- id: check-merge-conflict
- id: check-executables-have-shebangs
- id: check-shebang-scripts-are-executable
exclude: ^tests/test_.*$
- id: fix-byte-order-marker
- id: check-case-conflict
# Beautify shell scripts
# Deactivated because of an issue with deprecated python dependencies.
# See https://github.com/lovesegfault/beautysh/issues/248 and its fix to re-activate
# - repo: https://github.com/lovesegfault/beautysh.git
# rev: v6.2.1
# hooks:
# - id: beautysh
# exclude: (?x)^(tests/test_(.*))$
# args: [-i, "2"]
# Run local script
- repo: local
hooks:
- id: local-precommit-script
name: Run local script before commit if it exists
language: system
entry: bash -c '[ ! -x local.sh ] || ./local.sh'
pass_filenames: false
# Prettier (format code, only for non common files)
- repo: https://github.com/pre-commit/mirrors-prettier
rev: v4.0.0-alpha.8
hooks:
- id: prettier
stages: [manual]
exclude_types:
- executable
- binary
- shell
- markdown
# Check format of yaml files
- repo: https://github.com/adrienverge/yamllint.git
rev: v1.35.1
hooks:
- id: yamllint
args:
- --no-warnings
- -d
- '{extends: relaxed, rules: {line-length: {max: 120}}}'
# Execute codespell to fix typo errors (setup of codespell into dev/tools/codespell/)
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
- id: codespell
args:
- --ignore-words-list=master,als
- --builtin=clear,rare,informal,usage,code,names,en-GB_to_en-US
exclude_types: [image]
exclude: ^docs/man/.*$
# Check some shell scripts
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.9.0.6
hooks:
- id: shellcheck
args: [-W, '100']
# Run tests
- repo: local
hooks:
- id: tests
stages: [manual]
name: Run tests
language: system
entry: bash -c "./bash_unit tests/*"
pass_filenames: false
# This is how one can use bash_unit with pre-commit
# Only for documentation purpose as it can't be
# used in bash_unit itself: we always want to test
# bash_unit with the last version of bash_unit.
# Otherwise tests would always fail when we introduce
# a new feature.
# - repo: https://github.com/pgrange/bash_unit
# rev: v2.2.0
# hooks:
# - id: bash-unit
# stages: [manual]
# always_run: true
# verbose: true
bash_unit-2.3.2/.pre-commit-hooks.yaml 0000664 0000000 0000000 00000001051 14737441462 0017642 0 ustar 00root root 0000000 0000000 # Define hooks that this repository provides for pre-commit
- id: bash-unit
name: Run tests with `bash_unit`
description: This hook runs tests using `bash_unit`
entry: ./bash_unit
language: script
files: ^tests/(.*/)?test_.*\.sh$
types: [shell]
pass_filenames: true
# Duplicated with different id name for convienience
- id: bash_unit
name: Run tests with `bash_unit`
description: This hook runs tests using `bash_unit`
entry: ./bash_unit
language: script
files: ^tests/(.*/)?test_.*\.sh$
types: [shell]
pass_filenames: true
bash_unit-2.3.2/CONTRIBUTING.md 0000664 0000000 0000000 00000003204 14737441462 0015736 0 ustar 00root root 0000000 0000000 **bash unit testing enterprise edition framework for professionals **
If you like bash_unit and want to contribute, you can do so in one of the
following ways (order might matter).
# Spread the word
Talking about bash_unit is a very welcomed contribution.
Share your success with bash_unit on your blog, twitter, stackoverflow...
Nice words to share your experience with bash_unit is always appreciated.
If you want to say something nice about bash_unit but can not think of a
place for that right now, just add a comment to
[issue #37](https://github.com/pgrange/bash_unit/issues/37).
Starring the project is also appreciated.
# Suggest improvements
When you see something that is not working with bash_unit, or if you feel
something is missing, open an
[issue](https://github.com/pgrange/bash_unit/issues).
Opening issues helps improving bash_unit.
# Contribute code
If you use a tool like bash_unit, odds are high that you already heard
about software development. Just code the improvement you have in mind
and create a pull-request.
You can contribute with new features you think are missing but you can
also find inspiration with the
[open issues](https://github.com/pgrange/bash_unit/issues) of bash_unit.
See [how to contribute code](CONTRIBUTING_CODE.md).
# Donate
bash_unit is free software I develop during my (not so) free time. If you feel
bash_unit is helpful enough to you that you want to compensate for some of
the time spent developing or promoting it, you can contribute with your money
on liberapay:
[](https://liberapay.com/bash_unit/donate)
bash_unit-2.3.2/CONTRIBUTING_CODE.md 0000664 0000000 0000000 00000000136 14737441462 0016531 0 ustar 00root root 0000000 0000000 To perform a new release, run ./release in current directory.
See help for more information.
bash_unit-2.3.2/LICENSE 0000664 0000000 0000000 00000104513 14737441462 0014517 0 ustar 00root root 0000000 0000000 GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
bash_unit-2.3.2/README.adoc 0000664 0000000 0000000 00000070550 14737441462 0015302 0 ustar 00root root 0000000 0000000 ifdef::backend-manpage[]
= BASH_UNIT(1)
== NAME
endif::[]
ifndef::backend-manpage[]
image::img/bu_50.png[bash_unit]
endif::[]
bash_unit - bash unit testing enterprise edition framework for professionals!
== Synopsis
*bash_unit* [-f tap] [-p ] [-s ] [-r] [test_file]
== Description
*bash_unit* allows you to write unit tests (functions starting with *test*),
run them and, in case of failure, displays the stack trace
with source file and line number indications to locate the problem.
You might want to take a look at link:getting_started[how to get started]
before continuing reading this documentation.
The following functions are available in your tests (see below for detailed documentation):
* `fail [message]`
* `assert [message]`
* `assert_fail [message]`
* `assert_status_code [message]`
* `assert_equals [message]`
* `assert_not_equals [message]`
* `assert_matches [message]`
* `assert_not_matches [message]`
* `assert_within_delta [message]`
* `assert_no_diff [message]`
* `skip_if `
* `fake [replacement code]`
ifndef::backend-manpage[]
image::img/demo.gif[demo]
endif::[]
_(by the way, the documentation you are reading is itself tested with bash-unit)_
*bash_unit* is free software you may contribute to. See link:CONTRIBUTING.md[CONTRIBUTING.md].
== Options
*-p* _pattern_::
filters tests to run based on the given pattern.
You can specify several patterns by repeating this option
for each pattern.
*-s* _pattern_::
skip tests which name matches the given pattern.
You can specify several patterns by repeating this option
for each pattern.
Tests will appear in *bash_unit* output as _skipped_.
(see also _skip_if_)
*-r*::
executes test cases in random order.
Only affects the order within a test file (files are always
executed in the order in which they are specified on the
command line).
*-f* _output_format_::
specify an alternative output format.
The only supported value is *tap*.
*-q*::
quiet mode.
Will only output the status of each test with no further
information even in case of failure.
ifndef::backend-manpage[]
== How to install *bash_unit*
=== installing on Archlinux
*bash_unit* package is available on Archlinux through AUR. In order to install, issue the following command :
yaourt -Sys bash_unit
=== installing via link:https://nixos.org/[Nix/NixOS]
*bash_unit* package has been added to link:https://github.com/nixos/nixpkgs[nixpkgs]. You can use it with the following command:
nix-shell -p bash_unit
=== installing via link:https://brew.sh[Homebrew]
*bash_unit* is available by invoking brew:
brew install bash_unit
=== other installation
This will install *bash_unit* in your current working directory:
curl -s https://raw.githubusercontent.com/pgrange/bash_unit/master/install.sh | bash
You can also download it from the https://github.com/pgrange/bash_unit/releases[release page].
endif::[]
=== GitHub Actions
Here is an example of how you could integrate *bash_unit* with https://docs.github.com/fr/actions[GitHub Actions]:
```
name: bash_unit tests
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
ubuntu:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Unit testing with bash_unit
run: |
curl -s https://raw.githubusercontent.com/pgrange/bash_unit/master/install.sh | bash
FORCE_COLOR=true ./bash_unit tests/test_*
```
See this bash_unit https://github.com/pgrange/bash_unit_getting_started[getting started gitlab project] for a working example.
=== GitLab CI
Here is an example of how you could integrate *bash_unit* with https://docs.gitlab.com/ee/ci/[GitLab CI]:
```
test:
image: debian
script:
- apt-get update
- apt-get install --no-install-recommends -y curl ca-certificates
- curl -s https://raw.githubusercontent.com/pgrange/bash_unit/master/install.sh | bash
- FORCE_COLOR=true ./bash_unit tests/test_*
```
See this bash_unit https://gitlab.com/pgrange/bash_unit_getting_started[getting started gitlab project] for a working example.
=== pre-commit hook
You can run `+bash_unit+` as a https://pre-commit.com[pre-commit] hook.
Add the following to your pre-commit configuration. By default it will run scripts that are identified as shell scripts that match the path `+^tests/(.*/)?test_.*\.sh$+`.
[.pre-commit-config,yaml]
```
repos:
- repo: https://github.com/pgrange/bash_unit
rev: v2.2.0
hooks:
- id: bash-unit
always-run: true
```
== How to run tests
To run tests, simply call *bash_unit* with all your tests files as parameter. For instance to run some *bash_unit* tests, from *bash_unit* directory:
```test
./bash_unit tests/test_core.sh
```
```output
Running tests in tests/test_core.sh
Running test_assert_equals_fails_when_not_equal ... SUCCESS
Running test_assert_equals_succeed_when_equal ... SUCCESS
Running test_assert_fails ... SUCCESS
Running test_assert_fails_fails ... SUCCESS
Running test_assert_fails_succeeds ... SUCCESS
Running test_assert_matches_fails_when_not_matching ... SUCCESS
Running test_assert_matches_succeed_when_matching ... SUCCESS
Running test_assert_no_diff_fails_when_diff ... SUCCESS
Running test_assert_no_diff_succeeds_when_no_diff ... SUCCESS
Running test_assert_not_equals_fails_when_equal ... SUCCESS
Running test_assert_not_equals_succeeds_when_not_equal ... SUCCESS
Running test_assert_not_matches_fails_when_matching ... SUCCESS
Running test_assert_not_matches_succeed_when_not_matching ... SUCCESS
Running test_assert_shows_stderr_on_failure ... SUCCESS
Running test_assert_shows_stdout_on_failure ... SUCCESS
Running test_assert_status_code_fails ... SUCCESS
Running test_assert_status_code_succeeds ... SUCCESS
Running test_assert_succeeds ... SUCCESS
Running test_assert_within_delta_fails ... SUCCESS
Running test_assert_within_delta_succeeds ... SUCCESS
Running test_fail_fails ... SUCCESS
Running test_fail_prints_failure_message ... SUCCESS
Running test_fail_prints_where_is_error ... SUCCESS
Running test_fake_actually_fakes_the_command ... SUCCESS
Running test_fake_can_fake_inline ... SUCCESS
Running test_fake_echo_stdin_when_no_params ... SUCCESS
Running test_fake_exports_faked_in_subshells ... SUCCESS
Running test_fake_transmits_params_to_fake_code ... SUCCESS
Running test_fake_transmits_params_to_fake_code_as_array ... SUCCESS
Running test_should_pretty_format_even_when_LANG_is_unset ... SUCCESS
Overall result: SUCCESS
```
You might also want to run only specific tests, you may do so with the
_-p_ option. This option accepts a pattern as parameter and filters test
functions against this pattern.
```test
./bash_unit -p fail_fails -p assert tests/test_core.sh
```
```output
Running tests in tests/test_core.sh
Running test_assert_equals_fails_when_not_equal ... SUCCESS
Running test_assert_equals_succeed_when_equal ... SUCCESS
Running test_assert_fails ... SUCCESS
Running test_assert_fails_fails ... SUCCESS
Running test_assert_fails_succeeds ... SUCCESS
Running test_assert_matches_fails_when_not_matching ... SUCCESS
Running test_assert_matches_succeed_when_matching ... SUCCESS
Running test_assert_no_diff_fails_when_diff ... SUCCESS
Running test_assert_no_diff_succeeds_when_no_diff ... SUCCESS
Running test_assert_not_equals_fails_when_equal ... SUCCESS
Running test_assert_not_equals_succeeds_when_not_equal ... SUCCESS
Running test_assert_not_matches_fails_when_matching ... SUCCESS
Running test_assert_not_matches_succeed_when_not_matching ... SUCCESS
Running test_assert_shows_stderr_on_failure ... SUCCESS
Running test_assert_shows_stdout_on_failure ... SUCCESS
Running test_assert_status_code_fails ... SUCCESS
Running test_assert_status_code_succeeds ... SUCCESS
Running test_assert_succeeds ... SUCCESS
Running test_assert_within_delta_fails ... SUCCESS
Running test_assert_within_delta_succeeds ... SUCCESS
Running test_fail_fails ... SUCCESS
Overall result: SUCCESS
```
You can combine the _-p_ option with _-s_ to skip some of the tests. This option accepts a pattern
as parameter and mark as skipped any test function which matches this pattern.
```test
./bash_unit -p fail_fails -p assert -s no -s status tests/test_core.sh
```
```output
Running tests in tests/test_core.sh
Running test_assert_equals_fails_when_not_equal ... SKIPPED
Running test_assert_matches_fails_when_not_matching ... SKIPPED
Running test_assert_no_diff_fails_when_diff ... SKIPPED
Running test_assert_no_diff_succeeds_when_no_diff ... SKIPPED
Running test_assert_not_equals_fails_when_equal ... SKIPPED
Running test_assert_not_equals_succeeds_when_not_equal ... SKIPPED
Running test_assert_not_matches_fails_when_matching ... SKIPPED
Running test_assert_not_matches_succeed_when_not_matching ... SKIPPED
Running test_assert_status_code_fails ... SKIPPED
Running test_assert_status_code_succeeds ... SKIPPED
Running test_assert_equals_succeed_when_equal ... SUCCESS
Running test_assert_fails ... SUCCESS
Running test_assert_fails_fails ... SUCCESS
Running test_assert_fails_succeeds ... SUCCESS
Running test_assert_matches_succeed_when_matching ... SUCCESS
Running test_assert_shows_stderr_on_failure ... SUCCESS
Running test_assert_shows_stdout_on_failure ... SUCCESS
Running test_assert_succeeds ... SUCCESS
Running test_assert_within_delta_fails ... SUCCESS
Running test_assert_within_delta_succeeds ... SUCCESS
Running test_fail_fails ... SUCCESS
Overall result: SUCCESS
```
*bash_unit* supports the http://testanything.org/[Test Anything Protocol] so you can ask for a tap formatted
output with the _-f_ option.
```test
./bash_unit -f tap tests/test_core.sh
```
```output
# Running tests in tests/test_core.sh
ok - test_assert_equals_fails_when_not_equal
ok - test_assert_equals_succeed_when_equal
ok - test_assert_fails
ok - test_assert_fails_fails
ok - test_assert_fails_succeeds
ok - test_assert_matches_fails_when_not_matching
ok - test_assert_matches_succeed_when_matching
ok - test_assert_no_diff_fails_when_diff
ok - test_assert_no_diff_succeeds_when_no_diff
ok - test_assert_not_equals_fails_when_equal
ok - test_assert_not_equals_succeeds_when_not_equal
ok - test_assert_not_matches_fails_when_matching
ok - test_assert_not_matches_succeed_when_not_matching
ok - test_assert_shows_stderr_on_failure
ok - test_assert_shows_stdout_on_failure
ok - test_assert_status_code_fails
ok - test_assert_status_code_succeeds
ok - test_assert_succeeds
ok - test_assert_within_delta_fails
ok - test_assert_within_delta_succeeds
ok - test_fail_fails
ok - test_fail_prints_failure_message
ok - test_fail_prints_where_is_error
ok - test_fake_actually_fakes_the_command
ok - test_fake_can_fake_inline
ok - test_fake_echo_stdin_when_no_params
ok - test_fake_exports_faked_in_subshells
ok - test_fake_transmits_params_to_fake_code
ok - test_fake_transmits_params_to_fake_code_as_array
ok - test_should_pretty_format_even_when_LANG_is_unset
1..30
```
== How to write tests
Write your test functions in a file. The name of a test function has to start with *test*. Only functions starting with *test* will be tested.
Use the *bash_unit* assertion functions in your test functions, see below.
You may write a *setup* function that will be executed before each test is run.
You may write a *teardown* function that will be executed after each test is run.
You may write a *setup_suite* function that will be executed only once before all the tests of your test file.
You may write a *teardown_suite* function that will be executed only once after all the tests of your test file.
If you write code outside of any bash function, this code will be executed once at test file loading time since
your file is a bash script and *bash_unit* sources it before running your tests. It is suggested to write a
*setup_suite* function and avoid any code outside a bash function. you must not use any bash_unit assertion
in setup_suite or use exit in setup_suite for teardown_suite to be run.
See https://github.com/pgrange/bash_unit/issues/43[issue 43] for more details.
If you want to keep an eye on a test not yet implemented, prefix the name of the function by *todo* instead of test.
Test to do are not executed and do not impact the global status of your test suite but are displayed in *bash_unit* output.
*bash_unit* changes the current working directory to the one of the running test file. If you need to access files from your test code, for instance the script under test, use path relative to the test file.
You may need to change the behavior of some commands to create conditions for your code under test to behave as expected. The *fake* function may help you to do that, see below.
== Test functions
*bash_unit* supports several shell oriented assertion functions.
=== *fail*
fail [message]
Fails the test and displays an optional message.
```test
test_can_fail() {
fail "this test failed on purpose"
}
```
```output
Running test_can_fail ... FAILURE
this test failed on purpose
doc:2:test_can_fail()
```
=== *assert*
assert [message]
Evaluates _assertion_ and fails if _assertion_ fails.
_assertion_ fails if its evaluation returns a status code different from 0.
In case of failure, the standard output and error of the evaluated _assertion_ is displayed. The optional message is also displayed.
```test
test_assert_fails() {
assert false "this test failed, obviously"
}
test_assert_succeed() {
assert true
}
```
```output
Running test_assert_fails ... FAILURE
this test failed, obviously
doc:2:test_assert_fails()
Running test_assert_succeed ... SUCCESS
```
But you probably want to assert less obvious facts.
```test
code() {
touch /tmp/the_file
}
test_code_creates_the_file() {
code
assert "test -e /tmp/the_file"
}
test_code_makes_the_file_executable() {
code
assert "test -x /tmp/the_file" "/tmp/the_file should be executable"
}
```
```output
Running test_code_creates_the_file ... SUCCESS
Running test_code_makes_the_file_executable ... FAILURE
/tmp/the_file should be executable
doc:14:test_code_makes_the_file_executable()
```
It may also be fun to use assert to check for the expected content of a file.
```test
code() {
echo 'not so cool' > /tmp/the_file
}
test_code_write_appropriate_content_in_the_file() {
code
assert "diff <(echo 'this is cool') /tmp/the_file"
}
```
```output
Running test_code_write_appropriate_content_in_the_file ... FAILURE
out> 1c1
out> < this is cool
out> ---
out> > not so cool
doc:8:test_code_write_appropriate_content_in_the_file()
```
=== *assert_fail*
assert_fail [message]
Asserts that _assertion_ fails. This is the opposite of *assert*.
_assertion_ fails if its evaluation returns a status code different from 0.
If the evaluated expression does not fail, then *assert_fail* will fail and display the standard output and error of the evaluated _assertion_. The optional message is also displayed.
```test
code() {
echo 'not so cool' > /tmp/the_file
}
test_code_does_not_write_cool_in_the_file() {
code
assert_fails "grep cool /tmp/the_file" "should not write 'cool' in /tmp/the_file"
}
test_code_does_not_write_this_in_the_file() {
code
assert_fails "grep this /tmp/the_file" "should not write 'this' in /tmp/the_file"
}
```
```output
Running test_code_does_not_write_cool_in_the_file ... FAILURE
should not write 'cool' in /tmp/the_file
out> not so cool
doc:8:test_code_does_not_write_cool_in_the_file()
Running test_code_does_not_write_this_in_the_file ... SUCCESS
```
=== *assert_status_code*
assert_status_code [message]
Checks for a precise status code of the evaluation of _assertion_.
It may be useful if you want to distinguish between several error conditions in your code.
In case of failure, the standard output and error of the evaluated _assertion_ is displayed. The optional message is also displayed.
```test
code() {
exit 23
}
test_code_should_fail_with_code_25() {
assert_status_code 25 code
}
```
```output
Running test_code_should_fail_with_code_25 ... FAILURE
expected status code 25 but was 23
doc:6:test_code_should_fail_with_code_25()
```
=== *assert_equals*
assert_equals [message]
Asserts for equality of the two strings _expected_ and _actual_.
```test
test_obvious_inequality_with_assert_equals(){
assert_equals "a string" "another string" "a string should be another string"
}
test_obvious_equality_with_assert_equals(){
assert_equals a a
}
```
```output
Running test_obvious_equality_with_assert_equals ... SUCCESS
Running test_obvious_inequality_with_assert_equals ... FAILURE
a string should be another string
expected [a string] but was [another string]
doc:2:test_obvious_inequality_with_assert_equals()
```
=== *assert_not_equals*
assert_not_equals [message]
Asserts for inequality of the two strings _unexpected_ and _actual_.
```test
test_obvious_equality_with_assert_not_equals(){
assert_not_equals "a string" "a string" "a string should be different from another string"
}
test_obvious_inequality_with_assert_not_equals(){
assert_not_equals a b
}
```
```output
Running test_obvious_equality_with_assert_not_equals ... FAILURE
a string should be different from another string
expected different value than [a string] but was the same
doc:2:test_obvious_equality_with_assert_not_equals()
Running test_obvious_inequality_with_assert_not_equals ... SUCCESS
```
=== *assert_matches*
assert_matches [message]
Asserts that the string _actual_ matches the regex pattern _expected-regex_.
```test
test_obvious_notmatching_with_assert_matches(){
assert_matches "a str.*" "another string" "'another string' should not match 'a str.*'"
}
test_obvious_matching_with_assert_matches(){
assert_matches "a[nN].t{0,1}.*r str.*" "another string"
}
```
```output
Running test_obvious_matching_with_assert_matches ... SUCCESS
Running test_obvious_notmatching_with_assert_matches ... FAILURE
'another string' should not match 'a str.*'
expected regex [a str.*] to match [another string]
doc:2:test_obvious_notmatching_with_assert_matches()
```
=== *assert_not_matches*
assert_not_matches [message]
Asserts that the string _actual_ does not match the regex pattern _unexpected-regex_.
```test
test_obvious_matching_with_assert_not_matches(){
assert_not_matches "a str.*" "a string" "'a string' should not match 'a str.*'"
}
test_obvious_notmatching_with_assert_not_matches(){
assert_not_matches "a str.*" "another string"
}
```
```output
Running test_obvious_matching_with_assert_not_matches ... FAILURE
'a string' should not match 'a str.*'
expected regex [a str.*] should not match but matched [a string]
doc:2:test_obvious_matching_with_assert_not_matches()
Running test_obvious_notmatching_with_assert_not_matches ... SUCCESS
```
=== *assert_within_delta*
assert_within_delta [message]
Asserts that the expected num matches the actual num up to a given max delta.
This function only support integers.
Given an expectation of 5 and a delta of 2 this would match 3, 4, 5, 6, and 7:
```test
test_matches_within_delta(){
assert_within_delta 5 3 2
assert_within_delta 5 4 2
assert_within_delta 5 5 2
assert_within_delta 5 6 2
assert_within_delta 5 7 2
}
test_does_not_match_within_delta(){
assert_within_delta 5 2 2
}
```
```output
Running test_does_not_match_within_delta ... FAILURE
expected value [5] to match [2] with a maximum delta of [2]
doc:9:test_does_not_match_within_delta()
Running test_matches_within_delta ... SUCCESS
```
=== *assert_no_diff*
assert_no_diff [message]
Asserts that the content of the file _actual_ does not have any differences to the one _expected_.
```test
test_obvious_notmatching_with_assert_no_diff(){
assert_no_diff <(echo foo) <(echo bar)
}
test_obvious_matching_with_assert_assert_no_diff(){
assert_no_diff bash_unit bash_unit
}
```
```output
Running test_obvious_matching_with_assert_assert_no_diff ... SUCCESS
Running test_obvious_notmatching_with_assert_no_diff ... FAILURE
expected 'doc' to be identical to 'doc' but was different
out> 1c1
out> < foo
out> ---
out> > bar
doc:2:test_obvious_notmatching_with_assert_no_diff()
```
== *skip_if* function
skip_if
If _condition_ is true, will skip all the tests in the current file which match the given _pattern_.
This can be useful when one has tests that are dependent on system environment, for instance:
```test
skip_if "uname | grep Darwin" linux
skip_if "uname | grep Linux" darwin
test_linux_proc_exists() {
assert "ls /proc/" "there should exist /proc on Linux"
}
test_darwin_proc_does_not_exist() {
assert_fail "ls /proc/" "there should not exist /proc on Darwin"
}
```
will output, on a Linux system:
```output
Running test_darwin_proc_does_not_exist ... SKIPPED
Running test_linux_proc_exists ... SUCCESS
```
== *fake* function
fake [replacement code]
Fakes _command_ and replaces it with _replacement code_ (if code is specified) for the rest of the execution of your test. If no replacement code is specified, then it replaces command by one that echoes stdin of fake. This may be useful if you need to simulate an environment for you code under test.
For instance:
```test
fake ps echo hello world
ps
```
will output:
```output
hello world
```
We can do the same using _stdin_ of fake:
```test
fake ps << EOF
hello world
EOF
ps
```
```output
hello world
```
ifndef::backend-manpage[]
It has been asked whether using *fake* results in creating actual fakes or stubs or mocks? or may be spies? or may be they are dummies?
The first answer to this question is: it depends. The second is: read this
https://www.google.fr/search?tbm=isch&q=fake%20mock%20stub[great and detailed literature] on this subject.
endif::[]
=== Using stdin
Here is an example, parameterizing fake with its _stdin_ to test that code fails when some process does not run and succeeds otherwise:
```test
code() {
ps a | grep apache
}
test_code_succeeds_if_apache_runs() {
fake ps </dev/null
}
```
This test calls _code_, which calls _ps_, which is actually implemented by __ps_. Since _code_ does not use _ax_ but only _a_ as parameters, this test should fail. But ...
```output
Running test_code_gives_ps_appropriate_parameters ... SUCCESS
```
The problem here is that _ps_ fail (because of the failed *assert_equals* assertion). But _ps_ is piped with _grep_:
```shell
code() {
ps a | grep apache
}
```
With bash, the result code of a pipeline equals the result code of the last command of the pipeline. The last command is _grep_ and since grep succeeds, the failure of __ps_ is lost and our test succeeds. We have only succeeded in messing with the test output, nothing more.
An alternative may be to activate bash _pipefail_ option but this may introduce unwanted side effects. We can also simply not output anything in __ps_ so that _grep_ fails:
```shell
code() {
ps a | grep apache
}
test_code_gives_ps_appropriate_parameters() {
_ps() {
assert_equals ax "${FAKE_PARAMS[@]}"
}
export -f _ps
fake ps _ps
code >/dev/null
}
```
The problem here is that we use a trick to make the code under test fail but the
failure has nothing to do with the actual *assert_equals* failure. This is really
bad, don't do that.
Moreover, *assert_equals* output is captured by _ps_ and this just messes with the display of our test results:
```shell
Running test_code_gives_ps_appropriate_parameters ...
```
The only correct alternative is for the fake _ps_ to write _FAKE_PARAMS_ in a file descriptor
so that your test can grab them after code execution and assert their value. For instance
by writing to a file:
```test
code() {
ps a | grep apache
}
test_code_gives_ps_appropriate_parameters() {
_ps() {
echo ${FAKE_PARAMS[@]} > /tmp/fake_params
}
export -f _ps
fake ps _ps
code || true
assert_equals ax "$(head -n1 /tmp/fake_params)"
}
setup() {
rm -f /tmp/fake_params
}
```
Here our fake writes to _/tmp/fake_. We delete this file in *setup* to be
sure that we do not get inappropriate data from a previous test. We assert
that the first line of _/tmp/fake_ equals _ax_. Also, note that we know
that _code_ will fail and write this to ignore the error: `code || true`.
```output
Running test_code_gives_ps_appropriate_parameters ... FAILURE
expected [ax] but was [a]
doc:14:test_code_gives_ps_appropriate_parameters()
```
We can also compact the fake definition:
```test
code() {
ps a | grep apache
}
test_code_gives_ps_appropriate_parameters() {
fake ps 'echo ${FAKE_PARAMS[@]} >/tmp/fake_params'
code || true
assert_equals ax "$(head -n1 /tmp/fake_params)"
}
setup() {
rm -f /tmp/fake_params
}
```
```output
Running test_code_gives_ps_appropriate_parameters ... FAILURE
expected [ax] but was [a]
doc:10:test_code_gives_ps_appropriate_parameters()
```
Finally, we can avoid the _/tmp/fake_params_ temporary file by using _coproc_:
```test
code() {
ps a | grep apache
}
test_get_data_from_fake() {
#Fasten you seat belt ...
coproc cat
exec {test_channel}>&${COPROC[1]}
fake ps 'echo ${FAKE_PARAMS[@]} >&$test_channel'
code || true
assert_equals ax "$(head -n1 <&${COPROC[0]})"
}
```
```output
Running test_get_data_from_fake ... FAILURE
expected [ax] but was [a]
doc:13:test_get_data_from_fake()
```
bash_unit-2.3.2/bash_unit 0000775 0000000 0000000 00000032645 14737441462 0015422 0 ustar 00root root 0000000 0000000 #!/usr/bin/env bash
#
# bash unit testing enterprise edition framework for professionals
# Copyright (C) 2011-2016 Pascal Grange
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software Foundation,
# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#
# https://github.com/pgrange/bash_unit
# shellcheck disable=2317 # Ignore unreachable - most function are not called.
# shellcheck disable=2155 # Ignore Declare and assign separately
VERSION=v2.3.2
ESCAPE=$(printf "\033")
NOCOLOR="${ESCAPE}[0m"
RED="${ESCAPE}[91m"
GREEN="${ESCAPE}[92m"
YELLOW="${ESCAPE}[93m"
BLUE="${ESCAPE}[94m"
# Make bash_unit immune to some basic unix commands faking
CAT="$(type -P cat)"
SED="$(type -P sed)"
GREP="$(type -P grep)"
RM="$(type -P rm)"
SHUF="$(type -P sort) -R"
# Store the number of tests run in a file so that the value is available
# from the parent process. This will become an issue if we start considering
# parallel test execution in the future.
TEST_COUNT_FILE="$(mktemp)"
# shellcheck disable=2064 # Use single quotes, expands now, not when signaled.
trap "$RM -f \"$TEST_COUNT_FILE\"" EXIT
fail() {
local message=${1:-}
local stdout=${2:-}
local stderr=${3:-}
# shellcheck disable=2154
notify_test_failed "$__bash_unit_current_test__"
notify_message "$message"
[[ -n "$stdout" ]] && [ -s "$stdout" ] && notify_stdout < "$stdout"
[[ -n "$stderr" ]] && [ -s "$stderr" ] && notify_stderr < "$stderr"
stacktrace | notify_stack
exit 1
}
assert() {
local assertion=$1
local message=${2:-}
_assert_expression \
"$assertion" \
"[ \$status == 0 ]" \
"\"$message\""
}
assert_fails() {
local assertion=$1
local message=${2:-}
_assert_expression \
"$assertion" \
"[ \$status != 0 ]" \
"\"$message\""
}
assert_fail() {
#deprecated, use assert_fails instead
assert_fails "$@"
}
assert_status_code() {
local expected_status=$1
local assertion="$2"
local message="${3:-}"
_assert_expression \
"$assertion" \
"[ \$status == $expected_status ]" \
"\"$message\" expected status code $expected_status but was \$status"
}
_assert_expression() {
local assertion=$1
local condition=$2
local message=$3
(
local stdout=$(mktemp)
local stderr=$(mktemp)
# shellcheck disable=2064 # Use single quotes, expands now, not when signaled.
trap "$RM -f \"$stdout\" \"$stderr\"" EXIT
local status
eval "($assertion)" >"$stdout" 2>"$stderr" && status=$? || status=$?
if ! eval "$condition"
then
fail "$(eval echo "$message")" "$stdout" "$stderr"
fi
) || exit $?
}
assert_equals() {
local expected=$1
local actual=$2
local message=${3:-}
[[ -z $message ]] || message="$message\n"
if [ "$expected" != "$actual" ]
then
fail "$message expected [$expected] but was [$actual]"
fi
}
assert_not_equals() {
local unexpected=$1
local actual=$2
local message=${3:-}
[[ -z $message ]] || message="$message\n"
[ "$unexpected" != "$actual" ] || \
fail "$message expected different value than [$unexpected] but was the same"
}
assert_matches() {
local expected=$1
local actual=$2
local message=${3:-}
[[ -z $message ]] || message="$message\n"
if [[ ! "${actual}" =~ ${expected} ]]; then
fail "$message expected regex [$expected] to match [$actual]"
fi
}
assert_not_matches() {
local unexpected=$1
local actual=$2
local message=${3:-}
[[ -z $message ]] || message="$message\n"
if [[ "${actual}" =~ ${unexpected} ]]; then
fail "$message expected regex [$unexpected] should not match but matched [$actual]"
fi
}
assert_within_delta() {
function abs() {
local value=$1
local sign=$(( value < 0 ? -1 : 1 ))
echo $((value * sign))
}
function is_number() {
local value=$1
test "$value" -eq "$value" 2>/dev/null
}
local expected=$1
local actual=$2
local max_delta=$3
assert "is_number $expected" "$message expected value [$expected] is not a number"
assert "is_number $actual" "$message actual value [$actual] is not a number"
assert "is_number $max_delta" "$message max_delta [$max_delta] is not a number"
local message=${4:-}
[[ -z $message ]] || message="$message\n"
local actual_delta="$(abs $((expected - actual)))"
if (( actual_delta > max_delta )); then
fail "$message expected value [$expected] to match [$actual] with a maximum delta of [$max_delta]"
fi
}
assert_no_diff() {
local expected=$1
local actual=$2
local message=${3:-}
[[ -z "$message" ]] || message="$message\n"
assert "diff '${expected}' '${actual}'" \
"$message expected '${actual}' to be identical to '${expected}' but was different"
}
fake() {
local command=$1
shift
if [ $# -gt 0 ]
then
eval "function $command() { export FAKE_PARAMS=(\"\$@\") ; $* ; }"
else
eval "function $command() { echo \"$($CAT)\" ; }"
fi
export -f "${command?}"
}
stacktrace() {
local i=1
while [ -n "${BASH_SOURCE[$i]:-}" ]
do
echo "${BASH_SOURCE[$i]}:${BASH_LINENO[$((i-1))]}:${FUNCNAME[$i]}()"
i=$((i + 1))
done | "$GREP" -v "^$BASH_SOURCE"
}
run_test_suite() {
local failure=0
if run_setup_suite
then
run_tests || failure=$?
else
failure=$?
fi
run_teardown_suite
return $failure
}
run_setup_suite() {
if declare -F | "$GREP" ' setup_suite$' >/dev/null
then
setup_suite
fi
}
maybe_shuffle() {
# shellcheck disable=2015 # A && B || C. C may run when A is true.
((randomize)) && $SHUF || $CAT
}
run_tests() {
local failure=0
local pending_tests=$(set | "$GREP" -E '^(pending|todo).* \(\)' | "$GREP" -E "$test_pattern" | "$SED" -e 's: .*::')
if [[ -n "$skip_pattern" ]]
then
local skipped_tests=$(set | "$GREP" -E '^test.* \(\)' | "$GREP" -E "$test_pattern" | "$GREP" -E "$skip_pattern" | "$SED" -e 's: .*::')
local tests_to_run="$(set | "$GREP" -E '^test.* \(\)' | "$GREP" -E "$test_pattern" | "$GREP" -v -E "$skip_pattern" | "$SED" -e 's: .*::' | maybe_shuffle)"
else
local skipped_tests=""
local tests_to_run="$(set | "$GREP" -E '^test.* \(\)' | "$GREP" -E "$test_pattern" | "$SED" -e 's: .*::' | maybe_shuffle)"
fi
local test_count=$(cat "${TEST_COUNT_FILE}")
test_count=$((test_count + $(count "$pending_tests") + $(count "$tests_to_run") + $(count "$skipped_tests")))
echo "${test_count}" > "${TEST_COUNT_FILE}"
for pending_test in $pending_tests
do
notify_test_starting "$pending_test"
notify_test_pending "$pending_test"
done
for skipped_test in $skipped_tests
do
notify_test_starting "$skipped_test"
notify_test_skipped "$skipped_test"
done
for test in $tests_to_run
do
(
local status=0
declare -F | "$GREP" ' setup$' >/dev/null && setup
(__bash_unit_current_test__="$test" run_test) || status=$?
declare -F | "$GREP" ' teardown$' >/dev/null && teardown
exit $status
)
failure=$(( $? || failure))
done
return $failure
}
run_test() {
set -e
notify_test_starting "$__bash_unit_current_test__"
"$__bash_unit_current_test__" && notify_test_succeeded "$__bash_unit_current_test__"
}
run_teardown_suite() {
if declare -F | "$GREP" ' teardown_suite$' >/dev/null
then
teardown_suite
fi
}
usage() {
echo "$1" >&2
echo "$0 [-f