[DRUACI7594]-meta.source.serializer information needs to be filled in by remrem semantics (#57)

Author: sarvesh-devops

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.3.1
+- Implemented functionality to override input semantics gav with MANIFEST.MF file gav
+
 ## 0.3.0
 - Implemented routing key for eiffel messages in REMReM semantics.
 

build.gradle

@@ -48,11 +48,13 @@ allprojects {
 
 jar {
     baseName = 'eiffel-remrem-semantics'
-    version =  '0.3.0'
+    version =  '0.3.1'
     manifest {
         attributes('remremVersionKey': 'semanticsVersion')
         attributes('semanticsVersion': version)
         attributes('isEndpointVersion': 'true')
+        attributes('groupId': 'com.github.Ericsson')
+        attributes('artifactId': baseName)
     }
     from { configurations.runtime.collect { it.isDirectory() ? it : zipTree(it) } }
 	{
@@ -64,7 +66,7 @@ jar {
 
 shadowJar {
     baseName = 'eiffel-remrem-semantics'
-    version =  '0.3.0'
+    version =  '0.3.1'
     classifier = ''
 }
 

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

@@ -41,6 +41,7 @@
 import java.util.HashMap;
 import java.util.Map;
 
+import javax.annotation.PostConstruct;
 import javax.inject.Named;
 
 import org.apache.commons.lang3.StringUtils;
@@ -50,6 +51,7 @@
 import com.ericsson.eiffel.remrem.protocol.MsgService;
 import com.ericsson.eiffel.remrem.protocol.ValidationResult;
 import com.ericsson.eiffel.remrem.semantics.factory.EiffelOutputValidatorFactory;
+import com.ericsson.eiffel.remrem.semantics.util.ManifestHandler;
 import com.ericsson.eiffel.remrem.semantics.validator.EiffelValidationException;
 import com.ericsson.eiffel.remrem.semantics.validator.EiffelValidator;
 import com.ericsson.eiffel.semantics.events.EiffelActivityCanceledEvent;
@@ -75,6 +77,9 @@
 import com.ericsson.eiffel.semantics.events.EiffelIssueVerifiedEvent;
 import com.ericsson.eiffel.semantics.events.EiffelArtifactReusedEvent;
 import com.ericsson.eiffel.semantics.events.Event;
+import com.ericsson.eiffel.semantics.events.Gav;
+import com.ericsson.eiffel.semantics.events.Serializer;
+import com.ericsson.eiffel.semantics.events.Source;
 import com.google.gson.Gson;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
@@ -100,7 +105,8 @@ public class SemanticsService implements MsgService {
     private final ArrayList<String> supportedEventTypes = new ArrayList<String>();
     public static final Logger log = LoggerFactory.getLogger(SemanticsService.class);
     private Event event = new Event();
-
+    public static Gav semanticsGAV;
+    private boolean semanticsGavFlag = false;
     private static Gson gson = new Gson();
     private static Map<EiffelEventType, Class<? extends Event>> eventTypes = SemanticsService.eventType();
 
@@ -109,6 +115,16 @@ public SemanticsService() {
             supportedEventTypes.add(msg.getEventName());
         }
     }
+    
+    @PostConstruct
+	public void readManifest() {
+		ManifestHandler manifastHandler = new ManifestHandler();
+		semanticsGAV = manifastHandler.readGavfromManifest();
+		if (semanticsGAV == null || semanticsGAV.getArtifactId() == null || semanticsGAV.getGroupId() == null
+				|| semanticsGAV.getVersion() == null) {
+			semanticsGavFlag = true;
+		}
+	}
 
     public static Map<EiffelEventType, Class<? extends Event>> eventType() {
         eventTypes = new HashMap<>();
@@ -139,6 +155,10 @@ public static Map<EiffelEventType, Class<? extends Event>> eventType() {
 
     @Override
     public String generateMsg(String msgType, JsonObject bodyJson) {
+    	if (semanticsGavFlag) {
+			return createErrorResponse("GAV info of eiffel-remrem-semantics is missing",
+					"Required Serializer GAV information of eiffel-remrem-semantics is missing in MANIFEST.MF");
+		}
         EiffelEventType eiffelType = EiffelEventType.fromString(msgType);
         if (eiffelType == null) {
             log.error("Unknown message type requested: " + msgType);
@@ -178,6 +198,7 @@ private static Event eventCreation(Class<? extends Event> eventType, JsonObject
         eventNodes.add("meta", msgNodes.get("meta"));
         Event event = createEvent(eventNodes, eventType);
         event.setMeta(event.generateMeta(event.getMeta()));
+        event.getMeta().setSource(setSerializerGav(event.getMeta().getSource()));
         return event;
     }
 
@@ -321,4 +342,22 @@ public String generateRoutingKey(JsonObject eiffelMessage, String tag, String do
         }
         return null;
     }
+    
+    /**
+	 * This method is used to override given input meta.source.serializer GAV
+	 * with semantics GAV or if not exist, generates semantics GAV and set to
+	 * meta.source.serializer
+	 * 
+	 * @param source
+	 * @return updated source instance with semantics gav information
+	 */
+	public static Source setSerializerGav(Source source) {
+		source = source == null ? new Source() : source;
+		Serializer serializer = source.getSerializer()==null? new Serializer():source.getSerializer();
+		serializer.setGroupId(semanticsGAV.getGroupId());
+		serializer.setArtifactId(semanticsGAV.getArtifactId());
+		serializer.setVersion(semanticsGAV.getVersion());
+		source.setSerializer(serializer);
+		return source;
+	}
 }

src/main/java/com/ericsson/eiffel/remrem/semantics/util/ManifestHandler.java

@@ -0,0 +1,52 @@
+/*
+    Copyright 2017 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.util;
+
+import java.net.URL;
+import java.util.jar.Attributes;
+import java.util.jar.Manifest;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.ericsson.eiffel.remrem.semantics.SemanticsService;
+import com.ericsson.eiffel.semantics.events.Gav;
+
+public class ManifestHandler {
+	public static final Logger log = LoggerFactory.getLogger(SemanticsService.class);
+
+	/**
+	 * This method is used to read semantics GAV from MANIFEST.MF file
+	 * 
+	 * @return Gav instance which contains semantics gav read from MANIFEST.MF
+	 *         file
+	 */
+	public Gav readGavfromManifest() {
+		try {
+			Gav semanticsGAV = new Gav();
+			String classPath = SemanticsService.class.getResource("SemanticsService.class").toString();
+			String manifestPath = classPath.substring(0, classPath.lastIndexOf("!") + 1) + "/META-INF/MANIFEST.MF";
+			Manifest manifest = new Manifest(new URL(manifestPath).openStream());
+			Attributes attributes = manifest.getMainAttributes();
+			semanticsGAV.setGroupId(attributes.getValue("groupId"));
+			semanticsGAV.setArtifactId(attributes.getValue("artifactId"));
+			semanticsGAV.setVersion(attributes.getValue("semanticsVersion"));
+			return semanticsGAV;
+		} catch (Exception e) {
+			log.error("Unable to read eiffel-remrem-semantics gav information from MANIFEST.MF " + e.getMessage());
+		}
+		return null;
+	}
+}

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

@@ -17,5 +17,6 @@
 public interface Meta {
 	public void setId(String id);
 	public void setTime(Long time);
-	
+	public void setSource(Source source);
+	public Source getSource();
 }

src/main/resources/MANIFEST.MF

@@ -0,0 +1,8 @@
+comment: This Manifest file is used for testing purpose
+Manifest-Version: 1.0
+groupId: com.github.Ericsson
+remremVersionKey: semanticsVersion
+artifactId: eiffel-remrem-semantics
+isEndpointVersion: true
+semanticsVersion: 0.3.1
+

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

@@ -20,18 +20,23 @@
 import static org.mockito.Mockito.when;
 
 import java.io.File;
+import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.FileReader;
 import java.net.URL;
 import java.util.jar.Attributes;
+import java.util.jar.Manifest;
+
 
 import org.junit.Assert;
 import org.junit.Before;
+import org.junit.BeforeClass;
 import org.junit.Test;
 import org.mockito.InjectMocks;
 import org.mockito.MockitoAnnotations;
 
 import com.ericsson.eiffel.remrem.protocol.ValidationResult;
+import com.ericsson.eiffel.remrem.semantics.util.ManifestHandler;
 import com.ericsson.eiffel.semantics.events.EiffelActivityCanceledEvent;
 import com.ericsson.eiffel.semantics.events.EiffelActivityFinishedEvent;
 import com.ericsson.eiffel.semantics.events.EiffelActivityStartedEvent;
@@ -54,6 +59,7 @@
 import com.ericsson.eiffel.semantics.events.EiffelTestExecutionRecipeCollectionCreatedEvent;
 import com.ericsson.eiffel.semantics.events.EiffelTestSuiteFinishedEvent;
 import com.ericsson.eiffel.semantics.events.EiffelTestSuiteStartedEvent;
+import com.ericsson.eiffel.semantics.events.Gav;
 import com.google.gson.JsonIOException;
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParser;
@@ -157,12 +163,35 @@ public class ServiceTest {
 
     @InjectMocks
     EiffelTestExecutionRecipeCollectionCreatedEvent terEvent = new EiffelTestExecutionRecipeCollectionCreatedEvent();
+    
+    ManifestHandler manifestHandler;
+    static Gav manifestGav = null;
+    
+	@BeforeClass
+	public static void readManifestGav() {
+		manifestGav = new Gav();
+		URL url = ServiceTest.class.getClassLoader().getResource("MANIFEST.MF");
+		String manifestPath = url.getPath().replace("%20", " ");
+		try {
+			Manifest manifest = new Manifest(new FileInputStream(manifestPath));
+			Attributes attributes1 = manifest.getMainAttributes();
+			manifestGav.setGroupId(attributes1.getValue("groupId"));
+			manifestGav.setArtifactId(attributes1.getValue("artifactId"));
+			manifestGav.setVersion(attributes1.getValue("semanticsVersion"));
+		} catch (FileNotFoundException e) {
+			e.printStackTrace();
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+	}
 
     @Before
     public void setUp() throws Exception {
         Attributes attributes = mock(Attributes.class);
+        manifestHandler = mock(ManifestHandler.class);
         MockitoAnnotations.initMocks(this);        
-        when(attributes.getValue(anyString())).thenReturn("0.2.3");        
+        when(attributes.getValue(anyString())).thenReturn("0.2.3");
+        SemanticsService.semanticsGAV = manifestGav;
     }
 
     private void testGenerateMsg(String msgType, String fileName) {
@@ -280,7 +309,7 @@ public void testInvalidMessage() {
             Assert.assertTrue(msg.contains("message"));
             Assert.assertTrue(msg.contains("Cannot validate given JSON string"));
             Assert.assertTrue(msg.contains("cause"));
-            Assert.assertTrue(msg.contains("missing required properties ([\\\"groupId"));
+            Assert.assertTrue(msg.contains("missing required properties ([\\\"conclusion"));
         } catch(FileNotFoundException e) {
             Assert.assertFalse(false);
         }
@@ -346,4 +375,25 @@ public void testGenerateRoutingKey() {
         }
         assertEquals("eiffel.activity.finished.notag.domainID", routingKey);
     }
+    
+    @Test
+	public void testGetRemremSemanticsGav() {
+		when(manifestHandler.readGavfromManifest()).thenReturn(manifestGav);
+		Gav gav = manifestHandler.readGavfromManifest();
+		Assert.assertEquals(gav.getGroupId(), "com.github.Ericsson");
+		Assert.assertEquals(gav.getArtifactId(), "eiffel-remrem-semantics");
+		Assert.assertEquals(gav.getVersion(), "0.3.1");
+	}
+    
+	@Test(expected = FileNotFoundException.class)
+	public void testInvalidPathRemremSemanticsGav() throws Exception {
+		URL url = ServiceTest.class.getClassLoader().getResource("MANIFEST.MF");
+		String manifestPath = url.getPath() + "/InvalidPath";
+		Manifest manifest = new Manifest(new FileInputStream(manifestPath));
+		Attributes attributes1 = manifest.getMainAttributes();
+		manifestGav.setGroupId(attributes1.getValue("groupId"));
+		manifestGav.setArtifactId(attributes1.getValue("artifactId"));
+		manifestGav.setVersion(attributes1.getValue("semanticsVersion"));
+
+	}
 }

src/test/resources/input/ActivityFinishedInvalid.json

@@ -25,7 +25,6 @@
   "eventParams": {
     "data": {
       "outcome": {
-        "conclusion": "TIMED_OUT",
         "description": "Compilation timed out."
       },
       "persistentLogs": [{