Add a function that can reload config files #64
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Once the first call to `Get()`, `GetStrict()`, `GetAll()`, or`GetAllStrict()` has been made, the contents of the config files will be cached for all future calls to any of those functions. This can be frustrating if the user wants to capture changes to the config file that were made externally. This change adds the `ClearCachedConfigs()` function to provide control over that.
Clearing cached data is somewhat vague and could be more confusing to users who are not familiar with this library. But Reloading the config data is very straightforward. For this reason, the ability to clear the cache has been replaced with the ability to reload. The reload simply clears the cache and then loads the contents again. Additionally, this contains a bug fix that ensure the loadConfigs pointer is set to a non-null value before it is used.
This adds 2 tests. The first checks that ssh config data is cached and does not update if the file changes afterward. The second checks that the `ReloadConfigs()` function will discard the cached data and load the current config file contents.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change addresses issue #63. To summarize, this change adds a function
ReloadConfigs()that will reload the data from ssh config files in case they were modified externally.This involves changing the type of UserSettings.loadConfigs from sync.Once to a pointer *sync.Once. This makes it possible to swap out one pointer for another if requested by the
ReloadConfigs()function.In addition, this change updates the README.md file with additional documentation explaining what the function is. It also adds two tests that demonstrate the difference between when
ReloadConfigs()is used and when it isn't.