You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2010/10/28 14:13:03 UTC

svn commit: r1028270 - in /camel/trunk: camel-core/src/main/java/org/apache/camel/impl/ components/camel-test/src/main/java/org/apache/camel/test/ components/camel-test/src/main/java/org/apache/camel/test/junit4/ components/camel-test/src/test/java/org...

Author: davsclaus
Date: Thu Oct 28 12:13:03 2010
New Revision: 1028270

URL: http://svn.apache.org/viewvc?rev=1028270&view=rev
Log:
CAMEL-3241: Easier to debug routes using Camel Test Kit.

Added:
    camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugJUnit4Test.java
    camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugTest.java
Modified:
    camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
    camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/CamelTestSupport.java
    camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/junit4/CamelTestSupport.java

Modified: camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java
URL: http://svn.apache.org/viewvc/camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java?rev=1028270&r1=1028269&r2=1028270&view=diff
==============================================================================
--- camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java (original)
+++ camel/trunk/camel-core/src/main/java/org/apache/camel/impl/DefaultCamelContext.java Thu Oct 28 12:13:03 2010
@@ -1337,6 +1337,9 @@ public class DefaultCamelContext extends
 
         // the stop order is important
 
+        // shutdown debugger
+        ServiceHelper.stopAndShutdownService(getDebugger());
+
         shutdownServices(endpoints.values());
         endpoints.clear();
 

Modified: camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/CamelTestSupport.java
URL: http://svn.apache.org/viewvc/camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/CamelTestSupport.java?rev=1028270&r1=1028269&r2=1028270&view=diff
==============================================================================
--- camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/CamelTestSupport.java (original)
+++ camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/CamelTestSupport.java Thu Oct 28 12:13:03 2010
@@ -21,7 +21,6 @@ import java.util.Hashtable;
 import java.util.Map;
 import java.util.Properties;
 import java.util.concurrent.TimeUnit;
-
 import javax.naming.Context;
 import javax.naming.InitialContext;
 
@@ -37,9 +36,12 @@ import org.apache.camel.ProducerTemplate
 import org.apache.camel.Service;
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.mock.MockEndpoint;
+import org.apache.camel.impl.BreakpointSupport;
 import org.apache.camel.impl.DefaultCamelContext;
+import org.apache.camel.impl.DefaultDebugger;
 import org.apache.camel.impl.JndiRegistry;
 import org.apache.camel.management.JmxSystemPropertyKeys;
+import org.apache.camel.model.ProcessorDefinition;
 import org.apache.camel.spi.Language;
 import org.apache.camel.spring.CamelBeanPostProcessor;
 
@@ -49,13 +51,14 @@ import org.apache.camel.spring.CamelBean
  *
  * @version $Revision$
  */
-public abstract class CamelTestSupport extends TestSupport {    
+public abstract class CamelTestSupport extends TestSupport {
     
     protected volatile CamelContext context;
     protected volatile ProducerTemplate template;
     protected volatile ConsumerTemplate consumer;
     private boolean useRouteBuilder = true;
     private Service camelContextService;
+    private final DebugBreakpoint breakpoint = new DebugBreakpoint();
 
     public boolean isUseRouteBuilder() {
         return useRouteBuilder;
@@ -97,6 +100,11 @@ public abstract class CamelTestSupport e
         // reduce default shutdown timeout to avoid waiting for 300 seconds
         context.getShutdownStrategy().setTimeout(getShutdownTimeout());
 
+        // set debugger
+        context.setDebugger(new DefaultDebugger());
+        context.getDebugger().addBreakpoint(breakpoint);
+        // note: when stopping CamelContext it will automatic remove the breakpoint
+
         template = context.createProducerTemplate();
         template.start();
         consumer = context.createConsumerTemplate();
@@ -402,4 +410,46 @@ public abstract class CamelTestSupport e
         System.setProperty(JmxSystemPropertyKeys.DISABLED, "false");
     }
 
+    /**
+     * Single step debugs and Camel invokes this method before entering the given processor
+     *
+     * @param exchange     the exchange
+     * @param processor    the processor about to be invoked
+     * @param definition   the definition for the processor
+     * @param id           the id of the definition
+     * @param shortName    the short name of the definition
+     */
+    protected void debugBefore(Exchange exchange, Processor processor, ProcessorDefinition definition,
+                               String id, String shortName) {
+    }
+
+    /**
+     * Single step debugs and Camel invokes this method after processing the given processor
+     *
+     * @param exchange     the exchange
+     * @param processor    the processor that was invoked
+     * @param definition   the definition for the processor
+     * @param id           the id of the definition
+     * @param shortName    the short name of the definition
+     * @param timeTaken    time taken to process the processor in millis
+     */
+    protected void debugAfter(Exchange exchange, Processor processor, ProcessorDefinition definition,
+                              String id, String shortName, long timeTaken) {
+    }
+
+    /**
+     * To easily debug by overriding the <tt>debugBefore</tt> and <tt>debugAfter</tt> methods.
+     */
+    private class DebugBreakpoint extends BreakpointSupport {
+
+        @Override
+        public void beforeProcess(Exchange exchange, Processor processor, ProcessorDefinition definition) {
+            CamelTestSupport.this.debugBefore(exchange, processor, definition, definition.getId(), definition.getShortName());
+        }
+
+        @Override
+        public void afterProcess(Exchange exchange, Processor processor, ProcessorDefinition definition, long timeTaken) {
+            CamelTestSupport.this.debugAfter(exchange, processor, definition, definition.getId(), definition.getShortName(), timeTaken);
+        }
+    }
 }
\ No newline at end of file

Modified: camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/junit4/CamelTestSupport.java
URL: http://svn.apache.org/viewvc/camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/junit4/CamelTestSupport.java?rev=1028270&r1=1028269&r2=1028270&view=diff
==============================================================================
--- camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/junit4/CamelTestSupport.java (original)
+++ camel/trunk/components/camel-test/src/main/java/org/apache/camel/test/junit4/CamelTestSupport.java Thu Oct 28 12:13:03 2010
@@ -21,7 +21,6 @@ import java.util.Hashtable;
 import java.util.Map;
 import java.util.Properties;
 import java.util.concurrent.TimeUnit;
-
 import javax.naming.Context;
 import javax.naming.InitialContext;
 
@@ -37,9 +36,12 @@ import org.apache.camel.ProducerTemplate
 import org.apache.camel.Service;
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.mock.MockEndpoint;
+import org.apache.camel.impl.BreakpointSupport;
 import org.apache.camel.impl.DefaultCamelContext;
+import org.apache.camel.impl.DefaultDebugger;
 import org.apache.camel.impl.JndiRegistry;
 import org.apache.camel.management.JmxSystemPropertyKeys;
+import org.apache.camel.model.ProcessorDefinition;
 import org.apache.camel.spi.Language;
 import org.apache.camel.spring.CamelBeanPostProcessor;
 import org.junit.After;
@@ -58,6 +60,7 @@ public abstract class CamelTestSupport e
     protected volatile ConsumerTemplate consumer;
     private boolean useRouteBuilder = true;
     private Service camelContextService;
+    private final DebugBreakpoint breakpoint = new DebugBreakpoint();
 
     public boolean isUseRouteBuilder() {
         return useRouteBuilder;
@@ -99,6 +102,11 @@ public abstract class CamelTestSupport e
         // reduce default shutdown timeout to avoid waiting for 300 seconds
         context.getShutdownStrategy().setTimeout(getShutdownTimeout());
 
+        // set debugger
+        context.setDebugger(new DefaultDebugger());
+        context.getDebugger().addBreakpoint(breakpoint);
+        // note: when stopping CamelContext it will automatic remove the breakpoint
+
         template = context.createProducerTemplate();
         template.start();
         consumer = context.createConsumerTemplate();
@@ -402,4 +410,35 @@ public abstract class CamelTestSupport e
     protected void enableJMX() {
         System.setProperty(JmxSystemPropertyKeys.DISABLED, "false");
     }
+
+    /**
+     * Single step debugs and Camel invokes this method before entering the given processor
+     */
+    protected void debugBefore(Exchange exchange, Processor processor, ProcessorDefinition definition,
+                               String id, String label) {
+    }
+
+    /**
+     * Single step debugs and Camel invokes this method after processing the given processor
+     */
+    protected void debugAfter(Exchange exchange, Processor processor, ProcessorDefinition definition,
+                              String id, String label, long timeTaken) {
+    }
+
+    /**
+     * To easily debug by overriding the <tt>debugBefore</tt> and <tt>debugAfter</tt> methods.
+     */
+    private class DebugBreakpoint extends BreakpointSupport {
+
+        @Override
+        public void beforeProcess(Exchange exchange, Processor processor, ProcessorDefinition definition) {
+            CamelTestSupport.this.debugBefore(exchange, processor, definition, definition.getId(), definition.getLabel());
+        }
+
+        @Override
+        public void afterProcess(Exchange exchange, Processor processor, ProcessorDefinition definition, long timeTaken) {
+            CamelTestSupport.this.debugAfter(exchange, processor, definition, definition.getId(), definition.getLabel(), timeTaken);
+        }
+    }
+
 }
\ No newline at end of file

Added: camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugJUnit4Test.java
URL: http://svn.apache.org/viewvc/camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugJUnit4Test.java?rev=1028270&view=auto
==============================================================================
--- camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugJUnit4Test.java (added)
+++ camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugJUnit4Test.java Thu Oct 28 12:13:03 2010
@@ -0,0 +1,83 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.test.patterns;
+
+import org.apache.camel.Exchange;
+import org.apache.camel.Processor;
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.model.ProcessorDefinition;
+import org.apache.camel.test.junit4.CamelTestSupport;
+import org.junit.Test;
+
+/**
+ * @version $Revision$
+ */
+public class DebugJUnit4Test extends CamelTestSupport {
+
+    // START SNIPPET: e1
+    @Override
+    protected void debugBefore(Exchange exchange, Processor processor,
+                               ProcessorDefinition definition, String id, String shortName) {
+        // this method is invoked before we are about to enter the given processor
+        // from your Java editor you can just add a breakpoint in the code line below
+        log.info("Before " + definition + " with body " + exchange.getIn().getBody());
+    }
+    // END SNIPPET: e1
+
+    @Test
+    public void testDebugger() throws Exception {
+        // set mock expectations
+        getMockEndpoint("mock:a").expectedMessageCount(1);
+        getMockEndpoint("mock:b").expectedMessageCount(1);
+
+        // send a message
+        template.sendBody("direct:start", "World");
+
+        // assert mocks
+        assertMockEndpointsSatisfied();
+    }
+
+    @Test
+    public void testTwo() throws Exception {
+        // set mock expectations
+        getMockEndpoint("mock:a").expectedMessageCount(2);
+        getMockEndpoint("mock:b").expectedMessageCount(2);
+
+        // send a message
+        template.sendBody("direct:start", "World");
+        template.sendBody("direct:start", "Camel");
+
+        // assert mocks
+        assertMockEndpointsSatisfied();
+    }
+
+    // START SNIPPET: e2
+    @Override
+    protected RouteBuilder createRouteBuilder() throws Exception {
+        return new RouteBuilder() {
+            @Override
+            public void configure() throws Exception {
+                // this is the route we want to debug
+                from("direct:start")
+                    .to("mock:a")
+                    .transform(body().prepend("Hello "))
+                    .to("mock:b");
+            }
+        };
+    }
+    // END SNIPPET: e2
+}

Added: camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugTest.java
URL: http://svn.apache.org/viewvc/camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugTest.java?rev=1028270&view=auto
==============================================================================
--- camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugTest.java (added)
+++ camel/trunk/components/camel-test/src/test/java/org/apache/camel/test/patterns/DebugTest.java Thu Oct 28 12:13:03 2010
@@ -0,0 +1,80 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.camel.test.patterns;
+
+import org.apache.camel.Exchange;
+import org.apache.camel.Processor;
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.model.ProcessorDefinition;
+import org.apache.camel.test.CamelTestSupport;
+
+/**
+ * @version $Revision$
+ */
+public class DebugTest extends CamelTestSupport {
+
+    // START SNIPPET: e1
+    @Override
+    protected void debugBefore(Exchange exchange, Processor processor,
+                               ProcessorDefinition definition, String id, String shortName) {
+        // this method is invoked before we are about to enter the given processor
+        // from your Java editor you can just add a breakpoint in the code line below
+        log.info("Before " + definition + " with body " + exchange.getIn().getBody());
+    }
+    // END SNIPPET: e1
+
+    public void testDebugger() throws Exception {
+        // set mock expectations
+        getMockEndpoint("mock:a").expectedMessageCount(1);
+        getMockEndpoint("mock:b").expectedMessageCount(1);
+
+        // send a message
+        template.sendBody("direct:start", "World");
+
+        // assert mocks
+        assertMockEndpointsSatisfied();
+    }
+
+    public void testTwo() throws Exception {
+        // set mock expectations
+        getMockEndpoint("mock:a").expectedMessageCount(2);
+        getMockEndpoint("mock:b").expectedMessageCount(2);
+
+        // send a message
+        template.sendBody("direct:start", "World");
+        template.sendBody("direct:start", "Camel");
+
+        // assert mocks
+        assertMockEndpointsSatisfied();
+    }
+
+    // START SNIPPET: e2
+    @Override
+    protected RouteBuilder createRouteBuilder() throws Exception {
+        return new RouteBuilder() {
+            @Override
+            public void configure() throws Exception {
+                // this is the route we want to debug
+                from("direct:start")
+                    .to("mock:a")
+                    .transform(body().prepend("Hello "))
+                    .to("mock:b");
+            }
+        };
+    }
+    // END SNIPPET: e2
+}