cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/inventory/sync/ModuleSyncWatchdog.java

   1 /*
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2022 Nordix Foundation
   4  *  Modifications Copyright (C) 2022 Bell Canada
   5  *  ================================================================================
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *        http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License.
  17  *
  18  *  SPDX-License-Identifier: Apache-2.0
  19  *  ============LICENSE_END=========================================================
  20  */
  21
  22 package org.onap.cps.ncmp.api.inventory.sync;
  23
  24 import java.util.List;
  25 import java.util.function.Consumer;
  26 import lombok.RequiredArgsConstructor;
  27 import lombok.extern.slf4j.Slf4j;
  28 import org.onap.cps.ncmp.api.impl.yangmodels.YangModelCmHandle;
  29 import org.onap.cps.ncmp.api.inventory.CmHandleState;
  30 import org.onap.cps.ncmp.api.inventory.CompositeState;
  31 import org.onap.cps.ncmp.api.inventory.DataStoreSyncState;
  32 import org.onap.cps.ncmp.api.inventory.InventoryPersistence;
  33 import org.onap.cps.ncmp.api.inventory.LockReasonCategory;
  34 import org.springframework.scheduling.annotation.Scheduled;
  35 import org.springframework.stereotype.Component;
  36
  37 @Slf4j
  38 @RequiredArgsConstructor
  39 @Component
  40 public class ModuleSyncWatchdog {
  41
  42     private final InventoryPersistence inventoryPersistence;
  43
  44     private final SyncUtils syncUtils;
  45
  46     private final ModuleSyncService moduleSyncService;
  47
  48     /**
  49      * Execute Cm Handle poll which changes the cm handle state from 'ADVISED' to 'READY'.
  50      */
  51     @Scheduled(fixedDelayString = "${timers.advised-modules-sync.sleep-time-ms:30000}")
  52     public void executeAdvisedCmHandlePoll() {
  53         YangModelCmHandle advisedCmHandle = syncUtils.getAnAdvisedCmHandle();
  54         while (advisedCmHandle != null) {
  55             final String cmHandleId = advisedCmHandle.getId();
  56             final CompositeState compositeState = inventoryPersistence.getCmHandleState(cmHandleId);
  57             try {
  58                 moduleSyncService.deleteSchemaSetIfExists(advisedCmHandle);
  59                 moduleSyncService.syncAndCreateSchemaSetAndAnchor(advisedCmHandle);
  60                 setCompositeStateToReadyWithInitialDataStoreSyncState().accept(compositeState);
  61             } catch (final Exception e) {
  62                 setCompositeStateToLocked().accept(compositeState);
  63                 syncUtils.updateLockReasonDetailsAndAttempts(compositeState,
  64                         LockReasonCategory.LOCKED_MISBEHAVING, e.getMessage());
  65             }
  66             inventoryPersistence.saveCmHandleState(cmHandleId, compositeState);
  67             log.debug("{} is now in {} state", cmHandleId, compositeState.getCmHandleState().name());
  68             advisedCmHandle = syncUtils.getAnAdvisedCmHandle();
  69         }
  70         log.debug("No Cm-Handles currently found in an ADVISED state");
  71     }
  72
  73     /**
  74      * Execute Cm Handle poll which changes the cm handle state from 'LOCKED' to 'ADVISED'.
  75      */
  76     @Scheduled(fixedDelayString = "${timers.locked-modules-sync.sleep-time-ms:300000}")
  77     public void executeLockedCmHandlePoll() {
  78         final List<YangModelCmHandle> lockedMisbehavingCmHandles = syncUtils.getLockedMisbehavingYangModelCmHandles();
  79         for (final YangModelCmHandle moduleSyncFailedCmHandle : lockedMisbehavingCmHandles) {
  80             final CompositeState compositeState = moduleSyncFailedCmHandle.getCompositeState();
  81             final boolean isReadyForRetry = syncUtils.isReadyForRetry(compositeState);
  82             if (isReadyForRetry) {
  83                 setCompositeStateToAdvisedAndRetainOldLockReasonDetails(compositeState);
  84                 log.debug("Locked misbehaving cm handle {} is being recycled", moduleSyncFailedCmHandle.getId());
  85                 inventoryPersistence.saveCmHandleState(moduleSyncFailedCmHandle.getId(), compositeState);
  86             }
  87         }
  88     }
  89
  90     private Consumer<CompositeState> setCompositeStateToLocked() {
  91         return compositeState -> {
  92             compositeState.setCmHandleState(CmHandleState.LOCKED);
  93             compositeState.setLastUpdateTimeNow();
  94         };
  95     }
  96
  97     private Consumer<CompositeState> setCompositeStateToReadyWithInitialDataStoreSyncState() {
  98         return compositeState -> {
  99             compositeState.setCmHandleState(CmHandleState.READY);
 100             final CompositeState.Operational operational = CompositeState.Operational.builder()
 101                     .dataStoreSyncState(DataStoreSyncState.UNSYNCHRONIZED)
 102                     .lastSyncTime(CompositeState.nowInSyncTimeFormat())
 103                     .build();
 104             final CompositeState.DataStores dataStores = CompositeState.DataStores.builder()
 105                     .operationalDataStore(operational)
 106                     .build();
 107             compositeState.setDataStores(dataStores);
 108         };
 109     }
 110
 111     private void setCompositeStateToAdvisedAndRetainOldLockReasonDetails(final CompositeState compositeState) {
 112         compositeState.setCmHandleState(CmHandleState.ADVISED);
 113         compositeState.setLastUpdateTimeNow();
 114         final String oldLockReasonDetails = compositeState.getLockReason().getDetails();
 115         final CompositeState.LockReason lockReason = CompositeState.LockReason.builder()
 116                 .details(oldLockReasonDetails).build();
 117         compositeState.setLockReason(lockReason);
 118     }
 119 }