fix network_cli connection plugin: ConnectionError: unsupported operand type(s) for ^: 'str' and 'str'

[smnmtzgr]

SUMMARY

Fixes ansible/awx#4325 (comment)
Fixes #48093

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

network_cli.py

ADDITIONAL INFORMATION

network_cli.py breaks when used in AWX 6.0.0. AWX seems to define credentials in special the become with some string, e.g. "true". This leads to a failure:

The full traceback is:
Traceback (most recent call last):
  File "/usr/bin/ansible-connection", line 302, in main
    conn.update_play_context(pc_data)
  File "/usr/lib/python2.7/site-packages/ansible/module_utils/connection.py", line 186, in __rpc__
    raise ConnectionError(to_text(msg, errors='surrogate_then_replace'), code=code)
ConnectionError: unsupported operand type(s) for ^: 'str' and 'str'

With this bugfix the become gets converted to boolean and checked correctly.

[ansibot]

cc @NilashishC @Qalthos @danielmellado @ganeshrn @justjais @rcarrillocruz @trishnaguha
click here for bot help

[smnmtzgr]

I think this should be a backport bugfix, because it is existent since the ^-operator was introduced in the network_cli plugin. Thats the case since Ansible 2.7 https://github.com/ansible/ansible/blob/stable-2.7/lib/ansible/plugins/connection/network_cli.py

In the earlier versions we had the following logic, which also worked correctly with AWX:

        messages = ['updating play_context for connection']
        if self._play_context.become is False and play_context.become is True:
            auth_pass = play_context.become_pass
            self._terminal.on_become(passwd=auth_pass)
            messages.append('authorizing connection')

        elif self._play_context.become is True and not play_context.become:
            self._terminal.on_unbecome()
            messages.append('deauthorizing connection')

        self._play_context = play_context
        return messages

[ansible-zuul]

Build succeeded (third-party-check pipeline).

• ansible-test-network-integration-eos-python27 : SUCCESS in 1h 06m 20s
• ansible-test-network-integration-eos-python35 : SUCCESS in 1h 04m 15s
• ansible-test-network-integration-eos-python36 : SUCCESS in 1h 04m 40s
• ansible-test-network-integration-eos-python37 : SUCCESS in 1h 23m 53s
• ansible-test-network-integration-ios-python27 : SUCCESS in 40m 26s
• ansible-test-network-integration-ios-python35 : SUCCESS in 40m 01s
• ansible-test-network-integration-ios-python36 : SUCCESS in 46m 53s
• ansible-test-network-integration-ios-python37 : SUCCESS in 45m 45s
• ansible-test-network-integration-iosxr-python27 : SUCCESS in 59m 02s
• ansible-test-network-integration-iosxr-python35 : SUCCESS in 1h 02m 37s
• ansible-test-network-integration-iosxr-python36 : SUCCESS in 57m 43s
• ansible-test-network-integration-iosxr-python37 : SUCCESS in 1h 05m 44s
• ansible-test-network-integration-junos-python27 : SUCCESS in 1h 24m 26s
• ansible-test-network-integration-junos-python35 : SUCCESS in 1h 22m 23s
• ansible-test-network-integration-junos-python36 : SUCCESS in 1h 20m 13s
• ansible-test-network-integration-junos-python37 : SUCCESS in 1h 23m 14s
• ansible-test-network-integration-vyos-python27 : SUCCESS in 35m 09s
• ansible-test-network-integration-vyos-python35 : SUCCESS in 38m 31s
• ansible-test-network-integration-vyos-python36 : SUCCESS in 40m 51s
• ansible-test-network-integration-vyos-python37 : SUCCESS in 36m 18s

[bcoca]

so this should not be needed as become is defined as a boolean attribute, it is an indication that 'validation' is not happening on the play_context objects, which can lead to many of the same issues for other fields.

The proper fix would be to ensure both objects trigger full validation of their attributes.

[smnmtzgr]

Ok, can you give me a hint where this validation should be done?

[Qalthos]

Can you verify that the issue still occurs without this patch in Ansible 2.9?

needs_info

[ansibot]

@smnmtzgr This pullrequest is waiting for your response. Please respond or the pullrequest will be closed.

click here for bot help

[ansibot]

@smnmtzgr You have not responded to information requests in this pullrequest so we will assume it no longer affects you. If you are still interested in this, please create a new pullrequest with the requested information.

click here for bot help