diff options
author | 2021-07-22 11:53:53 -0400 | |
---|---|---|
committer | 2021-07-23 08:39:12 -0400 | |
commit | 22fe2165bed771fdd4c452891646076aecb22ac3 (patch) | |
tree | c40ba41a039ae4f275b6eea0ff62dbc77f76d50d /src | |
parent | 092d4a0b4eb6011b16d223f0c1d5072fdb5f6abb (diff) |
generating swagger-ui and controller interface using openapi.yml
Issue-ID: CPS-387
Signed-off-by: Renu Kumari <renu.kumari@bell.ca>
Change-Id: I3e9742407148efcb16d8d79411e4de6738796f86
Diffstat (limited to 'src')
6 files changed, 150 insertions, 72 deletions
diff --git a/src/main/java/org/onap/cps/temporal/controller/rest/QueryController.java b/src/main/java/org/onap/cps/temporal/controller/rest/QueryController.java new file mode 100644 index 0000000..e7171a0 --- /dev/null +++ b/src/main/java/org/onap/cps/temporal/controller/rest/QueryController.java @@ -0,0 +1,52 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (c) 2021 Bell Canada. + * ================================================================================ + * 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.temporal.controller.rest; + +import javax.validation.Valid; +import javax.validation.constraints.Max; +import javax.validation.constraints.Min; +import javax.validation.constraints.NotNull; +import org.onap.cps.temporal.controller.rest.model.AnchorHistory; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@RequestMapping("${rest.api.base-path}") +public class QueryController implements CpsTemporalQueryApi { + + @Override + public ResponseEntity<AnchorHistory> getAnchorDataByName(final String dataspaceName, + final String anchorName, final @Valid String after, final @Valid String simplePayloadFilter, + final @Valid String pointInTime, final @Min(0) @Valid Integer pageNumber, + final @Min(0) @Max(10000) @Valid Integer pageLimit, final @Valid String sort) { + return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); + } + + @Override + public ResponseEntity<AnchorHistory> getAnchorsDataByFilter(final String dataspaceName, + final @NotNull @Valid String schemaSetName, final @Valid String after, final @Valid String simplePayloadFilter, + final @Valid String pointInTime, final @Min(0) @Valid Integer pageNumber, + final @Min(0) @Max(10000) @Valid Integer pageLimit, final @Valid String sort) { + return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED); + } +} diff --git a/src/main/java/org/onap/cps/temporal/controller/web/QueryController.java b/src/main/java/org/onap/cps/temporal/controller/web/QueryController.java deleted file mode 100644 index fae95cc..0000000 --- a/src/main/java/org/onap/cps/temporal/controller/web/QueryController.java +++ /dev/null @@ -1,35 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (c) 2021 Bell Canada. - * ================================================================================ - * 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========================================================= - */ - -package org.onap.cps.temporal.controller.web; - -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.RestController; - -/** - * Controller for query requests. - */ -@RestController -public class QueryController { - - @GetMapping("/") - public String home() { - return "Welcome to CPS Temporal Service!"; - } - -} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index 5fe30b0..0b41a07 100755 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -13,11 +13,17 @@ # 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: + base-path: /cps-temporal/api + spring: datasource: url: jdbc:postgresql://${DB_HOST}:${DB_PORT}/cpstemporaldb @@ -50,3 +56,11 @@ app: listener: data-updated: topic: ${CPS_CHANGE_EVENT_TOPIC:cps.cfg-state-events} + +springdoc: + swagger-ui: + disable-swagger-default-url: true + urlsPrimaryName: query + urls: + - name: query + url: /swagger/openapi.yml diff --git a/src/test/groovy/org/onap/cps/temporal/controller/rest/QueryControllerSpec.groovy b/src/test/groovy/org/onap/cps/temporal/controller/rest/QueryControllerSpec.groovy new file mode 100644 index 0000000..771a3fc --- /dev/null +++ b/src/test/groovy/org/onap/cps/temporal/controller/rest/QueryControllerSpec.groovy @@ -0,0 +1,78 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (c) 2021 Bell Canada. + * ================================================================================ + * 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.temporal.controller.rest + +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.http.HttpStatus +import org.springframework.http.MediaType +import org.springframework.test.web.servlet.MockMvc + +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get + +import spock.lang.Specification + +/** + * Specification for Query Controller. + */ +@WebMvcTest(QueryController) +class QueryControllerSpec extends Specification { + + @Autowired + MockMvc mvc + + @Value('${rest.api.base-path}') + def basePath + + def myDataspace = 'my-dataspace' + def myAnchor = 'my-anchor' + def mySchemaset = 'my-schemaset' + + def 'Get anchors by name is not implemented.'(){ + given: 'an endpoint' + def getAnchorsByNameEndpoint = "${basePath}/v1/dataspaces/{dataspace-name}/anchors/{anchor-name}/history" + + when: 'get anchors by name endpoint is called' + def response = mvc.perform( get(getAnchorsByNameEndpoint, myDataspace, myAnchor) + .contentType(MediaType.APPLICATION_JSON)) + .andReturn().response + + then: 'received unsupported operation response' + response.getStatus() == HttpStatus.NOT_IMPLEMENTED.value() + + } + + def 'Get anchors by dataspace name is not implemented.'(){ + given: 'an endpoint' + def getAnchorsByDataspaceEndpoint = "${basePath}/v1/dataspaces/{dataspace-name}/anchors/history" + + when: 'get anchors by dataspace name endpoint is called' + def response = mvc.perform( get(getAnchorsByDataspaceEndpoint, myDataspace).queryParam('schema-set-name', mySchemaset) + .contentType(MediaType.APPLICATION_JSON)) + .andReturn().response + + then: 'received unsupported operation response' + response.getStatus() == HttpStatus.NOT_IMPLEMENTED.value() + + } + +} diff --git a/src/test/groovy/org/onap/cps/temporal/controller/web/QueryControllerSpec.groovy b/src/test/groovy/org/onap/cps/temporal/controller/web/QueryControllerSpec.groovy deleted file mode 100644 index c834f38..0000000 --- a/src/test/groovy/org/onap/cps/temporal/controller/web/QueryControllerSpec.groovy +++ /dev/null @@ -1,37 +0,0 @@ -/* - * ============LICENSE_START======================================================= - * Copyright (c) 2021 Bell Canada. - * ================================================================================ - * 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========================================================= - */ - -package org.onap.cps.temporal.controller.web - -import spock.lang.Specification - -/** - * Specification for Query Controller. - */ -class QueryControllerSpec extends Specification { - - def objectUnderTest = new QueryController() - - def 'Get home returns some data'() { - when: 'get home is invoked' - def response = objectUnderTest.home() - then: 'a response is returned' - ! response.empty - } - -} diff --git a/src/test/resources/application.yml b/src/test/resources/application.yml index 3ac13a9..fb38742 100644 --- a/src/test/resources/application.yml +++ b/src/test/resources/application.yml @@ -12,11 +12,17 @@ # 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: + base-path: /cps-temporal/api + spring: datasource: url: ${DB_URL} |