1867909 – Vault module does not return a dict of values.

RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 1867909 - Vault module does not return a dict of values.

Summary: Vault module does not return a dict of values.

Keywords:
Status:	CLOSED ERRATA
Alias:	None
Product:	Red Hat Enterprise Linux 8
Classification:	Red Hat
Component:	ansible-freeipa
Sub Component:
Version:	8.3
Hardware:	Unspecified
OS:	Unspecified
Priority:	unspecified
Severity:	unspecified
Target Milestone:	rc
Target Release:	8.0
Assignee:	Rafael Jeffman
QA Contact:	ipa-qe
Docs Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+	depends on / blocked

Reported:	2020-08-11 07:48 UTC by Rafael Jeffman
Modified:	2020-11-04 02:47 UTC (History)
CC List:	3 users (show)
Fixed In Version:
Doc Type:	If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed:	2020-11-04 02:46:57 UTC
Type:	Bug
Target Upstream Version:
Embargoed:
Dependent Products:
Flags:	pm-rhel: mirror+

Attachments	(Terms of Use)

Links
System	ID	Private	Priority	Status	Summary	Last Updated
Red Hat Product Errata	RHEA-2020:4663	0	None	None	None	2020-11-04 02:46:59 UTC

Description Rafael Jeffman 2020-08-11 07:48:00 UTC

Description of problem:

When retrieving vault data, the data is returned in a varible `data`, but this variable should be returned inside a dict object (`vault.data`) to be consistent with other ansible-freeipa modules.

Version-Release number of selected component (if applicable):

0.1.12

How reproducible:

Using the following playbook, the problem is reproduced:

```
---
- name: Test vault
  hosts: ipaserver
  become: true
  # Need to gather facts for ansible_env.
  gather_facts: true


- name: Retrieve data from standard vault.
    ipavault:
      ipaadmin_password: SomeADMINpassword
      name: stdvault
      state: retrieved
    register: result

- debug:
    msg: "{{ result }}"
```


Actual results:

The vault data is retrieved in `result.data`.

Expected results:

The data retrieved should be in `result.vault.data`.

Comment 1 Rafael Jeffman 2020-08-11 07:59:30 UTC

There is an upstream PR for this issue: https://github.com/freeipa/ansible-freeipa/pull/342

Comment 3 Rafael Jeffman 2020-08-11 18:34:25 UTC

Sumedh, yes the current automation should be enough.

Comment 5 Thomas Woerner 2020-08-18 07:10:30 UTC

The upstream PR has been merged.

Comment 8 Varun Mylaraiah 2020-08-19 07:26:10 UTC

Verified

ansible-freeipa-0.1.12-6.el8.noarch

Passed	ansible_freeipa_tests/vault_module.py::TestStandardVault::()::test_standard_vault_with_retrieved_data
------------------------------ Captured log call -------------------------------
channel.py                1212 DEBUG    [chan 53] Max packet in: 32768 bytes
channel.py                1212 DEBUG    [chan 53] Max packet out: 32768 bytes
transport.py              1819 DEBUG    Secsh channel 53 opened.
transport.py               318 INFO     RUN ['kinit', 'admin']
transport.py               519 DEBUG    RUN ['kinit', 'admin']
channel.py                1212 DEBUG    [chan 53] Sesch channel 53 request ok
transport.py               563 DEBUG    -bash: line 1: cd: /root/multihost_tests: No such file or directory
transport.py               563 DEBUG    -bash: line 2: /root/multihost_tests/env.sh: No such file or directory
transport.py               563 DEBUG    Password for admin: 
channel.py                1212 DEBUG    [chan 53] EOF received (53)
channel.py                1212 DEBUG    [chan 53] EOF sent (53)
transport.py               217 DEBUG    Exit code: 0
channel.py                1212 DEBUG    [chan 54] Max packet in: 32768 bytes
channel.py                1212 DEBUG    [chan 54] Max packet out: 32768 bytes
transport.py              1819 DEBUG    Secsh channel 54 opened.
transport.py               318 INFO     RUN ['ipa', 'vault-retrieve', '21stdvault']
transport.py               519 DEBUG    RUN ['ipa', 'vault-retrieve', '21stdvault']
channel.py                1212 DEBUG    [chan 54] Sesch channel 54 request ok
transport.py               563 DEBUG    -bash: line 1: cd: /root/multihost_tests: No such file or directory
transport.py               563 DEBUG    -bash: line 2: /root/multihost_tests/env.sh: No such file or directory
transport.py               563 DEBUG    --------------------------------------
transport.py               563 DEBUG    Retrieved data from vault "21stdvault"
transport.py               563 DEBUG    --------------------------------------
transport.py               563 DEBUG      Data: VGVzdF9WYXVsdF9EYXRh
channel.py                1212 DEBUG    [chan 54] EOF received (54)
channel.py                1212 DEBUG    [chan 54] EOF sent (54)
transport.py               217 DEBUG    Exit code: 0
channel.py                1212 DEBUG    [chan 55] Max packet in: 32768 bytes
channel.py                1212 DEBUG    [chan 55] Max packet out: 32768 bytes
transport.py              1819 DEBUG    Secsh channel 55 opened.
transport.py               318 INFO     RUN ['kdestroy', '-A']
transport.py               519 DEBUG    RUN ['kdestroy', '-A']
channel.py                1212 DEBUG    [chan 55] Sesch channel 55 request ok
transport.py               563 DEBUG    -bash: line 1: cd: /root/multihost_tests: No such file or directory
transport.py               563 DEBUG    -bash: line 2: /root/multihost_tests/env.sh: No such file or directory
channel.py                1212 DEBUG    [chan 55] EOF received (55)
channel.py                1212 DEBUG    [chan 55] EOF sent (55)
transport.py               217 DEBUG    Exit code: 0
transport.py               293 INFO     WRITE inventory/vault.hosts
sftp.py                    158 DEBUG    [chan 0] open(b'inventory/vault.hosts', 'wb')
sftp.py                    158 DEBUG    [chan 0] open(b'inventory/vault.hosts', 'wb') -> 00000000
sftp.py                    158 DEBUG    [chan 0] close(00000000)
transport.py               329 INFO     PUT vault_module.yml
sftp.py                    158 DEBUG    [chan 0] open(b'vault_module.yml', 'wb')
sftp.py                    158 DEBUG    [chan 0] open(b'vault_module.yml', 'wb') -> 00000000
sftp.py                    158 DEBUG    [chan 0] close(00000000)
sftp.py                    158 DEBUG    [chan 0] stat(b'vault_module.yml')
channel.py                1212 DEBUG    [chan 13] Max packet in: 32768 bytes
channel.py                1212 DEBUG    [chan 13] Max packet out: 32768 bytes
transport.py              1819 DEBUG    Secsh channel 13 opened.
transport.py               318 INFO     RUN ['ansible-playbook', '--ssh-extra-args="-o StrictHostKeyChecking=no"', '-vv', '-i', 'inventory/vault.hosts', 'vault_module.yml']
transport.py               519 DEBUG    RUN ['ansible-playbook', '--ssh-extra-args="-o StrictHostKeyChecking=no"', '-vv', '-i', 'inventory/vault.hosts', 'vault_module.yml']
channel.py                1212 DEBUG    [chan 13] Sesch channel 13 request ok
transport.py               563 DEBUG    -bash: line 1: cd: /root/multihost_tests: No such file or directory
transport.py               563 DEBUG    -bash: line 2: /root/multihost_tests/env.sh: No such file or directory
transport.py               563 DEBUG    ansible-playbook 2.9.12
transport.py               563 DEBUG      config file = /root/ansible.cfg
transport.py               563 DEBUG      configured module search path = ['/root/ansible-freeipa/plugins/modules', '/usr/share/ansible/plugins/modules']
transport.py               563 DEBUG      ansible python module location = /usr/lib/python3.6/site-packages/ansible
transport.py               563 DEBUG      executable location = /usr/bin/ansible-playbook
transport.py               563 DEBUG      python version = 3.6.8 (default, Jun 26 2020, 12:10:09) [GCC 8.3.1 20191121 (Red Hat 8.3.1-5)]
transport.py               563 DEBUG    Using /root/ansible.cfg as config file
transport.py               563 DEBUG    
transport.py               563 DEBUG    PLAYBOOK: vault_module.yml *****************************************************
transport.py               563 DEBUG    1 plays in vault_module.yml
transport.py               563 DEBUG    
transport.py               563 DEBUG    PLAY [Playbook to ensure data is retrieved from standard vault.] ***************
transport.py               563 DEBUG    
transport.py               563 DEBUG    TASK [Gathering Facts] *********************************************************
transport.py               563 DEBUG    task path: /root/vault_module.yml:2
transport.py               563 DEBUG    ok: [master.ipadomain.test]
transport.py               563 DEBUG    META: ran handlers
transport.py               563 DEBUG    
transport.py               563 DEBUG    TASK [ipavault] ****************************************************************
transport.py               563 DEBUG    task path: /root/vault_module.yml:6
transport.py               563 DEBUG    ok: [master.ipadomain.test] => {"changed": false, "vault": {"data": "Test_Vault_Data"}}
transport.py               563 DEBUG    META: ran handlers
transport.py               563 DEBUG    META: ran handlers
transport.py               563 DEBUG    
transport.py               563 DEBUG    PLAY RECAP *********************************************************************
transport.py               563 DEBUG    master.ipadomain.test      : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0   
transport.py               563 DEBUG    
channel.py                1212 DEBUG    [chan 13] EOF received (13)
channel.py                1212 DEBUG    [chan 13] EOF sent (13)
transport.py               217 DEBUG    Exit code: 0

Comment 11 errata-xmlrpc 2020-11-04 02:46:57 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (ansible-freeipa bug fix and enhancement update), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHEA-2020:4663

Note You need to log in before you can comment on or make changes to this bug.