Introduce dig lookup argument fail_on_error

[tumbl3w33d]

with default False for backwards compatibility.

Allows fail-fast behavior on lookup failures instead of returning strings and continuing.

SUMMARY

I would like the dig lookup to offer the option to fail on lookup errors. Right now it just returns empty strings or something like 'NXDOMAIN' as string which is ugly because you notice quite late that something is wrong with your infrastructure because a dig lookup in some config template produced an unexpected result although your playbook run was clean.

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

dig lookup plugin

ADDITIONAL INFORMATION

IMHO this should be the default, but for backwards compatibility I've disabled it.

[ansibullbot]

cc @jpmens
click here for bot help

[jpmens]

For the record, this behaviour was originally proposed in ansible/ansible#41192 and in ansible/ansible#41195 (at least that's the way I recall it).

I am all for this change, and think we should, indeed, make fail_on_error default to True at some stage. (Why not introduce a deprecation on the current behaviour?)

[jpmens]

shipit

[github-actions]

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

[felixfontein]

Thanks for your contribution! Could you please add a changelog fragment? Thanks :)

[felixfontein]

I am all for this change, and think we should, indeed, make fail_on_error default to True at some stage. (Why not introduce a deprecation on the current behaviour?)

Since the current behavior has been the default for a very long time, I would wait a bit before making it configurable and deprecating the old behavior, to give users at least some versions of this collection that are backwards compatible but do not yet spit out deprecation warnings.

(I'm fine with announcing deprecation in the next major release, i.e. 6.0.0, and announcing the default value change for version 8.0.0. In fact the deprecation can already be merged in a follow-up, since by keeping it in main and not backporting it will be only in 6.x.y releases, but not in 5.x.y releases.)