File: //lib/python3.9/site-packages/ansible_collections/cloud/common/plugins/plugin_utils/turbo/lookup.py
# Copyright (c) 2021 Red Hat
#
# This code is part of Ansible, but is an independent component.
# This particular file snippet, and this file snippet only, is BSD licensed.
# Modules you write using this snippet, which is embedded dynamically by Ansible
# still belong to the author of the module, and may assign their own license
# to the complete work.
#
# Redistribution and use in source and binary forms, with or without modification,
# are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * 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.
#
# 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
from ansible.plugins.lookup import LookupBase
import ansible_collections.cloud.common.plugins.module_utils.turbo.common
from ansible_collections.cloud.common.plugins.module_utils.turbo.exceptions import (
EmbeddedModuleUnexpectedFailure,
)
def get_server_ttl(variables):
# trying to retrieve first TTL from environment variable
ttl = os.environ.get("ANSIBLE_TURBO_LOOKUP_TTL", None)
if ttl is not None:
return ttl
# Read TTL from ansible environment
for env_var in variables.get("environment", []):
value = env_var.get("ANSIBLE_TURBO_LOOKUP_TTL", None)
test_var_int = [
isinstance(value, str) and value.isnumeric(),
isinstance(value, int),
]
if value is not None and any(test_var_int):
ttl = value
return ttl
class TurboLookupBase(LookupBase):
def run_on_daemon(self, terms, variables=None, **kwargs):
self._ttl = get_server_ttl(variables)
return self.execute(terms=terms, variables=variables, **kwargs)
@property
def socket_path(self):
if not hasattr(self, "__socket_path"):
"""
Input:
_load_name: ansible_collections.cloud.common.plugins.lookup.turbo_random_lookup
Output:
__socket_path: {HOME}/.ansible/tmp/turbo_mode_cloud.common.socket
this will allow to have one socket per collection
"""
name = self._load_name
ansible_collections = "ansible_collections."
if name.startswith(ansible_collections):
name = name.replace(ansible_collections, "", 1)
lookup_plugins = ".plugins.lookup."
idx = name.find(lookup_plugins)
if idx != -1:
name = name[:idx]
self.__socket_path = os.environ[
"HOME"
] + "/.ansible/tmp/turbo_lookup.{0}.socket".format(name)
return self.__socket_path
def execute(self, terms, variables=None, **kwargs):
with ansible_collections.cloud.common.plugins.module_utils.turbo.common.connect(
socket_path=self.socket_path, ttl=self._ttl, plugin="lookup"
) as turbo_socket:
content = (self._load_name, terms, variables, kwargs)
(result, errors) = turbo_socket.communicate(content)
if errors:
raise EmbeddedModuleUnexpectedFailure(errors)
return result