Implement CLI / Config with Cobra / Viper

.golangci.yml

@@ -56,6 +56,7 @@ linters-settings:
         allow:
           - "$gostd"
           - "github.com/ansible/receptor/internal/version"
+          - "github.com/ansible/receptor/cmd"
           - "github.com/ansible/receptor/pkg"
           - "github.com/creack/pty"
           - "github.com/fsnotify/fsnotify"
@@ -70,6 +71,8 @@ linters-settings:
           - "github.com/rogpeppe/go-internal/lockedfile"
           - "github.com/songgao/water"
           - "github.com/vishvananda/netlink"
+          - "github.com/spf13/viper"
+          - "github.com/spf13/cobra"
           - "k8s.io/api/core"
           - "k8s.io/apimachinery/pkg"
           - "k8s.io/client-go"

Makefile

@@ -117,10 +117,6 @@ build-all:
 		./cmd/receptor-cl && \
 	$(GO) build \
 		example/*.go && \
-	$(GO) build \
-		-o receptor \
-		--tags no_backends,no_services,no_tls_config \
-		./cmd/receptor-cl && \
 	$(GO) build \
 		-o receptor \
 		-ldflags "-X 'github.com/ansible/receptor/internal/version.Version=$(VERSION)'" \

cmd/config.go

@@ -0,0 +1,217 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"reflect"
+
+	"github.com/ansible/receptor/pkg/backends"
+	"github.com/ansible/receptor/pkg/certificates"
+	"github.com/ansible/receptor/pkg/controlsvc"
+	"github.com/ansible/receptor/pkg/logger"
+	"github.com/ansible/receptor/pkg/netceptor"
+	"github.com/ansible/receptor/pkg/services"
+	"github.com/ansible/receptor/pkg/types"
+	"github.com/ansible/receptor/pkg/workceptor"
+	"github.com/ghjm/cmdline"
+	"github.com/spf13/viper"
+)
+
+type Initer interface {
+	Init() error
+}
+
+type Preparer interface {
+	Prepare() error
+}
+
+type Runer interface {
+	Run() error
+}
+
+type ReceptorConfig struct {
+	// Used pointer structs to apply defaults to config
+	Node              *types.NodeCfg
+	Trace             logger.TraceCfg
+	LocalOnly         backends.NullBackendCfg          `mapstructure:"local-only"`
+	LogLevel          *logger.LoglevelCfg              `mapstructure:"log-level"`
+	ControlServices   []*controlsvc.CmdlineConfigUnix  `mapstructure:"control-services"`
+	TCPPeers          []*backends.TCPDialerCfg         `mapstructure:"tcp-peers"`
+	UDPPeers          []*backends.UDPDialerCfg         `mapstructure:"udp-peers"`
+	WSPeers           []*backends.WebsocketDialerCfg   `mapstructure:"ws-peers"`
+	TCPListeners      []*backends.TCPListenerCfg       `mapstructure:"tcp-listeners"`
+	UDPListeners      []*backends.UDPListenerCfg       `mapstructure:"udp-listeners"`
+	WSListeners       []*backends.WebsocketListenerCfg `mapstructure:"ws-listeners"`
+	TLSClients        []netceptor.TLSClientConfig      `mapstructure:"tls-clients"`
+	TLSServer         []netceptor.TLSServerConfig      `mapstructure:"tls-servers"`
+	WorkCommands      []workceptor.CommandWorkerCfg    `mapstructure:"work-commands"`
+	WorkKubernetes    []*workceptor.KubeWorkerCfg      `mapstructure:"work-kubernetes"`
+	WorkSigning       workceptor.SigningKeyPrivateCfg  `mapstructure:"work-signing"`
+	WorkVerification  workceptor.VerifyingKeyPublicCfg `mapstructure:"work-verification"`
+	IPRouters         []services.IPRouterCfg
+	TCPClients        []services.TCPProxyOutboundCfg  `mapstructure:"tcp-clients"`
+	TCPServers        []services.TCPProxyInboundCfg   `mapstructure:"tcp-servers"`
+	UDPClients        []services.TCPProxyInboundCfg   `mapstructure:"udp-clients"`
+	UDPServers        []services.TCPProxyInboundCfg   `mapstructure:"udp-servers"`
+	UnixSocketClients []services.UnixProxyOutboundCfg `mapstructure:"unix-socket-clients"`
+	UnixSocketServers []services.UnixProxyInboundCfg  `mapstructure:"unix-socket-servers"`
+}
+
+type CertificatesConfig struct {
+	InitCA  certificates.InitCAConfig    `mapstructure:"cert-init"`
+	MakeReq []certificates.MakeReqConfig `mapstructure:"cert-makereqs"`
+	SignReq []certificates.SignReqConfig `mapstructure:"cert-signreqs"`
+}
+
+func PrintPhaseErrorMessage(configName string, phase string, err error) {
+	fmt.Printf("ERROR: %s for %s on %s phase\n", err, configName, phase)
+}
+
+func ParseConfigs(configFile string) (*ReceptorConfig, *CertificatesConfig, error) {
+	if configFile == "" && viper.ConfigFileUsed() == "" {
+		fmt.Fprintln(os.Stderr, "Could not locate config file (default is $HOME/receptor.yaml)")
+		os.Exit(1)
+	}
+	var receptorConfig ReceptorConfig
+	var certifcatesConfig CertificatesConfig
+	err := viper.Unmarshal(&receptorConfig)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	err = viper.Unmarshal(&certifcatesConfig)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	return &receptorConfig, &certifcatesConfig, nil
+}
+
+func isConfigEmpty(v reflect.Value) bool {
+	isEmpty := true
+	for i := 0; i < v.NumField(); i++ {
+		if reflect.Value.IsZero(v.Field(i)) {
+			continue
+		}
+		isEmpty = false
+	}
+
+	return isEmpty
+}
+
+func RunConfigV2(v reflect.Value) {
+	phases := []string{"Init", "Prepare", "Run"}
+
+	for _, phase := range phases {
+		for i := 0; i < v.NumField(); i++ {
+			if reflect.Value.IsZero(v.Field(i)) {
+				continue
+			}
+
+			switch v.Field(i).Kind() {
+			case reflect.Slice:
+				for j := 0; j < v.Field(i).Len(); j++ {
+					RunPhases(phase, v.Field(i).Index(j))
+				}
+			default:
+				RunPhases(phase, v.Field(i))
+			}
+		}
+	}
+}
+
+// RunPhases runs the appropriate function (Init, Prepare, Run) on a command.
+func RunPhases(phase string, v reflect.Value) {
+	cmd := v.Interface()
+	var err error
+
+	if phase == "Init" {
+		switch c := cmd.(type) {
+		case Initer:
+			err = c.Init()
+			if err != nil {
+				PrintPhaseErrorMessage(v.Type().Name(), phase, err)
+			}
+		default:
+		}
+	}
+	if phase == "Prepare" {
+		switch c := cmd.(type) {
+		case Preparer:
+			err = c.Prepare()
+			if err != nil {
+				PrintPhaseErrorMessage(v.Type().Name(), phase, err)
+			}
+		default:
+		}
+	}
+	if phase == "Run" {
+		switch c := cmd.(type) {
+		case Runer:
+			err = c.Run()
+			if err != nil {
+				PrintPhaseErrorMessage(v.Type().Name(), phase, err)
+			}
+		default:
+		}
+	}
+}
+
+func RunConfigV1() {
+	cl := cmdline.NewCmdline()
+	cl.AddConfigType("node", "Specifies the node configuration of this instance", types.NodeCfg{}, cmdline.Required, cmdline.Singleton)
+	cl.AddConfigType("local-only", "Runs a self-contained node with no backend", backends.NullBackendCfg{}, cmdline.Singleton)
+
+	// Add registered config types from imported modules
+	for _, appName := range []string{
+		"receptor-version",
+		"receptor-logging",
+		"receptor-tls",
+		"receptor-certificates",
+		"receptor-control-service",
+		"receptor-command-service",
+		"receptor-ip-router",
+		"receptor-proxies",
+		"receptor-backends",
+		"receptor-workers",
+	} {
+		cl.AddRegisteredConfigTypes(appName)
+	}
+
+	osArgs := os.Args[1:]
+
+	err := cl.ParseAndRun(osArgs, []string{"Init", "Prepare", "Run"}, cmdline.ShowHelpIfNoArgs)
+	if err != nil {
+		fmt.Printf("Error: %s\n", err)
+		os.Exit(1)
+	}
+	if cl.WhatRan() != "" {
+		// We ran an exclusive command, so we aren't starting any back-ends
+		os.Exit(0)
+	}
+
+	configPath := ""
+	for i, arg := range osArgs {
+		if arg == "--config" || arg == "-c" {
+			if len(osArgs) > i+1 {
+				configPath = osArgs[i+1]
+			}
+
+			break
+		}
+	}
+
+	// only allow reloading if a configuration file was provided. If ReloadCL is
+	// not set, then the control service reload command will fail
+	if configPath != "" {
+		// create closure with the passed in args to be ran during a reload
+		reloadParseAndRun := func(toRun []string) error {
+			return cl.ParseAndRun(osArgs, toRun)
+		}
+		err = controlsvc.InitReload(configPath, reloadParseAndRun)
+		if err != nil {
+			fmt.Printf("Error: %s\n", err)
+			os.Exit(1)
+		}
+	}
+}

cmd/defaults.go

@@ -0,0 +1,122 @@
+package cmd
+
+func SetTCPListenerDefaults(config *ReceptorConfig) {
+	for _, listener := range config.TCPListeners {
+		if listener.Cost == 0 {
+			listener.Cost = 1.0
+		}
+		if listener.BindAddr == "" {
+			listener.BindAddr = "0.0.0.0"
+		}
+	}
+}
+
+func SetUDPListenerDefaults(config *ReceptorConfig) {
+	for _, listener := range config.UDPListeners {
+		if listener.Cost == 0 {
+			listener.Cost = 1.0
+		}
+		if listener.BindAddr == "" {
+			listener.BindAddr = "0.0.0.0"
+		}
+	}
+}
+
+func SetWSListenerDefaults(config *ReceptorConfig) {
+	for _, listener := range config.WSListeners {
+		if listener.Cost == 0 {
+			listener.Cost = 1.0
+		}
+		if listener.BindAddr == "" {
+			listener.BindAddr = "0.0.0.0"
+		}
+		if listener.Path == "" {
+			listener.BindAddr = "/"
+		}
+	}
+}
+
+func SetUDPPeerDefaults(config *ReceptorConfig) {
+	for _, peer := range config.TCPPeers {
+		if peer.Cost == 0 {
+			peer.Cost = 1.0
+		}
+
+		if !peer.Redial {
+			peer.Redial = true
+		}
+	}
+}
+
+func SetTCPPeerDefaults(config *ReceptorConfig) {
+	for _, peer := range config.TCPPeers {
+		if peer.Cost == 0 {
+			peer.Cost = 1.0
+		}
+
+		if !peer.Redial {
+			peer.Redial = true
+		}
+	}
+}
+
+func SetWSPeerDefaults(config *ReceptorConfig) {
+	for _, peer := range config.WSPeers {
+		if peer.Cost == 0 {
+			peer.Cost = 1.0
+		}
+
+		if !peer.Redial {
+			peer.Redial = true
+		}
+	}
+}
+
+func SetCmdlineUnixDefaults(config *ReceptorConfig) {
+	for _, service := range config.ControlServices {
+		if service.Permissions == 0 {
+			service.Permissions = 0o600
+		}
+
+		if service.Service == "" {
+			service.Service = "control"
+		}
+	}
+}
+
+func SetLogLevelDefaults(config *ReceptorConfig) {
+	if config.LogLevel.Level == "" {
+		config.LogLevel.Level = "error"
+	}
+}
+
+func SetNodeDefaults(config *ReceptorConfig) {
+	if config.Node.DataDir == "" {
+		config.Node.DataDir = "/tmp/receptor"
+	}
+}
+
+func SetKubeWorkerDefaults(config *ReceptorConfig) {
+	for _, worker := range config.WorkKubernetes {
+		if worker.AuthMethod == "" {
+			worker.AuthMethod = "incluster"
+		}
+
+		if worker.StreamMethod == "" {
+			worker.StreamMethod = "logger"
+		}
+	}
+}
+
+func SetConfigDefaults(config *ReceptorConfig) {
+	SetTCPListenerDefaults(config)
+	SetUDPListenerDefaults(config)
+	SetWSListenerDefaults(config)
+	SetTCPPeerDefaults(config)
+	SetUDPPeerDefaults(config)
+	SetWSPeerDefaults(config)
+	SetCmdlineUnixDefaults(config)
+	SetLogLevelDefaults(config)
+	SetNodeDefaults(config)
+	SetKubeWorkerDefaults(config)
+}