func TestApp_DefaultStdout(t *testing.T) { app := cli.NewApp() if app.Writer != os.Stdout { t.Error("Default output writer not set.") } }
func ExampleAppBashComplete() { // set args for examples sake os.Args = []string{"greet", "--generate-bash-completion"} app := cli.NewApp() app.Name = "greet" app.EnableBashCompletion = true app.Commands = []cli.Command{ { Name: "describeit", Aliases: []string{"d"}, Usage: "use it to see a description", Description: "This is how we describe describeit the function", Action: func(c *cli.Context) { fmt.Printf("i like to describe things") }, }, { Name: "next", Usage: "next example", Description: "more stuff to see when generating bash completion", Action: func(c *cli.Context) { fmt.Printf("the next example") }, }, } app.Run(os.Args) // Output: // describeit // d // next // help // h }
func TestGlobalFlagsInSubcommands(t *testing.T) { subcommandRun := false app := cli.NewApp() app.Flags = []cli.Flag{ cli.BoolFlag{Name: "debug, d", Usage: "Enable debugging"}, } app.Commands = []cli.Command{ cli.Command{ Name: "foo", Subcommands: []cli.Command{ { Name: "bar", Action: func(c *cli.Context) { if c.GlobalBool("debug") { subcommandRun = true } }, }, }, }, } app.Run([]string{"command", "-d", "foo", "bar"}) expect(t, subcommandRun, true) }
func TestApp_RunAsSubcommandParseFlags(t *testing.T) { var context *cli.Context a := cli.NewApp() a.Commands = []cli.Command{ { Name: "foo", Action: func(c *cli.Context) { context = c }, Flags: []cli.Flag{ cli.StringFlag{ Name: "lang", Value: "english", Usage: "language for the greeting", }, }, Before: func(_ *cli.Context) error { return nil }, }, } a.Run([]string{"", "foo", "--lang", "spanish", "abcd"}) expect(t, context.Args().Get(0), "abcd") expect(t, context.String("lang"), "spanish") }
func ExampleAppHelp() { // set args for examples sake os.Args = []string{"greet", "h", "describeit"} app := cli.NewApp() app.Name = "greet" app.Flags = []cli.Flag{ cli.StringFlag{Name: "name", Value: "bob", Usage: "a name to say"}, } app.Commands = []cli.Command{ { Name: "describeit", Aliases: []string{"d"}, Usage: "use it to see a description", Description: "This is how we describe describeit the function", Action: func(c *cli.Context) { fmt.Printf("i like to describe things") }, }, } app.Run(os.Args) // Output: // NAME: // describeit - use it to see a description // // USAGE: // command describeit [arguments...] // // DESCRIPTION: // This is how we describe describeit the function }
func TestApp_ParseSliceFlags(t *testing.T) { var parsedOption, firstArg string var parsedIntSlice []int var parsedStringSlice []string app := cli.NewApp() command := cli.Command{ Name: "cmd", Flags: []cli.Flag{ cli.IntSliceFlag{Name: "p", Value: &cli.IntSlice{}, Usage: "set one or more ip addr"}, cli.StringSliceFlag{Name: "ip", Value: &cli.StringSlice{}, Usage: "set one or more ports to open"}, }, Action: func(c *cli.Context) { parsedIntSlice = c.IntSlice("p") parsedStringSlice = c.StringSlice("ip") parsedOption = c.String("option") firstArg = c.Args().First() }, } app.Commands = []cli.Command{command} app.Run([]string{"", "cmd", "my-arg", "-p", "22", "-p", "80", "-ip", "8.8.8.8", "-ip", "8.8.4.4"}) IntsEquals := func(a, b []int) bool { if len(a) != len(b) { return false } for i, v := range a { if v != b[i] { return false } } return true } StrsEquals := func(a, b []string) bool { if len(a) != len(b) { return false } for i, v := range a { if v != b[i] { return false } } return true } var expectedIntSlice = []int{22, 80} var expectedStringSlice = []string{"8.8.8.8", "8.8.4.4"} if !IntsEquals(parsedIntSlice, expectedIntSlice) { t.Errorf("%v does not match %v", parsedIntSlice, expectedIntSlice) } if !StrsEquals(parsedStringSlice, expectedStringSlice) { t.Errorf("%v does not match %v", parsedStringSlice, expectedStringSlice) } }
func TestApp_Command(t *testing.T) { app := cli.NewApp() fooCommand := cli.Command{Name: "foobar", Aliases: []string{"f"}} batCommand := cli.Command{Name: "batbaz", Aliases: []string{"b"}} app.Commands = []cli.Command{ fooCommand, batCommand, } for _, test := range commandAppTests { expect(t, app.Command(test.name) != nil, test.expected) } }
func TestApp_Run(t *testing.T) { s := "" app := cli.NewApp() app.Action = func(c *cli.Context) { s = s + c.Args().First() } err := app.Run([]string{"command", "foo"}) expect(t, err, nil) err = app.Run([]string{"command", "bar"}) expect(t, err, nil) expect(t, s, "foobar") }
func TestApp_Float64Flag(t *testing.T) { var meters float64 app := cli.NewApp() app.Flags = []cli.Flag{ cli.Float64Flag{Name: "height", Value: 1.5, Usage: "Set the height, in meters"}, } app.Action = func(c *cli.Context) { meters = c.Float64("height") } app.Run([]string{"", "--height", "1.93"}) expect(t, meters, 1.93) }
func TestAppNoHelpFlag(t *testing.T) { oldFlag := cli.HelpFlag defer func() { cli.HelpFlag = oldFlag }() cli.HelpFlag = cli.BoolFlag{} app := cli.NewApp() err := app.Run([]string{"test", "-h"}) if err != flag.ErrHelp { t.Errorf("expected error about missing help flag, but got: %s (%T)", err, err) } }
func TestApp_SetStdout(t *testing.T) { w := &mockWriter{} app := cli.NewApp() app.Name = "test" app.Writer = w err := app.Run([]string{"help"}) if err != nil { t.Fatalf("Run error: %s", err) } if len(w.written) == 0 { t.Error("App did not write output to desired writer.") } }
func TestAppHelpPrinter(t *testing.T) { oldPrinter := cli.HelpPrinter defer func() { cli.HelpPrinter = oldPrinter }() var wasCalled = false cli.HelpPrinter = func(template string, data interface{}) { wasCalled = true } app := cli.NewApp() app.Run([]string{"-h"}) if wasCalled == false { t.Errorf("Help printer expected to be called, but was not") } }
func TestApp_CommandWithNoFlagBeforeTerminator(t *testing.T) { var args []string app := cli.NewApp() command := cli.Command{ Name: "cmd", Action: func(c *cli.Context) { args = c.Args() }, } app.Commands = []cli.Command{command} app.Run([]string{"", "cmd", "my-arg", "--", "notAFlagAtAll"}) expect(t, args[0], "my-arg") expect(t, args[1], "--") expect(t, args[2], "notAFlagAtAll") }
func TestAppVersionPrinter(t *testing.T) { oldPrinter := cli.VersionPrinter defer func() { cli.VersionPrinter = oldPrinter }() var wasCalled = false cli.VersionPrinter = func(c *cli.Context) { wasCalled = true } app := cli.NewApp() ctx := cli.NewContext(app, nil, nil) cli.ShowVersion(ctx) if wasCalled == false { t.Errorf("Version printer expected to be called, but was not") } }
func ExampleApp() { // set args for examples sake os.Args = []string{"greet", "--name", "Jeremy"} app := cli.NewApp() app.Name = "greet" app.Flags = []cli.Flag{ cli.StringFlag{Name: "name", Value: "bob", Usage: "a name to say"}, } app.Action = func(c *cli.Context) { fmt.Printf("Hello %v\n", c.String("name")) } app.Author = "Harrison" app.Email = "*****@*****.**" app.Authors = []cli.Author{cli.Author{Name: "Oliver Allen", Email: "*****@*****.**"}} app.Run(os.Args) // Output: // Hello Jeremy }
func TestCommandDoNotIgnoreFlags(t *testing.T) { app := cli.NewApp() set := flag.NewFlagSet("test", 0) test := []string{"blah", "blah", "-break"} set.Parse(test) c := cli.NewContext(app, set, set) command := cli.Command{ Name: "test-cmd", Aliases: []string{"tc"}, Usage: "this is for testing", Description: "testing", Action: func(_ *cli.Context) {}, } err := command.Run(c) expect(t, err.Error(), "flag provided but not defined: -break") }
func TestCommandIgnoreFlags(t *testing.T) { app := cli.NewApp() set := flag.NewFlagSet("test", 0) test := []string{"blah", "blah"} set.Parse(test) c := cli.NewContext(app, set, set) command := cli.Command{ Name: "test-cmd", Aliases: []string{"tc"}, Usage: "this is for testing", Description: "testing", Action: func(_ *cli.Context) {}, SkipFlagParsing: true, } err := command.Run(c) expect(t, err, nil) }
func TestApp_CommandWithArgBeforeFlags(t *testing.T) { var parsedOption, firstArg string app := cli.NewApp() command := cli.Command{ Name: "cmd", Flags: []cli.Flag{ cli.StringFlag{Name: "option", Value: "", Usage: "some option"}, }, Action: func(c *cli.Context) { parsedOption = c.String("option") firstArg = c.Args().First() }, } app.Commands = []cli.Command{command} app.Run([]string{"", "cmd", "my-arg", "--option", "my-option"}) expect(t, parsedOption, "my-option") expect(t, firstArg, "my-arg") }
func TestAppCommandNotFound(t *testing.T) { beforeRun, subcommandRun := false, false app := cli.NewApp() app.CommandNotFound = func(c *cli.Context, command string) { beforeRun = true } app.Commands = []cli.Command{ cli.Command{ Name: "bar", Action: func(c *cli.Context) { subcommandRun = true }, }, } app.Run([]string{"command", "foo"}) expect(t, beforeRun, true) expect(t, subcommandRun, false) }
func ExampleAppSubcommand() { // set args for examples sake os.Args = []string{"say", "hi", "english", "--name", "Jeremy"} app := cli.NewApp() app.Name = "say" app.Commands = []cli.Command{ { Name: "hello", Aliases: []string{"hi"}, Usage: "use it to see a description", Description: "This is how we describe hello the function", Subcommands: []cli.Command{ { Name: "english", Aliases: []string{"en"}, Usage: "sends a greeting in english", Description: "greets someone in english", Flags: []cli.Flag{ cli.StringFlag{ Name: "name", Value: "Bob", Usage: "Name of the person to greet", }, }, Action: func(c *cli.Context) { fmt.Println("Hello,", c.String("name")) }, }, }, }, } app.Run(os.Args) // Output: // Hello, Jeremy }
func TestApp_CommandWithFlagBeforeTerminator(t *testing.T) { var parsedOption string var args []string app := cli.NewApp() command := cli.Command{ Name: "cmd", Flags: []cli.Flag{ cli.StringFlag{Name: "option", Value: "", Usage: "some option"}, }, Action: func(c *cli.Context) { parsedOption = c.String("option") args = c.Args() }, } app.Commands = []cli.Command{command} app.Run([]string{"", "cmd", "my-arg", "--option", "my-option", "--", "--notARealFlag"}) expect(t, parsedOption, "my-option") expect(t, args[0], "my-arg") expect(t, args[1], "--") expect(t, args[2], "--notARealFlag") }
func main() { app := cli.NewApp() app.Name = "dns-workbench" app.Usage = "a simple authoritative DNS workbench server" app.Authors = []cli.Author{cli.Author{Name: "Roland Shoemaker", Email: "*****@*****.**"}} app.Version = "0.0.1" app.Flags = []cli.Flag{} app.Commands = []cli.Command{ { Name: "run", Usage: "Starts the DNS server", Flags: []cli.Flag{ cli.StringFlag{ Name: "dns-name", Value: "localhost", Usage: "Hostname of the DNS server", }, cli.StringFlag{ Name: "dns-address", Value: "127.0.0.1", Usage: "Address for the DNS server to listen on", }, cli.StringFlag{ Name: "dns-port", Value: "8053", Usage: "Port for the DNS server to listen on", }, cli.StringFlag{ Name: "dns-network", Value: "udp", Usage: "Network for the DNS server to listen on", }, cli.BoolFlag{ Name: "dns-compression", Usage: "Use DNS message compression", }, cli.StringFlag{ Name: "zone-file", Usage: "Path to workbench zones file", }, cli.StringFlag{ Name: "api-uri", Value: "127.0.0.1:5353", Usage: "Address for the HTTP API to listen on", }, cli.BoolTFlag{ Name: "disable-api", Usage: "Don't start the HTTP API", }, }, Action: func(c *cli.Context) { var rz rawZones var z zones var a auth var err error logger := log.New(os.Stdout, "[dns-wb] ", log.Flags()) if rzFile := c.String("zone-file"); rzFile != "" { rz, err = loadYAML(rzFile) if err != nil { logger.Fatalf("Failed to read zone file: %s\n", err) } z, a, err = constrcutZones(rz, dns.Fqdn(c.String("dns-name"))) if err != nil { logger.Fatalf("Failed to parse zone file: %s\n", err) } } else { z = make(zones) a = make(auth) } wb := workbench{ z: z, a: a, l: logger, name: dns.Fqdn(c.String("dns-name")), bind: c.String("dns-address"), port: c.String("dns-port"), net: c.String("dns-network"), rTimeout: time.Second * 2, wTimeout: time.Second * 2, iTimeout: time.Second * 8, compression: c.Bool("dns-compression"), } go func() { http.HandleFunc("/api/reload", wb.apiReload) logger.Printf("API listening on %s\n", c.String("api-uri")) err := http.ListenAndServe(c.String("api-uri"), nil) if err != nil { logger.Printf("HTTP API crashed: %s\n", err) // Dont' exit } }() err = wb.serveWorkbench() if err != nil { logger.Fatalf("DNS server crashed: %s\n", err) os.Exit(1) } }, }, { Name: "reload", Usage: "Loads a new zone file into a running workbench", Flags: []cli.Flag{ cli.StringFlag{ Name: "zone-file", Usage: "Path to workbench zones file", }, cli.StringFlag{ Name: "api-uri", Value: "127.0.0.1:5353", Usage: "Address for the HTTP API", }, }, Action: func(c *cli.Context) { logger := log.New(os.Stdout, "[dns-wb] ", log.Flags()) if c.String("zone-file") == "" { logger.Fatalf("Zone file option is required\n") } rz, err := loadYAML(c.String("zone-file")) if err != nil { logger.Fatalf("Failed to load zone file: %s\n", err) } rzJSON, err := json.Marshal(rz) if err != nil { logger.Fatalf("Failed to marshal zone file to JSON: %s\n", err) } req, err := http.NewRequest("POST", fmt.Sprintf("http://%s/api/reload", c.String("api-uri")), bytes.NewBuffer(rzJSON)) req.Header.Set("Content-Type", "application/json") client := &http.Client{} resp, err := client.Do(req) if err != nil { logger.Fatalf("Failed to send update: %s\n", err) } defer resp.Body.Close() if resp.StatusCode != 200 { apiErr, err := ioutil.ReadAll(resp.Body) if err != nil { logger.Fatalf("Failed to read response body: %s\n", err) return } logger.Fatalf("Failed to reload zones: %s\n", apiErr) return } logger.Printf("Succesesfully reloaded zones\n") }, }, } err := app.Run(os.Args) if err != nil { fmt.Println(err) } }
func TestApp_AfterFunc(t *testing.T) { afterRun, subcommandRun := false, false afterError := fmt.Errorf("fail") var err error app := cli.NewApp() app.After = func(c *cli.Context) error { afterRun = true s := c.String("opt") if s == "fail" { return afterError } return nil } app.Commands = []cli.Command{ cli.Command{ Name: "sub", Action: func(c *cli.Context) { subcommandRun = true }, }, } app.Flags = []cli.Flag{ cli.StringFlag{Name: "opt"}, } // run with the After() func succeeding err = app.Run([]string{"command", "--opt", "succeed", "sub"}) if err != nil { t.Fatalf("Run error: %s", err) } if afterRun == false { t.Errorf("After() not executed when expected") } if subcommandRun == false { t.Errorf("Subcommand not executed when expected") } // reset afterRun, subcommandRun = false, false // run with the Before() func failing err = app.Run([]string{"command", "--opt", "fail", "sub"}) // should be the same error produced by the Before func if err != afterError { t.Errorf("Run error expected, but not received") } if afterRun == false { t.Errorf("After() not executed when expected") } if subcommandRun == false { t.Errorf("Subcommand not executed when expected") } }