gerrit.onap Code Review - ccsdk/oran.git/blob

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * ONAP : ccsdk oran
   4  * ======================================================================
   5  * Copyright (C) 2020 Nordix Foundation. 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.ccsdk.oran.a1policymanagementservice.tasks;
  22
  23 import java.util.Collection;
  24
  25 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1Client;
  26 import org.onap.ccsdk.oran.a1policymanagementservice.clients.A1ClientFactory;
  27 import org.onap.ccsdk.oran.a1policymanagementservice.clients.AsyncRestClientFactory;
  28 import org.onap.ccsdk.oran.a1policymanagementservice.clients.SecurityContext;
  29 import org.onap.ccsdk.oran.a1policymanagementservice.configuration.ApplicationConfig;
  30 import org.onap.ccsdk.oran.a1policymanagementservice.exceptions.ServiceException;
  31 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Lock.LockType;
  32 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Policies;
  33 import org.onap.ccsdk.oran.a1policymanagementservice.repository.PolicyTypes;
  34 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric;
  35 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Ric.RicState;
  36 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Rics;
  37 import org.onap.ccsdk.oran.a1policymanagementservice.repository.Services;
  38 import org.slf4j.Logger;
  39 import org.slf4j.LoggerFactory;
  40 import org.springframework.beans.factory.annotation.Autowired;
  41 import org.springframework.scheduling.annotation.EnableScheduling;
  42 import org.springframework.scheduling.annotation.Scheduled;
  43 import org.springframework.stereotype.Component;
  44
  45 import reactor.core.publisher.Flux;
  46 import reactor.core.publisher.Mono;
  47
  48 /**
  49  * Regularly checks the existing rics towards the local repository to keep it
  50  * consistent. When the policy types or instances in the Near-RT RIC is not
  51  * consistent, a synchronization is performed.
  52  */
  53 @Component
  54 @EnableScheduling
  55 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
  56 public class RicSupervision {
  57     private static final Logger logger = LoggerFactory.getLogger(RicSupervision.class);
  58
  59     private static final int CONCURRENCY = 50; // Number of RIC checked in paralell
  60     private final Rics rics;
  61     private final Policies policies;
  62     private final PolicyTypes policyTypes;
  63     private final A1ClientFactory a1ClientFactory;
  64     private final Services services;
  65     private final AsyncRestClientFactory restClientFactory;
  66
  67     private static class SynchNeededException extends ServiceException {
  68         private static final long serialVersionUID = 1L;
  69
  70         public SynchNeededException(RicData ric) {
  71             super("SynchNeededException for " + ric.ric.id());
  72         }
  73     }
  74
  75     private static class RicData {
  76         RicData(Ric ric, A1Client a1Client) {
  77             this.ric = ric;
  78             this.a1Client = a1Client;
  79         }
  80
  81         A1Client getClient() {
  82             return a1Client;
  83         }
  84
  85         final Ric ric;
  86         private final A1Client a1Client;
  87     }
  88
  89     @Autowired
  90     public RicSupervision(Rics rics, Policies policies, A1ClientFactory a1ClientFactory, PolicyTypes policyTypes,
  91             Services services, ApplicationConfig config, SecurityContext securityContext) {
  92         this.rics = rics;
  93         this.policies = policies;
  94         this.a1ClientFactory = a1ClientFactory;
  95         this.policyTypes = policyTypes;
  96         this.services = services;
  97         this.restClientFactory = new AsyncRestClientFactory(config.getWebClientConfig(), securityContext);
  98     }
  99
 100     /**
 101      * Regularly contacts all Rics to check if they are alive and synchronized.
 102      */
 103     @Scheduled(fixedRate = 1000 * 60)
 104     public void checkAllRics() {
 105         logger.debug("Checking Rics starting");
 106         createTask().subscribe(null, null, () -> logger.debug("Checking all RICs completed"));
 107     }
 108
 109     private Flux<Ric> createTask() {
 110         return Flux.fromIterable(rics.getRics()) //
 111                 .flatMap(this::createRicData) //
 112                 .onErrorResume(t -> Flux.empty()) //
 113                 .flatMap(this::checkOneRic, CONCURRENCY) //
 114                 .map(ricData -> ricData.ric);
 115     }
 116
 117     private Mono<RicData> checkOneRic(RicData ricData) {
 118         if (ricData.ric.getState() == RicState.CONSISTENCY_CHECK || ricData.ric.getState() == RicState.SYNCHRONIZING) {
 119             logger.debug("Skipping check ric: {}, state: {}", ricData.ric.id(), ricData.ric.getState());
 120             return Mono.empty(); // Skip, already in progress
 121         }
 122         return ricData.ric.getLock().lock(LockType.EXCLUSIVE, "checkOneRic") //
 123                 .flatMap(lock -> synchIfUnavailable(ricData)) //
 124                 .doOnNext(ric -> ricData.ric.setState(RicState.CONSISTENCY_CHECK)) //
 125                 .flatMap(x -> checkRicPolicies(ricData)) //
 126                 .flatMap(x -> checkRicPolicyTypes(ricData)) //
 127                 .doOnNext(x -> onRicCheckedOk(ricData)) //
 128                 .onErrorResume(t -> onRicCheckedError(t, ricData)) //
 129                 .doFinally(sig -> ricData.ric.getLock().unlockBlocking()) //
 130                 .onErrorResume(throwable -> Mono.empty());
 131     }
 132
 133     private Mono<RicData> synchIfUnavailable(RicData ric) {
 134         if (ric.ric.getState() == RicState.UNAVAILABLE) {
 135             return Mono.error(new SynchNeededException(ric));
 136         } else {
 137             return Mono.just(ric);
 138         }
 139     }
 140
 141     private Mono<RicData> onRicCheckedError(Throwable t, RicData ricData) {
 142         logger.debug("Ric: {} check stopped, exception: {}", ricData.ric.id(), t.getMessage());
 143         ricData.ric.setState(RicState.UNAVAILABLE);
 144         if ((t instanceof SynchNeededException)) {
 145             return startSynchronization(ricData);
 146         } else {
 147             logger.warn("RicSupervision, ric: {}, exception: {}", ricData.ric.id(), t.getMessage());
 148             return Mono.empty();
 149         }
 150     }
 151
 152     private void onRicCheckedOk(RicData ricData) {
 153         logger.debug("Ric: {} checked OK", ricData.ric.id());
 154         ricData.ric.setState(RicState.AVAILABLE);
 155     }
 156
 157     private Mono<RicData> createRicData(Ric ric) {
 158         return this.a1ClientFactory.createA1Client(ric) //
 159                 .doOnError(t -> logger.debug("Could not create A1 client for ric: {}, reason: {}", ric.id(),
 160                         t.getMessage())) //
 161                 .map(a1Client -> new RicData(ric, a1Client));
 162     }
 163
 164     private Mono<RicData> checkRicPolicies(RicData ric) {
 165         return ric.getClient().getPolicyIdentities() //
 166                 .flatMap(ricP -> validateInstances(ricP, ric));
 167     }
 168
 169     private Mono<RicData> validateInstances(Collection<String> ricPolicies, RicData ric) {
 170         synchronized (this.policies) {
 171             if (ricPolicies.size() != policies.getForRic(ric.ric.id()).size()) {
 172                 logger.debug("RicSupervision, starting ric: {} synchronization (noOfPolicices == {}, expected == {})",
 173                         ric.ric.id(), ricPolicies.size(), policies.getForRic(ric.ric.id()).size());
 174                 return Mono.error(new SynchNeededException(ric));
 175             }
 176
 177             for (String policyId : ricPolicies) {
 178                 if (!policies.containsPolicy(policyId)) {
 179                     logger.debug("RicSupervision, starting ric: {} synchronization (unexpected policy in RIC: {})",
 180                             ric.ric.id(), policyId);
 181                     return Mono.error(new SynchNeededException(ric));
 182                 }
 183             }
 184             return Mono.just(ric);
 185         }
 186     }
 187
 188     private Mono<RicData> checkRicPolicyTypes(RicData ric) {
 189         return ric.getClient().getPolicyTypeIdentities() //
 190                 .flatMap(ricTypes -> validateTypes(ricTypes, ric));
 191     }
 192
 193     private Mono<RicData> validateTypes(Collection<String> ricTypes, RicData ric) {
 194         if (ricTypes.size() != ric.ric.getSupportedPolicyTypes().size()) {
 195             logger.debug(
 196                     "RicSupervision, starting ric: {} synchronization (unexpected numer of policy types in RIC: {}, expected: {})",
 197                     ric.ric.id(), ricTypes.size(), ric.ric.getSupportedPolicyTypes().size());
 198             return Mono.error(new SynchNeededException(ric));
 199         }
 200         for (String typeName : ricTypes) {
 201             if (!ric.ric.isSupportingType(typeName)) {
 202                 logger.debug("RicSupervision, starting ric: {} synchronization (unexpected policy type: {})",
 203                         ric.ric.id(), typeName);
 204                 return Mono.error(new SynchNeededException(ric));
 205             }
 206         }
 207         return Mono.just(ric);
 208     }
 209
 210     private Mono<RicData> startSynchronization(RicData ric) {
 211         logger.debug("RicSupervision, starting ric: {} synchronization, state: {}", ric.ric.id(), ric.ric.getState());
 212         RicSynchronizationTask synchronizationTask = createSynchronizationTask();
 213         return synchronizationTask.synchronizeRic(ric.ric) //
 214                 .flatMap(notUsed -> Mono.just(ric));
 215
 216     }
 217
 218     RicSynchronizationTask createSynchronizationTask() {
 219         return new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory, rics);
 220     }
 221 }