diff options
| -rw-r--r-- | .gitignore | 31 | ||||
| -rw-r--r-- | docs/openapi/components.yml | 59 | ||||
| -rw-r--r-- | docs/openapi/openapi.yml | 44 | ||||
| -rw-r--r-- | pom.xml | 214 | ||||
| -rw-r--r-- | src/main/java/org/onap/cps/ncmp/Application.java | 33 | ||||
| -rw-r--r-- | src/main/java/org/onap/cps/ncmp/rest/controller/DmiRestController.java | 38 | ||||
| -rw-r--r-- | src/main/java/org/onap/cps/ncmp/service/DmiService.java | 30 | ||||
| -rw-r--r-- | src/main/java/org/onap/cps/ncmp/service/DmiServiceImpl.java | 28 | ||||
| -rw-r--r-- | src/main/resources/application.yml | 29 | ||||
| -rw-r--r-- | src/test/groovy/org/onap/cps/ncmp/rest/controller/DmiRestControllerSpec.groovy | 53 | ||||
| -rw-r--r-- | src/test/groovy/org/onap/cps/ncmp/service/DmiServiceImplSpec.groovy | 33 |
11 files changed, 592 insertions, 0 deletions
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 @@ +<!-- + ============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. + ============LICENSE_END========================================================= +--> + +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.onap.oparent</groupId> + <artifactId>oparent</artifactId> + <version>3.2.0</version> + <relativePath/> + </parent> + + <organization> + <name>ONAP - CPS</name> + <url>http://www.onap.org/</url> + </organization> + + <groupId>org.onap.cps</groupId> + <artifactId>ncmp-dmi-plugin</artifactId> + <version>0.0.1-SNAPSHOT</version> + <name>ncmp-dmi-plugin</name> + <description>DMI Plugin Service</description> + + <properties> + <app>org.onap.cps.ncmp.Application</app> + <groovy.version>3.0.8</groovy.version> + <java.version>11</java.version> + <oparent.version>3.1.0</oparent.version> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + <spock-core.version>2.0-M5-groovy-3.0</spock-core.version> + <spock-spring.version>2.0-M5-groovy-3.0</spock-spring.version> + <springboot.version>2.5.0</springboot.version> + <swagger.version>2.1.4</swagger.version> + <swagger-annotations-version>1.6.2</swagger-annotations-version> + <swagger-codegen-maven-plugin.version>3.0.18</swagger-codegen-maven-plugin.version> + </properties> + + <dependencyManagement> + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-dependencies</artifactId> + <version>${springboot.version}</version> + <type>pom</type> + <scope>import</scope> + </dependency> + <dependency> + <groupId>io.swagger</groupId> + <artifactId>swagger-annotations</artifactId> + <version>${swagger-annotations-version}</version> + </dependency> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy</artifactId> + <version>${groovy.version}</version> + </dependency> + <dependency> + <groupId>org.spockframework</groupId> + <artifactId>spock-core</artifactId> + <version>${spock-core.version}</version> + </dependency> + <dependency> + <groupId>org.spockframework</groupId> + <artifactId>spock-spring</artifactId> + <version>${spock-spring.version}</version> + </dependency> + </dependencies> + </dependencyManagement> + + <dependencies> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter-web</artifactId> + </dependency> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter-validation</artifactId> + </dependency> + <dependency> + <groupId>org.codehaus.groovy</groupId> + <artifactId>groovy</artifactId> + <version>${groovy.version}</version> + </dependency> + <dependency> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-starter-test</artifactId> + <scope>test</scope> + <exclusions> + <exclusion> + <groupId>org.junit.vintage</groupId> + <artifactId>junit-vintage-engine</artifactId> + </exclusion> + </exclusions> + </dependency> + <dependency> + <groupId>org.spockframework</groupId> + <artifactId>spock-core</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>org.spockframework</groupId> + <artifactId>spock-spring</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>io.swagger</groupId> + <artifactId>swagger-annotations</artifactId> + <version>${swagger-annotations-version}</version> + </dependency> + </dependencies> + + <build> + <resources> + <resource> + <directory>src/main/resources</directory> + <filtering>true</filtering> + </resource> + <resource> + <directory>target/generated-sources/license</directory> + <includes> + <include>third-party-licenses.txt</include> + </includes> + </resource> + <resource> + <directory>target/generated-resources/licenses</directory> + <includes> + <include>*.*</include> + </includes> + <targetPath>third-party-licenses</targetPath> + </resource> + </resources> + <plugins> + <plugin> + <groupId>io.swagger.codegen.v3</groupId> + <artifactId>swagger-codegen-maven-plugin</artifactId> + <version>${swagger-codegen-maven-plugin.version}</version> + <executions> + <execution> + <goals> + <goal>generate</goal> + </goals> + <configuration> + <inputSpec>${project.basedir}/docs/openapi/openapi.yml</inputSpec> + <language>spring</language> + <generateSupportingFiles>false</generateSupportingFiles> + <apiPackage>org.onap.cps.ncmp.rest.api</apiPackage> + <modelPackage>org.onap.cps.ncmp.rest.model</modelPackage> + <configOptions> + <sourceFolder>src/gen/java</sourceFolder> + <dateLibrary>java11</dateLibrary> + <interfaceOnly>true</interfaceOnly> + <useTags>true</useTags> + </configOptions> + </configuration> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.springframework.boot</groupId> + <artifactId>spring-boot-maven-plugin</artifactId> + <executions> + <execution> + <goals> + <goal>build-info</goal> + <goal>repackage</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.codehaus.gmavenplus</groupId> + <artifactId>gmavenplus-plugin</artifactId> + <executions> + <execution> + <goals> + <goal>compileTests</goal> + </goals> + </execution> + </executions> + </plugin> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-surefire-plugin</artifactId> + <configuration> + <argLine>${surefireArgLine}</argLine> + <includes> + <include>**/*Spec.java</include> + </includes> + <excludes> + <exclude>**/IT*.java</exclude> + </excludes> + </configuration> + </plugin> + </plugins> + </build> +</project>
\ 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<Object> 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' + } + +} |