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
|
# Testing `singularity help` content
This package contains the end-to-end tests for `singularity help`.
## Contributing new help tests
For this example, we're going to create a new test for
`singularity help inspect`.
- Add the help text to the `testdata/help` directory.
```sh
singularity help inspect > e2e/testdata/help/help-inspect.txt
```
- Add the help command to the `helpContentTests` struct in `help.go`
```go
var helpContentTests = []struct {
cmds []string
}{
...
// singularity inspect
{[]string{"help", "inspect"}},
...
}
```
## Updating existing help tests
For this example, we're going to update an existing test for
`singularity help inspect`.
- When a help test fails, we need to check why it failed.
- Was the failure a result of an unintended change? If so, we open an issue.
- Was the failure a result of an intended change? If so, we update the help
text.
- Update the help text in the `testdata/help` directory.
```sh
singularity help inspect > e2e/testdata/help/help-inspect.txt
```
## Running the help tests
To verify this test, modify the `Makefile` to add both a verbose flag and a
filter flag (`go test -v -r helpContentTests`) and then run the tests.
```sh
SINGULARITY_E2E=1 make -C builddir e2e-test
```
|
