Support a @timeout annotation.

Closes #9

[email protected]

Review URL: https://codereview.chromium.org//1086213002

Author: nex3

CHANGELOG.md

@@ -1,5 +1,12 @@
 ### 0.12.0-beta.8
 
+* Add support for configuring timeouts on a test, group, and suite basis. Test
+  and group timeouts are configured with the `timeout` named argument; suites
+  are configured using the `@Timeout` annotation. See [the README][timeout] for
+  more information.
+
+[timeout]: https://github.com/dart-lang/test/blob/master/README.md#timeouts
+
 * Add a `--version` flag.
 
 ### 0.12.0-beta.7

README.md

@@ -278,6 +278,49 @@ void main() {
 
 [expectAsync]: http://www.dartdocs.org/documentation/test/latest/index.html#test/test@id_expectAsync
 
+## Configuring Tests
+
+### Timeouts
+
+By default, tests will time out after 30 seconds of inactivity. However, this
+can be configured on a per-test, -group, or -suite basis. To change the timeout
+for a test suite, put a `@Timeout` annotation at the top of the file:
+
+```dart
+@Timeout(new Duration(seconds: 45))
+
+import "package:test/test.dart";
+
+void main() {
+  // ...
+}
+```
+
+In addition to setting an absolute timeout, you can set the timeout relative to
+the default using `@Timeout.factor`. For example, `@Timeout.factor(1.5)` will
+set the timeout to one and a half times as long as the default—45 seconds.
+
+Timeouts can be set for tests and groups using the `timeout` parameter. This
+parameter takes a `Timeout` object just like the annotation. For example:
+
+```dart
+import "package:test/test.dart";
+
+void main() {
+  group("slow tests", () {
+    // ...
+
+    test("even slower test", () {
+      // ...
+    }, timeout: new Timeout.factor(2))
+  }, timeout: new Timeout(new Duration(minutes: 1)));
+}
+```
+
+Nested timeouts apply in order from outermost to innermost. That means that
+"even slower test" will take two minutes to time out, since it multiplies the
+group's timeout by 2.
+
 ## Testing With `barback`
 
 Packages using the `barback` transformer system may need to test code that's

lib/pub_serve.dart

@@ -35,7 +35,8 @@ import "${p.url.basename(id.path)}" as test;
 
 void main(_, Map message) {
   var sendPort = message['reply'];
-  IsolateListener.start(sendPort, () => test.main);
+  var metadata = new Metadata.deserialize(message['metadata']);
+  IsolateListener.start(sendPort, metadata, () => test.main);
 }
 '''));
 

lib/src/backend/invoker.dart

@@ -67,6 +67,9 @@ class Invoker {
   /// The test being run.
   LocalTest get _test => liveTest.test as LocalTest;
 
+  /// The test metadata merged with the suite metadata.
+  final Metadata metadata;
+
   /// Note that this is meaningless once [_onCompleteCompleter] is complete.
   var _outstandingCallbacks = 0;
 
@@ -84,7 +87,8 @@ class Invoker {
     return Zone.current[#test.invoker];
   }
 
-  Invoker._(Suite suite, LocalTest test) {
+  Invoker._(Suite suite, LocalTest test)
+      : metadata = suite.metadata.merge(test.metadata) {
     _controller = new LiveTestController(suite, test, _onRun, () {
       _closed = true;
     });
@@ -158,7 +162,7 @@ class Invoker {
         // TODO(nweiz): Make the timeout configurable.
         // TODO(nweiz): Reset this timer whenever the user's code interacts with
         // the library.
-        var timeout = _test.metadata.timeout.apply(new Duration(seconds: 30));
+        var timeout = metadata.timeout.apply(new Duration(seconds: 30));
         var timer = new Timer(timeout, () {
           if (liveTest.isComplete) return;
           handleError(

lib/src/backend/metadata.dart

@@ -23,7 +23,7 @@ class Metadata {
   /// [testOn] defaults to [PlatformSelector.all].
   Metadata({PlatformSelector testOn, Timeout timeout})
       : testOn = testOn == null ? PlatformSelector.all : testOn,
-        timeout = timeout == null ? new Timeout.factor(1) : timeout;
+        timeout = timeout == null ? const Timeout.factor(1) : timeout;
 
   /// Creates a new Metadata, but with fields parsed from strings where
   /// applicable.

lib/src/runner/browser/browser_manager.dart

@@ -38,8 +38,11 @@ class BrowserManager {
   ///
   /// [url] should be an HTML page with a reference to the JS-compiled test
   /// suite. [path] is the path of the original test suite file, which is used
-  /// for reporting.
-  Future<Suite> loadSuite(String path, Uri url) {
+  /// for reporting. [metadata] is the parsed metadata for the test suite.
+  Future<Suite> loadSuite(String path, Uri url, Metadata metadata) {
+    url = url.replace(
+        fragment: Uri.encodeFull(JSON.encode(metadata.serialize())));
+
     var suiteChannel = _channel.virtualChannel();
     _channel.sink.add({
       "command": "loadSuite",
@@ -66,10 +69,10 @@ class BrowserManager {
       }
 
       return new Suite(response["tests"].map((test) {
-        var metadata = new Metadata.deserialize(test['metadata']);
+        var testMetadata = new Metadata.deserialize(test['metadata']);
         var testChannel = suiteChannel.virtualChannel(test['channel']);
-        return new IframeTest(test['name'], metadata, testChannel);
-      }), path: path);
+        return new IframeTest(test['name'], testMetadata, testChannel);
+      }), metadata: metadata, path: path);
     });
   }
 }

lib/src/runner/browser/iframe_listener.dart

@@ -5,9 +5,11 @@
 library test.runner.browser.iframe_listener;
 
 import 'dart:async';
-import 'dart:html';
+import 'dart:convert';
+import 'dart:html' hide Metadata;
 
 import '../../backend/declarer.dart';
+import '../../backend/metadata.dart';
 import '../../backend/suite.dart';
 import '../../backend/test.dart';
 import '../../util/multi_channel.dart';
@@ -63,7 +65,13 @@ class IframeListener {
       return;
     }
 
-    new IframeListener._(new Suite(declarer.tests))._listen(channel);
+    var url = Uri.parse(window.location.href);
+    var metadata = url.hasFragment
+        ? new Metadata.deserialize(JSON.decode(Uri.decodeFull(url.fragment)))
+        : new Metadata();
+
+    new IframeListener._(new Suite(declarer.tests, metadata: metadata))
+        ._listen(channel);
   }
 
   /// Constructs a [MultiChannel] wrapping the `postMessage` communication with

lib/src/runner/browser/server.dart

@@ -15,6 +15,7 @@ import 'package:shelf/shelf_io.dart' as shelf_io;
 import 'package:shelf_static/shelf_static.dart';
 import 'package:shelf_web_socket/shelf_web_socket.dart';
 
+import '../../backend/metadata.dart';
 import '../../backend/suite.dart';
 import '../../backend/test_platform.dart';
 import '../../util/io.dart';
@@ -223,7 +224,8 @@ void main() {
   ///
   /// This will start a browser to load the suite if one isn't already running.
   /// Throws an [ArgumentError] if [browser] isn't a browser platform.
-  Future<Suite> loadSuite(String path, TestPlatform browser) {
+  Future<Suite> loadSuite(String path, TestPlatform browser,
+      Metadata metadata) {
     if (!browser.isBrowser) {
       throw new ArgumentError("$browser is not a browser.");
     }
@@ -249,7 +251,7 @@ void main() {
       // TODO(nweiz): Don't start the browser until all the suites are compiled.
       return _browserManagerFor(browser).then((browserManager) {
         if (_closed) return null;
-        return browserManager.loadSuite(path, suiteUrl);
+        return browserManager.loadSuite(path, suiteUrl, metadata);
       }).then((suite) {
         if (_closed) return null;
         if (suite != null) return suite.change(platform: browser.name);

lib/src/runner/loader.dart

@@ -135,35 +135,41 @@ class Loader {
               'When using "pub serve", all test files must be in test/.');
         }
 
-        if (platform.isBrowser) return _loadBrowserFile(path, platform);
-        assert(platform == TestPlatform.vm);
-        return _loadVmFile(path);
+        if (platform == TestPlatform.vm) return _loadVmFile(path, metadata);
+        assert(platform.isBrowser);
+        return _loadBrowserFile(path, platform, metadata);
       }).then((suite) {
         if (suite == null) return;
 
-        controller.add(suite
-            .change(metadata: metadata).filter(platform, os: currentOS));
+        controller.add(suite.filter(platform, os: currentOS));
       }).catchError(controller.addError);
     }).then((_) => controller.close());
 
     return controller.stream;
   }
 
-  /// Load the test suite at [path] in a browser.
-  Future<Suite> _loadBrowserFile(String path, TestPlatform platform) =>
+  /// Load the test suite at [path] in [platform].
+  ///
+  /// [metadata] is the suite-level metadata for the test.
+  Future<Suite> _loadBrowserFile(String path, TestPlatform platform,
+        Metadata metadata) =>
       _browserServer.then((browserServer) =>
-          browserServer.loadSuite(path, platform));
+          browserServer.loadSuite(path, platform, metadata));
 
   /// Load the test suite at [path] in VM isolate.
-  Future<Suite> _loadVmFile(String path) {
+  ///
+  /// [metadata] is the suite-level metadata for the test.
+  Future<Suite> _loadVmFile(String path, Metadata metadata) {
     var receivePort = new ReceivePort();
 
     return new Future.sync(() {
       if (_pubServeUrl != null) {
         var url = _pubServeUrl.resolve(
             p.relative(path, from: 'test') + '.vm_test.dart');
-        return Isolate.spawnUri(url, [], {'reply': receivePort.sendPort})
-            .then((isolate) => new IsolateWrapper(isolate, () {}))
+        return Isolate.spawnUri(url, [], {
+          'reply': receivePort.sendPort,
+          'metadata': metadata.serialize()
+        }).then((isolate) => new IsolateWrapper(isolate, () {}))
             .catchError((error, stackTrace) {
           if (error is! IsolateSpawnException) throw error;
 
@@ -181,16 +187,19 @@ class Loader {
         });
       } else {
         return runInIsolate('''
+import "package:test/src/backend/metadata.dart";
 import "package:test/src/runner/vm/isolate_listener.dart";
 
 import "${p.toUri(p.absolute(path))}" as test;
 
 void main(_, Map message) {
   var sendPort = message['reply'];
-  IsolateListener.start(sendPort, () => test.main);
+  var metadata = new Metadata.deserialize(message['metadata']);
+  IsolateListener.start(sendPort, metadata, () => test.main);
 }
 ''', {
-          'reply': receivePort.sendPort
+          'reply': receivePort.sendPort,
+          'metadata': metadata.serialize()
         }, packageRoot: _packageRoot);
       }
     }).catchError((error, stackTrace) {
@@ -211,9 +220,9 @@ void main(_, Map message) {
       }
 
       return new Suite(response["tests"].map((test) {
-        var metadata = new Metadata.deserialize(test['metadata']);
-        return new IsolateTest(test['name'], metadata, test['sendPort']);
-      }), path: path, platform: "VM");
+        var testMetadata = new Metadata.deserialize(test['metadata']);
+        return new IsolateTest(test['name'], testMetadata, test['sendPort']);
+      }), metadata: metadata, path: path, platform: "VM");
     });
   }