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 <base_path>/v3/api-docs on endpoints

Issue-ID: POLICY-4404
Change-Id: I49f48bc7828cb49dab854ef9ed16a9aa377983e1
Signed-off-by: liamfallon <liam.fallon@est.tech>

4 files changed, 103 insertions, 72 deletions

diff --git a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringFoxConfig.java b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringDocBean.java
index cfa98bd65..17e1b16d1 100644
--- a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringFoxConfig.java
+++ b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/configurations/SpringDocBean.java
@@ -1,6 +1,6 @@
 /*-
  * ============LICENSE_START=======================================================
- *  Copyright (C) 2021 Nordix Foundation.
+ *  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.
@@ -20,26 +20,29 @@
 
 package org.onap.policy.clamp.acm.participant.kubernetes.configurations;
 
-import org.onap.policy.clamp.acm.participant.kubernetes.controller.ChartController;
+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;
-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 {
+public class SpringDocBean {
 
     /**
-     * Docket Spring Fox Config.
+     * Bean to configure Springdoc.
      *
-     * @return Docket
+     * @return the OpenAPI specification
      */
     @Bean
-    public Docket api() {
-        return new Docket(DocumentationType.SWAGGER_2).select()
-                .apis(RequestHandlerSelectors.basePackage(ChartController.class.getPackageName()))
-                .paths(PathSelectors.any()).build();
+    public OpenAPI kubernetesParticipantOpenApi() {
+        return new OpenAPI()
+                .info(new Info().title("ACM Kubernetes Participant")
+                .description("CLAMP Automation Composition Management Kubernetes 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-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java
index 1186b7bf5..3928dd4f8 100644
--- a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java
+++ b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/controller/ChartController.java
@@ -18,15 +18,14 @@
 
 package org.onap.policy.clamp.acm.participant.kubernetes.controller;
 
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.responses.ApiResponse;
-import io.swagger.v3.oas.annotations.responses.ApiResponses;
-import io.swagger.v3.oas.annotations.tags.Tag;
 import java.io.IOException;
 import java.lang.invoke.MethodHandles;
 import java.util.ArrayList;
+import java.util.UUID;
 import lombok.RequiredArgsConstructor;
+import org.onap.policy.clamp.acm.participant.kubernetes.controller.genapi.KubernetesParticipantControllerApi;
 import org.onap.policy.clamp.acm.participant.kubernetes.exception.ServiceException;
+import org.onap.policy.clamp.acm.participant.kubernetes.exception.ServiceRuntimeException;
 import org.onap.policy.clamp.acm.participant.kubernetes.models.ChartInfo;
 import org.onap.policy.clamp.acm.participant.kubernetes.models.ChartList;
 import org.onap.policy.clamp.acm.participant.kubernetes.models.HelmRepository;
@@ -38,16 +37,8 @@ import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
 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.PathVariable;
-import org.springframework.web.bind.annotation.PostMapping;
-import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
-import org.springframework.web.bind.annotation.RequestParam;
-import org.springframework.web.bind.annotation.RequestPart;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.multipart.MultipartFile;
 
@@ -55,8 +46,7 @@ import org.springframework.web.multipart.MultipartFile;
 @RestController("chartController")
 @ConditionalOnExpression("${chart.api.enabled:false}")
 @RequestMapping("helm")
-@Tag(name = "k8s-participant")
-public class ChartController {
+public class ChartController implements KubernetesParticipantControllerApi {
     private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
     private final ChartService chartService;
@@ -68,12 +58,10 @@ public class ChartController {
      *
      * @return List of charts installed
      */
-    @GetMapping(path = "/charts", produces = MediaType.APPLICATION_JSON_VALUE)
-    @Operation(summary = "Return all Charts")
-    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "chart List")})
-    public ResponseEntity<ChartList> getAllCharts() {
+    @Override
+    public ResponseEntity<ChartList> getAllCharts(UUID onapRequestId) {
         return new ResponseEntity<>(ChartList.builder().charts(new ArrayList<>(chartService.getAllCharts())).build(),
-                HttpStatus.OK);
+            HttpStatus.OK);
     }
 
     /**
@@ -84,18 +72,18 @@ public class ChartController {
      * @throws ServiceException in case of error
      * @throws IOException in case of IO error
      */
-    @PostMapping(path = "/install", consumes = MediaType.APPLICATION_JSON_VALUE,
-            produces = MediaType.APPLICATION_JSON_VALUE)
-    @Operation(summary = "Install the chart")
-    @ApiResponses(value = {@ApiResponse(responseCode = "201", description = "chart Installed")})
-    public ResponseEntity<Void> installChart(@RequestBody InstallationInfo info)
-            throws ServiceException, IOException {
+    @Override
+    public ResponseEntity<Void> installChart(UUID onapRequestId, InstallationInfo info) {
         ChartInfo chart = chartService.getChart(info.getName(), info.getVersion());
         if (chart == null) {
             return new ResponseEntity<>(HttpStatus.NOT_FOUND);
         }
 
-        chartService.installChart(chart);
+        try {
+            chartService.installChart(chart);
+        } catch (ServiceException | IOException e) {
+            throw new ServiceRuntimeException(e);
+        }
         return new ResponseEntity<>(HttpStatus.CREATED);
     }
 
@@ -107,18 +95,19 @@ public class ChartController {
      * @return Status of operation
      * @throws ServiceException in case of error.
      */
-    @DeleteMapping(path = "/uninstall/{name}/{version}", produces = MediaType.APPLICATION_JSON_VALUE)
-    @Operation(summary = "Uninstall the Chart")
-    @ApiResponses(value = {@ApiResponse(responseCode = "204", description = "chart Uninstalled")})
-    public ResponseEntity<Void> uninstallChart(@PathVariable("name") String name,
-            @PathVariable("version") String version) throws ServiceException {
+    @Override
+    public ResponseEntity<Void> uninstallChart(String name, String version, UUID onapRequestId) {
         ChartInfo chart = chartService.getChart(name, version);
         if (chart == null) {
             return new ResponseEntity<>(HttpStatus.NOT_FOUND);
         }
 
-        chartService.uninstallChart(chart);
-        return new ResponseEntity<>(HttpStatus.NO_CONTENT);
+        try {
+            chartService.uninstallChart(chart);
+            return new ResponseEntity<>(HttpStatus.NO_CONTENT);
+        } catch (ServiceException se) {
+            throw se.asRuntimeException();
+        }
     }
 
     /**
@@ -131,23 +120,23 @@ public class ChartController {
      * @throws ServiceException in case of error
      * @throws IOException in case of IO error
      */
-    @PostMapping(path = "/onboard/chart", consumes = MediaType.MULTIPART_FORM_DATA_VALUE,
-            produces = MediaType.APPLICATION_JSON_VALUE)
-    @Operation(summary = "Onboard the Chart")
-    @ApiResponses(value = {@ApiResponse(responseCode = "200", description = "Chart Onboarded")})
-    public ResponseEntity<Void> onboardChart(@RequestPart("chart") MultipartFile chartFile,
-            @RequestParam(name = "values", required = false) MultipartFile overrideFile,
-            @RequestParam("info") String infoJson) throws ServiceException, IOException {
+    @Override
+    public ResponseEntity<Void> onboardChart(MultipartFile chartFile, MultipartFile overrideFile, String infoJson,
+        UUID onapRequestId) {
 
         ChartInfo info;
         try {
             info = CODER.decode(infoJson, ChartInfo.class);
         } catch (CoderException e) {
-            throw new ServiceException("Error parsing the chart information", e);
+            throw new ServiceRuntimeException("Error parsing the chart information", e);
         }
 
-        chartService.saveChart(info, chartFile, overrideFile);
-        return new ResponseEntity<>(HttpStatus.OK);
+        try {
+            chartService.saveChart(info, chartFile, overrideFile);
+            return new ResponseEntity<>(HttpStatus.OK);
+        } catch (IOException | ServiceException e) {
+            throw new ServiceRuntimeException(e);
+        }
     }
 
     /**
@@ -157,11 +146,8 @@ public class ChartController {
      * @param version version of the chart
      * @return Status of operation
      */
-    @DeleteMapping(path = "/chart/{name}/{version}")
-    @Operation(summary = "Delete the chart")
-    @ApiResponses(value = {@ApiResponse(responseCode = "204", description = "Chart Deleted")})
-    public ResponseEntity<Void> deleteChart(@PathVariable("name") String name,
-            @PathVariable("version") String version) {
+    @Override
+    public ResponseEntity<Void> deleteChart(String name, String version, UUID onapRequestId) {
 
         ChartInfo chart = chartService.getChart(name, version);
         if (chart == null) {
@@ -180,24 +166,25 @@ public class ChartController {
      * @throws ServiceException in case of error
      * @throws IOException in case of IO error
      */
-    @PostMapping(path = "/repo", consumes = MediaType.APPLICATION_JSON_VALUE,
-            produces = MediaType.APPLICATION_JSON_VALUE)
-    @ApiResponses(
-            value = {@ApiResponse(responseCode = "201", description = "Repository added"),
-                @ApiResponse(responseCode = "409", description = "Repository already Exist")})
-    public ResponseEntity<String> configureRepo(@RequestBody String repo)
-            throws ServiceException, IOException {
+    @Override
+    public ResponseEntity<String> configureRepo(UUID onapRequestId, String repo) {
         HelmRepository repository;
         try {
             repository = CODER.decode(repo, HelmRepository.class);
         } catch (CoderException e) {
             logger.warn("Error parsing the repository information:", e);
             return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
-                    .body("Error parsing the repository information");
+                .body("Error parsing the repository information");
         }
-        if (chartService.configureRepository(repository)) {
-            return new ResponseEntity<>(HttpStatus.CREATED);
+
+        try {
+            if (chartService.configureRepository(repository)) {
+                return new ResponseEntity<>(HttpStatus.CREATED);
+            } else {
+                return new ResponseEntity<>(HttpStatus.CONFLICT);
+            }
+        } catch (ServiceException se) {
+            throw se.asRuntimeException();
         }
-        return new ResponseEntity<>(HttpStatus.CONFLICT);
     }
 }
diff --git a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java
index 6414f2fa9..f4701e0ac 100644
--- a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java
+++ b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceException.java
@@ -29,4 +29,8 @@ public class ServiceException extends Exception {
     public ServiceException(String message, Exception originalException) {
         super(message, originalException);
     }
+
+    public ServiceRuntimeException asRuntimeException() {
+        return new ServiceRuntimeException(this);
+    }
 }
diff --git a/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceRuntimeException.java b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceRuntimeException.java
new file mode 100644
index 000000000..9aa2eefa3
--- /dev/null
+++ b/participant/participant-impl/participant-impl-kubernetes/src/main/java/org/onap/policy/clamp/acm/participant/kubernetes/exception/ServiceRuntimeException.java
@@ -0,0 +1,37 @@
+/*-
+ * ========================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.
+ * ========================LICENSE_END===================================
+ */
+
+package org.onap.policy.clamp.acm.participant.kubernetes.exception;
+
+public class ServiceRuntimeException extends RuntimeException {
+
+
+    private static final long serialVersionUID = -4702572294307202439L;
+
+    public ServiceRuntimeException(String message) {
+        super(message);
+    }
+
+    public ServiceRuntimeException(String message, Exception originalException) {
+        super(message, originalException);
+    }
+
+    public ServiceRuntimeException(Exception originalException) {
+        super(originalException);
+    }
+}