From 7ad8905da8be882fd2106861a030ff4ad470615f Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Tue, 25 Feb 2020 10:49:32 -0500 Subject: Add "disabled" property to Guard Actor Issue-ID: POLICY-2350 Signed-off-by: Jim Hahn Change-Id: I3e9c9aae474d4b288a162243bc492b301d1044c0 --- .../controlloop/actor/guard/GuardActorParams.java | 5 +++ .../controlloop/actor/guard/GuardConfig.java | 9 +++++ .../controlloop/actor/guard/GuardOperation.java | 4 +++ .../controlloop/actor/guard/GuardParams.java | 5 +++ .../actor/guard/GuardActorParamsTest.java | 6 ++++ .../controlloop/actor/guard/GuardConfigTest.java | 8 +++++ .../actor/guard/GuardOperationTest.java | 40 ++++++++++++++++++++-- .../controlloop/actor/guard/GuardParamsTest.java | 6 ++++ 8 files changed, 80 insertions(+), 3 deletions(-) diff --git a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardActorParams.java b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardActorParams.java index b8eb85c03..aa6d7273f 100644 --- a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardActorParams.java +++ b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardActorParams.java @@ -40,4 +40,9 @@ public class GuardActorParams extends HttpActorParams { private String onapComponent; private String onapInstance; private String action = DEFAULT_ACTION; + + /** + * {@code True} if guard operations are disabled. + */ + private boolean disabled = false; } diff --git a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardConfig.java b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardConfig.java index c6bf32635..0e711d1be 100644 --- a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardConfig.java +++ b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardConfig.java @@ -23,6 +23,7 @@ package org.onap.policy.controlloop.actor.guard; import java.util.LinkedHashMap; import java.util.Map; import java.util.concurrent.Executor; +import lombok.Getter; import org.onap.policy.common.endpoints.http.client.HttpClient; import org.onap.policy.common.endpoints.http.client.HttpClientFactory; import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; @@ -33,6 +34,12 @@ import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; public class GuardConfig extends HttpConfig { private final Map defaultRequest = new LinkedHashMap<>(); + /** + * {@code True} if the associated guard operation is disabled. + */ + @Getter + private boolean disabled; + /** * Constructs the object. * @@ -47,6 +54,8 @@ public class GuardConfig extends HttpConfig { addProperty("ONAPInstance", params.getOnapInstance()); addProperty("ONAPName", params.getOnapName()); addProperty("action", params.getAction()); + + this.disabled = params.isDisabled(); } /** diff --git a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperation.java b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperation.java index a5459f660..e35caa06c 100644 --- a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperation.java +++ b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperation.java @@ -84,6 +84,10 @@ public class GuardOperation extends HttpOperation { @Override protected CompletableFuture startOperationAsync(int attempt, OperationOutcome outcome) { + if (config.isDisabled()) { + // guard is disabled, thus it is always treated as a success + return CompletableFuture.completedFuture(params.makeOutcome()); + } DecisionRequest request = Util.translate(getName(), makeRequest(), DecisionRequest.class); diff --git a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardParams.java b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardParams.java index 251482525..5f8360377 100644 --- a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardParams.java +++ b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardParams.java @@ -41,4 +41,9 @@ public class GuardParams extends HttpParams { private String onapComponent; private String onapInstance; private String action; + + /** + * {@code True} if the associated guard operation is disabled. + */ + private boolean disabled; } diff --git a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardActorParamsTest.java b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardActorParamsTest.java index 1c256090e..0fef3bd29 100644 --- a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardActorParamsTest.java +++ b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardActorParamsTest.java @@ -64,6 +64,12 @@ public class GuardActorParamsTest { params = makeGuardActorParams(); } + @Test + public void testIsDisabled() { + // disabled by default + assertFalse(params.isDisabled()); + } + @Test public void testValidate() { assertTrue(params.validate(CONTAINER).isValid()); diff --git a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardConfigTest.java b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardConfigTest.java index f94d122d9..49c1c916a 100644 --- a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardConfigTest.java +++ b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardConfigTest.java @@ -21,7 +21,9 @@ package org.onap.policy.controlloop.actor.guard; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; import static org.junit.Assert.assertSame; +import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.when; import java.util.concurrent.Executor; @@ -85,8 +87,14 @@ public class GuardConfigTest { // repeat, with minimal parameters params = GuardParams.builder().clientName(MY_CLIENT).path(PATH).timeoutSec(TIMEOUT).build(); config = new GuardConfig(executor, params, factory); + assertFalse(config.isDisabled()); actual = Util.translate("", config.makeRequest(), DecisionRequest.class); assertEquals(new DecisionRequest(), actual); + + // try with disabled=true + params = params.toBuilder().disabled(true).build(); + config = new GuardConfig(executor, params, factory); + assertTrue(config.isDisabled()); } } diff --git a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperationTest.java b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperationTest.java index bd23a818b..a43292a65 100644 --- a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperationTest.java +++ b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperationTest.java @@ -26,14 +26,17 @@ import static org.junit.Assert.assertFalse; 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.util.Map; import java.util.TreeMap; import java.util.concurrent.CompletableFuture; +import java.util.function.Consumer; import org.junit.Before; import org.junit.Test; +import org.mockito.Mock; import org.onap.policy.common.utils.coder.CoderException; import org.onap.policy.controlloop.actor.test.BasicHttpOperation; import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; @@ -44,6 +47,12 @@ import org.onap.policy.models.decisions.concepts.DecisionResponse; public class GuardOperationTest extends BasicHttpOperation { + @Mock + private Consumer started; + @Mock + private Consumer completed; + + private GuardConfig guardConfig; private GuardOperation oper; /** @@ -53,12 +62,14 @@ public class GuardOperationTest extends BasicHttpOperation { public void setUp() throws Exception { super.setUpBasic(); - GuardConfig cguard = mock(GuardConfig.class); - when(cguard.makeRequest()).thenAnswer(args -> new TreeMap<>(Map.of("action", "guard"))); + guardConfig = mock(GuardConfig.class); + when(guardConfig.makeRequest()).thenAnswer(args -> new TreeMap<>(Map.of("action", "guard"))); - config = cguard; + config = guardConfig; initConfig(); + params = params.toBuilder().startCallback(started).completeCallback(completed).build(); + oper = new GuardOperation(params, config); } @@ -87,6 +98,29 @@ public class GuardOperationTest extends BasicHttpOperation { assertEquals(PolicyResult.SUCCESS, future2.get().getResult()); } + /** + * Tests startOperationAsync() when the guard is disabled. + */ + @Test + public void testStartOperationAsyncDisabled() throws Exception { + // indicate that it's disabled + when(guardConfig.isDisabled()).thenReturn(true); + + CompletableFuture future2 = oper.start(); + executor.runAll(100); + + verify(client, never()).post(any(), any(), any(), any()); + + // should already be done + assertTrue(future2.isDone()); + + assertEquals(PolicyResult.SUCCESS, future2.get().getResult()); + + // ensure callbacks were invoked + verify(started).accept(any()); + verify(completed).accept(any()); + } + @Test public void testMakeRequest() throws CoderException { verifyPayload("makeReqStd.json", makePayload()); diff --git a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardParamsTest.java b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardParamsTest.java index b4148857a..172368349 100644 --- a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardParamsTest.java +++ b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardParamsTest.java @@ -50,6 +50,12 @@ public class GuardParamsTest { .action(MY_ACTION).clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build(); } + @Test + public void testIsDisabled() { + // disabled by default + assertFalse(params.isDisabled()); + } + @Test public void testValidate() { assertTrue(params.validate(CONTAINER).isValid()); -- cgit 1.2.3-korg