bash-spec-2

KO | EN

gitlite — search

#javascript #hacktoberfest #react #typescript #llm #go #android #rust #linux #cli #awesome-list #vue #mcp #ios

(★ 24)

REAs updates to bash-spec

bash-spec-2 Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://raw.githubusercontent.com/holmesjr/bash-spec-2/master/LICENSE.md)
[![Build Status](https://img.shields.io/github/actions/workflow/status/holmesjr/bash-spec-2/tests.yml?branch=master)
[![GitHub issues](https://img.shields.io/github/issues/holmesjr/bash-spec-2.svg)](https://github.com/holmesjr/bash-spec-2/issues)
[![Latest Version](https://img.shields.io/github/release/holmesjr/bash-spec-2.svg)](https://github.com/holmesjr/bash-spec-2/releases)

New for 2.1
===========
#### Supporting other coding styles/formats
```
old format: describe "title" "$( ... )"
alt format: describe "title" && { ...  } (most readable but variables are not locally scoped)
alt format2: describe "title" && ( ... ) (compromise?)
```
#### Assertions on expressions
```
[[ some_expression ]]
should_succeed
[[ some_expression ]]
should_fail
```
#### Cleaner support for arrays and vars - pass by reference

```
expect_var varname to_be 5
expect_array arrayname to_contain 5
```

#### Unofficial bash strict mode

http://redsymbol.net/articles/unofficial-bash-strict-mode/

#### Travis-CI

bash-spec
=========

This is a modified version of bash-spec from https://github.com/neopragma/bash-spec. The most important changes are:

- The "describe" and "context" syntaxes are available
- The "it" syntax has changed
- All the above syntaxes are nestable and work via command substitution (i.e. `"$( commands here )"` )
- A few bugs around failure messages have been fixed (with their own tests, of course)

# Usage

## Installation

Just put the bash-spec.sh file in your project in a folder of your choice.

## Writing tests

Your test file (a bash script you'll write) needs to source bash-spec.sh:

. ./path-to-files/bash-spec.sh

Then you can describe a thing and how you expect it to behave:

```
describe "The word Penguin" "$(

word="Penguin"

it "Is seven letters long" "$(
    expect "${#word}" to_be "7"
  )"

it "Begins with the capital letter P" "$(
    expect "${word:0:1}" to_be "P"
  )"

context "When converted to lowercase" "$(

word=$( echo $word | tr '[:upper:]' '[:lower:]' )

it "Begins with the lower case letter p" "$(
      expect "${word:0:1}" to_be "p"
    )"

)"
```

OK, so we're mixing tests with code under test a bit here, but it's a standalone example of the syntax, so deal.

Running the test script (don't forget to make it executable) will give you the following:

```
The word Penguin
  Is seven letters long
         PASS
  Begins with the capital letter P
         PASS
When converted to lowercase
  Begins with the lower case letter p
         PASS
```

### Matchers

Most of the matchers from the original bash-spec survived. The to_be_installed matcher went away, 
because it didn't work and wasn't super useful. It can be resurrected if someone cares enough.

The available matchers are:

- `to_be` (equality)
- `to_match` (regex matching)
- `to_contain` (array element equality)
- `to_exist` (file existence)
- `to_have_mode` (file permissions matching)
- `to_be_true` (exit mode matcher)

Each matcher has a negated mode (`not to_be`, `not to_match` etc)

### Blocks and the notably absent "before" syntax

You'll have noticed that the command substitution syntax is used. 
This provides something similar to independent blocks, since each "$( )" spawns a subshell that doesn't 
affect other subshells or the parent shell. Each subshell also gets a copy of the environment in the parent shell, 
making a "before" syntax unnecessary.

The [bash-spec test suite](https://github.com/realestate-com-au/bash-spec-2/blob/master/test_bash-spec.sh) has some good examples of this.

### Mocks

bash-spec-2 works hand in hand with [stub.sh](https://github.com/jimeh/stub.sh) to allow for mocking. You can do things like calling AWS via chains of your own functions to build up the command line and test it with a stubbed "aws." See the stub.sh docs for details or see examples in [the wiki](https://github.com/realestate-com-au/bash-spec-2/wiki).

# TODO list

- An equivalent for let blocks (memoized, lazy evaluated) might be useful
- Proper nesting of the output would be cool

# New Features

- expect "${arr[@]}" to_contain 3 occurring 2 times
- expect "$output" to_be "line1" "line2" "line3"

bash-spec-2

bash-spec-2 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bash-spec-2

bash-spec-2 Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README