dashboard/webapp-backend/src/test/java/org/oransc/ric/portal/dashboard/controller/AdminControllerExtension.java

   1 /*-
   2  * ========================LICENSE_START=================================
   3  * O-RAN-SC
   4  * %%
   5  * Copyright (C) 2019 AT&T Intellectual Property
   6  * %%
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ========================LICENSE_END===================================
  19  */
  20 package org.oransc.ric.portal.dashboard.controller;
  21
  22 import java.lang.invoke.MethodHandles;
  23 import java.nio.charset.Charset;
  24
  25 import org.slf4j.Logger;
  26 import org.slf4j.LoggerFactory;
  27 import org.springframework.context.annotation.Profile;
  28 import org.springframework.http.HttpStatus;
  29 import org.springframework.http.MediaType;
  30 import org.springframework.web.bind.annotation.GetMapping;
  31 import org.springframework.web.bind.annotation.RequestMapping;
  32 import org.springframework.web.bind.annotation.RestController;
  33 import org.springframework.web.client.HttpClientErrorException;
  34 import org.springframework.web.client.RestClientResponseException;
  35
  36 /**
  37  * Extends the Admin controller with methods that throw exceptions to support
  38  * testing.
  39  */
  40 @Profile("test")
  41 @RestController
  42 @RequestMapping(value = AdminController.CONTROLLER_PATH, produces = MediaType.APPLICATION_JSON_VALUE)
  43 public class AdminControllerExtension {
  44
  45         public static final String HTTP_STATUS_CODE_EXCEPTION_METHOD = "hscexception";
  46         public static final String REST_CLIENT_RESPONSE_EXCEPTION_METHOD = "rcrexception";
  47         public static final String RUNTIME_EXCEPTION_METHOD = "rexception";
  48
  49         private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
  50
  51         @GetMapping(HTTP_STATUS_CODE_EXCEPTION_METHOD)
  52         public void throwHttpStatusCodeException() {
  53                 logger.warn("throwing HttpClientErrorException");
  54                 final String mockResponseBody = "mock http status code exception";
  55                 throw new HttpClientErrorException(HttpStatus.CHECKPOINT, "mock status", mockResponseBody.getBytes(),
  56                                 Charset.defaultCharset());
  57         }
  58
  59         @GetMapping(REST_CLIENT_RESPONSE_EXCEPTION_METHOD)
  60         public void throwRestClientResponseException() {
  61                 logger.warn("throwing RestClientResponseException");
  62                 throw new RestClientResponseException("simulate remote client failure", 0, "bar", null, null, null);
  63         }
  64
  65         @GetMapping(RUNTIME_EXCEPTION_METHOD)
  66         public void throwRuntimeException() {
  67                 logger.warn("throwing RuntimeException");
  68                 throw new RuntimeException("simulate runtime failure");
  69         }
  70
  71 }