Fix an error when rendering a SecretsError with an unknown provider to string #2962
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.
Closes: #TBD
What's Changed
Fix a user-reported issue from public Slack:
This happens in the case where a
Secret
has a configuredprovider
string that doesn't correspond to any registeredSecretsProvider
class; when attempting to get the value of thisSecret
, aSecretProviderError
is raised with aNone
value for itsprovider_class
attribute; when Nautobot attempts to log this error, theSecretError.__str__()
function attempts to dereferenceself.provider_class.__name__
which throws the aboveAttributeError
.To fix this issue, I've made the following changes:
SecretError
to store either aprovider_class
class reference (as before) or a rawprovider
string, and let the__str__()
representation of theSecretError
use either.provider
string instead ofNone
when constructing theSecretProviderError
.Additionally:
SecretError
to be raised so that they also now check the string representation of each such exception.TODO