Add GET /rules endpoint (#300)

* /rules is now an endpoint that fetches the active rules content and path

Author: Christoffer-Cortes

src/functionaltests/java/com/ericsson/ei/rules/RuleCheckSteps.java

@@ -1,6 +1,6 @@
 package com.ericsson.ei.rules;
 
-import com.ericsson.ei.controller.RuleCheckController;
+import com.ericsson.ei.controller.RuleController;
 import com.ericsson.ei.utils.FunctionalTestBase;
 import com.ericsson.ei.utils.HttpRequest;
 import com.ericsson.ei.utils.HttpRequest.HttpMethod;
@@ -28,7 +28,7 @@ public class RuleCheckSteps extends FunctionalTestBase {
     private static final String TEST_RESOURCES_PATH = "src/test/resources";
 
     @Autowired
-    private RuleCheckController ruleCheckController;
+    private RuleController ruleController;
 
     private String rules;
     private String events;
@@ -40,12 +40,12 @@ public class RuleCheckSteps extends FunctionalTestBase {
 
     @Given("^rules checking is enabled$")
     public void rules_checking_is_enabled() throws Throwable {
-        ReflectionTestUtils.setField(ruleCheckController, "testEnable", true);
+        ReflectionTestUtils.setField(ruleController, "testEnabled", true);
     }
 
     @Given("^rules checking is not enabled$")
     public void rules_checking_is_not_enabled() throws Throwable {
-        ReflectionTestUtils.setField(ruleCheckController, "testEnable", false);
+        ReflectionTestUtils.setField(ruleController, "testEnabled", false);
     }
 
     @Given("^file with JMESPath rules \"([^\"]*)\" and file with events \"([^\"]*)\"$")

src/main/java/com/ericsson/ei/controller/RuleCheckController.java renamed to src/main/java/com/ericsson/ei/controller/RuleController.java

@@ -11,21 +11,28 @@
 
 
 /**
- * No description
+ * This class is used for anything rules related. It's currently used to test rules on eiffel events and to fetch the active rules file content. Test rules must be enabled in Eiffel Intelligence for the /rule-check endpoints to work.
  * (Generated with springmvc-raml-parser v.2.0.4)
  * 
  */
 @RestController
 @Validated
-@RequestMapping(value = "/rules/rule-check", produces = "application/json")
-public interface RuleCheckController {
+@RequestMapping(value = "/rules", produces = "application/json")
+public interface RuleController {
 
 
+    /**
+     * This method returns the active rules file content.
+     * 
+     */
+    @RequestMapping(value = "", method = RequestMethod.GET)
+    public ResponseEntity<?> getRules();
+
     /**
      * This method extracts data from a single Eiffel event based on the given JMESPath expression.
      * 
      */
-    @RequestMapping(value = "", method = RequestMethod.POST)
+    @RequestMapping(value = "/rule-check", method = RequestMethod.POST)
     public ResponseEntity<?> createRulesRuleCheck(
         @javax.validation.Valid
         @org.springframework.web.bind.annotation.RequestBody
@@ -35,7 +42,7 @@ public ResponseEntity<?> createRulesRuleCheck(
      * This method extracts data from the given list of Eiffel events, based on a set of rules and returns an aggregated object.
      * 
      */
-    @RequestMapping(value = "/aggregation", method = RequestMethod.POST)
+    @RequestMapping(value = "/rule-check/aggregation", method = RequestMethod.POST)
     public ResponseEntity<?> createRuleCheckAggregation(
         @javax.validation.Valid
         @org.springframework.web.bind.annotation.RequestBody
@@ -45,7 +52,7 @@ public ResponseEntity<?> createRuleCheckAggregation(
      * This method checks if the possibility to test rules has been enabled in Eiffel Intelligence.
      * 
      */
-    @RequestMapping(value = "/testRulePageEnabled", method = RequestMethod.GET)
+    @RequestMapping(value = "/rule-check/testRulePageEnabled", method = RequestMethod.GET)
     public ResponseEntity<?> getRuleCheckTestRulePageEnabled();
 
 }

src/main/java/com/ericsson/ei/controller/RuleCheckControllerImpl.java renamed to src/main/java/com/ericsson/ei/controller/RuleControllerImpl.java

@@ -34,48 +34,61 @@
 import com.ericsson.ei.controller.model.RuleCheckBody;
 import com.ericsson.ei.controller.model.RulesCheckBody;
 import com.ericsson.ei.jmespath.JmesPathInterface;
+import com.ericsson.ei.rules.RulesHandler;
 import com.ericsson.ei.services.IRuleCheckService;
 import com.ericsson.ei.utils.ResponseMessage;
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
 
 import io.swagger.annotations.Api;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiParam;
 import lombok.Setter;
 
-/**
- * This class implements the Interface for JMESPath API, generated by RAML 0.8
- * Provides interaction with JmesPathInterface class
- *
- * Usage: 1. If input contains a rule as an argument and json expression in a
- * text file, then the following curl command may be used. curl -H
- * "Content-type: application/x-www-form-urlencoded" -X POST --data-urlencode
- * jsonContent@testjson.txt
- * http://localhost:8090/jmespathrule/runRule?rule=data.outcome
- *
- * 2. If input contains rule and json expression as two String arguments, then
- * the following curl command may be used. curl -H "Content-type:
- * application/x-www-form-urlencoded" -X POST -d
- * jsonContent={"data":{"outcome":{"conclusion":"SUCCESSFUL"},"test":"persistentLogs"}}
- * http://localhost:8090/jmespathrule/runRule?rule=data.outcome
- *
- */
-
 @Component
 @CrossOrigin
-@Api(value = "checkRules", tags = {"Check rules"})
-public class RuleCheckControllerImpl implements RuleCheckController {
+@Api(value = "Rules", tags = {"Rules"})
+public class RuleControllerImpl implements RuleController{
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(RuleCheckControllerImpl.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(RuleControllerImpl.class);
 
     @Autowired
     private JmesPathInterface jmesPathInterface;
 
     @Autowired
     private IRuleCheckService ruleCheckService;
 
+    @Autowired
+    private RulesHandler rulesHandler;
+
     @Setter
     @Value("${testaggregated.enabled:false}")
-    private Boolean testEnable;
+    private Boolean testEnabled;
+
+    @Value("${rules.path}")
+    private String rulesPath;
+
+    @Override
+    @CrossOrigin
+    @ApiOperation(value = "Get the active rules from Eiffel Intelligence", response = String.class)
+    public ResponseEntity<?> getRules() {
+        JsonNode rulesContent = rulesHandler.getRulesContent();
+        ObjectMapper objectmapper = new ObjectMapper();
+        try {
+            String contentAsString = objectmapper.writeValueAsString(rulesContent);
+            JSONObject jsonResult = new JSONObject();
+            jsonResult.put("path", rulesPath);
+            jsonResult.put("content", contentAsString);
+            String result = jsonResult.toString();
+            return new ResponseEntity<>(result, HttpStatus.OK);
+        } catch (JsonProcessingException e) {
+            String errorMessage = "Internal Server Error: Failed to parse the rules content.";
+            LOGGER.error(errorMessage, e);
+            String errorJsonAsString = ResponseMessage.createJsonMessage(errorMessage);
+            return new ResponseEntity<>(errorJsonAsString, HttpStatus.INTERNAL_SERVER_ERROR);
+        }
+    }
 
     /**
      * This method interacts with JmesPathInterface class method runRuleOnEvent to
@@ -114,7 +127,7 @@ public ResponseEntity<?> createRulesRuleCheck(
     @ApiOperation(value = "To execute the list of rules on list of Eiffel events. Returns the aggregated object(s)", response = String.class)
     public ResponseEntity<?> createRuleCheckAggregation(
             @ApiParam(value = "Object that include list of rules and list of Eiffel events", required = true) @RequestBody RulesCheckBody body) {
-        if (testEnable) {
+        if (testEnabled) {
             try {
                 String aggregatedObject = ruleCheckService.prepareAggregatedObject(
                         new JSONArray(body.getListRulesJson()), new JSONArray(body.getListEventsJson()));
@@ -148,7 +161,7 @@ public ResponseEntity<?> createRuleCheckAggregation(
     public ResponseEntity<?> getRuleCheckTestRulePageEnabled() {
         LOGGER.debug("Getting Enabling Status of Rules Check Service");
         try {
-            return new ResponseEntity<>(new JSONObject().put("status", testEnable).toString(), HttpStatus.OK);
+            return new ResponseEntity<>(new JSONObject().put("status", testEnabled).toString(), HttpStatus.OK);
         } catch (Exception e) {
             String errorMessage = "Internal Server Error: Failed to get status.";
             LOGGER.error(errorMessage, e);

src/main/java/com/ericsson/ei/controller/model/QueryBody.java

@@ -24,9 +24,9 @@
 public class QueryBody {
 
     /**
-     *
+     * 
      * (Required)
-     *
+     * 
      */
     @JsonProperty("criteria")
     @Valid
@@ -42,19 +42,19 @@ public class QueryBody {
     private Map<String, Object> additionalProperties = new HashMap<String, Object>();
 
     /**
-     *
+     * 
      * (Required)
-     *
+     * 
      */
     @JsonProperty("criteria")
     public Criteria getCriteria() {
         return criteria;
     }
 
     /**
-     *
+     * 
      * (Required)
-     *
+     * 
      */
     @JsonProperty("criteria")
     public void setCriteria(Criteria criteria) {

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

@@ -103,6 +103,15 @@ public RulesObject getRulesForEvent(String event) {
         return null;
     }
 
+    /**
+     * Returns the active rules used by Eiffel Intelligence.
+     *
+     * @return rules content
+     */
+    public JsonNode getRulesContent() {
+        return parsedJson;
+    }
+
     /**
      * Reads the content of a given rules file path or URL.
      *

src/main/resources/public/raml/resourceTypes/rules.raml

@@ -1,4 +1,13 @@
-description: This class is used to test rules on Eiffel events. Testrules must be enabled in Eiffel Intelligence.
+description: This class is used for anything rules related. It's currently used to test rules on Eiffel events
+             and to fetch the active rules file content. Test rules must be enabled in Eiffel Intelligence
+             for the /rule-check endpoints to work.
+get:
+  description: This method returns the active rules content.
+  responses:
+    200:
+      body:
+        application/string:
+
 /rule-check:
   post:
     description: This method extracts data from a single Eiffel event based on the given JMESPath expression.

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

@@ -48,7 +48,7 @@
 import org.springframework.util.SocketUtils;
 
 import com.ericsson.ei.App;
-import com.ericsson.ei.controller.RuleCheckControllerImpl;
+import com.ericsson.ei.controller.RuleControllerImpl;
 import com.ericsson.ei.services.IRuleCheckService;
 
 @RunWith(SpringJUnit4ClassRunner.class)
@@ -158,8 +158,8 @@ public void testGetTestRulePageEnabledAPI_ensurePropertyFalse() throws Exception
     @Test
     public void testGetTestRulePageEnabledAPI_setPropertyTrue() throws Exception {
         String responseBody = new JSONObject().put("status", true).toString();
-        RuleCheckControllerImpl ruleCheckControllerImpl = new RuleCheckControllerImpl();
-        ruleCheckControllerImpl.setTestEnable(true);
+        RuleControllerImpl ruleCheckControllerImpl = new RuleControllerImpl();
+        ruleCheckControllerImpl.setTestEnabled(true);
         ResponseEntity<?> responseEntity = ruleCheckControllerImpl.getRuleCheckTestRulePageEnabled();
         assertEquals(HttpStatus.OK, responseEntity.getStatusCode());
         assertEquals(responseBody, responseEntity.getBody().toString());
@@ -169,8 +169,8 @@ public void testGetTestRulePageEnabledAPI_setPropertyTrue() throws Exception {
     @Test
     public void testGetTestRulePageEnabledAPI_setPropertyFalse() throws Exception {
         String responseBody = new JSONObject().put("status", false).toString();
-        RuleCheckControllerImpl ruleCheckControllerImpl = new RuleCheckControllerImpl();
-        ruleCheckControllerImpl.setTestEnable(false);
+        RuleControllerImpl ruleCheckControllerImpl = new RuleControllerImpl();
+        ruleCheckControllerImpl.setTestEnabled(false);
         ResponseEntity<?> responseEntity = ruleCheckControllerImpl.getRuleCheckTestRulePageEnabled();
         assertEquals(HttpStatus.OK, responseEntity.getStatusCode());
         assertEquals(responseBody, responseEntity.getBody().toString());