Ensure ansible-docs display boolean values using true/false

[ssbarnea]

Adopts JSON/YAML 1.2 standard booleans names.

Related: ansible-community/community-topics#116

SUMMARY

ISSUE TYPE

• Bugfix Pull Request
• Docs Pull Request
• Feature Pull Request
• Test Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

[sivel]

This is definitely the wrong place for this to happen. This function should not concern itself with YAML serialization. This is basically just Python conversion to text type, not special case modifications to non python types.

[ssbarnea]

@sivel given your deep knowledge and experience with ansible, could you take a few minutes to get me headed in the right direction? A couple pointers into the code would be great. I really want to get this right.

As part of mentioned change, we want to ensure that we only display booleans as true, false to the user, including output of ansible-doc <module>.

[bcoca]

That should already be the case except where 'python stringification' takes place, ... which affects fields like Default but not most others. Removing the python stringification would make it match.

[sivel]

You will likely have to make modifications in every location that outputs the value.

In the case of ansible-doc, the change would be required in lib/ansible/cli/doc.py::DocCLI.add_fields. A new helper function might be required to avoid duplication. The change likely needs to happen for the default value, as well as choices.

Something like:

default = "[Default: %s" % to_text(_coerce_bool_to_yaml(opt.pop('default', '(null)'))) + "]"

[ansibot]

The test ansible-test sanity --test ansible-doc [explain] failed with the error:

Output on stderr from ansible-doc is considered an error.

Command "ansible-doc -t become runas su sudo" returned exit status 0.
>>> Standard Error
�[1;35m[WARNING]: You are running the development version of Ansible. You should only
�[1;35mrun Ansible from "devel" if you are modifying the Ansible engine, or trying out
�[1;35mfeatures under development. This is a rapidly changing source of code and can
�[1;35mbecome unstable at any point.

The test ansible-test sanity --test import --python 3.9 [explain] failed with 10 errors:

lib/ansible/plugins/inventory/__init__.py:0:0: stdout: �[1;30m   244 1660662676.25904: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/advanced_host_list.py:0:0: stdout: �[1;30m   244 1660662676.46643: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/auto.py:0:0: stdout: �[1;30m   244 1660662676.66129: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/constructed.py:0:0: stdout: �[1;30m   244 1660662676.89622: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/generator.py:0:0: stdout: �[1;30m   244 1660662677.09583: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/host_list.py:0:0: stdout: �[1;30m   244 1660662677.33248: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/ini.py:0:0: stdout: �[1;30m   244 1660662677.53513: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/script.py:0:0: stdout: �[1;30m   244 1660662677.77478: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/toml.py:0:0: stdout: �[1;30m   244 1660662677.98461: trying /root/ansible/lib/ansible/plugins/cache
lib/ansible/plugins/inventory/yaml.py:0:0: stdout: �[1;30m   244 1660662678.17048: trying /root/ansible/lib/ansible/plugins/cache

click here for bot help

[bcoca]

#78561

[mkrizek]

Closing in favor of #78668