Improved exception handling functionality for message type mismatch (#42)

Author: xdurvak

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.2.4
+- Improved exception handling functionality for event type mismatch
+
 ## 0.2.3
 - Implemented event specific meta class generation functionality
 

build.gradle

@@ -34,7 +34,7 @@ allprojects {
 
 jar {
     baseName = 'eiffel-remrem-semantics'
-    version =  '0.2.3'
+    version =  '0.2.4'
     manifest {
         attributes('remremVersionKey': 'semanticsVersion')
         attributes('semanticsVersion': version)
@@ -50,7 +50,7 @@ jar {
 
 shadowJar {
     baseName = 'eiffel-remrem-semantics'
-    version =  '0.2.3'
+    version =  '0.2.4'
     classifier = ''
 }
 

src/main/java/com/ericsson/eiffel/remrem/semantics/EiffelEventType.java

@@ -40,4 +40,8 @@ public static EiffelEventType fromString(String id) {
         }
         return idMap.get(id);
     }
+    
+    String getEventName() {
+        return id;
+    }
 }

src/main/java/com/ericsson/eiffel/remrem/semantics/SemanticsService.java

@@ -22,6 +22,7 @@
 import static com.ericsson.eiffel.remrem.semantics.EiffelEventType.ISSUE_VERIFIED;
 import static com.ericsson.eiffel.remrem.semantics.EiffelEventType.ARTIFACT_REUSED;
 
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -62,7 +63,10 @@
 
 @Named("eiffel-semantics")
 public class SemanticsService implements MsgService{
-
+    private static final String ERROR = "error";
+    private static final String SUPPORTED_EVENT_TYPES = "SUPPORTED_EVENT_TYPES";
+    private static final String RESULT = "result";
+    private static final String UNKNOWN_EVENT_TYPE_REQUESTED = "Unknown event type requested";
     private static final String EVENT_PARAMS = "eventParams";
     private static final String MSG_PARAMS = "msgParams";
     private static final String MESSAGE = "message";
@@ -71,12 +75,18 @@ public class SemanticsService implements MsgService{
     private static final String ID = "id";
     private static final String META = "meta";
     private static final String TYPE = "type";
-
+    private static final ArrayList<String> supportedEventTypes = new ArrayList<String>();
     public static final Logger log = LoggerFactory.getLogger(SemanticsService.class);
 
     private static Gson gson = new Gson();
     private static Map<EiffelEventType, Class<? extends Event>> eventTypes=SemanticsService.eventType();
 
+    public SemanticsService(){
+        for (final EiffelEventType msg : EiffelEventType.values()) {
+            supportedEventTypes.add(msg.getEventName());
+        }
+    }
+    
     public static Map<EiffelEventType, Class<? extends Event>> eventType()
     {
         eventTypes = new HashMap<>();
@@ -107,7 +117,7 @@ public String generateMsg(String msgType, JsonObject bodyJson){
         EiffelEventType eiffelType = EiffelEventType.fromString(msgType);
         if (eiffelType == null) {
             log.error("Unknown message type requested: " + msgType);
-            return createErrorResponse("Unknown message type requested", "'" + msgType + "' is not in the vocabulary of this service");
+            return createErrorResponse(msgType,supportedEventTypes);
         }
         Class<? extends Event> eventType = eventTypes.get(eiffelType);
 
@@ -143,7 +153,13 @@ private String createErrorResponse(final String message, final String cause){
         errorResponse.addProperty(CAUSE, cause.replace("\n", ""));
         return errorResponse.toString();
     }
-    
+    private String createErrorResponse(final String message, final ArrayList<String> supportedEventTypes){
+        JsonObject errorResponse = new JsonObject();
+        errorResponse.addProperty(RESULT, ERROR);
+        errorResponse.addProperty(MESSAGE, UNKNOWN_EVENT_TYPE_REQUESTED+"  -  " + message);
+        errorResponse.addProperty(SUPPORTED_EVENT_TYPES,supportedEventTypes.toString());
+        return errorResponse.toString();
+    }
     private void outputValidate(EiffelEventType eiffelType, String jsonStringInput) throws EiffelValidationException {
         EiffelValidator validator = EiffelOutputValidatorFactory.getEiffelValidator(eiffelType);
         JsonObject jsonObject = new JsonParser().parse(jsonStringInput).getAsJsonObject();

src/test/java/com/ericsson/eiffel/remrem/semantics/ServiceTest.java

@@ -226,8 +226,8 @@ private void testGenerateMsg(String msgType, String fileName) {
             JsonObject input = parser.parse(new FileReader(file)).getAsJsonObject();
             String msg = service.generateMsg("unknownmessage",input);
             Assert.assertTrue(msg.contains("message"));
-            Assert.assertTrue(msg.contains("Unknown message type requested"));
-            Assert.assertTrue(msg.contains("cause"));
+            Assert.assertTrue(msg.contains("Unknown event type requested"));
+            Assert.assertTrue(msg.contains("SUPPORTED_EVENT_TYPES"));
         } catch(FileNotFoundException e) {
             Assert.assertFalse(false);
         }