Replacement marker mismatch handled better (#428)

* Throw exception earlier and more helpful error message

Author: Christoffer-Cortes

src/main/java/com/ericsson/ei/exception/ReplacementMarkerException.java

@@ -0,0 +1,10 @@
+package com.ericsson.ei.exception;
+
+public class ReplacementMarkerException extends Exception {
+
+    private static final long serialVersionUID = 1L;
+
+    public ReplacementMarkerException(String message) {
+        super(message);
+    }
+}

src/main/java/com/ericsson/ei/rules/MatchIdRulesHandler.java

@@ -16,9 +16,14 @@
 */
 package com.ericsson.ei.rules;
 
+import java.util.ArrayList;
 import java.util.List;
 
+import com.ericsson.ei.exception.ReplacementMarkerException;
 import com.ericsson.ei.handlers.ObjectHandler;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Component;
@@ -30,6 +35,8 @@
 @Component
 public class MatchIdRulesHandler {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(MatchIdRulesHandler.class);
+
     @Value("${rules.replacement.marker:%IdentifyRulesEventId%}")
     private String replacementMarker;
 
@@ -42,10 +49,13 @@ public class MatchIdRulesHandler {
      * */
     public List<String> fetchObjectsById(RulesObject ruleObject, String id) {
         String matchIdString = ruleObject.getMatchIdRules();
-        String fetchQueryString = replaceIdInRules(matchIdString, id);
-        MongoQuery fetchQuery = new MongoStringQuery(fetchQueryString);
-        List<String> objects = objHandler.findObjectsByCondition(fetchQuery);
-        return objects;
+        List<String> objects = new ArrayList<>();
+        try {
+            objects = doFetchObjectsById(matchIdString, id);
+        } catch (ReplacementMarkerException e) {
+            LOGGER.error("Replacement marker mismatch.", e);
+        }
+        return  objects;
     }
 
     /**
@@ -62,13 +72,21 @@ public List<String> fetchObjectsById(RulesObject ruleObject, String id) {
      * @param matchIdString the string containing a placeholder key to be replaced
      * @param id            the Eiffel event id to replace placeholder with
      * @return an updated matchIdString
+     * @throws ReplacementMarkerException
      */
-    public String replaceIdInRules(String matchIdString, String id) {
+    protected String replaceIdInRules(String matchIdString, String id) throws ReplacementMarkerException {
         if (matchIdString.contains(replacementMarker)) {
             return matchIdString.replace(replacementMarker, id);
         } else {
-            return null;
+            String errorMessage = String.format("MatchIdRules: %s does not contain the rules.replacement.marker: %s", matchIdString, replacementMarker);
+            throw new ReplacementMarkerException(errorMessage);
         }
     }
 
+    private List<String> doFetchObjectsById(String matchIdString, String id) throws ReplacementMarkerException {
+        String fetchQueryString = replaceIdInRules(matchIdString, id);
+        MongoQuery fetchQuery = new MongoStringQuery(fetchQueryString);
+        List<String> objects = objHandler.findObjectsByCondition(fetchQuery);
+        return objects;
+    }
 }

src/test/java/com/ericsson/ei/extraction/test/TestExtractionHandler.java

@@ -31,7 +31,7 @@
 import com.ericsson.ei.handlers.ExtractionHandler;
 import com.ericsson.ei.jmespath.JmesPathInterface;
 import com.ericsson.ei.rules.RulesObject;
-import com.ericsson.ei.rules.test.TestRulesHandler;
+import com.ericsson.ei.rules.TestRulesHandler;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 

src/test/java/com/ericsson/ei/rules/test/MatchIdRulesHandlerTest.java renamed to src/test/java/com/ericsson/ei/rules/MatchIdRulesHandlerTest.java

@@ -14,53 +14,66 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-package com.ericsson.ei.rules.test;
+package com.ericsson.ei.rules;
 
 import static org.junit.Assert.assertEquals;
 
 import java.io.File;
+import java.io.IOException;
 
 import org.apache.commons.io.FileUtils;
-import org.junit.Before;
 import org.junit.Test;
 import org.powermock.reflect.Whitebox;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
-import com.ericsson.ei.rules.MatchIdRulesHandler;
+import com.ericsson.ei.exception.ReplacementMarkerException;
 import com.ericsson.ei.rules.RulesObject;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
 public class MatchIdRulesHandlerTest {
     private static final String INPUT_FILE_PATH = "src/test/resources/MatchIdRulesHandlerInput.json";
     private static final String OUTPUT_FILE_PATH = "src/test/resources/MatchIdRulesHandlerOutput.json";
     private static final String EVENT_ID = "e90daae3-bf3f-4b0a-b899-67834fd5ebd0";
-    private static final Logger LOGGER = LoggerFactory.getLogger(MatchIdRulesHandlerTest.class);
 
     private MatchIdRulesHandler matchIdRulesHandler;
 
-    @Before
-    public void setProperties() {
-        matchIdRulesHandler = new MatchIdRulesHandler();
-        Whitebox.setInternalState(matchIdRulesHandler, "replacementMarker", "%IdentifyRulesEventId%");
-    }
-
     @Test
-    public void replaceIdInRulesTest() {
-        String jsonInput = null;
-        String jsonOutput = null;
-        RulesObject ruleObject = null;
-        try {
-            jsonInput = FileUtils.readFileToString(new File(INPUT_FILE_PATH), "UTF-8");
-            jsonOutput = FileUtils.readFileToString(new File(OUTPUT_FILE_PATH), "UTF-8");
-            ObjectMapper objectmapper = new ObjectMapper();
-            ruleObject = new RulesObject(objectmapper.readTree(jsonInput));
-        } catch (Exception e) {
-            LOGGER.error(e.getMessage(), e);
-        }
+    public void replaceIdInRulesTest() throws IOException, ReplacementMarkerException {
+        setMatchingProperty();
+        String jsonInput = readFile(INPUT_FILE_PATH);
+        String jsonOutput = readFile(OUTPUT_FILE_PATH);
+        RulesObject ruleObject = createRulesObject(jsonInput);
         String matchIdString = ruleObject.getMatchIdRules();
         String replacedId = matchIdRulesHandler.replaceIdInRules(matchIdString, EVENT_ID);
         assertEquals(replacedId, jsonOutput);
     }
 
+    @Test(expected = ReplacementMarkerException.class)
+    public void replaceIdInRulesExceptionTest() throws IOException, ReplacementMarkerException {
+        setMismatchingProperty();
+        String jsonInput = readFile(INPUT_FILE_PATH);
+        RulesObject ruleObject = createRulesObject(jsonInput);
+        String matchIdString = ruleObject.getMatchIdRules();
+        matchIdRulesHandler.replaceIdInRules(matchIdString, EVENT_ID);
+    }
+
+    private RulesObject createRulesObject(String input) throws IOException {
+        ObjectMapper objectmapper = new ObjectMapper();
+        RulesObject ruleObject = new RulesObject(objectmapper.readTree(input));
+        return ruleObject;
+    }
+
+    private String readFile(String path) throws IOException {
+        return FileUtils.readFileToString(new File(path), "UTF-8");
+    }
+
+    private void setMatchingProperty() {
+        matchIdRulesHandler = new MatchIdRulesHandler();
+        Whitebox.setInternalState(matchIdRulesHandler, "replacementMarker",
+                "%IdentifyRulesEventId%");
+    }
+
+    private void setMismatchingProperty() {
+        matchIdRulesHandler = new MatchIdRulesHandler();
+        Whitebox.setInternalState(matchIdRulesHandler, "replacementMarker", "%IdentifyRulesEvent%");
+    }
 }

src/test/java/com/ericsson/ei/rules/test/TestIdRulesHandler.java renamed to src/test/java/com/ericsson/ei/rules/TestIdRulesHandler.java

@@ -14,7 +14,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-package com.ericsson.ei.rules.test;
+package com.ericsson.ei.rules;
 
 import static org.junit.Assert.assertEquals;
 

src/test/java/com/ericsson/ei/rules/test/TestRulesHandler.java renamed to src/test/java/com/ericsson/ei/rules/TestRulesHandler.java

@@ -14,7 +14,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-package com.ericsson.ei.rules.test;
+package com.ericsson.ei.rules;
 
 import static org.junit.Assert.assertEquals;
 

src/test/java/com/ericsson/ei/rules/test/TestRulesObject.java renamed to src/test/java/com/ericsson/ei/rules/TestRulesObject.java

@@ -14,7 +14,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
 */
-package com.ericsson.ei.rules.test;
+package com.ericsson.ei.rules;
 
 import static org.junit.Assert.assertEquals;
 

src/test/java/com/ericsson/ei/rules/test/TestRulesRestAPI.java renamed to src/test/java/com/ericsson/ei/rules/TestRulesRestAPI.java

@@ -14,7 +14,7 @@
    See the License for the specific language governing permissions and
    limitations under the License.
  */
-package com.ericsson.ei.rules.test;
+package com.ericsson.ei.rules;
 
 import static org.junit.Assert.assertEquals;
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;

src/test/java/com/ericsson/ei/rules/test/TestRulesService.java renamed to src/test/java/com/ericsson/ei/rules/TestRulesService.java

@@ -1,4 +1,4 @@
-package com.ericsson.ei.rules.test;
+package com.ericsson.ei.rules;
 
 import static org.junit.Assert.assertEquals;