mirror of
https://github.com/jimeh/stub.sh.git
synced 2026-02-19 13:46:40 +00:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 3663e1488b | |||
|
|
14b1b07d45 | ||
| cdc428f859 | |||
|
|
30db3416ea | ||
|
|
b75a952a20 | ||
| b6a1ae189c | |||
|
|
bd6f3c4666 | ||
| 89aed2999c |
2
Makefile
2
Makefile
@@ -8,7 +8,7 @@ update: update_test-runner.sh update_assert.sh
|
||||
test/assert.sh:
|
||||
echo "fetching assert.sh..." && \
|
||||
curl -s -L -o test/assert.sh \
|
||||
https://raw.github.com/lehmannro/assert.sh/v1.0.2/assert.sh
|
||||
https://raw.github.com/lehmannro/assert.sh/v1.1/assert.sh
|
||||
|
||||
remove_assert.sh:
|
||||
( \
|
||||
|
||||
34
README.md
34
README.md
@@ -1,4 +1,4 @@
|
||||
# stub.sh [](https://travis-ci.org/jimeh/stub.sh)
|
||||
# stub.sh [](https://travis-ci.org/jimeh/stub.sh)
|
||||
|
||||
Helpers for bash script testing to stub/fake binaries and functions. Includes
|
||||
support for validating number of stub calls, and/or if stub has been called
|
||||
@@ -7,6 +7,34 @@ with specific arguments.
|
||||
Particularly useful when used in combination with the simple and elegant
|
||||
[assert.sh](https://github.com/lehmannro/assert.sh) test framework.
|
||||
|
||||
## Installation
|
||||
|
||||
The `stub.sh` script can be installed in several ways:
|
||||
|
||||
- Downloading the "raw" `stub.sh` file from Github
|
||||
- Using `bpkg`
|
||||
|
||||
### Downloading the `stub.sh` file
|
||||
|
||||
```sh
|
||||
curl -LO 'https://github.com/jimeh/stub.sh/raw/master/stub.sh'
|
||||
```
|
||||
|
||||
(Or manually open https://github.com/jimeh/stub.sh/raw/master/stub.sh in a webbrowser).
|
||||
|
||||
### Using bpkg
|
||||
|
||||
[BPKG](http://www.bpkg.io/) is a lightweight package manager for bash.
|
||||
|
||||
`stub.sh` is available as [bpkg](http://www.bpkg.io/) package:
|
||||
|
||||
```sh
|
||||
bpkg install jimeh/stub.sh
|
||||
```
|
||||
|
||||
This will install `stub.sh` at `./deps/stub.sh/stub.sh` in the directory that `bpkg` has been run in.
|
||||
|
||||
To install globally run: `bpkg install -g jimeh/stub.sh`
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -25,7 +53,7 @@ uname #=> Darwin
|
||||
stub uname # silent stub
|
||||
uname #=>
|
||||
stub uname STDOUT # stub prints to STDOUT
|
||||
uname #=> uname stub:
|
||||
uname #=> uname stub:
|
||||
uname -r #=> uname stub: -r
|
||||
restore uname # remove stub
|
||||
uname #=> Darwin
|
||||
@@ -38,7 +66,7 @@ source "stub.sh"
|
||||
my-name-is() { echo "My name is $@."; }
|
||||
my-name-is Edward Elric #=> My name is Edward Elric.
|
||||
stub my-name-is # silent stub
|
||||
my-name-is Edward Elric #=>
|
||||
my-name-is Edward Elric #=>
|
||||
stub my-name-is STDOUT # stub prints to STDOUT
|
||||
my-name-is Edward Elric #=> my-name-is stub: Edward Elric
|
||||
restore my-name-is # remove stub
|
||||
|
||||
9
package.json
Normal file
9
package.json
Normal file
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"name": "stub.sh",
|
||||
"description": "Utilities to mock/fake/stub binaries and functions for testing with BASH.",
|
||||
"author": "Jim Myhrberg <contact@jimeh.me>",
|
||||
"license": "MIT",
|
||||
"homepage": "https://github.com/jimeh/stub.sh",
|
||||
"scripts": [],
|
||||
"files": ["README.md", "stub.sh"]
|
||||
}
|
||||
18
stub.sh
18
stub.sh
@@ -38,8 +38,8 @@
|
||||
# Returns nothing.
|
||||
stub() {
|
||||
local redirect="null"
|
||||
if [ "$2" == "stdout" ] || [ "$2" == "STDOUT" ]; then redirect=""; fi
|
||||
if [ "$2" == "stderr" ] || [ "$2" == "STDERR" ]; then redirect="stderr"; fi
|
||||
if [ "$2" = "stdout" ] || [ "$2" = "STDOUT" ]; then redirect=""; fi
|
||||
if [ "$2" = "stderr" ] || [ "$2" = "STDERR" ]; then redirect="stderr"; fi
|
||||
|
||||
stub_and_echo "$1" "$1 stub: \$@" "$redirect"
|
||||
}
|
||||
@@ -57,8 +57,8 @@ stub() {
|
||||
# Returns nothing.
|
||||
stub_and_echo() {
|
||||
local redirect=""
|
||||
if [ "$3" == "stderr" ] || [ "$3" == "STDERR" ]; then redirect=" 1>&2"; fi
|
||||
if [ "$3" == "null" ]; then redirect=" &>/dev/null"; fi
|
||||
if [ "$3" = "stderr" ] || [ "$3" = "STDERR" ]; then redirect=" 1>&2"; fi
|
||||
if [ "$3" = "null" ]; then redirect=" &>/dev/null"; fi
|
||||
|
||||
stub_and_eval "$1" "echo \"$2\"$redirect"
|
||||
}
|
||||
@@ -234,14 +234,14 @@ stub_called_with_times() {
|
||||
|
||||
shift 1
|
||||
local args="$@"
|
||||
if [ "$args" == "" ]; then args="<none>"; fi
|
||||
if [ "$args" = "" ]; then args="<none>"; fi
|
||||
|
||||
local count=0
|
||||
local index="$(__stub_index "$cmd")"
|
||||
if [ -n "$index" ]; then
|
||||
eval "local calls=(\"\${STUB_${index}_CALLS[@]}\")"
|
||||
for call in "${calls[@]}"; do
|
||||
if [ "$call" == "$args" ]; then ((count++)); fi
|
||||
if [ "$call" = "$args" ]; then ((count++)); fi
|
||||
done
|
||||
fi
|
||||
|
||||
@@ -362,7 +362,7 @@ __stub_call() {
|
||||
local cmd="$1"
|
||||
shift 1
|
||||
local args="$@"
|
||||
if [ "$args" == "" ]; then args="<none>"; fi
|
||||
if [ "$args" = "" ]; then args="<none>"; fi
|
||||
|
||||
local index="$(__stub_index "$cmd")"
|
||||
if [ -n "$index" ]; then
|
||||
@@ -376,7 +376,7 @@ __stub_index() {
|
||||
local cmd="$1"
|
||||
|
||||
for item in ${STUB_INDEX[@]}; do
|
||||
if [[ "$item" == "${cmd}="* ]]; then
|
||||
if [[ "$item" = "${cmd}="* ]]; then
|
||||
local index="$item"
|
||||
index="${index/${cmd}=/}"
|
||||
echo "$index"
|
||||
@@ -401,7 +401,7 @@ __stub_register() {
|
||||
eval "STUB_${STUB_NEXT_INDEX}_CALLS=()"
|
||||
|
||||
# Increment stub count.
|
||||
((STUB_NEXT_INDEX++))
|
||||
((++STUB_NEXT_INDEX))
|
||||
}
|
||||
|
||||
# Private: Cleans out and removes a stub's call list, and removes stub from
|
||||
|
||||
@@ -6,7 +6,7 @@ source "test-helper.sh"
|
||||
#
|
||||
|
||||
# Sets up stub index, stub call list, and adds stub to index.
|
||||
__stub_register "uname"
|
||||
__stub_register "uname" || assert_raises "false"
|
||||
__stub_register "top"
|
||||
assert 'echo ${STUB_INDEX[@]}' 'uname=0 top=1'
|
||||
assert 'echo ${STUB_INDEX[0]}' 'uname=0'
|
||||
|
||||
Reference in New Issue
Block a user