| # Copyright (c) 2013 The Chromium OS 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 logging |
| import re |
| import time |
| |
| from contextlib import contextmanager |
| from collections import namedtuple |
| |
| from autotest_lib.client.bin import utils |
| from autotest_lib.client.common_lib import error |
| from autotest_lib.client.common_lib.cros.network import interface |
| from autotest_lib.client.common_lib.cros.network import iw_runner |
| from autotest_lib.client.common_lib.cros.network import ping_runner |
| from autotest_lib.client.cros import constants |
| from autotest_lib.server import autotest |
| from autotest_lib.server import frontend |
| from autotest_lib.server import site_linux_system |
| from autotest_lib.server import site_utils |
| from autotest_lib.server.cros.network import wpa_cli_proxy |
| from autotest_lib.server.hosts import adb_host |
| |
| # wake-on-WiFi feature strings |
| WAKE_ON_WIFI_NONE = 'none' |
| WAKE_ON_WIFI_PACKET = 'packet' |
| WAKE_ON_WIFI_SSID = 'ssid' |
| WAKE_ON_WIFI_PACKET_SSID = 'packet_and_ssid' |
| |
| ConnectTime = namedtuple('ConnectTime', 'state, time') |
| |
| XMLRPC_BRINGUP_TIMEOUT_SECONDS = 60 |
| |
| def get_xmlrpc_proxy(host): |
| """Get a shill XMLRPC proxy for |host|. |
| |
| The returned object has no particular type. Instead, when you call |
| a method on the object, it marshalls the objects passed as arguments |
| and uses them to make RPCs on the remote server. Thus, you should |
| read shill_xmlrpc_server.py to find out what methods are supported. |
| |
| @param host: host object representing a remote device. |
| @return proxy object for remote XMLRPC server. |
| |
| """ |
| # Make sure the client library is on the device so that the proxy |
| # code is there when we try to call it. |
| client_at = autotest.Autotest(host) |
| client_at.install() |
| # Start up the XMLRPC proxy on the client |
| proxy = host.xmlrpc_connect( |
| constants.SHILL_XMLRPC_SERVER_COMMAND, |
| constants.SHILL_XMLRPC_SERVER_PORT, |
| command_name=constants.SHILL_XMLRPC_SERVER_CLEANUP_PATTERN, |
| ready_test_name=constants.SHILL_XMLRPC_SERVER_READY_METHOD, |
| timeout_seconds=XMLRPC_BRINGUP_TIMEOUT_SECONDS) |
| return proxy |
| |
| |
| def _is_conductive(hostname): |
| if utils.host_is_in_lab_zone(hostname): |
| conductive = site_utils.get_label_from_afe(hostname, |
| 'conductive:', |
| frontend.AFE()) |
| if conductive and conductive.lower() == 'true': |
| return True |
| return False |
| |
| |
| class WiFiClient(site_linux_system.LinuxSystem): |
| """WiFiClient is a thin layer of logic over a remote DUT in wifitests.""" |
| |
| DEFAULT_PING_COUNT = 10 |
| COMMAND_PING = 'ping' |
| |
| MAX_SERVICE_GONE_TIMEOUT_SECONDS = 60 |
| |
| # List of interface names we won't consider for use as "the" WiFi interface |
| # on Android hosts. |
| WIFI_IF_BLACKLIST = ['p2p0'] |
| |
| UNKNOWN_BOARD_TYPE = 'unknown' |
| |
| # DBus device properties. Wireless interfaces should support these. |
| ROAM_THRESHOLD = 'RoamThreshold' |
| WAKE_ON_WIFI_FEATURES = 'WakeOnWiFiFeaturesEnabled' |
| |
| CONNECTED_STATES = 'ready', 'portal', 'online' |
| |
| @property |
| def machine_id(self): |
| """@return string unique to a particular board/cpu configuration.""" |
| if self._machine_id: |
| return self._machine_id |
| |
| uname_result = self.host.run('uname -m', ignore_status=True) |
| kernel_arch = '' |
| if not uname_result.exit_status and uname_result.stdout.find(' ') < 0: |
| kernel_arch = uname_result.stdout.strip() |
| cpu_info = self.host.run('cat /proc/cpuinfo').stdout.splitlines() |
| cpu_count = len(filter(lambda x: x.lower().startswith('bogomips'), |
| cpu_info)) |
| cpu_count_str = '' |
| if cpu_count: |
| cpu_count_str = 'x%d' % cpu_count |
| ghz_value = '' |
| ghz_pattern = re.compile('([0-9.]+GHz)') |
| for line in cpu_info: |
| match = ghz_pattern.search(line) |
| if match is not None: |
| ghz_value = '_' + match.group(1) |
| break |
| |
| return '%s_%s%s%s' % (self.board, kernel_arch, ghz_value, cpu_count_str) |
| |
| |
| @property |
| def powersave_on(self): |
| """@return bool True iff WiFi powersave mode is enabled.""" |
| result = self.host.run("iw dev %s get power_save" % self.wifi_if) |
| output = result.stdout.rstrip() # NB: chop \n |
| # Output should be either "Power save: on" or "Power save: off". |
| find_re = re.compile('([^:]+):\s+(\w+)') |
| find_results = find_re.match(output) |
| if not find_results: |
| raise error.TestFail('Failed to find power_save parameter ' |
| 'in iw results.') |
| |
| return find_results.group(2) == 'on' |
| |
| |
| @property |
| def shill(self): |
| """@return shill RPCProxy object.""" |
| return self._shill_proxy |
| |
| |
| @property |
| def client(self): |
| """Deprecated accessor for the client host. |
| |
| The term client is used very loosely in old autotests and this |
| accessor should not be used in new code. Use host() instead. |
| |
| @return host object representing a remote DUT. |
| |
| """ |
| return self.host |
| |
| |
| @property |
| def command_ip(self): |
| """@return string path to ip command.""" |
| return self._command_ip |
| |
| |
| @property |
| def command_iptables(self): |
| """@return string path to iptables command.""" |
| return self._command_iptables |
| |
| |
| @property |
| def command_ping6(self): |
| """@return string path to ping6 command.""" |
| return self._command_ping6 |
| |
| |
| @property |
| def command_wpa_cli(self): |
| """@return string path to wpa_cli command.""" |
| return self._command_wpa_cli |
| |
| |
| @property |
| def conductive(self): |
| """@return True if the rig is conductive; False otherwise.""" |
| return self._conductive |
| |
| |
| @conductive.setter |
| def conductive(self, value): |
| """Set the conductive member to True or False.""" |
| self._conductive = value |
| |
| |
| @property |
| def wifi_if(self): |
| """@return string wifi device on machine (e.g. mlan0).""" |
| return self._wifi_if |
| |
| |
| @property |
| def wifi_mac(self): |
| """@return string MAC address of self.wifi_if.""" |
| return self._interface.mac_address |
| |
| |
| @property |
| def wifi_ip(self): |
| """@return string IPv4 address of self.wifi_if.""" |
| return self._interface.ipv4_address |
| |
| |
| @property |
| def wifi_ip_subnet(self): |
| """@return string IPv4 subnet prefix of self.wifi_if.""" |
| return self._interface.ipv4_subnet |
| |
| |
| @property |
| def wifi_signal_level(self): |
| """Returns the signal level of this DUT's WiFi interface. |
| |
| @return int signal level of connected WiFi interface or None (e.g. -67). |
| |
| """ |
| return self._interface.signal_level |
| |
| |
| def wifi_noise_level(self, frequency_mhz): |
| """Returns the noise level of this DUT's WiFi interface. |
| |
| @param frequency_mhz: frequency at which the noise level should be |
| measured and reported. |
| @return int signal level of connected WiFi interface in dBm (e.g. -67) |
| or None if the value is unavailable. |
| |
| """ |
| return self._interface.noise_level(frequency_mhz) |
| |
| |
| def __init__(self, client_host, result_dir): |
| """ |
| Construct a WiFiClient. |
| |
| @param client_host host object representing a remote host. |
| @param result_dir string directory to store test logs/packet caps. |
| |
| """ |
| super(WiFiClient, self).__init__(client_host, 'client', |
| inherit_interfaces=True) |
| self._command_ip = 'ip' |
| self._command_iptables = 'iptables' |
| self._command_ping6 = 'ping6' |
| self._command_wpa_cli = 'wpa_cli' |
| self._machine_id = None |
| self._result_dir = result_dir |
| self._conductive = _is_conductive(client_host.hostname) |
| |
| if isinstance(self.host, adb_host.ADBHost): |
| # Look up the WiFi device (and its MAC) on the client. |
| devs = self.iw_runner.list_interfaces(desired_if_type='managed') |
| devs = [dev for dev in devs |
| if dev.if_name not in self.WIFI_IF_BLACKLIST] |
| if not devs: |
| raise error.TestFail('No wlan devices found on %s.' % |
| self.host.hostname) |
| |
| if len(devs) > 1: |
| logging.warning('Warning, found multiple WiFi devices on ' |
| '%s: %r', self.host.hostname, devs) |
| self._wifi_if = devs[0].if_name |
| self._shill_proxy = wpa_cli_proxy.WpaCliProxy( |
| self.host, self._wifi_if) |
| else: |
| self._shill_proxy = get_xmlrpc_proxy(self.host) |
| interfaces = self._shill_proxy.list_controlled_wifi_interfaces() |
| if not interfaces: |
| logging.debug('No interfaces managed by shill. Rebooting host') |
| self.host.reboot() |
| raise error.TestError('No interfaces managed by shill on %s' % |
| self.host.hostname) |
| self._wifi_if = interfaces[0] |
| self._raise_logging_level() |
| self._interface = interface.Interface(self._wifi_if, host=self.host) |
| logging.debug('WiFi interface is: %r', |
| self._interface.device_description) |
| self._firewall_rules = [] |
| # Turn off powersave mode by default. |
| self.powersave_switch(False) |
| # All tests that use this object assume the interface starts enabled. |
| self.set_device_enabled(self._wifi_if, True) |
| # Make sure wpa_supplicant is started. |
| self.start_wpasupplicant(warn_if_not_running=True) |
| |
| |
| def _assert_method_supported(self, method_name): |
| """Raise a TestNAError if the XMLRPC proxy has no method |method_name|. |
| |
| @param method_name: string name of method that should exist on the |
| XMLRPC proxy. |
| |
| """ |
| if not self._supports_method(method_name): |
| raise error.TestNAError('%s() is not supported' % method_name) |
| |
| |
| def _raise_logging_level(self): |
| """Raises logging levels for WiFi on DUT.""" |
| self.host.run('wpa_debug excessive') |
| self.host.run('ff_debug --level -5') |
| self.host.run('ff_debug +wifi') |
| |
| |
| def vht_supported(self): |
| """Returns True if VHT supported; False otherwise""" |
| return self.iw_runner.vht_supported() |
| |
| |
| def _supports_method(self, method_name): |
| """Checks if |method_name| is supported on the remote XMLRPC proxy. |
| |
| autotest will, for their own reasons, install python files in the |
| autotest client package that correspond the version of the build |
| rather than the version running on the autotest drone. This |
| creates situations where we call methods on the client XMLRPC proxy |
| that don't exist in that version of the code. This detects those |
| situations so that we can degrade more or less gracefully. |
| |
| @param method_name: string name of method that should exist on the |
| XMLRPC proxy. |
| @return True if method is available, False otherwise. |
| |
| """ |
| # Make no assertions about ADBHost support. We don't use an XMLRPC |
| # proxy with those hosts anyway. |
| supported = (isinstance(self.host, adb_host.ADBHost) or |
| method_name in self._shill_proxy.system.listMethods()) |
| if not supported: |
| logging.warning('%s() is not supported on older images', |
| method_name) |
| return supported |
| |
| |
| def close(self): |
| """Tear down state associated with the client.""" |
| self.stop_capture() |
| self.powersave_switch(False) |
| self.shill.clean_profiles() |
| # Start wpasupplicant if it was stopped during the test. |
| self.start_wpasupplicant() |
| super(WiFiClient, self).close() |
| |
| |
| def firewall_open(self, proto, src): |
| """Opens up firewall to run netperf tests. |
| |
| By default, we have a firewall rule for NFQUEUE (see crbug.com/220736). |
| In order to run netperf test, we need to add a new firewall rule BEFORE |
| this NFQUEUE rule in the INPUT chain. |
| |
| @param proto a string, test traffic protocol, e.g. udp, tcp. |
| @param src a string, subnet/mask. |
| |
| @return a string firewall rule added. |
| |
| """ |
| rule = 'INPUT -s %s/32 -p %s -m %s -j ACCEPT' % (src, proto, proto) |
| self.host.run('%s -I %s' % (self._command_iptables, rule)) |
| self._firewall_rules.append(rule) |
| return rule |
| |
| |
| def firewall_cleanup(self): |
| """Cleans up firewall rules.""" |
| for rule in self._firewall_rules: |
| self.host.run('%s -D %s' % (self._command_iptables, rule)) |
| self._firewall_rules = [] |
| |
| |
| def sync_host_times(self): |
| """Set time on our DUT to match local time.""" |
| epoch_seconds = time.time() |
| self.shill.sync_time_to(epoch_seconds) |
| |
| |
| def check_iw_link_value(self, iw_link_key, desired_value): |
| """Assert that the current wireless link property is |desired_value|. |
| |
| @param iw_link_key string one of IW_LINK_KEY_* defined in iw_runner. |
| @param desired_value string desired value of iw link property. |
| |
| """ |
| actual_value = self.get_iw_link_value(iw_link_key) |
| desired_value = str(desired_value) |
| if actual_value != desired_value: |
| raise error.TestFail('Wanted iw link property %s value %s, but ' |
| 'got %s instead.' % (iw_link_key, |
| desired_value, |
| actual_value)) |
| |
| |
| def get_iw_link_value(self, iw_link_key): |
| """Get the current value of a link property for this WiFi interface. |
| |
| @param iw_link_key string one of IW_LINK_KEY_* defined in iw_runner. |
| |
| """ |
| return self.iw_runner.get_link_value(self.wifi_if, iw_link_key) |
| |
| |
| def powersave_switch(self, turn_on): |
| """Toggle powersave mode for the DUT. |
| |
| @param turn_on bool True iff powersave mode should be turned on. |
| |
| """ |
| mode = 'off' |
| if turn_on: |
| mode = 'on' |
| self.host.run('iw dev %s set power_save %s' % (self.wifi_if, mode)) |
| |
| |
| def timed_scan(self, frequencies, ssids, scan_timeout_seconds=10, |
| retry_timeout_seconds=10): |
| """Request timed scan to discover given SSIDs. |
| |
| This method will retry for a default of |retry_timeout_seconds| until it |
| is able to successfully kick off a scan. Sometimes, the device on the |
| DUT claims to be busy and rejects our requests. It will raise error |
| if the scan did not complete within |scan_timeout_seconds| or it was |
| not able to discover the given SSIDs. |
| |
| @param frequencies list of int WiFi frequencies to scan for. |
| @param ssids list of string ssids to probe request for. |
| @param scan_timeout_seconds: float number of seconds the scan |
| operation not to exceed. |
| @param retry_timeout_seconds: float number of seconds to retry scanning |
| if the interface is busy. This does not retry if certain |
| SSIDs are missing from the results. |
| @return time in seconds took to complete scan request. |
| |
| """ |
| start_time = time.time() |
| while time.time() - start_time < retry_timeout_seconds: |
| scan_result = self.iw_runner.timed_scan( |
| self.wifi_if, frequencies=frequencies, ssids=ssids) |
| |
| if scan_result is not None: |
| break |
| |
| time.sleep(0.5) |
| else: |
| raise error.TestFail('Unable to trigger scan on client.') |
| |
| # Verify scan operation completed within given timeout |
| if scan_result.time > scan_timeout_seconds: |
| raise error.TestFail('Scan time %.2fs exceeds the scan timeout' % |
| (scan_result.time)) |
| |
| # Verify all ssids are discovered |
| for ssid in ssids: |
| if not ssid: |
| continue |
| |
| for bss in scan_result.bss_list: |
| if bss.ssid == ssid: |
| break |
| else: |
| raise error.TestFail('SSID %s is not in scan results: %r' % |
| (ssid, scan_result.bss_list)) |
| |
| logging.info('Wifi scan completed in %.2f seconds', scan_result.time) |
| return scan_result.time |
| |
| |
| def scan(self, frequencies, ssids, timeout_seconds=10): |
| """Request a scan and check that certain SSIDs appear in the results. |
| |
| This method will retry for a default of |timeout_seconds| until it is |
| able to successfully kick off a scan. Sometimes, the device on the DUT |
| claims to be busy and rejects our requests. |
| |
| @param frequencies list of int WiFi frequencies to scan for. |
| @param ssids list of string ssids to probe request for. |
| @param timeout_seconds: float number of seconds to retry scanning |
| if the interface is busy. This does not retry if certain |
| SSIDs are missing from the results. |
| |
| """ |
| start_time = time.time() |
| while time.time() - start_time < timeout_seconds: |
| bss_list = self.iw_runner.scan( |
| self.wifi_if, frequencies=frequencies, ssids=ssids) |
| if bss_list is not None: |
| break |
| |
| time.sleep(0.5) |
| else: |
| raise error.TestFail('Unable to trigger scan on client.') |
| |
| for ssid in ssids: |
| if not ssid: |
| continue |
| |
| for bss in bss_list: |
| if bss.ssid == ssid: |
| break |
| |
| else: |
| raise error.TestFail('SSID %s is not in scan results: %r' % |
| (ssid, bss_list)) |
| |
| |
| def wait_for_bsses(self, ssid, num_bss_expected, timeout_seconds=15): |
| """Wait for all BSSes associated with given SSID to be discovered in the |
| scan. |
| |
| @param ssid string name of network being queried |
| @param num_bss_expected int number of BSSes expected |
| @param timeout_seconds int seconds to wait for BSSes to be discovered |
| |
| """ |
| start_time = time.time() |
| while time.time() - start_time < timeout_seconds: |
| bss_list = self.iw_runner.scan( |
| self.wifi_if, frequencies=[], ssids=[ssid]) |
| |
| # Determine number of BSSes found in the scan result. |
| num_bss_found = 0 |
| if bss_list is not None: |
| for bss in bss_list: |
| if bss.ssid == ssid: |
| num_bss_found += 1 |
| |
| # Verify all BSSes are found. |
| if num_bss_found == num_bss_expected: |
| break |
| |
| time.sleep(0.5) |
| else: |
| raise error.TestFail('Failed to discover all BSSes.') |
| |
| |
| def wait_for_service_states(self, ssid, states, timeout_seconds): |
| """Waits for a WiFi service to achieve one of |states|. |
| |
| @param ssid string name of network being queried |
| @param states tuple list of states for which the caller is waiting |
| @param timeout_seconds int seconds to wait for a state in |states| |
| |
| """ |
| logging.info('Waiting for %s to reach one of %r...', ssid, states) |
| success, state, time = self._shill_proxy.wait_for_service_states( |
| ssid, states, timeout_seconds) |
| logging.info('...ended up in state \'%s\' (%s) after %f seconds.', |
| state, 'success' if success else 'failure', time) |
| return success, state, time |
| |
| |
| def do_suspend(self, seconds): |
| """Puts the DUT in suspend power state for |seconds| seconds. |
| |
| @param seconds: The number of seconds to suspend the device. |
| |
| """ |
| logging.info('Suspending DUT for %d seconds...', seconds) |
| self._shill_proxy.do_suspend(seconds) |
| logging.info('...done suspending') |
| |
| |
| def do_suspend_bg(self, seconds): |
| """Suspend DUT using the power manager - non-blocking. |
| |
| @param seconds: The number of seconds to suspend the device. |
| |
| """ |
| logging.info('Suspending DUT (in background) for %d seconds...', |
| seconds) |
| self._shill_proxy.do_suspend_bg(seconds) |
| |
| |
| def clear_supplicant_blacklist(self): |
| """Clear's the AP blacklist on the DUT. |
| |
| @return stdout and stderror returns passed from |
| self._shill_proxy.clear_supplicant_blacklist() |
| |
| """ |
| stdoutdata, stderrdata = self._shill_proxy.clear_supplicant_blacklist() |
| logging.info('wpa_cli blacklist clear: out:%r err:%r', stdoutdata, |
| stderrdata) |
| return stdoutdata, stderrdata |
| |
| |
| def get_active_wifi_SSIDs(self): |
| """Get a list of visible SSID's around the DUT |
| |
| @return list of string SSIDs |
| |
| """ |
| self._assert_method_supported('get_active_wifi_SSIDs') |
| return self._shill_proxy.get_active_wifi_SSIDs() |
| |
| |
| def roam_threshold(self, value): |
| """Get a context manager to temporarily change wpa_supplicant's |
| roaming threshold for the specified interface. |
| |
| The correct way to use this method is: |
| |
| with client.roam_threshold(40): |
| ... |
| |
| @param value: the desired roam threshold for the test. |
| |
| @return a context manager for the threshold. |
| |
| """ |
| return TemporaryDBusProperty(self._shill_proxy, |
| self.wifi_if, |
| self.ROAM_THRESHOLD, |
| value) |
| |
| |
| def set_device_enabled(self, wifi_interface, value, |
| fail_on_unsupported=False): |
| """Enable or disable the WiFi device. |
| |
| @param wifi_interface: string name of interface being modified. |
| @param enabled: boolean; true if this device should be enabled, |
| false if this device should be disabled. |
| @return True if it worked; False, otherwise. |
| |
| """ |
| if fail_on_unsupported: |
| self._assert_method_supported('set_device_enabled') |
| elif not self._supports_method('set_device_enabled'): |
| return False |
| return self._shill_proxy.set_device_enabled(wifi_interface, value) |
| |
| |
| def add_arp_entry(self, ip_address, mac_address): |
| """Add an ARP entry to the table associated with the WiFi interface. |
| |
| @param ip_address: string IP address associated with the new ARP entry. |
| @param mac_address: string MAC address associated with the new ARP |
| entry. |
| |
| """ |
| self.host.run('ip neigh add %s lladdr %s dev %s nud perm' % |
| (ip_address, mac_address, self.wifi_if)) |
| |
| |
| def establish_tdls_link(self, mac_address): |
| """Establish a TDLS link with |mac_address|. |
| |
| @param mac_address: string MAC address associated with the TDLS peer. |
| |
| @return bool True if operation initiated successfully, False otherwise. |
| |
| """ |
| return self._shill_proxy.establish_tdls_link(self.wifi_if, mac_address) |
| |
| |
| def query_tdls_link(self, mac_address): |
| """Query a TDLS link with |mac_address|. |
| |
| @param mac_address: string MAC address associated with the TDLS peer. |
| |
| @return string indicating current TDLS connectivity. |
| |
| """ |
| return self._shill_proxy.query_tdls_link(self.wifi_if, mac_address) |
| |
| |
| def add_wake_packet_source(self, source_ip): |
| """Add |source_ip| as a source that can wake us up with packets. |
| |
| @param source_ip: IP address from which to wake upon receipt of packets |
| |
| @return True if successful, False otherwise. |
| |
| """ |
| return self._shill_proxy.add_wake_packet_source( |
| self.wifi_if, source_ip) |
| |
| |
| def remove_wake_packet_source(self, source_ip): |
| """Remove |source_ip| as a source that can wake us up with packets. |
| |
| @param source_ip: IP address to stop waking on packets from |
| |
| @return True if successful, False otherwise. |
| |
| """ |
| return self._shill_proxy.remove_wake_packet_source( |
| self.wifi_if, source_ip) |
| |
| |
| def remove_all_wake_packet_sources(self): |
| """Remove all IPs as sources that can wake us up with packets. |
| |
| @return True if successful, False otherwise. |
| |
| """ |
| return self._shill_proxy.remove_all_wake_packet_sources(self.wifi_if) |
| |
| |
| def wake_on_wifi_features(self, features): |
| """Shill supports programming the NIC to wake on special kinds of |
| incoming packets, or on changes to the available APs (disconnect, |
| coming in range of a known SSID). This method allows you to configure |
| what wake-on-WiFi mechanisms are active. It returns a context manager, |
| because this is a system-wide setting and we don't want it to persist |
| across different tests. |
| |
| If you enable wake-on-packet, then the IPs registered by |
| add_wake_packet_source will be able to wake the system from suspend. |
| |
| The correct way to use this method is: |
| |
| with client.wake_on_wifi_features(WAKE_ON_WIFI_SSID): |
| ... |
| |
| @param features: string from the WAKE_ON_WIFI constants above. |
| |
| @return a context manager for the features. |
| |
| """ |
| return TemporaryDBusProperty(self._shill_proxy, |
| self.wifi_if, |
| self.WAKE_ON_WIFI_FEATURES, |
| features) |
| |
| |
| def request_roam(self, bssid): |
| """Request that we roam to the specified BSSID. |
| |
| Note that this operation assumes that: |
| |
| 1) We're connected to an SSID for which |bssid| is a member. |
| 2) There is a BSS with an appropriate ID in our scan results. |
| |
| This method does not check for success of either the command or |
| the roaming operation. |
| |
| @param bssid: string MAC address of bss to roam to. |
| |
| """ |
| self._assert_method_supported('request_roam') |
| self._shill_proxy.request_roam(bssid) |
| |
| |
| def wait_for_roam(self, bssid, timeout_seconds=10.0): |
| """Wait for a roam to the given |bssid|. |
| |
| @param bssid: string bssid to expect a roam to |
| (e.g. '00:11:22:33:44:55'). |
| @param timeout_seconds: float number of seconds to wait for a roam. |
| @return True iff we detect an association to the given |bssid| within |
| |timeout_seconds|. |
| |
| """ |
| start_time = time.time() |
| success = False |
| duration = 0.0 |
| while time.time() - start_time < timeout_seconds: |
| duration = time.time() - start_time |
| current_bssid = self.iw_runner.get_current_bssid(self.wifi_if) |
| logging.debug('Current BSSID is %s.', current_bssid) |
| if current_bssid == bssid: |
| success = True |
| break |
| time.sleep(0.5) |
| |
| logging.debug('%s to %s in %f seconds.', |
| 'Roamed ' if success else 'Failed to roam ', |
| bssid, |
| duration) |
| return success |
| |
| |
| def wait_for_ssid_vanish(self, ssid): |
| """Wait for shill to notice that there are no BSS's for an SSID present. |
| |
| Raise a test failing exception if this does not come to pass. |
| |
| @param ssid: string SSID of the network to require be missing. |
| |
| """ |
| start_time = time.time() |
| while time.time() - start_time < self.MAX_SERVICE_GONE_TIMEOUT_SECONDS: |
| visible_ssids = self.get_active_wifi_SSIDs() |
| logging.info('Got service list: %r', visible_ssids) |
| if ssid not in visible_ssids: |
| return |
| |
| self.scan(frequencies=[], ssids=[], timeout_seconds=30) |
| else: |
| raise error.TestFail('shill should mark the BSS as not present') |
| |
| |
| def reassociate(self, timeout_seconds=10): |
| """Reassociate to the connected network. |
| |
| @param timeout_seconds: float number of seconds to wait for operation |
| to complete. |
| |
| """ |
| logging.info('Attempt to reassociate') |
| with self.iw_runner.get_event_logger() as logger: |
| logger.start() |
| # Issue reattach command to wpa_supplicant |
| result = self.host.run('su wpa -s /usr/bin/wpa_cli reattach') |
| if not result.stdout.strip().endswith('OK'): |
| raise error.TestFail('wpa_cli reassociate command failed') |
| |
| # Wait for the timeout seconds for association to complete |
| time.sleep(timeout_seconds) |
| |
| # Stop iw event logger |
| logger.stop() |
| |
| # Get association time based on the iw event log |
| reassociate_time = logger.get_reassociation_time() |
| if reassociate_time is None or reassociate_time > timeout_seconds: |
| raise error.TestFail( |
| 'Failed to reassociate within given timeout') |
| logging.info('Reassociate time: %.2f seconds', reassociate_time) |
| |
| |
| def wait_for_connection(self, ssid, timeout_seconds=30, freq=None, |
| ping_ip=None, desired_subnet=None): |
| """Verifies a connection to network ssid, optionally verifying |
| frequency, ping connectivity and subnet. |
| |
| @param ssid string ssid of the network to check. |
| @param timeout_seconds int number of seconds to wait for |
| connection on the given frequency. |
| @param freq int frequency of network to check. |
| @param ping_ip string ip address to ping for verification. |
| @param desired_subnet string expected subnet in which client |
| ip address should reside. |
| |
| @returns a named tuple of (state, time) |
| """ |
| POLLING_INTERVAL_SECONDS = 1.0 |
| start_time = time.time() |
| duration = lambda: time.time() - start_time |
| success = False |
| while duration() < timeout_seconds: |
| success, state, conn_time = self.wait_for_service_states( |
| ssid, self.CONNECTED_STATES, timeout_seconds - duration()) |
| if not success: |
| time.sleep(POLLING_INTERVAL_SECONDS) |
| continue |
| |
| if freq: |
| actual_freq = self.get_iw_link_value( |
| iw_runner.IW_LINK_KEY_FREQUENCY) |
| if str(freq) != actual_freq: |
| logging.debug('Waiting for desired frequency %s (got %s).', |
| freq, actual_freq) |
| time.sleep(POLLING_INTERVAL_SECONDS) |
| continue |
| |
| if desired_subnet: |
| actual_subnet = self.wifi_ip_subnet |
| if actual_subnet != desired_subnet: |
| logging.debug('Waiting for desired subnet %s (got %s).', |
| desired_subnet, actual_subnet) |
| time.sleep(POLLING_INTERVAL_SECONDS) |
| continue |
| |
| if ping_ip: |
| ping_config = ping_runner.PingConfig(ping_ip) |
| self.ping(ping_config) |
| |
| return ConnectTime(state, conn_time) |
| |
| freq_error_str = (' on frequency %d Mhz' % freq) if freq else '' |
| raise error.TestFail( |
| 'Failed to connect to "%s"%s in %f seconds (state=%s)' % |
| (ssid, freq_error_str, duration(), state)) |
| |
| |
| @contextmanager |
| def assert_disconnect_count(self, count): |
| """Context asserting |count| disconnects for the context lifetime. |
| |
| Creates an iw logger during the lifetime of the context and asserts |
| that the client disconnects exactly |count| times. |
| |
| @param count int the expected number of disconnections. |
| |
| """ |
| with self.iw_runner.get_event_logger() as logger: |
| logger.start() |
| yield |
| logger.stop() |
| if logger.get_disconnect_count() != count: |
| raise error.TestFail( |
| 'Client disconnected %d times; expected %d' % |
| (logger.get_disconnect_count(), count)) |
| |
| |
| def assert_no_disconnects(self): |
| """Context asserting no disconnects for the context lifetime.""" |
| return self.assert_disconnect_count(0) |
| |
| |
| def stop_wpasupplicant(self): |
| """Stop wpa_supplicant.""" |
| self.host.run('stop wpasupplicant', ignore_status=True) |
| # wpa_supplicant will bring down the link when it goes down. Bring up |
| # the interface to allow the test to use the interface. |
| self.host.run('%s link set %s up' % (self.cmd_ip, self.wifi_if)) |
| |
| |
| def start_wpasupplicant(self, warn_if_not_running=False): |
| """Start wpa_supplicant if it is not running""" |
| if (self.host.run('pgrep -l wpa_supplicant', |
| ignore_status=True).exit_status != 0): |
| if warn_if_not_running: |
| logging.warning('wpasupplicant is not running, will be started') |
| self.host.run('start wpasupplicant', ignore_status=True) |
| |
| |
| def set_sched_scan(self, enable, fail_on_unsupported=False): |
| """enable/disable scheduled scan. |
| |
| @param enable bool flag indicating to enable/disable scheduled scan. |
| |
| """ |
| if fail_on_unsupported: |
| self._assert_method_supported('set_sched_scan') |
| elif not self._supports_method('set_sched_scan'): |
| return False |
| return self._shill_proxy.set_sched_scan(enable) |
| |
| |
| class TemporaryDBusProperty: |
| """Utility class to temporarily change a dbus property for the WiFi device. |
| |
| Since dbus properties are global and persistent settings, we want |
| to make sure that we change them back to what they were before the test |
| started. |
| |
| """ |
| |
| def __init__(self, shill_proxy, interface, prop_name, value): |
| """Construct a TemporaryDBusProperty context manager. |
| |
| @param shill_proxy: the shill proxy to use to communicate via dbus |
| @param interface: the name of the interface we are setting the property for |
| @param prop_name: the name of the property we want to set |
| @param value: the desired value of the property |
| |
| """ |
| self._shill = shill_proxy |
| self._interface = interface |
| self._prop_name = prop_name |
| self._value = value |
| self._saved_value = None |
| |
| |
| def __enter__(self): |
| logging.info('- Setting property %s on device %s', |
| self._prop_name, self._interface) |
| |
| self._saved_value = self._shill.get_dbus_property_on_device( |
| self._interface, self._prop_name) |
| if self._saved_value is None: |
| raise error.TestFail('Device or property not found.') |
| if not self._shill.set_dbus_property_on_device(self._interface, |
| self._prop_name, |
| self._value): |
| raise error.TestFail('Could not set property') |
| |
| logging.info('- Changed value from %s to %s', |
| self._saved_value, |
| self._value) |
| |
| |
| def __exit__(self, exception, value, traceback): |
| logging.info('- Resetting property %s', self._prop_name) |
| |
| if not self._shill.set_dbus_property_on_device(self._interface, |
| self._prop_name, |
| self._saved_value): |
| raise error.TestFail('Could not reset property') |
