Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/torokmark/assert.sh
:exclamation: Assertion lib for shell script users
https://github.com/torokmark/assert.sh
assertion-functions assertions script shell
Last synced: 14 days ago
JSON representation
:exclamation: Assertion lib for shell script users
- Host: GitHub
- URL: https://github.com/torokmark/assert.sh
- Owner: torokmark
- License: mit
- Created: 2016-12-11T09:23:04.000Z (almost 8 years ago)
- Default Branch: main
- Last Pushed: 2024-08-04T05:45:30.000Z (3 months ago)
- Last Synced: 2024-10-15T12:16:44.446Z (29 days ago)
- Topics: assertion-functions, assertions, script, shell
- Language: Shell
- Homepage: https://torokmark.github.io/assert.sh
- Size: 23.4 KB
- Stars: 145
- Watchers: 4
- Forks: 29
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# assert.sh
[](https://travis-ci.com/torokmark/assert.sh)
Assert.sh is intended to give the assertion mechanism to shell scripts with well-known assert functions like `assert_eq`, `assert_array_eq`, or `assert_empty`.
Inspired by [Assert class of JUnit](http://junit.sourceforge.net/javadoc/org/junit/Assert.html)
### Install & Usage
```sh
> $ git clone https://github.com/torokmark/assert.sh.git; cd assert.sh
> $ source assert.sh
> $ assert_eq "hello" "world"
> $ echo "$?"
# => 1
```
I. Clone the repository
```sh
git clone https://github.com/torokmark/assert.sh.git
```
> Or copy the assert.sh where your project is located.
II. Edit the script where you would like to use asserts and paste the next line on the top:
```sh
source './assert.sh'
```
III. Now assert functions are available for use.
```sh
assert_eq "hello" "world"
```
> 0 return status is considered true and anything else is considered false.
### List of assert functions
* `assert_eq` takes two strings and checks whether they are the same based on the character strings.
* `assert_not_eq` is the opposite of `assert_eq`.
* `assert_true` takes a parameter and returns 0 confirming the parameter is true.
* `assert_false` takes a parameter and decides whether it is false.
* `assert_array_eq` takes two arrays and compare them by items.
* `assert_array_not_eq` takes two arrays and return 0 if the items are not the same on the same index.
* `assert_empty` takes a string and returns 0 if it is empty
* `assert_not_empty` is the opposite of `assert_empty`.
* `assert_contain` checks whether the first argument contains the second one.
* `assert_not_contain` check whether the first argument does not contain the second one.
* `assert_gt` checks whether the first param is greater than the second.
* `assert_ge` checks whether the first param is greator than or equal to the second one.
* `assert_lt` checks whether the first param is less than the second one.
* `assert_le` checks whether the first param is less than or equal to the second one.
### How to write tests
Example:
```sh
source "./assert.sh"
local expected actual
expected="Hello"
actual="World!"
assert_eq "$expected" "$actual" "not equivalent!"
# => x Hello == World :: not equivalent!
```
```sh
source "./assert.sh"
local expected actual
expected="Hello"
actual="Hello"
assert_eq "$expected" "$actual"
if [ "$?" == 0 ]; then
log_success "assert_eq returns 0 if two words are equal"
else
log_failure "assert_eq should return 0"
fi
```
If the return status (`$?`) of `assert_eq` is equal to `0`, which is considered true according to the convention.
If the assert function returns `1`, the expected and actual values are differred.