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 with specific arguments.

Particularly useful when used in combination with the simple and elegant 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

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 is a lightweight package manager for bash.

stub.sh is available as bpkg package:

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

Put stub.sh in your project, and source it into your tests. For detailed examples, why not have a look at the tests for stub.sh itself?

Examples

Stubbing binaries:

source "stub.sh"
uname             #=> Darwin
stub uname        # silent stub
uname             #=>
stub uname STDOUT # stub prints to STDOUT
uname             #=> uname stub:
uname -r          #=> uname stub: -r
restore uname     # remove stub
uname             #=> Darwin

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         # 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      # remove stub
my-name-is Edward Elric #=> My name is Edward Elric.

Asserting stub has been called:

source "stub.sh"
my-uname() { uname; }
stub_and_echo uname "FooBar"
stub_called uname # returns 1 (error)
my-uname          #=> FooBar
stub_called uname # returns 0 (success)
restore uname

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_exactly_times uname 2 # returns 1 (error)
my-uname                          #=> FooBar
stub_called_times uname           #=> 1
stub_called_exactly_times uname 2 # returns 1 (error)
my-uname                          #=> FooBar
stub_called_times uname           #=> 2
stub_called_exactly_times uname 2 # returns 0 (success)
restore uname

Asserting stub has been called with specific arguments:

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:

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

Stubbing and Restoring

• stub: Basic stubbing command.
  • $1: Name of command to stub
  • $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.
  • $1: Name of command to stub.
  • $2: String to echo when stub is called.
  • $3: (optional) When set to "STDERR", echo to STDERR instead of STDOUT.
• stub_and_eval: Stub given command and execute custom commands via 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.
  • $1: Name of command to restore.

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.
  • $1: Name of stub to check.
• stub_called_exactly_times: Validate that stub has been called exactly given 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 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

• Better ReadMe/Documentation.

License

(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 rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.