diff options
Diffstat (limited to 'command/parse_test.go')
| -rw-r--r-- | command/parse_test.go | 292 |
1 files changed, 292 insertions, 0 deletions
diff --git a/command/parse_test.go b/command/parse_test.go new file mode 100644 index 00000000..f424e97b --- /dev/null +++ b/command/parse_test.go @@ -0,0 +1,292 @@ +package command_test + +import ( + "bytes" + "errors" + "flag" + "fmt" + "io" + "log" + "strings" + "testing" + + "git.gensokyo.uk/security/fortify/command" +) + +func TestParse(t *testing.T) { + testCases := []struct { + name string + buildTree func(wout, wlog io.Writer) command.Command + args []string + want string + wantLog string + wantErr error + }{ + { + "d=0 empty sub", + func(wout, wlog io.Writer) command.Command { return command.New(wout, newLogFunc(wlog), "root") }, + []string{""}, + "", "test: \"root\" has no subcommands\n", command.ErrEmptyTree, + }, + { + "d=0 empty sub garbage", + func(wout, wlog io.Writer) command.Command { return command.New(wout, newLogFunc(wlog), "root") }, + []string{"a", "b", "c", "d"}, + "", "test: \"root\" has no subcommands\n", command.ErrEmptyTree, + }, + { + "d=0 no match", + buildTestCommand, + []string{"nonexistent"}, + "", "test: \"nonexistent\" is not a valid command\n", command.ErrNoMatch, + }, + { + "d=0 direct error", + buildTestCommand, + []string{"error"}, + "", "", errSuccess, + }, + { + "d=0 direct error garbage", + buildTestCommand, + []string{"error", "0", "1", "2"}, + "", "", errSuccess, + }, + { + "d=0 direct success out of order", + buildTestCommand, + []string{"succeed"}, + "", "", nil, + }, + { + "d=0 direct success output", + buildTestCommand, + []string{"print", "0", "1", "2"}, + "012", "", nil, + }, + { + "d=0 string flag", + buildTestCommand, + []string{"--val", "64d3b4b7b21788585845060e2199a78f", "flag"}, + "64d3b4b7b21788585845060e2199a78f", "", nil, + }, + { + "d=0 out of order string flag", + buildTestCommand, + []string{"flag", "--val", "64d3b4b7b21788585845060e2199a78f"}, + "flag provided but not defined: -val\n\nUsage:\ttest flag [-h | --help] COMMAND [OPTIONS]\n\n", "", + errors.New("flag provided but not defined: -val"), + }, + + { + "d=1 empty sub", + buildTestCommand, + []string{"empty"}, + "", "test: \"empty\" has no subcommands\n", command.ErrEmptyTree, + }, + { + "d=1 empty sub garbage", + buildTestCommand, + []string{"empty", "a", "b", "c", "d"}, + "", "test: \"empty\" has no subcommands\n", command.ErrEmptyTree, + }, + { + "d=1 empty sub help", + buildTestCommand, + []string{"empty", "-h"}, + "\nUsage:\ttest empty [-h | --help] COMMAND [OPTIONS]\n\n", "", flag.ErrHelp, + }, + { + "d=1 no match", + buildTestCommand, + []string{"join", "23aa3bb0", "34986782", "d8859355", "cd9ac317", ", "}, + "", "test: \"23aa3bb0\" is not a valid command\n", command.ErrNoMatch, + }, + { + "d=1 direct success out", + buildTestCommand, + []string{"join", "out", "23aa3bb0", "34986782", "d8859355", "cd9ac317", ", "}, + "23aa3bb0, 34986782, d8859355, cd9ac317", "", nil, + }, + { + "d=1 direct success log", + buildTestCommand, + []string{"join", "log", "23aa3bb0", "34986782", "d8859355", "cd9ac317", ", "}, + "", "test: 23aa3bb0, 34986782, d8859355, cd9ac317\n", nil, + }, + + { + "d=4 empty sub", + buildTestCommand, + []string{"deep", "d=2", "d=3", "d=4"}, + "", "test: \"d=4\" has no subcommands\n", command.ErrEmptyTree}, + + { + "d=0 help", + buildTestCommand, + []string{}, + ` +Usage: test [-h | --help] [-v] [--val <value>] COMMAND [OPTIONS] + +Commands: + error return an error + print wraps Fprint + flag print value passed by flag + empty empty subcommand + join wraps strings.Join + succeed this command succeeds + deep top level of command tree with various levels + +`, "", command.ErrHelp, + }, + { + "d=0 help flag", + buildTestCommand, + []string{"-h"}, + ` +Usage: test [-h | --help] [-v] [--val <value>] COMMAND [OPTIONS] + +Commands: + error return an error + print wraps Fprint + flag print value passed by flag + empty empty subcommand + join wraps strings.Join + succeed this command succeeds + deep top level of command tree with various levels + +Flags: + -v verbosity + -val string + store val for the "flag" command (default "default") + +`, "", flag.ErrHelp, + }, + + { + "d=1 help", + buildTestCommand, + []string{"join"}, + ` +Usage: test join [-h | --help] COMMAND [OPTIONS] + +Commands: + out write result to wout + log log result to wlog + +`, "", command.ErrHelp, + }, + { + "d=1 help flag", + buildTestCommand, + []string{"join", "-h"}, + ` +Usage: test join [-h | --help] COMMAND [OPTIONS] + +Commands: + out write result to wout + log log result to wlog + +`, "", flag.ErrHelp, + }, + + { + "d=2 help", + buildTestCommand, + []string{"deep", "d=2"}, + ` +Usage: test deep d=2 [-h | --help] COMMAND [OPTIONS] + +Commands: + d=3 relative third level + +`, "", command.ErrHelp, + }, + { + "d=2 help flag", + buildTestCommand, + []string{"deep", "d=2", "-h"}, + ` +Usage: test deep d=2 [-h | --help] COMMAND [OPTIONS] + +Commands: + d=3 relative third level + +`, "", flag.ErrHelp, + }, + } + for _, tc := range testCases { + t.Run(tc.name, func(t *testing.T) { + wout, wlog := new(bytes.Buffer), new(bytes.Buffer) + c := tc.buildTree(wout, wlog) + + if err := c.Parse(tc.args); !errors.Is(err, tc.wantErr) { + t.Errorf("Parse: error = %v; wantErr %v", err, tc.wantErr) + } + if got := wout.String(); got != tc.want { + t.Errorf("Parse: %s want %s", got, tc.want) + } + if gotLog := wlog.String(); gotLog != tc.wantLog { + t.Errorf("Parse: log = %s wantLog %s", gotLog, tc.wantLog) + } + }) + } +} + +var ( + errJoinLen = errors.New("not enough arguments to join") + errSuccess = errors.New("success") +) + +func buildTestCommand(wout, wlog io.Writer) (c command.Command) { + var val string + + logf := newLogFunc(wlog) + c = command.New(wout, logf, "test"). + Flag(new(bool), "v", command.BoolFlag(false), "verbosity"). + Command("error", "return an error", func([]string) error { + return errSuccess + }). + Command("print", "wraps Fprint", func(args []string) error { + a := make([]any, len(args)) + for i, v := range args { + a[i] = v + } + _, err := fmt.Fprint(wout, a...) + return err + }). + Flag(&val, "val", command.StringFlag("default"), "store val for the \"flag\" command"). + Command("flag", "print value passed by flag", func(args []string) error { + _, err := fmt.Fprint(wout, val) + return err + }) + + c.New("empty", "empty subcommand") + + c.New("join", "wraps strings.Join"). + Command("out", "write result to wout", func(args []string) error { + if len(args) == 0 { + return errJoinLen + } + _, err := fmt.Fprint(wout, strings.Join(args[:len(args)-1], args[len(args)-1])) + return err + }). + Command("log", "log result to wlog", func(args []string) error { + if len(args) == 0 { + return errJoinLen + } + logf("%s", strings.Join(args[:len(args)-1], args[len(args)-1])) + return nil + }) + + c.Command("succeed", "this command succeeds", func([]string) error { return nil }) + + c.New("deep", "top level of command tree with various levels"). + New("d=2", "relative second level"). + New("d=3", "relative third level"). + New("d=4", "relative fourth level") + + return +} + +func newLogFunc(w io.Writer) command.LogFunc { return log.New(w, "test: ", 0).Printf } |
