Added an argument to AddDomMutationObserver and WaitForDomNode automation hooks to allow the use of…

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 2950 matching lines @@
     cmd_dict = {
       'command': 'AddDomEventObserver',
       'event_name': event_name,
       'automation_id': automation_id,
       'recurring': recurring,
     }
     return self._GetResultFromJSONRequest(cmd_dict, windex=None)['observer_id']
 
   def AddDomMutationObserver(self, mutation_type, xpath,
                              attribute='textContent', expected_value=None,
-                             automation_id=44444, **kwargs):
+                             automation_id=44444,
+                             exec_js=None, **kwargs):

[Nirnimesh, 2012/04/24 23:25:02]

would supplying the default arg (PyUITest.ExecuteJavascript) work here?

[craigdh, 2012/04/25 00:57:15]

Unfortunately, no, I tried that. Even moving the ExecuteJavascript def before
here doesn't work. It appears you can't reference methods internal to the class
before the class is fully parsed by Python.

     """Sets up an event observer watching for a specific DOM mutation.
 
     Creates an observer that raises an event when a mutation of the given type
     occurs on a DOM node specified by |selector|.
 
     Args:
       mutation_type: One of 'add', 'remove', 'change', or 'exists'.
       xpath: An xpath specifying the DOM node to watch. The node must already
           exist if |mutation_type| is 'change'.
       attribute: Attribute to match |expected_value| against, if given. Defaults
           to 'textContent'.
       expected_value: Optional regular expression to match against the node's
           textContent attribute after the mutation. Defaults to None.
       automation_id: The automation_id used to route the observer javascript
           messages. Defaults to 44444.
+      exec_js: A callable of the form f(self, js, **kwargs) used to inject the
+          MutationObserver javascript. Defaults to None, which uses
+          PyUITest.ExecuteJavascript.
 
       Any additional keyword arguments are passed on to ExecuteJavascript and
       can be used to select the tab where the DOM MutationObserver is created.
 
     Returns:
       The id of the created observer, which can be used with GetNextEvent(id)
       and RemoveEventObserver(id).
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
@@ skipping 11 matching lines @@
     observer_id = (
         self._GetResultFromJSONRequest(cmd_dict, windex=None)['observer_id'])
     expected_string = ('null' if expected_value is None else '"%s"' %
                        expected_value.replace('"', r'\"'))
     jsfile = os.path.join(os.path.abspath(os.path.dirname(__file__)),
                           'dom_mutation_observer.js')
     with open(jsfile, 'r') as f:
       js = ('(' + f.read() + ')(%d, %d, "%s", "%s", "%s", %s);' %
             (automation_id, observer_id, mutation_type,
              xpath.replace('"', r'\"'), attribute, expected_string))
-    jsreturn = self.ExecuteJavascript(js, **kwargs)
+    exec_js = PyUITest.ExecuteJavascript if exec_js is None else exec_js

[Nirnimesh, 2012/04/24 23:25:02]

exec_js = exec_js or PyUITest.ExecuteJavascript

[craigdh, 2012/04/25 00:57:15]

Done. Good point, a callable will never evaluate as False.

+    jsreturn = exec_js(self, js, **kwargs)
     if jsreturn != 'success':
       self.RemoveEventObserver(observer_id)
       raise pyauto_errors.JavascriptRuntimeError(jsreturn)
     return observer_id
 
   def WaitForDomNode(self, xpath, attribute='textContent',
-                     expected_value=None, timeout=-1, **kwargs):
+                     expected_value=None, exec_js=None, timeout=-1, **kwargs):
     """Waits until a node specified by an xpath exists in the DOM.
 
     NOTE: This does NOT poll. It returns as soon as the node appears, or
       immediately if the node already exists.
 
     Args:
       xpath: An xpath specifying the DOM node to watch.
       attribute: Attribute to match |expected_value| against, if given. Defaults
           to 'textContent'.
       expected_value: Optional regular expression to match against the node's
           textContent attribute. Defaults to None.
+      exec_js: A callable of the form f(self, js, **kwargs) used to inject the
+          MutationObserver javascript. Defaults to None, which uses
+          PyUITest.ExecuteJavascript.
       timeout: Time to wait for the node to exist before raising an exception,
           defaults to the default automation timeout.
 
       Any additional keyword arguments are passed on to ExecuteJavascript and
       can be used to select the tab where the DOM MutationObserver is created.
 
     Raises:
       pyauto_errors.JSONInterfaceError if the automation call returns an error.
       pyauto_errors.JavascriptRuntimeError if the injected javascript
           MutationObserver returns an error.
     """
     observer_id = self.AddDomMutationObserver('exists', xpath, attribute,
-                                              expected_value, **kwargs)
+                                              expected_value, exec_js=exec_js,
+                                              **kwargs)
     self.GetNextEvent(observer_id, timeout=timeout)
 
   def GetNextEvent(self, observer_id=-1, blocking=True, timeout=-1):
     """Waits for an observed event to occur.
 
     The returned event is removed from the Event Queue. If there is already a
     matching event in the queue it is returned immediately, otherwise the call
     blocks until a matching event occurs. If blocking is disabled and no
     matching event is in the queue this function will immediately return None.
 
@@ skipping 2339 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()