02a0d2fbc9
This patch modifies the GenMarkdownCustom to skip writing a Synopsis header with the `cmd.Short` duplicated both before and after the header. Instead, it only writes the `### Synopsis` header and the paragraph when a `cmd.Long` has some kind of content in it. Adds `TestGenMdDocWithNoLongOrSynopsis` as the test case. Signed-off-by: Marc Lopez <marc5.12@outlook.com>
113 lines
3.0 KiB
Go
113 lines
3.0 KiB
Go
package doc
|
|
|
|
import (
|
|
"bytes"
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
func TestGenMdDoc(t *testing.T) {
|
|
// We generate on subcommand so we have both subcommands and parents.
|
|
buf := new(bytes.Buffer)
|
|
if err := GenMarkdown(echoCmd, buf); 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")
|
|
checkStringContains(t, output, rootCmd.Short)
|
|
checkStringContains(t, output, echoSubCmd.Short)
|
|
checkStringOmits(t, output, deprecatedCmd.Short)
|
|
checkStringContains(t, output, "Options inherited from parent commands")
|
|
}
|
|
|
|
func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) {
|
|
// We generate on subcommand so we have both subcommands and parents.
|
|
buf := new(bytes.Buffer)
|
|
if err := GenMarkdown(dummyCmd, buf); 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) {
|
|
// 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 := GenMarkdown(echoCmd, buf); 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")
|
|
checkStringContains(t, output, rootCmd.Short)
|
|
checkStringContains(t, output, echoSubCmd.Short)
|
|
checkStringOmits(t, output, deprecatedCmd.Short)
|
|
checkStringOmits(t, output, "Options inherited from parent commands")
|
|
}
|
|
|
|
func TestGenMdNoTag(t *testing.T) {
|
|
rootCmd.DisableAutoGenTag = true
|
|
defer func() { rootCmd.DisableAutoGenTag = false }()
|
|
|
|
buf := new(bytes.Buffer)
|
|
if err := GenMarkdown(rootCmd, buf); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
output := buf.String()
|
|
|
|
checkStringOmits(t, output, "Auto generated")
|
|
}
|
|
|
|
func TestGenMdTree(t *testing.T) {
|
|
c := &cobra.Command{Use: "do [OPTIONS] arg1 arg2"}
|
|
tmpdir, err := ioutil.TempDir("", "test-gen-md-tree")
|
|
if err != nil {
|
|
t.Fatalf("Failed to create tmpdir: %v", err)
|
|
}
|
|
defer os.RemoveAll(tmpdir)
|
|
|
|
if err := GenMarkdownTree(c, tmpdir); 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 := ioutil.TempFile("", "")
|
|
if err != nil {
|
|
b.Fatal(err)
|
|
}
|
|
defer os.Remove(file.Name())
|
|
defer file.Close()
|
|
|
|
b.ResetTimer()
|
|
for i := 0; i < b.N; i++ {
|
|
if err := GenMarkdown(rootCmd, file); err != nil {
|
|
b.Fatal(err)
|
|
}
|
|
}
|
|
}
|