clip/help_test.go at main · rliebz/clip · GitHub

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
package clip

import (
	"bytes"
	"testing"

	"github.com/rliebz/ghost"
	"github.com/rliebz/ghost/be"
)

func TestHelpContextFullName(t *testing.T) {
	g := ghost.New(t)

	wasCalled := false
	var hctx *helpContext
	action := func(ctx *Context) error {
		wasCalled = true
		hctx = newHelpContext(ctx)
		return nil
	}

	root := NewCommand(
		"root",
		SubCommand(
			"child",
			SubCommand(
				"grandchild",
				CommandAction(action),
			),
		),
	)

	g.NoError(root.Execute([]string{"root", "child", "grandchild"}))
	g.Should(be.True(wasCalled))
	g.Should(be.Equal(hctx.FullName(), "root child grandchild"))
}

func TestHelpCommands(t *testing.T) {
	g := ghost.New(t)

	buf := new(bytes.Buffer)
	root := NewCommand(
		"root",
		CommandStdout(buf),
		SubCommand("child-one", CommandSummary("1")),
		SubCommand("child-two", CommandSummary("2")),
		SubCommand("child-three", CommandSummary("3")),
	)

	args := []string{root.Name()}
	g.NoError(root.Execute(args))

	output := buf.String()
	g.Should(be.StringContaining(output, "child-one    1"))
	g.Should(be.StringContaining(output, "child-two    2"))
	g.Should(be.StringContaining(output, "child-three  3"))
}

func TestHidden(t *testing.T) {
	g := ghost.New(t)

	buf := new(bytes.Buffer)
	root := NewCommand(
		"root",
		CommandStdout(buf),
		SubCommand("visible"),
		SubCommand("hidden", CommandHidden),
	)

	args := []string{root.Name()}
	g.NoError(root.Execute(args))

	output := buf.String()
	g.Should(be.StringContaining(output, "visible"))
	g.ShouldNot(be.StringContaining(output, "hidden"))
}

func TestHiddenFlags(t *testing.T) {
	g := ghost.New(t)

	buf := new(bytes.Buffer)
	root := NewCommand(
		"root",
		CommandStdout(buf),
		ToggleFlag("visible"),
		ToggleFlag("hidden", FlagHidden),
	)

	args := []string{root.Name()}
	g.NoError(root.Execute(args))

	output := buf.String()
	g.Should(be.StringContaining(output, "visible"))
	g.ShouldNot(be.StringContaining(output, "hidden"))
}

func Test_printCommandHelp_deprecated(t *testing.T) {
	g := ghost.New(t)

	buf := new(bytes.Buffer)
	root := NewCommand(
		"root",
		CommandStdout(buf),
		StringFlag(new(string), "loud", FlagDeprecated("Don't be loud.")),
	)

	args := []string{root.Name()}
	g.NoError(root.Execute(args))

	output := buf.String()
	g.Should(be.StringContaining(output, "Deprecated: Don't be loud"))
}

func Test_printCommandHelp_placeholder(t *testing.T) {
	g := ghost.New(t)

	buf := new(bytes.Buffer)
	root := NewCommand(
		"root",
		CommandStdout(buf),
		StringFlag(new(string), "default-string"),
		StringFlag(new(string), "override-string", FlagPlaceholder("somevalue")),
		BoolFlag(new(bool), "default-bool"),
		BoolFlag(new(bool), "override-bool", FlagPlaceholder("somebool")),
	)

	args := []string{root.Name()}
	g.NoError(root.Execute(args))

	output := buf.String()
	g.Should(be.StringContaining(output, "--default-string <string>"))
	g.Should(be.StringContaining(output, "--override-string <somevalue>"))
	g.Should(be.StringContaining(output, "--default-bool\n"))
	g.Should(be.StringContaining(output, "--override-bool=<somebool>"))
}