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 SynchStartedException extends ServiceException {
  68         private static final long serialVersionUID = 1L;
  69
  70         public SynchStartedException(String message) {
  71             super(message);
  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<RicData> createTask() {
 110         return Flux.fromIterable(rics.getRics()) //
 111                 .flatMap(this::createRicData) //
 112                 .flatMap(this::checkOneRic, CONCURRENCY);
 113     }
 114
 115     private Mono<RicData> checkOneRic(RicData ricData) {
 116         return checkRicState(ricData) //
 117                 .flatMap(x -> ricData.ric.getLock().lock(LockType.EXCLUSIVE, "checkOneRic")) //
 118                 .flatMap(notUsed -> setRicState(ricData)) //
 119                 .flatMap(x -> checkRicPolicies(ricData)) //
 120                 .flatMap(x -> checkRicPolicyTypes(ricData)) //
 121                 .doOnNext(x -> onRicCheckedOk(ricData)) //
 122                 .doOnError(t -> onRicCheckedError(t, ricData)) //
 123                 .onErrorResume(throwable -> Mono.empty());
 124     }
 125
 126     private void onRicCheckedError(Throwable t, RicData ricData) {
 127         logger.debug("Ric: {} check stopped, exception: {}", ricData.ric.id(), t.getMessage());
 128         if (!(t instanceof SynchStartedException)) {
 129             // If synch is started, the synch will set the final state
 130             ricData.ric.setState(RicState.UNAVAILABLE);
 131         }
 132         ricData.ric.getLock().unlockBlocking();
 133     }
 134
 135     private void onRicCheckedOk(RicData ricData) {
 136         logger.debug("Ric: {} checked OK", ricData.ric.id());
 137         ricData.ric.setState(RicState.AVAILABLE);
 138         ricData.ric.getLock().unlockBlocking();
 139     }
 140
 141     @SuppressWarnings("squid:S2445") // Blocks should be synchronized on "private final" fields
 142     private Mono<RicData> setRicState(RicData ric) {
 143         synchronized (ric) {
 144             if (ric.ric.getState() == RicState.CONSISTENCY_CHECK) {
 145                 logger.debug("Ric: {} is already being checked", ric.ric.getConfig().ricId());
 146                 return Mono.empty();
 147             }
 148             ric.ric.setState(RicState.CONSISTENCY_CHECK);
 149             return Mono.just(ric);
 150         }
 151     }
 152
 153     private Mono<RicData> createRicData(Ric ric) {
 154         return Mono.just(ric) //
 155                 .flatMap(aRic -> this.a1ClientFactory.createA1Client(ric)) //
 156                 .map(a1Client -> new RicData(ric, a1Client));
 157     }
 158
 159     private Mono<RicData> checkRicState(RicData ric) {
 160         if (ric.ric.getState() == RicState.UNAVAILABLE) {
 161             logger.debug("RicSupervision, starting ric: {} synchronization (state == UNAVAILABLE)", ric.ric.id());
 162             return startSynchronization(ric) //
 163                     .onErrorResume(t -> Mono.empty());
 164         } else if (ric.ric.getState() == RicState.SYNCHRONIZING || ric.ric.getState() == RicState.CONSISTENCY_CHECK) {
 165             return Mono.empty();
 166         } else {
 167             return Mono.just(ric);
 168         }
 169     }
 170
 171     private Mono<RicData> checkRicPolicies(RicData ric) {
 172         return ric.getClient().getPolicyIdentities() //
 173                 .flatMap(ricP -> validateInstances(ricP, ric));
 174     }
 175
 176     private Mono<RicData> validateInstances(Collection<String> ricPolicies, RicData ric) {
 177         synchronized (this.policies) {
 178             if (ricPolicies.size() != policies.getForRic(ric.ric.id()).size()) {
 179                 logger.debug("RicSupervision, starting ric: {} synchronization (noOfPolicices == {}, expected == {})",
 180                         ric.ric.id(), ricPolicies.size(), policies.getForRic(ric.ric.id()).size());
 181                 return startSynchronization(ric);
 182             }
 183
 184             for (String policyId : ricPolicies) {
 185                 if (!policies.containsPolicy(policyId)) {
 186                     logger.debug("RicSupervision, starting ric: {} synchronization (unexpected policy in RIC: {})",
 187                             ric.ric.id(), policyId);
 188                     return startSynchronization(ric);
 189                 }
 190             }
 191             return Mono.just(ric);
 192         }
 193     }
 194
 195     private Mono<RicData> checkRicPolicyTypes(RicData ric) {
 196         return ric.getClient().getPolicyTypeIdentities() //
 197                 .flatMap(ricTypes -> validateTypes(ricTypes, ric));
 198     }
 199
 200     private Mono<RicData> validateTypes(Collection<String> ricTypes, RicData ric) {
 201         if (ricTypes.size() != ric.ric.getSupportedPolicyTypes().size()) {
 202             logger.debug(
 203                     "RicSupervision, starting ric: {} synchronization (unexpected numer of policy types in RIC: {}, expected: {})",
 204                     ric.ric.id(), ricTypes.size(), ric.ric.getSupportedPolicyTypes().size());
 205             return startSynchronization(ric);
 206         }
 207         for (String typeName : ricTypes) {
 208             if (!ric.ric.isSupportingType(typeName)) {
 209                 logger.debug("RicSupervision, starting ric: {} synchronization (unexpected policy type: {})",
 210                         ric.ric.id(), typeName);
 211                 return startSynchronization(ric);
 212             }
 213         }
 214         return Mono.just(ric);
 215     }
 216
 217     private Mono<RicData> startSynchronization(RicData ric) {
 218         RicSynchronizationTask synchronizationTask = createSynchronizationTask();
 219         return synchronizationTask.synchronizeRic(ric.ric) //
 220                 .flatMap(notUsed -> Mono.error(new SynchStartedException("Syncronization started")));
 221
 222     }
 223
 224     RicSynchronizationTask createSynchronizationTask() {
 225         return new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services, restClientFactory, rics);
 226     }
 227 }