Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codehearts/shpy

🕵️‍♀️ POSIX compliant spies and stubs for shell unit testing
https://github.com/codehearts/shpy

hacktoberfest mocks posix shell shunit2 stubs testing

Last synced: 8 days ago
JSON representation

🕵️‍♀️ POSIX compliant spies and stubs for shell unit testing

Host: GitHub
URL: https://github.com/codehearts/shpy
Owner: codehearts
License: mit
Created: 2014-04-02T05:54:48.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-09-07T00:34:14.000Z (2 months ago)
Last Synced: 2024-09-07T03:15:43.644Z (2 months ago)
Topics: hacktoberfest, mocks, posix, shell, shunit2, stubs, testing
Language: Shell
Homepage: https://hub.docker.com/r/shpy/shpy
Size: 156 KB
Stars: 13
Watchers: 4
Forks: 3
Open Issues: 12
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md

Awesome Lists containing this project

README

# shpy

[![Build Status][build-badge]][build-link]
[![Coverage][coverage-badge]][coverage-link]
[![MIT License][license-badge]](https://github.com/codehearts/shpy/blob/master/LICENSE.md)
![Build status for supported shells](http://github-actions.40ants.com/codehearts/shpy/matrix.svg?only=Test.test)

POSIX compliant[^[1]](https://github.com/codehearts/shpy#a-word-on-shell-portability) spies and stubs for shell unit testing

Features at a glance:

- Create spies for any command or function in the shell environment
- Stub the stdout, stderr, and return value of spies
- See the call count and check arguments passed to spies
- [Integrates](#shunit2-integration) with the [shunit2](https://github.com/kward/shunit2) testing framework

## Table of Contents

- [Why Unit Test Shell Scripts?](#why-unit-test-shell-scripts)
- [Docker Image](#docker-image)
- [Usage](#usage)
- [Contributing](#contributing)
- [API Reference](#api-reference)
- [shunit2 Integration](#shunit2-integration)
- [A Word On Shell Portability](#a-word-on-shell-portability)

## Why Unit Test Shell Scripts?

Like other scripting languages, shell scripts can become complex and difficult to maintain over time. Unit tests help to avoid regressions and verify the correctness of functionality, but where do spies come in?

Spies are useful for limiting the dependencies and scope of a test. Code that utilizes system binaries or shell functions can be tested without running the underlying implementations, allowing tests to focus solely on the system under test. To see this in action, see [examples/renamer](https://github.com/codehearts/shpy/blob/master/examples/renamer)

The benefits of spies are even greater when testing code that relies on a network. For an example of using spies to stub `curl` and make unit tests completely offline, see [examples/coverfetch](https://github.com/codehearts/shpy/blob/master/examples/coverfetch)

## Docker Image

Shpy is available as [shpy/shpy](https://hub.docker.com/r/shpy/shpy) on Docker Hub. The latest master node is published as `shpy/shpy:latest`, while tagged releases are available as `shpy/shpy:1.0.0`. To use `kcov`, append `-kcov` to the tag or use the `kcov` tag for the latest master node

To use the shpy image, mount your code into `/app` and specify the command you want to run. When using kcov, you can also mount `/coverage` and output your coverage reports to that directory

```sh
docker --rm -v$PWD:/app:ro shpy/shpy:1.0.0 zsh /app/tests/run_my_tests.sh
# ^-your project ^--------your command---------
```

The following scripts and binaries are provided by this image

## Usage

Let's try out shpy! If you don't want to install shpy locally you can run the official [Docker](https://www.docker.com) image like so:

```sh
docker run -it --rm shpy/shpy:1.0.0
```

To use shpy, the `SHPY_PATH` environment variable must be set as the path to shpy and the shpy script must be sourced. If you're using the Docker image, `SHPY_PATH` is already set and shpy is located at `/shpy/shpy`

```sh
SHPY_PATH=path/to/shpy
. path/to/shpy
```

Let's create a spy for the `touch` command and call it!

```sh
createSpy touch
touch my-new-file
ls my-new-file # No such file or directory, touch wasn't actually called
```

The call to `touch` was _stubbed out_ with a test dummy in place of the actual implementation. Spies record data about the calls made to them, allowing you to check the call count or call args

```sh
getSpyCallCount touch # 1
wasSpyCalledWith touch my-new-file # true
wasSpyCalledWith touch my-old-file # false
getArgsForCall touch 1 # my-new-file
```

Spies can also simulate successful or unsuccessful calls, like so:

```sh
createSpy -o 'call me once, shame on you' -e '' -r 0 \
-e 'call me twice, shame on me' -o '' -r 1 touch
touch my-new-file # outputs "call me once, shame on you" to stdout, returns true
touch my-new-file # outputs "call me twice, shame on me" to stderr, returns false
```

When developing tests for complex functions with long chained calls, source all of them and use spy with -u flag. The flag will unset declared function, so complex functions can be tested with a mix of spies and original functions.

```sh
source my_script.sh # contains complex_function that calls file_check and directory_check

createSpy -o 'spy test' -u file_check
complex_function # complex_function calls file_check, which is mocked to output "spy test"
# Without -u, createSpy would warn that file_check is already declared and wouldn't be mocked
```

When you're done playing with shpy, it's only polite to clean up after yourself

```sh
cleanupSpies
touch my-new-file
ls my-new-file # my-new-file, touch was actually called!
```

Your shell environment is back to normal, and you've got a new tool at your disposal! :mortar_board:

## Contributing

If you'd like to help with shpy's development, or just gain a better understanding of the internals, check out the [contributor guidelines](https://github.com/codehearts/shpy/blob/master/CONTRIBUTING.md)

## API Reference

To use shpy in your tests, set `SHPY_PATH` to the location of `shpy` and source the script:

```
SHPY_PATH=path/to/shpy
export SHPY_PATH

. path/to/shpy
```

When using the Docker image, `SHPY_PATH` is preset as `/shpy/shpy` for convenience

The `SHPY_VERSION` environment variable is provided to get the current shpy version

A summary of functions:

Function | Description
---|---
`createSpy name` | Create a new spy, or reset an existing spy
`createSpy -r status name` | Sets the status code returned when the spy is invoked
Can be passed multiple times to set a return value sequence
Once the sequence finishes, the last value is always returned
`createSpy -o output name` | Sets output sent to stdout when the spy is invoked
Can be passed multiple times to set an output sequence
Once the sequence finishes, the last value is always output
When used with `-e`, standard out is written to first
`createSpy -e output name` | Sets output sent to stderr when the spy is invoked
Can be passed multiple times to set an error output sequence
Once the sequence finishes, the last value is always output
When used with `-o`, standard out is written to first
`createSpy -u name` | A flag to unset declared function, so created spy can run instead otherwise declared function takes precedence
Function is not restored after test runs
`createStub name` | Alias for `createSpy`
`getSpyCallCount name` | Outputs the number of invocations of a spy
`wasSpyCalledWith name [arg ...]` | Returns 0 if the current spy call under examination has the given args
`getArgsForCall name call` | Prints the arguments from a call to a spy (first call is 1)
Single-word arguments are always listed without quotes
Multi-word arguments are always listed with double-quotes
`examineNextSpyCall name` | Examine the next spy invocation when calling `wasSpyCalledWith`
This causes `wasSpyCalledWith` to verify the second invocation, etc
`cleanupSpies` | Clean up any metadata on disk or in the environment for a spy

### shunit2 Integration

To use shpy asserts in your shunit2 tests, you must also source the
`shpy-shunit2` script:

. path/to/shpy
. path/to/shpy-shunit2

A summary of asserts:

Function | Description
------------------------------------------------------|------------------------------------------------------------------
`assertCallCount [message] spy count` | Assert the number of times the spy was invoked
`assertCalledWith spy [arg ...]` | Assert the arguments for the first invocation of the spy
Subsequent calls will assert for the second invocation, etc
`assertCalledWith_ message spy [arg ...]` | Same as `assertCalledWith`, with a specific assertion message
`assertCalledOnceWith spy [arg ...]` | Assert the spy was called once and given the specified arguments
`assertCalledOnceWith_ message spy [arg ...]`| Same as `assertCalledOnceWith`, with a specific assertion message
`assertNeverCalled [message] spy` | Assert the spy was never invoked

Use the `tearDown` hook provided by shunit2 to remove all spies after each test

```sh
tearDown() {
cleanupSpies
}
```

## A Word On Shell Portability

shpy relies on [portable but more modern shell features](http://apenwarr.ca/log/?m=201102#28), such as the `local` keyword. To be clear, shpy does not use any [Bashisms](https://wiki.ubuntu.com/DashAsBinSh)

[coverage-badge]: https://codecov.io/gh/codehearts/shpy/branch/master/graph/badge.svg
[coverage-link]: https://codecov.io/gh/codehearts/shpy
[license-badge]: https://img.shields.io/badge/license-MIT-007EC7.svg
[build-badge]: https://img.shields.io/github/workflow/status/codehearts/shpy/Test/master
[ash-build-badge]: https://travis-matrix-badges.herokuapp.com/repos/codehearts/shpy/branches/master/1
[bash-build-badge]: https://travis-matrix-badges.herokuapp.com/repos/codehearts/shpy/branches/master/2
[dash-build-badge]: https://travis-matrix-badges.herokuapp.com/repos/codehearts/shpy/branches/master/3
[mksh-build-badge]: https://travis-matrix-badges.herokuapp.com/repos/codehearts/shpy/branches/master/4
[zsh-build-badge]: https://travis-matrix-badges.herokuapp.com/repos/codehearts/shpy/branches/master/5
[build-link]: https://github.com/codehearts/shpy/actions?query=workflow%3ATest+branch%3Amaster