passwordstore: Improve error messages

[jplitza]

Summary

When using the passwordstore lookup plugin and the execution of pass fails (e.g. because the repository doesn't exist, the GPG key isn't present, ...) the output from Ansible simply is:

{"msg": "An unhandled exception occurred while running the lookup plugin 'pass'. Error was a <class 'ansible.errors.AnsibleError'>, original message: Command '['pass', 'show', 'my/secret']' returned non-zero exit status 1."}

This is quite unhelpful, since the exit codes from pass aren't documented.

Issue Type

Feature Idea

Component Name

passwordstore

Additional Information

- debug:
    var: 'lookup("passwordstore", "my/secret")'

When no password store is present, this should output helpful information, such as

{"msg": "An unhandled exception occured while running the lookup plugin 'pass'. Error was a <class 'ansible.errors.AnsibleError'>, original message: Command '['pass', 'show', 'my/secret']' returned non-zero exit status 1, standard error: "Error: You must run:
pass init your-gpg-id
before you may use the password store.".

This information even is available to the AnsibleError class, because the parent exception is a submodule.CalledProcessError which has a output attribute which is populated by the module.

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibullbot]

Files identified in the description:

• plugins/lookup/passwordstore.py

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

click here for bot help

[TheLastProject]

Maybe my old code can be used for this, if the password store module is maintained now: ansible/ansible#47120

(Back then, nobody had merging rights so it was stuck in limbo)

[felixfontein]

I don't think it's actively maintained, but if someone creates a PR that looks reasonable I'll merge it.