Add validation infrastructure for "pub lish".

utils/tests/pub/test_pub.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.
 
 /**
  * Test infrastructure for testing pub. Unlike typical unit tests, most pub
  * tests are integration tests that stage some stuff on the file system, run
  * pub, and then validate the results. This library provides an API to build
  * tests like that.
  */
 library test_pub;
 
 import 'dart:io';
 import 'dart:isolate';
 import 'dart:json';
 import 'dart:math';
 import 'dart:uri';
 
 import '../../../pkg/oauth2/lib/oauth2.dart' as oauth2;
 import '../../../pkg/unittest/lib/unittest.dart';
 import '../../lib/file_system.dart' as fs;
+import '../../pub/entrypoint.dart';
 import '../../pub/git_source.dart';
 import '../../pub/hosted_source.dart';
 import '../../pub/io.dart';
 import '../../pub/sdk_source.dart';
+import '../../pub/system_cache.dart';
 import '../../pub/utils.dart';
+import '../../pub/validator.dart';
 import '../../pub/yaml/yaml.dart';
 
 /**
  * Creates a new [FileDescriptor] with [name] and [contents].
  */
 FileDescriptor file(Pattern name, String contents) =>
     new FileDescriptor(name, contents);
 
 /**
  * Creates a new [DirectoryDescriptor] with [name] and [contents].
@@ skipping 224 matching lines @@
   return dir("lib", [
     file("$name.dart", 'main() => "$code";')
   ]);
 }
 
 /**
  * Describes a map representing a library package with the given [name],
  * [version], and [dependencies].
  */
 Map package(String name, String version, [List dependencies]) {
-  var package = {"name": name, "version": version};
+  var package = {
+    "name": name,
+    "version": version,
+    "author": "Nathan Weizenbaum <nweiz@google.com>",
+    "homepage": "http://pub.dartlang.org"
+  };
   if (dependencies != null) {
     package["dependencies"] = _dependencyListToMap(dependencies);
   }
   return package;
 }
 
 /**
  * Describes a map representing a dependency on a package in the package
  * repository.
  */
@@ skipping 237 matching lines @@
     // that the test framework sees it, then finally call asyncDone so that the
     // test framework knows we're done doing asynchronous stuff.
     var future = _runScheduled(createdSandboxDir, _scheduledOnException)
         .chain((_) => cleanup());
     future.handleException((e) {
       print("Exception while cleaning up: $e");
       print(future.stackTrace);
       registerException(error, future.stackTrace);
       return true;
     });
-    future.then((_) {
-      print("Registering exception");
-      registerException(error, future.stackTrace);
-    });
+    future.then((_) => registerException(error, future.stackTrace));
     return true;
   });
 
   future.chain((_) => cleanup()).then((_) {
     asyncDone();
   });
 }
 
 /// Get the path to the root "util/test/pub" directory containing the pub tests.
 String get testDirectory {
@@ skipping 690 matching lines @@
   InputStream load(List<String> path) {
     if (path.isEmpty) {
       throw "Can't load the contents of $name: it doesn't exist.";
     } else {
       throw "Can't load ${Strings.join(path, '/')} from within $name: $name "
         "doesn't exist.";
     }
   }
 }
 
+/// A function that creates a [Validator] subclass.
+typedef Validator ValidatorCreator(Entrypoint entrypoint);
+
+/// Schedules a single [Validator] to run on the [appPath]. Returns a scheduled
+/// Future that contains the erros and warnings produced by that validator.
+Future<Pair<List<String>, List<String>>> schedulePackageValidation(
+    ValidatorCreator fn) {
+  return _scheduleValue((sandboxDir) {
+    var cache = new SystemCache.withSources(
+        join(sandboxDir, cachePath),
+        join(sandboxDir, sdkPath));
+
+    return Entrypoint.load(join(sandboxDir, appPath), cache)
+        .chain((entrypoint) {
+      var validator = fn(entrypoint);
+      return validator.validate().transform((_) {
+        return new Pair(validator.errors, validator.warnings);
+      });
+    });
+  });
+}
+
+/// A matcher that matches a Pair.      
+Matcher pairOf(Matcher firstMatcher, Matcher lastMatcher) =>
+   new _PairMatcher(firstMatcher, lastMatcher);
+
+class _PairMatcher extends BaseMatcher {
+  final Matcher _firstMatcher;
+  final Matcher _lastMatcher;
+
+  _PairMatcher(this._firstMatcher, this._lastMatcher);
+
+  bool matches(item, MatchState matchState) {
+    if (item is! Pair) return false;
+    return _firstMatcher.matches(item.first, matchState) &&
+        _lastMatcher.matches(item.last, matchState);
+  }
+
+  Description describe(Description description) {
+    description.addAll("(", ", ", ")", [_firstMatcher, _lastMatcher]);
+  }
+}
+
+/// The time (in milliseconds) to wait for scheduled events that could run
+/// forever.
+const _SCHEDULE_TIMEOUT = 5000;
+
 /// A class representing a [Process] that is scheduled to run in the course of
 /// the test. This class allows actions on the process to be scheduled
 /// synchronously. All operations on this class are scheduled.
 ///
 /// Before running the test, either [shouldExit] or [kill] must be called on
 /// this to ensure that the process terminates when expected.
 ///
 /// If the test fails, this will automatically print out any remaining stdout
 /// and stderr from the process to aid debugging.
 class ScheduledProcess {
@@ skipping 79 matching lines @@
       var process = _process.value;
       process.kill();
       process.stdout.close();
       process.stderr.close();
     });
   }
 
   /// Reads the next line of stdout from the process.
   Future<String> nextLine() {
     return _scheduleValue((_) {
-      return timeout(_stdout.chain(readLine), 5000,
+      return timeout(_stdout.chain(readLine), _SCHEDULE_TIMEOUT,
           "waiting for the next stdout line from process $name");
     });
   }
 
   /// Reads the next line of stderr from the process.
   Future<String> nextErrLine() {
     return _scheduleValue((_) {
-      return timeout(_stderr.chain(readLine), 5000,
+      return timeout(_stderr.chain(readLine), _SCHEDULE_TIMEOUT,
           "waiting for the next stderr line from process $name");
     });
   }
 
+  /// Reads the remaining stdout from the process. This should only be called
+  /// after kill() or shouldExit().
+  Future<String> remainingStdout() {
+    if (!_endScheduled) {
+      throw new StateError("remainingStdout() should only be called after "
+          "kill() or shouldExit().");
+    }
+
+    return _scheduleValue((_) {
+      return timeout(_stdout.chain(consumeStringInputStream), _SCHEDULE_TIMEOUT,
+          "waiting for the last stdout line from process $name");
+    });
+  }
+
+  /// Reads the remaining stderr from the process. This should only be called
+  /// after kill() or shouldExit().
+  Future<String> remainingStderr() {
+    if (!_endScheduled) {
+      throw new StateError("remainingStderr() should only be called after "
+          "kill() or shouldExit().");
+    }
+
+    return _scheduleValue((_) {
+      return timeout(_stderr.chain(consumeStringInputStream), _SCHEDULE_TIMEOUT,
+          "waiting for the last stderr line from process $name");
+    });
+  }
+
   /// Writes [line] to the process as stdin.
   void writeLine(String line) {
     _schedule((_) => _process.transform((p) => p.stdin.writeString('$line\n')));
   }
 
   /// Kills the process, and waits until it's dead.
   void kill() {
     _endScheduled = true;
     _schedule((_) {
       _endExpected = true;
       return _process.chain((p) {
         p.kill();
-        return timeout(_exitCode, 5000, "waiting for process $name to die");
+        return timeout(_exitCode, _SCHEDULE_TIMEOUT,
+            "waiting for process $name to die");
       });
     });
   }
 
   /// Waits for the process to exit, and verifies that the exit code matches
   /// [expectedExitCode] (if given).
   void shouldExit([int expectedExitCode]) {
     _endScheduled = true;
     _schedule((_) {
       _endExpected = true;
-      return timeout(_exitCode, 5000, "waiting for process $name to exit")
-          .transform((exitCode) {
+      return timeout(_exitCode, _SCHEDULE_TIMEOUT,
+          "waiting for process $name to exit").transform((exitCode) {
         if (expectedExitCode != null) {
           expect(exitCode, equals(expectedExitCode));
         }
       });
     });
   }
 
   /// Prints the remaining data in the process's stdout and stderr streams.
   /// Prints nothing if the straems are empty.
   Future _printStreams() {
@@ skipping 17 matching lines @@
 /// A class representing an [HttpServer] that's scheduled to run in the course
 /// of the test. This class allows the server's request handling to be scheduled
 /// synchronously. All operations on this class are scheduled.
 class ScheduledServer {
   /// The wrapped server.
   final Future<HttpServer> _server;
 
   /// The queue of handlers to run for upcoming requests.
   final _handlers = new Queue<Future>();
 
+  /// The requests to be ignored.
+  final _ignored = new Set<Pair<String, String>>();
+
   ScheduledServer._(this._server);
 
   /// Creates a new server listening on an automatically-allocated port on
   /// localhost.
   factory ScheduledServer() {
     var scheduledServer;
     scheduledServer = new ScheduledServer._(_scheduleValue((_) {
       var server = new HttpServer();
       server.defaultRequestHandler = scheduledServer._awaitHandle;
       server.listen("127.0.0.1", 0);
@@ skipping 20 matching lines @@
       var requestCompleteCompleter = new Completer();
       handlerCompleter.complete((request, response) {
         expect(request.method, equals(method));
         expect(request.path, equals(path));
 
         var future = handler(request, response);
         if (future == null) future = new Future.immediate(null);
         chainToCompleter(future, requestCompleteCompleter);
       });
       return timeout(requestCompleteCompleter.future,
-          5000, "waiting for $method $path");
+          _SCHEDULE_TIMEOUT, "waiting for $method $path");
     });
     _handlers.add(handlerCompleter.future);
   }
 
+  /// Ignore all requests with the given [method] and [path]. If one is
+  /// received, don't respond to it.
+  void ignore(String method, String path) =>
+    _ignored.add(new Pair(method, path));
+
   /// Raises an error complaining of an unexpected request.
   void _awaitHandle(HttpRequest request, HttpResponse response) {
+    if (_ignored.contains(new Pair(request.method, request.path))) return;
     var future = timeout(new Future.immediate(null).chain((_) {
       if (_handlers.isEmpty) {
         fail('Unexpected ${request.method} request to ${request.path}.');
       }
       return _handlers.removeFirst();
     }).transform((handler) {
       handler(request, response);
-    }), 5000, "waiting for a handler for ${request.method} ${request.path}");
+    }), _SCHEDULE_TIMEOUT, "waiting for a handler for ${request.method} "
+        "${request.path}");
     expect(future, completes);
   }
 }
 
 /**
  * Takes a simple data structure (composed of [Map]s, [List]s, scalar objects,
  * and [Future]s) and recursively resolves all the [Future]s contained within.
  * Completes with the fully resolved structure.
  */
 Future _awaitObject(object) {
@@ skipping 57 matching lines @@
 /// calling [completion] is unnecessary.
 void expectLater(Future actual, matcher, {String reason,
     FailureHandler failureHandler, bool verbose: false}) {
   _schedule((_) {
     return actual.transform((value) {
       expect(value, matcher, reason: reason, failureHandler: failureHandler,
           verbose: false);
     });
   });
 }