public static final String REG_STATISTICS_MANAGER = "object:manager/statistics";
public static final String REG_PDP_MODIFY_LOCK = "lock:pdp";
public static final String REG_PDP_MODIFY_MAP = "object:pdp/modify/map";
+ public static final String REG_PDP_TRACKER = "object:pdp/tracker";
public static final String REG_PAP_DAO_FACTORY = "object:pap/dao/factory";
// topic names
import java.util.TreeMap;
import org.apache.commons.lang3.builder.EqualsBuilder;
+import org.onap.policy.common.parameters.ParameterService;
import org.onap.policy.common.utils.services.Registry;
import org.onap.policy.models.base.PfModelException;
import org.onap.policy.models.pdp.concepts.Pdp;
import org.onap.policy.pap.main.PapConstants;
import org.onap.policy.pap.main.PolicyModelsProviderFactoryWrapper;
import org.onap.policy.pap.main.PolicyPapException;
+import org.onap.policy.pap.main.parameters.PapParameterGroup;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
* @author Ram Krishna Verma (ram.krishna.verma@est.tech)
*/
public class PdpStatusMessageHandler {
-
private static final Logger LOGGER = LoggerFactory.getLogger(PdpStatusMessageHandler.class);
+ private static final String PAP_GROUP_PARAMS_NAME = "PapGroup";
+
/**
* Lock used when updating PDPs.
*/
/**
* Factory for PAP DAO.
*/
- PolicyModelsProviderFactoryWrapper modelProviderWrapper;
+ private final PolicyModelsProviderFactoryWrapper modelProviderWrapper;
+
+ /**
+ * Heart beat interval, in milliseconds, to pass to PDPs.
+ */
+ private final long heartBeatMs;
/**
* Constructs the object.
modelProviderWrapper = Registry.get(PapConstants.REG_PAP_DAO_FACTORY, PolicyModelsProviderFactoryWrapper.class);
updateLock = Registry.get(PapConstants.REG_PDP_MODIFY_LOCK, Object.class);
requestMap = Registry.get(PapConstants.REG_PDP_MODIFY_MAP, PdpModifyRequestMap.class);
+
+ PapParameterGroup params = ParameterService.get(PAP_GROUP_PARAMS_NAME);
+ heartBeatMs = params.getPdpParameters().getHeartBeatMs();
}
/**
} else {
handlePdpHeartbeat(message, databaseProvider);
}
+
+ /*
+ * Indicate that a heart beat was received from the PDP. This is invoked
+ * only if handleXxx() does not throw an exception.
+ */
+ if (message.getName() != null) {
+ PdpTracker pdpTracker = Registry.get(PapConstants.REG_PDP_TRACKER);
+ pdpTracker.add(message.getName());
+ }
} catch (final PolicyPapException exp) {
LOGGER.error("Operation Failed", exp);
} catch (final Exception exp) {
update.setPdpGroup(pdpGroupName);
update.setPdpSubgroup(subGroup.getPdpType());
update.setPolicies(getToscaPolicies(subGroup, databaseProvider));
+ update.setPdpHeartbeatIntervalMs(heartBeatMs);
LOGGER.debug("Created PdpUpdate message - {}", update);
return update;
--- /dev/null
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP PAP
+ * ================================================================================
+ * Copyright (C) 2019 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.pap.main.comm;
+
+import java.util.HashMap;
+import java.util.Map;
+import lombok.Builder;
+import lombok.NonNull;
+import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.pdp.concepts.Pdp;
+import org.onap.policy.models.pdp.concepts.PdpGroup;
+import org.onap.policy.models.pdp.concepts.PdpSubGroup;
+import org.onap.policy.models.provider.PolicyModelsProvider;
+import org.onap.policy.pap.main.PolicyModelsProviderFactoryWrapper;
+import org.onap.policy.pap.main.PolicyPapRuntimeException;
+import org.onap.policy.pap.main.comm.TimerManager.Timer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * Tracks PDPs. When a PDP is added to the tracker, a timer is started. If the PDP is not
+ * re-added to the tracker before the timer expires, then
+ * {@link PdpModifyRequestMap#removeFromGroups(String)} is called.
+ */
+public class PdpTracker {
+ private static final Logger logger = LoggerFactory.getLogger(PdpTracker.class);
+
+ /**
+ * PDP expiration timers.
+ */
+ private final TimerManager timers;
+
+ /**
+ * Maps a PDP name to its expiration timer.
+ */
+ private final Map<String, TimerManager.Timer> pdp2timer = new HashMap<>();
+
+ /**
+ * PDP modification lock.
+ */
+ private final Object modifyLock;
+
+ /**
+ * Used to remove a PDP from its group/subgroup.
+ */
+ private final PdpModifyRequestMap requestMap;
+
+
+ /**
+ * Constructs the object. Loads the list of PDPs to be tracked, from the DB.
+ *
+ * @param requestMap map used to remove a PDP from its group/subgroup
+ * @param modifyLock object to be locked while data structures are updated
+ * @param timers timers used to detect missed heart beats
+ * @param daoFactory DAO factory
+ */
+ @Builder
+ public PdpTracker(@NonNull PdpModifyRequestMap requestMap, @NonNull Object modifyLock, @NonNull TimerManager timers,
+ @NonNull PolicyModelsProviderFactoryWrapper daoFactory) {
+
+ this.requestMap = requestMap;
+ this.modifyLock = modifyLock;
+ this.timers = timers;
+
+ loadPdps(daoFactory);
+ }
+
+ /**
+ * Loads the PDPs from the DB.
+ *
+ * @param daoFactory DAO factory
+ */
+ private void loadPdps(PolicyModelsProviderFactoryWrapper daoFactory) {
+ synchronized (modifyLock) {
+ try (PolicyModelsProvider dao = daoFactory.create()) {
+ for (PdpGroup group : dao.getPdpGroups(null)) {
+ loadPdpsFromGroup(group);
+ }
+
+ } catch (PfModelException e) {
+ throw new PolicyPapRuntimeException("cannot load PDPs from the DB", e);
+ }
+ }
+ }
+
+ /**
+ * Loads the PDPs appearing within a group.
+ *
+ * @param group group whose PDPs are to be loaded
+ */
+ private void loadPdpsFromGroup(PdpGroup group) {
+ for (PdpSubGroup subgrp : group.getPdpSubgroups()) {
+ for (Pdp pdp : subgrp.getPdpInstances()) {
+ add(pdp.getInstanceId());
+ }
+ }
+ }
+
+ /**
+ * Adds a PDP to the tracker and starts its timer. If a timer is already running, the
+ * old timer is cancelled.
+ *
+ * @param pdpName name of the PDP
+ */
+ public void add(String pdpName) {
+ synchronized (modifyLock) {
+ Timer timer = pdp2timer.remove(pdpName);
+ if (timer != null) {
+ timer.cancel();
+ }
+
+ timer = timers.register(pdpName, this::handleTimeout);
+ pdp2timer.put(pdpName, timer);
+ }
+ }
+
+ /**
+ * Handles a timeout. Removes the PDP from {@link #pdp2timer}.
+ *
+ * @param pdpName name of the PDP whose timer has expired
+ */
+ private void handleTimeout(String pdpName) {
+ synchronized (modifyLock) {
+ // remove timer - no need to cancel it, as TimerManager does that
+ pdp2timer.remove(pdpName);
+
+ try {
+ requestMap.removeFromGroups(pdpName);
+
+ } catch (PfModelException e) {
+ logger.warn("unable to remove PDP {} from its group/subgroup", pdpName, e);
+ }
+ }
+ }
+}
import lombok.Getter;
import org.onap.policy.common.parameters.ParameterGroupImpl;
+import org.onap.policy.common.parameters.annotations.Min;
import org.onap.policy.common.parameters.annotations.NotBlank;
import org.onap.policy.common.parameters.annotations.NotNull;
@NotBlank
@Getter
public class PdpParameters extends ParameterGroupImpl {
+
+ @Min(1)
+ private long heartBeatMs;
+
private PdpUpdateParameters updateParameters;
private PdpStateChangeParameters stateChangeParameters;
import java.util.Arrays;
import java.util.Properties;
import java.util.concurrent.atomic.AtomicReference;
-
import org.onap.policy.common.endpoints.event.comm.TopicEndpoint;
import org.onap.policy.common.endpoints.event.comm.TopicSource;
import org.onap.policy.common.endpoints.listeners.MessageTypeDispatcher;
import org.onap.policy.pap.main.PolicyPapRuntimeException;
import org.onap.policy.pap.main.comm.PdpHeartbeatListener;
import org.onap.policy.pap.main.comm.PdpModifyRequestMap;
+import org.onap.policy.pap.main.comm.PdpTracker;
import org.onap.policy.pap.main.comm.Publisher;
import org.onap.policy.pap.main.comm.TimerManager;
import org.onap.policy.pap.main.parameters.PapParameterGroup;
private static final String[] MSG_TYPE_NAMES = { "messageName" };
private static final String[] REQ_ID_NAMES = { "response", "responseTo" };
- private final PapParameterGroup papParameterGroup;
-
/**
- * The PAP REST API server.
+ * Max number of heat beats that can be missed before PAP removes a PDP.
*/
- private PapRestServer restServer;
+ private static final int MAX_MISSED_HEARTBEATS = 3;
+
+ private final PapParameterGroup papParameterGroup;
/**
* Listens for messages on the topic, decodes them into a {@link PdpStatus} message, and then dispatches them to
final AtomicReference<Publisher> pdpPub = new AtomicReference<>();
final AtomicReference<TimerManager> pdpUpdTimers = new AtomicReference<>();
final AtomicReference<TimerManager> pdpStChgTimers = new AtomicReference<>();
+ final AtomicReference<TimerManager> heartBeatTimers = new AtomicReference<>();
final AtomicReference<PolicyModelsProviderFactoryWrapper> daoFactory = new AtomicReference<>();
+ final AtomicReference<PdpModifyRequestMap> requestMap = new AtomicReference<>();
+ final AtomicReference<PapRestServer> restServer = new AtomicReference<>();
// @formatter:off
addAction("PAP parameters",
},
() -> pdpPub.get().stop());
+ addAction("PDP heart beat timers",
+ () -> {
+ long maxWaitHeartBeatMs = MAX_MISSED_HEARTBEATS * pdpParams.getHeartBeatMs();
+ heartBeatTimers.set(new TimerManager("heart beat", maxWaitHeartBeatMs));
+ startThread(heartBeatTimers.get());
+ },
+ () -> heartBeatTimers.get().stop());
+
addAction("PDP update timers",
() -> {
pdpUpdTimers.set(new TimerManager("update", pdpParams.getUpdateParameters().getMaxWaitMs()));
() -> Registry.unregister(PapConstants.REG_PDP_MODIFY_LOCK));
addAction("PDP modification requests",
- () -> Registry.register(PapConstants.REG_PDP_MODIFY_MAP, new PdpModifyRequestMap(
+ () -> {
+ requestMap.set(new PdpModifyRequestMap(
new PdpModifyRequestMapParams()
.setDaoFactory(daoFactory.get())
.setModifyLock(pdpUpdateLock)
.setPublisher(pdpPub.get())
.setResponseDispatcher(reqIdDispatcher)
.setStateChangeTimers(pdpStChgTimers.get())
- .setUpdateTimers(pdpUpdTimers.get()))),
+ .setUpdateTimers(pdpUpdTimers.get())));
+ Registry.register(PapConstants.REG_PDP_MODIFY_MAP, requestMap.get());
+ },
() -> Registry.unregister(PapConstants.REG_PDP_MODIFY_MAP));
- addAction("Create REST server",
- () -> restServer = new PapRestServer(papParameterGroup.getRestServerParameters()),
- () -> restServer = null);
+ addAction("PDP heart beat tracker",
+ () -> Registry.register(PapConstants.REG_PDP_TRACKER, PdpTracker.builder()
+ .daoFactory(daoFactory.get())
+ .timers(heartBeatTimers.get())
+ .modifyLock(pdpUpdateLock)
+ .requestMap(requestMap.get())
+ .build()),
+ () -> Registry.unregister(PapConstants.REG_PDP_TRACKER));
addAction("REST server",
- () -> restServer.start(),
- () -> restServer.stop());
+ () -> {
+ restServer.set(new PapRestServer(papParameterGroup.getRestServerParameters()));
+ restServer.get().start();
+ },
+ () -> restServer.get().stop());
// @formatter:on
}
--- /dev/null
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP PAP
+ * ================================================================================
+ * Copyright (C) 2019 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.pap.main.comm;
+
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.junit.Assert.assertNotNull;
+import static org.mockito.Matchers.any;
+import static org.mockito.Matchers.eq;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.function.Consumer;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Captor;
+import org.mockito.Mock;
+import org.mockito.MockitoAnnotations;
+import org.onap.policy.common.utils.coder.StandardCoder;
+import org.onap.policy.common.utils.resources.ResourceUtils;
+import org.onap.policy.models.base.PfModelException;
+import org.onap.policy.models.pdp.concepts.PdpGroup;
+import org.onap.policy.models.pdp.concepts.PdpGroups;
+import org.onap.policy.models.provider.PolicyModelsProvider;
+import org.onap.policy.pap.main.PolicyModelsProviderFactoryWrapper;
+import org.onap.policy.pap.main.PolicyPapRuntimeException;
+import org.onap.policy.pap.main.comm.TimerManager.Timer;
+
+public class PdpTrackerTest {
+ private static final String PDP1 = "pdp1";
+ private static final String PDP2 = "pdp2";
+
+ private PdpTracker tracker;
+ private PdpTracker.PdpTrackerBuilder builder;
+
+ private Object modifyLock;
+
+ @Captor
+ private ArgumentCaptor<Consumer<String>> handlerCaptor;
+
+ @Mock
+ private PdpModifyRequestMap requestMap;
+
+ @Mock
+ private TimerManager timers;
+
+ @Mock
+ private PolicyModelsProviderFactoryWrapper daoFactory;
+
+ @Mock
+ private PolicyModelsProvider dao;
+
+ @Mock
+ private Timer timer1;
+
+ @Mock
+ private Timer timer2;
+
+ /**
+ * Sets up.
+ *
+ * @throws Exception if an error occurs
+ */
+ @Before
+ public void setUp() throws Exception {
+ MockitoAnnotations.initMocks(this);
+
+ modifyLock = new Object();
+
+ builder = PdpTracker.builder().daoFactory(daoFactory).modifyLock(modifyLock).requestMap(requestMap)
+ .timers(timers);
+
+ when(daoFactory.create()).thenReturn(dao);
+
+ when(dao.getPdpGroups(null)).thenReturn(Collections.emptyList());
+
+ when(timers.register(eq(PDP1), any())).thenReturn(timer1);
+ when(timers.register(eq(PDP2), any())).thenReturn(timer2);
+
+ tracker = builder.build();
+ }
+
+ @Test
+ public void testPdpTracker() throws Exception {
+ // verify that PDPs were loaded
+ verify(dao).getPdpGroups(null);
+ }
+
+ @Test
+ public void testBuilderToString() throws Exception {
+ assertNotNull(builder.toString());
+ }
+
+ @Test
+ public void testPdpTracker_MissingRequestMap() throws Exception {
+ assertThatThrownBy(() -> builder.requestMap(null).build()).isInstanceOf(NullPointerException.class);
+ }
+
+ @Test
+ public void testPdpTracker_MissingModifyLock() throws Exception {
+ assertThatThrownBy(() -> builder.modifyLock(null).build()).isInstanceOf(NullPointerException.class);
+ }
+
+ @Test
+ public void testPdpTracker_MissingTimers() throws Exception {
+ assertThatThrownBy(() -> builder.timers(null).build()).isInstanceOf(NullPointerException.class);
+ }
+
+ @Test
+ public void testPdpTracker_MissingDaoFactory() throws Exception {
+ assertThatThrownBy(() -> builder.daoFactory(null).build()).isInstanceOf(NullPointerException.class);
+ }
+
+ @Test
+ public void testLoadPdps_testLoadPdpsFromGroup() throws Exception {
+ // arrange for DAO to return a couple of groups
+ String groupsJson = ResourceUtils.getResourceAsString("comm/PdpTracker.json");
+ List<PdpGroup> groups = new StandardCoder().decode(groupsJson, PdpGroups.class).getGroups();
+ when(dao.getPdpGroups(null)).thenReturn(groups);
+
+ tracker = builder.build();
+
+ // verify that all PDPs were registered
+ verify(timers).register(eq("pdp-A"), any());
+ verify(timers).register(eq("pdp-B"), any());
+ verify(timers).register(eq("pdp-C"), any());
+ verify(timers).register(eq("pdp-D"), any());
+ }
+
+ @Test
+ public void testLoadPdps_DaoException() throws Exception {
+ // arrange for DAO to throw an exception
+ PfModelException ex = mock(PfModelException.class);
+ when(daoFactory.create()).thenThrow(ex);
+
+ assertThatThrownBy(() -> builder.build()).isInstanceOf(PolicyPapRuntimeException.class).hasCause(ex);
+ }
+
+ @Test
+ public void testAdd() {
+ tracker.add(PDP1);
+ verify(timers).register(eq(PDP1), any());
+ verify(timer1, never()).cancel();
+
+ tracker.add(PDP2);
+ verify(timers).register(eq(PDP2), any());
+ verify(timer1, never()).cancel();
+ verify(timer2, never()).cancel();
+
+ // re-add PDP1 - old timer should be canceled and a new timer added
+ Timer timer3 = mock(Timer.class);
+ when(timers.register(eq(PDP1), any())).thenReturn(timer3);
+ tracker.add(PDP1);
+ verify(timer1).cancel();
+ verify(timer2, never()).cancel();
+ verify(timer3, never()).cancel();
+ }
+
+ @Test
+ public void testHandleTimeout() throws Exception {
+ tracker.add(PDP1);
+ tracker.add(PDP2);
+
+ verify(timers).register(eq(PDP1), handlerCaptor.capture());
+
+ handlerCaptor.getValue().accept(PDP1);
+
+ verify(requestMap).removeFromGroups(PDP1);
+
+ // now we'll re-add PDP1 - the original timer should not be canceled
+ Timer timer3 = mock(Timer.class);
+ when(timers.register(eq(PDP1), any())).thenReturn(timer3);
+ tracker.add(PDP1);
+ verify(timer1, never()).cancel();
+ }
+
+ @Test
+ public void testHandleTimeout_MapException() throws Exception {
+ tracker.add(PDP1);
+
+ verify(timers).register(eq(PDP1), handlerCaptor.capture());
+
+ // arrange for request map to throw an exception
+ PfModelException ex = mock(PfModelException.class);
+ when(requestMap.removeFromGroups(PDP1)).thenThrow(ex);
+
+ // exception should be caught, but not re-thrown
+ handlerCaptor.getValue().accept(PDP1);
+ }
+}
PdpStateChangeParameters state = params.getStateChangeParameters();
assertNotNull(state);
assertEquals(5, state.getMaxWaitMs());
+
+ assertEquals(6L, params.getHeartBeatMs());
}
@Test
assertNull(result.getResult());
assertTrue(result.isValid());
+ // invalid heart beat
+ json2 = json.replaceFirst(": 6", ": 0");
+ result = coder.decode(json2, PapParameterGroup.class).getPdpParameters().validate();
+ assertFalse(result.isValid());
+ assertTrue(result.getResult().contains(
+ "field 'heartBeatMs' type 'long' value '0' INVALID, must be >= 1".replace('\'', '"')));
+
// no update params
json2 = testData.nullifyField(json, "updateParameters");
result = coder.decode(json2, PapParameterGroup.class).getPdpParameters().validate();
assertTrue(result.getResult().contains("is null"));
// invalid update params
- json2 = json.replaceFirst("2", "-2");
+ json2 = json.replaceFirst(": 2", ": -2");
result = coder.decode(json2, PapParameterGroup.class).getPdpParameters().validate();
assertFalse(result.isValid());
assertTrue(result.getResult().contains("parameter group 'PdpUpdateParameters'".replace('\'', '"')));
assertFalse(result.isValid());
// invalid state-change params
- json2 = json.replaceFirst("5", "-5");
+ json2 = json.replaceFirst(": 5", ": -5");
result = coder.decode(json2, PapParameterGroup.class).getPdpParameters().validate();
assertFalse(result.isValid());
assertTrue(result.getResult().contains("parameter group 'PdpStateChangeParameters'".replace('\'', '"')));
--- /dev/null
+{
+ "groups": [
+ {
+ "name": "group-X",
+ "pdpSubgroups": [
+ {
+ "pdpType": "apex",
+ "pdpInstances": [
+ {
+ "instanceId": "pdp-A"
+ },
+ {
+ "instanceId": "pdp-B"
+ }
+ ]
+ },
+ {
+ "pdpType": "drools",
+ "pdpInstances": [
+ {
+ "instanceId": "pdp-C"
+ }
+ ]
+ }
+ ]
+ },
+ {
+ "name": "group-Y",
+ "pdpSubgroups": [
+ {
+ "pdpType": "apex",
+ "pdpInstances": [
+ {
+ "instanceId": "pdp-D"
+ }
+ ]
+ }
+ ]
+ }
+ ]
+}
"https": true
},
"pdpParameters": {
+ "heartBeatMs": 5000,
"updateParameters": {
"maxRetryCount": 0,
"maxWaitMs": 5000
"password":"zb!XztG34"
},
"pdpParameters": {
+ "heartBeatMs": 1,
"updateParameters": {
"maxRetryCount": 1,
"maxWaitMs": 1
"https": true
},
"pdpParameters": {
+ "heartBeatMs": 10,
"updateParameters": {
"maxRetryCount": 1,
"maxWaitMs": 1
"stateChangeParameters": {
"maxRetryCount": 1,
"maxWaitMs": 5
- }
+ },
+ "heartBeatMs": 6
},
"databaseProviderParameters": {
"name": "PolicyModelsProviderParameters",
"password":"zb!XztG34"
},
"pdpParameters": {
+ "heartBeatMs": 1,
"updateParameters": {
"maxRetryCount": 1,
"maxWaitMs": 1
"https": true
},
"pdpParameters": {
+ "heartBeatMs": 10,
"updateParameters": {
"maxRetryCount": 1,
"maxWaitMs": 30000
"aaf": false
},
"pdpParameters": {
+ "heartBeatMs": 120000,
"updateParameters": {
"maxRetryCount": 1,
"maxWaitMs": 30000
Code Review / policy / pap.git / commitdiff