1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
# bats-core
`bats-core` is a supporting library providing common functions to test
helper libraries written for [Bats][bats].
Features:
- [output formatting](#output-formatting)
See the [shared documentation][bats-docs] to learn how to install and
load this library.
If you want to use this library in your own helpers or just want to
learn about its internals see the developer documentation in the [source
files](src).
## Output formatting
Many test helpers need to produce human readable output. This library
provides a simple way to format simple messages and key value pairs, and
display them on the standard error.
### Simple message
Simple messages without structure, e.g. one-line error messages, are
simply wrapped in a header and a footer to help them stand out.
```
-- ERROR: assert_output --
`--partial' and `--regexp' are mutually exclusive
--
```
### Key-Value pairs
Some helpers, e.g. [assertions][bats-assert], structure output as
key-value pairs. This library provides two ways to format them.
When the value is one line long, a pair can be displayed in a columnar
fashion called ***two-column*** format.
```
-- output differs --
expected : want
actual : have
--
```
When the value is longer than one line, the key and value must be
displayed on separate lines. First, the key is displayed along with the
number of lines in the value. Then, the value, indented by two spaces
for added readability, starting on the next line. This is called
***multi-line*** format.
```
-- command failed --
status : 1
output (2 lines):
Error! Something went terribly wrong!
Our engineers are panicing... \`>`;/
--
```
Sometimes, for clarity, it is a good idea to display related values also
in this format, even if they are just one line long.
```
-- output differs --
expected (1 lines):
want
actual (3 lines):
have 1
have 2
have 3
--
```
# Licence
`bats-core` is licensed under the CC0 licence to ensure the highest
possible compatibility with other software.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
<!-- BEGIN GENERATED with https://creativecommons.org/choose/zero/ -->
<p xmlns:dct="http://purl.org/dc/terms/" xmlns:vcard="http://www.w3.org/2001/vcard-rdf/3.0#">
<a rel="license"
href="http://creativecommons.org/publicdomain/zero/1.0/">
<img src="http://i.creativecommons.org/p/zero/1.0/88x31.png" style="border-style: none;" alt="CC0" />
</a>
<br />
To the extent possible under law,
<a rel="dct:publisher"
href="https://github.com/ztombol">
<span property="dct:title">Zoltán Tömböl</span></a>
has waived all copyright and related or neighboring rights to
<span property="dct:title">bats-core</span>.
This work is published from:
<span property="vcard:Country" datatype="dct:ISO3166"
content="HU" about="https://github.com/ztombol">
Hungary</span>.
</p>
<!-- END GENERATED -->
<!-- REFERENCES -->
[bats]: https://github.com/sstephenson/bats
[bats-docs]: https://github.com/ztombol/bats-docs
[bats-assert]: https://github.com/ztombol/bats-assert
|
