From 0adbcf752f3f90df6c2d3fa4e79b632dfb30d81b Mon Sep 17 00:00:00 2001 From: Patrick Boos Date: Fri, 22 Sep 2023 11:08:47 +0200 Subject: [PATCH 1/3] Improve logging when there is no validator found for a path --- .../MultipleSpecOpenApiInteractionValidatorWrapper.java | 6 +++--- .../MultipleSpecOpenApiInteractionValidatorWrapperTest.java | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapper.java b/openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapper.java index d5ef5049..b35a25ae 100644 --- a/openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapper.java +++ b/openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapper.java @@ -12,7 +12,7 @@ import org.apache.commons.lang3.tuple.Pair; public class MultipleSpecOpenApiInteractionValidatorWrapper implements OpenApiInteractionValidatorWrapper { - public static final String MESSAGE_KEY_VALIDATOR_FOUND = "zopenapi-validator-java.noValidatorFound"; + public static final String MESSAGE_KEY_NO_VALIDATOR_FOUND = "openapi-validator-java.noValidatorFound"; private final List> validators; public MultipleSpecOpenApiInteractionValidatorWrapper( @@ -49,8 +49,8 @@ private Optional getValidatorForPath(String private static SimpleMessage buildNoValidatorFoundMessage(String path) { return new SimpleMessage( - MESSAGE_KEY_VALIDATOR_FOUND, - "No validator found for path: " + path, + MESSAGE_KEY_NO_VALIDATOR_FOUND, + "No validator found in ValidatorConfiguration for path: " + path, ValidationReport.Level.WARN ); } diff --git a/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java b/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java index 53eb5b49..564ce855 100644 --- a/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java +++ b/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java @@ -1,6 +1,6 @@ package com.getyourguide.openapi.validation.core.validator; -import static com.getyourguide.openapi.validation.core.validator.MultipleSpecOpenApiInteractionValidatorWrapper.MESSAGE_KEY_VALIDATOR_FOUND; +import static com.getyourguide.openapi.validation.core.validator.MultipleSpecOpenApiInteractionValidatorWrapper.MESSAGE_KEY_NO_VALIDATOR_FOUND; import static org.junit.jupiter.api.Assertions.assertEquals; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; @@ -52,7 +52,7 @@ public void testReturnsViolationWhenNoMatchingValidatorFound() { var messages = report.getMessages(); assertEquals(1, messages.size()); var message = messages.get(0); - assertEquals(MESSAGE_KEY_VALIDATOR_FOUND, message.getKey()); + assertEquals(MESSAGE_KEY_NO_VALIDATOR_FOUND, message.getKey()); assertEquals("No validator found for path: /123", message.getMessage()); } From aca93f5627952910f2c12638be43968f97230470 Mon Sep 17 00:00:00 2001 From: Patrick Boos Date: Fri, 22 Sep 2023 11:15:43 +0200 Subject: [PATCH 2/3] Update test --- .../MultipleSpecOpenApiInteractionValidatorWrapperTest.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java b/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java index 564ce855..a457ad19 100644 --- a/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java +++ b/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java @@ -53,7 +53,7 @@ public void testReturnsViolationWhenNoMatchingValidatorFound() { assertEquals(1, messages.size()); var message = messages.get(0); assertEquals(MESSAGE_KEY_NO_VALIDATOR_FOUND, message.getKey()); - assertEquals("No validator found for path: /123", message.getMessage()); + assertEquals("No validator found in ValidatorConfiguration for path: /123", message.getMessage()); } private static MockValidatorResult mockValidator() { From b83dba78b4c907f3536a76aa79e10e527c7a8a99 Mon Sep 17 00:00:00 2001 From: Patrick Boos Date: Fri, 22 Sep 2023 11:54:09 +0200 Subject: [PATCH 3/3] Update message --- .../MultipleSpecOpenApiInteractionValidatorWrapper.java | 2 +- .../MultipleSpecOpenApiInteractionValidatorWrapperTest.java | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapper.java b/openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapper.java index b35a25ae..8ba1a493 100644 --- a/openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapper.java +++ b/openapi-validation-core/src/main/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapper.java @@ -50,7 +50,7 @@ private Optional getValidatorForPath(String private static SimpleMessage buildNoValidatorFoundMessage(String path) { return new SimpleMessage( MESSAGE_KEY_NO_VALIDATOR_FOUND, - "No validator found in ValidatorConfiguration for path: " + path, + "ValidatorConfiguration has no spec file matching path: " + path, ValidationReport.Level.WARN ); } diff --git a/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java b/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java index a457ad19..1ee1354c 100644 --- a/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java +++ b/openapi-validation-core/src/test/java/com/getyourguide/openapi/validation/core/validator/MultipleSpecOpenApiInteractionValidatorWrapperTest.java @@ -53,7 +53,7 @@ public void testReturnsViolationWhenNoMatchingValidatorFound() { assertEquals(1, messages.size()); var message = messages.get(0); assertEquals(MESSAGE_KEY_NO_VALIDATOR_FOUND, message.getKey()); - assertEquals("No validator found in ValidatorConfiguration for path: /123", message.getMessage()); + assertEquals("ValidatorConfiguration has no spec file matching path: /123", message.getMessage()); } private static MockValidatorResult mockValidator() {