Add dce auth; refactor config mgmt, refactor tests

Stuff going on here

- Add `dce auth` command
  - pops you out to a browser at the `/auth` endpoint that @joshmarsh is working on
  - see #33
- Remove dce.yml configs we aren't using
- Configure a AWS creds provider that will load creds from the auth token, but fallback to env vars or the `~/.aws/credentials` file
- Run `dce auth` before any command, if we don't have any valid creds in our chain
- Refactor how to load and save our config YAML, so it's easier to work with from inside multiple commands
- Remove viper dependency (wasn't really being used)
- Some other cleanup/refactor around init logic, to get this all wired up properly
  - I'll try to point these out in the code
- New setup for integration tests
  - These test call our cobra CLI programmatically. For some reasons:
    - Lets us use debugger to run through tests
    - Don't need to rebuild for every test run
    - Can still use mocks at boundaries (eg. mock out web browser call)
  - I'm hoping this new testing pattern makes it easier to write tests for CLI commands going forward.

.gitignore

@@ -51,4 +51,6 @@ override.tf.json
 # Other stuff
 *.zip
 
-junit-report/
+junit-report/
+
+dce-cli

cmd/accounts.go

@@ -33,7 +33,7 @@ var accountsDescribeCmd = &cobra.Command{
 	Short: "describe an account",
 	Args:  cobra.ExactValidArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		service.GetAccount(args[0])
+		Service.GetAccount(args[0])
 	},
 }
 
@@ -42,7 +42,7 @@ var accountsListCmd = &cobra.Command{
 	Short: "list accounts",
 	Args:  cobra.NoArgs,
 	Run: func(cmd *cobra.Command, args []string) {
-		service.ListAccounts()
+		Service.ListAccounts()
 	},
 }
 
@@ -51,7 +51,7 @@ var accountsAddCmd = &cobra.Command{
 	Short: "Add an account to the accounts pool",
 	Args:  cobra.NoArgs,
 	Run: func(cmd *cobra.Command, args []string) {
-		service.AddAccount(accountID, adminRoleARN)
+		Service.AddAccount(accountID, adminRoleARN)
 	},
 }
 
@@ -60,6 +60,6 @@ var accountsRemoveCmd = &cobra.Command{
 	Short: "Remove an account from the accounts pool.",
 	Args:  cobra.ExactValidArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		service.RemoveAccount(args[0])
+		Service.RemoveAccount(args[0])
 	},
 }

cmd/auth.go

@@ -4,17 +4,15 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var authUrl string
-
 func init() {
 	RootCmd.AddCommand(authCmd)
-	authCmd.Flags().StringVarP(&authUrl, "url-override", "u", "", "Override the DCE login url")
+	authCmd.Flags()
 }
 
 var authCmd = &cobra.Command{
 	Use:   "auth",
 	Short: "Login to dce",
-	Run: func(cmd *cobra.Command, args []string) {
-		service.Authenticate(authUrl)
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return Service.Authenticate()
 	},
 }

cmd/init.go

@@ -12,6 +12,6 @@ var initCmd = &cobra.Command{
 	Use:   "init",
 	Short: "First time DCE cli setup. Creates config file at ~/.dce.yaml",
 	Run: func(cmd *cobra.Command, args []string) {
-		service.InitializeDCE(cfgFile)
+		Service.InitializeDCE()
 	},
 }

cmd/leases.go

@@ -68,7 +68,7 @@ var leasesDescribeCmd = &cobra.Command{
 	Short: "describe a lease",
 	Args:  cobra.ExactValidArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		service.GetLease(args[0])
+		Service.GetLease(args[0])
 	},
 }
 
@@ -77,7 +77,7 @@ var leasesListCmd = &cobra.Command{
 	Short: "List leases using various query filters.",
 	Args:  cobra.NoArgs,
 	Run: func(cmd *cobra.Command, args []string) {
-		service.ListLeases(acctID, principalID, nextAcctID, nextPrincipalID, leaseStatus, pagLimit)
+		Service.ListLeases(acctID, principalID, nextAcctID, nextPrincipalID, leaseStatus, pagLimit)
 	},
 }
 
@@ -86,7 +86,7 @@ var leasesCreateCmd = &cobra.Command{
 	Short: "Create a lease.",
 	Args:  cobra.NoArgs,
 	Run: func(cmd *cobra.Command, args []string) {
-		service.CreateLease(principalID, budgetAmount, budgetCurrency, email)
+		Service.CreateLease(principalID, budgetAmount, budgetCurrency, email)
 	},
 }
 
@@ -95,7 +95,7 @@ var leasesEndCmd = &cobra.Command{
 	Short: "Cause a lease to immediately expire",
 	Args:  cobra.NoArgs,
 	Run: func(cmd *cobra.Command, args []string) {
-		service.EndLease(accountID, principalID)
+		Service.EndLease(accountID, principalID)
 	},
 }
 
@@ -104,6 +104,6 @@ var leasesLoginCmd = &cobra.Command{
 	Short: "Login to a leased DCE account. (Sets AWS CLI credentials if used with no flags)",
 	Args:  cobra.ExactArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
-		service.LoginToLease(args[0], loginProfile, loginOpenBrowser, loginPrintCreds)
+		Service.LoginToLease(args[0], loginProfile, loginOpenBrowser, loginPrintCreds)
 	},
 }

cmd/root.go

@@ -16,7 +16,9 @@ limitations under the License.
 package cmd
 
 import (
+	"errors"
 	"fmt"
+	"github.com/mitchellh/go-homedir"
 	"os"
 	"path/filepath"
 
@@ -27,18 +29,32 @@ import (
 	svc "github.com/Optum/dce-cli/pkg/service"
 	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
-	"github.com/spf13/viper"
 )
 
 var cfgFile string
-var config *configs.Root = &configs.Root{}
-var service *svc.ServiceContainer
-var util *utl.UtilContainer
-var observation *observ.ObservationContainer
+var Config = &configs.Root{}
+var Service *svc.ServiceContainer
+var Util *utl.UtilContainer
+var Observation *observ.ObservationContainer
+// Expose logger as global for ease of use
+var log observ.Logger
+var Log observ.Logger
 
 func init() {
-	cobra.OnInitialize(initObservation, initConfig, initUtil, initService)
-	RootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.dce.yaml)")
+	homeDir, err := homedir.Dir()
+	if err != nil {
+		log.Fatalf("error: %v", err)
+	}
+
+	// Global Flags
+	// ---------------
+	// --config flag, to specify path to dce.yml config
+	// default to ~/.dce.yml
+	RootCmd.PersistentFlags().StringVar(
+		&cfgFile, "config",
+		filepath.Join(homeDir, constants.DefaultConfigFileName),
+		"config file",
+	)
 }
 
 // RootCmd represents the base command when called without any subcommands
@@ -51,28 +67,84 @@ var RootCmd = &cobra.Command{
 
   - Admins to provision DCE to a master account and administer said account
   - Users to lease accounts and execute commands against them`,
+  PersistentPreRunE: preRun,
+}
+
+func preRun(cmd *cobra.Command, args []string) error {
+	err := onInit(cmd, args)
+	if err != nil {
+		return err
+	}
+
+	// Check if the user has valid creds,
+	// otherwise require authentication
+	creds := Util.AWSSession.Config.Credentials
+	_, _ = creds.Get()
+	hasValidCreds := !creds.IsExpired()
+	isAuthCommand := cmd.Name() == authCmd.Name()
+	isInitCommand := cmd.Name() == initCmd.Name()
+	if !hasValidCreds && !isAuthCommand && !isInitCommand {
+		log.Print("No valid DCE credentials found")
+		err := Service.Authenticate()
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
 func Execute() {
 	if err := RootCmd.Execute(); err != nil {
-		fmt.Println(err)
 		os.Exit(1)
 	}
+	// Print an extra newline when we're done,
+	// so users terminal prompt shows up on a new line
+	fmt.Println("")
 }
 
 type FmtOutputFormatter struct {
 }
 
 func (f *FmtOutputFormatter) Format(entry *logrus.Entry) ([]byte, error) {
 	var serialized []byte
-	var err error
 	serialized = []byte(entry.Message)
-	if err != nil {
-		return nil, fmt.Errorf("Failed to marshal fields to JSON, %v", err)
+	//fmt.Println(string(serialized))
+	return serialized, nil
+}
+
+func onInit(cmd *cobra.Command, args []string) error {
+	// Configure observation / logging
+	initObservation()
+	// Expose global `log` object for ease of use
+	log = Observation.Logger
+	Log = log
+
+	fsUtil := &utl.FileSystemUtil{Config: Config, ConfigFile: cfgFile}
+
+	// Initialize config
+	// If config file does not exist,
+	// run the `dce init` command
+	if !fsUtil.IsExistingFile(cfgFile) {
+		if cmd.Name() != initCmd.Name() {
+			return errors.New("Config file not found. Please type 'dce init' to generate one.")
+		}
+	} else {
+		// Load config from dce.yaml
+		err := fsUtil.ReadInConfig()
+		if err != nil {
+			return fmt.Errorf("Failed to parse dce.yml: %s", err)
+		}
 	}
-	fmt.Println(string(serialized))
-	return nil, nil
+
+	// initialize utilities and interfaces to external things
+	Util = utl.New(Config, cfgFile, Observation)
+
+	// initialize business logic services
+	Service = svc.New(Config, Observation, Util)
+
+	return nil
 }
 
 // initialize anything related to logging, metrics, or tracing
@@ -107,48 +179,5 @@ func initObservation() {
 		logrusInstance.SetFormatter(&logrus.TextFormatter{})
 	}
 
-	observation = observ.New(logrusInstance)
-}
-
-// Utils we need before they are normally instantiated
-var log observ.Logger
-var fsUtil utl.FileSystemer
-
-// initialize config from file or tell user to run 'dce init' if none exists
-func initConfig() {
-
-	tempUtil := utl.New(config, observation)
-	fsUtil = tempUtil.FileSystemer
-	log = observation.Logger
-
-	var configFileUsed string
-	if cfgFile != "" {
-		configFileUsed = cfgFile
-		viper.SetConfigFile(configFileUsed)
-	} else {
-		home := fsUtil.GetHomeDir()
-		configFileUsed = filepath.Join(home, constants.DefaultConfigFileName)
-		viper.SetConfigFile(configFileUsed)
-	}
-
-	if !fsUtil.IsExistingFile(configFileUsed) {
-		if len(os.Args) < 2 || os.Args[1] != initCmd.Name() {
-			log.Endln("Config file not found. Please type 'dce init' to generate one.")
-		}
-	} else {
-		if err := viper.ReadInConfig(); err == nil {
-			viper.BindEnv("githubtoken", "GITHUB_TOKEN")
-			viper.Unmarshal(config)
-		}
-	}
-}
-
-// initialize utilities and interfaces to external things
-func initUtil() {
-	util = utl.New(config, observation)
-}
-
-// initialize business logic
-func initService() {
-	service = svc.New(config, observation, util)
-}
+	Observation = observ.New(logrusInstance)
+}

cmd/system.go

@@ -36,6 +36,6 @@ var systemDeployCmd = &cobra.Command{
 	Use:   "deploy",
 	Short: "Deploy DCE to a new master account",
 	Run: func(cmd *cobra.Command, args []string) {
-		service.Deploy(deployLocalPath, &deployOverrides)
+		Service.Deploy(deployLocalPath, &deployOverrides)
 	},
 }

cmd/usage.go

@@ -20,6 +20,6 @@ var usageCmd = &cobra.Command{
 	Short: "View lease budget information",
 	Args:  cobra.NoArgs,
 	Run: func(cmd *cobra.Command, args []string) {
-		service.GetUsage(startDate, endDate)
+		Service.GetUsage(startDate, endDate)
 	},
 }

configs/config.go

@@ -2,17 +2,17 @@ package configs
 
 // Root contains config
 type Root struct {
-	System struct {
-		Auth struct {
-			LoginURL *string
-		}
-	}
-	API struct {
-		Host     *string
-		BasePath *string
-	}
+	API API
 	Region      *string
-	GithubToken *string
+	GithubToken *string `yaml:"githubToken,omitempty"`
+}
+
+type API struct {
+	Host     *string
+	BasePath *string
+	// Token for authenticating against the API
+	// token is base64 encoded JSON, containing an STS token.
+	Token *string `yaml:"token,omitempty"`
 }
 
 var Regions = []string{"us-east-1", "us-east-2", "us-west-1", "us-west-2"}