Add safari browser controller.

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 30 matching lines @@
    * Id of the browser
    */
   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 = true;
 
+  // We use this to gracefully handle double calls to close.
+  bool underTermination = false;
+
   void _logEvent(String event) {
     String toLog = "$this ($id) - ${new DateTime.now()}: $event \n";
     if (debugPrint) print("usageLog: $toLog");
     _usageLog.write(toLog);
   }
 
   void _addStdout(String output) {
     if (debugPrint) print("stdout: $output");
     _stdout.write(output);
   }
@@ skipping 51 matching lines @@
       _logEvent("The process is already dead, kill signal could not be send");
       completer.complete(true);
     }
     return completer.future;
   }
 
 
   /** Close the browser */
   Future<bool> close() {
     _logEvent("Close called on browser");
+    if (underTermination) {
+      _logEvent("Browser already under termination.");
+      return new Future.immediate(true);
+    }
+    underTermination = true;
     if (process == null) {
       _logEvent("No process open, nothing to kill.");
       return new Future.immediate(true);
     }
     var killFunction = process.kill;
     // We use a SIGKILL signal if we don't kill the process in the first go.
     var alternativeKillFunction =
         () { return process.kill(ProcessSignal.SIGKILL);};
     return _killIt(killFunction, killRetries, alternativeKillFunction);
   }
@@ skipping 39 matching lines @@
    */
   String get stdout => _stdout.toString();
   String get stderr => _stderr.toString();
   String get usageLog => _usageLog.toString();
 
   String toString();
   /** Starts the browser loading the given url */
   Future<bool> start(String url);
 }
 
+class Safari extends Browser {
+  /**
+   * The binary used to run safari - changing this can be nececcary for
+   * testing or using non standard safari installation.
+   */
+  const String binary = "/Applications/Safari.app/Contents/MacOS/Safari";
+
+  /**
+   * We get the safari version by parsing a version file
+   */
+  const String versionFile = "/Applications/Safari.app/Contents/version.plist";
+
+  Future<String> getVersion() {
+    File f = new File(versionFile);
+    return f.readAsLines().then((content) {
+      bool versionOnNextLine = false;

[kustermann, 2013/05/28 07:42:39]

Small comment about how the file looks like would be nice.

[ricow1, 2013/05/28 08:07:30]

Done.

+      for (var line in content) {
+        if (versionOnNextLine) return line;
+        if (line.contains("CFBundleShortVersionString")) {
+          versionOnNextLine = true;
+        }
+      }
+      return null;
+    });
+  }
+
+  void _createLaunchHTML(var path, var url) {
+    var file = new File("${path.toString()}/launch.html");

[kustermann, 2013/05/28 07:42:39]

No reason to call 'toString()' explicitly (otherwise use 'toNativePath()' if
it's a Path).

[ricow1, 2013/05/28 08:07:30]

Done.

+    var randomFile = file.openSync(FileMode.WRITE);
+    var content = '<script language="JavaScript">location = "$url"</script>';
+    randomFile.writeStringSync(content);
+    randomFile.close();
+  }
+
+  Future<bool> start(String url) {
+    _logEvent("Starting Safari browser on: $url");
+    // Get the version and log that.
+    return getVersion().then((version) {
+      _logEvent("Got version: $version");
+      var args = ["'$url'"];
+      return new Directory('').createTemp().then((userDir) {
+        _cleanup = () { userDir.delete(recursive: true); };
+        _createLaunchHTML(userDir.path, url);
+        var args = ["${userDir.path}/launch.html"];
+        return startBrowser(binary, args);
+      });
+    }).catchError((e) {
+      _logEvent("Running $binary --version failed with $e");
+      return false;
+    });
+  }
+
+  String toString() => "Safari";
+}
+
+
 class Chrome extends Browser {
   /**
    * The binary used to run chrome - changing this can be nececcary for
    * testing or using non standard chrome installation.
    */
   const String binary = "google-chrome";
 
   Future<bool> start(String url) {
     _logEvent("Starting chrome browser on: $url");
     // Get the version and log that.
@@ skipping 320 matching lines @@
     // We could be smarter here, but it does not seems like it is worth it.
     status.timeout = true;
     timedOut.add(status.currentTest.url);
     var id = status.browser.id;
     status.browser.close().then((closed) {
       if (!closed) {
         // Very bad, we could not kill the browser.
         print("could not kill browser $id");
         return;
       }
+      // We don't want to start a new browser if we are terminating.
+      if (underTermination) return;

[kustermann, 2013/05/28 07:42:39]

We could also assert/throw here, since we never reuse Browser objects (i.e. if
we want to call 'start(url)' we first call 'getInstance()', right?

[ricow1, 2013/05/28 08:07:30]

Here is what can happen:
All tests but one are done, the test times out and we get in here. Now since
everything is done we will shutdown all the other browsers and close the http
server. Right below we start a new browser and points it to the driver page,
while sending back response to that we may close the http server in the
termination step (because this is async)

+
       var browser;
       if (browserName == 'chromeOnAndroid') {
         browser = new AndroidChrome(adbDeviceMapping[id]);
       } else {
         browser = getInstance();
       }
       browser.start(testingServer.getDriverUrl(id)).then((success) {
         // We may have started terminating in the mean time.
         if (underTermination) {
           browser.close().then((success) {
@@ skipping 73 matching lines @@
       printDoubleReportingTests();
       return !values.contains(false);
     });
   }
 
   Browser getInstance() {
     if (browserName == "chrome") {
       return new Chrome();
     } else if (browserName == "ff") {
       return new Firefox();
+    } else if (browserName == "safari") {
+      return new Safari();
     } else {
       throw "Non supported browser for browser controller";
     }
   }
 }
 
 class BrowserTestingServer {
   /// Interface of the testing server:
   ///
   /// GET /driver/BROWSER_ID -- This will get the driver page to fetch
@@ skipping 42 matching lines @@
           textResponse = getDriverPage(browserId);
         } else if (request.uri.path.startsWith(nextTestPath)) {
           var browserId = request.uri.path.substring(nextTestPath.length + 1);
           textResponse = getNextTest(browserId);
         } else {
           // We silently ignore other requests.
         }
         request.response.write(textResponse);
         request.listen((_) {}, onDone: request.response.close);
         request.response.done.catchError((error) {
-        if (!underTermination) {
-          print("URI ${request.uri}");
-          print("Textresponse $textResponse");
-          throw("Error returning content to browser: $error");
-        }
+          if (!underTermination) {
+            print("URI ${request.uri}");
+            print("Textresponse $textResponse");
+            throw("Error returning content to browser: $error");

[kustermann, 2013/05/28 07:42:39]

don't use 'throw()' but rather 'throw ""'

[ricow1, 2013/05/28 08:07:30]

Done.

+          }
       });
       }
       void errorHandler(e) {
         if (!underTermination) print("Error occured in httpserver: $e");
       };
       httpServer.listen(handler, onError: errorHandler);
       return true;
     });
   }
 
@@ skipping 130 matching lines @@
   </script>
 </head>
   <body>
     Dart test driver, number of tests: <div id="number"></div>
   </body>
 </html>
 """;
     return driverContent;
   }
 }