briantist commented 3 years ago

SUMMARY

Fixes: #116 Resolves: #35

Pulling the auth out of the lookup and into their own auth classes. Getting us one step closer to new plugins, and drastically reducing the size and complexity of the lookup plugin.

Major Changes

new HashiVaultAuthMethodBase class to serve as a base for all auth methods to be in their own classes (with unit tests)
every auth method pulled out of the hashi_vault lookup plugin, and put into its own auth class 🎉
new HashiVaultAuthenticator class serves as a single entry point that holds instances of all the other auth classes. Any content that needs to authenticate can use this one class, and doesn't need to be directly updated when new auth methods are introduced. Units also added for this class.
The HashiVault class is no longer needed and removed from the lookup plugin; everything in it has been moved out to auth methods, except the get function which moved back into the LookupModule class.
With those changes above, all plugin options access is now done correctly through Config Manager (#35) 🎉
Imports and other stuff not needed is removed from the lookup plugin.
auth method docstrings moved to a doc_fragment (this will need updates later, but for now it's all together in a single fragment)
HashiVaultConnectionOptions class moved to its own file.

Minor Changes

fixed a bad import fallback for retries (#116)
coverage flag to file mappings added (in anticipation of rebasing once #114 lands)
a unit test for missing retry support was added

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

codecov[bot] commented 3 years ago

Codecov Report

Merging #113 (e5cf9d6) into main (15742bc) will increase coverage by 2.24%. The diff coverage is 80.30%.

:exclamation: Current head e5cf9d6 differs from pull request most recent head 9443f93. Consider uploading reports for the commit 9443f93 to get more accurate results

@@            Coverage Diff             @@
##             main     #113      +/-   ##
==========================================
+ Coverage   83.52%   85.76%   +2.24%     
==========================================
  Files          16       29      +13     
  Lines         892     1082     +190     
  Branches       87       83       -4     
==========================================
+ Hits          745      928     +183     
- Misses        129      141      +12     
+ Partials       18       13       -5

Flag	Coverage Δ
env_docker-default	`85.76% <80.30%> (+2.24%)`	:arrow_up:
integration	`71.81% <68.23%> (+3.19%)`	:arrow_up:
py2.6	`71.80% <70.53%> (-3.44%)`	:arrow_down:
py2.7	`78.37% <77.24%> (+2.36%)`	:arrow_up:
py3.10	`85.02% <79.86%> (+2.40%)`	:arrow_up:
py3.5	`78.74% <77.46%> (+2.28%)`	:arrow_up:
py3.6	`78.74% <77.46%> (+2.28%)`	:arrow_up:
py3.7	`78.74% <77.46%> (+2.28%)`	:arrow_up:
py3.8	`85.02% <79.86%> (+2.18%)`	:arrow_up:
py3.9	`85.02% <79.86%> (+2.40%)`	:arrow_up:
target_auth_none	`100.00% <100.00%> (+48.91%)`	:arrow_up:
target_connection_options	`73.78% <73.78%> (+7.52%)`	:arrow_up:
target_controller	`67.98% <47.51%> (+2.62%)`	:arrow_up:
target_lookup_hashi_vault	`78.75% <75.00%> (+16.77%)`	:arrow_up:
target_module_utils	`81.60% <73.91%> (-6.70%)`	:arrow_down:
units	`81.05% <70.67%> (+3.81%)`	:arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
plugins/module_utils/_auth_method_aws_iam_login.py	`21.56% <21.56%> (ø)`
plugins/module_utils/_auth_method_userpass.py	`50.00% <50.00%> (ø)`
plugins/module_utils/_auth_method_ldap.py	`57.89% <57.89%> (ø)`
plugins/module_utils/_auth_method_token.py	`68.00% <68.00%> (ø)`
plugins/lookup/hashi_vault.py	`81.25% <75.00%> (+17.40%)`	:arrow_up:
plugins/module_utils/_auth_method_approle.py	`89.47% <89.47%> (ø)`
plugins/module_utils/_connection_options.py	`90.29% <90.29%> (ø)`
plugins/module_utils/_auth_method_jwt.py	`91.66% <91.66%> (ø)`
plugins/doc_fragments/auth.py	`100.00% <100.00%> (ø)`
plugins/module_utils/_auth_method_none.py	`100.00% <100.00%> (ø)`
... and 20 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update ba33e4c...9443f93. Read the comment docs.

github-actions[bot] commented 3 years ago

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and the docs are now incorporated into main: https://community-hashi-vault-main.surge.sh