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.repository.Lock.LockType;
  28 import org.oransc.policyagent.repository.Policies;
  29 import org.oransc.policyagent.repository.PolicyTypes;
  30 import org.oransc.policyagent.repository.Ric;
  31 import org.oransc.policyagent.repository.Ric.RicState;
  32 import org.oransc.policyagent.repository.Rics;
  33 import org.oransc.policyagent.repository.Services;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36 import org.springframework.beans.factory.annotation.Autowired;
  37 import org.springframework.scheduling.annotation.EnableScheduling;
  38 import org.springframework.scheduling.annotation.Scheduled;
  39 import org.springframework.stereotype.Component;
  40
  41 import reactor.core.publisher.Flux;
  42 import reactor.core.publisher.Mono;
  43
  44 /**
  45  * Regularly checks the existing rics towards the local repository to keep it
  46  * consistent. When the policy types or instances in the Near-RT RIC is not
  47  * consistent, a synchronization is performed.
  48  */
  49 @Component
  50 @EnableScheduling
  51 @SuppressWarnings("squid:S2629") // Invoke method(s) only conditionally
  52 public class RicSupervision {
  53     private static final Logger logger = LoggerFactory.getLogger(RicSupervision.class);
  54
  55     private final Rics rics;
  56     private final Policies policies;
  57     private final PolicyTypes policyTypes;
  58     private final A1ClientFactory a1ClientFactory;
  59     private final Services services;
  60
  61     @Autowired
  62     public RicSupervision(Rics rics, Policies policies, A1ClientFactory a1ClientFactory, PolicyTypes policyTypes,
  63         Services services) {
  64         this.rics = rics;
  65         this.policies = policies;
  66         this.a1ClientFactory = a1ClientFactory;
  67         this.policyTypes = policyTypes;
  68         this.services = services;
  69     }
  70
  71     /**
  72      * Regularly contacts all Rics to check if they are alive and synchronized.
  73      */
  74     @Scheduled(fixedRate = 1000 * 60)
  75     public void checkAllRics() {
  76         logger.debug("Checking Rics starting");
  77         createTask().subscribe(null, null, () -> logger.debug("Checking all RICs completed"));
  78     }
  79
  80     private Flux<RicData> createTask() {
  81         return Flux.fromIterable(rics.getRics()) //
  82             .flatMap(this::createRicData) //
  83             .flatMap(this::checkOneRic) //
  84             .onErrorResume(throwable -> Mono.empty());
  85
  86     }
  87
  88     private Mono<RicData> checkOneRic(RicData ricData) {
  89         return checkRicState(ricData) //
  90             .flatMap(x -> ricData.ric.getLock().lock(LockType.EXCLUSIVE)) //
  91             .flatMap(x -> checkRicPolicies(ricData)) //
  92             .flatMap(x -> ricData.ric.getLock().unlock()) //
  93             .doOnError(throwable -> ricData.ric.getLock().unlockBlocking()) //
  94             .flatMap(x -> checkRicPolicyTypes(ricData)) //
  95             .doOnNext(x -> logger.debug("Ric: {} checked OK", ricData.ric.name())) //
  96             .doOnError(t -> logger.debug("Ric: {} check Failed, exception: {}", ricData.ric.name(), t.getMessage()));
  97     }
  98
  99     private static class RicData {
 100         RicData(Ric ric, A1Client a1Client) {
 101             this.ric = ric;
 102             this.a1Client = a1Client;
 103         }
 104
 105         final Ric ric;
 106         final A1Client a1Client;
 107     }
 108
 109     private Mono<RicData> createRicData(Ric ric) {
 110         return Mono.just(ric) //
 111             .flatMap(aRic -> this.a1ClientFactory.createA1Client(ric)) //
 112             .flatMap(a1Client -> Mono.just(new RicData(ric, a1Client)));
 113     }
 114
 115     private Mono<RicData> checkRicState(RicData ric) {
 116         if (ric.ric.getState() == RicState.UNAVAILABLE) {
 117             return startSynchronization(ric) //
 118                 .onErrorResume(t -> Mono.empty());
 119         } else if (ric.ric.getState() == RicState.SYNCHRONIZING) {
 120             return Mono.empty();
 121         } else {
 122             return Mono.just(ric);
 123         }
 124     }
 125
 126     private Mono<RicData> checkRicPolicies(RicData ric) {
 127         return ric.a1Client.getPolicyIdentities() //
 128             .flatMap(ricP -> validateInstances(ricP, ric));
 129     }
 130
 131     private Mono<RicData> validateInstances(Collection<String> ricPolicies, RicData ric) {
 132         synchronized (this.policies) {
 133             if (ricPolicies.size() != policies.getForRic(ric.ric.name()).size()) {
 134                 return startSynchronization(ric);
 135             }
 136
 137             for (String policyId : ricPolicies) {
 138                 if (!policies.containsPolicy(policyId)) {
 139                     return startSynchronization(ric);
 140                 }
 141             }
 142             return Mono.just(ric);
 143         }
 144     }
 145
 146     private Mono<RicData> checkRicPolicyTypes(RicData ric) {
 147         return ric.a1Client.getPolicyTypeIdentities() //
 148             .flatMap(ricTypes -> validateTypes(ricTypes, ric));
 149     }
 150
 151     private Mono<RicData> validateTypes(Collection<String> ricTypes, RicData ric) {
 152         if (ricTypes.size() != ric.ric.getSupportedPolicyTypes().size()) {
 153             return startSynchronization(ric);
 154         }
 155         for (String typeName : ricTypes) {
 156             if (!ric.ric.isSupportingType(typeName)) {
 157                 return startSynchronization(ric);
 158             }
 159         }
 160         return Mono.just(ric);
 161     }
 162
 163     private Mono<RicData> startSynchronization(RicData ric) {
 164         RicSynchronizationTask synchronizationTask = createSynchronizationTask();
 165         synchronizationTask.run(ric.ric);
 166         return Mono.error(new Exception("Syncronization started"));
 167     }
 168
 169     RicSynchronizationTask createSynchronizationTask() {
 170         return new RicSynchronizationTask(a1ClientFactory, policyTypes, policies, services);
 171     }
 172 }