spf13--cobra/doc/rest_docs_test.go

113 lines
3 KiB
Go
Raw Normal View History

2023-03-06 02:28:31 +00:00
// Copyright 2013-2023 The Cobra Authors
2022-09-16 11:55:56 +00:00
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
2017-10-07 17:39:47 +00:00
package doc
import (
"bytes"
"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 TestGenRSTNoHiddenParents(t *testing.T) {
// We generate on a 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 := GenReST(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")
}
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"}
tmpdir, err := os.MkdirTemp("", "test-gen-rst-tree")
2017-10-07 17:39:47 +00:00
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 := os.CreateTemp("", "")
2017-10-07 17:39:47 +00:00
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)
}
}
}