From b86ef87781764606358ace875ef13f36e39502d0 Mon Sep 17 00:00:00 2001 From: mpriyank Date: Thu, 24 Aug 2023 14:20:51 +0100 Subject: Fix pojos and classes with new cps version - incorporate changes done on pojos and schema rename in cps 3.3.6 which affects dmi plugin - refactor the test cases and naming - dmi plugin to use the upgraded cps version Issue-ID: CPS-1828 Change-Id: I98fbb15dac58caac584b9e267be0c1cdc3675b91 Signed-off-by: mpriyank --- .../avcsubscription/SubscriptionEventConsumer.java | 126 --------------------- .../SubscriptionEventResponseMapper.java | 94 --------------- .../CmSubscriptionDmiInEventConsumer.java | 124 ++++++++++++++++++++ ...mSubscriptionDmiOutEventToCloudEventMapper.java | 62 ++++++++++ .../dmi/notifications/mapper/CloudEventMapper.java | 62 ++++++++++ 5 files changed, 248 insertions(+), 220 deletions(-) delete mode 100644 src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventConsumer.java delete mode 100644 src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventResponseMapper.java create mode 100644 src/main/java/org/onap/cps/ncmp/dmi/notifications/cmsubscription/CmSubscriptionDmiInEventConsumer.java create mode 100644 src/main/java/org/onap/cps/ncmp/dmi/notifications/cmsubscription/CmSubscriptionDmiOutEventToCloudEventMapper.java create mode 100644 src/main/java/org/onap/cps/ncmp/dmi/notifications/mapper/CloudEventMapper.java (limited to 'src/main/java/org/onap') diff --git a/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventConsumer.java b/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventConsumer.java deleted file mode 100644 index bef68a67..00000000 --- a/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventConsumer.java +++ /dev/null @@ -1,126 +0,0 @@ -/* - * ============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.dmi.notifications.avcsubscription; - -import io.cloudevents.CloudEvent; -import java.util.ArrayList; -import java.util.HashSet; -import java.util.List; -import java.util.Set; -import lombok.RequiredArgsConstructor; -import lombok.extern.slf4j.Slf4j; -import org.apache.kafka.clients.consumer.ConsumerRecord; -import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.Data; -import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse; -import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionStatus; -import org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.CmHandle; -import org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent; -import org.springframework.beans.factory.annotation.Value; -import org.springframework.kafka.annotation.KafkaListener; -import org.springframework.kafka.core.KafkaTemplate; -import org.springframework.stereotype.Component; - -@Component -@Slf4j -@RequiredArgsConstructor -public class SubscriptionEventConsumer { - - @Value("${app.dmi.avc.subscription-response-topic}") - private String cmAvcSubscriptionResponseTopic; - @Value("${dmi.service.name}") - private String dmiName; - private final KafkaTemplate cloudEventKafkaTemplate; - - /** - * Consume the specified event. - * - * @param subscriptionCloudEvent the event to be consumed - */ - @KafkaListener(topics = "${app.dmi.avc.subscription-topic}", - containerFactory = "cloudEventConcurrentKafkaListenerContainerFactory") - public void consumeSubscriptionEvent(final ConsumerRecord subscriptionCloudEvent) { - final SubscriptionEvent subscriptionEvent = - SubscriptionEventResponseMapper.toSubscriptionEvent(subscriptionCloudEvent.value()); - if (subscriptionEvent != null) { - final String eventKey = subscriptionCloudEvent.value().getId(); - final String subscriptionType = subscriptionCloudEvent.value().getType(); - if ("subscriptionCreated".equals(subscriptionType)) { - sendSubscriptionResponseMessage(eventKey, "subscriptionCreatedStatus", - formSubscriptionEventResponse(subscriptionEvent)); - } else if ("subscriptionDeleted".equals(subscriptionType)) { - sendSubscriptionResponseMessage(eventKey, "subscriptionDeletedStatus", - formSubscriptionEventResponse(subscriptionEvent)); - } - } - } - - /** - * Sends message to the configured topic. - * - * @param eventKey is the kafka message key - * @param subscriptionType is the type of subscription action - * @param subscriptionEventResponse is the payload of the kafka message - */ - public void sendSubscriptionResponseMessage(final String eventKey, - final String subscriptionType, - final SubscriptionEventResponse subscriptionEventResponse) { - cloudEventKafkaTemplate.send(cmAvcSubscriptionResponseTopic, eventKey, - SubscriptionEventResponseMapper.toCloudEvent(subscriptionEventResponse, subscriptionType, dmiName)); - } - - private SubscriptionEventResponse formSubscriptionEventResponse(final SubscriptionEvent subscriptionEvent) { - final SubscriptionEventResponse subscriptionEventResponse = new SubscriptionEventResponse(); - final Data subscriptionResponseData = new Data(); - subscriptionResponseData.setClientId(subscriptionEvent.getData().getSubscription().getClientID()); - subscriptionResponseData.setSubscriptionName(subscriptionEvent.getData().getSubscription().getName()); - subscriptionResponseData.setDmiName(dmiName); - - final List cmHandles = subscriptionEvent.getData() - .getPredicates().getTargets(); - subscriptionResponseData - .setSubscriptionStatus( - populateSubscriptionStatus( - extractCmHandleIds(cmHandles))); - subscriptionEventResponse.setData(subscriptionResponseData); - return subscriptionEventResponse; - } - - private Set extractCmHandleIds(final List cmHandles) { - final Set cmHandleIds = new HashSet<>(); - - for (final CmHandle cmHandle : cmHandles) { - cmHandleIds.add(cmHandle.getId()); - } - return cmHandleIds; - } - - private List populateSubscriptionStatus(final Set cmHandleIds) { - final List subscriptionStatuses = new ArrayList<>(); - for (final String cmHandleId : cmHandleIds) { - final SubscriptionStatus status = new SubscriptionStatus(); - status.setId(cmHandleId); - status.setStatus(SubscriptionStatus.Status.ACCEPTED); - subscriptionStatuses.add(status); - } - return subscriptionStatuses; - } - -} diff --git a/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventResponseMapper.java b/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventResponseMapper.java deleted file mode 100644 index 49bdfe31..00000000 --- a/src/main/java/org/onap/cps/ncmp/dmi/notifications/avcsubscription/SubscriptionEventResponseMapper.java +++ /dev/null @@ -1,94 +0,0 @@ -/* - * ============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.dmi.notifications.avcsubscription; - -import com.fasterxml.jackson.databind.ObjectMapper; -import io.cloudevents.CloudEvent; -import io.cloudevents.core.CloudEventUtils; -import io.cloudevents.core.builder.CloudEventBuilder; -import io.cloudevents.core.data.PojoCloudEventData; -import io.cloudevents.jackson.PojoCloudEventDataMapper; -import java.net.URI; -import java.util.UUID; -import lombok.AccessLevel; -import lombok.NoArgsConstructor; -import lombok.extern.slf4j.Slf4j; -import org.onap.cps.ncmp.dmi.exception.CloudEventConstructionException; -import org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse; -import org.onap.cps.ncmp.events.avcsubscription1_0_0.ncmp_to_dmi.SubscriptionEvent; - -@NoArgsConstructor(access = AccessLevel.PRIVATE) -@Slf4j -public class SubscriptionEventResponseMapper { - - private static final ObjectMapper objectMapper = new ObjectMapper(); - - /** - * Maps CloudEvent object to SubscriptionEvent object. - * - * @param cloudEvent object - * @return SubscriptionEvent deserialized - */ - public static SubscriptionEvent toSubscriptionEvent(final CloudEvent cloudEvent) { - final PojoCloudEventData deserializedCloudEvent = - CloudEventUtils.mapData(cloudEvent, - PojoCloudEventDataMapper.from(objectMapper, SubscriptionEvent.class)); - if (deserializedCloudEvent == null) { - log.debug("No data found in the consumed subscription response event"); - return null; - } else { - final SubscriptionEvent subscriptionEvent = deserializedCloudEvent.getValue(); - log.debug("Consuming subscription response event {}", subscriptionEvent); - return subscriptionEvent; - } - } - - /** - * Maps SubscriptionEventResponse to a CloudEvent. - * - * @param subscriptionEventResponse object. - * @param subscriptionType String of subscription type. - * @param dmiName String of dmiName. - * @return CloudEvent built. - */ - public static CloudEvent toCloudEvent( - final org.onap.cps.ncmp.events.avcsubscription1_0_0.dmi_to_ncmp.SubscriptionEventResponse - subscriptionEventResponse, - final String subscriptionType, - final String dmiName) { - try { - return CloudEventBuilder.v1() - .withId(UUID.randomUUID().toString()) - .withSource(URI.create(dmiName)) - .withType(subscriptionType) - .withDataSchema(URI.create("urn:cps:" + SubscriptionEventResponse.class.getName() + ":1.0.0")) - .withExtension("correlationid", subscriptionEventResponse.getData().getClientId() + ":" - + subscriptionEventResponse.getData().getSubscriptionName()) - .withData(objectMapper.writeValueAsBytes(subscriptionEventResponse)) - .build(); - } catch (final Exception ex) { - throw new CloudEventConstructionException("The Cloud Event could not be constructed", "Invalid object to " - + "serialize or required headers is missing", ex); - } - } - - -} diff --git a/src/main/java/org/onap/cps/ncmp/dmi/notifications/cmsubscription/CmSubscriptionDmiInEventConsumer.java b/src/main/java/org/onap/cps/ncmp/dmi/notifications/cmsubscription/CmSubscriptionDmiInEventConsumer.java new file mode 100644 index 00000000..57652809 --- /dev/null +++ b/src/main/java/org/onap/cps/ncmp/dmi/notifications/cmsubscription/CmSubscriptionDmiInEventConsumer.java @@ -0,0 +1,124 @@ +/* + * ============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.dmi.notifications.cmsubscription; + +import io.cloudevents.CloudEvent; +import java.util.ArrayList; +import java.util.HashSet; +import java.util.List; +import java.util.Set; +import lombok.RequiredArgsConstructor; +import org.apache.kafka.clients.consumer.ConsumerRecord; +import org.onap.cps.ncmp.dmi.notifications.mapper.CloudEventMapper; +import org.onap.cps.ncmp.events.cmsubscription1_0_0.dmi_to_ncmp.CmSubscriptionDmiOutEvent; +import org.onap.cps.ncmp.events.cmsubscription1_0_0.dmi_to_ncmp.Data; +import org.onap.cps.ncmp.events.cmsubscription1_0_0.dmi_to_ncmp.SubscriptionStatus; +import org.onap.cps.ncmp.events.cmsubscription1_0_0.ncmp_to_dmi.CmHandle; +import org.onap.cps.ncmp.events.cmsubscription1_0_0.ncmp_to_dmi.CmSubscriptionDmiInEvent; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.kafka.annotation.KafkaListener; +import org.springframework.kafka.core.KafkaTemplate; +import org.springframework.stereotype.Service; + +@Service +@RequiredArgsConstructor +public class CmSubscriptionDmiInEventConsumer { + + @Value("${app.dmi.avc.subscription-response-topic}") + private String cmAvcSubscriptionResponseTopic; + @Value("${dmi.service.name}") + private String dmiName; + private final KafkaTemplate cloudEventKafkaTemplate; + + /** + * Consume the specified event. + * + * @param cmSubscriptionDmiInCloudEvent the event to be consumed + */ + @KafkaListener(topics = "${app.dmi.avc.subscription-topic}", + containerFactory = "cloudEventConcurrentKafkaListenerContainerFactory") + public void consumeCmSubscriptionDmiInEvent( + final ConsumerRecord cmSubscriptionDmiInCloudEvent) { + final CmSubscriptionDmiInEvent cmSubscriptionDmiInEvent = + CloudEventMapper.toTargetEvent(cmSubscriptionDmiInCloudEvent.value(), CmSubscriptionDmiInEvent.class); + if (cmSubscriptionDmiInEvent != null) { + final String eventKey = cmSubscriptionDmiInCloudEvent.value().getId(); + final String subscriptionType = cmSubscriptionDmiInCloudEvent.value().getType(); + if ("subscriptionCreated".equals(subscriptionType)) { + sendCmSubscriptionDmiOutEvent(eventKey, "subscriptionCreatedStatus", + formCmSubscriptionDmiOutEvent(cmSubscriptionDmiInEvent)); + } else if ("subscriptionDeleted".equals(subscriptionType)) { + sendCmSubscriptionDmiOutEvent(eventKey, "subscriptionDeletedStatus", + formCmSubscriptionDmiOutEvent(cmSubscriptionDmiInEvent)); + } + } + } + + /** + * Sends message to the configured topic. + * + * @param eventKey is the kafka message key + * @param subscriptionType is the type of subscription action + * @param cmSubscriptionDmiOutEvent is the payload of the kafka message + */ + public void sendCmSubscriptionDmiOutEvent(final String eventKey, final String subscriptionType, + final CmSubscriptionDmiOutEvent cmSubscriptionDmiOutEvent) { + cloudEventKafkaTemplate.send(cmAvcSubscriptionResponseTopic, eventKey, + CmSubscriptionDmiOutEventToCloudEventMapper.toCloudEvent(cmSubscriptionDmiOutEvent, subscriptionType, + dmiName)); + } + + private CmSubscriptionDmiOutEvent formCmSubscriptionDmiOutEvent( + final CmSubscriptionDmiInEvent cmSubscriptionDmiInEvent) { + final CmSubscriptionDmiOutEvent cmSubscriptionDmiOutEvent = new CmSubscriptionDmiOutEvent(); + final Data cmSubscriptionDmiOutEventData = new Data(); + cmSubscriptionDmiOutEventData.setClientId(cmSubscriptionDmiInEvent.getData().getSubscription().getClientID()); + cmSubscriptionDmiOutEventData.setSubscriptionName( + cmSubscriptionDmiInEvent.getData().getSubscription().getName()); + cmSubscriptionDmiOutEventData.setDmiName(dmiName); + + final List cmHandles = cmSubscriptionDmiInEvent.getData().getPredicates().getTargets(); + cmSubscriptionDmiOutEventData.setSubscriptionStatus(populateSubscriptionStatus(extractCmHandleIds(cmHandles))); + cmSubscriptionDmiOutEvent.setData(cmSubscriptionDmiOutEventData); + return cmSubscriptionDmiOutEvent; + } + + private Set extractCmHandleIds(final List cmHandles) { + final Set cmHandleIds = new HashSet<>(); + + for (final CmHandle cmHandle : cmHandles) { + cmHandleIds.add(cmHandle.getId()); + } + return cmHandleIds; + } + + private List populateSubscriptionStatus(final Set cmHandleIds) { + final List subscriptionStatuses = new ArrayList<>(); + for (final String cmHandleId : cmHandleIds) { + final SubscriptionStatus status = new SubscriptionStatus(); + status.setId(cmHandleId); + status.setStatus(SubscriptionStatus.Status.ACCEPTED); + subscriptionStatuses.add(status); + } + return subscriptionStatuses; + } + +} diff --git a/src/main/java/org/onap/cps/ncmp/dmi/notifications/cmsubscription/CmSubscriptionDmiOutEventToCloudEventMapper.java b/src/main/java/org/onap/cps/ncmp/dmi/notifications/cmsubscription/CmSubscriptionDmiOutEventToCloudEventMapper.java new file mode 100644 index 00000000..00fd1b65 --- /dev/null +++ b/src/main/java/org/onap/cps/ncmp/dmi/notifications/cmsubscription/CmSubscriptionDmiOutEventToCloudEventMapper.java @@ -0,0 +1,62 @@ +/* + * ============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.dmi.notifications.cmsubscription; + +import com.fasterxml.jackson.databind.ObjectMapper; +import io.cloudevents.CloudEvent; +import io.cloudevents.core.builder.CloudEventBuilder; +import java.net.URI; +import java.util.UUID; +import lombok.AccessLevel; +import lombok.NoArgsConstructor; +import org.onap.cps.ncmp.dmi.exception.CloudEventConstructionException; +import org.onap.cps.ncmp.events.cmsubscription1_0_0.dmi_to_ncmp.CmSubscriptionDmiOutEvent; + +@NoArgsConstructor(access = AccessLevel.PRIVATE) +public class CmSubscriptionDmiOutEventToCloudEventMapper { + + private static final ObjectMapper objectMapper = new ObjectMapper(); + + /** + * Maps SubscriptionEventResponse to a CloudEvent. + * + * @param cmSubscriptionDmiOutEvent object. + * @param subscriptionType String of subscription type. + * @param dmiName String of dmiName. + * @return CloudEvent built. + */ + public static CloudEvent toCloudEvent(final CmSubscriptionDmiOutEvent cmSubscriptionDmiOutEvent, + final String subscriptionType, final String dmiName) { + try { + return CloudEventBuilder.v1().withId(UUID.randomUUID().toString()).withSource(URI.create(dmiName)) + .withType(subscriptionType) + .withDataSchema(URI.create("urn:cps:" + CmSubscriptionDmiOutEvent.class.getName() + ":1.0.0")) + .withExtension("correlationid", cmSubscriptionDmiOutEvent.getData().getClientId() + ":" + + cmSubscriptionDmiOutEvent.getData().getSubscriptionName()) + .withData(objectMapper.writeValueAsBytes(cmSubscriptionDmiOutEvent)).build(); + } catch (final Exception ex) { + throw new CloudEventConstructionException("The Cloud Event could not be constructed", + "Invalid object to serialize or required headers is missing", ex); + } + } + + +} diff --git a/src/main/java/org/onap/cps/ncmp/dmi/notifications/mapper/CloudEventMapper.java b/src/main/java/org/onap/cps/ncmp/dmi/notifications/mapper/CloudEventMapper.java new file mode 100644 index 00000000..edf875e6 --- /dev/null +++ b/src/main/java/org/onap/cps/ncmp/dmi/notifications/mapper/CloudEventMapper.java @@ -0,0 +1,62 @@ +/* + * ============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.dmi.notifications.mapper; + +import com.fasterxml.jackson.databind.ObjectMapper; +import io.cloudevents.CloudEvent; +import io.cloudevents.core.CloudEventUtils; +import io.cloudevents.core.data.PojoCloudEventData; +import io.cloudevents.jackson.PojoCloudEventDataMapper; +import io.cloudevents.rw.CloudEventRWException; +import lombok.AccessLevel; +import lombok.NoArgsConstructor; +import lombok.extern.slf4j.Slf4j; + +@Slf4j +@NoArgsConstructor(access = AccessLevel.PRIVATE) +public class CloudEventMapper { + + private static final ObjectMapper objectMapper = new ObjectMapper(); + + /** + * Generic method to map cloud event data to target event class object. + * + * @param cloudEvent input cloud event + * @param targetEventClass target event class + * @param target event class type + * @return mapped target event + */ + public static T toTargetEvent(final CloudEvent cloudEvent, final Class targetEventClass) { + PojoCloudEventData mappedCloudEvent = null; + + try { + mappedCloudEvent = + CloudEventUtils.mapData(cloudEvent, PojoCloudEventDataMapper.from(objectMapper, targetEventClass)); + + } catch (final CloudEventRWException cloudEventRwException) { + log.error("Unable to map cloud event to target event class type : {} with cause : {}", targetEventClass, + cloudEventRwException.getMessage()); + } + + return mappedCloudEvent == null ? null : mappedCloudEvent.getValue(); + } + +} -- cgit 1.2.3-korg