File: usage_test.go

package info (click to toggle)
golang-gopkg-alecthomas-kingpin.v3 3.0~git20180227.b8d601d-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 420 kB
  • sloc: makefile: 6
file content (148 lines) | stat: -rw-r--r-- 2,954 bytes parent folder | download
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
package kingpin

import (
	"bytes"
	"io/ioutil"
	"strings"
	"testing"

	"github.com/stretchr/testify/assert"
)

func TestFormatTwoColumns(t *testing.T) {
	buf := bytes.NewBuffer(nil)
	formatTwoColumns(buf, 2, 2, 20, [][2]string{
		{"--hello", "Hello world help with something that is cool."},
	})
	expected := `  --hello  Hello
           world
           help with
           something
           that is
           cool.
`
	assert.Equal(t, expected, buf.String())
}

func TestRequiredSubcommandsUsage(t *testing.T) {
	var buf bytes.Buffer

	a := New("test", "Test").Writers(&buf, ioutil.Discard).Terminate(nil)
	c0 := a.Command("c0", "c0info")
	c0.Command("c1", "c1info")
	_, err := a.Parse(nil)
	assert.Error(t, err)

	expectedStr := `
usage: test [<flags>] <command>

Test


Flags:
  --help  Show context-sensitive help.

Commands:
  help [<command> ...]
    Show help.


  c0 c1
    c1info


`
	assert.Equal(t, expectedStr, buf.String())
}

func TestOptionalSubcommandsUsage(t *testing.T) {
	var buf bytes.Buffer

	a := New("test", "Test").Writers(&buf, ioutil.Discard).Terminate(nil)
	c0 := a.Command("c0", "c0info").OptionalSubcommands()
	c0.Command("c1", "c1info")
	_, err := a.Parse(nil)
	assert.Error(t, err)

	expectedStr := `
usage: test [<flags>] <command>

Test


Flags:
  --help  Show context-sensitive help.

Commands:
  help [<command> ...]
    Show help.


  c0
    c0info


  c0 c1
    c1info


`
	assert.Equal(t, expectedStr, buf.String())
}

func TestFormatTwoColumnsWide(t *testing.T) {
	samples := [][2]string{
		{strings.Repeat("x", 29), "29 chars"},
		{strings.Repeat("x", 30), "30 chars"}}
	buf := bytes.NewBuffer(nil)
	formatTwoColumns(buf, 0, 0, 200, samples)
	expected := `xxxxxxxxxxxxxxxxxxxxxxxxxxxxx29 chars
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                             30 chars
`
	assert.Equal(t, expected, buf.String())
}

func TestHiddenCommand(t *testing.T) {
	templates := []struct{ name, template string }{
		{"default", DefaultUsageTemplate},
		{"Compact", CompactUsageTemplate},
		{"Man", ManPageTemplate},
	}

	var buf bytes.Buffer

	a := New("test", "Test").Writers(&buf, ioutil.Discard).Terminate(nil)
	a.Command("visible", "visible")
	a.Command("hidden", "hidden").Hidden()

	for _, tp := range templates {
		buf.Reset()
		a.UsageTemplate(tp.template)
		a.Parse(nil)
		// a.Parse([]string{"--help"})
		usage := buf.String()
		t.Logf("Usage for %s is:\n%s\n", tp.name, usage)

		assert.NotContains(t, usage, "hidden")
		assert.Contains(t, usage, "visible")
	}
}

func TestIssue169MultipleUsageCorruption(t *testing.T) {
	buf := &bytes.Buffer{}
	app := newTestApp()
	cmd := app.Command("cmd", "")
	cmd.Flag("flag", "").Default("false").Bool()
	app.Writers(buf, ioutil.Discard)
	_, err := app.Parse([]string{"help", "cmd"})
	assert.NoError(t, err)
	expected := buf.String()

	buf.Reset()
	_, err = app.Parse([]string{"help"})
	assert.NoError(t, err)
	actual := buf.String()

	assert.NotEqual(t, expected, actual)
}