Refactor test servers to make them less global.

test/test_pub.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.
 
 /// 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.
 import 'dart:async';
@@ skipping 17 matching lines @@
 import 'package:pub/src/package.dart';
 import 'package:pub/src/source_registry.dart';
 import 'package:pub/src/system_cache.dart';
 import 'package:pub/src/utils.dart';
 import 'package:pub/src/validator.dart';
 import 'package:pub_semver/pub_semver.dart';
 import 'package:scheduled_test/scheduled_process.dart';
 import 'package:scheduled_test/scheduled_server.dart';
 import 'package:scheduled_test/scheduled_stream.dart';
 import 'package:scheduled_test/scheduled_test.dart' hide fail;
-import 'package:shelf/shelf.dart' as shelf;
-import 'package:shelf/shelf_io.dart' as shelf_io;
 
 import 'descriptor.dart' as d;
+import 'descriptor_server.dart';
 
-export 'serve_packages.dart';
-
-/// The current [HttpServer] created using [serve].
-var _server;
-
-/// The list of paths that have been requested from the server since the last
-/// call to [getRequestedPaths].
-final _requestedPaths = <String>[];
-
-/// The cached value for [_portCompleter].
-Completer<int> _portCompleterCache;
+export 'descriptor_server.dart';
+export 'package_server.dart';
 
 /// A [Matcher] that matches JavaScript generated by dart2js with minification
 /// enabled.
 Matcher isMinifiedDart2JSOutput =
     isNot(contains("// The code supports the following hooks"));
 
 /// A [Matcher] that matches JavaScript generated by dart2js with minification
 /// disabled.
 Matcher isUnminifiedDart2JSOutput =
     contains("// The code supports the following hooks");
 
 /// The entrypoint for pub itself.
 final _entrypoint = new Entrypoint(
     pubRoot, new SystemCache.withSources(isOffline: true));
 
-/// The completer for [port].
-Completer<int> get _portCompleter {
-  if (_portCompleterCache != null) return _portCompleterCache;
-  _portCompleterCache = new Completer<int>();
-  currentSchedule.onComplete.schedule(() {
-    _portCompleterCache = null;
-  }, 'clearing the port completer');
-  return _portCompleterCache;
-}
-
-/// A future that will complete to the port used for the current server.
-Future<int> get port => _portCompleter.future;
-
-/// Gets the list of paths that have been requested from the server since the
-/// last time this was called (or since the server was first spun up).
-Future<List<String>> getRequestedPaths() {
-  return schedule(() {
-    var paths = _requestedPaths.toList();
-    _requestedPaths.clear();
-    return paths;
-  }, "get previous network requests");
-}
-
-/// Creates an HTTP server to serve [contents] as static files.
-///
-/// This server will exist only for the duration of the pub run. Subsequent
-/// calls to [serve] replace the previous server.
-void serve([List<d.Descriptor> contents]) {
-  var baseDir = d.dir("serve-dir", contents);
-
-  _hasServer = true;
-
-  schedule(() {
-    return _closeServer().then((_) {
-      return shelf_io.serve((request) {
-        var path = p.posix.fromUri(request.url.path);
-        _requestedPaths.add(path);
-
-        return validateStream(baseDir.load(path))
-            .then((stream) => new shelf.Response.ok(stream))
-            .catchError((error) {
-          return new shelf.Response.notFound('File "$path" not found.');
-        });
-      }, 'localhost', 0).then((server) {
-        _server = server;
-        _portCompleter.complete(_server.port);
-        currentSchedule.onComplete.schedule(_closeServer);
-      });
-    });
-  }, 'starting a server serving:\n${baseDir.describe()}');
-}
-
-/// Like [serve], but reports an error if a request ever comes in to the server.
-void serveErrors() {
-  _hasServer = true;
-
-  schedule(() async {
-    await _closeServer();
-
-    _server = await shelf_io.serve((request) {
-      fail("The HTTP server received an unexpected request:\n"
-          "${request.method} ${request.requestedUri}");
-      return new shelf.Response.forbidden(null);
-    }, 'localhost', 0);
-
-    _portCompleter.complete(_server.port);
-    currentSchedule.onComplete.schedule(_closeServer);
-  });
-}
-
-/// Closes [_server].
-///
-/// Returns a [Future] that completes after the [_server] is closed.
-Future _closeServer() {
-  if (_server == null) return new Future.value();
-  var future = _server.close();
-  _server = null;
-  _hasServer = false;
-  _portCompleterCache = null;
-  return future;
-}
-
-/// `true` if the current test spins up an HTTP server.
-bool _hasServer = false;
-
 /// Converts [value] into a YAML string.
 String yaml(value) => JSON.encode(value);
 
 /// The full path to the created sandbox directory for an integration test.
 String get sandboxDir => _sandboxDir;
 String _sandboxDir;
 
 /// The path of the package cache directory used for tests, relative to the
 /// sandbox directory.
 final String cachePath = "cache";
@@ skipping 234 matching lines @@
   environment['_PUB_TESTING'] = 'true';
   environment['PUB_CACHE'] = await schedule(() => _pathInSandbox(cachePath));
 
   // Ensure a known SDK version is set for the tests that rely on that.
   environment['_PUB_TEST_SDK_VERSION'] = "0.1.2+3";
 
   if (tokenEndpoint != null) {
     environment['_PUB_TEST_TOKEN_ENDPOINT'] = tokenEndpoint.toString();
   }
 
-  if (_hasServer) {
-    environment['PUB_HOSTED_URL'] = "http://localhost:${await port}";
+  if (globalServer != null) {
+    environment['PUB_HOSTED_URL'] =
+        "http://localhost:${await globalServer.port}";
   }
 
   return environment;
 }
 
 /// Starts a Pub process and returns a [ScheduledProcess] that supports
 /// interaction with that process.
 ///
 /// Any futures in [args] will be resolved before the process is started.
 ///
@@ skipping 427 matching lines @@
         _lastMatcher.matches(item.last, matchState);
   }
 
   Description describe(Description description) {
     return description.addAll("(", ", ", ")", [_firstMatcher, _lastMatcher]);
   }
 }
 
 /// A [StreamMatcher] that matches multiple lines of output.
 StreamMatcher emitsLines(String output) => inOrder(output.split("\n"));