Refactor GlobalControllerExceptionHandler 88/125088/3
authorFrancescoFioraEst <francesco.fiora@est.tech>
Mon, 18 Oct 2021 16:12:39 +0000 (17:12 +0100)
committerAjith Sreekumar <ajith.sreekumar@bell.ca>
Tue, 19 Oct 2021 15:43:21 +0000 (15:43 +0000)
Issue-ID: POLICY-3530
Change-Id: Ib33daf8491c1bf96460b424e8b0da228d65e571a
Signed-off-by: FrancescoFioraEst <francesco.fiora@est.tech>
models/src/main/java/org/onap/policy/clamp/controlloop/models/rest/RestUtils.java [new file with mode: 0644]
models/src/test/java/org/onap/policy/clamp/controlloop/models/rest/RestUtilsTest.java [new file with mode: 0644]
participant/participant-impl/participant-impl-simulator/src/main/java/org/onap/policy/clamp/controlloop/participant/simulator/main/rest/GlobalControllerExceptionHandler.java
runtime-controlloop/src/main/java/org/onap/policy/clamp/controlloop/runtime/main/web/GlobalControllerExceptionHandler.java

diff --git a/models/src/main/java/org/onap/policy/clamp/controlloop/models/rest/RestUtils.java b/models/src/main/java/org/onap/policy/clamp/controlloop/models/rest/RestUtils.java
new file mode 100644 (file)
index 0000000..6c12c2d
--- /dev/null
@@ -0,0 +1,43 @@
+/*-
+ * ============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.policy.clamp.controlloop.models.rest;
+
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import org.onap.policy.clamp.controlloop.models.messages.rest.SimpleResponse;
+import org.onap.policy.models.errors.concepts.ErrorResponseInfo;
+import org.springframework.http.ResponseEntity;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public final class RestUtils {
+
+    /**
+     * Convert an ErrorResponseInfo to a ResponseEntity.
+     *
+     * @param ex the ErrorResponseInfo
+     * @return the ResponseEntity
+     */
+    public static ResponseEntity<SimpleResponse> toSimpleResponse(ErrorResponseInfo ex) {
+        var resp = new SimpleResponse();
+        resp.setErrorDetails(ex.getErrorResponse().getErrorMessage());
+        return ResponseEntity.status(ex.getErrorResponse().getResponseCode().getStatusCode()).body(resp);
+    }
+}
diff --git a/models/src/test/java/org/onap/policy/clamp/controlloop/models/rest/RestUtilsTest.java b/models/src/test/java/org/onap/policy/clamp/controlloop/models/rest/RestUtilsTest.java
new file mode 100644 (file)
index 0000000..4dedae2
--- /dev/null
@@ -0,0 +1,54 @@
+/*-
+ * ============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.policy.clamp.controlloop.models.rest;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import javax.ws.rs.core.Response.Status;
+import org.junit.jupiter.api.Test;
+import org.onap.policy.models.errors.concepts.ErrorResponse;
+import org.onap.policy.models.errors.concepts.ErrorResponseInfo;
+
+class RestUtilsTest {
+
+    private static final String MESSAGE_ERROR = "Erorr";
+    private static final Status STATUS_ERROR = Status.BAD_REQUEST;
+
+    @Test
+    void testToSimpleResponse() {
+        var ex = new ErrorResponseInfo() {
+
+            @Override
+            public ErrorResponse getErrorResponse() {
+                var er = new ErrorResponse();
+                er.setErrorMessage(MESSAGE_ERROR);
+                er.setResponseCode(STATUS_ERROR);
+                return er;
+            }
+        };
+
+        var response = RestUtils.toSimpleResponse(ex);
+
+        assertThat(response.getStatusCodeValue()).isEqualTo(STATUS_ERROR.getStatusCode());
+        assertThat(response.getBody()).isNotNull();
+        assertThat(response.getBody().getErrorDetails()).isEqualTo(MESSAGE_ERROR);
+    }
+}
index 34b2123..8648c25 100644 (file)
 package org.onap.policy.clamp.controlloop.participant.simulator.main.rest;
 
 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
-import org.onap.policy.clamp.controlloop.models.messages.rest.commissioning.CommissioningResponse;
-import org.springframework.http.HttpStatus;
+import org.onap.policy.clamp.controlloop.models.messages.rest.SimpleResponse;
+import org.onap.policy.clamp.controlloop.models.rest.RestUtils;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.ExceptionHandler;
-import org.springframework.web.bind.annotation.ResponseStatus;
 import org.springframework.web.bind.annotation.RestControllerAdvice;
 
 @RestControllerAdvice
@@ -40,12 +39,7 @@ public class GlobalControllerExceptionHandler {
      * @return ResponseEntity
      */
     @ExceptionHandler(ControlLoopException.class)
-    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
-    public ResponseEntity<CommissioningResponse> handleBadRequest(ControlLoopException ex) {
-
-        var resp = new CommissioningResponse();
-        resp.setErrorDetails(ex.getErrorResponse().getErrorMessage());
-
-        return ResponseEntity.status(ex.getErrorResponse().getResponseCode().getStatusCode()).body(resp);
+    public ResponseEntity<SimpleResponse> handleBadRequest(ControlLoopException ex) {
+        return RestUtils.toSimpleResponse(ex);
     }
 }
index d093c67..fd493fd 100644 (file)
@@ -22,6 +22,7 @@ package org.onap.policy.clamp.controlloop.runtime.main.web;
 
 import org.onap.policy.clamp.controlloop.common.exception.ControlLoopException;
 import org.onap.policy.clamp.controlloop.models.messages.rest.SimpleResponse;
+import org.onap.policy.clamp.controlloop.models.rest.RestUtils;
 import org.onap.policy.models.base.PfModelException;
 import org.onap.policy.models.base.PfModelRuntimeException;
 import org.springframework.http.ResponseEntity;
@@ -39,9 +40,7 @@ public class GlobalControllerExceptionHandler {
      */
     @ExceptionHandler(ControlLoopException.class)
     public ResponseEntity<SimpleResponse> handleBadRequest(ControlLoopException ex) {
-        var resp = new SimpleResponse();
-        resp.setErrorDetails(ex.getErrorResponse().getErrorMessage());
-        return ResponseEntity.status(ex.getErrorResponse().getResponseCode().getStatusCode()).body(resp);
+        return RestUtils.toSimpleResponse(ex);
     }
 
     /**
@@ -52,9 +51,7 @@ public class GlobalControllerExceptionHandler {
      */
     @ExceptionHandler(PfModelRuntimeException.class)
     public ResponseEntity<SimpleResponse> handleBadRequest(PfModelRuntimeException ex) {
-        var resp = new SimpleResponse();
-        resp.setErrorDetails(ex.getErrorResponse().getErrorMessage());
-        return ResponseEntity.status(ex.getErrorResponse().getResponseCode().getStatusCode()).body(resp);
+        return RestUtils.toSimpleResponse(ex);
     }
 
     /**
@@ -65,9 +62,6 @@ public class GlobalControllerExceptionHandler {
      */
     @ExceptionHandler(PfModelException.class)
     public ResponseEntity<SimpleResponse> handleBadRequest(PfModelException ex) {
-        var resp = new SimpleResponse();
-        resp.setErrorDetails(ex.getErrorResponse().getErrorMessage());
-        return ResponseEntity.status(ex.getErrorResponse().getResponseCode().getStatusCode()).body(resp);
+        return RestUtils.toSimpleResponse(ex);
     }
-
 }