Consistently schedule operations in the barback tests.

pkg/barback/test/utils.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 barback.test.utils;
 
 import 'dart:async';
 import 'dart:collection';
 import 'dart:io';
 
@@ skipping 51 matching lines @@
   if (transformers == null) transformers = {};
 
   _provider = new MockProvider(assets, transformers);
   _barback = new Barback(_provider);
   _nextBuildResult = 0;
 }
 
 /// Updates [assets] in the current [PackageProvider].
 ///
 /// Each item in the list may either be an [AssetId] or a string that can be
+/// parsed as one.
+void updateSources(Iterable assets) {
+  assets = _parseAssets(assets);
+  schedule(() => _barback.updateSources(assets),
+      "updating ${assets.join(', ')}");
+}
+
+/// Updates [assets] in the current [PackageProvider].
+///
+/// Each item in the list may either be an [AssetId] or a string that can be
 /// parsed as one. Note that this method is not automatically scheduled.

[Bob Nystrom, 2013/08/08 21:35:35]

Remove the "Note that..." sentence and collapse the next one into this
paragraph.

[nweiz, 2013/08/09 19:41:51]

Done.

-void updateSources(Iterable assets) {
-  // Allow strings as asset IDs.
-  assets = assets.map((asset) {
-    if (asset is String) return new AssetId.parse(asset);
-    return asset;
-  });
+///
+/// Unlike [updateSources], this is not automatically scheduled and will be run
+/// synchronously when called.
+void updateSourcesSync(Iterable assets) =>
+    _barback.updateSources(_parseAssets(assets));
 
-  _barback.updateSources(assets);
+/// Removes [assets] from the current [PackageProvider].
+///
+/// Each item in the list may either be an [AssetId] or a string that can be
+/// parsed as one.
+void removeSources(Iterable assets) {
+  assets = _parseAssets(assets);
+  schedule(() => _barback.removeSources(assets),
+      "removing ${assets.join(', ')}");
 }
 
 /// Removes [assets] from the current [PackageProvider].
 ///
 /// Each item in the list may either be an [AssetId] or a string that can be
-/// parsed as one. Note that this method is not automatically scheduled.
-void removeSources(Iterable assets) {
-  // Allow strings as asset IDs.
-  assets = assets.map((asset) {
+/// parsed as one.
+///
+/// Unlike [removeSources], this is not automatically scheduled and will be run

[Bob Nystrom, 2013/08/08 21:35:35]

Nit, but make this part of previous paragraph.

[nweiz, 2013/08/09 19:41:51]

Done.

+/// synchronously when called.
+void removeSourcesSync(Iterable assets) =>
+    _barback.removeSources(_parseAssets(assets));
+
+/// Parse a list of strings or [AssetId]s into a list of [AssetId]s.
+List<AssetId> _parseAssets(Iterable assets) {
+  return assets.map((asset) {
     if (asset is String) return new AssetId.parse(asset);
     return asset;
-  });
-
-  _barback.removeSources(assets);
+  }).toList();
 }
 
 /// Schedules a change to the contents of an asset identified by [name] to
 /// [contents].
 ///
 /// Does not update it in the graph.
 void modifyAsset(String name, String contents) {
   schedule(() {
     _provider._modifyAsset(name, contents);
   }, "modify asset $name");
@@ skipping 31 matching lines @@
 /// after this.
 void buildShouldNotBeDone() {
   _futureShouldNotCompleteUntil(
       _barback.results.elementAt(_nextBuildResult),
       schedule(() => pumpEventQueue(), "build should not terminate"),
       "build");
 }
 
 /// Expects that the next [BuildResult] is a build success.
 void buildShouldSucceed() {
-  expect(_getNextBuildResult().then((result) {
+  expect(_getNextBuildResult("build should succeed").then((result) {
     result.errors.forEach(currentSchedule.signalError);
     expect(result.succeeded, isTrue);
   }), completes);
 }
 
 /// Expects that the next [BuildResult] emitted is a failure.
 ///
 /// [matchers] is a list of matchers to match against the errors that caused the
 /// build to fail. Every matcher is expected to match an error, but the order of
 /// matchers is unimportant.
 void buildShouldFail(List matchers) {
-  expect(_getNextBuildResult().then((result) {
+  expect(_getNextBuildResult("build should fail").then((result) {
     expect(result.succeeded, isFalse);
     expect(result.errors.length, equals(matchers.length));
     for (var matcher in matchers) {
       expect(result.errors, contains(matcher));
     }
   }), completes);
 }
 
-Future<BuildResult> _getNextBuildResult() =>
-  _barback.results.elementAt(_nextBuildResult++);
-
-/// Pauses the schedule until the currently running build completes.
-///
-/// Validates that the build completed successfully.
-void waitForBuild() {
-  schedule(() {
-    return _barback.results.first.then((result) {
-      expect(result.succeeded, isTrue);
-    });
-  }, "wait for build");
+Future<BuildResult> _getNextBuildResult(String description) {
+  var result = currentSchedule.wrapFuture(
+      _barback.results.elementAt(_nextBuildResult++));
+  return schedule(() => result, description);
 }
 
 /// Schedules an expectation that the graph will deliver an asset matching
 /// [name] and [contents].
 ///
 /// If [contents] is omitted, defaults to the asset's filename without an
 /// extension (which is the same default that [initGraph] uses).
 void expectAsset(String name, [String contents]) {
   var id = new AssetId.parse(name);
 
@@ skipping 237 matching lines @@
 
   _MockAsset(this.id, this.contents);
 
   Future<String> readAsString({Encoding encoding}) =>
       new Future.value(contents);
 
   Stream<List<int>> read() => throw new UnimplementedError();
 
   String toString() => "MockAsset $id $contents";
 }