gerrit.onap Code Review - dcaegen2/services.git/blob

   1 /*
   2  * ============LICENSE_START=======================================================
   3  * BBS-RELOCATION-CPE-AUTHENTICATION-HANDLER
   4  * ================================================================================
   5  * Copyright (C) 2019 NOKIA Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.bbs.event.processor.pipelines;
  22
  23 import static org.onap.bbs.event.processor.config.ApplicationConstants.CONSUME_REREGISTRATION_TASK_NAME;
  24 import static org.onap.bbs.event.processor.config.ApplicationConstants.DCAE_BBS_EVENT_PROCESSOR_MS_INSTANCE;
  25 import static org.onap.bbs.event.processor.config.ApplicationConstants.RETRIEVE_HSI_CFS_SERVICE_INSTANCE_TASK_NAME;
  26 import static org.onap.bbs.event.processor.config.ApplicationConstants.RETRIEVE_PNF_TASK_NAME;
  27 import static org.onap.dcaegen2.services.sdk.rest.services.model.logging.MdcVariables.INSTANCE_UUID;
  28 import static org.onap.dcaegen2.services.sdk.rest.services.model.logging.MdcVariables.RESPONSE_CODE;
  29
  30 import java.time.Duration;
  31 import java.time.Instant;
  32 import java.util.HashMap;
  33 import java.util.List;
  34 import java.util.Map;
  35 import java.util.UUID;
  36 import java.util.concurrent.TimeoutException;
  37
  38 import javax.net.ssl.SSLException;
  39
  40 import org.onap.bbs.event.processor.config.ApplicationConfiguration;
  41 import org.onap.bbs.event.processor.exceptions.EmptyDmaapResponseException;
  42 import org.onap.bbs.event.processor.model.ControlLoopPublisherDmaapModel;
  43 import org.onap.bbs.event.processor.model.ImmutableControlLoopPublisherDmaapModel;
  44 import org.onap.bbs.event.processor.model.PnfAaiObject;
  45 import org.onap.bbs.event.processor.model.ReRegistrationConsumerDmaapModel;
  46 import org.onap.bbs.event.processor.model.RelationshipListAaiObject;
  47 import org.onap.bbs.event.processor.model.ServiceInstanceAaiObject;
  48 import org.onap.bbs.event.processor.tasks.AaiClientTask;
  49 import org.onap.bbs.event.processor.tasks.DmaapPublisherTask;
  50 import org.onap.bbs.event.processor.tasks.DmaapReRegistrationConsumerTask;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53 import org.slf4j.MDC;
  54 import org.springframework.beans.factory.annotation.Autowired;
  55 import org.springframework.http.ResponseEntity;
  56 import org.springframework.stereotype.Component;
  57 import org.springframework.util.StringUtils;
  58
  59 import reactor.core.publisher.Flux;
  60 import reactor.core.publisher.Mono;
  61
  62 @Component
  63 public class ReRegistrationPipeline {
  64
  65     private static final Logger LOGGER = LoggerFactory.getLogger(ReRegistrationPipeline.class);
  66
  67     private static final String POLICY_NAME = "Nomadic_ONT";
  68
  69     private DmaapReRegistrationConsumerTask consumerTask;
  70     private DmaapPublisherTask publisherTask;
  71     private AaiClientTask aaiClientTask;
  72
  73     private ApplicationConfiguration configuration;
  74
  75     private Map<String, String> mdcContextMap;
  76
  77     @Autowired
  78     ReRegistrationPipeline(ApplicationConfiguration configuration,
  79                            DmaapReRegistrationConsumerTask consumerTask,
  80                            DmaapPublisherTask publisherTask,
  81                            AaiClientTask aaiClientTask,
  82                            Map<String, String> mdcContextMap) {
  83         this.configuration = configuration;
  84         this.consumerTask = consumerTask;
  85         this.publisherTask = publisherTask;
  86         this.aaiClientTask = aaiClientTask;
  87         this.mdcContextMap = mdcContextMap;
  88     }
  89
  90     /**
  91      * PNF re-registration processing pipeline for BBS uS.
  92      */
  93     public void processPnfReRegistrationEvents() {
  94         MDC.setContextMap(mdcContextMap);
  95         LOGGER.info("Process next Re-Registration events");
  96         executePipeline()
  97                 .subscribe(this::onSuccess, this::onError, this::onComplete);
  98         LOGGER.trace("Reactive PNF Re-registration pipeline subscribed - Execution started");
  99     }
 100
 101     Flux<ResponseEntity<String>> executePipeline() {
 102         return
 103             // Consume Re-Registration from DMaaP
 104             consumeReRegistrationsFromDmaap()
 105             // Fetch PNF from A&AI
 106             .flatMap(this::fetchPnfFromAai)
 107             // Fetch related HSI CFS instance from A&AI
 108             .flatMap(this::fetchHsiCfsServiceInstanceFromAai)
 109             // Trigger Policy for relocation
 110             .flatMap(this::triggerPolicy);
 111     }
 112
 113     private void onSuccess(ResponseEntity<String> responseCode) {
 114         MDC.put(RESPONSE_CODE, responseCode.getStatusCode().toString());
 115         LOGGER.info("PNF Re-Registration event successfully handled. "
 116                         + "Publishing to DMaaP for Policy returned a status code of ({} {})",
 117                 responseCode.getStatusCode().value(), responseCode.getStatusCode().getReasonPhrase());
 118         MDC.remove(RESPONSE_CODE);
 119     }
 120
 121     private void onError(Throwable throwable) {
 122         LOGGER.error("Aborted PNF Re-Registration events processing. Error: {}", throwable.getMessage());
 123     }
 124
 125     private void onComplete() {
 126         LOGGER.info("PNF Re-Registration processing pipeline has been completed");
 127     }
 128
 129     private Flux<PipelineState> consumeReRegistrationsFromDmaap() {
 130         return Flux.defer(() -> {
 131             MDC.put(INSTANCE_UUID, UUID.randomUUID().toString());
 132             try {
 133                 return consumerTask.execute(CONSUME_REREGISTRATION_TASK_NAME)
 134                         .timeout(Duration.ofSeconds(configuration.getPipelinesTimeoutInSeconds()))
 135                         .doOnError(e -> {
 136                             if (e instanceof TimeoutException) {
 137                                 LOGGER.warn("Timed out waiting for DMaaP response");
 138                             } else if (e instanceof EmptyDmaapResponseException) {
 139                                 LOGGER.info("Nothing to consume from DMaaP");
 140                             } else {
 141                                 LOGGER.error("DMaaP Consumer error: {}", e.getMessage());
 142                                 LOGGER.debug("Error\n", e);
 143                             }
 144                         })
 145                         .onErrorResume(
 146                             e -> e instanceof Exception,
 147                             e -> Mono.empty())
 148                         .map(event -> {
 149                             // For each message, we have to keep separate state. This state will be enhanced
 150                             // in each step and handed off to the next processing step
 151                             PipelineState state = new PipelineState();
 152                             state.setReRegistrationEvent(event);
 153                             return state;
 154                         });
 155             } catch (SSLException e) {
 156                 return Flux.error(e);
 157             }
 158         });
 159     }
 160
 161     private Mono<PipelineState> fetchPnfFromAai(PipelineState state) {
 162
 163         ReRegistrationConsumerDmaapModel vesEvent = state.getReRegistrationEvent();
 164         String pnfName = vesEvent.getCorrelationId();
 165         String url = String.format("/aai/v14/network/pnfs/pnf/%s?depth=all", pnfName);
 166         LOGGER.debug("Processing Step: Retrieve PNF. Url: ({})", url);
 167
 168         return aaiClientTask.executePnfRetrieval(RETRIEVE_PNF_TASK_NAME, url)
 169                 .timeout(Duration.ofSeconds(configuration.getPipelinesTimeoutInSeconds()))
 170                 .doOnError(TimeoutException.class,
 171                         e -> LOGGER.warn("Timed out waiting for A&AI response")
 172                 )
 173                 .doOnError(e -> LOGGER.error("Error while retrieving PNF: {}",
 174                         e.getMessage())
 175                 )
 176                 .onErrorResume(
 177                     e -> e instanceof Exception,
 178                     e -> Mono.empty())
 179                 .map(p -> {
 180                     state.setPnfAaiObject(p);
 181                     return state;
 182                 });
 183     }
 184
 185     private Mono<PipelineState> fetchHsiCfsServiceInstanceFromAai(PipelineState state) {
 186
 187         if (state == null || state.getPnfAaiObject() == null) {
 188             return Mono.empty();
 189         }
 190
 191         // At this point, we have both the VES-event of the re-registration and the PNF object retrieved from A&AI
 192         // We can check if this processing needs to continue in case of a true relocation
 193         if (isNotReallyAnOntRelocation(state)) {
 194             return Mono.empty();
 195         }
 196
 197         PnfAaiObject pnf = state.getPnfAaiObject();
 198         // Assuming that the PNF will only have a single service-instance relationship pointing
 199         // towards the HSI CFS service
 200         String serviceInstanceId = pnf.getRelationshipListAaiObject().getRelationshipEntries()
 201                 .stream()
 202                 .filter(e -> "service-instance".equals(e.getRelatedTo()))
 203                 .flatMap(e -> e.getRelationshipData().stream())
 204                 .filter(d -> "service-instance.service-instance-id".equals(d.getRelationshipKey()))
 205                 .map(RelationshipListAaiObject.RelationshipDataEntryAaiObject::getRelationshipValue)
 206                 .findFirst().orElse("");
 207
 208         if (StringUtils.isEmpty(serviceInstanceId)) {
 209             LOGGER.error("Unable to retrieve HSI CFS service instance from PNF {}",
 210                     state.getPnfAaiObject().getPnfName());
 211             return Mono.empty();
 212         }
 213
 214         String url = String.format("/aai/v14/nodes/service-instances/service-instance/%s?depth=all",
 215                 serviceInstanceId);
 216         LOGGER.debug("Processing Step: Retrieve HSI CFS Service. Url: ({})", url);
 217         return aaiClientTask.executeServiceInstanceRetrieval(RETRIEVE_HSI_CFS_SERVICE_INSTANCE_TASK_NAME, url)
 218                 .timeout(Duration.ofSeconds(configuration.getPipelinesTimeoutInSeconds()))
 219                 .doOnError(TimeoutException.class,
 220                         e -> LOGGER.warn("Timed out waiting for A&AI response")
 221                 )
 222                 .doOnError(e -> LOGGER.error("Error while retrieving HSI CFS Service instance: {}",
 223                         e.getMessage())
 224                 )
 225                 .onErrorResume(
 226                     e -> e instanceof Exception,
 227                     e -> Mono.empty())
 228                 .map(s -> {
 229                     state.setHsiCfsServiceInstance(s);
 230                     return state;
 231                 });
 232     }
 233
 234     private boolean isNotReallyAnOntRelocation(PipelineState state) {
 235         List<RelationshipListAaiObject.RelationshipEntryAaiObject> relationshipEntries =
 236                 state.getPnfAaiObject().getRelationshipListAaiObject().getRelationshipEntries();
 237
 238         // If no logical-link, fail further processing
 239         if (relationshipEntries.stream().noneMatch(e -> "logical-link".equals(e.getRelatedTo()))) {
 240             LOGGER.warn("PNF {} does not have any logical-links bridged. Stop further processing",
 241                     state.getPnfAaiObject().getPnfName());
 242             return true;
 243         }
 244
 245         // Assuming PNF will only have one logical-link per BBS use case design
 246         boolean isNotRelocation = relationshipEntries
 247                 .stream()
 248                 .filter(e -> "logical-link".equals(e.getRelatedTo()))
 249                 .flatMap(e -> e.getRelationshipData().stream())
 250                 .anyMatch(d -> d.getRelationshipValue()
 251                         .equals(state.getReRegistrationEvent().getAttachmentPoint()));
 252
 253
 254         if (isNotRelocation) {
 255             LOGGER.warn("Not a Relocation for PNF {} with attachment point {}",
 256                     state.getPnfAaiObject().getPnfName(),
 257                     state.getReRegistrationEvent().getAttachmentPoint());
 258         }
 259         return isNotRelocation;
 260     }
 261
 262     private Mono<ResponseEntity<String>> triggerPolicy(PipelineState state) {
 263
 264         if (state == null || state.getHsiCfsServiceInstance() == null) {
 265             return Mono.empty();
 266         }
 267
 268         ControlLoopPublisherDmaapModel event = buildTriggeringPolicyEvent(state);
 269         return publisherTask.execute(event)
 270                 .timeout(Duration.ofSeconds(configuration.getPipelinesTimeoutInSeconds()))
 271                 .doOnError(TimeoutException.class,
 272                         e -> LOGGER.warn("Timed out waiting for DMaaP confirmation")
 273                 )
 274                 .doOnError(e -> LOGGER.error("Error while triggering Policy: {}", e.getMessage()))
 275                 .onErrorResume(
 276                     e -> e instanceof Exception,
 277                     e -> Mono.empty());
 278     }
 279
 280     private ControlLoopPublisherDmaapModel buildTriggeringPolicyEvent(PipelineState state) {
 281
 282         String cfsServiceInstanceId = state.getHsiCfsServiceInstance().getServiceInstanceId();
 283
 284         String attachmentPoint = state.getReRegistrationEvent().getAttachmentPoint();
 285         String remoteId = state.getReRegistrationEvent().getRemoteId();
 286         String cvlan = state.getReRegistrationEvent().getCVlan();
 287         String svlan = state.getReRegistrationEvent().getSVlan();
 288
 289         Map<String, String> enrichmentData = new HashMap<>();
 290         enrichmentData.put("service-information.hsia-cfs-service-instance-id", cfsServiceInstanceId);
 291
 292         enrichmentData.put("attachmentPoint", attachmentPoint);
 293         enrichmentData.put("remoteId", remoteId);
 294         enrichmentData.put("cvlan", cvlan);
 295         enrichmentData.put("svlan", svlan);
 296
 297         ControlLoopPublisherDmaapModel triggerEvent = ImmutableControlLoopPublisherDmaapModel.builder()
 298                 .closedLoopEventClient(DCAE_BBS_EVENT_PROCESSOR_MS_INSTANCE)
 299                 .policyVersion(configuration.getPolicyVersion())
 300                 .policyName(POLICY_NAME)
 301                 .policyScope(configuration.getReRegistrationCloseLoopPolicyScope())
 302                 .targetType(configuration.getCloseLoopTargetType())
 303                 .aaiEnrichmentData(enrichmentData)
 304                 .closedLoopAlarmStart(Instant.now().getEpochSecond())
 305                 .closedLoopEventStatus(configuration.getCloseLoopEventStatus())
 306                 .closedLoopControlName(configuration.getReRegistrationCloseLoopControlName())
 307                 .version(configuration.getCloseLoopVersion())
 308                 .target(configuration.getCloseLoopTarget())
 309                 .requestId(UUID.randomUUID().toString())
 310                 .originator(configuration.getCloseLoopOriginator())
 311                 .build();
 312         LOGGER.debug("Processing Step: Publish for Policy");
 313         LOGGER.trace("Trigger Policy event: ({})",triggerEvent);
 314         return triggerEvent;
 315     }
 316
 317     private static class PipelineState {
 318
 319         private ReRegistrationConsumerDmaapModel reRegistrationEvent;
 320         private PnfAaiObject pnfAaiObject;
 321         private ServiceInstanceAaiObject hsiCfsServiceInstance;
 322
 323         ReRegistrationConsumerDmaapModel getReRegistrationEvent() {
 324             return reRegistrationEvent;
 325         }
 326
 327         void setReRegistrationEvent(ReRegistrationConsumerDmaapModel reRegistrationEvent) {
 328             this.reRegistrationEvent = reRegistrationEvent;
 329         }
 330
 331         PnfAaiObject getPnfAaiObject() {
 332             return pnfAaiObject;
 333         }
 334
 335         void setPnfAaiObject(PnfAaiObject pnfAaiObject) {
 336             this.pnfAaiObject = pnfAaiObject;
 337         }
 338
 339         ServiceInstanceAaiObject getHsiCfsServiceInstance() {
 340             return hsiCfsServiceInstance;
 341         }
 342
 343         void setHsiCfsServiceInstance(ServiceInstanceAaiObject hsiCfsServiceInstance) {
 344             this.hsiCfsServiceInstance = hsiCfsServiceInstance;
 345         }
 346     }
 347 }