fix(#1471): Support json output in Camel cmd receive

- Add option to use Json command output to verify message content
- Store received Json message into message store for later reference

Author: christophd

core/citrus-api/src/main/java/org/citrusframework/actions/camel/CamelJBangCmdReceiveActionBuilder.java

@@ -47,6 +47,8 @@ public interface CamelJBangCmdReceiveActionBuilder<T extends TestAction, B exten
 
     B loggingColor(boolean enabled);
 
+    B jsonOutput(boolean enabled);
+
     B grep(String filter);
 
     B since(String duration);

endpoints/citrus-camel/src/main/java/org/citrusframework/camel/actions/CamelCmdReceiveAction.java

@@ -19,13 +19,16 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Optional;
 
 import org.citrusframework.actions.camel.CamelJBangCmdReceiveActionBuilder;
 import org.citrusframework.camel.CamelSettings;
 import org.citrusframework.context.TestContext;
 import org.citrusframework.exceptions.ActionTimeoutException;
 import org.citrusframework.exceptions.CitrusRuntimeException;
 import org.citrusframework.jbang.ProcessAndOutput;
+import org.citrusframework.message.DefaultMessage;
+import org.citrusframework.message.Message;
 import org.citrusframework.util.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -60,6 +63,9 @@ public class CamelCmdReceiveAction extends AbstractCamelJBangAction {
     /** The number of messages from the end to show */
     private final String tail;
 
+    /** Should use Json output and verify */
+    private final boolean jsonOutput;
+
     /** Camel JBang command arguments */
     private final List<String> args;
 
@@ -82,6 +88,7 @@ public CamelCmdReceiveAction(CamelCmdReceiveAction.Builder builder) {
         this.grep = builder.grep;
         this.since = builder.since;
         this.tail = builder.tail;
+        this.jsonOutput = builder.jsonOutput;
         this.maxAttempts = builder.maxAttempts;
         this.delayBetweenAttempts = builder.delayBetweenAttempts;
         this.printLogs = builder.printLogs;
@@ -124,6 +131,12 @@ public void doExecute(TestContext context) {
             commandArgs.add(tail);
         }
 
+        if (jsonOutput) {
+            commandArgs.add("--output=json");
+            commandArgs.add("--compact=false");
+            commandArgs.add("--pretty");
+        }
+
         if (!args.contains("--logging-color") && args.stream().noneMatch(it -> it.startsWith("--logging-color"))) {
             // disable logging colors by default
             commandArgs.add("--logging-color=false");
@@ -155,8 +168,18 @@ public void doExecute(TestContext context) {
                     CAMEL_JBANG_LOG.info(log);
                 }
 
-                if (log.contains("Received Message:")) {
-                    logger.info("Verified Camel received message - All values OK!");
+                boolean verified = false;
+                if (jsonOutput) {
+                    if (log.contains("\"message\": {")) {
+                        verified = true;
+                        storeMessageFromLog(log, context);
+                    }
+                } else if (log.contains("Received Message:")) {
+                    verified = true;
+                }
+
+                if (verified) {
+                    logger.info("Verified Camel receive command - received at least one message matching the criteria - All values OK!");
                     return;
                 }
 
@@ -175,14 +198,35 @@ public void doExecute(TestContext context) {
 
             throw new ActionTimeoutException((maxAttempts * delayBetweenAttempts),
                     new CitrusRuntimeException(String.format("Failed to verify Camel receive command '%s' - " +
-                            "has not received message with matching '%s' after %d attempts", integrationName, grep, maxAttempts)));
+                            "has not received message with matching '%s' after %d attempts", integrationName, Optional.ofNullable(grep).orElse("any message"), maxAttempts)));
         } finally {
             if (pao != null && pao.getProcess().isAlive()) {
                 pao.getProcess().destroy();
             }
         }
     }
 
+    private void storeMessageFromLog(String log, TestContext context) {
+        String[] messages = log.trim().split("^\\s+$");
+        if (messages.length > 0) {
+            // Store last message
+            String message = messages[messages.length - 1];
+            if (!message.startsWith("{") && message.contains("{")) {
+                // Remove plain text content - usually something like 'Waiting for messages ...'
+                message = message.substring(message.indexOf("{"));
+            }
+
+            String messageName = integrationName + ".message";
+            logger.info("Storing last message '{}' received from Camel integration '{}'", messageName, integrationName);
+
+            Message msg = new DefaultMessage(message);
+            context.getMessageStore()
+                    .storeMessage(messageName, msg);
+            context.getMessageStore()
+                    .storeMessage(integrationName + "." + Optional.ofNullable(endpoint).orElse(endpointUri), msg);
+        }
+    }
+
     /**
      * Action builder.
      */
@@ -195,6 +239,7 @@ public static final class Builder extends AbstractCamelJBangAction.Builder<Camel
         private String grep;
         private String since;
         private String tail = "0";
+        private boolean jsonOutput;
         private final List<String> args = new ArrayList<>();
 
         private int maxAttempts = CamelSettings.getMaxAttempts();
@@ -246,6 +291,12 @@ public Builder loggingColor(boolean enabled) {
             return this;
         }
 
+        @Override
+        public Builder jsonOutput(boolean enabled) {
+            this.jsonOutput = enabled;
+            return this;
+        }
+
         @Override
         public Builder grep(String filter) {
             this.grep = filter;

endpoints/citrus-camel/src/main/java/org/citrusframework/camel/xml/Camel.java

@@ -383,6 +383,8 @@ public void setJBang(JBang jbang) {
 
                 builder.loggingColor(jbang.getCmd().getReceive().isLoggingColor());
 
+                builder.jsonOutput(jbang.getCmd().getReceive().isJsonOutput());
+
                 if (jbang.getCmd().getReceive().getSince() != null) {
                     builder.since(jbang.getCmd().getReceive().getSince());
                 }

endpoints/citrus-camel/src/main/java/org/citrusframework/camel/xml/JBang.java

@@ -1180,6 +1180,8 @@ public static class Receive {
             protected String argLine;
             @XmlAttribute(name = "logging-color")
             protected boolean loggingColor;
+            @XmlAttribute(name = "json-output")
+            protected boolean jsonOutput;
             @XmlAttribute(name = "grep")
             protected String grep;
             @XmlAttribute(name = "since")
@@ -1232,6 +1234,14 @@ public boolean isLoggingColor() {
                 return loggingColor;
             }
 
+            public void setJsonOutput(boolean jsonOutput) {
+                this.jsonOutput = jsonOutput;
+            }
+
+            public boolean isJsonOutput() {
+                return jsonOutput;
+            }
+
             public void setGrep(String grep) {
                 this.grep = grep;
             }

endpoints/citrus-camel/src/main/java/org/citrusframework/camel/yaml/JBang.java

@@ -761,6 +761,8 @@ public void setReceive(Receive receive) {
 
             builder.loggingColor(receive.isLoggingColor());
 
+            builder.jsonOutput(receive.isJsonOutput());
+
             if (receive.getSince() != null) {
                 builder.since(receive.getSince());
             }
@@ -905,6 +907,7 @@ public static class Receive {
             protected String uri;
             protected List<String> args;
             protected boolean loggingColor;
+            protected boolean jsonOutput;
 
             protected String grep;
             protected String since;
@@ -964,6 +967,15 @@ public void setLoggingColor(boolean loggingColor) {
                 this.loggingColor = loggingColor;
             }
 
+            public boolean isJsonOutput() {
+                return loggingColor;
+            }
+
+            @SchemaProperty(advanced = true, description = "When enabled action stores messages from json output.", defaultValue = "false")
+            public void setJsonOutput(boolean loggingColor) {
+                this.jsonOutput = jsonOutput;
+            }
+
             public String getGrep() {
                 return grep;
             }