mirror of
https://github.com/zsh-users/zsh-autosuggestions.git
synced 2024-09-12 05:31:17 +02:00
[Test] Add stub.sh from ericfreese/stub.sh for stubbing/mocking.
This commit is contained in:
Eric Freese
parent
abe577d519
commit
74197498fc
1 changed files with 419 additions and 0 deletions
419
test/stub-1.0.2.sh
Normal file
419
test/stub-1.0.2.sh
Normal file
|
|
@ -0,0 +1,419 @@
|
|||
# !/usr/bin/env bash
|
||||
#
|
||||
# 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
|
||||
# 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.
|
||||
#
|
||||
|
||||
|
||||
# Public: Stub given command.
|
||||
#
|
||||
# Arguments:
|
||||
# - $1: Name of command to stub.
|
||||
# - $2: (optional) When set to "STDOUT", echo a default message to STDOUT.
|
||||
# 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" = "stderr" ] || [ "$2" = "STDERR" ]; then redirect="stderr"; fi
|
||||
|
||||
stub_and_echo "$1" "$1 stub: \$@" "$redirect"
|
||||
}
|
||||
|
||||
|
||||
# Public: Stub given command, and echo given string.
|
||||
#
|
||||
# Arguments:
|
||||
# - $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.
|
||||
# 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" = "null" ]; then redirect=" &>/dev/null"; fi
|
||||
|
||||
stub_and_eval "$1" "echo \"$2\"$redirect"
|
||||
}
|
||||
|
||||
|
||||
# Public: Stub given command, and execute given string with eval.
|
||||
#
|
||||
# Arguments:
|
||||
# - $1: Name of command to stub.
|
||||
# - $2: String to eval when stub is called.
|
||||
#
|
||||
# Echoes nothing.
|
||||
# Returns nothing.
|
||||
stub_and_eval() {
|
||||
local cmd="$1"
|
||||
|
||||
# Setup empty list of active stubs.
|
||||
if [ -z "$STUB_ACTIVE_STUBS" ]; then STUB_ACTIVE_STUBS=(); fi
|
||||
|
||||
# If stubbing a function, store non-stubbed copy of it required for restore.
|
||||
if [ -n "$(command -v "$cmd")" ]; then
|
||||
if [ -z "$(command -v "non_stubbed_${cmd}")" ]; then
|
||||
if [[ "$(type "$cmd" | head -1)" == *"is a function" ]]; then
|
||||
local source="$(type "$cmd" | tail -n +2)"
|
||||
source="${source/$cmd/non_stubbed_${cmd}}"
|
||||
eval "$source"
|
||||
fi
|
||||
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[@]} " != *" $cmd "* ]]; then
|
||||
STUB_ACTIVE_STUBS+=("$cmd")
|
||||
fi
|
||||
|
||||
# Create the stub.
|
||||
eval "$( printf "%s" "${cmd}() { __stub_call \"${cmd}\" \$@; $2;}")"
|
||||
}
|
||||
|
||||
|
||||
# Public: Find out if stub has been called. Returns 0 if yes, 1 if no.
|
||||
#
|
||||
# Arguments:
|
||||
# - $1: Name of stubbed command.
|
||||
#
|
||||
# Echoes nothing.
|
||||
# Returns 0 (success) is stub has been called, 1 (error) otherwise.
|
||||
stub_called() {
|
||||
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
|
||||
}
|
||||
|
||||
|
||||
# Public: Find out how many times a stub has been called.
|
||||
#
|
||||
# Arguments:
|
||||
# - $1: Name of stubbed command.
|
||||
#
|
||||
# Echoes number of times stub has been called if $2 is not given, otherwise
|
||||
# echoes nothing.
|
||||
# Returns 0 (success) if $2 is not given, or if it is given and it matches the
|
||||
# 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
|
||||
|
||||
if [ -n "$index" ]; then
|
||||
eval "count=\"\${#STUB_${index}_CALLS[@]}\""
|
||||
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.
|
||||
#
|
||||
# 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 if stub has been called at least the given number of times.
|
||||
#
|
||||
# Arguments:
|
||||
# - $1: Name of stubbed command.
|
||||
# - $2: Minimum required number of times stub has been called.
|
||||
#
|
||||
# Echoes nothing.
|
||||
# Returns 0 (success) if stub has been called at least the given number of
|
||||
# times, otherwise 1 (error) is returned.
|
||||
stub_called_at_least_times() {
|
||||
if [ "$(stub_called_times "$1")" -lt "$2" ]; 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.
|
||||
#
|
||||
# Echoes nothing.
|
||||
# Returns 0 (success) if stub has been called no more than the given number of
|
||||
# times, otherwise 1 (error) is returned.
|
||||
stub_called_at_most_times() {
|
||||
if [ "$(stub_called_times "$1")" -gt "$2" ]; then
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
# 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:
|
||||
# - $1: Name of command to restore.
|
||||
#
|
||||
# Echoes nothing.
|
||||
# Returns nothing.
|
||||
restore() {
|
||||
local cmd="$1"
|
||||
|
||||
# Don't do anything if the command isn't currently stubbed.
|
||||
if [[ " ${STUB_ACTIVE_STUBS[@]} " != *" $1 "* ]]; then
|
||||
return 0
|
||||
fi
|
||||
|
||||
# Remove stub functions.
|
||||
unset -f "$cmd"
|
||||
|
||||
# Remove stub from list of active stubs.
|
||||
STUB_ACTIVE_STUBS=(${STUB_ACTIVE_STUBS[@]/$cmd/})
|
||||
|
||||
# If stub was for a function, restore the original function.
|
||||
if type "non_stubbed_${cmd}" &>/dev/null; then
|
||||
local original_type="$(type "non_stubbed_${cmd}" | head -1)"
|
||||
if [[ "$original_type" == *"is a function" ]]; then
|
||||
local source="$(type "non_stubbed_$cmd" | tail -n +2)"
|
||||
source="${source/non_stubbed_${cmd}/$cmd}"
|
||||
eval "$source"
|
||||
unset -f "non_stubbed_${cmd}"
|
||||
fi
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
#
|
||||
# Internal functions
|
||||
#
|
||||
|
||||
# Private: Used to keep track of which stubs have been called and how many
|
||||
# times.
|
||||
__stub_call() {
|
||||
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
|
||||
}
|
||||
Loading…
Reference in a new issue