Move configuration package to go-sona-types for reuse (#200)

* use `configuration` package from go-sona-types

go.mod

@@ -22,7 +22,7 @@ require (
 	github.com/sdboyer/constext v0.0.0-20170321163424-836a14457353 // indirect
 	github.com/shopspring/decimal v1.2.0
 	github.com/sirupsen/logrus v1.6.0
-	github.com/sonatype-nexus-community/go-sona-types v0.0.7
+	github.com/sonatype-nexus-community/go-sona-types v0.0.8
 	github.com/spf13/afero v1.3.4 // indirect
 	github.com/spf13/cast v1.3.1 // indirect
 	github.com/spf13/cobra v1.0.0
@@ -34,7 +34,6 @@ require (
 	golang.org/x/sys v0.0.0-20200824131525-c12d262b63d8 // indirect
 	google.golang.org/protobuf v1.25.0 // indirect
 	gopkg.in/ini.v1 v1.60.1 // indirect
-	gopkg.in/yaml.v2 v2.3.0
 )
 
 // fix vulnerability: CVE-2020-15114 in etcd v3.3.13+incompatible

go.sum

@@ -240,8 +240,8 @@ github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1
 github.com/smartystreets/goconvey v1.6.4 h1:fv0U8FUIMPNf1L9lnHLvLhgicrIVChEkdzIKYqbNC9s=
 github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA=
 github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM=
-github.com/sonatype-nexus-community/go-sona-types v0.0.7 h1:ZH00KCTlLnI0LBIs+Juv9WBCtamKKdoFeryp1p5UB6s=
-github.com/sonatype-nexus-community/go-sona-types v0.0.7/go.mod h1:voGD7LEwz9TSvjZWNxST56pFPa0hdNQ71WsuMwBki3k=
+github.com/sonatype-nexus-community/go-sona-types v0.0.8 h1:6xb9BIC2w3y4kF/xQA25Zs6Yrl8ZqFkfH77AKPaG4RA=
+github.com/sonatype-nexus-community/go-sona-types v0.0.8/go.mod h1:uou8FGf9R5Nz1c6BfSM3v9K7g0R6faTYoxLh9Ybeht8=
 github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
 github.com/spf13/afero v1.1.2/go.mod h1:j4pytiNVoe2o6bmDsKpLACNPDBIoEAkihy7loJ1B0CQ=
 github.com/spf13/afero v1.3.4 h1:8q6vk3hthlpb2SouZcnBVKboxWQWMDNF38bwholZrJc=

internal/cmd/config.go

@@ -20,9 +20,10 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/sonatype-nexus-community/go-sona-types/configuration"
 	"github.com/sonatype-nexus-community/nancy/internal/customerrors"
+	"github.com/sonatype-nexus-community/nancy/internal/logger"
 
-	"github.com/sonatype-nexus-community/nancy/internal/configuration"
 	"github.com/spf13/cobra"
 )
 
@@ -47,7 +48,13 @@ func doConfig(cmd *cobra.Command, args []string) (err error) {
 		}
 	}()
 
-	if err = configuration.GetConfigFromCommandLine(os.Stdin); err != nil {
+	logLady = logger.GetLogger("", configOssi.LogLevel)
+	var configSet *configuration.ConfigSet
+	if configSet, err = configuration.New(logLady); err != nil {
+		panic(err)
+	}
+
+	if err = configSet.GetConfigFromCommandLine(os.Stdin); err != nil {
 		panic(err)
 	}
 	return

internal/cmd/iq.go

@@ -24,8 +24,9 @@ import (
 	"path"
 
 	"github.com/mitchellh/go-homedir"
+	"github.com/sonatype-nexus-community/go-sona-types/configuration"
 	"github.com/sonatype-nexus-community/go-sona-types/iq"
-	"github.com/sonatype-nexus-community/nancy/internal/configuration"
+	ossIndexTypes "github.com/sonatype-nexus-community/go-sona-types/ossindex/types"
 	"github.com/sonatype-nexus-community/nancy/internal/customerrors"
 	"github.com/sonatype-nexus-community/nancy/internal/logger"
 	"github.com/sonatype-nexus-community/nancy/packages"
@@ -179,7 +180,7 @@ func bindViperIq(cmd *cobra.Command) {
 	// need to defer bind call until command is run. see: https://github.com/spf13/viper/issues/233
 
 	// need to ensure ossi CLI flags will override ossi config file values when running IQ command
-	bindViper(rootCmd)
+	bindViperRootCmd()
 
 	// Bind viper to the flags passed in via the command line, so it will override config from file
 	if err := viper.BindPFlag(configuration.ViperKeyIQUsername, lookupFlagNotNil(flagNameIqUsername, cmd)); err != nil {
@@ -206,21 +207,21 @@ func initIQConfig() {
 	var cfgFileToCheck string
 	if cfgFileIQ != "" {
 		viper.SetConfigFile(cfgFileIQ)
-		viper.SetConfigType(configTypeYaml)
+		viper.SetConfigType(configuration.ConfigTypeYaml)
 		cfgFileToCheck = cfgFileIQ
 	} else {
 		home, err := homedir.Dir()
 		if err != nil {
 			fmt.Println(err)
 			os.Exit(1)
 		}
-		configPath := path.Join(home, types.IQServerDirName)
+		configPath := path.Join(home, ossIndexTypes.IQServerDirName)
 
 		viper.AddConfigPath(configPath)
-		viper.SetConfigType(configTypeYaml)
-		viper.SetConfigName(types.IQServerConfigFileName)
+		viper.SetConfigType(configuration.ConfigTypeYaml)
+		viper.SetConfigName(ossIndexTypes.IQServerConfigFileName)
 
-		cfgFileToCheck = path.Join(configPath, types.IQServerConfigFileName)
+		cfgFileToCheck = path.Join(configPath, ossIndexTypes.IQServerConfigFileName)
 	}
 
 	if fileExists(cfgFileToCheck) {

internal/cmd/iq_test.go

@@ -27,8 +27,9 @@ import (
 
 	"github.com/sirupsen/logrus"
 	"github.com/sirupsen/logrus/hooks/test"
+	"github.com/sonatype-nexus-community/go-sona-types/configuration"
 	"github.com/sonatype-nexus-community/go-sona-types/iq"
-	"github.com/sonatype-nexus-community/nancy/internal/configuration"
+	ossIndexTypes "github.com/sonatype-nexus-community/go-sona-types/ossindex/types"
 	"github.com/sonatype-nexus-community/nancy/internal/customerrors"
 	"github.com/sonatype-nexus-community/nancy/types"
 	"github.com/spf13/viper"
@@ -77,10 +78,10 @@ func TestIqCommandPathInvalidFile(t *testing.T) {
 }
 
 func setupIQConfigFile(t *testing.T, tempDir string) {
-	cfgDirIQ := path.Join(tempDir, types.IQServerDirName)
+	cfgDirIQ := path.Join(tempDir, ossIndexTypes.IQServerDirName)
 	assert.Nil(t, os.Mkdir(cfgDirIQ, 0700))
 
-	cfgFileIQ = path.Join(tempDir, types.IQServerDirName, types.IQServerConfigFileName)
+	cfgFileIQ = path.Join(tempDir, ossIndexTypes.IQServerDirName, ossIndexTypes.IQServerConfigFileName)
 }
 func resetIQConfigFile() {
 	cfgFileIQ = ""

internal/cmd/root.go

@@ -29,12 +29,11 @@ import (
 	"strings"
 	"time"
 
-	"github.com/sonatype-nexus-community/nancy/internal/configuration"
-
 	"github.com/common-nighthawk/go-figure"
 	"github.com/golang/dep"
 	"github.com/mitchellh/go-homedir"
 	"github.com/sirupsen/logrus"
+	"github.com/sonatype-nexus-community/go-sona-types/configuration"
 	"github.com/sonatype-nexus-community/go-sona-types/ossindex"
 	ossIndexTypes "github.com/sonatype-nexus-community/go-sona-types/ossindex/types"
 	"github.com/sonatype-nexus-community/nancy/buildversion"
@@ -178,14 +177,14 @@ func init() {
 	rootCmd.PersistentFlags().StringVarP(&configOssi.Path, "path", "p", "", "Specify a path to a dep "+GopkgLockFilename+" file for scanning")
 }
 
-func bindViper(cmd *cobra.Command) {
+func bindViperRootCmd() {
 	// need to defer bind call until command is run. see: https://github.com/spf13/viper/issues/233
 
 	// Bind viper to the flags passed in via the command line, so it will override config from file
-	if err := viper.BindPFlag(configuration.ViperKeyUsername, lookupPersistentFlagNotNil(flagNameOssiUsername, cmd)); err != nil {
+	if err := viper.BindPFlag(configuration.ViperKeyUsername, lookupPersistentFlagNotNil(flagNameOssiUsername, rootCmd)); err != nil {
 		panic(err)
 	}
-	if err := viper.BindPFlag(configuration.ViperKeyToken, lookupPersistentFlagNotNil(flagNameOssiToken, cmd)); err != nil {
+	if err := viper.BindPFlag(configuration.ViperKeyToken, lookupPersistentFlagNotNil(flagNameOssiToken, rootCmd)); err != nil {
 		panic(err)
 	}
 }
@@ -199,27 +198,25 @@ func lookupPersistentFlagNotNil(flagName string, cmd *cobra.Command) *pflag.Flag
 	return foundFlag
 }
 
-const configTypeYaml = "yaml"
-
 func initConfig() {
 	var cfgFileToCheck string
 	if cfgFile != "" {
 		viper.SetConfigFile(cfgFile)
-		viper.SetConfigType(configTypeYaml)
+		viper.SetConfigType(configuration.ConfigTypeYaml)
 		cfgFileToCheck = cfgFile
 	} else {
 		home, err := homedir.Dir()
 		if err != nil {
 			fmt.Println(err)
 			os.Exit(1)
 		}
-		configPath := path.Join(home, types.OssIndexDirName)
+		configPath := path.Join(home, ossIndexTypes.OssIndexDirName)
 
 		viper.AddConfigPath(configPath)
-		viper.SetConfigType(configTypeYaml)
-		viper.SetConfigName(types.OssIndexConfigFileName)
+		viper.SetConfigType(configuration.ConfigTypeYaml)
+		viper.SetConfigName(ossIndexTypes.OssIndexConfigFileName)
 
-		cfgFileToCheck = path.Join(configPath, types.OssIndexConfigFileName)
+		cfgFileToCheck = path.Join(configPath, ossIndexTypes.OssIndexConfigFileName)
 	}
 
 	if fileExists(cfgFileToCheck) {

internal/cmd/root_test.go

@@ -26,13 +26,13 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/sonatype-nexus-community/go-sona-types/configuration"
 	"github.com/sonatype-nexus-community/go-sona-types/ossindex"
 	ossIndexTypes "github.com/sonatype-nexus-community/go-sona-types/ossindex/types"
 	"github.com/sonatype-nexus-community/nancy/types"
 
 	"github.com/sirupsen/logrus"
 	"github.com/sirupsen/logrus/hooks/test"
-	"github.com/sonatype-nexus-community/nancy/internal/configuration"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 
@@ -316,13 +316,11 @@ func TestConfigOssi_cleanCache(t *testing.T) {
 func setupConfig(t *testing.T) (tempDir string) {
 	tempDir, err := ioutil.TempDir("", "config-test")
 	assert.NoError(t, err)
-	configuration.HomeDir = tempDir
 	return tempDir
 }
 
 func resetConfig(t *testing.T, tempDir string) {
 	var err error
-	configuration.HomeDir, err = os.UserHomeDir()
 	assert.NoError(t, err)
 	_ = os.RemoveAll(tempDir)
 }
@@ -366,10 +364,10 @@ func TestInitConfigWithNoConfigFile(t *testing.T) {
 }
 
 func setupTestOSSIConfigFile(t *testing.T, tempDir string) {
-	cfgDir := path.Join(tempDir, types.OssIndexDirName)
+	cfgDir := path.Join(tempDir, ossIndexTypes.OssIndexDirName)
 	assert.Nil(t, os.Mkdir(cfgDir, 0700))
 
-	cfgFile = path.Join(tempDir, types.OssIndexDirName, types.OssIndexConfigFileName)
+	cfgFile = path.Join(tempDir, ossIndexTypes.OssIndexDirName, ossIndexTypes.OssIndexConfigFileName)
 }
 
 func resetOSSIConfigFile() {

internal/cmd/sleuth.go

@@ -39,7 +39,7 @@ var sleuthCmd = &cobra.Command{
   nancy sleuth -p Gopkg.lock --` + flagNameOssiUsername + ` your_user --` + flagNameOssiToken + ` your_token`,
 	Short:  "Check for vulnerabilities in your Golang dependencies using Sonatype's OSS Index",
 	Long:   `'nancy sleuth' is a command to check for vulnerabilities in your Golang dependencies, powered by the 'Sonatype OSS Index'.`,
-	PreRun: func(cmd *cobra.Command, args []string) { bindViper(rootCmd) },
+	PreRun: func(cmd *cobra.Command, args []string) { bindViperRootCmd() },
 	RunE:   doOSSI,
 }
 

internal/cmd/sleuth_test.go

@@ -67,7 +67,7 @@ func TestConfigOssi_exclude_vulnerabilities(t *testing.T) {
 		[]string{sleuthCmd.Use, "--exclude-vulnerability=CVE123,CVE988"}...)
 }
 
-const testdataDir = "../../internal/configuration/testdata"
+const testdataDir = "testdata/sleuth"
 
 func TestConfigOssi_exclude_vulnerabilities_with_sane_file(t *testing.T) {
 	file, _ := os.Open(testdataDir + "/normalIgnore")