blob: 5216f16d1484bab2c1a0715210b47f16d97951e7 [file] [log] [blame]
# Copyright (c) 2012 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
import inspect
import logging
import os
import re
import signal
import socket
import time
import urllib2
import uuid
from autotest_lib.client.common_lib import base_utils
from autotest_lib.client.common_lib import error
from autotest_lib.client.common_lib import global_config
from autotest_lib.client.common_lib import lsbrelease_utils
from autotest_lib.client.cros import constants
# Keep checking if the pid is alive every second until the timeout (in seconds)
_LOCAL_HOST_LIST = ('localhost', '')
# The default address of a vm gateway.
# Google Storage bucket URI to store results in.
DEFAULT_OFFLOAD_GSURI = global_config.global_config.get_config_value(
'CROS', 'results_storage_server', default=None)
# Default Moblab Ethernet Interface.
MOBLAB_ETH = 'eth0'
def ping(host, deadline=None, tries=None, timeout=60):
"""Attempt to ping |host|.
Shell out to 'ping' to try to reach |host| for |timeout| seconds.
Returns exit code of ping.
Per 'man ping', if you specify BOTH |deadline| and |tries|, ping only
returns 0 if we get responses to |tries| pings within |deadline| seconds.
Specifying |deadline| or |count| alone should return 0 as long as
some packets receive responses.
@param host: the host to ping.
@param deadline: seconds within which |tries| pings must succeed.
@param tries: number of pings to send.
@param timeout: number of seconds after which to kill 'ping' command.
@return exit code of ping command.
args = [host]
if deadline:
args.append('-w%d' % deadline)
if tries:
args.append('-c%d' % tries)
return'ping', args=args,
ignore_status=True, timeout=timeout,
def host_is_in_lab_zone(hostname):
"""Check if the host is in the CLIENT.dns_zone.
@param hostname: The hostname to check.
@returns True if hostname.dns_zone resolves, otherwise False.
host_parts = hostname.split('.')
dns_zone = global_config.global_config.get_config_value('CLIENT', 'dns_zone',
fqdn = '%s.%s' % (host_parts[0], dns_zone)
return True
except socket.gaierror:
return False
def host_could_be_in_afe(hostname):
"""Check if the host could be in Autotest Front End.
Report whether or not a host could be in AFE, without actually
consulting AFE. This method exists because some systems are in the
lab zone, but not actually managed by AFE.
@param hostname: The hostname to check.
@returns True if hostname is in lab zone, and does not match *-dev-*
# Do the 'dev' check first, so that we skip DNS lookup if the
# hostname matches. This should give us greater resilience to lab
# failures.
return (hostname.find('-dev-') == -1) and host_is_in_lab_zone(hostname)
def get_chrome_version(job_views):
Retrieves the version of the chrome binary associated with a job.
When a test runs we query the chrome binary for it's version and drop
that value into a client keyval. To retrieve the chrome version we get all
the views associated with a test from the db, including those of the
server and client jobs, and parse the version out of the first test view
that has it. If we never ran a single test in the suite the job_views
dictionary will not contain a chrome version.
This method cannot retrieve the chrome version from a dictionary that
does not conform to the structure of an autotest tko view.
@param job_views: a list of a job's result views, as returned by
the get_detailed_test_views method in rpc_interface.
@return: The chrome version string, or None if one can't be found.
# Aborted jobs have no views.
if not job_views:
return None
for view in job_views:
if (view.get('attributes')
and constants.CHROME_VERSION in view['attributes'].keys()):
return view['attributes'].get(constants.CHROME_VERSION)
logging.warning('Could not find chrome version for failure.')
return None
def get_interface_mac_address(interface):
"""Return the MAC address of a given interface.
@param interface: Interface to look up the MAC address of.
interface_link =
'ip addr show %s | grep link/ether' % interface).stdout
# The output will be in the format of:
# 'link/ether <mac> brd ff:ff:ff:ff:ff:ff'
return interface_link.split()[1]
def get_offload_gsuri():
"""Return the GSURI to offload test results to.
For the normal use case this is the results_storage_server in the
However partners using Moblab will be offloading their results to a
subdirectory of their image storage buckets. The subdirectory is
determined by the MAC Address of the Moblab device.
@returns gsuri to offload test results to.
if not lsbrelease_utils.is_moblab():
moblab_id_filepath = '/home/moblab/.moblab_id'
if os.path.exists(moblab_id_filepath):
with open(moblab_id_filepath, 'r') as moblab_id_file:
random_id =
random_id = uuid.uuid1()
with open(moblab_id_filepath, 'w') as moblab_id_file:
moblab_id_file.write('%s' % random_id)
return '%sresults/%s/%s/' % (
'CROS', 'image_storage_server'),
get_interface_mac_address(MOBLAB_ETH), random_id)
# TODO(petermayo): Share this with _GsUpload in
# //chromite.git/buildbot/ somewhere/somehow
def gs_upload(local_file, remote_file, acl, result_dir=None,
transfer_timeout=300, acl_timeout=300):
"""Upload to GS bucket.
@param local_file: Local file to upload
@param remote_file: Remote location to upload the local_file to.
@param acl: name or file used for controlling access to the uploaded
@param result_dir: Result directory if you want to add tracing to the
@param transfer_timeout: Timeout for this upload call.
@param acl_timeout: Timeout for the acl call needed to confirm that
the uploader has permissions to execute the upload.
@raise CmdError: the exit code of the gsutil call was not 0.
@returns True/False - depending on if the upload succeeded or failed.
CANNED_ACLS = ['project-private', 'private', 'public-read',
'public-read-write', 'authenticated-read',
'bucket-owner-read', 'bucket-owner-full-control']
_GSUTIL_BIN = 'gsutil'
acl_cmd = None
if acl in CANNED_ACLS:
cmd = '%s cp -a %s %s %s' % (_GSUTIL_BIN, acl, local_file, remote_file)
# For private uploads we assume that the overlay board is set up
# properly and a googlestore_acl.xml is present, if not this script
# errors
cmd = '%s cp -a private %s %s' % (_GSUTIL_BIN, local_file, remote_file)
if not os.path.exists(acl):
logging.error('Unable to find ACL File %s.', acl)
return False
acl_cmd = '%s setacl %s %s' % (_GSUTIL_BIN, acl, remote_file)
if not result_dir:, timeout=transfer_timeout, verbose=True)
if acl_cmd:, timeout=acl_timeout, verbose=True)
return True
with open(os.path.join(result_dir, 'tracing'), 'w') as ftrace:
ftrace.write('Preamble\n'), timeout=transfer_timeout, verbose=True,
stdout_tee=ftrace, stderr_tee=ftrace)
if acl_cmd:
ftrace.write('\nACL setting\n')
# Apply the passed in ACL xml file to the uploaded object., timeout=acl_timeout, verbose=True,
stdout_tee=ftrace, stderr_tee=ftrace)
return True
def gs_ls(uri_pattern):
"""Returns a list of URIs that match a given pattern.
@param uri_pattern: a GS URI pattern, may contain wildcards
@return A list of URIs matching the given pattern.
@raise CmdError: the gsutil command failed.
gs_cmd = ' '.join(['gsutil', 'ls', uri_pattern])
result = base_utils.system_output(gs_cmd).splitlines()
return [path.rstrip() for path in result if path]
def nuke_pids(pid_list, signal_queue=[signal.SIGTERM, signal.SIGKILL]):
Given a list of pid's, kill them via an esclating series of signals.
@param pid_list: List of PID's to kill.
@param signal_queue: Queue of signals to send the PID's to terminate them.
@return: A mapping of the signal name to the number of processes it
was sent to.
sig_count = {}
# Though this is slightly hacky it beats hardcoding names anyday.
sig_names = dict((k, v) for v, k in signal.__dict__.iteritems()
if v.startswith('SIG'))
for sig in signal_queue:
logging.debug('Sending signal %s to the following pids:', sig)
sig_count[sig_names.get(sig, 'unknown_signal')] = len(pid_list)
for pid in pid_list:
logging.debug('Pid %d', pid)
os.kill(pid, sig)
except OSError:
# The process may have died from a previous signal before we
# could kill it.
if sig == signal.SIGKILL:
return sig_count
pid_list = [pid for pid in pid_list if base_utils.pid_is_alive(pid)]
if not pid_list:
failed_list = []
for pid in pid_list:
if base_utils.pid_is_alive(pid):
failed_list.append('Could not kill %d for process name: %s.' % pid,
if failed_list:
raise error.AutoservRunError('Following errors occured: %s' %
failed_list, None)
return sig_count
def externalize_host(host):
"""Returns an externally accessible host name.
@param host: a host name or address (string)
@return An externally visible host name or address
return socket.gethostname() if host in _LOCAL_HOST_LIST else host
def urlopen_socket_timeout(url, data=None, timeout=5):
Wrapper to urllib2.urlopen with a socket timeout.
This method will convert all socket timeouts to
TimeoutExceptions, so we can use it in conjunction
with the rpc retry decorator and continue to handle
other URLErrors as we see fit.
@param url: The url to open.
@param data: The data to send to the url (eg: the urlencoded dictionary
used with a POST call).
@param timeout: The timeout for this urlopen call.
@return: The response of the urlopen call.
@raises: error.TimeoutException when a socket timeout occurs.
urllib2.URLError for errors that not caused by timeout.
urllib2.HTTPError for errors like 404 url not found.
old_timeout = socket.getdefaulttimeout()
return urllib2.urlopen(url, data=data)
except urllib2.URLError as e:
if type(e.reason) is socket.timeout:
raise error.TimeoutException(str(e))
def parse_chrome_version(version_string):
Parse a chrome version string and return version and milestone.
Given a chrome version of the form "W.X.Y.Z", return "W.X.Y.Z" as
the version and "W" as the milestone.
@param version_string: Chrome version string.
@return: a tuple (chrome_version, milestone). If the incoming version
string is not of the form "W.X.Y.Z", chrome_version will
be set to the incoming "version_string" argument and the
milestone will be set to the empty string.
match ='(\d+)\.\d+\.\d+\.\d+', version_string)
ver = if match else version_string
milestone = if match else ''
return ver, milestone
def is_localhost(server):
"""Check if server is equivalent to localhost.
@param server: Name of the server to check.
@return: True if given server is equivalent to localhost.
@raise socket.gaierror: If server name failed to be resolved.
if server in _LOCAL_HOST_LIST:
return True
return (socket.gethostbyname(socket.gethostname()) ==
except socket.gaierror:
logging.error('Failed to resolve server name %s.', server)
return False
def is_puppylab_vm(server):
"""Check if server is a virtual machine in puppylab.
In the virtual machine testing environment (i.e., puppylab), each
shard VM has a hostname like localhost:<port>.
@param server: Server name to check.
@return True if given server is a virtual machine in puppylab.
# TODO(mkryu): This is a puppylab specific hack. Please update
# this method if you have a better solution.
regex = re.compile(r'(.+):\d+')
m = regex.match(server)
if m:
return in _LOCAL_HOST_LIST
return False
def get_function_arg_value(func, arg_name, args, kwargs):
"""Get the value of the given argument for the function.
@param func: Function being called with given arguments.
@param arg_name: Name of the argument to look for value.
@param args: arguments for function to be called.
@param kwargs: keyword arguments for function to be called.
@return: The value of the given argument for the function.
@raise ValueError: If the argument is not listed function arguemnts.
@raise KeyError: If no value is found for the given argument.
if arg_name in kwargs:
return kwargs[arg_name]
argspec = inspect.getargspec(func)
index = argspec.args.index(arg_name)
return args[index]
except IndexError:
# The argument can use a default value. Reverse the default value
# so argument with default value can be counted from the last to
# the first.
return argspec.defaults[::-1][len(argspec.args) - index - 1]
except IndexError:
raise KeyError('Argument %s is not given a value. argspec: %s, '
'args:%s, kwargs:%s' %
(arg_name, argspec, args, kwargs))
def version_match(build_version, release_version, update_url=''):
"""Compare release versino from lsb-release with cros-version label.
build_version is a string based on build name. It is prefixed with builder
info and branch ID, e.g., lumpy-release/R43-6809.0.0. It may not include
builder info, e.g., lumpy-release, in which case, update_url shall be passed
in to determine if the build is a trybot or pgo-generate build.
release_version is retrieved from lsb-release.
These two values might not match exactly.
The method is designed to compare version for following 6 scenarios with
samples of build version and expected release version:
1. trybot non-release build (paladin or pre-cq build).
build version: trybot-lumpy-paladin/R27-3837.0.0-b123
release version: 3837.0.2013_03_21_1340
2. trybot release build.
build version: trybot-lumpy-release/R27-3837.0.0-b456
release version: 3837.0.0
3. buildbot official release build.
build version: lumpy-release/R27-3837.0.0
release version: 3837.0.0
4. non-official paladin rc build.
build version: lumpy-paladin/R27-3878.0.0-rc7
release version: 3837.0.0-rc7
5. chrome-perf build.
build version: lumpy-chrome-perf/R28-3837.0.0-b2996
release version: 3837.0.0
6. pgo-generate build.
build version: lumpy-release-pgo-generate/R28-3837.0.0-b2996
release version: 3837.0.0-pgo-generate
TODO: This logic has a bug if a trybot paladin build failed to be
installed in a DUT running an older trybot paladin build with same
platform number, but different build number (-b###). So to conclusively
determine if a tryjob paladin build is imaged successfully, we may need
to find out the date string from update url.
@param build_version: Build name for cros version, e.g.
peppy-release/R43-6809.0.0 or R43-6809.0.0
@param release_version: Release version retrieved from lsb-release,
e.g., 6809.0.0
@param update_url: Update url which include the full builder information.
Default is set to empty string.
@return: True if the values match, otherwise returns False.
# If the build is from release, CQ or PFQ builder, cros-version label must
# be ended with release version in lsb-release.
if build_version.endswith(release_version):
return True
# Remove R#- and -b# at the end of build version
stripped_version = re.sub(r'(R\d+-|-b\d+)', '', build_version)
# Trim the builder info, e.g., trybot-lumpy-paladin/
stripped_version = stripped_version.split('/')[-1]
is_trybot_non_release_build = (
re.match(r'.*trybot-.+-(paladin|pre-cq)', build_version) or
re.match(r'.*trybot-.+-(paladin|pre-cq)', update_url))
# Replace date string with 0 in release_version
release_version_no_date = re.sub(r'\d{4}_\d{2}_\d{2}_\d+', '0',
has_date_string = release_version != release_version_no_date
is_pgo_generate_build = (
re.match(r'.+-pgo-generate', build_version) or
re.match(r'.+-pgo-generate', update_url))
# Remove |-pgo-generate| in release_version
release_version_no_pgo = release_version.replace('-pgo-generate', '')
has_pgo_generate = release_version != release_version_no_pgo
if is_trybot_non_release_build:
if not has_date_string:
logging.error('A trybot paladin or pre-cq build is expected. '
'Version "%s" is not a paladin or pre-cq build.',
return False
return stripped_version == release_version_no_date
elif is_pgo_generate_build:
if not has_pgo_generate:
logging.error('A pgo-generate build is expected. Version '
'"%s" is not a pgo-generate build.',
return False
return stripped_version == release_version_no_pgo
if has_date_string:
logging.error('Unexpected date found in a non trybot paladin or '
'pre-cq build.')
return False
# Versioned build, i.e., rc or release build.
return stripped_version == release_version
def get_real_user():
"""Get the real user that runs the script.
The function check environment variable SUDO_USER for the user if the
script is run with sudo. Otherwise, it returns the value of environment
variable USER.
@return: The user name that runs the script.
user = os.environ.get('SUDO_USER')
if not user:
user = os.environ.get('USER')
return user
def sudo_require_password():
"""Test if the process can run sudo command without using password.
@return: True if the process needs password to run sudo command.
try:'sudo -n true')
return False
except error.CmdError:
logging.warn('sudo command requires password.')
return True
def is_in_container():
"""Check if the process is running inside a container.
@return: True if the process is running inside a container, otherwise False.
result ='grep -q "/lxc/" /proc/1/cgroup',
verbose=False, ignore_status=True)
return result.exit_status == 0
def is_flash_installed():
The Adobe Flash binary is only distributed with internal builds.
return (os.path.exists('/opt/google/chrome/pepper/')
and os.path.exists('/opt/google/chrome/pepper/'))
def verify_flash_installed():
The Adobe Flash binary is only distributed with internal builds.
Warn users of public builds of the extra dependency.
if not is_flash_installed():
raise error.TestNAError('No Adobe Flash binary installed.')