From 4c5740094a9e7f84b72e79f691a34babbf6be344 Mon Sep 17 00:00:00 2001 From: ToineSiebelink Date: Thu, 24 Aug 2023 10:29:34 +0100 Subject: Extend model loader to support model-upgrade (part 1) - refactor existign code for easier extension (no code changes yet, just want to review refactor in this first patch...) - changed log level of some (error) logging Issue-ID: CPS-1804 Signed-off-by: ToineSiebelink Change-Id: I234ad6c4057e9447cd39a83b8f48799918ca6b7f --- .../onap/cps/ncmp/init/AbstractModelLoader.java | 139 +++++++++++++++++++ .../java/org/onap/cps/ncmp/init/ModelLoader.java | 20 +-- .../cps/ncmp/init/SubscriptionModelLoader.java | 147 +++------------------ 3 files changed, 156 insertions(+), 150 deletions(-) create mode 100644 cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/AbstractModelLoader.java (limited to 'cps-ncmp-service/src/main/java') diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/AbstractModelLoader.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/AbstractModelLoader.java new file mode 100644 index 000000000..349b1c5b0 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/AbstractModelLoader.java @@ -0,0 +1,139 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2023 Nordix Foundation + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.init; + +import com.fasterxml.jackson.databind.ObjectMapper; +import java.io.InputStream; +import java.nio.charset.StandardCharsets; +import java.time.OffsetDateTime; +import java.util.Map; +import lombok.NonNull; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.onap.cps.api.CpsAdminService; +import org.onap.cps.api.CpsDataService; +import org.onap.cps.api.CpsModuleService; +import org.onap.cps.ncmp.api.impl.exception.NcmpStartUpException; +import org.onap.cps.spi.exceptions.AlreadyDefinedException; +import org.onap.cps.utils.JsonObjectMapper; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.boot.SpringApplication; +import org.springframework.boot.context.event.ApplicationReadyEvent; +import org.springframework.stereotype.Service; + +@Slf4j +@Service +@RequiredArgsConstructor +abstract class AbstractModelLoader implements ModelLoader { + + private final CpsAdminService cpsAdminService; + private final CpsModuleService cpsModuleService; + private final CpsDataService cpsDataService; + + private static final int EXIT_CODE_ON_ERROR = 1; + + private final JsonObjectMapper jsonObjectMapper = new JsonObjectMapper(new ObjectMapper()); + + @Value("${ncmp.model-loader.maximum-attempt-count:20}") + int maximumAttemptCount; + + @Value("${ncmp.timers.model-loader.retry-time-ms:1000}") + long retryTimeMs; + + @Override + public void onApplicationEvent(@NonNull final ApplicationReadyEvent applicationReadyEvent) { + try { + onboardOrUpgradeModel(); + } catch (final NcmpStartUpException ncmpStartUpException) { + log.error("Onboarding model for NCMP failed: {} ", ncmpStartUpException.getMessage()); + SpringApplication.exit(applicationReadyEvent.getApplicationContext(), () -> EXIT_CODE_ON_ERROR); + } + } + + void waitUntilDataspaceIsAvailable(final String dataspaceName) { + int attemptCount = 0; + while (cpsAdminService.getDataspace(dataspaceName) == null) { + if (attemptCount < maximumAttemptCount) { + try { + Thread.sleep(attemptCount * retryTimeMs); + log.info("Retrieving dataspace {} ... {} attempt(s) ", dataspaceName, ++attemptCount); + } catch (final InterruptedException e) { + Thread.currentThread().interrupt(); + } + } else { + throw new NcmpStartUpException("Retrieval of NCMP dataspace failed", + dataspaceName + " not available (yet)"); + } + } + } + + void createSchemaSet(final String dataspaceName, final String schemaSetName, final String resourceName) { + try { + final Map yangResourceContentMap = createYangResourceToContentMap(resourceName); + cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, yangResourceContentMap); + } catch (final AlreadyDefinedException alreadyDefinedException) { + log.warn("Creating new schema set failed as schema set already exists"); + } catch (final Exception exception) { + log.error("Creating schema set for subscription model failed: {} ", exception.getMessage()); + throw new NcmpStartUpException("Creating schema set failed", exception.getMessage()); + } + } + + void createAnchor(final String dataspaceName, final String schemaSetName, final String anchorName) { + try { + cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName); + } catch (final AlreadyDefinedException alreadyDefinedException) { + log.warn("Creating new anchor failed as anchor already exists"); + } catch (final Exception exception) { + log.error("Creating anchor for subscription model failed: {} ", exception.getMessage()); + throw new NcmpStartUpException("Creating anchor failed", exception.getMessage()); + } + } + + void createTopLevelDataNode(final String dataspaceName, + final String anchorName, + final String dataNodeName) { + final String nodeData = jsonObjectMapper.asJsonString(Map.of(dataNodeName, Map.of())); + try { + cpsDataService.saveData(dataspaceName, anchorName, nodeData, OffsetDateTime.now()); + } catch (final AlreadyDefinedException exception) { + log.warn("Creating new data node '{}' failed as data node already exists", dataNodeName); + } catch (final Exception exception) { + log.error("Creating data node for subscription model failed: {}", exception.getMessage()); + throw new NcmpStartUpException("Creating data node failed", exception.getMessage()); + } + } + + Map createYangResourceToContentMap(final String resourceName) { + return Map.of(resourceName, getFileContentAsString("models/" + resourceName)); + } + + private String getFileContentAsString(final String fileName) { + try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream(fileName)) { + return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8); + } catch (final Exception exception) { + final String message = String.format("Onboarding failed as unable to read file: %s", fileName); + log.debug(message); + throw new NcmpStartUpException(message, exception.getMessage()); + } + } + +} diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/ModelLoader.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/ModelLoader.java index 6f834b702..c61bf1c9b 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/ModelLoader.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/ModelLoader.java @@ -20,7 +20,6 @@ package org.onap.cps.ncmp.init; -import java.util.Map; import lombok.NonNull; import org.springframework.boot.context.event.ApplicationReadyEvent; import org.springframework.context.ApplicationListener; @@ -30,23 +29,6 @@ public interface ModelLoader extends ApplicationListener @Override void onApplicationEvent(@NonNull ApplicationReadyEvent applicationReadyEvent); - /** - * Create schema set. - * - * @param dataspaceName dataspace name - * @param schemaSetName schemaset name - * @param yangResourceContentMap yang resource content map - * @return true if schema set is created - */ - boolean createSchemaSet(String dataspaceName, String schemaSetName, Map yangResourceContentMap); + void onboardOrUpgradeModel(); - /** - * Create anchor. - * - * @param dataspaceName dataspace name - * @param schemaSetName schemaset name - * @param anchorName anchor name - * @return true if anchor is created - */ - boolean createAnchor(String dataspaceName, String schemaSetName, String anchorName); } diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/SubscriptionModelLoader.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/SubscriptionModelLoader.java index af9ee721c..614efd4f4 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/SubscriptionModelLoader.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/init/SubscriptionModelLoader.java @@ -20,162 +20,47 @@ package org.onap.cps.ncmp.init; -import java.io.InputStream; -import java.nio.charset.StandardCharsets; -import java.time.OffsetDateTime; -import java.util.Map; -import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.onap.cps.api.CpsAdminService; import org.onap.cps.api.CpsDataService; import org.onap.cps.api.CpsModuleService; -import org.onap.cps.ncmp.api.impl.exception.NcmpStartUpException; -import org.onap.cps.spi.exceptions.AlreadyDefinedException; -import org.onap.cps.spi.model.Dataspace; import org.springframework.beans.factory.annotation.Value; -import org.springframework.boot.SpringApplication; -import org.springframework.boot.context.event.ApplicationReadyEvent; -import org.springframework.stereotype.Component; +import org.springframework.stereotype.Service; @Slf4j -@Component -@RequiredArgsConstructor -public class SubscriptionModelLoader implements ModelLoader { +@Service +public class SubscriptionModelLoader extends AbstractModelLoader { - private final CpsAdminService cpsAdminService; - private final CpsModuleService cpsModuleService; - private final CpsDataService cpsDataService; private static final String SUBSCRIPTION_MODEL_FILENAME = "subscription.yang"; - private static final String SUBSCRIPTION_MODEL_RESOURCE_PATH = "model/" + SUBSCRIPTION_MODEL_FILENAME; private static final String SUBSCRIPTION_DATASPACE_NAME = "NCMP-Admin"; private static final String SUBSCRIPTION_ANCHOR_NAME = "AVC-Subscriptions"; private static final String SUBSCRIPTION_SCHEMASET_NAME = "subscriptions"; private static final String SUBSCRIPTION_REGISTRY_DATANODE_NAME = "subscription-registry"; - @Value("${ncmp.model-loader.maximum-attempt-count:20}") - private int maximumAttemptCount; - - @Value("${ncmp.timers.model-loader.retry-time-ms:1000}") - private long retryTimeMs; + public SubscriptionModelLoader(final CpsAdminService cpsAdminService, + final CpsModuleService cpsModuleService, + final CpsDataService cpsDataService) { + super(cpsAdminService, cpsModuleService, cpsDataService); + } @Value("${ncmp.model-loader.subscription:true}") private boolean subscriptionModelLoaderEnabled; - /** - * Method calls boarding subscription model when Application is ready. - * - * @param applicationReadyEvent the event to respond to - */ @Override - public void onApplicationEvent(final ApplicationReadyEvent applicationReadyEvent) { - try { - if (subscriptionModelLoaderEnabled) { - checkNcmpDataspaceExists(); - onboardSubscriptionModel(createYangResourceToContentMap()); - } else { - log.info("Subscription Model Loader is disabled"); - } - } catch (final NcmpStartUpException ncmpStartUpException) { - log.debug("Onboarding model for NCMP failed: {} ", ncmpStartUpException.getMessage()); - SpringApplication.exit(applicationReadyEvent.getApplicationContext(), () -> 1); - } - } - - private void checkNcmpDataspaceExists() { - boolean ncmpDataspaceExists = false; - int attemptCount = 0; - while (!ncmpDataspaceExists) { - final Dataspace ncmpDataspace = cpsAdminService.getDataspace(SUBSCRIPTION_DATASPACE_NAME); - if (ncmpDataspace != null) { - ncmpDataspaceExists = true; - } - if (attemptCount < maximumAttemptCount) { - try { - Thread.sleep(attemptCount * retryTimeMs); - attemptCount++; - log.info("Retrieving NCMP dataspace... {} attempt(s) ", attemptCount); - } catch (final InterruptedException e) { - Thread.currentThread().interrupt(); - } - } else { - throw new NcmpStartUpException("Retrieval of NCMP dataspace fails", - "NCMP dataspace does not exist"); - } + public void onboardOrUpgradeModel() { + if (subscriptionModelLoaderEnabled) { + waitUntilDataspaceIsAvailable(SUBSCRIPTION_DATASPACE_NAME); + onboardSubscriptionModel(); + } else { + log.info("Subscription Model Loader is disabled"); } } - /** - * Method to onboard subscription model for NCMP. - */ - private void onboardSubscriptionModel(final Map yangResourceContentMap) { - createSchemaSet(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, yangResourceContentMap); + private void onboardSubscriptionModel() { + createSchemaSet(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, SUBSCRIPTION_MODEL_FILENAME); createAnchor(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_SCHEMASET_NAME, SUBSCRIPTION_ANCHOR_NAME); createTopLevelDataNode(SUBSCRIPTION_DATASPACE_NAME, SUBSCRIPTION_ANCHOR_NAME, SUBSCRIPTION_REGISTRY_DATANODE_NAME); } - - @Override - public boolean createSchemaSet(final String dataspaceName, - final String schemaSetName, - final Map yangResourceContentMap) { - try { - cpsModuleService.createSchemaSet(dataspaceName, schemaSetName, yangResourceContentMap); - } catch (final AlreadyDefinedException exception) { - log.info("Creating new schema set failed as schema set already exists"); - } catch (final Exception exception) { - log.debug("Creating schema set for subscription model failed: {} ", exception.getMessage()); - throw new NcmpStartUpException("Creating schema set failed", exception.getMessage()); - } - return true; - } - - /** - * Create Anchor. - * - * @param dataspaceName dataspace name - * @param schemaSetName schema set name - * @param anchorName anchor name - */ - @Override - public boolean createAnchor(final String dataspaceName, final String schemaSetName, - final String anchorName) { - try { - cpsAdminService.createAnchor(dataspaceName, schemaSetName, anchorName); - } catch (final AlreadyDefinedException exception) { - log.info("Creating new anchor failed as anchor already exists"); - } catch (final Exception exception) { - log.debug("Creating anchor for subscription model failed: {} ", exception.getMessage()); - throw new NcmpStartUpException("Creating anchor failed", exception.getMessage()); - } - return true; - } - - private void createTopLevelDataNode(final String dataspaceName, - final String anchorName, - final String dataNodeName) { - final String nodeData = "{\"" + dataNodeName + "\":{}}"; - try { - cpsDataService.saveData(dataspaceName, anchorName, nodeData, OffsetDateTime.now()); - } catch (final AlreadyDefinedException exception) { - log.info("Creating new data node '{}' failed as data node already exists", dataNodeName); - } catch (final Exception exception) { - log.debug("Creating data node for subscription model failed: {}", exception.getMessage()); - throw new NcmpStartUpException("Creating data node failed", exception.getMessage()); - } - } - - private String getFileContentAsString(final String fileName) { - try (InputStream inputStream = getClass().getClassLoader().getResourceAsStream(fileName)) { - return new String(inputStream.readAllBytes(), StandardCharsets.UTF_8); - } catch (final Exception exception) { - final String message = String.format("Onboarding failed as unable to read file: %s", fileName); - log.debug(message); - throw new NcmpStartUpException(message, exception.getMessage()); - } - } - - private Map createYangResourceToContentMap() { - return Map.of(SUBSCRIPTION_MODEL_FILENAME, getFileContentAsString(SUBSCRIPTION_MODEL_RESOURCE_PATH)); - } } -- cgit 1.2.3-korg