git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2024 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.mqtt.homeassistant.internal.component;
  14
  15 import static org.hamcrest.CoreMatchers.*;
  16 import static org.hamcrest.MatcherAssert.assertThat;
  17 import static org.mockito.ArgumentMatchers.*;
  18 import static org.mockito.ArgumentMatchers.any;
  19 import static org.mockito.Mockito.*;
  20
  21 import java.nio.charset.StandardCharsets;
  22 import java.util.List;
  23 import java.util.Objects;
  24 import java.util.Set;
  25 import java.util.concurrent.CountDownLatch;
  26 import java.util.concurrent.TimeUnit;
  27
  28 import org.eclipse.jdt.annotation.NonNull;
  29 import org.eclipse.jdt.annotation.NonNullByDefault;
  30 import org.eclipse.jdt.annotation.Nullable;
  31 import org.junit.jupiter.api.AfterEach;
  32 import org.junit.jupiter.api.BeforeEach;
  33 import org.mockito.ArgumentMatchers;
  34 import org.mockito.Mock;
  35 import org.openhab.binding.mqtt.generic.MqttChannelStateDescriptionProvider;
  36 import org.openhab.binding.mqtt.generic.MqttChannelTypeProvider;
  37 import org.openhab.binding.mqtt.generic.values.Value;
  38 import org.openhab.binding.mqtt.homeassistant.internal.AbstractHomeAssistantTests;
  39 import org.openhab.binding.mqtt.homeassistant.internal.ComponentChannel;
  40 import org.openhab.binding.mqtt.homeassistant.internal.HaID;
  41 import org.openhab.binding.mqtt.homeassistant.internal.HandlerConfiguration;
  42 import org.openhab.binding.mqtt.homeassistant.internal.config.dto.AbstractChannelConfiguration;
  43 import org.openhab.binding.mqtt.homeassistant.internal.handler.HomeAssistantThingHandler;
  44 import org.openhab.core.library.types.HSBType;
  45 import org.openhab.core.thing.Thing;
  46 import org.openhab.core.thing.ThingStatusInfo;
  47 import org.openhab.core.thing.binding.ThingHandlerCallback;
  48 import org.openhab.core.thing.type.ChannelTypeRegistry;
  49 import org.openhab.core.types.Command;
  50 import org.openhab.core.types.State;
  51
  52 import com.hubspot.jinjava.Jinjava;
  53
  54 /**
  55  * Abstract class for components tests.
  56  *
  57  * @author Anton Kharuzhy - Initial contribution
  58  */
  59 @NonNullByDefault
  60 public abstract class AbstractComponentTests extends AbstractHomeAssistantTests {
  61     private static final int SUBSCRIBE_TIMEOUT = 10000;
  62     private static final int ATTRIBUTE_RECEIVE_TIMEOUT = 2000;
  63
  64     private @Mock @NonNullByDefault({}) ThingHandlerCallback callbackMock;
  65     private @NonNullByDefault({}) LatchThingHandler thingHandler;
  66
  67     @BeforeEach
  68     public void setupThingHandler() {
  69         final var config = haThing.getConfiguration();
  70
  71         config.put(HandlerConfiguration.PROPERTY_BASETOPIC, HandlerConfiguration.DEFAULT_BASETOPIC);
  72         config.put(HandlerConfiguration.PROPERTY_TOPICS, getConfigTopics());
  73
  74         // Plumb thing status updates through
  75         doAnswer(invocation -> {
  76             ((Thing) invocation.getArgument(0)).setStatusInfo((ThingStatusInfo) invocation.getArgument(1));
  77             return null;
  78         }).when(callbackMock).statusUpdated(any(Thing.class), any(ThingStatusInfo.class));
  79
  80         when(callbackMock.getBridge(eq(BRIDGE_UID))).thenReturn(bridgeThing);
  81
  82         thingHandler = new LatchThingHandler(haThing, channelTypeProvider, stateDescriptionProvider,
  83                 channelTypeRegistry, SUBSCRIBE_TIMEOUT, ATTRIBUTE_RECEIVE_TIMEOUT);
  84         thingHandler.setConnection(bridgeConnection);
  85         thingHandler.setCallback(callbackMock);
  86         thingHandler = spy(thingHandler);
  87
  88         thingHandler.initialize();
  89     }
  90
  91     @AfterEach
  92     public void disposeThingHandler() {
  93         thingHandler.dispose();
  94     }
  95
  96     /**
  97      * {@link org.openhab.binding.mqtt.homeassistant.internal.DiscoverComponents} will wait a config on specified
  98      * topics.
  99      * Topics in config must be without prefix and suffix, they can be converted to full with method
 100      * {@link #configTopicToMqtt(String)}
 101      *
 102      * @return config topics
 103      */
 104     protected abstract Set<String> getConfigTopics();
 105
 106     /**
 107      * Process payload to discover and configure component. Topic should be added to {@link #getConfigTopics()}
 108      *
 109      * @param mqttTopic mqtt topic with configuration
 110      * @param json configuration payload in Json
 111      * @return discovered component
 112      */
 113     protected AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> discoverComponent(String mqttTopic,
 114             String json) {
 115         return discoverComponent(mqttTopic, json.getBytes(StandardCharsets.UTF_8));
 116     }
 117
 118     /**
 119      * Process payload to discover and configure component. Topic should be added to {@link #getConfigTopics()}
 120      *
 121      * @param mqttTopic mqtt topic with configuration
 122      * @param jsonPayload configuration payload in Json
 123      * @return discovered component
 124      */
 125     protected AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> discoverComponent(String mqttTopic,
 126             byte[] jsonPayload) {
 127         var latch = thingHandler.createWaitForComponentDiscoveredLatch(1);
 128         assertThat(publishMessage(mqttTopic, jsonPayload), is(true));
 129         try {
 130             assert latch.await(1, TimeUnit.SECONDS);
 131         } catch (InterruptedException e) {
 132             assertThat(e.getMessage(), false);
 133         }
 134         return Objects.requireNonNull(thingHandler.getDiscoveredComponent());
 135     }
 136
 137     /**
 138      * Assert channel topics, label and value class
 139      *
 140      * @param component component
 141      * @param channelId channel
 142      * @param stateTopic state topic or empty string
 143      * @param commandTopic command topic or empty string
 144      * @param label label
 145      * @param valueClass value class
 146      */
 147     protected static void assertChannel(AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> component,
 148             String channelId, String stateTopic, String commandTopic, String label, Class<? extends Value> valueClass) {
 149         var stateChannel = Objects.requireNonNull(component.getChannel(channelId));
 150         assertChannel(stateChannel, stateTopic, commandTopic, label, valueClass);
 151     }
 152
 153     /**
 154      * Assert channel topics, label and value class
 155      *
 156      * @param stateChannel channel
 157      * @param stateTopic state topic or empty string
 158      * @param commandTopic command topic or empty string
 159      * @param label label
 160      * @param valueClass value class
 161      */
 162     protected static void assertChannel(ComponentChannel stateChannel, String stateTopic, String commandTopic,
 163             String label, Class<? extends Value> valueClass) {
 164         assertThat(stateChannel.getChannel().getLabel(), is(label));
 165         assertThat(stateChannel.getState().getStateTopic(), is(stateTopic));
 166         assertThat(stateChannel.getState().getCommandTopic(), is(commandTopic));
 167         assertThat(stateChannel.getState().getCache(), is(instanceOf(valueClass)));
 168     }
 169
 170     /**
 171      * Assert channel state
 172      *
 173      * @param component component
 174      * @param channelId channel
 175      * @param state expected state
 176      */
 177     @SuppressWarnings("null")
 178     protected static void assertState(AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> component,
 179             String channelId, State state) {
 180         State actualState = component.getChannel(channelId).getState().getCache().getChannelState();
 181         if ((actualState instanceof HSBType actualHsb) && (state instanceof HSBType stateHsb)) {
 182             assertThat(actualHsb.closeTo(stateHsb, 0.01), is(true));
 183         } else {
 184             assertThat(actualState, is(state));
 185         }
 186     }
 187
 188     protected void spyOnChannelUpdates(AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> component,
 189             String channelId) {
 190         // It's already thingHandler, but not the spy version
 191         component.getChannel(channelId).getState().setChannelStateUpdateListener(thingHandler);
 192     }
 193
 194     /**
 195      * Assert a channel triggers
 196      */
 197     protected void assertTriggered(AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> component,
 198             String channelId, String trigger) {
 199         verify(thingHandler).triggerChannel(eq(component.getChannel(channelId).getChannel().getUID()), eq(trigger));
 200     }
 201
 202     /**
 203      * Assert that given payload was published exact-once on given topic.
 204      *
 205      * @param mqttTopic Mqtt topic
 206      * @param payload payload
 207      */
 208     protected void assertPublished(String mqttTopic, String payload) {
 209         verify(bridgeConnection).publish(eq(mqttTopic), ArgumentMatchers.eq(payload.getBytes(StandardCharsets.UTF_8)),
 210                 anyInt(), anyBoolean());
 211     }
 212
 213     /**
 214      * Assert that given payload was published N times on given topic.
 215      *
 216      * @param mqttTopic Mqtt topic
 217      * @param payload payload
 218      * @param t payload must be published N times on given topic
 219      */
 220     protected void assertPublished(String mqttTopic, String payload, int t) {
 221         verify(bridgeConnection, times(t)).publish(eq(mqttTopic),
 222                 ArgumentMatchers.eq(payload.getBytes(StandardCharsets.UTF_8)), anyInt(), anyBoolean());
 223     }
 224
 225     /**
 226      * Assert that given payload was not published on given topic.
 227      *
 228      * @param mqttTopic Mqtt topic
 229      * @param payload payload
 230      */
 231     protected void assertNotPublished(String mqttTopic, String payload) {
 232         verify(bridgeConnection, never()).publish(eq(mqttTopic),
 233                 ArgumentMatchers.eq(payload.getBytes(StandardCharsets.UTF_8)), anyInt(), anyBoolean());
 234     }
 235
 236     /**
 237      * Assert that nothing was published on given topic.
 238      *
 239      * @param mqttTopic Mqtt topic
 240      */
 241     protected void assertNothingPublished(String mqttTopic) {
 242         verify(bridgeConnection, never()).publish(eq(mqttTopic), any(), anyInt(), anyBoolean());
 243     }
 244
 245     /**
 246      * Publish payload to all subscribers on specified topic.
 247      *
 248      * @param mqttTopic Mqtt topic
 249      * @param payload payload
 250      * @return true when at least one subscriber found
 251      */
 252     protected boolean publishMessage(String mqttTopic, String payload) {
 253         return publishMessage(mqttTopic, payload.getBytes(StandardCharsets.UTF_8));
 254     }
 255
 256     /**
 257      * Publish payload to all subscribers on specified topic.
 258      *
 259      * @param mqttTopic Mqtt topic
 260      * @param payload payload
 261      * @return true when at least one subscriber found
 262      */
 263     protected boolean publishMessage(String mqttTopic, byte[] payload) {
 264         final var topicSubscribers = subscriptions.get(mqttTopic);
 265
 266         if (topicSubscribers != null && !topicSubscribers.isEmpty()) {
 267             topicSubscribers.forEach(mqttMessageSubscriber -> mqttMessageSubscriber.processMessage(mqttTopic, payload));
 268             return true;
 269         }
 270         return false;
 271     }
 272
 273     /**
 274      * Send command to a thing's channel
 275      *
 276      * @param component component
 277      * @param channelId channel
 278      * @param command command to send
 279      */
 280     protected void sendCommand(AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> component,
 281             String channelId, Command command) {
 282         var channel = Objects.requireNonNull(component.getChannel(channelId));
 283         thingHandler.handleCommand(channel.getChannel().getUID(), command);
 284     }
 285
 286     protected static class LatchThingHandler extends HomeAssistantThingHandler {
 287         private @Nullable CountDownLatch latch;
 288         private @Nullable AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> discoveredComponent;
 289
 290         public LatchThingHandler(Thing thing, MqttChannelTypeProvider channelTypeProvider,
 291                 MqttChannelStateDescriptionProvider stateDescriptionProvider, ChannelTypeRegistry channelTypeRegistry,
 292                 int subscribeTimeout, int attributeReceiveTimeout) {
 293             super(thing, channelTypeProvider, stateDescriptionProvider, channelTypeRegistry, new Jinjava(),
 294                     subscribeTimeout, attributeReceiveTimeout);
 295         }
 296
 297         @Override
 298         public void componentDiscovered(HaID homeAssistantTopicID, AbstractComponent<@NonNull ?> component) {
 299             accept(List.of(component));
 300             discoveredComponent = component;
 301             if (latch != null) {
 302                 latch.countDown();
 303             }
 304         }
 305
 306         public CountDownLatch createWaitForComponentDiscoveredLatch(int count) {
 307             final var newLatch = new CountDownLatch(count);
 308             latch = newLatch;
 309             return newLatch;
 310         }
 311
 312         public @Nullable AbstractComponent<@NonNull ? extends AbstractChannelConfiguration> getDiscoveredComponent() {
 313             return discoveredComponent;
 314         }
 315     }
 316 }