tsai
/
thingsboard
mirror of https://github.com/thingsboard/thingsboard.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

add options fromMetadata 

change logic node
pull/7009/head
Yuriy Lytvynchuk 4 years ago
parent
fd9736b051
commit
f723c3c847
3 changed files with 90 additions and 45 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 78
      rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java
  2. 12
      rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java
  3. 45
      rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java

78
rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNode.java → rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNode.java
View File

@ -32,59 +32,77 @@ import org.thingsboard.server.common.msg.TbMsg;
import org.thingsboard.server.common.msg.TbMsgMetaData; import org.thingsboard.server.common.msg.TbMsgMetaData;
import java.util.List; import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutionException;
import java.util.regex.Pattern;
@Slf4j @Slf4j
@RuleNode( @RuleNode(
type = ComponentType.TRANSFORMATION, type = ComponentType.TRANSFORMATION,
name = "copy from metadata to msg", name = "copy keys",
configClazz = TbCopyFromMdToMsgNodeConfiguration.class, configClazz = TbCopyKeysNodeConfiguration.class,
nodeDescription = "Copies the msg metadata keys to msg data with specified key names selected in the list", nodeDescription = "Copies the msg or metadata keys with specified key names selected in the list",
nodeDetails = "Will fetch fields values specified in list. If specified field is not part of msg metadata fields it will be ignored." + nodeDetails = "Will fetch fields values specified in list. If specified field is not part of msg or metadata fields it will be ignored." +
"If the msg is not a JSON object returns the incoming message as outbound message with <code>Failure</code> chain, " + "If the msg is not a JSON object returns the incoming message as outbound message with <code>Failure</code> chain, " +
"otherwise returns transformed messages via <code>Success</code> chain", "otherwise returns transformed messages via <code>Success</code> chain",
uiResources = {"static/rulenode/rulenode-core-config.js"}, uiResources = {"static/rulenode/rulenode-core-config.js"},
configDirective = "tbTransformationNodeCopyFromMdToMsgConfig", configDirective = "tbTransformationNodeCopyKeysConfig",
icon = "functions" icon = "content_copy"
) )
public class TbCopyFromMdToMsgNode implements TbNode { public class TbCopyKeysNode implements TbNode {
TbCopyFromMdToMsgNodeConfiguration config; TbCopyKeysNodeConfiguration config;
@Override @Override
public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException {
this.config = TbNodeUtils.convert(configuration, TbCopyFromMdToMsgNodeConfiguration.class); this.config = TbNodeUtils.convert(configuration, TbCopyKeysNodeConfiguration.class);
} }
@Override @Override
public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException {
processCopy(ctx, msg); List<String> keys = config.getKeys();
} if (CollectionUtils.isEmpty(keys)) {
@Override
public void destroy() {
}
private void processCopy(TbContext ctx, TbMsg msg) {
List<String> metadataMsgKeys = config.getMetadataMsgKeys();
if (CollectionUtils.isEmpty(metadataMsgKeys)) {
ctx.tellSuccess(msg); ctx.tellSuccess(msg);
} else { } else {
JsonNode dataNode = JacksonUtil.toJsonNode(msg.getData()); TbMsgMetaData metaData = msg.getMetaData();
if (dataNode.isObject()) { String msgData = msg.getData();
ObjectNode msgData = (ObjectNode) dataNode; JsonNode dataNode = JacksonUtil.toJsonNode(msgData);
TbMsgMetaData metaData = msg.getMetaData(); if (!dataNode.isObject()) {
metadataMsgKeys.forEach(metadataKey -> { ctx.tellFailure(msg, new RuntimeException("Msg data is not a JSON Object!"));
String value = metaData.getValue(metadataKey); return;
if (!StringUtils.isEmpty(value)) { }
msgData.put(metadataKey, value); if (config.isFromMetadata()) {
} ObjectNode msgDataNode = (ObjectNode) dataNode;
Map<String, String> metaDataMap = metaData.getData();
keys.forEach(key -> {
Pattern pattern = Pattern.compile(key);
metaDataMap.forEach((keyMetaData, valueMetaData) -> {
if (pattern.matcher(keyMetaData).matches()) {
if (!StringUtils.isEmpty(valueMetaData)) {
msgDataNode.put(keyMetaData, valueMetaData);
}
}
});
}); });
ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, JacksonUtil.toString(msgData))); msgData = JacksonUtil.toString(msgDataNode);
} else { } else {
ctx.tellFailure(msg, new RuntimeException("Msg data is not a JSON Object!")); keys.forEach(key -> {
Pattern pattern = Pattern.compile(key);
dataNode.fields().forEachRemaining(entry -> {
String keyData = entry.getKey();
if (pattern.matcher(keyData).matches()) {
metaData.putValue(keyData, String.valueOf(entry.getValue()));
}
});
});
} }
ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, msgData));
} }
} }
@Override
public void destroy() {
}
} }

12
rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeConfiguration.java → rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeConfiguration.java
View File

@ -22,14 +22,16 @@ import java.util.Collections;
import java.util.List; import java.util.List;
@Data @Data
public class TbCopyFromMdToMsgNodeConfiguration implements NodeConfiguration<TbCopyFromMdToMsgNodeConfiguration> { public class TbCopyKeysNodeConfiguration implements NodeConfiguration<TbCopyKeysNodeConfiguration> {
private List<String> metadataMsgKeys; private boolean fromMetadata;
private List<String> keys;
@Override @Override
public TbCopyFromMdToMsgNodeConfiguration defaultConfiguration() { public TbCopyKeysNodeConfiguration defaultConfiguration() {
TbCopyFromMdToMsgNodeConfiguration configuration = new TbCopyFromMdToMsgNodeConfiguration(); TbCopyKeysNodeConfiguration configuration = new TbCopyKeysNodeConfiguration();
configuration.setMetadataMsgKeys(Collections.emptyList()); configuration.setKeys(Collections.emptyList());
configuration.setFromMetadata(false);
return configuration; return configuration;
} }

45
rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeTest.java → rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyKeysNodeTest.java
View File

@ -44,12 +44,12 @@ import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.times; import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verify;
public class TbCopyFromMdToMsgNodeTest { public class TbCopyKeysNodeTest {
final ObjectMapper mapper = new ObjectMapper(); final ObjectMapper mapper = new ObjectMapper();
DeviceId deviceId; DeviceId deviceId;
TbCopyFromMdToMsgNode node; TbCopyKeysNode node;
TbCopyFromMdToMsgNodeConfiguration config; TbCopyKeysNodeConfiguration config;
TbNodeConfiguration nodeConfiguration; TbNodeConfiguration nodeConfiguration;
TbContext ctx; TbContext ctx;
TbMsgCallback callback; TbMsgCallback callback;
@ -59,10 +59,11 @@ public class TbCopyFromMdToMsgNodeTest {
deviceId = new DeviceId(UUID.randomUUID()); deviceId = new DeviceId(UUID.randomUUID());
callback = mock(TbMsgCallback.class); callback = mock(TbMsgCallback.class);
ctx = mock(TbContext.class); ctx = mock(TbContext.class);
config = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); config = new TbCopyKeysNodeConfiguration().defaultConfiguration();
config.setMetadataMsgKeys(List.of("TestKey_1", "TestKey_2", "TestKey_3")); config.setKeys(List.of("TestKey_1", "TestKey_2", "TestKey_3", "(\\w*)Data(\\w*)"));
config.setFromMetadata(true);
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config)); nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config));
node = spy(new TbCopyFromMdToMsgNode()); node = spy(new TbCopyKeysNode());
node.init(ctx, nodeConfiguration); node.init(ctx, nodeConfiguration);
} }
@ -78,12 +79,13 @@ public class TbCopyFromMdToMsgNodeTest {
@Test @Test
void givenDefaultConfig_whenVerify_thenOK() { void givenDefaultConfig_whenVerify_thenOK() {
TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); TbCopyKeysNodeConfiguration defaultConfig = new TbCopyKeysNodeConfiguration().defaultConfiguration();
assertThat(defaultConfig.getMetadataMsgKeys()).isEqualTo(Collections.emptyList()); assertThat(defaultConfig.getKeys()).isEqualTo(Collections.emptyList());
assertThat(defaultConfig.isFromMetadata()).isEqualTo(false);
} }
@Test @Test
void givenMsg_whenOnMsg_thenVerifyOutput() throws Exception { void givenMsgFromMetadata_whenOnMsg_thenVerifyOutput() throws Exception {
String data = "{}"; String data = "{}";
node.onMsg(ctx, getTbMsg(deviceId, data)); node.onMsg(ctx, getTbMsg(deviceId, data));
@ -96,11 +98,33 @@ public class TbCopyFromMdToMsgNodeTest {
JsonNode dataNode = JacksonUtil.toJsonNode(newMsg.getData()); JsonNode dataNode = JacksonUtil.toJsonNode(newMsg.getData());
assertThat(dataNode.has("TestKey_1")).isEqualTo(true); assertThat(dataNode.has("TestKey_1")).isEqualTo(true);
assertThat(dataNode.has("voltageDataValue")).isEqualTo(true);
}
@Test
void givenMsgFromMsg_whenOnMsg_thenVerifyOutput() throws Exception {
config.setFromMetadata(false);
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config));
node.init(ctx, nodeConfiguration);
String data = "{\"DigitData\":22.5,\"TempDataValue\":10.5}";
node.onMsg(ctx, getTbMsg(deviceId, data));
ArgumentCaptor<TbMsg> newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class);
verify(ctx, times(1)).tellSuccess(newMsgCaptor.capture());
verify(ctx, never()).tellFailure(any(), any());
TbMsg newMsg = newMsgCaptor.getValue();
assertThat(newMsg).isNotNull();
Map<String, String> metaDataMap = newMsg.getMetaData().getData();
assertThat(metaDataMap.containsKey("DigitData")).isEqualTo(true);
assertThat(metaDataMap.containsKey("TempDataValue")).isEqualTo(true);
} }
@Test @Test
void givenEmptyKeys_whenOnMsg_thenVerifyOutput() throws Exception { void givenEmptyKeys_whenOnMsg_thenVerifyOutput() throws Exception {
TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); TbCopyKeysNodeConfiguration defaultConfig = new TbCopyKeysNodeConfiguration().defaultConfiguration();
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(defaultConfig)); nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(defaultConfig));
node.init(ctx, nodeConfiguration); node.init(ctx, nodeConfiguration);
@ -134,6 +158,7 @@ public class TbCopyFromMdToMsgNodeTest {
final Map<String, String> mdMap = Map.of( final Map<String, String> mdMap = Map.of(
"TestKey_1", "Test", "TestKey_1", "Test",
"country", "US", "country", "US",
"voltageDataValue", "220",
"city", "NY" "city", "NY"
); );
return TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", entityId, new TbMsgMetaData(mdMap), data, callback); return TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", entityId, new TbMsgMetaData(mdMap), data, callback);
Write Preview
Loading…
Cancel
Save