Viacheslav Klimov
2 years ago
committed by
GitHub
GitHub
1 changed files with 273 additions and 0 deletions
@ -0,0 +1,273 @@ |
|||||
|
/** |
||||
|
* Copyright © 2016-2024 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.action; |
||||
|
|
||||
|
import com.google.common.util.concurrent.FutureCallback; |
||||
|
import com.google.common.util.concurrent.Futures; |
||||
|
import org.junit.jupiter.api.BeforeEach; |
||||
|
import org.junit.jupiter.api.Test; |
||||
|
import org.junit.jupiter.api.extension.ExtendWith; |
||||
|
import org.junit.jupiter.params.ParameterizedTest; |
||||
|
import org.junit.jupiter.params.provider.EnumSource; |
||||
|
import org.mockito.ArgumentCaptor; |
||||
|
import org.mockito.Mock; |
||||
|
import org.mockito.junit.jupiter.MockitoExtension; |
||||
|
import org.thingsboard.common.util.JacksonUtil; |
||||
|
import org.thingsboard.rule.engine.api.EmptyNodeConfiguration; |
||||
|
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.AttributeScope; |
||||
|
import org.thingsboard.server.common.data.DataConstants; |
||||
|
import org.thingsboard.server.common.data.EntityView; |
||||
|
import org.thingsboard.server.common.data.id.DeviceId; |
||||
|
import org.thingsboard.server.common.data.id.EntityViewId; |
||||
|
import org.thingsboard.server.common.data.id.TenantId; |
||||
|
import org.thingsboard.server.common.data.kv.AttributeKvEntry; |
||||
|
import org.thingsboard.server.common.data.msg.TbMsgType; |
||||
|
import org.thingsboard.server.common.data.msg.TbNodeConnectionType; |
||||
|
import org.thingsboard.server.common.data.objects.AttributesEntityView; |
||||
|
import org.thingsboard.server.common.data.objects.TelemetryEntityView; |
||||
|
import org.thingsboard.server.common.msg.TbMsg; |
||||
|
import org.thingsboard.server.common.msg.TbMsgMetaData; |
||||
|
import org.thingsboard.server.dao.entityview.EntityViewService; |
||||
|
|
||||
|
import java.time.Instant; |
||||
|
import java.time.temporal.ChronoUnit; |
||||
|
import java.util.Collections; |
||||
|
import java.util.List; |
||||
|
import java.util.Map; |
||||
|
import java.util.UUID; |
||||
|
|
||||
|
import static org.assertj.core.api.AssertionsForClassTypes.assertThat; |
||||
|
import static org.mockito.ArgumentMatchers.any; |
||||
|
import static org.mockito.ArgumentMatchers.anyList; |
||||
|
import static org.mockito.ArgumentMatchers.eq; |
||||
|
import static org.mockito.Mockito.doAnswer; |
||||
|
import static org.mockito.Mockito.verify; |
||||
|
import static org.mockito.Mockito.verifyNoMoreInteractions; |
||||
|
import static org.mockito.Mockito.when; |
||||
|
import static org.thingsboard.server.common.data.msg.TbMsgType.ACTIVITY_EVENT; |
||||
|
import static org.thingsboard.server.common.data.msg.TbMsgType.ATTRIBUTES_DELETED; |
||||
|
import static org.thingsboard.server.common.data.msg.TbMsgType.ATTRIBUTES_UPDATED; |
||||
|
import static org.thingsboard.server.common.data.msg.TbMsgType.INACTIVITY_EVENT; |
||||
|
import static org.thingsboard.server.common.data.msg.TbMsgType.POST_ATTRIBUTES_REQUEST; |
||||
|
|
||||
|
@ExtendWith(MockitoExtension.class) |
||||
|
public class TbCopyAttributesToEntityViewNodeTest { |
||||
|
|
||||
|
private final TenantId TENANT_ID = TenantId.fromUUID(UUID.fromString("9fdb1f05-dc66-4960-9263-ae195f1b4533")); |
||||
|
private final DeviceId DEVICE_ID = new DeviceId(UUID.fromString("1d453dc9-9333-476a-a51f-093cf2176e59")); |
||||
|
private final EntityViewId ENTITY_VIEW_ID = new EntityViewId(UUID.fromString("65636806-453d-4bb4-b513-92b833970753")); |
||||
|
|
||||
|
private final AttributesEntityView CLIENT_ATTRIBUTES = new AttributesEntityView(List.of("clientAttribute1"), Collections.emptyList(), Collections.emptyList()); |
||||
|
private final AttributesEntityView SERVER_ATTRIBUTES = new AttributesEntityView(Collections.emptyList(), List.of("serverAttribute1"), Collections.emptyList()); |
||||
|
private final AttributesEntityView SHARED_ATTRIBUTES = new AttributesEntityView(Collections.emptyList(), Collections.emptyList(), List.of("sharedAttribute1")); |
||||
|
|
||||
|
private final TelemetryEntityView CLIENT_TELEMETRY_ENTITY_VIEW = new TelemetryEntityView(Collections.emptyList(), CLIENT_ATTRIBUTES); |
||||
|
private final TelemetryEntityView SERVER_TELEMETRY_ENTITY_VIEW = new TelemetryEntityView(Collections.emptyList(), SERVER_ATTRIBUTES); |
||||
|
private final TelemetryEntityView SHARED_TELEMETRY_ENTITY_VIEW = new TelemetryEntityView(Collections.emptyList(), SHARED_ATTRIBUTES); |
||||
|
|
||||
|
private final long ENTITY_VIEW_START_TS = Instant.now().minus(1, ChronoUnit.DAYS).toEpochMilli(); |
||||
|
private final long ENTITY_VIEW_END_TS = Instant.now().plus(1, ChronoUnit.DAYS).toEpochMilli(); |
||||
|
|
||||
|
private TbCopyAttributesToEntityViewNode node; |
||||
|
|
||||
|
@Mock |
||||
|
private TbContext ctxMock; |
||||
|
@Mock |
||||
|
private EntityViewService entityViewServiceMock; |
||||
|
@Mock |
||||
|
private RuleEngineTelemetryService telemetryServiceMock; |
||||
|
|
||||
|
@BeforeEach |
||||
|
void setUp() throws TbNodeException { |
||||
|
node = new TbCopyAttributesToEntityViewNode(); |
||||
|
var config = new EmptyNodeConfiguration().defaultConfiguration(); |
||||
|
var configuration = new TbNodeConfiguration(JacksonUtil.valueToTree(config)); |
||||
|
node.init(ctxMock, configuration); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
public void givenExistingClientAttributes_whenOnMsg_thenCopyAttributesToView() { |
||||
|
EntityView entityView = getEntityView(CLIENT_TELEMETRY_ENTITY_VIEW); |
||||
|
|
||||
|
TbMsg msg = TbMsg.newMsg(TbMsgType.POST_ATTRIBUTES_REQUEST, DEVICE_ID, |
||||
|
new TbMsgMetaData(Map.of(DataConstants.SCOPE, AttributeScope.SERVER_SCOPE.name())), |
||||
|
"{\"clientAttribute1\": 100, \"clientAttribute2\": \"value2\"}"); |
||||
|
|
||||
|
mockEntityViewLookup(entityView); |
||||
|
when(ctxMock.getTelemetryService()).thenReturn(telemetryServiceMock); |
||||
|
doAnswer(invocation -> { |
||||
|
FutureCallback<Void> callback = invocation.getArgument(4); |
||||
|
callback.onSuccess(null); |
||||
|
return null; |
||||
|
}).when(telemetryServiceMock).saveAndNotify(any(), any(), any(AttributeScope.class), anyList(), any(FutureCallback.class)); |
||||
|
TbMsg newMsg = TbMsg.newMsg(msg, msg.getQueueName(), msg.getRuleChainId(), msg.getRuleNodeId()); |
||||
|
// TODO: use newMsg() with any(TbMsgType.class), replace in other tests as well.
|
||||
|
doAnswer(invocation -> newMsg).when(ctxMock).newMsg(any(), any(String.class), any(), any(), any(), any()); |
||||
|
|
||||
|
node.onMsg(ctxMock, msg); |
||||
|
|
||||
|
verify(entityViewServiceMock).findEntityViewsByTenantIdAndEntityIdAsync(eq(TENANT_ID), eq(DEVICE_ID)); |
||||
|
ArgumentCaptor<List<AttributeKvEntry>> filteredAttributesCaptor = ArgumentCaptor.forClass(List.class); |
||||
|
verify(telemetryServiceMock).saveAndNotify(eq(TENANT_ID), eq(ENTITY_VIEW_ID), eq(AttributeScope.CLIENT_SCOPE), |
||||
|
filteredAttributesCaptor.capture(), any(FutureCallback.class)); |
||||
|
List<AttributeKvEntry> filteredAttributesCaptorValue = filteredAttributesCaptor.getValue(); |
||||
|
assertThat(filteredAttributesCaptorValue.size()).isEqualTo(1); |
||||
|
assertThat(filteredAttributesCaptorValue.get(0).getKey()).isEqualTo("clientAttribute1"); |
||||
|
assertThat(filteredAttributesCaptorValue.get(0).getValue()).isEqualTo(100L); |
||||
|
verify(ctxMock).ack(eq(msg)); |
||||
|
verify(ctxMock).enqueueForTellNext(eq(newMsg), eq(TbNodeConnectionType.SUCCESS)); |
||||
|
verifyNoMoreInteractions(ctxMock, entityViewServiceMock, telemetryServiceMock); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
public void givenExistingServerAttributesAndMsgTypeAttributesDeleted_whenOnMsg_thenDeleteAttributesFromView() { |
||||
|
EntityView entityView = getEntityView(SERVER_TELEMETRY_ENTITY_VIEW); |
||||
|
|
||||
|
TbMsg msg = TbMsg.newMsg( |
||||
|
ATTRIBUTES_DELETED, DEVICE_ID, new TbMsgMetaData(Map.of(DataConstants.SCOPE, AttributeScope.SERVER_SCOPE.name())), |
||||
|
"{\"attributes\": [\"serverAttribute1\"]}"); |
||||
|
|
||||
|
mockEntityViewLookup(entityView); |
||||
|
when(ctxMock.getTelemetryService()).thenReturn(telemetryServiceMock); |
||||
|
doAnswer(invocation -> { |
||||
|
FutureCallback<Void> callback = invocation.getArgument(4); |
||||
|
callback.onSuccess(null); |
||||
|
return null; |
||||
|
}).when(telemetryServiceMock).deleteAndNotify(any(), any(), any(AttributeScope.class), anyList(), any(FutureCallback.class)); |
||||
|
TbMsg newMsg = TbMsg.newMsg(msg, msg.getQueueName(), msg.getRuleChainId(), msg.getRuleNodeId()); |
||||
|
doAnswer(invocation -> newMsg).when(ctxMock).newMsg(any(), any(String.class), any(), any(), any(), any()); |
||||
|
|
||||
|
node.onMsg(ctxMock, msg); |
||||
|
|
||||
|
verify(entityViewServiceMock).findEntityViewsByTenantIdAndEntityIdAsync(eq(TENANT_ID), eq(DEVICE_ID)); |
||||
|
ArgumentCaptor<List<String>> filteredAttributesCaptor = ArgumentCaptor.forClass(List.class); |
||||
|
verify(telemetryServiceMock).deleteAndNotify(eq(TENANT_ID), eq(ENTITY_VIEW_ID), eq(AttributeScope.SERVER_SCOPE), filteredAttributesCaptor.capture(), any(FutureCallback.class)); |
||||
|
List<String> filteredAttributesCaptorValue = filteredAttributesCaptor.getValue(); |
||||
|
assertThat(filteredAttributesCaptorValue.size()).isEqualTo(1); |
||||
|
assertThat(filteredAttributesCaptorValue.get(0)).isEqualTo("serverAttribute1"); |
||||
|
verify(ctxMock).ack(eq(msg)); |
||||
|
verify(ctxMock).enqueueForTellNext(eq(newMsg), eq(TbNodeConnectionType.SUCCESS)); |
||||
|
verifyNoMoreInteractions(ctxMock, entityViewServiceMock, telemetryServiceMock); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
public void givenNonMatchedSharedAttributesAndMsgTypeIsAttributesDeleted_whenOnMsg_thenNoAttributesDeleteFromView() { |
||||
|
EntityView entityView = getEntityView(SHARED_TELEMETRY_ENTITY_VIEW); |
||||
|
|
||||
|
TbMsg msg = TbMsg.newMsg( |
||||
|
TbMsgType.ATTRIBUTES_DELETED, DEVICE_ID, new TbMsgMetaData(Map.of(DataConstants.SCOPE, AttributeScope.SHARED_SCOPE.name())), |
||||
|
"{\"attributes\": [\"anotherAttribute\"]}"); |
||||
|
|
||||
|
mockEntityViewLookup(entityView); |
||||
|
|
||||
|
node.onMsg(ctxMock, msg); |
||||
|
|
||||
|
verify(entityViewServiceMock).findEntityViewsByTenantIdAndEntityIdAsync(eq(TENANT_ID), eq(DEVICE_ID)); |
||||
|
verify(ctxMock).ack(eq(msg)); |
||||
|
verifyNoMoreInteractions(ctxMock, entityViewServiceMock); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
public void givenNonMatchedAttributesAndMsgTypeIsPostAttributesRequest_whenOnMsg_thenCopyNoAttributesToView() { |
||||
|
EntityView entityView = getEntityView(CLIENT_TELEMETRY_ENTITY_VIEW); |
||||
|
|
||||
|
TbMsg msg = TbMsg.newMsg( |
||||
|
TbMsgType.POST_ATTRIBUTES_REQUEST, DEVICE_ID, new TbMsgMetaData(Map.of(DataConstants.SCOPE, AttributeScope.SERVER_SCOPE.name())), |
||||
|
"{\"clientAttribute2\": \"value2\"}"); |
||||
|
|
||||
|
mockEntityViewLookup(entityView); |
||||
|
when(ctxMock.getTelemetryService()).thenReturn(telemetryServiceMock); |
||||
|
doAnswer(invocation -> { |
||||
|
FutureCallback<Void> callback = invocation.getArgument(4); |
||||
|
callback.onSuccess(null); |
||||
|
return null; |
||||
|
}).when(telemetryServiceMock).saveAndNotify(any(), any(), any(AttributeScope.class), anyList(), any(FutureCallback.class)); |
||||
|
TbMsg newMsg = TbMsg.newMsg(msg, msg.getQueueName(), msg.getRuleChainId(), msg.getRuleNodeId()); |
||||
|
doAnswer(invocation -> newMsg).when(ctxMock).newMsg(any(), any(String.class), any(), any(), any(), any()); |
||||
|
|
||||
|
node.onMsg(ctxMock, msg); |
||||
|
|
||||
|
verify(entityViewServiceMock).findEntityViewsByTenantIdAndEntityIdAsync(eq(TENANT_ID), eq(DEVICE_ID)); |
||||
|
verify(telemetryServiceMock).saveAndNotify(eq(TENANT_ID), eq(ENTITY_VIEW_ID), eq(AttributeScope.CLIENT_SCOPE), eq(Collections.emptyList()), any(FutureCallback.class)); |
||||
|
verify(ctxMock).ack(eq(msg)); |
||||
|
verify(ctxMock).enqueueForTellNext(eq(newMsg), eq(TbNodeConnectionType.SUCCESS)); |
||||
|
verifyNoMoreInteractions(ctxMock, entityViewServiceMock, telemetryServiceMock); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
public void givenAttributesValidityPeriodOutOfStartDateAndEndDate_whenOnMsg_thenDoNothing() { |
||||
|
EntityView entityView = getEntityView( |
||||
|
SERVER_TELEMETRY_ENTITY_VIEW, |
||||
|
Instant.now().minus(2, ChronoUnit.DAYS).toEpochMilli(), |
||||
|
Instant.now().minus(1, ChronoUnit.DAYS).toEpochMilli() |
||||
|
); |
||||
|
mockEntityViewLookup(entityView); |
||||
|
|
||||
|
TbMsg msg = TbMsg.newMsg( |
||||
|
ATTRIBUTES_DELETED, DEVICE_ID, new TbMsgMetaData(Map.of(DataConstants.SCOPE, AttributeScope.SERVER_SCOPE.name())), |
||||
|
"{\"attributes\": [\"serverAttribute1\"]}"); |
||||
|
node.onMsg(ctxMock, msg); |
||||
|
|
||||
|
verify(entityViewServiceMock).findEntityViewsByTenantIdAndEntityIdAsync(eq(TENANT_ID), eq(DEVICE_ID)); |
||||
|
verify(ctxMock).ack(eq(msg)); |
||||
|
verifyNoMoreInteractions(ctxMock, entityViewServiceMock); |
||||
|
} |
||||
|
|
||||
|
@ParameterizedTest |
||||
|
@EnumSource(TbMsgType.class) |
||||
|
public void givenMsgTypeAndEmptyMetadata_whenOnMsg_thenVerifyFailureMsg(TbMsgType msgType) { |
||||
|
TbMsg msg = TbMsg.newMsg(msgType, DEVICE_ID, TbMsgMetaData.EMPTY, TbMsg.EMPTY_JSON_OBJECT); |
||||
|
|
||||
|
node.onMsg(ctxMock, msg); |
||||
|
|
||||
|
ArgumentCaptor<Throwable> throwableCaptor = ArgumentCaptor.forClass(Throwable.class); |
||||
|
verify(ctxMock).tellFailure(eq(msg), throwableCaptor.capture()); |
||||
|
|
||||
|
if (msg.isTypeOneOf(ATTRIBUTES_UPDATED, ATTRIBUTES_DELETED, |
||||
|
ACTIVITY_EVENT, INACTIVITY_EVENT, POST_ATTRIBUTES_REQUEST)) { |
||||
|
assertThat(throwableCaptor.getValue()).isInstanceOf(IllegalArgumentException.class) |
||||
|
.hasMessage("Message metadata is empty"); |
||||
|
return; |
||||
|
} |
||||
|
assertThat(throwableCaptor.getValue()).isInstanceOf(IllegalArgumentException.class) |
||||
|
.hasMessage("Unsupported msg type [" + msgType + "]"); |
||||
|
|
||||
|
verifyNoMoreInteractions(ctxMock); |
||||
|
} |
||||
|
|
||||
|
private EntityView getEntityView(TelemetryEntityView attributesEntityView, long startTimeMs, long endTimeMs) { |
||||
|
EntityView entityView = new EntityView(ENTITY_VIEW_ID); |
||||
|
entityView.setStartTimeMs(startTimeMs); |
||||
|
entityView.setEndTimeMs(endTimeMs); |
||||
|
entityView.setKeys(attributesEntityView); |
||||
|
return entityView; |
||||
|
} |
||||
|
|
||||
|
private EntityView getEntityView(TelemetryEntityView attributesEntityView) { |
||||
|
return getEntityView(attributesEntityView, ENTITY_VIEW_START_TS, ENTITY_VIEW_END_TS); |
||||
|
} |
||||
|
|
||||
|
private void mockEntityViewLookup(EntityView entityView) { |
||||
|
when(ctxMock.getEntityViewService()).thenReturn(entityViewServiceMock); |
||||
|
when(ctxMock.getTenantId()).thenReturn(TENANT_ID); |
||||
|
when(entityViewServiceMock.findEntityViewsByTenantIdAndEntityIdAsync(any(), any())) |
||||
|
.thenReturn(Futures.immediateFuture(List.of(entityView))); |
||||
|
} |
||||
|
} |
||||
Loading…
Reference in new issue