CAMEL-22549: Add tests, update existing tests, and document upgrade guide

gnodet · claude · gnodet · commit 77f8d969a265 · 2026-04-08T18:26:45.000+02:00
Add 9 unit tests for ExchangeHelper response utilities (hasResponse,
getResponse, setResponse, createResponse, createResponseFromInput).
Update 13 test files to remove incidental deprecated API usage.
Add upgrade guide entry documenting the new utilities.

Co-Authored-By: Claude Opus 4.6 &lt;noreply@anthropic.com&gt;
diff --git a/core/camel-core/src/test/java/org/apache/camel/component/seda/SedaWaitForTaskAsPropertyTest.java b/core/camel-core/src/test/java/org/apache/camel/component/seda/SedaWaitForTaskAsPropertyTest.java
@@ -22,10 +22,11 @@
 import org.apache.camel.Processor;
 import org.apache.camel.WaitForTaskToComplete;
 import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 
 public class SedaWaitForTaskAsPropertyTest extends ContextTestSupport {
 
@@ -59,7 +60,7 @@ public void process(Exchange exchange) {
         // we do not expecy a reply and thus do no wait so we just get our own
         // input back
         assertEquals("Hello World", out.getIn().getBody());
-        assertNull(out.getOut().getBody());
+        assertFalse(ExchangeHelper.hasResponse(out));
 
         assertMockEndpointsSatisfied();
     }
diff --git a/core/camel-core/src/test/java/org/apache/camel/component/seda/SedaWaitForTaskIfReplyExpectedTest.java b/core/camel-core/src/test/java/org/apache/camel/component/seda/SedaWaitForTaskIfReplyExpectedTest.java
@@ -21,10 +21,11 @@
 import org.apache.camel.ExchangePattern;
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 
 public class SedaWaitForTaskIfReplyExpectedTest extends ContextTestSupport {
 
@@ -51,7 +52,7 @@ public void process(Exchange exchange) {
         // we do not expecy a reply and thus do no wait so we just get our own
         // input back
         assertEquals("Hello World", out.getIn().getBody());
-        assertNull(out.getOut().getBody());
+        assertFalse(ExchangeHelper.hasResponse(out));
 
         assertMockEndpointsSatisfied();
     }
diff --git a/core/camel-core/src/test/java/org/apache/camel/component/seda/SedaWaitForTaskNewerTest.java b/core/camel-core/src/test/java/org/apache/camel/component/seda/SedaWaitForTaskNewerTest.java
@@ -21,10 +21,11 @@
 import org.apache.camel.ExchangePattern;
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 
 public class SedaWaitForTaskNewerTest extends ContextTestSupport {
 
@@ -51,7 +52,7 @@ public void process(Exchange exchange) {
         });
         // we do not wait for the response so we just get our own input back
         assertEquals("Hello World", out.getIn().getBody());
-        assertNull(out.getOut().getBody());
+        assertFalse(ExchangeHelper.hasResponse(out));
 
         assertMockEndpointsSatisfied();
     }
diff --git a/core/camel-core/src/test/java/org/apache/camel/issues/SplitStopOnExceptionIssueTest.java b/core/camel-core/src/test/java/org/apache/camel/issues/SplitStopOnExceptionIssueTest.java
@@ -20,6 +20,7 @@
 import org.apache.camel.Exchange;
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -41,7 +42,7 @@ public void process(Exchange exchange) {
         });
         assertNotNull(out);
         assertTrue(out.isFailed());
-        assertFalse(out.hasOut());
+        assertFalse(ExchangeHelper.hasResponse(out));
 
         // when we use stopOnException the exchange should not be affected
         // during the splitter
diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/MulticastRedeliverTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/MulticastRedeliverTest.java
@@ -21,6 +21,7 @@
 import org.apache.camel.Exchange;
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -99,7 +100,7 @@ public void configure() {
                     public void process(Exchange exchange) {
                         // should be same input body
                         assertEquals("Hello World", exchange.getIn().getBody());
-                        assertFalse(exchange.hasOut(), "Should not have OUT");
+                        assertFalse(ExchangeHelper.hasResponse(exchange), "Should not have OUT");
                         assertNull(exchange.getException());
 
                         counter++;
@@ -112,7 +113,7 @@ public void process(Exchange exchange) {
                     public void process(Exchange exchange) {
                         // should be same input body
                         assertEquals("Hello World", exchange.getIn().getBody());
-                        assertFalse(exchange.hasOut(), "Should not have OUT");
+                        assertFalse(ExchangeHelper.hasResponse(exchange), "Should not have OUT");
                         assertNull(exchange.getException());
 
                         // mutate OUT body
diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/ProcessorMutateExchangeRedeliverTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/ProcessorMutateExchangeRedeliverTest.java
@@ -21,6 +21,7 @@
 import org.apache.camel.Exchange;
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -79,7 +80,7 @@ public void configure() {
                     public void process(Exchange exchange) {
                         // should be same input body
                         assertEquals("Hello World", exchange.getIn().getBody());
-                        assertFalse(exchange.hasOut(), "Should not have OUT");
+                        assertFalse(ExchangeHelper.hasResponse(exchange), "Should not have OUT");
                         assertNull(exchange.getException());
 
                         // mutate IN body
@@ -95,7 +96,7 @@ public void process(Exchange exchange) {
                     public void process(Exchange exchange) {
                         // should be same input body
                         assertEquals("Hello World", exchange.getIn().getBody());
-                        assertFalse(exchange.hasOut(), "Should not have OUT");
+                        assertFalse(ExchangeHelper.hasResponse(exchange), "Should not have OUT");
                         assertNull(exchange.getException());
 
                         // mutate OUT body
diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/RecipientListRedeliverTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/RecipientListRedeliverTest.java
@@ -21,6 +21,7 @@
 import org.apache.camel.Exchange;
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -95,7 +96,7 @@ public void configure() {
                     public void process(Exchange exchange) {
                         // should be same input body
                         assertEquals("Hello World", exchange.getIn().getBody());
-                        assertFalse(exchange.hasOut(), "Should not have OUT");
+                        assertFalse(ExchangeHelper.hasResponse(exchange), "Should not have OUT");
                         assertNull(exchange.getException());
 
                         counter++;
@@ -108,7 +109,7 @@ public void process(Exchange exchange) {
                     public void process(Exchange exchange) {
                         // should be same input body
                         assertEquals("Hello World", exchange.getIn().getBody());
-                        assertFalse(exchange.hasOut(), "Should not have OUT");
+                        assertFalse(ExchangeHelper.hasResponse(exchange), "Should not have OUT");
                         assertNull(exchange.getException());
 
                         // mutate IN body
diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/RoutingSlipRedeliverTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/RoutingSlipRedeliverTest.java
@@ -21,6 +21,7 @@
 import org.apache.camel.Exchange;
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -98,7 +99,7 @@ public void configure() {
                     public void process(Exchange exchange) {
                         // should be same input body
                         assertEquals("Hello World", exchange.getIn().getBody());
-                        assertFalse(exchange.hasOut(), "Should not have OUT");
+                        assertFalse(ExchangeHelper.hasResponse(exchange), "Should not have OUT");
                         assertNull(exchange.getException());
 
                         counter++;
@@ -111,7 +112,7 @@ public void process(Exchange exchange) {
                     public void process(Exchange exchange) {
                         // should be same input body
                         assertEquals("Hello World", exchange.getIn().getBody());
-                        assertFalse(exchange.hasOut(), "Should not have OUT");
+                        assertFalse(ExchangeHelper.hasResponse(exchange), "Should not have OUT");
                         assertNull(exchange.getException());
 
                         // mutate IN body
diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/SimpleSingleOutputMockTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/SimpleSingleOutputMockTest.java
@@ -35,7 +35,6 @@ public void testSimple() throws Exception {
         Exchange out = template.request("direct:start", e -> e.getMessage().setBody("Hello World"));
         assertNotNull(out);
         assertEquals(ExchangePattern.InOut, out.getPattern());
-        assertTrue(out.hasOut());
 
         assertMockEndpointsSatisfied();
     }
diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/SplitterTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/SplitterTest.java
@@ -33,6 +33,7 @@
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.mock.MockEndpoint;
 import org.apache.camel.processor.aggregate.UseLatestAggregationStrategy;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.*;
@@ -101,7 +102,7 @@ public void process(Exchange exchange) {
             }
         });
 
-        assertFalse(result.hasOut(), "Should not have out");
+        assertFalse(ExchangeHelper.hasResponse(result), "Should not have out");
     }
 
     @Test
diff --git a/core/camel-core/src/test/java/org/apache/camel/processor/enricher/EnricherTest.java b/core/camel-core/src/test/java/org/apache/camel/processor/enricher/EnricherTest.java
@@ -22,6 +22,7 @@
 import org.apache.camel.Processor;
 import org.apache.camel.builder.RouteBuilder;
 import org.apache.camel.component.mock.MockEndpoint;
+import org.apache.camel.support.ExchangeHelper;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
@@ -63,7 +64,7 @@ public void process(Exchange exchange) {
         mock.assertIsSatisfied();
         assertEquals("test", exchange.getIn().getBody());
         assertEquals("failed", exchange.getException().getMessage());
-        assertFalse(exchange.hasOut());
+        assertFalse(ExchangeHelper.hasResponse(exchange));
     }
 
     // -------------------------------------------------------------
@@ -86,7 +87,7 @@ public void process(Exchange exchange) {
         });
         assertEquals("bar", exchange.getIn().getHeader("foo"));
         assertEquals("test:blah", exchange.getIn().getBody());
-        assertTrue(exchange.hasOut());
+        assertTrue(ExchangeHelper.hasResponse(exchange));
         assertNull(exchange.getException());
     }
 
@@ -99,7 +100,7 @@ public void process(Exchange exchange) {
         });
         assertEquals("test", exchange.getIn().getBody());
         assertEquals("failed", exchange.getException().getMessage());
-        assertFalse(exchange.hasOut());
+        assertFalse(ExchangeHelper.hasResponse(exchange));
     }
 
     @Override
diff --git a/core/camel-core/src/test/java/org/apache/camel/util/ExchangeHelperTest.java b/core/camel-core/src/test/java/org/apache/camel/util/ExchangeHelperTest.java
@@ -23,6 +23,7 @@
 import org.apache.camel.ContextTestSupport;
 import org.apache.camel.Exchange;
 import org.apache.camel.ExchangePattern;
+import org.apache.camel.Message;
 import org.apache.camel.NoSuchBeanException;
 import org.apache.camel.NoSuchHeaderException;
 import org.apache.camel.NoSuchPropertyException;
@@ -191,7 +192,7 @@ public void testCreateVariableMapNoExistingOut() {
         exchange.setPattern(ExchangePattern.InOut);
         exchange.getIn().setBody("bar");
         exchange.getIn().setHeader("quote", "Camel rocks");
-        assertFalse(exchange.hasOut());
+        assertFalse(ExchangeHelper.hasResponse(exchange));
 
         Map<?, ?> map = ExchangeHelper.createVariableMap(exchange, true);
 
@@ -210,7 +211,7 @@ public void testCreateVariableMapNoExistingOut() {
 
         // but the Exchange does still not have an OUT message to avoid
         // causing side effects with the createVariableMap method
-        assertFalse(exchange.hasOut());
+        assertFalse(ExchangeHelper.hasResponse(exchange));
     }
 
     @Test
@@ -249,6 +250,76 @@ public void testGetBodyAndResetStreamCache() {
         assertNull(third);
     }
 
+    @Test
+    public void testHasResponseNoOut() {
+        assertFalse(ExchangeHelper.hasResponse(exchange));
+    }
+
+    @SuppressWarnings("deprecation")
+    @Test
+    public void testHasResponseWithOut() {
+        exchange.setOut(exchange.getIn().copy());
+        assertTrue(ExchangeHelper.hasResponse(exchange));
+    }
+
+    @Test
+    public void testGetResponseNoOut() {
+        assertNull(ExchangeHelper.getResponse(exchange));
+    }
+
+    @SuppressWarnings("deprecation")
+    @Test
+    public void testGetResponseWithOut() {
+        exchange.setOut(exchange.getIn().copy());
+        assertNotNull(ExchangeHelper.getResponse(exchange));
+        assertSame(exchange.getMessage(), ExchangeHelper.getResponse(exchange));
+    }
+
+    @Test
+    public void testSetResponseCreatesOut() {
+        assertFalse(ExchangeHelper.hasResponse(exchange));
+        ExchangeHelper.setResponse(exchange, exchange.getIn().copy());
+        assertTrue(ExchangeHelper.hasResponse(exchange));
+    }
+
+    @Test
+    public void testSetResponseNullClearsOut() {
+        ExchangeHelper.setResponse(exchange, exchange.getIn().copy());
+        assertTrue(ExchangeHelper.hasResponse(exchange));
+        ExchangeHelper.setResponse(exchange, null);
+        assertFalse(ExchangeHelper.hasResponse(exchange));
+    }
+
+    @Test
+    public void testGetResponseDoesNotCreateOut() {
+        // unlike getOut(), getResponse() must NOT lazily create a message
+        assertNull(ExchangeHelper.getResponse(exchange));
+        assertFalse(ExchangeHelper.hasResponse(exchange));
+    }
+
+    @Test
+    public void testCreateResponse() {
+        assertFalse(ExchangeHelper.hasResponse(exchange));
+        Message response = ExchangeHelper.createResponse(exchange);
+        assertNotNull(response);
+        assertTrue(ExchangeHelper.hasResponse(exchange));
+        assertSame(response, exchange.getMessage());
+        assertNull(response.getBody());
+    }
+
+    @Test
+    public void testCreateResponseFromInput() {
+        exchange.getIn().setBody("hello");
+        exchange.getIn().setHeader("myHeader", "myValue");
+        assertFalse(ExchangeHelper.hasResponse(exchange));
+        Message response = ExchangeHelper.createResponseFromInput(exchange);
+        assertNotNull(response);
+        assertTrue(ExchangeHelper.hasResponse(exchange));
+        assertSame(response, exchange.getMessage());
+        assertEquals("hello", response.getBody());
+        assertEquals("myValue", response.getHeader("myHeader"));
+    }
+
     @Override
     @BeforeEach
     public void setUp() throws Exception {
diff --git a/core/camel-core/src/test/java/org/apache/camel/util/MessageHelperTest.java b/core/camel-core/src/test/java/org/apache/camel/util/MessageHelperTest.java
@@ -139,7 +139,7 @@ public void testCopyHeadersWithHeaderFilterStrategy() {
         message = new DefaultExchange(context).getIn();
 
         Message source = message;
-        Message target = message.getExchange().getOut();
+        Message target = new DefaultMessage(context);
 
         DefaultHeaderFilterStrategy headerFilterStrategy = new DefaultHeaderFilterStrategy();
         headerFilterStrategy.setInFilterPattern("foo");
diff --git a/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_19.adoc b/docs/user-manual/modules/ROOT/pages/camel-4x-upgrade-guide-4_19.adoc
@@ -40,6 +40,23 @@ is backward-compatible with peers that do not support PQC.
 
 See xref:camel-configuration-utilities.adoc[JSSE Utility] for full details on PQC TLS configuration.
 
+==== Exchange getOut/hasOut/setOut deprecation migration
+
+The deprecated `Exchange.getOut()`, `hasOut()`, and `setOut()` methods have been replaced throughout
+the codebase with `Exchange.getMessage()` and five new utility methods in `ExchangeHelper`:
+
+- `ExchangeHelper.hasResponse(exchange)` -- checks if a response (OUT) message exists, without side effects.
+- `ExchangeHelper.getResponse(exchange)` -- returns the response message, or `null` if none exists.
+  Unlike `getOut()`, this does *not* lazily create an empty message.
+- `ExchangeHelper.setResponse(exchange, message)` -- explicitly sets or clears the response message.
+- `ExchangeHelper.createResponse(exchange)` -- creates a new empty response message and returns it.
+  This is the non-deprecated equivalent of the lazy-creation side effect of `getOut()`.
+- `ExchangeHelper.createResponseFromInput(exchange)` -- creates a response by copying the input message
+  (headers, body, attachments) and returns it. Use this when the response should inherit the input message's headers.
+
+Component developers who currently use `getOut()`, `hasOut()`, or `setOut()` should migrate to these utilities.
+A follow-up change will add these methods directly to the `Exchange` interface.
+
 The WireTap EIP has removed the `pattern` option from its model (not in use) as wiretap always
 uses `InOnly` pattern.
 

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,6 @@ public void testSimple() throws Exception {`
`35`	`35`	`Exchange out = template.request("direct:start", e -> e.getMessage().setBody("Hello World"));`
`36`	`36`	`assertNotNull(out);`
`37`	`37`	`assertEquals(ExchangePattern.InOut, out.getPattern());`
`38`		`- assertTrue(out.hasOut());`
`39`	`38`
`40`	`39`	`assertMockEndpointsSatisfied();`
`41`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,7 @@`
`33`	`33`	`import org.apache.camel.builder.RouteBuilder;`
`34`	`34`	`import org.apache.camel.component.mock.MockEndpoint;`
`35`	`35`	`import org.apache.camel.processor.aggregate.UseLatestAggregationStrategy;`
	`36`	`+import org.apache.camel.support.ExchangeHelper;`
`36`	`37`	`import org.junit.jupiter.api.Test;`
`37`	`38`
`38`	`39`	`import static org.junit.jupiter.api.Assertions.*;`
`@@ -101,7 +102,7 @@ public void process(Exchange exchange) {`
`101`	`102`	`}`
`102`	`103`	`});`
`103`	`104`
`104`		`- assertFalse(result.hasOut(), "Should not have out");`
	`105`	`+ assertFalse(ExchangeHelper.hasResponse(result), "Should not have out");`
`105`	`106`	`}`
`106`	`107`
`107`	`108`	`@Test`