- Producer configuration and Topic related information.
- Accepted topicParameter and request id from NCMP to process async
- Replacing Springfox and using Springdoc instead
Issue-ID: CPS-829
Change-Id: I369b5ec6c16318220bb218701006918a0bf21419
Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
example: my-data
cmHandleProperties:
$ref: '#/components/schemas/cmHandleProperties'
+ requestId:
+ type: string
+ example: uuid-random-id-eg
ModuleSet_schemas:
type: object
properties:
example: my-data
cmHandleProperties:
$ref: '#/components/schemas/cmHandleProperties'
+ requestId:
+ type: string
+ example: uuid-random-id-eg
cmHandleProperties:
type: object
options: (key1=value1,key2=value1/value2)
sample3:
value:
- options: (key1=10,key2=value2,key3=val31,val32)
\ No newline at end of file
+ options: (key1=10,key2=value2,key3=val31,val32)
+ topicParamInQuery:
+ name: topicParamInQuery
+ in: query
+ description: valid topic name passed from client(NCMP).
+ required: false
+ schema:
+ type: string
+ allowReserved: true
+ examples:
+ sample1:
+ value: ncmp-async-m2m
\ No newline at end of file
- $ref: 'components.yml#/components/parameters/cmHandleInPath'
- $ref: 'components.yml#/components/parameters/resourceIdentifierInQuery'
- $ref: 'components.yml#/components/parameters/optionsParamInQuery'
+ - $ref: 'components.yml#/components/parameters/topicParamInQuery'
requestBody:
description: Operational body
content:
- $ref: 'components.yml#/components/parameters/cmHandleInPath'
- $ref: 'components.yml#/components/parameters/resourceIdentifierInQuery'
- $ref: 'components.yml#/components/parameters/optionsParamInQuery'
+ - $ref: 'components.yml#/components/parameters/topicParamInQuery'
requestBody:
content:
application/json:
<type>pom</type>
<scope>import</scope>
</dependency>
+ <dependency>
+ <groupId>org.testcontainers</groupId>
+ <artifactId>testcontainers-bom</artifactId>
+ <version>1.15.3</version>
+ <type>pom</type>
+ <scope>import</scope>
+ </dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<artifactId>swagger-annotations</artifactId>
<version>1.6.2</version>
</dependency>
- <dependency>
- <groupId>io.springfox</groupId>
- <artifactId>springfox-boot-starter</artifactId>
- <version>3.0.0</version>
- </dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-security</artifactId>
<artifactId>httpclient</artifactId>
<version>${httpclient.version}</version>
</dependency>
+ <dependency>
+ <groupId>org.springframework.kafka</groupId>
+ <artifactId>spring-kafka</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.springframework.kafka</groupId>
+ <artifactId>spring-kafka-test</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.testcontainers</groupId>
+ <artifactId>spock</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.testcontainers</groupId>
+ <artifactId>kafka</artifactId>
+ <scope>test</scope>
+ </dependency>
</dependencies>
<build>
<resources>
<excludes>
<exclude>**/IT*.java</exclude>
</excludes>
+ <environmentVariables>
+ <!--
+ Disable privileged container usage to cleanup the test containers;
+ these are removed automatically on jvm termination;
+ see https://www.testcontainers.org/features/configuration/#disabling-ryuk
+ -->
+ <TESTCONTAINERS_RYUK_DISABLED>true</TESTCONTAINERS_RYUK_DISABLED>
+ </environmentVariables>
</configuration>
</plugin>
<plugin>
/*
* ============LICENSE_START=======================================================
- * Copyright (C) 2021 Nordix Foundation
+ * 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.
package org.onap.cps.ncmp.dmi.config;
import lombok.Getter;
+import org.springdoc.core.GroupedOpenApi;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;
-import springfox.documentation.builders.PathSelectors;
-import springfox.documentation.builders.RequestHandlerSelectors;
-import springfox.documentation.spi.DocumentationType;
-import springfox.documentation.spring.web.plugins.Docket;
@Configuration
public class DmiPluginConfig {
+
/**
- * Swagger-ui configuration.
+ * Swagger-ui configuration using springdoc.
*/
- @Bean("dmi-plugin-docket")
- public Docket api() {
- return new Docket(DocumentationType.OAS_30)
- .groupName("dmi-plugin-docket")
- .select()
- .apis(RequestHandlerSelectors.any())
- .paths(PathSelectors.any())
- .build();
+ @Bean("dmi-plugin-api")
+ public GroupedOpenApi api() {
+ return GroupedOpenApi.builder().group("dmi-plugin-api")
+ .pathsToMatch("/swagger-ui/**,/swagger-resources/**,/v3/api-docs").build();
}
@Getter
import org.onap.cps.ncmp.dmi.rest.api.DmiPluginApi;
import org.onap.cps.ncmp.dmi.rest.api.DmiPluginInternalApi;
import org.onap.cps.ncmp.dmi.service.DmiService;
+import org.onap.cps.ncmp.dmi.service.NcmpKafkaPublisherService;
import org.onap.cps.ncmp.dmi.service.model.ModuleReference;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
private final ObjectMapper objectMapper;
+ private final NcmpKafkaPublisherService ncmpKafkaPublisherService;
+
private static final Map<OperationEnum, HttpStatus> operationToHttpStatusMap = new HashMap<>(6);
static {
operationToHttpStatusMap.put(OperationEnum.DELETE, HttpStatus.NO_CONTENT);
}
+
@Override
public ResponseEntity<ModuleSet> getModuleReferences(final String cmHandle,
final @Valid ModuleReferencesRequest body) {
* @param cmHandle cm handle identifier
* @param dataAccessRequest data Access Request
* @param optionsParamInQuery options query parameter
+ * @param topicParamInQuery optional topic parameter
* @return {@code ResponseEntity} response entity
*/
@Override
final String cmHandle,
final @Valid DataAccessRequest
dataAccessRequest,
- final @Valid String optionsParamInQuery) {
+ final @Valid String optionsParamInQuery,
+ final String topicParamInQuery) {
if (isReadOperation(dataAccessRequest)) {
final String resourceDataAsJson = dmiService.getResourceData(cmHandle,
resourceIdentifier,
final String cmHandle,
final @Valid DataAccessRequest
dataAccessRequest,
- final @Valid String optionsParamInQuery) {
+ final @Valid String optionsParamInQuery,
+ final String topicParamInQuery) {
final String sdncResponse;
if (isReadOperation(dataAccessRequest)) {
sdncResponse = dmiService.getResourceData(cmHandle,
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.dmi.service;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.kafka.core.KafkaTemplate;
+import org.springframework.kafka.support.SendResult;
+import org.springframework.stereotype.Component;
+import org.springframework.util.concurrent.ListenableFuture;
+import org.springframework.util.concurrent.ListenableFutureCallback;
+
+@Component
+@Slf4j
+public class NcmpKafkaPublisher {
+
+ private final KafkaTemplate<String, Object> kafkaTemplate;
+ private final String topicName;
+
+ /**
+ * KafkaTemplate and Topic name.
+ *
+ * @param kafkaTemplate kafka template
+ * @param topicName topic name
+ */
+ @Autowired
+ public NcmpKafkaPublisher(final KafkaTemplate<String, Object> kafkaTemplate,
+ @Value("${app.ncmp.async-m2m.topic}") final String topicName) {
+ this.kafkaTemplate = kafkaTemplate;
+ this.topicName = topicName;
+ }
+
+ /**
+ * Sends message to the configured topic with a message key.
+ *
+ * @param messageKey message key
+ * @param payload message payload
+ */
+ public void sendMessage(final String messageKey, final Object payload) {
+ final ListenableFuture<SendResult<String, Object>> send = kafkaTemplate.send(topicName, messageKey, payload);
+ send.addCallback(new ListenableFutureCallback<>() {
+ @Override
+ public void onFailure(final Throwable ex) {
+ log.warn("Failed to send the messages {}", ex.getMessage());
+ }
+
+ @Override
+ public void onSuccess(final SendResult<String, Object> result) {
+ log.debug("Sent message {}", result.getProducerRecord());
+ }
+ });
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.dmi.service;
+
+import lombok.AllArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+
+@Slf4j
+@Service
+@AllArgsConstructor
+public class NcmpKafkaPublisherService {
+
+ private final NcmpKafkaPublisher ncmpKafkaPublisher;
+
+ /**
+ * publish the message to NCMP.
+ *
+ * @param messageKey message key
+ * @param message message payload
+ */
+ public void publishToNcmp(final String messageKey, final Object message) {
+ log.debug("Publishing message : {} to NCMP with message-key : {}", message, messageKey);
+ ncmpKafkaPublisher.sendMessage(messageKey, message);
+ }
+}
# ============LICENSE_START=======================================================
-# Copyright (C) 2021 Nordix Foundation
+# Copyright (C) 2021-2022 Nordix Foundation
# Modifications Copyright (C) 2021 Bell Canada.
# ================================================================================
# Licensed under the Apache License, Version 2.0 (the "License");
mvc:
pathmatch:
matching-strategy: ANT_PATH_MATCHER
+ kafka:
+ bootstrap-servers: ${KAFKA_BOOTSTRAP_SERVER}
+ security:
+ protocol: PLAINTEXT
+ producer:
+ key-serializer: org.apache.kafka.common.serialization.StringSerializer
+ value-serializer: org.springframework.kafka.support.serializer.JsonSerializer
+ client-id: dmi-plugin
+
+app:
+ ncmp:
+ async-m2m:
+ topic: ${NCMP_ASYNC_M2M_TOPIC:ncmp-async-m2m}
# Actuator
management:
/*
* ============LICENSE_START=======================================================
- * Copyright (C) 2021 Nordix Foundation
+ * 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.
package org.onap.cps.ncmp.dmi.config
+import org.springdoc.core.GroupedOpenApi
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.test.context.ContextConfiguration
import spock.lang.Specification
-import springfox.documentation.spring.web.plugins.Docket
@SpringBootTest
@ContextConfiguration(classes = [DmiPluginConfig.DmiPluginProperties])
dmiPluginProperties.dmiServiceUrl == 'some url for the dmi service'
}
- def 'DMI plugin docket creation.'() {
+ def 'DMI plugin api creation.'() {
given: 'a DMI plugin configuration'
DmiPluginConfig objectUnderTest = new DmiPluginConfig()
when: 'the api method is invoked'
def result = objectUnderTest.api()
then: 'a spring web plugin docket is returned'
- result instanceof Docket
- and: 'it is named "dmi-plugin-docket"'
- result.groupName == 'dmi-plugin-docket'
+ result instanceof GroupedOpenApi
+ and: 'it is named "dmi-plugin-api"'
+ result.group == 'dmi-plugin-api'
}
}
import org.onap.cps.ncmp.dmi.exception.DmiException
import org.onap.cps.ncmp.dmi.exception.ModuleResourceNotFoundException
import org.onap.cps.ncmp.dmi.exception.ModulesNotFoundException
+import org.onap.cps.ncmp.dmi.service.NcmpKafkaPublisherService
import org.onap.cps.ncmp.dmi.service.model.ModuleReference
import org.onap.cps.ncmp.dmi.model.ModuleSet
import org.onap.cps.ncmp.dmi.model.ModuleSetSchemas
@SpringBean
DmiService mockDmiService = Mock()
+ @SpringBean
+ NcmpKafkaPublisherService mockNcmpKafkaPublisherService = Mock()
+
@Value('${rest.api.dmi-base-path}/v1')
def basePathV1
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.dmi.service
+
+import spock.lang.Specification
+
+class NcmpKafkaPublisherServiceSpec extends Specification {
+
+ def mockNcmpKafkaPublisher = Mock(NcmpKafkaPublisher)
+ def objectUnderTest = new NcmpKafkaPublisherService(mockNcmpKafkaPublisher)
+
+ def 'Message publishing'() {
+ given: 'a sample message with key'
+ def message = 'sample message'
+ def messageKey = 'sample-key'
+ when: 'published'
+ objectUnderTest.publishToNcmp(messageKey, message)
+ then: 'no exception is thrown'
+ noExceptionThrown()
+ }
+}
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.cps.ncmp.dmi.service
+
+
+import org.springframework.beans.factory.annotation.Autowired
+import org.springframework.beans.factory.annotation.Value
+import org.springframework.boot.test.context.SpringBootTest
+import org.springframework.kafka.core.KafkaTemplate
+import org.springframework.test.context.DynamicPropertyRegistry
+import org.springframework.test.context.DynamicPropertySource
+import org.testcontainers.containers.KafkaContainer
+import org.testcontainers.spock.Testcontainers
+import spock.lang.Specification
+
+@SpringBootTest
+@Testcontainers
+class NcmpKafkaPublisherSpec extends Specification {
+
+ static kafkaTestContainer = new KafkaContainer()
+ static {
+ Runtime.getRuntime().addShutdownHook(new Thread(kafkaTestContainer::stop))
+ }
+
+ def setupSpec() {
+ kafkaTestContainer.start()
+ }
+
+ @Autowired
+ KafkaTemplate<String, Object> kafkaTemplate
+
+ @Value('${app.ncmp.async-m2m.topic}')
+ String topic
+
+ def 'Publish message'() {
+ given: 'a sample messsage and key'
+ def message = 'sample message'
+ def messageKey = 'message-key'
+ def objectUnderTest = new NcmpKafkaPublisher(kafkaTemplate, topic)
+ when: 'a message is published'
+ objectUnderTest.sendMessage(messageKey, message)
+ then: 'no exception is thrown'
+ noExceptionThrown()
+
+ }
+
+ @DynamicPropertySource
+ static void registerKafkaProperties(DynamicPropertyRegistry registry) {
+ registry.add('spring.kafka.bootstrap-servers', kafkaTestContainer::getBootstrapServers)
+ }
+}
# ============LICENSE_START=======================================================
-# Copyright (C) 2021 Nordix Foundation
+# 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.
dmi-base-path: /dmi
security:
+ permit-uri: /manage/**,/swagger-ui/**,/swagger-resources/**,/v3/api-docs
auth:
username: cpsuser
password: cpsr0cks!
service:
url: some url for the dmi service
+spring:
+ kafka:
+ bootstrap-servers: localhost:9092
+ security:
+ protocol: PLAINTEXT
+ producer:
+ key-serializer: org.apache.kafka.common.serialization.StringSerializer
+ value-serializer: org.springframework.kafka.support.serializer.JsonSerializer
+ client-id: dmi-plugin
+
+app:
+ ncmp:
+ async-m2m:
+ topic: ncmp-async-m2m
+
Code Review / cps / ncmp-dmi-plugin.git / commitdiff