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.

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 a function that can reload config files #64

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

oneirocosm
Copy link

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.

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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant