From 43cf828fcc152ad830222377bb61fb8a51a177fd Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Tue, 18 Feb 2020 12:26:34 -0500 Subject: APPC Actor Issue-ID: POLICY-2363 Signed-off-by: Jim Hahn Change-Id: I21908c9875aa1d2ad3678cb7613b5a3e1fada340 --- .../actor/appc/AppcActorServiceProvider.java | 4 + .../controlloop/actor/appc/AppcOperation.java | 166 ++++++++++++++++++ .../actor/appc/ModifyConfigOperation.java | 75 ++++++++ .../controlloop/actor/appc/AppcOperationTest.java | 195 +++++++++++++++++++++ .../actor/appc/AppcServiceProviderTest.java | 14 +- .../controlloop/actor/appc/BasicAppcOperation.java | 191 ++++++++++++++++++++ .../actor/appc/ModifyConfigOperationTest.java | 105 +++++++++++ 7 files changed, 749 insertions(+), 1 deletion(-) create mode 100644 models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcOperation.java create mode 100644 models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/ModifyConfigOperation.java create mode 100644 models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcOperationTest.java create mode 100644 models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/BasicAppcOperation.java create mode 100644 models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/ModifyConfigOperationTest.java diff --git a/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcActorServiceProvider.java b/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcActorServiceProvider.java index 2491c33a1..1ec46899f 100644 --- a/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcActorServiceProvider.java +++ b/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcActorServiceProvider.java @@ -34,6 +34,7 @@ import org.onap.policy.common.utils.coder.StandardCoder; import org.onap.policy.controlloop.ControlLoopOperation; import org.onap.policy.controlloop.VirtualControlLoopEvent; import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicActor; +import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator; import org.onap.policy.controlloop.policy.Policy; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -74,6 +75,9 @@ public class AppcActorServiceProvider extends BidirectionalTopicActor { */ public AppcActorServiceProvider() { super(NAME); + + addOperator(BidirectionalTopicOperator.makeOperator(NAME, ModifyConfigOperation.NAME, this, + AppcOperation.SELECTOR_KEYS, ModifyConfigOperation::new)); } diff --git a/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcOperation.java b/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcOperation.java new file mode 100644 index 000000000..8bc1a7f32 --- /dev/null +++ b/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/AppcOperation.java @@ -0,0 +1,166 @@ +/*- + * ============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.appc; + +import java.util.List; +import java.util.Map; +import java.util.Map.Entry; +import java.util.UUID; +import org.onap.policy.appc.CommonHeader; +import org.onap.policy.appc.Request; +import org.onap.policy.appc.Response; +import org.onap.policy.appc.ResponseCode; +import org.onap.policy.common.utils.coder.CoderException; +import org.onap.policy.common.utils.coder.StandardCoder; +import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; +import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation; +import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey; +import org.onap.policy.controlloop.policy.PolicyResult; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * Superclass for APPC Operations. + */ +public abstract class AppcOperation extends BidirectionalTopicOperation { + private static final Logger logger = LoggerFactory.getLogger(AppcOperation.class); + private static final StandardCoder coder = new StandardCoder(); + public static final String VNF_ID_KEY = "generic-vnf.vnf-id"; + + /** + * Keys used to match the response with the request listener. The sub request ID is a + * UUID, so it can be used to uniquely identify the response. + *

+ * Note: if these change, then {@link #getExpectedKeyValues(int, Request)} must be + * updated accordingly. + */ + public static final List SELECTOR_KEYS = List.of(new SelectorKey("CommonHeader", "SubRequestID")); + + /** + * Constructs the object. + * + * @param params operation parameters + * @param operator operator that created this operation + */ + public AppcOperation(ControlLoopOperationParams params, BidirectionalTopicOperator operator) { + super(params, operator, Response.class); + } + + /** + * Makes a request, given the target VNF. This is a support function for + * {@link #makeRequest(int)}. + * + * @param attempt attempt number + * @param targetVnf target VNF + * @return a new request + */ + protected Request makeRequest(int attempt, String targetVnf) { + Request request = new Request(); + request.setCommonHeader(new CommonHeader()); + request.getCommonHeader().setRequestId(params.getRequestId()); + + // TODO ok to use UUID, or does it have to be the "attempt"? + request.getCommonHeader().setSubRequestId(UUID.randomUUID().toString()); + + request.setAction(getName()); + + // convert payload strings to objects + if (params.getPayload() == null) { + logger.info("{}: no payload specified for {}", getFullName(), params.getRequestId()); + } else { + convertPayload(params.getPayload(), request.getPayload()); + } + + // add/replace specific values + request.getPayload().put(VNF_ID_KEY, targetVnf); + + return request; + } + + /** + * Converts a payload. The original value is assumed to be a JSON string, which is + * decoded into an object. + * + * @param source source from which to get the values + * @param target where to place the decoded values + */ + private static void convertPayload(Map source, Map target) { + for (Entry ent : source.entrySet()) { + try { + target.put(ent.getKey(), coder.decode(ent.getValue(), Object.class)); + + } catch (CoderException e) { + logger.warn("cannot decode JSON value {}: {}", ent.getKey(), ent.getValue(), e); + } + } + } + + /** + * Note: these values must match {@link #SELECTOR_KEYS}. + */ + @Override + protected List getExpectedKeyValues(int attempt, Request request) { + return List.of(request.getCommonHeader().getSubRequestId()); + } + + @Override + protected Status detmStatus(String rawResponse, Response response) { + if (response.getStatus() == null) { + throw new IllegalArgumentException("APP-C response is missing the response status"); + } + + ResponseCode code = ResponseCode.toResponseCode(response.getStatus().getCode()); + if (code == null) { + throw new IllegalArgumentException( + "unknown APPC-C response status code: " + response.getStatus().getCode()); + } + + switch (code) { + case SUCCESS: + return Status.SUCCESS; + case FAILURE: + return Status.FAILURE; + case ERROR: + case REJECT: + throw new IllegalArgumentException("APP-C request was not accepted, code=" + code); + case ACCEPT: + default: + // awaiting a "final" response + return Status.STILL_WAITING; + } + } + + /** + * Sets the message to the status description, if available. + */ + @Override + public OperationOutcome setOutcome(OperationOutcome outcome, PolicyResult result, Response response) { + if (response.getStatus() == null || response.getStatus().getDescription() == null) { + return setOutcome(outcome, result); + } + + outcome.setResult(result); + outcome.setMessage(response.getStatus().getDescription()); + return outcome; + } +} diff --git a/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/ModifyConfigOperation.java b/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/ModifyConfigOperation.java new file mode 100644 index 000000000..5839df58e --- /dev/null +++ b/models-interactions/model-actors/actor.appc/src/main/java/org/onap/policy/controlloop/actor/appc/ModifyConfigOperation.java @@ -0,0 +1,75 @@ +/*- + * ============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.appc; + +import java.util.concurrent.CompletableFuture; +import org.onap.aai.domain.yang.GenericVnf; +import org.onap.policy.aai.AaiConstants; +import org.onap.policy.aai.AaiCqResponse; +import org.onap.policy.appc.Request; +import org.onap.policy.controlloop.actor.aai.AaiCustomQueryOperation; +import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; +import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class ModifyConfigOperation extends AppcOperation { + private static final Logger logger = LoggerFactory.getLogger(ModifyConfigOperation.class); + + public static final String NAME = "ModifyConfig"; + + /** + * Constructs the object. + * + * @param params operation parameters + * @param operator operator that created this operation + */ + public ModifyConfigOperation(ControlLoopOperationParams params, BidirectionalTopicOperator operator) { + super(params, operator); + } + + /** + * Ensures that A&AI customer query has been performed, and then runs the guard query. + */ + @Override + @SuppressWarnings("unchecked") + protected CompletableFuture startPreprocessorAsync() { + ControlLoopOperationParams cqParams = params.toBuilder().actor(AaiConstants.ACTOR_NAME) + .operation(AaiCustomQueryOperation.NAME).payload(null).retry(null).timeoutSec(null).build(); + + // run Custom Query and Guard, in parallel + return allOf(() -> params.getContext().obtain(AaiCqResponse.CONTEXT_KEY, cqParams), this::startGuardAsync); + } + + @Override + protected Request makeRequest(int attempt) { + AaiCqResponse cq = params.getContext().getProperty(AaiCqResponse.CONTEXT_KEY); + + GenericVnf genvnf = cq.getGenericVnfByModelInvariantId(params.getTarget().getResourceID()); + if (genvnf == null) { + logger.info("{}: target entity could not be found for {}", getFullName(), params.getRequestId()); + throw new IllegalArgumentException("target vnf-id could not be found"); + } + + return makeRequest(attempt, genvnf.getVnfId()); + } +} diff --git a/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcOperationTest.java b/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcOperationTest.java new file mode 100644 index 000000000..8a86b346c --- /dev/null +++ b/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcOperationTest.java @@ -0,0 +1,195 @@ +/*- + * ============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.appc; + +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotEquals; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertSame; + +import java.util.Arrays; +import java.util.Map; +import java.util.TreeMap; +import org.junit.Before; +import org.junit.Test; +import org.onap.policy.appc.CommonHeader; +import org.onap.policy.appc.Request; +import org.onap.policy.appc.ResponseCode; +import org.onap.policy.appc.ResponseStatus; +import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation.Status; +import org.onap.policy.controlloop.policy.PolicyResult; + +public class AppcOperationTest extends BasicAppcOperation { + private AppcOperation oper; + + /** + * Sets up. + */ + @Before + public void setUp() throws Exception { + super.setUp(); + + oper = new AppcOperation(params, operator) { + @Override + protected Request makeRequest(int attempt) { + return oper.makeRequest(attempt, MY_VNF); + } + }; + } + + @Test + public void testAppcOperation() { + assertEquals(DEFAULT_ACTOR, oper.getActorName()); + assertEquals(DEFAULT_OPERATION, oper.getName()); + } + + @Test + public void testMakeRequest() { + Request request = oper.makeRequest(2, MY_VNF); + assertEquals(DEFAULT_OPERATION, request.getAction()); + + assertNotNull(request.getPayload()); + + CommonHeader header = request.getCommonHeader(); + assertNotNull(header); + assertEquals(params.getRequestId(), header.getRequestId()); + + String subreq = header.getSubRequestId(); + assertNotNull(subreq); + + // a subsequent request should have a different sub-request id + assertNotEquals(subreq, oper.makeRequest(2, MY_VNF).getCommonHeader().getSubRequestId()); + + // repeat using a null payload + params = params.toBuilder().payload(null).build(); + oper = new AppcOperation(params, operator) { + @Override + protected Request makeRequest(int attempt) { + return oper.makeRequest(attempt, MY_VNF); + } + }; + assertEquals(Map.of(AppcOperation.VNF_ID_KEY, MY_VNF), oper.makeRequest(2, MY_VNF).getPayload()); + } + + @Test + public void testConvertPayload() { + Request request = oper.makeRequest(2, MY_VNF); + + // @formatter:off + assertEquals( + Map.of(AppcOperation.VNF_ID_KEY, MY_VNF, + KEY1, Map.of("input", "hello"), + KEY2, Map.of("output", "world")), + request.getPayload()); + // @formatter:on + + + /* + * insert invalid json text into the payload. + */ + Map payload = new TreeMap<>(params.getPayload()); + payload.put("invalid-key", "{invalid json"); + + params = params.toBuilder().payload(payload).build(); + + oper = new AppcOperation(params, operator) { + @Override + protected Request makeRequest(int attempt) { + return oper.makeRequest(attempt, MY_VNF); + } + }; + request = oper.makeRequest(2, MY_VNF); + + // @formatter:off + assertEquals( + Map.of(AppcOperation.VNF_ID_KEY, MY_VNF, + KEY1, Map.of("input", "hello"), + KEY2, Map.of("output", "world")), + request.getPayload()); + // @formatter:on + } + + @Test + public void testGetExpectedKeyValues() { + Request request = oper.makeRequest(2, MY_VNF); + assertEquals(Arrays.asList(request.getCommonHeader().getSubRequestId()), + oper.getExpectedKeyValues(50, request)); + } + + @Test + public void testDetmStatusStringResponse() { + final ResponseStatus status = response.getStatus(); + + // null status + response.setStatus(null); + assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response)) + .withMessage("APP-C response is missing the response status"); + response.setStatus(status); + + // invalid code + status.setCode(-45); + assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response)) + .withMessage("unknown APPC-C response status code: -45"); + + status.setCode(ResponseCode.SUCCESS.getValue()); + assertEquals(Status.SUCCESS, oper.detmStatus("", response)); + + status.setCode(ResponseCode.FAILURE.getValue()); + assertEquals(Status.FAILURE, oper.detmStatus("", response)); + + status.setCode(ResponseCode.ERROR.getValue()); + assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response)) + .withMessage("APP-C request was not accepted, code=" + ResponseCode.ERROR.getValue()); + + status.setCode(ResponseCode.REJECT.getValue()); + assertThatIllegalArgumentException().isThrownBy(() -> oper.detmStatus("", response)) + .withMessage("APP-C request was not accepted, code=" + ResponseCode.REJECT.getValue()); + + status.setCode(ResponseCode.ACCEPT.getValue()); + assertEquals(Status.STILL_WAITING, oper.detmStatus("", response)); + } + + @Test + public void testSetOutcome() { + final ResponseStatus status = response.getStatus(); + + // null status + response.setStatus(null); + assertSame(outcome, oper.setOutcome(outcome, PolicyResult.SUCCESS, response)); + assertEquals(PolicyResult.SUCCESS, outcome.getResult()); + assertNotNull(outcome.getMessage()); + response.setStatus(status); + + // null description + status.setDescription(null); + assertSame(outcome, oper.setOutcome(outcome, PolicyResult.FAILURE, response)); + assertEquals(PolicyResult.FAILURE, outcome.getResult()); + assertNotNull(outcome.getMessage()); + status.setDescription(MY_DESCRIPTION); + + for (PolicyResult result : PolicyResult.values()) { + assertSame(outcome, oper.setOutcome(outcome, result, response)); + assertEquals(result, outcome.getResult()); + assertEquals(MY_DESCRIPTION, outcome.getMessage()); + } + } +} diff --git a/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcServiceProviderTest.java b/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcServiceProviderTest.java index 0dfea32d6..305c6d7cd 100644 --- a/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcServiceProviderTest.java +++ b/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/AppcServiceProviderTest.java @@ -27,9 +27,10 @@ import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; import java.time.Instant; +import java.util.Arrays; import java.util.HashMap; import java.util.UUID; - +import java.util.stream.Collectors; import org.junit.AfterClass; import org.junit.BeforeClass; import org.junit.Test; @@ -127,6 +128,17 @@ public class AppcServiceProviderTest { HttpServletServerFactoryInstance.getServerFactory().destroy(); } + @Test + public void testConstructor() { + AppcActorServiceProvider prov = new AppcActorServiceProvider(); + + // verify that it has the operators we expect + var expected = Arrays.asList(ModifyConfigOperation.NAME).stream().sorted().collect(Collectors.toList()); + var actual = prov.getOperationNames().stream().sorted().collect(Collectors.toList()); + + assertEquals(expected.toString(), actual.toString()); + } + @Test public void testConstructModifyConfigRequest() { policy.setPayload(new HashMap<>()); diff --git a/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/BasicAppcOperation.java b/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/BasicAppcOperation.java new file mode 100644 index 000000000..cbdcad6b0 --- /dev/null +++ b/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/BasicAppcOperation.java @@ -0,0 +1,191 @@ +/*- + * ============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.appc; + +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.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.verify; + +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ExecutionException; +import java.util.concurrent.TimeoutException; +import java.util.function.BiConsumer; +import java.util.function.BiFunction; +import org.onap.policy.appc.Response; +import org.onap.policy.appc.ResponseCode; +import org.onap.policy.appc.ResponseStatus; +import org.onap.policy.common.utils.coder.CoderException; +import org.onap.policy.common.utils.coder.StandardCoder; +import org.onap.policy.common.utils.coder.StandardCoderObject; +import org.onap.policy.common.utils.resources.ResourceUtils; +import org.onap.policy.controlloop.actor.test.BasicBidirectionalTopicOperation; +import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; +import org.onap.policy.controlloop.actorserviceprovider.Util; +import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.policy.PolicyResult; +import org.onap.policy.controlloop.policy.Target; +import org.powermock.reflect.Whitebox; + +/** + * Superclass for various operator tests. + */ +public abstract class BasicAppcOperation extends BasicBidirectionalTopicOperation { + protected static final String MY_DESCRIPTION = "my-description"; + protected static final String MY_VNF = "my-vnf"; + protected static final String KEY1 = "my-key-A"; + protected static final String KEY2 = "my-key-B"; + protected static final String VALUE1 = "{\"input\":\"hello\"}"; + protected static final String VALUE2 = "{\"output\":\"world\"}"; + protected static final String RESOURCE_ID = "my-resource"; + + protected Response response; + + /** + * Constructs the object using a default actor and operation name. + */ + public BasicAppcOperation() { + super(); + } + + /** + * Constructs the object. + * + * @param actor actor name + * @param operation operation name + */ + public BasicAppcOperation(String actor, String operation) { + super(actor, operation); + } + + /** + * Initializes mocks and sets up. + */ + public void setUp() throws Exception { + super.setUp(); + + response = new Response(); + + ResponseStatus status = new ResponseStatus(); + response.setStatus(status); + status.setCode(ResponseCode.SUCCESS.getValue()); + status.setDescription(MY_DESCRIPTION); + } + + /** + * Runs the operation and verifies that the response is successful. + * + * @param operation operation to run + */ + protected void verifyOperation(AppcOperation operation) + throws InterruptedException, ExecutionException, TimeoutException { + + CompletableFuture future2 = operation.start(); + executor.runAll(100); + assertFalse(future2.isDone()); + + verify(forwarder).register(any(), listenerCaptor.capture()); + provideResponse(listenerCaptor.getValue(), ResponseCode.SUCCESS.getValue(), MY_DESCRIPTION); + + executor.runAll(100); + assertTrue(future2.isDone()); + + outcome = future2.get(); + assertEquals(PolicyResult.SUCCESS, outcome.getResult()); + assertEquals(MY_DESCRIPTION, outcome.getMessage()); + } + + /** + * Pretty-prints a request and verifies that the result matches the expected JSON. + * + * @param request type + * @param expectedJsonFile name of the file containing the expected JSON + * @param request request to verify + * @throws CoderException if the request cannot be pretty-printed + */ + protected void verifyRequest(String expectedJsonFile, T request) throws CoderException { + String json = new StandardCoder().encode(request, true); + String expected = ResourceUtils.getResourceAsString(expectedJsonFile); + + // strip request id, because it changes each time + final String stripper = "svc-request-id[^,]*"; + json = json.replaceFirst(stripper, "").trim(); + expected = expected.replaceFirst(stripper, "").trim(); + + assertEquals(expected, json); + } + + /** + * Verifies that an exception is thrown if a field is missing from the enrichment + * data. + * + * @param fieldName name of the field to be removed from the enrichment data + * @param expectedText text expected in the exception message + */ + protected void verifyMissing(String fieldName, String expectedText, + BiFunction maker) { + + makeContext(); + enrichment.remove(fieldName); + + AppcOperation oper = maker.apply(params, operator); + + assertThatIllegalArgumentException().isThrownBy(() -> Whitebox.invokeMethod(oper, "makeRequest", 1)) + .withMessageContaining("missing").withMessageContaining(expectedText); + } + + @Override + protected void makeContext() { + super.makeContext(); + + Target target = new Target(); + target.setResourceID(RESOURCE_ID); + + params = params.toBuilder().target(target).build(); + } + + /** + * Provides a response to the listener. + * + * @param listener listener to which to provide the response + * @param code response code + * @param description response description + */ + protected void provideResponse(BiConsumer listener, int code, String description) { + Response response = new Response(); + + ResponseStatus status = new ResponseStatus(); + response.setStatus(status); + status.setCode(code); + status.setDescription(description); + + provideResponse(listener, Util.translate("", response, String.class)); + } + + @Override + protected Map makePayload() { + return Map.of(KEY1, VALUE1, KEY2, VALUE2); + } +} diff --git a/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/ModifyConfigOperationTest.java b/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/ModifyConfigOperationTest.java new file mode 100644 index 000000000..f7c88f67c --- /dev/null +++ b/models-interactions/model-actors/actor.appc/src/test/java/org/onap/policy/controlloop/actor/appc/ModifyConfigOperationTest.java @@ -0,0 +1,105 @@ +/*- + * ============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.appc; + +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.assertSame; +import static org.junit.Assert.assertTrue; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.ArgumentMatchers.eq; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import java.util.Arrays; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.atomic.AtomicBoolean; +import org.junit.Before; +import org.junit.Test; +import org.onap.aai.domain.yang.GenericVnf; +import org.onap.policy.aai.AaiCqResponse; +import org.onap.policy.appc.Request; +import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; +import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext; + +public class ModifyConfigOperationTest extends BasicAppcOperation { + + private ModifyConfigOperation oper; + + public ModifyConfigOperationTest() { + super(DEFAULT_ACTOR, ModifyConfigOperation.NAME); + } + + @Before + public void setUp() throws Exception { + super.setUp(); + oper = new ModifyConfigOperation(params, operator); + } + + @Test + public void testModifyConfigOperation() { + assertEquals(DEFAULT_ACTOR, oper.getActorName()); + assertEquals(ModifyConfigOperation.NAME, oper.getName()); + } + + @Test + public void testStartPreprocessorAsync() { + CompletableFuture future = new CompletableFuture<>(); + context = mock(ControlLoopEventContext.class); + when(context.obtain(eq(AaiCqResponse.CONTEXT_KEY), any())).thenReturn(future); + params = params.toBuilder().context(context).build(); + + AtomicBoolean guardStarted = new AtomicBoolean(); + + oper = new ModifyConfigOperation(params, operator) { + @Override + protected CompletableFuture startGuardAsync() { + guardStarted.set(true); + return super.startGuardAsync(); + } + }; + + assertSame(future, oper.startPreprocessorAsync()); + assertFalse(future.isDone()); + assertTrue(guardStarted.get()); + } + + @Test + public void testMakeRequest() { + AaiCqResponse cq = new AaiCqResponse("{}"); + + // missing vnf-id + params.getContext().setProperty(AaiCqResponse.CONTEXT_KEY, cq); + assertThatIllegalArgumentException().isThrownBy(() -> oper.makeRequest(1)); + + // populate the CQ data with a vnf-id + GenericVnf genvnf = new GenericVnf(); + genvnf.setVnfId(MY_VNF); + genvnf.setModelInvariantId(RESOURCE_ID); + cq.setInventoryResponseItems(Arrays.asList(genvnf)); + + Request request = oper.makeRequest(2); + assertNotNull(request); + assertEquals(MY_VNF, request.getPayload().get(ModifyConfigOperation.VNF_ID_KEY)); + } +} -- cgit 1.2.3-korg