mirror
/
cobra
mirror of https://github.com/spf13/cobra.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Add tests for double line break

This commit is contained in:
Dan Ramich 2024-05-18 14:57:18 -06:00
parent 50ba2caeb5
commit 83d142ca76
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/cmd_test.go
View File

@ -103,3 +103,10 @@ func checkStringOmits(t *testing.T, got, expected string) {
t.Errorf("Expected to not contain: \n %v\nGot: %v", expected, got) t.Errorf("Expected to not contain: \n %v\nGot: %v", expected, got)
} }
} }
func checkStringOmitsSuffix(t *testing.T, got, expected string) {
if strings.HasSuffix(got, expected) {
// Note this uses %q so things like line breaks can be seen in the printed output
t.Errorf("Expected to not have suffix: \n %q\nGot: %q", expected, got)
}
}

6
doc/md_docs_test.go
View File

@ -24,6 +24,8 @@ import (
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
const doubleLineBreak = "\n\n"
func TestGenMdDoc(t *testing.T) { func TestGenMdDoc(t *testing.T) {
// We generate on subcommand so we have both subcommands and parents. // We generate on subcommand so we have both subcommands and parents.
buf := new(bytes.Buffer) buf := new(bytes.Buffer)
@ -40,6 +42,7 @@ func TestGenMdDoc(t *testing.T) {
checkStringContains(t, output, echoSubCmd.Short) checkStringContains(t, output, echoSubCmd.Short)
checkStringOmits(t, output, deprecatedCmd.Short) checkStringOmits(t, output, deprecatedCmd.Short)
checkStringContains(t, output, "Options inherited from parent commands") checkStringContains(t, output, "Options inherited from parent commands")
checkStringOmitsSuffix(t, output, doubleLineBreak)
} }
func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) { func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) {
@ -54,6 +57,7 @@ func TestGenMdDocWithNoLongOrSynopsis(t *testing.T) {
checkStringContains(t, output, dummyCmd.Short) checkStringContains(t, output, dummyCmd.Short)
checkStringContains(t, output, "Options inherited from parent commands") checkStringContains(t, output, "Options inherited from parent commands")
checkStringOmits(t, output, "### Synopsis") checkStringOmits(t, output, "### Synopsis")
checkStringOmitsSuffix(t, output, doubleLineBreak)
} }
func TestGenMdNoHiddenParents(t *testing.T) { func TestGenMdNoHiddenParents(t *testing.T) {
@ -77,6 +81,7 @@ func TestGenMdNoHiddenParents(t *testing.T) {
checkStringContains(t, output, echoSubCmd.Short) checkStringContains(t, output, echoSubCmd.Short)
checkStringOmits(t, output, deprecatedCmd.Short) checkStringOmits(t, output, deprecatedCmd.Short)
checkStringOmits(t, output, "Options inherited from parent commands") checkStringOmits(t, output, "Options inherited from parent commands")
checkStringOmitsSuffix(t, output, doubleLineBreak)
} }
func TestGenMdNoTag(t *testing.T) { func TestGenMdNoTag(t *testing.T) {
@ -90,6 +95,7 @@ func TestGenMdNoTag(t *testing.T) {
output := buf.String() output := buf.String()
checkStringOmits(t, output, "Auto generated") checkStringOmits(t, output, "Auto generated")
checkStringOmitsSuffix(t, output, doubleLineBreak)
} }
func TestGenMdTree(t *testing.T) { func TestGenMdTree(t *testing.T) {