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