Refactor things to be clean and private

Author: splittingred

bonvoy.go

@@ -6,34 +6,8 @@ import (
 	"os"
 )
 
-//func root(args[] string) error {
-//	var cmds = commands.All()
-//	subcommand := os.Args[1]
-//
-//	for _, cmd := range cmds {
-//		if cmd.Name() == subcommand {
-//			var err = cmd.Init(os.Args[2:])
-//			if err != nil {
-//				panic(err)
-//			}
-//			return cmd.Run()
-//		}
-//	}
-//	return fmt.Errorf("Unknown subcommand: %s", subcommand)
-//}
-
 func main() {
 	_ = os.Setenv("DOCKER_API_VERSION", "1.39")
 	config.Load()
-	commands.Init()
-	//if len(os.Args) < 2 {
-	//	fmt.Println("USAGE: bonvoy" +
-	//		"\n\tversion - Display bonvoy version" +
-	//		"\n\tlog-level [service] (level) - Set log level for a sidecar" +
-	//		"\n\tcerts-expired - Display expired certificates compared to Consul agent for a sidecar" +
-	//		"\n\tlisteners [service] - Display all listeners for sidecar")
-	//} else if err := root(os.Args[1:]); err != nil {
-	//	fmt.Println(err)
-	//	os.Exit(1)
-	//}
+	commands.NewRegistry().Init()
 }

commands/certificates.go

@@ -8,25 +8,40 @@ import (
 	"strings"
 )
 
-type ExpiredCertificatesController struct {
-	ServiceName string
-	Consul consul.Client
+type Certificates struct {
+	Command *cobra.Command
+}
+
+func (r *Registry) Certificates() *Certificates {
+	cmd := &cobra.Command{
+		Use: "certificates",
+		Short: "Certificates-related commands",
+	}
+	cmd.AddCommand(r.BuildExpiredCertificatesCommand())
+	return &Certificates{
+		Command: cmd,
+	}
 }
 
-func BuildExpiredCertificatesController(rootCmd *cobra.Command) {
-	rootCmd.AddCommand(&cobra.Command{
-		Use: "certificates expired",
+func (r *Registry) BuildExpiredCertificatesCommand() *cobra.Command {
+	return &cobra.Command{
+		Use: "expired",
 		Short: "Show all expired certificates",
 		Long:  `Display all expired sidecar certificates as compared to the local Consul agent`,
-		Args: cobra.MinimumNArgs(2),
+		Args: cobra.MinimumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			controller := ExpiredCertificatesController{
-				ServiceName: args[1],
+				ServiceName: args[0],
 				Consul: consul.NewClient(),
 			}
 			return controller.Run()
 		},
-	})
+	}
+}
+
+type ExpiredCertificatesController struct {
+	ServiceName string
+	Consul consul.Client
 }
 
 func (c *ExpiredCertificatesController) Run() error {

commands/listeners.go

@@ -2,28 +2,33 @@ package commands
 
 import (
 	"bonvoy/envoy"
-	"flag"
 	"fmt"
 	"github.com/spf13/cobra"
 )
 
-type ListenersController struct {
-	ServiceName string
+type Listeners struct {
+	Command *cobra.Command
 }
 
-func BuildListenersCommand(rootCmd *cobra.Command) {
-	rootCmd.AddCommand(&cobra.Command{
-		Use: "listeners",
-		Short: "Show Envoy listeners",
-		Long:  `Display all registered Envoy sidecar listeners`,
-		Args: cobra.MinimumNArgs(2),
-		RunE: func(cmd *cobra.Command, args []string) error {
-			controller := ListenersController{
-				ServiceName: args[1],
-			}
-			return controller.Run()
+func (r *Registry) Listeners() *Listeners {
+	return &Listeners{
+		Command: &cobra.Command{
+			Use: "listeners",
+			Short: "Show Envoy listeners",
+			Long:  `Display all registered Envoy sidecar listeners`,
+			Args: cobra.MinimumNArgs(1),
+			RunE: func(cmd *cobra.Command, args []string) error {
+				controller := ListenersController{
+					ServiceName: args[0],
+				}
+				return controller.Run()
+			},
 		},
-	})
+	}
+}
+
+type ListenersController struct {
+	ServiceName string
 }
 
 func (s *ListenersController) Run() error {
@@ -38,8 +43,4 @@ func (s *ListenersController) Run() error {
 		fmt.Printf("%s: %s\n", listener.Name, listener.TargetAddress)
 	}
 	return nil
-}
-type ListenersCommand struct {
-	fs *flag.FlagSet
-	name string
 }

commands/logging.go

@@ -7,40 +7,57 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var (
-	logLevel string
-)
+type Logging struct {
+	Command *cobra.Command
+}
 
-type SetLogLevelController struct {
-	ServiceName string
+func (r *Registry) Logging() *Logging {
+	cmd := &cobra.Command{
+		Use: "log",
+		Short: "Logging related commands",
+	}
+	cmd.AddCommand(r.BuildSetLogLevelCommand())
+	return &Logging{
+		Command: cmd,
+	}
 }
 
-func BuildSetLogLevelCommand(rootCmd *cobra.Command) {
+// log level
+
+var (
+	desiredLogLevel string
+)
+
+func (r *Registry) BuildSetLogLevelCommand() *cobra.Command {
 	cmd := &cobra.Command{
-		Use: "log level",
+		Use: "level",
 		Short: "Set Envoy log level",
 		Long:  `Set the Envoy sidecar log level`,
-		Args: cobra.MinimumNArgs(2),
+		Args: cobra.MinimumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			controller := SetLogLevelController{
-				ServiceName: args[1],
+				ServiceName: args[0],
 			}
 			return controller.Run()
 		},
 	}
-	cmd.Flags().StringVarP(&logLevel, "level", "l", "", "Desired log level (debug/info/warning/error")
-	rootCmd.AddCommand(cmd)
+	cmd.Flags().StringVarP(&desiredLogLevel, "level", "l", "", "Desired log level (debug/info/warning/error")
+	return cmd
+}
+
+type SetLogLevelController struct {
+	ServiceName string
 }
 
 func (c *SetLogLevelController) Run() error {
-	if logLevel == "" {
-		logLevel = c.SelectLogLevel()
+	if desiredLogLevel == "" {
+		desiredLogLevel = c.SelectLogLevel()
 	}
 	e, err := envoy.NewFromServiceName(c.ServiceName)
 	if err != nil {
 		return err
 	}
-	e.Logging().SetLevel(logLevel)
+	e.Logging().SetLevel(desiredLogLevel)
 	return nil
 }
 

commands/registry.go

@@ -6,39 +6,30 @@ import (
 	"os"
 )
 
+type Registry struct {}
+
+func NewRegistry() *Registry {
+	return &Registry{}
+}
+
 var rootCmd = &cobra.Command{
 	Use:   "bonvoy",
 	Short: "Envoy and Consul Connect interaction",
-	Long: ``,
-	Run: func(cmd *cobra.Command, args []string) {
-
-	},
 }
 
-func Init() {
-	BuildServerInfoCommand(rootCmd)
-	BuildSetLogLevelCommand(rootCmd)
-	BuildListenersCommand(rootCmd)
-	BuildExpiredCertificatesController(rootCmd)
-	BuildVersionCommand(rootCmd)
+func (r *Registry) Init() {
+	r.RegisterCommands()
 	if err := rootCmd.Execute(); err != nil {
 		_, _ = fmt.Fprintln(os.Stderr, err)
 		os.Exit(1)
 	}
 }
 
-//type Runner interface {
-//	Init([]string) error
-//	Run() error
-//	Name() string
-//}
-//
-//func All() []Runner {
-//	return []Runner{
-//		BuildListeners(),
-//		BuildVersion(),
-//		BuildExpiredCertificatesCommand(),
-//		BuildSetLogLevelCommand(),
-//		BuildServerInfoCommand(),
-//	}
-//}
+func (r *Registry) RegisterCommands() {
+	// Root level subcommands/commands
+	rootCmd.AddCommand(r.Server().Command)
+	rootCmd.AddCommand(r.Logging().Command)
+	rootCmd.AddCommand(r.Listeners().Command)
+	rootCmd.AddCommand(r.Certificates().Command)
+	rootCmd.AddCommand(r.Version().Command)
+}

commands/server_info.go commands/server.gocommands/server_info.go renamed to commands/server.go

@@ -8,23 +8,38 @@ import (
 	"os"
 )
 
-type ServerInfoController struct {
-	ServiceName string
+type Server struct {
+	Command *cobra.Command
+}
+
+func (r *Registry) Server() *Server {
+	cmd := &cobra.Command{
+		Use: "server",
+		Short: "Envoy server commands",
+	}
+	cmd.AddCommand(r.BuildServerInfoCommand())
+	return &Server{
+		Command: cmd,
+	}
 }
 
-func BuildServerInfoCommand(rootCmd *cobra.Command) {
-	rootCmd.AddCommand(&cobra.Command{
-		Use: "server info",
-		Short: "Envoy server information",
+func (r *Registry) BuildServerInfoCommand() *cobra.Command {
+	return &cobra.Command{
+		Use: "info",
+		Short: "Display envoy server information",
 		Long:  `Display server information about the envoy sidecar`,
-		Args: cobra.MinimumNArgs(2),
+		Args: cobra.MinimumNArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
 			controller := ServerInfoController{
-				ServiceName: args[1],
+				ServiceName: args[0],
 			}
 			return controller.Run()
 		},
-	})
+	}
+}
+
+type ServerInfoController struct {
+	ServiceName string
 }
 
 func (s *ServerInfoController) Run() error {

commands/version.go

@@ -6,14 +6,20 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func BuildVersionCommand(rootCmd *cobra.Command) {
-	rootCmd.AddCommand(&cobra.Command{
-		Use: "version",
-		Short: "Display Bonvoy version",
-		Long:  `Display the Bonvoy CLI version`,
-		RunE: func(cmd *cobra.Command, args []string) error {
-			fmt.Println(version.Version)
-			return nil
+type Version struct {
+	Command *cobra.Command
+}
+
+func (r *Registry) Version() *Version {
+	return &Version{
+		Command: &cobra.Command{
+			Use:   "version",
+			Short: "Display Bonvoy version",
+			Long:  `Display the Bonvoy CLI version`,
+			RunE: func(cmd *cobra.Command, args []string) error {
+				fmt.Println(version.Version)
+				return nil
+			},
 		},
-	})
+	}
 }

version/version.go

@@ -5,7 +5,7 @@ var GitCommit string
 var GitDescribe string
 
 // The main version number that is being run at the moment.
-const Version = "0.0.1"
+const Version = "0.0.2"
 
 // A pre-release marker for the version. If this is "" (empty string)
 // then it means that it is a final release. Otherwise, this is a pre-release