File: help.bats

package info (click to toggle)
pyenv 2.5.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,176 kB
  • sloc: sh: 4,727; python: 402; makefile: 70; ansic: 60
file content (115 lines) | stat: -rw-r--r-- 2,361 bytes parent folder | download | duplicates (2)
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
#!/usr/bin/env bats

load test_helper

@test "without args shows summary of common commands" {
  run pyenv-help
  assert_success
  assert_line "Usage: pyenv <command> [<args>]"
  assert_line "Some useful pyenv commands are:"
}

@test "invalid command" {
  run pyenv-help hello
  assert_failure "pyenv: no such command \`hello'"
}

@test "shows help for a specific command" {
  mkdir -p "${PYENV_TEST_DIR}/bin"
  cat > "${PYENV_TEST_DIR}/bin/pyenv-hello" <<SH
#!shebang
# Usage: pyenv hello <world>
# Summary: Says "hello" to you, from pyenv
# This command is useful for saying hello.
echo hello
SH

  run pyenv-help hello
  assert_success
  assert_output <<SH
Usage: pyenv hello <world>

This command is useful for saying hello.
SH
}

@test "replaces missing extended help with summary text" {
  mkdir -p "${PYENV_TEST_DIR}/bin"
  cat > "${PYENV_TEST_DIR}/bin/pyenv-hello" <<SH
#!shebang
# Usage: pyenv hello <world>
# Summary: Says "hello" to you, from pyenv
echo hello
SH

  run pyenv-help hello
  assert_success
  assert_output <<SH
Usage: pyenv hello <world>

Says "hello" to you, from pyenv
SH
}

@test "extracts only usage" {
  mkdir -p "${PYENV_TEST_DIR}/bin"
  cat > "${PYENV_TEST_DIR}/bin/pyenv-hello" <<SH
#!shebang
# Usage: pyenv hello <world>
# Summary: Says "hello" to you, from pyenv
# This extended help won't be shown.
echo hello
SH

  run pyenv-help --usage hello
  assert_success "Usage: pyenv hello <world>"
}

@test "multiline usage section" {
  mkdir -p "${PYENV_TEST_DIR}/bin"
  cat > "${PYENV_TEST_DIR}/bin/pyenv-hello" <<SH
#!shebang
# Usage: pyenv hello <world>
#        pyenv hi [everybody]
#        pyenv hola --translate
# Summary: Says "hello" to you, from pyenv
# Help text.
echo hello
SH

  run pyenv-help hello
  assert_success
  assert_output <<SH
Usage: pyenv hello <world>
       pyenv hi [everybody]
       pyenv hola --translate

Help text.
SH
}

@test "multiline extended help section" {
  mkdir -p "${PYENV_TEST_DIR}/bin"
  cat > "${PYENV_TEST_DIR}/bin/pyenv-hello" <<SH
#!shebang
# Usage: pyenv hello <world>
# Summary: Says "hello" to you, from pyenv
# This is extended help text.
# It can contain multiple lines.
#
# And paragraphs.

echo hello
SH

  run pyenv-help hello
  assert_success
  assert_output <<SH
Usage: pyenv hello <world>

This is extended help text.
It can contain multiple lines.

And paragraphs.
SH
}