fix(simulator-spring-boot): indicate simulation failure with http status

citrusframework · May 13, 2024 · 58e39b5 · 58e39b5
1 parent 4e42ef3
commit 58e39b5
Show file tree

Hide file tree

Showing 50 changed files with 530 additions and 449 deletions.
diff --git a/...type-jms/src/main/resources/archetype-resources/src/main/resources/application.properties b/...type-jms/src/main/resources/archetype-resources/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=JMS Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable JMS support
 citrus.simulator.jms.enabled=true

diff --git a/...ype-mail/src/main/resources/archetype-resources/src/main/resources/application.properties b/...ype-mail/src/main/resources/archetype-resources/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=Mail Server Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable Mail endpoint support
 citrus.simulator.endpoint.enabled=true

diff --git a/...ype-rest/src/main/resources/archetype-resources/src/main/resources/application.properties b/...ype-rest/src/main/resources/archetype-resources/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=REST Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable Http REST support
 citrus.simulator.rest.enabled=true

diff --git a/...-swagger/src/main/resources/archetype-resources/src/main/resources/application.properties b/...-swagger/src/main/resources/archetype-resources/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=REST Petstore Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable Http REST support
 citrus.simulator.rest.enabled=true

diff --git a/...etype-ws/src/main/resources/archetype-resources/src/main/resources/application.properties b/...etype-ws/src/main/resources/archetype-resources/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=SOAP Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable SOAP web service support
 citrus.simulator.ws.enabled=true

diff --git a/...ype-wsdl/src/main/resources/archetype-resources/src/main/resources/application.properties b/...ype-wsdl/src/main/resources/archetype-resources/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=SOAP WSDL Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable SOAP web service support
 citrus.simulator.ws.enabled=true

diff --git a/simulator-samples/sample-bank-service/src/main/resources/application.properties b/simulator-samples/sample-bank-service/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=Citrus Bank Simulator
-logging.level.org.citrusframework=INFO
 
 # SSL Configuration for HTTPS endpoint
 server.port=8443

diff --git a/simulator-samples/sample-combined/src/main/resources/application.properties b/simulator-samples/sample-combined/src/main/resources/application.properties
@@ -1,6 +1,5 @@
 info.simulator.name=Combined REST and JMS Simulator
 
-logging.level.org.citrusframework=INFO
 
 # Enable Http REST and JMS support
 citrus.simulator.rest.enabled=true

diff --git a/simulator-samples/sample-jms-fax/src/main/resources/application.properties b/simulator-samples/sample-jms-fax/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=JMS Async Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable JMS support
 citrus.simulator.jms.enabled=true

diff --git a/simulator-samples/sample-jms/src/main/resources/application.properties b/simulator-samples/sample-jms/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=JMS Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable JMS support
 citrus.simulator.jms.enabled=true

diff --git a/simulator-samples/sample-mail/src/main/resources/application.properties b/simulator-samples/sample-mail/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=Mail Server Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable Mail endpoint support
 citrus.simulator.endpoint.enabled=true

diff --git a/...sample-rest/src/main/java/org/citrusframework/simulator/sample/scenario/FailScenario.java b/...sample-rest/src/main/java/org/citrusframework/simulator/sample/scenario/FailScenario.java
@@ -16,33 +16,33 @@
 
 package org.citrusframework.simulator.sample.scenario;
 
-import static org.citrusframework.actions.EchoAction.Builder.echo;
-import static org.citrusframework.actions.FailAction.Builder.fail;
-import static org.citrusframework.dsl.MessageSupport.MessageBodySupport.fromBody;
-
 import org.citrusframework.simulator.scenario.AbstractSimulatorScenario;
 import org.citrusframework.simulator.scenario.Scenario;
 import org.citrusframework.simulator.scenario.ScenarioRunner;
-import org.springframework.http.HttpStatus;
+import org.citrusframework.simulator.scenario.SimulatorScenario;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;
 
+import static org.citrusframework.actions.EchoAction.Builder.echo;
+import static org.citrusframework.actions.FailAction.Builder.fail;
+
 /**
- * @author Christoph Deppisch
+ * This scenario fails expectantly, using the {@link org.citrusframework.actions.FailAction.Builder#fail(String)}
+ * method. From the view point of a {@link SimulatorScenario}, there is nothing wrong with it. It should therefore be
+ * viewed as a "successful simulation".
+ * <p>
+ * In contrary to this, the {@link ThrowScenario} does fail in an "uncontrolled" manner (by throwing an exception at
+ * runtime), therefore results in a "failed simulation".
  */
 @Scenario("Fail")
-@RequestMapping(value = "/services/rest/simulator/fail", method = RequestMethod.POST)
+@RequestMapping(value = "/services/rest/simulator/fail", method = RequestMethod.GET)
 public class FailScenario extends AbstractSimulatorScenario {
 
     @Override
     public void run(ScenarioRunner scenario) {
         scenario.$(scenario.http()
             .receive()
-            .post()
-            .message()
-            .body("<Failure xmlns=\"http://citrusframework.org/schemas/failure\">" +
-                "Fail!" +
-                "</Failure>"));
+            .get());
 
         scenario.$(echo("Careful - I am gonna fail successfully (:"));
 

diff --git a/...ample-rest/src/main/java/org/citrusframework/simulator/sample/scenario/ThrowScenario.java b/...ample-rest/src/main/java/org/citrusframework/simulator/sample/scenario/ThrowScenario.java
@@ -0,0 +1,48 @@
+/*
+ * Copyright 2006-2017 the original author or authors.
+ *
+ * Licensed 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.citrusframework.simulator.sample.scenario;
+
+import org.citrusframework.exceptions.CitrusRuntimeException;
+import org.citrusframework.simulator.scenario.AbstractSimulatorScenario;
+import org.citrusframework.simulator.scenario.Scenario;
+import org.citrusframework.simulator.scenario.ScenarioRunner;
+import org.citrusframework.simulator.scenario.SimulatorScenario;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+
+import static org.citrusframework.actions.EchoAction.Builder.echo;
+
+/**
+ * This scenario fails at runtime, unexpectedly. It must therefore be reported as failed {@link SimulatorScenario}.
+ * <p>
+ * On the other hand, if a simulation fails on purpose, see {@link FailScenario}, it must be a "successful simulation".
+ */
+@Scenario("Throw")
+@RequestMapping(value = "/services/rest/simulator/throw", method = RequestMethod.GET)
+public class ThrowScenario extends AbstractSimulatorScenario {
+
+    @Override
+    public void run(ScenarioRunner scenario) {
+        scenario.$(scenario.http()
+            .receive()
+            .get());
+
+        scenario.$(echo("Careful - I am gonna fail (:"));
+
+        throw new CitrusRuntimeException("Every failure is a step to success.");
+    }
+}
diff --git a/simulator-samples/sample-rest/src/main/resources/application.properties b/simulator-samples/sample-rest/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=REST Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable Http REST support
 citrus.simulator.rest.enabled=true

diff --git a/...ator-samples/sample-rest/src/test/java/org/citrusframework/simulator/SimulatorRestIT.java b/...ator-samples/sample-rest/src/test/java/org/citrusframework/simulator/SimulatorRestIT.java
@@ -227,22 +227,51 @@ public void testInterveningRequest() {
     }
 
     /**
-     * Sends a request to the server expecting it to purposefully fail a simulation.
+     * Sends a request to the server, expecting it to purposefully fail a simulation. The response code must therefore
+     * be {@link HttpStatus#OK}.
+     *
+     * @see org.citrusframework.simulator.sample.scenario.FailScenario
      */
     @CitrusTest
-    public void testFailingSimulation() {
+    public void testSimulationFailingExpectantly() {
         $(http().client(simulatorClient)
             .send()
-            .post("fail")
+            .get("fail"));
+
+        $(http().client(simulatorClient)
+            .receive()
+            .response(HttpStatus.OK));
+    }
+
+    /**
+     * Sends a request to the server, expecting it to execute a simulation. The response should indicate the unexpected
+     * error, returning a {@link HttpStatus#INTERNAL_SERVER_ERROR}.
+     *
+     * @see org.citrusframework.simulator.sample.scenario.ThrowScenario
+     */
+    @CitrusTest
+    public void testSimulationWithUnexpectedError() {
+        $(http().client(simulatorClient)
+            .send()
+            .get("throw")
             .message()
-            .contentType(MediaType.APPLICATION_XML_VALUE)
-            .body("<Failure xmlns=\"http://citrusframework.org/schemas/failure\">" +
-                "Fail!" +
-                "</Failure>"));
+            .accept(MediaType.APPLICATION_JSON_VALUE));
 
         $(http().client(simulatorClient)
             .receive()
-            .response(HttpStatus.OK)); // TODO: Pretty sure this should be HttpStatus.INTERNAL_SERVER_ERROR
+            .response(HttpStatus.INTERNAL_SERVER_ERROR)
+            .message()
+            .body(
+                // language=json
+                """
+                    {
+                      "timestamp":"@ignore@",
+                      "status":555,
+                      "error":"Http Status 555",
+                      "path":"/services/rest/simulator/throw"
+                    }
+                    """
+            ));
     }
 
     @Configuration

diff --git a/simulator-samples/sample-swagger/src/main/resources/application.properties b/simulator-samples/sample-swagger/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=REST Petstore Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable Http REST support
 citrus.simulator.rest.enabled=true

diff --git a/simulator-samples/sample-ws-client/src/main/resources/application.properties b/simulator-samples/sample-ws-client/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=SOAP Client Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable SOAP web service support
 citrus.simulator.ws.client.enabled=true

diff --git a/simulator-samples/sample-ws/src/main/resources/application.properties b/simulator-samples/sample-ws/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=SOAP Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable SOAP web service support
 citrus.simulator.ws.enabled=true

diff --git a/simulator-samples/sample-wsdl/src/main/resources/application.properties b/simulator-samples/sample-wsdl/src/main/resources/application.properties
@@ -1,5 +1,4 @@
 info.simulator.name=SOAP WSDL Simulator
-logging.level.org.citrusframework=INFO
 
 # Enable SOAP web service support
 citrus.simulator.ws.enabled=true

diff --git a/...or-spring-boot/src/main/java/org/citrusframework/simulator/endpoint/ExceptionMessage.java b/...or-spring-boot/src/main/java/org/citrusframework/simulator/endpoint/ExceptionMessage.java
@@ -0,0 +1,17 @@
+package org.citrusframework.simulator.endpoint;
+
+import org.citrusframework.message.DefaultMessage;
+
+public class ExceptionMessage extends DefaultMessage {
+
+    public static final String EXCEPTION_TYPE = "Exception";
+
+    public ExceptionMessage(Throwable e) {
+        super(e);
+    }
+
+    @Override
+    public String getType() {
+        return EXCEPTION_TYPE;
+    }
+}