Support for running tests in an iframe

tools/testing/dart/browser_controller.dart

 // Copyright (c) 2013, 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.
 library browser;
 
 import "dart:async";
 import "dart:core";
 import "dart:io";
 
 import 'android.dart';
@@ skipping 34 matching lines @@
   String id;
 
   /** Callback that will be executed when the browser has closed */
   Function onClose;
 
   /** Print everything (stdout, stderr, usageLog) whenever we add to it */
   bool debugPrint = false;
 
   // We use this to gracefully handle double calls to close.
   bool underTermination = false;
-  
+
   Browser();
 
   factory Browser.byName(String name) {
     if (name == 'ff' || name == 'firefox') {
       return new Firefox();
     } else if (name == 'chrome') {
       return new Chrome();
     } else if (name == 'safari') {
       return new Safari();
     } else {
       throw "Non supported browser";
     }
   }
 
-  static const List<String> SUPPORTED_BROWSERS = 
+  static const List<String> SUPPORTED_BROWSERS =
+      const ['safari', 'ff', 'firefox', 'chrome'];
+
+  static const List<String> BROWSERS_WITH_WINDOW_SUPPORT =
       const ['safari', 'ff', 'firefox', 'chrome'];
 
   // TODO(kustermann): add standard support for chrome on android
   static bool supportedBrowser(String name) {
     return SUPPORTED_BROWSERS.contains(name);
   }
 
   void _logEvent(String event) {
     String toLog = "$this ($id) - ${new DateTime.now()}: $event \n";
     if (debugPrint) print("usageLog: $toLog");
@@ skipping 444 matching lines @@
   // If we do we need to provide developers with this information.
   // We don't add urls to the cache until we have run it.
   Map<int, String> testCache = new Map<int, String>();
   List<int> doubleReportingTests = new List<int>();
 
   BrowserTestingServer testingServer;
 
   BrowserTestRunner(this.local_ip, this.browserName, this.maxNumBrowsers);
 
   Future<bool> start() {
-    testingServer = new BrowserTestingServer(local_ip);
+    // If [browserName] doesn't support opening new windows, we use new iframes
+    // instead.
+    bool useIframe = !Browser.BROWSERS_WITH_WINDOW_SUPPORT.contains(browserName);

[ricow1, 2013/05/30 11:50:20]

long line

[kustermann, 2013/05/30 11:53:12]

Done.

+    testingServer = new BrowserTestingServer(local_ip, useIframe);
     return testingServer.start().then((_) {
       testingServer.testDoneCallBack = handleResults;
       testingServer.nextTestCallBack = getNextTest;
       return getBrowsers().then((browsers) {
         var futures = [];
         for (var browser in browsers) {
           var url = testingServer.getDriverUrl(browser.id);
           var future = browser.start(url).then((success) {
             if (success) {
               browserStatus[browser.id] = new BrowserTestingStatus(browser);
@@ skipping 208 matching lines @@
 
   const String driverPath = "/driver";
   const String nextTestPath = "/next_test";
   const String reportPath = "/report";
   const String waitSignal = "WAIT";
   const String terminateSignal = "TERMINATE";
 
   var testCount = 0;
   var httpServer;
   bool underTermination = false;
+  bool useIframe = false;
 
   Function testDoneCallBack;
   Function nextTestCallBack;
 
-  BrowserTestingServer(this.local_ip);
+  BrowserTestingServer(this.local_ip, this.useIframe);
 
   Future start() {
     return HttpServer.bind(local_ip, 0).then((createdServer) {
       httpServer = createdServer;
       void handler(HttpRequest request) {
         if (request.uri.path.startsWith(reportPath)) {
           var browserId = request.uri.path.substring(reportPath.length + 1);
           var testId = int.parse(request.queryParameters["id"].split("=")[1]);
 
           handleReport(request, browserId, testId);
@@ skipping 64 matching lines @@
     return "http://$local_ip:${httpServer.port}/driver/$browserId";
   }
 
 
   String getDriverPage(String browserId) {
     String driverContent = """
 <!DOCTYPE html><html>
 <head>
   <title>Driving page</title>
   <script type='text/javascript'>
-    var number_of_tests = 0;
-    var current_id;
-    var last_reported_id;
-    var testing_window;
-    // We use this to determine if we did actually get back a start event
-    // from the test we just loaded.
-    var did_start = false;
 
-    function newTaskHandler() {
-      if (this.readyState == this.DONE) {
-        if (this.status == 200) {
-          if (this.responseText == '$waitSignal') {
-            setTimeout(getNextTask, 500);
-          } else if (this.responseText == '$terminateSignal') {
-            // Don't do anything, we will be killed shortly.
+    function startTesting() {
+      var number_of_tests = 0;
+      var current_id;
+      var last_reported_id;
+      var testing_window;
+      // We use this to determine if we did actually get back a start event
+      // from the test we just loaded.
+      var did_start = false;
+
+      var embedded_iframe = document.getElementById('embedded_iframe');
+      var use_iframe = ${useIframe};
+
+      function newTaskHandler() {
+        if (this.readyState == this.DONE) {
+          if (this.status == 200) {
+            if (this.responseText == '$waitSignal') {
+              setTimeout(getNextTask, 500);
+            } else if (this.responseText == '$terminateSignal') {
+              // Don't do anything, we will be killed shortly.
+            } else {
+              // TODO(ricow): Do something more clever here.
+              if (nextTask != undefined) alert('This is really bad');
+              // The task is send to us as:
+              // URL#ID
+              var split = this.responseText.split('#');
+              var nextTask = split[0];
+              current_id = split[1];
+              did_start = false;
+              run(nextTask);
+            }
           } else {
-            // TODO(ricow): Do something more clever here.
-            if (nextTask != undefined) alert('This is really bad');
-            // The task is send to us as:
-            // URL#ID
-            var split = this.responseText.split('#');
-            var nextTask = split[0];
-            current_id = split[1];
-            did_start = false;
-            run(nextTask);
-          }
-        } else {
-          // We are basically in trouble - do something clever.
-        }
-      }
-    }
-
-    function getNextTask() {
-      var client = new XMLHttpRequest();
-      client.onreadystatechange = newTaskHandler;
-      client.open('GET', '$nextTestPath/$browserId');
-      client.send();
-    }
-
-    function run(url) {
-      number_of_tests++;
-      document.getElementById('number').innerHTML = number_of_tests;
-      if (testing_window == undefined) {
-        testing_window = window.open(url);
-      } else {
-        testing_window.location = url;
-      }
-    }
-
-    function reportMessage(msg) {
-      if (msg == 'STARTING') {
-        did_start = true;
-        return;
-      }
-      var client = new XMLHttpRequest();
-      function handleReady() {
-        if (this.readyState == this.DONE) {
-          if (last_reported_id != current_id && did_start) {
-            getNextTask();
-            last_reported_id = current_id;
+            // We are basically in trouble - do something clever.
           }
         }
       }
-      client.onreadystatechange = handleReady;
-      // If did_start is false it means that we did actually set the url on
-      // the testing_window, but this is a report left in the event loop or
-      // a callback because the page did not load yet.
-      // In both cases this is a double report from the last test.
-      var posting_id = did_start ? current_id : last_reported_id;
-      client.open('POST', '$reportPath/${browserId}?id=' + posting_id);
-      client.setRequestHeader('Content-type',
-                              'application/x-www-form-urlencoded');
-      client.send(msg);
-      // TODO(ricow) add error handling to somehow report the fact that
-      // we could not send back a result.
+
+      function getNextTask() {
+        var client = new XMLHttpRequest();
+        client.onreadystatechange = newTaskHandler;
+        client.open('GET', '$nextTestPath/$browserId');
+        client.send();
+      }
+
+      function run(url) {
+        number_of_tests++;
+        document.getElementById('number').innerHTML = number_of_tests;
+        if (use_iframe) {
+          embedded_iframe.src = url;
+        } else {
+          if (testing_window == undefined) {
+            testing_window = window.open(url);
+          } else {
+            testing_window.location = url;
+          }
+        }
+      }
+
+      function reportMessage(msg) {
+        if (msg == 'STARTING') {
+          did_start = true;
+          return;
+        }
+        var client = new XMLHttpRequest();
+        function handleReady() {
+          if (this.readyState == this.DONE) {
+            if (last_reported_id != current_id && did_start) {
+              getNextTask();
+              last_reported_id = current_id;
+            }
+          }
+        }
+        client.onreadystatechange = handleReady;
+        // If did_start is false it means that we did actually set the url on
+        // the testing_window, but this is a report left in the event loop or
+        // a callback because the page did not load yet.
+        // In both cases this is a double report from the last test.
+        var posting_id = did_start ? current_id : last_reported_id;
+        client.open('POST', '$reportPath/${browserId}?id=' + posting_id);
+        client.setRequestHeader('Content-type',
+                                'application/x-www-form-urlencoded');
+        client.send(msg);
+        // TODO(ricow) add error handling to somehow report the fact that
+        // we could not send back a result.
+      }
+
+      function messageHandler(e) {
+        var msg = e.data;
+        if (typeof msg != 'string') return;
+        reportMessage(msg);
+      }
+
+      window.addEventListener('message', messageHandler, false);
+      waitForDone = false;
+
+      getNextTask();
     }
 
-    function messageHandler(e) {
-      var msg = e.data;
-      if (typeof msg != 'string') return;
-      reportMessage(msg);
-    }
-
-    window.addEventListener('message', messageHandler, false);
-    waitForDone = false;
-
-    getNextTask();
-
   </script>
 </head>
-  <body>
+  <body onload="startTesting()">
     Dart test driver, number of tests: <div id="number"></div>
+    <iframe id="embedded_iframe"></iframe>
   </body>
 </html>
 """;
     return driverContent;
   }
 }