Refactor GuardOperation

Extracted DecisionOperation superclass out of GuardOperation.

Issue-ID: POLICY-3502
Change-Id: Ice766e9c33756a5780726c75a0283f89c85cabad
Signed-off-by: Jim Hahn <jrh3@att.com>

4 files changed, 308 insertions, 115 deletions

diff --git a/models-interactions/model-actors/actor.xacml/src/main/java/org/onap/policy/controlloop/actor/xacml/DecisionOperation.java b/models-interactions/model-actors/actor.xacml/src/main/java/org/onap/policy/controlloop/actor/xacml/DecisionOperation.java
new file mode 100644
index 000000000..9fbb3e268
--- /dev/null
+++ b/models-interactions/model-actors/actor.xacml/src/main/java/org/onap/policy/controlloop/actor/xacml/DecisionOperation.java
@@ -0,0 +1,106 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020-2021 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.xacml;
+
+import java.util.List;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import javax.ws.rs.client.Entity;
+import javax.ws.rs.core.MediaType;
+import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
+import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
+import org.onap.policy.controlloop.actorserviceprovider.CallbackManager;
+import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
+import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
+import org.onap.policy.models.decisions.concepts.DecisionRequest;
+import org.onap.policy.models.decisions.concepts.DecisionResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Generic Decision Operation.
+ */
+public abstract class DecisionOperation extends HttpOperation<DecisionResponse> {
+    private static final Logger logger = LoggerFactory.getLogger(DecisionOperation.class);
+
+    protected final DecisionConfig config;
+
+
+    /**
+     * Constructs the object.
+     *
+     * @param params operation parameters
+     * @param config configuration for this operation
+     * @param propertyNames names of properties required by this operation
+     */
+    public DecisionOperation(ControlLoopOperationParams params, HttpConfig config,
+                    List<String> propertyNames) {
+        super(params, config, DecisionResponse.class, propertyNames);
+        this.config = (DecisionConfig) config;
+    }
+
+    @Override
+    public CompletableFuture<OperationOutcome> start() {
+        if (!config.isDisabled()) {
+            // enabled - do full guard operation
+            return super.start();
+        }
+
+        // guard is disabled, thus it is always treated as a success
+        logger.info("{}: guard disabled, always succeeds for {}", getFullName(), params.getRequestId());
+
+        final var executor = params.getExecutor();
+        final var callbacks = new CallbackManager();
+
+        return CompletableFuture.completedFuture(makeOutcome())
+                        .whenCompleteAsync(callbackStarted(callbacks), executor)
+                        .whenCompleteAsync(callbackCompleted(callbacks), executor);
+    }
+
+    @Override
+    protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
+        DecisionRequest request = makeRequest();
+
+        Map<String, Object> headers = makeHeaders();
+
+        headers.put("Accept", MediaType.APPLICATION_JSON);
+        String url = getUrl();
+
+        String strRequest = prettyPrint(request);
+        logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
+
+        Entity<String> entity = Entity.entity(strRequest, MediaType.APPLICATION_JSON);
+
+        // @formatter:off
+        return handleResponse(outcome, url,
+            callback -> getClient().post(callback, getPath(), entity, headers));
+        // @formatter:on
+    }
+
+    /**
+     * Makes a request from the payload.
+     *
+     * @return a new request
+     */
+    protected abstract DecisionRequest makeRequest();
+}
diff --git a/models-interactions/model-actors/actor.xacml/src/main/java/org/onap/policy/controlloop/actor/xacml/GuardOperation.java b/models-interactions/model-actors/actor.xacml/src/main/java/org/onap/policy/controlloop/actor/xacml/GuardOperation.java
index 6da970968..eddbd186c 100644
--- a/models-interactions/model-actors/actor.xacml/src/main/java/org/onap/policy/controlloop/actor/xacml/GuardOperation.java
+++ b/models-interactions/model-actors/actor.xacml/src/main/java/org/onap/policy/controlloop/actor/xacml/GuardOperation.java
@@ -23,21 +23,13 @@ package org.onap.policy.controlloop.actor.xacml;
 import java.util.Collections;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
-import javax.ws.rs.client.Entity;
-import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
-import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
-import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
-import org.onap.policy.controlloop.actorserviceprovider.CallbackManager;
 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
 import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
-import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
 import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
 import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
 import org.onap.policy.models.decisions.concepts.DecisionRequest;
 import org.onap.policy.models.decisions.concepts.DecisionResponse;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * Guard Operation. The outcome message is set to the guard response. If the guard is
@@ -54,9 +46,7 @@ import org.slf4j.LoggerFactory;
  * <dd>generated</dd>
  * </dl>
  */
-public class GuardOperation extends HttpOperation<DecisionResponse> {
-    private static final Logger logger = LoggerFactory.getLogger(GuardOperation.class);
-
+public class GuardOperation extends DecisionOperation {
     // operation name
     public static final String NAME = "Guard";
 
@@ -64,14 +54,6 @@ public class GuardOperation extends HttpOperation<DecisionResponse> {
     public static final String DENY = "Deny";
     public static final String INDETERMINATE = "Indeterminate";
 
-    /**
-     * Prefix for properties in the payload that should be copied to the "resource" field
-     * of the request.
-     */
-    public static final String RESOURCE_PREFIX = "resource.";
-
-    private final DecisionConfig config;
-
 
     /**
      * Constructs the object.
@@ -80,46 +62,7 @@ public class GuardOperation extends HttpOperation<DecisionResponse> {
      * @param config configuration for this operation
      */
     public GuardOperation(ControlLoopOperationParams params, HttpConfig config) {
-        super(params, config, DecisionResponse.class, Collections.emptyList());
-        this.config = (DecisionConfig) config;
-    }
-
-    @Override
-    public CompletableFuture<OperationOutcome> start() {
-        if (!config.isDisabled()) {
-            // enabled - do full guard operation
-            return super.start();
-        }
-
-        // guard is disabled, thus it is always treated as a success
-        logger.info("{}: guard disabled, always succeeds for {}", getFullName(), params.getRequestId());
-
-        final var executor = params.getExecutor();
-        final var callbacks = new CallbackManager();
-
-        return CompletableFuture.completedFuture(makeOutcome())
-                        .whenCompleteAsync(callbackStarted(callbacks), executor)
-                        .whenCompleteAsync(callbackCompleted(callbacks), executor);
-    }
-
-    @Override
-    protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) {
-        DecisionRequest request = makeRequest();
-
-        Map<String, Object> headers = makeHeaders();
-
-        headers.put("Accept", MediaType.APPLICATION_JSON);
-        String url = getUrl();
-
-        String strRequest = prettyPrint(request);
-        logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest);
-
-        Entity<String> entity = Entity.entity(strRequest, MediaType.APPLICATION_JSON);
-
-        // @formatter:off
-        return handleResponse(outcome, url,
-            callback -> getClient().post(callback, getPath(), entity, headers));
-        // @formatter:on
+        super(params, config, Collections.emptyList());
     }
 
     /**
diff --git a/models-interactions/model-actors/actor.xacml/src/test/java/org/onap/policy/controlloop/actor/xacml/DecisionOperationTest.java b/models-interactions/model-actors/actor.xacml/src/test/java/org/onap/policy/controlloop/actor/xacml/DecisionOperationTest.java
new file mode 100644
index 000000000..cad318701
--- /dev/null
+++ b/models-interactions/model-actors/actor.xacml/src/test/java/org/onap/policy/controlloop/actor/xacml/DecisionOperationTest.java
@@ -0,0 +1,200 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020-2021 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.xacml;
+
+import static org.assertj.core.api.Assertions.assertThat;
+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.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.List;
+import java.util.Map;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+import org.junit.AfterClass;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
+import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
+import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
+import org.onap.policy.controlloop.actor.test.BasicHttpOperation;
+import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
+import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
+import org.onap.policy.controlloop.actorserviceprovider.Util;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
+import org.onap.policy.models.decisions.concepts.DecisionRequest;
+import org.onap.policy.models.decisions.concepts.DecisionResponse;
+import org.onap.policy.simulators.XacmlSimulatorJaxRs;
+
+public class DecisionOperationTest extends BasicHttpOperation {
+    private static final List<String> PROPERTY_NAMES = List.of("prop-A", "prop-B");
+
+    @Mock
+    private Consumer<OperationOutcome> started;
+    @Mock
+    private Consumer<OperationOutcome> completed;
+
+    private DecisionConfig guardConfig;
+    private MyOper oper;
+
+    /**
+     * Starts the simulator.
+     */
+    @BeforeClass
+    public static void setUpBeforeClass() throws Exception {
+        org.onap.policy.simulators.Util.buildXacmlSim();
+
+        BusTopicParams clientParams = BusTopicParams.builder().clientName(MY_CLIENT).basePath("policy/pdpx/v1/")
+                        .hostname("localhost").managed(true).port(org.onap.policy.simulators.Util.XACMLSIM_SERVER_PORT)
+                        .build();
+        HttpClientFactoryInstance.getClientFactory().build(clientParams);
+    }
+
+    @AfterClass
+    public static void tearDownAfterClass() {
+        HttpClientFactoryInstance.getClientFactory().destroy();
+        HttpServletServerFactoryInstance.getServerFactory().destroy();
+    }
+
+    /**
+     * Sets up.
+     */
+    @Before
+    public void setUp() throws Exception {
+        super.setUpBasic();
+
+        guardConfig = mock(DecisionConfig.class);
+        when(guardConfig.makeRequest()).thenAnswer(args -> {
+            DecisionRequest req = new DecisionRequest();
+            req.setAction("guard");
+            req.setOnapComponent("my-onap-component");
+            req.setOnapInstance("my-onap-instance");
+            req.setOnapName("my-onap-name");
+            return req;
+        });
+
+        config = guardConfig;
+        initConfig();
+
+        params = params.toBuilder().startCallback(started).completeCallback(completed).build();
+
+        oper = new MyOper(params, config);
+    }
+
+    /**
+     * Tests with simulator.
+     */
+    @Test
+    public void testSimulator() throws Exception {
+        DecisionParams opParams = DecisionParams.builder().clientName(MY_CLIENT).path("decision").build();
+        config = new DecisionConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory());
+
+        params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor)
+                        .payload(Map.of("clname", XacmlSimulatorJaxRs.DENY_CLNAME)).build();
+        oper = new MyOper(params, config);
+
+        outcome = oper.start().get();
+        assertEquals(OperationResult.FAILURE, outcome.getResult());
+        assertTrue(outcome.getResponse() instanceof DecisionResponse);
+    }
+
+    @Test
+    public void testConstructor() {
+        assertEquals(DEFAULT_ACTOR, oper.getActorName());
+        assertEquals(DEFAULT_OPERATION, oper.getName());
+    }
+
+    @Test
+    public void testGetPropertyNames() {
+        assertThat(oper.getPropertyNames()).isEqualTo(PROPERTY_NAMES);
+    }
+
+    @Test
+    public void testStartOperationAsync() throws Exception {
+        CompletableFuture<OperationOutcome> future2 = oper.start();
+        executor.runAll(100);
+        assertFalse(future2.isDone());
+
+        DecisionResponse resp = new DecisionResponse();
+        resp.setStatus(GuardOperation.PERMIT);
+        when(rawResponse.readEntity(String.class)).thenReturn(Util.translate("", resp, String.class));
+
+        verify(client).post(callbackCaptor.capture(), any(), requestCaptor.capture(), any());
+        callbackCaptor.getValue().completed(rawResponse);
+
+        executor.runAll(100);
+        assertTrue(future2.isDone());
+
+        outcome = future2.get();
+        assertEquals(OperationResult.SUCCESS, outcome.getResult());
+        assertEquals(resp, outcome.getResponse());
+
+        assertNotNull(oper.getSubRequestId());
+        assertEquals(oper.getSubRequestId(), future2.get().getSubRequestId());
+    }
+
+    /**
+     * Tests startOperationAsync() when the guard is disabled.
+     */
+    @Test
+    public void testStartOperationAsyncDisabled() throws Exception {
+        // indicate that it's disabled
+        when(guardConfig.isDisabled()).thenReturn(true);
+
+        CompletableFuture<OperationOutcome> future2 = oper.start();
+        executor.runAll(100);
+
+        verify(client, never()).post(any(), any(), any(), any());
+
+        // should already be done
+        assertTrue(future2.isDone());
+
+        outcome = future2.get();
+        assertEquals(OperationResult.SUCCESS, outcome.getResult());
+        assertNull(outcome.getResponse());
+
+        // ensure callbacks were invoked
+        verify(started).accept(any());
+        verify(completed).accept(any());
+    }
+
+    private class MyOper extends DecisionOperation {
+
+        public MyOper(ControlLoopOperationParams params, HttpConfig config) {
+            super(params, config, PROPERTY_NAMES);
+        }
+
+        @Override
+        protected DecisionRequest makeRequest() {
+            return guardConfig.makeRequest();
+        }
+    }
+}
diff --git a/models-interactions/model-actors/actor.xacml/src/test/java/org/onap/policy/controlloop/actor/xacml/GuardOperationTest.java b/models-interactions/model-actors/actor.xacml/src/test/java/org/onap/policy/controlloop/actor/xacml/GuardOperationTest.java
index e69b62d2a..2988d695b 100644
--- a/models-interactions/model-actors/actor.xacml/src/test/java/org/onap/policy/controlloop/actor/xacml/GuardOperationTest.java
+++ b/models-interactions/model-actors/actor.xacml/src/test/java/org/onap/policy/controlloop/actor/xacml/GuardOperationTest.java
@@ -23,20 +23,14 @@ package org.onap.policy.controlloop.actor.xacml;
 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.util.Map;
 import java.util.TreeMap;
-import java.util.concurrent.CompletableFuture;
 import java.util.function.Consumer;
 import org.junit.AfterClass;
 import org.junit.Before;
@@ -50,7 +44,6 @@ import org.onap.policy.common.utils.coder.CoderException;
 import org.onap.policy.controlloop.actor.test.BasicHttpOperation;
 import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
 import org.onap.policy.controlloop.actorserviceprovider.OperationResult;
-import org.onap.policy.controlloop.actorserviceprovider.Util;
 import org.onap.policy.models.decisions.concepts.DecisionRequest;
 import org.onap.policy.models.decisions.concepts.DecisionResponse;
 import org.onap.policy.simulators.XacmlSimulatorJaxRs;
@@ -154,55 +147,6 @@ public class GuardOperationTest extends BasicHttpOperation {
     }
 
     @Test
-    public void testStartOperationAsync() throws Exception {
-        CompletableFuture<OperationOutcome> future2 = oper.start();
-        executor.runAll(100);
-        assertFalse(future2.isDone());
-
-        DecisionResponse resp = new DecisionResponse();
-        resp.setStatus(GuardOperation.PERMIT);
-        when(rawResponse.readEntity(String.class)).thenReturn(Util.translate("", resp, String.class));
-
-        verify(client).post(callbackCaptor.capture(), any(), requestCaptor.capture(), any());
-        callbackCaptor.getValue().completed(rawResponse);
-
-        executor.runAll(100);
-        assertTrue(future2.isDone());
-
-        outcome = future2.get();
-        assertEquals(OperationResult.SUCCESS, outcome.getResult());
-        assertEquals(resp, outcome.getResponse());
-
-        assertNotNull(oper.getSubRequestId());
-        assertEquals(oper.getSubRequestId(), future2.get().getSubRequestId());
-    }
-
-    /**
-     * Tests startOperationAsync() when the guard is disabled.
-     */
-    @Test
-    public void testStartOperationAsyncDisabled() throws Exception {
-        // indicate that it's disabled
-        when(guardConfig.isDisabled()).thenReturn(true);
-
-        CompletableFuture<OperationOutcome> future2 = oper.start();
-        executor.runAll(100);
-
-        verify(client, never()).post(any(), any(), any(), any());
-
-        // should already be done
-        assertTrue(future2.isDone());
-
-        outcome = future2.get();
-        assertEquals(OperationResult.SUCCESS, outcome.getResult());
-        assertNull(outcome.getResponse());
-
-        // ensure callbacks were invoked
-        verify(started).accept(any());
-        verify(completed).accept(any());
-    }
-
-    @Test
     public void testMakeRequest() throws CoderException {
         oper.generateSubRequestId(2);