[PROD-881] Dynamic alarm severity in Create Alarm Rule Node (#4393)
* Dynamic alarm severity feature added * Tests for dynamic alarm severity added * Removed redundant imports * Join front-end part * Refactoring: create of method processAlarmSeverity, remove incorrect solution and process severity in correct places * Correct updating of alarm parsed from msg data * Removed redundant operations * Correct exceptions throwing
This commit is contained in:
AndrewVolosytnykhThingsboard
GitHub
parent
321fb731a6
commit
c7269528fa
@ -22,12 +22,14 @@ import com.google.common.util.concurrent.Futures;
|
||||
import com.google.common.util.concurrent.ListenableFuture;
|
||||
import com.google.common.util.concurrent.MoreExecutors;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.apache.commons.lang3.EnumUtils;
|
||||
import org.thingsboard.rule.engine.api.RuleNode;
|
||||
import org.thingsboard.rule.engine.api.TbContext;
|
||||
import org.thingsboard.rule.engine.api.TbNodeConfiguration;
|
||||
import org.thingsboard.rule.engine.api.TbNodeException;
|
||||
import org.thingsboard.rule.engine.api.util.TbNodeUtils;
|
||||
import org.thingsboard.server.common.data.alarm.Alarm;
|
||||
import org.thingsboard.server.common.data.alarm.AlarmSeverity;
|
||||
import org.thingsboard.server.common.data.alarm.AlarmStatus;
|
||||
import org.thingsboard.server.common.data.id.TenantId;
|
||||
import org.thingsboard.server.common.data.plugin.ComponentType;
|
||||
@ -56,6 +58,19 @@ public class TbCreateAlarmNode extends TbAbstractAlarmNode<TbCreateAlarmNodeConf
|
||||
|
||||
private static ObjectMapper mapper = new ObjectMapper();
|
||||
private List<String> relationTypes;
|
||||
private AlarmSeverity notDynamicAlarmSeverity;
|
||||
|
||||
@Override
|
||||
public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException {
|
||||
super.init(ctx, configuration);
|
||||
if(!this.config.isDynamicSeverity()) {
|
||||
this.notDynamicAlarmSeverity = EnumUtils.getEnum(AlarmSeverity.class, this.config.getSeverity());
|
||||
if(this.notDynamicAlarmSeverity == null) {
|
||||
throw new TbNodeException("Incorrect Alarm Severity value: " + this.config.getSeverity());
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@Override
|
||||
protected TbCreateAlarmNodeConfiguration loadAlarmNodeConfig(TbNodeConfiguration configuration) throws TbNodeException {
|
||||
@ -132,7 +147,7 @@ public class TbCreateAlarmNode extends TbAbstractAlarmNode<TbCreateAlarmNodeConf
|
||||
existingAlarm.setPropagate(msgAlarm.isPropagate());
|
||||
existingAlarm.setPropagateRelationTypes(msgAlarm.getPropagateRelationTypes());
|
||||
} else {
|
||||
existingAlarm.setSeverity(config.getSeverity());
|
||||
existingAlarm.setSeverity(processAlarmSeverity(msg));
|
||||
existingAlarm.setPropagate(config.isPropagate());
|
||||
existingAlarm.setPropagateRelationTypes(relationTypes);
|
||||
}
|
||||
@ -149,7 +164,7 @@ public class TbCreateAlarmNode extends TbAbstractAlarmNode<TbCreateAlarmNodeConf
|
||||
.tenantId(tenantId)
|
||||
.originator(msg.getOriginator())
|
||||
.status(AlarmStatus.ACTIVE_UNACK)
|
||||
.severity(config.getSeverity())
|
||||
.severity(this.config.isDynamicSeverity() ? processAlarmSeverity(msg) : notDynamicAlarmSeverity)
|
||||
.propagate(config.isPropagate())
|
||||
.type(TbNodeUtils.processPattern(this.config.getAlarmType(), msg))
|
||||
.propagateRelationTypes(relationTypes)
|
||||
@ -160,4 +175,12 @@ public class TbCreateAlarmNode extends TbAbstractAlarmNode<TbCreateAlarmNodeConf
|
||||
.build();
|
||||
}
|
||||
|
||||
private AlarmSeverity processAlarmSeverity(TbMsg msg) {
|
||||
AlarmSeverity severity = EnumUtils.getEnum(AlarmSeverity.class, TbNodeUtils.processPattern(this.config.getSeverity(), msg));
|
||||
if(severity == null) {
|
||||
throw new RuntimeException("Used incorrect pattern or Alarm Severity not included in message");
|
||||
}
|
||||
return severity;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@ -25,9 +25,10 @@ import java.util.List;
|
||||
@Data
|
||||
public class TbCreateAlarmNodeConfiguration extends TbAbstractAlarmNodeConfiguration implements NodeConfiguration<TbCreateAlarmNodeConfiguration> {
|
||||
|
||||
private AlarmSeverity severity;
|
||||
private String severity;
|
||||
private boolean propagate;
|
||||
private boolean useMessageAlarmData;
|
||||
private boolean dynamicSeverity;
|
||||
|
||||
private List<String> relationTypes;
|
||||
|
||||
@ -40,10 +41,11 @@ public class TbCreateAlarmNodeConfiguration extends TbAbstractAlarmNodeConfigura
|
||||
"}\n" +
|
||||
"return details;");
|
||||
configuration.setAlarmType("General Alarm");
|
||||
configuration.setSeverity(AlarmSeverity.CRITICAL);
|
||||
configuration.setSeverity(AlarmSeverity.CRITICAL.name());
|
||||
configuration.setPropagate(false);
|
||||
configuration.setUseMessageAlarmData(false);
|
||||
configuration.setRelationTypes(Collections.emptyList());
|
||||
configuration.setDynamicSeverity(false);
|
||||
return configuration;
|
||||
}
|
||||
}
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -384,11 +384,131 @@ public class TbAlarmNodeTest {
|
||||
assertEquals(expectedAlarm, actualAlarm);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testCreateAlarmWithDynamicSeverityFromMessageBody() throws Exception {
|
||||
TbCreateAlarmNodeConfiguration config = new TbCreateAlarmNodeConfiguration();
|
||||
config.setPropagate(true);
|
||||
config.setSeverity("$[alarmSeverity]");
|
||||
config.setAlarmType("SomeType");
|
||||
config.setAlarmDetailsBuildJs("DETAILS");
|
||||
config.setDynamicSeverity(true);
|
||||
ObjectMapper mapper = new ObjectMapper();
|
||||
TbNodeConfiguration nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config));
|
||||
|
||||
when(ctx.createJsScriptEngine("DETAILS")).thenReturn(detailsJs);
|
||||
|
||||
when(ctx.getTenantId()).thenReturn(tenantId);
|
||||
when(ctx.getAlarmService()).thenReturn(alarmService);
|
||||
when(ctx.getDbCallbackExecutor()).thenReturn(dbExecutor);
|
||||
|
||||
node = new TbCreateAlarmNode();
|
||||
node.init(ctx, nodeConfiguration);
|
||||
|
||||
String rawJson = "{\"alarmSeverity\": \"WARNING\", \"passed\": 5}";
|
||||
metaData.putValue("key", "value");
|
||||
TbMsg msg = TbMsg.newMsg("USER", originator, metaData, TbMsgDataType.JSON, rawJson, ruleChainId, ruleNodeId);
|
||||
|
||||
when(detailsJs.executeJsonAsync(msg)).thenReturn(Futures.immediateFuture(null));
|
||||
when(alarmService.findLatestByOriginatorAndType(tenantId, originator, "SomeType")).thenReturn(Futures.immediateFuture(null));
|
||||
doAnswer((Answer<Alarm>) invocationOnMock -> (Alarm) (invocationOnMock.getArguments())[0]).when(alarmService).createOrUpdateAlarm(any(Alarm.class));
|
||||
|
||||
node.onMsg(ctx, msg);
|
||||
|
||||
verify(ctx).enqueue(any(), successCaptor.capture(), failureCaptor.capture());
|
||||
successCaptor.getValue().run();
|
||||
verify(ctx).tellNext(any(), eq("Created"));
|
||||
|
||||
ArgumentCaptor<TbMsg> msgCaptor = ArgumentCaptor.forClass(TbMsg.class);
|
||||
ArgumentCaptor<String> typeCaptor = ArgumentCaptor.forClass(String.class);
|
||||
ArgumentCaptor<EntityId> originatorCaptor = ArgumentCaptor.forClass(EntityId.class);
|
||||
ArgumentCaptor<TbMsgMetaData> metadataCaptor = ArgumentCaptor.forClass(TbMsgMetaData.class);
|
||||
ArgumentCaptor<String> dataCaptor = ArgumentCaptor.forClass(String.class);
|
||||
verify(ctx).transformMsg(msgCaptor.capture(), typeCaptor.capture(), originatorCaptor.capture(), metadataCaptor.capture(), dataCaptor.capture());
|
||||
|
||||
assertEquals("ALARM", typeCaptor.getValue());
|
||||
assertEquals(originator, originatorCaptor.getValue());
|
||||
assertEquals("value", metadataCaptor.getValue().getValue("key"));
|
||||
assertEquals(Boolean.TRUE.toString(), metadataCaptor.getValue().getValue(IS_NEW_ALARM));
|
||||
assertNotSame(metaData, metadataCaptor.getValue());
|
||||
|
||||
Alarm actualAlarm = new ObjectMapper().readValue(dataCaptor.getValue().getBytes(), Alarm.class);
|
||||
Alarm expectedAlarm = Alarm.builder()
|
||||
.tenantId(tenantId)
|
||||
.originator(originator)
|
||||
.status(ACTIVE_UNACK)
|
||||
.severity(WARNING)
|
||||
.propagate(true)
|
||||
.type("SomeType")
|
||||
.details(null)
|
||||
.build();
|
||||
|
||||
assertEquals(expectedAlarm, actualAlarm);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testCreateAlarmWithDynamicSeverityFromMetadata() throws Exception {
|
||||
TbCreateAlarmNodeConfiguration config = new TbCreateAlarmNodeConfiguration();
|
||||
config.setPropagate(true);
|
||||
config.setSeverity("${alarmSeverity}");
|
||||
config.setAlarmType("SomeType");
|
||||
config.setAlarmDetailsBuildJs("DETAILS");
|
||||
config.setDynamicSeverity(true);
|
||||
ObjectMapper mapper = new ObjectMapper();
|
||||
TbNodeConfiguration nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config));
|
||||
|
||||
when(ctx.createJsScriptEngine("DETAILS")).thenReturn(detailsJs);
|
||||
|
||||
when(ctx.getTenantId()).thenReturn(tenantId);
|
||||
when(ctx.getAlarmService()).thenReturn(alarmService);
|
||||
when(ctx.getDbCallbackExecutor()).thenReturn(dbExecutor);
|
||||
|
||||
node = new TbCreateAlarmNode();
|
||||
node.init(ctx, nodeConfiguration);
|
||||
|
||||
metaData.putValue("alarmSeverity", "WARNING");
|
||||
TbMsg msg = TbMsg.newMsg("USER", originator, metaData, TbMsgDataType.JSON, rawJson, ruleChainId, ruleNodeId);
|
||||
|
||||
when(detailsJs.executeJsonAsync(msg)).thenReturn(Futures.immediateFuture(null));
|
||||
when(alarmService.findLatestByOriginatorAndType(tenantId, originator, "SomeType")).thenReturn(Futures.immediateFuture(null));
|
||||
doAnswer((Answer<Alarm>) invocationOnMock -> (Alarm) (invocationOnMock.getArguments())[0]).when(alarmService).createOrUpdateAlarm(any(Alarm.class));
|
||||
|
||||
node.onMsg(ctx, msg);
|
||||
|
||||
verify(ctx).enqueue(any(), successCaptor.capture(), failureCaptor.capture());
|
||||
successCaptor.getValue().run();
|
||||
verify(ctx).tellNext(any(), eq("Created"));
|
||||
|
||||
ArgumentCaptor<TbMsg> msgCaptor = ArgumentCaptor.forClass(TbMsg.class);
|
||||
ArgumentCaptor<String> typeCaptor = ArgumentCaptor.forClass(String.class);
|
||||
ArgumentCaptor<EntityId> originatorCaptor = ArgumentCaptor.forClass(EntityId.class);
|
||||
ArgumentCaptor<TbMsgMetaData> metadataCaptor = ArgumentCaptor.forClass(TbMsgMetaData.class);
|
||||
ArgumentCaptor<String> dataCaptor = ArgumentCaptor.forClass(String.class);
|
||||
verify(ctx).transformMsg(msgCaptor.capture(), typeCaptor.capture(), originatorCaptor.capture(), metadataCaptor.capture(), dataCaptor.capture());
|
||||
|
||||
assertEquals("ALARM", typeCaptor.getValue());
|
||||
assertEquals(originator, originatorCaptor.getValue());
|
||||
assertEquals(Boolean.TRUE.toString(), metadataCaptor.getValue().getValue(IS_NEW_ALARM));
|
||||
assertNotSame(metaData, metadataCaptor.getValue());
|
||||
|
||||
Alarm actualAlarm = new ObjectMapper().readValue(dataCaptor.getValue().getBytes(), Alarm.class);
|
||||
Alarm expectedAlarm = Alarm.builder()
|
||||
.tenantId(tenantId)
|
||||
.originator(originator)
|
||||
.status(ACTIVE_UNACK)
|
||||
.severity(WARNING)
|
||||
.propagate(true)
|
||||
.type("SomeType")
|
||||
.details(null)
|
||||
.build();
|
||||
|
||||
assertEquals(expectedAlarm, actualAlarm);
|
||||
}
|
||||
|
||||
private void initWithCreateAlarmScript() {
|
||||
try {
|
||||
TbCreateAlarmNodeConfiguration config = new TbCreateAlarmNodeConfiguration();
|
||||
config.setPropagate(true);
|
||||
config.setSeverity(CRITICAL);
|
||||
config.setSeverity(CRITICAL.name());
|
||||
config.setAlarmType("SomeType");
|
||||
config.setAlarmDetailsBuildJs("DETAILS");
|
||||
ObjectMapper mapper = new ObjectMapper();
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user