Environment variable handling with envconfig

Documentation for environment variables
eth0izzle · Mar 6, 2020 · dd984a0 · dd984a0
1 parent c26ac4a
commit dd984a0
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -88,6 +88,10 @@ signatures: # list of signatures to check
     name: '' # name of the signature
 ```
 
+Note that some configuration can be also overwritten with environment varibles. There are:
+- `github_access_tokens`, environment variable `GITHUB_ACCESS_TOKENS`
+- `slack_webhook`, environment variable `SLACK_WEBHOOK`
+
 #### Signatures
 
 shhgit comes with 120 signatures. You can remove or add more by editing `config.yaml`.

diff --git a/core/config.go b/core/config.go
@@ -7,12 +7,13 @@ import (
 	"path"
 	"strings"
 
+	"github.com/kelseyhightower/envconfig"
 	"gopkg.in/yaml.v3"
 )
 
 type Config struct {
-	GitHubAccessTokens           []string          `yaml:"github_access_tokens"`
-	SlackWebhook                 string            `yaml:"slack_webhook,omitempty"`
+	GitHubAccessTokens           []string          `yaml:"github_access_tokens" envconfig:"GITHUB_ACCESS_TOKENS"`
+	SlackWebhook                 string            `yaml:"slack_webhook,omitempty" envconfig:"SLACK_WEBHOOK"`
 	BlacklistedExtensions        []string          `yaml:"blacklisted_extensions"`
 	BlacklistedPaths             []string          `yaml:"blacklisted_paths"`
 	BlacklistedEntropyExtensions []string          `yaml:"blacklisted_entropy_extensions"`
@@ -41,14 +42,6 @@ func ParseConfig() (*Config, error) {
 		return config, err
 	}
 
-	for i := 0; i < len(config.GitHubAccessTokens); i++ {
-		config.GitHubAccessTokens[i] = os.ExpandEnv(config.GitHubAccessTokens[i])
-	}
-
-	if len(config.SlackWebhook) > 0 {
-		config.SlackWebhook = os.ExpandEnv(config.SlackWebhook)
-	}
-
 	return config, nil
 }
 
@@ -61,6 +54,11 @@ func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error {
 		return err
 	}
 
+	err = envconfig.Process("", c)
+	if err != nil {
+		return err
+	}
+
 	if len(c.GitHubAccessTokens) < 1 || strings.TrimSpace(strings.Join(c.GitHubAccessTokens, "")) == "" {
 		return errors.New("You need to provide at least one GitHub Access Token. See https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line")
 	}

diff --git a/go.mod b/go.mod
@@ -6,6 +6,7 @@ require (
 	github.com/fatih/color v1.7.0
 	github.com/google/go-github v17.0.0+incompatible
 	github.com/google/go-querystring v1.0.0 // indirect
+	github.com/kelseyhightower/envconfig v1.4.0
 	github.com/mattn/go-colorable v0.1.2 // indirect
 	github.com/mattn/go-isatty v0.0.9 // indirect
 	golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45

diff --git a/go.sum b/go.sum
@@ -23,6 +23,8 @@ github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
 github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
+github.com/kelseyhightower/envconfig v1.4.0 h1:Im6hONhd3pLkfDFsbRgu68RDNkGF1r3dvMUtDTo2cv8=
+github.com/kelseyhightower/envconfig v1.4.0/go.mod h1:cccZRl6mQpaq41TPp5QxidR+Sa3axMbJDNb//FQX6Gg=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd h1:Coekwdh0v2wtGp9Gmz1Ze3eVRAWJMLokvN3QjdzCHLY=
 github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
 github.com/kr/pretty v0.1.0 h1:L/CwN0zerZDmRFUapSPitk6f+Q3+0za1rQkzVuMiMFI=