diff options
Diffstat (limited to 'models-interactions/model-impl/vfc')
3 files changed, 1 insertions, 406 deletions
diff --git a/models-interactions/model-impl/vfc/pom.xml b/models-interactions/model-impl/vfc/pom.xml index f94bdd9a5..4fe965f44 100644 --- a/models-interactions/model-impl/vfc/pom.xml +++ b/models-interactions/model-impl/vfc/pom.xml @@ -24,7 +24,7 @@ <parent> <groupId>org.onap.policy.models.policy-models-interactions.model-impl</groupId> <artifactId>model-impl</artifactId> - <version>2.3.0-SNAPSHOT</version> + <version>2.3.1-SNAPSHOT</version> </parent> <artifactId>vfc</artifactId> diff --git a/models-interactions/model-impl/vfc/src/main/java/org/onap/policy/vfc/VfcManager.java b/models-interactions/model-impl/vfc/src/main/java/org/onap/policy/vfc/VfcManager.java deleted file mode 100644 index 64d60ba1e..000000000 --- a/models-interactions/model-impl/vfc/src/main/java/org/onap/policy/vfc/VfcManager.java +++ /dev/null @@ -1,196 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2017-2019 Intel Corp. All rights reserved. - * Modifications Copyright (C) 2019-2020 Nordix Foundation. - * Modifications Copyright (C) 2018-2019 AT&T Corporation. All rights reserved. - * Modifications Copyright (C) 2019 Samsung Electronics Co., Ltd. - * ================================================================================ - * 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.vfc; - -import com.google.gson.JsonSyntaxException; -import java.util.HashMap; -import java.util.Map; -import org.apache.commons.lang3.tuple.Pair; -import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; -import org.onap.policy.common.endpoints.utils.NetLoggerUtil; -import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType; -import org.onap.policy.rest.RestManager; -import org.onap.policy.vfc.util.Serialization; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -public final class VfcManager implements Runnable { - - private String vfcUrlBase; - private String username; - private String password; - private VfcRequest vfcRequest; - private VfcCallback callback; - private static final Logger logger = LoggerFactory.getLogger(VfcManager.class); - - // The REST manager used for processing REST calls for this VFC manager - private RestManager restManager; - - @FunctionalInterface - public interface VfcCallback { - void onResponse(VfcResponse responseError); - } - - /** - * Constructor. - * - * @param cb Callback method to call when response - * @param request request - * @param url URL to VFC component - * @param user username - * @param pwd password - */ - public VfcManager(VfcCallback cb, VfcRequest request, String url, String user, String pwd) { - if (cb == null || request == null) { - throw new IllegalArgumentException( - "the parameters \"cb\" and \"request\" on the VfcManager constructor may not be null"); - } - if (url == null) { - throw new IllegalArgumentException( - "the \"url\" parameter on the VfcManager constructor may not be null"); - } - callback = cb; - vfcRequest = request; - vfcUrlBase = url; - username = user; - password = pwd; - - restManager = new RestManager(); - } - - /** - * Set the parameters. - * - * @param baseUrl base URL - * @param name username - * @param pwd password - */ - public void setVfcParams(String baseUrl, String name, String pwd) { - vfcUrlBase = baseUrl + "/api/nslcm/v1"; - username = name; - password = pwd; - } - - @Override - public void run() { - Map<String, String> headers = new HashMap<>(); - Pair<Integer, String> httpDetails; - - VfcResponse responseError = new VfcResponse(); - responseError.setResponseDescriptor(new VfcResponseDescriptor()); - responseError.getResponseDescriptor().setStatus("error"); - - headers.put("Accept", "application/json"); - String vfcUrl = vfcUrlBase + "/ns/" + vfcRequest.getNsInstanceId() + "/heal"; - try { - String vfcRequestJson = Serialization.gsonPretty.toJson(vfcRequest); - NetLoggerUtil.log(EventType.OUT, CommInfrastructure.REST, vfcUrl, vfcRequestJson); - - httpDetails = restManager.post(vfcUrl, username, password, headers, "application/json", vfcRequestJson); - } catch (Exception e) { - logger.error(e.getMessage(), e); - this.callback.onResponse(responseError); - return; - } - - if (httpDetails == null) { - this.callback.onResponse(responseError); - return; - } - - if (httpDetails.getLeft() != 202) { - logger.warn("VFC Heal Restcall failed"); - return; - } - - try { - handleVfcResponse(headers, httpDetails, vfcUrl); - } catch (JsonSyntaxException e) { - logger.error("Failed to deserialize into VfcResponse {}", e.getLocalizedMessage(), e); - } catch (InterruptedException e) { - logger.error("Interrupted exception: {}", e.getLocalizedMessage(), e); - Thread.currentThread().interrupt(); - } catch (Exception e) { - logger.error("Unknown error deserializing into VfcResponse {}", e.getLocalizedMessage(), e); - } - } - - /** - * Handle a VFC response message. - * - * @param headers the headers in the response - * @param httpDetails the HTTP details in the response - * @param vfcUrl the response URL - * @throws InterruptedException on errors in the response - */ - private void handleVfcResponse(Map<String, String> headers, Pair<Integer, String> httpDetails, String vfcUrl) - throws InterruptedException { - VfcResponse response = Serialization.gsonPretty.fromJson(httpDetails.getRight(), VfcResponse.class); - NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, vfcUrl, httpDetails.getRight()); - String body = Serialization.gsonPretty.toJson(response); - logger.debug("Response to VFC Heal post:"); - logger.debug(body); - - String jobId = response.getJobId(); - int attemptsLeft = 20; - - String urlGet = vfcUrlBase + "/jobs/" + jobId; - VfcResponse responseGet = null; - - while (attemptsLeft-- > 0) { - NetLoggerUtil.getNetworkLogger().info("[OUT|{}|{}|]", "VFC", urlGet); - Pair<Integer, String> httpDetailsGet = restManager.get(urlGet, username, password, headers); - responseGet = Serialization.gsonPretty.fromJson(httpDetailsGet.getRight(), VfcResponse.class); - NetLoggerUtil.log(EventType.IN, CommInfrastructure.REST, vfcUrl, httpDetailsGet.getRight()); - responseGet.setRequestId(vfcRequest.getRequestId().toString()); - body = Serialization.gsonPretty.toJson(responseGet); - logger.debug("Response to VFC Heal get:"); - logger.debug(body); - - String responseStatus = responseGet.getResponseDescriptor().getStatus(); - if (httpDetailsGet.getLeft() == 200 - && ("finished".equalsIgnoreCase(responseStatus) || "error".equalsIgnoreCase(responseStatus))) { - logger.debug("VFC Heal Status {}", responseGet.getResponseDescriptor().getStatus()); - this.callback.onResponse(responseGet); - return; - } - Thread.sleep(20000); - } - boolean isTimeout = (attemptsLeft <= 0) && (responseGet != null) - && (responseGet.getResponseDescriptor() != null); - isTimeout = isTimeout && (responseGet.getResponseDescriptor().getStatus() != null) - && (!responseGet.getResponseDescriptor().getStatus().isEmpty()); - if (isTimeout) { - logger.debug("VFC timeout. Status: ({})", responseGet.getResponseDescriptor().getStatus()); - this.callback.onResponse(responseGet); - } - } - - /** - * Protected setter for rest manager to allow mocked rest manager to be used for testing. - * - * @param restManager the test REST manager - */ - protected void setRestManager(final RestManager restManager) { - this.restManager = restManager; - } -} diff --git a/models-interactions/model-impl/vfc/src/test/java/org/onap/policy/vfc/VfcManagerTest.java b/models-interactions/model-impl/vfc/src/test/java/org/onap/policy/vfc/VfcManagerTest.java deleted file mode 100644 index fbe29c384..000000000 --- a/models-interactions/model-impl/vfc/src/test/java/org/onap/policy/vfc/VfcManagerTest.java +++ /dev/null @@ -1,209 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * vfc - * ================================================================================ - * Copyright (C) 2018-2020 AT&T Intellectual Property. All rights reserved. - * Modifications Copyright (C) 2019-2020 Nordix Foundation.. All rights reserved. - * Modifications Copyright (C) 2018-2019 AT&T Corporation. 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.vfc; - -import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.ArgumentMatchers.anyMap; -import static org.mockito.ArgumentMatchers.anyString; -import static org.mockito.ArgumentMatchers.eq; -import static org.mockito.ArgumentMatchers.startsWith; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.verify; -import static org.mockito.Mockito.when; - -import java.util.ArrayList; -import java.util.List; -import java.util.UUID; -import org.apache.commons.lang3.tuple.Pair; -import org.junit.Before; -import org.junit.Test; -import org.onap.policy.rest.RestManager; -import org.onap.policy.vfc.VfcManager.VfcCallback; -import org.onap.policy.vfc.util.Serialization; - -public class VfcManagerTest implements VfcCallback { - - private static final String SOME_URL = "http://somewhere.over.the.rainbow"; - - private static final String DOROTHY = "Dorothy"; - - private RestManager mockedRestManager; - - private Pair<Integer, String> httpResponsePutOk; - private Pair<Integer, String> httpResponseBadResponse; - private Pair<Integer, String> httpResponseErr; - - private VfcRequest request; - private VfcResponse response; - - /** - * Set up the mocked REST manager. - */ - @Before - public void setupMockedRest() { - mockedRestManager = mock(RestManager.class); - - httpResponsePutOk = Pair.of(202, Serialization.gsonPretty.toJson(response)); - httpResponseBadResponse = Pair.of(202, Serialization.gsonPretty.toJson(null)); - httpResponseErr = Pair.of(200, null); - } - - /** - * Create the request and response before. - */ - @Before - public void createRequestAndResponse() { - VfcHealActionVmInfo actionInfo = new VfcHealActionVmInfo(); - actionInfo.setVmid("TheWizard"); - actionInfo.setVmname("The Wizard of Oz"); - - VfcHealAdditionalParams additionalParams = new VfcHealAdditionalParams(); - additionalParams.setAction("Go Home"); - additionalParams.setActionInfo(actionInfo); - - VfcHealRequest healRequest = new VfcHealRequest(); - healRequest.setAdditionalParams(additionalParams); - healRequest.setCause("WestWitch"); - healRequest.setVnfInstanceId("EmeraldCity"); - - final UUID requestId = UUID.randomUUID(); - request = new VfcRequest(); - request.setHealRequest(healRequest); - request.setNsInstanceId(DOROTHY); - request.setRequestId(requestId); - - List<VfcResponseDescriptor> responseHistoryList = new ArrayList<>();; - - VfcResponseDescriptor responseDescriptor = new VfcResponseDescriptor(); - responseDescriptor.setErrorCode("1234"); - responseDescriptor.setProgress("Follow The Yellow Brick Road"); - responseDescriptor.setResponseHistoryList(responseHistoryList); - responseDescriptor.setResponseId(UUID.randomUUID().toString()); - responseDescriptor.setStatus("finished"); - responseDescriptor.setStatusDescription("There's no place like home"); - - response = new VfcResponse(); - response.setJobId("1234"); - response.setRequestId(request.getRequestId().toString()); - response.setResponseDescriptor(responseDescriptor); - } - - @Test - public void testVfcInitiation() { - assertThatIllegalArgumentException().isThrownBy(() -> new VfcManager(null, null, null, null, null)).withMessage( - "the parameters \"cb\" and \"request\" on the VfcManager constructor may not be null"); - - assertThatIllegalArgumentException().isThrownBy(() -> new VfcManager(this, null, null, null, null)).withMessage( - "the parameters \"cb\" and \"request\" on the VfcManager constructor may not be null"); - - assertThatIllegalArgumentException().isThrownBy(() -> new VfcManager(this, request, null, null, null)) - .withMessage("the \"url\" parameter on the VfcManager constructor may not be null"); - - new VfcManager(this, request, SOME_URL, null, null); - - new VfcManager(this, request, SOME_URL, DOROTHY, "Toto"); - } - - @Test - public void testVfcExecutionException() throws InterruptedException { - VfcManager manager = new VfcManager(this, request, SOME_URL, DOROTHY, "Exception"); - manager.setRestManager(mockedRestManager); - - when(mockedRestManager.post( - startsWith(SOME_URL), - eq(DOROTHY), - eq("Exception"), - anyMap(), - anyString(), - anyString())) - .thenThrow(new RuntimeException("OzException")); - - manager.run(); - - verify(mockedRestManager).post(any(), any(), any(), any(), any(), any()); - } - - @Test - public void testVfcExecutionNull() throws InterruptedException { - VfcManager manager = new VfcManager(this, request, SOME_URL, DOROTHY, "Null"); - manager.setRestManager(mockedRestManager); - - when(mockedRestManager.post(startsWith(SOME_URL), - eq(DOROTHY), eq("Null"), anyMap(), anyString(), anyString())) - .thenReturn(null); - - manager.run(); - - verify(mockedRestManager).post(any(), any(), any(), any(), any(), any()); - } - - @Test - public void testVfcExecutionError0() throws InterruptedException { - VfcManager manager = new VfcManager(this, request, SOME_URL, DOROTHY, "Error0"); - manager.setRestManager(mockedRestManager); - - when(mockedRestManager.post(startsWith(SOME_URL), - eq(DOROTHY), eq("Error0"), anyMap(), anyString(), anyString())) - .thenReturn(httpResponseErr); - - manager.run(); - - verify(mockedRestManager).post(any(), any(), any(), any(), any(), any()); - } - - @Test - public void testVfcExecutionBadResponse() throws InterruptedException { - VfcManager manager = new VfcManager(this, request, SOME_URL, DOROTHY, "BadResponse"); - manager.setRestManager(mockedRestManager); - - when(mockedRestManager.post(startsWith(SOME_URL), - eq(DOROTHY), eq("OK"), anyMap(), anyString(), anyString())) - .thenReturn(httpResponseBadResponse); - - manager.run(); - - verify(mockedRestManager).post(any(), any(), any(), any(), any(), any()); - } - - @Test - public void testVfcExecutionOk() throws InterruptedException { - VfcManager manager = new VfcManager(this, request, SOME_URL, DOROTHY, "Ok"); - manager.setRestManager(mockedRestManager); - - when(mockedRestManager.post(startsWith(SOME_URL), - eq(DOROTHY), eq("OK"), anyMap(), anyString(), anyString())) - .thenReturn(httpResponsePutOk); - - manager.run(); - - verify(mockedRestManager).post(any(), any(), any(), any(), any(), any()); - } - - @Override - public void onResponse(VfcResponse responseError) { - // - // Nothing needs to be done - // - } -} |