OSSForks/ansible
1
0
Fork 0
mirror of https://github.com/zebrajr/ansible.git synced 2025-12-06 00:19:48 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

vault/unvault filters: remove deprecated vaultid parameter (#85744)

Browse Source
This commit is contained in:
Martin Krizek 2025-08-26 15:11:57 +02:00 committed by GitHub
parent 7b598f3fc9
commit 5e78bc8eda
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 5 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelogs/fragments/vault-vaultid-removal.yml Normal file
View File

@ -0,0 +1,2 @@
removed_features:
- "``vault``/``unvault`` filters - remove the deprecated ``vaultid`` parameter."

30
lib/ansible/plugins/filter/encryption.py
View File

@ -13,25 +13,13 @@ from ansible.utils.display import Display
display = Display()
def do_vault(data, secret, salt=None, vault_id='filter_default', wrap_object=False, vaultid=None):
def do_vault(data, secret, salt=None, vault_id='filter_default', wrap_object=False):
if not isinstance(secret, (str, bytes)):
raise TypeError(f"Secret passed is required to be a string, instead we got {type(secret)}.")
if not isinstance(data, (str, bytes)):
raise TypeError(f"Can only vault strings, instead we got {type(data)}.")
if vaultid is not None:
display.deprecated(
msg="Use of undocumented `vaultid`.",
version="2.20",
help_text="Use `vault_id` instead.",
)
if vault_id == 'filter_default':
vault_id = vaultid
else:
display.warning("Ignoring vaultid as vault_id is already set.")
vs = VaultSecret(to_bytes(secret))
vl = VaultLib()
try:
@ -48,11 +36,11 @@ def do_vault(data, secret, salt=None, vault_id='filter_default', wrap_object=Fal
@_template.accept_args_markers
def do_unvault(vault, secret, vault_id='filter_default', vaultid=None):
def do_unvault(vault, secret, vault_id='filter_default'):
if isinstance(vault, VaultExceptionMarker):
vault = vault._disarm()
if (first_marker := _template.get_first_marker_arg((vault, secret, vault_id, vaultid), {})) is not None:
if (first_marker := _template.get_first_marker_arg((vault, secret, vault_id), {})) is not None:
return first_marker
if not isinstance(secret, (str, bytes)):
@ -61,18 +49,6 @@ def do_unvault(vault, secret, vault_id='filter_default', vaultid=None):
if not isinstance(vault, (str, bytes)):
raise TypeError(f"Vault should be in the form of a string, instead we got {type(vault)}.")
if vaultid is not None:
display.deprecated(
msg="Use of undocumented `vaultid`.",
version="2.20",
help_text="Use `vault_id` instead.",
)
if vault_id == 'filter_default':
vault_id = vaultid
else:
display.warning("Ignoring vaultid as vault_id is already set.")
vs = VaultSecret(to_bytes(secret))
vl = VaultLib([(vault_id, vs)])

1
test/sanity/ignore.txt
View File

@ -231,7 +231,6 @@ test/integration/targets/ansible-test-sanity-pylint/deprecated_thing.py pylint:a
test/integration/targets/ansible-test-sanity-pylint/deprecated_thing.py pylint:ansible-deprecated-collection-name-not-permitted # required to verify plugin against core
lib/ansible/cli/doc.py pylint:ansible-deprecated-version # TODO: 2.20
lib/ansible/galaxy/api.py pylint:ansible-deprecated-version # TODO: 2.20
lib/ansible/plugins/filter/encryption.py pylint:ansible-deprecated-version # TODO: 2.20
lib/ansible/utils/encrypt.py pylint:ansible-deprecated-version # TODO: 2.20
lib/ansible/utils/ssh_functions.py pylint:ansible-deprecated-version # TODO: 2.20
lib/ansible/vars/manager.py pylint:ansible-deprecated-version-comment # TODO: 2.20