PyAuto automation hooks: blocking wifi connect, disconnect, and network scan.

chrome/test/pyautolib/pyauto.py

 #!/usr/bin/python
 
 # Copyright (c) 2011 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,
@@ skipping 453 matching lines @@
       windex: 0-based window index on which to work. Default: 0 (first window)
               Use -ve windex if the automation command does not apply to a
               browser window. example: chromeos login
 
     Returns:
       a dictionary for the output returned by the automation channel.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
-    ret_dict = json.loads(self._SendJSONRequest(windex, json.dumps(cmd_dict)))
+    result = self._SendJSONRequest(windex, json.dumps(cmd_dict))
+    if len(result) == 0:
+      raise JSONInterfaceError('Automation call received no response.')
+    ret_dict = json.loads(result)
     if ret_dict.has_key('error'):
       raise JSONInterfaceError(ret_dict['error'])
     return ret_dict
 
   def GetBookmarkModel(self):
     """Return the bookmark model as a BookmarkModel object.
 
     This is a snapshot of the bookmark model; it is not a proxy and
     does not get updated as the bookmark model changes.
     """
@@ skipping 1796 matching lines @@
       Sample:
 
       { u'is_logged_in': True,
         u'is_guest': False,
         u'is_screen_locked': False}
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
     cmd_dict = { 'command': 'GetLoginInfo' }
-    return self._GetResultFromJSONRequest(cmd_dict)
+    return self._GetResultFromJSONRequest(cmd_dict, windex=-1)
 
   def LoginAsGuest(self):
     """Login to chromeos as a guest user.
 
     Waits until logged in.
     Should be displaying the login screen to work.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
@@ skipping 68 matching lines @@
 
   def GetNetworkInfo(self):
     """Get details about ethernet, wifi, and cellular networks on chromeos.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
     cmd_dict = { 'command': 'GetNetworkInfo' }
     return self._GetResultFromJSONRequest(cmd_dict, windex=-1)
 
+  def NetworkScan(self):
+    """Causes ChromeOS to scan for available wifi networks.
+
+    Blocks until scanning is complete.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = { 'command': 'NetworkScan' }
+    self._GetResultFromJSONRequest(cmd_dict, windex=-1)
+
+  CONNECTION_ERROR_UNKNOWN           = 0
+  CONNECTION_ERROR_OUT_OF_RANGE      = 1
+  CONNECTION_ERROR_PIN_MISSING       = 2
+  CONNECTION_ERROR_DHCP_FAILED       = 3
+  CONNECTION_ERROR_CONNECT_FAILED    = 4
+  CONNECTION_ERROR_BAD_PASSPHRASE    = 5
+  CONNECTION_ERROR_BAD_WEPKEY        = 6
+  CONNECTION_ERROR_ACTIVATION_FAILED = 7
+  CONNECTION_ERROR_NEED_EVDO         = 8
+  CONNECTION_ERROR_NEED_HOME_NETWORK = 9
+  CONNECTION_ERROR_OTASP_FAILED      = 10
+  CONNECTION_ERROR_AAA_FAILED        = 11
+
   def ConnectToWifiNetwork(self, service_path,
                            password='', identity='', certpath=''):
     """Connect to a wifi network by its service path.
 
+    Blocks until connection suceeds or fails.

[dennis_jeffrey, 2011/03/24 23:48:54]

"suceeds" --> "succeeds"

[dtu, 2011/03/25 22:22:11]

Done.

+
+    Returns:
+      A tuple. The first element is True on success and False on failure.
+      The second element contains an integer error code in case of failure.

[stanleyw, 2011/03/24 23:16:03]

Rewrite as integer is too cumbersome to decode

[dtu, 2011/03/25 22:22:11]

Done. Using string error messages instead and comment updated.

[stanleyw, 2011/03/25 22:40:03]

What are the possible values of error strings? Or maybe specify where we can
find these. 
On 2011/03/25 22:22:11, Dave Tu wrote:

+
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
     """
     cmd_dict = {
         'command': 'ConnectToWifiNetwork',
         'service_path': service_path,
         'password': password,
         'identity': identity,
         'certpath': certpath,
     }
-    return self._GetResultFromJSONRequest(cmd_dict, windex=-1)
+    result = self._GetResultFromJSONRequest(cmd_dict, windex=-1)
+    if result.has_key('error_code'):
+      return (False, result['error_code'])

[stanleyw, 2011/03/24 23:16:03]

result['error_code'] is too cumbersome to decode

[dtu, 2011/03/25 22:22:11]

It's decoded for you, a caller of this function will just see a tuple with
(success, error_code).

+    else:
+      return (True, None)
+
+  def DisconnectFromWifiNetwork(self, service_path,
+                           password='', identity='', certpath=''):

[dennis_jeffrey, 2011/03/24 23:48:54]

Indent underneath first parameter in the previous line.

[dtu, 2011/03/25 22:22:11]

Done.

+    """Disconnect from a wifi network by its service path.
+
+    Blocks until disconnect is complete.
+
+    Raises:
+      pyauto_errors.JSONInterfaceError if the automation call returns an error.
+    """
+    cmd_dict = {
+        'command': 'DisconnectFromWifiNetwork',
+        'service_path': service_path,
+    }
+    self._GetResultFromJSONRequest(cmd_dict, windex=-1)
 
   ## ChromeOS section -- end
 
 
 class PyUITestSuite(pyautolib.PyUITestSuiteBase, unittest.TestSuite):
   """Base TestSuite for PyAuto UI tests."""
 
   def __init__(self, args):
     pyautolib.PyUITestSuiteBase.__init__(self, args)
 
@@ skipping 379 matching lines @@
     if self._options.verbose:
       verbosity = 2
     result = PyAutoTextTestRuner(verbosity=verbosity).run(pyauto_suite)
     del loaded_tests  # Need to destroy test cases before the suite
     del pyauto_suite
     sys.exit(not result.wasSuccessful())
 
 
 if __name__ == '__main__':
   Main()