diff options
29 files changed, 420 insertions, 296 deletions
diff --git a/cps-application/src/main/resources/application.yml b/cps-application/src/main/resources/application.yml index decc03b263..9e9d57a441 100644 --- a/cps-application/src/main/resources/application.yml +++ b/cps-application/src/main/resources/application.yml @@ -236,8 +236,10 @@ ncmp: timers: advised-modules-sync: + initial-delay-ms: 40000 sleep-time-ms: 5000 cm-handle-data-sync: + initial-delay-ms: 40000 sleep-time-ms: 30000 subscription-forwarding: dmi-response-timeout-ms: 30000 diff --git a/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/DataJobControllerForTest.java b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/DataJobControllerForTest.java new file mode 100644 index 0000000000..d259d91796 --- /dev/null +++ b/cps-ncmp-rest/src/main/java/org/onap/cps/ncmp/rest/controller/DataJobControllerForTest.java @@ -0,0 +1,79 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2025 OpenInfra Foundation Europe. All rights reserved. + * ================================================================================ + * 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.rest.controller; + +import io.swagger.v3.oas.annotations.Hidden; +import java.util.List; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.onap.cps.ncmp.api.datajobs.DataJobService; +import org.onap.cps.ncmp.api.datajobs.models.DataJobMetadata; +import org.onap.cps.ncmp.api.datajobs.models.DataJobRequest; +import org.onap.cps.ncmp.api.datajobs.models.DataJobWriteRequest; +import org.onap.cps.ncmp.api.datajobs.models.SubJobWriteResponse; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.PostMapping; +import org.springframework.web.bind.annotation.RequestBody; +import org.springframework.web.bind.annotation.RequestHeader; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +/** + * Controller responsible for handling data job write operations. + * This class exposes an API endpoint that accepts a write request for a data job and processes it. + */ +@Slf4j +@RestController +@RequestMapping("/do-not-use/dataJobs") +@RequiredArgsConstructor +public class DataJobControllerForTest { + + private final DataJobService dataJobService; + + /** + * Handles POST requests to write a data job. This endpoint is unsupported and intended for testing purposes only. + * This internal endpoint processes a data job write request by extracting necessary metadata and data + * from the request body and delegating the operation to the {@link DataJobService}. + * <p><b>Note:</b> The {@link DataJobRequest} parameter is created and used for testing purposes only. + * In a production environment, data job write operations are not triggered through internal workflows.</p> + * + * @param authorization The optional authorization token sent in the request header. + * @param dataJobId The unique identifier for the data job, extracted from the URL path. + * @param dataJobRequest The request payload containing metadata and data for the data job write operation. + * @return A {@link ResponseEntity} containing a list of {@link SubJobWriteResponse} objects representing the + * status of each sub-job within the data job, or an error response with an appropriate HTTP status code. + */ + @PostMapping("/{dataJobId}/write") + @Hidden + public ResponseEntity<List<SubJobWriteResponse>> writeDataJob(@RequestHeader(value = "Authorization", + required = false) final String authorization, + @PathVariable("dataJobId") final String dataJobId, + @RequestBody final DataJobRequest dataJobRequest) { + log.info("Internal API: writeDataJob invoked for {}", dataJobId); + final DataJobMetadata dataJobMetadata = dataJobRequest.dataJobMetadata(); + final DataJobWriteRequest dataJobWriteRequest = dataJobRequest.dataJobWriteRequest(); + final List<SubJobWriteResponse> subJobWriteResponses = dataJobService.writeDataJob(authorization, dataJobId, + dataJobMetadata, dataJobWriteRequest); + return ResponseEntity.ok(subJobWriteResponses); + } +} + diff --git a/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/DataJobControllerForTestSpec.groovy b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/DataJobControllerForTestSpec.groovy new file mode 100644 index 0000000000..6fc4a699e5 --- /dev/null +++ b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/DataJobControllerForTestSpec.groovy @@ -0,0 +1,50 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2025 OpenInfra Foundation Europe. All rights reserved. + * ================================================================================ + * 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.rest.controller + +import org.onap.cps.ncmp.api.datajobs.DataJobService +import org.onap.cps.ncmp.api.datajobs.models.DataJobMetadata +import org.onap.cps.ncmp.api.datajobs.models.DataJobRequest +import org.onap.cps.ncmp.api.datajobs.models.DataJobWriteRequest +import org.onap.cps.ncmp.api.datajobs.models.WriteOperation +import org.springframework.http.HttpStatus +import spock.lang.Specification + +class DataJobControllerForTestSpec extends Specification { + + DataJobService mockDataJobService = Mock() + + def objectUnderTest = new DataJobControllerForTest(mockDataJobService) + + def 'Write Data Job request'() { + given: 'a valid datajob write request' + def dataJobMetadata = new DataJobMetadata('some destination', 'some accept type', 'some content type') + def writeOperations = [ new WriteOperation('/path/to/node', 'create', 'op123', 'value1') ] + def dataJobWriteRequest = new DataJobWriteRequest(writeOperations) + def dataJobRequest = new DataJobRequest(dataJobMetadata, dataJobWriteRequest) + when: 'write data job is called' + def result = objectUnderTest.writeDataJob('my authorization', 'my job', dataJobRequest) + then: 'response is 200 OK' + assert result.statusCode == HttpStatus.OK + and: 'the service method is called once with expected parameters' + 1 * mockDataJobService.writeDataJob('my authorization', 'my job', dataJobMetadata, dataJobWriteRequest) + } +} diff --git a/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyRestExceptionHandlerSpec.groovy b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyRestExceptionHandlerSpec.groovy index aad04a18ae..3a9a0bb09c 100644 --- a/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyRestExceptionHandlerSpec.groovy +++ b/cps-ncmp-rest/src/test/groovy/org/onap/cps/ncmp/rest/controller/NetworkCmProxyRestExceptionHandlerSpec.groovy @@ -1,7 +1,7 @@ /* * ============LICENSE_START======================================================= * Copyright (C) 2021 highstreet technologies GmbH - * Modifications Copyright (C) 2021-2024 Nordix Foundation + * Modifications Copyright (C) 2021-2025 OpenInfra Foundation Europe. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -102,6 +102,9 @@ class NetworkCmProxyRestExceptionHandlerSpec extends Specification { @SpringBean NcmpPassthroughResourceRequestHandler StubbedNcmpPassthroughResourceRequestHandler = Stub() + @SpringBean + DataJobControllerForTest stubbedDataJobControllerForTest = Stub() + @Value('${rest.api.ncmp-base-path}') def basePathNcmp diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/datajobs/models/DataJobRequest.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/datajobs/models/DataJobRequest.java new file mode 100644 index 0000000000..fe73a601b9 --- /dev/null +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/datajobs/models/DataJobRequest.java @@ -0,0 +1,24 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2025 OpenInfra Foundation Europe. All rights reserved. + * ================================================================================ + * 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.api.datajobs.models; + +public record DataJobRequest(DataJobMetadata dataJobMetadata, DataJobWriteRequest dataJobWriteRequest) { +} diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/DataSyncWatchdog.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/DataSyncWatchdog.java index af78d95742..708077915b 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/DataSyncWatchdog.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/DataSyncWatchdog.java @@ -55,7 +55,8 @@ public class DataSyncWatchdog { * Execute Cm Handle poll which queries the cm handle state in 'READY' and Operational Datastore Sync State in * 'UNSYNCHRONIZED'. */ - @Scheduled(fixedDelayString = "${ncmp.timers.cm-handle-data-sync.sleep-time-ms:30000}") + @Scheduled(initialDelayString = "${ncmp.timers.cm-handle-data-sync.initial-delay-ms:40000}", + fixedDelayString = "${ncmp.timers.cm-handle-data-sync.sleep-time-ms:30000}") public void executeUnSynchronizedReadyCmHandlePoll() { moduleOperationsUtils.getUnsynchronizedReadyCmHandles().forEach(unSynchronizedReadyCmHandle -> { final String cmHandleId = unSynchronizedReadyCmHandle.getId(); diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/ModuleSyncWatchdog.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/ModuleSyncWatchdog.java index 8c9ec03dd9..62eb514953 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/ModuleSyncWatchdog.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/impl/inventory/sync/ModuleSyncWatchdog.java @@ -53,7 +53,7 @@ public class ModuleSyncWatchdog { * This method will only finish when there are no more 'ADVISED' cm handles in the DB. * This method is triggered on a configurable interval (ncmp.timers.advised-modules-sync.sleep-time-ms) */ - @Scheduled(initialDelayString = "${test.ncmp.timers.advised-modules-sync.initial-delay-ms:0}", + @Scheduled(initialDelayString = "${ncmp.timers.advised-modules-sync.initial-delay-ms:40000}", fixedDelayString = "${ncmp.timers.advised-modules-sync.sleep-time-ms:5000}") public void moduleSyncAdvisedCmHandles() { log.debug("Processing module sync watchdog waking up."); diff --git a/csit/plans/cps/pnfsim/docker-compose.yml b/csit/plans/cps/pnfsim/docker-compose.yml deleted file mode 100644 index 869df22789..0000000000 --- a/csit/plans/cps/pnfsim/docker-compose.yml +++ /dev/null @@ -1,27 +0,0 @@ -# ============LICENSE_START======================================================= -# Modifications Copyright (C) 2022-2024 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. -# ============LICENSE_END========================================================= - -services: - netconf-pnp-simulator: - image: blueonap/netconf-pnp-simulator:v2.8.6 - container_name: netconf-simulator - restart: always - ports: - - "831:830" - - "6512:6513" - volumes: - - ./netconf-config:/config/modules/stores - - ./tls:/config/tls diff --git a/csit/plans/cps/sdnc/check_sdnc_mount_node.sh b/csit/plans/cps/sdnc/check_sdnc_mount_node.sh deleted file mode 100644 index e92cec717f..0000000000 --- a/csit/plans/cps/sdnc/check_sdnc_mount_node.sh +++ /dev/null @@ -1,82 +0,0 @@ -# ============LICENSE_START======================================================= -# Copyright (C) 2023-2024 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. -# ============LICENSE_END========================================================= - -# WAIT 10 minutes maximum and test every 30 seconds if SDNC is up using HealthCheck API -TIME_OUT=600 -INTERVAL=30 -TIME=0 -while [ "$TIME" -lt "$TIME_OUT" ]; do - response=$(curl --write-out '%{http_code}' --silent --output /dev/null -H "Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==" -X POST -H "X-FromAppId: csit-sdnc" -H "X-TransactionId: csit-sdnc" -H "Accept: application/json" -H "Content-Type: application/json" http://$SDNC_HOST:$SDNC_PORT/restconf/operations/SLI-API:healthcheck ); - echo $response - - if [ "$response" == "200" ]; then - echo SDNC started in $TIME seconds - break; - fi - - echo Sleep: $INTERVAL seconds before testing if SDNC is up. Total wait time up now is: $TIME seconds. Timeout is: $TIME_OUT seconds - sleep $INTERVAL - TIME=$(($TIME+$INTERVAL)) -done - -if [ "$TIME" -ge "$TIME_OUT" ]; then - echo TIME OUT: karaf session not started in $TIME_OUT seconds... Could cause problems for testing activities... -fi - -###################### mount pnf-sim as PNFDemo ########################## -SDNC_TIME_OUT=250 -SDNC_INTERVAL=10 -SDNC_TIME=0 - -while [ "$SDNC_TIME" -le "$SDNC_TIME_OUT" ]; do - - # Mount netconf node - curl --location --request PUT 'http://'$SDNC_HOST:$SDNC_PORT'/restconf/config/network-topology:network-topology/topology/topology-netconf/node/ietfYang-PNFDemo' \ - --header 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' \ - --header 'Content-Type: application/json' \ - --data-raw '{ - "node": [ - { - "node-id": "ietfYang-PNFDemo", - "netconf-node-topology:protocol": { - "name": "TLS" - }, - "netconf-node-topology:host": "'$LOCAL_IP'", - "netconf-node-topology:key-based": { - "username": "netconf", - "key-id": "ODL_private_key_0" - }, - "netconf-node-topology:port": 6512, - "netconf-node-topology:tcp-only": false, - "netconf-node-topology:max-connection-attempts": 5 - } - ] - }' - - # Verify node has been mounted - - RESPONSE=$( curl --location --request GET 'http://'$SDNC_HOST:$SDNC_PORT'/restconf/config/network-topology:network-topology/topology/topology-netconf' --header 'Authorization: basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==') - - if [[ "$RESPONSE" == *"ietfYang-PNFDemo"* ]]; then - echo "Node mounted in $SDNC_TIME" - sleep 10 - break; - fi - - sleep $SDNC_INTERVAL - SDNC_TIME=$((SDNC_TIME + SDNC_INTERVAL)) - -done
\ No newline at end of file diff --git a/csit/plans/cps/sdnc/docker-compose.yml b/csit/plans/cps/sdnc/docker-compose.yml deleted file mode 100644 index 29e8293fde..0000000000 --- a/csit/plans/cps/sdnc/docker-compose.yml +++ /dev/null @@ -1,71 +0,0 @@ -# ============LICENSE_START======================================================= -# Modifications Copyright (C) 2022 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. -# ============LICENSE_END========================================================= - -services: - mariadb: - image: mariadb:10.5 - ports: - - "3306:3306" - environment: - - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-password} - - MYSQL_ROOT_HOST=% - - MYSQL_USER=${MYSQL_USER:-sdnc} - - MYSQL_PASSWORD=${MYSQL_PASSWORD:-password} - - MYSQL_DATABASE=${MYSQL_DATABASE:-sdncdb} - logging: - driver: "json-file" - options: - max-size: "30m" - max-file: "5" - - sdnc: - image: onap/sdnc-image:${VERSION:-2.2.3} - container_name: sdnc - depends_on : - - mariadb - entrypoint: ["/opt/onap/sdnc/bin/startODL.sh"] - ports: - - "8282:8181" - hostname: - sdnc - links: - - mariadb:dbhost - - mariadb:sdnctldb01 - - mariadb:sdnctldb02 - environment: - - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-password} - - MYSQL_USER=${MYSQL_USER:-sdnc} - - MYSQL_PASSWORD=${MYSQL_PASSWORD:-password} - - MYSQL_DATABASE=${MYSQL_DATABASE:-sdncdb} - - SDNC_CONFIG_DIR=/opt/onap/sdnc/data/properties - - SDNC_BIN=/opt/onap/sdnc/bin - - ODL_CERT_DIR=/opt/opendaylight/certs - - ODL_ADMIN_USERNAME=${ODL_USER:-admin} - - ODL_ADMIN_PASSWORD=${ODL_PASSWORD:-Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U} - - SDNC_DB_INIT=true - - SQL_CRYPTKEY=${SQL_CRYPTKEY:-fakECryptKey} - - volumes: - - ./certs/certs.properties:/opt/opendaylight/certs/certs.properties - - ./certs/keys0.zip:/opt/opendaylight/certs/keys0.zip - - dns: - - ${DNS_IP_ADDR-10.0.100.1} - logging: - driver: "json-file" - options: - max-size: "30m" - max-file: "5"
\ No newline at end of file diff --git a/csit/plans/cps/sdnc/sdnc_setup.sh b/csit/plans/cps/sdnc/sdnc_setup.sh deleted file mode 100644 index 61c61fc289..0000000000 --- a/csit/plans/cps/sdnc/sdnc_setup.sh +++ /dev/null @@ -1,27 +0,0 @@ -#!/bin/bash -# -# ============LICENSE_START======================================================= -# Copyright (C) 2021-2022 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========================================================= - -# @author Rahul Tyagi (rahul.tyagi@est.tech) -# setup sdnc - -export SDNC_CERT_PATH=$WORKSPACE/plans/cps/sdnc/certs - -#start SDNC containers with docker compose and configuration from docker-compose.yml -docker-compose -f $WORKSPACE/plans/cps/sdnc/docker-compose.yml up -d
\ No newline at end of file diff --git a/csit/plans/cps/setup.sh b/csit/plans/cps/setup.sh index 332be8c461..f22173a9fd 100755 --- a/csit/plans/cps/setup.sh +++ b/csit/plans/cps/setup.sh @@ -5,7 +5,7 @@ # Modifications copyright (c) 2020-2021 Samsung Electronics Co., Ltd. # Modifications Copyright (C) 2021 Pantheon.tech # Modifications Copyright (C) 2021 Bell Canada. -# Modifications Copyright (C) 2021-2025 Nordix Foundation. +# Modifications Copyright (C) 2021-2025 OpenInfra Foundation Europe. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -24,7 +24,7 @@ ###################### setup env ############################ # Set env variables for docker compose -export LOCAL_IP=$((ip -4 addr show docker0 | grep -Po 'inet \K[\d.]+') || hostname -I | awk '{print $1}') +export LOCAL_IP=localhost source $WORKSPACE/plans/cps/test.properties export $(cut -d= -f1 $WORKSPACE/plans/cps/test.properties) @@ -33,14 +33,17 @@ export $(cut -d= -f1 $WORKSPACE/plans/cps/test.properties) cd $CPS_HOME/docker-compose # start CPS/NCMP, DMI Plugin, and PostgreSQL containers with docker compose, waiting for all containers to be healthy -docker-compose --profile dmi-service up -d --quiet-pull --wait || exit 1 - -###################### setup sdnc ####################################### -source $WORKSPACE/plans/cps/sdnc/sdnc_setup.sh - -###################### setup pnfsim ##################################### -docker-compose -f $WORKSPACE/plans/cps/pnfsim/docker-compose.yml up -d +docker-compose --profile dmi-service --profile dmi-stub up -d --quiet-pull --wait || exit 1 ###################### ROBOT Configurations ########################## # Pass variables required for Robot test suites in ROBOT_VARIABLES -ROBOT_VARIABLES="-v CPS_CORE_HOST:$CPS_CORE_HOST -v CPS_CORE_PORT:$CPS_CORE_PORT -v DMI_HOST:$LOCAL_IP -v DMI_PORT:$DMI_PORT -v DMI_VERSION:$DMI_VERSION -v DMI_CSIT_STUB_HOST:$LOCAL_IP -v DMI_CSIT_STUB_PORT:$DMI_DEMO_STUB_PORT -v DMI_AUTH_ENABLED:$DMI_AUTH_ENABLED -v DATADIR_CPS_CORE:$WORKSPACE/data/cps-core -v DATADIR_NCMP:$WORKSPACE/data/ncmp -v DATADIR_SUBS_NOTIFICATION:$WORKSPACE/data/subscription-notification --exitonfailure" +ROBOT_VARIABLES="\ +-v CPS_CORE_HOST:$CPS_CORE_HOST \ +-v CPS_CORE_PORT:$CPS_CORE_PORT \ +-v DMI_HOST:$DMI_HOST \ +-v DMI_PORT:$DMI_PORT \ +-v DMI_CSIT_STUB_HOST:$DMI_DEMO_STUB_HOST \ +-v DMI_CSIT_STUB_PORT:$DMI_DEMO_STUB_PORT \ +-v DATADIR_CPS_CORE:$WORKSPACE/data/cps-core \ +-v DATADIR_NCMP:$WORKSPACE/data/ncmp \ +-v DATADIR_SUBS_NOTIFICATION:$WORKSPACE/data/subscription-notification" diff --git a/csit/plans/cps/test.properties b/csit/plans/cps/test.properties index 52e82bdb85..ce218320af 100644 --- a/csit/plans/cps/test.properties +++ b/csit/plans/cps/test.properties @@ -1,9 +1,9 @@ -DB_HOST=$LOCAL_IP +DB_HOST=dbpostgresql DB_USERNAME=cps DB_PASSWORD=cps -SDNC_HOST=$LOCAL_IP -SDNC_PORT=8282 +SDNC_HOST=sdnc +SDNC_PORT=8181 SDNC_USERNAME=admin SDNC_PASSWORD=Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U @@ -12,23 +12,24 @@ CPS_CORE_PORT=8883 CPS_CORE_USERNAME=cpsuser CPS_CORE_PASSWORD=cpsr0cks! -DMI_HOST=$LOCAL_IP -DMI_PORT=8783 +DMI_HOST=ncmp-dmi-plugin +DMI_PORT=8080 DMI_USERNAME=cpsuser DMI_PASSWORD=cpsr0cks! -DMI_SERVICE_URL=http://$LOCAL_IP:$DMI_PORT +DMI_SERVICE_URL=http://$DMI_HOST:$DMI_PORT DOCKER_REPO=nexus3.onap.org:10003 CPS_VERSION=latest DMI_VERSION=latest +DMI_DEMO_STUB_VERSION=latest ADVISED_MODULES_SYNC_SLEEP_TIME_MS=2000 CMHANDLE_DATA_SYNC_SLEEP_TIME_MS=2000 CPS_HOME=$CPS_HOME -DMI_DEMO_STUB_PORT=8784 -DMI_DEMO_STUB_VERSION=latest +DMI_DEMO_STUB_HOST=ncmp-dmi-plugin-demo-and-csit-stub +DMI_DEMO_STUB_PORT=8092 DMI_AUTH_ENABLED=true diff --git a/csit/plans/cps/pnfsim/netconf-config/LICENSE b/docker-compose/config/pnfsim/netconf-config/LICENSE index 3bc5b026c6..3bc5b026c6 100755 --- a/csit/plans/cps/pnfsim/netconf-config/LICENSE +++ b/docker-compose/config/pnfsim/netconf-config/LICENSE diff --git a/csit/plans/cps/pnfsim/netconf-config/stores.yang b/docker-compose/config/pnfsim/netconf-config/stores.yang index 56ad95c8d5..56ad95c8d5 100644 --- a/csit/plans/cps/pnfsim/netconf-config/stores.yang +++ b/docker-compose/config/pnfsim/netconf-config/stores.yang diff --git a/csit/plans/cps/pnfsim/netconf-config/subscriber.py b/docker-compose/config/pnfsim/netconf-config/subscriber.py index 5147c93458..5147c93458 100755 --- a/csit/plans/cps/pnfsim/netconf-config/subscriber.py +++ b/docker-compose/config/pnfsim/netconf-config/subscriber.py diff --git a/csit/plans/cps/pnfsim/tls/ca.pem b/docker-compose/config/pnfsim/tls/ca.pem index 4c4473815c..4c4473815c 100644 --- a/csit/plans/cps/pnfsim/tls/ca.pem +++ b/docker-compose/config/pnfsim/tls/ca.pem diff --git a/csit/plans/cps/pnfsim/tls/server_cert.pem b/docker-compose/config/pnfsim/tls/server_cert.pem index a022dc56ca..a022dc56ca 100644 --- a/csit/plans/cps/pnfsim/tls/server_cert.pem +++ b/docker-compose/config/pnfsim/tls/server_cert.pem diff --git a/csit/plans/cps/pnfsim/tls/server_key.pem b/docker-compose/config/pnfsim/tls/server_key.pem index 02fd68846d..02fd68846d 100644 --- a/csit/plans/cps/pnfsim/tls/server_key.pem +++ b/docker-compose/config/pnfsim/tls/server_key.pem diff --git a/csit/plans/cps/sdnc/certs/certs.properties b/docker-compose/config/sdnc/certs/certs.properties index f8f3fa72b6..f8f3fa72b6 100644 --- a/csit/plans/cps/sdnc/certs/certs.properties +++ b/docker-compose/config/sdnc/certs/certs.properties diff --git a/csit/plans/cps/sdnc/certs/keys0.zip b/docker-compose/config/sdnc/certs/keys0.zip Binary files differindex b2dec5c7b2..b2dec5c7b2 100644 --- a/csit/plans/cps/sdnc/certs/keys0.zip +++ b/docker-compose/config/sdnc/certs/keys0.zip diff --git a/docker-compose/config/sdnc/check_sdnc_mount_node.sh b/docker-compose/config/sdnc/check_sdnc_mount_node.sh new file mode 100644 index 0000000000..8fa4bee8cf --- /dev/null +++ b/docker-compose/config/sdnc/check_sdnc_mount_node.sh @@ -0,0 +1,61 @@ +#!/bin/sh +# ============LICENSE_START======================================================= +# Copyright (C) 2025 OpenInfra Foundation Europe. All rights reserved. +# ================================================================================ +# 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. +# ============LICENSE_END========================================================= + +set -x # Enable command echoing +apk --no-cache add curl + +SDNC_HOST=${SDNC_HOST:-'sdnc'} +SDNC_PORT=${SDNC_PORT:-8181} +SDNC_AUTH_HEADER=${SDNC_AUTH_HEADER:-'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ=='} +PNF_SIM_HOST=${PNF_SIM_HOST:-'pnf-simulator'} +PNF_SIM_PORT=${PNF_SIM_PORT:-6513} +NODE_ID=${NODE_ID:-'ietfYang-PNFDemo'} + +echo "Attempting to mount node with id '$NODE_ID' to SDNC using RestConf" +curl --request PUT "http://$SDNC_HOST:$SDNC_PORT/restconf/config/network-topology:network-topology/topology/topology-netconf/node/$NODE_ID" \ +--silent --location \ +--header "$SDNC_AUTH_HEADER" \ +--header 'Content-Type: application/json' \ +--data-raw '{ + "node": [ + { + "node-id": "'$NODE_ID'", + "netconf-node-topology:protocol": { + "name": "TLS" + }, + "netconf-node-topology:host": "'$PNF_SIM_HOST'", + "netconf-node-topology:key-based": { + "username": "netconf", + "key-id": "ODL_private_key_0" + }, + "netconf-node-topology:port": '$PNF_SIM_PORT', + "netconf-node-topology:tcp-only": false, + "netconf-node-topology:max-connection-attempts": 5 + } + ] +}' + +# Verify node has been mounted +RESPONSE=$(curl --silent --location --request GET "http://$SDNC_HOST:$SDNC_PORT/restconf/config/network-topology:network-topology/topology/topology-netconf" --header "$SDNC_AUTH_HEADER") + +if echo "$RESPONSE" | grep -q "$NODE_ID"; then + echo "Node mounted successfully" + exit 0 +else + echo "Could not mount node to SNDC" + exit 1 +fi diff --git a/docker-compose/docker-compose.yml b/docker-compose/docker-compose.yml index 49646731e2..568fab4810 100644 --- a/docker-compose/docker-compose.yml +++ b/docker-compose/docker-compose.yml @@ -1,7 +1,7 @@ # ============LICENSE_START======================================================= # Copyright (c) 2020 Pantheon.tech. # Modifications Copyright (C) 2021 Bell Canada. -# Modifications Copyright (C) 2022-2025 Nordix Foundation. +# Modifications Copyright (C) 2022-2025 OpenInfra Foundation Europe. # ================================================================================ # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -154,11 +154,14 @@ services: image: ${DOCKER_REPO:-nexus3.onap.org:10003}/onap/ncmp-dmi-plugin:${DMI_VERSION:-1.7.0-SNAPSHOT-latest} ports: - ${DMI_PORT:-8783}:8080 + depends_on: + - sdnc + - pnf-simulator environment: CPS_USERNAME: ${CPS_CORE_USERNAME:-cpsuser} CPS_PASSWORD: ${CPS_CORE_PASSWORD:-cpsr0cks!} - CPS_CORE_HOST: ${CPS_CORE_HOST:-cps-and-ncmp} - CPS_CORE_PORT: ${CPS_CORE_PORT:-8080} + CPS_CORE_HOST: ${CPS_CORE_HOST:-nginx} + CPS_CORE_PORT: ${CPS_CORE_PORT:-80} CPS_CORE_USERNAME: ${CPS_CORE_USERNAME:-cpsuser} CPS_CORE_PASSWORD: ${CPS_CORE_PASSWORD:-cpsr0cks!} SDNC_HOST: ${SDNC_HOST:-sdnc} @@ -197,7 +200,6 @@ services: restart: unless-stopped profiles: - dmi-stub - - dmi-service healthcheck: test: wget -q -O - http://localhost:8092/actuator/health/readiness | grep -q '{"status":"UP"}' || exit 1 interval: 10s @@ -205,6 +207,98 @@ services: retries: 3 start_period: 30s + sdnc: + container_name: sdnc + image: onap/sdnc-image:${SDNC_VERSION:-2.2.3} + entrypoint: /opt/onap/sdnc/bin/startODL.sh + ports: + - 8181:8181 + depends_on: + sdnc-db: + condition: service_healthy + hostname: sdnc + links: + - sdnc-db:dbhost + - sdnc-db:sdnctldb01 + - sdnc-db:sdnctldb02 + environment: + - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-password} + - MYSQL_USER=${MYSQL_USER:-sdnc} + - MYSQL_PASSWORD=${MYSQL_PASSWORD:-password} + - MYSQL_DATABASE=${MYSQL_DATABASE:-sdncdb} + - SDNC_CONFIG_DIR=/opt/onap/sdnc/data/properties + - SDNC_BIN=/opt/onap/sdnc/bin + - ODL_CERT_DIR=/opt/opendaylight/certs + - ODL_ADMIN_USERNAME=${SDNC_USERNAME:-admin} + - ODL_ADMIN_PASSWORD=${SDNC_PASSWORD:-Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U} + - SDNC_DB_INIT=true + - SQL_CRYPTKEY=${SQL_CRYPTKEY:-fakECryptKey} + volumes: + - ./config/sdnc/certs/certs.properties:/opt/opendaylight/certs/certs.properties + - ./config/sdnc/certs/keys0.zip:/opt/opendaylight/certs/keys0.zip + profiles: + - dmi-service + healthcheck: + test: "wget -q -O - --header 'Authorization: Basic YWRtaW46S3A4Yko0U1hzek0wV1hsaGFrM2VIbGNzZTJnQXc4NHZhb0dHbUp2VXkyVQ==' http://localhost:8181/restconf/operational/network-topology:network-topology || exit 1" + interval: 10s + timeout: 10s + retries: 6 + start_period: 60s + + sdnc-sidecar: # This container runs a script to mount the PNFDemo node to SDNC, needed for CSITs. + container_name: sdnc-sidecar + image: alpine:latest + volumes: + - ./config/sdnc/check_sdnc_mount_node.sh:/root/check_sdnc_mount_node.sh + command: sh /root/check_sdnc_mount_node.sh + depends_on: + sdnc: + condition: service_healthy + pnf-simulator: + condition: service_healthy + profiles: + - dmi-service + # Note: This container does not need a health-check as it immediately exits with status 0 or 1. + + sdnc-db: + container_name: sdnc-db + image: mariadb:10.5 + ports: + - 3306:3306 + environment: + - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-password} + - MYSQL_ROOT_HOST=% + - MYSQL_USER=${MYSQL_USER:-sdnc} + - MYSQL_PASSWORD=${MYSQL_PASSWORD:-password} + - MYSQL_DATABASE=${MYSQL_DATABASE:-sdncdb} + profiles: + - dmi-service + healthcheck: + test: healthcheck.sh --connect --innodb_initialized || exit 1 + interval: 10s + timeout: 10s + retries: 3 + start_period: 30s + + pnf-simulator: + container_name: pnf-simulator + image: blueonap/netconf-pnp-simulator:v2.8.6 + restart: always + ports: + - 830:830 + - 6513:6513 + volumes: + - ./config/pnfsim/netconf-config:/config/modules/stores + - ./config/pnfsim/tls:/config/tls + profiles: + - dmi-service + healthcheck: + test: nc -z 127.0.0.1 6513 || exit 1 + interval: 10s + timeout: 10s + retries: 3 + start_period: 30s + policy-executor-stub: container_name: ${POLICY_EXECUTOR_STUB_CONTAINER_NAME:-policy-executor-stub} image: ${DOCKER_REPO:-nexus3.onap.org:10003}/onap/policy-executor-stub:latest diff --git a/docs/deployment.rst b/docs/deployment.rst index 840ab8e116..b3a279f92b 100644 --- a/docs/deployment.rst +++ b/docs/deployment.rst @@ -192,100 +192,97 @@ To get a listing of the cps-core Pods, run the following command: Additional CPS-Core Customizations ================================== -The following table lists some properties that can be specified as Helm chart -values to configure the application to be deployed. This list is not exhaustive. - -Any spring supported property can be configured by providing in ``config.additional.<spring-supported-property-name>: value`` Example: config.additional.spring.datasource.hikari.maximumPoolSize: 30 +The following table lists some properties that can be configured in the deployment. This list is not exhaustive. +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | Property | Description | Default Value | +===========================================+=========================================================================================================+===============================+ -| config.appUserName | User name used by cps-core service to configure the authentication for REST API it exposes. | ``cpsuser`` | +| appUserName | User name used by cps-core service to configure the authentication for REST API it exposes. | ``cpsuser`` | | | This is the user name to be used by cps-core REST clients to authenticate themselves. | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.appUserPassword | Password used by cps-core service to configure the authentication for REST API it exposes. | Not defined | +| appUserPassword | Password used by cps-core service to configure the authentication for REST API it exposes. | Not defined | | | If not defined, the password is generated when deploying the application. | | | | See also :ref:`cps_common_credentials_retrieval`. | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| postgres.config.pgUserName | Internal user name used by cps-core to connect to its own database. | ``cps`` | +| postgres.pgUserName | Internal user name used by cps-core to connect to its own database. | ``cps`` | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| postgres.config.pgUserPassword | Internal password used by cps-core to connect to its own database. | Not defined | +| postgres.pgUserPassword | Internal password used by cps-core to connect to its own database. | Not defined | | | If not defined, the password is generated when deploying the application. | | | | See also :ref:`cps_common_credentials_retrieval`. | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| postgres.config.pgDatabase | Database name used by cps-core | ``cpsdb`` | +| postgres.pgDatabase | Database name used by cps-core | ``cpsdb`` | | | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ | logging.level | Logging level set in cps-core | info | | | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.useStrimziKafka | If targeting a custom kafka cluster, i.e. useStrimziKafka: false, the | true | -| | config.eventPublisher.spring.kafka values below must be set. | | +| useStrimziKafka | If targeting a custom kafka cluster, i.e. useStrimziKafka: false, the | true | +| | eventPublisher.spring.kafka values below must be set. | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka hostname and port | ``<kafka-bootstrap>:9092`` | +| eventPublisher. | Kafka hostname and port | ``<kafka-bootstrap>:9092`` | | spring.kafka.bootstrap-servers | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka consumer client id | ``cps-core`` | +| eventPublisher. | Kafka consumer client id | ``cps-core`` | | spring.kafka.consumer.client-id | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka security protocol. | ``SASL_PLAINTEXT`` | +| eventPublisher. | Kafka security protocol. | ``SASL_PLAINTEXT`` | | spring.kafka.security.protocol | Some possible values are: | | | | * ``PLAINTEXT`` | | | | * ``SASL_PLAINTEXT``, for authentication | | | | * ``SASL_SSL``, for authentication and encryption | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka security SASL mechanism. Required for SASL_PLAINTEXT and SASL_SSL protocols. | Not defined | +| eventPublisher. | Kafka security SASL mechanism. Required for SASL_PLAINTEXT and SASL_SSL protocols. | Not defined | | spring.kafka.properties. | Some possible values are: | | | sasl.mechanism | * ``PLAIN``, for PLAINTEXT | | | | * ``SCRAM-SHA-512``, for SSL | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka security SASL JAAS configuration. Required for SASL_PLAINTEXT and SASL_SSL protocols. | Not defined | +| eventPublisher. | Kafka security SASL JAAS configuration. Required for SASL_PLAINTEXT and SASL_SSL protocols. | Not defined | | spring.kafka.properties. | Some possible values are: | | | sasl.jaas.config | * ``org.apache.kafka.common.security.plain.PlainLoginModule required username="..." password="...";``, | | | | for PLAINTEXT | | | | * ``org.apache.kafka.common.security.scram.ScramLoginModule required username="..." password="...";``, | | | | for SSL | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka security SASL SSL store type. Required for SASL_SSL protocol. | Not defined | +| eventPublisher. | Kafka security SASL SSL store type. Required for SASL_SSL protocol. | Not defined | | spring.kafka.ssl.trust-store-type | Some possible values are: | | | | * ``JKS`` | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka security SASL SSL store file location. Required for SASL_SSL protocol. | Not defined | +| eventPublisher. | Kafka security SASL SSL store file location. Required for SASL_SSL protocol. | Not defined | | spring.kafka.ssl.trust-store-location | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka security SASL SSL store password. Required for SASL_SSL protocol. | Not defined | +| eventPublisher. | Kafka security SASL SSL store password. Required for SASL_SSL protocol. | Not defined | | spring.kafka.ssl.trust-store-password | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.eventPublisher. | Kafka security SASL SSL broker hostname identification verification. Required for SASL_SSL protocol. | Not defined | +| eventPublisher. | Kafka security SASL SSL broker hostname identification verification. Required for SASL_SSL protocol. | Not defined | | spring.kafka.properties. | Possible value is: | | | ssl.endpoint.identification.algorithm | | | | | * ``""``, empty string to disable | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Core pool size in asynchronous execution of notification. | ``2`` | +| additional. | Core pool size in asynchronous execution of notification. | ``2`` | | notification.async.executor. | | | | core-pool-size | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Max pool size in asynchronous execution of notification. | ``1`` | +| additional. | Max pool size in asynchronous execution of notification. | ``1`` | | notification.async.executor. | | | | max-pool-size | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Queue Capacity in asynchronous execution of notification. | ``500`` | +| additional. | Queue Capacity in asynchronous execution of notification. | ``500`` | | notification.async.executor. | | | | queue-capacity | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | If the executor should wait for the tasks to be completed on shutdown | ``true`` | +| additional. | If the executor should wait for the tasks to be completed on shutdown | ``true`` | | notification.async.executor. | | | | wait-for-tasks-to-complete-on-shutdown | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Prefix to be added to the thread name in asynchronous execution of notifications. | ``Async-`` | +| additional. | Prefix to be added to the thread name in asynchronous execution of notifications. | ``Async-`` | | notification.async.executor. | | | | thread-name-prefix | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Maximum time allowed by the thread pool executor for execution of one of the threads in milliseconds. | ``60000`` | +| additional. | Maximum time allowed by the thread pool executor for execution of one of the threads in milliseconds. | ``60000`` | | notification.async.executor. | | | | time-out-value-in-ms | | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ -| config.additional. | Specifies number of database connections between database and application. | ``10`` | +| additional. | Specifies number of database connections between database and application. | ``10`` | | spring.datasource.hikari. | This property controls the maximum size that the pool is allowed to reach, | | | maximumPoolSize | including both idle and in-use connections. | | +-------------------------------------------+---------------------------------------------------------------------------------------------------------+-------------------------------+ @@ -298,72 +295,79 @@ Additional CPS-NCMP Customizations +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ | Property | Description | Default Value | +=================================================+=======================================================================================+=================================+ -| config.dmiPluginUserName | User name used by cps-core to authenticate themselves for using ncmp-dmi-plugin | ``dmiuser`` | +| dmiPluginUserName | User name used by cps-core to authenticate themselves for using ncmp-dmi-plugin | ``dmiuser`` | | | service. | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.dmiPluginUserPassword | Internal password used by cps-core to connect to ncmp-dmi-plugin service. | Not defined | +| dmiPluginUserPassword | Internal password used by cps-core to connect to ncmp-dmi-plugin service. | Not defined | | | If not defined, the password is generated when deploying the application. | | | | See also :ref:`cps_common_credentials_retrieval`. | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.ncmp.timers | Specifies the delay in milliseconds in which the module sync watch dog will wake again| ``5000`` | +| ncmp.timers | Specifies the delay in milliseconds in which the module sync watch dog will wake again| ``5000`` | | .advised-modules-sync.sleep-time-ms | after finishing. | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.ncmp.timers | Specifies the delay in milliseconds in which the data sync watch dog will wake again | ``30000`` | +| ncmp.timers | Specifies the delay in milliseconds in which the module sync watch dog will wake up | ``40000`` | +| .advised-modules-sync.initial-delay-ms | for the first time. | | ++-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ +| ncmp.timers | Specifies the delay in milliseconds in which the data sync watch dog will wake again | ``30000`` | | .cm-handle-data-sync.sleep-time-ms | after finishing. | | | | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp | Maximum size (in MB) of the in-memory buffer for HTTP response data. | ``16`` | +| ncmp.timers | Specifies the delay in milliseconds in which the data sync watch dog will wake up | ``40000`` | +| .cm-handle-data-sync.initial-delay-ms | for the first time. | | +| | | | ++-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ +| additional.ncmp | Maximum size (in MB) of the in-memory buffer for HTTP response data. | ``16`` | | .[app] | | | | .httpclient | | | | .[services] | | | | .maximumInMemorySizeInMegabytes | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp | Maximum number of simultaneous connections allowed in the connection pool. | ``100`` | +| additional.ncmp | Maximum number of simultaneous connections allowed in the connection pool. | ``100`` | | .[app] | | | | .httpclient | | | | .[services] | | | | .maximumConnectionsTotal | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp | Maximum number of pending requests when the connection pool is full. | ``50`` | +| additional.ncmp | Maximum number of pending requests when the connection pool is full. | ``50`` | | .[app] | | | | .httpclient | | | | .[services] | | | | .pendingAcquireMaxCount | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp | Specifies the maximum time in seconds, to wait for establishing a connection for the | ``30`` | +| additional.ncmp | Specifies the maximum time in seconds, to wait for establishing a connection for the | ``30`` | | .[app] | HTTP Client. | | | .httpclient | | | | .[services] | | | | .connectionTimeoutInSeconds | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp | Timeout (in seconds) for reading data from the server after the connection is | ``30`` | +| additional.ncmp | Timeout (in seconds) for reading data from the server after the connection is | ``30`` | | .[app] | established. | | | .httpclient | | | | .[services] | | | | .readTimeoutInSeconds | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp | Timeout (in seconds) for writing data to the server. | ``30`` | +| additional.ncmp | Timeout (in seconds) for writing data to the server. | ``30`` | | .[app] | | | | .httpclient | | | | .[services] | | | | .writeTimeoutInSeconds | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp | Total timeout (in seconds) for receiving a complete response, including all processing| ``60`` | +| additional.ncmp | Total timeout (in seconds) for receiving a complete response, including all processing| ``60`` | | .[app] | stages. | | | .httpclient | | | | .[services] | | | | .responseTimeoutInSeconds | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp.policy-executor | Enables or disables the policy-executor feature. | ``false`` | +| additional.ncmp.policy-executor | Enables or disables the policy-executor feature. | ``false`` | | .enabled | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp.policy-executor | The default (fallback) decision in case a problem with the external service occurs. | ``allow`` | +| additional.ncmp.policy-executor | The default (fallback) decision in case a problem with the external service occurs. | ``allow`` | | .defaultDecision | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp.policy-executor | The server address for the external policy executor service. | ``http://policy-executor-stub`` | +| additional.ncmp.policy-executor | The server address for the external policy executor service. | ``http://policy-executor-stub`` | | .server.address | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ -| config.additional.ncmp.policy-executor | The port used for the external policy executor service. | ``8093`` | +| additional.ncmp.policy-executor | The port used for the external policy executor service. | ``8093`` | | .server.port | | | +-------------------------------------------------+---------------------------------------------------------------------------------------+---------------------------------+ diff --git a/integration-test/src/test/resources/application-module-sync-delayed.yml b/integration-test/src/test/resources/application-module-sync-delayed.yml index 7b9c6aea4f..27c99e93b2 100644 --- a/integration-test/src/test/resources/application-module-sync-delayed.yml +++ b/integration-test/src/test/resources/application-module-sync-delayed.yml @@ -1,3 +1,4 @@ + # ============LICENSE_START======================================================= # Copyright (C) 2024 Nordix Foundation. # ================================================================================ @@ -14,7 +15,6 @@ # # SPDX-License-Identifier: Apache-2.0 # ============LICENSE_END========================================================= - test: ncmp: timers: diff --git a/integration-test/src/test/resources/application.yml b/integration-test/src/test/resources/application.yml index e213a70a59..024ff5b33f 100644 --- a/integration-test/src/test/resources/application.yml +++ b/integration-test/src/test/resources/application.yml @@ -180,6 +180,7 @@ ncmp: timers: advised-modules-sync: + initial-delay-ms: 0 sleep-time-ms: 1000000 cm-handle-data-sync: sleep-time-ms: 30000 diff --git a/k6-tests/ncmp/common/passthrough-crud.js b/k6-tests/ncmp/common/passthrough-crud.js index eed1ab5190..c6732571ba 100644 --- a/k6-tests/ncmp/common/passthrough-crud.js +++ b/k6-tests/ncmp/common/passthrough-crud.js @@ -1,6 +1,6 @@ /* * ============LICENSE_START======================================================= - * Copyright (C) 2024 Nordix Foundation + * Copyright (C) 2024-2025 OpenInfra Foundation Europe. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,13 +18,12 @@ * ============LICENSE_END========================================================= */ -import { randomIntBetween } from 'https://jslib.k6.io/k6-utils/1.2.0/index.js'; import { performPostRequest, performGetRequest, NCMP_BASE_URL, LEGACY_BATCH_TOPIC_NAME, - TOTAL_CM_HANDLES, + getRandomCmHandleReference, } from './utils.js'; export function passthroughRead(useAlternateId) { @@ -66,11 +65,6 @@ export function legacyBatchRead(cmHandleIds) { return performPostRequest(url, payload, 'batchRead'); } -function getRandomCmHandleReference(useAlternateId) { - const prefix = useAlternateId ? 'Region=NorthAmerica,Segment=' : 'ch-'; - return `${prefix}${randomIntBetween(1, TOTAL_CM_HANDLES)}`; -} - function generatePassthroughUrl(cmHandleReference, datastoreName, resourceIdentifier, includeDescendants) { const descendantsParam = includeDescendants ? `&include-descendants=${includeDescendants}` : ''; return `${NCMP_BASE_URL}/ncmp/v1/ch/${cmHandleReference}/data/ds/${datastoreName}?resourceIdentifier=${resourceIdentifier}${descendantsParam}`; diff --git a/k6-tests/ncmp/common/utils.js b/k6-tests/ncmp/common/utils.js index 36ce6b48f3..ea77aae176 100644 --- a/k6-tests/ncmp/common/utils.js +++ b/k6-tests/ncmp/common/utils.js @@ -1,6 +1,6 @@ /* * ============LICENSE_START======================================================= - * Copyright (C) 2024-2025 Nordix Foundation + * Copyright (C) 2024-2025 OpenInfra Foundation Europe. All rights reserved. * ================================================================================ * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -18,6 +18,7 @@ * ============LICENSE_END========================================================= */ +import { randomIntBetween } from 'https://jslib.k6.io/k6-utils/1.2.0/index.js'; import http from 'k6/http'; export const testConfig = JSON.parse(open(`../config/${__ENV.TEST_PROFILE}.json`)); @@ -48,16 +49,29 @@ export function makeBatchOfCmHandleIds(batchSize, batchNumber) { } /** - * Generates an unordered batch of CM-handle IDs based on batch size. - * @returns {string[]} Array of CM-handle IDs, for example ['ch-8', 'ch-2' ... 'ch-32432'] + * Generates an unordered batch of Alternate IDs. + * The batch size is determined by `LEGACY_BATCH_THROUGHPUT_TEST_BATCH_SIZE`, + * and the IDs are generated within the range of `TOTAL_CM_HANDLES`. + * + * @returns {string[]} Array of Alternate IDs, for example, + * ['Region=NorthAmerica,Segment=8', 'Region=NorthAmerica,Segment=2' ... 'Region=NorthAmerica,Segment=32432'] */ -export function makeRandomBatchOfCmHandleIds() { - const cmHandleIds = new Set(); - while (cmHandleIds.size < LEGACY_BATCH_THROUGHPUT_TEST_BATCH_SIZE) { - const randomNum = Math.floor(Math.random() * TOTAL_CM_HANDLES) + 1; - cmHandleIds.add('ch-' + randomNum); +export function makeRandomBatchOfAlternateIds() { + const alternateIds = new Set(); + while (alternateIds.size < LEGACY_BATCH_THROUGHPUT_TEST_BATCH_SIZE) { + alternateIds.add(getRandomCmHandleReference(true)); } - return Array.from(cmHandleIds) + return Array.from(alternateIds) +} + +/** + * Generates a random CM Handle reference based on the provided flag. + * @param useAlternateId + * @returns {string} CM Handle reference representing a CM handle ID or an alternate ID. + */ +export function getRandomCmHandleReference(useAlternateId) { + const prefix = useAlternateId ? 'Region=NorthAmerica,Segment=' : 'ch-'; + return `${prefix}${randomIntBetween(1, TOTAL_CM_HANDLES)}`; } /** diff --git a/k6-tests/ncmp/ncmp-test-runner.js b/k6-tests/ncmp/ncmp-test-runner.js index 1104b14e4a..1c53139991 100644 --- a/k6-tests/ncmp/ncmp-test-runner.js +++ b/k6-tests/ncmp/ncmp-test-runner.js @@ -23,7 +23,7 @@ import { Trend } from 'k6/metrics'; import { Reader } from 'k6/x/kafka'; import { TOTAL_CM_HANDLES, READ_DATA_FOR_CM_HANDLE_DELAY_MS, WRITE_DATA_FOR_CM_HANDLE_DELAY_MS, - makeCustomSummaryReport, makeBatchOfCmHandleIds, makeRandomBatchOfCmHandleIds, + makeCustomSummaryReport, makeBatchOfCmHandleIds, makeRandomBatchOfAlternateIds, LEGACY_BATCH_THROUGHPUT_TEST_BATCH_SIZE, REGISTRATION_BATCH_SIZE, LEGACY_BATCH_THROUGHPUT_TEST_NUMBER_OF_REQUESTS, KAFKA_BOOTSTRAP_SERVERS, LEGACY_BATCH_TOPIC_NAME, CONTAINER_UP_TIME_IN_SECONDS, testConfig } from './common/utils.js'; @@ -183,7 +183,7 @@ export function cmHandleSearchCpsPathScenario() { export function cmHandleIdSearchTrustLevelScenario() { const response = executeCmHandleIdSearch('trust-level'); if (check(response, { 'CM handle ID trust level search status equals 200': (r) => r.status === 200 }) - && check(response, { 'CM handle ID trust level search returned the correct number of ids': (r) => r.json('#') === TOTAL_CM_HANDLES })) { + && check(response, { 'CM handle ID trust level search returned the correct number of cm handle references': (r) => r.json('#') === TOTAL_CM_HANDLES })) { idSearchTrustLevelDurationTrend.add(response.timings.duration); } } @@ -197,8 +197,8 @@ export function cmHandleSearchTrustLevelScenario() { } export function legacyBatchProduceScenario() { - const nextBatchOfCmHandleIds = makeRandomBatchOfCmHandleIds(); - const response = legacyBatchRead(nextBatchOfCmHandleIds); + const nextBatchOfAlternateIds = makeRandomBatchOfAlternateIds(); + const response = legacyBatchRead(nextBatchOfAlternateIds); check(response, { 'data operation batch read status equals 200': (r) => r.status === 200 }); } |