summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorDylanB95EST <dylan.byrne@est.tech>2021-06-02 19:45:46 +0100
committerDylanB95EST <dylan.byrne@est.tech>2021-06-11 11:04:17 +0100
commitb5a238326e5fc5e240acb11f52748774c2f6da40 (patch)
tree1dd5657c59efa00dd98d39d813e10446d498c585 /src
parent429f06a7e721b88b495921f9853ea2f7f827f925 (diff)
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 <dylan.byrne@est.tech>
Diffstat (limited to 'src')
-rw-r--r--src/main/java/org/onap/cps/ncmp/Application.java33
-rw-r--r--src/main/java/org/onap/cps/ncmp/rest/controller/DmiRestController.java38
-rw-r--r--src/main/java/org/onap/cps/ncmp/service/DmiService.java30
-rw-r--r--src/main/java/org/onap/cps/ncmp/service/DmiServiceImpl.java28
-rw-r--r--src/main/resources/application.yml29
-rw-r--r--src/test/groovy/org/onap/cps/ncmp/rest/controller/DmiRestControllerSpec.groovy53
-rw-r--r--src/test/groovy/org/onap/cps/ncmp/service/DmiServiceImplSpec.groovy33
7 files changed, 244 insertions, 0 deletions
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'
+ }
+
+}