ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-06-10 18:15:39 +00:00
Code Activity

consul_kv: add empty_value option for null Consul values (#12120)

Browse source 
* feat(consul_kv): add empty_value option for null Consul values

Add the ``empty_value`` option to the ``consul_kv`` lookup plugin, allowing
users to control what is returned when a key exists in Consul but has a
null/empty value. Defaults to ``'None'`` to preserve existing behaviour.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat(changelog): add fragment for PR 12120

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* feat(consul_kv): make empty_value a choices option

Replace the free-form string empty_value with a choices option:
textual_none (default, legacy behaviour), python_none, empty_string.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(consul_kv): use dict form for empty_value choices

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Alexei Znamensky 2026-05-31 20:48:48 +12:00 • committed by GitHub
parent 6e6199ae3d
commit d46ce24abb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 24 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
changelogs/fragments/12120-consul-kv-empty-value.yml Normal file
View file

@ -0,0 +1,2 @@
minor_changes:
- consul_kv lookup plugin - add ``empty_value`` option to control what is returned for null Consul values (https://github.com/ansible-collections/community.general/issues/11039, https://github.com/ansible-collections/community.general/pull/12120).

24
plugins/lookup/consul_kv.py
View file

@ -94,6 +94,16 @@ options:
ini:
- section: lookup_consul
key: url
empty_value:
description:
- Controls what is returned when a Consul value is null.
type: str
default: 'textual_none'
choices:
textual_none: Return the string V(None). This is the legacy behavior.
python_none: Return a Python V(null)/V(None) value.
empty_string: Return an empty string.
version_added: 13.1.0
"""
EXAMPLES = r"""
@ -136,6 +146,13 @@ except ImportError:
HAS_CONSUL = False
_EMPTY_VALUE_MAP = {
"textual_none": "None",
"python_none": None,
"empty_string": "",
}
class LookupModule(LookupBase):
def run(self, terms, variables=None, **kwargs):
if not HAS_CONSUL:
@ -165,6 +182,7 @@ class LookupModule(LookupBase):
verify = (ca_path or validate_certs) if validate_certs else False
empty_value = _EMPTY_VALUE_MAP[self.get_option("empty_value")]
values = []
try:
for term in terms:
@ -182,9 +200,11 @@ class LookupModule(LookupBase):
# responds with a single or list of result maps
if isinstance(results[1], list):
for r in results[1]:
values.append(to_text(r["Value"]))
v = r["Value"]
values.append(to_text(v) if v is not None else empty_value)
else:
values.append(to_text(results[1]["Value"]))
v = results[1]["Value"]
values.append(to_text(v) if v is not None else empty_value)
except Exception as e:
raise AnsibleError(f"Error locating '{term}' in kv store. Error was {e}") from e