22 Commits

Author SHA1 Message Date
de104f7cd5 Bump version to 1.0.2 2014-09-08 20:43:24 +01:00
58e1b8dfa7 Remove useless empty line 2014-09-08 20:43:05 +01:00
e8388b911b Update Makefile 2014-09-08 20:40:23 +01:00
d9e3e14c76 Merge pull request #2 from BrandonOCasey/master
Removed echo -e for portability issues
2014-09-08 17:05:06 +01:00
Brandon Casey
f46506d00e changed printf to use %s and changed newlines in the command string to semi colons 2014-09-08 11:07:11 -04:00
Brandon Casey
59a69b883f removing echo -e for portability issues 2014-09-04 11:49:24 -04:00
1f6dc46f3f Tweak .travis.yml 2014-05-26 13:45:45 +01:00
332cfb8d28 Whitespace tweak 2014-05-26 13:45:21 +01:00
f3e0f666cb Use test-runner.sh instead of homegrown test.sh 2014-05-26 13:45:21 +01:00
47ce28bba6 Fix travis build 2014-04-09 13:48:21 +01:00
6e8e9fcfcf Merge pull request #1 from macie/patch-1
timing support
2014-04-09 13:42:45 +01:00
Maciej Żok
0ea845751e timing support 2014-04-09 14:38:06 +02:00
3b02e60207 Fix typo in readme 2014-03-22 15:37:37 +00:00
78f31d9bc9 Bump version to 1.0.1 2014-03-22 15:32:19 +00:00
e5382ea2dc Update function reference to reflect changes in function comments 2014-03-22 15:31:21 +00:00
9a34d8fa90 Update/fix various function comments 2014-03-22 15:29:19 +00:00
8c18d4075c Ensure readme formatting is consistent 2014-03-22 15:21:28 +00:00
407fefcb34 Fix incorrect description of stub function in readme 2014-03-22 15:20:28 +00:00
ef607e8eec Fix stub_called_with example in readme 2014-03-22 15:05:20 +00:00
49ec034829 Add example to readme for validating X calls with Y arguments 2014-03-22 15:00:55 +00:00
5ac835a822 Fix outdated and incorrect example in readme 2014-03-22 15:00:09 +00:00
51f6c8776e Fix typo in readme 2014-03-22 15:00:01 +00:00
24 changed files with 107 additions and 95 deletions

3
.gitignore vendored
View File

@@ -1 +1,2 @@
test/assert.sh test/assert.sh
test-runner.sh

View File

@@ -1,2 +1,4 @@
language: node_js language: c
script: INVARIANT=1 make test before_install:
- sudo apt-get install bc
script: make test

View File

@@ -1,12 +1,38 @@
test: prepare test: bootstrap
./test.sh ./test-runner.sh
prepare: bootstrap: test-runner.sh test/assert.sh
test -f "test/assert.sh" || ( \ clean: remove_test-runner.sh remove_assert.sh
echo "fetching assert.sh..." && \ update: update_test-runner.sh update_assert.sh
curl -s -L -o test/assert.sh \
https://raw.github.com/lehmannro/assert.sh/v1.0.2/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
remove_assert.sh:
( \
test -f "test/assert.sh" && rm "test/assert.sh" && \
echo "removed test/assert.sh" \
) || exit 0
update_assert.sh: remove_assert.sh test/assert.sh
test-runner.sh:
echo "fetching test-runner.sh..." && \
curl -s -L -o test-runner.sh \
https://github.com/jimeh/test-runner.sh/raw/master/test-runner.sh && \
chmod +x test-runner.sh
remove_test-runner.sh:
( \
test -f "test-runner.sh" && rm "test-runner.sh" && \
echo "removed test-runner.sh" \
) || exit 0
update_test-runner.sh: remove_test-runner.sh test-runner.sh
.SILENT: .SILENT:
.PHONY: test prepare .PHONY: test bootstrap clean update \
remove_test-runner.sh update_test-runner.sh \
remove_assert.sh update_assert.sh

View File

@@ -63,52 +63,71 @@ Asserting stub has been called X times:
source "stub.sh" source "stub.sh"
my-uname() { uname; } my-uname() { uname; }
stub_and_echo uname "FooBar" stub_and_echo uname "FooBar"
stub_called_times uname #=> 0 stub_called_times uname #=> 0
stub_called_times uname 2 # returns 1 (error) stub_called_exactly_times uname 2 # returns 1 (error)
my-uname #=> FooBar my-uname #=> FooBar
stub_called_times uname #=> 1 stub_called_times uname #=> 1
stub_called_times uname 2 # returns 1 (error) stub_called_exactly_times uname 2 # returns 1 (error)
my-uname #=> FooBar my-uname #=> FooBar
stub_called_times uname #=> 2 stub_called_times uname #=> 2
stub_called_times uname 2 # returns 0 (success) stub_called_exactly_times uname 2 # returns 0 (success)
restore uname restore uname
``` ```
Asserting stub has been called with specific attributes: Asserting stub has been called with specific arguments:
```bash ```bash
source "stub.sh" source "stub.sh"
my-uname() { uname $@; } my-uname() { uname $@; }
stub_and_echo uname "FooBar" stub_and_echo uname "FooBar"
stub_called_with uname -r # returns 1 (error)
my-uname -r -a #=> FooBar
stub_called_with uname -r -a # returns 1 (error) stub_called_with uname -r -a # returns 1 (error)
stub_called_with uname -r # returns 1 (error) stub_called_with uname -r # returns 1 (error)
my-uname -r -a #=> FooBar
stub_called_with uname -r -a # returns 0 (success)
stub_called_with uname -r # returns 1 (error)
my-uname -r #=> FooBar my-uname -r #=> FooBar
stub_called_with uname -r -a # returns 0 (success)
stub_called_with uname -r # returns 0 (success) stub_called_with uname -r # returns 0 (success)
restore uname restore uname
``` ```
Asserting stub has been called X number of times with specific arguments:
```bash
source "stub.sh"
my-uname() { uname $@; }
stub_and_echo uname "FooBar"
stub_called_with_times uname -r #=> 0
stub_called_with_exactly_times uname 2 -r # returns 1 (error)
my-uname -r #=> FooBar
stub_called_with_times uname -r #=> 1
stub_called_with_exactly_times uname 2 -r # returns 1 (error)
my-uname -r #=> FooBar
stub_called_with_times uname -r #=> 2
stub_called_with_exactly_times uname 2 -r # returns 0 (success)
stub_called_with_times uname -r -a #=> 0
restore uname
```
## Function Reference ## Function Reference
### Stubbing and Restoring ### Stubbing and Restoring
- **`stub`**: Basic stubbing command. Will echo a default message to STDOUT. - **`stub`**: Basic stubbing command.
Arguments:
- `$1`: Name of command to stub - `$1`: Name of command to stub
- `$2`: When set to "STDERR", echo to STDERR instead of STDOUT (optional). - `$2`: (optional) When set to "STDERR" or "STDOUT", will echo a default
message to specified output. If no output is specified, nothing is
echoed.
- **`stub_and_echo`**: Stub given command and echo a custom string to STDOUT. - **`stub_and_echo`**: Stub given command and echo a custom string to STDOUT.
Arguments:
- `$1`: Name of command to stub. - `$1`: Name of command to stub.
- `$2`: String to echo when stub is called. - `$2`: String to echo when stub is called.
- `$3`: When set to "STDERR", echo to STDERR instead of STDOUT (optional). - `$3`: (optional) When set to "STDERR", echo to STDERR instead of STDOUT.
- **`stub_and_eval`**: Stub given command and execute custom commands via eval. - **`stub_and_eval`**: Stub given command and execute custom commands via
Arguments: eval.
- `$1`: Name of command to stub. - `$1`: Name of command to stub.
- `$2`: String to eval when stub is called. - `$2`: String to eval when stub is called.
- **`restore`**: Restores use of original binary/function that was stubbed. - **`restore`**: Restores use of original binary/function that was stubbed.
Arguments:
- `$1`: Name of command to restore. - `$1`: Name of command to restore.
### Stub Called Validation ### Stub Called Validation
@@ -136,26 +155,31 @@ restore uname
- **`stub_called_with`**: Check if given stub has been called with specified - **`stub_called_with`**: Check if given stub has been called with specified
arguments. arguments.
- `$1`: Name of stub to check. - `$1`: Name of stub to check.
- `$@`: All additional arguments are used to specify what stub was with. - `$@`: Any/all additional arguments are used to specify what stub was
called with.
- **`stub_called_with_times`**: Find out how many times a stub has been - **`stub_called_with_times`**: Find out how many times a stub has been
called with specified arguments. called with specified arguments.
- `$1`: Name of stub to check. - `$1`: Name of stub to check.
- `$@`: All additional arguments are used to specify what stub was with. - `$@`: Any/all additional arguments are used to specify what stub was
called with.
- **`stub_called_with_exactly_times`**: Validate that stub has been called - **`stub_called_with_exactly_times`**: Validate that stub has been called
with specified arguments exactly given number of times. with specified arguments exactly given number of times.
- `$1`: Name of stub to check. - `$1`: Name of stub to check.
- `$2`: Exact number of times stub should have been called. - `$2`: Exact number of times stub should have been called.
- `$@`: All additional arguments are used to specify what stub was with. - `$@`: Any/all additional arguments are used to specify what stub was
called with.
- **`stub_called_with_at_least_times`**: Validate that stub has been called - **`stub_called_with_at_least_times`**: Validate that stub has been called
with specified arguments at least X number of times. with specified arguments at least X number of times.
- `$1`: Name of stub to check. - `$1`: Name of stub to check.
- `$2`: Minimum number of times stub should have been called. - `$2`: Minimum number of times stub should have been called.
- `$@`: All additional arguments are used to specify what stub was with. - `$@`: Any/all additional arguments are used to specify what stub was
called with.
- **`stub_called_with_at_most_times`**: Validate that stub has been called - **`stub_called_with_at_most_times`**: Validate that stub has been called
with specified arguments no more than X number of times. with specified arguments no more than X number of times.
- `$1`: Name of stub to check. - `$1`: Name of stub to check.
- `$2`: Maximum number of times stub should have been called. - `$2`: Maximum number of times stub should have been called.
- `$@`: All additional arguments are used to specify what stub was with. - `$@`: Any/all additional arguments are used to specify what stub was
called with.
## Todo ## Todo

43
stub.sh
View File

@@ -1,5 +1,6 @@
# !/usr/bin/env bash # !/usr/bin/env bash
# stub.sh 1.0.0 - stubbing helpers for simplifying bash script tests. #
# stub.sh 1.0.2 - stubbing helpers for simplifying bash script tests.
# https://github.com/jimeh/stub.sh # https://github.com/jimeh/stub.sh
# #
# (The MIT License) # (The MIT License)
@@ -26,12 +27,12 @@
# #
# Public: Stub given command, echoing a default stub message. # Public: Stub given command.
# #
# Arguments: # Arguments:
# - $1: Name of command to stub. # - $1: Name of command to stub.
# - $2: When set to "STDERR", echo to STDERR instead of STDOUT. # - $2: (optional) When set to "STDOUT", echo a default message to STDOUT.
# When set to "null", all output is redirected to /dev/null. # When set to "STDERR", echo default message to STDERR.
# #
# Echoes nothing. # Echoes nothing.
# Returns nothing. # Returns nothing.
@@ -49,7 +50,7 @@ stub() {
# Arguments: # Arguments:
# - $1: Name of command to stub. # - $1: Name of command to stub.
# - $2: String to echo when stub is called. # - $2: String to echo when stub is called.
# - $3: When set to "STDERR", echo to STDERR instead of STDOUT. # - $3: (optional) When set to "STDERR", echo to STDERR instead of STDOUT.
# When set to "null", all output is redirected to /dev/null. # When set to "null", all output is redirected to /dev/null.
# #
# Echoes nothing. # Echoes nothing.
@@ -98,7 +99,7 @@ stub_and_eval() {
fi fi
# Create the stub. # Create the stub.
eval "$(echo -e "${cmd}() {\n __stub_call \"${cmd}\" \$@\n $2\n}")" eval "$( printf "%s" "${cmd}() { __stub_call \"${cmd}\" \$@; $2;}")"
} }
@@ -120,11 +121,11 @@ stub_called() {
# #
# Arguments: # Arguments:
# - $1: Name of stubbed command. # - $1: Name of stubbed command.
# - $@: All additional arguments are used to specify what stub was called # - $@: Any/all additional arguments are used to specify what stub was
# with. # called with.
# #
# Examples: # Examples:
# stub "uname" # stub uname
# uname # uname
# uname -r -a # uname -r -a
# stub_called_with uname # Returns 0 (success). # stub_called_with uname # Returns 0 (success).
@@ -148,13 +149,6 @@ stub_called_with() {
# #
# Arguments: # Arguments:
# - $1: Name of stubbed command. # - $1: Name of stubbed command.
# - $2: When specified, will check if stub was called exactly the given
# number of times (optional).
#
# Examples:
# stub_called_times "uname" # Echoes "2" if stub has been called twice.
# stub_called_times "uname" 2 # Returns 0 (success).
# stub_called_times "uname" 3 # Returns 1 (error).
# #
# Echoes number of times stub has been called if $2 is not given, otherwise # Echoes number of times stub has been called if $2 is not given, otherwise
# echoes nothing. # echoes nothing.
@@ -230,8 +224,8 @@ stub_called_at_most_times() {
# #
# Arguments: # Arguments:
# - $1: Name of stubbed command. # - $1: Name of stubbed command.
# - $@: All additional arguments are used to specify what stub was called # - $@: Any/all additional arguments are used to specify what stub was
# with. # called with.
# #
# Echoes number of times stub has been called with given arguments. # Echoes number of times stub has been called with given arguments.
# Return 0 (success). # Return 0 (success).
@@ -261,8 +255,8 @@ stub_called_with_times() {
# Arguments: # Arguments:
# - $1: Name of stubbed command. # - $1: Name of stubbed command.
# - $2: Exact number of times stub has been called. # - $2: Exact number of times stub has been called.
# - $@: All additional arguments are used to specify what stub was called # - $@: Any/all additional arguments are used to specify what stub was
# with. # called with.
# #
# Echoes nothing. # Echoes nothing.
# Returns 0 (success) if stub has been called at least the given number of # Returns 0 (success) if stub has been called at least the given number of
@@ -284,8 +278,8 @@ stub_called_with_exactly_times() {
# Arguments: # Arguments:
# - $1: Name of stubbed command. # - $1: Name of stubbed command.
# - $2: Minimum required number of times stub has been called. # - $2: Minimum required number of times stub has been called.
# - $@: All additional arguments are used to specify what stub was called # - $@: Any/all additional arguments are used to specify what stub was
# with. # called with.
# #
# Echoes nothing. # Echoes nothing.
# Returns 0 (success) if stub has been called at least the given number of # Returns 0 (success) if stub has been called at least the given number of
@@ -307,8 +301,8 @@ stub_called_with_at_least_times() {
# Arguments: # Arguments:
# - $1: Name of stubbed command. # - $1: Name of stubbed command.
# - $2: Maximum allowed number of times stub has been called. # - $2: Maximum allowed number of times stub has been called.
# - $@: All additional arguments are used to specify what stub was called # - $@: Any/all additional arguments are used to specify what stub was
# with. # called with.
# #
# Echoes nothing. # Echoes nothing.
# Returns 0 (success) if stub has been called no more than the given number of # Returns 0 (success) if stub has been called no more than the given number of
@@ -422,5 +416,4 @@ __stub_clean() {
eval "unset STUB_${index}_CALLS" eval "unset STUB_${index}_CALLS"
STUB_INDEX=(${STUB_INDEX[@]/${cmd}=*/}) STUB_INDEX=(${STUB_INDEX[@]/${cmd}=*/})
fi fi
} }

34
test.sh
View File

@@ -1,34 +0,0 @@
#! /usr/bin/env bash
resolve_link() {
$(type -p greadlink readlink | head -1) $1
}
abs_dirname() {
local cwd="$(pwd)"
local path="$1"
while [ -n "$path" ]; do
cd "${path%/*}"
local name="${path##*/}"
path="$(resolve_link "$name" || true)"
done
pwd
cd "$cwd"
}
testdir="$(abs_dirname "$0")/test"
testfiles="$(find "$testdir" -name "*-test.sh")"
RET=0
for testfile in $testfiles; do
echo ""
echo "running: ${testfile/#$(dirname "$testdir")\//}"
cd "$(dirname "$testfile")"
"$testfile"
if [ "$?" != "0" ]; then RET=1; fi
done
echo ""
exit $RET