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

   1 /**
   2  * Copyright (c) 2010-2023 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;
  14
  15 import static org.hamcrest.CoreMatchers.is;
  16 import static org.hamcrest.MatcherAssert.assertThat;
  17 import static org.junit.jupiter.api.Assertions.*;
  18 import static org.mockito.ArgumentMatchers.any;
  19 import static org.mockito.Mockito.*;
  20
  21 import java.util.ArrayList;
  22 import java.util.Collections;
  23 import java.util.HashMap;
  24 import java.util.List;
  25 import java.util.Map;
  26 import java.util.concurrent.CompletableFuture;
  27 import java.util.concurrent.CountDownLatch;
  28 import java.util.concurrent.ScheduledExecutorService;
  29 import java.util.concurrent.ScheduledThreadPoolExecutor;
  30 import java.util.concurrent.TimeUnit;
  31
  32 import org.eclipse.jdt.annotation.NonNullByDefault;
  33 import org.eclipse.jdt.annotation.Nullable;
  34 import org.junit.jupiter.api.AfterEach;
  35 import org.junit.jupiter.api.BeforeEach;
  36 import org.junit.jupiter.api.Test;
  37 import org.junit.jupiter.api.extension.ExtendWith;
  38 import org.mockito.Mock;
  39 import org.mockito.junit.jupiter.MockitoExtension;
  40 import org.mockito.junit.jupiter.MockitoSettings;
  41 import org.mockito.quality.Strictness;
  42 import org.openhab.binding.mqtt.generic.AvailabilityTracker;
  43 import org.openhab.binding.mqtt.generic.ChannelStateUpdateListener;
  44 import org.openhab.binding.mqtt.generic.MqttChannelTypeProvider;
  45 import org.openhab.binding.mqtt.generic.TransformationServiceProvider;
  46 import org.openhab.binding.mqtt.homeassistant.internal.DiscoverComponents;
  47 import org.openhab.binding.mqtt.homeassistant.internal.DiscoverComponents.ComponentDiscovered;
  48 import org.openhab.binding.mqtt.homeassistant.internal.HaID;
  49 import org.openhab.binding.mqtt.homeassistant.internal.component.AbstractComponent;
  50 import org.openhab.binding.mqtt.homeassistant.internal.component.Switch;
  51 import org.openhab.binding.mqtt.homeassistant.internal.config.ChannelConfigurationTypeAdapterFactory;
  52 import org.openhab.core.io.transport.mqtt.MqttBrokerConnection;
  53 import org.openhab.core.io.transport.mqtt.MqttConnectionObserver;
  54 import org.openhab.core.io.transport.mqtt.MqttConnectionState;
  55 import org.openhab.core.library.types.OnOffType;
  56 import org.openhab.core.types.State;
  57 import org.openhab.core.types.UnDefType;
  58 import org.openhab.core.util.UIDUtils;
  59
  60 import com.google.gson.Gson;
  61 import com.google.gson.GsonBuilder;
  62
  63 /**
  64  * A full implementation test, that starts the embedded MQTT broker and publishes a homeassistant MQTT discovery device
  65  * tree.
  66  *
  67  * @author David Graeff - Initial contribution
  68  */
  69 @ExtendWith(MockitoExtension.class)
  70 @MockitoSettings(strictness = Strictness.LENIENT)
  71 @NonNullByDefault
  72 public class HomeAssistantMQTTImplementationTest extends MqttOSGiTest {
  73
  74     private @NonNullByDefault({}) MqttBrokerConnection haConnection;
  75     private int registeredTopics = 100;
  76     private @Nullable Throwable failure;
  77
  78     private @Mock @NonNullByDefault({}) ChannelStateUpdateListener channelStateUpdateListener;
  79     private @Mock @NonNullByDefault({}) AvailabilityTracker availabilityTracker;
  80     private @Mock @NonNullByDefault({}) TransformationServiceProvider transformationServiceProvider;
  81
  82     /**
  83      * Create an observer that fails the test as soon as the broker client connection changes its connection state
  84      * to something else then CONNECTED.
  85      */
  86     private final MqttConnectionObserver failIfChange = (state, error) -> assertThat(state,
  87             is(MqttConnectionState.CONNECTED));
  88     private final String testObjectTopic = "homeassistant/switch/node/"
  89             + ThingChannelConstants.TEST_HOME_ASSISTANT_THING.getId();
  90
  91     @Override
  92     @BeforeEach
  93     public void beforeEach() throws Exception {
  94         super.beforeEach();
  95
  96         haConnection = createBrokerConnection("ha_mqtt");
  97
  98         // If the connection state changes in between -> fail
  99         haConnection.addConnectionObserver(failIfChange);
 100
 101         // Create topic string and config for one example HA component (a Switch)
 102         final String config = "{'name':'testname','state_topic':'" + testObjectTopic + "/state','command_topic':'"
 103                 + testObjectTopic + "/set'}";
 104
 105         // Publish component configurations and component states to MQTT
 106         List<CompletableFuture<Boolean>> futures = new ArrayList<>();
 107         futures.add(publish(testObjectTopic + "/config", config));
 108         futures.add(publish(testObjectTopic + "/state", "ON"));
 109
 110         registeredTopics = futures.size();
 111         CompletableFuture.allOf(futures.toArray(new CompletableFuture[0])).get(2, TimeUnit.SECONDS);
 112
 113         failure = null;
 114
 115         doReturn(null).when(transformationServiceProvider).getTransformationService(any());
 116     }
 117
 118     @Override
 119     @AfterEach
 120     public void afterEach() throws Exception {
 121         if (haConnection != null) {
 122             haConnection.removeConnectionObserver(failIfChange);
 123             haConnection.stop().get(5, TimeUnit.SECONDS);
 124         }
 125
 126         super.afterEach();
 127     }
 128
 129     @Test
 130     public void reconnectTest() throws Exception {
 131         haConnection.removeConnectionObserver(failIfChange);
 132         haConnection.stop().get(5, TimeUnit.SECONDS);
 133         haConnection = createBrokerConnection("ha_mqtt");
 134     }
 135
 136     @Test
 137     public void retrieveAllTopics() throws Exception {
 138         CountDownLatch c = new CountDownLatch(registeredTopics);
 139         haConnection.subscribe("homeassistant/+/+/" + ThingChannelConstants.TEST_HOME_ASSISTANT_THING.getId() + "/#",
 140                 (topic, payload) -> c.countDown()).get(5, TimeUnit.SECONDS);
 141         assertTrue(c.await(2, TimeUnit.SECONDS),
 142                 "Connection " + haConnection.getClientId() + " not retrieving all topics");
 143     }
 144
 145     @Test
 146     public void parseHATree() throws Exception {
 147         MqttChannelTypeProvider channelTypeProvider = mock(MqttChannelTypeProvider.class);
 148
 149         final Map<String, AbstractComponent<?>> haComponents = new HashMap<>();
 150         Gson gson = new GsonBuilder().registerTypeAdapterFactory(new ChannelConfigurationTypeAdapterFactory()).create();
 151
 152         ScheduledExecutorService scheduler = new ScheduledThreadPoolExecutor(4);
 153         DiscoverComponents discover = spy(new DiscoverComponents(ThingChannelConstants.TEST_HOME_ASSISTANT_THING,
 154                 scheduler, channelStateUpdateListener, availabilityTracker, gson, transformationServiceProvider));
 155
 156         // The DiscoverComponents object calls ComponentDiscovered callbacks.
 157         // In the following implementation we add the found component to the `haComponents` map
 158         // and add the types to the channelTypeProvider, like in the real Thing handler.
 159         final CountDownLatch latch = new CountDownLatch(1);
 160         ComponentDiscovered cd = (haID, c) -> {
 161             haComponents.put(c.getGroupUID().getId(), c);
 162             c.addChannelTypes(channelTypeProvider);
 163             channelTypeProvider.setChannelGroupType(c.getGroupTypeUID(), c.getType());
 164             latch.countDown();
 165         };
 166
 167         // Start the discovery for 2000ms. Forced timeout after 4000ms.
 168         HaID haID = new HaID(testObjectTopic + "/config");
 169         CompletableFuture<Void> future = discover.startDiscovery(haConnection, 2000, Collections.singleton(haID), cd)
 170                 .thenRun(() -> {
 171                 }).exceptionally(e -> {
 172                     failure = e;
 173                     return null;
 174                 });
 175
 176         assertTrue(latch.await(4, TimeUnit.SECONDS));
 177         future.get(5, TimeUnit.SECONDS);
 178
 179         // No failure expected and one discovered result
 180         assertNull(failure);
 181         assertThat(haComponents.size(), is(1));
 182
 183         // For the switch component we should have one channel group type and one channel type
 184         // setChannelGroupType is called once above
 185         verify(channelTypeProvider, times(2)).setChannelGroupType(any(), any());
 186         verify(channelTypeProvider, times(1)).setChannelType(any(), any());
 187
 188         String channelGroupId = UIDUtils
 189                 .encode("node_" + ThingChannelConstants.TEST_HOME_ASSISTANT_THING.getId() + "_switch");
 190
 191         State value = haComponents.get(channelGroupId).getChannel(Switch.SWITCH_CHANNEL_ID).getState().getCache()
 192                 .getChannelState();
 193         assertThat(value, is(UnDefType.UNDEF));
 194
 195         haComponents.values().stream().map(e -> e.start(haConnection, scheduler, 100))
 196                 .reduce(CompletableFuture.completedFuture(null), (a, v) -> a.thenCompose(b -> v)).exceptionally(e -> {
 197                     failure = e;
 198                     return null;
 199                 }).get();
 200
 201         // We should have received the retained value, while subscribing to the channels MQTT state topic.
 202         verify(channelStateUpdateListener, timeout(4000).times(1)).updateChannelState(any(), any());
 203
 204         // Value should be ON now.
 205         value = haComponents.get(channelGroupId).getChannel(Switch.SWITCH_CHANNEL_ID).getState().getCache()
 206                 .getChannelState();
 207         assertThat(value, is(OnOffType.ON));
 208     }
 209 }