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

feat: add secrets support for tap and target config, via Property(..., secret=True) #1096

Merged
merged 22 commits into from
Oct 21, 2022

Conversation

aaronsteers
Copy link
Contributor

@aaronsteers aaronsteers commented Oct 20, 2022

Changes:

  • Implement writeOnly=True support for passwords and other secrets, as per the JSON Schema spec.
  • Additionally implement a secret=True annotation to help with readability for humans.
  • The Property type helper class now now implements both of the above via a secret=True argument in the constructor.
  • The same type helpers may be used within schema declarations for streams.

Todo:

  • Docs for tap config
  • [ ] Docs for stream schema creation

Note:

singer_sdk/typing.py Show resolved Hide resolved
singer_sdk/typing.py Outdated Show resolved Hide resolved
singer_sdk/plugin_base.py Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Oct 21, 2022

Codecov Report

Merging #1096 (8eb0026) into main (6563a47) will decrease coverage by 0.18%.
The diff coverage is 60.97%.

@@            Coverage Diff             @@
##             main    #1096      +/-   ##
==========================================
- Coverage   83.60%   83.41%   -0.19%     
==========================================
  Files          40       40              
  Lines        3805     3840      +35     
  Branches      640      655      +15     
==========================================
+ Hits         3181     3203      +22     
- Misses        464      472       +8     
- Partials      160      165       +5     
Impacted Files Coverage Δ
singer_sdk/helpers/_typing.py 50.31% <50.00%> (+2.24%) ⬆️
singer_sdk/plugin_base.py 75.14% <100.00%> (ø)
singer_sdk/sinks/core.py 80.64% <100.00%> (ø)
singer_sdk/typing.py 94.56% <100.00%> (+0.09%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@edgarrmondragon
Copy link
Collaborator

pre-commit.ci autofix

@aaronsteers aaronsteers requested review from a team as code owners October 21, 2022 22:54
@aaronsteers aaronsteers changed the title feat: add secrets support in config and streams feat: add secrets support for tap and target config, via Property(..., secret=True) Oct 21, 2022
@aaronsteers aaronsteers merged commit 253851e into main Oct 21, 2022
@aaronsteers aaronsteers deleted the 77-feat-secrets-support-in-config-and-streams branch October 21, 2022 23:14
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.

2 participants