/*- * ============LICENSE_START======================================================= * ONAP * ================================================================================ * Copyright (C) 2020 AT&T Intellectual Property. 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.controlloop.actor.so; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertSame; import static org.junit.Assert.assertTrue; import static org.mockito.ArgumentMatchers.any; import static org.mockito.Mockito.mock; import static org.mockito.Mockito.never; import static org.mockito.Mockito.verify; import static org.mockito.Mockito.when; import java.net.http.HttpHeaders; import java.net.http.HttpRequest; import java.net.http.HttpRequest.Builder; import java.net.http.HttpResponse; import java.net.http.HttpResponse.BodyHandlers; import java.nio.charset.StandardCharsets; import java.util.Base64; import java.util.List; import java.util.Map; import java.util.concurrent.CompletableFuture; import java.util.concurrent.ForkJoinPool; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicBoolean; import javax.ws.rs.client.InvocationCallback; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; import org.apache.commons.lang3.tuple.Pair; import org.junit.AfterClass; import org.junit.Before; import org.junit.BeforeClass; import org.junit.Test; import org.mockito.ArgumentCaptor; import org.mockito.Mock; import org.onap.aai.domain.yang.CloudRegion; import org.onap.aai.domain.yang.GenericVnf; import org.onap.aai.domain.yang.ModelVer; import org.onap.aai.domain.yang.ServiceInstance; import org.onap.aai.domain.yang.Tenant; import org.onap.policy.aai.AaiCqResponse; import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; import org.onap.policy.common.utils.coder.CoderException; import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; import org.onap.policy.controlloop.actorserviceprovider.OperationProperties; import org.onap.policy.controlloop.actorserviceprovider.OperationResult; import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams; import org.onap.policy.so.SoRequest; import org.onap.policy.so.SoResponse; public class VfModuleDeleteTest extends BasicSoOperation { private static final String EXPECTED_EXCEPTION = "expected exception"; private static final String MODEL_NAME2 = "my-model-name-B"; private static final String MODEL_VERS2 = "my-model-version-B"; private static final String SVC_INSTANCE_ID = "my-service-instance-id"; private static final String VNF_ID = "my-vnf-id"; @Mock private java.net.http.HttpClient javaClient; @Mock private HttpResponse javaResp; @Mock private InvocationCallback callback; private CompletableFuture> javaFuture; private VfModuleDelete oper; public VfModuleDeleteTest() { super(DEFAULT_ACTOR, VfModuleDelete.NAME); } @BeforeClass public static void setUpBeforeClass() throws Exception { initBeforeClass(); } @AfterClass public static void tearDownAfterClass() { destroyAfterClass(); } /** * Sets up. */ @Override @Before public void setUp() throws Exception { super.setUp(); initHostPort(); configureResponse(coder.encode(response)); oper = new MyOperation(params, config); } /** * Tests "success" case with simulator. */ @Test public void testSuccess() throws Exception { HttpPollingParams opParams = HttpPollingParams.builder().clientName(MY_CLIENT).path("serviceInstances/v7") .pollPath("orchestrationRequests/v5/").maxPolls(2).build(); config = new HttpPollingConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build(); oper = new VfModuleDelete(params, config); outcome = oper.start().get(); assertEquals(OperationResult.SUCCESS, outcome.getResult()); assertTrue(outcome.getResponse() instanceof SoResponse); } /** * Tests "success" case with simulator, using properties instead of custom query data. */ @Test public void testSuccessViaProperties() throws Exception { HttpPollingParams opParams = HttpPollingParams.builder().clientName(MY_CLIENT).path("serviceInstances/v7") .pollPath("orchestrationRequests/v5/").maxPolls(2).build(); config = new HttpPollingConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).preprocessed(true).build(); params.getContext().removeProperty(AaiCqResponse.CONTEXT_KEY); oper = new VfModuleDelete(params, config); // set the properties ServiceInstance instance = new ServiceInstance(); instance.setServiceInstanceId(SVC_INSTANCE_ID); oper.setProperty(OperationProperties.AAI_SERVICE, instance); GenericVnf vnf = new GenericVnf(); vnf.setVnfId(VNF_ID); oper.setProperty(OperationProperties.AAI_VNF, vnf); oper.setProperty(OperationProperties.AAI_DEFAULT_CLOUD_REGION, new CloudRegion()); oper.setProperty(OperationProperties.AAI_DEFAULT_TENANT, new Tenant()); oper.setProperty(OperationProperties.DATA_VF_COUNT, VF_COUNT); // run the operation outcome = oper.start().get(); assertEquals(OperationResult.SUCCESS, outcome.getResult()); assertTrue(outcome.getResponse() instanceof SoResponse); int count = oper.getProperty(OperationProperties.DATA_VF_COUNT); assertEquals(VF_COUNT - 1, count); } @Test public void testConstructor() { assertEquals(DEFAULT_ACTOR, oper.getActorName()); assertEquals(VfModuleDelete.NAME, oper.getName()); // verify that target validation is done params = params.toBuilder().targetType(null).build(); assertThatIllegalArgumentException().isThrownBy(() -> new MyOperation(params, config)) .withMessageContaining("Target information"); } @Test public void testGetPropertyNames() { // @formatter:off assertThat(oper.getPropertyNames()).isEqualTo( List.of( OperationProperties.AAI_SERVICE, OperationProperties.AAI_VNF, OperationProperties.AAI_DEFAULT_CLOUD_REGION, OperationProperties.AAI_DEFAULT_TENANT, OperationProperties.DATA_VF_COUNT)); // @formatter:on } @Test public void testStartPreprocessorAsync() throws Exception { // insert CQ data so it's there for the check context.setProperty(AaiCqResponse.CONTEXT_KEY, makeCqResponse()); AtomicBoolean guardStarted = new AtomicBoolean(); oper = new MyOperation(params, config) { @Override protected CompletableFuture startGuardAsync() { guardStarted.set(true); return super.startGuardAsync(); } }; CompletableFuture future3 = oper.startPreprocessorAsync(); assertNotNull(future3); assertTrue(guardStarted.get()); } /** * Tests startPreprocessorAsync(), when preprocessing is disabled. */ @Test public void testStartPreprocessorAsyncDisabled() { params = params.toBuilder().preprocessed(true).build(); assertNull(new MyOperation(params, config).startPreprocessorAsync()); } @Test public void testStartGuardAsync() throws Exception { // remove CQ data so it's forced to query context.removeProperty(AaiCqResponse.CONTEXT_KEY); CompletableFuture future2 = oper.startPreprocessorAsync(); assertTrue(executor.runAll(100)); assertFalse(future2.isDone()); provideCqResponse(makeCqResponse()); assertTrue(executor.runAll(100)); assertTrue(future2.isDone()); assertEquals(OperationResult.SUCCESS, future2.get().getResult()); } @Test public void testMakeGuardPayload() { final int origCount = 30; oper.setVfCount(origCount); CompletableFuture future2 = oper.startPreprocessorAsync(); assertTrue(executor.runAll(100)); assertTrue(future2.isDone()); // get the payload from the request ArgumentCaptor captor = ArgumentCaptor.forClass(ControlLoopOperationParams.class); verify(guardOperator).buildOperation(captor.capture()); Map payload = captor.getValue().getPayload(); assertNotNull(payload); Integer newCount = (Integer) payload.get(VfModuleDelete.PAYLOAD_KEY_VF_COUNT); assertNotNull(newCount); assertEquals(origCount - 1, newCount.intValue()); } @Test public void testStartOperationAsync_testSuccessfulCompletion() throws Exception { final int origCount = 30; oper.setVfCount(origCount); // use a real executor params = params.toBuilder().executor(ForkJoinPool.commonPool()).build(); oper = new MyOperation(params, config) { @Override public long getPollWaitMs() { return 1; } }; CompletableFuture future2 = oper.start(); outcome = future2.get(5, TimeUnit.SECONDS); assertEquals(OperationResult.SUCCESS, outcome.getResult()); SoResponse resp = outcome.getResponse(); assertNotNull(resp); assertEquals(REQ_ID.toString(), resp.getRequestReferences().getRequestId()); assertEquals(origCount - 1, oper.getVfCount()); } /** * Tests startOperationAsync() when polling is required. */ @Test public void testStartOperationAsyncWithPolling() throws Exception { // indicate that the response was incomplete configureResponse(coder.encode(response).replace("COMPLETE", "incomplete")); when(rawResponse.getStatus()).thenReturn(500, 500, 500, 200, 200); when(client.get(any(), any(), any())).thenAnswer(provideResponse(rawResponse)); // use a real executor params = params.toBuilder().executor(ForkJoinPool.commonPool()).build(); oper = new MyOperation(params, config) { @Override public long getPollWaitMs() { return 1; } }; CompletableFuture future2 = oper.start(); outcome = future2.get(5, TimeUnit.SECONDS); assertEquals(OperationResult.SUCCESS, outcome.getResult()); } @Test public void testMakeRequest() throws CoderException { Pair pair = oper.makeRequest(); assertEquals("/my-service-instance-id/vnfs/my-vnf-id/vfModules/null", pair.getLeft()); verifyRequest("VfModuleDelete.json", pair.getRight()); } @Test public void testDelete() throws Exception { SoRequest req = new SoRequest(); req.setRequestId(REQ_ID); Map headers = Map.of("key-A", "value-A"); String reqText = oper.prettyPrint(req); final CompletableFuture delFuture = oper.delete("my-uri", headers, MediaType.APPLICATION_JSON, reqText, callback); ArgumentCaptor reqCaptor = ArgumentCaptor.forClass(HttpRequest.class); verify(javaClient).sendAsync(reqCaptor.capture(), any()); HttpRequest req2 = reqCaptor.getValue(); assertEquals("http://my-host:6969/my-uri", req2.uri().toString()); assertEquals("DELETE", req2.method()); HttpHeaders headers2 = req2.headers(); assertEquals("value-A", headers2.firstValue("key-A").orElse("missing-key")); assertEquals(MediaType.APPLICATION_JSON, headers2.firstValue("Content-type").orElse("missing-key")); assertTrue(delFuture.isDone()); Response resp = delFuture.get(); verify(callback).completed(resp); assertEquals(200, resp.getStatus()); SoResponse resp2 = resp.readEntity(SoResponse.class); assertEquals(SoOperation.COMPLETE, resp2.getRequest().getRequestStatus().getRequestState()); } /** * Tests delete() when an exception is thrown in the future. */ @Test @SuppressWarnings("unchecked") public void testDeleteException() throws Exception { Throwable thrown = new IllegalStateException(EXPECTED_EXCEPTION); // need a new future, with an exception javaFuture = CompletableFuture.failedFuture(thrown); when(javaClient.sendAsync(any(), any(BodyHandlers.ofString().getClass()))).thenReturn(javaFuture); SoRequest req = new SoRequest(); req.setRequestId(REQ_ID); String reqText = oper.prettyPrint(req); CompletableFuture delFuture = oper.delete("/my-uri", Map.of(), MediaType.APPLICATION_JSON, reqText, callback); assertTrue(delFuture.isCompletedExceptionally()); ArgumentCaptor thrownCaptor = ArgumentCaptor.forClass(Throwable.class); verify(callback).failed(thrownCaptor.capture()); assertSame(thrown, thrownCaptor.getValue().getCause()); } /** * Tests addAuthHeader() when there is a username, but no password. */ @Test public void testAddAuthHeader() { Builder builder = mock(Builder.class); when(client.getUserName()).thenReturn("the-user"); when(client.getPassword()).thenReturn("the-password"); oper.addAuthHeader(builder); ArgumentCaptor keyCaptor = ArgumentCaptor.forClass(String.class); ArgumentCaptor valueCaptor = ArgumentCaptor.forClass(String.class); verify(builder).header(keyCaptor.capture(), valueCaptor.capture()); assertEquals("Authorization", keyCaptor.getValue()); String encoded = Base64.getEncoder().encodeToString("the-user:the-password".getBytes(StandardCharsets.UTF_8)); assertEquals("Basic " + encoded, valueCaptor.getValue()); } /** * Tests addAuthHeader() when there is no username. */ @Test public void testAddAuthHeaderNoUser() { Builder builder = mock(Builder.class); when(client.getPassword()).thenReturn("world"); oper.addAuthHeader(builder); verify(builder, never()).header(any(), any()); // repeat with empty username when(client.getUserName()).thenReturn(""); oper.addAuthHeader(builder); verify(builder, never()).header(any(), any()); } /** * Tests addAuthHeader() when there is a username, but no password. */ @Test public void testAddAuthHeaderUserOnly() { Builder builder = mock(Builder.class); when(client.getUserName()).thenReturn("my-user"); oper.addAuthHeader(builder); ArgumentCaptor keyCaptor = ArgumentCaptor.forClass(String.class); ArgumentCaptor valueCaptor = ArgumentCaptor.forClass(String.class); verify(builder).header(keyCaptor.capture(), valueCaptor.capture()); assertEquals("Authorization", keyCaptor.getValue()); String encoded = Base64.getEncoder().encodeToString("my-user:".getBytes(StandardCharsets.UTF_8)); assertEquals("Basic " + encoded, valueCaptor.getValue()); } @Test public void testMakeHttpClient() { // must use a real operation to invoke this method assertNotNull(new MyOperation(params, config).makeHttpClient()); } @Override protected void makeContext() { super.makeContext(); AaiCqResponse cq = mock(AaiCqResponse.class); GenericVnf vnf = new GenericVnf(); when(cq.getGenericVnfByVfModuleModelInvariantId(MODEL_INVAR_ID)).thenReturn(vnf); vnf.setVnfId(VNF_ID); ServiceInstance instance = new ServiceInstance(); when(cq.getServiceInstance()).thenReturn(instance); instance.setServiceInstanceId(SVC_INSTANCE_ID); when(cq.getDefaultTenant()).thenReturn(new Tenant()); when(cq.getDefaultCloudRegion()).thenReturn(new CloudRegion()); ModelVer modelVers = new ModelVer(); when(cq.getModelVerByVersionId(any())).thenReturn(modelVers); modelVers.setModelName(MODEL_NAME2); modelVers.setModelVersion(MODEL_VERS2); params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, cq); } private void initHostPort() { when(client.getBaseUrl()).thenReturn("http://my-host:6969/"); } @SuppressWarnings("unchecked") private void configureResponse(String responseText) throws CoderException { // indicate that the response was completed when(javaResp.statusCode()).thenReturn(200); when(javaResp.body()).thenReturn(responseText); javaFuture = CompletableFuture.completedFuture(javaResp); when(javaClient.sendAsync(any(), any(BodyHandlers.ofString().getClass()))).thenReturn(javaFuture); } private class MyOperation extends VfModuleDelete { public MyOperation(ControlLoopOperationParams params, HttpPollingConfig config) { super(params, config); } @Override protected java.net.http.HttpClient makeHttpClient() { return javaClient; } } }