Merge pull request #765 from CJSCommonPlatform/add-blacklisting-of-commands

Allow contexts to be able to blacklist the handling of certain commands

Author: mapingo

CHANGELOG.md

@@ -3,9 +3,12 @@ All notable changes to this project will be documented in this file, which follo
 on [Keep a CHANGELOG](http://keepachangelog.com/). This project adheres to
 [Semantic Versioning](http://semver.org/).
 
-
 ## [Unreleased]
 
+## [6.0.10] - 2018-08-28
+### Added
+- JMX SystemCommands can now be disabled for a context
+
 ## [6.0.9] - 2018-08-21
 ### Fixed
 - JsonSchemaValidationMatcher now supports yaml/json/schema location

core/src/main/java/uk/gov/justice/services/core/json/FileBasedJsonSchemaValidator.java

@@ -9,7 +9,6 @@
 import org.everit.json.schema.Schema;
 import org.everit.json.schema.ValidationException;
 import org.json.JSONObject;
-import org.slf4j.Logger;
 
 /**
  * Service for validating JSON payloads against a schema.
@@ -20,13 +19,13 @@ public class FileBasedJsonSchemaValidator {
     private final Map<String, Schema> schemas = new ConcurrentHashMap<>();
 
     @Inject
-    Logger logger;
+    private JsonSchemaLoader jsonSchemaLoader;
 
     @Inject
-    JsonSchemaLoader jsonSchemaLoader;
+    private PayloadExtractor payloadExtractor;
 
     @Inject
-    PayloadExtractor payloadExtractor;
+    private SchemaValidationErrorMessageGenerator schemaValidationErrorMessageGenerator;
 
     /**
      * Validate a JSON payload against the correct schema for the given message type name. If the
@@ -36,13 +35,14 @@ public class FileBasedJsonSchemaValidator {
      * @param actionName   the message type name
      */
     public void validateWithoutSchemaCatalog(final String envelopeJson, final String actionName) {
-        logger.debug("Falling back to file based schema lookup, no catalog schema found for: {}", actionName);
         final JSONObject payload = payloadExtractor.extractPayloadFrom(envelopeJson);
 
         try {
             schemaOf(actionName).validate(payload);
-        } catch (final ValidationException ex) {
-            throw new JsonSchemaValidationException(ex.getMessage(), ex);
+        } catch (final ValidationException e) {
+            throw new JsonSchemaValidationException(
+                    schemaValidationErrorMessageGenerator.generateErrorMessage(e),
+                    e);
         }
     }
 

core/src/main/java/uk/gov/justice/services/core/json/SchemaValidationErrorMessageGenerator.java

@@ -0,0 +1,23 @@
+package uk.gov.justice.services.core.json;
+
+import static java.lang.String.format;
+
+import java.util.List;
+
+import org.everit.json.schema.ValidationException;
+
+public class SchemaValidationErrorMessageGenerator {
+
+    private static final String ERROR_MASSAGE_FORMAT = "Json validation failed with %d violation(s): %s. Errors: %s. Violated schema id: '%s'. Location: '%s'";
+
+    public String generateErrorMessage(final ValidationException e) {
+
+        final int violationCount = e.getViolationCount();
+        final String errorMessage = e.getErrorMessage();
+        final List<String> allMessages = e.getAllMessages();
+        final String id = e.getViolatedSchema().getId();
+        final String schemaLocation = e.getSchemaLocation();
+
+        return format(ERROR_MASSAGE_FORMAT, violationCount, errorMessage, allMessages, id, schemaLocation);
+    }
+}

…er/spi/DefaultEnveloperProviderTest.java …oper/spi/DefaultEnveloperProviderIT.javacore/src/test/java/uk/gov/justice/services/core/enveloper/spi/DefaultEnveloperProviderTest.java renamed to core/src/test/java/uk/gov/justice/services/core/enveloper/spi/DefaultEnveloperProviderIT.java core/src/test/java/uk/gov/justice/services/core/enveloper/spi/DefaultEnveloperProviderTest.java renamed to core/src/test/java/uk/gov/justice/services/core/enveloper/spi/DefaultEnveloperProviderIT.java

@@ -43,6 +43,7 @@
 import uk.gov.justice.services.core.json.JsonSchemaLoader;
 import uk.gov.justice.services.core.json.PayloadExtractor;
 import uk.gov.justice.services.core.json.SchemaCatalogAwareJsonSchemaValidator;
+import uk.gov.justice.services.core.json.SchemaValidationErrorMessageGenerator;
 import uk.gov.justice.services.core.mapping.ActionNameToMediaTypesMappingObserver;
 import uk.gov.justice.services.core.mapping.DefaultMediaTypesMappingCache;
 import uk.gov.justice.services.core.mapping.DefaultNameToMediaTypeConverter;
@@ -73,7 +74,7 @@
 import org.junit.runner.RunWith;
 
 @RunWith(ApplicationComposer.class)
-public class DefaultEnveloperProviderTest {
+public class DefaultEnveloperProviderIT {
 
     private static final String TEST_EVENT_NAME = "test.event.something-happened";
 
@@ -143,7 +144,9 @@ public class DefaultEnveloperProviderTest {
             MediaTypesMappingCacheInitialiser.class,
             SchemaIdMappingCacheInitialiser.class,
             DefaultEnveloper.class,
-            ObjectMapperProducer.class
+            ObjectMapperProducer.class,
+
+            SchemaValidationErrorMessageGenerator.class
     })
     public WebApp war() {
         return new WebApp()
@@ -173,7 +176,7 @@ public void shouldDelegateToDefaultEnveloperFromCdiToEnvelopeWithMetadateFrom()
                 new UtcClock(),
                 new ObjectToJsonValueConverter(new ObjectMapperProducer().objectMapper()));
 
-        enveloper.register(new EventFoundEvent(DefaultEnveloperProviderTest.TestEvent.class, TEST_EVENT_NAME));
+        enveloper.register(new EventFoundEvent(DefaultEnveloperProviderIT.TestEvent.class, TEST_EVENT_NAME));
 
         final Metadata metadata = createMetadata();
         final TestPojo payload = new TestPojo(TEST_EVENT_NAME);

core/src/test/java/uk/gov/justice/services/core/it/AllEventsHandlerIT.java

@@ -50,6 +50,7 @@
 import uk.gov.justice.services.core.json.JsonSchemaLoader;
 import uk.gov.justice.services.core.json.PayloadExtractor;
 import uk.gov.justice.services.core.json.SchemaCatalogAwareJsonSchemaValidator;
+import uk.gov.justice.services.core.json.SchemaValidationErrorMessageGenerator;
 import uk.gov.justice.services.core.mapping.ActionNameToMediaTypesMappingObserver;
 import uk.gov.justice.services.core.mapping.DefaultMediaTypesMappingCache;
 import uk.gov.justice.services.core.mapping.DefaultNameToMediaTypeConverter;
@@ -157,7 +158,9 @@ public class AllEventsHandlerIT {
             EnvelopeInspector.class,
             DummyJsonSchemaValidator.class,
             MediaTypesMappingCacheInitialiser.class,
-            SchemaIdMappingCacheInitialiser.class
+            SchemaIdMappingCacheInitialiser.class,
+
+            SchemaValidationErrorMessageGenerator.class
     })
     public WebApp war() {
         return new WebApp()

core/src/test/java/uk/gov/justice/services/core/it/CustomServiceComponentHandlerIT.java

@@ -52,6 +52,7 @@
 import uk.gov.justice.services.core.json.JsonSchemaLoader;
 import uk.gov.justice.services.core.json.PayloadExtractor;
 import uk.gov.justice.services.core.json.SchemaCatalogAwareJsonSchemaValidator;
+import uk.gov.justice.services.core.json.SchemaValidationErrorMessageGenerator;
 import uk.gov.justice.services.core.mapping.ActionNameToMediaTypesMappingObserver;
 import uk.gov.justice.services.core.mapping.DefaultMediaTypesMappingCache;
 import uk.gov.justice.services.core.mapping.DefaultNameToMediaTypeConverter;
@@ -158,7 +159,9 @@ public class CustomServiceComponentHandlerIT {
             DummyJsonSchemaValidator.class,
 
             MediaTypesMappingCacheInitialiser.class,
-            SchemaIdMappingCacheInitialiser.class
+            SchemaIdMappingCacheInitialiser.class,
+
+            SchemaValidationErrorMessageGenerator.class
 
     })
     public WebApp war() {

core/src/test/java/uk/gov/justice/services/core/it/EventHandlerIT.java

@@ -54,6 +54,7 @@
 import uk.gov.justice.services.core.json.JsonSchemaLoader;
 import uk.gov.justice.services.core.json.PayloadExtractor;
 import uk.gov.justice.services.core.json.SchemaCatalogAwareJsonSchemaValidator;
+import uk.gov.justice.services.core.json.SchemaValidationErrorMessageGenerator;
 import uk.gov.justice.services.core.mapping.ActionNameToMediaTypesMappingObserver;
 import uk.gov.justice.services.core.mapping.DefaultMediaTypesMappingCache;
 import uk.gov.justice.services.core.mapping.DefaultNameToMediaTypeConverter;
@@ -165,7 +166,9 @@ public class EventHandlerIT {
             DummyJsonSchemaValidator.class,
 
             MediaTypesMappingCacheInitialiser.class,
-            SchemaIdMappingCacheInitialiser.class
+            SchemaIdMappingCacheInitialiser.class,
+
+            SchemaValidationErrorMessageGenerator.class
     })
     public WebApp war() {
         return new WebApp()

core/src/test/java/uk/gov/justice/services/core/it/SenderRequesterHandlerIT.java

@@ -47,6 +47,7 @@
 import uk.gov.justice.services.core.json.JsonSchemaLoader;
 import uk.gov.justice.services.core.json.PayloadExtractor;
 import uk.gov.justice.services.core.json.SchemaCatalogAwareJsonSchemaValidator;
+import uk.gov.justice.services.core.json.SchemaValidationErrorMessageGenerator;
 import uk.gov.justice.services.core.mapping.ActionNameToMediaTypesMappingObserver;
 import uk.gov.justice.services.core.mapping.DefaultMediaTypesMappingCache;
 import uk.gov.justice.services.core.mapping.DefaultNameToMediaTypeConverter;
@@ -170,7 +171,9 @@ public class SenderRequesterHandlerIT {
             DummyJsonSchemaValidator.class,
 
             MediaTypesMappingCacheInitialiser.class,
-            SchemaIdMappingCacheInitialiser.class
+            SchemaIdMappingCacheInitialiser.class,
+
+            SchemaValidationErrorMessageGenerator.class
     })
     public WebApp war() {
         return new WebApp()

core/src/test/java/uk/gov/justice/services/core/json/FileBasedJsonSchemaValidatorTest.java

@@ -25,15 +25,15 @@
 @RunWith(MockitoJUnitRunner.class)
 public class FileBasedJsonSchemaValidatorTest {
 
-    @Mock
-    private Logger logger;
-
     @Mock
     private JsonSchemaLoader jsonSchemaLoader;
 
     @Mock
     private PayloadExtractor payloadExtractor;
 
+    @Mock
+    private SchemaValidationErrorMessageGenerator schemaValidationErrorMessageGenerator;
+
     @InjectMocks
     private FileBasedJsonSchemaValidator fileBasedJsonSchemaValidator;
 
@@ -52,27 +52,30 @@ public void shouldLoadASchemaFromTheFileSystemByItsNameAndValidate() throws Exce
         fileBasedJsonSchemaValidator.validateWithoutSchemaCatalog(envelopeJson, actionName);
 
         verify(schema).validate(payload);
-        verify(logger).debug("Falling back to file based schema lookup, no catalog schema found for: {}", actionName);
     }
 
     @Test
     public void shouldThrowExceptionIfSchemaValidationFails() throws Exception {
 
         final String actionName = "example.action-name";
         final String envelopeJson = "{\"envelope\": \"json\"}";
+        final String errorMessage = "error message";
 
         final JSONObject payload = mock(JSONObject.class);
         final Schema schema = mock(Schema.class);
+        final ValidationException validationException = mock(ValidationException.class);
 
         when(payloadExtractor.extractPayloadFrom(envelopeJson)).thenReturn(payload);
         when(jsonSchemaLoader.loadSchema(actionName)).thenReturn(schema);
-        doThrow(new ValidationException(schema, "", "", "")).when(schema).validate(payload);
+        when(schemaValidationErrorMessageGenerator.generateErrorMessage(validationException)).thenReturn(errorMessage);
+        doThrow(validationException).when(schema).validate(payload);
 
         try {
             fileBasedJsonSchemaValidator.validateWithoutSchemaCatalog(envelopeJson, actionName);
             fail();
         } catch (final JsonSchemaValidationException e) {
-            assertThat(e.getCause(), is(instanceOf(ValidationException.class)));
+            assertThat(e.getMessage(), is(errorMessage));
+            assertThat(e.getCause(), is(validationException));
         }
     }
 }

core/src/test/java/uk/gov/justice/services/core/json/SchemaValidationErrorMessageGeneratorTest.java

@@ -0,0 +1,39 @@
+package uk.gov.justice.services.core.json;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.junit.Assert.assertThat;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.when;
+
+import org.everit.json.schema.Schema;
+import org.everit.json.schema.ValidationException;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.InjectMocks;
+import org.mockito.runners.MockitoJUnitRunner;
+
+@RunWith(MockitoJUnitRunner.class)
+public class SchemaValidationErrorMessageGeneratorTest {
+
+
+    @InjectMocks
+    private SchemaValidationErrorMessageGenerator schemaValidationErrorMessageGenerator;
+
+    @Test
+    public void shouldName() throws Exception {
+
+        final Schema violatedSchema = mock(Schema.class);
+
+        when(violatedSchema.getId()).thenReturn("schema id");
+
+        final ValidationException validationException = new ValidationException(
+                violatedSchema,
+                "error message",
+                "don't care",
+                "schemaLocation");
+
+        final String errorMessage = schemaValidationErrorMessageGenerator.generateErrorMessage(validationException);
+
+        assertThat(errorMessage, is("Json validation failed with 1 violation(s): error message. Errors: [#: error message]. Violated schema id: 'schema id'. Location: 'schemaLocation'"));
+    }
+}