Feature idea: check_mode for callbacks

Archives Ansible Developer
1

Hi all,

Proposing the following feature idea in the hopes that someone will tell me it’s already available.

We currently run all of our playbooks through ansible-playbook -c as part of automated testing. We also have a callback that depends on some environment configuration in the __init__ function. It would be nice if we could determine if we are running under check_mode in the callback to skip this validation (you could also see this being useful for callbacks with other behaviour during init). This feature would be similar to how you can determine, in an Ansible module, if you are in check_mode to change the behaviour.

-Jesse

2

You should be able to achieve this by implementing some code that looks like:

def playbook_on_start(self):
self.disabled = self.playbook.check

3

Callbacks are output mechanisms, so you wouldn’t be doing any validation in a callback.

Or at least, I’m not sure I know what validation you mean. Can you tell me more about what’s going in your custom callback?

4

Ah! Thank you Matt, I didn’t realize it’d be available via the playbook; I can move initialization there.

Michael, the custom callback is doing Hipchat notification (similar to https://github.com/ansible/ansible/blob/devel/plugins/callbacks/hipchat.py) and requires some environment variables to be set to run. If they aren’t set it outputs a warning (similar to the example plugin). We were just trying to avoid the warnings during ansible-playbook -c.

Thank you both!