diff options
| author |   Jim Hahn <jrh3@att.com> | 2020-06-11 19:00:41 -0400 |
|---|---|---|
| committer | Jim Hahn <jrh3@att.com> | 2020-06-12 18:40:29 -0400 |
| commit | e9af3a2b3a430626c740b18ccf8592706db1dfb1 (patch) | |
| tree | ff0d351b54f4862de8512666d3a7c1371ef73118 | |
| parent | c34fdc19686d70af12e8873b0b01b96dd54c1aa3 (diff) | |
Moving common polling code into HttpOperation
SO and VFC have duplicate code for polling. Moved it into the
common superclass.
Issue-ID: POLICY-2632
Change-Id: I27128bfb2d54ef522b6b44ff569819a8463f3454
Signed-off-by: Jim Hahn <jrh3@att.com>
40 files changed, 861 insertions, 1081 deletions
diff --git a/models-interactions/model-actors/actor.aai/src/test/java/org/onap/policy/controlloop/actor/aai/AaiCustomQueryOperationTest.java b/models-interactions/model-actors/actor.aai/src/test/java/org/onap/policy/controlloop/actor/aai/AaiCustomQueryOperationTest.java index 386eb219a..abfd2eb41 100644 --- a/models-interactions/model-actors/actor.aai/src/test/java/org/onap/policy/controlloop/actor/aai/AaiCustomQueryOperationTest.java +++ b/models-interactions/model-actors/actor.aai/src/test/java/org/onap/policy/controlloop/actor/aai/AaiCustomQueryOperationTest.java @@ -50,9 +50,9 @@ import org.onap.policy.common.endpoints.http.client.HttpClientFactory; import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; import org.onap.policy.common.utils.coder.StandardCoder; import org.onap.policy.common.utils.coder.StandardCoderObject; -import org.onap.policy.controlloop.actorserviceprovider.Operation; import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; 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.parameters.ControlLoopOperationParams; import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; @@ -277,7 +277,7 @@ public class AaiCustomQueryOperationTest extends BasicAaiOperation<Map<String, S } @Override - public Operation buildOperation(ControlLoopOperationParams params) { + public HttpOperation<?> buildOperation(ControlLoopOperationParams params) { return new AaiGetTenantOperation(params, getCurrentConfig()); } 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 index 6375e95eb..f86d370e9 100644 --- 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 @@ -35,7 +35,7 @@ import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterVali public class DecisionOperator extends HttpOperator { public DecisionOperator(String actorName, String name, - @SuppressWarnings("rawtypes") OperationMaker<HttpConfig, HttpOperation> operationMaker) { + OperationMaker<HttpConfig, HttpOperation<?>> operationMaker) { super(actorName, name, operationMaker); } diff --git a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoActorServiceProvider.java b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoActorServiceProvider.java index e4b9c14fe..642e2b455 100644 --- a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoActorServiceProvider.java +++ b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoActorServiceProvider.java @@ -36,6 +36,8 @@ import org.onap.policy.aai.AaiCqResponse; import org.onap.policy.controlloop.ControlLoopOperation; import org.onap.policy.controlloop.VirtualControlLoopEvent; import org.onap.policy.controlloop.actorserviceprovider.impl.HttpActor; +import org.onap.policy.controlloop.actorserviceprovider.impl.HttpPollingOperator; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingActorParams; import org.onap.policy.controlloop.policy.Policy; import org.onap.policy.so.SoCloudConfiguration; import org.onap.policy.so.SoManager; @@ -51,7 +53,7 @@ import org.onap.policy.so.util.Serialization; import org.slf4j.Logger; import org.slf4j.LoggerFactory; -public class SoActorServiceProvider extends HttpActor<SoActorParams> { +public class SoActorServiceProvider extends HttpActor<HttpPollingActorParams> { private static final Logger logger = LoggerFactory.getLogger(SoActorServiceProvider.class); public static final String NAME = "SO"; @@ -96,10 +98,10 @@ public class SoActorServiceProvider extends HttpActor<SoActorParams> { * Constructs the object. */ public SoActorServiceProvider() { - super(NAME, SoActorParams.class); + super(NAME, HttpPollingActorParams.class); - addOperator(new SoOperator(NAME, VfModuleCreate.NAME, VfModuleCreate::new)); - addOperator(new SoOperator(NAME, VfModuleDelete.NAME, VfModuleDelete::new)); + addOperator(new HttpPollingOperator(NAME, VfModuleCreate.NAME, VfModuleCreate::new)); + addOperator(new HttpPollingOperator(NAME, VfModuleDelete.NAME, VfModuleDelete::new)); } // TODO old code: remove lines down to **HERE** diff --git a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoOperation.java b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoOperation.java index a8900f76b..cb9ec9c40 100644 --- a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoOperation.java +++ b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoOperation.java @@ -29,19 +29,14 @@ import java.util.List; import java.util.Map; import java.util.Optional; import java.util.concurrent.CompletableFuture; -import java.util.concurrent.TimeUnit; -import java.util.function.Function; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response; -import lombok.Getter; import org.onap.aai.domain.yang.CloudRegion; import org.onap.aai.domain.yang.GenericVnf; import org.onap.aai.domain.yang.ServiceInstance; import org.onap.aai.domain.yang.Tenant; import org.onap.policy.aai.AaiConstants; import org.onap.policy.aai.AaiCqResponse; -import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure; -import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType; import org.onap.policy.common.gson.GsonMessageBodyHandler; import org.onap.policy.common.utils.coder.Coder; import org.onap.policy.common.utils.coder.CoderException; @@ -50,7 +45,7 @@ import org.onap.policy.common.utils.coder.StandardCoderObject; 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.controlloop.actorserviceprovider.parameters.HttpPollingConfig; import org.onap.policy.controlloop.policy.PolicyResult; import org.onap.policy.controlloop.policy.Target; import org.onap.policy.so.SoCloudConfiguration; @@ -61,15 +56,12 @@ import org.onap.policy.so.SoRequestParameters; import org.onap.policy.so.SoRequestStatus; import org.onap.policy.so.SoResponse; import org.onap.policy.so.util.SoLocalDateTimeTypeAdapter; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; /** - * Superclass for SDNC Operators. Note: subclasses should invoke {@link #resetGetCount()} + * Superclass for SDNC Operators. Note: subclasses should invoke {@link #resetPollCount()} * each time they issue an HTTP request. */ public abstract class SoOperation extends HttpOperation<SoResponse> { - private static final Logger logger = LoggerFactory.getLogger(SoOperation.class); private static final Coder coder = new SoCoder(); public static final String PAYLOAD_KEY_VF_COUNT = "vfCount"; @@ -81,8 +73,6 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { public static final String REQ_PARAM_NM = "requestParameters"; public static final String CONFIG_PARAM_NM = "configurationParameters"; - private final SoConfig config; - // values extracted from the parameter Target private final String modelCustomizationId; private final String modelInvariantId; @@ -90,12 +80,6 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { private final String vfCountKey; - /** - * Number of "get" requests issued so far, on the current operation attempt. - */ - @Getter - private int getCount; - /** * Constructs the object. @@ -103,9 +87,10 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { * @param params operation parameters * @param config configuration for this operation */ - public SoOperation(ControlLoopOperationParams params, HttpConfig config) { + public SoOperation(ControlLoopOperationParams params, HttpPollingConfig config) { super(params, config, SoResponse.class); - this.config = (SoConfig) config; + + setUsePolling(); verifyNotNull("Target information", params.getTarget()); @@ -117,11 +102,9 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { + modelVersionId + "]"; } - /** - * Subclasses should invoke this before issuing their first HTTP request. - */ - protected void resetGetCount() { - getCount = 0; + @Override + protected void resetPollCount() { + super.resetPollCount(); setSubRequestId(null); } @@ -193,28 +176,18 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { params.getContext().setProperty(vfCountKey, vfCount); } - /** - * If the response does not indicate that the request has been completed, then sleep a - * bit and issue a "get". - */ @Override - protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url, - Response rawResponse, SoResponse response) { - - // see if the request has "completed", whether or not it was successful + protected Status detmStatus(Response rawResponse, SoResponse response) { if (rawResponse.getStatus() == 200) { String requestState = getRequestState(response); if (COMPLETE.equalsIgnoreCase(requestState)) { extractSubRequestId(response); - successfulCompletion(); - return CompletableFuture - .completedFuture(setOutcome(outcome, PolicyResult.SUCCESS, rawResponse, response)); + return Status.SUCCESS; } if (FAILED.equalsIgnoreCase(requestState)) { extractSubRequestId(response); - return CompletableFuture - .completedFuture(setOutcome(outcome, PolicyResult.FAILURE, rawResponse, response)); + return Status.FAILURE; } } @@ -225,18 +198,12 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { throw new IllegalArgumentException("missing request ID in response"); } - // see if the limit for the number of "gets" has been reached - if (getCount++ >= getMaxGets()) { - logger.warn("{}: execeeded 'get' limit {} for {}", getFullName(), getMaxGets(), params.getRequestId()); - setOutcome(outcome, PolicyResult.FAILURE_TIMEOUT); - outcome.setResponse(response); - outcome.setMessage(SO_RESPONSE_CODE + " " + outcome.getMessage()); - return CompletableFuture.completedFuture(outcome); - } + return Status.STILL_WAITING; + } - // sleep and then perform a "get" operation - Function<Void, CompletableFuture<OperationOutcome>> doGet = unused -> issueGet(outcome); - return sleep(getWaitMsGet(), TimeUnit.MILLISECONDS).thenComposeAsync(doGet); + @Override + protected String getPollingPath() { + return super.getPollingPath() + getSubRequestId(); } @Override @@ -255,30 +222,6 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { } /** - * Invoked when a request completes successfully. - */ - protected void successfulCompletion() { - // do nothing - } - - /** - * Issues a "get" request to see if the original request is complete yet. - * - * @param outcome outcome to be populated with the response - * @return a future that can be used to cancel the "get" request or await its response - */ - private CompletableFuture<OperationOutcome> issueGet(OperationOutcome outcome) { - String path = getPathGet() + getSubRequestId(); - String url = getClient().getBaseUrl() + path; - - logger.debug("{}: 'get' count {} for {}", getFullName(), getCount, params.getRequestId()); - - logMessage(EventType.OUT, CommInfrastructure.REST, url, null); - - return handleResponse(outcome, url, callback -> getClient().get(callback, path, null)); - } - - /** * Gets the request state of a response. * * @param response response from which to get the state @@ -317,8 +260,10 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { // set default result and message setOutcome(outcome, result); + int code = (result == PolicyResult.FAILURE_TIMEOUT ? SO_RESPONSE_CODE : rawResponse.getStatus()); + outcome.setResponse(response); - outcome.setMessage(rawResponse.getStatus() + " " + outcome.getMessage()); + outcome.setMessage(code + " " + outcome.getMessage()); return outcome; } @@ -467,27 +412,6 @@ public abstract class SoOperation extends HttpOperation<SoResponse> { // these may be overridden by junit tests - /** - * Gets the wait time, in milliseconds, between "get" requests. - * - * @return the wait time, in milliseconds, between "get" requests - */ - public long getWaitMsGet() { - return TimeUnit.MILLISECONDS.convert(getWaitSecGet(), TimeUnit.SECONDS); - } - - public int getMaxGets() { - return config.getMaxGets(); - } - - public String getPathGet() { - return config.getPathGet(); - } - - public int getWaitSecGet() { - return config.getWaitSecGet(); - } - @Override protected Coder getCoder() { return coder; diff --git a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoOperator.java b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoOperator.java deleted file mode 100644 index b8d0e652a..000000000 --- a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoOperator.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.so; - -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; - -/** - * SO Operator. - */ -public class SoOperator extends HttpOperator { - - public SoOperator(String actorName, String name, - @SuppressWarnings("rawtypes") OperationMaker<HttpConfig, HttpOperation> operationMaker) { - super(actorName, name, operationMaker); - } - - @Override - protected HttpConfig makeConfiguration(Map<String, Object> parameters) { - SoParams params = Util.translate(getFullName(), parameters, SoParams.class); - ValidationResult result = params.validate(getFullName()); - if (!result.isValid()) { - throw new ParameterValidationRuntimeException("invalid parameters", result); - } - - return new SoConfig(getBlockingExecutor(), params, getClientFactory()); - } -} diff --git a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoParams.java b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoParams.java deleted file mode 100644 index 53f6e932f..000000000 --- a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoParams.java +++ /dev/null @@ -1,55 +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.so; - -import lombok.Data; -import lombok.EqualsAndHashCode; -import lombok.experimental.SuperBuilder; -import org.onap.policy.common.parameters.annotations.Min; -import org.onap.policy.common.parameters.annotations.NotBlank; -import org.onap.policy.common.parameters.annotations.NotNull; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams; - -@NotNull -@NotBlank -@Data -@EqualsAndHashCode(callSuper = true) -@SuperBuilder(toBuilder = true) -public class SoParams extends HttpParams { - - /** - * Path to use for the "get" request. - */ - private String pathGet; - - /** - * Maximum number of "get" requests permitted, after the initial request, to retrieve - * the response. - */ - @Min(0) - private int maxGets; - - /** - * Time, in seconds, to wait between issuing "get" requests. - */ - @Min(1) - private int waitSecGet; -} diff --git a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleCreate.java b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleCreate.java index 6a6c79279..c56bc222f 100644 --- a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleCreate.java +++ b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleCreate.java @@ -24,6 +24,7 @@ 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.apache.commons.lang3.tuple.Pair; import org.onap.aai.domain.yang.CloudRegion; import org.onap.aai.domain.yang.GenericVnf; @@ -35,7 +36,7 @@ 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.OperationOutcome; import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; import org.onap.policy.so.SoModelInfo; import org.onap.policy.so.SoOperationType; import org.onap.policy.so.SoRelatedInstance; @@ -43,6 +44,7 @@ import org.onap.policy.so.SoRelatedInstanceListElement; import org.onap.policy.so.SoRequest; import org.onap.policy.so.SoRequestDetails; import org.onap.policy.so.SoRequestParameters; +import org.onap.policy.so.SoResponse; /** * Operation to create a VF Module. This gets the VF count from the A&AI Custom Query @@ -61,7 +63,7 @@ public class VfModuleCreate extends SoOperation { * @param params operation parameters * @param config configuration for this operation */ - public VfModuleCreate(ControlLoopOperationParams params, HttpConfig config) { + public VfModuleCreate(ControlLoopOperationParams params, HttpPollingConfig config) { super(params, config); // ensure we have the necessary parameters @@ -101,7 +103,7 @@ public class VfModuleCreate extends SoOperation { protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) { // starting a whole new attempt - reset the count - resetGetCount(); + resetPollCount(); Pair<String, SoRequest> pair = makeRequest(); String path = getPath() + pair.getLeft(); @@ -120,11 +122,18 @@ public class VfModuleCreate extends SoOperation { } /** - * Increments the VF count that's stored in the context. + * Increments the VF count that's stored in the context, if the request was + * successful. */ @Override - protected void successfulCompletion() { - setVfCount(getVfCount() + 1); + protected Status detmStatus(Response rawResponse, SoResponse response) { + Status status = super.detmStatus(rawResponse, response); + + if (status == Status.SUCCESS) { + setVfCount(getVfCount() + 1); + } + + return status; } /** diff --git a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleDelete.java b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleDelete.java index 9dbdc58d8..c67243f9f 100644 --- a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleDelete.java +++ b/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/VfModuleDelete.java @@ -47,12 +47,13 @@ import org.onap.policy.common.endpoints.http.client.HttpClient; import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType; import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture; import org.onap.policy.so.SoModelInfo; import org.onap.policy.so.SoOperationType; import org.onap.policy.so.SoRequest; import org.onap.policy.so.SoRequestDetails; +import org.onap.policy.so.SoResponse; /** * Operation to delete a VF Module. This gets the VF count from the A&AI Custom Query @@ -71,7 +72,7 @@ public class VfModuleDelete extends SoOperation { * @param params operation parameters * @param config configuration for this operation */ - public VfModuleDelete(ControlLoopOperationParams params, HttpConfig config) { + public VfModuleDelete(ControlLoopOperationParams params, HttpPollingConfig config) { super(params, config); // ensure we have the necessary parameters @@ -111,7 +112,7 @@ public class VfModuleDelete extends SoOperation { protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) { // starting a whole new attempt - reset the count - resetGetCount(); + resetPollCount(); Pair<String, SoRequest> pair = makeRequest(); SoRequest request = pair.getRight(); @@ -203,12 +204,20 @@ public class VfModuleDelete extends SoOperation { return builder.header("Authorization", "Basic " + encoded); } + /** - * Decrements the VF count that's stored in the context. + * Decrements the VF count that's stored in the context, if the request was + * successful. */ @Override - protected void successfulCompletion() { - setVfCount(getVfCount() - 1); + protected Status detmStatus(Response rawResponse, SoResponse response) { + Status status = super.detmStatus(rawResponse, response); + + if (status == Status.SUCCESS) { + setVfCount(getVfCount() - 1); + } + + return status; } /** diff --git a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/BasicSoOperation.java b/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/BasicSoOperation.java index 11418ff75..c8afab450 100644 --- a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/BasicSoOperation.java +++ b/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/BasicSoOperation.java @@ -35,6 +35,7 @@ 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.Util; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; import org.onap.policy.controlloop.policy.Target; import org.onap.policy.simulators.SoSimulatorJaxRs; import org.onap.policy.so.SoRequest; @@ -56,13 +57,13 @@ public abstract class BasicSoOperation extends BasicHttpOperation<SoRequest> { public static final String MODEL_VERS_ID = "my-model-version-id"; public static final String SUBSCRIPTION_SVC_TYPE = "my-subscription-service-type"; public static final String MY_PATH = "my-path"; - public static final String PATH_GET = "my-path-get/"; - public static final int MAX_GETS = 3; - public static final int WAIT_SEC_GETS = 20; + public static final String POLL_PATH = "my-poll-path/"; + public static final int MAX_POLLS = 3; + public static final int POLL_WAIT_SEC = 20; public static final Integer VF_COUNT = 10; @Mock - protected SoConfig config; + protected HttpPollingConfig config; protected Target target; protected SoResponse response; @@ -134,9 +135,9 @@ public abstract class BasicSoOperation extends BasicHttpOperation<SoRequest> { super.initConfig(); when(config.getClient()).thenReturn(client); when(config.getPath()).thenReturn(MY_PATH); - when(config.getMaxGets()).thenReturn(MAX_GETS); - when(config.getPathGet()).thenReturn(PATH_GET); - when(config.getWaitSecGet()).thenReturn(WAIT_SEC_GETS); + when(config.getMaxPolls()).thenReturn(MAX_POLLS); + when(config.getPollPath()).thenReturn(POLL_PATH); + when(config.getPollWaitSec()).thenReturn(POLL_WAIT_SEC); } @Override diff --git a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoOperationTest.java b/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoOperationTest.java index b794eab4e..46d96fded 100644 --- a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoOperationTest.java +++ b/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoOperationTest.java @@ -28,7 +28,6 @@ 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.when; @@ -37,8 +36,6 @@ import java.time.Month; import java.util.Collections; import java.util.List; import java.util.concurrent.CompletableFuture; -import java.util.concurrent.ForkJoinPool; -import java.util.concurrent.TimeUnit; import java.util.function.Consumer; import java.util.function.Supplier; import org.junit.Before; @@ -56,7 +53,6 @@ import org.onap.policy.controlloop.policy.PolicyResult; import org.onap.policy.so.SoModelInfo; import org.onap.policy.so.SoRequest; import org.onap.policy.so.SoRequestInfo; -import org.onap.policy.so.SoRequestReferences; import org.onap.policy.so.SoRequestStatus; import org.onap.policy.so.SoResponse; @@ -79,11 +75,11 @@ public class SoOperationTest extends BasicSoOperation { } @Test - public void testConstructor_testGetWaitMsGet() { + public void testConstructor() { assertEquals(DEFAULT_ACTOR, oper.getActorName()); assertEquals(DEFAULT_OPERATION, oper.getName()); assertSame(config, oper.getConfig()); - assertEquals(1000 * WAIT_SEC_GETS, oper.getWaitMsGet()); + assertTrue(oper.isUsePolling()); // check when Target is null params = params.toBuilder().target(null).build(); @@ -167,98 +163,6 @@ public class SoOperationTest extends BasicSoOperation { } @Test - public void testPostProcess() throws Exception { - // completed - oper.generateSubRequestId(2); - assertNull(oper.getSubRequestId()); - CompletableFuture<OperationOutcome> future2 = oper.postProcessResponse(outcome, PATH, rawResponse, response); - assertTrue(future2.isDone()); - assertSame(outcome, future2.get()); - assertEquals(PolicyResult.SUCCESS, outcome.getResult()); - assertNotNull(oper.getSubRequestId()); - assertSame(response, outcome.getResponse()); - - // failed - oper.generateSubRequestId(2); - assertNull(oper.getSubRequestId()); - response.getRequest().getRequestStatus().setRequestState(SoOperation.FAILED); - future2 = oper.postProcessResponse(outcome, PATH, rawResponse, response); - assertTrue(future2.isDone()); - assertSame(outcome, future2.get()); - assertEquals(PolicyResult.FAILURE, outcome.getResult()); - assertNotNull(oper.getSubRequestId()); - assertSame(response, outcome.getResponse()); - - // no request id in the response - oper.generateSubRequestId(2); - assertNull(oper.getSubRequestId()); - response.getRequestReferences().setRequestId(null); - response.getRequest().getRequestStatus().setRequestState("unknown"); - assertThatIllegalArgumentException() - .isThrownBy(() -> oper.postProcessResponse(outcome, PATH, rawResponse, response)) - .withMessage("missing request ID in response"); - response.getRequestReferences().setRequestId(REQ_ID.toString()); - - // status = 500 - when(rawResponse.getStatus()).thenReturn(500); - - // null request reference - SoRequestReferences ref = response.getRequestReferences(); - response.setRequestReferences(null); - assertThatIllegalArgumentException() - .isThrownBy(() -> oper.postProcessResponse(outcome, PATH, rawResponse, response)) - .withMessage("missing request ID in response"); - response.setRequestReferences(ref); - } - - /** - * Tests postProcess() when the "get" is repeated a couple of times. - */ - @Test - public void testPostProcessRepeated_testResetGetCount() throws Exception { - /* - * Two failures and then a success - should result in two "get" calls. - * - * Note: getStatus() is invoked twice during each call, so have to double up the - * return values. - */ - when(rawResponse.getStatus()).thenReturn(500, 500, 500, 500, 200, 200); - - when(client.get(any(), any(), any())).thenAnswer(provideResponse(rawResponse)); - - // use a real executor - params = params.toBuilder().executor(ForkJoinPool.commonPool()).build(); - - oper = new SoOperation(params, config) { - @Override - public long getWaitMsGet() { - return 1; - } - }; - - CompletableFuture<OperationOutcome> future2 = oper.postProcessResponse(outcome, PATH, rawResponse, response); - - assertSame(outcome, future2.get(5, TimeUnit.SECONDS)); - assertEquals(PolicyResult.SUCCESS, outcome.getResult()); - assertEquals(2, oper.getGetCount()); - - /* - * repeat - this time, the "get" operations will be exhausted, so it should fail - */ - when(rawResponse.getStatus()).thenReturn(500); - - future2 = oper.postProcessResponse(outcome, PATH, rawResponse, response); - - assertSame(outcome, future2.get(5, TimeUnit.SECONDS)); - assertEquals(PolicyResult.FAILURE_TIMEOUT, outcome.getResult()); - assertEquals(MAX_GETS + 1, oper.getGetCount()); - - oper.resetGetCount(); - assertEquals(0, oper.getGetCount()); - assertNull(oper.getSubRequestId()); - } - - @Test public void testGetRequestState() { SoResponse resp = new SoResponse(); assertNull(oper.getRequestState(resp)); diff --git a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleCreateTest.java b/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleCreateTest.java index 2b3e1163b..94268646d 100644 --- a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleCreateTest.java +++ b/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleCreateTest.java @@ -51,6 +51,8 @@ import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; import org.onap.policy.common.utils.coder.CoderException; import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams; import org.onap.policy.controlloop.policy.PolicyResult; import org.onap.policy.so.SoRequest; import org.onap.policy.so.SoResponse; @@ -88,11 +90,13 @@ public class VfModuleCreateTest extends BasicSoOperation { */ @Test public void testSuccess() throws Exception { - SoParams opParams = SoParams.builder().clientName(MY_CLIENT).path("serviceInstantiation/v7/serviceInstances") - .pathGet("orchestrationRequests/v5/").maxGets(2).build(); - config = new SoConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); + HttpPollingParams opParams = HttpPollingParams.builder().clientName(MY_CLIENT) + .path("serviceInstantiation/v7/serviceInstances").pollPath("orchestrationRequests/v5/") + .maxPolls(2).build(); + config = new HttpPollingConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build(); + oper = new VfModuleCreate(params, config); outcome = oper.start().get(); @@ -179,7 +183,7 @@ public class VfModuleCreateTest extends BasicSoOperation { oper = new VfModuleCreate(params, config) { @Override - public long getWaitMsGet() { + protected long getPollWaitMs() { return 1; } }; @@ -197,10 +201,10 @@ public class VfModuleCreateTest extends BasicSoOperation { } /** - * Tests startOperationAsync() when "get" operations are required. + * Tests startOperationAsync() when polling is required. */ @Test - public void testStartOperationAsyncWithGets() throws Exception { + public void testStartOperationAsyncWithPolling() throws Exception { when(rawResponse.getStatus()).thenReturn(500, 500, 500, 500, 200, 200); when(client.post(any(), any(), any(), any())).thenAnswer(provideResponse(rawResponse)); @@ -211,7 +215,7 @@ public class VfModuleCreateTest extends BasicSoOperation { oper = new VfModuleCreate(params, config) { @Override - public long getWaitMsGet() { + public long getPollWaitMs() { return 1; } }; diff --git a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleDeleteTest.java b/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleDeleteTest.java index f5d05a0e8..d7b53411b 100644 --- a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleDeleteTest.java +++ b/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/VfModuleDeleteTest.java @@ -64,7 +64,8 @@ import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; import org.onap.policy.common.utils.coder.CoderException; import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams; import org.onap.policy.controlloop.policy.PolicyResult; import org.onap.policy.so.SoRequest; import org.onap.policy.so.SoResponse; @@ -119,11 +120,12 @@ public class VfModuleDeleteTest extends BasicSoOperation { */ @Test public void testSuccess() throws Exception { - SoParams opParams = SoParams.builder().clientName(MY_CLIENT).path("serviceInstances/v7") - .pathGet("orchestrationRequests/v5/").maxGets(2).build(); - config = new SoConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); + HttpPollingParams opParams = HttpPollingParams.builder().clientName(MY_CLIENT).path("serviceInstances/v7") + .pollPath("orchestrationRequests/v5/").maxPolls(2).build(); + config = new HttpPollingConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build(); + oper = new VfModuleDelete(params, config); outcome = oper.start().get(); @@ -138,7 +140,7 @@ public class VfModuleDeleteTest extends BasicSoOperation { // verify that target validation is done params = params.toBuilder().target(null).build(); - assertThatIllegalArgumentException().isThrownBy(() -> new VfModuleDelete(params, config)) + assertThatIllegalArgumentException().isThrownBy(() -> new MyOperation(params, config)) .withMessageContaining("Target information"); } @@ -208,7 +210,7 @@ public class VfModuleDeleteTest extends BasicSoOperation { oper = new MyOperation(params, config) { @Override - public long getWaitMsGet() { + public long getPollWaitMs() { return 1; } }; @@ -226,10 +228,10 @@ public class VfModuleDeleteTest extends BasicSoOperation { } /** - * Tests startOperationAsync() when "get" operations are required. + * Tests startOperationAsync() when polling is required. */ @Test - public void testStartOperationAsyncWithGets() throws Exception { + public void testStartOperationAsyncWithPolling() throws Exception { // indicate that the response was incomplete configureResponse(coder.encode(response).replace("COMPLETE", "incomplete")); @@ -242,7 +244,7 @@ public class VfModuleDeleteTest extends BasicSoOperation { oper = new MyOperation(params, config) { @Override - public long getWaitMsGet() { + public long getPollWaitMs() { return 1; } }; @@ -383,7 +385,7 @@ public class VfModuleDeleteTest extends BasicSoOperation { @Test public void testMakeHttpClient() { // must use a real operation to invoke this method - assertNotNull(new VfModuleDelete(params, config).makeHttpClient()); + assertNotNull(new MyOperation(params, config).makeHttpClient()); } @@ -428,7 +430,7 @@ public class VfModuleDeleteTest extends BasicSoOperation { private class MyOperation extends VfModuleDelete { - public MyOperation(ControlLoopOperationParams params, HttpConfig config) { + public MyOperation(ControlLoopOperationParams params, HttpPollingConfig config) { super(params, config); } diff --git a/models-interactions/model-actors/actor.so/src/test/resources/service.yaml b/models-interactions/model-actors/actor.so/src/test/resources/service.yaml index e1cb0d9f3..e16e7d74a 100644 --- a/models-interactions/model-actors/actor.so/src/test/resources/service.yaml +++ b/models-interactions/model-actors/actor.so/src/test/resources/service.yaml @@ -26,8 +26,11 @@ httpClients: actors: SO: clientName: my-client + pollPath: orchestrationRequests/v5 + pollWaitSec: 20 + maxPolls: 20 operations: VF Module Create: path: serviceInstantiation/v7/serviceInstances VF Module Delete: - path: serviceInstances/v7
\ No newline at end of file + path: serviceInstances/v7 diff --git a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/Restart.java b/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/Restart.java index b6b82d14f..bc9642888 100644 --- a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/Restart.java +++ b/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/Restart.java @@ -41,7 +41,7 @@ public class Restart extends VfcOperation { protected CompletableFuture<OperationOutcome> startOperationAsync(int attempt, OperationOutcome outcome) { // starting a whole new attempt - reset the count - resetGetCount(); + resetPollCount(); Pair<String, VfcRequest> pair = makeRequest(); Entity<VfcRequest> entity = Entity.entity(pair.getRight(), MediaType.APPLICATION_JSON); diff --git a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcActorServiceProvider.java b/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcActorServiceProvider.java index 5bd6b59ad..768ad4c11 100644 --- a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcActorServiceProvider.java +++ b/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcActorServiceProvider.java @@ -27,14 +27,16 @@ import java.util.List; import org.onap.policy.aai.AaiCqResponse; import org.onap.policy.controlloop.ControlLoopOperation; import org.onap.policy.controlloop.VirtualControlLoopEvent; -import org.onap.policy.controlloop.actorserviceprovider.impl.ActorImpl; +import org.onap.policy.controlloop.actorserviceprovider.impl.HttpActor; +import org.onap.policy.controlloop.actorserviceprovider.impl.HttpPollingOperator; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingActorParams; import org.onap.policy.controlloop.policy.Policy; import org.onap.policy.vfc.VfcHealActionVmInfo; import org.onap.policy.vfc.VfcHealAdditionalParams; import org.onap.policy.vfc.VfcHealRequest; import org.onap.policy.vfc.VfcRequest; -public class VfcActorServiceProvider extends ActorImpl { +public class VfcActorServiceProvider extends HttpActor<HttpPollingActorParams> { private static final String GENERIC_VNF_ID = "generic-vnf.vnf-id"; // TODO old code: remove lines down to **HERE** @@ -60,9 +62,9 @@ public class VfcActorServiceProvider extends ActorImpl { * Constructor. */ public VfcActorServiceProvider() { - super(NAME); + super(NAME, HttpPollingActorParams.class); - addOperator(new VfcOperator(NAME, Restart.NAME, Restart::new)); + addOperator(new HttpPollingOperator(NAME, Restart.NAME, Restart::new)); } // TODO old code: remove lines down to **HERE** diff --git a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcConfig.java b/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcConfig.java deleted file mode 100644 index 4b5088a3a..000000000 --- a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcConfig.java +++ /dev/null @@ -1,63 +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.vfc; - -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; - -@Getter -public class VfcConfig extends HttpConfig { - - /** - * Path to use for the "get" request. A trailing "/" is added, if it is missing. - */ - private String pathGet; - - /** - * Maximum number of "get" requests permitted, after the initial request, to retrieve - * the response. - */ - private int maxGets; - - /** - * Time, in seconds, to wait between issuing "get" requests. - */ - private int waitSecGet; - - /** - * Constructor. - * - * @param blockingExecutor executor to be used for tasks that may perform blocking I/O - * @param params operator parameters - * @param clientFactory factory from which to obtain the {@link HttpClient} - */ - public VfcConfig(Executor blockingExecutor, VfcParams params, HttpClientFactory clientFactory) { - super(blockingExecutor, params, clientFactory); - - this.pathGet = params.getPathGet() + (params.getPathGet().endsWith("/") ? "" : "/"); - this.maxGets = params.getMaxGets(); - this.waitSecGet = params.getWaitSecGet(); - } - -} diff --git a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcOperation.java b/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcOperation.java index 573ee2698..d5ee44a5d 100644 --- a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcOperation.java +++ b/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcOperation.java @@ -21,13 +21,8 @@ package org.onap.policy.controlloop.actor.vfc; import java.util.concurrent.CompletableFuture; -import java.util.concurrent.TimeUnit; -import java.util.function.Function; import javax.ws.rs.core.Response; -import lombok.Getter; import org.apache.commons.lang3.StringUtils; -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.OperationOutcome; import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext; import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation; @@ -39,12 +34,8 @@ import org.onap.policy.vfc.VfcHealAdditionalParams; import org.onap.policy.vfc.VfcHealRequest; import org.onap.policy.vfc.VfcRequest; import org.onap.policy.vfc.VfcResponse; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; public abstract class VfcOperation extends HttpOperation<VfcResponse> { - private static final Logger logger = LoggerFactory.getLogger(VfcOperation.class); - public static final String FAILED = "FAILED"; public static final String COMPLETE = "COMPLETE"; public static final int VFC_RESPONSE_CODE = 999; @@ -53,13 +44,11 @@ public abstract class VfcOperation extends HttpOperation<VfcResponse> { public static final String REQ_PARAM_NM = "requestParameters"; public static final String CONFIG_PARAM_NM = "configurationParameters"; - private final VfcConfig config; - /** - * Number of "get" requests issued so far, on the current operation attempt. + * Job ID extracted from the first response. */ - @Getter - private int getCount; + private String jobId; + /** * Constructs the object. @@ -69,14 +58,19 @@ public abstract class VfcOperation extends HttpOperation<VfcResponse> { */ public VfcOperation(ControlLoopOperationParams params, HttpConfig config) { super(params, config, VfcResponse.class); - this.config = (VfcConfig) config; + + setUsePolling(); } - /** - * Subclasses should invoke this before issuing their first HTTP request. - */ - protected void resetGetCount() { - getCount = 0; + @Override + protected void resetPollCount() { + super.resetPollCount(); + jobId = null; + } + + @Override + protected String getPollingPath() { + return super.getPollingPath() + jobId; } /** @@ -87,64 +81,38 @@ public abstract class VfcOperation extends HttpOperation<VfcResponse> { return startGuardAsync(); } - /** - * If the response does not indicate that the request has been completed, then sleep a - * bit and issue a "get". - */ @Override - protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url, - Response rawResponse, VfcResponse response) { - // Determine if the request has "completed" and determine if it was successful + protected Status detmStatus(Response rawResponse, VfcResponse response) { if (rawResponse.getStatus() == 200) { String requestState = getRequestState(response); if ("finished".equalsIgnoreCase(requestState)) { - return CompletableFuture - .completedFuture(setOutcome(outcome, PolicyResult.SUCCESS, rawResponse, response)); + extractJobId(response); + return Status.SUCCESS; } if ("error".equalsIgnoreCase(requestState)) { - return CompletableFuture - .completedFuture(setOutcome(outcome, PolicyResult.FAILURE, rawResponse, response)); + extractJobId(response); + return Status.FAILURE; } } // still incomplete - // need a request ID with which to query - if (response == null || response.getJobId() == null) { + // need a job ID with which to query + if (jobId == null && !extractJobId(response)) { throw new IllegalArgumentException("missing job ID in response"); } - // see if the limit for the number of "gets" has been reached - if (getCount++ >= getMaxGets()) { - logger.warn("{}: execeeded 'get' limit {} for {}", getFullName(), getMaxGets(), params.getRequestId()); - setOutcome(outcome, PolicyResult.FAILURE_TIMEOUT); - outcome.setResponse(response); - outcome.setMessage(VFC_RESPONSE_CODE + " " + outcome.getMessage()); - return CompletableFuture.completedFuture(outcome); - } - - // sleep and then perform a "get" operation - Function<Void, CompletableFuture<OperationOutcome>> doGet = unused -> issueGet(outcome, response); - return sleep(getWaitMsGet(), TimeUnit.MILLISECONDS).thenComposeAsync(doGet); + return Status.STILL_WAITING; } - /** - * Issues a "get" request to see if the original request is complete yet. - * - * @param outcome outcome to be populated with the response - * @param response previous response - * @return a future that can be used to cancel the "get" request or await its response - */ - private CompletableFuture<OperationOutcome> issueGet(OperationOutcome outcome, VfcResponse response) { - String path = getPathGet() + response.getJobId(); - String url = getClient().getBaseUrl() + path; - - logger.debug("{}: 'get' count {} for {}", getFullName(), getCount, params.getRequestId()); - - logMessage(EventType.OUT, CommInfrastructure.REST, url, null); + private boolean extractJobId(VfcResponse response) { + if (response == null || response.getJobId() == null) { + return false; + } - return handleResponse(outcome, url, callback -> getClient().get(callback, path, null)); + jobId = response.getJobId(); + return true; } /** @@ -180,8 +148,10 @@ public abstract class VfcOperation extends HttpOperation<VfcResponse> { // set default result and message setOutcome(outcome, result); + int code = (result == PolicyResult.FAILURE_TIMEOUT ? VFC_RESPONSE_CODE : rawResponse.getStatus()); + outcome.setResponse(response); - outcome.setMessage(rawResponse.getStatus() + " " + outcome.getMessage()); + outcome.setMessage(code + " " + outcome.getMessage()); return outcome; } @@ -221,27 +191,4 @@ public abstract class VfcOperation extends HttpOperation<VfcResponse> { return request; } - - // These may be overridden by jUnit tests - - /** - * Gets the wait time, in milliseconds, between "get" requests. - * - * @return the wait time, in milliseconds, between "get" requests - */ - public long getWaitMsGet() { - return TimeUnit.MILLISECONDS.convert(getWaitSecGet(), TimeUnit.SECONDS); - } - - public int getMaxGets() { - return config.getMaxGets(); - } - - public String getPathGet() { - return config.getPathGet(); - } - - public int getWaitSecGet() { - return config.getWaitSecGet(); - } } diff --git a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcOperator.java b/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcOperator.java deleted file mode 100644 index 4e70d6550..000000000 --- a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcOperator.java +++ /dev/null @@ -1,49 +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.vfc; - -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; - -public class VfcOperator extends HttpOperator { - - public VfcOperator(String actorName, String name, - @SuppressWarnings("rawtypes") OperationMaker<HttpConfig, HttpOperation> operationMaker) { - super(actorName, name, operationMaker); - } - - @Override - protected HttpConfig makeConfiguration(Map<String, Object> parameters) { - VfcParams params = Util.translate(getFullName(), parameters, VfcParams.class); - ValidationResult result = params.validate(getFullName()); - if (!result.isValid()) { - throw new ParameterValidationRuntimeException("invalid parameters", result); - } - - return new VfcConfig(getBlockingExecutor(), params, getClientFactory()); - } -} diff --git a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/BasicVfcOperation.java b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/BasicVfcOperation.java index 47371d2b3..d41da1b87 100644 --- a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/BasicVfcOperation.java +++ b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/BasicVfcOperation.java @@ -27,17 +27,18 @@ 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.parameters.HttpPollingConfig; import org.onap.policy.simulators.Util; import org.onap.policy.vfc.VfcRequest; import org.onap.policy.vfc.VfcResponse; public abstract class BasicVfcOperation extends BasicHttpOperation<VfcRequest> { - public static final String PATH_GET = "my-path-get/"; - public static final int MAX_GETS = 3; - public static final int WAIT_SEC_GETS = 20; + public static final String POLL_PATH = "my-path-get/"; + public static final int MAX_POLLS = 3; + public static final int POLL_WAIT_SEC = 20; @Mock - protected VfcConfig config; + protected HttpPollingConfig config; protected VfcResponse response; @@ -94,9 +95,9 @@ public abstract class BasicVfcOperation extends BasicHttpOperation<VfcRequest> { protected void initConfig() { super.initConfig(); when(config.getClient()).thenReturn(client); - when(config.getMaxGets()).thenReturn(MAX_GETS); - when(config.getPathGet()).thenReturn(PATH_GET); - when(config.getWaitSecGet()).thenReturn(WAIT_SEC_GETS); + when(config.getMaxPolls()).thenReturn(MAX_POLLS); + when(config.getPollPath()).thenReturn(POLL_PATH); + when(config.getPollWaitSec()).thenReturn(POLL_WAIT_SEC); } } diff --git a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/RestartTest.java b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/RestartTest.java index d8ba7e4e8..ed072f761 100644 --- a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/RestartTest.java +++ b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/RestartTest.java @@ -32,6 +32,8 @@ import org.junit.BeforeClass; import org.junit.Test; import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams; import org.onap.policy.controlloop.policy.PolicyResult; import org.onap.policy.vfc.VfcRequest; import org.onap.policy.vfc.VfcResponse; @@ -66,10 +68,12 @@ public class RestartTest extends BasicVfcOperation { */ @Test public void testSuccess() throws Exception { - VfcParams opParams = VfcParams.builder().clientName(MY_CLIENT).path("ns").pathGet("jobs").maxGets(1).build(); - config = new VfcConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); + HttpPollingParams opParams = HttpPollingParams.builder().clientName(MY_CLIENT).path("ns").pollPath("jobs") + .maxPolls(1).build(); + config = new HttpPollingConfig(blockingExecutor, opParams, HttpClientFactoryInstance.getClientFactory()); params = params.toBuilder().retry(0).timeoutSec(5).executor(blockingExecutor).build(); + restartOper = new Restart(params, config); outcome = restartOper.start().get(); @@ -81,7 +85,7 @@ public class RestartTest extends BasicVfcOperation { public void testConstructor() { CompletableFuture<OperationOutcome> futureRes = restartOper.startOperationAsync(1, outcome); assertNotNull(futureRes); - assertEquals(0, restartOper.getGetCount()); + assertEquals(0, restartOper.getPollCount()); } @Test diff --git a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcConfigTest.java b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcConfigTest.java deleted file mode 100644 index f03e32393..000000000 --- a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcConfigTest.java +++ /dev/null @@ -1,85 +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.vfc; - -import static org.junit.Assert.assertEquals; -import static org.junit.Assert.assertSame; -import static org.mockito.Mockito.when; - -import java.util.concurrent.Executor; -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; - -public class VfcConfigTest { - private static final String MY_CLIENT = "my-client"; - private static final String MY_PATH = "my-path"; - private static final String GET_PATH = "get-path"; - private static final int TIMEOUT_SEC = 10; - private static final int MAX_GETS = 20; - private static final int WAIT_SEC = 30; - - @Mock - private HttpClient client; - @Mock - private HttpClientFactory factory; - @Mock - private Executor executor; - - private VfcParams params; - private VfcConfig config; - - /** - * Setup. - * - * @throws Exception Exception - */ - @Before - public void setUp() throws Exception { - MockitoAnnotations.initMocks(this); - - when(factory.get(MY_CLIENT)).thenReturn(client); - - params = VfcParams.builder().maxGets(MAX_GETS).pathGet(GET_PATH).waitSecGet(WAIT_SEC).clientName(MY_CLIENT) - .path(MY_PATH).timeoutSec(TIMEOUT_SEC).build(); - config = new VfcConfig(executor, params, factory); - } - - @Test - public void test() { - assertEquals(GET_PATH + "/", config.getPathGet()); - assertEquals(MAX_GETS, config.getMaxGets()); - assertEquals(WAIT_SEC, config.getWaitSecGet()); - - // check value from superclass - assertSame(executor, config.getBlockingExecutor()); - assertSame(client, config.getClient()); - - // path with trailing "/" - params = params.toBuilder().pathGet(GET_PATH + "/").build(); - config = new VfcConfig(executor, params, factory); - assertEquals(GET_PATH + "/", config.getPathGet()); - } - -} diff --git a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcOperationTest.java b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcOperationTest.java index 0b58fd4a3..425ff91b1 100644 --- a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcOperationTest.java +++ b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcOperationTest.java @@ -20,20 +20,15 @@ package org.onap.policy.controlloop.actor.vfc; -import static org.assertj.core.api.Assertions.assertThatExceptionOfType; 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 java.util.concurrent.CompletableFuture; import org.junit.Before; import org.junit.Test; import org.mockito.Mockito; -import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; -import org.onap.policy.controlloop.policy.PolicyResult; import org.onap.policy.vfc.VfcResponse; import org.onap.policy.vfc.VfcResponseDescriptor; @@ -55,11 +50,11 @@ public class VfcOperationTest extends BasicVfcOperation { } @Test - public void testConstructor_testGetWaitMsGet() { + public void testConstructor() { assertEquals(DEFAULT_ACTOR, oper.getActorName()); assertEquals(DEFAULT_OPERATION, oper.getName()); assertSame(config, oper.getConfig()); - assertEquals(1000 * WAIT_SEC_GETS, oper.getWaitMsGet()); + assertTrue(oper.isUsePolling()); } @Test @@ -68,44 +63,9 @@ public class VfcOperationTest extends BasicVfcOperation { } @Test - public void testResetGetCount() { - oper.resetGetCount(); - assertEquals(0, oper.getGetCount()); - } - - @Test - public void testPostProcess() throws Exception { - - assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> { - oper.postProcessResponse(outcome, PATH, rawResponse, response); - }); - - response.setResponseDescriptor(new VfcResponseDescriptor()); - response.setJobId("sampleJobId"); - - // null status - CompletableFuture<OperationOutcome> future2 = oper.postProcessResponse(outcome, PATH, rawResponse, response); - assertFalse(future2.isDone()); - - response.getResponseDescriptor().setStatus("FinisHeD"); - future2 = oper.postProcessResponse(outcome, PATH, rawResponse, response); - assertTrue(future2.isDone()); - assertSame(outcome, future2.get()); - assertEquals(PolicyResult.SUCCESS, outcome.getResult()); - assertSame(response, outcome.getResponse()); - - // failed - response.getResponseDescriptor().setStatus("eRRor"); - future2 = oper.postProcessResponse(outcome, PATH, rawResponse, response); - assertTrue(future2.isDone()); - assertSame(outcome, future2.get()); - assertEquals(PolicyResult.FAILURE, outcome.getResult()); - assertSame(response, outcome.getResponse()); - - // unfinished - response.getResponseDescriptor().setStatus("anything but finished"); - future2 = oper.postProcessResponse(outcome, PATH, rawResponse, response); - assertFalse(future2.isDone()); + public void testResetPollCount() { + oper.resetPollCount(); + assertEquals(0, oper.getPollCount()); } @Test diff --git a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcOperatorTest.java b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcOperatorTest.java deleted file mode 100644 index d469d5a74..000000000 --- a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcOperatorTest.java +++ /dev/null @@ -1,102 +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.vfc; - -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 VfcOperatorTest { - 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 String PATH_GET = "my-path-get/"; - private static final int MAX_GETS = 3; - private static final int WAIT_SEC_GETS = 20; - private static final int TIMEOUT = 100; - - private VfcOperator oper; - - @Mock - private HttpClient client; - - @Mock - private HttpClientFactory factory; - - /** - * setUp. - * - * @throws Exception exception - */ - @Before - public void setUp() throws Exception { - MockitoAnnotations.initMocks(this); - - when(factory.get(CLIENT)).thenReturn(client); - - oper = new MyOperator(); - - VfcParams params = VfcParams.builder().pathGet(PATH_GET).maxGets(MAX_GETS).waitSecGet(WAIT_SEC_GETS) - .clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build(); - Map<String, Object> paramMap = Util.translateToMap(OPERATION, params); - oper.configure(paramMap); - } - - @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 VfcConfig); - - // test invalid parameters - Map<String, Object> paramMap2 = Util.translateToMap(OPERATION, VfcParams.builder().build()); - assertThatThrownBy(() -> oper.configure(paramMap2)).isInstanceOf(ParameterValidationRuntimeException.class); - } - - private class MyOperator extends VfcOperator { - - public MyOperator() { - super(ACTOR, OPERATION, null); - } - - @Override - protected HttpClientFactory getClientFactory() { - return factory; - } - } -} diff --git a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcParamsTest.java b/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcParamsTest.java deleted file mode 100644 index 5e324463f..000000000 --- a/models-interactions/model-actors/actor.vfc/src/test/java/org/onap/policy/controlloop/actor/vfc/VfcParamsTest.java +++ /dev/null @@ -1,93 +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.vfc; - -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.assertTrue; - -import java.util.function.Function; -import org.junit.Before; -import org.junit.Test; -import org.onap.policy.common.parameters.ValidationResult; -import org.onap.policy.controlloop.actor.vfc.VfcParams.VfcParamsBuilder; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams.HttpParamsBuilder; - -public class VfcParamsTest { - private static final String CONTAINER = "my-container"; - private static final String CLIENT = "my-client"; - private static final String PATH = "my-path"; - private static final String PATH_GET = "my-path-get"; - private static final int MAX_GETS = 3; - private static final int WAIT_SEC_GETS = 20; - private static final int TIMEOUT = 10; - - private VfcParams params; - - @Before - public void setUp() throws Exception { - params = VfcParams.builder().pathGet(PATH_GET).maxGets(MAX_GETS).waitSecGet(WAIT_SEC_GETS).clientName(CLIENT) - .path(PATH).timeoutSec(TIMEOUT).build(); - } - - @Test - public void testValidate() { - assertTrue(params.validate(CONTAINER).isValid()); - - testValidateField("pathGet", "null", bldr -> bldr.pathGet(null)); - testValidateField("maxGets", "minimum", bldr -> bldr.maxGets(-1)); - testValidateField("waitSecGet", "minimum", bldr -> bldr.waitSecGet(-1)); - - // validate one of the superclass fields - testValidateField("clientName", "null", bldr -> bldr.clientName(null)); - - // check edge cases - assertTrue(params.toBuilder().maxGets(0).build().validate(CONTAINER).isValid()); - assertFalse(params.toBuilder().waitSecGet(0).build().validate(CONTAINER).isValid()); - assertTrue(params.toBuilder().waitSecGet(1).build().validate(CONTAINER).isValid()); - } - - @Test - public void testBuilder_testToBuilder() { - assertEquals(CLIENT, params.getClientName()); - - assertEquals(PATH_GET, params.getPathGet()); - assertEquals(MAX_GETS, params.getMaxGets()); - assertEquals(WAIT_SEC_GETS, params.getWaitSecGet()); - - assertEquals(params, params.toBuilder().build()); - } - - private void testValidateField(String fieldName, String expected, - @SuppressWarnings("rawtypes") Function<VfcParamsBuilder, HttpParamsBuilder> makeInvalid) { - - // original params should be valid - ValidationResult result = params.validate(CONTAINER); - assertTrue(fieldName, result.isValid()); - - // make invalid params - result = makeInvalid.apply(params.toBuilder()).build().validate(CONTAINER); - assertFalse(fieldName, result.isValid()); - assertThat(result.getResult()).contains(fieldName).contains(expected); - } - -} diff --git a/models-interactions/model-actors/actor.vfc/src/test/resources/service.yaml b/models-interactions/model-actors/actor.vfc/src/test/resources/service.yaml index f6988517b..04d9e4639 100644 --- a/models-interactions/model-actors/actor.vfc/src/test/resources/service.yaml +++ b/models-interactions/model-actors/actor.vfc/src/test/resources/service.yaml @@ -25,11 +25,11 @@ httpClients: managed: true actors: VFC: + clientName: my-client + pollPath: jobs + pollWaitSec: 20 + maxPolls: 20 operations: Restart: - clientName: my-client - pathGet: jobs - maxGets: 20 - waitSecGet: 20 path: ns timeoutSec: 60 diff --git a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/BidirectionalTopicOperator.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/BidirectionalTopicOperator.java index 43c8b8872..0745c3aba 100644 --- a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/BidirectionalTopicOperator.java +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/BidirectionalTopicOperator.java @@ -23,14 +23,10 @@ package org.onap.policy.controlloop.actorserviceprovider.impl; import java.util.Arrays; import java.util.List; import java.util.Map; -import lombok.Getter; import org.onap.policy.common.parameters.ValidationResult; -import org.onap.policy.controlloop.actorserviceprovider.Operation; import org.onap.policy.controlloop.actorserviceprovider.Util; import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig; import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicParams; -import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams; import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException; import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler; import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicManager; @@ -40,13 +36,8 @@ import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey; * Operator that uses a bidirectional topic. Topic operators may share a * {@link BidirectionalTopicHandler}. */ -public class BidirectionalTopicOperator extends OperatorPartial { - - /** - * Function to make an operation. - */ - @SuppressWarnings("rawtypes") - private final OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation> operationMaker; +public class BidirectionalTopicOperator + extends TypedOperator<BidirectionalTopicConfig, BidirectionalTopicOperation<?, ?>> { /** * Manager from which to get the topic handlers. @@ -58,12 +49,6 @@ public class BidirectionalTopicOperator extends OperatorPartial { */ private final List<SelectorKey> selectorKeys; - /** - * Current configuration. This is set by {@link #doConfigure(Map)}. - */ - @Getter - private BidirectionalTopicConfig currentConfig; - /** * Constructs the object. @@ -88,17 +73,13 @@ public class BidirectionalTopicOperator extends OperatorPartial { * @param selectorKeys keys used to extract the fields used to select responses for * this operator */ - // @formatter:off public BidirectionalTopicOperator(String actorName, String name, BidirectionalTopicManager topicManager, List<SelectorKey> selectorKeys, - @SuppressWarnings("rawtypes") OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation> - operationMaker) { - // @formatter:on + OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation<?, ?>> operationMaker) { - super(actorName, name); + super(actorName, name, operationMaker); this.topicManager = topicManager; this.selectorKeys = selectorKeys; - this.operationMaker = operationMaker; } /** @@ -110,25 +91,13 @@ public class BidirectionalTopicOperator extends OperatorPartial { * @param selectorKeys keys used to extract the fields used to select responses for * this operator */ - // @formatter:off public BidirectionalTopicOperator(String actorName, String name, BidirectionalTopicManager topicManager, - @SuppressWarnings("rawtypes") OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation> - operationMaker, + OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation<?, ?>> operationMaker, SelectorKey... selectorKeys) { - // @formatter:on this(actorName, name, topicManager, Arrays.asList(selectorKeys), operationMaker); } /** - * Translates the parameters to an {@link HttpParams} and then extracts the relevant - * values. - */ - @Override - protected void doConfigure(Map<String, Object> parameters) { - currentConfig = makeConfiguration(parameters); - } - - /** * Makes a new configuration using the specified parameters. * * @param parameters operator parameters @@ -143,15 +112,4 @@ public class BidirectionalTopicOperator extends OperatorPartial { return new BidirectionalTopicConfig(getBlockingExecutor(), params, topicManager, selectorKeys); } - - @Override - public Operation buildOperation(ControlLoopOperationParams params) { - if (operationMaker == null) { - throw new UnsupportedOperationException("cannot make operation for " + getFullName()); - } - - verifyRunning(); - - return operationMaker.apply(params, currentConfig); - } } diff --git a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpActor.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpActor.java index eb5662f23..5a6081611 100644 --- a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpActor.java +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpActor.java @@ -34,7 +34,7 @@ import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpActorPara public class HttpActor<P extends HttpActorParams> extends ActorImpl { /** - * Class of parameters. + * Class of Actor parameters. */ private final Class<P> paramsClass; diff --git a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpOperation.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpOperation.java index fb6d38292..4800b3a4b 100644 --- a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpOperation.java +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpOperation.java @@ -25,6 +25,7 @@ import java.util.Map; import java.util.concurrent.CompletableFuture; import java.util.concurrent.Executor; import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; import java.util.function.Function; import javax.ws.rs.client.InvocationCallback; import javax.ws.rs.core.Response; @@ -38,6 +39,7 @@ import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture; import org.onap.policy.controlloop.policy.PolicyResult; import org.slf4j.Logger; @@ -53,6 +55,13 @@ public abstract class HttpOperation<T> extends OperationPartial { private static final Logger logger = LoggerFactory.getLogger(HttpOperation.class); /** + * Response status. + */ + public enum Status { + SUCCESS, FAILURE, STILL_WAITING + } + + /** * Configuration for this operation. */ private final HttpConfig config; @@ -62,6 +71,18 @@ public abstract class HttpOperation<T> extends OperationPartial { */ private final Class<T> responseClass; + /** + * {@code True} to use polling, {@code false} otherwise. + */ + @Getter + private boolean usePolling; + + /** + * Number of polls issued so far, on the current operation attempt. + */ + @Getter + private int pollCount; + /** * Constructs the object. @@ -76,6 +97,17 @@ public abstract class HttpOperation<T> extends OperationPartial { this.responseClass = clazz; } + /** + * Indicates that polling should be used. + */ + protected void setUsePolling() { + if (!(config instanceof HttpPollingConfig)) { + throw new IllegalStateException("cannot poll without polling parameters"); + } + + usePolling = true; + } + public HttpClient getClient() { return config.getClient(); } @@ -123,6 +155,17 @@ public abstract class HttpOperation<T> extends OperationPartial { } /** + * Resets the polling count + * + * <p/> + * Note: This should be invoked at the start of each operation (i.e., in + * {@link #startOperationAsync(int, OperationOutcome)}. + */ + protected void resetPollCount() { + pollCount = 0; + } + + /** * Arranges to handle a response. * * @param outcome outcome to be populate @@ -234,7 +277,88 @@ public abstract class HttpOperation<T> extends OperationPartial { protected CompletableFuture<OperationOutcome> postProcessResponse(OperationOutcome outcome, String url, Response rawResponse, T response) { - return CompletableFuture.completedFuture(outcome); + if (!usePolling) { + // doesn't use polling - just return the completed future + return CompletableFuture.completedFuture(outcome); + } + + HttpPollingConfig cfg = (HttpPollingConfig) config; + + switch (detmStatus(rawResponse, response)) { + case SUCCESS: + logger.info("{}.{} request succeeded for {}", params.getActor(), params.getOperation(), + params.getRequestId()); + return CompletableFuture + .completedFuture(setOutcome(outcome, PolicyResult.SUCCESS, rawResponse, response)); + + case FAILURE: + logger.info("{}.{} request failed for {}", params.getActor(), params.getOperation(), + params.getRequestId()); + return CompletableFuture + .completedFuture(setOutcome(outcome, PolicyResult.FAILURE, rawResponse, response)); + + case STILL_WAITING: + default: + logger.info("{}.{} request incomplete for {}", params.getActor(), params.getOperation(), + params.getRequestId()); + break; + } + + // still incomplete + + // see if the limit for the number of polls has been reached + if (pollCount++ >= cfg.getMaxPolls()) { + logger.warn("{}: execeeded 'poll' limit {} for {}", getFullName(), cfg.getMaxPolls(), + params.getRequestId()); + setOutcome(outcome, PolicyResult.FAILURE_TIMEOUT); + return CompletableFuture.completedFuture(outcome); + } + + // sleep and then poll + Function<Void, CompletableFuture<OperationOutcome>> doPoll = unused -> issuePoll(outcome); + return sleep(getPollWaitMs(), TimeUnit.MILLISECONDS).thenComposeAsync(doPoll); + } + + /** + * Polls to see if the original request is complete. This method polls using an HTTP + * "get" request whose URL is constructed by appending the extracted "poll ID" to the + * poll path from the configuration data. + * + * @param outcome outcome to be populated with the response + * @return a future that can be used to cancel the poll or await its response + */ + protected CompletableFuture<OperationOutcome> issuePoll(OperationOutcome outcome) { + String path = getPollingPath(); + String url = getClient().getBaseUrl() + path; + + logger.debug("{}: 'poll' count {} for {}", getFullName(), pollCount, params.getRequestId()); + + logMessage(EventType.OUT, CommInfrastructure.REST, url, null); + + return handleResponse(outcome, url, callback -> getClient().get(callback, path, null)); + } + + /** + * Determines the status of the response. This particular method simply throws an + * exception. + * + * @param rawResponse raw response + * @param response decoded response + * @return the status of the response + */ + protected Status detmStatus(Response rawResponse, T response) { + throw new UnsupportedOperationException("cannot determine response status"); + } + + /** + * Gets the URL to use when polling. Typically, this is some unique ID appended to the + * polling path found within the configuration data. This particular method simply + * returns the polling path from the configuration data. + * + * @return the URL to use when polling + */ + protected String getPollingPath() { + return ((HttpPollingConfig) config).getPollPath(); } /** @@ -255,4 +379,12 @@ public abstract class HttpOperation<T> extends OperationPartial { NetLoggerUtil.log(direction, infra, sink, json); return json; } + + // these may be overridden by junit tests + + protected long getPollWaitMs() { + HttpPollingConfig cfg = (HttpPollingConfig) config; + + return TimeUnit.MILLISECONDS.convert(cfg.getPollWaitSec(), TimeUnit.SECONDS); + } } diff --git a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpOperator.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpOperator.java index 9e446a7c8..f731a2c84 100644 --- a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpOperator.java +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpOperator.java @@ -21,13 +21,10 @@ package org.onap.policy.controlloop.actorserviceprovider.impl; import java.util.Map; -import lombok.Getter; import org.onap.policy.common.endpoints.http.client.HttpClientFactory; import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; import org.onap.policy.common.parameters.ValidationResult; -import org.onap.policy.controlloop.actorserviceprovider.Operation; 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.controlloop.actorserviceprovider.parameters.HttpParams; import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException; @@ -35,20 +32,7 @@ import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterVali /** * Operator that uses HTTP. The operator's parameters must be an {@link HttpParams}. */ -public class HttpOperator extends OperatorPartial { - - /** - * Function to make an operation. - */ - @SuppressWarnings("rawtypes") - private final OperationMaker<HttpConfig, HttpOperation> operationMaker; - - /** - * Current configuration. This is set by {@link #doConfigure(Map)}. - */ - @Getter - private HttpConfig currentConfig; - +public class HttpOperator extends TypedOperator<HttpConfig,HttpOperation<?>> { /** * Constructs the object. @@ -68,18 +52,8 @@ public class HttpOperator extends OperatorPartial { * @param operationMaker function to make an operation */ public HttpOperator(String actorName, String name, - @SuppressWarnings("rawtypes") OperationMaker<HttpConfig, HttpOperation> operationMaker) { - super(actorName, name); - this.operationMaker = operationMaker; - } - - /** - * Translates the parameters to an {@link HttpParams} and then extracts the relevant - * values. - */ - @Override - protected void doConfigure(Map<String, Object> parameters) { - currentConfig = makeConfiguration(parameters); + OperationMaker<HttpConfig, HttpOperation<?>> operationMaker) { + super(actorName, name, operationMaker); } /** @@ -98,17 +72,6 @@ public class HttpOperator extends OperatorPartial { return new HttpConfig(getBlockingExecutor(), params, getClientFactory()); } - @Override - public Operation buildOperation(ControlLoopOperationParams params) { - if (operationMaker == null) { - throw new UnsupportedOperationException("cannot make operation for " + getFullName()); - } - - verifyRunning(); - - return operationMaker.apply(params, currentConfig); - } - // these may be overridden by junit tests protected HttpClientFactory getClientFactory() { diff --git a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpPollingOperator.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpPollingOperator.java new file mode 100644 index 000000000..9e681ceeb --- /dev/null +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpPollingOperator.java @@ -0,0 +1,81 @@ +/*- + * ============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.actorserviceprovider.impl; + +import java.util.Map; +import org.onap.policy.common.endpoints.http.client.HttpClientFactory; +import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; +import org.onap.policy.common.parameters.ValidationResult; +import org.onap.policy.controlloop.actorserviceprovider.Util; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException; + +/** + * Operator that uses HTTP and polls for the request completion status. The operator's + * parameters must be an {@link HttpPollingParams}. + */ +public class HttpPollingOperator extends TypedOperator<HttpPollingConfig, HttpOperation<?>> { + + /** + * Constructs the object. + * + * @param actorName name of the actor with which this operator is associated + * @param name operation name + */ + protected HttpPollingOperator(String actorName, String name) { + this(actorName, name, null); + } + + /** + * Constructs the object. + * + * @param actorName name of the actor with which this operator is associated + * @param name operation name + * @param operationMaker function to make an operation + */ + public HttpPollingOperator(String actorName, String name, + OperationMaker<HttpPollingConfig, HttpOperation<?>> operationMaker) { + super(actorName, name, operationMaker); + } + + /** + * Makes a new configuration using the specified parameters. + * + * @param parameters operator parameters + * @return a new configuration + */ + protected HttpPollingConfig makeConfiguration(Map<String, Object> parameters) { + HttpPollingParams params = Util.translate(getFullName(), parameters, HttpPollingParams.class); + ValidationResult result = params.validate(getFullName()); + if (!result.isValid()) { + throw new ParameterValidationRuntimeException("invalid parameters", result); + } + + return new HttpPollingConfig(getBlockingExecutor(), params, getClientFactory()); + } + + // these may be overridden by junit tests + + protected HttpClientFactory getClientFactory() { + return HttpClientFactoryInstance.getClientFactory(); + } +} diff --git a/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/TypedOperator.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/TypedOperator.java new file mode 100644 index 000000000..5561a97ef --- /dev/null +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/impl/TypedOperator.java @@ -0,0 +1,97 @@ +/*- + * ============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.actorserviceprovider.impl; + +import java.util.Map; +import lombok.Getter; +import org.onap.policy.controlloop.actorserviceprovider.Operation; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams; + +/** + * Operator with typed parameter information. + * + * @param <C> type of configuration data + * @param <T> type of operation that the operator creates + */ +public abstract class TypedOperator<C, T extends Operation> extends OperatorPartial { + + /** + * Function to make an operation. + */ + private final OperationMaker<C, T> operationMaker; + + /** + * Current configuration. This is set by {@link #doConfigure(Map)}. + */ + @Getter + private C currentConfig; + + + /** + * Constructs the object. + * + * @param actorName name of the actor with which this operator is associated + * @param name operation name + */ + protected TypedOperator(String actorName, String name) { + this(actorName, name, null); + } + + /** + * Constructs the object. + * + * @param actorName name of the actor with which this operator is associated + * @param name operation name + * @param operationMaker function to make an operation + */ + public TypedOperator(String actorName, String name, OperationMaker<C, T> operationMaker) { + super(actorName, name); + this.operationMaker = operationMaker; + } + + /** + * Translates the parameters, saving the relevant configuration data. + */ + @Override + protected void doConfigure(Map<String, Object> parameters) { + currentConfig = makeConfiguration(parameters); + } + + /** + * Makes a new configuration using the specified parameters. + * + * @param parameters operator parameters + * @return a new configuration + */ + protected abstract C makeConfiguration(Map<String, Object> parameters); + + @Override + public T buildOperation(ControlLoopOperationParams params) { + if (operationMaker == null) { + throw new UnsupportedOperationException("cannot make operation for " + getFullName()); + } + + verifyRunning(); + + return operationMaker.apply(params, currentConfig); + } +} diff --git a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoActorParams.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingActorParams.java index 3e82fe1a6..3343c5b3c 100644 --- a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoActorParams.java +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingActorParams.java @@ -18,7 +18,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.policy.controlloop.actor.so; +package org.onap.policy.controlloop.actorserviceprovider.parameters; import lombok.EqualsAndHashCode; import lombok.Getter; @@ -26,10 +26,14 @@ import lombok.Setter; import org.onap.policy.common.parameters.annotations.Min; import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpActorParams; +/** + * Parameters used by Actors that, after issuing an HTTP request, must poll the target + * server to determine the request completion status. + */ @Getter @Setter @EqualsAndHashCode(callSuper = true) -public class SoActorParams extends HttpActorParams { +public class HttpPollingActorParams extends HttpActorParams { /* * Optional, default values that are used if missing from the operation-specific @@ -37,20 +41,19 @@ public class SoActorParams extends HttpActorParams { */ /** - * Path to use for the "get" request. + * Path to use when polling for request completion. */ - private String pathGet = "/orchestrationRequests/v5/"; + private String pollPath; /** - * Maximum number of "get" requests permitted, after the initial request, to retrieve - * the response. + * Maximum number of times to poll to retrieve the response. */ @Min(0) - private int maxGets = 20; + private int maxPolls = 3; /** - * Time, in seconds, to wait between issuing "get" requests. + * Time, in seconds, to wait between polling. */ @Min(1) - private int waitSecGet = 20; + private int pollWaitSec = 20; } diff --git a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoConfig.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingConfig.java index 959cd454a..8e0daa07c 100644 --- a/models-interactions/model-actors/actor.so/src/main/java/org/onap/policy/controlloop/actor/so/SoConfig.java +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingConfig.java @@ -18,32 +18,35 @@ * ============LICENSE_END========================================================= */ -package org.onap.policy.controlloop.actor.so; +package org.onap.policy.controlloop.actorserviceprovider.parameters; 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; +/** + * Configuration for HTTP Operators that, after issuing a request, must poll the target + * server to determine the request completion status. + */ @Getter -public class SoConfig extends HttpConfig { +public class HttpPollingConfig extends HttpConfig { /** - * Path to use for the "get" request. A trailing "/" is added, if it is missing. + * Path to use when polling for request completion. A trailing "/" is added, if it is + * missing. */ - private String pathGet; + private String pollPath; /** - * Maximum number of "get" requests permitted, after the initial request, to retrieve - * the response. + * Maximum number of times to poll to retrieve the response. */ - private int maxGets; + private int maxPolls; /** - * Time, in seconds, to wait between issuing "get" requests. + * Time, in seconds, to wait between polling. */ - private int waitSecGet; + private int pollWaitSec; /** @@ -53,11 +56,11 @@ public class SoConfig extends HttpConfig { * @param params operator parameters * @param clientFactory factory from which to obtain the {@link HttpClient} */ - public SoConfig(Executor blockingExecutor, SoParams params, HttpClientFactory clientFactory) { + public HttpPollingConfig(Executor blockingExecutor, HttpPollingParams params, HttpClientFactory clientFactory) { super(blockingExecutor, params, clientFactory); - this.pathGet = params.getPathGet() + (params.getPathGet().endsWith("/") ? "" : "/"); - this.maxGets = params.getMaxGets(); - this.waitSecGet = params.getWaitSecGet(); + this.pollPath = params.getPollPath() + (params.getPollPath().endsWith("/") ? "" : "/"); + this.maxPolls = params.getMaxPolls(); + this.pollWaitSec = params.getPollWaitSec(); } } diff --git a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcParams.java b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingParams.java index 31c2a9441..2f33bd217 100644 --- a/models-interactions/model-actors/actor.vfc/src/main/java/org/onap/policy/controlloop/actor/vfc/VfcParams.java +++ b/models-interactions/model-actors/actorServiceProvider/src/main/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingParams.java @@ -18,7 +18,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.policy.controlloop.actor.vfc; +package org.onap.policy.controlloop.actorserviceprovider.parameters; import lombok.Data; import lombok.EqualsAndHashCode; @@ -28,28 +28,31 @@ import org.onap.policy.common.parameters.annotations.NotBlank; import org.onap.policy.common.parameters.annotations.NotNull; import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams; +/** + * Parameters used by Operators that, after issuing an HTTP request, must poll the target + * server to determine the request completion status. + */ @NotNull @NotBlank @Data @EqualsAndHashCode(callSuper = true) @SuperBuilder(toBuilder = true) -public class VfcParams extends HttpParams { +public class HttpPollingParams extends HttpParams { /** - * Path to use for the "get" request. + * Path to use when polling for request completion. */ - private String pathGet; + private String pollPath; /** - * Maximum number of "get" requests permitted, after the initial request, to retrieve - * the response. + * Maximum number of times to poll to retrieve the response. */ @Min(0) - private int maxGets; + private int maxPolls; /** - * Time, in seconds, to wait between issuing "get" requests. + * Time, in seconds, to wait between polling. */ @Min(1) - private int waitSecGet; + private int pollWaitSec; } diff --git a/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/BidirectionalTopicOperatorTest.java b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/BidirectionalTopicOperatorTest.java index b5e3de32c..29f507e60 100644 --- a/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/BidirectionalTopicOperatorTest.java +++ b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/BidirectionalTopicOperatorTest.java @@ -34,7 +34,6 @@ import org.junit.Before; import org.junit.Test; import org.mockito.Mock; import org.mockito.MockitoAnnotations; -import org.onap.policy.controlloop.actorserviceprovider.Operation; import org.onap.policy.controlloop.actorserviceprovider.Util; import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig; import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicParams; @@ -108,8 +107,7 @@ public class BidirectionalTopicOperatorTest { AtomicReference<BidirectionalTopicConfig> configRef = new AtomicReference<>(); // @formatter:off - @SuppressWarnings("rawtypes") - OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation> maker = + OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation<?,?>> maker = (params, config) -> { paramsRef.set(params); configRef.set(config); @@ -152,7 +150,7 @@ public class BidirectionalTopicOperatorTest { } @Override - public Operation buildOperation(ControlLoopOperationParams params) { + public BidirectionalTopicOperation<?,?> buildOperation(ControlLoopOperationParams params) { return null; } } diff --git a/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpPollingOperationTest.java b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpPollingOperationTest.java new file mode 100644 index 000000000..ed5ba9b56 --- /dev/null +++ b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpPollingOperationTest.java @@ -0,0 +1,255 @@ +/*- + * ============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.actorserviceprovider.impl; + +import static org.assertj.core.api.Assertions.assertThatIllegalStateException; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.junit.Assert.assertEquals; +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.when; + +import java.util.concurrent.CompletableFuture; +import java.util.concurrent.ForkJoinPool; +import java.util.concurrent.TimeUnit; +import javax.ws.rs.client.InvocationCallback; +import javax.ws.rs.core.Response; +import org.junit.Before; +import org.junit.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.mockito.stubbing.Answer; +import org.onap.policy.common.endpoints.http.client.HttpClient; +import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; +import org.onap.policy.controlloop.policy.PolicyResult; + +/** + * Tests HttpOperation when polling is enabled. + */ +public class HttpPollingOperationTest { + private static final String BASE_URI = "http://my-host:6969/base-uri/"; + private static final String MY_PATH = "my-path"; + private static final String FULL_PATH = BASE_URI + MY_PATH; + private static final int MAX_POLLS = 3; + private static final int POLL_WAIT_SEC = 20; + private static final String POLL_PATH = "my-poll-path"; + private static final String MY_ACTOR = "my-actor"; + private static final String MY_OPERATION = "my-operation"; + private static final String MY_RESPONSE = "my-response"; + private static final int RESPONSE_ACCEPT = 100; + private static final int RESPONSE_SUCCESS = 200; + private static final int RESPONSE_FAILURE = 500; + + @Mock + private HttpPollingConfig config; + @Mock + private HttpClient client; + @Mock + private Response rawResponse; + + protected ControlLoopOperationParams params; + private String response; + private OperationOutcome outcome; + + private HttpOperation<String> oper; + + /** + * Sets up. + */ + @Before + public void setUp() throws Exception { + MockitoAnnotations.initMocks(this); + + when(client.getBaseUrl()).thenReturn(BASE_URI); + + when(config.getClient()).thenReturn(client); + when(config.getPath()).thenReturn(MY_PATH); + when(config.getMaxPolls()).thenReturn(MAX_POLLS); + when(config.getPollPath()).thenReturn(POLL_PATH); + when(config.getPollWaitSec()).thenReturn(POLL_WAIT_SEC); + + response = MY_RESPONSE; + + when(rawResponse.getStatus()).thenReturn(RESPONSE_SUCCESS); + when(rawResponse.readEntity(String.class)).thenReturn(response); + + params = ControlLoopOperationParams.builder().actor(MY_ACTOR).operation(MY_OPERATION).build(); + outcome = params.makeOutcome(); + + oper = new MyOper(params, config); + } + + @Test + public void testConstructor_testGetWaitMsGet() { + assertEquals(MY_ACTOR, oper.getActorName()); + assertEquals(MY_OPERATION, oper.getName()); + assertSame(config, oper.getConfig()); + assertEquals(1000 * POLL_WAIT_SEC, oper.getPollWaitMs()); + } + + @Test + public void testSetUsePollExceptions() { + // should be no exception + oper.setUsePolling(); + + // should throw an exception if we pass a plain HttpConfig + HttpConfig config2 = mock(HttpConfig.class); + when(config2.getClient()).thenReturn(client); + when(config2.getPath()).thenReturn(MY_PATH); + + assertThatIllegalStateException().isThrownBy(() -> new MyOper(params, config2).setUsePolling()); + } + + @Test + public void testPostProcess() throws Exception { + // completed + oper.generateSubRequestId(2); + CompletableFuture<OperationOutcome> future2 = + oper.postProcessResponse(outcome, FULL_PATH, rawResponse, response); + assertTrue(future2.isDone()); + assertSame(outcome, future2.get()); + assertEquals(PolicyResult.SUCCESS, outcome.getResult()); + assertNotNull(oper.getSubRequestId()); + assertSame(response, outcome.getResponse()); + + // failed + oper.generateSubRequestId(2); + when(rawResponse.getStatus()).thenReturn(RESPONSE_FAILURE); + future2 = oper.postProcessResponse(outcome, FULL_PATH, rawResponse, response); + assertTrue(future2.isDone()); + assertSame(outcome, future2.get()); + assertEquals(PolicyResult.FAILURE, outcome.getResult()); + assertNotNull(oper.getSubRequestId()); + assertSame(response, outcome.getResponse()); + } + + /** + * Tests postProcess() when the poll is repeated a couple of times. + */ + @Test + public void testPostProcessRepeated_testResetGetCount() throws Exception { + /* + * Two accepts and then a success - should result in two polls. + */ + when(rawResponse.getStatus()).thenReturn(RESPONSE_ACCEPT, RESPONSE_ACCEPT, RESPONSE_SUCCESS, RESPONSE_SUCCESS); + + when(client.get(any(), any(), any())).thenAnswer(provideResponse(rawResponse)); + + // use a real executor + params = params.toBuilder().executor(ForkJoinPool.commonPool()).build(); + + oper = new MyOper(params, config) { + @Override + public long getPollWaitMs() { + return 1; + } + }; + + CompletableFuture<OperationOutcome> future2 = + oper.postProcessResponse(outcome, FULL_PATH, rawResponse, response); + + assertSame(outcome, future2.get(5, TimeUnit.SECONDS)); + assertEquals(PolicyResult.SUCCESS, outcome.getResult()); + assertEquals(2, oper.getPollCount()); + + /* + * repeat - this time, the "poll" count will be exhausted, so it should fail + */ + when(rawResponse.getStatus()).thenReturn(RESPONSE_ACCEPT); + + future2 = oper.postProcessResponse(outcome, FULL_PATH, rawResponse, response); + + assertSame(outcome, future2.get(5, TimeUnit.SECONDS)); + assertEquals(PolicyResult.FAILURE_TIMEOUT, outcome.getResult()); + assertEquals(MAX_POLLS + 1, oper.getPollCount()); + + oper.resetPollCount(); + assertEquals(0, oper.getPollCount()); + assertNull(oper.getSubRequestId()); + } + + @Test + public void testDetmStatus() { + // make an operation that does NOT override detmStatus() + oper = new HttpOperation<String>(params, config, String.class) {}; + + assertThatThrownBy(() -> oper.detmStatus(rawResponse, response)) + .isInstanceOf(UnsupportedOperationException.class); + } + + /** + * Provides a response to an asynchronous HttpClient call. + * + * @param response response to be provided to the call + * @return a function that provides the response to the call + */ + protected Answer<CompletableFuture<Response>> provideResponse(Response response) { + return provideResponse(response, 0); + } + + /** + * Provides a response to an asynchronous HttpClient call. + * + * @param response response to be provided to the call + * @param index index of the callback within the arguments + * @return a function that provides the response to the call + */ + protected Answer<CompletableFuture<Response>> provideResponse(Response response, int index) { + return args -> { + InvocationCallback<Response> cb = args.getArgument(index); + cb.completed(response); + return CompletableFuture.completedFuture(response); + }; + } + + private static class MyOper extends HttpOperation<String> { + + public MyOper(ControlLoopOperationParams params, HttpConfig config) { + super(params, config, String.class); + + setUsePolling(); + } + + @Override + protected Status detmStatus(Response rawResponse, String response) { + switch (rawResponse.getStatus()) { + case RESPONSE_ACCEPT: + return Status.STILL_WAITING; + case RESPONSE_SUCCESS: + return Status.SUCCESS; + default: + return Status.FAILURE; + } + } + + @Override + protected boolean isSuccess(Response rawResponse, String response) { + return true; + } + } +} diff --git a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoOperatorTest.java b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpPollingOperatorTest.java index 20403237b..2a22b4b86 100644 --- a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoOperatorTest.java +++ b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/impl/HttpPollingOperatorTest.java @@ -18,10 +18,11 @@ * ============LICENSE_END========================================================= */ -package org.onap.policy.controlloop.actor.so; +package org.onap.policy.controlloop.actorserviceprovider.impl; import static org.assertj.core.api.Assertions.assertThatThrownBy; import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertTrue; import static org.mockito.Mockito.when; @@ -33,26 +34,28 @@ 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.ControlLoopOperationParams; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingConfig; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams; import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException; -public class SoOperatorTest { +public class HttpPollingOperatorTest { 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 String PATH_GET = "my-path-get/"; - private static final int MAX_GETS = 3; - private static final int WAIT_SEC_GETS = 20; + private static final String POLL_PATH = "my-path-get/"; + private static final int MAX_POLLS = 3; + private static final int POLL_WAIT_SEC = 20; private static final int TIMEOUT = 100; @Mock private HttpClient client; - @Mock private HttpClientFactory factory; - - private SoOperator oper; + private HttpPollingOperator oper; /** * Initializes fields, including {@link #oper}, and resets the static fields used by @@ -66,8 +69,8 @@ public class SoOperatorTest { oper = new MyOperator(); - SoParams params = SoParams.builder().pathGet(PATH_GET).maxGets(MAX_GETS).waitSecGet(WAIT_SEC_GETS) - .clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build(); + HttpPollingParams params = HttpPollingParams.builder().pollPath(POLL_PATH).maxPolls(MAX_POLLS) + .pollWaitSec(POLL_WAIT_SEC).clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build(); Map<String, Object> paramMap = Util.translateToMap(OPERATION, params); oper.configure(paramMap); } @@ -81,17 +84,23 @@ public class SoOperatorTest { @Test public void testDoConfigure_testGetters() { - assertTrue(oper.getCurrentConfig() instanceof SoConfig); + assertTrue(oper.getCurrentConfig() instanceof HttpPollingConfig); // test invalid parameters - Map<String, Object> paramMap2 = Util.translateToMap(OPERATION, SoParams.builder().build()); + Map<String, Object> paramMap2 = Util.translateToMap(OPERATION, HttpPollingParams.builder().build()); assertThatThrownBy(() -> oper.configure(paramMap2)).isInstanceOf(ParameterValidationRuntimeException.class); } + @Test + public void testGetClientFactory() { + HttpPollingOperator oper2 = new HttpPollingOperator(ACTOR, OPERATION); + assertNotNull(oper2.getClientFactory()); + } + - private class MyOperator extends SoOperator { + private class MyOperator extends HttpPollingOperator { public MyOperator() { - super(ACTOR, OPERATION, null); + super(ACTOR, OPERATION, MyOperation::new); } @Override @@ -99,4 +108,10 @@ public class SoOperatorTest { return factory; } } + + private static class MyOperation extends HttpOperation<String> { + public MyOperation(ControlLoopOperationParams params, HttpConfig config) { + super(params, config, String.class); + } + } } diff --git a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoActorParamsTest.java b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingActorParamsTest.java index 93f305550..78240beb6 100644 --- a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoActorParamsTest.java +++ b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingActorParamsTest.java @@ -18,7 +18,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.policy.controlloop.actor.so; +package org.onap.policy.controlloop.actorserviceprovider.parameters; import static org.assertj.core.api.Assertions.assertThat; import static org.junit.Assert.assertFalse; @@ -34,12 +34,12 @@ import org.onap.policy.controlloop.actorserviceprovider.Util; import org.onap.policy.controlloop.actorserviceprovider.parameters.ActorParams; -public class SoActorParamsTest { +public class HttpPollingActorParamsTest { private static final String CONTAINER = "my-container"; private static final String CLIENT = "my-client"; - private static final String PATH_GET = "my-path-get"; - private static final int MAX_GETS = 3; - private static final int WAIT_SEC_GETS = 20; + private static final String POLL_PATH = "my-poll-path"; + private static final int MAX_POLLS = 3; + private static final int POLL_WAIT_SEC = 20; private static final int TIMEOUT = 10; private static final String PATH1 = "path #1"; @@ -48,7 +48,7 @@ public class SoActorParamsTest { private static final String URI2 = "uri #2"; private Map<String, Map<String, Object>> operations; - private SoActorParams params; + private HttpPollingActorParams params; /** * Initializes {@link #operations} with two items and {@link params} with a fully @@ -60,7 +60,7 @@ public class SoActorParamsTest { operations.put(PATH1, Map.of("path", URI1)); operations.put(PATH2, Map.of("path", URI2)); - params = makeSoActorParams(); + params = makeHttpPollingActorParams(); } @Test @@ -68,50 +68,50 @@ public class SoActorParamsTest { assertTrue(params.validate(CONTAINER).isValid()); // only a few fields are required - SoActorParams sparse = Util.translate(CONTAINER, Map.of(ActorParams.OPERATIONS_FIELD, operations), - SoActorParams.class); + HttpPollingActorParams sparse = Util.translate(CONTAINER, Map.of(ActorParams.OPERATIONS_FIELD, operations), + HttpPollingActorParams.class); assertTrue(sparse.validate(CONTAINER).isValid()); - testValidateField("maxGets", "minimum", params2 -> params2.setMaxGets(-1)); - testValidateField("waitSecGet", "minimum", params2 -> params2.setWaitSecGet(0)); + testValidateField("maxPolls", "minimum", params2 -> params2.setMaxPolls(-1)); + testValidateField("pollWaitSec", "minimum", params2 -> params2.setPollWaitSec(0)); // check fields from superclass testValidateField(ActorParams.OPERATIONS_FIELD, "null", params2 -> params2.setOperations(null)); testValidateField("timeoutSec", "minimum", params2 -> params2.setTimeoutSec(-1)); // check edge cases - params.setMaxGets(0); + params.setMaxPolls(0); assertTrue(params.validate(CONTAINER).isValid()); - params.setMaxGets(MAX_GETS); + params.setMaxPolls(MAX_POLLS); - params.setWaitSecGet(1); + params.setPollWaitSec(1); assertTrue(params.validate(CONTAINER).isValid()); - params.setWaitSecGet(WAIT_SEC_GETS); + params.setPollWaitSec(POLL_WAIT_SEC); } - private void testValidateField(String fieldName, String expected, Consumer<SoActorParams> makeInvalid) { + private void testValidateField(String fieldName, String expected, Consumer<HttpPollingActorParams> makeInvalid) { // original params should be valid ValidationResult result = params.validate(CONTAINER); assertTrue(fieldName, result.isValid()); // make invalid params - SoActorParams params2 = makeSoActorParams(); + HttpPollingActorParams params2 = makeHttpPollingActorParams(); makeInvalid.accept(params2); result = params2.validate(CONTAINER); assertFalse(fieldName, result.isValid()); assertThat(result.getResult()).contains(CONTAINER).contains(fieldName).contains(expected); } - private SoActorParams makeSoActorParams() { - SoActorParams params2 = new SoActorParams(); + private HttpPollingActorParams makeHttpPollingActorParams() { + HttpPollingActorParams params2 = new HttpPollingActorParams(); params2.setClientName(CLIENT); params2.setTimeoutSec(TIMEOUT); params2.setOperations(operations); - params2.setWaitSecGet(WAIT_SEC_GETS); - params2.setMaxGets(MAX_GETS); - params2.setPathGet(PATH_GET); + params2.setPollWaitSec(POLL_WAIT_SEC); + params2.setMaxPolls(MAX_POLLS); + params2.setPollPath(POLL_PATH); return params2; } diff --git a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoConfigTest.java b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingConfigTest.java index 17fd9c9de..53be6c711 100644 --- a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoConfigTest.java +++ b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingConfigTest.java @@ -18,7 +18,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.policy.controlloop.actor.so; +package org.onap.policy.controlloop.actorserviceprovider.parameters; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertSame; @@ -32,12 +32,12 @@ import org.mockito.MockitoAnnotations; import org.onap.policy.common.endpoints.http.client.HttpClient; import org.onap.policy.common.endpoints.http.client.HttpClientFactory; -public class SoConfigTest { +public class HttpPollingConfigTest { private static final String MY_CLIENT = "my-client"; private static final String MY_PATH = "my-path"; - private static final String GET_PATH = "get-path"; + private static final String POLL_PATH = "poll-path"; private static final int TIMEOUT_SEC = 10; - private static final int MAX_GETS = 20; + private static final int MAX_POLLS = 20; private static final int WAIT_SEC = 30; @Mock @@ -47,8 +47,8 @@ public class SoConfigTest { @Mock private Executor executor; - private SoParams params; - private SoConfig config; + private HttpPollingParams params; + private HttpPollingConfig config; /** * Sets up. @@ -59,24 +59,24 @@ public class SoConfigTest { when(factory.get(MY_CLIENT)).thenReturn(client); - params = SoParams.builder().maxGets(MAX_GETS).pathGet(GET_PATH).waitSecGet(WAIT_SEC).clientName(MY_CLIENT) - .path(MY_PATH).timeoutSec(TIMEOUT_SEC).build(); - config = new SoConfig(executor, params, factory); + params = HttpPollingParams.builder().maxPolls(MAX_POLLS).pollPath(POLL_PATH).pollWaitSec(WAIT_SEC) + .clientName(MY_CLIENT).path(MY_PATH).timeoutSec(TIMEOUT_SEC).build(); + config = new HttpPollingConfig(executor, params, factory); } @Test public void test() { - assertEquals(GET_PATH + "/", config.getPathGet()); - assertEquals(MAX_GETS, config.getMaxGets()); - assertEquals(WAIT_SEC, config.getWaitSecGet()); + assertEquals(POLL_PATH + "/", config.getPollPath()); + assertEquals(MAX_POLLS, config.getMaxPolls()); + assertEquals(WAIT_SEC, config.getPollWaitSec()); // check value from superclass assertSame(executor, config.getBlockingExecutor()); assertSame(client, config.getClient()); // path with trailing "/" - params = params.toBuilder().pathGet(GET_PATH + "/").build(); - config = new SoConfig(executor, params, factory); - assertEquals(GET_PATH + "/", config.getPathGet()); + params = params.toBuilder().pollPath(POLL_PATH + "/").build(); + config = new HttpPollingConfig(executor, params, factory); + assertEquals(POLL_PATH + "/", config.getPollPath()); } } diff --git a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoParamsTest.java b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingParamsTest.java index 2b02ad8ff..e3fef83c5 100644 --- a/models-interactions/model-actors/actor.so/src/test/java/org/onap/policy/controlloop/actor/so/SoParamsTest.java +++ b/models-interactions/model-actors/actorServiceProvider/src/test/java/org/onap/policy/controlloop/actorserviceprovider/parameters/HttpPollingParamsTest.java @@ -18,7 +18,7 @@ * ============LICENSE_END========================================================= */ -package org.onap.policy.controlloop.actor.so; +package org.onap.policy.controlloop.actorserviceprovider.parameters; import static org.assertj.core.api.Assertions.assertThat; import static org.junit.Assert.assertEquals; @@ -29,56 +29,55 @@ import java.util.function.Function; import org.junit.Before; import org.junit.Test; import org.onap.policy.common.parameters.ValidationResult; -import org.onap.policy.controlloop.actor.so.SoParams.SoParamsBuilder; -import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams.HttpParamsBuilder; +import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpPollingParams.HttpPollingParamsBuilder; -public class SoParamsTest { +public class HttpPollingParamsTest { private static final String CONTAINER = "my-container"; private static final String CLIENT = "my-client"; private static final String PATH = "my-path"; - private static final String PATH_GET = "my-path-get"; - private static final int MAX_GETS = 3; - private static final int WAIT_SEC_GETS = 20; + private static final String POLL_PATH = "my-poll-path"; + private static final int MAX_POLLS = 3; + private static final int POLL_WAIT_SEC = 20; private static final int TIMEOUT = 10; - private SoParams params; + private HttpPollingParams params; @Before public void setUp() { - params = SoParams.builder().pathGet(PATH_GET).maxGets(MAX_GETS).waitSecGet(WAIT_SEC_GETS).clientName(CLIENT) - .path(PATH).timeoutSec(TIMEOUT).build(); + params = HttpPollingParams.builder().pollPath(POLL_PATH).maxPolls(MAX_POLLS).pollWaitSec(POLL_WAIT_SEC) + .clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build(); } @Test public void testValidate() { assertTrue(params.validate(CONTAINER).isValid()); - testValidateField("pathGet", "null", bldr -> bldr.pathGet(null)); - testValidateField("maxGets", "minimum", bldr -> bldr.maxGets(-1)); - testValidateField("waitSecGet", "minimum", bldr -> bldr.waitSecGet(-1)); + testValidateField("pollPath", "null", bldr -> bldr.pollPath(null)); + testValidateField("maxPolls", "minimum", bldr -> bldr.maxPolls(-1)); + testValidateField("pollWaitSec", "minimum", bldr -> bldr.pollWaitSec(-1)); // validate one of the superclass fields testValidateField("clientName", "null", bldr -> bldr.clientName(null)); // check edge cases - assertTrue(params.toBuilder().maxGets(0).build().validate(CONTAINER).isValid()); - assertFalse(params.toBuilder().waitSecGet(0).build().validate(CONTAINER).isValid()); - assertTrue(params.toBuilder().waitSecGet(1).build().validate(CONTAINER).isValid()); + assertTrue(params.toBuilder().maxPolls(0).build().validate(CONTAINER).isValid()); + assertFalse(params.toBuilder().pollWaitSec(0).build().validate(CONTAINER).isValid()); + assertTrue(params.toBuilder().pollWaitSec(1).build().validate(CONTAINER).isValid()); } @Test public void testBuilder_testToBuilder() { assertEquals(CLIENT, params.getClientName()); - assertEquals(PATH_GET, params.getPathGet()); - assertEquals(MAX_GETS, params.getMaxGets()); - assertEquals(WAIT_SEC_GETS, params.getWaitSecGet()); + assertEquals(POLL_PATH, params.getPollPath()); + assertEquals(MAX_POLLS, params.getMaxPolls()); + assertEquals(POLL_WAIT_SEC, params.getPollWaitSec()); assertEquals(params, params.toBuilder().build()); } private void testValidateField(String fieldName, String expected, - @SuppressWarnings("rawtypes") Function<SoParamsBuilder, HttpParamsBuilder> makeInvalid) { + Function<HttpPollingParamsBuilder<?,?>, HttpPollingParamsBuilder<?,?>> makeInvalid) { // original params should be valid ValidationResult result = params.validate(CONTAINER); |