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