Let debug target pick the debugger port

tests/standalone/debugger/debug_lib.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 used by debugger wire protocol tests (standalone VM debugging).
 
 library DartDebugger;
 
 import "dart:async";
 import "dart:io";
 import "dart:math";
 import "dart:utf";
 import "dart:json" as JSON;
 
 // Whether or not to print the debugger wire messages on the console.
 var verboseWire = false;
 
-// The number of attempts made to find an unused debugger port.
-var retries = 0;
-
 // Class to buffer wire protocol data from debug target and
 // break it down to individual json messages.
 class JsonBuffer {
   String buffer = null;
 
   append(String s) {
     if (buffer == null || buffer.length == 0) {
       buffer = s;
     } else {
       buffer += s;
@@ skipping 259 matching lines @@
   bool get isEmpty => entries.isEmpty;
   get currentEntry => entries.last;
   advance() => entries.removeLast();
   add(entry) => entries.add(entry);
 }
 
 
 class Debugger {
   // Debug target process properties.
   Process targetProcess;
-  int portNumber;
   Socket socket;
   JsonBuffer responses = new JsonBuffer();
 
   DebugScript script;
   int seqNr = 0;  // Sequence number of next debugger command message.
   Command lastCommand = null;  // Most recent command sent to target.
   List<String> errors = new List();
   bool cleanupDone = false;
 
   // Data collected from debug target.
   Map currentMessage = null;  // Currently handled message sent by target.
   String scriptUrl = null;
   bool shutdownEventSeen = false;
   int isolateId = 0;
   bool isPaused = false;
 
-  Debugger(this.targetProcess, this.portNumber, this.script) {
+  Debugger(this.targetProcess, this.script) {
     stdin.listen((_) {});

[Ivan Posva, 2013/05/23 02:06:11]

Why is this stdin even needed? This is the stdin of the XYZ_debugger_test.dart,
which we should not be messing with at all in this case, correct?

[kustermann, 2013/05/23 07:22:32]

Correct, this should not be necessary.
When have had problems with this before when I filed http://dartbug.com/9439.

[hausner, 2013/05/23 17:41:40]

Removed this line.

On 2013/05/23 07:22:32, kustermann wrote:

     var stdoutStringStream = targetProcess.stdout
         .transform(new StringDecoder())
         .transform(new LineTransformer());
     stdoutStringStream.listen((line) {
-      if (line == "Debugger initialized") {
-        openConnection();
+      print("TARG: $line");
+      if (line.startsWith("Debugger listening")) {
+        RegExp portExpr = new RegExp(r"\d+");
+        var port = portExpr.stringMatch(line);
+        print("Debug target found listening at port '$port'");
+        openConnection(int.parse(port));
       }
-      print("TARG: $line");
     });
 
     var stderrStringStream = targetProcess.stderr
         .transform(new StringDecoder())
         .transform(new LineTransformer());
     stderrStringStream.listen((line) {
       print("TARG: $line");
     });
   }
 
@@ skipping 111 matching lines @@
     socket.write(jsonMsg);
   }
 
   bool get errorsDetected => errors.length > 0;
 
   // Record error message.
   void error(String s) {
     errors.add(s);
   }
 
-  void openConnection() {
+  void openConnection(int portNumber) {
     Socket.connect("127.0.0.1", portNumber).then((s) {
         this.socket = s;
         var stringStream = socket.transform(new StringDecoder());
         stringStream.listen((str) {
             try {
               responses.append(str);
               handleMessages();
             } catch(e, trace) {
               print("Unexpected exception:\n$e\n$trace");
               cleanup();
@@ skipping 23 matching lines @@
     if (cleanupDone) return;
     if (socket != null) {
       socket.close().catchError((error) {
         // Print this directly in addition to adding it to the
         // error message queue, in case the error message queue
         // gets printed before this error handler is called.
         print("Error occurred while closing socket: $error");
         error("Error while closing socket: $error");
       });
     }
+    var targetPid = targetProcess.pid;
+    print("Sending kill signal to process $targetPid...");
     targetProcess.kill();
     // If the process was already dead exitCode is already
     // available and we call exit() in the next event loop cycle.
     // Otherwise this will wait for the process to exit.
     targetProcess.exitCode.then((exitCode) {
+      print("process $targetPid terminated with exit code $exitCode.");
       if (errorsDetected) {
         print("\n===== Errors detected: =====");
         for (int i = 0; i < errors.length; i++) print(errors[i]);
         print("============================\n");
       }
       exit(errors.length);
     });
     cleanupDone = true;
   }
 }
 
 
 bool RunScript(List script) {
   var options = new Options();
   if (options.arguments.contains("--debuggee")) {
     return false;
   }
   verboseWire = options.arguments.contains("--wire");
 
-  // Pick a port in the upper half of the port number range.
-  var seed = new DateTime.now().millisecondsSinceEpoch;
-  Random random = new Random(seed);
-  var debugPort = random.nextInt(32000) + 32000;
-  print('using debug port $debugPort ...');
-  ServerSocket.bind('127.0.0.1', debugPort).then((ServerSocket s) {
-      s.close();
-      var targetOpts = [ "--debug:$debugPort" ];
-      // --verbose_debug is necessary so the test knows when the debuggee
-      // is initialized.
-      targetOpts.add("--verbose_debug");
-      targetOpts.add(options.script);
-      targetOpts.add("--debuggee");
-      print('args: ${targetOpts.join(" ")}');
+  // Port number 0 means debug target picks a free port dynamically.
+  var targetOpts = [ "--debug:0" ];
+  targetOpts.add(options.script);
+  targetOpts.add("--debuggee");
+  print('args: ${targetOpts.join(" ")}');
 
-      Process.start(options.executable, targetOpts).then((Process process) {
-        print("Debug target process started");
-        process.stdin.close();
-        process.exitCode.then((int exitCode) {
-          if (exitCode != 0) throw "bad exit code: $exitCode";
-          print("Debug target process exited with exit code $exitCode");
-        });
-        var debugger =
-            new Debugger(process, debugPort, new DebugScript(script));
-      });
-    },
-    onError: (e) {
-      if (++retries >= 3) {
-        print('unable to find unused port: $e');
-        var trace = getAttachedStackTrace(e);
-        if (trace != null) print("StackTrace: $trace");
-        return -1;
-      } else {
-        // Retry with another random port.
-        RunScript(script);
-      }
-    });
+  Process.start(options.executable, targetOpts).then((Process process) {
+    print("Debug target process started, pid ${process.pid}.");
+    process.stdin.close();
+    var debugger = new Debugger(process, new DebugScript(script));
+  });
   return true;
 }