gerrit.onap Code Review - dcaegen2/collectors/datafile.git/blob

   1 /*-
   2  * ============LICENSE_START========================================================================
   3  * Copyright (C) 2018 NOKIA Intellectual Property, 2018-2019 Nordix Foundation. All rights reserved.
   4  * ==================================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  */
  18
  19 package org.onap.dcaegen2.collectors.datafile.service;
  20
  21 import com.google.gson.JsonArray;
  22 import com.google.gson.JsonElement;
  23 import com.google.gson.JsonObject;
  24 import com.google.gson.JsonParser;
  25 import java.net.URI;
  26 import java.util.ArrayList;
  27 import java.util.List;
  28 import java.util.Optional;
  29 import java.util.stream.StreamSupport;
  30 import org.onap.dcaegen2.collectors.datafile.ftp.Scheme;
  31 import org.onap.dcaegen2.collectors.datafile.model.FileData;
  32 import org.onap.dcaegen2.collectors.datafile.model.FileReadyMessage;
  33 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFileData;
  34 import org.onap.dcaegen2.collectors.datafile.model.ImmutableFileReadyMessage;
  35 import org.onap.dcaegen2.collectors.datafile.model.ImmutableMessageMetaData;
  36 import org.onap.dcaegen2.collectors.datafile.model.MessageMetaData;
  37 import org.slf4j.Logger;
  38 import org.slf4j.LoggerFactory;
  39 import org.springframework.util.StringUtils;
  40 import reactor.core.publisher.Flux;
  41 import reactor.core.publisher.Mono;
  42
  43 /**
  44  * Parses the fileReady event and creates a Flux of FileReadyMessage containing the information.
  45  *
  46  * @author <a href="mailto:henrik.b.andersson@est.tech">Henrik Andersson</a>
  47  */
  48 public class JsonMessageParser {
  49     private static final Logger logger = LoggerFactory.getLogger(JsonMessageParser.class);
  50
  51     private static final String COMMON_EVENT_HEADER = "commonEventHeader";
  52     private static final String EVENT_NAME = "eventName";
  53     private static final String LAST_EPOCH_MICROSEC = "lastEpochMicrosec";
  54     private static final String SOURCE_NAME = "sourceName";
  55     private static final String START_EPOCH_MICROSEC = "startEpochMicrosec";
  56     private static final String TIME_ZONE_OFFSET = "timeZoneOffset";
  57
  58     private static final String EVENT = "event";
  59     private static final String NOTIFICATION_FIELDS = "notificationFields";
  60     private static final String CHANGE_IDENTIFIER = "changeIdentifier";
  61     private static final String CHANGE_TYPE = "changeType";
  62     private static final String NOTIFICATION_FIELDS_VERSION = "notificationFieldsVersion";
  63
  64     private static final String ARRAY_OF_NAMED_HASH_MAP = "arrayOfNamedHashMap";
  65     private static final String NAME = "name";
  66     private static final String HASH_MAP = "hashMap";
  67     private static final String LOCATION = "location";
  68     private static final String COMPRESSION = "compression";
  69     private static final String FILE_FORMAT_TYPE = "fileFormatType";
  70     private static final String FILE_FORMAT_VERSION = "fileFormatVersion";
  71
  72     private static final String FILE_READY_CHANGE_TYPE = "FileReady";
  73     private static final String FILE_READY_CHANGE_IDENTIFIER = "PM_MEAS_FILES";
  74
  75     /**
  76      * The data types available in the event name.
  77      */
  78     private enum EventNameDataType {
  79         PRODUCT_NAME(1), VENDOR_NAME(2);
  80
  81         private int index;
  82
  83         EventNameDataType(int index) {
  84             this.index = index;
  85         }
  86     }
  87
  88     /**
  89      * Parses the Json message and returns a stream of messages.
  90      *
  91      * @param rawMessage the Json message to parse.
  92      * @return a <code>Flux</code> containing messages.
  93      */
  94     public Flux<FileReadyMessage> getMessagesFromJson(Mono<String> rawMessage) {
  95         return rawMessage.flatMapMany(this::getJsonParserMessage).flatMap(this::createMessageData);
  96     }
  97
  98     Optional<JsonObject> getJsonObjectFromAnArray(JsonElement element) {
  99         JsonParser jsonParser = new JsonParser();
 100         if (element.isJsonPrimitive()) {
 101             return Optional.of(jsonParser.parse(element.getAsString()).getAsJsonObject());
 102         } else if (element.isJsonObject()) {
 103             return Optional.of((JsonObject) element);
 104         } else {
 105             return Optional.of(jsonParser.parse(element.toString()).getAsJsonObject());
 106         }
 107     }
 108
 109     private Flux<FileReadyMessage> getMessagesFromJsonArray(JsonElement jsonElement) {
 110         return createMessages(Flux.fromStream(StreamSupport.stream(jsonElement.getAsJsonArray().spliterator(), false)
 111                 .map(jsonElementFromArray -> getJsonObjectFromAnArray(jsonElementFromArray)
 112                         .orElseGet(JsonObject::new))));
 113     }
 114
 115     /**
 116      * Extract info from string and create a Flux of {@link FileReadyMessage}.
 117      *
 118      * @param rawMessage - results from DMaaP
 119      * @return reactive Flux of FileReadyMessages
 120      */
 121     private Flux<FileReadyMessage> createMessageData(JsonElement jsonElement) {
 122         return jsonElement.isJsonObject() ? createMessages(Flux.just(jsonElement.getAsJsonObject()))
 123                 : getMessagesFromJsonArray(jsonElement);
 124     }
 125
 126     private Mono<JsonElement> getJsonParserMessage(String message) {
 127         logger.trace("original message from message router: {}", message);
 128         return StringUtils.isEmpty(message) ? Mono.empty() : Mono.fromSupplier(() -> new JsonParser().parse(message));
 129     }
 130
 131     private Flux<FileReadyMessage> createMessages(Flux<JsonObject> jsonObject) {
 132         return jsonObject.flatMap(monoJsonP -> containsNotificationFields(monoJsonP) ? transformMessages(monoJsonP)
 133                 : logErrorAndReturnEmptyMessageFlux("Incorrect JsonObject - missing header. " + jsonObject));
 134     }
 135
 136
 137     private Mono<FileReadyMessage> transformMessages(JsonObject message) {
 138         Optional<MessageMetaData> optionalMessageMetaData = getMessageMetaData(message);
 139         if (optionalMessageMetaData.isPresent()) {
 140             MessageMetaData messageMetaData = optionalMessageMetaData.get();
 141             JsonObject notificationFields = message.getAsJsonObject(EVENT).getAsJsonObject(NOTIFICATION_FIELDS);
 142             JsonArray arrayOfNamedHashMap = notificationFields.getAsJsonArray(ARRAY_OF_NAMED_HASH_MAP);
 143             if (arrayOfNamedHashMap != null) {
 144                 List<FileData> allFileDataFromJson = getAllFileDataFromJson(arrayOfNamedHashMap, messageMetaData);
 145                 if (!allFileDataFromJson.isEmpty()) {
 146                     return Mono.just(ImmutableFileReadyMessage.builder() //
 147                             .files(allFileDataFromJson) //
 148                             .build());
 149                 } else {
 150                     return Mono.empty();
 151                 }
 152             }
 153
 154             logger.error("VES event parsing. Missing arrayOfNamedHashMap in message. {}", message);
 155             return Mono.empty();
 156         }
 157         logger.error("VES event parsing. FileReady event has incorrect JsonObject. {}", message);
 158         return Mono.empty();
 159     }
 160
 161
 162     private Optional<MessageMetaData> getMessageMetaData(JsonObject message) {
 163         List<String> missingValues = new ArrayList<>();
 164         JsonObject commonEventHeader = message.getAsJsonObject(EVENT).getAsJsonObject(COMMON_EVENT_HEADER);
 165         String eventName = getValueFromJson(commonEventHeader, EVENT_NAME, missingValues);
 166
 167         JsonObject notificationFields = message.getAsJsonObject(EVENT).getAsJsonObject(NOTIFICATION_FIELDS);
 168         String changeIdentifier = getValueFromJson(notificationFields, CHANGE_IDENTIFIER, missingValues);
 169         String changeType = getValueFromJson(notificationFields, CHANGE_TYPE, missingValues);
 170
 171         // Just to check that it is in the message. Might be needed in the future if there is a new
 172         // version.
 173         getValueFromJson(notificationFields, NOTIFICATION_FIELDS_VERSION, missingValues);
 174
 175         MessageMetaData messageMetaData = ImmutableMessageMetaData.builder() //
 176                 .productName(getDataFromEventName(EventNameDataType.PRODUCT_NAME, eventName, missingValues)) //
 177                 .vendorName(getDataFromEventName(EventNameDataType.VENDOR_NAME, eventName, missingValues)) //
 178                 .lastEpochMicrosec(getValueFromJson(commonEventHeader, LAST_EPOCH_MICROSEC, missingValues)) //
 179                 .sourceName(getValueFromJson(commonEventHeader, SOURCE_NAME, missingValues)) //
 180                 .startEpochMicrosec(getValueFromJson(commonEventHeader, START_EPOCH_MICROSEC, missingValues)) //
 181                 .timeZoneOffset(getValueFromJson(commonEventHeader, TIME_ZONE_OFFSET, missingValues)) //
 182                 .changeIdentifier(changeIdentifier) //
 183                 .changeType(changeType) //
 184                 .build();
 185         if (missingValues.isEmpty() && isChangeIdentifierCorrect(changeIdentifier) && isChangeTypeCorrect(changeType)) {
 186             return Optional.of(messageMetaData);
 187         } else {
 188             String errorMessage = "VES event parsing.";
 189             if (!missingValues.isEmpty()) {
 190                 errorMessage += " Missing data: " + missingValues;
 191             }
 192             if (!isChangeIdentifierCorrect(changeIdentifier) || !isChangeTypeCorrect(changeType)) {
 193                 errorMessage += " Change identifier or change type is wrong.";
 194             }
 195             errorMessage += " Message: {}";
 196             logger.error(errorMessage, message);
 197             return Optional.empty();
 198         }
 199     }
 200
 201     private boolean isChangeTypeCorrect(String changeType) {
 202         return FILE_READY_CHANGE_TYPE.equals(changeType);
 203     }
 204
 205     private boolean isChangeIdentifierCorrect(String changeIdentifier) {
 206         return FILE_READY_CHANGE_IDENTIFIER.equals(changeIdentifier);
 207     }
 208
 209     private List<FileData> getAllFileDataFromJson(JsonArray arrayOfAdditionalFields, MessageMetaData messageMetaData) {
 210         List<FileData> res = new ArrayList<>();
 211         for (int i = 0; i < arrayOfAdditionalFields.size(); i++) {
 212             JsonObject fileInfo = (JsonObject) arrayOfAdditionalFields.get(i);
 213             Optional<FileData> fileData = getFileDataFromJson(fileInfo, messageMetaData);
 214
 215             if (fileData.isPresent()) {
 216                 res.add(fileData.get());
 217             }
 218         }
 219         return res;
 220     }
 221
 222     private Optional<FileData> getFileDataFromJson(JsonObject fileInfo, MessageMetaData messageMetaData) {
 223         logger.trace("starting to getFileDataFromJson!");
 224
 225         List<String> missingValues = new ArrayList<>();
 226         JsonObject data = fileInfo.getAsJsonObject(HASH_MAP);
 227
 228         String location = getValueFromJson(data, LOCATION, missingValues);
 229         Scheme scheme;
 230         try {
 231             scheme = Scheme.getSchemeFromString(URI.create(location).getScheme());
 232         } catch (Exception e) {
 233             logger.error("VES event parsing.", e);
 234             return Optional.empty();
 235         }
 236         FileData fileData = ImmutableFileData.builder() //
 237                 .name(getValueFromJson(fileInfo, NAME, missingValues)) //
 238                 .fileFormatType(getValueFromJson(data, FILE_FORMAT_TYPE, missingValues)) //
 239                 .fileFormatVersion(getValueFromJson(data, FILE_FORMAT_VERSION, missingValues)) //
 240                 .location(location) //
 241                 .scheme(scheme) //
 242                 .compression(getValueFromJson(data, COMPRESSION, missingValues)) //
 243                 .messageMetaData(messageMetaData) //
 244                 .build();
 245         if (missingValues.isEmpty()) {
 246             return Optional.of(fileData);
 247         }
 248         logger.error("VES event parsing. File information wrong. Missing data: {} Data: {}", missingValues, fileInfo);
 249         return Optional.empty();
 250     }
 251
 252     /**
 253      * Gets data from the event name. Defined as: {DomainAbbreviation}_{productName}-{vendorName}_{Description},
 254      * example: Noti_RnNode-Ericsson_FileReady
 255      *
 256      * @param dataType The type of data to get, {@link DmaapConsumerJsonParser.EventNameDataType}.
 257      * @param eventName The event name to get the data from.
 258      * @param missingValues List of missing values. The dataType will be added if missing.
 259      * @return String of data from event name
 260      */
 261     private String getDataFromEventName(EventNameDataType dataType, String eventName, List<String> missingValues) {
 262         String[] eventArray = eventName.split("_|-");
 263         if (eventArray.length >= 4) {
 264             return eventArray[dataType.index];
 265         } else {
 266             missingValues.add(dataType.toString());
 267             logger.error("Can not get {} from eventName, eventName is not in correct format: {}", dataType, eventName);
 268         }
 269         return "";
 270     }
 271
 272     private String getValueFromJson(JsonObject jsonObject, String jsonKey, List<String> missingValues) {
 273         if (jsonObject.has(jsonKey)) {
 274             return jsonObject.get(jsonKey).getAsString();
 275         } else {
 276             missingValues.add(jsonKey);
 277             return "";
 278         }
 279     }
 280
 281     private boolean containsNotificationFields(JsonObject jsonObject) {
 282         return jsonObject.has(EVENT) && jsonObject.getAsJsonObject(EVENT).has(NOTIFICATION_FIELDS);
 283     }
 284
 285     private Flux<FileReadyMessage> logErrorAndReturnEmptyMessageFlux(String errorMessage) {
 286         logger.error(errorMessage);
 287         return Flux.empty();
 288     }
 289 }