xref: /external/autotest/server/hosts/factory.py

from autotest_lib.client.common_lib import utils, error
from autotest_lib.server import utils as server_utils
from autotest_lib.server.hosts import site_factory, abstract_ssh
from autotest_lib.server.hosts import ssh_host, serial, netconsole
from autotest_lib.server.hosts import logfile_monitor

DEFAULT_FOLLOW_PATH = '/var/log/kern.log'
DEFAULT_PATTERNS_PATH = 'console_patterns'


# for tracking which hostnames have already had job_start called
_started_hostnames = set()

def create_host(
    hostname, auto_monitor=True, follow_paths=None, pattern_paths=None, **args):
    # by default assume we're using SSH support
    classes = [ssh_host.SSHHost]

    if auto_monitor:
        # use serial console support if it's available
        conmux_args = {}
        for key in ("conmux_server", "conmux_attach"):
            if key in args:
                conmux_args[key] = args[key]
        if serial.SerialHost.host_is_supported(hostname, **conmux_args):
            classes.append(serial.SerialHost)
        else:
            # no serial host available, try netconsole logging if available
            def run_func(cmd):
                base_cmd = abstract_ssh.make_ssh_command(connect_timeout=3)
                full_cmd = '%s %s "%s"' % (base_cmd, hostname,
                                           server_utils.sh_escape(cmd))
                try:
                    utils.run(full_cmd)
                except error.CmdError:
                    pass

            if netconsole.NetconsoleHost.host_is_supported(run_func):
                classes.append(netconsole.NetconsoleHost)
            else:
                # nothing available, fall back to direct dmesg logging
                if follow_paths is None:
                    follow_paths = [DEFAULT_FOLLOW_PATH]
                else:
                    follow_paths = list(follow_paths) + [DEFAULT_FOLLOW_PATH]

                if pattern_paths is None:
                    pattern_paths = [DEFAULT_PATTERNS_PATH]
                else:
                    pattern_paths = (
                        list(pattern_paths) + [DEFAULT_PATTERNS_PATH])

                logfile_monitor_class = logfile_monitor.NewLogfileMonitorMixin(
                    follow_paths, pattern_paths)
                classes.append(logfile_monitor_class)

    elif follow_paths:
        logfile_monitor_class = logfile_monitor.NewLogfileMonitorMixin(
            follow_paths, pattern_paths)
        classes.append(logfile_monitor_class)

    # do any site-specific processing of the classes list
    site_factory.postprocess_classes(classes, hostname,
                                     auto_monitor=auto_monitor, **args)

    # create a custom host class for this machine and return an instance of it
    host_class = type("%s_host" % hostname, tuple(classes), {})
    host_instance = host_class(hostname, **args)

    # call job_start if this is the first time this host is being used
    if hostname not in _started_hostnames:
        host_instance.job_start()
        _started_hostnames.add(hostname)

    return host_instance