spf13--cobra/doc/rest_docs_test.go

77 lines
1.7 KiB
Go
Raw Normal View History

2017-10-07 17:39:47 +00:00
package doc
import (
"bytes"
"io/ioutil"
"os"
"path/filepath"
"testing"
"github.com/spf13/cobra"
)
func TestGenRSTDoc(t *testing.T) {
2017-11-02 15:22:38 +00:00
// We generate on a subcommand so we have both subcommands and parents
buf := new(bytes.Buffer)
if err := GenReST(echoCmd, buf); err != nil {
2017-10-07 17:39:47 +00:00
t.Fatal(err)
}
2017-11-02 15:22:38 +00:00
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)
2017-10-07 17:39:47 +00:00
}
func TestGenRSTNoTag(t *testing.T) {
2017-11-02 15:22:38 +00:00
rootCmd.DisableAutoGenTag = true
defer func() { rootCmd.DisableAutoGenTag = false }()
2017-10-07 17:39:47 +00:00
2017-11-02 15:22:38 +00:00
buf := new(bytes.Buffer)
if err := GenReST(rootCmd, buf); err != nil {
2017-10-07 17:39:47 +00:00
t.Fatal(err)
}
2017-11-02 15:22:38 +00:00
output := buf.String()
2017-10-07 17:39:47 +00:00
unexpected := "Auto generated"
2017-11-02 15:22:38 +00:00
checkStringOmits(t, output, unexpected)
2017-10-07 17:39:47 +00:00
}
func TestGenRSTTree(t *testing.T) {
2017-11-02 15:22:38 +00:00
c := &cobra.Command{Use: "do [OPTIONS] arg1 arg2"}
2017-10-07 17:39:47 +00:00
tmpdir, err := ioutil.TempDir("", "test-gen-rst-tree")
if err != nil {
t.Fatalf("Failed to create tmpdir: %s", err.Error())
}
defer os.RemoveAll(tmpdir)
2017-11-02 15:22:38 +00:00
if err := GenReSTTree(c, tmpdir); err != nil {
2017-10-07 17:39:47 +00:00
t.Fatalf("GenReSTTree failed: %s", err.Error())
}
if _, err := os.Stat(filepath.Join(tmpdir, "do.rst")); err != nil {
t.Fatalf("Expected file 'do.rst' to exist")
}
}
func BenchmarkGenReSTToFile(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++ {
2017-11-02 15:22:38 +00:00
if err := GenReST(rootCmd, file); err != nil {
2017-10-07 17:39:47 +00:00
b.Fatal(err)
}
}
}