Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add the current executable dir to the config load path #350

Merged
merged 1 commit into from
Jun 17, 2022
+36 −9
Merged

Add the current executable dir to the config load path #350

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions internal/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import (
"context"
"errors"
"fmt"
"os"
"path/filepath"

"github.com/fsnotify/fsnotify"
"github.com/sirupsen/logrus"
Expand Down Expand Up @@ -54,6 +56,12 @@ func Init(name string, rootCmd cobra.Command, vip *viper.Viper, configChanged fu
vip.AddConfigPath("./")
vip.AddConfigPath("$HOME/")
vip.AddConfigPath("/etc/")
// Add the executable path to the config search path.
if binPath, err := os.Executable(); err != nil {
log.Warningf(context.Background(), i18n.G("Failed to get current executable path, not adding it as a config dir: %v"), err)
} else {
vip.AddConfigPath(filepath.Dir(binPath))
}
}

if err := vip.ReadInConfig(); err != nil {
Expand Down
37 changes: 28 additions & 9 deletions internal/config/config_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,15 @@ func TestSetVerboseMode(t *testing.T) {

func TestInit(t *testing.T) {
tests := map[string]struct {
withValueFlagSet bool
noVerboseFlag bool
noConfigFlag bool
withConfigFlagSet string
withConfigEnv bool
configFileContent string
notInConfigDir bool
changeConfigWith string
withValueFlagSet bool
noVerboseFlag bool
noConfigFlag bool
withConfigFlagSet string
withConfigEnv bool
withConfigInExeDir bool
configFileContent string
notInConfigDir bool
changeConfigWith string

errFromCallbackOn int

Expand All @@ -108,6 +109,12 @@ func TestInit(t *testing.T) {
configFileContent: "value: filecontentvalue",
want: "filecontentvalue", wantCallbackCalled: 1,
},
"Load configuration from executable dir": {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With a test without asking! You got the spirit :) \o/

configFileContent: "value: filecontentvalue",
withConfigInExeDir: true,
notInConfigDir: true,
want: "filecontentvalue", wantCallbackCalled: 1,
},
"No config flag set before Init is call is ignored": {
noConfigFlag: true,
wantCallbackCalled: 1,
Expand Down Expand Up @@ -170,6 +177,19 @@ func TestInit(t *testing.T) {
tc := tc
t.Run(name, func(t *testing.T) {
configDir := t.TempDir()
prefix := "adsys_config_test"

if tc.withConfigInExeDir {
exePath, err := os.Executable()
require.NoError(t, err, "Setup: can't get executable path")
configDir = filepath.Dir(exePath)

t.Cleanup(func() {
os.Remove(filepath.Join(configDir, prefix+".yaml"))
syscall.Sync()
})
}

if !tc.notInConfigDir {
chDir(t, configDir)
}
Expand Down Expand Up @@ -204,7 +224,6 @@ func TestInit(t *testing.T) {
require.NoError(t, err, "Setup: can’t set config flag")
}

prefix := "adsys_config_test"
if tc.withConfigEnv {
testutils.Setenv(t, strings.ToUpper(prefix)+"_VALUE", "envvalue")
}
Expand Down