feat: Switch to viper for configuration

cmd/root.go

@@ -1,7 +1,10 @@
 package cmd
 
 import (
+	"path/filepath"
+
 	"github.com/rs/zerolog"
+	"github.com/underdog-tech/vulnbot/internal"
 	"github.com/underdog-tech/vulnbot/logger"
 
 	"github.com/spf13/cobra"
@@ -44,7 +47,9 @@ func Execute() {
 func init() {
 	persistent := rootCmd.PersistentFlags()
 	persistent.BoolP("disable-slack", "d", false, "Disable Slack alerts.")
-	persistent.StringP("config", "c", "config.toml", "Config file path.")
+
+	projectRootDir := internal.GetProjectRootDir()
+	persistent.StringP("config", "c", filepath.Join(projectRootDir, "config.toml"), "Config file path.")
 
 	persistent.BoolP("quiet", "q", false, "Suppress all console output. (Mutually exclusive with 'verbose'.)")
 	persistent.CountP("verbose", "v", "More verbose output. Specifying multiple times increases verbosity. (Mutually exclusive with 'quiet'.)")

config/config.go

@@ -2,10 +2,12 @@
 
 import (
 	"fmt"
+	"path/filepath"
+	"strings"
 
 	"github.com/underdog-tech/vulnbot/logger"
 
-	"github.com/BurntSushi/toml"
+	"github.com/spf13/viper"
 )
 
 type SeverityConfig struct {
@@ -24,23 +26,86 @@
 	Slack_channel string
 }
 
-type TomlConfig struct {
+type Config struct {
 	Default_slack_channel string
 	Severity              []SeverityConfig
 	Ecosystem             []EcosystemConfig
 	Team                  []TeamConfig
 }
 
-func LoadConfig(configFilePath *string) TomlConfig {
-	var config TomlConfig
+type Env struct {
+	GithubOrg      string `mapstructure:"GITHUB_ORG"`
+	SlackAuthToken string `mapstructure:"SLACK_AUTH_TOKEN"`
+	GithubToken    string `mapstructure:"GITHUB_TOKEN"`
+}
+
+var viperClient *viper.Viper
+
+type ViperParams struct {
+	ConfigPath  *string
+	Output      interface{}
+	EnvFileName *string
+}
+
+func getViper() *viper.Viper {
+	if viperClient == nil {
+		viperClient = viper.New()
+	}
+	return viperClient
+}
+
+func LoadConfig(params ViperParams) error {
 	log := logger.Get()
 
-	_, err := toml.DecodeFile(*configFilePath, &config)
+	v := getViper()
+
+	filename := filepath.Base(*params.ConfigPath)
+	extension := filepath.Ext(*params.ConfigPath)
+	configDir := filepath.Dir(*params.ConfigPath)
+
+	v.SetConfigName(filename)
+	v.AddConfigPath(configDir)
+	v.SetConfigType(strings.TrimLeft(extension, "."))
+
+	err := v.ReadInConfig()
+	if err != nil {
+		log.Fatal().Err(err).Msg("Unable to read config.")
+		return err
+	}
+
+	err = v.Unmarshal(&params.Output)
 	if err != nil {
-		log.Fatal().Err(err).Msg("Error loading config file.")
+		log.Fatal().Err(err).Msg("Unable to unmarshal config.")
+		return err
 	}
-	log.Debug().Any("config", config).Msg("Config loaded.")
-	return config
+
+	log.Debug().Any("config", params.Output).Msg("Config loaded.")
+	return nil
+}
+
+func LoadEnv(params ViperParams) error {
+	log := logger.Get()
+
+	v := getViper()
+
+	// Read in environment variables that match
+	v.SetConfigFile(*params.EnvFileName)
+	v.AutomaticEnv()
+
+	err := v.ReadInConfig()
+	if err != nil {
+		log.Fatal().Err(err).Msg("Unable to read ENV file.")
+		return err
+	}
+
+	err = v.Unmarshal(&params.Output)
+	if err != nil {
+		log.Fatal().Err(err).Msg("Unable to unmarshal ENV.")
+		return err
+	}
+
+	log.Debug().Any("env", params.Output).Msg("ENV loaded.")
+	return nil
 }
 
 func GetIconForSeverity(severity string, severities []SeverityConfig) (string, error) {

config/config_test.go

@@ -1,6 +1,9 @@
 package config
 
 import (
+	"fmt"
+	"os"
+	"path/filepath"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -54,3 +57,49 @@ func TestGetUnconfiguredTeamConfigBySlug(t *testing.T) {
 	assert.Empty(t, team)
 	assert.Error(t, err)
 }
+
+func getCurrentDir() (string, error) {
+	cwd, err := os.Getwd()
+	if err != nil {
+		fmt.Println("Failed to get current working directory:", err)
+		return "", err
+	}
+
+	return cwd, nil
+}
+
+func TestLoadConfig(t *testing.T) {
+	expectedSlackChannel := "testing_slack_channel"
+	currentDir, err := getCurrentDir()
+	if err != nil {
+		assert.Error(t, err)
+	}
+	testDataPath := filepath.Join(currentDir, "/testdata/test_config.toml")
+
+	var config Config
+	LoadConfig(ViperParams{
+		Output:     &config,
+		ConfigPath: &testDataPath,
+	})
+
+	assert.IsType(t, Config{}, config)
+	assert.Equal(t, expectedSlackChannel, config.Default_slack_channel)
+}
+
+func TestLoadEnv(t *testing.T) {
+	expectedSlackAuthToken := "testing"
+	currentDir, err := getCurrentDir()
+	if err != nil {
+		assert.Error(t, err)
+	}
+	testDataPath := filepath.Join(currentDir, "/testdata/config.env")
+
+	var env Env
+	LoadEnv(ViperParams{
+		EnvFileName: &testDataPath,
+		Output: &env,
+	})
+
+	assert.IsType(t, Env{}, env)
+	assert.Equal(t, expectedSlackAuthToken, env.SlackAuthToken)
+}

config/testdata/config.env

@@ -0,0 +1 @@
+SLACK_AUTH_TOKEN="testing"

config/testdata/test_config.toml

@@ -0,0 +1,5 @@
+default_slack_channel = "testing_slack_channel"
+
+[[ecosystem]]
+label = "Go"
+slack_emoji = ":golang:"

go.mod

@@ -3,34 +3,44 @@ module github.com/underdog-tech/vulnbot
 go 1.20
 
 require (
-	github.com/BurntSushi/toml v1.2.1
 	github.com/gookit/color v1.5.3
-	github.com/joho/godotenv v1.5.1
 	github.com/rs/zerolog v1.29.1
 	github.com/shurcooL/githubv4 v0.0.0-20230424031643-6cea62ecd5a9
 	github.com/slack-go/slack v0.12.2
 	github.com/spf13/cobra v1.7.0
 	github.com/spf13/pflag v1.0.5
+	github.com/spf13/viper v1.16.0
 	github.com/stretchr/testify v1.8.3
 	golang.org/x/exp v0.0.0-20230522175609-2e198f4a06a1
 	golang.org/x/oauth2 v0.8.0
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/fsnotify/fsnotify v1.6.0 // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/gorilla/websocket v1.5.0 // indirect
+	github.com/hashicorp/hcl v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/magiconair/properties v1.8.7 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
 	github.com/mattn/go-isatty v0.0.19 // indirect
+	github.com/mitchellh/mapstructure v1.5.0 // indirect
+	github.com/pelletier/go-toml/v2 v2.0.8 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/shurcooL/graphql v0.0.0-20220606043923-3cf50f8a0a29 // indirect
+	github.com/spf13/afero v1.9.5 // indirect
+	github.com/spf13/cast v1.5.1 // indirect
+	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/stretchr/objx v0.5.0 // indirect
+	github.com/subosito/gotenv v1.4.2 // indirect
 	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
 	golang.org/x/net v0.10.0 // indirect
 	golang.org/x/sys v0.8.0 // indirect
+	golang.org/x/text v0.9.0 // indirect
 	google.golang.org/appengine v1.6.7 // indirect
 	google.golang.org/protobuf v1.30.0 // indirect
+	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )
 
@@ -41,4 +51,25 @@ require (
 exclude (
 	golang.org/x/text v0.3.0
 	golang.org/x/text v0.3.2
+	golang.org/x/text v0.3.3
+	golang.org/x/text v0.3.4
+	golang.org/x/text v0.3.6
+	golang.org/x/text v0.3.7
+	google.golang.org/grpc v1.19.0
+	google.golang.org/grpc v1.20.1
+	google.golang.org/grpc v1.21.1
+	google.golang.org/grpc v1.23.0
+	google.golang.org/grpc v1.25.1
+	google.golang.org/grpc v1.26.0
+	google.golang.org/grpc v1.27.0
+	google.golang.org/grpc v1.27.1
+	google.golang.org/grpc v1.28.0
+	google.golang.org/grpc v1.29.1
+	google.golang.org/grpc v1.30.0
+	google.golang.org/grpc v1.31.0
+	google.golang.org/grpc v1.31.1
+	google.golang.org/grpc v1.33.2
+	google.golang.org/grpc v1.34.0
+	google.golang.org/grpc v1.35.0
+	gopkg.in/yaml.v2 v2.2.2
 )