242 lines
10 KiB
Python
242 lines
10 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# 2011-2017 Steven Armstrong (steven-cdist at armstrong.cc)
|
|
# 2011-2013 Nico Schottelius (nico-cdist at schottelius.org)
|
|
# 2014 Daniel Heule (hda at sfs.biz)
|
|
#
|
|
# This file is part of cdist.
|
|
#
|
|
# cdist 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.
|
|
#
|
|
# cdist 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 cdist. If not, see <http://www.gnu.org/licenses/>.
|
|
#
|
|
#
|
|
|
|
import os
|
|
import importlib.util
|
|
import inspect
|
|
import cdist
|
|
from cdist.core import PythonType
|
|
from . import util
|
|
|
|
|
|
'''
|
|
common:
|
|
runs only locally, does not need remote
|
|
|
|
env:
|
|
PATH: prepend directory with type emulator symlinks == local.bin_path
|
|
__target_host: the target host we are working on
|
|
__target_hostname: the target hostname provided from __target_host
|
|
__target_fqdn: the target's fully qualified domain name provided from
|
|
__target_host
|
|
__cdist_manifest: full qualified path of the manifest == script
|
|
__cdist_type_base_path: full qualified path to the directory where
|
|
types are defined for use in type emulator
|
|
== local.type_path
|
|
|
|
gencode-local
|
|
script: full qualified path to a types gencode-local
|
|
|
|
env:
|
|
__target_host: the target host we are working on
|
|
__target_hostname: the target hostname provided from __target_host
|
|
__target_fqdn: the target's fully qualified domain name provided from
|
|
__target_host
|
|
__global: full qualified path to the global
|
|
output dir == local.out_path
|
|
__object: full qualified path to the object's dir
|
|
__object_id: the objects id
|
|
__object_fq: full qualified object id, iow: $type.name + / + object_id
|
|
__type: full qualified path to the type's dir
|
|
__files: full qualified path to the files dir
|
|
__target_host_tags: comma spearated list of host tags
|
|
|
|
returns: string containing the generated code or None
|
|
|
|
gencode-remote
|
|
script: full qualified path to a types gencode-remote
|
|
|
|
env:
|
|
__target_host: the target host we are working on
|
|
__target_hostname: the target hostname provided from __target_host
|
|
__target_fqdn: the target's fully qualified domain name provided from
|
|
__target_host
|
|
__global: full qualified path to the global
|
|
output dir == local.out_path
|
|
__object: full qualified path to the object's dir
|
|
__object_id: the objects id
|
|
__object_fq: full qualified object id, iow: $type.name + / + object_id
|
|
__type: full qualified path to the type's dir
|
|
__files: full qualified path to the files dir
|
|
__target_host_tags: comma spearated list of host tags
|
|
|
|
returns: string containing the generated code or None
|
|
|
|
|
|
code-local
|
|
script: full qualified path to object's code-local
|
|
- run script localy
|
|
returns: string containing the output
|
|
|
|
code-remote
|
|
script: full qualified path to object's code-remote
|
|
- copy script to remote
|
|
- run script remotely
|
|
returns: string containing the output
|
|
'''
|
|
|
|
|
|
class Code(object):
|
|
"""Generates and executes cdist code scripts.
|
|
|
|
"""
|
|
# target_host is tuple (target_host, target_hostname, target_fqdn)
|
|
def __init__(self, target_host, local, remote):
|
|
self.target_host = target_host
|
|
self.local = local
|
|
self.remote = remote
|
|
self.env = {
|
|
'__target_host': self.target_host[0],
|
|
'__target_hostname': self.target_host[1],
|
|
'__target_fqdn': self.target_host[2],
|
|
'__global': self.local.base_path,
|
|
'__files': self.local.files_path,
|
|
'__target_host_tags': self.local.target_host_tags,
|
|
'__cdist_log_level': util.log_level_env_var_val(local.log),
|
|
'__cdist_log_level_name': util.log_level_name_env_var_val(
|
|
local.log),
|
|
}
|
|
|
|
def run_py(self, cdist_object):
|
|
cdist_type = cdist_object.cdist_type
|
|
module_name = cdist_type.name
|
|
file_path = os.path.join(cdist_type.absolute_path, '__init__.py')
|
|
|
|
if os.path.isfile(file_path):
|
|
spec = importlib.util.spec_from_file_location(module_name,
|
|
file_path)
|
|
m = importlib.util.module_from_spec(spec)
|
|
spec.loader.exec_module(m)
|
|
classes = inspect.getmembers(m, inspect.isclass)
|
|
type_class = None
|
|
for _, cl in classes:
|
|
if cl != PythonType and issubclass(cl, PythonType):
|
|
if type_class:
|
|
raise cdist.Error("Only one python type class is "
|
|
"supported, but at least two "
|
|
"found: {}".format((type_class,
|
|
cl, )))
|
|
else:
|
|
type_class = cl
|
|
env = os.environ.copy()
|
|
env.update(self.env)
|
|
message_prefix = cdist_object.name
|
|
type_obj = type_class(env=env, cdist_object=cdist_object,
|
|
local=self.local, remote=self.remote,
|
|
message_prefix=message_prefix)
|
|
if hasattr(type_obj, 'run') and inspect.ismethod(type_obj.run):
|
|
if self.local.save_output_streams:
|
|
which = 'gencode-py'
|
|
stderr_path = os.path.join(cdist_object.stderr_path, which)
|
|
stdout_path = os.path.join(cdist_object.stdout_path, which)
|
|
with open(stderr_path, 'a+') as stderr, \
|
|
open(stdout_path, 'a+') as stdout:
|
|
return type_obj.run(stdout=stdout, stderr=stderr)
|
|
else:
|
|
return type_obj.run()
|
|
|
|
def _run_gencode(self, cdist_object, which):
|
|
cdist_type = cdist_object.cdist_type
|
|
script = os.path.join(self.local.type_path,
|
|
getattr(cdist_type, 'gencode_%s_path' % which))
|
|
if os.path.isfile(script):
|
|
env = os.environ.copy()
|
|
env.update(self.env)
|
|
env.update({
|
|
'__type': cdist_object.cdist_type.absolute_path,
|
|
'__object': cdist_object.absolute_path,
|
|
'__object_id': cdist_object.object_id,
|
|
'__object_name': cdist_object.name,
|
|
})
|
|
message_prefix = cdist_object.name
|
|
if self.local.save_output_streams:
|
|
stderr_path = os.path.join(cdist_object.stderr_path,
|
|
'gencode-' + which)
|
|
with open(stderr_path, 'ba+') as stderr:
|
|
return self.local.run_script(script, env=env,
|
|
return_output=True,
|
|
message_prefix=message_prefix,
|
|
stderr=stderr)
|
|
else:
|
|
return self.local.run_script(script, env=env,
|
|
return_output=True,
|
|
message_prefix=message_prefix)
|
|
|
|
def run_gencode_local(self, cdist_object):
|
|
"""Run the gencode-local script for the given cdist object."""
|
|
return self._run_gencode(cdist_object, 'local')
|
|
|
|
def run_gencode_remote(self, cdist_object):
|
|
"""Run the gencode-remote script for the given cdist object."""
|
|
return self._run_gencode(cdist_object, 'remote')
|
|
|
|
def transfer_code_remote(self, cdist_object):
|
|
"""Transfer the code_remote script for the given object to the
|
|
remote side."""
|
|
source = os.path.join(self.local.object_path,
|
|
cdist_object.code_remote_path)
|
|
destination = os.path.join(self.remote.object_path,
|
|
cdist_object.code_remote_path)
|
|
self.remote.mkdir(os.path.dirname(destination))
|
|
self.remote.transfer(source, destination)
|
|
|
|
def _run_code(self, cdist_object, which, env=None):
|
|
which_exec = getattr(self, which)
|
|
script = os.path.join(which_exec.object_path,
|
|
getattr(cdist_object, 'code_%s_path' % which))
|
|
if which_exec.save_output_streams:
|
|
stderr_path = os.path.join(cdist_object.stderr_path,
|
|
'code-' + which)
|
|
stdout_path = os.path.join(cdist_object.stdout_path,
|
|
'code-' + which)
|
|
with open(stderr_path, 'ba+') as stderr, \
|
|
open(stdout_path, 'ba+') as stdout:
|
|
return which_exec.run_script(script, env=env, stdout=stdout,
|
|
stderr=stderr)
|
|
else:
|
|
return which_exec.run_script(script, env=env)
|
|
|
|
def run_code_local(self, cdist_object):
|
|
"""Run the code-local script for the given cdist object."""
|
|
# Put some env vars, to allow read only access to the parameters
|
|
# over $__object
|
|
env = os.environ.copy()
|
|
env.update(self.env)
|
|
env.update({
|
|
'__object': cdist_object.absolute_path,
|
|
'__object_id': cdist_object.object_id,
|
|
})
|
|
return self._run_code(cdist_object, 'local', env=env)
|
|
|
|
def run_code_remote(self, cdist_object):
|
|
"""Run the code-remote script for the given cdist object on the
|
|
remote side."""
|
|
# Put some env vars, to allow read only access to the parameters
|
|
# over $__object which is already on the remote side
|
|
env = {
|
|
'__object': os.path.join(self.remote.object_path,
|
|
cdist_object.path),
|
|
'__object_id': cdist_object.object_id,
|
|
}
|
|
return self._run_code(cdist_object, 'remote', env=env)
|