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

new RuleNode "rename keys"

pull/7016/head
Yuriy Lytvynchuk 4 years ago
parent
0cb8490027
commit
0861d86562
3 changed files with 38 additions and 42 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. 39
      rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbRenameMsgKeysNode.java
  2. 12
      rule-engine/rule-engine-components/src/main/java/org/thingsboard/rule/engine/transform/TbRenameMsgKeysNodeConfiguration.java
  3. 29
      rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeTest.java

39
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/TbRenameMsgKeysNode.java
View File

@ -26,59 +26,58 @@ import org.thingsboard.rule.engine.api.TbNode;
import org.thingsboard.rule.engine.api.TbNodeConfiguration; import org.thingsboard.rule.engine.api.TbNodeConfiguration;
import org.thingsboard.rule.engine.api.TbNodeException; import org.thingsboard.rule.engine.api.TbNodeException;
import org.thingsboard.rule.engine.api.util.TbNodeUtils; import org.thingsboard.rule.engine.api.util.TbNodeUtils;
import org.thingsboard.server.common.data.StringUtils;
import org.thingsboard.server.common.data.plugin.ComponentType; import org.thingsboard.server.common.data.plugin.ComponentType;
import org.thingsboard.server.common.msg.TbMsg; import org.thingsboard.server.common.msg.TbMsg;
import org.thingsboard.server.common.msg.TbMsgMetaData;
import java.util.List; import java.util.Map;
import java.util.concurrent.ExecutionException; import java.util.concurrent.ExecutionException;
@Slf4j @Slf4j
@RuleNode( @RuleNode(
type = ComponentType.TRANSFORMATION, type = ComponentType.TRANSFORMATION,
name = "copy from metadata to msg", name = "rename keys",
configClazz = TbCopyFromMdToMsgNodeConfiguration.class, configClazz = TbRenameMsgKeysNodeConfiguration.class,
nodeDescription = "Copies the message metadata keys to msg data with specified key names selected in the list", nodeDescription = "Renames the keys in the msg data to the specified key names selected in the key mapping.",
nodeDetails = "", nodeDetails = "Will fetch fields values specified in mapping. If specified field is not part of msg 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," +
" otherwise returns transformed messages via <code>Success</code> chain",
uiResources = {"static/rulenode/rulenode-core-config.js"}, uiResources = {"static/rulenode/rulenode-core-config.js"},
configDirective = "", configDirective = "",
icon = "functions" icon = "functions"
) )
public class TbCopyFromMdToMsgNode implements TbNode { public class TbRenameMsgKeysNode implements TbNode {
TbCopyFromMdToMsgNodeConfiguration config; TbRenameMsgKeysNodeConfiguration 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, TbRenameMsgKeysNodeConfiguration.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); processRename(ctx, msg);
} }
@Override @Override
public void destroy() { public void destroy() {
} }
private void processCopy(TbContext ctx, TbMsg msg) { private void processRename(TbContext ctx, TbMsg msg) {
List<String> metadataMsgKeys = config.getMetadataMsgKeys(); Map<String, String> renameKeysMapping = config.getRenameKeysMapping();
if (CollectionUtils.isEmpty(metadataMsgKeys)) { if (CollectionUtils.isEmpty(renameKeysMapping)) {
ctx.tellSuccess(msg); ctx.tellSuccess(msg);
} else { } else {
JsonNode dataNode = JacksonUtil.toJsonNode(msg.getData()); JsonNode dataNode = JacksonUtil.toJsonNode(msg.getData());
if (dataNode.isObject()) { if (dataNode.isObject()) {
ObjectNode msgData = (ObjectNode) dataNode; ObjectNode msgData = (ObjectNode) dataNode;
TbMsgMetaData metaData = msg.getMetaData(); renameKeysMapping.forEach((nameKey, newNameKey) -> {
metadataMsgKeys.forEach(metadataKey -> { if (msgData.has(nameKey)) {
String value = metaData.getValue(metadataKey); msgData.set(newNameKey, msgData.get(nameKey));
if (!StringUtils.isEmpty(value)) { msgData.remove(nameKey);
msgData.put(metadataKey, value);
} }
}); });
ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), metaData, JacksonUtil.toString(msgData))); ctx.tellSuccess(TbMsg.transformMsg(msg, msg.getType(), msg.getOriginator(), msg.getMetaData(), JacksonUtil.toString(msgData)));
} else { } else {
ctx.tellFailure(msg, new RuntimeException("Msg data is not a JSON Object!")); ctx.tellFailure(msg, new RuntimeException("Msg data is not a JSON Object!"));
} }

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/TbRenameMsgKeysNodeConfiguration.java
View File

@ -19,17 +19,17 @@ import lombok.Data;
import org.thingsboard.rule.engine.api.NodeConfiguration; import org.thingsboard.rule.engine.api.NodeConfiguration;
import java.util.Collections; import java.util.Collections;
import java.util.List; import java.util.Map;
@Data @Data
public class TbCopyFromMdToMsgNodeConfiguration implements NodeConfiguration<TbCopyFromMdToMsgNodeConfiguration> { public class TbRenameMsgKeysNodeConfiguration implements NodeConfiguration<TbRenameMsgKeysNodeConfiguration> {
private List<String> metadataMsgKeys; private Map<String, String> renameKeysMapping;
@Override @Override
public TbCopyFromMdToMsgNodeConfiguration defaultConfiguration() { public TbRenameMsgKeysNodeConfiguration defaultConfiguration() {
TbCopyFromMdToMsgNodeConfiguration configuration = new TbCopyFromMdToMsgNodeConfiguration(); TbRenameMsgKeysNodeConfiguration configuration = new TbRenameMsgKeysNodeConfiguration();
configuration.setMetadataMsgKeys(Collections.emptyList()); configuration.setRenameKeysMapping(Collections.emptyMap());
return configuration; return configuration;
} }

29
rule-engine/rule-engine-components/src/test/java/org/thingsboard/rule/engine/transform/TbCopyFromMdToMsgNodeTest.java
View File

@ -16,7 +16,6 @@
package org.thingsboard.rule.engine.transform; package org.thingsboard.rule.engine.transform;
import com.fasterxml.jackson.databind.JsonNode; import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach; import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
@ -32,7 +31,6 @@ import org.thingsboard.server.common.msg.TbMsgMetaData;
import org.thingsboard.server.common.msg.queue.TbMsgCallback; import org.thingsboard.server.common.msg.queue.TbMsgCallback;
import java.util.Collections; import java.util.Collections;
import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.UUID; import java.util.UUID;
@ -45,11 +43,9 @@ import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify; import static org.mockito.Mockito.verify;
public class TbCopyFromMdToMsgNodeTest { public class TbCopyFromMdToMsgNodeTest {
final ObjectMapper mapper = new ObjectMapper();
DeviceId deviceId; DeviceId deviceId;
TbCopyFromMdToMsgNode node; TbRenameMsgKeysNode node;
TbCopyFromMdToMsgNodeConfiguration config; TbRenameMsgKeysNodeConfiguration config;
TbNodeConfiguration nodeConfiguration; TbNodeConfiguration nodeConfiguration;
TbContext ctx; TbContext ctx;
TbMsgCallback callback; TbMsgCallback callback;
@ -59,10 +55,10 @@ 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 TbRenameMsgKeysNodeConfiguration().defaultConfiguration();
config.setMetadataMsgKeys(List.of("TestKey_1", "TestKey_2", "TestKey_3")); config.setRenameKeysMapping(Map.of("TestKey_1", "Attribute_1", "TestKey_2", "Attribute_2"));
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config)); nodeConfiguration = new TbNodeConfiguration(JacksonUtil.valueToTree(config));
node = spy(new TbCopyFromMdToMsgNode()); node = spy(new TbRenameMsgKeysNode());
node.init(ctx, nodeConfiguration); node.init(ctx, nodeConfiguration);
} }
@ -78,13 +74,13 @@ public class TbCopyFromMdToMsgNodeTest {
@Test @Test
void givenDefaultConfig_whenVerify_thenOK() { void givenDefaultConfig_whenVerify_thenOK() {
TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); TbRenameMsgKeysNodeConfiguration defaultConfig = new TbRenameMsgKeysNodeConfiguration().defaultConfiguration();
assertThat(defaultConfig.getMetadataMsgKeys()).isEqualTo(Collections.emptyList()); assertThat(defaultConfig.getRenameKeysMapping()).isEqualTo(Collections.emptyMap());
} }
@Test @Test
void givenMsg_whenOnMsg_thenVerifyOutput() throws Exception { void givenMsg_whenOnMsg_thenVerifyOutput() throws Exception {
String data = "{}"; String data = "{\"Temperature_1\":22.5,\"TestKey_2\":10.3}";
node.onMsg(ctx, getTbMsg(deviceId, data)); node.onMsg(ctx, getTbMsg(deviceId, data));
ArgumentCaptor<TbMsg> newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class); ArgumentCaptor<TbMsg> newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class);
@ -95,13 +91,14 @@ public class TbCopyFromMdToMsgNodeTest {
assertThat(newMsg).isNotNull(); assertThat(newMsg).isNotNull();
JsonNode dataNode = JacksonUtil.toJsonNode(newMsg.getData()); JsonNode dataNode = JacksonUtil.toJsonNode(newMsg.getData());
assertThat(dataNode.has("TestKey_1")).isEqualTo(true); assertThat(dataNode.has("Attribute_2")).isEqualTo(true);
assertThat(dataNode.has("Temperature_1")).isEqualTo(true);
} }
@Test @Test
void givenEmptyKeys_whenOnMsg_thenVerifyOutput() throws Exception { void givenEmptyKeys_whenOnMsg_thenVerifyOutput() throws Exception {
TbCopyFromMdToMsgNodeConfiguration defaultConfig = new TbCopyFromMdToMsgNodeConfiguration().defaultConfiguration(); TbRenameMsgKeysNodeConfiguration defaultConfig = new TbRenameMsgKeysNodeConfiguration().defaultConfiguration();
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(defaultConfig)); nodeConfiguration = new TbNodeConfiguration(JacksonUtil.valueToTree(defaultConfig));
node.init(ctx, nodeConfiguration); node.init(ctx, nodeConfiguration);
String data = "{}"; String data = "{}";

Write Preview
Loading…
Cancel
Save