mitogen/ansible_mitogen/plugins/connection/mitogen_local.py

# Copyright 2017, David Wilson
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice,
# this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its contributors
# may be used to endorse or promote products derived from this software without
# specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.

import os.path
import sys

#
# This is not the real Connection implementation module, it simply exists as a
# proxy to the real module, which is loaded using Python's regular import
# mechanism, to prevent Ansible's PluginLoader from making up a fake name that
# results in ansible_mitogen plugin modules being loaded twice: once by
# PluginLoader with a name like "ansible.plugins.connection.mitogen", which is
# stuffed into sys.modules even though attempting to import it will trigger an
# ImportError, and once under its canonical name, "ansible_mitogen.connection".
#
# Therefore we have a proxy module that imports it under the real name, and
# sets up the duff PluginLoader-imported module to just contain objects from
# the real module, so duplicate types don't exist in memory, and things like
# debuggers and isinstance() work predictably.
#

try:
    import ansible_mitogen
except ImportError:
    base_dir = os.path.dirname(__file__)
    sys.path.insert(0, os.path.abspath(os.path.join(base_dir, '../../..')))
    del base_dir

from ansible_mitogen.connection import LocalConnection as Connection
del os
del sys
ansible: initial support for async jobs Running in a thread to begin with, but this must change. 7 years ago			`# Copyright 2017, David Wilson`
			`#`
			`# Redistribution and use in source and binary forms, with or without`
			`# modification, are permitted provided that the following conditions are met:`
			`#`
			`# 1. Redistributions of source code must retain the above copyright notice,`
			`# this list of conditions and the following disclaimer.`
			`#`
			`# 2. Redistributions in binary form must reproduce the above copyright notice,`
			`# this list of conditions and the following disclaimer in the documentation`
			`# and/or other materials provided with the distribution.`
			`#`
			`# 3. Neither the name of the copyright holder nor the names of its contributors`
			`# may be used to endorse or promote products derived from this software without`
			`# specific prior written permission.`
			`#`
			`# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"`
			`# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE`
			`# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR`
			`# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF`
			`# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS`
			`# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN`
			`# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)`
			`# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE`
			`# POSSIBILITY OF SUCH DAMAGE.`

ansible: restructure package to avoid yet more madness Ansible's PluginLoader makes up bullshit when it imports a module (mostly because it has to make up something), therefore we ended up with duplicate copies of ansible_mitogen loaded: one under ansible.plugins.*.mitogen, and one under the canonical namespace. Which broke isinstance(). 7 years ago			`import os.path`
			`import sys`
ansible: initial support for async jobs Running in a thread to begin with, but this must change. 7 years ago
ansible: restructure package to avoid yet more madness Ansible's PluginLoader makes up bullshit when it imports a module (mostly because it has to make up something), therefore we ended up with duplicate copies of ansible_mitogen loaded: one under ansible.plugins.*.mitogen, and one under the canonical namespace. Which broke isinstance(). 7 years ago			`#`
			`# This is not the real Connection implementation module, it simply exists as a`
			`# proxy to the real module, which is loaded using Python's regular import`
			`# mechanism, to prevent Ansible's PluginLoader from making up a fake name that`
			`# results in ansible_mitogen plugin modules being loaded twice: once by`
			`# PluginLoader with a name like "ansible.plugins.connection.mitogen", which is`
			`# stuffed into sys.modules even though attempting to import it will trigger an`
			`# ImportError, and once under its canonical name, "ansible_mitogen.connection".`
			`#`
			`# Therefore we have a proxy module that imports it under the real name, and`
			`# sets up the duff PluginLoader-imported module to just contain objects from`
			`# the real module, so duplicate types don't exist in memory, and things like`
			`# debuggers and isinstance() work predictably.`
			`#`
ansible: initial support for async jobs Running in a thread to begin with, but this must change. 7 years ago
ansible: restructure package to avoid yet more madness Ansible's PluginLoader makes up bullshit when it imports a module (mostly because it has to make up something), therefore we ended up with duplicate copies of ansible_mitogen loaded: one under ansible.plugins.*.mitogen, and one under the canonical namespace. Which broke isinstance(). 7 years ago			`try:`
			`import ansible_mitogen`
			`except ImportError:`
			`base_dir = os.path.dirname(__file__)`
ansible: correct sys.path fixup. 7 years ago			`sys.path.insert(0, os.path.abspath(os.path.join(base_dir, '../../..')))`
ansible: restructure package to avoid yet more madness Ansible's PluginLoader makes up bullshit when it imports a module (mostly because it has to make up something), therefore we ended up with duplicate copies of ansible_mitogen loaded: one under ansible.plugins.*.mitogen, and one under the canonical namespace. Which broke isinstance(). 7 years ago			`del base_dir`
ansible: initial support for async jobs Running in a thread to begin with, but this must change. 7 years ago
ansible: connection delegation v1 This implements the first edition of Connection Delegation, where delegating connection establishment is initially single-threaded. ansible_mitogen/strategy.py: ansible_mitogen/plugins/connection/: Begin splitting connection.Connection into subclasses, exposing them directly as "mitogen_ssh", "mitogen_local", etc. connection types. This is far from removing strategy.py, but it's a tiny start. ansible_mitogen/connection.py: config_from_play_context() and config_from_host_vars() build up a huge dictionary containing either more or less PlayContext contents, or our best attempt at reconstructing a host's connection config from its hostvars, where that config is not the current WorkerProcess target. They both produce the same format with the same keys, allowing remaining code to have a single input format. These dicts contain fields named after how Ansible refers to them, e.g. "sudo_exe". * _config_from_via() parses a basic connection specification like "username@inventory_name" into one of the aforementioned dicts. * _stack_from_config() produces a list of dicts describing the order in which (Mitogen) connections should be established, such that each element is proxied via= the previous element. The dicts produced by this function use Mitogen keyword arguments, the former di. These dicts contain fields named after how Mitogen refers to them, e.g. "sudo_path". * Pass the stack to ContextService, which is responsible for actual setup of the full chain. ansible_mitogen/services.py: Teach get() to walk the supplied stack, establishing each connection in turn, creating refounts for it before continuing. TODO: refcounting is broken in a variety of cases. 7 years ago			`from ansible_mitogen.connection import LocalConnection as Connection`
ansible: restructure package to avoid yet more madness Ansible's PluginLoader makes up bullshit when it imports a module (mostly because it has to make up something), therefore we ended up with duplicate copies of ansible_mitogen loaded: one under ansible.plugins.*.mitogen, and one under the canonical namespace. Which broke isinstance(). 7 years ago			`del os`
			`del sys`