feat: make ambiguous oneOf violations configurable

Author: visheshupadhyay

openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/exclusions/InternalViolationExclusions.java

@@ -4,20 +4,31 @@
 import com.getyourguide.openapi.validation.api.exclusions.ViolationExclusions;
 import com.getyourguide.openapi.validation.api.model.Direction;
 import com.getyourguide.openapi.validation.api.model.OpenApiViolation;
-import lombok.AllArgsConstructor;
 
-@AllArgsConstructor
 public class InternalViolationExclusions {
 
     private final ViolationExclusions customViolationExclusions;
+    private final boolean ignoreAmbiguousOneOfViolations;
+
+    public InternalViolationExclusions(ViolationExclusions customViolationExclusions) {
+        this(customViolationExclusions, true);
+    }
+
+    public InternalViolationExclusions(
+        ViolationExclusions customViolationExclusions,
+        boolean ignoreAmbiguousOneOfViolations
+    ) {
+        this.customViolationExclusions = customViolationExclusions;
+        this.ignoreAmbiguousOneOfViolations = ignoreAmbiguousOneOfViolations;
+    }
 
     public boolean isExcluded(OpenApiViolation violation) {
         return falsePositive404(violation)
             || falsePositive405(violation)
             || falsePositive406(violation)
             || falsePositiveRequestWith4xxResponse(violation)
             || customViolationExclusions.isExcluded(violation)
-            || oneOfMatchesMoreThanOneSchema(violation)
+            || (ignoreAmbiguousOneOfViolations && oneOfMatchesMoreThanOneSchema(violation))
             || isConcurrentModificationExceptionInLibrary(violation)
             || isUnhandledUncheckedExecutionExceptionInLibrary(violation);
     }

openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/exclusions/InternalViolationExclusionsTest.java

@@ -58,6 +58,27 @@ public void whenInstanceFailedToMatchExactlyOneThenViolationExcluded() {
             .message("[Path '/v1/endpoint'] Instance failed to match exactly one schema (matched 2 out of 4)").build());
     }
 
+    @Test
+    public void whenAmbiguousOneOfViolationsAreIgnoredThenViolationExcluded() {
+        violationExclusions = new InternalViolationExclusions(customViolationExclusions, true);
+        when(customViolationExclusions.isExcluded(any())).thenReturn(false);
+
+        checkViolationExcluded(OpenApiViolation.builder()
+            .rule("validation.response.body.schema.oneOf")
+            .message("[Path '/v1/endpoint'] Instance failed to match exactly one schema (matched 2 out of 4)").build());
+    }
+
+    @Test
+    public void whenAmbiguousOneOfViolationsAreNotIgnoredThenViolationNotExcluded() {
+        violationExclusions = new InternalViolationExclusions(customViolationExclusions, false);
+        when(customViolationExclusions.isExcluded(any())).thenReturn(false);
+
+        checkViolationNotExcluded(OpenApiViolation.builder()
+            .rule("validation.response.body.schema.oneOf")
+            .message("[Path '/v1/endpoint'] Instance failed to match exactly one schema (matched 2 out of 4)")
+            .build());
+    }
+
     @Test
     public void whenInstanceFailedToMatchExactlyOneWithOneOf24ThenViolationExcluded() {
         when(customViolationExclusions.isExcluded(any())).thenReturn(false);