From b63a221f95a7c4e3387cf29bf197ee58c7d9e136 Mon Sep 17 00:00:00 2001 From: JvD_Ericsson Date: Wed, 10 Jan 2024 11:01:05 +0000 Subject: Create tests for EventPublisher error scenarios - Added tests for error scenarios - Added tests for expected scenarios Issue-ID: CPS-1978 Signed-off-by: JvD_Ericsson Change-Id: I6ba19ac456098f074e634f7cf70fdc141491c635 --- .../cps/ncmp/api/impl/events/EventsPublisher.java | 8 +- .../api/impl/events/EventsPublisherSpec.groovy | 120 +++++++++++++++++++++ 2 files changed, 124 insertions(+), 4 deletions(-) create mode 100644 cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/events/EventsPublisherSpec.groovy diff --git a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/EventsPublisher.java b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/EventsPublisher.java index dddad63923..03d440e640 100644 --- a/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/EventsPublisher.java +++ b/cps-ncmp-service/src/main/java/org/onap/cps/ncmp/api/impl/events/EventsPublisher.java @@ -1,6 +1,6 @@ /* * ============LICENSE_START======================================================= - * Copyright (C) 2022-2023 Nordix Foundation + * 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. @@ -118,11 +118,11 @@ public class EventsPublisher { private void handleLegacyEventCallback(final String topicName, final CompletableFuture> eventFuture) { eventFuture.whenComplete((result, e) -> { - if (e != null) { - log.error("Unable to publish event to topic : {} due to {}", topicName, e.getMessage()); - } else { + if (e == null) { log.debug("Successfully published event to topic : {} , Event : {}", result.getRecordMetadata().topic(), result.getProducerRecord().value()); + } else { + log.error("Unable to publish event to topic : {} due to {}", topicName, e.getMessage()); } }); } diff --git a/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/events/EventsPublisherSpec.groovy b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/events/EventsPublisherSpec.groovy new file mode 100644 index 0000000000..9176a79f6f --- /dev/null +++ b/cps-ncmp-service/src/test/groovy/org/onap/cps/ncmp/api/impl/events/EventsPublisherSpec.groovy @@ -0,0 +1,120 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.cps.ncmp.api.impl.events + +import ch.qos.logback.classic.Level +import ch.qos.logback.classic.Logger +import ch.qos.logback.classic.spi.ILoggingEvent +import ch.qos.logback.core.read.ListAppender +import io.cloudevents.CloudEvent +import java.util.concurrent.CompletableFuture +import org.apache.kafka.clients.producer.ProducerRecord +import org.apache.kafka.clients.producer.RecordMetadata +import org.apache.kafka.common.TopicPartition +import org.junit.jupiter.api.AfterEach +import org.junit.jupiter.api.BeforeEach +import org.slf4j.LoggerFactory +import org.springframework.kafka.core.KafkaTemplate +import org.springframework.kafka.support.SendResult +import spock.lang.Specification + +class EventsPublisherSpec extends Specification { + + def legacyKafkaTemplateStub = Stub(KafkaTemplate) + def mockCloudEventKafkaTemplate = Mock(KafkaTemplate) + def logger = Spy(ListAppender) + + @BeforeEach + void setup() { + def setupLogger = ((Logger) LoggerFactory.getLogger(EventsPublisher.class)) + setupLogger.setLevel(Level.DEBUG) + setupLogger.addAppender(logger) + logger.start() + } + + @AfterEach + void teardown() { + ((Logger) LoggerFactory.getLogger(EventsPublisher.class)).detachAndStopAllAppenders() + } + + def objectUnderTest = new EventsPublisher(legacyKafkaTemplateStub, mockCloudEventKafkaTemplate) + + def 'Publish Cloud Event'() { + given: 'a successfully published event' + def eventFuture = CompletableFuture.completedFuture( + new SendResult( + new ProducerRecord('some-topic', 'some-value'), + new RecordMetadata(new TopicPartition('some-topic', 0), 0, 0, 0, 0, 0) + ) + ) + def someCloudEvent = Mock(CloudEvent) + 1 * mockCloudEventKafkaTemplate.send('some-topic', 'some-event-key', someCloudEvent) >> eventFuture + when: 'publishing the cloud event' + objectUnderTest.publishCloudEvent('some-topic', 'some-event-key', someCloudEvent) + then: 'the correct debug message is logged' + def lastLoggingEvent = logger.list[0] + assert lastLoggingEvent.level == Level.DEBUG + assert lastLoggingEvent.formattedMessage.contains('Successfully published event') + } + + def 'Publish Cloud Event with Exception'() { + given: 'a failed event' + def eventFutureWithFailure = new CompletableFuture>() + eventFutureWithFailure.completeExceptionally(new RuntimeException('some exception')) + def someCloudEvent = Mock(CloudEvent) + 1 * mockCloudEventKafkaTemplate.send('some-topic', 'some-event-key', someCloudEvent) >> eventFutureWithFailure + when: 'publishing the cloud event' + objectUnderTest.publishCloudEvent('some-topic', 'some-event-key', someCloudEvent) + then: 'the correct error message is logged' + def lastLoggingEvent = logger.list[0] + assert lastLoggingEvent.level == Level.ERROR + assert lastLoggingEvent.formattedMessage.contains('Unable to publish event') + } + + def 'Handle Legacy Event Callback'() { + given: 'an event is successfully published' + def eventFuture = CompletableFuture.completedFuture( + new SendResult( + new ProducerRecord('some-topic', 'some-value'), + new RecordMetadata(new TopicPartition('some-topic', 0), 0, 0, 0, 0, 0) + ) + ) + when: 'handling legacy event callback' + objectUnderTest.handleLegacyEventCallback('some-topic', eventFuture) + then: 'the correct debug message is logged' + def lastLoggingEvent = logger.list[0] + assert lastLoggingEvent.level == Level.DEBUG + assert lastLoggingEvent.formattedMessage.contains('Successfully published event') + } + + def 'Handle Legacy Event Callback with Exception'() { + given: 'a failure to publish an event' + def eventFutureWithFailure = new CompletableFuture>() + eventFutureWithFailure.completeExceptionally(new RuntimeException('some exception')) + when: 'handling legacy event callback' + objectUnderTest.handleLegacyEventCallback('some-topic', eventFutureWithFailure) + then: 'the correct error message is logged' + def lastLoggingEvent = logger.list[0] + assert lastLoggingEvent.level == Level.ERROR + assert lastLoggingEvent.formattedMessage.contains('Unable to publish event') + } + +} \ No newline at end of file -- cgit 1.2.3-korg