chore(camel): Fix environment variable setting for Camel JBang process

citrusframework · Nov 13, 2024 · 59d7cb9 · 59d7cb9
1 parent 2efe88a
commit 59d7cb9
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 22 deletions.
diff --git a/connectors/citrus-jbang-connector/src/main/java/org/citrusframework/jbang/JBangSupport.java b/connectors/citrus-jbang-connector/src/main/java/org/citrusframework/jbang/JBangSupport.java
@@ -94,7 +94,7 @@ public static JBangSupport jbang() {
      * Get JBang version.
      */
     public String version() {
-        ProcessAndOutput p = execute(jBang("version"), envVars);
+        ProcessAndOutput p = execute(jBang("version"), null);
         return p.getOutput();
     }
 
@@ -175,7 +175,7 @@ public ProcessAndOutput runAsync(String command, String... args) {
      * Command can be a script file or an app command.
      */
     public ProcessAndOutput runAsync(String command, List<String> args) {
-        return executeAsync(jBang(systemProperties, constructAllArgs(command, args)));
+        return executeAsync(jBang(systemProperties, constructAllArgs(command, args)), envVars);
     }
 
     /**
@@ -193,7 +193,7 @@ public ProcessAndOutput runAsync(String command, File output, String... args) {
      * Redirect the process output to given file.
      */
     public ProcessAndOutput runAsync(String command, File output, List<String> args) {
-        return executeAsync(jBang(systemProperties, constructAllArgs(command, args)), output);
+        return executeAsync(jBang(systemProperties, constructAllArgs(command, args)), output, envVars);
     }
 
     private List<String> constructAllArgs(String command, List<String> args) {
@@ -333,7 +333,7 @@ private static String getSystemPropertyArgs(Map<String, String> systemProperties
 
         return systemProperties.entrySet()
                 .stream()
-                .map(entry -> "-D%s=%s".formatted(entry.getKey(), entry.getValue()))
+                .map(entry -> "-D%s=\"%s\"".formatted(entry.getKey(), entry.getValue()))
                 .collect(Collectors.joining(" ")) + " ";
     }
 
@@ -353,7 +353,7 @@ private static ProcessAndOutput execute(List<String> command, Map<String, String
             ProcessBuilder pBuilder = new ProcessBuilder(command)
                     .redirectErrorStream(true);
 
-            if (envVars != null && !envVars.isEmpty()) {
+            if (envVars != null) {
                 pBuilder.environment().putAll(envVars);
             }
 
@@ -382,13 +382,19 @@ private static ProcessAndOutput execute(List<String> command, Map<String, String
      * Execute JBang command using the process API. Waits for the process to complete and returns the process instance so
      * caller is able to access the exit code and process output.
      * @param command
+     * @param envVars
      * @return
      */
-    private static ProcessAndOutput executeAsync(List<String> command) {
+    private static ProcessAndOutput executeAsync(List<String> command, Map<String, String> envVars) {
         try {
-            Process p = new ProcessBuilder(command)
-                    .redirectErrorStream(true)
-                    .start();
+            ProcessBuilder pBuilder = new ProcessBuilder(command)
+                    .redirectErrorStream(true);
+
+            if (envVars != null) {
+                pBuilder.environment().putAll(envVars);
+            }
+
+            Process p = pBuilder.start();
             return new ProcessAndOutput(p);
         } catch (IOException e) {
             throw new CitrusRuntimeException("Error while executing JBang", e);
@@ -400,15 +406,20 @@ private static ProcessAndOutput executeAsync(List<String> command) {
      * caller is able to access the exit code and process output.
      * @param command
      * @param outputFile
+     * @param envVars
      * @return
      */
-    private static ProcessAndOutput executeAsync(List<String> command, File outputFile) {
+    private static ProcessAndOutput executeAsync(List<String> command, File outputFile, Map<String, String> envVars) {
         try {
-            Process p = new ProcessBuilder(command)
+            ProcessBuilder pBuilder = new ProcessBuilder(command)
                 .redirectErrorStream(true)
-                .redirectOutput(outputFile)
-                .start();
+                .redirectOutput(outputFile);
 
+            if (envVars != null) {
+                pBuilder.environment().putAll(envVars);
+            }
+
+            Process p = pBuilder.start();
             return new ProcessAndOutput(p, outputFile);
         } catch (IOException e) {
             throw new CitrusRuntimeException("Error while executing JBang", e);

diff --git a/...trus-camel/src/main/java/org/citrusframework/camel/actions/CamelRunIntegrationAction.java b/...trus-camel/src/main/java/org/citrusframework/camel/actions/CamelRunIntegrationAction.java
@@ -73,6 +73,7 @@ public class CamelRunIntegrationAction extends AbstractCamelJBangAction {
     private final boolean autoRemoveResources;
 
     private final boolean waitForRunningState;
+    private final boolean dumpIntegrationOutput;
 
     /**
      * Default constructor.
@@ -89,6 +90,7 @@ public CamelRunIntegrationAction(Builder builder) {
         this.systemProperties = builder.systemProperties;
         this.autoRemoveResources = builder.autoRemoveResources;
         this.waitForRunningState = builder.waitForRunningState;
+        this.dumpIntegrationOutput = builder.dumpIntegrationOutput;
     }
 
     @Override
@@ -113,6 +115,7 @@ public void doExecute(TestContext context) {
                 throw new CitrusRuntimeException("Missing Camel integration source code or file");
             }
 
+            camelJBang().dumpIntegrationOutput(dumpIntegrationOutput);
             camelJBang().camelApp().withEnvs(context.resolveDynamicValuesInMap(envVars));
             camelJBang().camelApp().withSystemProperties(context.resolveDynamicValuesInMap(systemProperties));
 
@@ -191,6 +194,7 @@ public static final class Builder extends AbstractCamelJBangAction.Builder<Camel
 
         private boolean autoRemoveResources = CamelJBangSettings.isAutoRemoveResources();
         private boolean waitForRunningState = CamelJBangSettings.isWaitForRunningState();
+        private boolean dumpIntegrationOutput = CamelJBangSettings.isDumpIntegrationOutput();
 
         /**
          * Runs Camel integration from given source code.
@@ -351,6 +355,11 @@ public Builder withSystemProperties(Resource systemPropertiesFile) {
             return this;
         }
 
+        public Builder dumpIntegrationOutput(boolean enabled) {
+            this.dumpIntegrationOutput = enabled;
+            return this;
+        }
+
         public Builder autoRemove(boolean enabled) {
             this.autoRemoveResources = enabled;
             return this;

diff --git a/endpoints/citrus-camel/src/main/java/org/citrusframework/camel/jbang/CamelJBang.java b/endpoints/citrus-camel/src/main/java/org/citrusframework/camel/jbang/CamelJBang.java
@@ -47,6 +47,8 @@ public class CamelJBang {
 
     private final JBangSupport camelApp = JBangSupport.jbang().app(CamelJBangSettings.getCamelApp());
 
+    private boolean dumpIntegrationOutput = CamelJBangSettings.isDumpIntegrationOutput();
+
     /**
      * Prevent direct instantiation.
      */
@@ -117,7 +119,7 @@ public ProcessAndOutput run(String name, String file, List<String> resources, St
         runArgs.add(file);
         runArgs.addAll(resources);
 
-        if (CamelJBangSettings.isCamelDumpIntegrationOutput()) {
+        if (dumpIntegrationOutput) {
             Path workDir = CamelJBangSettings.getWorkDir();
             File outputFile = workDir.resolve(String.format("i-%s-output.txt", name)).toFile();
 
@@ -232,4 +234,9 @@ public List<Map<String, String>> getAll() {
         }
     }
 
+    public CamelJBang dumpIntegrationOutput(boolean enabled) {
+        this.dumpIntegrationOutput = enabled;
+        return this;
+    }
+
 }
diff --git a/endpoints/citrus-camel/src/main/java/org/citrusframework/camel/jbang/CamelJBangSettings.java b/endpoints/citrus-camel/src/main/java/org/citrusframework/camel/jbang/CamelJBangSettings.java
@@ -114,7 +114,7 @@ public static String[] getTrustUrl() {
      * When set to true JBang process output for Camel integrations will be redirected to a file in the current working directory.
      * @return
      */
-    public static boolean isCamelDumpIntegrationOutput() {
+    public static boolean isDumpIntegrationOutput() {
         return Boolean.parseBoolean(System.getProperty(CAMEL_DUMP_INTEGRATION_OUTPUT_PROPERTY,
                 System.getenv(CAMEL_DUMP_INTEGRATION_OUTPUT_ENV) != null ? System.getenv(CAMEL_DUMP_INTEGRATION_OUTPUT_ENV) : CAMEL_DUMP_INTEGRATION_OUTPUT_DEFAULT));
     }

diff --git a/endpoints/citrus-camel/src/test/java/org/citrusframework/camel/integration/CamelJBangIT.java b/endpoints/citrus-camel/src/test/java/org/citrusframework/camel/integration/CamelJBangIT.java
@@ -43,16 +43,18 @@ public void runIntegrationWithSourceCodeIT() {
                       includeMetadata: true
                     steps:
                       - setBody:
-                          simple: "Hello Camel #${header.CamelTimerCounter}"
+                          simple: "{{greeting}} #${header.CamelTimerCounter}"
                       - transform:
                           simple: "${body.toUpperCase()}"
                       - to: "log:info"
-                """));
+                """)
+                .withSystemProperty("greeting", "Hello Camel"));
 
         then(camel().jbang()
                 .verify("hello")
                 .waitForLogMessage("HELLO CAMEL #10"));
     }
+
     @Test
     @CitrusTest(name = "RunIntegration_Resource_IT")
     public void runIntegrationWithResourceIT() {
@@ -62,7 +64,8 @@ public void runIntegrationWithResourceIT() {
 
         when(camel().jbang()
                 .run()
-                .integration(Resources.fromClasspath("route.yaml", CamelJBangIT.class)));
+                .integration(Resources.fromClasspath("route.yaml", CamelJBangIT.class))
+                .withEnv("GREETING", "Hello Camel"));
 
         then(camel().jbang()
                 .verify("route")

diff --git a/endpoints/citrus-camel/src/test/resources/org/citrusframework/camel/integration/route.yaml b/endpoints/citrus-camel/src/test/resources/org/citrusframework/camel/integration/route.yaml
@@ -5,7 +5,7 @@
       includeMetadata: true
     steps:
       - setBody:
-          simple: "Hello Camel #${header.CamelTimerCounter}"
+          simple: "{{greeting}} #${header.CamelTimerCounter}"
       - transform:
           simple: "${body.toUpperCase()}"
       - to: "log:info"
diff --git a/endpoints/citrus-camel/src/test/resources/org/citrusframework/camel/xml/camel-jbang-test.xml b/endpoints/citrus-camel/src/test/resources/org/citrusframework/camel/xml/camel-jbang-test.xml
@@ -24,7 +24,11 @@
       <jbang>
         <run args="--verbose">
           <integration name="hello-xml"
-                       file="classpath:org/citrusframework/camel/integration/route.yaml"/>
+                       file="classpath:org/citrusframework/camel/integration/route.yaml">
+            <system-properties>
+              <property name="greeting" value="Hello Camel"/>
+            </system-properties>
+          </integration>
         </run>
       </jbang>
     </camel>

diff --git a/...ints/citrus-camel/src/test/resources/org/citrusframework/camel/yaml/camel-jbang-test.yaml b/...ints/citrus-camel/src/test/resources/org/citrusframework/camel/yaml/camel-jbang-test.yaml
@@ -10,6 +10,10 @@ actions:
           integration:
             name: "hello-yaml"
             file: "classpath:org/citrusframework/camel/integration/route.yaml"
+            systemProperties:
+              properties:
+                - name: greeting
+                  value: Hello Camel
   - camel:
       jbang:
         verify:

diff --git a/...main/resources/org/citrusframework/schema/xml/testcase/citrus-testcase-4.4.0-SNAPSHOT.xsd b/...main/resources/org/citrusframework/schema/xml/testcase/citrus-testcase-4.4.0-SNAPSHOT.xsd
@@ -1028,7 +1028,7 @@
                               <xs:attribute name="file" type="xs:string"/>
                             </xs:complexType>
                           </xs:element>
-                          <xs:element name="systemProperties" minOccurs="0">
+                          <xs:element name="system-properties" minOccurs="0">
                             <xs:complexType>
                               <xs:sequence>
                                 <xs:element name="property" maxOccurs="unbounded">

diff --git a/...citrus-xml/src/main/resources/org/citrusframework/schema/xml/testcase/citrus-testcase.xsd b/...citrus-xml/src/main/resources/org/citrusframework/schema/xml/testcase/citrus-testcase.xsd
@@ -1028,7 +1028,7 @@
                               <xs:attribute name="file" type="xs:string"/>
                             </xs:complexType>
                           </xs:element>
-                          <xs:element name="systemProperties" minOccurs="0">
+                          <xs:element name="system-properties" minOccurs="0">
                             <xs:complexType>
                               <xs:sequence>
                                 <xs:element name="property" maxOccurs="unbounded">