Merge pull request #6 from TsutomuNakamura/change_increment_in_stub_register

Changed increment in __stub_register() not to return non 0

.gitignore

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

.travis.yml

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

Makefile

@@ -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.1/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:
-.PHONY: test prepare
+.PHONY: test bootstrap clean update \
+	remove_test-runner.sh update_test-runner.sh \
+	remove_assert.sh update_assert.sh

README.md

@@ -1,11 +1,40 @@
-# stub.sh [![Build Status](https://travis-ci.org/jimeh/stub.sh.png)](https://travis-ci.org/jimeh/stub.sh)
+# stub.sh [![Build Status](https://api.travis-ci.org/jimeh/stub.sh.svg)](https://travis-ci.org/jimeh/stub.sh)
 
-A set of stubbing helpers for use in bash script tests. Supports stubbing and
+Helpers for bash script testing to stub/fake binaries and functions. Includes
-restoring both binaries and bash functions.
+support for validating number of stub calls, and/or if stub has been called
+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
 
@@ -20,12 +49,14 @@ Stubbing binaries:
 
 ```bash
 source "stub.sh"
-uname #=> Darwin
+uname             #=> Darwin
-stub uname
+stub uname        # silent stub
-uname #=> uname stub:
+uname             #=>
-uname -r #=> uname stub: -r
+stub uname STDOUT # stub prints to STDOUT
-restore uname
+uname             #=> uname stub:
-uname #=> Darwin
+uname -r          #=> uname stub: -r
+restore uname     # remove stub
+uname             #=> Darwin
 ```
 
 Stubbing bash functions:
@@ -34,9 +65,11 @@ Stubbing bash functions:
 source "stub.sh"
 my-name-is() { echo "My name is $@."; }
 my-name-is Edward Elric #=> My name is Edward Elric.
-stub my-name-is
+stub my-name-is         # silent stub
+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
+restore my-name-is      # remove stub
 my-name-is Edward Elric #=> My name is Edward Elric.
 ```
 
@@ -46,9 +79,9 @@ Asserting stub has been called:
 source "stub.sh"
 my-uname() { uname; }
 stub_and_echo uname "FooBar"
-stub_called uname # return value of 1 (error)
+stub_called uname # returns 1 (error)
-my-uname            #=> FooBar
+my-uname          #=> FooBar
-stub_called uname # return value of 0 (success)
+stub_called uname # returns 0 (success)
 restore uname
 ```
 
@@ -58,59 +91,128 @@ Asserting stub has been called X times:
 source "stub.sh"
 my-uname() { uname; }
 stub_and_echo uname "FooBar"
-stub_called_times uname   #=> 0
+stub_called_times uname           #=> 0
-stub_called_times uname 2 # return value of 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 # return value of 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 # return value of 0 (success)
+stub_called_exactly_times uname 2 # returns 0 (success)
+restore uname
+```
+
+Asserting stub has been called with specific arguments:
+
+```bash
+source "stub.sh"
+my-uname() { uname $@; }
+stub_and_echo uname "FooBar"
+stub_called_with uname -r -a # 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
+stub_called_with uname -r -a # returns 0 (success)
+stub_called_with uname -r    # returns 0 (success)
+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
 
-- `stub`: Basic stubbing command. Will echo a default message to STDOUT.
+### Stubbing and Restoring
-  Arguments:
+
+- **`stub`**: Basic stubbing command.
     - `$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
-- `stub_and_echo`: Stub given command and echo a custom string to STDOUT.
+      message to specified output. If no output is specified, nothing is
-  Arguments:
+      echoed.
+- **`stub_and_echo`**: Stub given command and echo a custom string to STDOUT.
     - `$1`: Name of command to stub.
     - `$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.
     - `$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.
-- `stub_called`: Check if given stub has been called. Gives a `0` return value
+
-  when true, and `1` when false.
+### Stub Called Validation
+
+- **`stub_called`**: Check if given stub has been called. Gives a `0` return
+  value when true, and `1` when false.
     - `$1`: Name of stub to check.
-- `stub_called_times`: Find out how many times a stub has been called, or
+- **`stub_called_times`**: Find out how many times a stub has been called.
-  given a second argument it validates if stub was called exactly X times.
     - `$1`: Name of stub to check.
-    - `$2`: Exact number of times stub should have been called (optional).
+- **`stub_called_exactly_times`**: Validate that stub has been called exactly
-- `stub_called_at_least_times`: Validate that stub has been called at least X
+  given number of times.
-  number of times.
+    - `$1`: Name of stub to check.
+    - `$2`: Exact number of times stub should have been called.
+- **`stub_called_at_least_times`**: Validate that stub has been called at
+  least X number of times.
     - `$1`: Name of stub to check.
     - `$2`: Minimum number of times stub should have been called.
-- `stub_called_at_most_times`: Validate that stub has been called no more than
+- **`stub_called_at_most_times`**: Validate that stub has been called no more
-  X number of times.
+  than X number of times.
     - `$1`: Name of stub to check.
     - `$2`: Maximum number of times stub should have been called.
 
+### Stub Called With Validation
+
+- **`stub_called_with`**: Check if given stub has been called with specified
+  arguments.
+    - `$1`: Name of stub to check.
+    - `$@`: 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
+  called with specified arguments.
+    - `$1`: Name of stub to check.
+    - `$@`: Any/all additional arguments are used to specify what stub was
+      called with.
+- **`stub_called_with_exactly_times`**: Validate that stub has been called
+  with specified arguments exactly given number of times.
+    - `$1`: Name of stub to check.
+    - `$2`: Exact number of times stub should have been called.
+    - `$@`: 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
+  with specified arguments at least X number of times.
+    - `$1`: Name of stub to check.
+    - `$2`: Minimum number of times stub should have been called.
+    - `$@`: 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
+  with specified arguments no more than X number of times.
+    - `$1`: Name of stub to check.
+    - `$2`: Maximum number of times stub should have been called.
+    - `$@`: Any/all additional arguments are used to specify what stub was
+      called with.
+
 
 ## Todo
 
-- Add a `stub_called_with` function that validates the stub has been called
+- Better ReadMe/Documentation.
-  with specific arguments.
-- Add a `stub_called_with_times` function that validates the stub has been
-  called with specific arguments a specific number of times.
 
 
 ## License

package.json

@@ -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"]
+}

stub.sh

@@ -1,9 +1,12 @@
 # !/usr/bin/env bash
-# stub.sh 0.3.0 - stubbing helpers for simplifying bash script tests.
-# Copyright (c) 2014 Jim Myhrberg.
 #
+# stub.sh 1.0.2 - stubbing helpers for simplifying bash script tests.
 # https://github.com/jimeh/stub.sh
 #
+# (The MIT License)
+#
+# Copyright (c) 2014 Jim Myhrberg.
+#
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to
 # deal in the Software without restriction, including without limitation the
@@ -24,19 +27,19 @@
 #
 
 
-# Public: Stub given command, echoing a default stub message.
+# Public: Stub given command.
 #
 # Arguments:
 #   - $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.
 # Returns nothing.
 stub() {
   local redirect="null"
-  if [ "$2" == "stdout" ] || [ "$2" == "STDOUT" ]; then redirect=""; fi
+  if [ "$2" = "stdout" ] || [ "$2" = "STDOUT" ]; then redirect=""; fi
-  if [ "$2" == "stderr" ] || [ "$2" == "STDERR" ]; then redirect="stderr"; fi
+  if [ "$2" = "stderr" ] || [ "$2" = "STDERR" ]; then redirect="stderr"; fi
 
   stub_and_echo "$1" "$1 stub: \$@" "$redirect"
 }
@@ -47,15 +50,15 @@ stub() {
 # Arguments:
 #   - $1: Name of command to stub.
 #   - $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.
 #
 # Echoes nothing.
 # Returns nothing.
 stub_and_echo() {
   local redirect=""
-  if [ "$3" == "stderr" ] || [ "$3" == "STDERR" ]; then redirect=" 1>&2"; fi
+  if [ "$3" = "stderr" ] || [ "$3" = "STDERR" ]; then redirect=" 1>&2"; fi
-  if [ "$3" == "null" ]; then redirect=" &>/dev/null"; fi
+  if [ "$3" = "null" ]; then redirect=" &>/dev/null"; fi
 
   stub_and_eval "$1" "echo \"$2\"$redirect"
 }
@@ -72,9 +75,6 @@ stub_and_echo() {
 stub_and_eval() {
   local cmd="$1"
 
-  # Setup empty list of called stubs.
-  if [ -z "$STUB_CALLED_STUBS" ]; then STUB_CALLED_STUBS=(); fi
-
   # Setup empty list of active stubs.
   if [ -z "$STUB_ACTIVE_STUBS" ]; then STUB_ACTIVE_STUBS=(); fi
 
@@ -89,18 +89,17 @@ stub_and_eval() {
     fi
   fi
 
+  # Prepare stub index and call list for this stub.
+  __stub_register "$cmd"
+
   # Keep track of what is currently stubbed to ensure restore only acts on
   # actual stubs.
-  if [[ " ${STUB_ACTIVE_STUBS[@]} " != *" $1 "* ]]; then
+  if [[ " ${STUB_ACTIVE_STUBS[@]} " != *" $cmd "* ]]; then
     STUB_ACTIVE_STUBS+=("$cmd")
   fi
 
-  # Remove stub from list of called stubs, as we are now creating a new stub
-  # which hasn't been called yet.
-  STUB_CALLED_STUBS=(${STUB_CALLED_STUBS[@]/$cmd/})
-
   # Create the stub.
-  eval "$(echo -e "${cmd}() {\n  __stub_call \"${cmd}\"\n  $2\n}")"
+  eval "$( printf "%s" "${cmd}() {  __stub_call \"${cmd}\" \$@;  $2;}")"
 }
 
 
@@ -112,7 +111,35 @@ stub_and_eval() {
 # Echoes nothing.
 # Returns 0 (success) is stub has been called, 1 (error) otherwise.
 stub_called() {
-  if [[ " ${STUB_CALLED_STUBS[@]} " != *" $1 "* ]]; then
+  if [ "$(stub_called_times "$1")" -lt 1 ]; then
+    return 1
+  fi
+}
+
+
+# Public: Find out if stub has been called with specific arguments.
+#
+# Arguments:
+#   - $1: Name of stubbed command.
+#   - $@: Any/all additional arguments are used to specify what stub was
+#         called with.
+#
+# Examples:
+#   stub uname
+#   uname
+#   uname -r -a
+#   stub_called_with uname       # Returns 0 (success).
+#   stub_called_with uname -r    # Returns 1 (error).
+#   stub_called_with uname -r -a # Returns 0 (success).
+#
+# Echoes nothing.
+# Returns 0 (success) if specified stub has been called with given arguments,
+# otherwise returns 1 (error).
+stub_called_with() {
+  local cmd="$1"
+  shift 1
+
+  if [ "$(stub_called_with_times "$cmd" $@)" -lt 1 ]; then
     return 1
   fi
 }
@@ -122,13 +149,6 @@ stub_called() {
 #
 # Arguments:
 #   - $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 value of 0 (success).
-#   stub_called_times "uname" 3 # Returns value of 1 (error).
 #
 # Echoes number of times stub has been called if $2 is not given, otherwise
 # echoes nothing.
@@ -136,25 +156,37 @@ stub_called() {
 # number of times the stub has been called. Otherwise 1 (error) is returned if
 # it doesn't match..
 stub_called_times() {
+  local cmd="$1"
+
+  local index="$(__stub_index "$1")"
   local count=0
 
-  for called in ${STUB_CALLED_STUBS[@]}; do
+  if [ -n "$index" ]; then
-    if [ "$called" == "$1" ]; then
+    eval "count=\"\${#STUB_${index}_CALLS[@]}\""
-      ((count++))
+  fi
-    fi
-  done
 
-  if [ -n "$2" ]; then
+  echo $count
-    if [ "$2" != "$count" ]; then
+}
-      return 1
+
-    fi
+
-  else
+# Public: Find out if stub has been called exactly the given number of times
-    echo $count
+# with specified arguments.
+#
+# Arguments:
+#   - $1: Name of stubbed command.
+#   - $2: Exact number of times stub has been called.
+#
+# Echoes nothing.
+# Returns 0 (success) if stub has been called at least the given number of
+# times with specified arguments, otherwise 1 (error) is returned.
+stub_called_exactly_times() {
+  if [ "$(stub_called_times "$1")" != "$2" ]; then
+    return 1
   fi
 }
 
 
-# Public: Find out of stub has been called at least the given number of times.
+# Public: Find out if stub has been called at least the given number of times.
 #
 # Arguments:
 #   - $1: Name of stubbed command.
@@ -170,12 +202,12 @@ stub_called_at_least_times() {
 }
 
 
-# Public: Find out of stub has been called no more than the given number of
+# Public: Find out if stub has been called no more than the given number of
 # times.
 #
 # Arguments:
 #   - $1: Name of stubbed command.
-#   - $2: Minimum required number of times stub has been called.
+#   - $2: Maximum allowed number of times stub has been called.
 #
 # Echoes nothing.
 # Returns 0 (success) if stub has been called no more than the given number of
@@ -187,6 +219,105 @@ stub_called_at_most_times() {
 }
 
 
+# Public: Find out how many times a stub has been called with specific
+# arguments.
+#
+# Arguments:
+#   - $1: Name of stubbed command.
+#   - $@: Any/all additional arguments are used to specify what stub was
+#         called with.
+#
+# Echoes number of times stub has been called with given arguments.
+# Return 0 (success).
+stub_called_with_times() {
+  local cmd="$1"
+
+  shift 1
+  local args="$@"
+  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
+    done
+  fi
+
+  echo $count
+}
+
+
+# Public: Find out if stub has been called exactly the given number of times
+# with specified arguments.
+#
+# Arguments:
+#   - $1: Name of stubbed command.
+#   - $2: Exact number of times stub has been called.
+#   - $@: Any/all additional arguments are used to specify what stub was
+#         called with.
+#
+# Echoes nothing.
+# Returns 0 (success) if stub has been called at least the given number of
+# times with specified arguments, otherwise 1 (error) is returned.
+stub_called_with_exactly_times() {
+  local cmd="$1"
+  local count="$2"
+  shift 2
+
+  if [ "$(stub_called_with_times "$cmd" $@)" != "$count" ]; then
+    return 1
+  fi
+}
+
+
+# Public: Find out if stub has been called at least the given number of times
+# with specified arguments.
+#
+# Arguments:
+#   - $1: Name of stubbed command.
+#   - $2: Minimum required number of times stub has been called.
+#   - $@: Any/all additional arguments are used to specify what stub was
+#         called with.
+#
+# Echoes nothing.
+# Returns 0 (success) if stub has been called at least the given number of
+# times with specified arguments, otherwise 1 (error) is returned.
+stub_called_with_at_least_times() {
+  local cmd="$1"
+  local count="$2"
+  shift 2
+
+  if [ "$(stub_called_with_times "$cmd" $@)" -lt "$count" ]; then
+    return 1
+  fi
+}
+
+
+# Public: Find out if stub has been called no more than the given number of
+# times.
+#
+# Arguments:
+#   - $1: Name of stubbed command.
+#   - $2: Maximum allowed number of times stub has been called.
+#   - $@: Any/all additional arguments are used to specify what stub was
+#         called with.
+#
+# Echoes nothing.
+# Returns 0 (success) if stub has been called no more than the given number of
+# times with specified arguments, otherwise 1 (error) is returned.
+stub_called_with_at_most_times() {
+  local cmd="$1"
+  local count="$2"
+  shift 2
+
+  if [ "$(stub_called_with_times "$cmd" $@)" -gt "$count" ]; then
+    return 1
+  fi
+}
+
+
 # Public: Restore the original command/function that was stubbed.
 #
 # Arguments:
@@ -228,5 +359,61 @@ restore() {
 # Private: Used to keep track of which stubs have been called and how many
 # times.
 __stub_call() {
-  STUB_CALLED_STUBS+=("$1")
+  local cmd="$1"
+  shift 1
+  local args="$@"
+  if [ "$args" = "" ]; then args="<none>"; fi
+
+  local index="$(__stub_index "$cmd")"
+  if [ -n "$index" ]; then
+    eval "STUB_${index}_CALLS+=(\"\$args\")"
+  fi
+}
+
+
+# Private: Get index value of stub. Required to access list of stub calls.
+__stub_index() {
+  local cmd="$1"
+
+  for item in ${STUB_INDEX[@]}; do
+    if [[ "$item" = "${cmd}="* ]]; then
+      local index="$item"
+      index="${index/${cmd}=/}"
+      echo "$index"
+    fi
+  done
+}
+
+
+# Private: Prepare for the creation of a new stub. Adds stub to index and
+# sets up an empty call list.
+__stub_register() {
+  local cmd="$1"
+
+  if [ -z "$STUB_NEXT_INDEX" ]; then STUB_NEXT_INDEX=0; fi
+  if [ -z "$STUB_INDEX" ]; then STUB_INDEX=(); fi
+
+  # Clean up after any previous stub for the same command.
+  __stub_clean "$cmd"
+
+  # Add stub to index.
+  STUB_INDEX+=("${cmd}=${STUB_NEXT_INDEX}")
+  eval "STUB_${STUB_NEXT_INDEX}_CALLS=()"
+
+  # Increment stub count.
+  ((++STUB_NEXT_INDEX))
+}
+
+# Private: Cleans out and removes a stub's call list, and removes stub from
+# index.
+__stub_clean() {
+  local cmd="$1"
+  local index="$(__stub_index "$cmd")"
+
+  # Remove all relevant details from any previously existing stub for the same
+  # command.
+  if [ -n "$index" ]; then
+    eval "unset STUB_${index}_CALLS"
+    STUB_INDEX=(${STUB_INDEX[@]/${cmd}=*/})
+  fi
 }

test.sh

@@ -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

test/__stub_call.test.sh

@@ -0,0 +1,21 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# __stub_call() tests.
+#
+
+# Adds call to stub call list.
+STUB_INDEX=("uname=0")
+STUB_0_CALLS=()
+__stub_call "uname"
+__stub_call "uname" -r
+__stub_call "uname" -r -a
+assert 'echo ${STUB_0_CALLS[@]}' "<none> -r -r -a"
+assert 'echo ${STUB_0_CALLS[0]}' "<none>"
+assert 'echo ${STUB_0_CALLS[1]}' "-r"
+assert 'echo ${STUB_0_CALLS[2]}' "-r -a"
+
+
+# End of tests.
+assert_end "__stub_call()"

test/__stub_clean.test.sh

@@ -0,0 +1,19 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# __stub_clean() tests.
+#
+
+# Removes unsets stub call list, removes stub from index
+STUB_INDEX=("uname=0" "top=1")
+STUB_0_CALLS=("<none>" "-r" "-r -a")
+STUB_1_CALLS=("-h")
+__stub_clean "uname"
+assert 'echo ${STUB_INDEX[@]}' "top=1"
+assert 'echo ${STUB_INDEX[0]}' "top=1"
+assert 'echo ${STUB_0_CALLS[@]}' ""
+
+
+# End of tests.
+assert_end "__stub_clean()"

test/__stub_index.test.sh

@@ -0,0 +1,21 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# __stub_index() tests.
+#
+
+# Echoes index of given stub.
+STUB_INDEX=("uname=1" "top=3")
+assert '__stub_index "uname"' "1"
+assert '__stub_index "top"' "3"
+unset STUB_INDEX
+
+# Echoes nothing if stub is not in the index.
+STUB_INDEX=("uname=1")
+assert '__stub_index "top"' ""
+unset STUB_INDEX
+
+
+# End of tests.
+assert_end "__stub_index()"

test/__stub_register.test.sh

@@ -0,0 +1,22 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# __stub_register() tests.
+#
+
+# Sets up stub index, stub call list, and adds stub to index.
+__stub_register "uname" || assert_raises "false"
+__stub_register "top"
+assert 'echo ${STUB_INDEX[@]}' 'uname=0 top=1'
+assert 'echo ${STUB_INDEX[0]}' 'uname=0'
+assert 'echo ${STUB_INDEX[1]}' 'top=1'
+assert 'echo $STUB_NEXT_INDEX' "2"
+
+# Note: There seems to be no possible way to validate if a empty array
+# variable has been set, as it appears to be empty/null/undefined whatever I
+# try.
+
+
+# End of tests.
+assert_end "__stub_register()"

test/stub_called_at_least_times.test.sh

@@ -5,7 +5,7 @@ source "test-helper.sh"
 # stub_called_at_least_times() tests.
 #
 
-# Setup
+# Setup.
 stub "uname"
 uname
 uname
@@ -24,7 +24,7 @@ assert_raises 'stub_called_at_least_times "uname" 5' 1
 assert_raises 'stub_called_at_least_times "top" 0' 0
 assert_raises 'stub_called_at_least_times "top" 1' 1
 
-# Teardown
+# Teardown.
 restore "uname"
 
 

test/stub_called_exactly_times.test.sh

@@ -0,0 +1,32 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# stub_called_exactly_times() tests.
+#
+
+# Setup.
+stub "uname"
+uname
+uname -r
+
+
+# Returns 0 when stub called exactly given number of times.
+assert_raises 'stub_called_exactly_times "uname" 2' 0
+
+# Returns 1 when stub has not been called the exact given number of times.
+assert_raises 'stub_called_exactly_times "uname" 4' 1
+assert_raises 'stub_called_exactly_times "uname" 3' 1
+assert_raises 'stub_called_exactly_times "uname" 1' 1
+assert_raises 'stub_called_exactly_times "uname" 0' 1
+
+# Behaves as if stub has not been called when the stub doesn't exist.
+assert_raises 'stub_called_exactly_times "top" 0' 0
+assert_raises 'stub_called_exactly_times "top" 1' 1
+
+# Teardown.
+restore "uname"
+
+
+# End of tests.
+assert_end "stub_called_times()"

test/stub_called_times.test.sh

@@ -29,14 +29,6 @@ stub "uname"
 assert 'stub_called_times "uname"' "0"
 restore "uname"
 
-# When given a second argument, asserts stub called X number of times.
-stub "uname"
-uname
-assert_raises 'stub_called_times "uname" 1' 0
-assert 'stub_called_times "uname" 1' ""
-assert_raises 'stub_called_times "uname" 3' 1
-assert 'stub_called_times "uname" 3' ""
-restore "uname"
 
 # End of tests.
 assert_end "stub_called_times()"

test/stub_called_with.test.sh

@@ -0,0 +1,54 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# stub_called_with() tests.
+#
+
+# Returns 1 when stub doesn't exist.
+assert_raises 'stub_called_with "top"' 1
+
+# Returns 0 when stub has been called with given arguments.
+stub "uname"
+uname
+uname -r
+uname -r -a
+assert_raises 'stub_called_with "uname"' 0
+assert_raises 'stub_called_with "uname" -r' 0
+assert_raises 'stub_called_with "uname" -r -a' 0
+restore "uname"
+
+# Returns 1 when stub has not been called with given arguments.
+stub "uname"
+uname -r
+assert_raises 'stub_called_with "uname"' 1
+assert_raises 'stub_called_with "uname" -a' 1
+restore "uname"
+
+# Only matches against exact argument lists.
+stub "uname"
+uname -r -a
+assert_raises 'stub_called_with "uname" -r' 1
+assert_raises 'stub_called_with "uname" -r -a' 0
+restore "uname"
+
+# Call history is only reset when restubbing a command, not when restoring.
+stub "uname"
+uname -r
+assert_raises 'stub_called_with "uname" -r' 0
+restore "uname"
+assert_raises 'stub_called_with "uname" -r' 0
+stub "uname"
+assert_raises 'stub_called_with "uname" -r' 1
+restore "uname"
+
+# Handling of string arguments containing spaces.
+stub "uname"
+uname -r "foo bar"
+assert_raises 'stub_called_with "uname" -r "foo bar"' 0
+assert_raises 'stub_called_with "uname" -r foo bar' 0
+restore "uname"
+
+
+# End of tests.
+assert_end "stub_called_with()"

test/stub_called_with_at_least_times.test.sh

@@ -0,0 +1,34 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# stub_called_with_at_least_times() tests.
+#
+
+# Setup.
+stub "uname"
+uname
+uname -r
+uname -r
+uname -r -a
+
+# Retruns 0 when stub called with at least given number of times.
+assert_raises 'stub_called_with_at_least_times "uname" 0 -r' 0
+assert_raises 'stub_called_with_at_least_times "uname" 1 -r' 0
+assert_raises 'stub_called_with_at_least_times "uname" 2 -r' 0
+
+# Retruns 1 when stub called with less than given number of times.
+assert_raises 'stub_called_with_at_least_times "uname" 3 -r' 1
+assert_raises 'stub_called_with_at_least_times "uname" 4 -r' 1
+assert_raises 'stub_called_with_at_least_times "uname" 5 -r' 1
+
+# Behaves as if stub has not been called when the stub doesn't exist.
+assert_raises 'stub_called_with_at_least_times "top" 0' 0
+assert_raises 'stub_called_with_at_least_times "top" 1' 1
+
+# Teardown.
+restore "uname"
+
+
+# End of tests.
+assert_end "stub_called_with_at_least_times()"

test/stub_called_with_at_most_times.test.sh

@@ -0,0 +1,35 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# stub_called_with_at_most_times() tests.
+#
+
+# Setup.
+stub "uname"
+uname
+uname -r
+uname -r
+uname -r
+uname -r -a
+
+# Returns 0 when stub called no more than given number of times.
+assert_raises 'stub_called_with_at_most_times "uname" 5 -r' 0
+assert_raises 'stub_called_with_at_most_times "uname" 4 -r' 0
+assert_raises 'stub_called_with_at_most_times "uname" 3 -r' 0
+
+# Returns 1 when stub has been called more than given number of times.
+assert_raises 'stub_called_with_at_most_times "uname" 2 -r' 1
+assert_raises 'stub_called_with_at_most_times "uname" 1 -r' 1
+assert_raises 'stub_called_with_at_most_times "uname" 0 -r' 1
+
+# Behaves as if stub has not been called when the stub doesn't exist.
+assert_raises 'stub_called_with_at_most_times "top" 0' 0
+assert_raises 'stub_called_with_at_most_times "top" 1' 0
+
+# Teardown.
+restore "uname"
+
+
+# End of tests.
+assert_end "stub_called_with_at_most_times()"

test/stub_called_with_exactly_times.test.sh

@@ -0,0 +1,33 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# stub_called_with_exactly_times() tests.
+#
+
+# Setup.
+stub "uname"
+uname
+uname -r
+uname -r
+uname -r -a
+
+# Returns 0 when stub called exactly given number of times.
+assert_raises 'stub_called_with_exactly_times "uname" 2 -r' 0
+
+# Returns 1 when stub has not been called the exact given number of times.
+assert_raises 'stub_called_with_exactly_times "uname" 4 -r' 1
+assert_raises 'stub_called_with_exactly_times "uname" 3 -r' 1
+assert_raises 'stub_called_with_exactly_times "uname" 1 -r' 1
+assert_raises 'stub_called_with_exactly_times "uname" 0 -r' 1
+
+# Behaves as if stub has not been called when the stub doesn't exist.
+assert_raises 'stub_called_with_exactly_times "top" 0' 0
+assert_raises 'stub_called_with_exactly_times "top" 1' 1
+
+# Teardown.
+restore "uname"
+
+
+# End of tests.
+assert_end "stub_called_with_exactly_times()"

test/stub_called_with_times.test.sh

@@ -0,0 +1,43 @@
+#! /usr/bin/env bash
+source "test-helper.sh"
+
+#
+# stub_called_with_times() tests.
+#
+
+# Echoes 0 when stub doesn't exist.
+assert 'stub_called_with_times "cowabunga-dude"' "0"
+
+# Echoes how many times a stub has been called with given arguments
+stub "uname"
+uname
+uname -r
+uname -r
+uname -r -a
+uname -r -a
+uname -r -a
+assert 'stub_called_with_times "uname"' "1"
+assert 'stub_called_with_times "uname" -r' "2"
+assert 'stub_called_with_times "uname" -r -a' "3"
+assert 'stub_called_with_times "uname" -a' "0"
+
+# Keeps track of identical argument calls to different stubs.
+stub "top"
+top
+top
+top -r
+top -r
+top -r
+top -r -a
+assert 'stub_called_with_times "top"' "2"
+assert 'stub_called_with_times "top" -r' "3"
+assert 'stub_called_with_times "top" -r -a' "1"
+assert 'stub_called_with_times "top" -a' "0"
+
+# Teardown.
+restore "uname"
+restore "top"
+
+
+# End of tests.
+assert_end "stub_called_with_times()"