| # 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 dbus |
| import logging |
| import time |
| |
| def dbus2primitive(value): |
| if isinstance(value, dbus.Boolean): |
| return bool(value) |
| elif isinstance(value, int): |
| return int(value) |
| elif isinstance(value, float): |
| return float(value) |
| elif isinstance(value, str): |
| return str(value) |
| elif isinstance(value, unicode): |
| return str(value) |
| elif isinstance(value, list): |
| return [dbus2primitive(x) for x in value] |
| elif isinstance(value, tuple): |
| return tuple([dbus2primitive(x) for x in value]) |
| elif isinstance(value, dict): |
| return dict([(dbus2primitive(k), dbus2primitive(v)) |
| for k,v in value.items()]) |
| else: |
| logging.error('Failed to convert dbus object of class: %r', |
| value.__class__.__name__) |
| return value |
| |
| |
| class ShillProxy(object): |
| DBUS_INTERFACE = 'org.chromium.flimflam' |
| DBUS_SERVICE_UNKNOWN = 'org.freedesktop.DBus.Error.ServiceUnknown' |
| DBUS_TYPE_DEVICE = 'org.chromium.flimflam.Device' |
| DBUS_TYPE_MANAGER = 'org.chromium.flimflam.Manager' |
| DBUS_TYPE_PROFILE = 'org.chromium.flimflam.Profile' |
| DBUS_TYPE_SERVICE = 'org.chromium.flimflam.Service' |
| |
| MANAGER_PROPERTY_ACTIVE_PROFILE = 'ActiveProfile' |
| MANAGER_PROPERTY_DEVICES = 'Devices' |
| MANAGER_PROPERTY_PROFILES = 'Profiles' |
| MANAGER_PROPERTY_SERVICES = 'Services' |
| MANAGER_PROPERTY_ALL_SERVICES = 'ServiceCompleteList' |
| |
| OBJECT_TYPE_PROPERTY_MAP = { |
| 'Device': ( DBUS_TYPE_DEVICE, MANAGER_PROPERTY_DEVICES ), |
| 'Profile': ( DBUS_TYPE_PROFILE, MANAGER_PROPERTY_PROFILES ), |
| 'Service': ( DBUS_TYPE_SERVICE, MANAGER_PROPERTY_SERVICES ), |
| 'AnyService': ( DBUS_TYPE_SERVICE, MANAGER_PROPERTY_ALL_SERVICES ) |
| } |
| |
| SERVICE_DISCONNECT_TIMEOUT = 5 |
| |
| SERVICE_PROPERTY_AUTOCONNECT = 'AutoConnect' |
| SERVICE_PROPERTY_GUID = 'GUID' |
| SERVICE_PROPERTY_HIDDEN = 'WiFi.HiddenSSID' |
| SERVICE_PROPERTY_MODE = 'Mode' |
| SERVICE_PROPERTY_NAME = 'Name' |
| SERVICE_PROPERTY_PASSPHRASE = 'Passphrase' |
| SERVICE_PROPERTY_SAVE_CREDENTIALS = 'SaveCredentials' |
| SERVICE_PROPERTY_SECURITY = 'Security' |
| SERVICE_PROPERTY_SSID = 'SSID' |
| SERVICE_PROPERTY_STRENGTH = 'Strength' |
| SERVICE_PROPERTY_STATE = 'State' |
| SERVICE_PROPERTY_TYPE = 'Type' |
| |
| SUPPORTED_WIFI_STATION_TYPES = {'managed': 'managed', |
| 'ibss': 'adhoc', |
| None: 'managed'} |
| |
| TECHNOLOGY_CELLULAR = 'cellular' |
| TECHNOLOGY_ETHERNET = 'ethernet' |
| TECHNOLOGY_VPN = 'vpn' |
| TECHNOLOGY_WIFI = 'wifi' |
| TECHNOLOGY_WIMAX = 'wimax' |
| |
| POLLING_INTERVAL_SECONDS = 0.2 |
| |
| # Default log level used in connectivity tests. |
| LOG_LEVEL_FOR_TEST = -4 |
| |
| # Default log scopes used in connectivity tests. |
| LOG_SCOPES_FOR_TEST_COMMON = [ |
| 'connection', |
| 'dbus', |
| 'device', |
| 'link', |
| 'manager', |
| 'portal', |
| 'service' |
| ] |
| |
| # Default log scopes used in connectivity tests for specific technologies. |
| LOG_SCOPES_FOR_TEST = { |
| TECHNOLOGY_CELLULAR: LOG_SCOPES_FOR_TEST_COMMON + ['cellular'], |
| TECHNOLOGY_ETHERNET: LOG_SCOPES_FOR_TEST_COMMON + ['ethernet'], |
| TECHNOLOGY_VPN: LOG_SCOPES_FOR_TEST_COMMON + ['vpn'], |
| TECHNOLOGY_WIFI: LOG_SCOPES_FOR_TEST_COMMON + ['wifi'], |
| TECHNOLOGY_WIMAX: LOG_SCOPES_FOR_TEST_COMMON + ['wimax'] |
| } |
| |
| UNKNOWN_METHOD = 'org.freedesktop.DBus.Error.UnknownMethod' |
| |
| |
| @staticmethod |
| def get_shill_proxy(timeout_seconds=10): |
| """Create a ShillProxy, retrying if necessary. |
| |
| Connects to shill over D-Bus. If shill is not yet running, |
| retry until it is, or until |timeout_seconds| expires. |
| |
| After connecting to shill, this method will verify that shill |
| is answering RPCs. No timeout is applied to the test RPC, so |
| this method _may_ block indefinitely. |
| |
| @param timeout_seconds float number of seconds to try connecting |
| A value <= 0 will cause the method to return immediately, |
| without trying to connect. |
| @return a ShillProxy instance if we connected, or None otherwise |
| """ |
| end_time = time.time() + timeout_seconds |
| connection = None |
| while connection is None and time.time() < end_time: |
| try: |
| connection = ShillProxy() |
| except dbus.exceptions.DBusException as e: |
| if e.get_dbus_name() != ShillProxy.DBUS_SERVICE_UNKNOWN: |
| raise error.TestFail('Error connecting to shill') |
| else: |
| # Wait a moment before retrying |
| time.sleep(ShillProxy.POLLING_INTERVAL_SECONDS) |
| |
| if connection is None: |
| return None |
| |
| # Although shill is connected to D-Bus at this point, it may |
| # not have completed initialization just yet. Call into shill, |
| # and wait for the response, to make sure that it is truly up |
| # and running. (Shill will not service D-Bus requests until |
| # initialization is complete.) |
| connection.get_profiles() |
| return connection |
| |
| |
| def wait_for_property_in(self, dbus_object, property_name, |
| expected_values, timeout_seconds): |
| """ |
| Block until the property |property_name| in |dbus_object| is in |
| |expected_values|, or |timeout_seconds|. |
| |
| @param dbus_object DBus proxy object as returned by |
| self.get_dbus_object. |
| @param property_name string property key in dbus_object. |
| @param expected_values iterable set of values to return successfully |
| upon seeing. |
| @param timeout_seconds float number of seconds to return if we haven't |
| seen the appropriate property value in time. |
| @return tuple(successful, final_value, duration) |
| where successful is True iff we saw one of |expected_values| for |
| |property_name|, final_value is the member of |expected_values| we |
| saw, and duration is how long we waited to see that value. |
| |
| """ |
| # TODO(wiley) This should be changed to be event based (not polling). |
| value = None |
| start_time = time.time() |
| successful = False |
| while time.time() < start_time + timeout_seconds: |
| properties = dbus_object.GetProperties(utf8_strings=True) |
| value = properties.get(property_name, None) |
| if value in expected_values: |
| successful = True |
| break |
| time.sleep(self.POLLING_INTERVAL_SECONDS) |
| duration = time.time() - start_time |
| return (successful, dbus2primitive(value), duration) |
| |
| |
| def __init__(self, bus=None): |
| if bus is None: |
| bus = dbus.SystemBus() |
| self._bus = bus |
| self._manager = self.get_dbus_object(self.DBUS_TYPE_MANAGER, '/') |
| |
| |
| @property |
| def manager(self): |
| """ @return DBus proxy object representing the shill Manager. """ |
| return self._manager |
| |
| |
| def get_active_profile(self): |
| """ |
| Get the active profile in shill. |
| |
| @return dbus object representing the active profile. |
| |
| """ |
| properties = self.manager.GetProperties(utf8_strings=True) |
| return self.get_dbus_object( |
| self.DBUS_TYPE_PROFILE, |
| properties[self.MANAGER_PROPERTY_ACTIVE_PROFILE]) |
| |
| |
| def get_dbus_object(self, type_str, path): |
| """ |
| Return the DBus object of type |type_str| at |path| in shill. |
| |
| @param type_str string (e.g. self.DBUS_TYPE_SERVICE). |
| @param path path to object in shill (e.g. '/service/12'). |
| @return DBus proxy object. |
| |
| """ |
| return dbus.Interface( |
| self._bus.get_object(self.DBUS_INTERFACE, path), |
| type_str) |
| |
| |
| def get_profiles(self): |
| properties = self.manager.GetProperties(utf8_strings=True) |
| return [self.get_dbus_object(self.DBUS_TYPE_PROFILE, path) |
| for path in properties[self.MANAGER_PROPERTY_PROFILES]] |
| |
| |
| def get_service(self, params): |
| """ |
| Get the shill service that matches |params|. |
| |
| @param params dict of strings understood by shill to describe |
| a service. |
| @return DBus object interface representing a service. |
| |
| """ |
| path = self.manager.GetService(params) |
| return self.get_dbus_object(self.DBUS_TYPE_SERVICE, path) |
| |
| |
| def set_logging(self, level, scopes): |
| """Set the logging in shill to the specified |level| and |scopes|. |
| |
| @param level int log level to set to in shill. |
| @param scopes list of strings of log scopes to set to in shill. |
| |
| """ |
| self.manager.SetDebugLevel(level) |
| self.manager.SetDebugTags('+'.join(scopes)) |
| |
| |
| def set_logging_for_test(self, technology): |
| """Set the logging in shill for a test of the specified |technology|. |
| |
| Set the log level to |LOG_LEVEL_FOR_TEST| and the log scopes to the |
| ones defined in |LOG_SCOPES_FOR_TEST| for |technology|. If |technology| |
| is not found in |LOG_SCOPES_FOR_TEST|, the log scopes are set to |
| |LOG_SCOPES_FOR_TEST_COMMON|. |
| |
| @param technology string representing the technology type of a test |
| that the logging in shill is to be customized for. |
| |
| """ |
| scopes = self.LOG_SCOPES_FOR_TEST.get(technology, |
| self.LOG_SCOPES_FOR_TEST_COMMON) |
| self.set_logging(self.LOG_LEVEL_FOR_TEST, scopes) |
| |
| |
| def connect_to_wifi_network(self, |
| ssid, |
| security, |
| security_parameters, |
| save_credentials, |
| station_type=None, |
| hidden_network=False, |
| discovery_timeout_seconds=15, |
| association_timeout_seconds=15, |
| configuration_timeout_seconds=15): |
| """ |
| Connect to a WiFi network with the given association parameters. |
| |
| @param ssid string name of network to connect to. |
| @param security string type of security used in network (e.g. psk) |
| @param security_parameters dict of service property/value pairs that |
| make up the credentials and settings for the given security |
| type (e.g. the passphrase for psk security). |
| @param save_credentials bool True if we should save EAP credentials. |
| @param station_type string one of SUPPORTED_WIFI_STATION_TYPES. |
| @param hidden_network bool True when the SSID is not broadcasted. |
| @param discovery_timeout_seconds float timeout for service discovery. |
| @param association_timeout_seconds float timeout for service |
| association. |
| @param configuration_timeout_seconds float timeout for DHCP |
| negotiations. |
| @return (successful, discovery_time, association_time, |
| configuration_time, reason) |
| where successful is True iff the operation succeeded, *_time is |
| the time spent waiting for each transition, and reason is a string |
| which may contain a meaningful description of failures. |
| |
| """ |
| logging.info('Attempting to conect to %s', ssid) |
| service_proxy = None |
| start_time = time.time() |
| discovery_time = -1.0 |
| association_time = -1.0 |
| configuration_time = -1.0 |
| if station_type not in self.SUPPORTED_WIFI_STATION_TYPES: |
| return (False, discovery_time, association_time, |
| configuration_time, |
| 'FAIL(Invalid station type specified.)') |
| |
| # mode is derived from the station type we're attempting to join. |
| # It does not refer to the 802.11x type. It refers to a flimflam/shill |
| # connection mode. |
| mode = self.SUPPORTED_WIFI_STATION_TYPES[station_type] |
| |
| if hidden_network: |
| logging.info('Configuring %s as a hidden network.', ssid) |
| config_params = {self.SERVICE_PROPERTY_TYPE: 'wifi', |
| self.SERVICE_PROPERTY_HIDDEN: True, |
| self.SERVICE_PROPERTY_SSID: ssid, |
| self.SERVICE_PROPERTY_SECURITY: security, |
| self.SERVICE_PROPERTY_MODE: mode} |
| try: |
| self.manager.ConfigureService(config_params) |
| except dbus.exceptions.DBusException, e: |
| logging.error( |
| 'Caught an error while configuring a hidden SSID: %s', |
| e.get_dbus_message()) |
| return (False, discovery_time, association_time, |
| configuration_time, |
| 'FAIL(Failed to configure hidden SSID)') |
| |
| logging.info('Configured hidden service: %s', ssid) |
| |
| |
| logging.info('Discovering...') |
| discovery_params = {self.SERVICE_PROPERTY_TYPE: 'wifi', |
| self.SERVICE_PROPERTY_NAME: ssid, |
| self.SERVICE_PROPERTY_SECURITY: security, |
| self.SERVICE_PROPERTY_MODE: mode} |
| while time.time() - start_time < discovery_timeout_seconds: |
| discovery_time = time.time() - start_time |
| try: |
| service_path = self.manager.FindMatchingService( |
| discovery_params) |
| service_object = self.get_dbus_object(self.DBUS_TYPE_SERVICE, |
| service_path) |
| service_properties = service_object.GetProperties( |
| utf8_strings=True) |
| strength = dbus2primitive( |
| service_properties[self.SERVICE_PROPERTY_STRENGTH]) |
| if strength > 0: |
| logging.info('Discovered service: %s. Strength: %r.', |
| ssid, strength) |
| break |
| except dbus.exceptions.DBusException, e: |
| # There really is not a better way to check the error type. |
| if e.get_dbus_message() != 'Matching service was not found': |
| logging.error('Caught an error while discovering: %s', |
| e.get_dbus_message()) |
| # This is spammy, but shill handles that for us. |
| self.manager.RequestScan('wifi') |
| time.sleep(self.POLLING_INTERVAL_SECONDS) |
| else: |
| return (False, discovery_time, association_time, |
| configuration_time, 'FAIL(Discovery timed out)') |
| |
| # At this point, we know |service| is in the service list. Attempt |
| # to connect it, and watch the states roll by. |
| logging.info('Connecting...') |
| try: |
| for service_property, value in security_parameters.iteritems(): |
| service_object.SetProperty(service_property, value) |
| service_object.Connect() |
| logging.info('Called connect on service') |
| except dbus.exceptions.DBusException, e: |
| logging.error('Caught an error while trying to connect: %s', |
| e.get_dbus_message()) |
| return (False, discovery_time, association_time, |
| configuration_time, 'FAIL(Failed to call connect)') |
| |
| logging.info('Associating...') |
| result = self.wait_for_property_in( |
| service_object, |
| self.SERVICE_PROPERTY_STATE, |
| ('configuration', 'ready', 'portal', 'online'), |
| association_timeout_seconds) |
| (successful, _, association_time) = result |
| if not successful: |
| return (False, discovery_time, association_time, |
| configuration_time, 'FAIL(Association timed out)') |
| |
| logging.info('Associated with service: %s', ssid) |
| |
| logging.info('Configuring...') |
| result = self.wait_for_property_in( |
| service_object, |
| self.SERVICE_PROPERTY_STATE, |
| ('ready', 'portal', 'online'), |
| configuration_timeout_seconds) |
| (successful, _, configuration_time) = result |
| if not successful: |
| return (False, discovery_time, association_time, |
| configuration_time, 'FAIL(Configuration timed out)') |
| |
| logging.info('Configured service: %s', ssid) |
| |
| # Great success! |
| logging.info('Connected to WiFi service.') |
| return (True, discovery_time, association_time, configuration_time, |
| 'SUCCESS(Connection successful)') |
| |
| |
| def disconnect_from_wifi_network(self, ssid, timeout=None): |
| """Disconnect from the specified WiFi network. |
| |
| Method will succeed if it observes the specified network in the idle |
| state after calling Disconnect. |
| |
| @param ssid string name of network to disconnect. |
| @param timeout float number of seconds to wait for idle. |
| @return tuple(success, duration, reason) where: |
| success is a bool (True on success). |
| duration is a float number of seconds the operation took. |
| reason is a string containing an informative error on failure. |
| |
| """ |
| if timeout is None: |
| timeout = self.SERVICE_DISCONNECT_TIMEOUT |
| service_description = {self.SERVICE_PROPERTY_TYPE: 'wifi', |
| self.SERVICE_PROPERTY_NAME: ssid} |
| try: |
| service_path = self.manager.FindMatchingService(service_description) |
| except dbus.exceptions.DBusException, e: |
| return (False, |
| 0.0, |
| 'Failed to disconnect from %s, service not found.' % ssid) |
| |
| service = self.get_dbus_object(self.DBUS_TYPE_SERVICE, service_path) |
| service.Disconnect() |
| result = self.wait_for_property_in(service, |
| self.SERVICE_PROPERTY_STATE, |
| ('idle',), |
| timeout) |
| (successful, final_state, duration) = result |
| message = 'Success.' |
| if not successful: |
| message = ('Failed to disconnect from %s, ' |
| 'timed out in state: %s.' % (ssid, final_state)) |
| return (successful, duration, message) |
| |
| |
| def find_object(self, object_type, properties): |
| """Find a shill object with the specified type and properties. |
| |
| Return the first shill object of |object_type| whose properties match |
| all that of |properties|. |
| |
| @param object_type string representing the type of object to be |
| returned. Valid values are those object types defined in |
| |OBJECT_TYPE_PROPERTY_MAP|. |
| @param properties dict of strings understood by shill to describe |
| a service. |
| @return DBus object interface representing the object found or None |
| if no matching object is found. |
| |
| """ |
| if object_type not in self.OBJECT_TYPE_PROPERTY_MAP: |
| return None |
| |
| dbus_type, manager_property = self.OBJECT_TYPE_PROPERTY_MAP[object_type] |
| manager_properties = self.manager.GetProperties(utf8_strings=True) |
| for path in manager_properties[manager_property]: |
| test_object = self.get_dbus_object(dbus_type, path) |
| object_properties = test_object.GetProperties(utf8_strings=True) |
| for name, value in properties.iteritems(): |
| if (name not in object_properties or |
| dbus2primitive(object_properties[name]) != value): |
| break |
| else: |
| return test_object |
| return None |
| |
| |
| def configure_bgscan(self, interface, method=None, short_interval=None, |
| long_interval=None, signal=None): |
| """Configures bgscan parameters for wpa_supplicant. |
| |
| @param interface string name of interface to configure (e.g. 'mlan0'). |
| @param method string bgscan method (e.g. 'none'). |
| @param short_interval int short scanning interval. |
| @param long_interval int normal scanning interval. |
| @param signal int signal threshold. |
| |
| """ |
| device = self.find_object('Device', {'Name': interface}) |
| if device is None: |
| logging.error('No device found with name: %s', interface) |
| return False |
| |
| attributes = {'ScanInterval': (dbus.UInt16, long_interval), |
| 'BgscanMethod': (dbus.String, method), |
| 'BgscanShortInterval': (dbus.UInt16, short_interval), |
| 'BgscanSignalThreshold': (dbus.Int32, signal)} |
| for k, (type_cast, value) in attributes.iteritems(): |
| if value is None: |
| continue |
| |
| # 'default' is defined in: |
| # client/common_lib/cros/network/xmlrpc_datatypes.py |
| # but we don't have access to that file here. |
| if value == 'default': |
| device.ClearProperty(k) |
| else: |
| device.SetProperty(k, type_cast(value)) |
| return True |