Enhance unit tests reliability of js bindings (cztomczak#59)

cztomczak · cztomczak · commit a737d26cad76 · 2018-08-18T15:37:47.000+02:00
diff --git a/unittests/_common.py b/unittests/_common.py
@@ -13,6 +13,7 @@
 MESSAGE_LOOP_RANGE = 100  # each iteration is 0.01 sec
 
 g_subtests_ran = 0
+g_js_code_completed = False
 
 
 def subtest_message(message):
@@ -50,7 +51,21 @@ def do_message_loop_work(work_loops):
         time.sleep(0.01)
 
 
+def js_code_completed():
+    """Sometimes window.onload can execute before javascript bindings
+    are ready if the document loads very fast. When setting javascript
+    bindings it can take some time, because these bindings are sent
+    via IPC messaging to the Renderer process."""
+    global g_js_code_completed
+    assert not g_js_code_completed
+    g_js_code_completed = True
+    subtest_message("js_code_completed() ok")
+
+
 def check_auto_asserts(test_case, objects):
+    # Check if js code completed
+    test_case.assertTrue(g_js_code_completed)
+
     # Automatic check of asserts in handlers and in external
     for obj in objects:
         test_for_True = False  # Test whether asserts are working correctly
@@ -170,4 +185,3 @@ def Visit(self, value):
         self.load_handler.FrameSourceVisitor_True = True
         self.test_case.assertIn("747ef3e6011b6a61e6b3c6e54bdd2dee",
                                 value)
-
diff --git a/unittests/main_test.py b/unittests/main_test.py
@@ -31,9 +31,17 @@
         msg = msg.replace("error", "<b style='color:red'>error</b>");
         document.getElementById("console").innerHTML += msg+"<br>";
     }
-    window.onload = function(){
-        print("window.onload() ok");
-
+    function onload_helper() {
+        if (!window.hasOwnProperty("cefpython_version")) {
+            // Sometimes page could finish loading before javascript
+            // bindings are available. Javascript bindings are sent
+            // from the browser process to the renderer process via
+            // IPC messaging and it can take some time (5-10ms). If
+            // the page loads very fast window.onload could execute
+            // before bindings are available.
+            setTimeout(onload_helper, 10);
+            return;
+        }
         version = cefpython_version
         print("CEF Python: <b>"+version.version+"</b>");
         print("Chrome: <b>"+version.chrome_version+"</b>");
@@ -78,7 +86,12 @@
             py_callback("String sent from Javascript");
             print("py_callback() ok");
         });
-    };
+        js_code_completed();
+    }
+    window.onload = function() {
+        print("window.onload() ok");
+        onload_helper();
+    }
     </script>
 </head>
 <body>
@@ -133,6 +146,7 @@ def test_main(self):
         external = External(self)
         bindings = cef.JavascriptBindings(
                 bindToFrames=False, bindToPopups=False)
+        bindings.SetFunction("js_code_completed", js_code_completed)
         bindings.SetFunction("test_function", external.test_function)
         bindings.SetProperty("test_property1", external.test_property1)
         bindings.SetProperty("test_property2", external.test_property2)
@@ -181,6 +195,7 @@ def test_main(self):
         # and calling shutdown.
         do_message_loop_work(25)
 
+        # Asserts before shutdown
         # noinspection PyTypeChecker
         check_auto_asserts(self, [] + client_handlers
                                     + [global_handler,
diff --git a/unittests/osr_test.py b/unittests/osr_test.py
@@ -31,13 +31,26 @@
         msg = msg.replace("error", "<b style='color:red'>error</b>");
         document.getElementById("console").innerHTML += msg+"<br>";
     }
-    window.onload = function(){
-        print("window.onload() ok");
-
+    function onload_helper() {
+        if (!window.hasOwnProperty("cefpython_version")) {
+            // Sometimes page could finish loading before javascript
+            // bindings are available. Javascript bindings are sent
+            // from the browser process to the renderer process via
+            // IPC messaging and it can take some time (5-10ms). If
+            // the page loads very fast window.onload could execute
+            // before bindings are available.
+            setTimeout(onload_helper, 10);
+            return;
+        }
         version = cefpython_version
         print("CEF Python: <b>"+version.version+"</b>");
         print("Chrome: <b>"+version.chrome_version+"</b>");
         print("CEF: <b>"+version.cef_version+"</b>");
+        js_code_completed();
+    }
+    window.onload = function() {
+        print("window.onload() ok");
+        onload_helper();
     }
     </script>
 </head>
@@ -95,6 +108,7 @@ def test_osr(self):
         # Javascript bindings
         bindings = cef.JavascriptBindings(
                 bindToFrames=False, bindToPopups=False)
+        bindings.SetFunction("js_code_completed", js_code_completed)
         bindings.SetProperty("cefpython_version", cef.GetVersion())
         browser.SetJavascriptBindings(bindings)
         subtest_message("browser.SetJavascriptBindings() ok")
@@ -126,7 +140,7 @@ def test_osr(self):
         # and calling shutdown.
         do_message_loop_work(25)
 
-        # Automatic check of asserts in handlers
+        # Asserts before shutdown
         # noinspection PyTypeChecker
         check_auto_asserts(self, [] + client_handlers
                                     + [global_handler,
