add more tests for app run

Author: inhere

_examples/cliapp/main.go

@@ -20,9 +20,10 @@ func main() {
 	app := gcli.NewApp(func(app *gcli.App) {
 		app.Version = "3.0.0"
 		app.Desc = "this is my cli application"
-		app.On(gcli.EvtAppInit, func(data ...interface{}) {
+		app.On(gcli.EvtAppInit, func(data ...interface{}) bool {
 			// do something...
 			// fmt.Println("init app")
+			return true
 		})
 
 		// app.SetVerbose(gcli.VerbDebug)

app.go

@@ -16,15 +16,8 @@ import (
  * CLI application
  *************************************************************/
 
-// HookFunc definition.
-// func arguments:
-//  in app, like: func(app *App, data interface{})
-//  in cmd, like: func(cmd *Command, data interface{})
-// type HookFunc func(obj interface{}, data interface{})
-type HookFunc func(obj ...interface{})
-
-// Commander interface definition
-type Commander interface {
+// Handler interface definition
+type Handler interface {
 	// Creator for create new command
 	Creator() *Command
 	// Config bind Flags or Arguments for the command
@@ -42,10 +35,11 @@ type Logo struct {
 // App the cli app definition
 type App struct {
 	// internal use
+	// - *cmdLine
+	// - HelpVars
+	// - Hooks // allow hooks: "init", "before", "after", "error"
 	core
-	// *cmdLine
-	// HelpVars
-	// Hooks // allow hooks: "init", "before", "after", "error"
+	// for manager commands
 	commandBase
 
 	// Name app name
@@ -62,7 +56,7 @@ type App struct {
 	// args on after parse global options and command name.
 	args []string
 	// all commands by module TODO remove
-	moduleCommands map[string]map[string]*Command
+	// moduleCommands map[string]map[string]*Command
 
 	// rawFlagArgs []string
 	// clean os.args, not contains bin-name and command-name
@@ -218,13 +212,15 @@ func (app *App) AddCommand(c *Command) {
 	app.commandBase.addCommand(app.Name, c)
 }
 
-// AddCommander to the application
-func (app *App) AddCommander(cmder Commander) {
-	c := cmder.Creator()
-	c.Func = cmder.Execute
+// AddHandler to the application
+func (app *App) AddHandler(h Handler) {
+	c := h.Creator()
+	c.Func = h.Execute
 
 	// binding flags
-	cmder.Config(c)
+	h.Config(c)
+
+	// add
 	app.AddCommand(c)
 }
 
@@ -329,8 +325,11 @@ func (app *App) prepareRun() (code int, name string) {
 	// name is not empty, but is not command.
 	if app.inputName == "" {
 		Logf(VerbDebug, "input the command is not an registered: %s", name)
-		// display unknown input command and similar commands tips
-		app.showCommandTips(name)
+
+		if ok := app.fireEvent(EvtCmdNotFound, name); ok {
+			// display unknown input command and similar commands tips
+			app.showCommandTips(name)
+		}
 		return
 	}
 
@@ -359,7 +358,7 @@ func (app *App) findCommandName() (name string) {
 	name = args[0]
 	// is empty string or is an option
 	if name == "" || name[0] == '-' {
-		 return ""
+		return ""
 	}
 
 	Debugf("the raw input command name(args[0]) is '%s'", name)
@@ -389,7 +388,7 @@ func (app *App) findCommandName() (name string) {
 
 			bakName := realName
 			realName = nodes[0]
-			app.args = append(nodes[1:], args[1:]...)  // update app.args
+			app.args = append(nodes[1:], args[1:]...) // update app.args
 			Debugf("the '%s' is an command ID, expand it, command '%s', args: %v",
 				bakName,
 				realName,
@@ -503,10 +502,10 @@ func (app *App) exitOnEnd(code int) int {
 	// if IsGteVerbose(VerbDebug) {
 	// 	app.Infoln("[DEBUG] The Runtime Call Stacks:")
 
-		// bts := goutil.GetCallStacks(true)
-		// app.Println(string(bts), len(bts))
-		// cs := goutil.GetCallersInfo(2, 10)
-		// app.Println(strings.Join(cs, "\n"), len(cs))
+	// bts := goutil.GetCallStacks(true)
+	// app.Println(string(bts), len(bts))
+	// cs := goutil.GetCallersInfo(2, 10)
+	// app.Println(strings.Join(cs, "\n"), len(cs))
 	// }
 
 	if app.ExitOnEnd {
@@ -519,6 +518,12 @@ func (app *App) exitOnEnd(code int) int {
 // name can be:
 // - top command name in the app. 'top'
 // - command path in the app. 'top sub'
+//
+// Usage:
+//	app.Exec("top")
+//	app.Exec("top:sub")
+//	app.Exec("top sub")
+//	app.Exec("top sub", []string{"-a", "val0", "arg0"})
 func (app *App) Exec(path string, args []string) error {
 	cmd := app.MatchByPath(path)
 	if cmd == nil {
@@ -562,10 +567,10 @@ func (app *App) On(name string, handler HookFunc) {
 	app.core.On(name, handler)
 }
 
-func (app *App) fireEvent(event string, data interface{}) {
+func (app *App) fireEvent(event string, data interface{}) bool {
 	Debugf("trigger the application event: <green>%s</>", event)
 
-	app.core.Fire(event, app, data)
+	return app.core.Fire(event, app, data)
 }
 
 /*************************************************************

app_test.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/gookit/color"
 	"github.com/gookit/gcli/v3"
+	"github.com/gookit/goutil/dump"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -20,7 +21,8 @@ var (
 		Name: "simple",
 		Desc: "an simple command",
 		Func: func(c *gcli.Command, args []string) error {
-			fmt.Println(c.Path(), args)
+			dump.Println(c.Path(), args)
+			c.SetValue("simple", "simple command")
 			return nil
 		},
 	}
@@ -432,7 +434,7 @@ func TestApp_showCommandTips(t *testing.T) {
 func TestApp_AddCommander(t *testing.T) {
 	app := gcli.NewApp()
 
-	app.AddCommander(&UserCommand{})
+	app.AddHandler(&UserCommand{})
 
 	assert.True(t, app.HasCommand("test"))
 }

base.go

@@ -10,7 +10,9 @@ import (
 	"strings"
 
 	"github.com/gookit/color"
+	"github.com/gookit/goutil/mathutil"
 	"github.com/gookit/goutil/structs"
+	"github.com/gookit/goutil/strutil"
 )
 
 // core definition TODO rename to context ??
@@ -108,10 +110,78 @@ func (s SimplePrinter) Errorln(a ...interface{}) {
 	color.Error.Println(a...)
 }
 
+// simple map[string]interface{} struct
+type mapData struct {
+	data map[string]interface{}
+}
+
+// Data get all
+func (md *mapData) Data() map[string]interface{} {
+	return md.data
+}
+
+// SetData set all data
+func (md *mapData) SetData(data map[string]interface{}) {
+	md.data = data
+}
+
+// Value get from data
+func (md *mapData) Value(key string) interface{} {
+	return md.data[key]
+}
+
+// StrValue get from data
+func (md *mapData) StrValue(key string) string {
+	return strutil.MustString(md.data[key])
+}
+
+// IntValue get from data
+func (md *mapData) IntValue(key string) int {
+	return mathutil.MustInt(md.data[key])
+}
+
+// SetValue to data
+func (md *mapData) SetValue(key string, val interface{}) {
+	if md.data == nil {
+		md.data = make(map[string]interface{})
+	}
+	md.data[key] = val
+}
+
+// ClearData all data
+func (md *mapData) ClearData() {
+	md.data = nil
+}
+
 /*************************************************************
  * simple events manage
  *************************************************************/
 
+// HookFunc definition.
+// func arguments:
+//  in app, like: func(app *App, data ...interface{})
+//  in cmd, like: func(cmd *Command, data ...interface{})
+// type HookFunc func(obj interface{}, data interface{})
+// return:
+// - True go on handle. default is True
+// - False stop goon handle.
+type HookFunc func(data ...interface{}) bool
+
+// HookCtx struct
+type HookCtx struct {
+	mapData
+	App *App
+	Cmd *Command
+
+	name string
+	data map[string]interface{}
+}
+
+// Name of event
+func (hc *HookCtx) Name() string {
+	return hc.name
+}
+
 // Hooks struct
 type Hooks struct {
 	// Hooks can setting some hooks func on running.
@@ -137,10 +207,12 @@ func (h *Hooks) AddOn(name string, handler HookFunc) {
 }
 
 // Fire event by name, allow with event data
-func (h *Hooks) Fire(event string, data ...interface{}) {
+func (h *Hooks) Fire(event string, data ...interface{}) bool {
 	if handler, ok := h.hooks[event]; ok {
-		handler(data...)
+		return handler(data...)
 	}
+
+	return true
 }
 
 // HasHook register
@@ -314,6 +386,7 @@ func (hv *HelpVars) ReplaceVars(input string) string {
 
 // will inject to every Command
 type commandBase struct {
+	mapData
 	// Logo ASCII logo setting
 	Logo *Logo
 	// Version app version. like "1.0.1"
@@ -349,8 +422,6 @@ type commandBase struct {
 
 	// store some runtime errors
 	errors []error
-	// TODO simple context data map
-	data map[string]interface{}
 }
 
 func newCommandBase() commandBase {
@@ -530,26 +601,3 @@ func (b *commandBase) CmdAliases() *structs.Aliases {
 func (b *commandBase) AliasesMapping() map[string]string {
 	return b.cmdAliases.Mapping()
 }
-
-// Data get
-func (b *commandBase) Data() map[string]interface{} {
-	return b.data
-}
-
-// SetData to cmd
-func (b *commandBase) SetData(data map[string]interface{}) {
-	b.data = data
-}
-
-// Value get from b.data
-func (b *commandBase) Value(key string) interface{} {
-	return b.data[key]
-}
-
-// SetValue to b.data
-func (b *commandBase) SetValue(key string, val interface{}) {
-	if b.data == nil {
-		b.data = make(map[string]interface{})
-	}
-	b.data[key] = val
-}