Provide an API to dart:developer to control the web server hosting the Service Protocol

runtime/observatory/tests/service/test_helper.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 test_helper;
 
 import 'dart:async';
 import 'dart:convert';
 import 'dart:io';
 import 'package:observatory/service_io.dart';
@@ skipping 73 matching lines @@
   bool killedByTester = false;
 
   _ServiceTesteeLauncher() :
       args = [Platform.script.toFilePath()] {}
 
   // Spawn the testee process.
   Future<Process> _spawnProcess(bool pause_on_start,
                                 bool pause_on_exit,
                                 bool pause_on_unhandled_exceptions,
                                 bool trace_service,
-                                bool trace_compiler) {
+                                bool trace_compiler,
+                                bool testeeControlsServer) {
     assert(pause_on_start != null);
     assert(pause_on_exit != null);
     assert(pause_on_unhandled_exceptions != null);
     assert(trace_service != null);
     assert(trace_compiler != null);
+    assert(testeeControlsServer != null);
 
     if (_shouldLaunchSkyShell()) {
       return _spawnSkyProcess(pause_on_start,
                               pause_on_exit,
                               pause_on_unhandled_exceptions,
                               trace_service,
-                              trace_compiler);
+                              trace_compiler,
+                              testeeControlsServer);
     } else {
       return _spawnDartProcess(pause_on_start,
                                pause_on_exit,
                                pause_on_unhandled_exceptions,
                                trace_service,
-                               trace_compiler);
+                               trace_compiler,
+                               testeeControlsServer);
     }
   }
 
   Future<Process> _spawnDartProcess(bool pause_on_start,
                                     bool pause_on_exit,
                                     bool pause_on_unhandled_exceptions,
                                     bool trace_service,
-                                    bool trace_compiler) {
+                                    bool trace_compiler,
+                                    bool testeeControlsServer) {
     assert(!_shouldLaunchSkyShell());
 
     String dartExecutable = Platform.executable;
 
     var fullArgs = [];
     if (trace_service) {
       fullArgs.add('--trace-service');
       fullArgs.add('--trace-service-verbose');
     }
     if (trace_compiler) {
       fullArgs.add('--trace-compiler');
     }
     if (pause_on_start) {
       fullArgs.add('--pause-isolates-on-start');
     }
     if (pause_on_exit) {
       fullArgs.add('--pause-isolates-on-exit');
     }
     if (pause_on_unhandled_exceptions) {
       fullArgs.add('--pause-isolates-on-unhandled-exceptions');
     }
 
     fullArgs.addAll(Platform.executableArguments);
-    fullArgs.add('--enable-vm-service:0');
+    if (!testeeControlsServer) {
+      fullArgs.add('--enable-vm-service:0');
+    }
     fullArgs.addAll(args);
 
     return _spawnCommon(dartExecutable, fullArgs);
   }
 
   Future<Process> _spawnSkyProcess(bool pause_on_start,
                                    bool pause_on_exit,
                                    bool pause_on_unhandled_exceptions,
                                    bool trace_service,
                                    bool trace_compiler) {
@@ skipping 17 matching lines @@
     if (pause_on_exit) {
       dartFlags.add('--pause_isolates_on_exit');
     }
     if (pause_on_unhandled_exceptions) {
       dartFlags.add('--pause_isolates_on_unhandled_exceptions');
     }
     // Override mirrors.
     dartFlags.add('--enable_mirrors=true');
 
     fullArgs.addAll(Platform.executableArguments);
-    fullArgs.add('--observatory-port=0');
+    if (!testeeControlsServer) {
+      fullArgs.add('--observatory-port=0');
+    }
     fullArgs.add('--dart-flags=${dartFlags.join(' ')}');
     fullArgs.addAll(args);
 
     return _spawnCommon(dartExecutable, fullArgs);
   }
 
   Future<Process> _spawnCommon(String executable, List<String> arguments) {
     var environment = _TESTEE_SPAWN_ENV;
     var bashEnvironment = new StringBuffer();
     environment.forEach((k, v) => bashEnvironment.write("$k=$v "));
     print('** Launching $bashEnvironment$executable ${arguments.join(' ')}');
     return Process.start(executable, arguments, environment: environment);
   }
 
-  Future<int> launch(bool pause_on_start,
+  Future<Uri> launch(bool pause_on_start,
                      bool pause_on_exit,
                      bool pause_on_unhandled_exceptions,
                      bool trace_service,
-                     bool trace_compiler) {
+                     bool trace_compiler,
+                     bool testeeControlsServer) {
     return _spawnProcess(pause_on_start,
                   pause_on_exit,
                   pause_on_unhandled_exceptions,
                   trace_service,
-                  trace_compiler).then((p) {
-      Completer completer = new Completer();
+                  trace_compiler,
+                  testeeControlsServer).then((p) {
+      Completer<Uri> completer = new Completer<Uri>();
       process = p;
-      var portNumber;
+      Uri uri;
       var blank;
       var first = true;
       process.stdout.transform(UTF8.decoder)
                     .transform(new LineSplitter()).listen((line) {
-        if (line.startsWith('Observatory listening on http://')) {
-          RegExp portExp = new RegExp(r"\d+.\d+.\d+.\d+:(\d+)");
-          var port = portExp.firstMatch(line).group(1);
-          portNumber = int.parse(port);
+        const kObservatoryListening = 'Observatory listening on ';
+        if (line.startsWith(kObservatoryListening)) {
+          uri = Uri.parse(line.substring(kObservatoryListening.length));
         }
         if (pause_on_start || line == '') {
           // Received blank line.
           blank = true;
         }
-        if (portNumber != null && blank == true && first == true) {
-          completer.complete(portNumber);
+        if ((uri != null) && (blank == true) && (first == true)) {
+          completer.complete(uri);
           // Stop repeat completions.
           first = false;
-          print('** Signaled to run test queries on $portNumber');
+          print('** Signaled to run test queries on $uri');
         }
         print('>testee>out> $line');
       });
       process.stderr.transform(UTF8.decoder)
                     .transform(new LineSplitter()).listen((line) {
         print('>testee>err> $line');
       });
       process.exitCode.then((exitCode) {
         if ((exitCode != 0) && !killedByTester) {
           throw "Testee exited with $exitCode";
         }
         print("** Process exited");
       });
       return completer.future;
     });
   }
 
   void requestExit() {
     print('** Killing script');
     if (process.kill()) {
       killedByTester = true;
     }
   }
 }
 
-// A tester runner that doesn't spawn a process but instead connects to
-// an already running flutter application running on a device. Assumes
-// port 8100. This is only useful for debugging.
-class _FlutterDeviceServiceTesterRunner {
-  void run({List<String> mainArgs,
-            List<VMTest> vmTests,
-            List<IsolateTest> isolateTests,
-            bool pause_on_start: false,
-            bool pause_on_exit: false,
-            bool trace_service: false,
-            bool trace_compiler: false,
-            bool verbose_vm: false,
-            bool pause_on_unhandled_exceptions: false}) {
-    var port = 8100;
-    serviceWebsocketAddress = 'ws://localhost:$port/ws';
-    serviceHttpAddress = 'http://localhost:$port';
-    var name = Platform.script.pathSegments.last;
-    Chain.capture(() async {
-      var vm =
-          new WebSocketVM(new WebSocketVMTarget(serviceWebsocketAddress));
-      print('Loading VM...');
-      await vm.load();
-      print('Done loading VM');
-
-      // Run vm tests.
-      if (vmTests != null) {
-        var testIndex = 1;
-        var totalTests = vmTests.length;
-        for (var test in vmTests) {
-          vm.verbose = verbose_vm;
-          print('Running $name [$testIndex/$totalTests]');
-          testIndex++;
-          await test(vm);
-        }
-      }
-
-      // Run isolate tests.
-      if (isolateTests != null) {
-        var isolate = await vm.isolates.first.load();
-        var testIndex = 1;
-        var totalTests = isolateTests.length;
-        for (var test in isolateTests) {
-          vm.verbose = verbose_vm;
-          print('Running $name [$testIndex/$totalTests]');
-          testIndex++;
-          await test(isolate);
-        }
-      }
-    }, onError: (error, stackTrace) {
-      print('Unexpected exception in service tests: $error\n$stackTrace');
-    });
-  }
-}
-
-void suppressWarning() {
-  new _FlutterDeviceServiceTesterRunner();
+void setupAddresses(Uri serverAddress) {
+  serviceWebsocketAddress =
+          'ws://${serverAddress.authority}${serverAddress.path}ws';
+  serviceHttpAddress =
+      'http://${serverAddress.authority}${serverAddress.path}';
 }
 
 class _ServiceTesterRunner {
   void run({List<String> mainArgs,
             List<VMTest> vmTests,
             List<IsolateTest> isolateTests,
             bool pause_on_start: false,
             bool pause_on_exit: false,
             bool trace_service: false,
             bool trace_compiler: false,
             bool verbose_vm: false,
-            bool pause_on_unhandled_exceptions: false}) {
+            bool pause_on_unhandled_exceptions: false,
+            bool testeeControlsServer: false}) {
     var process = new _ServiceTesteeLauncher();
     process.launch(pause_on_start, pause_on_exit,
                    pause_on_unhandled_exceptions,
-                   trace_service, trace_compiler).then((port) async {
+                   trace_service, trace_compiler,
+                   testeeControlsServer).then((Uri serverAddress) async {
       if (mainArgs.contains("--gdb")) {
         var pid = process.process.pid;
         var wait = new Duration(seconds: 10);
         print("Testee has pid $pid, waiting $wait before continuing");
         sleep(wait);
       }
-      serviceWebsocketAddress = 'ws://localhost:$port/ws';
-      serviceHttpAddress = 'http://localhost:$port';
+      setupAddresses(serverAddress);
       var name = Platform.script.pathSegments.last;
       Chain.capture(() async {
         var vm =
             new WebSocketVM(new WebSocketVMTarget(serviceWebsocketAddress));
         print('Loading VM...');
         await vm.load();
         print('Done loading VM');
 
         // Run vm tests.
         if (vmTests != null) {
@@ skipping 36 matching lines @@
 /// to run tests or testee in this invokation of the script.
 Future runIsolateTests(List<String> mainArgs,
                        List<IsolateTest> tests,
                        {testeeBefore(),
                         testeeConcurrent(),
                         bool pause_on_start: false,
                         bool pause_on_exit: false,
                         bool trace_service: false,
                         bool trace_compiler: false,
                         bool verbose_vm: false,
-                        bool pause_on_unhandled_exceptions: false}) async {
+                        bool pause_on_unhandled_exceptions: false,
+                        bool testeeControlsServer: false}) async {
   assert(!pause_on_start || testeeBefore == null);
   if (_isTestee()) {
     new _ServiceTesteeRunner().run(testeeBefore: testeeBefore,
                                    testeeConcurrent: testeeConcurrent,
                                    pause_on_start: pause_on_start,
                                    pause_on_exit: pause_on_exit);
   } else {
     new _ServiceTesterRunner().run(
         mainArgs: mainArgs,
         isolateTests: tests,
         pause_on_start: pause_on_start,
         pause_on_exit: pause_on_exit,
         trace_service: trace_service,
         trace_compiler: trace_compiler,
         verbose_vm: verbose_vm,
-        pause_on_unhandled_exceptions: pause_on_unhandled_exceptions);
+        pause_on_unhandled_exceptions: pause_on_unhandled_exceptions,
+        testeeControlsServer: testeeControlsServer);
   }
 }
 
 /// Runs [tests] in sequence, each of which should take an [Isolate] and
 /// return a [Future]. Code for setting up state can run before and/or
 /// concurrently with the tests. Uses [mainArgs] to determine whether
 /// to run tests or testee in this invokation of the script.
 ///
 /// This is a special version of this test harness specifically for the
 /// pause_on_unhandled_exceptions_test, which cannot properly function
@@ skipping 53 matching lines @@
         mainArgs: mainArgs,
         vmTests: tests,
         pause_on_start: pause_on_start,
         pause_on_exit: pause_on_exit,
         trace_service: trace_service,
         trace_compiler: trace_compiler,
         verbose_vm: verbose_vm,
         pause_on_unhandled_exceptions: pause_on_unhandled_exceptions);
   }
 }