e87b5bcaff
* Add "reference" help topic * Only print reference as a help topic * fix for color fns, slightly generalize * WIP for switching to markdown * escape gt/lt * minor * higher wrap point * detect terminal theme * futz with angle brackets once more * minor cleanup * prepend parent commands * rename help topic fns and add test * Simplify reference help generation - the `<...>` characters from command usage line are now preserved by enclosing the entire usage synopsis in a code span - hard breaks in flag usage lines are preserved by enclosing flag usage in a code block - TTY detection and Markdown rendering are now delayed until the user explicitly requests `gh help reference` - `gh help reference` output is now pager-enabled Co-authored-by: vilmibm <vilmibm@github.com> Co-authored-by: vilmibm <vilmibm@neongrid.space> Co-authored-by: Mislav Marohnić <mislav@github.com>
79 lines
1.4 KiB
Go
79 lines
1.4 KiB
Go
package root
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/cli/cli/pkg/iostreams"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestNewHelpTopic(t *testing.T) {
|
|
tests := []struct {
|
|
name string
|
|
topic string
|
|
args []string
|
|
flags []string
|
|
wantsErr bool
|
|
}{
|
|
{
|
|
name: "valid topic",
|
|
topic: "environment",
|
|
args: []string{},
|
|
flags: []string{},
|
|
wantsErr: false,
|
|
},
|
|
{
|
|
name: "invalid topic",
|
|
topic: "invalid",
|
|
args: []string{},
|
|
flags: []string{},
|
|
wantsErr: false,
|
|
},
|
|
{
|
|
name: "more than zero args",
|
|
topic: "environment",
|
|
args: []string{"invalid"},
|
|
flags: []string{},
|
|
wantsErr: false,
|
|
},
|
|
{
|
|
name: "more than zero flags",
|
|
topic: "environment",
|
|
args: []string{},
|
|
flags: []string{"--invalid"},
|
|
wantsErr: true,
|
|
},
|
|
{
|
|
name: "help arg",
|
|
topic: "environment",
|
|
args: []string{"help"},
|
|
flags: []string{},
|
|
wantsErr: false,
|
|
},
|
|
{
|
|
name: "help flag",
|
|
topic: "environment",
|
|
args: []string{},
|
|
flags: []string{"--help"},
|
|
wantsErr: false,
|
|
},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
_, _, stdout, stderr := iostreams.Test()
|
|
|
|
cmd := NewHelpTopic(tt.topic)
|
|
cmd.SetArgs(append(tt.args, tt.flags...))
|
|
cmd.SetOut(stdout)
|
|
cmd.SetErr(stderr)
|
|
|
|
_, err := cmd.ExecuteC()
|
|
if tt.wantsErr {
|
|
assert.Error(t, err)
|
|
return
|
|
}
|
|
assert.NoError(t, err)
|
|
})
|
|
}
|
|
}
|