Need for a check whether the proxy is usable, i.e. whether it is started and not finished. Introucing #isReady + sanity test.

mkrauskopf · mkrauskopf · commit 2859c6ec3f07 · 2008-10-31T12:25:28.000Z
diff --git a/CHANGES b/CHANGES
@@ -3,7 +3,7 @@
   * Some progress. Code cleanup, API changes (increasing middle version of
     trunk).
     * RubyDebuggerProxy
-      * use isFinished instead of checkConnection, getting rid of 'connected'
+      * use #isReady instead of #checkConnection
       * s/connect/setDebugTarget (this what it actually do now)
       * relaxing addBreakpoint, to emit warning instead of exception (debuggee
         could die)
diff --git a/src/org/rubyforge/debugcommons/RubyDebuggerProxy.java b/src/org/rubyforge/debugcommons/RubyDebuggerProxy.java
@@ -45,6 +45,7 @@ public static enum DebuggerType { CLASSIC_DEBUGGER, RUBY_DEBUG }
     private final DebuggerType debuggerType;
     private RubyDebugTarget debugTarged;
     private Socket commandSocket;
+    private boolean started;
     private boolean finished;
     
     private PrintWriter commandWriter;
@@ -112,16 +113,17 @@ public void startDebugging(final IRubyBreakpoint[] initialBreakpoints) throws Ru
         startSuspensionReaderLoop();
     }
 
+
     /**
-     * Whether client might send command to the proxy. When the debuggee
-     * finished (in a standard manner or unexpectedly, e.g. was killed) this
-     * returns false.
+     * Whether client might send command to the proxy. When the debuggee has
+     * finished (in a standard manner or unexpectedly, e.g. was killed) or the
+     * proxy did not start yet, false is returned.
      */
-    public synchronized boolean isFinished() {
-        return finished || !getDebugTarged().isRunning();
+    public synchronized boolean isReady() {
+        return !finished && commandWriter != null && getDebugTarged().isRunning();
     }
 
-    private void startClassicDebugger(final IRubyBreakpoint[] initialBreakpoints) throws RubyDebuggerException {
+    private synchronized void startClassicDebugger(final IRubyBreakpoint[] initialBreakpoints) throws RubyDebuggerException {
         try {
             commandFactory = new ClassicDebuggerCommandFactory();
             readersSupport.startCommandLoop(getCommandSocket().getInputStream());
@@ -133,7 +135,7 @@ private void startClassicDebugger(final IRubyBreakpoint[] initialBreakpoints) th
         }
     }
 
-    private void startRubyDebug(final IRubyBreakpoint[] initialBreakpoints) throws RubyDebuggerException {
+    private synchronized void startRubyDebug(final IRubyBreakpoint[] initialBreakpoints) throws RubyDebuggerException {
         try {
             commandFactory = new RubyDebugCommandFactory();
             readersSupport.startCommandLoop(getCommandSocket().getInputStream());
@@ -172,8 +174,8 @@ protected void setBreakpoints(final IRubyBreakpoint[] breakpoints) throws RubyDe
     
     public synchronized void addBreakpoint(final IRubyBreakpoint breakpoint) {
         LOGGER.fine("Adding breakpoint: " + breakpoint);
-        if (isFinished()) {
-            LOGGER.fine("Session and/or debuggee has already finished, skipping addition of breakpoint: " + breakpoint);
+        if (!isReady()) {
+            LOGGER.fine("Session and/or debuggee is not ready, skipping addition of breakpoint: " + breakpoint);
             return;
         }
         assert breakpoint != null : "breakpoint cannot be null";
@@ -226,8 +228,8 @@ public synchronized void removeBreakpoint(final IRubyBreakpoint breakpoint) {
      */
     public synchronized void removeBreakpoint(final IRubyBreakpoint breakpoint, boolean silent) {
         LOGGER.fine("Removing breakpoint: " + breakpoint);
-        if (isFinished()) {
-            LOGGER.fine("Session and/or debuggee has already finished, skipping removing of breakpoint: " + breakpoint);
+        if (!isReady()) {
+            LOGGER.fine("Session and/or debuggee is not ready, skipping removing of breakpoint: " + breakpoint);
             return;
         }
         if (breakpoint instanceof IRubyLineBreakpoint) {
@@ -307,9 +309,9 @@ public void resume(final RubyThread thread) {
     
     private void sendCommand(final String s) throws RubyDebuggerException {
         LOGGER.fine("Sending command debugger: " + s);
-        if (isFinished()) {
+        if (!isReady()) {
             throw new RubyDebuggerException("Trying to send a command [" + s +
-                    "] to terminated process (debuggee: " + getDebugTarged() + ", output: \n\n" +
+                    "] to non-started or finished proxy (debuggee: " + getDebugTarged() + ", output: \n\n" +
                     dumpProcess(debugTarged.getProcess()));
         }
         getCommandWriter().println(s);
@@ -358,7 +360,7 @@ public RubyFrame[] readFrames(RubyThread thread) throws RubyDebuggerException {
             sendCommand(commandFactory.createReadFrames(thread));
             infos = getReadersSupport().readFrames();
         } catch (RubyDebuggerException e) {
-            if (isFinished()) {
+            if (!isReady()) {
                 throw e;
             }
             infos = new RubyFrameInfo[0];
diff --git a/src/org/rubyforge/debugcommons/model/RubyDebugTarget.java b/src/org/rubyforge/debugcommons/model/RubyDebugTarget.java
@@ -72,8 +72,8 @@ public void suspensionOccurred(SuspensionPoint suspensionPoint) {
         try {
             updateThreads();
         } catch (RubyDebuggerException e) {
-            if (getProxy().isFinished()) {
-                throw new RuntimeException("Cannot update threads", e);
+            if (!getProxy().isReady()) {
+                throw new RuntimeException("Cannot update threads. Proxy is not ready.", e);
             } else {
                 LOGGER.fine("Session has finished. Ignoring unsuccessful thread update.");
                 return;
diff --git a/test/org/rubyforge/debugcommons/DebuggerTestBase.java b/test/org/rubyforge/debugcommons/DebuggerTestBase.java
@@ -194,7 +194,7 @@ protected void startDebugging(
             public void run() {
                 try {
                     proxy.startDebugging(breakpoints);
-                    assertFalse("proxy alive", proxy.isFinished());
+                    assertTrue("proxy alive", proxy.isReady());
                 } catch (RubyDebuggerException e) {
                     fail("Cannot start debugger: " + e);
                 }
diff --git a/test/org/rubyforge/debugcommons/RubyDebuggerProxyTest.java b/test/org/rubyforge/debugcommons/RubyDebuggerProxyTest.java
@@ -15,6 +15,13 @@ public final class RubyDebuggerProxyTest extends DebuggerTestBase {
     public RubyDebuggerProxyTest(String testName) {
         super(testName);
     }
+
+    public void testIsFinished() throws Exception {
+        final RubyDebuggerProxy proxy = prepareProxy("sleep 0.01");
+        assertFalse("proxy not ready yet", proxy.isReady());
+        startDebugging(proxy, new IRubyLineBreakpoint[]{}, 0);
+        assertTrue("proxy not ready yet", proxy.isReady());
+    }
     
     public void testBreakpointsRemoving1() throws Exception {
         final RubyDebuggerProxy proxy = prepareProxy(

Original file line number	Diff line number	Diff line change
`@@ -194,7 +194,7 @@ protected void startDebugging(`
`194`	`194`	`public void run() {`
`195`	`195`	`try {`
`196`	`196`	`proxy.startDebugging(breakpoints);`
`197`		`- assertFalse("proxy alive", proxy.isFinished());`
	`197`	`+ assertTrue("proxy alive", proxy.isReady());`
`198`	`198`	`} catch (RubyDebuggerException e) {`
`199`	`199`	`fail("Cannot start debugger: " + e);`
`200`	`200`	`}`