policy-agent/src/main/java/org/oransc/policyagent/tasks/RicSupervision.java

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