expect: utf-8' codec can't decode byte 0x80 enhancement #46556

[madhu222]

SUMMARY

Modified the expect.py script to handle the utf-8 codec error

ISSUE TYPE

• Feature Pull Request

COMPONENT NAME

lib/ansible/modules/commands/expect.py

ADDITIONAL INFORMATION

If the reload is called after the telnet, it will show the utf-8 codec error. If I do the codec_error as replace option, the error is not seen. The example is shown below.

- name: Telnet to the switch to get the prompt
  delegate_to: localhost
  become: no
  expect:
    command: telnet {{ ansible_console }} {{ console_port }} -e {{ telnet_esc }}
    timeout: "{{ timeout|default(30) }}"
    responses: "{{ exp | default({}) | combine(default_exp) | combine(extra_exp) }}"
    echo: no
    codec_errors: replace
  register: output

[ansibot]

cc @sivel
click here for bot help

[sivel]

In addition to the other comments, this will also require a changelog to changelog/fragments

[sivel]

This is missing documentation. In addition you should probably support choices and enumerate the possibilities provided by codecs.

[madhu222]

@sivel Will add the documentation

[ansibot]

The test ansible-test sanity --test validate-modules [explain] failed with 2 errors:

lib/ansible/modules/commands/expect.py:0:0: E309 version_added for new option (codec_errors) should be 2.8. Currently 0.0
lib/ansible/modules/commands/expect.py:0:0: E324 Value for "default" from the argument_spec (None) for "codec_errors" does not match the documentation ('False')

click here for bot help

[ansibot]

The test ansible-test sanity --test pylint [explain] failed with 1 error:

lib/ansible/modules/commands/expect.py:147:59: bad-whitespace Exactly one space required after comma             codec_errors=dict(type='str', choices=['strict','replace']),                                                            ^

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/modules/commands/expect.py:147:60: E231 missing whitespace after ','

The test ansible-test sanity --test validate-modules [explain] failed with 1 error:

lib/ansible/modules/commands/expect.py:0:0: E324 Argument 'codec_errors' in argument_spec defines default as (None) but documentation defines default as ('False')

click here for bot help

[Akasurde]

@madhu222 Are you still working on this? Thanks.

[bcoca]

close via alternate fix in #73255