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

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