From cf5af3fd2e67b0aef402114a0f3ae263fdfc7efe Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Dec 2022 15:24:57 +0000 Subject: Replace SpringFox with SpringDoc in CLAMP This commit: - Remove springfox from CLAMP - updates the commissioning, AC Element, and K8S particiapnt to use the generated interface rather than the hard coded one - removes swagger annotations from handwritten code - implements SpringDoc for the /v3/api-docs on endpoints Issue-ID: POLICY-4404 Change-Id: I49f48bc7828cb49dab854ef9ed16a9aa377983e1 Signed-off-by: liamfallon --- .../clamp/acm/element/config/SpringDocBean.java | 48 ++++ .../clamp/acm/element/config/SpringFoxConfig.java | 46 ---- .../main/parameters/ElementTopicParameters.java | 2 + .../element/main/rest/AbstractRestController.java | 67 ------ .../acm/element/main/rest/AcElementController.java | 96 ++------ .../src/main/resources/config/application.yaml | 8 + .../src/main/resources/openapi/openapi.yaml | 242 +++++++++++++++++++++ .../acm/element/rest/AcElementControllerTest.java | 6 +- .../acm/element/rest/ActuatorControllerTest.java | 21 +- .../src/test/resources/application-test.yaml | 2 + 10 files changed, 336 insertions(+), 202 deletions(-) create mode 100644 participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/config/SpringDocBean.java delete mode 100644 participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/config/SpringFoxConfig.java delete mode 100644 participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/rest/AbstractRestController.java create mode 100644 participant/participant-impl/participant-impl-acelement/src/main/resources/openapi/openapi.yaml (limited to 'participant/participant-impl/participant-impl-acelement/src') diff --git a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/config/SpringDocBean.java b/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/config/SpringDocBean.java new file mode 100644 index 000000000..11696093a --- /dev/null +++ b/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/config/SpringDocBean.java @@ -0,0 +1,48 @@ +/*- + * ============LICENSE_START======================================================= + * 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. + * 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.policy.clamp.acm.element.config; + +import io.swagger.v3.oas.models.ExternalDocumentation; +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.info.Info; +import io.swagger.v3.oas.models.info.License; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class SpringDocBean { + + /** + * Bean to configure Springdoc. + * + * @return the OpenAPI specification + */ + @Bean + public OpenAPI acmElementParticipantOpenApi() { + return new OpenAPI() + .info(new Info().title("ACM Element Test Participant") + .description("CLAMP Automation Composition Management Element Test Participant API") + .license(new License().name("Apache 2.0").url("http://www.apache.org/licenses/LICENSE-2.0"))) + .externalDocs(new ExternalDocumentation() + .description("CLAMP Automation Composition Management Documentation") + .url("https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp.html")); + } +} diff --git a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/config/SpringFoxConfig.java b/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/config/SpringFoxConfig.java deleted file mode 100644 index 4e88e364a..000000000 --- a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/config/SpringFoxConfig.java +++ /dev/null @@ -1,46 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * 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. - * 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.policy.clamp.acm.element.config; - -import org.onap.policy.clamp.acm.element.main.rest.AcElementController; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; -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 SpringFoxConfig { - - /** - * Docket Spring Fox Config. - * - * @return Docket - */ - @Bean - public Docket api() { - return new Docket(DocumentationType.SWAGGER_2).select() - .apis(RequestHandlerSelectors.basePackage(AcElementController.class.getPackageName())) - .paths(PathSelectors.any()).build(); - } -} - diff --git a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/parameters/ElementTopicParameters.java b/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/parameters/ElementTopicParameters.java index 21394401c..d42b0d196 100644 --- a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/parameters/ElementTopicParameters.java +++ b/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/parameters/ElementTopicParameters.java @@ -22,10 +22,12 @@ package org.onap.policy.clamp.acm.element.main.parameters; import java.util.List; import lombok.Data; +import lombok.EqualsAndHashCode; import org.onap.policy.clamp.models.acm.messages.rest.element.DmaapConfig; import org.onap.policy.common.endpoints.parameters.TopicParameters; @Data +@EqualsAndHashCode(callSuper = false) public class ElementTopicParameters extends TopicParameters { /** diff --git a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/rest/AbstractRestController.java b/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/rest/AbstractRestController.java deleted file mode 100644 index 369342b11..000000000 --- a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/rest/AbstractRestController.java +++ /dev/null @@ -1,67 +0,0 @@ -/*- - * ============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.policy.clamp.acm.element.main.rest; - -import javax.ws.rs.core.MediaType; -import org.springframework.web.bind.annotation.RequestMapping; - -/** - * Common superclass to provide REST endpoints for the AC element. - */ -// @formatter:off -@RequestMapping( - value = "/onap/policy/clamp/acelement/v2", - produces = { - MediaType.APPLICATION_JSON, - AbstractRestController.APPLICATION_YAML - } -) -// @formatter:on -public abstract class AbstractRestController { - public static final String APPLICATION_YAML = "application/yaml"; - - public static final String API_VERSION_NAME = "api-version"; - - public static final String VERSION_MINOR_NAME = "X-MinorVersion"; - public static final String VERSION_MINOR_DESCRIPTION = - "Used to request or communicate a MINOR version back from the client" - + " to the server, and from the server back to the client"; - - public static final String VERSION_PATCH_NAME = "X-PatchVersion"; - public static final String VERSION_PATCH_DESCRIPTION = "Used only to communicate a PATCH version in a response for" - + " troubleshooting purposes only, and will not be provided by" + " the client on request"; - - public static final String VERSION_LATEST_NAME = "X-LatestVersion"; - public static final String VERSION_LATEST_DESCRIPTION = "Used only to communicate an API's latest version"; - - public static final String REQUEST_ID_NAME = "X-ONAP-RequestID"; - public static final String REQUEST_ID_HDR_DESCRIPTION = "Used to track REST transactions for logging purpose"; - - public static final String OK_CODE = "200"; - public static final String CREATED_CODE = "201"; - public static final String NO_CONTENT_CODE = "204"; - public static final String AUTHENTICATION_ERROR_CODE = "401"; - public static final String BAD_REQUEST_ERROR_CODE = "400"; - - public static final String AUTHENTICATION_ERROR_MESSAGE = "Authentication Error"; - public static final String BAD_REQUEST_ERROR_MESSAGE = "Bad request"; - public static final String SERVER_OK_MESSAGE = "Success"; -} \ No newline at end of file diff --git a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/rest/AcElementController.java b/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/rest/AcElementController.java index afe864edc..021567a7b 100644 --- a/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/rest/AcElementController.java +++ b/participant/participant-impl/participant-impl-acelement/src/main/java/org/onap/policy/clamp/acm/element/main/rest/AcElementController.java @@ -20,117 +20,49 @@ package org.onap.policy.clamp.acm.element.main.rest; -import io.swagger.v3.oas.annotations.Operation; -import io.swagger.v3.oas.annotations.headers.Header; -import io.swagger.v3.oas.annotations.media.Content; -import io.swagger.v3.oas.annotations.media.Schema; -import io.swagger.v3.oas.annotations.responses.ApiResponse; -import io.swagger.v3.oas.annotations.responses.ApiResponses; +import java.util.UUID; import lombok.RequiredArgsConstructor; +import org.onap.policy.clamp.acm.element.main.rest.genapi.AcElementControllerApi; import org.onap.policy.clamp.acm.element.service.ConfigService; import org.onap.policy.clamp.models.acm.messages.rest.element.ElementConfig; import org.springframework.http.HttpStatus; -import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; -import org.springframework.web.bind.annotation.DeleteMapping; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.PostMapping; -import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; @RestController @RequiredArgsConstructor -public class AcElementController extends AbstractRestController { +public class AcElementController implements AcElementControllerApi { private final ConfigService configService; /** - * REST endpoint to get the existing element config. + * REST end point to get the existing element configuration. * - * @return the element config params + * @return the element configuration parameters */ - // @formatter:off - @GetMapping(path = "/config", produces = MediaType.APPLICATION_JSON_VALUE) - @Operation(summary = "Return the element config", - tags = { "Clamp Automation Composition AC Element Impl API" }) - @ApiResponses( - value = { - @ApiResponse(responseCode = OK_CODE, description = SERVER_OK_MESSAGE, - content = @Content(schema = @Schema(implementation = ElementConfig.class)), - headers = { - @Header(name = API_VERSION_NAME), - @Header(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION), - @Header(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION), - @Header(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION), - @Header(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION), - @Header(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION) - }), - @ApiResponse(responseCode = AUTHENTICATION_ERROR_CODE, description = AUTHENTICATION_ERROR_MESSAGE) - } - ) - // @formatter:on - public ResponseEntity getElementConfig() { + @Override + public ResponseEntity getElementConfig(UUID onapRequestId) { return new ResponseEntity<>(configService.getElementConfig(), HttpStatus.OK); } /** - * REST endpoint to activate the element. + * REST end point to activate the element. * - * @param params element parameters for this ac element + * @param params element parameters for this AC element */ - // @formatter:off - @PostMapping(path = "/activate", consumes = MediaType.APPLICATION_JSON_VALUE, - produces = MediaType.APPLICATION_JSON_VALUE) - @Operation(summary = "Activates the element config", - tags = { "Clamp Automation Composition AC Element Impl API" } - ) - @ApiResponses( - value = { - @ApiResponse(responseCode = CREATED_CODE, description = SERVER_OK_MESSAGE, - headers = { - @Header(name = API_VERSION_NAME), - @Header(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION), - @Header(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION), - @Header(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION), - @Header(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION), - @Header(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION) - }), - @ApiResponse(responseCode = AUTHENTICATION_ERROR_CODE, description = AUTHENTICATION_ERROR_MESSAGE), - @ApiResponse(responseCode = BAD_REQUEST_ERROR_CODE, description = BAD_REQUEST_ERROR_MESSAGE) - } - ) - // formatter:on - public ResponseEntity activateElement(@RequestBody ElementConfig params) { + @Override + public ResponseEntity activateElement(UUID onapRequestId, ElementConfig params) { configService.activateElement(params); return new ResponseEntity<>(HttpStatus.CREATED); } /** - * REST endpoint to delete the element config. + * REST end point to delete the element configuration. * * @return Status of operation */ - // @formatter:off - @DeleteMapping(path = "/deactivate") - @Operation(summary = "Delete the element config", - tags = { "Clamp Automation Composition AC Element Impl API" } - ) - @ApiResponses( - value = { - @ApiResponse(responseCode = NO_CONTENT_CODE, description = SERVER_OK_MESSAGE, - headers = { - @Header(name = API_VERSION_NAME), - @Header(name = VERSION_MINOR_NAME, description = VERSION_MINOR_DESCRIPTION), - @Header(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION), - @Header(name = VERSION_PATCH_NAME, description = VERSION_PATCH_DESCRIPTION), - @Header(name = VERSION_LATEST_NAME, description = VERSION_LATEST_DESCRIPTION), - @Header(name = REQUEST_ID_NAME, description = REQUEST_ID_HDR_DESCRIPTION) - }), - @ApiResponse(responseCode = AUTHENTICATION_ERROR_CODE, description = AUTHENTICATION_ERROR_MESSAGE) - } - ) - // @formatter:on - public ResponseEntity deleteConfig() { + @Override + public ResponseEntity deleteConfig(UUID onapRequestId) { configService.deleteConfig(); return new ResponseEntity<>(HttpStatus.NO_CONTENT); } diff --git a/participant/participant-impl/participant-impl-acelement/src/main/resources/config/application.yaml b/participant/participant-impl/participant-impl-acelement/src/main/resources/config/application.yaml index 4d7710304..c32680602 100644 --- a/participant/participant-impl/participant-impl-acelement/src/main/resources/config/application.yaml +++ b/participant/participant-impl/participant-impl-acelement/src/main/resources/config/application.yaml @@ -3,9 +3,16 @@ spring: user: name: ${REST_USER:acmUser} password: ${REST_PASSWORD:zb!XztG34} + autoconfigure: + exclude: > + org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration, + org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration, + org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration server: port: ${PORT:8084} + servlet: + context-path: /onap/policy/clamp/acelement/v2 error: path: /error @@ -13,6 +20,7 @@ element: elementId: name: ${ELEMENT_ID:onap.policy.clamp.ac.element1} version: ${ELEMENT_VERSION:1.0.0} + management: endpoints: web: diff --git a/participant/participant-impl/participant-impl-acelement/src/main/resources/openapi/openapi.yaml b/participant/participant-impl/participant-impl-acelement/src/main/resources/openapi/openapi.yaml new file mode 100644 index 000000000..a3ccd1865 --- /dev/null +++ b/participant/participant-impl/participant-impl-acelement/src/main/resources/openapi/openapi.yaml @@ -0,0 +1,242 @@ +openapi: 3.0.3 +info: + title: ACM Element Test Participant + description: ApiCLAMP Automation Composition Management Element Test Participant API + contact: + name: ONAP Support + url: https://lists.onap.org/g/onap-discuss + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: '1.0' +externalDocs: + description: CLAMP Automation Composition Management Documentation + url: https://docs.onap.org/projects/onap-policy-parent/en/latest/clamp/clamp.html +servers: + - url: http:{port}/{server} + variables: + port: + default: "30296" + description: This value is assigned by the service provider + server: + default: /onap/policy/clamp/acelement/v2 + description: This value is assigned by the service provider +tags: + - name: ac-element-controller + description: Automation Composition Element Test Participant controller +paths: + /config: + get: + tags: + - ac-element-controller + summary: Return the element configuration + description: Return the configuraiton of this AC element + operationId: getElementConfig + parameters: + - name: X-onap-RequestId + in: header + description: RequestID for http transaction + schema: + type: string + format: uuid + responses: + 200: + description: OK, serialised instance of + [ElementConfig](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/element/ElementConfig.java) + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + content: + application/json: + schema: + $ref: '#/components/schemas/ElementConfig' + application/yaml: + schema: + $ref: '#/components/schemas/ElementConfig' + 401: + description: Authorization Error + 404: + description: Not Found + 500: + description: Internal Server Error + security: + - basicAuth: [] + /activate: + post: + tags: + - ac-element-controller + summary: Activates the element configuration + description: >- + Activates a configuration on an Automation Composition Element + operationId: activateElement + parameters: + - name: X-onap-RequestId + in: header + description: RequestID for http transaction + schema: + type: string + format: uuid + requestBody: + description: The AC element configuration to apply in a serialised instance of + [ElementConfig](https://github.com/onap/policy-clamp/blob/master/models/src/main/java/org/onap/policy/clamp/models/acm/messages/rest/element/ElementConfig.java) + content: + application/json: + schema: + $ref: '#/components/schemas/ElementConfig' + application/yaml: + schema: + $ref: '#/components/schemas/ElementConfig' + responses: + 201: + description: OK, configuration has been created + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + content: + application/json: + schema: + type: string + example: Success + application/yaml: + schema: + type: string + example: Success + 400: + description: Bad Request + 401: + description: Authorization Error + 500: + description: Internal Server Error + security: + - basicAuth: [] + /deactivate: + delete: + tags: + - ac-element-controller + summary: Delete the AC element configuration + description: Deletes the configuration of an Automation Composition Element + operationId: deleteConfig + parameters: + - name: X-onap-RequestId + in: header + description: RequestID for http transaction + schema: + type: string + format: uuid + responses: + 204: + description: No Content + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + 400: + description: Bad Request + 401: + description: Authorization Error + 409: + description: Not Defined, the elemet type is not defined + headers: + api-version: + schema: + type: string + X-LatestVersion: + schema: + type: string + description: Used only to communicate an API's latest version + X-PatchVersion: + schema: + type: string + description: + Used only to communicate a PATCH version in a response for troubleshooting purposes only, + and will not be provided by the client on request + X-MinorVersion: + schema: + type: string + description: + Used to request or communicate a MINOR version back from the client + to the server, and from the server back to the client + X-onap-RequestId: + schema: + type: string + format: uuid + description: Used to track REST transactions for logging purposes + 500: + description: Internal Server Error + security: + - basicAuth: [] +components: + securitySchemes: + basicAuth: + type: http + scheme: basic + schemas: + ElementConfig: + title: ElementConfig + type: object diff --git a/participant/participant-impl/participant-impl-acelement/src/test/java/org/onap/policy/clamp/acm/element/rest/AcElementControllerTest.java b/participant/participant-impl/participant-impl-acelement/src/test/java/org/onap/policy/clamp/acm/element/rest/AcElementControllerTest.java index 001b2be3b..1d19b1a17 100644 --- a/participant/participant-impl/participant-impl-acelement/src/test/java/org/onap/policy/clamp/acm/element/rest/AcElementControllerTest.java +++ b/participant/participant-impl/participant-impl-acelement/src/test/java/org/onap/policy/clamp/acm/element/rest/AcElementControllerTest.java @@ -67,9 +67,9 @@ class AcElementControllerTest { private static final Coder CODER = new StandardCoder(); private static final String ELEMENT_CONFIG_YAML = "src/test/resources/config.json"; - private static final String RETRIEVE_CONFIG = "/onap/policy/clamp/acelement/v2/config"; - private static final String ACTIVATE_CONFIG = "/onap/policy/clamp/acelement/v2/activate"; - private static final String DEACTIVATE_CONFIG = "/onap/policy/clamp/acelement/v2/deactivate"; + private static final String RETRIEVE_CONFIG = "/config"; + private static final String ACTIVATE_CONFIG = "/activate"; + private static final String DEACTIVATE_CONFIG = "/deactivate"; private static ElementConfig config; diff --git a/participant/participant-impl/participant-impl-acelement/src/test/java/org/onap/policy/clamp/acm/element/rest/ActuatorControllerTest.java b/participant/participant-impl/participant-impl-acelement/src/test/java/org/onap/policy/clamp/acm/element/rest/ActuatorControllerTest.java index 489056adc..81c4b087c 100644 --- a/participant/participant-impl/participant-impl-acelement/src/test/java/org/onap/policy/clamp/acm/element/rest/ActuatorControllerTest.java +++ b/participant/participant-impl/participant-impl-acelement/src/test/java/org/onap/policy/clamp/acm/element/rest/ActuatorControllerTest.java @@ -41,9 +41,10 @@ import org.springframework.test.context.junit.jupiter.SpringExtension; @ActiveProfiles("test") class ActuatorControllerTest extends CommonActuatorController { - private static final String HEALTH_ENDPOINT = "health"; - private static final String METRICS_ENDPOINT = "metrics"; - private static final String PROMETHEUS_ENDPOINT = "prometheus"; + private static final String HEALTH_ENDPOINT = "onap/policy/clamp/acelement/v2/health/"; + private static final String METRICS_ENDPOINT = "onap/policy/clamp/acelement/v2/metrics/"; + private static final String PROMETHEUS_ENDPOINT = "onap/policy/clamp/acelement/v2/prometheus/"; + private static final String SWAGGER_ENDPOINT = "onap/policy/clamp/acelement/v2/v3/api-docs/"; @LocalServerPort private int randomServerPort; @@ -68,6 +69,11 @@ class ActuatorControllerTest extends CommonActuatorController { assertUnauthorizedActGet(PROMETHEUS_ENDPOINT); } + @Test + void testGetSwagger_Unauthorized() throws Exception { + assertUnauthorizedActGet(SWAGGER_ENDPOINT); + } + @Test void testGetHealth() throws Exception { Invocation.Builder invocationBuilder = super.sendActRequest(HEALTH_ENDPOINT); @@ -83,9 +89,16 @@ class ActuatorControllerTest extends CommonActuatorController { } @Test - void testGePrometheus() throws Exception { + void testGetPrometheus() throws Exception { Invocation.Builder invocationBuilder = super.sendActRequest(PROMETHEUS_ENDPOINT); Response rawresp = invocationBuilder.buildGet().invoke(); assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus()); } + + @Test + void testGetSwagger() throws Exception { + Invocation.Builder invocationBuilder = super.sendActRequest(SWAGGER_ENDPOINT); + Response rawresp = invocationBuilder.buildGet().invoke(); + assertEquals(Response.Status.OK.getStatusCode(), rawresp.getStatus()); + } } diff --git a/participant/participant-impl/participant-impl-acelement/src/test/resources/application-test.yaml b/participant/participant-impl/participant-impl-acelement/src/test/resources/application-test.yaml index d521ad742..4162bc8bf 100644 --- a/participant/participant-impl/participant-impl-acelement/src/test/resources/application-test.yaml +++ b/participant/participant-impl/participant-impl-acelement/src/test/resources/application-test.yaml @@ -6,6 +6,8 @@ spring: server: port: 8084 + servlet: + context-path: /onap/policy/clamp/acelement/v2 error: path: /error -- cgit 1.2.3-korg