Allow customization of commonEventHeadres before request is sent 69/116169/3
authorEli Halych <illia.halych@t-mobile.pl>
Mon, 7 Dec 2020 13:13:53 +0000 (13:13 +0000)
committerEli Halych <illia.halych@t-mobile.pl>
Mon, 7 Dec 2020 13:40:12 +0000 (13:40 +0000)
Details:
- Python handler is allowed to take --data argument with fields to be overriden.
- In python handler the original dictionary from config.json is merged with custom sourceName
 and reportingEntityName if provided.
- Java source code generates default sourceName and reportingEntityName as part of default data in
the form of "default-XXX", where XXX is YEAR, MONTH and DAY as integers.
- If such default data is received in the request body, don't override them with default values.
- BUG FIXED: the previous solution used abstract path that could be "/" that resulted in empty strings
for sourceName and reportingEntityName.

Issue-ID: INT-1800
Signed-off-by: Eli Halych <illia.halych@t-mobile.pl>
Change-Id: Ic88c5606a44abac64f842f28621332f3f86b83c6

test/mocks/masspnfsim/MassPnfSim.py
test/mocks/masspnfsim/pnf-sim-lightweight/src/main/java/org/onap/pnfsimulator/message/JSONObjectFactory.java

index c9c84e8..50e4b6e 100755 (executable)
@@ -27,6 +27,15 @@ def validate_url(url):
         pass
     return url
 
+def merge_dictionaries(origin, custom):
+    '''Combine 2 dictionaries based on common keys.'''
+    return {
+            key: dict(
+                origin.get(key, {}),
+                **custom.get(key, {}))
+            for key in origin.keys() | custom.keys()
+        }
+
 def validate_ip(ip):
     '''Helper function to validate input param is a vaild IP address'''
     try:
@@ -84,6 +93,7 @@ def get_parser():
                                      metavar='INT', required=True)
     parser_triggerstart.add_argument('--user', help='VES auth username', type=str, metavar='USERNAME')
     parser_triggerstart.add_argument('--password', help='VES auth password', type=str, metavar='PASSWORD')
+    parser_triggerstart.add_argument('--data', help='Custom data to override default values', type=dict, metavar='DATA')
     # Status command parser
     parser_status = subparsers.add_parser('status', help='Status')
     parser_status.add_argument('--count', help='Instance count to show status for', type=int, metavar='INT', default=0)
@@ -150,7 +160,7 @@ class MassPnfSim:
         self.logger = logging.getLogger(__name__)
         self.logger.setLevel(self.log_lvl)
         self.sim_dirname_pattern = "pnf-sim-lw-"
-        self.mvn_build_cmd = 'mvn clean package docker:build -Dcheckstyle.skip '
+        self.mvn_build_cmd = 'mvn clean package docker:build -Dcheckstyle.skip'
         self.docker_compose_status_cmd = 'docker-compose ps'
 
     def _run_cmd(self, cmd, dir_context='.'):
@@ -427,15 +437,19 @@ class MassPnfSim:
     @_MassPnfSim_Decorators.validate_subcommand
     def trigger(self, args): # pylint: disable=W0613
         self.logger.info("Triggering VES sending:")
+
         for i in range(*self._get_iter_range()):
+
             sim_ip = self._get_sim_instance_data(i)
             self.logger.info(f'Triggering {self.sim_dirname_pattern}{i} instance:')
             self.logger.info(f' PNF-Sim IP: {sim_ip}')
+
             # create a Basic auth token
             plaintext_auth = f"{args.user}:{args.password}"
             basic_auth_base64 = get_auth_token_base64(plaintext_auth)
             basic_auth_token = f"Basic {basic_auth_base64}"
             self.logger.info((basic_auth_base64))
+
             # setup req headers
             req_headers = {
                     "Content-Type": "application/json",
@@ -444,17 +458,28 @@ class MassPnfSim:
                     "Authorization": basic_auth_token
                 }
             self.logger.debug(f' Request headers: {req_headers}')
+
             try:
+
                 # get payload for the request
                 with open(f'{self.sim_dirname_pattern}{i}/{self.sim_msg_config}') as data:
+
                     json_data = loads(data.read())
+                    try:
+                        json_data = merge_dictionaries(json_data, args.data)
+                    except AttributeError:
+                        self.logger.debug('The request will be sent without customization.')
+
                     self.logger.debug(f' JSON payload for the simulator:\n{json_data}')
+
                     # make a http request to the simulator
                     sim_response = post('{}'.format(self.sim_start_url).format(sim_ip), headers=req_headers, json=json_data)
+
                     if sim_response.status_code == codes.ok:
                         self.logger.info(' Simulator response: ' + sim_response.text)
                     else:
                         self.logger.warning(' Simulator response ' + sim_response.text)
+
             except TypeError:
                 self.logger.error(f' Could not load JSON data from {self.sim_dirname_pattern}{i}/{self.sim_msg_config}')
 
index ded9910..7c12983 100644 (file)
@@ -50,6 +50,7 @@ import static org.onap.pnfsimulator.message.MessageConstants.VERSION;
 import static org.onap.pnfsimulator.message.MessageConstants.VERSION_NUMBER;
 import static org.onap.pnfsimulator.message.MessageConstants.VES_EVENT_LISTENER_VERSION;
 import static org.onap.pnfsimulator.message.MessageConstants.VES_EVENT_LISTENER_VERSION_NUMBER;
+import java.util.Calendar;
 import java.io.File;
 import java.util.List;
 import java.util.TimeZone;
@@ -61,6 +62,7 @@ final class JSONObjectFactory {
     static JSONObject generateConstantCommonEventHeader() {
         JSONObject commonEventHeader = new JSONObject();
         long timestamp = System.currentTimeMillis();
+        String nodeName = generateDefaultName();
         commonEventHeader.put(EVENT_ID, generateEventId());
         commonEventHeader.put(TIME_ZONE_OFFSET, generateTimeZone(timestamp));
         commonEventHeader.put(LAST_EPOCH_MICROSEC, timestamp);
@@ -70,8 +72,6 @@ final class JSONObjectFactory {
         commonEventHeader.put(INTERNAL_HEADER_FIELDS, new JSONObject());
         commonEventHeader.put(VERSION, VERSION_NUMBER);
         commonEventHeader.put(VES_EVENT_LISTENER_VERSION, VES_EVENT_LISTENER_VERSION_NUMBER);
-        String absPath = new File("").getAbsolutePath();
-        String nodeName = absPath.substring(absPath.lastIndexOf(File.separator)+1);
         commonEventHeader.put(SOURCE_NAME, nodeName);
         commonEventHeader.put(REPORTING_ENTITY_NAME, nodeName);
         return commonEventHeader;
@@ -118,6 +118,15 @@ final class JSONObjectFactory {
         return String.format("FileReady_%s", timeAsString);
     }
 
+    static String generateDefaultName() {
+        String defaultName = "default";
+        int year = Calendar.getInstance().get(Calendar.YEAR);
+        int month = Calendar.getInstance().get(Calendar.MONTH);
+        int day = Calendar.getInstance().get(Calendar.DAY_OF_MONTH);
+
+        return defaultName + "-" + year + month + day;
+    }
+
     static String generateTimeZone(long timestamp) {
         TimeZone timeZone = TimeZone.getDefault();
         int offsetInMillis = timeZone.getOffset(timestamp);