mirrors/mostlymatter
1
0
Форкнуть 0
Код Задачи Запросы на слияние Действия Пакеты Проекты Релизы Вики Активность

[MM-35470] Disable config watching logic (#17913)

Просмотр исходного кода 
* Disable config watching logic

* Fix tests
Этот коммит содержится в:
Claudio Costa
2021-07-26 20:13:30 +02:00
коммит произвёл GitHub
родитель b01f8ab0c8
Коммит 186475db3b
21 изменённых файлов: 82 добавлений и 313 удалений
Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

5
config/database.go
Просмотреть файл

@@ -346,8 +346,3 @@ func (ds *DatabaseStore) String() string {
func (ds *DatabaseStore) Close() error {
return ds.db.Close()
}
// Watch nothing on memory store
func (ds *DatabaseStore) Watch(_ func()) error {
return nil
}

60
config/file.go
Просмотреть файл

@@ -26,27 +26,19 @@ var (
// It also uses the folder containing the configuration file for storing other configuration files.
// Not to be used directly. Only to be used as a backing store for config.Store
type FileStore struct {
path string
watch bool
watcher *watcher
callback func()
path string
}
// NewFileStore creates a new instance of a config store backed by the given file path.
//
// If watch is true, any external changes to the file will force a reload.
func NewFileStore(path string, watch bool) (fs *FileStore, err error) {
func NewFileStore(path string) (fs *FileStore, err error) {
resolvedPath, err := resolveConfigFilePath(path)
if err != nil {
return nil, err
}
fs = &FileStore{
path: resolvedPath,
watch: watch,
}
return fs, nil
return &FileStore{
path: resolvedPath,
}, nil
}
// resolveConfigFilePath attempts to resolve the given configuration file path to an absolute path.
@@ -103,12 +95,6 @@ func (fs *FileStore) Set(newCfg *model.Config) error {
// persist writes the configuration to the configured file.
func (fs *FileStore) persist(cfg *model.Config) error {
needsRestart := false
if fs.watcher != nil {
fs.stopWatcher()
needsRestart = true
}
b, err := marshalConfig(cfg)
if err != nil {
return errors.Wrap(err, "failed to serialize")
@@ -119,12 +105,6 @@ func (fs *FileStore) persist(cfg *model.Config) error {
return errors.Wrap(err, "failed to write file")
}
if fs.watch && needsRestart {
if err = fs.Watch(fs.callback); err != nil {
mlog.Error("failed to start config watcher", mlog.String("path", fs.path), mlog.Err(err))
}
}
return nil
}
@@ -215,34 +195,6 @@ func (fs *FileStore) RemoveFile(name string) error {
return nil
}
func (fs *FileStore) Watch(callback func()) error {
if fs.watcher != nil || !fs.watch {
return nil
}
fs.callback = callback
watcher, err := newWatcher(fs.path, callback)
if err != nil {
return err
}
fs.watcher = watcher
return nil
}
// stopWatcher stops any previously started watcher.
func (fs *FileStore) stopWatcher() {
if fs.watcher == nil {
return
}
if err := fs.watcher.Close(); err != nil {
mlog.Error("failed to close watcher", mlog.Err(err))
}
fs.watcher = nil
}
// String returns the path to the file backing the config.
func (fs *FileStore) String() string {
return "file://" + fs.path
@@ -250,7 +202,5 @@ func (fs *FileStore) String() string {
// Close cleans up resources associated with the store.
func (fs *FileStore) Close() error {
fs.stopWatcher()
return nil
}

245
config/file_test.go
Просмотреть файл

@@ -51,7 +51,7 @@ func setupConfigFile(t *testing.T, cfg *model.Config) (string, func()) {
func setupConfigFileStore(t *testing.T, cfg *model.Config) (*Store, func()) {
t.Helper()
path, tearDown := setupConfigFile(t, cfg)
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, nil, false)
require.NoError(t, err)
@@ -101,7 +101,7 @@ func TestFileStoreNew(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, nil, false)
require.NoError(t, err)
@@ -115,7 +115,7 @@ func TestFileStoreNew(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, customConfigDefaults, false)
require.NoError(t, err)
@@ -134,7 +134,7 @@ func TestFileStoreNew(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfigNoFF)
defer tearDown()
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, nil, false)
require.NoError(t, err)
@@ -148,7 +148,7 @@ func TestFileStoreNew(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfigNoFF)
defer tearDown()
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, customConfigDefaults, false)
require.NoError(t, err)
@@ -170,7 +170,7 @@ func TestFileStoreNew(t *testing.T) {
defer os.RemoveAll(tempDir)
path := filepath.Join(tempDir, "does_not_exist")
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, nil, false)
require.NoError(t, err)
@@ -189,7 +189,7 @@ func TestFileStoreNew(t *testing.T) {
defer os.RemoveAll(tempDir)
path := filepath.Join(tempDir, "does_not_exist")
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, customConfigDefaults, false)
require.NoError(t, err)
@@ -208,7 +208,7 @@ func TestFileStoreNew(t *testing.T) {
defer os.RemoveAll(tempDir)
path := filepath.Join(tempDir, "does/not/exist")
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, nil, false)
require.Nil(t, configStore)
@@ -230,7 +230,7 @@ func TestFileStoreNew(t *testing.T) {
ioutil.WriteFile(path, cfgData, 0644)
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, nil, false)
require.NoError(t, err)
@@ -249,7 +249,7 @@ func TestFileStoreNew(t *testing.T) {
defer os.RemoveAll("config/TestFileStoreNew")
path := "TestFileStoreNew/a/b/c/config.json"
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
configStore, err := NewStoreFromBacking(fs, nil, false)
require.NoError(t, err)
@@ -284,7 +284,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -296,7 +296,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
os.Setenv("MM_SERVICESETTINGS_SITEURL", "http://override")
defer os.Unsetenv("MM_SERVICESETTINGS_SITEURL")
fsInner, err = NewFileStore(path, false)
fsInner, err = NewFileStore(path)
require.NoError(t, err)
fs, err = NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -310,7 +310,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, customConfigDefaults, false)
require.NoError(t, err)
@@ -322,7 +322,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
os.Setenv("MM_SERVICESETTINGS_SITEURL", "http://override")
defer os.Unsetenv("MM_SERVICESETTINGS_SITEURL")
fsInner, err = NewFileStore(path, false)
fsInner, err = NewFileStore(path)
require.NoError(t, err)
fs, err = NewStoreFromBacking(fsInner, customConfigDefaults, false)
require.NoError(t, err)
@@ -337,7 +337,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -349,7 +349,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
os.Setenv("MM_PLUGINSETTINGS_ENABLEUPLOADS", "true")
defer os.Unsetenv("MM_PLUGINSETTINGS_ENABLEUPLOADS")
fsInner, err = NewFileStore(path, false)
fsInner, err = NewFileStore(path)
require.NoError(t, err)
fs, err = NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -363,7 +363,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -375,7 +375,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
os.Setenv("MM_TEAMSETTINGS_MAXUSERSPERTEAM", "3000")
defer os.Unsetenv("MM_TEAMSETTINGS_MAXUSERSPERTEAM")
fsInner, err = NewFileStore(path, false)
fsInner, err = NewFileStore(path)
require.NoError(t, err)
fs, err = NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -389,7 +389,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -401,7 +401,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
os.Setenv("MM_SERVICESETTINGS_TLSSTRICTTRANSPORTMAXAGE", "123456")
defer os.Unsetenv("MM_SERVICESETTINGS_TLSSTRICTTRANSPORTMAXAGE")
fsInner, err = NewFileStore(path, false)
fsInner, err = NewFileStore(path)
require.NoError(t, err)
fs, err = NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -415,7 +415,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -427,7 +427,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
os.Setenv("MM_SQLSETTINGS_DATASOURCEREPLICAS", "user:pwd@db:5432/test-db")
defer os.Unsetenv("MM_SQLSETTINGS_DATASOURCEREPLICAS")
fsInner, err = NewFileStore(path, false)
fsInner, err = NewFileStore(path)
require.NoError(t, err)
fs, err = NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -441,7 +441,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
path, tearDown := setupConfigFile(t, testConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -453,7 +453,7 @@ func TestFileStoreGetEnivironmentOverrides(t *testing.T) {
os.Setenv("MM_SQLSETTINGS_DATASOURCEREPLICAS", "user:pwd@db:5432/test-db user:pwd@db2:5433/test-db2 user:pwd@db3:5434/test-db3")
defer os.Unsetenv("MM_SQLSETTINGS_DATASOURCEREPLICAS")
fsInner, err = NewFileStore(path, false)
fsInner, err = NewFileStore(path)
require.NoError(t, err)
fs, err = NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -529,7 +529,7 @@ func TestFileStoreSet(t *testing.T) {
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -623,40 +623,6 @@ func TestFileStoreSet(t *testing.T) {
require.True(t, wasCalled(called, 5*time.Second))
})
t.Run("watcher restarted", func(t *testing.T) {
if testing.Short() {
t.Skip("skipping watcher test in short mode")
}
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fsInner, err := NewFileStore(path, true)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
defer fs.Close()
_, _, err = fs.Set(minimalConfig)
require.NoError(t, err)
// Let the initial call to invokeConfigListeners finish.
time.Sleep(1 * time.Second)
called := make(chan bool, 1)
callback := func(oldCfg, newCfg *model.Config) {
called <- true
}
fs.AddListener(callback)
// Rewrite the config to the file on disk
cfgData, err := marshalConfig(emptyConfig)
require.NoError(t, err)
ioutil.WriteFile(path, cfgData, 0644)
require.True(t, wasCalled(called, 5*time.Second), "callback should have been called when config written")
})
}
func TestFileStoreLoad(t *testing.T) {
@@ -664,7 +630,7 @@ func TestFileStoreLoad(t *testing.T) {
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -699,7 +665,7 @@ func TestFileStoreLoad(t *testing.T) {
os.Setenv("MM_SERVICESETTINGS_SITEURL", "http://overridePersistEnvVariables")
defer os.Unsetenv("MM_SERVICESETTINGS_SITEURL")
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -724,7 +690,7 @@ func TestFileStoreLoad(t *testing.T) {
os.Setenv("MM_PLUGINSETTINGS_ENABLEUPLOADS", "true")
defer os.Unsetenv("MM_PLUGINSETTINGS_ENABLEUPLOADS")
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -749,7 +715,7 @@ func TestFileStoreLoad(t *testing.T) {
os.Setenv("MM_TEAMSETTINGS_MAXUSERSPERTEAM", "3000")
defer os.Unsetenv("MM_TEAMSETTINGS_MAXUSERSPERTEAM")
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -774,7 +740,7 @@ func TestFileStoreLoad(t *testing.T) {
os.Setenv("MM_SERVICESETTINGS_TLSSTRICTTRANSPORTMAXAGE", "123456")
defer os.Unsetenv("MM_SERVICESETTINGS_TLSSTRICTTRANSPORTMAXAGE")
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -799,7 +765,7 @@ func TestFileStoreLoad(t *testing.T) {
os.Setenv("MM_SQLSETTINGS_DATASOURCEREPLICAS", "user:pwd@db:5432/test-db")
defer os.Unsetenv("MM_SQLSETTINGS_DATASOURCEREPLICAS")
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -826,7 +792,7 @@ func TestFileStoreLoad(t *testing.T) {
os.Setenv("MM_SQLSETTINGS_DATASOURCEREPLICAS", "user:pwd@db:5432/test-db")
defer os.Unsetenv("MM_SQLSETTINGS_DATASOURCEREPLICAS")
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -848,7 +814,7 @@ func TestFileStoreLoad(t *testing.T) {
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -882,7 +848,7 @@ func TestFileStoreLoad(t *testing.T) {
path, tearDown := setupConfigFile(t, fixesRequiredConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -901,7 +867,7 @@ func TestFileStoreLoad(t *testing.T) {
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
@@ -968,121 +934,6 @@ func TestFileStoreLoad(t *testing.T) {
})
}
func TestFileStoreWatcherEmitter(t *testing.T) {
if testing.Short() {
t.Skip("skipping watcher test in short mode")
}
t.Run("disabled", func(t *testing.T) {
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fsInner, err := NewFileStore(path, false)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
defer fs.Close()
// Let the initial call to invokeConfigListeners finish.
time.Sleep(1 * time.Second)
called := make(chan bool, 1)
callback := func(oldCfg, newCfg *model.Config) {
called <- true
}
fs.AddListener(callback)
// Rewrite the config to the file on disk
cfgData, err := marshalConfig(emptyConfig)
require.NoError(t, err)
ioutil.WriteFile(path, cfgData, 0644)
require.False(t, wasCalled(called, 1*time.Second), "callback should not have been called since watching disabled")
})
t.Run("enabled", func(t *testing.T) {
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fsInner, err := NewFileStore(path, true)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
defer fs.Close()
called := make(chan bool, 1)
callback := func(oldCCfg, newCfg *model.Config) {
called <- true
}
fs.AddListener(callback)
// Rewrite the config to the file on disk
cfgData, err := marshalConfig(minimalConfig)
require.NoError(t, err)
f, err := os.OpenFile(path, os.O_WRONLY, 0644)
require.NoError(t, err)
defer f.Close()
_, err = f.Write(cfgData)
require.NoError(t, err)
require.True(t, wasCalled(called, 5*time.Second), "callback should have been called when config written")
})
t.Run("no change", func(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fsInner, err := NewFileStore(path, true)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
defer fs.Close()
// Let the initial call to invokeConfigListeners finish.
time.Sleep(1 * time.Second)
called := make(chan bool, 1)
callback := func(oldCfg, newCfg *model.Config) {
called <- true
}
fs.AddListener(callback)
_, _, err = fs.Set(minimalConfig)
require.NoError(t, err)
require.False(t, wasCalled(called, 1*time.Second), "callback should not have been called since no change has happened")
})
t.Run("env only change", func(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fsInner, err := NewFileStore(path, true)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, false)
require.NoError(t, err)
defer fs.Close()
// Let the initial call to invokeConfigListeners finish.
time.Sleep(1 * time.Second)
called := make(chan bool, 1)
callback := func(oldCfg, newCfg *model.Config) {
require.NotEqual(t, oldCfg, newCfg)
expectedConfig := minimalConfig.Clone()
expectedConfig.ServiceSettings.SiteURL = model.NewString("http://override")
require.Equal(t, minimalConfig, oldCfg)
require.Equal(t, expectedConfig, newCfg)
called <- true
}
fs.AddListener(callback)
os.Setenv("MM_SERVICESETTINGS_SITEURL", "http://override")
defer os.Unsetenv("MM_SERVICESETTINGS_SITEURL")
_, _, err = fs.Set(minimalConfig)
require.NoError(t, err)
require.True(t, wasCalled(called, 5*time.Second), "callback should have been called since no change has happened")
})
}
func TestFileStoreSave(t *testing.T) {
store, tearDown := setupConfigFileStore(t, minimalConfig)
defer tearDown()
@@ -1108,7 +959,7 @@ func TestFileGetFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1170,7 +1021,7 @@ func TestFileSetFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1221,7 +1072,7 @@ func TestFileHasFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1234,7 +1085,7 @@ func TestFileHasFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1250,7 +1101,7 @@ func TestFileHasFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1273,7 +1124,7 @@ func TestFileHasFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1286,7 +1137,7 @@ func TestFileHasFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1305,7 +1156,7 @@ func TestFileRemoveFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1317,7 +1168,7 @@ func TestFileRemoveFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1339,7 +1190,7 @@ func TestFileRemoveFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1368,7 +1219,7 @@ func TestFileRemoveFile(t *testing.T) {
path, tearDown := setupConfigFile(t, minimalConfig)
defer tearDown()
fs, err := NewFileStore(path, true)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1390,7 +1241,7 @@ func TestFileStoreString(t *testing.T) {
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fs, err := NewFileStore(path, false)
fs, err := NewFileStore(path)
require.NoError(t, err)
defer fs.Close()
@@ -1411,7 +1262,7 @@ func wasCalled(c chan bool, duration time.Duration) bool {
func TestFileStoreReadOnly(t *testing.T) {
path, tearDown := setupConfigFile(t, emptyConfig)
defer tearDown()
fsInner, err := NewFileStore(path, true)
fsInner, err := NewFileStore(path)
require.NoError(t, err)
fs, err := NewStoreFromBacking(fsInner, nil, true)
require.NoError(t, err)

5
config/memory.go
Просмотреть файл

@@ -118,8 +118,3 @@ func (ms *MemoryStore) String() string {
func (ms *MemoryStore) Close() error {
return nil
}
// Watch nothing on memory store
func (ms *MemoryStore) Watch(_ func()) error {
return nil
}

4
config/migrate.go
Просмотреть файл

@@ -9,13 +9,13 @@ import (
// Migrate migrates SAML keys, certificates, and other config files from one store to another given their data source names.
func Migrate(from, to string) error {
source, err := NewStoreFromDSN(from, false, false, nil)
source, err := NewStoreFromDSN(from, false, nil)
if err != nil {
return errors.Wrapf(err, "failed to access source config %s", from)
}
defer source.Close()
destination, err := NewStoreFromDSN(to, false, false, nil)
destination, err := NewStoreFromDSN(to, false, nil)
if err != nil {
return errors.Wrapf(err, "failed to access destination config %s", to)
}

4
config/migrate_test.go
Просмотреть файл

@@ -121,7 +121,7 @@ func TestMigrate(t *testing.T) {
err = Migrate(sourceDSN, destinationDSN)
require.NoError(t, err)
destinationfile, err := NewFileStore(destinationDSN, false)
destinationfile, err := NewFileStore(destinationDSN)
require.NoError(t, err)
destination, err := NewStoreFromBacking(destinationfile, nil, false)
require.NoError(t, err)
@@ -141,7 +141,7 @@ func TestMigrate(t *testing.T) {
sourceDSN := path.Join(pwd, "config-custom.json")
destinationDSN := getDsn(*sqlSettings.DriverName, *sqlSettings.DataSource)
sourcefile, err := NewFileStore(sourceDSN, false)
sourcefile, err := NewFileStore(sourceDSN)
require.NoError(t, err)
source, err := NewStoreFromBacking(sourcefile, nil, false)
require.NoError(t, err)

12
config/store.go
Просмотреть файл

@@ -61,8 +61,6 @@ type BackingStore interface {
// String describes the backing store for the config.
String() string
Watch(callback func()) error
// Close cleans up resources associated with the store.
Close() error
}
@@ -80,24 +78,18 @@ func NewStoreFromBacking(backingStore BackingStore, customDefaults *model.Config
return nil, errors.Wrap(err, "unable to load on store creation")
}
if err := backingStore.Watch(func() {
store.Load()
}); err != nil {
return nil, errors.Wrap(err, "failed to watch backing store")
}
return store, nil
}
// NewStoreFromDSN creates and returns a new config store backed by either a database or file store
// depending on the value of the given data source name string.
func NewStoreFromDSN(dsn string, watch, readOnly bool, customDefaults *model.Config) (*Store, error) {
func NewStoreFromDSN(dsn string, readOnly bool, customDefaults *model.Config) (*Store, error) {
var err error
var backingStore BackingStore
if IsDatabaseDSN(dsn) {
backingStore, err = NewDatabaseStore(dsn)
} else {
backingStore, err = NewFileStore(dsn, watch)
backingStore, err = NewFileStore(dsn)
}
if err != nil {
return nil, err

20
config/store_test.go
Просмотреть файл

@@ -27,25 +27,13 @@ func TestNewStoreFromDSN(t *testing.T) {
require.NoError(t, os.Mkdir(filepath.Join(tempDir, "config"), 0700))
t.Run("database dsn", func(t *testing.T) {
ds, err := NewStoreFromDSN(getDsn(*sqlSettings.DriverName, *sqlSettings.DataSource), false, false, nil)
require.NoError(t, err)
ds.Close()
})
t.Run("database dsn, watch ignored", func(t *testing.T) {
ds, err := NewStoreFromDSN(getDsn(*sqlSettings.DriverName, *sqlSettings.DataSource), true, false, nil)
ds, err := NewStoreFromDSN(getDsn(*sqlSettings.DriverName, *sqlSettings.DataSource), false, nil)
require.NoError(t, err)
ds.Close()
})
t.Run("file dsn", func(t *testing.T) {
fs, err := NewStoreFromDSN("config.json", false, false, nil)
require.NoError(t, err)
fs.Close()
})
t.Run("file dsn, watch", func(t *testing.T) {
fs, err := NewStoreFromDSN("config.json", true, false, nil)
fs, err := NewStoreFromDSN("config.json", false, nil)
require.NoError(t, err)
fs.Close()
})
@@ -66,7 +54,7 @@ func TestNewStoreReadOnly(t *testing.T) {
require.NoError(t, os.Mkdir(filepath.Join(tempDir, "config"), 0700))
t.Run("database dsn", func(t *testing.T) {
ds, err := NewStoreFromDSN(getDsn(*sqlSettings.DriverName, *sqlSettings.DataSource), false, true, nil)
ds, err := NewStoreFromDSN(getDsn(*sqlSettings.DriverName, *sqlSettings.DataSource), true, nil)
require.NoError(t, err)
t.Run("Set", func(t *testing.T) {
@@ -90,7 +78,7 @@ func TestNewStoreReadOnly(t *testing.T) {
})
t.Run("file dsn", func(t *testing.T) {
fs, err := NewStoreFromDSN("config.json", false, true, nil)
fs, err := NewStoreFromDSN("config.json", true, nil)
require.NoError(t, err)
t.Run("Set", func(t *testing.T) {