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.wemo.internal.handler.test;
  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.io.IOException;
  22 import java.net.MalformedURLException;
  23 import java.net.URISyntaxException;
  24 import java.util.List;
  25
  26 import org.junit.jupiter.api.AfterEach;
  27 import org.junit.jupiter.api.BeforeEach;
  28 import org.junit.jupiter.api.Test;
  29 import org.jupnp.model.ValidationException;
  30 import org.mockito.ArgumentCaptor;
  31 import org.openhab.binding.wemo.internal.WemoBindingConstants;
  32 import org.openhab.binding.wemo.internal.handler.WemoLightHandler;
  33 import org.openhab.binding.wemo.internal.test.GenericWemoLightOSGiTestParent;
  34 import org.openhab.core.library.types.IncreaseDecreaseType;
  35 import org.openhab.core.library.types.OnOffType;
  36 import org.openhab.core.library.types.PercentType;
  37 import org.openhab.core.thing.ChannelUID;
  38 import org.openhab.core.thing.Thing;
  39 import org.openhab.core.thing.ThingStatus;
  40 import org.openhab.core.thing.ThingUID;
  41 import org.openhab.core.thing.binding.ThingHandler;
  42 import org.openhab.core.types.Command;
  43 import org.openhab.core.types.RefreshType;
  44
  45 /**
  46  * Tests for {@link WemoLightHandler}.
  47  *
  48  * @author Svilen Valkanov - Initial contribution
  49  * @author Stefan Triller - Ported Tests from Groovy to Java
  50  */
  51 public class WemoLightHandlerOSGiTest extends GenericWemoLightOSGiTestParent {
  52
  53     private static final String GET_ACTION = "GetDeviceStatus";
  54     private static final String SET_ACTION = "SetDeviceStatus";
  55
  56     @BeforeEach
  57     public void setUp() throws IOException {
  58         setUpServices();
  59     }
  60
  61     @AfterEach
  62     public void tearDown() {
  63         removeThing();
  64     }
  65
  66     @Test
  67     public void handleONcommandForBRIGHTNESSchannel()
  68             throws MalformedURLException, URISyntaxException, ValidationException, IOException {
  69         Command command = OnOffType.ON;
  70         String channelID = WemoBindingConstants.CHANNEL_BRIGHTNESS;
  71
  72         // Command ON for this channel sends the following data to the device
  73         String action = SET_ACTION;
  74         // ON is equal to brightness value of 255
  75         String value = "255:0";
  76         String capitability = "10008";
  77
  78         assertRequestForCommand(channelID, command, action, value, capitability);
  79     }
  80
  81     @Test
  82     public void handlePercentCommandForBRIGHTNESSChannel()
  83             throws MalformedURLException, URISyntaxException, ValidationException, IOException {
  84         // Set brightness value to 20 Percent
  85         Command command = new PercentType(20);
  86         String channelID = WemoBindingConstants.CHANNEL_BRIGHTNESS;
  87
  88         String action = SET_ACTION;
  89         // 20 Percent brightness is equal to a brightness value of 51
  90         String value = "51:0";
  91         String capitability = "10008";
  92
  93         assertRequestForCommand(channelID, command, action, value, capitability);
  94     }
  95
  96     @Test
  97     public void handleIncreaseCommandForBRIGHTNESSchannel()
  98             throws MalformedURLException, URISyntaxException, ValidationException, IOException {
  99         // The value is increased by 5 Percents by default
 100         Command command = IncreaseDecreaseType.INCREASE;
 101         String channelID = WemoBindingConstants.CHANNEL_BRIGHTNESS;
 102
 103         String action = SET_ACTION;
 104         // 5 Percents brightness is equal to a brightness value of 12
 105         String value = "12:0";
 106         String capitability = "10008";
 107
 108         assertRequestForCommand(channelID, command, action, value, capitability);
 109     }
 110
 111     @Test
 112     public void handleDecreaseCommandForBRIGHTNESSchannel()
 113             throws MalformedURLException, URISyntaxException, ValidationException, IOException {
 114         // The value can not be decreased below 0
 115         Command command = IncreaseDecreaseType.DECREASE;
 116         String channelID = WemoBindingConstants.CHANNEL_BRIGHTNESS;
 117
 118         String action = SET_ACTION;
 119         String value = "0:0";
 120         String capitability = "10008";
 121
 122         assertRequestForCommand(channelID, command, action, value, capitability);
 123     }
 124
 125     @Test
 126     public void handleOnCommandForSTATEChannel()
 127             throws MalformedURLException, URISyntaxException, ValidationException, IOException {
 128         Command command = OnOffType.ON;
 129         String channelID = WemoBindingConstants.CHANNEL_STATE;
 130
 131         // Command ON for this channel sends the following data to the device
 132         String action = SET_ACTION;
 133         String value = "1";
 134         String capitability = "10006";
 135
 136         assertRequestForCommand(channelID, command, action, value, capitability);
 137     }
 138
 139     @Test
 140     public void handleREFRESHCommandForChannelSTATE()
 141             throws MalformedURLException, URISyntaxException, ValidationException, IOException {
 142         Command command = RefreshType.REFRESH;
 143         String channelID = WemoBindingConstants.CHANNEL_STATE;
 144
 145         String action = GET_ACTION;
 146         String value = null;
 147         String capitability = null;
 148
 149         assertRequestForCommand(channelID, command, action, value, capitability);
 150     }
 151
 152     private void assertRequestForCommand(String channelID, Command command, String action, String value,
 153             String capitability) throws MalformedURLException, URISyntaxException, ValidationException, IOException {
 154         Thing bridge = createBridge(BRIDGE_TYPE_UID);
 155
 156         Thing thing = createThing(THING_TYPE_UID, DEFAULT_TEST_CHANNEL, DEFAULT_TEST_CHANNEL_TYPE);
 157
 158         waitForAssert(() -> {
 159             assertThat(bridge.getStatus(), is(ThingStatus.ONLINE));
 160         });
 161
 162         waitForAssert(() -> {
 163             assertThat(thing.getStatus(), is(ThingStatus.UNKNOWN));
 164         });
 165
 166         // The device is registered as UPnP Device after the initialization, this will ensure that the polling job will
 167         // not start
 168         addUpnpDevice(SERVICE_ID, SERVICE_NUMBER, DEVICE_MODEL_NAME);
 169
 170         ThingUID thingUID = new ThingUID(THING_TYPE_UID, TEST_THING_ID);
 171         ChannelUID channelUID = new ChannelUID(thingUID, channelID);
 172         ThingHandler handler = thing.getHandler();
 173         assertNotNull(handler);
 174
 175         handler.handleCommand(channelUID, command);
 176
 177         ArgumentCaptor<String> captur = ArgumentCaptor.forClass(String.class);
 178
 179         verify(mockCaller, atLeastOnce()).executeCall(any(), any(), captur.capture());
 180
 181         List<String> results = captur.getAllValues();
 182         // we might catch multiple calls. iterate through them to find the one matching our settings
 183         boolean found = false;
 184         for (String result : results) {
 185             boolean matchesCapability = result.contains("CapabilityID&gt;" + capitability + "&lt;");
 186             boolean matchesValue = result.contains("CapabilityValue&gt;" + value + "&lt;");
 187             boolean matchesAction = result.contains("<s:Body><u:" + action);
 188
 189             if (action != null) {
 190                 if (!matchesAction) {
 191                     continue;
 192                 }
 193             }
 194             if (capitability != null) {
 195                 if (!matchesCapability) {
 196                     continue;
 197                 }
 198             }
 199             if (value != null) {
 200                 if (!matchesValue) {
 201                     continue;
 202                 }
 203             }
 204             found = true;
 205             break;
 206         }
 207         assertTrue(found);
 208     }
 209 }