Adding webdriver setup script.

tools/testing/dart/test_runner.dart

 // Copyright (c) 2012, 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.
 
 /**
  * Classes and methods for executing tests.
  *
  * This module includes:
  * - Managing parallel execution of tests, including timeout checks.
  * - Evaluating the output of each test as pass/fail/crash/timeout.
@@ skipping 314 matching lines @@
           && testCase.configuration['component'] == 'webdriver') {
         // Note: processQueue will always be non-null for component == webdriver
         // (It is only null for component == vm)
         processQueue._getBatchRunner(testCase).startTest(testCase);
       } else {
         runCommand(testCase.commands[currentStep++], stepExitHandler);
       }
     }
   }
 
-  Function makeReadHandler(StringInputStream source, List<String> destination) {
+  Function makeReadHandler(StringInputStream source, 
+      List<String> destination) {
     return () {
       if (source.closed) return;  // TODO(whesse): Remove when bug is fixed.
       var line = source.readLine();
       while (null != line) {
         destination.add(line);
         line = source.readLine();
       }
     };
   }
 
@@ skipping 223 matching lines @@
 
   // Cache information about test cases per test suite. For multiple
   // configurations there is no need to repeatedly search the file
   // system, generate tests, and search test files for options.
   Map<String, List<TestInformation>> _testCache;
   /**
    * String indicating the browser used to run the tests. Empty if no browser
    * used.
    */
   String browserUsed;
+  /** 
+   * Process running the selenium server .jar (only used for Safari and Opera
+   * tests.)
+   */
+  Process seleniumServer;
+  /** True if we are in the process of starting the server. */
+  bool startingServer;
 
   ProcessQueue(int this._maxProcesses,
                String progress,
                Date startTime,
                bool printTiming,
                Function this._enqueueMoreWork,
                [bool this._verbose = false,
                 bool this._listTests = false,
                 bool this._keepGeneratedTests = false])
       : _tests = new Queue<TestCase>(),
         _progress = new ProgressIndicator.fromName(progress,
                                                    startTime,
                                                    printTiming),
         _batchProcesses = new Map<String, List<BatchRunnerProcess>>(),
         _testCache = new Map<String, List<TestInformation>>() {
     if (!_enqueueMoreWork(this)) _progress.allDone();
     browserUsed = '';
+    seleniumServer = null;
+    startingServer = false;

[Siggi Cherem (dart-lang), 2012/02/29 02:12:08]

you should be able to initialize both inline in the declaration above.

[Emily Fortuna, 2012/03/01 23:55:13]

Done.

   }
 
   /**
    * Registers a TestSuite so that all of its tests will be run.
    */
   void addTestSuite(TestSuite testSuite) {
     _activeTestListers++;
     testSuite.forEachTest(_runTest, _testCache, globalTemporaryDirectory,
                           _testListerDone);
   }
@@ skipping 55 matching lines @@
     }
   }
 
   /**
    * Perform any cleanup needed once all tests in a TestSuite have completed
    * and notify our progress indicator that we are done.
    */
   void _cleanupAndMarkDone() {
     if (browserUsed != '') {
       killZombieBrowsers();
+      if (seleniumServer != null) {
+        seleniumServer.kill();
+      }
     } else {
       _progress.allDone();
     }
   }
 
   void _checkDone() {
     // When there are no more active test listers ask for more work
     // from process queue users.
     if (_activeTestListers == 0 && !_enqueueMoreWork(this)) {
       _progress.allTestsKnown();
@@ skipping 22 matching lines @@
             _cleanupAndMarkDone();
           };
         }
       }
     }
   }
 
   void _runTest(TestCase test) {
     if (test.configuration['component'] == 'webdriver') {
       browserUsed = test.configuration['browser'];
+      if (new Platform().operatingSystem() == 'macos' && browserUsed == 'safari'
+          && seleniumServer == null && startingServer == false) {

[Siggi Cherem (dart-lang), 2012/02/29 02:12:08]

style nit: I'd move these last two conditions into the method and call it
'_ensureSeleniumServer'. For instance:
if (platform... && safari) _ensureSeleniumServer();

void _ensureSeleniumServer() {
 if (seleniumServer != null || startingServer) return;
 startingServer = true;
 ...
}

[Jennifer Messerly, 2012/02/29 08:51:21]

+1

[Emily Fortuna, 2012/03/01 23:55:13]

Done.

+        startingServer = true;
+        _startSeleniumServer();
+      }
     }
     _progress.testAdded();
     _tests.add(test);
     _tryRunTest();
   }
 
+  /** 
+   * For browser tests using Safari or Opera, we need to use the Selenium 1.0
+   * Java server.
+   */
+  void _startSeleniumServer() {
+    // Get the absolute path to the Selenium jar.
+    String filePath = new Options().script;
+    String pathSep = new Platform().pathSeparator();
+    int index = filePath.lastIndexOf(pathSep);
+    filePath = filePath.substring(0, index) + '${pathSep}testing${pathSep}';
+    String command = 'ls';
+    List<String> args = [filePath];
+    // Right now the Selenium server is only used on the mac, but it will be
+    // used on Windows when we are testing Opera.
+    if (new Platform().operatingSystem() == 'windows') {
+      command = 'dir';
+      args.add('/B');
+    }
+    Process process = new Process.start(command, args);
+    StringInputStream stdoutStringStream = 
+        new StringInputStream(process.stdout);
+    stdoutStringStream.lineHandler = () {
+      String seleniumJar = stdoutStringStream.readLine();
+      // Loop through the files in the directory to find the jar. We can't do
+      // this a more elegant way right now because
+      // 'ls selenium-standalone-server*' doesn't work without a shell.
+      // TODO(efortuna): Clean this up when the IO API provides more.

[Siggi Cherem (dart-lang), 2012/02/29 02:12:08]

instead of reading the output of dir/ls to find the name of the jar, can we use
[Directory] for this?

For instance:
Directory dir = new Directory(filePath);
dir.fileHandler = (String filename) {
  if (const RegExp(@"selenium-server-.*\.jar").hasMatch(filename)) {
    var seleniumProcess = new Process.start(....);
    ...   
  }
}

+      while (seleniumJar != null) {
+        if (seleniumJar.startsWith('selenium-server-standalone-') &&
+            seleniumJar.endsWith('.jar')) {
+          var seleniumProcess = new Process.start('java', ['-jar',

[Siggi Cherem (dart-lang), 2012/02/29 02:12:08]

does this process print anything when it's ready?

If so, instead of doing
new Timer(..., 8000);

which feels it could be flaky, we could attach a handler for the output of this
process.

You could either use seleniumProcess.stdout.dataHandler, or if there is a
special line in the output that says when the server is ready, you could use a
line-reader like you did for the directory listing. Then you'd call _tryRunTest
when you match the line that indicates that the server is ready.

+              '${filePath}${seleniumJar}']);
+          // The Selenium server takes a little while to start and be ready to
+          // receive connections, so we wait before running our tests (~8 sec).
+          new Timer((Timer t) {
+            seleniumServer = seleniumProcess;
+            for (int i = 0; i < _maxProcesses; i++) {
+              // Attempt to run all the processes that have been waiting for
+              // the server to start up. If we just call this once we end up
+              // with a single-threaded run.
+              _tryRunTest();
+            }
+          }, 8000);
+          return;
+        }
+        seleniumJar = stderrStringStream.readLine();

[Siggi Cherem (dart-lang), 2012/02/29 02:12:08]

should this be stdoutStringStream? (of course this would go away if we can
replace it with Directory)

+      }
+    };
+  }
+
   void _terminateBatchRunners() {
     for (var runners in _batchProcesses.getValues()) {
       for (var runner in runners) {
         runner.terminate();
       }
     }
   }
 
   BatchRunnerProcess _getBatchRunner(TestCase test) {
     // Start batch processes if needed
@@ skipping 10 matching lines @@
     for (var runner in runners) {
       if (!runner.active) return runner;
     }
     throw new Exception('Unable to find inactive batch runner.');
   }
 
   void _tryRunTest() {
     _checkDone();
     if (_numProcesses < _maxProcesses && !_tests.isEmpty()) {
       TestCase test = _tests.removeFirst();
+      if (test.configuration['component'] == 'webdriver' 
+          && seleniumServer == null) {

[Siggi Cherem (dart-lang), 2012/02/29 02:12:08]

should this also check for safari & mac? maybe introduce a small function
[_isSeleniumIsAvailable]

[Jennifer Messerly, 2012/02/29 08:51:21]

also: we have a decent number of "test.configuration['component'] ==
'webdriver'" checks. Perhaps test.useWebDriver? I've thought about adding
something that in a change I'm working on. What do y'all think?

[Emily Fortuna, 2012/03/01 23:55:13]

Done.

[Emily Fortuna, 2012/03/01 23:55:13]

Done.

+        _tests.addFirst(test);
+        return;
+      }
       if (_verbose) print(test.commands.last().commandLine);
       if (_listTests) {
         final String tab = '\t';
         String outcomes =
             Strings.join(new List.from(test.expectedOutcomes), ',');
         print(test.displayName + tab + outcomes + tab + test.isNegative +
               tab + Strings.join(test.commands.last().arguments, tab));
         return;
       }
       _progress.start(test);
@@ skipping 16 matching lines @@
         // the developer doesn't waste his or her time trying to fix a bunch of
         // tests that appear to be broken but were actually just flakes that
         // didn't get retried because there had already been one failure.
         bool allowRetry = _MAX_FAILED_NO_RETRY > _progress.numFailedTests;
         new RunningProcess(test, allowRetry, this).start();
       }
       _numProcesses++;
     }
   }
 }