Support fail on request/response violation (#3)

Author: pboos

README.md

@@ -83,6 +83,8 @@ openapi.validation.sample-rate=1.0
 
 # Custom location of specification file within resources or filesystem.
 openapi.validation.specification-file-path=/tmp/openapi-spec/openapi.json
+# If it is within src/main/resources/folder/my-spec.json use
+openapi.validation.specification-file-path=folder/my-spec.json
 
 # Comma separated list of paths to be excluded from validation. Default is no excluded paths
 openapi.validation.excluded-paths=/_readiness,/_liveness,/_metrics
@@ -98,6 +100,10 @@ openapi.validation.validation-report-metric-name=openapi.violation
 # Add additional tags to be logged with metrics. They should be in the format {KEY}={VALUE},{KEY}={VALUE}
 # Default is no additional tags.
 openapi.validation.validation-report-metric-additional-tags=service=example,team=chk
+
+# Fail requests on request/response violations. Defaults to false.
+openapi.validation.should-fail-on-request-violation=true
+openapi.validation.should-fail-on-response-violation=true
 ```
 
 ### DataDog metrics

openapi-validation-api/src/main/java/com/getyourguide/openapi/validation/api/log/LoggerExtension.java

@@ -4,7 +4,6 @@
 import java.util.Map;
 import lombok.NonNull;
 
-// TODO CHK-8357 can we get rid of this one?
 public interface LoggerExtension {
     Closeable addToLoggingContext(@NonNull Map<String, String> newTags);
 }

openapi-validation-api/src/main/java/com/getyourguide/openapi/validation/api/model/ValidationResult.java

@@ -0,0 +1,3 @@
+package com.getyourguide.openapi.validation.api.model;
+
+public enum ValidationResult { VALID, INVALID, NOT_APPLICABLE }

openapi-validation-api/src/main/java/com/getyourguide/openapi/validation/api/selector/DefaultTrafficSelector.java

@@ -11,10 +11,24 @@ public class DefaultTrafficSelector implements TrafficSelector {
 
     private final double sampleRate;
     private final Set<String> excludedPaths;
+    private final Boolean shouldFailOnRequestViolation;
+    private final Boolean shouldFailOnResponseViolation;
 
     public DefaultTrafficSelector(Double sampleRate, Set<String> excludedPaths) {
+        this(sampleRate, excludedPaths, null, null);
+    }
+
+    public DefaultTrafficSelector(
+        Double sampleRate,
+        Set<String> excludedPaths,
+        Boolean shouldFailOnRequestViolation,
+        Boolean shouldFailOnResponseViolation
+    ) {
         this.sampleRate = sampleRate != null ? sampleRate : SAMPLE_RATE_DEFAULT;
         this.excludedPaths = excludedPaths != null ? excludedPaths : Set.of();
+        this.shouldFailOnRequestViolation = shouldFailOnRequestViolation != null ? shouldFailOnRequestViolation : false;
+        this.shouldFailOnResponseViolation =
+            shouldFailOnResponseViolation != null ? shouldFailOnResponseViolation : false;
     }
 
     @Override
@@ -40,6 +54,16 @@ public boolean canResponseBeValidated(RequestMetaData request, ResponseMetaData
             && isContentTypeSupported(response.getContentType());
     }
 
+    @Override
+    public boolean shouldFailOnRequestViolation(RequestMetaData request) {
+        return shouldFailOnRequestViolation;
+    }
+
+    @Override
+    public boolean shouldFailOnResponseViolation(RequestMetaData request) {
+        return shouldFailOnResponseViolation;
+    }
+
     private boolean isExcludedRequest(RequestMetaData request) {
         return excludedPaths.contains(request.getUri().getPath());
     }

openapi-validation-api/src/main/java/com/getyourguide/openapi/validation/api/selector/TrafficSelector.java

@@ -13,4 +13,12 @@ default boolean canRequestBeValidated(RequestMetaData request) {
     default boolean canResponseBeValidated(RequestMetaData request, ResponseMetaData response) {
         return true;
     }
+
+    default boolean shouldFailOnRequestViolation(RequestMetaData request) {
+        return false;
+    }
+
+    default boolean shouldFailOnResponseViolation(RequestMetaData request) {
+        return false;
+    }
 }

openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/OpenApiRequestValidator.java

@@ -3,9 +3,11 @@
 import com.atlassian.oai.validator.model.Request;
 import com.atlassian.oai.validator.model.SimpleRequest;
 import com.atlassian.oai.validator.model.SimpleResponse;
+import com.atlassian.oai.validator.report.ValidationReport;
 import com.getyourguide.openapi.validation.api.model.Direction;
 import com.getyourguide.openapi.validation.api.model.RequestMetaData;
 import com.getyourguide.openapi.validation.api.model.ResponseMetaData;
+import com.getyourguide.openapi.validation.api.model.ValidationResult;
 import com.getyourguide.openapi.validation.api.model.ValidatorConfiguration;
 import com.getyourguide.openapi.validation.core.validator.OpenApiInteractionValidatorWrapper;
 import java.nio.charset.StandardCharsets;
@@ -39,13 +41,15 @@ public void validateResponseObjectAsync(final RequestMetaData request, ResponseM
         threadPool.execute(() -> validateResponseObject(request, response, responseBody));
     }
 
-    private void validateRequestObject(final RequestMetaData request, String requestBody) {
+    public ValidationResult validateRequestObject(final RequestMetaData request, String requestBody) {
         try {
             var simpleRequest = buildSimpleRequest(request, requestBody);
             var result = validator.validateRequest(simpleRequest);
             validationReportHandler.handleValidationReport(request, Direction.REQUEST, requestBody, result);
+            return buildValidationResult(result);
         } catch (Exception e) {
             log.error("Could not validate request", e);
+            return ValidationResult.NOT_APPLICABLE;
         }
     }
 
@@ -60,7 +64,11 @@ private static SimpleRequest buildSimpleRequest(RequestMetaData request, String
         return requestBuilder.build();
     }
 
-    private void validateResponseObject(final RequestMetaData request, ResponseMetaData response, final String responseBody) {
+    public ValidationResult validateResponseObject(
+        final RequestMetaData request,
+        ResponseMetaData response,
+        final String responseBody
+    ) {
         try {
             var responseBuilder = new SimpleResponse.Builder(response.getStatusCode());
             response.getHeaders().forEach(responseBuilder::withHeader);
@@ -75,8 +83,22 @@ private void validateResponseObject(final RequestMetaData request, ResponseMetaD
                 responseBuilder.build()
             );
             validationReportHandler.handleValidationReport(request, Direction.RESPONSE, responseBody, result);
+            return buildValidationResult(result);
         } catch (Exception e) {
             log.error("Could not validate response", e);
+            return ValidationResult.NOT_APPLICABLE;
         }
     }
+
+    private ValidationResult buildValidationResult(ValidationReport validationReport) {
+        if (validationReport == null) {
+            return ValidationResult.NOT_APPLICABLE;
+        }
+
+        if (validationReport.getMessages().isEmpty()) {
+            return ValidationResult.VALID;
+        }
+
+        return ValidationResult.INVALID;
+    }
 }

spring-boot-starter/spring-boot-starter-core/src/main/java/com/getyourguide/openapi/validation/OpenApiValidationApplicationProperties.java

@@ -27,6 +27,8 @@ public class OpenApiValidationApplicationProperties {
     private String validationReportMetricName;
     private String validationReportMetricAdditionalTags;
     private String excludedPaths;
+    private Boolean shouldFailOnRequestViolation;
+    private Boolean shouldFailOnResponseViolation;
 
     public List<MetricTag> getValidationReportMetricAdditionalTags() {
         if (validationReportMetricAdditionalTags == null) {

spring-boot-starter/spring-boot-starter-core/src/main/java/com/getyourguide/openapi/validation/autoconfigure/FallbackLibraryAutoConfiguration.java

@@ -21,7 +21,12 @@ public class FallbackLibraryAutoConfiguration {
     @Bean
     @ConditionalOnMissingBean
     public TrafficSelector defaultTrafficSelector() {
-        return new DefaultTrafficSelector(properties.getSampleRate(), properties.getExcludedPathsAsSet());
+        return new DefaultTrafficSelector(
+            properties.getSampleRate(),
+            properties.getExcludedPathsAsSet(),
+            properties.getShouldFailOnRequestViolation(),
+            properties.getShouldFailOnResponseViolation()
+        );
     }
 
 }

spring-boot-starter/spring-boot-starter-core/src/main/resources/META-INF/spring-configuration-metadata.json

@@ -29,6 +29,16 @@
       "name": "openapi.validation.validation-report-metric-additional-tags",
       "type": "java.lang.String",
       "description": "Additional tags to be logged with metrics. They should be in the format {KEY}={VALUE},{KEY}={VALUE}. Default is no additional tags."
+    },
+    {
+      "name": "openapi.validation.should-fail-on-request-violation",
+      "type": "java.lang.Boolean",
+      "description": "If set to true the request will fail in case a request violation occurs. Defaults to false."
+    },
+    {
+      "name": "openapi.validation.should-fail-on-response-violation",
+      "type": "java.lang.Boolean",
+      "description": "If set to true the request will fail in case a response violation occurs. Defaults to false."
     }
   ]
 }

spring-boot-starter/spring-boot-starter-core/src/test/java/com/getyourguide/openapi/validation/OpenApiValidationApplicationPropertiesTest.java

@@ -1,6 +1,8 @@
 package com.getyourguide.openapi.validation;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import com.getyourguide.openapi.validation.api.metrics.MetricTag;
 import java.util.List;
@@ -24,7 +26,9 @@ void getters() {
             VALIDATION_REPORT_THROTTLE_WAIT_SECONDS,
             VALIDATION_REPORT_METRIC_NAME,
             VALIDATION_REPORT_METRIC_ADDITONAL_TAGS_STRING,
-            EXCLUDED_PATHS
+            EXCLUDED_PATHS,
+            true,
+            false
         );
 
         assertEquals(SAMPLE_RATE, loggingConfiguration.getSampleRate());
@@ -37,5 +41,7 @@ void getters() {
         );
         assertEquals(EXCLUDED_PATHS, loggingConfiguration.getExcludedPaths());
         assertEquals(Set.of("/_readiness","/_liveness","/_metrics"), loggingConfiguration.getExcludedPathsAsSet());
+        assertTrue(loggingConfiguration.getShouldFailOnRequestViolation());
+        assertFalse(loggingConfiguration.getShouldFailOnResponseViolation());
     }
 }