Deprecate DISPLAY_SKIPPED_HOSTS in favor of ANSIBLE_ prefix

[jamescassell]

SUMMARY

Most (all?) environment variables that configure ansible are prefixed with ANSIBLE_ which makes it easy to search for these, and unset them as the case requires. A notable exception is DISPLAY_SKIPPED_HOSTS which has been around forever but has not seen much use until recently due to the actionable and skippy stdout_callback plugins being available to implement the functionality.

I propose to deprecate this and any other env vars that don't start w/ ANSIBLE_ and make the ANSIBLE_ version override if both are defined.

Turns out it was in commit d5f20e6 that DISPLAY_SKIPPED_HOSTS was added. At that time, it was the only env var in lib/ansible/constants.py to NOT start with ANSIBLE_

ISSUE TYPE

• Bug Report

COMPONENT NAME

default callback plugin
skippy
actionable

ANSIBLE VERSION

ansible 2.7.7
  config file = /etc/ansible/ansible.cfg
  configured module search path = ['/home/user/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /usr/lib/python3.7/site-packages/ansible
  executable location = /usr/bin/ansible
  python version = 3.7.2 (default, Jan 16 2019, 19:49:22) [GCC 8.2.1 20181215 (Red Hat 8.2.1-6)]

CONFIGURATION

OS / ENVIRONMENT

Fedora 29

STEPS TO REPRODUCE

EXPECTED RESULTS

All ansible environment vars start with ANSIBLE_

ACTUAL RESULTS

At least one environment variable doesn't start with ANSIBLE_

[ansibot]

Files identified in the description:

• lib/ansible/plugins/callback/actionable.py
• lib/ansible/plugins/callback/default.py
• lib/ansible/plugins/callback/skippy.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

[jamescassell]

[14:42] cyberpear> IMO, if ansible is defining a var, it should start w/ ANSIBLE_, but if it's leveraging someone else's var, the name of that var is beyond the scoep
[14:43] bcoca> fine with me
[14:43] felixfontein> (which is not really optimal, since for example some docker TLS related env variables are interpreted differently by ansible, docker-py and docker cli.)
[14:43] nitzmahone> yeah, much less chance of unintentional collision
[14:43] sdoran> Changing that variable name is fine provided we keep the existing one working.
[14:43] bcoca> sdoran: easy to do and even show deprecation
[14:43] sdoran> cyberpear: +1
[14:43] bcoca> config api allows for it
[14:43] sdoran> Sweet. :)
[14:44] bcoca> +0 .. mostly cause its not a priority imho, but fine if someone puts the time in
[14:44] bcoca> anyone against?
[14:44] sivel> Nope
[14:44] sdoran> Nope. PRs welcome.
[14:44] bcoca> motion passes!