app_test.go

package cmd

import (
	"flag"
	"testing"

	"github.com/RTradeLtd/config/v2"
)

func TestNew(t *testing.T) {
	type args struct {
		cmds map[string]Cmd
		cfg  Config
	}
	tests := []struct {
		name     string
		args     args
		wantCmds int
	}{
		{"with version", args{make(map[string]Cmd), Config{Version: "1"}}, 2},
		{"without version", args{make(map[string]Cmd), Config{}}, 1},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			got := New(tt.args.cmds, tt.args.cfg)
			if len(got.cmds) != tt.wantCmds {
				t.Errorf("expected %d commands, got %d", len(got.cmds), tt.wantCmds)
			}
		})
	}
}

func TestApp_PreRun(t *testing.T) {
	type fields struct {
		cfg  Config
		cmds map[string]Cmd
	}
	type args struct {
		args []string
	}
	tests := []struct {
		name    string
		fields  fields
		args    args
		wantRun bool
	}{
		{
			"help command should run",
			fields{Config{}, make(map[string]Cmd)},
			args{[]string{"help"}},
			true,
		},
		{
			"invalid command should not run",
			fields{Config{}, make(map[string]Cmd)},
			args{[]string{"asdfasdf"}},
			false,
		},
		{
			"non-prerun command should not run",
			fields{Config{}, map[string]Cmd{"notme": Cmd{Action: func(config.TemporalConfig, map[string]string) {}}}},
			args{[]string{"notme"}},
			false,
		},
		{
			"should not run without required args",
			fields{Config{}, map[string]Cmd{"hi": Cmd{
				PreRun: true,
				Args:   []string{"hello", "world"},
				Action: func(config.TemporalConfig, map[string]string) {},
			}}},
			args{[]string{"hi"}},
			false,
		},
		{
			"should run with required args",
			fields{Config{}, map[string]Cmd{"hi": Cmd{
				PreRun: true,
				Args:   []string{"hello", "world"},
				Action: func(config.TemporalConfig, map[string]string) {},
			}}},
			args{[]string{"hi", "bobhead", "postables"}},
			true,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			a := New(tt.fields.cmds, tt.fields.cfg)
			exit := a.PreRun(nil, tt.args.args)
			if (exit == 0) != tt.wantRun {
				t.Errorf("expected command run to be %v, got %v",
					tt.wantRun, (exit == 0))
			}
		})
	}
}

func TestApp_Run(t *testing.T) {
	fl := flag.NewFlagSet("", flag.ExitOnError)
	tflag := fl.String("test", "", "flag for testing")

	type fields struct {
		cfg  Config
		cmds map[string]Cmd
	}
	type args struct {
		args []string
	}
	tests := []struct {
		name    string
		fields  fields
		args    args
		wantRun bool
	}{
		{
			"help command should run",
			fields{Config{}, make(map[string]Cmd)},
			args{[]string{"help"}},
			true,
		},
		{
			"invalid command should not run",
			fields{Config{}, make(map[string]Cmd)},
			args{[]string{"asdfasdf"}},
			false,
		},
		{
			"custom command should run",
			fields{Config{}, map[string]Cmd{"me": Cmd{Action: func(config.TemporalConfig, map[string]string) {}}}},
			args{[]string{"me"}},
			true,
		},
		{
			"nested commands should run",
			fields{Config{}, map[string]Cmd{"me": Cmd{
				Action: func(config.TemporalConfig, map[string]string) {},
				Children: map[string]Cmd{"too": Cmd{
					Children: map[string]Cmd{"wow": Cmd{
						Action: func(config.TemporalConfig, map[string]string) {},
					}},
				}},
			}}},
			args{[]string{"me", "too", "wow"}},
			true,
		},
		{
			"should not run without required args",
			fields{Config{}, map[string]Cmd{"hi": Cmd{
				Args:   []string{"hello", "world"},
				Action: func(config.TemporalConfig, map[string]string) {},
			}}},
			args{[]string{"hi"}},
			false,
		},
		{
			"should run with required args",
			fields{Config{}, map[string]Cmd{"hi": Cmd{
				Args:   []string{"hello", "world"},
				Action: func(config.TemporalConfig, map[string]string) {},
			}}},
			args{[]string{"hi", "bobhead", "postables"}},
			true,
		},
		{
			"should run with a flag on command",
			fields{Config{}, map[string]Cmd{"hi": Cmd{
				Options: fl,
				Action: func(cfg config.TemporalConfig, flags map[string]string) {
					defer func() {
						*tflag = ""
					}()
					if *tflag == "" {
						t.Error("expected flag 'test' to have value")
					}
				},
			}}},
			args{[]string{"hi", "--test", "wow"}},
			true,
		},
		{
			"should run with a missing flag on command",
			fields{Config{}, map[string]Cmd{"hi": Cmd{
				Options: fl,
				Action: func(cfg config.TemporalConfig, flags map[string]string) {
					defer func() {
						*tflag = ""
					}()
					if *tflag != "" {
						t.Error("expected flag 'test' to have no value")
					}
				},
			}}},
			args{[]string{"hi"}},
			true,
		},
	}
	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			a := New(tt.fields.cmds, tt.fields.cfg)
			exit := a.Run(config.TemporalConfig{}, nil, tt.args.args)
			if (exit == 0) != tt.wantRun {
				t.Errorf("expected command run to be %v, got %v",
					tt.wantRun, (exit == 0))
			}
		})
	}
}