Implemented changes to adapt routing key template to Sepia (#153)

* Implemented changes to adapt routing key template to Sepia

Author: jainadc9

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2.3.0
+- Sepia protocol routing key template adapted
+
 ## 2.2.6
 - Mockito framework upgraded to 5.3.1
 

pom.xml

@@ -7,7 +7,7 @@
         <version>2.0.12</version>
     </parent>
     <artifactId>eiffel-remrem-semantics</artifactId>
-    <version>2.2.6</version>
+    <version>2.3.0</version>
     <packaging>jar</packaging>
     <properties>
         <eclipse.jgit.version>5.0.1.201806211838-r</eclipse.jgit.version>
@@ -24,7 +24,7 @@
         <dependency>
             <groupId>com.github.eiffel-community</groupId>
             <artifactId>eiffel-remrem-protocol-interface</artifactId>
-            <version>2.1.3</version>
+            <version>2.2.0</version>
             <scope>compile</scope>
         </dependency>
         <dependency>

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

@@ -0,0 +1,65 @@
+/*
+    Copyright 2018 Ericsson AB.
+    For a full list of individual contributors, please see the commit history.
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+*/
+package com.ericsson.eiffel.remrem.semantics;
+
+import com.ericsson.eiffel.remrem.semantics.schemas.EiffelConstants;
+
+public enum RoutingKeyFamilies {
+
+    EiffelActivityCanceledEvent(EiffelConstants.ACTIVITY),
+    EiffelActivityFinishedEvent(EiffelConstants.ACTIVITY),
+    EiffelActivityStartedEvent(EiffelConstants.ACTIVITY),
+    EiffelActivityTriggeredEvent(EiffelConstants.ACTIVITY),
+    EiffelAnnouncementPublishedEvent(EiffelConstants.ANNOUNCEMENT),
+    EiffelArtifactCreatedEvent(EiffelConstants.ARTIFACT),
+    EiffelArtifactPublishedEvent(EiffelConstants.ARTIFACT),
+    EiffelArtifactReusedEvent(EiffelConstants.ARTIFACT),
+    EiffelCompositionDefinedEvent(EiffelConstants.CM),
+    EiffelConfidenceLevelModifiedEvent(EiffelConstants.ARTIFACT),
+    EiffelEnvironmentDefinedEvent(EiffelConstants.CM),
+    EiffelFlowContextDefinedEvent(EiffelConstants.FLOWCONTEXT),
+    EiffelIssueVerifiedEvent(EiffelConstants.TEST),
+    EiffelSourceChangeCreatedEvent(EiffelConstants.CM),
+    EiffelSourceChangeSubmittedEvent(EiffelConstants.CM),
+    EiffelTestCaseCanceledEvent(EiffelConstants.TEST),
+    EiffelTestCaseTriggeredEvent(EiffelConstants.TEST),
+    EiffelTestCaseFinishedEvent(EiffelConstants.TEST),
+    EiffelTestCaseStartedEvent(EiffelConstants.TEST),
+    EiffelTestSuiteFinishedEvent(EiffelConstants.TEST),
+    EiffelTestSuiteStartedEvent(EiffelConstants.TEST),
+    EiffelTestExecutionRecipeCollectionCreatedEvent(EiffelConstants.TEST),
+    EiffelAlertAcknowledgedEvent(EiffelConstants.ALERT),
+    EiffelArtifactDeployedEvent(EiffelConstants.ARTIFACT),
+    EiffelServiceAllocatedEvent(EiffelConstants.SERVICE),
+    EiffelServiceDeployedEvent(EiffelConstants.SERVICE),
+    EiffelServiceDiscontinuedEvent(EiffelConstants.SERVICE),
+    EiffelServiceReturnedEvent(EiffelConstants.SERVICE),
+    EiffelServiceStartedEvent(EiffelConstants.SERVICE),
+    EiffelServiceStoppedEvent(EiffelConstants.SERVICE),
+    EiffelAlertRaisedEvent(EiffelConstants.ALERT),
+    EiffelAlertCeasedEvent(EiffelConstants.ALERT),
+    EiffelIssueDefinedEvent(EiffelConstants.TEST);
+
+
+    private final String family;   // family
+
+    RoutingKeyFamilies(String family) {
+        this.family = family;
+    }
+
+    public String getFamily() {
+        return family;
+    }
+}

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

@@ -388,23 +388,6 @@ private String getFamily(JsonObject eiffelMessage) {
         return null;
     }
 
-    /**
-     * Returns Type Routing Key Word from the messaging library based on the
-     * eiffel message eventType.
-     * 
-     * @param JsonObject
-     *            eiffelMessage
-     * @return type routing key word in String format.
-     */
-    private String getType(JsonObject eiffelMessage) {
-        if (eiffelMessage.isJsonObject() && eiffelMessage.getAsJsonObject().has(META)
-                && eiffelMessage.getAsJsonObject().getAsJsonObject(META).has(TYPE)) {
-            return event
-                    .getTypeRoutingKey(eiffelMessage.getAsJsonObject().getAsJsonObject(META).get(TYPE).getAsString());
-        }
-        return null;
-    }
-
     @Override
     public String getServiceName() {
         return EIFFELSEMANTICS;
@@ -430,8 +413,20 @@ private String getDomainId(JsonObject eiffelMessage) {
 
     @Override
     public String generateRoutingKey(JsonObject eiffelMessage, String tag, String domain, String userDomainSuffix) {
+        return generateRoutingKey(getEventType(eiffelMessage), tag, domain, userDomainSuffix, eiffelMessage);
+    }
+
+    @Override
+    public String generateRoutingKey(JsonObject eiffelMessage, String tag, String domain, String userDomainSuffix, String type) {
+        if (StringUtils.isNotBlank(type)) {
+            return generateRoutingKey(type, tag, domain, userDomainSuffix, eiffelMessage);
+        } else {
+            return generateRoutingKey(eiffelMessage, tag, domain, userDomainSuffix);
+        }
+    }
+
+    public String generateRoutingKey(String type, String tag, String domain, String userDomainSuffix, JsonObject eiffelMessage) {
         String family = getFamily(eiffelMessage);
-        String type = getType(eiffelMessage);
         if (StringUtils.isNotEmpty(family) && StringUtils.isNotEmpty(type)) {
             if (StringUtils.isNotBlank(tag) && (tag.contains(".") || StringUtils.deleteWhitespace(tag).length() > 16)) {
                 log.error("tag must not contain any dots and must not exceed 16 characters");

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

@@ -56,7 +56,7 @@ public final class EiffelConstants {
     public static String SERVICE = "service";
     public static String ALERT = "alert";
     public static String CM = "cm";
-    public static String INFO = "info";
+    public static String ANNOUNCEMENT = "announcement";
     public static String CONFIGURATION = "configuration";
     public static String FLOWCONTEXT = "flowcontext";
     public static String TEST = "test";

src/main/java/com/ericsson/eiffel/remrem/semantics/schemas/EiffelConstants.java

@@ -21,7 +21,7 @@
 import java.util.UUID;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import com.ericsson.eiffel.remrem.semantics.RoutingKeyTypes;
+import com.ericsson.eiffel.remrem.semantics.RoutingKeyFamilies;
 
 /**
  * This is the super class for all Eiffel event classes
@@ -54,28 +54,17 @@ public Meta generateMeta(Meta meta) {
      *         eventType requested.
      */
     public String getFamilyRoutingKey(String eventType) {
-        try {
-            return RoutingKeyTypes.valueOf(eventType).getFamily();
-        } catch (Exception e) {
-            log.error("Unknown event type requested: " + eventType);
-        }
-        return null;
-    }
-
-    /**
-     * This method is used to get type based on the eventType
-     * 
-     * @param eventType
-     *            Eiffel eventType
-     * @return type based on eventType (or) error will be thrown if unknown
-     *         eventType requested.
-     */
-    public String getTypeRoutingKey(String eventType) {
-        try {
-            return RoutingKeyTypes.valueOf(eventType).getType();
-        } catch (Exception e) {
-            log.error("Unknown event type requested: " + eventType);
-        }
+    	
+    	if(eventType != null) {
+    		try {
+    			return RoutingKeyFamilies.valueOf(eventType).getFamily();
+    		} catch (IllegalArgumentException e) {
+    			log.error("Unknown event type requested: " + eventType);
+    		}
+    	}else {
+    		log.error("Null event type requested: " + eventType);
+    	}
+        
         return null;
     }
 

src/main/java/com/ericsson/eiffel/semantics/events/Event.java

@@ -179,7 +179,7 @@ public void testGenerateRoutingKey() throws UnsupportedEncodingException {
         } catch (Exception e) {
             e.printStackTrace();
         }
-        assertEquals("eiffel.activity.finished.notag.domainID", routingKey);
+        assertEquals("eiffel.activity.EiffelActivityFinishedEvent.notag.domainID", routingKey);
     }
 
     @Test