Repository navigation
Expand file tree
/
Copy pathhelp_notemplate_test.go
More file actions
153 lines (143 loc) · 4.02 KB
/
Copy pathhelp_notemplate_test.go
File metadata and controls
153 lines (143 loc) · 4.02 KB
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
149
150
151
152
153
//go:build urfave_cli_no_template
package cli
import (
"bytes"
"context"
"io"
"strings"
"testing"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestNoTemplate_CustomHelpTemplate(t *testing.T) {
tests := []struct {
name string
cmd *Command
args []string
want string
}{
{
name: "root",
cmd: &Command{Name: "foo", CustomRootCommandHelpTemplate: "{{.Name}}"},
args: []string{"foo", "--help"},
want: `command "foo": ` + errNoTemplate.Error(),
},
{
name: "subcommand",
cmd: &Command{Name: "foo", Commands: []*Command{
{Name: "bar", CustomHelpTemplate: "{{.Name}}"},
}},
args: []string{"foo", "bar", "--help"},
want: `command "foo bar": ` + errNoTemplate.Error(),
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
tc.cmd.Writer = io.Discard
assertPanicsNoTemplate(t, tc.want, func() {
_ = tc.cmd.Run(context.Background(), tc.args)
})
})
}
}
// A custom template is fine as long as it is handled by a custom help
// printer, or never used.
func TestNoTemplate_CustomHelpPrinter(t *testing.T) {
defer func(old HelpPrinterFunc) { HelpPrinter = old }(HelpPrinter)
HelpPrinter = func(w io.Writer, _ string, data any) {
_, _ = io.WriteString(w, "custom help for "+data.(*Command).Name+"\n")
}
for _, args := range [][]string{{"foo"}, {"foo", "--help"}} {
var out, errOut bytes.Buffer
ran := false
cmd := &Command{
Name: "foo",
Writer: &out,
ErrWriter: &errOut,
CustomRootCommandHelpTemplate: "rendered by the custom printer",
Action: func(context.Context, *Command) error {
ran = true
return nil
},
}
require.NoError(t, cmd.Run(context.Background(), args))
assert.Empty(t, errOut.String())
if len(args) == 1 {
assert.True(t, ran)
} else {
assert.Equal(t, "custom help for foo\n", out.String())
}
}
}
// A custom help printer receives "root", "command" or "subcommand" as templ,
// and can tell commands with the same name apart using data.
func TestNoTemplate_CustomHelpPrinterTempl(t *testing.T) {
defer func(old HelpPrinterFunc) { HelpPrinter = old }(HelpPrinter)
HelpPrinter = func(w io.Writer, templ string, data any) {
_, _ = io.WriteString(w, templ+": "+data.(*Command).FullName()+"\n")
}
tests := []struct {
args []string
want string
}{
{args: []string{"app", "--help"}, want: "root: app"},
{args: []string{"app", "a", "--help"}, want: "subcommand: app a"},
{args: []string{"app", "a", "x", "--help"}, want: "command: app a x"},
{args: []string{"app", "b", "x", "--help"}, want: "command: app b x"},
{args: []string{"app", "b", "help", "x"}, want: "command: app b x"},
}
for _, tc := range tests {
t.Run(strings.Join(tc.args[1:], " "), func(t *testing.T) {
var out bytes.Buffer
cmd := &Command{
Name: "app",
Writer: &out,
Commands: []*Command{
{Name: "a", Commands: []*Command{{Name: "x"}}},
{Name: "b", Commands: []*Command{{Name: "x"}}},
},
}
require.NoError(t, cmd.Run(context.Background(), tc.args))
assert.Equal(t, tc.want+"\n", out.String())
})
}
}
func TestNoTemplate_DefaultPrintHelpCustom(t *testing.T) {
tests := []struct {
name string
templ string
data any
want string
}{
{
name: "custom template",
templ: "{{.Name}}",
data: &Command{Name: "foo"},
want: `command "foo": ` + errNoTemplate.Error(),
},
{
name: "not a command",
templ: RootCommandHelpTemplate,
data: "not a command",
want: errNoTemplate.Error(),
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
assertPanicsNoTemplate(t, tc.want, func() {
DefaultPrintHelpCustom(io.Discard, tc.templ, tc.data, nil)
})
})
}
}
// assertPanicsNoTemplate checks that f panics with errNoTemplate,
// and the panic message is want.
func assertPanicsNoTemplate(t *testing.T, want string, f func()) {
t.Helper()
defer func() {
err, _ := recover().(error)
require.ErrorIs(t, err, errNoTemplate)
assert.Equal(t, want, err.Error())
}()
f()
}