Andrew Shvayka
4 years ago
committed by
GitHub
GitHub
8 changed files with 316 additions and 2 deletions
@ -0,0 +1,96 @@ |
|||
/** |
|||
* 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.metadata; |
|||
|
|||
import com.fasterxml.jackson.databind.JsonNode; |
|||
import com.fasterxml.jackson.databind.node.ObjectNode; |
|||
import lombok.extern.slf4j.Slf4j; |
|||
import org.thingsboard.common.util.JacksonUtil; |
|||
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.EntityType; |
|||
import org.thingsboard.server.common.data.id.DeviceId; |
|||
import org.thingsboard.server.common.data.id.EntityId; |
|||
import org.thingsboard.server.common.data.plugin.ComponentType; |
|||
import org.thingsboard.server.common.data.security.DeviceCredentials; |
|||
import org.thingsboard.server.common.msg.TbMsg; |
|||
import org.thingsboard.server.common.msg.TbMsgMetaData; |
|||
|
|||
import java.util.concurrent.ExecutionException; |
|||
|
|||
@Slf4j |
|||
@RuleNode( |
|||
type = ComponentType.ENRICHMENT, |
|||
name = "fetch device credentials", |
|||
configClazz = TbFetchDeviceCredentialsNodeConfiguration.class, |
|||
nodeDescription = "Fetch device credentials for message originator", |
|||
nodeDetails = "Adds <b>credentialsType</b> and <b>credentials</b> properties to the message metadata if the " + |
|||
"configuration parameter <b>fetchToMetadata</b> is set to <code>true</code>, otherwise, adds properties " + |
|||
"to the message data. If originator type is not <b>DEVICE</b> or rule node failed to get device credentials " + |
|||
"- send Message via <code>Failure</code> chain, otherwise <code>Success</code> chain is used.", |
|||
uiResources = {"static/rulenode/rulenode-core-config.js"}, |
|||
configDirective = "tbEnrichmentNodeFetchDeviceCredentialsConfig", |
|||
icon = "functions" |
|||
) |
|||
public class TbFetchDeviceCredentialsNode implements TbNode { |
|||
|
|||
private static final String CREDENTIALS = "credentials"; |
|||
private static final String CREDENTIALS_TYPE = "credentialsType"; |
|||
|
|||
TbFetchDeviceCredentialsNodeConfiguration config; |
|||
boolean fetchToMetadata; |
|||
|
|||
@Override |
|||
public void init(TbContext ctx, TbNodeConfiguration configuration) throws TbNodeException { |
|||
this.config = TbNodeUtils.convert(configuration, TbFetchDeviceCredentialsNodeConfiguration.class); |
|||
this.fetchToMetadata = config.isFetchToMetadata(); |
|||
} |
|||
|
|||
@Override |
|||
public void onMsg(TbContext ctx, TbMsg msg) throws ExecutionException, InterruptedException, TbNodeException { |
|||
EntityId originator = msg.getOriginator(); |
|||
if (!EntityType.DEVICE.equals(originator.getEntityType())) { |
|||
ctx.tellFailure(msg, new RuntimeException("Unsupported originator type: " + originator.getEntityType() + "!")); |
|||
return; |
|||
} |
|||
DeviceId deviceId = new DeviceId(msg.getOriginator().getId()); |
|||
DeviceCredentials deviceCredentials = ctx.getDeviceCredentialsService().findDeviceCredentialsByDeviceId(ctx.getTenantId(), deviceId); |
|||
if (deviceCredentials == null) { |
|||
ctx.tellFailure(msg, new RuntimeException("Failed to get Device Credentials for device: " + deviceId + "!")); |
|||
return; |
|||
} |
|||
|
|||
TbMsg transformedMsg; |
|||
String credentialsType = deviceCredentials.getCredentialsType().name(); |
|||
JsonNode credentialsInfo = ctx.getDeviceCredentialsService().toCredentialsInfo(deviceCredentials); |
|||
if (fetchToMetadata) { |
|||
TbMsgMetaData metaData = msg.getMetaData(); |
|||
metaData.putValue(CREDENTIALS_TYPE, credentialsType); |
|||
metaData.putValue(CREDENTIALS, JacksonUtil.toString(credentialsInfo)); |
|||
transformedMsg = TbMsg.transformMsg(msg, msg.getType(), originator, metaData, msg.getData()); |
|||
} else { |
|||
ObjectNode data = (ObjectNode) JacksonUtil.toJsonNode(msg.getData()); |
|||
data.put(CREDENTIALS_TYPE, credentialsType); |
|||
data.set(CREDENTIALS, credentialsInfo); |
|||
transformedMsg = TbMsg.transformMsg(msg, msg.getType(), originator, msg.getMetaData(), JacksonUtil.toString(data)); |
|||
} |
|||
ctx.tellSuccess(transformedMsg); |
|||
} |
|||
} |
|||
@ -0,0 +1,34 @@ |
|||
/** |
|||
* 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.metadata; |
|||
|
|||
import com.fasterxml.jackson.annotation.JsonIgnoreProperties; |
|||
import lombok.Data; |
|||
import org.thingsboard.rule.engine.api.NodeConfiguration; |
|||
|
|||
@Data |
|||
@JsonIgnoreProperties(ignoreUnknown = true) |
|||
public class TbFetchDeviceCredentialsNodeConfiguration implements NodeConfiguration<TbFetchDeviceCredentialsNodeConfiguration> { |
|||
|
|||
private boolean fetchToMetadata; |
|||
|
|||
@Override |
|||
public TbFetchDeviceCredentialsNodeConfiguration defaultConfiguration() { |
|||
TbFetchDeviceCredentialsNodeConfiguration configuration = new TbFetchDeviceCredentialsNodeConfiguration(); |
|||
configuration.setFetchToMetadata(true); |
|||
return configuration; |
|||
} |
|||
} |
|||
@ -0,0 +1,156 @@ |
|||
/** |
|||
* 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.metadata; |
|||
|
|||
import com.fasterxml.jackson.databind.ObjectMapper; |
|||
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.common.util.JacksonUtil; |
|||
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.id.CustomerId; |
|||
import org.thingsboard.server.common.data.id.DeviceId; |
|||
import org.thingsboard.server.common.data.id.EntityId; |
|||
import org.thingsboard.server.common.data.security.DeviceCredentials; |
|||
import org.thingsboard.server.common.msg.TbMsg; |
|||
import org.thingsboard.server.common.msg.TbMsgMetaData; |
|||
import org.thingsboard.server.common.msg.queue.TbMsgCallback; |
|||
import org.thingsboard.server.dao.device.DeviceCredentialsService; |
|||
|
|||
import java.util.Map; |
|||
import java.util.UUID; |
|||
|
|||
import static org.assertj.core.api.Assertions.assertThat; |
|||
import static org.mockito.ArgumentMatchers.any; |
|||
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; |
|||
import static org.thingsboard.server.common.data.security.DeviceCredentialsType.ACCESS_TOKEN; |
|||
|
|||
public class TbFetchDeviceCredentialsNodeTest { |
|||
final ObjectMapper mapper = new ObjectMapper(); |
|||
|
|||
DeviceId deviceId; |
|||
TbFetchDeviceCredentialsNode node; |
|||
TbFetchDeviceCredentialsNodeConfiguration config; |
|||
TbNodeConfiguration nodeConfiguration; |
|||
TbContext ctx; |
|||
TbMsgCallback callback; |
|||
DeviceCredentialsService deviceCredentialsService; |
|||
|
|||
@BeforeEach |
|||
void setUp() throws TbNodeException { |
|||
deviceId = new DeviceId(UUID.randomUUID()); |
|||
callback = mock(TbMsgCallback.class); |
|||
ctx = mock(TbContext.class); |
|||
config = new TbFetchDeviceCredentialsNodeConfiguration().defaultConfiguration(); |
|||
config.setFetchToMetadata(true); |
|||
nodeConfiguration = new TbNodeConfiguration(mapper.valueToTree(config)); |
|||
node = spy(new TbFetchDeviceCredentialsNode()); |
|||
node.init(ctx, nodeConfiguration); |
|||
deviceCredentialsService = mock(DeviceCredentialsService.class); |
|||
|
|||
willReturn(deviceCredentialsService).given(ctx).getDeviceCredentialsService(); |
|||
willAnswer(invocation -> { |
|||
DeviceCredentials deviceCredentials = new DeviceCredentials(); |
|||
deviceCredentials.setCredentialsType(ACCESS_TOKEN); |
|||
return deviceCredentials; |
|||
}).given(deviceCredentialsService).findDeviceCredentialsByDeviceId(any(), any()); |
|||
willAnswer(invocation -> { |
|||
return JacksonUtil.newObjectNode(); |
|||
}).given(deviceCredentialsService).toCredentialsInfo(any()); |
|||
} |
|||
|
|||
@AfterEach |
|||
void tearDown() { |
|||
node.destroy(); |
|||
} |
|||
|
|||
@Test |
|||
void givenDefaultConfig_whenInit_thenOK() { |
|||
assertThat(node.config).isEqualTo(config); |
|||
assertThat(node.fetchToMetadata).isEqualTo(true); |
|||
} |
|||
|
|||
@Test |
|||
void givenDefaultConfig_whenVerify_thenOK() { |
|||
TbFetchDeviceCredentialsNodeConfiguration defaultConfig = new TbFetchDeviceCredentialsNodeConfiguration().defaultConfiguration(); |
|||
assertThat(defaultConfig.isFetchToMetadata()).isEqualTo(true); |
|||
} |
|||
|
|||
@Test |
|||
void givenMsg_whenOnMsg_thenVerifyOutput() throws Exception { |
|||
node.onMsg(ctx, getTbMsg(deviceId)); |
|||
|
|||
ArgumentCaptor<TbMsg> newMsgCaptor = ArgumentCaptor.forClass(TbMsg.class); |
|||
verify(ctx, times(1)).tellSuccess(newMsgCaptor.capture()); |
|||
verify(ctx, never()).tellFailure(any(), any()); |
|||
verify(deviceCredentialsService, times(1)).findDeviceCredentialsByDeviceId(any(), any()); |
|||
|
|||
TbMsg newMsg = newMsgCaptor.getValue(); |
|||
assertThat(newMsg).isNotNull(); |
|||
|
|||
assertThat(newMsg.getMetaData().getData().containsKey("credentials")).isEqualTo(true); |
|||
assertThat(newMsg.getMetaData().getData().containsKey("credentialsType")).isEqualTo(true); |
|||
} |
|||
|
|||
@Test |
|||
void givenUnsupportedOriginatorType_whenOnMsg_thenTellFailure() throws Exception { |
|||
node.onMsg(ctx, getTbMsg(new CustomerId(UUID.randomUUID()))); |
|||
|
|||
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(exceptionCaptor.getValue()).isInstanceOf(RuntimeException.class); |
|||
} |
|||
|
|||
@Test |
|||
void givenGetDeviceCredentials_whenOnMsg_thenTellFailure() throws Exception { |
|||
willAnswer(invocation -> { |
|||
return null; |
|||
}).given(deviceCredentialsService).findDeviceCredentialsByDeviceId(any(), any()); |
|||
|
|||
node.onMsg(ctx, getTbMsg(deviceId)); |
|||
|
|||
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(exceptionCaptor.getValue()).isInstanceOf(RuntimeException.class); |
|||
} |
|||
|
|||
private TbMsg getTbMsg(EntityId entityId) { |
|||
final Map<String, String> mdMap = Map.of( |
|||
"country", "US", |
|||
"city", "NY" |
|||
); |
|||
|
|||
final TbMsgMetaData metaData = new TbMsgMetaData(mdMap); |
|||
final String data = "{\"TestAttribute_1\": \"humidity\", \"TestAttribute_2\": \"voltage\"}"; |
|||
|
|||
return TbMsg.newMsg("POST_ATTRIBUTES_REQUEST", entityId, metaData, data, callback); |
|||
} |
|||
} |
|||
Loading…
Reference in new issue