3078 use otp secret type

[mssalvatore]

What does this PR do?

Uses a SecretStr everywhere OTPs are used. This is a defensive coding measure to prevent OTPs from being accidentally leaked into the logs.

Note

The ISecretVariable was added to attempt to isolate other components from pydantic. While a noble attempt, the interface is too loose to be truly valuable (get_secret_value() returns Any). The OTP type alias itself serves the purpose of isolating the code from pydantic. The only pydantic "leakage" would be the name of the method, get_secret_value(). However, if we removed pydantic, as long as whatever replaced pydantic.SecretStr still provides get_secret_value() -> str, no other code needs to change.

We could provide ISecretStr, but if its interface is identical to SecretStr, I don't see what value that would offer us.

An additional note: We'd prefer OTP to be a concrete type so that strings can be converted to OTPs easily with OTP(my_otp_str).

Scope

We need to make the same changes for the Token type, but that is out of scope for this PR.

PR Checklist

• Have you added an explanation of what your changes do and why you'd like to include them?
• Is the TravisCI build passing?
• Was the CHANGELOG.md updated to reflect the changes?
• Was the documentation framework updated to reflect the changes?
• Have you checked that you haven't introduced any duplicate code?

Testing Checklist

• Added relevant unit tests?
• Do all unit tests pass?
• Do all end-to-end tests pass?
• Any other testing performed?
• If applicable, add screenshots or log transcripts of the feature working

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -0.03 ⚠️

Comparison is base (beee177) 73.05% compared to head (7539afd) 73.02%.

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3202      +/-   ##
===========================================
- Coverage    73.05%   73.02%   -0.03%     
===========================================
  Files          471      469       -2     
  Lines        13585    13566      -19     
===========================================
- Hits          9924     9907      -17     
+ Misses        3661     3659       -2     

see 11 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.