Fix for core changes: stop stripping Unsafe, adapt adapter to config manager changes

briantist commented 6 months ago

Changes to `requests` requirement

The requests package which is required by hvac now has a more restrictive range for this collection due to breaking security changes in ansible-core that were backported. These changes were backported to core 2.14, 2.15, and 2.16.
These restrictions only apply to situations where values marked "unsafe" by Ansible (usually coming from lookup plugins) are used as values for options that are used in HTTP headers. These options are token and namespace.
- https://github.com/ansible-collections/community.hashi_vault/issues/289
Specifically, the problem occurs with unsafe values used with requests>=2.28,<2.29
The collection previously worked around this by stripping the unsafe wrapper, but the core changes have made this more difficult, and requests updated their overly restrictive type requirement, so as of this PR, we will no longer attempt to strip unsafe.
- https://github.com/ansible-collections/community.hashi_vault/pull/291
- https://github.com/ansible-collections/community.hashi_vault/pull/310

Changes related to the option adapter and validation

A change is core (devel) changes the way config manager (which is used in plugins) sets options, to now "get" the option before setting it.
- https://github.com/ansible/ansible/pull/82300
This changes the behavior of the set_option/set_options API in plugins by:
- failing if the option name you're referencing is not defined in documentation
- casting/validating the option value to the type defined in documentation (unless it's defined as raw)
This affected us in a few areas where we used the options API as a value store for some plugin-internal values, and in one area where an option (ca_cert) is supposed to be a str but internally could be overwritten to str or bool.
- all areas were updated to avoid the new behavior or work around it in some way
- tests around the option adapter were updated to check for the now differing behavior between an adapter backed by a dict vs. backed by config manager
The core change and the changes we made to compensate are internal implementation details and there are no user-facing changes at this time.

Other changes

The docker localenv now limits its version of the docker SDK in its requirements. This only affects development and testing of the collection.
The constraints.txt file we had (for tests) was in the wrong place and was not being used. It's been deleted from the old place and duplicated into the unit and integration tests directories.
Removed fail-fast on unit and sanity tests in CI

SUMMARY

Fixes #412 Fixes #417

ISSUE TYPE

Bugfix Pull Request

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (10d7d7e) 98.85% compared to head (3265184) 98.83%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #416 +/- ## ========================================== - Coverage 98.85% 98.83% -0.03% ========================================== Files 82 79 -3 Lines 4282 4197 -85 Branches 841 825 -16 ========================================== - Hits 4233 4148 -85 Misses 39 39 Partials 10 10 ``` | [Flag](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | Coverage Δ | | |---|---|---| | [env_docker-default](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `98.83% <100.00%> (-0.03%)` | :arrow_down: | | [integration](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `81.25% <100.00%> (+0.20%)` | :arrow_up: | | [sanity](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `39.24% <0.00%> (-0.01%)` | :arrow_down: | | [target_auth_approle](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `89.47% <ø> (ø)` | | | [target_auth_aws_iam](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `50.00% <ø> (ø)` | | | [target_auth_azure](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `53.84% <ø> (ø)` | | | [target_auth_cert](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `86.36% <ø> (ø)` | | | [target_auth_jwt](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `91.30% <ø> (ø)` | | | [target_auth_ldap](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `89.47% <ø> (ø)` | | | [target_auth_none](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `100.00% <ø> (ø)` | | | [target_auth_token](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `71.42% <100.00%> (ø)` | | | [target_auth_userpass](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `85.71% <ø> (ø)` | | | [target_connection_options](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `74.76% <100.00%> (ø)` | | | [target_controller](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `83.40% <98.18%> (-0.64%)` | :arrow_down: | | [target_filter_vault_login_token](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `77.77% <ø> (ø)` | | | [target_import](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `39.24% <0.00%> (-0.01%)` | :arrow_down: | | [target_lookup_hashi_vault](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `81.33% <100.00%> (ø)` | | | [target_lookup_vault_ansible_settings](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `56.00% <80.00%> (-0.08%)` | :arrow_down: | | [target_lookup_vault_kv1_get](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `91.30% <ø> (ø)` | | | [target_lookup_vault_kv2_get](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `91.11% <ø> (ø)` | | | [target_lookup_vault_list](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `90.00% <ø> (ø)` | | | [target_lookup_vault_login](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `88.57% <ø> (ø)` | | | [target_lookup_vault_read](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `90.00% <ø> (ø)` | | | [target_lookup_vault_token_create](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `79.24% <ø> (ø)` | | | [target_lookup_vault_write](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `56.95% <80.00%> (-0.07%)` | :arrow_down: | | [target_module_utils](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `96.74% <72.72%> (-0.75%)` | :arrow_down: | | [target_module_vault_kv1_get](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `87.50% <ø> (ø)` | | | [target_module_vault_kv2_delete](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `56.85% <80.00%> (-0.08%)` | :arrow_down: | | [target_module_vault_kv2_get](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `87.23% <ø> (ø)` | | | [target_module_vault_kv2_write](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `57.26% <80.00%> (-0.07%)` | :arrow_down: | | [target_module_vault_list](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `85.71% <ø> (ø)` | | | [target_module_vault_login](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `83.72% <ø> (ø)` | | | [target_module_vault_pki_generate_certificate](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `78.72% <ø> (ø)` | | | [target_module_vault_read](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `85.71% <ø> (ø)` | | | [target_module_vault_token_create](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `91.66% <ø> (ø)` | | | [target_module_vault_write](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `56.02% <80.00%> (-0.10%)` | :arrow_down: | | [target_modules](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `82.67% <60.00%> (+0.31%)` | :arrow_up: | | [units](https://app.codecov.io/gh/ansible-collections/community.hashi_vault/pull/416/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections) | `95.49% <100.00%> (-0.09%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ansible-collections#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-actions[bot] commented 6 months ago

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and the docs are now incorporated into main: https://ansible-collections.github.io/community.hashi_vault/branch/main

ansible-collections / community.hashi_vault