new RuleNode "delete attributes"
This commit is contained in:
Yuriy Lytvynchuk
parent
088f971e3c
commit
d745fd21fb
@ -0,0 +1,85 @@
|
||||
/**
|
||||
* Copyright © 2016-2022 The Thingsboard Authors
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
package org.thingsboard.rule.engine.telemetry;
|
||||
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.springframework.util.CollectionUtils;
|
||||
import org.thingsboard.rule.engine.api.RuleNode;
|
||||
import org.thingsboard.rule.engine.api.TbContext;
|
||||
import org.thingsboard.rule.engine.api.TbNode;
|
||||
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.DataConstants;
|
||||
import org.thingsboard.server.common.data.StringUtils;
|
||||
import org.thingsboard.server.common.data.plugin.ComponentType;
|
||||
import org.thingsboard.server.common.msg.TbMsg;
|
||||
|
||||
import java.util.List;
|
||||
import java.util.concurrent.ExecutionException;
|
||||
import java.util.stream.Collectors;
|
||||
|
||||
@Slf4j
|
||||
@RuleNode(
|
||||
type = ComponentType.ACTION,
|
||||
name = "delete attributes",
|
||||
configClazz = TbMsgDeleteAttributesConfiguration.class,
|
||||
nodeDescription = "Delete attributes for Message Originator.",
|
||||
nodeDetails = "Allowed scope parameter values: <b>SERVER/CLIENT/SHARED</b>. If no attributes are selected - " +
|
||||
"message send via <b>Failure</b> chain. If selected attributes successfully deleted - message send via " +
|
||||
"<b>Success</b> chain, otherwise <b>Failure</b> chain will be used.",
|
||||
uiResources = {"static/rulenode/rulenode-core-config.js"},
|
||||
configDirective = "tbActionNodeDeleteAttributesConfig",
|
||||
icon = "remove_circle"
|
||||
)
|
||||
public class TbMsgDeleteAttributes implements TbNode {
|
||||
|
||||
TbMsgDeleteAttributesConfiguration config;
|
||||
|
||||
@Override
|
||||
public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException {
|
||||
this.config = TbNodeUtils.convert(configuration, TbMsgDeleteAttributesConfiguration.class);
|
||||
if (CollectionUtils.isEmpty(config.getKeysPatterns())) {
|
||||
throw new IllegalArgumentException("Attribute keys list is empty!");
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException {
|
||||
List<String> keysPatterns = config.getKeysPatterns();
|
||||
String scope = TbNodeUtils.processPattern(config.getScopePattern(), msg);
|
||||
if (DataConstants.SERVER_SCOPE.equals(scope) ||
|
||||
DataConstants.CLIENT_SCOPE.equals(scope) ||
|
||||
DataConstants.SHARED_SCOPE.equals(scope)) {
|
||||
List<String> keysToDelete = keysPatterns.stream()
|
||||
.map(keyPattern -> TbNodeUtils.processPattern(keyPattern, msg))
|
||||
.distinct()
|
||||
.filter(StringUtils::isNotBlank)
|
||||
.collect(Collectors.toList());
|
||||
if (keysToDelete.isEmpty()) {
|
||||
throw new RuntimeException("Selected keys patterns have invalid values!");
|
||||
}
|
||||
ctx.getTelemetryService().deleteAndNotify(ctx.getTenantId(), msg.getOriginator(), scope, keysToDelete, new TelemetryNodeCallback(ctx, msg));
|
||||
} else {
|
||||
ctx.tellFailure(msg, new IllegalArgumentException("Unsupported attributes scope '" + scope + "'! Only 'SERVER_SCOPE', 'CLIENT_SCOPE' or 'SHARED_SCOPE' are allowed!"));
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public void destroy() {
|
||||
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,38 @@
|
||||
/**
|
||||
* Copyright © 2016-2022 The Thingsboard Authors
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
package org.thingsboard.rule.engine.telemetry;
|
||||
|
||||
import lombok.Data;
|
||||
import org.thingsboard.rule.engine.api.NodeConfiguration;
|
||||
import org.thingsboard.server.common.data.DataConstants;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
|
||||
@Data
|
||||
public class TbMsgDeleteAttributesConfiguration implements NodeConfiguration<TbMsgDeleteAttributesConfiguration> {
|
||||
|
||||
private String scopePattern;
|
||||
private List<String> keysPatterns;
|
||||
|
||||
@Override
|
||||
public TbMsgDeleteAttributesConfiguration defaultConfiguration() {
|
||||
TbMsgDeleteAttributesConfiguration configuration = new TbMsgDeleteAttributesConfiguration();
|
||||
configuration.setScopePattern(DataConstants.SERVER_SCOPE);
|
||||
configuration.setKeysPatterns(Collections.emptyList());
|
||||
return configuration;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,148 @@
|
||||
/**
|
||||
* Copyright © 2016-2022 The Thingsboard Authors
|
||||
*
|
||||
* 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.
|
||||
*/
|
||||
package org.thingsboard.rule.engine.telemetry;
|
||||
|
||||
import com.fasterxml.jackson.databind.ObjectMapper;
|
||||
import lombok.extern.slf4j.Slf4j;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.mockito.ArgumentCaptor;
|
||||
import org.thingsboard.rule.engine.api.RuleEngineTelemetryService;
|
||||
import org.thingsboard.rule.engine.api.TbContext;
|
||||
import org.thingsboard.rule.engine.api.TbNodeConfiguration;
|
||||
import org.thingsboard.rule.engine.api.TbNodeException;
|
||||
import org.thingsboard.server.common.data.DataConstants;
|
||||
import org.thingsboard.server.common.data.id.DeviceId;
|
||||
import org.thingsboard.server.common.msg.TbMsg;
|
||||
import org.thingsboard.server.common.msg.TbMsgMetaData;
|
||||
import org.thingsboard.server.common.msg.queue.TbMsgCallback;
|
||||
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.assertj.core.api.Assertions.assertThatThrownBy;
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.ArgumentMatchers.anyList;
|
||||
import static org.mockito.ArgumentMatchers.anyString;
|
||||
import static org.mockito.BDDMockito.willAnswer;
|
||||
import static org.mockito.BDDMockito.willReturn;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.never;
|
||||
import static org.mockito.Mockito.spy;
|
||||
import static org.mockito.Mockito.times;
|
||||
import static org.mockito.Mockito.verify;
|
||||
|
||||
@Slf4j
|
||||
public class TbMsgDeleteAttributesTest {
|
||||
final ObjectMapper mapper = new ObjectMapper();
|
||||
|
||||
DeviceId deviceId;
|
||||
TbMsgDeleteAttributes node;
|
||||
TbMsgDeleteAttributesConfiguration config;
|
||||
TbNodeConfiguration nodeConfiguration;
|
||||
TbContext ctx;
|
||||
TbMsgCallback callback;
|
||||
|
||||
RuleEngineTelemetryService telemetryService;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() throws TbNodeException {
|
||||
deviceId = new DeviceId(UUID.randomUUID());
|
||||
callback = mock(TbMsgCallback.class);
|
||||
ctx = mock(TbContext.class);
|
||||
config = new TbMsgDeleteAttributesConfiguration().defaultConfiguration();
|
||||
config.setKeysPatterns(List.of("${TestAttribute_1}", "$[TestAttribute_2]", "$[TestAttribute_3]"));
|
||||
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config));
|
||||
node = spy(new TbMsgDeleteAttributes());
|
||||
node.init(ctx, nodeConfiguration);
|
||||
telemetryService = mock(RuleEngineTelemetryService.class);
|
||||
|
||||
willReturn(telemetryService).given(ctx).getTelemetryService();
|
||||
willAnswer(invocation -> {
|
||||
TelemetryNodeCallback callBack = invocation.getArgument(4);
|
||||
callBack.onSuccess(null);
|
||||
return null;
|
||||
}).given(telemetryService).deleteAndNotify(
|
||||
any(), any(), anyString(), anyList(), any());
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
void tearDown() {
|
||||
node.destroy();
|
||||
}
|
||||
|
||||
@Test
|
||||
void givenDefaultConfig_whenInit_thenOK() {
|
||||
assertThat(node.config).isEqualTo(config);
|
||||
}
|
||||
|
||||
@Test
|
||||
void givenDefaultConfig_whenInit_thenFail() {
|
||||
config.setKeysPatterns(Collections.emptyList());
|
||||
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config));
|
||||
assertThatThrownBy(() -> node.init(ctx, nodeConfiguration)).isInstanceOf(IllegalArgumentException.class);
|
||||
}
|
||||
|
||||
@Test
|
||||
void givenDefaultConfig_whenVerify_thenOK() {
|
||||
TbMsgDeleteAttributesConfiguration defaultConfig = new TbMsgDeleteAttributesConfiguration().defaultConfiguration();
|
||||
assertThat(defaultConfig.getScopePattern()).isEqualTo(DataConstants.SERVER_SCOPE);
|
||||
assertThat(defaultConfig.getKeysPatterns()).isEqualTo(Collections.emptyList());
|
||||
}
|
||||
|
||||
@Test
|
||||
void givenMsg_whenOnMsg_thenVerifyOutput() throws Exception {
|
||||
final Map<String, String> mdMap = Map.of(
|
||||
"TestAttribute_1", "temperature",
|
||||
"city", "NY"
|
||||
);
|
||||
final TbMsgMetaData metaData = new TbMsgMetaData(mdMap);
|
||||
final String data = "{\"TestAttribute_2\": \"humidity\", \"TestAttribute_3\": \"voltage\"}";
|
||||
|
||||
TbMsg msg = TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", deviceId, metaData, data, callback);
|
||||
node.onMsg(ctx, msg);
|
||||
|
||||
ArgumentCaptor<TbMsg> newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class);
|
||||
verify(ctx, times(1)).tellSuccess(newMsgCaptor.capture());
|
||||
verify(ctx, never()).tellFailure(any(), any());
|
||||
verify(telemetryService, times(1)).deleteAndNotify(any(), any(), anyString(), anyList(), any());
|
||||
}
|
||||
|
||||
@Test
|
||||
void givenEmptyMsg_whenOnMsg_thenTellFailure() throws Exception {
|
||||
final TbMsgMetaData metaData = new TbMsgMetaData();
|
||||
final String data = "{}";
|
||||
|
||||
config.setScopePattern("NOT_SERVER_SCOPE");
|
||||
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config));
|
||||
node.init(ctx, nodeConfiguration);
|
||||
|
||||
TbMsg msg = TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", deviceId, metaData, data, callback);
|
||||
node.onMsg(ctx, msg);
|
||||
|
||||
ArgumentCaptor<TbMsg> newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class);
|
||||
ArgumentCaptor<Exception> exceptionCaptor = ArgumentCaptor.forClass(Exception.class);
|
||||
verify(ctx, never()).tellSuccess(any());
|
||||
verify(ctx, times(1)).tellFailure(newMsgCaptor.capture(), exceptionCaptor.capture());
|
||||
|
||||
assertThat(newMsgCaptor.getValue()).isSameAs(msg);
|
||||
assertThat(exceptionCaptor.getValue()).isInstanceOf(IllegalArgumentException.class);
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user