From 905f592c969066b78f14fe89f48485b80c67d475 Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Wed, 10 Jun 2020 14:14:40 -0400 Subject: Rename GuardOperation to DecisionOperation Issue-ID: POLICY-2628 Change-Id: I94eec317ff91f37add417f70f33c2d23fa0f3026 Signed-off-by: Jim Hahn --- .../controlloop/actor/guard/DecisionOperation.java | 168 +++++++++++++ .../controlloop/actor/guard/DecisionOperator.java | 52 ++++ .../actor/guard/GuardActorServiceProvider.java | 2 +- .../controlloop/actor/guard/GuardOperation.java | 168 ------------- .../controlloop/actor/guard/GuardOperator.java | 52 ---- .../actor/guard/DecisionOperationTest.java | 264 +++++++++++++++++++++ .../actor/guard/DecisionOperatorTest.java | 105 ++++++++ .../actor/guard/GuardActorServiceProviderTest.java | 4 +- .../actor/guard/GuardOperationTest.java | 264 --------------------- .../controlloop/actor/guard/GuardOperatorTest.java | 105 -------- 10 files changed, 592 insertions(+), 592 deletions(-) create mode 100644 models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/DecisionOperation.java create mode 100644 models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/DecisionOperator.java delete mode 100644 models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperation.java delete mode 100644 models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperator.java create mode 100644 models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/DecisionOperationTest.java create mode 100644 models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/DecisionOperatorTest.java delete mode 100644 models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperationTest.java delete mode 100644 models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperatorTest.java (limited to 'models-interactions/model-actors') diff --git a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/DecisionOperation.java b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/DecisionOperation.java new file mode 100644 index 000000000..6a7b6fd93 --- /dev/null +++ b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/DecisionOperation.java @@ -0,0 +1,168 @@ +/*- + * ============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.guard; + +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.Executor; +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.impl.HttpOperation; +import org.onap.policy.controlloop.actorserviceprovider.impl.OperationPartial; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; +import org.onap.policy.controlloop.policy.PolicyResult; +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 + * permitted or indeterminate, then the outcome is set to SUCCESS. + *

+ * The input to the request is taken from the payload, where properties are mapped to the + * field names in the {@link DecisionRequest} object. Properties whose names begin with + * "resource." are placed into the "resource" field of the {@link DecisionRequest}. The + * following will be provided, if not specified in the payload: + *

+ *
action
+ *
"guard"
+ *
request ID
+ *
generated
+ *
+ */ +public class DecisionOperation extends HttpOperation { + private static final Logger logger = LoggerFactory.getLogger(DecisionOperation.class); + + // operation name + public static final String NAME = OperationPartial.GUARD_OPERATION_NAME; + + public static final String PERMIT = "Permit"; + 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 GuardConfig config; + + + /** + * Constructs the object. + * + * @param params operation parameters + * @param config configuration for this operation + */ + public DecisionOperation(ControlLoopOperationParams params, HttpConfig config) { + super(params, config, DecisionResponse.class); + this.config = (GuardConfig) config; + } + + @Override + public CompletableFuture 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 Executor executor = params.getExecutor(); + final CallbackManager callbacks = new CallbackManager(); + + return CompletableFuture.completedFuture(params.makeOutcome()) + .whenCompleteAsync(callbackStarted(callbacks), executor) + .whenCompleteAsync(callbackCompleted(callbacks), executor); + } + + @Override + protected CompletableFuture startOperationAsync(int attempt, OperationOutcome outcome) { + DecisionRequest request = makeRequest(); + + Map headers = makeHeaders(); + + headers.put("Accept", MediaType.APPLICATION_JSON); + String url = getUrl(); + + String strRequest = prettyPrint(request); + logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest); + + Entity 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 DecisionRequest makeRequest() { + if (params.getPayload() == null) { + throw new IllegalArgumentException("missing payload"); + } + + DecisionRequest req = config.makeRequest(); + req.setRequestId(getSubRequestId()); + req.setResource(Map.of("guard", params.getPayload())); + + return req; + } + + @Override + protected CompletableFuture postProcessResponse(OperationOutcome outcome, String url, + Response rawResponse, DecisionResponse response) { + + outcome.setResponse(response); + + // determine the result + String status = response.getStatus(); + if (status == null) { + outcome.setResult(PolicyResult.FAILURE); + outcome.setMessage("response contains no status"); + return CompletableFuture.completedFuture(outcome); + } + + if (PERMIT.equalsIgnoreCase(status) || INDETERMINATE.equalsIgnoreCase(status)) { + outcome.setResult(PolicyResult.SUCCESS); + } else { + outcome.setResult(PolicyResult.FAILURE); + } + + // set the message + outcome.setMessage(response.getStatus()); + + return CompletableFuture.completedFuture(outcome); + } +} diff --git a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/DecisionOperator.java b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/DecisionOperator.java new file mode 100644 index 000000000..6375e95eb --- /dev/null +++ b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/DecisionOperator.java @@ -0,0 +1,52 @@ +/*- + * ============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.guard; + +import java.util.Map; +import org.onap.policy.common.parameters.ValidationResult; +import org.onap.policy.controlloop.actorserviceprovider.Util; +import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation; +import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator; +import org.onap.policy.controlloop.actorserviceprovider.impl.OperationMaker; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException; + +/** + * Guard Operator. + */ +public class DecisionOperator extends HttpOperator { + + public DecisionOperator(String actorName, String name, + @SuppressWarnings("rawtypes") OperationMaker operationMaker) { + super(actorName, name, operationMaker); + } + + @Override + protected HttpConfig makeConfiguration(Map parameters) { + GuardParams params = Util.translate(getFullName(), parameters, GuardParams.class); + ValidationResult result = params.validate(getFullName()); + if (!result.isValid()) { + throw new ParameterValidationRuntimeException("invalid parameters", result); + } + + return new GuardConfig(getBlockingExecutor(), params, getClientFactory()); + } +} diff --git a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardActorServiceProvider.java b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardActorServiceProvider.java index 0053213f5..1cf09d399 100644 --- a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardActorServiceProvider.java +++ b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardActorServiceProvider.java @@ -35,6 +35,6 @@ public class GuardActorServiceProvider extends HttpActor { public GuardActorServiceProvider() { super(NAME, GuardActorParams.class); - addOperator(new GuardOperator(NAME, GuardOperation.NAME, GuardOperation::new)); + addOperator(new DecisionOperator(NAME, DecisionOperation.NAME, DecisionOperation::new)); } } 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 deleted file mode 100644 index a21886bf2..000000000 --- a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperation.java +++ /dev/null @@ -1,168 +0,0 @@ -/*- - * ============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.guard; - -import java.util.Map; -import java.util.concurrent.CompletableFuture; -import java.util.concurrent.Executor; -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.impl.HttpOperation; -import org.onap.policy.controlloop.actorserviceprovider.impl.OperationPartial; -import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; -import org.onap.policy.controlloop.policy.PolicyResult; -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 - * permitted or indeterminate, then the outcome is set to SUCCESS. - *

- * The input to the request is taken from the payload, where properties are mapped to the - * field names in the {@link DecisionRequest} object. Properties whose names begin with - * "resource." are placed into the "resource" field of the {@link DecisionRequest}. The - * following will be provided, if not specified in the payload: - *

- *
action
- *
"guard"
- *
request ID
- *
generated
- *
- */ -public class GuardOperation extends HttpOperation { - private static final Logger logger = LoggerFactory.getLogger(GuardOperation.class); - - // operation name - public static final String NAME = OperationPartial.GUARD_OPERATION_NAME; - - public static final String PERMIT = "Permit"; - 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 GuardConfig config; - - - /** - * Constructs the object. - * - * @param params operation parameters - * @param config configuration for this operation - */ - public GuardOperation(ControlLoopOperationParams params, HttpConfig config) { - super(params, config, DecisionResponse.class); - this.config = (GuardConfig) config; - } - - @Override - public CompletableFuture 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 Executor executor = params.getExecutor(); - final CallbackManager callbacks = new CallbackManager(); - - return CompletableFuture.completedFuture(params.makeOutcome()) - .whenCompleteAsync(callbackStarted(callbacks), executor) - .whenCompleteAsync(callbackCompleted(callbacks), executor); - } - - @Override - protected CompletableFuture startOperationAsync(int attempt, OperationOutcome outcome) { - DecisionRequest request = makeRequest(); - - Map headers = makeHeaders(); - - headers.put("Accept", MediaType.APPLICATION_JSON); - String url = getUrl(); - - String strRequest = prettyPrint(request); - logMessage(EventType.OUT, CommInfrastructure.REST, url, strRequest); - - Entity 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 DecisionRequest makeRequest() { - if (params.getPayload() == null) { - throw new IllegalArgumentException("missing payload"); - } - - DecisionRequest req = config.makeRequest(); - req.setRequestId(getSubRequestId()); - req.setResource(Map.of("guard", params.getPayload())); - - return req; - } - - @Override - protected CompletableFuture postProcessResponse(OperationOutcome outcome, String url, - Response rawResponse, DecisionResponse response) { - - outcome.setResponse(response); - - // determine the result - String status = response.getStatus(); - if (status == null) { - outcome.setResult(PolicyResult.FAILURE); - outcome.setMessage("response contains no status"); - return CompletableFuture.completedFuture(outcome); - } - - if (PERMIT.equalsIgnoreCase(status) || INDETERMINATE.equalsIgnoreCase(status)) { - outcome.setResult(PolicyResult.SUCCESS); - } else { - outcome.setResult(PolicyResult.FAILURE); - } - - // set the message - outcome.setMessage(response.getStatus()); - - return CompletableFuture.completedFuture(outcome); - } -} diff --git a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperator.java b/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperator.java deleted file mode 100644 index b3a47fd71..000000000 --- a/models-interactions/model-actors/actor.guard/src/main/java/org/onap/policy/controlloop/actor/guard/GuardOperator.java +++ /dev/null @@ -1,52 +0,0 @@ -/*- - * ============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.guard; - -import java.util.Map; -import org.onap.policy.common.parameters.ValidationResult; -import org.onap.policy.controlloop.actorserviceprovider.Util; -import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation; -import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator; -import org.onap.policy.controlloop.actorserviceprovider.impl.OperationMaker; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; -import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException; - -/** - * Guard Operator. - */ -public class GuardOperator extends HttpOperator { - - public GuardOperator(String actorName, String name, - @SuppressWarnings("rawtypes") OperationMaker operationMaker) { - super(actorName, name, operationMaker); - } - - @Override - protected HttpConfig makeConfiguration(Map parameters) { - GuardParams params = Util.translate(getFullName(), parameters, GuardParams.class); - ValidationResult result = params.validate(getFullName()); - if (!result.isValid()) { - throw new ParameterValidationRuntimeException("invalid parameters", result); - } - - return new GuardConfig(getBlockingExecutor(), params, getClientFactory()); - } -} diff --git a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/DecisionOperationTest.java b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/DecisionOperationTest.java new file mode 100644 index 000000000..da0ee95b5 --- /dev/null +++ b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/DecisionOperationTest.java @@ -0,0 +1,264 @@ +/*- + * ============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.guard; + +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; +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.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.Util; +import org.onap.policy.controlloop.policy.PolicyResult; +import org.onap.policy.models.decisions.concepts.DecisionRequest; +import org.onap.policy.models.decisions.concepts.DecisionResponse; +import org.onap.policy.simulators.GuardSimulatorJaxRs; + +public class DecisionOperationTest extends BasicHttpOperation { + + @Mock + private Consumer started; + @Mock + private Consumer completed; + + private GuardConfig guardConfig; + private DecisionOperation oper; + + /** + * Starts the simulator. + */ + @BeforeClass + public static void setUpBeforeClass() throws Exception { + org.onap.policy.simulators.Util.buildGuardSim(); + + BusTopicParams clientParams = BusTopicParams.builder().clientName(MY_CLIENT).basePath("policy/pdpx/v1/") + .hostname("localhost").managed(true).port(org.onap.policy.simulators.Util.GUARDSIM_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(GuardConfig.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 DecisionOperation(params, config); + } + + /** + * Tests "success" case with simulator. + */ + @Test + public void testSuccess() throws Exception { + GuardParams opParams = GuardParams.builder().clientName(MY_CLIENT).path("decision").build(); + config = new GuardConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); + + params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build(); + oper = new DecisionOperation(params, config); + + outcome = oper.start().get(); + assertEquals(PolicyResult.SUCCESS, outcome.getResult()); + assertTrue(outcome.getResponse() instanceof DecisionResponse); + } + + /** + * Tests "failure" case with simulator. + */ + @Test + public void testFailure() throws Exception { + GuardParams opParams = GuardParams.builder().clientName(MY_CLIENT).path("decision").build(); + config = new GuardConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); + + params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor) + .payload(Map.of("clname", GuardSimulatorJaxRs.DENY_CLNAME)).build(); + oper = new DecisionOperation(params, config); + + outcome = oper.start().get(); + assertEquals(PolicyResult.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 testStartOperationAsync() throws Exception { + CompletableFuture future2 = oper.start(); + executor.runAll(100); + assertFalse(future2.isDone()); + + DecisionResponse resp = new DecisionResponse(); + resp.setStatus(DecisionOperation.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(PolicyResult.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 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(PolicyResult.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); + + verifyPayload("makeReqStd.json", makePayload()); + verifyPayload("makeReqDefault.json", new TreeMap<>()); + + // null payload - start with fresh parameters and operation + params = params.toBuilder().payload(null).build(); + oper = new DecisionOperation(params, config); + assertThatIllegalArgumentException().isThrownBy(() -> oper.makeRequest()); + } + + private void verifyPayload(String expectedJsonFile, Map payload) throws CoderException { + params.getPayload().clear(); + params.getPayload().putAll(payload); + + DecisionRequest request = oper.makeRequest(); + + assertEquals("guard", request.getAction()); + assertEquals("my-onap-component", request.getOnapComponent()); + assertEquals("my-onap-instance", request.getOnapInstance()); + assertEquals("my-onap-name", request.getOnapName()); + assertNotNull(request.getRequestId()); + assertEquals(Map.of("guard", payload), request.getResource()); + + verifyRequest(expectedJsonFile, request, "requestId"); + } + + @Test + public void testPostProcessResponse() { + DecisionResponse response = new DecisionResponse(); + + // null status + response.setStatus(null); + verifyOutcome(response, PolicyResult.FAILURE, "response contains no status"); + + // permit, mixed case + response.setStatus("peRmit"); + verifyOutcome(response, PolicyResult.SUCCESS, "peRmit"); + + // indeterminate, mixed case + response.setStatus("inDETerminate"); + verifyOutcome(response, PolicyResult.SUCCESS, "inDETerminate"); + + // deny, mixed case + response.setStatus("deNY"); + verifyOutcome(response, PolicyResult.FAILURE, "deNY"); + + // unknown status + response.setStatus("unknown"); + verifyOutcome(response, PolicyResult.FAILURE, "unknown"); + } + + private void verifyOutcome(DecisionResponse response, PolicyResult expectedResult, String expectedMessage) { + oper.postProcessResponse(outcome, BASE_URI, rawResponse, response); + assertEquals(expectedResult, outcome.getResult()); + assertEquals(expectedMessage, outcome.getMessage()); + assertSame(response, outcome.getResponse()); + } + + @Override + protected Map makePayload() { + return new TreeMap<>(Map.of("hello", "world", "abc", "123")); + } +} diff --git a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/DecisionOperatorTest.java b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/DecisionOperatorTest.java new file mode 100644 index 000000000..170bcdf7e --- /dev/null +++ b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/DecisionOperatorTest.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.guard; + +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertTrue; +import static org.mockito.Mockito.when; + +import java.util.Map; +import org.junit.Before; +import org.junit.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.onap.policy.common.endpoints.http.client.HttpClient; +import org.onap.policy.common.endpoints.http.client.HttpClientFactory; +import org.onap.policy.controlloop.actorserviceprovider.Util; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException; + +public class DecisionOperatorTest { + private static final String ACTOR = "my-actor"; + private static final String OPERATION = "my-name"; + private static final String CLIENT = "my-client"; + private static final String PATH = "my-path"; + private static final int TIMEOUT = 10; + private static final String ONAP_NAME = "onap-nap"; + private static final String ONAP_COMP = "onap-component"; + private static final String ONAP_INST = "onap-instance"; + private static final String MY_ACTION = "my-action"; + + @Mock + private HttpClient client; + + @Mock + private HttpClientFactory factory; + + + private DecisionOperator oper; + + /** + * Initializes fields, including {@link #oper}, and resets the static fields used by + * the REST server. + */ + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + + when(factory.get(CLIENT)).thenReturn(client); + + oper = new MyOperator(); + + GuardParams params = GuardParams.builder().onapName(ONAP_NAME).onapComponent(ONAP_COMP).onapInstance(ONAP_INST) + .action(MY_ACTION).clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build(); + Map paramMap = Util.translateToMap(OPERATION, params); + oper.configure(paramMap); + + assertTrue(oper.makeConfiguration(paramMap) instanceof GuardConfig); + } + + @Test + public void testConstructor() { + assertEquals(ACTOR, oper.getActorName()); + assertEquals(OPERATION, oper.getName()); + assertEquals(ACTOR + "." + OPERATION, oper.getFullName()); + } + + @Test + public void testDoConfigure_testGetters() { + assertTrue(oper.getCurrentConfig() instanceof GuardConfig); + + // test invalid parameters + Map paramMap2 = Util.translateToMap(OPERATION, GuardParams.builder().build()); + assertThatThrownBy(() -> oper.configure(paramMap2)).isInstanceOf(ParameterValidationRuntimeException.class); + } + + + private class MyOperator extends DecisionOperator { + public MyOperator() { + super(ACTOR, OPERATION, null); + } + + @Override + protected HttpClientFactory getClientFactory() { + return factory; + } + } +} diff --git a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardActorServiceProviderTest.java b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardActorServiceProviderTest.java index 6721ff7d0..0ad8161c6 100644 --- a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardActorServiceProviderTest.java +++ b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardActorServiceProviderTest.java @@ -35,7 +35,7 @@ public class GuardActorServiceProviderTest extends BasicActor { final GuardActorServiceProvider prov = new GuardActorServiceProvider(); // verify that it has the operators we expect - var expected = Arrays.asList(GuardOperation.NAME).stream().sorted().collect(Collectors.toList()); + var expected = Arrays.asList(DecisionOperation.NAME).stream().sorted().collect(Collectors.toList()); var actual = prov.getOperationNames().stream().sorted().collect(Collectors.toList()); assertEquals(expected.toString(), actual.toString()); @@ -43,6 +43,6 @@ public class GuardActorServiceProviderTest extends BasicActor { // verify that it all plugs into the ActorService verifyActorService(GuardActorServiceProvider.NAME, "service.yaml"); - assertTrue(prov.getOperator(GuardOperation.NAME) instanceof GuardOperator); + assertTrue(prov.getOperator(DecisionOperation.NAME) instanceof DecisionOperator); } } 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 deleted file mode 100644 index daf4dff6e..000000000 --- a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperationTest.java +++ /dev/null @@ -1,264 +0,0 @@ -/*- - * ============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.guard; - -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; -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.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.Util; -import org.onap.policy.controlloop.policy.PolicyResult; -import org.onap.policy.models.decisions.concepts.DecisionRequest; -import org.onap.policy.models.decisions.concepts.DecisionResponse; -import org.onap.policy.simulators.GuardSimulatorJaxRs; - -public class GuardOperationTest extends BasicHttpOperation { - - @Mock - private Consumer started; - @Mock - private Consumer completed; - - private GuardConfig guardConfig; - private GuardOperation oper; - - /** - * Starts the simulator. - */ - @BeforeClass - public static void setUpBeforeClass() throws Exception { - org.onap.policy.simulators.Util.buildGuardSim(); - - BusTopicParams clientParams = BusTopicParams.builder().clientName(MY_CLIENT).basePath("policy/pdpx/v1/") - .hostname("localhost").managed(true).port(org.onap.policy.simulators.Util.GUARDSIM_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(GuardConfig.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 GuardOperation(params, config); - } - - /** - * Tests "success" case with simulator. - */ - @Test - public void testSuccess() throws Exception { - GuardParams opParams = GuardParams.builder().clientName(MY_CLIENT).path("decision").build(); - config = new GuardConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); - - params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build(); - oper = new GuardOperation(params, config); - - outcome = oper.start().get(); - assertEquals(PolicyResult.SUCCESS, outcome.getResult()); - assertTrue(outcome.getResponse() instanceof DecisionResponse); - } - - /** - * Tests "failure" case with simulator. - */ - @Test - public void testFailure() throws Exception { - GuardParams opParams = GuardParams.builder().clientName(MY_CLIENT).path("decision").build(); - config = new GuardConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); - - params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor) - .payload(Map.of("clname", GuardSimulatorJaxRs.DENY_CLNAME)).build(); - oper = new GuardOperation(params, config); - - outcome = oper.start().get(); - assertEquals(PolicyResult.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 testStartOperationAsync() throws Exception { - CompletableFuture 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(PolicyResult.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 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(PolicyResult.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); - - verifyPayload("makeReqStd.json", makePayload()); - verifyPayload("makeReqDefault.json", new TreeMap<>()); - - // null payload - start with fresh parameters and operation - params = params.toBuilder().payload(null).build(); - oper = new GuardOperation(params, config); - assertThatIllegalArgumentException().isThrownBy(() -> oper.makeRequest()); - } - - private void verifyPayload(String expectedJsonFile, Map payload) throws CoderException { - params.getPayload().clear(); - params.getPayload().putAll(payload); - - DecisionRequest request = oper.makeRequest(); - - assertEquals("guard", request.getAction()); - assertEquals("my-onap-component", request.getOnapComponent()); - assertEquals("my-onap-instance", request.getOnapInstance()); - assertEquals("my-onap-name", request.getOnapName()); - assertNotNull(request.getRequestId()); - assertEquals(Map.of("guard", payload), request.getResource()); - - verifyRequest(expectedJsonFile, request, "requestId"); - } - - @Test - public void testPostProcessResponse() { - DecisionResponse response = new DecisionResponse(); - - // null status - response.setStatus(null); - verifyOutcome(response, PolicyResult.FAILURE, "response contains no status"); - - // permit, mixed case - response.setStatus("peRmit"); - verifyOutcome(response, PolicyResult.SUCCESS, "peRmit"); - - // indeterminate, mixed case - response.setStatus("inDETerminate"); - verifyOutcome(response, PolicyResult.SUCCESS, "inDETerminate"); - - // deny, mixed case - response.setStatus("deNY"); - verifyOutcome(response, PolicyResult.FAILURE, "deNY"); - - // unknown status - response.setStatus("unknown"); - verifyOutcome(response, PolicyResult.FAILURE, "unknown"); - } - - private void verifyOutcome(DecisionResponse response, PolicyResult expectedResult, String expectedMessage) { - oper.postProcessResponse(outcome, BASE_URI, rawResponse, response); - assertEquals(expectedResult, outcome.getResult()); - assertEquals(expectedMessage, outcome.getMessage()); - assertSame(response, outcome.getResponse()); - } - - @Override - protected Map makePayload() { - return new TreeMap<>(Map.of("hello", "world", "abc", "123")); - } -} diff --git a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperatorTest.java b/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperatorTest.java deleted file mode 100644 index 36263329a..000000000 --- a/models-interactions/model-actors/actor.guard/src/test/java/org/onap/policy/controlloop/actor/guard/GuardOperatorTest.java +++ /dev/null @@ -1,105 +0,0 @@ -/*- - * ============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.guard; - -import static org.assertj.core.api.Assertions.assertThatThrownBy; -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertTrue; -import static org.mockito.Mockito.when; - -import java.util.Map; -import org.junit.Before; -import org.junit.Test; -import org.mockito.Mock; -import org.mockito.MockitoAnnotations; -import org.onap.policy.common.endpoints.http.client.HttpClient; -import org.onap.policy.common.endpoints.http.client.HttpClientFactory; -import org.onap.policy.controlloop.actorserviceprovider.Util; -import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException; - -public class GuardOperatorTest { - private static final String ACTOR = "my-actor"; - private static final String OPERATION = "my-name"; - private static final String CLIENT = "my-client"; - private static final String PATH = "my-path"; - private static final int TIMEOUT = 10; - private static final String ONAP_NAME = "onap-nap"; - private static final String ONAP_COMP = "onap-component"; - private static final String ONAP_INST = "onap-instance"; - private static final String MY_ACTION = "my-action"; - - @Mock - private HttpClient client; - - @Mock - private HttpClientFactory factory; - - - private GuardOperator oper; - - /** - * Initializes fields, including {@link #oper}, and resets the static fields used by - * the REST server. - */ - @Before - public void setUp() { - MockitoAnnotations.initMocks(this); - - when(factory.get(CLIENT)).thenReturn(client); - - oper = new MyOperator(); - - GuardParams params = GuardParams.builder().onapName(ONAP_NAME).onapComponent(ONAP_COMP).onapInstance(ONAP_INST) - .action(MY_ACTION).clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build(); - Map paramMap = Util.translateToMap(OPERATION, params); - oper.configure(paramMap); - - assertTrue(oper.makeConfiguration(paramMap) instanceof GuardConfig); - } - - @Test - public void testConstructor() { - assertEquals(ACTOR, oper.getActorName()); - assertEquals(OPERATION, oper.getName()); - assertEquals(ACTOR + "." + OPERATION, oper.getFullName()); - } - - @Test - public void testDoConfigure_testGetters() { - assertTrue(oper.getCurrentConfig() instanceof GuardConfig); - - // test invalid parameters - Map paramMap2 = Util.translateToMap(OPERATION, GuardParams.builder().build()); - assertThatThrownBy(() -> oper.configure(paramMap2)).isInstanceOf(ParameterValidationRuntimeException.class); - } - - - private class MyOperator extends GuardOperator { - public MyOperator() { - super(ACTOR, OPERATION, null); - } - - @Override - protected HttpClientFactory getClientFactory() { - return factory; - } - } -} -- cgit 1.2.3-korg