KeyError 'Options' from opensearch module_utils #1907

phene · 2023-08-04T20:42:06Z

Summary

The opensearch module_utils has a function called get_domain_config, which performs the AWS API call DescribeDomainConfig docs here. The function assumes that every property of the response has an Options key, but the ChangeProgressDetails section does not. Because of this, using the opensearch_info modules results in a KeyError.

Buggy code is here

Issue Type

Bug Report

Component Name

opensearch_info
get_domain_config in opensearch module_utils

Ansible Version

Not relevent

Collection Versions

4.5.0+

AWS SDK versions

boto3==1.26.35
botocore==1.29.35

Configuration

n/a

OS / Environment

n/a

Steps to Reproduce

- name: Get OpenSearch domain info
  community.aws.opensearch_info:
    domain_name: "{{ opensearch_domain_name }}"
  register: opensearch_domain_info

Expected Results

Fetches the domain info

Actual Results

  File "/home/localuser/.ansible/tmp/ansible-tmp-1691179537.8669083-2393-273467034050220/AnsiballZ_opensearch_info.py", line 102, in <module>
    _ansiballz_main()
  File "/home/localuser/.ansible/tmp/ansible-tmp-1691179537.8669083-2393-273467034050220/AnsiballZ_opensearch_info.py", line 94, in _ansiballz_main
    invoke_module(zipped_mod, temp_path, ANSIBALLZ_PARAMS)
  File "/home/localuser/.ansible/tmp/ansible-tmp-1691179537.8669083-2393-273467034050220/AnsiballZ_opensearch_info.py", line 40, in invoke_module
    runpy.run_module(mod_name='ansible_collections.community.aws.plugins.modules.opensearch_info', init_globals=None, run_name='__main__', alter_sys=True)
  File "/usr/lib/python3.7/runpy.py", line 205, in run_module
    return _run_module_code(code, init_globals, run_name, mod_spec)
  File "/usr/lib/python3.7/runpy.py", line 96, in _run_module_code
    mod_name, mod_spec, pkg_name, script_name)
  File "/usr/lib/python3.7/runpy.py", line 85, in _run_code
    exec(code, run_globals)
  File "/tmp/ansible_community.aws.opensearch_info_payload_h7ih8g0o/ansible_community.aws.opensearch_info_payload.zip/ansible_collections/community/aws/plugins/modules/opensearch_info.py", line 530, in <module>
  File "/tmp/ansible_community.aws.opensearch_info_payload_h7ih8g0o/ansible_community.aws.opensearch_info_payload.zip/ansible_collections/community/aws/plugins/modules/opensearch_info.py", line 526, in main
  File "/tmp/ansible_community.aws.opensearch_info_payload_h7ih8g0o/ansible_community.aws.opensearch_info_payload.zip/ansible_collections/community/aws/plugins/modules/opensearch_info.py", line 502, in domain_info
  File "/tmp/ansible_community.aws.opensearch_info_payload_h7ih8g0o/ansible_community.aws.opensearch_info_payload.zip/ansible_collections/community/aws/plugins/module_utils/opensearch.py", line 63, in get_domain_config
KeyError: 'Options'

Code of Conduct

I agree to follow the Ansible Code of Conduct

The text was updated successfully, but these errors were encountered:

ansibullbot · 2023-08-04T20:44:58Z

Files identified in the description:

[plugins/modules/opensearch.py](https://github.com/['ansible-collections/amazon.aws', 'ansible-collections/community.aws', 'ansible-collections/community.vmware']/blob/main/plugins/modules/opensearch.py)
[plugins/modules/opensearch_info.py](https://github.com/['ansible-collections/amazon.aws', 'ansible-collections/community.aws', 'ansible-collections/community.vmware']/blob/main/plugins/modules/opensearch_info.py)

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

ansibullbot · 2023-08-04T20:44:59Z

cc @jillr @markuman @s-hertel @sebastien-rosset @tremble
click here for bot help

RonneGisun · 2023-08-20T23:23:47Z

Same result for all examples (https://docs.ansible.com/ansible/latest//collections/community/aws/opensearch_info_module.html#examples)
Python 3.10
community.aws 5.5.0

- name: Get all OpenSearch instances that have the specified Doamin Name
  community.aws.opensearch_info:
    region: "{{ application_region }}"
    domain_name: "{{ aws_opensearch_domain_name }}"

- name: Get all OpenSearch instances
  community.aws.opensearch_info:
    region: "{{ application_region }}"

- name: Get all OpenSearch instances that have the specified Key, Value tags
  community.aws.opensearch_info:
    region: "{{ application_region }}"
    tags:
      Application: "{{ application_name }}"
      Environment: "{{ application_environment }}"

The full traceback is:
Traceback (most recent call last):
  File "<stdin>", line 107, in <module>
  File "<stdin>", line 99, in _ansiballz_main
  File "<stdin>", line 47, in invoke_module
  File "/usr/local/lib/python3.10/runpy.py", line 224, in run_module
    return _run_module_code(code, init_globals, run_name, mod_spec)
  File "/usr/local/lib/python3.10/runpy.py", line 96, in _run_module_code
    _run_code(code, mod_globals, init_globals,
  File "/usr/local/lib/python3.10/runpy.py", line 86, in _run_code
    exec(code, run_globals)
  File "/tmp/ansible_community.aws.opensearch_info_payload_bacvlzh4/ansible_community.aws.opensearch_info_payload.zip/ansible_collections/community/aws/plugins/modules/opensearch_info.py", line 531, in <module>
  File "/tmp/ansible_community.aws.opensearch_info_payload_bacvlzh4/ansible_community.aws.opensearch_info_payload.zip/ansible_collections/community/aws/plugins/modules/opensearch_info.py", line 527, in main
  File "/tmp/ansible_community.aws.opensearch_info_payload_bacvlzh4/ansible_community.aws.opensearch_info_payload.zip/ansible_collections/community/aws/plugins/modules/opensearch_info.py", line 503, in domain_info
  File "/tmp/ansible_community.aws.opensearch_info_payload_bacvlzh4/ansible_community.aws.opensearch_info_payload.zip/ansible_collections/community/aws/plugins/module_utils/opensearch.py", line 63, in get_domain_config
KeyError: 'Options'

markuman · 2023-08-21T07:58:18Z

ref #1910

opensearch: avoid a KeyError during the DomainConfig reading This commit avoids a KeyError exception in get_domain_config(). Some entries from DomainConfig don't have any Options key. For instance, ChangeProgressDetails. See: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainConfig.html https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ChangeProgressDetails.html Closes: #1907 Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis

opensearch: avoid a KeyError during the DomainConfig reading This commit avoids a KeyError exception in get_domain_config(). Some entries from DomainConfig don't have any Options key. For instance, ChangeProgressDetails. See: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainConfig.html https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ChangeProgressDetails.html Closes: #1907 Reviewed-by: Markus Bergholz <[email protected]> Reviewed-by: Alina Buzachis (cherry picked from commit 9a9c8c5)

…1923) [PR #1910/9a9c8c58 backport][stable-6] opensearch: avoid a KeyError during the DomainConfig reading This is a backport of PR #1910 as merged into main (9a9c8c5). This commit avoids a KeyError exception in get_domain_config(). Some entries from DomainConfig don't have any Options key. For instance, ChangeProgressDetails. See: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainConfig.html https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ChangeProgressDetails.html Closes: #1907 Reviewed-by: Alina Buzachis

…1922) [PR #1910/9a9c8c58 backport][stable-5] opensearch: avoid a KeyError during the DomainConfig reading This is a backport of PR #1910 as merged into main (9a9c8c5). This commit avoids a KeyError exception in get_domain_config(). Some entries from DomainConfig don't have any Options key. For instance, ChangeProgressDetails. See: https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainConfig.html https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ChangeProgressDetails.html Closes: #1907 Reviewed-by: Alina Buzachis

ansibullbot added bug This issue/PR relates to a bug module module needs_triage plugins plugin (any type) python3 traceback labels Aug 4, 2023

ansibullbot removed the needs_triage label Aug 21, 2023

goneri mentioned this issue Aug 30, 2023

opensearch: avoid a KeyError during the DomainConfig reading #1910

Merged

softwarefactory-project-zuul bot closed this as completed in #1910 Aug 31, 2023

patchback bot mentioned this issue Aug 31, 2023

[PR #1910/9a9c8c58 backport][stable-5] opensearch: avoid a KeyError during the DomainConfig reading #1922

Merged

patchback bot mentioned this issue Aug 31, 2023

[PR #1910/9a9c8c58 backport][stable-6] opensearch: avoid a KeyError during the DomainConfig reading #1923

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

KeyError 'Options' from opensearch module_utils #1907

KeyError 'Options' from opensearch module_utils #1907

phene commented Aug 4, 2023 •

edited

Loading

ansibullbot commented Aug 4, 2023

ansibullbot commented Aug 4, 2023

RonneGisun commented Aug 20, 2023 •

edited

Loading

markuman commented Aug 21, 2023 •

edited

Loading

KeyError 'Options' from opensearch module_utils #1907

KeyError 'Options' from opensearch module_utils #1907

Comments

phene commented Aug 4, 2023 • edited Loading

Summary

Issue Type

Component Name

Ansible Version

Collection Versions

AWS SDK versions

Configuration

OS / Environment

Steps to Reproduce

Expected Results

Actual Results

Code of Conduct

ansibullbot commented Aug 4, 2023

ansibullbot commented Aug 4, 2023

RonneGisun commented Aug 20, 2023 • edited Loading

markuman commented Aug 21, 2023 • edited Loading

phene commented Aug 4, 2023 •

edited

Loading

RonneGisun commented Aug 20, 2023 •

edited

Loading

markuman commented Aug 21, 2023 •

edited

Loading