mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 11:51:26 -07:00
8ef2e6da05
* Add support for Windows hosts in the SSH connection plugin * fix Python 2.6 unit test and sanity issues * fix up connection tests in CI, disable SCP for now * ensure we don't pollute the existing environment during the test * Add connection_windows_ssh to classifier * use test dir for inventory file * Required powershell as default shell and fix tests * Remove exlicit become_methods on connection * clarify console encoding comment * ignore recent SCP errors in integration tests * Add cmd shell type and added more tests * Fix some doc issues * revises windows faq * add anchors for windows links * revises windows setup page * Update changelogs/fragments/windows-ssh.yaml Co-Authored-By: jborean93 <jborean93@gmail.com>
57 lines
2 KiB
Python
57 lines
2 KiB
Python
# Copyright (c) 2019 Ansible Project
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
DOCUMENTATION = '''
|
|
name: cmd
|
|
plugin_type: shell
|
|
version_added: '2.8'
|
|
short_description: Windows Command Prompt
|
|
description:
|
|
- Used with the 'ssh' connection plugin and no C(DefaultShell) has been set on the Windows host.
|
|
extends_documentation_fragment:
|
|
- shell_windows
|
|
'''
|
|
|
|
import re
|
|
|
|
from ansible.plugins.shell.powershell import ShellModule as PSShellModule
|
|
|
|
# these are the metachars that have a special meaning in cmd that we want to escape when quoting
|
|
_find_unsafe = re.compile(r'[\s\(\)\%\!^\"\<\>\&\|]').search
|
|
|
|
|
|
class ShellModule(PSShellModule):
|
|
|
|
# Common shell filenames that this plugin handles
|
|
COMPATIBLE_SHELLS = frozenset()
|
|
# Family of shells this has. Must match the filename without extension
|
|
SHELL_FAMILY = 'cmd'
|
|
|
|
_SHELL_REDIRECT_ALLNULL = '>nul 2>&1'
|
|
_SHELL_AND = '&&'
|
|
|
|
# Used by various parts of Ansible to do Windows specific changes
|
|
_IS_WINDOWS = True
|
|
|
|
def quote(self, s):
|
|
# cmd does not support single quotes that the shlex_quote uses. We need to override the quoting behaviour to
|
|
# better match cmd.exe.
|
|
# https://blogs.msdn.microsoft.com/twistylittlepassagesallalike/2011/04/23/everyone-quotes-command-line-arguments-the-wrong-way/
|
|
|
|
# Return an empty argument
|
|
if not s:
|
|
return '""'
|
|
|
|
if _find_unsafe(s) is None:
|
|
return s
|
|
|
|
# Escape the metachars as we are quoting the string to stop cmd from interpreting that metachar. For example
|
|
# 'file &whoami.exe' would result in 'file $(whoami.exe)' instead of the literal string
|
|
# https://stackoverflow.com/questions/3411771/multiple-character-replace-with-python
|
|
for c in '^()%!"<>&|': # '^' must be the first char that we scan and replace
|
|
if c in s:
|
|
s = s.replace(c, "^" + c)
|
|
|
|
return '^"' + s + '^"'
|