Record/replay support to test.py

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.
  */
 library test_runner;
 
 import "dart:async";
 import "dart:collection" show Queue;
 // We need to use the 'io' prefix here, otherwise io.exitCode will shadow
 // CommandOutput.exitCode in subclasses of CommandOutput.
 import "dart:io" as io;
 import "dart:isolate";
 import "dart:uri";
 import "browser_controller.dart";
 import "http_server.dart" as http_server;
 import "status_file_parser.dart";
 import "test_progress.dart";
 import "test_suite.dart";
 import "utils.dart";
+import 'record_and_replay.dart';
 
 const int NO_TIMEOUT = 0;
 const int SLOW_TIMEOUT_MULTIPLIER = 4;
 
 const int CRASHING_BROWSER_EXITCODE = -10;
 
 typedef void TestCaseEvent(TestCase testCase);
 typedef void ExitCodeEvent(int exitCode);
 typedef void EnqueueMoreWork(ProcessQueue queue);
 
@@ skipping 1293 matching lines @@
  * upon to enqueue its tests again.
  */
 class ProcessQueue {
   int _numProcesses = 0;
   int _maxProcesses;
   int _numBrowserProcesses = 0;
   int _maxBrowserProcesses;
   int _numFailedTests = 0;
   bool _allTestsWereEnqueued = false;
 
+  // Support for recording and replaying test commands.
+  TestCaseRecorder _testCaseRecorder;
+  TestCaseOutputArchive _testCaseOutputArchive;
+
   /** The number of tests we allow to actually fail before we stop retrying. */
   int _MAX_FAILED_NO_RETRY = 4;
   bool _verbose;
   bool _listTests;
   Function _allDone;
   Queue<TestCase> _tests;
   List<EventListener> _eventListener;
 
   // For dartc/selenium batch processing we keep a list of batch processes.
   Map<String, List<BatchRunnerProcess>> _batchProcesses;
@@ skipping 23 matching lines @@
   /** True if we find that there is already a selenium jar running. */
   bool _seleniumAlreadyRunning = false;
 
   ProcessQueue(this._maxProcesses,
                this._maxBrowserProcesses,
                DateTime startTime,
                testSuites,
                this._eventListener,
                this._allDone,
                [bool verbose = false,
-                bool listTests = false])
+                bool listTests = false,
+                this._testCaseRecorder,
+                this._testCaseOutputArchive])
       : _verbose = verbose,
         _listTests = listTests,
         _tests = new Queue<TestCase>(),
         _batchProcesses = new Map<String, List<BatchRunnerProcess>>(),
         _testCache = new Map<String, List<TestInformation>>(),
         _browserTestRunners = new Map<String, BrowserTestRunner>() {
     _runTests(testSuites);
   }
 
   /**
@@ skipping 10 matching lines @@
 
   void _checkDone() {
     if (_allTestsWereEnqueued && _tests.isEmpty && _numProcesses == 0) {
       _terminateBatchRunners().then((_) {
         _terminateBrowserRunners().then((_) => _cleanupAndMarkDone());
       });
     }
   }
 
   void _runTests(List<TestSuite> testSuites) {
+    var newTest;
+    var allTestsKnown;
+
+    if (_testCaseRecorder != null) {
+      // Mode: recording.
+      newTest = _testCaseRecorder.nextTestCase;
+      allTestsKnown = () {
+        // We don't call any event*() methods, so test_progress.dart will not be
+        // notified (that's fine, since we're not running any tests).
+        _testCaseRecorder.finish();
+        _allDone();
+      };
+    } else {
+      if (_testCaseOutputArchive != null) {
+        // Mode: replaying.
+        newTest = (TestCase testCase) {
+          // We're doing this asynchronously to emulate the normal behaviour.
+          eventTestAdded(testCase);
+          Timer.run(() {
+            var output = _testCaseOutputArchive.outputOf(testCase);
+            testCase.completed();
+            eventFinishedTestCase(testCase);
+          });
+        };
+        allTestsKnown = () {
+          // If we're replaying commands, we need to call [_cleanupAndMarkDone]
+          // manually. We're putting it at the end of the event queue to make
+          // sure all the previous events were fired.
+          Timer.run(() => _cleanupAndMarkDone());
+        };
+      } else {
+        // Mode: none (we're not recording/replaying).
+        newTest = (TestCase testCase) {
+          _tests.add(testCase);
+          eventTestAdded(testCase);
+          _runTest(testCase);
+        };
+        allTestsKnown = _checkDone;
+      }
+    }
+
     // FIXME: For some reason we cannot call this method on all test suites
     // in parallel.
     // If we do, not all tests get enqueued (if --arch=all was specified,
     // we don't get twice the number of tests [tested on -rvm -cnone])
     // Issue: 7927
     Iterator<TestSuite> iterator = testSuites.iterator;
     void enqueueNextSuite() {
       if (!iterator.moveNext()) {
         _allTestsWereEnqueued = true;
+        allTestsKnown();
         eventAllTestsKnown();
-        _checkDone();
       } else {
-        iterator.current.forEachTest(_runTest, _testCache, enqueueNextSuite);
+        iterator.current.forEachTest(newTest, _testCache, enqueueNextSuite);
       }
     }
     enqueueNextSuite();
   }
 
   /**
    * True if we are using a browser + platform combination that needs the
    * Selenium server jar.
    */
   bool get _needsSelenium => (io.Platform.operatingSystem == 'macos' &&
@@ skipping 51 matching lines @@
         return true;
       });
     }
   }
 
   void _runTest(TestCase test) {
     if (test.usesWebDriver) {
       browserUsed = test.configuration['runtime'];
       if (_needsSelenium) _ensureSeleniumServerRunning();
     }
-    eventTestAdded(test);
-    _tests.add(test);
     _tryRunTest();
   }
 
   /**
    * Monitor the output of the Selenium server, to know when we are ready to
    * begin running tests.
    * source: Output(Stream) from the Java server.
    */
   void seleniumServerHandler(String line) {
     if (new RegExp(r".*Started.*Server.*").hasMatch(line) ||
@@ skipping 349 matching lines @@
     }
   }
 
   void eventAllTestsDone() {
     for (var listener in _eventListener) {
       listener.allDone();
     }
   }
 }