mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 11:21:25 -07:00
d834412ead
Fix for persistent connection plugin on Python3. Note that fixes are also needed to each terminal plugin. This PR only fixes the ios terminal (as proof that this approach is workable.) Future PRs can address the other terminal types. * On Python3, pickle needs to work with byte strings, not text strings. * Set the pickle protocol version to 0 because we're using a pty to feed data to the connection plugin. A pty can't have control characters. So we have to send ascii only. That means only using protocol=0 for pickling the data. * ansible-connection isn't being used with py3 in the bug but it needs several changes to work with python3. * In python3, closing the pty too early causes no data to be sent. So leave stdin open until after we finish with the ansible-connection process. * Fix typo using traceback.format_exc() * Cleanup unnecessary StringIO, BytesIO, and to_bytes calls * Modify the network_cli and terminal plugins for py3 compat. Lots of mixing of text and byte strings that needs to be straightened out to be compatible with python3 * Documentation for the bytes<=>text strategy for terminal plugins * Update unittests for more bytes-oriented internals Fixes #24355
82 lines
2.9 KiB
Python
82 lines
2.9 KiB
Python
#
|
|
# (c) 2016 Red Hat Inc.
|
|
#
|
|
# This file is part of Ansible
|
|
#
|
|
# Ansible is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Ansible is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
import json
|
|
import re
|
|
|
|
from ansible.errors import AnsibleConnectionFailure
|
|
from ansible.module_utils._text import to_bytes
|
|
from ansible.plugins.terminal import TerminalBase
|
|
|
|
|
|
class TerminalModule(TerminalBase):
|
|
|
|
terminal_stdout_re = [
|
|
re.compile(br"[\r\n]?[\w+\-\.:\/\[\]]+(?:\([^\)]+\)){,3}(?:>|#) ?$"),
|
|
re.compile(br"\[\w+\@[\w\-\.]+(?: [^\]])\] ?[>#\$] ?$")
|
|
]
|
|
|
|
terminal_stderr_re = [
|
|
re.compile(br"% ?Error"),
|
|
#re.compile(br"^% \w+", re.M),
|
|
re.compile(br"% ?Bad secret"),
|
|
re.compile(br"invalid input", re.I),
|
|
re.compile(br"(?:incomplete|ambiguous) command", re.I),
|
|
re.compile(br"connection timed out", re.I),
|
|
re.compile(br"[^\r\n]+ not found", re.I),
|
|
re.compile(br"'[^']' +returned error code: ?\d+"),
|
|
]
|
|
|
|
def on_open_shell(self):
|
|
try:
|
|
for cmd in (b'terminal length 0', b'terminal width 512'):
|
|
self._exec_cli_command(cmd)
|
|
except AnsibleConnectionFailure:
|
|
raise AnsibleConnectionFailure('unable to set terminal parameters')
|
|
|
|
def on_authorize(self, passwd=None):
|
|
if self._get_prompt().endswith(b'#'):
|
|
return
|
|
|
|
cmd = {u'command': u'enable'}
|
|
if passwd:
|
|
# Note: python-3.5 cannot combine u"" and r"" together. Thus make
|
|
# an r string and use to_text to ensure it's text on both py2 and py3.
|
|
cmd[u'prompt'] = to_text(r"[\r\n]?password: $", errors='surrogate_or_strict')
|
|
cmd[u'answer'] = passwd
|
|
|
|
try:
|
|
self._exec_cli_command(to_bytes(json.dumps(cmd), errors='surrogate_or_strict'))
|
|
except AnsibleConnectionFailure:
|
|
raise AnsibleConnectionFailure('unable to elevate privilege to enable mode')
|
|
|
|
def on_deauthorize(self):
|
|
prompt = self._get_prompt()
|
|
if prompt is None:
|
|
# if prompt is None most likely the terminal is hung up at a prompt
|
|
return
|
|
|
|
if b'(config' in prompt:
|
|
self._exec_cli_command(b'end')
|
|
self._exec_cli_command(b'disable')
|
|
|
|
elif prompt.endswith(b'#'):
|
|
self._exec_cli_command(b'disable')
|