dca59d52b6
- canonicalheader: fix cacheTTL header value to canonical form - embeddedstructfieldcheck: move embedded fields before regular fields in 4 structs - iotamixing: split const blocks mixing iota with non-iota constants - makezero: use make([]T, 0, n) instead of make([]T, n) before appending - testableexamples: add missing Output: comment to ExampleOption_UnwrapOrZero - wastedassign: remove wasted initial assignments in 4 locations - usetesting: replace os.MkdirTemp/os.Setenv with t.TempDir/t.Setenv in tests - tparallel: add t.Parallel() to 8 top-level test functions - unconvert: remove 16 unnecessary type conversions - intrange: convert 3 for loops to use integer range syntax - iface: consolidate identical EditPrompter and Prompt interfaces via type alias Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
241 lines
6.7 KiB
Go
241 lines
6.7 KiB
Go
package docs
|
|
|
|
import (
|
|
"bytes"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func TestGenMdDoc(t *testing.T) {
|
|
linkHandler := func(s string) string { return s }
|
|
|
|
// We generate on subcommand so we have both subcommands and parents.
|
|
buf := new(bytes.Buffer)
|
|
if err := genMarkdownCustom(echoCmd, buf, linkHandler); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
output := buf.String()
|
|
|
|
checkStringContains(t, output, echoCmd.Long)
|
|
checkStringContains(t, output, echoCmd.Example)
|
|
checkStringContains(t, output, "boolone")
|
|
checkStringContains(t, output, "rootflag")
|
|
checkStringOmits(t, output, rootCmd.Short)
|
|
checkStringOmits(t, output, echoSubCmd.Short)
|
|
checkStringOmits(t, output, deprecatedCmd.Short)
|
|
checkStringContains(t, output, "Options inherited from parent commands")
|
|
}
|
|
|
|
func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) {
|
|
linkHandler := func(s string) string { return s }
|
|
|
|
// We generate on subcommand so we have both subcommands and parents.
|
|
buf := new(bytes.Buffer)
|
|
if err := genMarkdownCustom(dummyCmd, buf, linkHandler); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
output := buf.String()
|
|
|
|
checkStringContains(t, output, dummyCmd.Example)
|
|
checkStringContains(t, output, dummyCmd.Short)
|
|
checkStringContains(t, output, "Options inherited from parent commands")
|
|
checkStringOmits(t, output, "### Synopsis")
|
|
}
|
|
|
|
func TestGenMdNoHiddenParents(t *testing.T) {
|
|
linkHandler := func(s string) string { return s }
|
|
|
|
// We generate on subcommand so we have both subcommands and parents.
|
|
for _, name := range []string{"rootflag", "strtwo"} {
|
|
f := rootCmd.PersistentFlags().Lookup(name)
|
|
f.Hidden = true
|
|
defer func() { f.Hidden = false }()
|
|
}
|
|
buf := new(bytes.Buffer)
|
|
if err := genMarkdownCustom(echoCmd, buf, linkHandler); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
output := buf.String()
|
|
|
|
checkStringContains(t, output, echoCmd.Long)
|
|
checkStringContains(t, output, echoCmd.Example)
|
|
checkStringContains(t, output, "boolone")
|
|
checkStringOmits(t, output, "rootflag")
|
|
checkStringOmits(t, output, rootCmd.Short)
|
|
checkStringOmits(t, output, echoSubCmd.Short)
|
|
checkStringOmits(t, output, deprecatedCmd.Short)
|
|
checkStringOmits(t, output, "Options inherited from parent commands")
|
|
}
|
|
|
|
func TestGenMdAliases(t *testing.T) {
|
|
buf := new(bytes.Buffer)
|
|
if err := genMarkdownCustom(aliasCmd, buf, nil); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
output := buf.String()
|
|
|
|
checkStringContains(t, output, aliasCmd.Long)
|
|
checkStringContains(t, output, jsonCmd.Example)
|
|
checkStringContains(t, output, "ALIASES")
|
|
checkStringContains(t, output, "yoo")
|
|
checkStringContains(t, output, "foo")
|
|
}
|
|
|
|
func TestGenMdJSONFields(t *testing.T) {
|
|
buf := new(bytes.Buffer)
|
|
if err := genMarkdownCustom(jsonCmd, buf, nil); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
output := buf.String()
|
|
|
|
checkStringContains(t, output, jsonCmd.Long)
|
|
checkStringContains(t, output, jsonCmd.Example)
|
|
checkStringContains(t, output, "JSON Fields")
|
|
checkStringContains(t, output, "`foo`")
|
|
checkStringContains(t, output, "`bar`")
|
|
checkStringContains(t, output, "`baz`")
|
|
}
|
|
|
|
func TestGenMdTree(t *testing.T) {
|
|
c := &cobra.Command{Use: "do [OPTIONS] arg1 arg2"}
|
|
tmpdir := t.TempDir()
|
|
|
|
if err := GenMarkdownTreeCustom(c, tmpdir, func(s string) string { return s }, func(s string) string { return s }); err != nil {
|
|
t.Fatalf("GenMarkdownTree failed: %v", err)
|
|
}
|
|
|
|
if _, err := os.Stat(filepath.Join(tmpdir, "do.md")); err != nil {
|
|
t.Fatalf("Expected file 'do.md' to exist")
|
|
}
|
|
}
|
|
|
|
func BenchmarkGenMarkdownToFile(b *testing.B) {
|
|
file, err := os.CreateTemp(b.TempDir(), "")
|
|
if err != nil {
|
|
b.Fatal(err)
|
|
}
|
|
defer file.Close()
|
|
|
|
linkHandler := func(s string) string { return s }
|
|
|
|
b.ResetTimer()
|
|
for range b.N {
|
|
if err := genMarkdownCustom(rootCmd, file, linkHandler); err != nil {
|
|
b.Fatal(err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestPrintFlagsHTMLShowsDefaultValues(t *testing.T) {
|
|
type TestOptions struct {
|
|
Limit int
|
|
Template string
|
|
Fork bool
|
|
NoArchive bool
|
|
Topic []string
|
|
}
|
|
opts := TestOptions{}
|
|
|
|
// Int flag should show it
|
|
c := &cobra.Command{}
|
|
c.Flags().IntVar(&opts.Limit, "limit", 30, "Some limit")
|
|
flags := c.NonInheritedFlags()
|
|
buf := new(bytes.Buffer)
|
|
flags.SetOutput(buf)
|
|
|
|
if err := printFlagsHTML(buf, flags); err != nil {
|
|
t.Fatalf("printFlagsHTML failed: %s", err.Error())
|
|
}
|
|
output := buf.String()
|
|
|
|
checkStringContains(t, output, "(default 30)")
|
|
|
|
// Bool flag should hide it if default is false
|
|
c = &cobra.Command{}
|
|
c.Flags().BoolVar(&opts.Fork, "fork", false, "Show only forks")
|
|
|
|
flags = c.NonInheritedFlags()
|
|
buf = new(bytes.Buffer)
|
|
flags.SetOutput(buf)
|
|
|
|
if err := printFlagsHTML(buf, flags); err != nil {
|
|
t.Fatalf("printFlagsHTML failed: %s", err.Error())
|
|
}
|
|
output = buf.String()
|
|
|
|
checkStringOmits(t, output, "(default ")
|
|
|
|
// Bool flag should show it if default is true
|
|
c = &cobra.Command{}
|
|
c.Flags().BoolVar(&opts.NoArchive, "no-archived", true, "Hide archived")
|
|
flags = c.NonInheritedFlags()
|
|
buf = new(bytes.Buffer)
|
|
flags.SetOutput(buf)
|
|
|
|
if err := printFlagsHTML(buf, flags); err != nil {
|
|
t.Fatalf("printFlagsHTML failed: %s", err.Error())
|
|
}
|
|
output = buf.String()
|
|
|
|
checkStringContains(t, output, "(default true)")
|
|
|
|
// String flag should show it if default is not an empty string
|
|
c = &cobra.Command{}
|
|
c.Flags().StringVar(&opts.Template, "template", "T1", "Some template")
|
|
flags = c.NonInheritedFlags()
|
|
buf = new(bytes.Buffer)
|
|
flags.SetOutput(buf)
|
|
|
|
if err := printFlagsHTML(buf, flags); err != nil {
|
|
t.Fatalf("printFlagsHTML failed: %s", err.Error())
|
|
}
|
|
output = buf.String()
|
|
|
|
checkStringContains(t, output, "(default "T1")")
|
|
|
|
// String flag should hide it if default is an empty string
|
|
c = &cobra.Command{}
|
|
c.Flags().StringVar(&opts.Template, "template", "", "Some template")
|
|
|
|
flags = c.NonInheritedFlags()
|
|
buf = new(bytes.Buffer)
|
|
flags.SetOutput(buf)
|
|
|
|
if err := printFlagsHTML(buf, flags); err != nil {
|
|
t.Fatalf("printFlagsHTML failed: %s", err.Error())
|
|
}
|
|
output = buf.String()
|
|
|
|
checkStringOmits(t, output, "(default ")
|
|
|
|
// String slice flag should hide it if default is an empty slice
|
|
c = &cobra.Command{}
|
|
c.Flags().StringSliceVar(&opts.Topic, "topic", nil, "Some topics")
|
|
flags = c.NonInheritedFlags()
|
|
buf = new(bytes.Buffer)
|
|
flags.SetOutput(buf)
|
|
|
|
if err := printFlagsHTML(buf, flags); err != nil {
|
|
t.Fatalf("printFlagsHTML failed: %s", err.Error())
|
|
}
|
|
output = buf.String()
|
|
|
|
checkStringOmits(t, output, "(default ")
|
|
|
|
// String slice flag should show it if default is not an empty slice
|
|
c = &cobra.Command{}
|
|
c.Flags().StringSliceVar(&opts.Topic, "topic", []string{"apples", "oranges"}, "Some topics")
|
|
flags = c.NonInheritedFlags()
|
|
buf = new(bytes.Buffer)
|
|
flags.SetOutput(buf)
|
|
|
|
if err := printFlagsHTML(buf, flags); err != nil {
|
|
t.Fatalf("printFlagsHTML failed: %s", err.Error())
|
|
}
|
|
output = buf.String()
|
|
|
|
checkStringContains(t, output, "(default [apples,oranges])")
|
|
}
|