test.py: Sending JSON between test_controller.js <-> browser_controller

dart/pkg/unittest/lib/test_controller.js

 // Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 /**
  * Test controller logic - used by unit test harness to embed tests in
  * conent shell.

[ricow1, 2013/10/23 11:42:32]

conent -> content + this comment is outdated

  */
 
-// Clear the console before every test run - this is Firebug specific code.
-if (typeof console == "object" && typeof console.clear == "function") {
-  console.clear();
+/*
+ * We will collect testing driver specific messages here instead of printing
+ * them to the DOM.
+ * Every entry will look like this:
+ *   {
+ *     'type' : 'test_outcome' / 'print' /  'debug' / 'message_received' / 'dom'
+ *     'value' : 'some content',
+ *   }
+ */
+var MESSAGES = [];
+
+function recordMessage(type, value) {
+  var message = {
+    type: type,
+    value: value
+  };
+  MESSAGES.push(message);
+  if (usingBrowserController()) {
+    printToConsole(JSON.stringify(message, null, 2));
+  }
 }
 
+function clearConsole() {
+  // Clear the console before every test run - this is Firebug specific code.
+  if (typeof console == 'object' && typeof console.clear == 'function') {
+    console.clear();
+  }
+}
+
+function printToConsole(message) {
+  if (typeof console === 'object') {
+    console.log(message);
+  }
+  if (!usingBrowserController()) {
+    var pre = document.createElement('pre');
+    pre.appendChild(document.createTextNode(String(message)));
+    document.body.appendChild(pre);
+    document.body.appendChild(document.createTextNode('\n'));
+  }
+}
+
+clearConsole();
+
 // Some tests may expect and have no way to suppress global errors.
 var testExpectsGlobalError = false;
 var testSuppressedGlobalErrors = [];
 
 // Set window onerror to make sure that we catch test harness errors across all
 // browsers.
 window.onerror = function (message, url, lineNumber) {
   if (testExpectsGlobalError) {
     testSuppressedGlobalErrors.push({
       message: message
@@ skipping 32 matching lines @@
   if (window != window.parent) {
     // We're running in an iframe.
     return window.parent;
   } else if (window.opener) {
     // We were opened by another window.
     return window.opener;
   }
   return null;
 }
 
+function usingBrowserController() {

[ricow1, 2013/10/23 11:42:32]

I am not sure we should special case on the browser controller in here, so maybe
find a better more generic name

+  return getDriverWindow() != null;
+}
+
 function notifyStart() {
   var driver = getDriverWindow();
   if (driver) {
     driver.postMessage("STARTING", "*");
   }
 }
 // We call notifyStart here to notify the encapsulating browser.
 notifyStart();
 
-function notifyDone() {
+function notifyDone(test_outcome) {
+  recordMessage('debug', 'Test outcome: ' + test_outcome);
+  // If we are not using the browser controller (i.e. in the none-drt

[ricow1, 2013/10/23 11:42:32]

again, I think this comment is bound to much to our internal testing framework

+  // configuration), we need to print 'test_outcome' as it is.
+  if (!usingBrowserController()) {
+    printToConsole(test_outcome);
+  }
+
   if (testRunner) testRunner.notifyDone();
-
-  // TODO(ricow): REMOVE, debug info, see issue 13292
-  if (!testRunner) {
-    printMessage('Calling notifyDone()');
-  }
   // To support in browser launching of tests we post back start and result
   // messages to the window.opener.
   var driver = getDriverWindow();
   if (driver) {
-    driver.postMessage(window.document.body.innerHTML, "*");
+    // FIXME: we have to post the dom and all recorded messages
+    var messages = MESSAGES.slice(0);
+    messages.push({
+      type: 'dom',
+      value: '' + window.document.documentElement.innerHTML
+    });
+    messages.push({
+      type: 'test_outcome',
+      value: test_outcome
+    });
+
+    driver.postMessage(JSON.stringify(messages), '*');
   }
 }
 
 function processMessage(msg) {
-  // TODO(ricow): REMOVE, debug info, see issue 13292
-  if (!testRunner) {
-    printMessage('processMessage(): ' + msg);
-  }
+  recordMessage('message_received', '' + msg);
   if (typeof msg != 'string') return;
-  if (msg == 'unittest-suite-done') {
-    notifyDone();
-  } else if (msg == 'unittest-suite-wait-for-done') {
+  if (msg == 'unittest-suite-wait-for-done') {
     waitForDone = true;
     if (testRunner) {
       testRunner.startedDartTest = true;
     }
   } else if (msg == 'dart-calling-main') {
     if (testRunner) {
       testRunner.startedDartTest = true;
     }
   } else if (msg == 'dart-main-done') {
     if (!waitForDone) {
-      printMessage('PASS');
-      notifyDone();
+      notifyDone('PASS');
     }
   } else if (msg == 'unittest-suite-success') {
-    printMessage('PASS');
-    notifyDone();
+    notifyDone('PASS');
   } else if (msg == 'unittest-suite-fail') {
-    showErrorAndExit('Some tests failed.');
+    notifyDone('FAIL');
   }
 }
 
 function onReceive(e) {
   processMessage(e.data);
 }
 
 if (testRunner) {
   testRunner.dumpAsText();
   testRunner.waitUntilDone();
 }
 window.addEventListener("message", onReceive, false);
 
 function showErrorAndExit(message) {
   if (message) {
-    printMessage('Error: ' + String(message));
+    recordMessage('debug', 'Error: ' + String(message));
   }
-  // dart/tools/testing/run_selenium.py is looking for either PASS or
-  // FAIL and will continue polling until one of these words show up.
-  printMessage('FAIL');
-  notifyDone();
+  notifyDone('FAIL');
 }
 
 function onLoad(e) {
   // needed for dartium compilation errors.
   if (window.compilationError) {
     showErrorAndExit(window.compilationError);
   }
 }
 
 window.addEventListener("DOMContentLoaded", onLoad, false);
@@ skipping 11 matching lines @@
   if (document.readyState != "loaded") return;
   // If 'startedDartTest' is not set, that means that the test did not have
   // a chance to load. This will happen when a load error occurs in the VM.
   // Give the machine time to start up.
   setTimeout(function() {
     // A window.postMessage might have been enqueued after this timeout.
     // Just sleep another time to give the browser the time to process the
     // posted message.
     setTimeout(function() {
       if (testRunner && !testRunner.startedDartTest) {
-        notifyDone();
+        notifyDone('NOT_STARTED');
       }
     }, 0);
   }, 50);
 });
 
 // dart2js will generate code to call this function to handle the Dart
 // [print] method.
 //
 // dartium will invoke this method for [print] calls if the environment variable
 // "DART_FORWARDING_PRINT" was set when launching dartium.
 //
 // Our tests will be wrapped, so we can detect when [main] is called and when
 // it has ended.
 // The wrapping happens either via "dartMainRunner" (for dart2js) or wrapped
 // tests for dartium.
 //
 // The following messages are handled specially:
 //   dart-calling-main:  signals that the dart [main] function will be invoked
 //   dart-main-done:  signals that the dart [main] function has finished
 //   unittest-suite-wait-for-done:  signals the start of an asynchronous test
 //   unittest-suite-success:  signals the end of an asynchrounous test
 //
 // These messages are used to communicate with the test and will be posted so
 // [processMessage] above can see it.
-function dartPrint(msg) {
-  if ((msg === 'unittest-suite-success')
-      || (msg === 'unittest-suite-done')
-      || (msg === 'unittest-suite-wait-for-done')
-      || (msg === 'dart-calling-main')
-      || (msg === 'dart-main-done')) {
-    window.postMessage(msg, '*');
+function dartPrint(message) {
+  recordMessage('print', message);
+  if ((message === 'unittest-suite-success')
+      || (message === 'unittest-suite-wait-for-done')
+      || (message === 'dart-calling-main')
+      || (message === 'dart-main-done')) {
+    window.postMessage(message, '*');
     return;
   }
-  printMessage(msg);
-}
-
-// Prints 'msg' to the console (if available) and to the body of the html
-// document.
-function printMessage(msg) {
-  if (typeof console === 'object') console.warn(msg);
-  var pre = document.createElement('pre');
-  pre.appendChild(document.createTextNode(String(msg)));
-  document.body.appendChild(pre);
-  document.body.appendChild(document.createTextNode('\n'));
 }
 
 // dart2js will generate code to call this function instead of calling
 // Dart [main] directly. The argument is a closure that invokes main.
 function dartMainRunner(main) {
   dartPrint('dart-calling-main');
   try {
     main();
   } catch (e) {
-    dartPrint(e);
-    if (e.stack) dartPrint(e.stack);
-    window.postMessage('unittest-suite-fail', '*');
+    showErrorAndExit('Exception: ' + e + '\nStack: ' + e.stack);
     return;
   }
   dartPrint('dart-main-done');
 }