List validations fails if elements='int' and value is not within choices

[kazagz]

Summary

When validating argument_spec with entry that is type='list', elements='int' and choices set to be list of ints, it fails to show proper validation error if value is not within choices. Just to be clear, validation works, just module crashes because can't format message. If value is within choices range, then there is no error.

Issue Type

Bug Report

Component Name

lib/ansible/module_utils/common/parameters.py

Ansible Version

$ ansible --version
ansible [core 2.16.3]
  config file = /***/ansible.cfg
  configured module search path = ['/home/***/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /***/.venv/lib64/python3.11/site-packages/ansible
  ansible collection location = /***
  executable location = /***/.venv/bin/ansible
  python version = 3.11.5 (main, Sep 22 2023, 15:34:29) [GCC 8.5.0 20210514 (Red Hat 8.5.0-20)] (/***/.venv/bin/python3.11)
  jinja version = 3.1.3
  libyaml = True

Configuration

# if using a version older than ansible-core 2.12 you should omit the '-t all'
$ ansible-config dump --only-changed -t all
COLLECTIONS_PATHS(/***/ansible.cfg) = ['***']
CONFIG_FILE() = /***/ansible.cfg
EDITOR(env: EDITOR) = vim

OS / Environment

RHEL8

Steps to Reproduce

import json

from ansible.module_utils import basic
from ansible.module_utils.common.text.converters import to_bytes


def run_module():
    module_args = dict(
        foo=dict(type="list", elements="int", choices=[1]),
    )
    module = basic.AnsibleModule(argument_spec=module_args, supports_check_mode=True)
    assert module is not None


def main():
    args = json.dumps({"ANSIBLE_MODULE_ARGS": {"foo": [2]}})
    basic._ANSIBLE_ARGS = to_bytes(args)
    run_module()


if __name__ == "__main__":
    main()

Expected Results

{"failed": true, "msg": "value of foo must be one or more of: 1. Got no match for: 2", "invocation": {"module_args": {"foo": [2]}}}

Actual Results

Traceback (most recent call last):
  File "/***/ansible_collections/***/plugins/module_utils/example.py", line 22, in <module>
    main()
  File "/***/ansible_collections/***/plugins/module_utils/example.py", line 18, in main
    run_module()
  File "/***/ansible_collections/***/plugins/module_utils/example.py", line 11, in run_module
    module = basic.AnsibleModule(argument_spec=module_args, supports_check_mode=True)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/***/.venv/lib64/python3.11/site-packages/ansible/module_utils/basic.py", line 488, in __init__
    self.validation_result = self.validator.validate(self.params)
                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/***/.venv/lib64/python3.11/site-packages/ansible/module_utils/common/arg_spec.py", line 301, in validate
    result = super(ModuleArgumentSpecValidator, self).validate(parameters)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/***/.venv/lib64/python3.11/site-packages/ansible/module_utils/common/arg_spec.py", line 241, in validate
    _validate_argument_values(self.argument_spec, result._validated_parameters, errors=result.errors)
  File "/***/.venv/lib64/python3.11/site-packages/ansible/module_utils/common/parameters.py", line 666, in _validate_argument_values
    diff_str = ", ".join(diff_list)
               ^^^^^^^^^^^^^^^^^^^^
TypeError: sequence item 0: expected str instance, int found

Code of Conduct

• I agree to follow the Ansible Code of Conduct

[ansibot]

Files identified in the description:

• lib/ansible/module_utils/common/parameters.py

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