Move WaitUntilWifiNetworkAvailable and GetServicePath to pyauto so it can be reached from autotest

chrome/test/pyautolib/pyauto.py

 #!/usr/bin/env python
 # 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.
 
 """PyAuto: Python Interface to Chromium's Automation Proxy.
 
 PyAuto uses swig to expose Automation Proxy interfaces to Python.
 For complete documentation on the functionality available,
 run pydoc on this file.
@@ skipping 4215 matching lines @@
 
     # Remembered networks do not have /service/ prepended to the service path
     # even though wifi_networks does.  We want this prepended to allow for
     # consistency and easy string comparison with wifi_networks.
     remembered_wifi = {}
     network_info['remembered_wifi'] = dict([('/service/' + k, v) for k, v in
       network_info['remembered_wifi'].iteritems()])
 
     return network_info
 
+  def GetConnectedWifi(self):
+    """Returns the SSID of the currently connected wifi network.

[dtu, 2012/04/30 21:26:05]

Add "on ChromeOS" or something like that. Same with the other one.

+
+    Returns:
+      The SSID of the connected network or None if we're not connected.
+    """
+    service_list = self.GetNetworkInfo()
+    connected_service_path = service_list.get('connected_wifi')
+    if 'wifi_networks' in service_list and \
+       connected_service_path in service_list['wifi_networks']:
+       return service_list['wifi_networks'][connected_service_path]['name']
+
+  def GetServicePath(self, ssid):
+    """Returns the service path associated with an SSID.
+
+    Args:
+      ssid: String defining the SSID we are searching for.
+
+    Returns:
+      The service path or None if SSID does not exist.
+    """
+    service_list = self.GetNetworkInfo()
+    service_list = service_list.get('wifi_networks', [])
+    for service_path, service_obj in service_list.iteritems():
+      if service_obj['name'] == ssid:
+        return service_path
+    return None
+
   def NetworkScan(self):
     """Causes ChromeOS to scan for available wifi networks.
 
     Blocks until scanning is complete.
 
     Returns:
       The new list of networks obtained from GetNetworkInfo().
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
@@ skipping 14 matching lines @@
         'command': 'ToggleNetworkDevice',
         'device': device,
         'enable': enable,
     }
     return self._GetResultFromJSONRequest(cmd_dict, windex=None)
 
   PROXY_TYPE_DIRECT = 1
   PROXY_TYPE_MANUAL = 2
   PROXY_TYPE_PAC = 3
 
+  def WaitUntilWifiNetworkAvailable(self, ssid, timeout=60, is_hidden=False):
+    """Waits until the given network is available.
+
+    Routers that are just turned on may take up to 1 minute upon turning them
+    on to broadcast their SSID.
+
+    Args:
+      ssid: SSID of the service we want to connect to.
+      timeout: timeout (in seconds)
+
+    Raises:
+      Exception if timeout duration has been hit before wifi router is seen.
+
+    Returns:
+      True, when the wifi network is seen within the timout period.
+      False, otherwise.
+    """
+    def _GotWifiNetwork():
+      # Returns non-empty array if desired SSID is available.
+      try:
+        return [wifi for wifi in
+                self.NetworkScan().get('wifi_networks', {}).values()
+                if wifi.get('name') == ssid]
+      except pyauto_errors.JSONInterfaceError:
+        # Temporary fix until crosbug.com/14174 is fixed.
+        # NetworkScan is only used in updating the list of networks so errors
+        # thrown by it are not critical to the results of wifi tests that use
+        # this method.
+        return False
+
+    # The hidden AP's will always be on, thus we will assume it is ready to
+    # connect to.
+    if is_hidden:
+      return bool(_GotWifiNetwork())
+
+    return self.WaitUntil(_GotWifiNetwork, timeout=timeout, retry_sleep=1)
+
   def GetProxyTypeName(self, proxy_type):
     values = { self.PROXY_TYPE_DIRECT: 'Direct Internet connection',
                self.PROXY_TYPE_MANUAL: 'Manual proxy configuration',
                self.PROXY_TYPE_PAC: 'Automatic proxy configuration' }
     return values[proxy_type]
 
   def GetProxySettingsOnChromeOS(self, windex=0):
     """Get current proxy settings on Chrome OS.
 
     Returns:
@@ skipping 1151 matching lines @@
     successful = result.wasSuccessful()
     if not successful:
       pyauto_tests_file = os.path.join(self.TestsDir(), self._tests_filename)
       print >>sys.stderr, 'Tests can be disabled by editing %s. ' \
                           'Ref: %s' % (pyauto_tests_file, _PYAUTO_DOC_URL)
     sys.exit(not successful)
 
 
 if __name__ == '__main__':
   Main()