feat(#285): implement validation and refine scenario generation

simulator-samples/sample-swagger/src/main/java/org/citrusframework/simulator/sample/Simulator.java

@@ -21,13 +21,15 @@
 import org.citrusframework.endpoint.adapter.StaticEndpointAdapter;
 import org.citrusframework.http.message.HttpMessage;
 import org.citrusframework.message.Message;
-import org.citrusframework.simulator.scenario.mapper.ScenarioMapper;
-import org.citrusframework.simulator.scenario.mapper.ScenarioMappers;
+import org.citrusframework.openapi.OpenApiRepository;
 import org.citrusframework.simulator.http.HttpRequestAnnotationScenarioMapper;
 import org.citrusframework.simulator.http.HttpRequestPathScenarioMapper;
+import org.citrusframework.simulator.http.HttpResponseActionBuilderProvider;
 import org.citrusframework.simulator.http.HttpScenarioGenerator;
 import org.citrusframework.simulator.http.SimulatorRestAdapter;
 import org.citrusframework.simulator.http.SimulatorRestConfigurationProperties;
+import org.citrusframework.simulator.scenario.mapper.ScenarioMapper;
+import org.citrusframework.simulator.scenario.mapper.ScenarioMappers;
 import org.citrusframework.spi.Resources;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
@@ -47,12 +49,13 @@ public static void main(String[] args) {
     @Override
     public ScenarioMapper scenarioMapper() {
         return ScenarioMappers.of(new HttpRequestPathScenarioMapper(),
-                                  new HttpRequestAnnotationScenarioMapper());
+            new HttpRequestAnnotationScenarioMapper());
     }
 
     @Override
-    public List<String> urlMappings(SimulatorRestConfigurationProperties simulatorRestConfiguration) {
-        return List.of("/petstore/v2/**");
+    public List<String> urlMappings(
+        SimulatorRestConfigurationProperties simulatorRestConfiguration) {
+        return List.of("/petstore/v2/**", "/petstore/api/v3/**", "/pingapi/v1/**");
     }
 
     @Override
@@ -67,8 +70,31 @@ protected Message handleMessageInternal(Message message) {
 
     @Bean
     public static HttpScenarioGenerator scenarioGenerator() {
-        HttpScenarioGenerator generator = new HttpScenarioGenerator(new Resources.ClasspathResource("swagger/petstore-api.json"));
+        HttpScenarioGenerator generator = new HttpScenarioGenerator(
+            new Resources.ClasspathResource("swagger/petstore-api.json"));
         generator.setContextPath("/petstore");
         return generator;
     }
+
+    @Bean
+    public static OpenApiRepository petstoreRepository() {
+        OpenApiRepository openApiRepository = new OpenApiRepository();
+        openApiRepository.setRootContextPath("/petstore");
+        openApiRepository.setLocations(List.of("openapi/*.json"));
+        return openApiRepository;
+    }
+
+    @Bean
+    public static OpenApiRepository pingRepository() {
+        OpenApiRepository openApiRepository = new OpenApiRepository();
+        openApiRepository.setLocations(List.of("openapi/*.yaml"));
+        return openApiRepository;
+    }
+
+    @Bean
+    static HttpResponseActionBuilderProvider httpResponseActionBuilderProvider() {
+        return new SpecificPingResponseMessageBuilder();
+    }
+
+
 }

simulator-samples/sample-swagger/src/main/java/org/citrusframework/simulator/sample/SpecificPingResponseMessageBuilder.java

@@ -0,0 +1,140 @@
+package org.citrusframework.simulator.sample;
+
+import static java.lang.String.format;
+
+import io.apicurio.datamodels.openapi.models.OasOperation;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+import org.apache.commons.lang3.function.TriFunction;
+import org.citrusframework.http.actions.HttpServerResponseActionBuilder;
+import org.citrusframework.http.message.HttpMessage;
+import org.citrusframework.http.message.HttpMessageHeaders;
+import org.citrusframework.message.MessageType;
+import org.citrusframework.openapi.actions.OpenApiActionBuilder;
+import org.citrusframework.openapi.actions.OpenApiServerActionBuilder;
+import org.citrusframework.openapi.actions.OpenApiServerResponseActionBuilder;
+import org.citrusframework.simulator.http.HttpOperationScenario;
+import org.citrusframework.simulator.http.HttpResponseActionBuilderProvider;
+import org.citrusframework.simulator.scenario.ScenarioRunner;
+import org.citrusframework.simulator.scenario.SimulatorScenario;
+import org.springframework.http.MediaType;
+
+/**
+ * {@link HttpResponseActionBuilderProvider} that provides specific responses for dedicated ping
+ * calls. Shows, how to use a {@link HttpResponseActionBuilderProvider} to control the random
+ * message generation.
+ */
+public class SpecificPingResponseMessageBuilder implements HttpResponseActionBuilderProvider {
+
+    private static final int MISSING_ID = Integer.MIN_VALUE;
+
+    /**
+     * Function that returns null to indicate, that the provider does not provide a builder for the given scenario.
+     */
+    private static final TriFunction<OpenApiServerActionBuilder, OasOperation, HttpMessage, HttpServerResponseActionBuilder> NULL_RESPONSE = SpecificPingResponseMessageBuilder::createNull;
+
+    /**
+     * Map to store specific functions per ping id.
+     */
+    private static final Map<Integer, TriFunction<OpenApiServerActionBuilder, OasOperation, HttpMessage, HttpServerResponseActionBuilder>> SPECIFC_BUILDER_MAP = new HashMap<>();
+
+    // Specific responses for some ids, all others will be handled by returning null and letting the random generator do its work.
+    static {
+        SPECIFC_BUILDER_MAP.put(15000,
+            SpecificPingResponseMessageBuilder::createResponseWithDedicatedRequiredHeader);
+        SPECIFC_BUILDER_MAP.put(10000,
+            SpecificPingResponseMessageBuilder::createResponseWithMessageAndHeaders);
+        SPECIFC_BUILDER_MAP.put(5000, SpecificPingResponseMessageBuilder::createResponseWithSpecificBody);
+        SPECIFC_BUILDER_MAP.put(4000,
+            SpecificPingResponseMessageBuilder::createResponseWithRandomGenerationSuppressed);
+    }
+
+    @Override
+    public HttpServerResponseActionBuilder provideHttpServerResponseActionBuilder(
+        ScenarioRunner scenarioRunner, SimulatorScenario simulatorScenario,
+        HttpMessage receivedMessage) {
+
+        if (!(simulatorScenario instanceof HttpOperationScenario httpOperationScenario)) {
+            return null;
+        }
+
+        OpenApiServerActionBuilder openApiServerActionBuilder = new OpenApiActionBuilder(
+            httpOperationScenario.getOpenApiSpecification()).server(scenarioRunner.getScenarioEndpoint());
+
+        return SPECIFC_BUILDER_MAP.getOrDefault(getIdFromPingRequest(receivedMessage), NULL_RESPONSE).apply(openApiServerActionBuilder, httpOperationScenario.getOperation(), receivedMessage);
+    }
+
+    private static Integer getIdFromPingRequest(HttpMessage httpMessage) {
+        String uri = httpMessage.getUri();
+        Pattern pattern = Pattern.compile("/pingapi/v1/ping/(\\d*)");
+        Matcher matcher = pattern.matcher(uri);
+        if (matcher.matches()) {
+            return Integer.parseInt(matcher.group(1));
+        }
+        return MISSING_ID;
+    }
+
+    /**
+     * Sample to prove, that random data generation can be suppressed. Note that the generated
+     * response is thus invalid and will result in an error.
+     */
+    private static OpenApiServerResponseActionBuilder createResponseWithRandomGenerationSuppressed(
+        OpenApiServerActionBuilder openApiServerActionBuilder, OasOperation oasOperation,
+        HttpMessage receivedMessage) {
+        OpenApiServerResponseActionBuilder sendMessageBuilder = openApiServerActionBuilder.send(
+            oasOperation.operationId, "200").enableRandomGeneration(false);
+        sendMessageBuilder.message().body(format("{\"id\": %d, \"pingTime\": %d}",
+            getIdFromPingRequest(receivedMessage), System.currentTimeMillis()));
+        return sendMessageBuilder;
+    }
+
+    /**
+     * Sample to prove, that the body content can be controlled, while headers will be generated by
+     * random generator.
+     */
+    private static OpenApiServerResponseActionBuilder createResponseWithSpecificBody(
+        OpenApiServerActionBuilder openApiServerActionBuilder, OasOperation oasOperation,
+        HttpMessage receivedMessage) {
+        OpenApiServerResponseActionBuilder sendMessageBuilder = openApiServerActionBuilder.send(
+            oasOperation.operationId, "200");
+        sendMessageBuilder.message().body(format("{\"id\": %d, \"pingCount\": %d}",
+            getIdFromPingRequest(receivedMessage), System.currentTimeMillis()));
+        return sendMessageBuilder;
+    }
+
+    /**
+     * Sample to prove, that the status, response and headers can be controlled and are not
+     * overwritten by random generator.
+     */
+    private static OpenApiServerResponseActionBuilder createResponseWithMessageAndHeaders(
+        OpenApiServerActionBuilder openApiServerActionBuilder, OasOperation oasOperation,
+        HttpMessage receivedMessage) {
+        OpenApiServerResponseActionBuilder sendMessageBuilder = openApiServerActionBuilder.send(
+            oasOperation.operationId, "400", receivedMessage.getAccept());
+        sendMessageBuilder.message().type(MessageType.PLAINTEXT)
+            .header(HttpMessageHeaders.HTTP_CONTENT_TYPE, MediaType.TEXT_PLAIN_VALUE)
+            .header("Ping-Time", "1").body("Requests with id == 10000 cannot be processed!");
+        return sendMessageBuilder;
+    }
+
+    /**
+     * Sample to prove, that a preset header can be controlled, while generating a valid random
+     * response.
+     */
+    private static OpenApiServerResponseActionBuilder createResponseWithDedicatedRequiredHeader(
+        OpenApiServerActionBuilder openApiServerActionBuilder, OasOperation oasOperation,
+        HttpMessage receivedMessage) {
+        OpenApiServerResponseActionBuilder sendMessageBuilder = openApiServerActionBuilder.send(
+            oasOperation.operationId, "200", receivedMessage.getAccept());
+        sendMessageBuilder.message().header("Ping-Time", "0");
+        return sendMessageBuilder;
+    }
+
+    private static OpenApiServerResponseActionBuilder createNull(
+        OpenApiServerActionBuilder ignoreOpenApiServerActionBuilder,
+        OasOperation ignoreOasOperation, HttpMessage ignoreReceivedMessage) {
+        return null;
+    }
+}

simulator-samples/sample-swagger/src/main/resources/openapi/README.md

@@ -0,0 +1,2 @@
+Note, that the petstore-v3.json has been slightly modified from its original version. 
+OK messages have been added, where missing, to be able to activate the response validation feature.