EI Subscription REST POST supporting authentication headers (#100)

saif-ericsson · web-flow · commit ebd10eab3634 · 2018-05-30T10:15:02.000+02:00
* JMESPath REST API

* JMESPath  API with fixed reviews

* partial work jmespath rest

* JMESPath API with RAML 0.8 specification

* remove componet comment

* replace tab with spaces

* fix usage examples

* prepare for new asserts in flow test

* fix unit tests

* Subscription for individual events

* pom file

* subscription individual objects

* pom

* error removal

* Subscription Individual Object

* deleting unused import

* jmespath comment correction

* space removal and new clean build

* review changes

* review change file deleted

* review change

* review changes

* log.info to log.error

* required changes

* raml

* raml files

* resolving conflict

* self generated code raml

* controllers auto generated

* auto generated

* removing ttl

* adding ttl

* copied pom

* changes in app.properties

* resolving conflict with upstream

* adding more files

* added time lapse variable

* rebased...

* new clone and update

* reviewed changes

* review changes-evasiba

* review changes 2:evasiba

* handling of authorization by Subscription REST API: 9584

* changing property name

* pom updated

* method change

* reviewed changes-1

* some review changes regarding comments

* some changes ´to get pass throguh tests

* review changes

* Update application.properties

* Fix test

* development

* changes

* code changes related to story 9561

* error

* error removal

* requested changes

* reviewed change

* reviewed changes
diff --git a/src/main/java/com/ericsson/ei/subscriptionhandler/InformSubscription.java b/src/main/java/com/ericsson/ei/subscriptionhandler/InformSubscription.java
@@ -23,6 +23,7 @@
 import com.mongodb.BasicDBObject;
 import com.mongodb.util.JSON;
 import lombok.Getter;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -50,7 +51,7 @@
 public class InformSubscription {
 
     private static final Logger LOGGER = (Logger) LoggerFactory.getLogger(InformSubscription.class);
-    //Regular expression for replacement unexpected character like \"|
+    // Regular expression for replacement unexpected character like \"|
     private static final String REGEX = "^\"|\"$";
 
     @Getter
@@ -90,28 +91,42 @@ public class InformSubscription {
      * @param subscriptionJson
      */
     public void informSubscriber(String aggregatedObject, JsonNode subscriptionJson) {
-        String subscriptionName = subscriptionJson.get("subscriptionName").toString().replaceAll(REGEX, "");
-        LOGGER.debug("SubscriptionName : " + subscriptionName);
-        String notificationType = subscriptionJson.get("notificationType").toString().replaceAll(REGEX, "");
-        LOGGER.debug("NotificationType : " + notificationType);
-        String notificationMeta = subscriptionJson.get("notificationMeta").toString().replaceAll(REGEX, "");
-        LOGGER.debug("NotificationMeta : " + notificationMeta);
+        String subscriptionName = getSubscriptionField("subscriptionName", subscriptionJson);
+        String notificationType = getSubscriptionField("notificationType", subscriptionJson);
+        String notificationMeta = getSubscriptionField("notificationMeta", subscriptionJson);
+
+        String key = "";
+        String val = "";
         MultiValueMap<String, String> mapNotificationMessage = new LinkedMultiValueMap<>();
         ArrayNode arrNode = (ArrayNode) subscriptionJson.get("notificationMessageKeyValues");
         if (arrNode.isArray()) {
             for (final JsonNode objNode : arrNode) {
-                mapNotificationMessage.add(objNode.get("formkey").toString().replaceAll(REGEX, ""), jmespath
-                        .runRuleOnEvent(objNode.get("formvalue").toString().replaceAll(REGEX, ""), aggregatedObject)
-                        .toString().replaceAll(REGEX, ""));
+                if (objNode.get("formkey").toString().replaceAll(REGEX, "").equals("Authorization")) {
+                    key = "Authorization";
+                    val = objNode.get("formvalue").toString().replaceAll(REGEX, "");
+
+                } else {
+
+                    mapNotificationMessage.add(objNode.get("formkey").toString().replaceAll(REGEX, ""), jmespath
+                            .runRuleOnEvent(objNode.get("formvalue").toString().replaceAll(REGEX, ""), aggregatedObject)
+                            .toString().replaceAll(REGEX, ""));
+                }
             }
         }
         if (notificationType.trim().equals("REST_POST")) {
             LOGGER.debug("Notification through REST_POST");
             int result;
-            String headerContentMediaType = subscriptionJson.get("restPostBodyMediaType").toString()
-                    .replaceAll(REGEX, "");
+            String headerContentMediaType = subscriptionJson.get("restPostBodyMediaType").toString().replaceAll(REGEX,
+                    "");
             LOGGER.debug("headerContentMediaType : " + headerContentMediaType);
-            result = restTemplate.postDataMultiValue(notificationMeta, mapNotificationMessage, headerContentMediaType);
+            if (!key.isEmpty() && !val.isEmpty()) {
+                result = restTemplate.postDataMultiValue(notificationMeta, mapNotificationMessage,
+                        headerContentMediaType, key, val);
+            } else {
+                result = restTemplate.postDataMultiValue(notificationMeta, mapNotificationMessage,
+                        headerContentMediaType);
+            }
+
             if (result == HttpStatus.OK.value() || result == HttpStatus.CREATED.value()
                     || result == HttpStatus.NO_CONTENT.value()) {
                 LOGGER.debug("The result is : " + result);
@@ -141,12 +156,12 @@ public void informSubscriber(String aggregatedObject, JsonNode subscriptionJson)
         } else if (notificationType.trim().equals("MAIL")) {
             LOGGER.debug("Notification through EMAIL");
             try {
-                sendMail.sendMail(notificationMeta,
-                        String.valueOf((mapNotificationMessage.get("")).get(0)));
+                sendMail.sendMail(notificationMeta, String.valueOf((mapNotificationMessage.get("")).get(0)));
             } catch (MessagingException e) {
                 e.printStackTrace();
                 LOGGER.error(e.getMessage());
             }
+
         }
     }
 
@@ -159,7 +174,8 @@ public void informSubscriber(String aggregatedObject, JsonNode subscriptionJson)
      * @param notificationMeta
      * @return String
      */
-    private String prepareMissedNotification(String aggregatedObject, String subscriptionName, String notificationMeta) {
+    private String prepareMissedNotification(String aggregatedObject, String subscriptionName,
+            String notificationMeta) {
         Date date = new Date();
         DateFormat dateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
         String time = dateFormat.format(date);
@@ -175,6 +191,19 @@ private String prepareMissedNotification(String aggregatedObject, String subscri
         document.put("AggregatedObject", JSON.parse(aggregatedObject));
         return document.toString();
     }
+    
+    /**
+     * This method, given the field name, returns its value
+     *
+     * @param subscriptionJson
+     * @param fieldName
+     * @return field value
+     */
+    private String getSubscriptionField(String fieldName, JsonNode subscriptionJson) {
+        String value = subscriptionJson.get(fieldName).toString().replaceAll(REGEX, "");
+        LOGGER.debug("Extracted field name and value from subscription json:" + fieldName + " : " + value);
+        return value;
+    }
 
     /**
      * This method is responsible to display the configurable application properties
diff --git a/src/main/java/com/ericsson/ei/subscriptionhandler/SpringRestTemplate.java b/src/main/java/com/ericsson/ei/subscriptionhandler/SpringRestTemplate.java
@@ -17,6 +17,7 @@
 package com.ericsson.ei.subscriptionhandler;
 
 import com.fasterxml.jackson.databind.JsonNode;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.web.client.RestTemplateBuilder;
@@ -42,23 +43,34 @@ public SpringRestTemplate(RestTemplateBuilder builder) {
     }
 
     /**
-     * This method is responsible to notify the subscriber through REST POST With raw body and form parameters.
+     * This method is responsible to notify the subscriber through REST POST With
+     * raw body and form parameters.
      *
      * @param notificationMeta
      * @param mapNotificationMessage
      * @param headerContentMediaType
      * @return integer
      */
-    public int postDataMultiValue(String notificationMeta, MultiValueMap<String, String> mapNotificationMessage, String headerContentMediaType) {
+    public int postDataMultiValue(String notificationMeta, MultiValueMap<String, String> mapNotificationMessage,
+            String headerContentMediaType, String... args) {
         ResponseEntity<JsonNode> response;
+
         try {
             HttpHeaders headers = new HttpHeaders();
             headers.setContentType(MediaType.valueOf(headerContentMediaType));
-            if (headerContentMediaType.equals(MediaType.APPLICATION_FORM_URLENCODED.toString())) { //"application/x-www-form-urlencoded"
+            if (headerContentMediaType.equals(MediaType.APPLICATION_FORM_URLENCODED.toString())) { // "application/x-www-form-urlencoded"
+
+                if (args.length != 0) {
+                    String key = args[0];
+                    String val = args[1];
+                    headers.add(key, val);
+                }
+
                 HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(mapNotificationMessage, headers);
                 response = rest.postForEntity(notificationMeta, request, JsonNode.class);
             } else {
-                HttpEntity<String> request = new HttpEntity<>(String.valueOf((mapNotificationMessage.get("")).get(0)), headers);
+                HttpEntity<String> request = new HttpEntity<>(String.valueOf((mapNotificationMessage.get("")).get(0)),
+                        headers);
                 response = rest.postForEntity(notificationMeta, request, JsonNode.class);
             }
         } catch (Exception e) {
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -72,7 +72,6 @@ spring.mail.properties.mail.smtp.auth: false
 er.url: http://localhost:8080/search/
 
 ldap.enabled:false
-
 ldap.url:
 ldap.base.dn:
 ldap.username:
diff --git a/src/test/java/com/ericsson/ei/subscriptionhandler/test/SubscriptionHandlerTest.java b/src/test/java/com/ericsson/ei/subscriptionhandler/test/SubscriptionHandlerTest.java
@@ -51,7 +51,6 @@
 import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
 import org.springframework.util.LinkedMultiValueMap;
 import org.springframework.util.MultiValueMap;
-
 import com.ericsson.ei.App;
 import com.ericsson.ei.controller.model.QueryResponse;
 import com.ericsson.ei.exception.SubscriptionValidationException;
@@ -71,26 +70,30 @@
 import de.flapdoodle.embed.mongo.tests.MongodForTestsFactory;
 
 @RunWith(SpringJUnit4ClassRunner.class)
-@SpringBootTest(classes = {
-        App.class
-    })
+@SpringBootTest(classes = { App.class })
 @AutoConfigureMockMvc
 public class SubscriptionHandlerTest {
 
     private static final Logger LOGGER = (Logger) LoggerFactory.getLogger(SubscriptionHandlerTest.class);
     private static final String aggregatedPath = "src/test/resources/AggregatedObject.json";
     private static final String subscriptionPath = "src/test/resources/SubscriptionObject.json";
+    private static final String subscriptionPathForAuthorization = "src/test/resources/SubscriptionObjectForAuthorization.json";
     private static final String DB_NAME = "MissedNotification";
     private static final String COLLECTION_NAME = "Notification";
     private static final String REGEX = "^\"|\"$";
     private static final String MISSED_NOTIFICATION_URL = "/queryMissedNotifications";
     private static final int STATUS_OK = 200;
     private static String aggregatedObject;
     private static String subscriptionData;
+    private static String subscriptionDataForAuthorization;
     private static String url;
     private static String headerContentMediaType;
+    private static String urlAuthorization;
+    private static String headerContentMediaTypeAuthorization;
     private static MongodForTestsFactory testsFactory;
     private static MongoClient mongoClient = null;
+    private static final String formkey = "Authorization";
+    private static final String formvalue = "Basic XX0=";
 
     @Autowired
     private RunSubscription runSubscription;
@@ -144,6 +147,7 @@ public static void setUpEmbeddedMongo() throws JSONException, IOException {
             subscriptionData = FileUtils.readFileToString(new File(subscriptionPath), "UTF-8");
             subscriptionRepeatFlagTrueData = FileUtils.readFileToString(new File(subscriptionRepeatFlagTruePath),
                     "UTF-8");
+            subscriptionDataForAuthorization = FileUtils.readFileToString(new File(subscriptionPathForAuthorization), "UTF-8");
             subscriptionDataEmail = FileUtils.readFileToString(new File(subscriptionPathForEmail), "UTF-8");
         } catch (Exception e) {
             LOGGER.error(e.getMessage(), e);
@@ -152,6 +156,8 @@ public static void setUpEmbeddedMongo() throws JSONException, IOException {
 
         url = new JSONObject(subscriptionData).getString("notificationMeta").replaceAll(REGEX, "");
         headerContentMediaType = new JSONObject(subscriptionData).getString("restPostBodyMediaType");
+        urlAuthorization = new JSONObject(subscriptionDataForAuthorization).getString("notificationMeta").replaceAll(REGEX, "");
+        headerContentMediaTypeAuthorization = new JSONObject(subscriptionDataForAuthorization).getString("restPostBodyMediaType");
     }
 
     @BeforeClass
@@ -288,16 +294,27 @@ public void sendMailTest() {
 
     @Test
     public void testRestPostTrigger() throws IOException {
-        when(springRestTemplate.postDataMultiValue(url, mapNotificationMessage(), headerContentMediaType))
-                .thenReturn(STATUS_OK);
+        when(springRestTemplate.postDataMultiValue(url, mapNotificationMessage(subscriptionData),
+                headerContentMediaType)).thenReturn(STATUS_OK);
         subscription.informSubscriber(aggregatedObject, new ObjectMapper().readTree(subscriptionData));
-        verify(springRestTemplate, times(1)).postDataMultiValue(url, mapNotificationMessage(), headerContentMediaType);
+        verify(springRestTemplate, times(1)).postDataMultiValue(url, mapNotificationMessage(subscriptionData),
+                headerContentMediaType);
+    }
+
+    @Test
+    public void testRestPostTriggerForAuthorization() throws IOException {
+        when(springRestTemplate.postDataMultiValue(urlAuthorization, mapNotificationMessage(subscriptionDataForAuthorization),
+                headerContentMediaTypeAuthorization, formkey, formvalue)).thenReturn(STATUS_OK);
+        subscription.informSubscriber(aggregatedObject, new ObjectMapper().readTree(subscriptionDataForAuthorization));
+        verify(springRestTemplate, times(1)).postDataMultiValue(urlAuthorization,
+                mapNotificationMessage(subscriptionDataForAuthorization), headerContentMediaTypeAuthorization, formkey, formvalue);
     }
 
     @Test
     public void testRestPostTriggerFailure() throws IOException {
         subscription.informSubscriber(aggregatedObject, new ObjectMapper().readTree(subscriptionData));
-        verify(springRestTemplate, times(4)).postDataMultiValue(url, mapNotificationMessage(), headerContentMediaType);
+        verify(springRestTemplate, times(4)).postDataMultiValue(url, mapNotificationMessage(subscriptionData),
+                headerContentMediaType);
         assertFalse(mongoDBHandler.getAllDocuments(DB_NAME, COLLECTION_NAME).isEmpty());
     }
 
@@ -315,16 +332,18 @@ public void testQueryMissedNotificationEndPoint() throws Exception {
         assertEquals(HttpStatus.OK.value(), result.getResponse().getStatus());
     }
 
-    private MultiValueMap<String, String> mapNotificationMessage() throws IOException {
+    private MultiValueMap<String, String> mapNotificationMessage(String data) throws IOException {
         MultiValueMap<String, String> mapNotificationMessage = new LinkedMultiValueMap<>();
 
-        ArrayNode arrNode = (ArrayNode) new ObjectMapper().readTree(subscriptionData)
-                .get("notificationMessageKeyValues");
+        ArrayNode arrNode = (ArrayNode) new ObjectMapper().readTree(data).get("notificationMessageKeyValues");
         if (arrNode.isArray()) {
             for (final JsonNode objNode : arrNode) {
-                mapNotificationMessage.add(objNode.get("formkey").toString().replaceAll(REGEX, ""), jmespath
-                        .runRuleOnEvent(objNode.get("formvalue").toString().replaceAll(REGEX, ""), aggregatedObject)
-                        .toString().replaceAll(REGEX, ""));
+                if (!objNode.get("formkey").toString().replaceAll(REGEX, "").equals("Authorization")) {
+
+                    mapNotificationMessage.add(objNode.get("formkey").toString().replaceAll(REGEX, ""), jmespath
+                            .runRuleOnEvent(objNode.get("formvalue").toString().replaceAll(REGEX, ""), aggregatedObject)
+                            .toString().replaceAll(REGEX, ""));
+                }
             }
         }
         return mapNotificationMessage;
diff --git a/src/test/resources/SubscriptionForMail.json b/src/test/resources/SubscriptionForMail.json
@@ -1,5 +1,6 @@
 {
   "subscriptionName": "Subscription_1",
+  "userName" : "DEF",
   "repeat": false,
   "created": "data-time",
   "notificationType": "MAIL",
diff --git a/src/test/resources/SubscriptionObject.json b/src/test/resources/SubscriptionObject.json
@@ -1,5 +1,6 @@
 {
         "subscriptionName": "Subscription_1",
+        "userName" : "DEF",
         "repeat": false,
         "created": "data-time",
         "notificationType": "REST_POST",
@@ -11,6 +12,7 @@
             "formvalue" : "@"
           }
         ],
+        
         "requirements": [
             {
                 "type": "ARTIFACT_1",
diff --git a/src/test/resources/SubscriptionObjectForAuthorization.json b/src/test/resources/SubscriptionObjectForAuthorization.json
@@ -0,0 +1,38 @@
+{
+        "subscriptionName": "Subscription_1",
+        "userName" : "DEF",
+        "repeat": false,
+        "created": "data-time",
+        "notificationType": "REST_POST",
+        "notificationMeta": "https://jenkins.domain.com:8100/jenkins/job/test_params/build",
+        "restPostBodyMediaType": "application/x-www-form-urlencoded",
+        "notificationMessageKeyValues" : [
+          {
+            "formkey" : "json",
+            "formvalue" : "{parameter: [{ name: 'parameter', value : 'parameterValue' }]}"
+          },
+          {
+            "formkey" : "Authorization",
+            "formvalue" : "Basic XX0="
+          }
+        ],
+
+        "requirements": [
+            {
+                "type": "ARTIFACT_1",
+                "conditions": [
+                    {"jmespath": "gav.groupId=='com.mycompany.myproduct'"},
+                    {"jmespath": "testCaseExecutions[?testCase.conclusion == 'SUCCESSFUL' && testCase.id=='TC5']"}
+                ]
+
+            },
+            {
+                "type": "ARTIFACT_1",
+                "conditions": [
+                    {"jmespath": "gav.groupId=='com.mycompany.myproduct'"},
+                    {"jmespath": "testCaseExecutions[?testCaseStartedEventId == '13af4a14-f951-4346-a1ba-624c79f10e98']"}
+                ]
+
+            }
+        ]
+    }

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"subscriptionName": "Subscription_1",`
	`3`	`+ "userName" : "DEF",`
`3`	`4`	`"repeat": false,`
`4`	`5`	`"created": "data-time",`
`5`	`6`	`"notificationType": "MAIL",`