dshvaika
12 months ago
5 changed files with 562 additions and 7 deletions
@ -0,0 +1,143 @@ |
|||||
|
/** |
||||
|
* Copyright © 2016-2025 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.server.service.cf.ctx.state; |
||||
|
|
||||
|
import org.junit.jupiter.api.BeforeEach; |
||||
|
import org.junit.jupiter.api.Test; |
||||
|
import org.thingsboard.script.api.tbel.TbelCfArg; |
||||
|
import org.thingsboard.script.api.tbel.TbelCfPropagationArg; |
||||
|
import org.thingsboard.server.common.data.id.AssetId; |
||||
|
import org.thingsboard.server.common.data.id.EntityId; |
||||
|
import org.thingsboard.server.service.cf.ctx.state.propagation.PropagationArgumentEntry; |
||||
|
|
||||
|
import java.util.ArrayList; |
||||
|
import java.util.List; |
||||
|
import java.util.UUID; |
||||
|
|
||||
|
import static org.assertj.core.api.Assertions.assertThat; |
||||
|
import static org.assertj.core.api.Assertions.assertThatThrownBy; |
||||
|
|
||||
|
public class PropagationArgumentEntryTest { |
||||
|
|
||||
|
private final AssetId ENTITY_1_ID = new AssetId(UUID.fromString("b0a8637d-6d67-43d5-a483-c0e391afe805")); |
||||
|
private final AssetId ENTITY_2_ID = new AssetId(UUID.fromString("7bd85073-ded5-414f-a2ef-bd56ad3dbf6a")); |
||||
|
private final AssetId ENTITY_3_ID = new AssetId(UUID.fromString("d64f3e51-2ec2-472f-b475-b095ef8bdc70")); |
||||
|
|
||||
|
private PropagationArgumentEntry entry; |
||||
|
|
||||
|
@BeforeEach |
||||
|
void setUp() { |
||||
|
List<EntityId> propagationEntityIds = new ArrayList<>(); |
||||
|
propagationEntityIds.add(ENTITY_1_ID); |
||||
|
propagationEntityIds.add(ENTITY_2_ID); |
||||
|
entry = new PropagationArgumentEntry(propagationEntityIds); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testArgumentEntryType() { |
||||
|
assertThat(entry.getType()).isEqualTo(ArgumentEntryType.PROPAGATION); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testIsEmpty() { |
||||
|
PropagationArgumentEntry emptyEntry = new PropagationArgumentEntry(List.of()); |
||||
|
assertThat(emptyEntry.isEmpty()).isTrue(); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testIsEmptyWhenNullList() { |
||||
|
PropagationArgumentEntry nullListEntry = new PropagationArgumentEntry(null); |
||||
|
assertThat(nullListEntry.isEmpty()).isTrue(); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testGetValueReturnsPropagationIds() { |
||||
|
assertThat(entry.getValue()).isInstanceOf(List.class); |
||||
|
@SuppressWarnings("unchecked") |
||||
|
List<AssetId> value = (List<AssetId>) entry.getValue(); |
||||
|
assertThat(value).containsExactly(ENTITY_1_ID, ENTITY_2_ID); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testUpdateEntryWhenSingleEntryPassed() { |
||||
|
assertThatThrownBy(() -> entry.updateEntry(new SingleValueArgumentEntry())) |
||||
|
.isInstanceOf(IllegalArgumentException.class) |
||||
|
.hasMessage("Unsupported argument entry type for propagation argument entry: SINGLE_VALUE"); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testUpdateEntryWhenRollingEntryPassed() { |
||||
|
assertThatThrownBy(() -> entry.updateEntry(new TsRollingArgumentEntry(5, 30000L))) |
||||
|
.isInstanceOf(IllegalArgumentException.class) |
||||
|
.hasMessage("Unsupported argument entry type for propagation argument entry: TS_ROLLING"); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testUpdateEntryReplacesWithNewIds() { |
||||
|
var newIds = new ArrayList<EntityId>(List.of(ENTITY_3_ID, ENTITY_1_ID)); |
||||
|
var updated = new PropagationArgumentEntry(newIds); |
||||
|
|
||||
|
boolean changed = entry.updateEntry(updated); |
||||
|
|
||||
|
assertThat(changed).isTrue(); |
||||
|
assertThat(entry.getPropagationEntityIds()).containsExactlyElementsOf(newIds); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testUpdateEntryClearsWhenNewEntryIsEmpty() { |
||||
|
var updatedEmpty = new PropagationArgumentEntry(List.of()); |
||||
|
|
||||
|
boolean changed = entry.updateEntry(updatedEmpty); |
||||
|
|
||||
|
assertThat(changed).isTrue(); |
||||
|
assertThat(entry.getPropagationEntityIds()).isEmpty(); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testUpdateEntryClearsWhenNewEntryIsNullList() { |
||||
|
var updatedNull = new PropagationArgumentEntry(null); |
||||
|
|
||||
|
boolean changed = entry.updateEntry(updatedNull); |
||||
|
|
||||
|
assertThat(changed).isTrue(); |
||||
|
assertThat(entry.getPropagationEntityIds()).isEmpty(); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
@SuppressWarnings("unchecked") |
||||
|
void testToTbelCfArgWithValues() { |
||||
|
TbelCfArg arg = entry.toTbelCfArg(); |
||||
|
assertThat(arg).isInstanceOf(TbelCfPropagationArg.class); |
||||
|
|
||||
|
TbelCfPropagationArg tbelCfPropagationArg = (TbelCfPropagationArg) arg; |
||||
|
assertThat(tbelCfPropagationArg.getValue()).isInstanceOf(List.class); |
||||
|
assertThat((List<EntityId>) tbelCfPropagationArg.getValue()).containsExactly(ENTITY_1_ID, ENTITY_2_ID); |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@Test |
||||
|
@SuppressWarnings("unchecked") |
||||
|
void testToTbelCfArgWithEmptyValues() { |
||||
|
var empty = new PropagationArgumentEntry(List.of()); |
||||
|
TbelCfArg emptyArg = empty.toTbelCfArg(); |
||||
|
assertThat(emptyArg).isInstanceOf(TbelCfPropagationArg.class); |
||||
|
|
||||
|
TbelCfPropagationArg tbelCfPropagationArg = (TbelCfPropagationArg) emptyArg; |
||||
|
assertThat(tbelCfPropagationArg.getValue()).isInstanceOf(List.class); |
||||
|
assertThat((List<EntityId>) tbelCfPropagationArg.getValue()).isEmpty(); |
||||
|
} |
||||
|
|
||||
|
} |
||||
@ -0,0 +1,246 @@ |
|||||
|
/** |
||||
|
* Copyright © 2016-2025 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.server.service.cf.ctx.state; |
||||
|
|
||||
|
import com.fasterxml.jackson.databind.node.ObjectNode; |
||||
|
import io.micrometer.core.instrument.simple.SimpleMeterRegistry; |
||||
|
import org.junit.jupiter.api.BeforeEach; |
||||
|
import org.junit.jupiter.api.Test; |
||||
|
import org.springframework.beans.factory.annotation.Autowired; |
||||
|
import org.springframework.boot.test.context.SpringBootTest; |
||||
|
import org.springframework.test.context.bean.override.mockito.MockitoBean; |
||||
|
import org.thingsboard.common.util.JacksonUtil; |
||||
|
import org.thingsboard.script.api.tbel.DefaultTbelInvokeService; |
||||
|
import org.thingsboard.script.api.tbel.TbelInvokeService; |
||||
|
import org.thingsboard.server.actors.ActorSystemContext; |
||||
|
import org.thingsboard.server.common.data.AttributeScope; |
||||
|
import org.thingsboard.server.common.data.cf.CalculatedField; |
||||
|
import org.thingsboard.server.common.data.cf.CalculatedFieldType; |
||||
|
import org.thingsboard.server.common.data.cf.configuration.Argument; |
||||
|
import org.thingsboard.server.common.data.cf.configuration.ArgumentType; |
||||
|
import org.thingsboard.server.common.data.cf.configuration.CalculatedFieldConfiguration; |
||||
|
import org.thingsboard.server.common.data.cf.configuration.Output; |
||||
|
import org.thingsboard.server.common.data.cf.configuration.OutputType; |
||||
|
import org.thingsboard.server.common.data.cf.configuration.PropagationCalculatedFieldConfiguration; |
||||
|
import org.thingsboard.server.common.data.cf.configuration.ReferencedEntityKey; |
||||
|
import org.thingsboard.server.common.data.id.AssetId; |
||||
|
import org.thingsboard.server.common.data.id.DeviceId; |
||||
|
import org.thingsboard.server.common.data.id.TenantId; |
||||
|
import org.thingsboard.server.common.data.kv.DoubleDataEntry; |
||||
|
import org.thingsboard.server.common.data.relation.EntityRelation; |
||||
|
import org.thingsboard.server.common.data.relation.EntitySearchDirection; |
||||
|
import org.thingsboard.server.common.stats.DefaultStatsFactory; |
||||
|
import org.thingsboard.server.dao.usagerecord.ApiLimitService; |
||||
|
import org.thingsboard.server.service.cf.PropagationCalculatedFieldResult; |
||||
|
import org.thingsboard.server.service.cf.TelemetryCalculatedFieldResult; |
||||
|
import org.thingsboard.server.service.cf.ctx.state.propagation.PropagationArgumentEntry; |
||||
|
import org.thingsboard.server.service.cf.ctx.state.propagation.PropagationCalculatedFieldState; |
||||
|
|
||||
|
import java.util.ArrayList; |
||||
|
import java.util.Collections; |
||||
|
import java.util.List; |
||||
|
import java.util.Map; |
||||
|
import java.util.UUID; |
||||
|
import java.util.concurrent.ExecutionException; |
||||
|
|
||||
|
import static org.assertj.core.api.Assertions.assertThat; |
||||
|
import static org.mockito.ArgumentMatchers.any; |
||||
|
import static org.mockito.Mockito.when; |
||||
|
import static org.thingsboard.server.common.data.cf.configuration.PropagationCalculatedFieldConfiguration.PROPAGATION_CONFIG_ARGUMENT; |
||||
|
|
||||
|
@SpringBootTest(classes = {SimpleMeterRegistry.class, DefaultStatsFactory.class, DefaultTbelInvokeService.class}) |
||||
|
public class PropagationCalculatedFieldStateTest { |
||||
|
|
||||
|
private static final String TEMPERATURE_ARGUMENT_NAME = "t"; |
||||
|
private static final String TEST_RESULT_EXPRESSION_KEY = "testResult"; |
||||
|
private static final double TEMPERATURE_VALUE = 12.5; |
||||
|
|
||||
|
private final TenantId TENANT_ID = TenantId.fromUUID(UUID.fromString("6c3513cb-85e7-4510-8746-1ba01859a8ce")); |
||||
|
private final DeviceId DEVICE_ID = new DeviceId(UUID.fromString("be960a50-c029-4698-b2ec-c56a543c561c")); |
||||
|
private final AssetId ASSET_ID_1 = new AssetId(UUID.fromString("d26f0e5b-7d7d-4a61-9f5e-08ab97b30734")); |
||||
|
private final AssetId ASSET_ID_2 = new AssetId(UUID.fromString("1933a317-4df5-4d36-9800-68aded74579b")); |
||||
|
|
||||
|
private final SingleValueArgumentEntry singleValueArgEntry = |
||||
|
new SingleValueArgumentEntry(System.currentTimeMillis(), new DoubleDataEntry("temperature", TEMPERATURE_VALUE), 99L); |
||||
|
|
||||
|
private final PropagationArgumentEntry propagationArgEntry = |
||||
|
new PropagationArgumentEntry(new ArrayList<>(List.of(ASSET_ID_2, ASSET_ID_1))); |
||||
|
|
||||
|
private PropagationCalculatedFieldState state; |
||||
|
private CalculatedFieldCtx ctx; |
||||
|
|
||||
|
@Autowired |
||||
|
private TbelInvokeService tbelInvokeService; |
||||
|
|
||||
|
@MockitoBean |
||||
|
private ApiLimitService apiLimitService; |
||||
|
|
||||
|
@MockitoBean |
||||
|
private ActorSystemContext actorSystemContext; |
||||
|
|
||||
|
@BeforeEach |
||||
|
void setUp() { |
||||
|
when(actorSystemContext.getTbelInvokeService()).thenReturn(tbelInvokeService); |
||||
|
when(actorSystemContext.getApiLimitService()).thenReturn(apiLimitService); |
||||
|
when(apiLimitService.getLimit(any(), any())).thenReturn(1000L); |
||||
|
} |
||||
|
|
||||
|
void initCtxAndState(boolean applyExpressionToResolvedArguments) { |
||||
|
ctx = new CalculatedFieldCtx(getCalculatedField(applyExpressionToResolvedArguments), actorSystemContext); |
||||
|
ctx.init(); |
||||
|
|
||||
|
state = new PropagationCalculatedFieldState(ctx.getEntityId()); |
||||
|
state.init(ctx); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testType() { |
||||
|
initCtxAndState(false); |
||||
|
assertThat(state.getType()).isEqualTo(CalculatedFieldType.PROPAGATION); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testInitAddsRequiredArgument() { |
||||
|
initCtxAndState(false); |
||||
|
assertThat(state.getRequiredArguments()).containsExactlyInAnyOrder(TEMPERATURE_ARGUMENT_NAME); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testIsReadyReturnFalseWhenNoArgumentsSet() { |
||||
|
initCtxAndState(false); |
||||
|
assertThat(state.isReady()).isFalse(); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testIsReadyWhenPropagationArgIsNull() { |
||||
|
initCtxAndState(false); |
||||
|
state.getArguments().put(TEMPERATURE_ARGUMENT_NAME, singleValueArgEntry); |
||||
|
assertThat(state.isReady()).isFalse(); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testIsReadyWhenPropagationArgIsEmpty() { |
||||
|
initCtxAndState(false); |
||||
|
state.getArguments().put(TEMPERATURE_ARGUMENT_NAME, singleValueArgEntry); |
||||
|
state.getArguments().put(PROPAGATION_CONFIG_ARGUMENT, new PropagationArgumentEntry(Collections.emptyList())); |
||||
|
assertThat(state.isReady()).isFalse(); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testIsReadyWhenPropagationArgHasEntities() { |
||||
|
initCtxAndState(false); |
||||
|
state.getArguments().put(TEMPERATURE_ARGUMENT_NAME, singleValueArgEntry); |
||||
|
state.getArguments().put(PROPAGATION_CONFIG_ARGUMENT, propagationArgEntry); |
||||
|
assertThat(state.isReady()).isTrue(); |
||||
|
} |
||||
|
|
||||
|
|
||||
|
@Test |
||||
|
void testPerformCalculationWithEmptyPropagationArg() throws Exception { |
||||
|
initCtxAndState(false); |
||||
|
state.getArguments().put(PROPAGATION_CONFIG_ARGUMENT, new PropagationArgumentEntry(Collections.emptyList())); |
||||
|
|
||||
|
PropagationCalculatedFieldResult result = performCalculation(); |
||||
|
|
||||
|
assertThat(result).isNotNull(); |
||||
|
assertThat(result.isEmpty()).isTrue(); |
||||
|
assertThat(result.getPropagationEntityIds()).isNullOrEmpty(); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testPerformCalculationWithArgumentsOnlyMode() throws Exception { |
||||
|
initCtxAndState(false); |
||||
|
state.getArguments().put(PROPAGATION_CONFIG_ARGUMENT, propagationArgEntry); |
||||
|
state.getArguments().put(TEMPERATURE_ARGUMENT_NAME, singleValueArgEntry); |
||||
|
|
||||
|
PropagationCalculatedFieldResult propagationResult = performCalculation(); |
||||
|
|
||||
|
assertThat(propagationResult).isNotNull(); |
||||
|
assertThat(propagationResult.isEmpty()).isFalse(); |
||||
|
assertThat(propagationResult.getPropagationEntityIds()).containsExactly(ASSET_ID_2, ASSET_ID_1); |
||||
|
|
||||
|
TelemetryCalculatedFieldResult result = propagationResult.getResult(); |
||||
|
assertThat(result).isNotNull(); |
||||
|
assertThat(result.getType()).isEqualTo(OutputType.ATTRIBUTES); |
||||
|
assertThat(result.getScope()).isEqualTo(AttributeScope.SERVER_SCOPE); |
||||
|
|
||||
|
ObjectNode expectedNode = JacksonUtil.newObjectNode(); |
||||
|
JacksonUtil.addKvEntry(expectedNode, singleValueArgEntry.getKvEntryValue()); |
||||
|
|
||||
|
assertThat(result.getResult()).isEqualTo(expectedNode); |
||||
|
} |
||||
|
|
||||
|
@Test |
||||
|
void testPerformCalculationWithExpressionResultMode() throws Exception { |
||||
|
initCtxAndState(true); |
||||
|
state.getArguments().put(PROPAGATION_CONFIG_ARGUMENT, propagationArgEntry); |
||||
|
state.getArguments().put(TEMPERATURE_ARGUMENT_NAME, singleValueArgEntry); |
||||
|
|
||||
|
PropagationCalculatedFieldResult propagationResult = performCalculation(); |
||||
|
|
||||
|
assertThat(propagationResult).isNotNull(); |
||||
|
assertThat(propagationResult.isEmpty()).isFalse(); |
||||
|
assertThat(propagationResult.getPropagationEntityIds()).containsExactly(ASSET_ID_2, ASSET_ID_1); |
||||
|
|
||||
|
TelemetryCalculatedFieldResult result = propagationResult.getResult(); |
||||
|
assertThat(result).isNotNull(); |
||||
|
assertThat(result.getType()).isEqualTo(OutputType.ATTRIBUTES); |
||||
|
assertThat(result.getScope()).isEqualTo(AttributeScope.SERVER_SCOPE); |
||||
|
|
||||
|
ObjectNode expectedNode = JacksonUtil.newObjectNode(); |
||||
|
expectedNode.put(TEST_RESULT_EXPRESSION_KEY, TEMPERATURE_VALUE * 2); |
||||
|
|
||||
|
assertThat(result.getResult()).isEqualTo(expectedNode); |
||||
|
} |
||||
|
|
||||
|
private CalculatedField getCalculatedField(boolean applyExpressionToResolvedArguments) { |
||||
|
CalculatedField calculatedField = new CalculatedField(); |
||||
|
calculatedField.setTenantId(TENANT_ID); |
||||
|
calculatedField.setEntityId(DEVICE_ID); |
||||
|
calculatedField.setType(CalculatedFieldType.PROPAGATION); |
||||
|
calculatedField.setName("Test Propagation CF"); |
||||
|
calculatedField.setConfigurationVersion(1); |
||||
|
calculatedField.setConfiguration(getCalculatedFieldConfig(applyExpressionToResolvedArguments)); |
||||
|
calculatedField.setVersion(1L); |
||||
|
return calculatedField; |
||||
|
} |
||||
|
|
||||
|
private CalculatedFieldConfiguration getCalculatedFieldConfig(boolean applyExpressionToResolvedArguments) { |
||||
|
var config = new PropagationCalculatedFieldConfiguration(); |
||||
|
|
||||
|
config.setDirection(EntitySearchDirection.TO); |
||||
|
config.setRelationType(EntityRelation.CONTAINS_TYPE); |
||||
|
config.setApplyExpressionToResolvedArguments(applyExpressionToResolvedArguments); |
||||
|
|
||||
|
Argument temperatureArg = new Argument(); |
||||
|
ReferencedEntityKey tempKey = new ReferencedEntityKey("temperature", ArgumentType.TS_LATEST, null); |
||||
|
temperatureArg.setRefEntityKey(tempKey); |
||||
|
|
||||
|
config.setArguments(Map.of(TEMPERATURE_ARGUMENT_NAME, temperatureArg)); |
||||
|
config.setExpression("{" + TEST_RESULT_EXPRESSION_KEY + ": " + TEMPERATURE_ARGUMENT_NAME + " * 2}"); |
||||
|
|
||||
|
Output output = new Output(); |
||||
|
output.setType(OutputType.ATTRIBUTES); |
||||
|
output.setScope(AttributeScope.SERVER_SCOPE); |
||||
|
config.setOutput(output); |
||||
|
|
||||
|
return config; |
||||
|
} |
||||
|
|
||||
|
private PropagationCalculatedFieldResult performCalculation() throws ExecutionException, InterruptedException { |
||||
|
return (PropagationCalculatedFieldResult) state.performCalculation(Collections.emptyMap(), ctx).get(); |
||||
|
} |
||||
|
} |
||||
Loading…
Reference in new issue