import org.onap.policy.aai.AaiConstants;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpActor;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpActorParams;
/**
* A&AI Actor.
*/
-public class AaiActorServiceProvider extends HttpActor {
+public class AaiActorServiceProvider extends HttpActor<HttpActorParams> {
public static final String NAME = AaiConstants.ACTOR_NAME;
/**
* Constructs the object.
*/
public AaiActorServiceProvider() {
- super(NAME);
+ super(NAME, HttpActorParams.class);
- addOperator(HttpOperator.makeOperator(NAME, AaiCustomQueryOperation.NAME,
- AaiCustomQueryOperation::new));
+ addOperator(new HttpOperator(NAME, AaiCustomQueryOperation.NAME, AaiCustomQueryOperation::new));
// add all "get" operators
for (String operation : AaiGetOperation.OPERATIONS) {
- addOperator(HttpOperator.makeOperator(NAME, operation, AaiGetOperation::new));
+ addOperator(new HttpOperator(NAME, operation, AaiGetOperation::new));
}
}
}
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.impl.HttpOperator;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public AaiCustomQueryOperation(ControlLoopOperationParams params, HttpOperator operator) {
- super(params, operator, String.class);
+ public AaiCustomQueryOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config, String.class);
}
/**
// @formatter:off
return handleResponse(outcome, url,
- callback -> getOperator().getClient().put(callback, makePath(), entity, headers));
+ callback -> getClient().put(callback, makePath(), entity, headers));
// @formatter:on
}
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.impl.HttpOperator;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public AaiGetOperation(ControlLoopOperationParams params, HttpOperator operator) {
- super(params, operator, StandardCoderObject.class);
- this.propertyPrefix = operator.getFullName() + ".";
+ public AaiGetOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config, StandardCoderObject.class);
+ this.propertyPrefix = getFullName() + ".";
}
/**
// @formatter:off
return handleResponse(outcome, url,
- callback -> getOperator().getClient().get(callback, makePath(), headers));
+ callback -> getClient().get(callback, makePath(), headers));
// @formatter:on
}
@Override
public String makePath() {
- return (getOperator().getPath() + "/" + params.getTargetEntity());
+ return (getPath() + "/" + params.getTargetEntity());
}
/**
*/
@Before
public void setUp() throws Exception {
- super.setUp();
+ super.setUpBasic();
MyTenantOperator tenantOperator = new MyTenantOperator();
when(service.getActor(AaiConstants.ACTOR_NAME)).thenReturn(tenantActor);
when(tenantActor.getOperator(AaiGetOperation.TENANT)).thenReturn(tenantOperator);
- oper = new AaiCustomQueryOperation(params, operator);
+ oper = new AaiCustomQueryOperation(params, config);
}
@Test
@Override
public Operation buildOperation(ControlLoopOperationParams params) {
- return new AaiGetOperation(params, this);
+ return new AaiGetOperation(params, getCurrentConfig());
}
@Override
*/
@Before
public void setUp() throws Exception {
- super.setUp();
- oper = new AaiGetOperation(params, operator);
+ super.setUpBasic();
+ oper = new AaiGetOperation(params, config);
}
@Test
import org.onap.policy.controlloop.VirtualControlLoopEvent;
import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicActor;
import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicActorParams;
import org.onap.policy.controlloop.policy.Policy;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class AppcActorServiceProvider extends BidirectionalTopicActor {
+public class AppcActorServiceProvider extends BidirectionalTopicActor<BidirectionalTopicActorParams> {
private static final String NAME = "APPC";
private static final Logger logger = LoggerFactory.getLogger(AppcActorServiceProvider.class);
* Constructs the object.
*/
public AppcActorServiceProvider() {
- super(NAME);
+ super(NAME, BidirectionalTopicActorParams.class);
- addOperator(BidirectionalTopicOperator.makeOperator(NAME, ModifyConfigOperation.NAME, this,
- AppcOperation.SELECTOR_KEYS, ModifyConfigOperation::new));
+ addOperator(new BidirectionalTopicOperator(NAME, ModifyConfigOperation.NAME, this, AppcOperation.SELECTOR_KEYS,
+ ModifyConfigOperation::new));
}
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperation;
-import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey;
import org.onap.policy.controlloop.policy.PolicyResult;
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public AppcOperation(ControlLoopOperationParams params, BidirectionalTopicOperator operator) {
- super(params, operator, Response.class);
+ public AppcOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config) {
+ super(params, config, Response.class);
}
/**
import org.onap.policy.appc.Request;
import org.onap.policy.controlloop.actor.aai.AaiCustomQueryOperation;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public ModifyConfigOperation(ControlLoopOperationParams params, BidirectionalTopicOperator operator) {
- super(params, operator);
+ public ModifyConfigOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config) {
+ super(params, config);
}
/**
public void setUp() throws Exception {
super.setUp();
- oper = new AppcOperation(params, operator) {
+ oper = new AppcOperation(params, config) {
@Override
protected Request makeRequest(int attempt) {
return oper.makeRequest(attempt, MY_VNF);
// repeat using a null payload
params = params.toBuilder().payload(null).build();
- oper = new AppcOperation(params, operator) {
+ oper = new AppcOperation(params, config) {
@Override
protected Request makeRequest(int attempt) {
return oper.makeRequest(attempt, MY_VNF);
params = params.toBuilder().payload(payload).build();
- oper = new AppcOperation(params, operator) {
+ oper = new AppcOperation(params, config) {
@Override
protected Request makeRequest(int attempt) {
return oper.makeRequest(attempt, MY_VNF);
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeoutException;
import java.util.function.BiConsumer;
-import java.util.function.BiFunction;
import org.onap.policy.appc.Response;
import org.onap.policy.appc.ResponseCode;
import org.onap.policy.appc.ResponseStatus;
import org.onap.policy.controlloop.actor.test.BasicBidirectionalTopicOperation;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.Util;
-import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.impl.OperationMaker;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.onap.policy.controlloop.policy.Target;
import org.powermock.reflect.Whitebox;
* Initializes mocks and sets up.
*/
public void setUp() throws Exception {
- super.setUp();
+ super.setUpBasic();
response = new Response();
* @param expectedText text expected in the exception message
*/
protected void verifyMissing(String fieldName, String expectedText,
- BiFunction<ControlLoopOperationParams, BidirectionalTopicOperator, AppcOperation> maker) {
+ OperationMaker<BidirectionalTopicConfig, AppcOperation> maker) {
makeContext();
enrichment.remove(fieldName);
- AppcOperation oper = maker.apply(params, operator);
+ AppcOperation oper = maker.apply(params, config);
assertThatIllegalArgumentException().isThrownBy(() -> Whitebox.invokeMethod(oper, "makeRequest", 1))
.withMessageContaining("missing").withMessageContaining(expectedText);
@Before
public void setUp() throws Exception {
super.setUp();
- oper = new ModifyConfigOperation(params, operator);
+ oper = new ModifyConfigOperation(params, config);
}
@Test
AtomicBoolean guardStarted = new AtomicBoolean();
- oper = new ModifyConfigOperation(params, operator) {
+ oper = new ModifyConfigOperation(params, config) {
@Override
protected CompletableFuture<OperationOutcome> startGuardAsync() {
guardStarted.set(true);
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.controlloop.actor.guard;
+
+import lombok.EqualsAndHashCode;
+import lombok.Getter;
+import lombok.Setter;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpActorParams;
+
+@Getter
+@Setter
+@EqualsAndHashCode(callSuper = true)
+public class GuardActorParams extends HttpActorParams {
+ public static final String DEFAULT_ACTION = "guard";
+
+ /*
+ * Optional, default values that are used if missing from the operation-specific
+ * parameters.
+ */
+
+ private String onapName;
+ private String onapComponent;
+ private String onapInstance;
+ private String action = DEFAULT_ACTION;
+}
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpActor;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
-public class GuardActorServiceProvider extends HttpActor {
+public class GuardActorServiceProvider extends HttpActor<GuardActorParams> {
// actor name
public static final String NAME = "GUARD";
* Constructs the object.
*/
public GuardActorServiceProvider() {
- super(NAME);
+ super(NAME, GuardActorParams.class);
- addOperator(HttpOperator.makeOperator(NAME, GuardOperation.NAME,
- GuardOperation::new));
+ addOperator(new HttpOperator(NAME, GuardOperation.NAME, GuardOperation::new));
}
}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.controlloop.actor.guard;
+
+import java.util.LinkedHashMap;
+import java.util.Map;
+import java.util.concurrent.Executor;
+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 Guard Operators.
+ */
+public class GuardConfig extends HttpConfig {
+ private final Map<String, Object> defaultRequest = new LinkedHashMap<>();
+
+ /**
+ * Constructs the object.
+ *
+ * @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 GuardConfig(Executor blockingExecutor, GuardParams params, HttpClientFactory clientFactory) {
+ super(blockingExecutor, params, clientFactory);
+
+ addProperty("ONAPComponent", params.getOnapComponent());
+ addProperty("ONAPInstance", params.getOnapInstance());
+ addProperty("ONAPName", params.getOnapName());
+ addProperty("action", params.getAction());
+ }
+
+ /**
+ * Adds a property to the default request, if the value is not {@code null}.
+ *
+ * @param key property key
+ * @param value property value, or {@code null}
+ */
+ private void addProperty(String key, String value) {
+ if (value != null) {
+ defaultRequest.put(key, value);
+ }
+ }
+
+ /**
+ * Creates a new request, with the default values.
+ *
+ * @return a new request map
+ */
+ public Map<String, Object> makeRequest() {
+ return new LinkedHashMap<>(defaultRequest);
+ }
+}
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;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.onap.policy.models.decisions.concepts.DecisionRequest;
import org.onap.policy.models.decisions.concepts.DecisionResponse;
*/
public static final String RESOURCE_PREFIX = "resource.";
+ private final GuardConfig config;
+
/**
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public GuardOperation(ControlLoopOperationParams params, HttpOperator operator) {
- super(params, operator, DecisionResponse.class);
+ public GuardOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config, DecisionResponse.class);
+ this.config = (GuardConfig) config;
}
@Override
// @formatter:off
return handleResponse(outcome, url,
- callback -> getOperator().getClient().post(callback, makePath(), entity, headers));
+ callback -> getClient().post(callback, makePath(), entity, headers));
// @formatter:on
}
* appropriate field.
*/
- Map<String, Object> req = new LinkedHashMap<>();
+ Map<String, Object> req = config.makeRequest();
Map<String, Object> resource = new LinkedHashMap<>();
for (Entry<String, String> ent : params.getPayload().entrySet()) {
}
}
- req.putIfAbsent("action", "guard");
req.computeIfAbsent("requestId", key -> UUID.randomUUID().toString());
req.put(RESOURCE, resource);
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.controlloop.actor.guard;
+
+import java.util.Map;
+import org.onap.policy.common.parameters.ValidationResult;
+import org.onap.policy.controlloop.actorserviceprovider.Util;
+import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperation;
+import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
+import org.onap.policy.controlloop.actorserviceprovider.impl.OperationMaker;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException;
+
+/**
+ * Guard Operator.
+ */
+public class GuardOperator extends HttpOperator {
+
+ public GuardOperator(String actorName, String name,
+ @SuppressWarnings("rawtypes") OperationMaker<HttpConfig, HttpOperation> operationMaker) {
+ super(actorName, name, operationMaker);
+ }
+
+ @Override
+ protected HttpConfig makeConfiguration(Map<String, Object> parameters) {
+ GuardParams params = Util.translate(getFullName(), parameters, GuardParams.class);
+ ValidationResult result = params.validate(getFullName());
+ if (!result.isValid()) {
+ throw new ParameterValidationRuntimeException("invalid parameters", result);
+ }
+
+ return new GuardConfig(getBlockingExecutor(), params, getClientFactory());
+ }
+}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.controlloop.actor.guard;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import lombok.experimental.SuperBuilder;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams;
+
+/**
+ * Default values to be included if not specified in the payload.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+@SuperBuilder(toBuilder = true)
+public class GuardParams extends HttpParams {
+
+ /*
+ * Optional, default values that are used if missing from the payload.
+ */
+
+ private String onapName;
+ private String onapComponent;
+ private String onapInstance;
+ private String action;
+}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.controlloop.actor.guard;
+
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.util.Map;
+import java.util.TreeMap;
+import java.util.function.Consumer;
+import org.junit.Before;
+import org.junit.Test;
+import org.onap.policy.common.parameters.ValidationResult;
+import org.onap.policy.controlloop.actorserviceprovider.Util;
+
+public class GuardActorParamsTest {
+ private static final String CONTAINER = "my-container";
+ private static final String CLIENT = "my-client";
+ private static final int TIMEOUT = 10;
+ private static final String ONAP_NAME = "onap-nap";
+ private static final String ONAP_COMP = "onap-component";
+ private static final String ONAP_INST = "onap-instance";
+ private static final String MY_ACTION = "my-action";
+
+ private static final String PATH1 = "path #1";
+ private static final String PATH2 = "path #2";
+ private static final String URI1 = "uri #1";
+ private static final String URI2 = "uri #2";
+
+ private Map<String, Map<String, Object>> operations;
+ private GuardActorParams params;
+
+ /**
+ * Initializes {@link #operations} with two items and {@link params} with a fully
+ * populated object.
+ */
+ @Before
+ public void setUp() {
+ operations = new TreeMap<>();
+ operations.put(PATH1, Map.of("path", URI1));
+ operations.put(PATH2, Map.of("path", URI2));
+
+ params = makeGuardActorParams();
+ }
+
+ @Test
+ public void testValidate() {
+ assertTrue(params.validate(CONTAINER).isValid());
+
+ // only a few fields are required
+ GuardActorParams sparse = Util.translate(CONTAINER, Map.of("operation", operations), GuardActorParams.class);
+ assertTrue(sparse.validate(CONTAINER).isValid());
+
+ assertEquals(GuardActorParams.DEFAULT_ACTION, sparse.getAction());
+
+ // check fields from superclass
+ testValidateField("operation", "null", params2 -> params2.setOperation(null));
+ testValidateField("timeoutSec", "minimum", params2 -> params2.setTimeoutSec(-1));
+ }
+
+ private void testValidateField(String fieldName, String expected, Consumer<GuardActorParams> makeInvalid) {
+
+ // original params should be valid
+ ValidationResult result = params.validate(CONTAINER);
+ assertTrue(fieldName, result.isValid());
+
+ // make invalid params
+ GuardActorParams params2 = makeGuardActorParams();
+ makeInvalid.accept(params2);
+ result = params2.validate(CONTAINER);
+ assertFalse(fieldName, result.isValid());
+ assertThat(result.getResult()).contains(CONTAINER).contains(fieldName).contains(expected);
+ }
+
+ private GuardActorParams makeGuardActorParams() {
+ GuardActorParams params2 = new GuardActorParams();
+ params2.setClientName(CLIENT);
+ params2.setTimeoutSec(TIMEOUT);
+ params2.setOperation(operations);
+
+ params2.setOnapName(ONAP_NAME);
+ params2.setOnapComponent(ONAP_COMP);
+ params2.setOnapInstance(ONAP_INST);
+ params2.setAction(MY_ACTION);
+
+ return params2;
+ }
+}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.controlloop.actor.guard;
+
+import static org.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;
+import org.onap.policy.controlloop.actorserviceprovider.Util;
+import org.onap.policy.models.decisions.concepts.DecisionRequest;
+
+public class GuardConfigTest {
+ private static final String MY_CLIENT = "my-client";
+ private static final String PATH = "my-path";
+ private static final int TIMEOUT = 10;
+ private static final String ONAP_NAME = "onap-nap";
+ private static final String ONAP_COMP = "onap-component";
+ private static final String ONAP_INST = "onap-instance";
+ private static final String MY_ACTION = "my-action";
+
+ @Mock
+ private HttpClient client;
+ @Mock
+ private HttpClientFactory factory;
+ @Mock
+ private Executor executor;
+
+ private GuardParams params;
+ private GuardConfig config;
+
+ /**
+ * Sets up.
+ */
+ @Before
+ public void setUp() {
+ MockitoAnnotations.initMocks(this);
+
+ when(factory.get(MY_CLIENT)).thenReturn(client);
+
+ params = GuardParams.builder().onapName(ONAP_NAME).onapComponent(ONAP_COMP).onapInstance(ONAP_INST)
+ .action(MY_ACTION).clientName(MY_CLIENT).path(PATH).timeoutSec(TIMEOUT).build();
+ config = new GuardConfig(executor, params, factory);
+ }
+
+ @Test
+ public void test() {
+ DecisionRequest expected = new DecisionRequest();
+ expected.setOnapComponent(ONAP_COMP);
+ expected.setOnapInstance(ONAP_INST);
+ expected.setOnapName(ONAP_NAME);
+ expected.setAction(MY_ACTION);
+
+ DecisionRequest actual = Util.translate("", config.makeRequest(), DecisionRequest.class);
+ assertEquals(expected, actual);
+
+ // check value from superclass
+ assertSame(executor, config.getBlockingExecutor());
+ assertSame(client, config.getClient());
+
+ // repeat, with minimal parameters
+ params = GuardParams.builder().clientName(MY_CLIENT).path(PATH).timeoutSec(TIMEOUT).build();
+ config = new GuardConfig(executor, params, factory);
+
+ actual = Util.translate("", config.makeRequest(), DecisionRequest.class);
+ assertEquals(new DecisionRequest(), actual);
+ }
+}
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
-import java.util.LinkedHashMap;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.CompletableFuture;
*/
@Before
public void setUp() throws Exception {
- super.setUp();
+ super.setUpBasic();
- oper = new GuardOperation(params, operator);
+ GuardConfig cguard = mock(GuardConfig.class);
+ when(cguard.makeRequest()).thenAnswer(args -> new TreeMap<>(Map.of("action", "guard")));
+
+ config = cguard;
+ initConfig();
+
+ oper = new GuardOperation(params, config);
}
@Test
executor.runAll(100);
assertTrue(future2.isDone());
- DecisionRequest request = requestCaptor.getValue().getEntity();
- verifyRequest("makeReqStd.json", request, "requestId");
-
assertEquals(PolicyResult.SUCCESS, future2.get().getResult());
}
// null payload - start with fresh parameters and operation
params = params.toBuilder().payload(null).build();
- oper = new GuardOperation(params, operator);
+ oper = new GuardOperation(params, config);
assertThatIllegalArgumentException().isThrownBy(() -> oper.makeRequest());
}
req.setRequestId("my-request-id");
@SuppressWarnings("unchecked")
- Map<String, String> map = Util.translate("", req, LinkedHashMap.class);
+ Map<String, String> map = Util.translate("", req, TreeMap.class);
// add resources
map.put(GuardOperation.RESOURCE_PREFIX + "actor", "resource-actor");
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.controlloop.actor.guard;
+
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.when;
+
+import java.util.Map;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.onap.policy.common.endpoints.http.client.HttpClient;
+import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
+import org.onap.policy.controlloop.actorserviceprovider.Util;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException;
+
+public class GuardOperatorTest {
+ private static final String ACTOR = "my-actor";
+ private static final String OPERATION = "my-name";
+ private static final String CLIENT = "my-client";
+ private static final String PATH = "my-path";
+ private static final int TIMEOUT = 10;
+ private static final String ONAP_NAME = "onap-nap";
+ private static final String ONAP_COMP = "onap-component";
+ private static final String ONAP_INST = "onap-instance";
+ private static final String MY_ACTION = "my-action";
+
+ @Mock
+ private HttpClient client;
+
+ @Mock
+ private HttpClientFactory factory;
+
+
+ private GuardOperator oper;
+
+ /**
+ * Initializes fields, including {@link #oper}, and resets the static fields used by
+ * the REST server.
+ */
+ @Before
+ public void setUp() {
+ MockitoAnnotations.initMocks(this);
+
+ when(factory.get(CLIENT)).thenReturn(client);
+
+ oper = new MyOperator();
+
+ GuardParams params = GuardParams.builder().onapName(ONAP_NAME).onapComponent(ONAP_COMP).onapInstance(ONAP_INST)
+ .action(MY_ACTION).clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build();
+ Map<String, Object> paramMap = Util.translateToMap(OPERATION, params);
+ oper.configure(paramMap);
+
+ assertTrue(oper.makeConfiguration(paramMap) instanceof GuardConfig);
+ }
+
+ @Test
+ public void testConstructor() {
+ assertEquals(ACTOR, oper.getActorName());
+ assertEquals(OPERATION, oper.getName());
+ assertEquals(ACTOR + "." + OPERATION, oper.getFullName());
+ }
+
+ @Test
+ public void testDoConfigure_testGetters() {
+ assertTrue(oper.getCurrentConfig() instanceof GuardConfig);
+
+ // test invalid parameters
+ Map<String, Object> paramMap2 = Util.translateToMap(OPERATION, GuardParams.builder().build());
+ assertThatThrownBy(() -> oper.configure(paramMap2)).isInstanceOf(ParameterValidationRuntimeException.class);
+ }
+
+
+ private class MyOperator extends GuardOperator {
+ public MyOperator() {
+ super(ACTOR, OPERATION, null);
+ }
+
+ @Override
+ protected HttpClientFactory getClientFactory() {
+ return factory;
+ }
+ }
+}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.controlloop.actor.guard;
+
+import static org.assertj.core.api.Assertions.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.guard.GuardParams.GuardParamsBuilder;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpParams.HttpParamsBuilder;
+
+public class GuardParamsTest {
+ private static final String CONTAINER = "my-container";
+ private static final String CLIENT = "my-client";
+ private static final String PATH = "my-path";
+ private static final int TIMEOUT = 10;
+ private static final String ONAP_NAME = "onap-nap";
+ private static final String ONAP_COMP = "onap-component";
+ private static final String ONAP_INST = "onap-instance";
+ private static final String MY_ACTION = "my-action";
+
+ private GuardParams params;
+
+ @Before
+ public void setUp() {
+ params = GuardParams.builder().onapName(ONAP_NAME).onapComponent(ONAP_COMP).onapInstance(ONAP_INST)
+ .action(MY_ACTION).clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build();
+ }
+
+ @Test
+ public void testValidate() {
+ assertTrue(params.validate(CONTAINER).isValid());
+
+ // validate one of the superclass fields
+ testValidateField("clientName", "null", bldr -> bldr.clientName(null));
+
+ // validate with mostly empty params
+ params = GuardParams.builder().clientName(CLIENT).path(PATH).timeoutSec(TIMEOUT).build();
+ assertTrue(params.validate(CONTAINER).isValid());
+ }
+
+ @Test
+ public void testBuilder_testToBuilder() {
+ assertEquals(CLIENT, params.getClientName());
+
+ assertEquals(ONAP_NAME, params.getOnapName());
+ assertEquals(ONAP_COMP, params.getOnapComponent());
+ assertEquals(ONAP_INST, params.getOnapInstance());
+ assertEquals(MY_ACTION, params.getAction());
+
+ assertEquals(params, params.toBuilder().build());
+ }
+
+ private void testValidateField(String fieldName, String expected,
+ @SuppressWarnings("rawtypes") Function<GuardParamsBuilder, 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);
+ }
+}
{
- "ONAPName": "my-onap-name",
"ONAPComponent": "my-onap-component",
"ONAPInstance": "my-onap-instance",
- "requestId": "abcdefghi",
+ "ONAPName": "my-onap-name",
"action": "my-action",
+ "requestId": "abcdefghi",
"resource": {
"actor": "resource-actor",
"operation": "resource-operation"
import java.util.UUID;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
-import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.onap.policy.sdnc.SdncHealRequest;
import org.onap.policy.sdnc.SdncHealRequestHeaderInfo;
import org.onap.policy.sdnc.SdncHealRequestInfo;
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public BandwidthOnDemandOperation(ControlLoopOperationParams params, HttpOperator operator) {
- super(params, operator);
+ public BandwidthOnDemandOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config);
}
@Override
import java.util.UUID;
import org.apache.commons.lang3.StringUtils;
import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
-import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.onap.policy.sdnc.SdncHealNetworkInfo;
import org.onap.policy.sdnc.SdncHealRequest;
import org.onap.policy.sdnc.SdncHealRequestHeaderInfo;
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public RerouteOperation(ControlLoopOperationParams params, HttpOperator operator) {
- super(params, operator);
+ public RerouteOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config);
}
@Override
import org.onap.policy.controlloop.VirtualControlLoopEvent;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpActor;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpActorParams;
import org.onap.policy.controlloop.policy.Policy;
import org.onap.policy.sdnc.SdncHealNetworkInfo;
import org.onap.policy.sdnc.SdncHealRequest;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-public class SdncActorServiceProvider extends HttpActor {
+public class SdncActorServiceProvider extends HttpActor<HttpActorParams> {
private static final Logger logger = LoggerFactory.getLogger(SdncActorServiceProvider.class);
public static final String NAME = "SDNC";
* Constructs the object.
*/
public SdncActorServiceProvider() {
- super(NAME);
+ super(NAME, HttpActorParams.class);
- addOperator(HttpOperator.makeOperator(NAME, RerouteOperation.NAME,
- RerouteOperation::new));
-
- addOperator(HttpOperator.makeOperator(NAME, BandwidthOnDemandOperation.NAME,
- BandwidthOnDemandOperation::new));
+ addOperator(new HttpOperator(NAME, RerouteOperation.NAME, RerouteOperation::new));
+ addOperator(new HttpOperator(NAME, BandwidthOnDemandOperation.NAME, BandwidthOnDemandOperation::new));
}
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
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;
import org.onap.policy.sdnc.SdncRequest;
import org.onap.policy.sdnc.SdncResponse;
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public SdncOperation(ControlLoopOperationParams params, HttpOperator operator) {
- super(params, operator, SdncResponse.class);
+ public SdncOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config, SdncResponse.class);
}
/**
// @formatter:off
return handleResponse(outcome, url,
- callback -> getOperator().getClient().post(callback, makePath(), entity, headers));
+ callback -> getClient().post(callback, makePath(), entity, headers));
// @formatter:on
}
@Before
public void setUp() throws Exception {
super.setUp();
- oper = new BandwidthOnDemandOperation(params, operator);
+ oper = new BandwidthOnDemandOperation(params, config);
}
@Test
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeoutException;
-import java.util.function.BiFunction;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.controlloop.actor.test.BasicHttpOperation;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.impl.OperationMaker;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.onap.policy.sdnc.SdncRequest;
import org.onap.policy.sdnc.SdncResponse;
* Initializes mocks and sets up.
*/
public void setUp() throws Exception {
- super.setUp();
+ super.setUpBasic();
response = new SdncResponse();
* @param expectedText text expected in the exception message
*/
protected void verifyMissing(String fieldName, String expectedText,
- BiFunction<ControlLoopOperationParams, HttpOperator, SdncOperation> maker) {
+ OperationMaker<HttpConfig, SdncOperation> maker) {
makeContext();
enrichment.remove(fieldName);
- SdncOperation oper = maker.apply(params, operator);
+ SdncOperation oper = maker.apply(params, config);
assertThatIllegalArgumentException().isThrownBy(() -> Whitebox.invokeMethod(oper, "makeRequest", 1))
.withMessageContaining("missing").withMessageContaining(expectedText);
@Before
public void setUp() throws Exception {
super.setUp();
- oper = new RerouteOperation(params, operator);
+ oper = new RerouteOperation(params, config);
}
@Test
public void setUp() throws Exception {
super.setUp();
- oper = new SdncOperation(params, operator) {
+ oper = new SdncOperation(params, config) {
@Override
protected SdncRequest makeRequest(int attempt) {
return request;
public SoActorServiceProvider() {
super(NAME);
- addOperator(SoOperator.makeSoOperator(NAME, VfModuleCreate.NAME, VfModuleCreate::new));
+ addOperator(new SoOperator(NAME, VfModuleCreate.NAME, VfModuleCreate::new));
}
// TODO old code: remove lines down to **HERE**
--- /dev/null
+/*-
+ * ============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.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 SoConfig 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;
+
+
+ /**
+ * Constructs the object.
+ *
+ * @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 SoConfig(Executor blockingExecutor, SoParams params, HttpClientFactory clientFactory) {
+ super(blockingExecutor, params, clientFactory);
+
+ this.pathGet = params.getPathGet() + (params.getPathGet().endsWith("/") ? "" : "/");
+ this.maxGets = params.getMaxGets();
+ this.waitSecGet = params.getWaitSecGet();
+ }
+}
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.policy.PolicyResult;
import org.onap.policy.controlloop.policy.Target;
import org.onap.policy.so.SoModelInfo;
public static final String REQ_PARAM_NM = "requestParameters";
public static final String CONFIG_PARAM_NM = "configurationParameters";
- @Getter
- private final SoOperator operator;
+ private final SoConfig config;
/**
* Number of "get" requests issued so far, on the current operation attempt.
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public SoOperation(ControlLoopOperationParams params, SoOperator operator) {
- super(params, operator, SoResponse.class);
- this.operator = operator;
+ public SoOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config, SoResponse.class);
+ this.config = (SoConfig) config;
}
/**
}
// see if the limit for the number of "gets" has been reached
- if (getCount++ >= operator.getMaxGets()) {
- logger.warn("{}: execeeded 'get' limit {} for {}", getFullName(), operator.getMaxGets(),
- params.getRequestId());
+ if (getCount++ >= getMaxGets()) {
+ logger.warn("{}: execeeded 'get' limit {} for {}", getFullName(), getMaxGets(), params.getRequestId());
setOutcome(outcome, PolicyResult.FAILURE_TIMEOUT);
outcome.setMessage(SO_RESPONSE_CODE + " " + outcome.getMessage());
return CompletableFuture.completedFuture(outcome);
* @return a future that can be used to cancel the "get" request or await its response
*/
private CompletableFuture<OperationOutcome> issueGet(OperationOutcome outcome, SoResponse response) {
- String path = operator.getPathGet() + response.getRequestReferences().getRequestId();
- String url = operator.getClient().getBaseUrl() + path;
+ String path = getPathGet() + response.getRequestReferences().getRequestId();
+ String url = getClient().getBaseUrl() + path;
logger.debug("{}: 'get' count {} for {}", getFullName(), getCount, params.getRequestId());
logMessage(EventType.OUT, CommInfrastructure.REST, url, null);
// TODO should this use "path" or the full "url"?
- return handleResponse(outcome, url, callback -> operator.getClient().get(callback, path, null));
+ return handleResponse(outcome, url, callback -> getClient().get(callback, path, null));
}
/**
* @return the wait time, in milliseconds, between "get" requests
*/
public long getWaitMsGet() {
- return TimeUnit.MILLISECONDS.convert(operator.getWaitSecGet(), TimeUnit.SECONDS);
+ 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();
}
}
package org.onap.policy.controlloop.actor.so;
import java.util.Map;
-import java.util.function.BiFunction;
-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.impl.HttpOperation;
import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.impl.OperationMaker;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException;
-@Getter
-public abstract class SoOperator extends HttpOperator {
-
- /**
- * 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;
-
+/**
+ * SO Operator.
+ */
+public class SoOperator extends HttpOperator {
- public SoOperator(String actorName, String name) {
- super(actorName, name);
+ public SoOperator(String actorName, String name,
+ @SuppressWarnings("rawtypes") OperationMaker<HttpConfig, HttpOperation> operationMaker) {
+ super(actorName, name, operationMaker);
}
@Override
- protected void doConfigure(Map<String, Object> parameters) {
+ 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);
}
- this.pathGet = params.getPathGet() + (params.getPathGet().endsWith("/") ? "" : "/");
- this.maxGets = params.getMaxGets();
- this.waitSecGet = params.getWaitSecGet();
-
- super.doConfigure(params);
- }
-
- /**
- * Makes an operator that will construct operations.
- *
- * @param actorName actor name
- * @param operation operation name
- * @param operationMaker function to make an operation
- * @return a new operator
- */
- public static SoOperator makeSoOperator(String actorName, String operation,
- BiFunction<ControlLoopOperationParams, SoOperator, SoOperation> operationMaker) {
-
- return new SoOperator(actorName, operation) {
- @Override
- public Operation buildOperation(ControlLoopOperationParams params) {
- return operationMaker.apply(params, this);
- }
- };
+ return new SoConfig(getBlockingExecutor(), params, getClientFactory());
}
}
import org.onap.policy.controlloop.actor.aai.AaiCustomQueryOperation;
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.so.SoCloudConfiguration;
import org.onap.policy.so.SoModelInfo;
import org.onap.policy.so.SoOperationType;
public class VfModuleCreate extends SoOperation {
public static final String NAME = "VF Module Create";
- public VfModuleCreate(ControlLoopOperationParams params, SoOperator operator) {
- super(params, operator);
+ public VfModuleCreate(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config);
}
/**
SoRequest request = pair.getRight();
Entity<SoRequest> entity = Entity.entity(request, MediaType.APPLICATION_JSON);
- String url = getOperator().getClient().getBaseUrl() + path;
+ String url = getClient().getBaseUrl() + path;
logMessage(EventType.OUT, CommInfrastructure.REST, url, request);
// TODO should this use "path" or the full "url"?
- return handleResponse(outcome, url, callback -> getOperator().getClient().post(callback, path, entity, null));
+ return handleResponse(outcome, url, callback -> getClient().post(callback, path, entity, null));
}
/**
public static final int WAIT_SEC_GETS = 20;
@Mock
- protected SoOperator soOperator;
+ protected SoConfig config;
protected Target target;
protected SoResponse response;
* Initializes mocks and sets up.
*/
public void setUp() throws Exception {
- super.setUp();
+ super.setUpBasic();
response = new SoResponse();
when(rawResponse.getStatus()).thenReturn(200);
when(rawResponse.readEntity(String.class)).thenReturn(coder.encode(response));
- operator = soOperator;
-
- initOperator();
+ initConfig();
}
@Override
- protected void initOperator() {
- super.initOperator();
- when(soOperator.getMaxGets()).thenReturn(MAX_GETS);
- when(soOperator.getPathGet()).thenReturn(PATH_GET);
- when(soOperator.getWaitSecGet()).thenReturn(WAIT_SEC_GETS);
+ 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);
}
@Override
--- /dev/null
+/*-
+ * ============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 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 SoConfigTest {
+ 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 SoParams params;
+ private SoConfig config;
+
+ /**
+ * Sets up.
+ */
+ @Before
+ public void setUp() {
+ MockitoAnnotations.initMocks(this);
+
+ 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);
+ }
+
+ @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 SoConfig(executor, params, factory);
+ assertEquals(GET_PATH + "/", config.getPathGet());
+ }
+}
public void setUp() throws Exception {
super.setUp();
- initOperator();
+ initConfig();
- oper = new SoOperation(params, soOperator) {};
+ oper = new SoOperation(params, config) {};
}
@Test
public void testConstructor_testGetWaitMsGet() {
assertEquals(DEFAULT_ACTOR, oper.getActorName());
assertEquals(DEFAULT_OPERATION, oper.getName());
- assertSame(soOperator, oper.getOperator());
+ assertSame(config, oper.getConfig());
assertEquals(1000 * WAIT_SEC_GETS, oper.getWaitMsGet());
}
public void testStartPreprocessorAsync() {
AtomicBoolean guardStarted = new AtomicBoolean();
- oper = new SoOperation(params, soOperator) {
+ oper = new SoOperation(params, config) {
@Override
protected CompletableFuture<OperationOutcome> startGuardAsync() {
guardStarted.set(true);
// use a real executor
params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
- oper = new SoOperation(params, soOperator) {
+ 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));
+ assertSame(outcome, future2.get(500, TimeUnit.SECONDS));
assertEquals(PolicyResult.SUCCESS, outcome.getResult());
assertEquals(2, oper.getGetCount());
// try with null target
params = params.toBuilder().target(null).build();
- oper = new SoOperation(params, soOperator) {};
+ oper = new SoOperation(params, config) {};
assertThatIllegalArgumentException().isThrownBy(() -> oper.prepareSoModelInfo()).withMessage("missing Target");
}
// null payload
params = params.toBuilder().payload(null).build();
- oper = new SoOperation(params, soOperator) {};
+ oper = new SoOperation(params, config) {};
assertNull(oper.buildRequestParameters());
}
// null payload
params = params.toBuilder().payload(null).build();
- oper = new SoOperation(params, soOperator) {};
+ oper = new SoOperation(params, config) {};
assertNull(oper.buildConfigurationParameters());
}
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.assertNotSame;
-import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.when;
import java.util.Map;
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.VirtualControlLoopEvent;
-import org.onap.policy.controlloop.actorserviceprovider.Operation;
import org.onap.policy.controlloop.actorserviceprovider.Util;
-import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException;
public class SoOperatorTest {
assertEquals(ACTOR + "." + OPERATION, oper.getFullName());
}
- @Test
- public void testMakeSoOperator() {
- oper = SoOperator.makeSoOperator(ACTOR, OPERATION, MyOperation::new);
-
- VirtualControlLoopEvent event = new VirtualControlLoopEvent();
- ControlLoopEventContext context = new ControlLoopEventContext(event);
- ControlLoopOperationParams params =
- ControlLoopOperationParams.builder().actor(ACTOR).operation(OPERATION).context(context).build();
-
- Operation operation1 = oper.buildOperation(params);
- assertNotNull(operation1);
-
- Operation operation2 = oper.buildOperation(params);
- assertNotNull(operation2);
- assertNotSame(operation1, operation2);
- }
-
@Test
public void testDoConfigure_testGetters() {
- // should use given values
- assertSame(client, oper.getClient());
- assertEquals(PATH_GET, oper.getPathGet());
- assertEquals(MAX_GETS, oper.getMaxGets());
- assertEquals(WAIT_SEC_GETS, oper.getWaitSecGet());
-
- SoParams params = SoParams.builder().pathGet("unslashed").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);
- assertEquals("unslashed/", oper.getPathGet());
+ assertTrue(oper.getCurrentConfig() instanceof SoConfig);
// test invalid parameters
Map<String, Object> paramMap2 = Util.translateToMap(OPERATION, SoParams.builder().build());
private class MyOperator extends SoOperator {
public MyOperator() {
- super(ACTOR, OPERATION);
- }
-
- @Override
- public Operation buildOperation(ControlLoopOperationParams params) {
- return null;
+ super(ACTOR, OPERATION, null);
}
@Override
return factory;
}
}
-
- private class MyOperation extends SoOperation {
- public MyOperation(ControlLoopOperationParams params, SoOperator operator) {
- super(params, operator);
- }
- }
}
@Before
public void setUp() throws Exception {
super.setUp();
- oper = new VfModuleCreate(params, soOperator);
+ oper = new VfModuleCreate(params, config);
}
@Test
AtomicBoolean guardStarted = new AtomicBoolean();
- oper = new VfModuleCreate(params, soOperator) {
+ oper = new VfModuleCreate(params, config) {
@Override
protected CompletableFuture<OperationOutcome> startGuardAsync() {
guardStarted.set(true);
// use a real executor
params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
- oper = new VfModuleCreate(params, soOperator) {
+ oper = new VfModuleCreate(params, config) {
@Override
public long getWaitMsGet() {
return 1;
// use a real executor
params = params.toBuilder().executor(ForkJoinPool.commonPool()).build();
- oper = new VfModuleCreate(params, soOperator) {
+ oper = new VfModuleCreate(params, config) {
@Override
public long getWaitMsGet() {
return 1;
import org.mockito.ArgumentCaptor;
import org.mockito.Captor;
import org.mockito.Mock;
-import org.mockito.MockitoAnnotations;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoderObject;
-import org.onap.policy.common.utils.time.PseudoExecutor;
-import org.onap.policy.controlloop.actorserviceprovider.impl.BidirectionalTopicOperator;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
public class BasicBidirectionalTopicOperation extends BasicOperation {
protected static final String MY_SINK = "my-sink";
protected static final String MY_SOURCE = "my-source";
- protected static final int TIMEOUT = 10;
+ protected static final int TIMEOUT_SEC = 10;
+ protected static final long TIMEOUT_MS = 1000L * TIMEOUT_SEC;
@Captor
protected ArgumentCaptor<BiConsumer<String, StandardCoderObject>> listenerCaptor;
@Mock
protected Forwarder forwarder;
@Mock
- protected BidirectionalTopicOperator operator;
-
- protected BidirectionalTopicParams topicParams;
+ protected BidirectionalTopicConfig config;
/**
* Constructs the object using a default actor and operation name.
/**
* Initializes mocks and sets up.
*/
- public void setUp() throws Exception {
- MockitoAnnotations.initMocks(this);
-
- executor = new PseudoExecutor();
-
- makeContext();
-
- outcome = params.makeOutcome();
- topicParams = BidirectionalTopicParams.builder().sinkTopic(MY_SINK).sourceTopic(MY_SOURCE).timeoutSec(TIMEOUT)
- .build();
-
- initOperator();
+ @Override
+ public void setUpBasic() {
+ super.setUpBasic();
+ initConfig();
}
/**
- * Initializes an operator so that it is "alive" and has the given names.
+ * Initializes a configuration.
*/
- protected void initOperator() {
- when(operator.isAlive()).thenReturn(true);
- when(operator.getFullName()).thenReturn(actorName + "." + operationName);
- when(operator.getActorName()).thenReturn(actorName);
- when(operator.getName()).thenReturn(operationName);
- when(operator.getTopicHandler()).thenReturn(topicHandler);
- when(operator.getForwarder()).thenReturn(forwarder);
- when(operator.getParams()).thenReturn(topicParams);
+ protected void initConfig() {
+ when(config.getTopicHandler()).thenReturn(topicHandler);
+ when(config.getForwarder()).thenReturn(forwarder);
+ when(config.getTimeoutMs()).thenReturn(TIMEOUT_MS);
}
/**
import org.mockito.stubbing.Answer;
import org.onap.policy.common.endpoints.http.client.HttpClient;
import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
-import org.onap.policy.controlloop.actorserviceprovider.impl.HttpOperator;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.HttpConfig;
/**
* Superclass for various HttpOperation tests.
@Captor
protected ArgumentCaptor<InvocationCallback<Response>> callbackCaptor;
-
@Captor
protected ArgumentCaptor<Entity<Q>> requestCaptor;
-
@Captor
protected ArgumentCaptor<Map<String, Object>> headerCaptor;
+ @Mock
+ protected HttpConfig config;
@Mock
protected HttpClient client;
-
@Mock
protected HttpClientFactory factory;
-
@Mock
protected Response rawResponse;
- @Mock
- protected HttpOperator operator;
-
/**
* Constructs the object using a default actor and operation name.
/**
* Initializes mocks and sets up.
*/
- public void setUp() throws Exception {
- super.setUp();
+ @Override
+ public void setUpBasic() {
+ super.setUpBasic();
when(factory.get(MY_CLIENT)).thenReturn(client);
when(client.getBaseUrl()).thenReturn(BASE_URI);
- initOperator();
+ initConfig();
}
/**
- * Initializes an operator so that it is "alive" and has the given names.
+ * Initializes a configuration.
*/
- protected void initOperator() {
- when(operator.isAlive()).thenReturn(true);
- when(operator.getFullName()).thenReturn(actorName + "." + operationName);
- when(operator.getActorName()).thenReturn(actorName);
- when(operator.getName()).thenReturn(operationName);
- when(operator.getClient()).thenReturn(client);
- when(operator.getPath()).thenReturn(PATH);
+ protected void initConfig() {
+ when(config.getClient()).thenReturn(client);
+ when(config.getPath()).thenReturn(PATH);
}
/**
/**
* Initializes mocks and sets up.
*/
- public void setUp() throws Exception {
+ public void setUpBasic() {
MockitoAnnotations.initMocks(this);
future = new CompletableFuture<>();
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
-import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.verify;
MockitoAnnotations.initMocks(this);
oper = new BasicBidirectionalTopicOperation(ACTOR, OPERATION);
- oper.setUp();
+ oper.setUpBasic();
}
@Test
public void testBasicBidirectionalTopicOperation() {
oper = new BasicBidirectionalTopicOperation();
- assertEquals(BasicHttpOperation.DEFAULT_ACTOR, oper.actorName);
- assertEquals(BasicHttpOperation.DEFAULT_OPERATION, oper.operationName);
+ assertEquals(BasicOperation.DEFAULT_ACTOR, oper.actorName);
+ assertEquals(BasicOperation.DEFAULT_OPERATION, oper.operationName);
}
@Test
@Test
public void testSetUp() {
- assertNotNull(oper.topicParams);
+ assertNotNull(oper.config);
assertNotNull(oper.context);
assertNotNull(oper.outcome);
assertNotNull(oper.executor);
- assertTrue(oper.operator.isAlive());
}
@Test
public void testInitOperator() {
- oper.initOperator();
-
- assertTrue(oper.operator.isAlive());
- assertEquals(ACTOR + "." + OPERATION, oper.operator.getFullName());
- assertEquals(ACTOR, oper.operator.getActorName());
- assertEquals(OPERATION, oper.operator.getName());
- assertSame(oper.topicHandler, oper.operator.getTopicHandler());
- assertSame(oper.forwarder, oper.operator.getForwarder());
- assertSame(oper.topicParams, oper.operator.getParams());
+ oper.initConfig();
+
+ assertSame(oper.topicHandler, oper.config.getTopicHandler());
+ assertSame(oper.forwarder, oper.config.getForwarder());
+ assertEquals(BasicBidirectionalTopicOperation.TIMEOUT_MS, oper.config.getTimeoutMs());
}
@Test
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
-import static org.junit.Assert.assertTrue;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
@Before
public void setUp() throws Exception {
oper = new BasicHttpOperation<>(ACTOR, OPERATION);
- oper.setUp();
+ oper.setUpBasic();
}
@Test
public void testBasicHttpOperation() {
oper = new BasicHttpOperation<>();
- assertEquals(BasicHttpOperation.DEFAULT_ACTOR, oper.actorName);
- assertEquals(BasicHttpOperation.DEFAULT_OPERATION, oper.operationName);
+ assertEquals(BasicOperation.DEFAULT_ACTOR, oper.actorName);
+ assertEquals(BasicOperation.DEFAULT_OPERATION, oper.operationName);
}
@Test
assertNotNull(oper.context);
assertNotNull(oper.outcome);
assertNotNull(oper.executor);
- assertTrue(oper.operator.isAlive());
}
@Test
public void testInitOperator() throws Exception {
- oper.initOperator();
-
- assertTrue(oper.operator.isAlive());
- assertEquals(ACTOR + "." + OPERATION, oper.operator.getFullName());
- assertEquals(ACTOR, oper.operator.getActorName());
- assertEquals(OPERATION, oper.operator.getName());
- assertSame(oper.client, oper.operator.getClient());
- assertEquals(BasicHttpOperation.PATH, oper.operator.getPath());
+ oper.initConfig();
+
+ assertSame(oper.client, oper.config.getClient());
+ assertEquals(BasicHttpOperation.PATH, oper.config.getPath());
}
@Test
@Before
public void setUp() throws Exception {
oper = new BasicHttpOperation<>(ACTOR, OPERATION);
- oper.setUp();
+ oper.setUpBasic();
}
@Test
import org.onap.policy.common.endpoints.event.comm.client.BidirectionalTopicClientException;
import org.onap.policy.controlloop.actorserviceprovider.Util;
import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicActorParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicParams;
import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicManager;
/**
- * Actor that uses a bidirectional topic. The actor's parameters must be a
- * {@link BidirectionalTopicActorParams}.
+ * Actor that uses a bidirectional topic. The actor's operator parameters are expected to
+ * be an {@link BidirectionalTopicParams}.
+ *
+ * @param <P> type of parameters
*/
-public class BidirectionalTopicActor extends ActorImpl implements BidirectionalTopicManager {
+public class BidirectionalTopicActor<P extends BidirectionalTopicActorParams> extends ActorImpl
+ implements BidirectionalTopicManager {
+
+ /**
+ * Class of parameters.
+ */
+ private final Class<P> paramsClass;
/**
* Maps a pair of sink and source topic names to their bidirectional topic.
*
* @param name actor's name
*/
- public BidirectionalTopicActor(String name) {
+ public BidirectionalTopicActor(String name, Class<P> paramsClass) {
super(name);
+ this.paramsClass = paramsClass;
}
@Override
String actorName = getName();
// @formatter:off
- return Util.translate(actorName, actorParameters, BidirectionalTopicActorParams.class)
+ return Util.translate(actorName, actorParameters, paramsClass)
.doValidation(actorName)
.makeOperationParameters(actorName);
// @formatter:on
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executor;
-import java.util.concurrent.TimeUnit;
import java.util.function.BiConsumer;
import lombok.Getter;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoderObject;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
SUCCESS, FAILURE, STILL_WAITING
}
- // fields extracted from the operator
-
- private final BidirectionalTopicHandler topicHandler;
- private final Forwarder forwarder;
- private final BidirectionalTopicParams topicParams;
- private final long timeoutMs;
+ /**
+ * Configuration for this operation.
+ */
+ private final BidirectionalTopicConfig config;
/**
* Response class.
*/
private final Class<S> responseClass;
+ // fields extracted from "config"
+
+ private final BidirectionalTopicHandler topicHandler;
+ private final Forwarder forwarder;
+
/**
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
* @param clazz response class
*/
- public BidirectionalTopicOperation(ControlLoopOperationParams params, BidirectionalTopicOperator operator,
+ public BidirectionalTopicOperation(ControlLoopOperationParams params, BidirectionalTopicConfig config,
Class<S> clazz) {
- super(params, operator);
- this.topicHandler = operator.getTopicHandler();
- this.forwarder = operator.getForwarder();
- this.topicParams = operator.getParams();
+ super(params, config);
+ this.config = config;
this.responseClass = clazz;
- this.timeoutMs = TimeUnit.MILLISECONDS.convert(topicParams.getTimeoutSec(), TimeUnit.SECONDS);
+ this.forwarder = config.getForwarder();
+ this.topicHandler = config.getTopicHandler();
+ }
+
+ public long getTimeoutMs() {
+ return config.getTimeoutMs();
}
/**
@Override
protected long getTimeoutMs(Integer timeoutSec) {
// TODO move this method to the superclass
- return (timeoutSec == null || timeoutSec == 0 ? this.timeoutMs : super.getTimeoutMs(timeoutSec));
+ return (timeoutSec == null || timeoutSec == 0 ? getTimeoutMs() : super.getTimeoutMs(timeoutSec));
}
/**
import java.util.Arrays;
import java.util.List;
import java.util.Map;
-import java.util.function.BiFunction;
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;
-import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey;
/**
* Operator that uses a bidirectional topic. Topic operators may share a
* {@link BidirectionalTopicHandler}.
*/
-public abstract class BidirectionalTopicOperator extends OperatorPartial {
+public class BidirectionalTopicOperator extends OperatorPartial {
+
+ /**
+ * Function to make an operation.
+ */
+ @SuppressWarnings("rawtypes")
+ private final OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation> operationMaker;
/**
* Manager from which to get the topic handlers.
*/
private final List<SelectorKey> selectorKeys;
- /*
- * The remaining fields are initialized when configure() is invoked, thus they may
- * change.
- */
-
/**
- * Current parameters. While {@link params} may change, the values contained within it
- * will not, thus operations may copy it.
+ * Current configuration. This is set by {@link #doConfigure(Map)}.
*/
@Getter
- private BidirectionalTopicParams params;
+ private BidirectionalTopicConfig currentConfig;
- /**
- * Topic handler associated with the parameters.
- */
- @Getter
- private BidirectionalTopicHandler topicHandler;
/**
- * Forwarder associated with the parameters.
+ * Constructs the object.
+ *
+ * @param actorName name of the actor with which this operator is associated
+ * @param name operation name
+ * @param topicManager manager from which to get the topic handler
+ * @param selectorKeys keys used to extract the fields used to select responses for
+ * this operator
*/
- @Getter
- private Forwarder forwarder;
-
+ protected BidirectionalTopicOperator(String actorName, String name, BidirectionalTopicManager topicManager,
+ List<SelectorKey> selectorKeys) {
+ this(actorName, name, topicManager, selectorKeys, null);
+ }
/**
* Constructs the object.
* @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) {
+ List<SelectorKey> selectorKeys,
+ @SuppressWarnings("rawtypes") OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation>
+ operationMaker) {
+ // @formatter:on
+
super(actorName, name);
this.topicManager = topicManager;
this.selectorKeys = selectorKeys;
- }
-
- @Override
- protected void doConfigure(Map<String, Object> parameters) {
- params = Util.translate(getFullName(), parameters, BidirectionalTopicParams.class);
- ValidationResult result = params.validate(getFullName());
- if (!result.isValid()) {
- throw new ParameterValidationRuntimeException("invalid parameters", result);
- }
-
- topicHandler = topicManager.getTopicHandler(params.getSinkTopic(), params.getSourceTopic());
- forwarder = topicHandler.addForwarder(selectorKeys);
+ this.operationMaker = operationMaker;
}
/**
- * Makes an operator that will construct operations.
+ * Constructs the object.
*
- * @param <Q> request type
- * @param <S> response type
- * @param actorName actor name
- * @param operation operation name
+ * @param actorName name of the actor with which this operator is associated
+ * @param name operation name
* @param topicManager manager from which to get the topic handler
- * @param operationMaker function to make an operation
- * @param keys keys used to extract the fields used to select responses for this
- * operator
- * @return a new operator
+ * @param selectorKeys keys used to extract the fields used to select responses for
+ * this operator
*/
// @formatter:off
- public static <Q, S> BidirectionalTopicOperator makeOperator(String actorName, String operation,
- BidirectionalTopicManager topicManager,
- BiFunction<ControlLoopOperationParams, BidirectionalTopicOperator,
- BidirectionalTopicOperation<Q, S>> operationMaker,
- SelectorKey... keys) {
- // @formatter:off
-
- return makeOperator(actorName, operation, topicManager, Arrays.asList(keys), operationMaker);
+ public BidirectionalTopicOperator(String actorName, String name, BidirectionalTopicManager topicManager,
+ @SuppressWarnings("rawtypes") 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 an operator that will construct operations.
+ * Makes a new configuration using the specified parameters.
*
- * @param <Q> request type
- * @param <S> response type
- * @param actorName actor name
- * @param operation operation name
- * @param topicManager manager from which to get the topic handler
- * @param keys keys used to extract the fields used to select responses for
- * this operator
- * @param operationMaker function to make an operation
- * @return a new operator
+ * @param parameters operator parameters
+ * @return a new configuration
*/
- // @formatter:off
- public static <Q,S> BidirectionalTopicOperator makeOperator(String actorName, String operation,
- BidirectionalTopicManager topicManager,
- List<SelectorKey> keys,
- BiFunction<ControlLoopOperationParams, BidirectionalTopicOperator,
- BidirectionalTopicOperation<Q,S>> operationMaker) {
- // @formatter:on
+ protected BidirectionalTopicConfig makeConfiguration(Map<String, Object> parameters) {
+ BidirectionalTopicParams params = Util.translate(getFullName(), parameters, BidirectionalTopicParams.class);
+ ValidationResult result = params.validate(getFullName());
+ if (!result.isValid()) {
+ throw new ParameterValidationRuntimeException("invalid parameters", result);
+ }
+
+ 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 new BidirectionalTopicOperator(actorName, operation, topicManager, keys) {
- @Override
- public synchronized Operation buildOperation(ControlLoopOperationParams params) {
- return operationMaker.apply(params, this);
- }
- };
+ return operationMaker.apply(params, currentConfig);
}
}
/**
* Actor that uses HTTP, where the only additional property that an operator needs is a
- * URL. The actor's parameters must be an {@link HttpActorParams} and its operator
- * parameters are expected to be an {@link HttpParams}.
+ * URL. The actor's operator parameters are expected to be an {@link HttpParams}.
+ *
+ * @param <P> type of parameters
*/
-public class HttpActor extends ActorImpl {
+public class HttpActor<P extends HttpActorParams> extends ActorImpl {
+
+ /**
+ * Class of parameters.
+ */
+ private final Class<P> paramsClass;
/**
* Constructs the object.
*
* @param name actor's name
+ * @param paramsClass class of parameters
*/
- public HttpActor(String name) {
+ public HttpActor(String name, Class<P> paramsClass) {
super(name);
+ this.paramsClass = paramsClass;
}
/**
String actorName = getName();
// @formatter:off
- return Util.translate(actorName, actorParameters, HttpActorParams.class)
+ return Util.translate(actorName, actorParameters, paramsClass)
.doValidation(actorName)
.makeOperationParameters(actorName);
// @formatter:on
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.HttpParams;
import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
import org.onap.policy.controlloop.policy.PolicyResult;
private static final Logger logger = LoggerFactory.getLogger(HttpOperation.class);
/**
- * Operator that created this operation.
+ * Configuration for this operation.
*/
- private final HttpOperator operator;
+ private final HttpConfig config;
/**
* Response class.
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
* @param clazz response class
*/
- public HttpOperation(ControlLoopOperationParams params, HttpOperator operator, Class<T> clazz) {
- super(params, operator);
- this.operator = operator;
+ public HttpOperation(ControlLoopOperationParams params, HttpConfig config, Class<T> clazz) {
+ super(params, config);
+ this.config = config;
this.responseClass = clazz;
}
+ public HttpClient getClient() {
+ return config.getClient();
+ }
+
+ public String getPath() {
+ return config.getPath();
+ }
+
+ public long getTimeoutMs() {
+ return config.getTimeoutMs();
+ }
+
/**
* If no timeout is specified, then it returns the operator's configured timeout.
*/
@Override
protected long getTimeoutMs(Integer timeoutSec) {
- return (timeoutSec == null || timeoutSec == 0 ? operator.getTimeoutMs() : super.getTimeoutMs(timeoutSec));
+ return (timeoutSec == null || timeoutSec == 0 ? getTimeoutMs() : super.getTimeoutMs(timeoutSec));
}
/**
* @return the path URI suffix
*/
public String makePath() {
- return operator.getPath();
+ return getPath();
}
/**
* @return the URL to which from which to get
*/
public String makeUrl() {
- return (operator.getClient().getBaseUrl() + makePath());
+ return (getClient().getBaseUrl() + makePath());
}
/**
package org.onap.policy.controlloop.actorserviceprovider.impl;
import java.util.Map;
-import java.util.concurrent.TimeUnit;
-import java.util.function.BiFunction;
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.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;
/**
* Operator that uses HTTP. The operator's parameters must be an {@link HttpParams}.
*/
-@Getter
-public abstract class HttpOperator extends OperatorPartial {
-
- private HttpClient client;
+public class HttpOperator extends OperatorPartial {
/**
- * Default timeout, in milliseconds, if none specified in the request.
+ * Function to make an operation.
*/
- private long timeoutMs;
+ @SuppressWarnings("rawtypes")
+ private final OperationMaker<HttpConfig, HttpOperation> operationMaker;
/**
- * URI path for this particular operation. Includes a leading "/".
+ * Current configuration. This is set by {@link #doConfigure(Map)}.
*/
- private String path;
+ @Getter
+ private HttpConfig currentConfig;
/**
* @param actorName name of the actor with which this operator is associated
* @param name operation name
*/
- public HttpOperator(String actorName, String name) {
- super(actorName, name);
+ protected HttpOperator(String actorName, String name) {
+ this(actorName, name, null);
}
/**
- * Makes an operator that will construct operations.
+ * Constructs the object.
*
- * @param <T> response type
- * @param actorName actor name
- * @param operation operation name
+ * @param actorName name of the actor with which this operator is associated
+ * @param name operation name
* @param operationMaker function to make an operation
- * @return a new operator
*/
- public static <T> HttpOperator makeOperator(String actorName, String operation,
- BiFunction<ControlLoopOperationParams, HttpOperator, HttpOperation<T>> operationMaker) {
-
- return new HttpOperator(actorName, operation) {
- @Override
- public Operation buildOperation(ControlLoopOperationParams params) {
- return operationMaker.apply(params, this);
- }
- };
+ public HttpOperator(String actorName, String name,
+ @SuppressWarnings("rawtypes") OperationMaker<HttpConfig, HttpOperation> operationMaker) {
+ super(actorName, name);
+ this.operationMaker = operationMaker;
}
/**
*/
@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 HttpConfig makeConfiguration(Map<String, Object> parameters) {
HttpParams params = Util.translate(getFullName(), parameters, HttpParams.class);
ValidationResult result = params.validate(getFullName());
if (!result.isValid()) {
throw new ParameterValidationRuntimeException("invalid parameters", result);
}
- doConfigure(params);
+ return new HttpConfig(getBlockingExecutor(), params, getClientFactory());
}
- /**
- * Configures the operator using the specified parameters.
- *
- * @param params operator parameters
- */
- protected void doConfigure(HttpParams params) {
- client = getClientFactory().get(params.getClientName());
- path = params.getPath();
- timeoutMs = TimeUnit.MILLISECONDS.convert(params.getTimeoutSec(), TimeUnit.SECONDS);
+ @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
--- /dev/null
+/*-
+ * ============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 org.onap.policy.controlloop.actorserviceprovider.Operation;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+
+/**
+ * Function to make an operation.
+ *
+ * @param <C> configuration type
+ * @param <T> type of operation it creates
+ */
+public interface OperationMaker<C, T extends Operation> {
+ T apply(ControlLoopOperationParams params, C config);
+}
import java.util.function.Function;
import java.util.function.Supplier;
import java.util.function.UnaryOperator;
+import lombok.Getter;
import org.onap.policy.common.endpoints.event.comm.Topic.CommInfrastructure;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil;
import org.onap.policy.common.endpoints.utils.NetLoggerUtil.EventType;
import org.onap.policy.controlloop.actorserviceprovider.Operation;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.OperatorConfig;
import org.onap.policy.controlloop.actorserviceprovider.pipeline.PipelineControllerFuture;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.slf4j.Logger;
public static final long DEFAULT_RETRY_WAIT_MS = 1000L;
- // values extracted from the operator
-
- private final OperatorPartial operator;
+ private final OperatorConfig config;
/**
* Operation parameters.
*/
protected final ControlLoopOperationParams params;
+ @Getter
+ private final String fullName;
+
/**
* Constructs the object.
*
* @param params operation parameters
- * @param operator operator that created this operation
+ * @param config configuration for this operation
*/
- public OperationPartial(ControlLoopOperationParams params, OperatorPartial operator) {
+ public OperationPartial(ControlLoopOperationParams params, OperatorConfig config) {
this.params = params;
- this.operator = operator;
+ this.config = config;
+ this.fullName = params.getActor() + "." + params.getOperation();
}
public Executor getBlockingExecutor() {
- return operator.getBlockingExecutor();
- }
-
- public String getFullName() {
- return operator.getFullName();
+ return config.getBlockingExecutor();
}
public String getActorName() {
- return operator.getActorName();
+ return params.getActor();
}
public String getName() {
- return operator.getName();
+ return params.getOperation();
}
@Override
public final CompletableFuture<OperationOutcome> start() {
- if (!operator.isAlive()) {
- throw new IllegalStateException("operation is not running: " + getFullName());
- }
-
// allocate a controller for the entire operation
final PipelineControllerFuture<OperationOutcome> controller = new PipelineControllerFuture<>();
this.name = name;
}
+ /**
+ * Verifies that the operator is running.
+ *
+ * @throws IllegalStateException if it is not running
+ */
+ public void verifyRunning() {
+ if (!isAlive()) {
+ throw new IllegalStateException("operation is not running: " + getFullName());
+ }
+ }
+
/**
* This method does nothing.
*/
--- /dev/null
+/*-
+ * ============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.parameters;
+
+import java.util.List;
+import java.util.concurrent.Executor;
+import java.util.concurrent.TimeUnit;
+import lombok.Getter;
+import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
+import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicManager;
+import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
+import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey;
+
+/**
+ * Configuration for Bidirectional Topic Operators.
+ */
+@Getter
+public class BidirectionalTopicConfig extends OperatorConfig {
+
+ /**
+ * Topic handler associated with the parameters.
+ */
+ private BidirectionalTopicHandler topicHandler;
+
+ /**
+ * Forwarder associated with the parameters.
+ */
+ private Forwarder forwarder;
+
+ /**
+ * Default timeout, in milliseconds, if none specified in the request.
+ */
+ private final long timeoutMs;
+
+
+ /**
+ * Constructs the object.
+ *
+ * @param blockingExecutor executor to be used for tasks that may perform blocking I/O
+ * @param params operator parameters
+ * @param topicManager manager from which to get the topic handler
+ * @param selectorKeys keys used to extract the fields used to select responses for
+ * this operator
+ */
+ public BidirectionalTopicConfig(Executor blockingExecutor, BidirectionalTopicParams params,
+ BidirectionalTopicManager topicManager, List<SelectorKey> selectorKeys) {
+ super(blockingExecutor);
+ topicHandler = topicManager.getTopicHandler(params.getSinkTopic(), params.getSourceTopic());
+ forwarder = topicHandler.addForwarder(selectorKeys);
+ timeoutMs = TimeUnit.MILLISECONDS.convert(params.getTimeoutSec(), TimeUnit.SECONDS);
+ }
+}
--- /dev/null
+/*-
+ * ============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.parameters;
+
+import java.util.concurrent.Executor;
+import java.util.concurrent.TimeUnit;
+import lombok.Getter;
+import org.onap.policy.common.endpoints.http.client.HttpClient;
+import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
+
+/**
+ * Configuration for HTTP Operators.
+ */
+@Getter
+public class HttpConfig extends OperatorConfig {
+
+ private final HttpClient client;
+
+ /**
+ * Default timeout, in milliseconds, if none specified in the request.
+ */
+ private final long timeoutMs;
+
+ /**
+ * URI path for this particular operation. Includes a leading "/".
+ */
+ private final String path;
+
+
+ /**
+ * Constructs the object.
+ *
+ * @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 HttpConfig(Executor blockingExecutor, HttpParams params, HttpClientFactory clientFactory) {
+ super(blockingExecutor);
+ client = clientFactory.get(params.getClientName());
+ path = params.getPath();
+ timeoutMs = TimeUnit.MILLISECONDS.convert(params.getTimeoutSec(), TimeUnit.SECONDS);
+ }
+}
--- /dev/null
+/*-
+ * ============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.parameters;
+
+import java.util.concurrent.Executor;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+
+@AllArgsConstructor
+public class OperatorConfig {
+
+ /**
+ * Executor to be used for tasks that may perform blocking I/O.
+ */
+ @Getter
+ private final Executor blockingExecutor;
+}
@Mock
private BidirectionalTopicHandler handler2;
- private BidirectionalTopicActor actor;
+ private BidirectionalTopicActor<BidirectionalTopicActorParams> actor;
/**
public void testMakeOperatorParameters() {
BidirectionalTopicActorParams params = makeParams();
- final BidirectionalTopicActor prov = new BidirectionalTopicActor(ACTOR);
+ final BidirectionalTopicActor<BidirectionalTopicActorParams> prov =
+ new BidirectionalTopicActor<>(ACTOR, BidirectionalTopicActorParams.class);
Function<String, Map<String, Object>> maker =
prov.makeOperatorParameters(Util.translateToMap(prov.getName(), params));
@Test
public void testMakeTopicHandler() {
// use a real actor
- actor = new BidirectionalTopicActor(ACTOR);
+ actor = new BidirectionalTopicActor<>(ACTOR, BidirectionalTopicActorParams.class);
handler1 = actor.getTopicHandler(MY_SINK, MY_SOURCE1);
handler2 = actor.getTopicHandler(MY_SINK, MY_SOURCE2);
return params;
}
- private class MyActor extends BidirectionalTopicActor {
+ private class MyActor extends BidirectionalTopicActor<BidirectionalTopicActorParams> {
public MyActor() {
- super(ACTOR);
+ super(ACTOR, BidirectionalTopicActorParams.class);
}
@Override
import org.onap.policy.common.utils.coder.StandardCoderObject;
import org.onap.policy.common.utils.time.PseudoExecutor;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
-import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.BidirectionalTopicConfig;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
private static final String ACTOR = "my-actor";
private static final String OPERATION = "my-operation";
private static final String REQ_ID = "my-request-id";
- private static final String MY_SINK = "my-sink";
- private static final String MY_SOURCE = "my-source";
private static final String TEXT = "some text";
private static final int TIMEOUT_SEC = 10;
private static final long TIMEOUT_MS = 1000 * TIMEOUT_SEC;
private static final StandardCoder coder = new StandardCoder();
@Mock
- private BidirectionalTopicOperator operator;
+ private BidirectionalTopicConfig config;
@Mock
private BidirectionalTopicHandler handler;
@Mock
private ArgumentCaptor<BiConsumer<String, StandardCoderObject>> listenerCaptor;
private ControlLoopOperationParams params;
- private BidirectionalTopicParams topicParams;
private OperationOutcome outcome;
private StandardCoderObject stdResponse;
private String responseText;
public void setUp() throws CoderException {
MockitoAnnotations.initMocks(this);
- topicParams = BidirectionalTopicParams.builder().sourceTopic(MY_SOURCE).sinkTopic(MY_SINK)
- .timeoutSec(TIMEOUT_SEC).build();
-
- when(operator.getActorName()).thenReturn(ACTOR);
- when(operator.getName()).thenReturn(OPERATION);
- when(operator.getTopicHandler()).thenReturn(handler);
- when(operator.getForwarder()).thenReturn(forwarder);
- when(operator.getParams()).thenReturn(topicParams);
- when(operator.isAlive()).thenReturn(true);
+ when(config.getTopicHandler()).thenReturn(handler);
+ when(config.getForwarder()).thenReturn(forwarder);
+ when(config.getTimeoutMs()).thenReturn(TIMEOUT_MS);
when(handler.send(any())).thenReturn(true);
when(handler.getSinkTopicCommInfrastructure()).thenReturn(SINK_INFRA);
assertEquals(OPERATION, oper.getName());
assertSame(handler, oper.getTopicHandler());
assertSame(forwarder, oper.getForwarder());
- assertSame(topicParams, oper.getTopicParams());
assertEquals(TIMEOUT_MS, oper.getTimeoutMs());
assertSame(MyResponse.class, oper.getResponseClass());
}
private class MyStringOperation extends BidirectionalTopicOperation<String, String> {
public MyStringOperation() {
- super(BidirectionalTopicOperationTest.this.params, operator, String.class);
+ super(BidirectionalTopicOperationTest.this.params, config, String.class);
}
@Override
private class MyScoOperation extends BidirectionalTopicOperation<MyRequest, StandardCoderObject> {
public MyScoOperation() {
- super(BidirectionalTopicOperationTest.this.params, operator, StandardCoderObject.class);
+ super(BidirectionalTopicOperationTest.this.params, config, StandardCoderObject.class);
}
@Override
private class MyOperation extends BidirectionalTopicOperation<MyRequest, MyResponse> {
public MyOperation() {
- super(BidirectionalTopicOperationTest.this.params, operator, MyResponse.class);
+ super(BidirectionalTopicOperationTest.this.params, config, MyResponse.class);
}
@Override
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.assertSame;
import static org.mockito.Mockito.when;
+import java.util.Arrays;
import java.util.List;
import java.util.concurrent.atomic.AtomicReference;
-import java.util.function.BiFunction;
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;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ParameterValidationRuntimeException;
public void testConstructor_testGetParams_testGetTopicHandler_testGetForwarder() {
assertEquals(ACTOR, oper.getActorName());
assertEquals(OPERATION, oper.getName());
- assertEquals(params, oper.getParams());
- assertSame(handler, oper.getTopicHandler());
- assertSame(forwarder, oper.getForwarder());
+ assertNotNull(oper.getCurrentConfig());
}
@Test
}
@Test
- public void testMakeOperator() {
+ public void testBuildOperator() {
AtomicReference<ControlLoopOperationParams> paramsRef = new AtomicReference<>();
- AtomicReference<BidirectionalTopicOperator> operRef = new AtomicReference<>();
+ AtomicReference<BidirectionalTopicConfig> configRef = new AtomicReference<>();
// @formatter:off
- BiFunction<ControlLoopOperationParams, BidirectionalTopicOperator,
- BidirectionalTopicOperation<String, Integer>> maker =
- (params, operator) -> {
- paramsRef.set(params);
- operRef.set(operator);
- return operation;
- };
+ @SuppressWarnings("rawtypes")
+ OperationMaker<BidirectionalTopicConfig, BidirectionalTopicOperation> maker =
+ (params, config) -> {
+ paramsRef.set(params);
+ configRef.set(config);
+ return operation;
+ };
// @formatter:on
BidirectionalTopicOperator oper2 =
- BidirectionalTopicOperator.makeOperator(ACTOR, OPERATION, mgr, maker, new SelectorKey(""));
+ new BidirectionalTopicOperator(ACTOR, OPERATION, mgr, maker, new SelectorKey(""));
assertEquals(ACTOR, oper2.getActorName());
assertEquals(OPERATION, oper2.getName());
ControlLoopOperationParams params2 = ControlLoopOperationParams.builder().build();
+ // not running yet
+ assertThatIllegalStateException().isThrownBy(() -> oper2.buildOperation(params2));
+
+ // configure and start it
+ params = BidirectionalTopicParams.builder().sourceTopic(MY_SOURCE).sinkTopic(MY_SINK).timeoutSec(TIMEOUT_SEC)
+ .build();
+ oper2.configure(Util.translateToMap(OPERATION, params));
+ oper2.start();
+
assertSame(operation, oper2.buildOperation(params2));
assertSame(params2, paramsRef.get());
- assertSame(oper2, operRef.get());
+ assertSame(oper2.getCurrentConfig(), configRef.get());
+
+ // with no operation-maker
+ BidirectionalTopicOperator oper3 =
+ new BidirectionalTopicOperator(ACTOR, OPERATION, mgr, Arrays.asList(new SelectorKey("")));
+ assertThatThrownBy(() -> oper3.buildOperation(params2)).isInstanceOf(UnsupportedOperationException.class);
}
private static final String CLIENT = "my-client";
private static final int TIMEOUT = 10;
- private HttpActor actor;
+ private HttpActor<HttpActorParams> actor;
@Before
public void setUp() {
- actor = new HttpActor(ACTOR);
+ actor = new HttpActor<>(ACTOR, HttpActorParams.class);
}
@Test
"operB", Map.of("path", "urlB")));
// @formatter:on
- final HttpActor prov = new HttpActor(ACTOR);
+ final HttpActor<HttpActorParams> prov = new HttpActor<>(ACTOR, HttpActorParams.class);
Function<String, Map<String, Object>> maker =
prov.makeOperatorParameters(Util.translateToMap(prov.getName(), params));
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertSame;
import static org.junit.Assert.assertTrue;
-import static org.mockito.Mockito.spy;
+import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.when;
import java.util.Collections;
import java.util.concurrent.CancellationException;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Executor;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams;
import org.onap.policy.common.endpoints.event.comm.bus.internal.BusTopicParams.TopicParamsBuilder;
import org.onap.policy.common.endpoints.http.client.HttpClient;
+import org.onap.policy.common.endpoints.http.client.HttpClientFactory;
import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance;
import org.onap.policy.common.endpoints.http.server.HttpServletServer;
import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.network.NetworkUtil;
import org.onap.policy.controlloop.VirtualControlLoopEvent;
-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.controlloop.ControlLoopEventContext;
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.policy.PolicyResult;
@Mock
private HttpClient client;
-
+ @Mock
+ private HttpClientFactory clientFactory;
@Mock
private Response response;
+ @Mock
+ private Executor executor;
private VirtualControlLoopEvent event;
private ControlLoopEventContext context;
private OperationOutcome outcome;
private AtomicReference<InvocationCallback<Response>> callback;
private Future<Response> future;
- private HttpOperator operator;
+ private HttpConfig config;
private MyGetOperation<String> oper;
/**
callback = new AtomicReference<>();
future = new CompletableFuture<>();
- operator = new HttpOperator(ACTOR, OPERATION) {
- @Override
- public Operation buildOperation(ControlLoopOperationParams params) {
- return null;
- }
+ when(clientFactory.get(any())).thenReturn(client);
- @Override
- public HttpClient getClient() {
- return client;
- }
- };
-
- initOper(operator, HTTP_CLIENT);
+ initConfig(HTTP_CLIENT);
oper = new MyGetOperation<>(String.class);
}
@Test
public void testMakeUrl() {
// use a real client
- client = HttpClientFactoryInstance.getClientFactory().get(HTTP_CLIENT);
+ initRealConfig(HTTP_CLIENT);
+
+ oper = new MyGetOperation<>(String.class);
assertThat(oper.makeUrl()).endsWith("/" + BASE_URI + PATH);
}
// should use given value
assertEquals(20 * 1000L, oper.getTimeoutMs(20));
-
- // indicate we have a timeout value
- operator = spy(operator);
- when(operator.getTimeoutMs()).thenReturn(30L);
-
- oper = new MyGetOperation<String>(String.class);
-
- // should use default
- assertEquals(30L, oper.getTimeoutMs(null));
- assertEquals(30L, oper.getTimeoutMs(0));
-
- // should use given value
- assertEquals(40 * 1000L, oper.getTimeoutMs(40));
}
/**
@Test
public void testGet() throws Exception {
// use a real client
- client = HttpClientFactoryInstance.getClientFactory().get(HTTP_CLIENT);
+ initRealConfig(HTTP_CLIENT);
MyGetOperation<MyResponse> oper2 = new MyGetOperation<>(MyResponse.class);
@Test
public void testDelete() throws Exception {
// use a real client
- client = HttpClientFactoryInstance.getClientFactory().get(HTTP_CLIENT);
+ initRealConfig(HTTP_CLIENT);
MyDeleteOperation oper2 = new MyDeleteOperation();
@Test
public void testPost() throws Exception {
// use a real client
- client = HttpClientFactoryInstance.getClientFactory().get(HTTP_CLIENT);
-
+ initRealConfig(HTTP_CLIENT);
MyPostOperation oper2 = new MyPostOperation();
OperationOutcome outcome = runOperation(oper2);
@Test
public void testPut() throws Exception {
// use a real client
- client = HttpClientFactoryInstance.getClientFactory().get(HTTP_CLIENT);
+ initRealConfig(HTTP_CLIENT);
MyPutOperation oper2 = new MyPutOperation();
}
/**
- * Initializes the given operator.
+ * Initializes the configuration.
*
* @param operator operator to be initialized
* @param clientName name of the client which it should use
*/
- private void initOper(HttpOperator operator, String clientName) {
- operator.stop();
+ private void initConfig(String clientName) {
+ initConfig(clientName, clientFactory);
+ }
+ /**
+ * Initializes the configuration with a real client.
+ *
+ * @param operator operator to be initialized
+ * @param clientName name of the client which it should use
+ */
+ private void initConfig(String clientName, HttpClientFactory factory) {
HttpParams params = HttpParams.builder().clientName(clientName).path(PATH).timeoutSec(1).build();
- Map<String, Object> mapParams = Util.translateToMap(OPERATION, params);
- operator.configure(mapParams);
- operator.start();
+ config = new HttpConfig(executor, params, factory);
+ }
+
+ /**
+ * Initializes the configuration with a real client.
+ *
+ * @param operator operator to be initialized
+ * @param clientName name of the client which it should use
+ */
+ private void initRealConfig(String clientName) {
+ initConfig(clientName, HttpClientFactoryInstance.getClientFactory());
}
/**
private class MyGetOperation<T> extends HttpOperation<T> {
public MyGetOperation(Class<T> responseClass) {
- super(HttpOperationTest.this.params, HttpOperationTest.this.operator, responseClass);
+ super(HttpOperationTest.this.params, HttpOperationTest.this.config, responseClass);
}
@Override
// @formatter:off
return handleResponse(outcome, url,
- callback -> operator.getClient().get(callback, makePath(), headers));
+ callback -> getClient().get(callback, makePath(), headers));
// @formatter:on
}
}
private class MyPostOperation extends HttpOperation<MyResponse> {
public MyPostOperation() {
- super(HttpOperationTest.this.params, HttpOperationTest.this.operator, MyResponse.class);
+ super(HttpOperationTest.this.params, HttpOperationTest.this.config, MyResponse.class);
}
@Override
// @formatter:off
return handleResponse(outcome, url,
- callback -> operator.getClient().post(callback, makePath(), entity, headers));
+ callback -> getClient().post(callback, makePath(), entity, headers));
// @formatter:on
}
}
private class MyPutOperation extends HttpOperation<MyResponse> {
public MyPutOperation() {
- super(HttpOperationTest.this.params, HttpOperationTest.this.operator, MyResponse.class);
+ super(HttpOperationTest.this.params, HttpOperationTest.this.config, MyResponse.class);
}
@Override
// @formatter:off
return handleResponse(outcome, url,
- callback -> operator.getClient().put(callback, makePath(), entity, headers));
+ callback -> getClient().put(callback, makePath(), entity, headers));
// @formatter:on
}
}
private class MyDeleteOperation extends HttpOperation<String> {
public MyDeleteOperation() {
- super(HttpOperationTest.this.params, HttpOperationTest.this.operator, String.class);
+ super(HttpOperationTest.this.params, HttpOperationTest.this.config, String.class);
}
@Override
// @formatter:off
return handleResponse(outcome, url,
- callback -> operator.getClient().delete(callback, makePath(), headers));
+ callback -> getClient().delete(callback, makePath(), headers));
// @formatter:on
}
}
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.assertNotSame;
import static org.junit.Assert.assertNull;
-import static org.junit.Assert.assertSame;
import static org.mockito.Mockito.when;
import java.util.Map;
import org.onap.policy.controlloop.actorserviceprovider.Util;
import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
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;
}
@Test
- public void testGetClient() {
- assertNotNull(oper.getClient());
+ public void testDoConfigureMapOfStringObject_testGetConfig() {
+ // start with an UNCONFIGURED operator
+ oper.shutdown();
+ oper = new MyOperator();
+
+ assertNull(oper.getCurrentConfig());
+
+ HttpParams params = HttpParams.builder().clientName(HTTP_CLIENT).path(PATH).timeoutSec(TIMEOUT).build();
+ Map<String, Object> paramMap = Util.translateToMap(OPERATION, params);
+ oper.configure(paramMap);
+
+ assertNotNull(oper.getCurrentConfig());
+
+ // test invalid parameters
+ paramMap.remove("path");
+ assertThatThrownBy(() -> oper.configure(paramMap)).isInstanceOf(ParameterValidationRuntimeException.class);
}
@Test
- public void testMakeOperator() {
- HttpOperator oper2 = HttpOperator.makeOperator(ACTOR, OPERATION, MyOperation::new);
+ public void testBuildOperation() {
+ HttpOperator oper2 = new MyOperator();
assertNotNull(oper2);
+ assertNotNull(oper2.getClientFactory());
VirtualControlLoopEvent event = new VirtualControlLoopEvent();
ControlLoopEventContext context = new ControlLoopEventContext(event);
ControlLoopOperationParams params =
ControlLoopOperationParams.builder().actor(ACTOR).operation(OPERATION).context(context).build();
+ // not running yet
+ assertThatIllegalStateException().isThrownBy(() -> oper2.buildOperation(params));
+
+ // configure and start it
+ HttpParams params2 = HttpParams.builder().clientName(HTTP_CLIENT).path(PATH).timeoutSec(TIMEOUT).build();
+ Map<String, Object> paramMap = Util.translateToMap(OPERATION, params2);
+ oper2.configure(paramMap);
+ oper2.start();
+
Operation operation1 = oper2.buildOperation(params);
assertNotNull(operation1);
Operation operation2 = oper2.buildOperation(params);
assertNotNull(operation2);
assertNotSame(operation1, operation2);
+
+ // with no operation-maker
+ HttpOperator oper3 = new HttpOperator(ACTOR, OPERATION);
+ assertThatThrownBy(() -> oper3.buildOperation(params)).isInstanceOf(UnsupportedOperationException.class);
}
@Test
- public void testDoConfigureMapOfStringObject_testGetClient_testGetPath_testGetTimeoutMs() {
- // start with an UNCONFIGURED operator
- oper.shutdown();
- oper = new MyOperator();
-
- assertNull(oper.getClient());
- assertNull(oper.getPath());
-
- // no timeout yet
- assertEquals(0L, oper.getTimeoutMs());
-
- HttpParams params = HttpParams.builder().clientName(HTTP_CLIENT).path(PATH).timeoutSec(TIMEOUT).build();
- Map<String, Object> paramMap = Util.translateToMap(OPERATION, params);
- oper.configure(paramMap);
-
- assertSame(client, oper.getClient());
- assertEquals(PATH, oper.getPath());
-
- // should use given value
- assertEquals(TIMEOUT * 1000, oper.getTimeoutMs());
-
- // test invalid parameters
- paramMap.remove("path");
- assertThatThrownBy(() -> oper.configure(paramMap)).isInstanceOf(ParameterValidationRuntimeException.class);
+ public void testGetClientFactory() {
+ HttpOperator oper2 = new HttpOperator(ACTOR, OPERATION);
+ assertNotNull(oper2.getClientFactory());
}
private class MyOperator extends HttpOperator {
public MyOperator() {
- super(ACTOR, OPERATION);
- }
-
- @Override
- public Operation buildOperation(ControlLoopOperationParams params) {
- return null;
+ super(ACTOR, OPERATION, MyOperation::new);
}
@Override
}
private class MyOperation extends HttpOperation<String> {
- public MyOperation(ControlLoopOperationParams params, HttpOperator operator) {
- super(params, operator, String.class);
+ public MyOperation(ControlLoopOperationParams params, HttpConfig config) {
+ super(params, config, String.class);
}
@Override
package org.onap.policy.controlloop.actorserviceprovider.impl;
import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.assertThatCode;
import static org.assertj.core.api.Assertions.assertThatIllegalStateException;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.CompletionException;
import java.util.concurrent.ExecutionException;
-import java.util.concurrent.Executor;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome;
import org.onap.policy.controlloop.actorserviceprovider.controlloop.ControlLoopEventContext;
import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams;
+import org.onap.policy.controlloop.actorserviceprovider.parameters.OperatorConfig;
import org.onap.policy.controlloop.policy.PolicyResult;
import org.slf4j.LoggerFactory;
private OperationOutcome opstart;
private OperationOutcome opend;
- private OperatorPartial operator;
+ private OperatorConfig config;
/**
* Attaches the appender to the logger.
.executor(executor).actor(ACTOR).operation(OPERATION).timeoutSec(TIMEOUT)
.startCallback(this::starter).targetEntity(MY_SINK).build();
- operator = new OperatorPartial(ACTOR, OPERATION) {
- @Override
- public Executor getBlockingExecutor() {
- return executor;
- }
-
- @Override
- public Operation buildOperation(ControlLoopOperationParams params) {
- return null;
- }
- };
-
- operator.configure(null);
- operator.start();
+ config = new OperatorConfig(executor);
oper = new MyOper();
assertNull(future.get(5, TimeUnit.SECONDS));
}
- /**
- * Exercises the doXxx() methods.
- */
- @Test
- public void testDoXxx() {
- assertThatCode(() -> operator.doConfigure(null)).doesNotThrowAnyException();
- assertThatCode(() -> operator.doStart()).doesNotThrowAnyException();
- assertThatCode(() -> operator.doStop()).doesNotThrowAnyException();
- assertThatCode(() -> operator.doShutdown()).doesNotThrowAnyException();
-
- }
-
@Test
public void testStart() {
verifyRun("testStart", 1, 1, PolicyResult.SUCCESS);
}
- /**
- * Tests startOperation() when the operator is not running.
- */
- @Test
- public void testStartNotRunning() {
- // stop the operator
- operator.stop();
-
- assertThatIllegalStateException().isThrownBy(() -> oper.start());
- }
-
/**
* Tests startOperation() when the operation has a preprocessor.
*/
/*
* Use an operation that doesn't override doOperation().
*/
- OperationPartial oper2 = new OperationPartial(params, operator) {};
+ OperationPartial oper2 = new OperationPartial(params, config) {};
oper2.start();
assertTrue(executor.runAll(MAX_REQUESTS));
@Test
public void testGetRetryWait() {
// need an operator that doesn't override the retry time
- OperationPartial oper2 = new OperationPartial(params, operator) {};
+ OperationPartial oper2 = new OperationPartial(params, config) {};
assertEquals(OperationPartial.DEFAULT_RETRY_WAIT_MS, oper2.getRetryWaitMs());
}
public MyOper() {
- super(OperationPartialTest.this.params, operator);
+ super(OperationPartialTest.this.params, config);
}
@Override
--- /dev/null
+/*-
+ * ============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.parameters;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertSame;
+import static org.mockito.Mockito.when;
+
+import java.util.Arrays;
+import java.util.List;
+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.controlloop.actorserviceprovider.topic.BidirectionalTopicHandler;
+import org.onap.policy.controlloop.actorserviceprovider.topic.BidirectionalTopicManager;
+import org.onap.policy.controlloop.actorserviceprovider.topic.Forwarder;
+import org.onap.policy.controlloop.actorserviceprovider.topic.SelectorKey;
+
+public class BidirectionalTopicConfigTest {
+ private static final String MY_SINK = "my-sink";
+ private static final String MY_SOURCE = "my-source";
+ private static final int TIMEOUT_SEC = 10;
+
+ @Mock
+ private BidirectionalTopicManager topicManager;
+ @Mock
+ private BidirectionalTopicHandler topicHandler;
+ @Mock
+ private Forwarder forwarder;
+ @Mock
+ private Executor executor;
+
+ private BidirectionalTopicConfig config;
+
+ /**
+ * Sets up.
+ */
+ @Before
+ public void setUp() {
+ MockitoAnnotations.initMocks(this);
+
+ List<SelectorKey> keys = Arrays.asList(new SelectorKey(""));
+
+ when(topicManager.getTopicHandler(MY_SINK, MY_SOURCE)).thenReturn(topicHandler);
+ when(topicHandler.addForwarder(keys)).thenReturn(forwarder);
+
+ BidirectionalTopicParams params = BidirectionalTopicParams.builder().sinkTopic(MY_SINK).sourceTopic(MY_SOURCE)
+ .timeoutSec(TIMEOUT_SEC).build();
+ config = new BidirectionalTopicConfig(executor, params, topicManager, keys);
+ }
+
+ @Test
+ public void test() {
+ assertSame(executor, config.getBlockingExecutor());
+ assertSame(topicHandler, config.getTopicHandler());
+ assertSame(forwarder, config.getForwarder());
+ assertEquals(1000L * TIMEOUT_SEC, config.getTimeoutMs());
+ }
+}
--- /dev/null
+/*-
+ * ============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.parameters;
+
+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 HttpConfigTest {
+ private static final String MY_CLIENT = "my-client";
+ private static final String MY_PATH = "my-path";
+ private static final int TIMEOUT_SEC = 10;
+
+ @Mock
+ private HttpClient client;
+ @Mock
+ private HttpClientFactory factory;
+ @Mock
+ private Executor executor;
+
+ private HttpConfig config;
+
+ /**
+ * Sets up.
+ */
+ @Before
+ public void setUp() {
+ MockitoAnnotations.initMocks(this);
+
+ when(factory.get(MY_CLIENT)).thenReturn(client);
+
+ HttpParams params = HttpParams.builder().clientName(MY_CLIENT).path(MY_PATH).timeoutSec(TIMEOUT_SEC).build();
+ config = new HttpConfig(executor, params, factory);
+ }
+
+ @Test
+ public void test() {
+ assertSame(executor, config.getBlockingExecutor());
+ assertSame(client, config.getClient());
+ assertEquals(MY_PATH, config.getPath());
+ assertEquals(1000L * TIMEOUT_SEC, config.getTimeoutMs());
+ }
+}
Code Review / policy / models.git / commitdiff