Force close of browser Windows when complete.

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 100 matching lines @@
 class BrowserTestCase extends TestCase {
   /**
    * The executable that is run in a new process in the compilation phase.
    */
   String compilerPath;
   /**
    * The arguments for the compilation command.
    */
   List<String> compilerArguments;
   /**
-   * Indicates if this test is a rerun, to compensate for flaky browser tests.
+   * Indicates the number of potential retries remaining, to compensate for
+   * flaky browser tests.
    */
-  bool isRerun;
+  bool numRetries;
 
   BrowserTestCase(displayName,
                     this.compilerPath,
                     this.compilerArguments,
                     executablePath,
                     arguments,
                     configuration,
                     completedHandler,
                     expectedOutcomes,
                     [isNegative = false]) : super(displayName,
                                                   executablePath,
                                                   arguments,
                                                   configuration,
                                                   completedHandler,
                                                   expectedOutcomes,
                                                   isNegative) {
     if (compilerPath != null) {
       commandLine = 'execution command: $commandLine';
       String compilationCommand =
           '$compilerPath ${Strings.join(compilerArguments, " ")}';
       commandLine = 'compilation command: $compilationCommand\n$commandLine';
     }
-    isRerun = false;
+    numRetries = 2; // Allow two retries to compensate for flaky browser tests.
   }
 }
 
 
 /**
  * TestOutput records the output of a completed test: the process's exit code,
  * the standard output and standard error, whether the process timed out, and
  * the time the process took to run.  It also contains a pointer to the
  * [TestCase] this is the output of.
  */
@@ skipping 95 matching lines @@
     new TestOutput(testCase, exitCode, timedOut, stdout,
                    stderr, new Date.now().difference(startTime));
     process.close();
     timeoutTimer.cancel();
     if (testCase.output.unexpectedOutput && testCase.configuration['verbose']) {
       print(testCase.displayName);
       for (var line in testCase.output.stderr) print(line);
       for (var line in testCase.output.stdout) print(line);
     }
     if (testCase is BrowserTestCase && testCase.output.unexpectedOutput &&
-        !testCase.isRerun) {
+        testCase.numRetries > 0) {
       // Selenium tests can be flaky. Try rerunning.
       testCase.output.requestRetry = true;
     }
     if (testCase.output.requestRetry) {
       testCase.output.requestRetry = false;
       this.timedOut = false;
-      testCase.isRerun = true;
+      testCase.dynamic.numRetries--;
       print("Potential flake. Re-running " + testCase.displayName);
       this.start();
     } else {
       testCase.completed();
     }
   }
 
   void compilerExitHandler(int exitCode) {
     if (exitCode != 0) {
       stderr.add('test.dart: Compilation step failed (exit code $exitCode)\n');
@@ skipping 223 matching lines @@
   Function _enqueueMoreWork;
   Queue<TestCase> _tests;
   ProgressIndicator _progress;
   String _temporaryDirectory;
   // For dartc batch processing we keep a list of batch processes.
   List<DartcBatchRunnerProcess> _batchProcesses;
   // 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;
 
   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 List<DartcBatchRunnerProcess>(),
         _testCache = new Map<String, List<TestInformation>>() {
     if (!_enqueueMoreWork(this)) _progress.allDone();
+    browserUsed = '';
   }
 
   /**
    * Registers a TestSuite so that all of its tests will be run.
    */
   void addTestSuite(TestSuite testSuite) {
     _activeTestListers++;
     testSuite.forEachTest(_runTest, _testCache, globalTemporaryDirectory,
                           _testListerDone);
   }
 
   void _testListerDone() {
     _activeTestListers--;
     _checkDone();
   }
 
   String globalTemporaryDirectory() {
     if (_temporaryDirectory != null) return _temporaryDirectory;
 
     if (new Platform().operatingSystem() == 'windows') {
       throw new Exception(
           'Test suite requires temporary directory. Not supported on Windows.');
     }
     var tempDir = new Directory('');
     tempDir.createTempSync();
     _temporaryDirectory = tempDir.path;
     return _temporaryDirectory;
   }
 
+  /**
+   * Sometimes Webdriver doesn't close every browser window when it's done 
+   * with a test. At the end of all tests we clear out any neglected processes
+   * that are still running. 
+   */
+  void killZombieBrowsers() {
+    String chromeName = 'chrome';
+    if (new Platform().operatingSystem() == 'macos') {
+      chromeName = 'Google\ Chrome';
+    }
+    Map<String, List<String>> processNames = {'ie': ['iexplore'], 'safari': 
+        ['Safari'], 'ff': ['firefox'], 'chrome': ['chromedriver', chromeName]};
+    for (String name in processNames[browserUsed]) {
+      Process process = null;
+      if (new Platform().operatingSystem() == 'windows') {
+        process = new Process.start(
+            'C:\\Windows\\System32\\taskkill.exe', ['/F', '/IM', name + '.exe',
+            '/T']);
+      } else {
+        process = new Process.start('killall', ['-9', name]);
+      }
+
+      if (name == processNames[browserUsed].last()) {
+        process.exitHandler = (exitCode) {
+          process.close();
+          _progress.allDone();
+        };
+        process.errorHandler = (error) {
+          _progress.allDone();
+        };
+      } else {
+        process.exitHandler = (exitCode) {
+          process.close();
+        };
+      }
+    }
+  }
+
+  /**
+   * 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();
+    } 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();
       if (_tests.isEmpty() && _numProcesses == 0) {
         _terminateDartcBatchRunners();
         if (_keepGeneratedTests || _temporaryDirectory == null) {
-          _progress.allDone();
+          _cleanupAndMarkDone();
         } else if (!_temporaryDirectory.startsWith('/tmp/') ||
                    _temporaryDirectory.contains('/../')) {
           // Let's be extra careful, since rm -rf is so dangerous.
           print('Temporary directory $_temporaryDirectory unsafe to delete!');
-          _progress.allDone();
+          _cleanupAndMarkDone();
         } else {
           // TODO(dart:1211): Use delete(recursive=true) in Dart when it is
           // implemented, and add Windows support.
           var deletion =
               new Process.start('/bin/rm', ['-rf', _temporaryDirectory]);
           deletion.exitHandler = (int exitCode) {
             if (exitCode == 0) {
               if (!_listTests) {  // Output of --list option is used by scripts.
                 print('\nTemporary directory $_temporaryDirectory deleted.');
               }
             } else {
               print('\nDeletion of temp dir $_temporaryDirectory failed.');
             }
-            _progress.allDone();
+            _cleanupAndMarkDone();
           };
         }
       }
     }
   }
 
   void _runTest(TestCase test) {
+    if (test.configuration['component'] == 'webdriver') {
+      browserUsed = test.configuration['browser'];
+    }
     _progress.testAdded();
     _tests.add(test);
     _tryRunTest();
   }
 
   void _terminateDartcBatchRunners() {
     _batchProcesses.forEach((runner) => runner.terminate());
   }
 
   void _ensureDartcBatchRunnersStarted(String executable) {
@@ skipping 38 matching lines @@
           test.displayName != 'dartc/junit_tests') {
         _ensureDartcBatchRunnersStarted(test.executablePath);
         _getDartcBatchRunnerProcess().startTest(test);
       } else {
         new RunningProcess(test).start();
       }
       _numProcesses++;
     }
   }
 }