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(
 111                 Flux.defer(() -> Flux.fromStream(StreamSupport.stream(jsonElement.getAsJsonArray().spliterator(), false)
 112                         .map(jsonElementFromArray -> getJsonObjectFromAnArray(jsonElementFromArray)
 113                                 .orElseGet(JsonObject::new)))));
 114     }
 115
 116     /**
 117      * Extract info from string and create a Flux of {@link FileReadyMessage}.
 118      *
 119      * @param rawMessage - results from DMaaP
 120      * @return reactive Flux of FileReadyMessages
 121      */
 122     private Flux<FileReadyMessage> createMessageData(JsonElement jsonElement) {
 123         return jsonElement.isJsonObject() ? createMessages(Flux.just(jsonElement.getAsJsonObject()))
 124                 : getMessagesFromJsonArray(jsonElement);
 125     }
 126
 127     private Mono<JsonElement> getJsonParserMessage(String message) {
 128         logger.trace("original message from message router: {}", message);
 129         return StringUtils.isEmpty(message) ? Mono.empty() : Mono.fromSupplier(() -> new JsonParser().parse(message));
 130     }
 131
 132     private Flux<FileReadyMessage> createMessages(Flux<JsonObject> jsonObject) {
 133         return jsonObject.flatMap(monoJsonP -> containsNotificationFields(monoJsonP) ? transformMessages(monoJsonP)
 134                 : logErrorAndReturnEmptyMessageFlux("Incorrect JsonObject - missing header. " + jsonObject));
 135     }
 136
 137
 138     private Mono<FileReadyMessage> transformMessages(JsonObject message) {
 139         Optional<MessageMetaData> optionalMessageMetaData = getMessageMetaData(message);
 140         if (optionalMessageMetaData.isPresent()) {
 141             MessageMetaData messageMetaData = optionalMessageMetaData.get();
 142             JsonObject notificationFields = message.getAsJsonObject(EVENT).getAsJsonObject(NOTIFICATION_FIELDS);
 143             JsonArray arrayOfNamedHashMap = notificationFields.getAsJsonArray(ARRAY_OF_NAMED_HASH_MAP);
 144             if (arrayOfNamedHashMap != null) {
 145                 List<FileData> allFileDataFromJson = getAllFileDataFromJson(arrayOfNamedHashMap, messageMetaData);
 146                 if (!allFileDataFromJson.isEmpty()) {
 147                     return Mono.just(ImmutableFileReadyMessage.builder() //
 148                             .files(allFileDataFromJson) //
 149                             .build());
 150                 } else {
 151                     return Mono.empty();
 152                 }
 153             }
 154
 155             logger.error("VES event parsing. Missing arrayOfNamedHashMap in message. {}", message);
 156             return Mono.empty();
 157         }
 158         logger.error("VES event parsing. FileReady event has incorrect JsonObject. {}", message);
 159         return Mono.empty();
 160     }
 161
 162
 163     private Optional<MessageMetaData> getMessageMetaData(JsonObject message) {
 164         List<String> missingValues = new ArrayList<>();
 165         JsonObject commonEventHeader = message.getAsJsonObject(EVENT).getAsJsonObject(COMMON_EVENT_HEADER);
 166         String eventName = getValueFromJson(commonEventHeader, EVENT_NAME, missingValues);
 167
 168         JsonObject notificationFields = message.getAsJsonObject(EVENT).getAsJsonObject(NOTIFICATION_FIELDS);
 169         String changeIdentifier = getValueFromJson(notificationFields, CHANGE_IDENTIFIER, missingValues);
 170         String changeType = getValueFromJson(notificationFields, CHANGE_TYPE, missingValues);
 171
 172         // Just to check that it is in the message. Might be needed in the future if there is a new
 173         // version.
 174         getValueFromJson(notificationFields, NOTIFICATION_FIELDS_VERSION, missingValues);
 175
 176         MessageMetaData messageMetaData = ImmutableMessageMetaData.builder() //
 177                 .productName(getDataFromEventName(EventNameDataType.PRODUCT_NAME, eventName, missingValues)) //
 178                 .vendorName(getDataFromEventName(EventNameDataType.VENDOR_NAME, eventName, missingValues)) //
 179                 .lastEpochMicrosec(getValueFromJson(commonEventHeader, LAST_EPOCH_MICROSEC, missingValues)) //
 180                 .sourceName(getValueFromJson(commonEventHeader, SOURCE_NAME, missingValues)) //
 181                 .startEpochMicrosec(getValueFromJson(commonEventHeader, START_EPOCH_MICROSEC, missingValues)) //
 182                 .timeZoneOffset(getValueFromJson(commonEventHeader, TIME_ZONE_OFFSET, missingValues)) //
 183                 .changeIdentifier(changeIdentifier) //
 184                 .changeType(changeType) //
 185                 .build();
 186         if (missingValues.isEmpty() && isChangeIdentifierCorrect(changeIdentifier) && isChangeTypeCorrect(changeType)) {
 187             return Optional.of(messageMetaData);
 188         } else {
 189             String errorMessage = "VES event parsing.";
 190             if (!missingValues.isEmpty()) {
 191                 errorMessage += " Missing data: " + missingValues;
 192             }
 193             if (!isChangeIdentifierCorrect(changeIdentifier) || !isChangeTypeCorrect(changeType)) {
 194                 errorMessage += " Change identifier or change type is wrong.";
 195             }
 196             errorMessage += " Message: {}";
 197             logger.error(errorMessage, message);
 198             return Optional.empty();
 199         }
 200     }
 201
 202     private boolean isChangeTypeCorrect(String changeType) {
 203         return FILE_READY_CHANGE_TYPE.equals(changeType);
 204     }
 205
 206     private boolean isChangeIdentifierCorrect(String changeIdentifier) {
 207         return FILE_READY_CHANGE_IDENTIFIER.equals(changeIdentifier);
 208     }
 209
 210     private List<FileData> getAllFileDataFromJson(JsonArray arrayOfAdditionalFields, MessageMetaData messageMetaData) {
 211         List<FileData> res = new ArrayList<>();
 212         for (int i = 0; i < arrayOfAdditionalFields.size(); i++) {
 213             JsonObject fileInfo = (JsonObject) arrayOfAdditionalFields.get(i);
 214             Optional<FileData> fileData = getFileDataFromJson(fileInfo, messageMetaData);
 215
 216             if (fileData.isPresent()) {
 217                 res.add(fileData.get());
 218             }
 219         }
 220         return res;
 221     }
 222
 223     private Optional<FileData> getFileDataFromJson(JsonObject fileInfo, MessageMetaData messageMetaData) {
 224         logger.trace("starting to getFileDataFromJson!");
 225
 226         List<String> missingValues = new ArrayList<>();
 227         JsonObject data = fileInfo.getAsJsonObject(HASH_MAP);
 228
 229         String location = getValueFromJson(data, LOCATION, missingValues);
 230         Scheme scheme;
 231         try {
 232             scheme = Scheme.getSchemeFromString(URI.create(location).getScheme());
 233         } catch (Exception e) {
 234             logger.error("VES event parsing.", e);
 235             return Optional.empty();
 236         }
 237         FileData fileData = ImmutableFileData.builder() //
 238                 .name(getValueFromJson(fileInfo, NAME, missingValues)) //
 239                 .fileFormatType(getValueFromJson(data, FILE_FORMAT_TYPE, missingValues)) //
 240                 .fileFormatVersion(getValueFromJson(data, FILE_FORMAT_VERSION, missingValues)) //
 241                 .location(location) //
 242                 .scheme(scheme) //
 243                 .compression(getValueFromJson(data, COMPRESSION, missingValues)) //
 244                 .messageMetaData(messageMetaData) //
 245                 .build();
 246         if (missingValues.isEmpty()) {
 247             return Optional.of(fileData);
 248         }
 249         logger.error("VES event parsing. File information wrong. Missing data: {} Data: {}", missingValues, fileInfo);
 250         return Optional.empty();
 251     }
 252
 253     /**
 254      * Gets data from the event name. Defined as: {DomainAbbreviation}_{productName}-{vendorName}_{Description},
 255      * example: Noti_RnNode-Ericsson_FileReady
 256      *
 257      * @param dataType The type of data to get, {@link DmaapConsumerJsonParser.EventNameDataType}.
 258      * @param eventName The event name to get the data from.
 259      * @param missingValues List of missing values. The dataType will be added if missing.
 260      * @return String of data from event name
 261      */
 262     private String getDataFromEventName(EventNameDataType dataType, String eventName, List<String> missingValues) {
 263         String[] eventArray = eventName.split("_|-");
 264         if (eventArray.length >= 4) {
 265             return eventArray[dataType.index];
 266         } else {
 267             missingValues.add(dataType.toString());
 268             logger.error("Can not get {} from eventName, eventName is not in correct format: {}", dataType, eventName);
 269         }
 270         return "";
 271     }
 272
 273     private String getValueFromJson(JsonObject jsonObject, String jsonKey, List<String> missingValues) {
 274         if (jsonObject.has(jsonKey)) {
 275             return jsonObject.get(jsonKey).getAsString();
 276         } else {
 277             missingValues.add(jsonKey);
 278             return "";
 279         }
 280     }
 281
 282     private boolean containsNotificationFields(JsonObject jsonObject) {
 283         return jsonObject.has(EVENT) && jsonObject.getAsJsonObject(EVENT).has(NOTIFICATION_FIELDS);
 284     }
 285
 286     private Flux<FileReadyMessage> logErrorAndReturnEmptyMessageFlux(String errorMessage) {
 287         logger.error(errorMessage);
 288         return Flux.empty();
 289     }
 290 }