refactor: pass lock.json & config value to subcommands

tyru · tyru · commit 089f65bfbfd7 · 2018-10-27T23:36:38.000+09:00
diff --git a/_docs/layer.md b/_docs/layer.md
@@ -0,0 +1,22 @@
+
+## Layered architecture
+
+The volt commands like `volt get` which may modify lock.json, config.toml([#221](https://github.com/vim-volt/volt/issues/221)),
+filesystem, are executed in several steps:
+
+1. (Subcmd layer): pass subcommand arguments, lock.json & config.toml structure
+   to Gateway layer
+2. (Gateway layer): Create an AST according to given information
+    * This layer cannot touch filesystem, because it makes unit testing difficult
+3. (Usecase layer): Execute the AST. This note mainly describes this layer's design
+
+Below is the dependency graph:
+
+```
+Subcmd --> Gateway --> Usecase
+```
+
+* Subcmd only depends Gateway
+* Gateway doesn't know Subcmd
+* Gateway only depends Usecase
+* Usecase doesn't know Gateway
diff --git a/subcmd/build.go b/subcmd/build.go
@@ -53,10 +53,10 @@ Description
 	return fs
 }
 
-func (cmd *buildCmd) Run(args []string) *Error {
+func (cmd *buildCmd) Run(cmdctx *CmdContext) *Error {
 	// Parse args
 	fs := cmd.FlagSet()
-	fs.Parse(args)
+	fs.Parse(cmdctx.Args)
 	if cmd.helped {
 		return nil
 	}
diff --git a/subcmd/cmd.go b/subcmd/cmd.go
@@ -2,12 +2,14 @@ package subcmd
 
 import (
 	"flag"
-	"github.com/pkg/errors"
 	"os"
 	"os/user"
 	"runtime"
 
+	"github.com/pkg/errors"
+
 	"github.com/vim-volt/volt/config"
+	"github.com/vim-volt/volt/lockjson"
 	"github.com/vim-volt/volt/logger"
 )
 
@@ -17,13 +19,20 @@ var cmdMap = make(map[string]Cmd)
 // All subcommands must implement this.
 type Cmd interface {
 	ProhibitRootExecution(args []string) bool
-	Run(args []string) *Error
+	Run(cmdctx *CmdContext) *Error
 	FlagSet() *flag.FlagSet
 }
 
+// CmdContext is a data transfer object between Subcmd and Gateway layer.
+type CmdContext struct {
+	Args     []string
+	LockJSON *lockjson.LockJSON
+	Config   *config.Config
+}
+
 // RunnerFunc invokes c with args.
 // On unit testing, a mock function was given.
-type RunnerFunc func(c Cmd, args []string) *Error
+type RunnerFunc func(c Cmd, cmdctx *CmdContext) *Error
 
 // Error is a command error.
 // It also has a exit code.
@@ -37,8 +46,8 @@ func (e *Error) Error() string {
 }
 
 // DefaultRunner simply runs command with args
-func DefaultRunner(c Cmd, args []string) *Error {
-	return c.Run(args)
+func DefaultRunner(c Cmd, cmdctx *CmdContext) *Error {
+	return c.Run(cmdctx)
 }
 
 // Run is invoked by main(), each argument means 'volt {subcmd} {args}'.
@@ -61,7 +70,7 @@ func Run(args []string, cont RunnerFunc) *Error {
 
 	c, exists := cmdMap[subCmd]
 	if !exists {
-		return &Error{Code: 3, Msg: "unknown command '" + subCmd + "'"}
+		return &Error{Code: 3, Msg: "Unknown command '" + subCmd + "'"}
 	}
 
 	// Disallow executing the commands which may modify files in root priviledge
@@ -72,7 +81,21 @@ func Run(args []string, cont RunnerFunc) *Error {
 		}
 	}
 
-	return cont(c, args)
+	lockJSON, err := lockjson.Read()
+	if err != nil {
+		return &Error{Code: 20, Msg: errors.Wrap(err, "failed to read lock.json").Error()}
+	}
+
+	cfg, err := config.Read()
+	if err != nil {
+		return &Error{Code: 30, Msg: errors.Wrap(err, "failed to read config.toml").Error()}
+	}
+
+	return cont(c, &CmdContext{
+		Args:     args,
+		LockJSON: lockJSON,
+		Config:   cfg,
+	})
 }
 
 func expandAlias(subCmd string, args []string) (string, []string, error) {
diff --git a/subcmd/disable.go b/subcmd/disable.go
@@ -41,8 +41,8 @@ Description
 	return fs
 }
 
-func (cmd *disableCmd) Run(args []string) *Error {
-	reposPathList, err := cmd.parseArgs(args)
+func (cmd *disableCmd) Run(cmdctx *CmdContext) *Error {
+	reposPathList, err := cmd.parseArgs(cmdctx.Args)
 	if err == ErrShowedHelp {
 		return nil
 	}
diff --git a/subcmd/enable.go b/subcmd/enable.go
@@ -41,8 +41,8 @@ Description
 	return fs
 }
 
-func (cmd *enableCmd) Run(args []string) *Error {
-	reposPathList, err := cmd.parseArgs(args)
+func (cmd *enableCmd) Run(cmdctx *CmdContext) *Error {
+	reposPathList, err := cmd.parseArgs(cmdctx.Args)
 	if err == ErrShowedHelp {
 		return nil
 	}
diff --git a/subcmd/get.go b/subcmd/get.go
@@ -116,31 +116,25 @@ Options`)
 	return fs
 }
 
-func (cmd *getCmd) Run(args []string) *Error {
+func (cmd *getCmd) Run(cmdctx *CmdContext) *Error {
 	// Parse args
-	args, err := cmd.parseArgs(args)
+	args, err := cmd.parseArgs(cmdctx.Args)
 	if err == ErrShowedHelp {
 		return nil
 	}
 	if err != nil {
 		return &Error{Code: 10, Msg: "Failed to parse args: " + err.Error()}
 	}
 
-	// Read lock.json
-	lockJSON, err := lockjson.Read()
-	if err != nil {
-		return &Error{Code: 11, Msg: "Could not read lock.json: " + err.Error()}
-	}
-
-	reposPathList, err := cmd.getReposPathList(args, lockJSON)
+	reposPathList, err := cmd.getReposPathList(args, cmdctx.LockJSON)
 	if err != nil {
 		return &Error{Code: 12, Msg: "Could not get repos list: " + err.Error()}
 	}
 	if len(reposPathList) == 0 {
 		return &Error{Code: 13, Msg: "No repositories are specified"}
 	}
 
-	err = cmd.doGet(reposPathList, lockJSON)
+	err = cmd.doGet(reposPathList, cmdctx.LockJSON)
 	if err != nil {
 		return &Error{Code: 20, Msg: err.Error()}
 	}
diff --git a/subcmd/help.go b/subcmd/help.go
@@ -99,7 +99,8 @@ Command
 	return fs
 }
 
-func (cmd *helpCmd) Run(args []string) *Error {
+func (cmd *helpCmd) Run(cmdctx *CmdContext) *Error {
+	args := cmdctx.Args
 	if len(args) == 0 {
 		cmd.FlagSet().Usage()
 		return nil
@@ -112,7 +113,7 @@ func (cmd *helpCmd) Run(args []string) *Error {
 	if !exists {
 		return &Error{Code: 1, Msg: fmt.Sprintf("Unknown command '%s'", args[0])}
 	}
-	args = append([]string{"-help"}, args[1:]...)
-	fs.Run(args)
+	cmdctx.Args = append([]string{"-help"}, args[1:]...)
+	fs.Run(cmdctx)
 	return nil
 }
diff --git a/subcmd/list.go b/subcmd/list.go
@@ -125,9 +125,9 @@ repos path:
 `
 }
 
-func (cmd *listCmd) Run(args []string) *Error {
+func (cmd *listCmd) Run(cmdctx *CmdContext) *Error {
 	fs := cmd.FlagSet()
-	fs.Parse(args)
+	fs.Parse(cmdctx.Args)
 	if cmd.helped {
 		return nil
 	}
diff --git a/subcmd/migrate.go b/subcmd/migrate.go
@@ -55,8 +55,8 @@ Available operations`)
 	return fs
 }
 
-func (cmd *migrateCmd) Run(args []string) *Error {
-	op, err := cmd.parseArgs(args)
+func (cmd *migrateCmd) Run(cmdctx *CmdContext) *Error {
+	op, err := cmd.parseArgs(cmdctx.Args)
 	if err == ErrShowedHelp {
 		return nil
 	}
diff --git a/subcmd/profile.go b/subcmd/profile.go
@@ -100,9 +100,9 @@ Quick example
 	return fs
 }
 
-func (cmd *profileCmd) Run(args []string) *Error {
+func (cmd *profileCmd) Run(cmdctx *CmdContext) *Error {
 	// Parse args
-	args, err := cmd.parseArgs(args)
+	args, err := cmd.parseArgs(cmdctx.Args)
 	if err == ErrShowedHelp {
 		return nil
 	}
diff --git a/subcmd/rm.go b/subcmd/rm.go
@@ -63,8 +63,8 @@ Description
 	return fs
 }
 
-func (cmd *rmCmd) Run(args []string) *Error {
-	reposPathList, err := cmd.parseArgs(args)
+func (cmd *rmCmd) Run(cmdctx *CmdContext) *Error {
+	reposPathList, err := cmd.parseArgs(cmdctx.Args)
 	if err == ErrShowedHelp {
 		return nil
 	}
diff --git a/subcmd/self_upgrade.go b/subcmd/self_upgrade.go
@@ -50,8 +50,8 @@ Description
 	return fs
 }
 
-func (cmd *selfUpgradeCmd) Run(args []string) *Error {
-	err := cmd.parseArgs(args)
+func (cmd *selfUpgradeCmd) Run(cmdctx *CmdContext) *Error {
+	err := cmd.parseArgs(cmdctx.Args)
 	if err == ErrShowedHelp {
 		return nil
 	}
diff --git a/subcmd/version.go b/subcmd/version.go
@@ -40,9 +40,9 @@ Description
 	return fs
 }
 
-func (cmd *versionCmd) Run(args []string) *Error {
+func (cmd *versionCmd) Run(cmdctx *CmdContext) *Error {
 	fs := cmd.FlagSet()
-	fs.Parse(args)
+	fs.Parse(cmdctx.Args)
 	if cmd.helped {
 		return nil
 	}

Original file line number	Diff line number	Diff line change
`@@ -53,10 +53,10 @@ Description`
`53`	`53`	`return fs`
`54`	`54`	`}`
`55`	`55`
`56`		`-func (cmd buildCmd) Run(args []string) Error {`
	`56`	`+func (cmd buildCmd) Run(cmdctx CmdContext) *Error {`
`57`	`57`	`// Parse args`
`58`	`58`	`fs := cmd.FlagSet()`
`59`		`- fs.Parse(args)`
	`59`	`+ fs.Parse(cmdctx.Args)`
`60`	`60`	`if cmd.helped {`
`61`	`61`	`return nil`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,8 +41,8 @@ Description`
`41`	`41`	`return fs`
`42`	`42`	`}`
`43`	`43`
`44`		`-func (cmd disableCmd) Run(args []string) Error {`
`45`		`- reposPathList, err := cmd.parseArgs(args)`
	`44`	`+func (cmd disableCmd) Run(cmdctx CmdContext) *Error {`
	`45`	`+ reposPathList, err := cmd.parseArgs(cmdctx.Args)`
`46`	`46`	`if err == ErrShowedHelp {`
`47`	`47`	`return nil`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
@@ -116,31 +116,25 @@ Options`)
`116`	`116`	`return fs`
`117`	`117`	`}`
`118`	`118`
`119`		`-func (cmd getCmd) Run(args []string) Error {`
	`119`	`+func (cmd getCmd) Run(cmdctx CmdContext) *Error {`
`120`	`120`	`// Parse args`
`121`		`- args, err := cmd.parseArgs(args)`
	`121`	`+ args, err := cmd.parseArgs(cmdctx.Args)`
`122`	`122`	`if err == ErrShowedHelp {`
`123`	`123`	`return nil`
`124`	`124`	`}`
`125`	`125`	`if err != nil {`
`126`	`126`	`return &Error{Code: 10, Msg: "Failed to parse args: " + err.Error()}`
`127`	`127`	`}`
`128`	`128`
`129`		`- // Read lock.json`
`130`		`- lockJSON, err := lockjson.Read()`
`131`		`- if err != nil {`
`132`		`- return &Error{Code: 11, Msg: "Could not read lock.json: " + err.Error()}`
`133`		`- }`
`134`		`-`
`135`		`- reposPathList, err := cmd.getReposPathList(args, lockJSON)`
	`129`	`+ reposPathList, err := cmd.getReposPathList(args, cmdctx.LockJSON)`
`136`	`130`	`if err != nil {`
`137`	`131`	`return &Error{Code: 12, Msg: "Could not get repos list: " + err.Error()}`
`138`	`132`	`}`
`139`	`133`	`if len(reposPathList) == 0 {`
`140`	`134`	`return &Error{Code: 13, Msg: "No repositories are specified"}`
`141`	`135`	`}`
`142`	`136`
`143`		`- err = cmd.doGet(reposPathList, lockJSON)`
	`137`	`+ err = cmd.doGet(reposPathList, cmdctx.LockJSON)`
`144`	`138`	`if err != nil {`
`145`	`139`	`return &Error{Code: 20, Msg: err.Error()}`
`146`	`140`	`}`
Original file line number	Diff line number	Diff line change
`@@ -99,7 +99,8 @@ Command`
`99`	`99`	`return fs`
`100`	`100`	`}`
`101`	`101`
`102`		`-func (cmd helpCmd) Run(args []string) Error {`
	`102`	`+func (cmd helpCmd) Run(cmdctx CmdContext) *Error {`
	`103`	`+ args := cmdctx.Args`
`103`	`104`	`if len(args) == 0 {`
`104`	`105`	`cmd.FlagSet().Usage()`
`105`	`106`	`return nil`
`@@ -112,7 +113,7 @@ func (cmd helpCmd) Run(args []string) Error {`
`112`	`113`	`if !exists {`
`113`	`114`	`return &Error{Code: 1, Msg: fmt.Sprintf("Unknown command '%s'", args[0])}`
`114`	`115`	`}`
`115`		`- args = append([]string{"-help"}, args[1:]...)`
`116`		`- fs.Run(args)`
	`116`	`+ cmdctx.Args = append([]string{"-help"}, args[1:]...)`
	`117`	`+ fs.Run(cmdctx)`
`117`	`118`	`return nil`
`118`	`119`	`}`
Original file line number	Diff line number	Diff line change
`@@ -125,9 +125,9 @@ repos path:`
`125`	`125`	`
`126`	`126`	`}`
`127`	`127`
`128`		`-func (cmd listCmd) Run(args []string) Error {`
	`128`	`+func (cmd listCmd) Run(cmdctx CmdContext) *Error {`
`129`	`129`	`fs := cmd.FlagSet()`
`130`		`- fs.Parse(args)`
	`130`	`+ fs.Parse(cmdctx.Args)`
`131`	`131`	`if cmd.helped {`
`132`	`132`	`return nil`
`133`	`133`	`}`
Original file line number	Diff line number	Diff line change
@@ -55,8 +55,8 @@ Available operations`)
`55`	`55`	`return fs`
`56`	`56`	`}`
`57`	`57`
`58`		`-func (cmd migrateCmd) Run(args []string) Error {`
`59`		`- op, err := cmd.parseArgs(args)`
	`58`	`+func (cmd migrateCmd) Run(cmdctx CmdContext) *Error {`
	`59`	`+ op, err := cmd.parseArgs(cmdctx.Args)`
`60`	`60`	`if err == ErrShowedHelp {`
`61`	`61`	`return nil`
`62`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -100,9 +100,9 @@ Quick example`
`100`	`100`	`return fs`
`101`	`101`	`}`
`102`	`102`
`103`		`-func (cmd profileCmd) Run(args []string) Error {`
	`103`	`+func (cmd profileCmd) Run(cmdctx CmdContext) *Error {`
`104`	`104`	`// Parse args`
`105`		`- args, err := cmd.parseArgs(args)`
	`105`	`+ args, err := cmd.parseArgs(cmdctx.Args)`
`106`	`106`	`if err == ErrShowedHelp {`
`107`	`107`	`return nil`
`108`	`108`	`}`