diff --git a/changelogs/fragments/vault-vaultid-removal.yml b/changelogs/fragments/vault-vaultid-removal.yml new file mode 100644 index 00000000000..d61fad7716d --- /dev/null +++ b/changelogs/fragments/vault-vaultid-removal.yml @@ -0,0 +1,2 @@ +removed_features: + - "``vault``/``unvault`` filters - remove the deprecated ``vaultid`` parameter." diff --git a/lib/ansible/plugins/filter/encryption.py b/lib/ansible/plugins/filter/encryption.py index 78c50422c1c..c6d1d732146 100644 --- a/lib/ansible/plugins/filter/encryption.py +++ b/lib/ansible/plugins/filter/encryption.py @@ -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)]) diff --git a/test/sanity/ignore.txt b/test/sanity/ignore.txt index 07b4474dc64..f91ad837e8a 100644 --- a/test/sanity/ignore.txt +++ b/test/sanity/ignore.txt @@ -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