From b5a238326e5fc5e240acb11f52748774c2f6da40 Mon Sep 17 00:00:00 2001 From: DylanB95EST Date: Wed, 2 Jun 2021 19:45:46 +0100 Subject: Adding new sub repo and modules, along with rest endpoint, test case and Spring Application class Issue-ID: CPS-431 Change-Id: I6fd4379df6133108c1f8f2a5339f990f16773ad6 Signed-off-by: DylanB95EST --- .gitignore | 31 +++ docs/openapi/components.yml | 59 ++++++ docs/openapi/openapi.yml | 44 +++++ pom.xml | 214 +++++++++++++++++++++ src/main/java/org/onap/cps/ncmp/Application.java | 33 ++++ .../ncmp/rest/controller/DmiRestController.java | 38 ++++ .../java/org/onap/cps/ncmp/service/DmiService.java | 30 +++ .../org/onap/cps/ncmp/service/DmiServiceImpl.java | 28 +++ src/main/resources/application.yml | 29 +++ .../rest/controller/DmiRestControllerSpec.groovy | 53 +++++ .../cps/ncmp/service/DmiServiceImplSpec.groovy | 33 ++++ 11 files changed, 592 insertions(+) create mode 100644 .gitignore create mode 100644 docs/openapi/components.yml create mode 100644 docs/openapi/openapi.yml create mode 100644 pom.xml create mode 100644 src/main/java/org/onap/cps/ncmp/Application.java create mode 100644 src/main/java/org/onap/cps/ncmp/rest/controller/DmiRestController.java create mode 100644 src/main/java/org/onap/cps/ncmp/service/DmiService.java create mode 100644 src/main/java/org/onap/cps/ncmp/service/DmiServiceImpl.java create mode 100644 src/main/resources/application.yml create mode 100644 src/test/groovy/org/onap/cps/ncmp/rest/controller/DmiRestControllerSpec.groovy create mode 100644 src/test/groovy/org/onap/cps/ncmp/service/DmiServiceImplSpec.groovy diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..3ab10191 --- /dev/null +++ b/.gitignore @@ -0,0 +1,31 @@ +*.class +*.jar +*.war +*.zip +*.log + +target/ +log/ + +.idea/ +.idea_modules/ +*.iml +*.ipr +*.iws +*.DS_Store + +.settings/ +bin/ +tmp/ +.metadata +.classpath +.project +*.tmp +.checkstyle + +/.tox +/_build/* +/__pycache__/* + +/docs/docs/ +/docs/.vscode/ \ No newline at end of file diff --git a/docs/openapi/components.yml b/docs/openapi/components.yml new file mode 100644 index 00000000..bc3a63a0 --- /dev/null +++ b/docs/openapi/components.yml @@ -0,0 +1,59 @@ +components: + schemas: + ErrorMessage: + type: object + title: Error + properties: + status: + type: string + message: + type: string + details: + type: string + + responses: + NotFound: + description: The specified resource was not found + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Unauthorized: + description: Unauthorized + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Forbidden: + description: Forbidden + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + BadRequest: + description: Bad Request + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Conflict: + description: Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorMessage' + Ok: + description: OK + content: + application/json: + schema: + type: object + Created: + description: Created + content: + text/plain: + schema: + type: string + NoContent: + description: No Content + content: {} diff --git a/docs/openapi/openapi.yml b/docs/openapi/openapi.yml new file mode 100644 index 00000000..0fe9d78f --- /dev/null +++ b/docs/openapi/openapi.yml @@ -0,0 +1,44 @@ +# ============LICENSE_START======================================================= +# Modification (C) 2021 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========================================================= + +openapi: 3.0.1 +info: + title: NCMP DMI Plugin + description: Adds Data Model Inventory Registry capability for ONAP + version: "1.0.0" +servers: + - url: //localhost:8088/ +tags: + - name: dmi-rest + description: DMI Rest +paths: + /v1/helloworld: + get: + description: Hello World + tags: + - dmi-plugin + summary: Hello World + operationId: helloWorld + responses: + '200': + $ref: 'components.yml#/components/responses/Ok' + '400': + $ref: 'components.yml#/components/responses/BadRequest' + '401': + $ref: 'components.yml#/components/responses/Unauthorized' + '403': + $ref: 'components.yml#/components/responses/Forbidden' \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 00000000..abed018e --- /dev/null +++ b/pom.xml @@ -0,0 +1,214 @@ + + + + 4.0.0 + + + org.onap.oparent + oparent + 3.2.0 + + + + + ONAP - CPS + http://www.onap.org/ + + + org.onap.cps + ncmp-dmi-plugin + 0.0.1-SNAPSHOT + ncmp-dmi-plugin + DMI Plugin Service + + + org.onap.cps.ncmp.Application + 3.0.8 + 11 + 3.1.0 + UTF-8 + 2.0-M5-groovy-3.0 + 2.0-M5-groovy-3.0 + 2.5.0 + 2.1.4 + 1.6.2 + 3.0.18 + + + + + + org.springframework.boot + spring-boot-dependencies + ${springboot.version} + pom + import + + + io.swagger + swagger-annotations + ${swagger-annotations-version} + + + org.codehaus.groovy + groovy + ${groovy.version} + + + org.spockframework + spock-core + ${spock-core.version} + + + org.spockframework + spock-spring + ${spock-spring.version} + + + + + + + org.springframework.boot + spring-boot-starter-web + + + org.springframework.boot + spring-boot-starter-validation + + + org.codehaus.groovy + groovy + ${groovy.version} + + + org.springframework.boot + spring-boot-starter-test + test + + + org.junit.vintage + junit-vintage-engine + + + + + org.spockframework + spock-core + test + + + org.spockframework + spock-spring + test + + + io.swagger + swagger-annotations + ${swagger-annotations-version} + + + + + + + src/main/resources + true + + + target/generated-sources/license + + third-party-licenses.txt + + + + target/generated-resources/licenses + + *.* + + third-party-licenses + + + + + io.swagger.codegen.v3 + swagger-codegen-maven-plugin + ${swagger-codegen-maven-plugin.version} + + + + generate + + + ${project.basedir}/docs/openapi/openapi.yml + spring + false + org.onap.cps.ncmp.rest.api + org.onap.cps.ncmp.rest.model + + src/gen/java + java11 + true + true + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + build-info + repackage + + + + + + org.codehaus.gmavenplus + gmavenplus-plugin + + + + compileTests + + + + + + org.apache.maven.plugins + maven-surefire-plugin + + ${surefireArgLine} + + **/*Spec.java + + + **/IT*.java + + + + + + \ No newline at end of file diff --git a/src/main/java/org/onap/cps/ncmp/Application.java b/src/main/java/org/onap/cps/ncmp/Application.java new file mode 100644 index 00000000..ca566071 --- /dev/null +++ b/src/main/java/org/onap/cps/ncmp/Application.java @@ -0,0 +1,33 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2021 Nordix Foundation. 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; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class Application { + + public static void main(final String[] args) { + SpringApplication.run(Application.class, args); + } + +} diff --git a/src/main/java/org/onap/cps/ncmp/rest/controller/DmiRestController.java b/src/main/java/org/onap/cps/ncmp/rest/controller/DmiRestController.java new file mode 100644 index 00000000..700ca82c --- /dev/null +++ b/src/main/java/org/onap/cps/ncmp/rest/controller/DmiRestController.java @@ -0,0 +1,38 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2021 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.rest.controller; + +import org.onap.cps.ncmp.rest.api.DmiPluginApi; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +@RequestMapping("${rest.api.dmi-base-path}") +@RestController +public class DmiRestController implements DmiPluginApi { + + @Override + public ResponseEntity helloWorld() { + final var helloWorld = "Hello World"; + return new ResponseEntity<>(helloWorld, HttpStatus.OK); + } + +} diff --git a/src/main/java/org/onap/cps/ncmp/service/DmiService.java b/src/main/java/org/onap/cps/ncmp/service/DmiService.java new file mode 100644 index 00000000..c17b9f7e --- /dev/null +++ b/src/main/java/org/onap/cps/ncmp/service/DmiService.java @@ -0,0 +1,30 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2021 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.service; + +/** + * Interface for handling Dmi plugin Data. + */ +public interface DmiService { + /** + * Return Simple Hello World Statement. + */ + String getHelloWorld(); +} diff --git a/src/main/java/org/onap/cps/ncmp/service/DmiServiceImpl.java b/src/main/java/org/onap/cps/ncmp/service/DmiServiceImpl.java new file mode 100644 index 00000000..a1cecc3e --- /dev/null +++ b/src/main/java/org/onap/cps/ncmp/service/DmiServiceImpl.java @@ -0,0 +1,28 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2021 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.service; + +public class DmiServiceImpl implements DmiService { + + @Override + public String getHelloWorld() { + return "Hello World"; + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..08466681 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,29 @@ +# ============LICENSE_START======================================================= +# Modification (C) 2021 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========================================================= + +server: + port: 8080 + +rest: + api: + dmi-base-path: /dmi/api + +security: + permit-uri: /manage/health/**,/manage/info,/swagger-ui/**,/swagger-resources/**,/v3/api-docs + auth: + username: ${CPS_USERNAME} + password: ${CPS_PASSWORD} \ No newline at end of file diff --git a/src/test/groovy/org/onap/cps/ncmp/rest/controller/DmiRestControllerSpec.groovy b/src/test/groovy/org/onap/cps/ncmp/rest/controller/DmiRestControllerSpec.groovy new file mode 100644 index 00000000..5a7db192 --- /dev/null +++ b/src/test/groovy/org/onap/cps/ncmp/rest/controller/DmiRestControllerSpec.groovy @@ -0,0 +1,53 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2021 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.rest.controller + +import org.springframework.http.HttpStatus + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get + +import org.springframework.beans.factory.annotation.Autowired +import org.springframework.beans.factory.annotation.Value +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest +import org.springframework.test.web.servlet.MockMvc +import spock.lang.Specification + +@WebMvcTest +class DmiRestControllerSpec extends Specification { + + @Autowired + private MockMvc mvc + + @Value('${rest.api.dmi-base-path}') + def basePath + + def 'Get Hello World'() { + given: 'hello world endpoint' + def helloWorldEndpoint = "$basePath/v1/helloworld" + + when: 'get hello world api is invoked' + def response = mvc.perform(get(helloWorldEndpoint)).andReturn().response + + then: 'Response Status is OK and contains expected text' + response.status == HttpStatus.OK.value() + response.getContentAsString() == 'Hello World' + } + +} diff --git a/src/test/groovy/org/onap/cps/ncmp/service/DmiServiceImplSpec.groovy b/src/test/groovy/org/onap/cps/ncmp/service/DmiServiceImplSpec.groovy new file mode 100644 index 00000000..8be4f069 --- /dev/null +++ b/src/test/groovy/org/onap/cps/ncmp/service/DmiServiceImplSpec.groovy @@ -0,0 +1,33 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2021 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.service + + +import spock.lang.Specification + +class DmiServiceImplSpec extends Specification { + def objectUnderTest = new DmiServiceImpl() + + def 'Retrieve Hello World'() { + expect: 'Hello World is Returned' + objectUnderTest.getHelloWorld() == 'Hello World' + } + +} -- cgit 1.2.3-korg