package doc import ( "bytes" "io/ioutil" "os" "path/filepath" "strings" "testing" "github.com/spf13/cobra" ) func TestGenMdDoc(t *testing.T) { c := initializeWithRootCmd() // Need two commands to run the command alphabetical sort cmdEcho.AddCommand(cmdTimes, cmdEchoSub, cmdDeprecated) c.AddCommand(cmdPrint, cmdEcho) cmdRootWithRun.PersistentFlags().StringVarP(&flags2a, "rootflag", "r", "two", strtwoParentHelp) out := new(bytes.Buffer) // We generate on s subcommand so we have both subcommands and parents if err := GenMarkdown(cmdEcho, out); err != nil { t.Fatal(err) } found := out.String() // Our description expected := cmdEcho.Long if !strings.Contains(found, expected) { t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found) } // Better have our example expected = cmdEcho.Example if !strings.Contains(found, expected) { t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found) } // A local flag expected = "boolone" if !strings.Contains(found, expected) { t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found) } // persistent flag on parent expected = "rootflag" if !strings.Contains(found, expected) { t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found) } // We better output info about our parent expected = cmdRootWithRun.Short if !strings.Contains(found, expected) { t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found) } // And about subcommands expected = cmdEchoSub.Short if !strings.Contains(found, expected) { t.Errorf("Unexpected response.\nExpecting to contain: \n %q\nGot:\n %q\n", expected, found) } unexpected := cmdDeprecated.Short if strings.Contains(found, unexpected) { t.Errorf("Unexpected response.\nFound: %v\nBut should not have!!\n", unexpected) } } func TestGenMdNoTag(t *testing.T) { c := initializeWithRootCmd() // Need two commands to run the command alphabetical sort cmdEcho.AddCommand(cmdTimes, cmdEchoSub, cmdDeprecated) c.AddCommand(cmdPrint, cmdEcho) c.DisableAutoGenTag = true cmdRootWithRun.PersistentFlags().StringVarP(&flags2a, "rootflag", "r", "two", strtwoParentHelp) out := new(bytes.Buffer) if err := GenMarkdown(c, out); err != nil { t.Fatal(err) } found := out.String() unexpected := "Auto generated" checkStringOmits(t, found, unexpected) } func TestGenMdTree(t *testing.T) { cmd := &cobra.Command{ Use: "do [OPTIONS] arg1 arg2", } tmpdir, err := ioutil.TempDir("", "test-gen-md-tree") if err != nil { t.Fatalf("Failed to create tmpdir: %s", err.Error()) } defer os.RemoveAll(tmpdir) if err := GenMarkdownTree(cmd, tmpdir); err != nil { t.Fatalf("GenMarkdownTree failed: %s", err.Error()) } if _, err := os.Stat(filepath.Join(tmpdir, "do.md")); err != nil { t.Fatalf("Expected file 'do.md' to exist") } }