2 * Copyright (c) 2010-2023 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
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
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.mielecloud.internal.handler;
15 import static org.junit.jupiter.api.Assertions.assertEquals;
16 import static org.mockito.ArgumentMatchers.any;
17 import static org.mockito.Mockito.*;
18 import static org.openhab.binding.mielecloud.internal.MieleCloudBindingConstants.Channels.*;
19 import static org.openhab.binding.mielecloud.internal.util.MieleCloudBindingIntegrationTestConstants.WASHING_MACHINE_THING_UID;
21 import java.util.Optional;
23 import org.eclipse.jdt.annotation.NonNullByDefault;
24 import org.junit.jupiter.api.Test;
25 import org.openhab.binding.mielecloud.internal.MieleCloudBindingConstants;
26 import org.openhab.binding.mielecloud.internal.util.MieleCloudBindingIntegrationTestConstants;
27 import org.openhab.binding.mielecloud.internal.webservice.api.ActionsState;
28 import org.openhab.binding.mielecloud.internal.webservice.api.DeviceState;
29 import org.openhab.binding.mielecloud.internal.webservice.api.PowerStatus;
30 import org.openhab.binding.mielecloud.internal.webservice.api.ProgramStatus;
31 import org.openhab.binding.mielecloud.internal.webservice.api.Quantity;
32 import org.openhab.binding.mielecloud.internal.webservice.api.json.StateType;
33 import org.openhab.core.library.types.DecimalType;
34 import org.openhab.core.library.types.OnOffType;
35 import org.openhab.core.library.types.QuantityType;
36 import org.openhab.core.library.types.StringType;
37 import org.openhab.core.library.unit.SIUnits;
38 import org.openhab.core.library.unit.Units;
41 * @author Björn Lange - Initial contribution
42 * @author Benjamin Bolte - Add info state channel and map signal flags from API tests
43 * @author Björn Lange - Add elapsed time, current water and energy consumption channels
46 public class WashingDeviceThingHandlerTest extends AbstractMieleThingHandlerTest {
49 protected AbstractMieleThingHandler setUpThingHandler() {
50 return createThingHandler(MieleCloudBindingConstants.THING_TYPE_WASHING_MACHINE, WASHING_MACHINE_THING_UID,
51 WashingDeviceThingHandler.class, MieleCloudBindingIntegrationTestConstants.SERIAL_NUMBER, "1");
55 public void testChannelUpdatesForNullValues() throws Exception {
57 setUpBridgeAndThing();
59 DeviceState deviceState = mock(DeviceState.class);
60 when(deviceState.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
61 when(deviceState.getStateType()).thenReturn(Optional.empty());
62 when(deviceState.isRemoteControlEnabled()).thenReturn(Optional.empty());
63 when(deviceState.getSpinningSpeed()).thenReturn(Optional.empty());
64 when(deviceState.getSpinningSpeedRaw()).thenReturn(Optional.empty());
65 when(deviceState.getSelectedProgram()).thenReturn(Optional.empty());
66 when(deviceState.getSelectedProgramId()).thenReturn(Optional.empty());
67 when(deviceState.getProgramPhase()).thenReturn(Optional.empty());
68 when(deviceState.getProgramPhaseRaw()).thenReturn(Optional.empty());
69 when(deviceState.getStatus()).thenReturn(Optional.empty());
70 when(deviceState.getStatusRaw()).thenReturn(Optional.empty());
71 when(deviceState.getStartTime()).thenReturn(Optional.empty());
72 when(deviceState.getElapsedTime()).thenReturn(Optional.empty());
73 when(deviceState.getTargetTemperature(0)).thenReturn(Optional.empty());
74 when(deviceState.getLightState()).thenReturn(Optional.empty());
75 when(deviceState.getDoorState()).thenReturn(Optional.empty());
76 when(deviceState.getCurrentWaterConsumption()).thenReturn(Optional.empty());
77 when(deviceState.getCurrentEnergyConsumption()).thenReturn(Optional.empty());
80 getBridgeHandler().onDeviceStateUpdated(deviceState);
84 assertEquals(NULL_VALUE_STATE, getChannelState(SPINNING_SPEED));
85 assertEquals(NULL_VALUE_STATE, getChannelState(SPINNING_SPEED_RAW));
86 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_ACTIVE));
87 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_ACTIVE_RAW));
88 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_PHASE));
89 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_PHASE_RAW));
90 assertEquals(NULL_VALUE_STATE, getChannelState(OPERATION_STATE));
91 assertEquals(NULL_VALUE_STATE, getChannelState(OPERATION_STATE_RAW));
92 assertEquals(new StringType(ProgramStatus.PROGRAM_STOPPED.getState()), getChannelState(PROGRAM_START_STOP));
93 assertEquals(new StringType(PowerStatus.POWER_ON.getState()), getChannelState(POWER_ON_OFF));
94 assertEquals(NULL_VALUE_STATE, getChannelState(DELAYED_START_TIME));
95 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_ELAPSED_TIME));
96 assertEquals(NULL_VALUE_STATE, getChannelState(TEMPERATURE_TARGET));
97 assertEquals(NULL_VALUE_STATE, getChannelState(LIGHT_SWITCH));
98 assertEquals(NULL_VALUE_STATE, getChannelState(DOOR_STATE));
99 assertEquals(NULL_VALUE_STATE, getChannelState(WATER_CONSUMPTION_CURRENT));
100 assertEquals(NULL_VALUE_STATE, getChannelState(ENERGY_CONSUMPTION_CURRENT));
105 public void testChannelUpdatesForValidValues() throws Exception {
107 setUpBridgeAndThing();
109 DeviceState deviceState = mock(DeviceState.class);
110 when(deviceState.isInState(any())).thenCallRealMethod();
111 when(deviceState.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
112 when(deviceState.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
113 when(deviceState.isRemoteControlEnabled()).thenReturn(Optional.of(true));
114 when(deviceState.getSpinningSpeed()).thenReturn(Optional.of("1200"));
115 when(deviceState.getSpinningSpeedRaw()).thenReturn(Optional.of(1200));
116 when(deviceState.getSelectedProgram()).thenReturn(Optional.of("Buntwäsche"));
117 when(deviceState.getSelectedProgramId()).thenReturn(Optional.of(1L));
118 when(deviceState.getProgramPhase()).thenReturn(Optional.of("Waschen"));
119 when(deviceState.getProgramPhaseRaw()).thenReturn(Optional.of(7));
120 when(deviceState.getStatus()).thenReturn(Optional.of("Läuft"));
121 when(deviceState.getStatusRaw()).thenReturn(Optional.of(StateType.RUNNING.getCode()));
122 when(deviceState.getStartTime()).thenReturn(Optional.of(3600));
123 when(deviceState.getElapsedTime()).thenReturn(Optional.of(63));
124 when(deviceState.getTargetTemperature(0)).thenReturn(Optional.of(30));
125 when(deviceState.hasError()).thenReturn(true);
126 when(deviceState.hasInfo()).thenReturn(true);
127 when(deviceState.getLightState()).thenReturn(Optional.of(false));
128 when(deviceState.getDoorState()).thenReturn(Optional.of(true));
129 when(deviceState.getCurrentWaterConsumption()).thenReturn(Optional.of(new Quantity(0.5, "l")));
130 when(deviceState.getCurrentEnergyConsumption()).thenReturn(Optional.of(new Quantity(1.5, "kWh")));
133 getBridgeHandler().onDeviceStateUpdated(deviceState);
136 waitForAssert(() -> {
137 assertEquals(new StringType("1200"), getChannelState(SPINNING_SPEED));
138 assertEquals(new DecimalType(1200), getChannelState(SPINNING_SPEED_RAW));
139 assertEquals(new StringType("Buntwäsche"), getChannelState(PROGRAM_ACTIVE));
140 assertEquals(new DecimalType(1), getChannelState(PROGRAM_ACTIVE_RAW));
141 assertEquals(new StringType("Waschen"), getChannelState(PROGRAM_PHASE));
142 assertEquals(new DecimalType(7), getChannelState(PROGRAM_PHASE_RAW));
143 assertEquals(new StringType("Läuft"), getChannelState(OPERATION_STATE));
144 assertEquals(new DecimalType(StateType.RUNNING.getCode()), getChannelState(OPERATION_STATE_RAW));
145 assertEquals(new StringType(ProgramStatus.PROGRAM_STARTED.getState()), getChannelState(PROGRAM_START_STOP));
146 assertEquals(new StringType(PowerStatus.POWER_ON.getState()), getChannelState(POWER_ON_OFF));
147 assertEquals(new DecimalType(3600), getChannelState(DELAYED_START_TIME));
148 assertEquals(new DecimalType(63), getChannelState(PROGRAM_ELAPSED_TIME));
149 assertEquals(new QuantityType<>(30, SIUnits.CELSIUS), getChannelState(TEMPERATURE_TARGET));
150 assertEquals(OnOffType.ON, getChannelState(ERROR_STATE));
151 assertEquals(OnOffType.ON, getChannelState(INFO_STATE));
152 assertEquals(OnOffType.OFF, getChannelState(LIGHT_SWITCH));
153 assertEquals(OnOffType.ON, getChannelState(DOOR_STATE));
154 assertEquals(new QuantityType<>(0.5, Units.LITRE), getChannelState(WATER_CONSUMPTION_CURRENT));
155 assertEquals(new QuantityType<>(1.5, Units.KILOWATT_HOUR), getChannelState(ENERGY_CONSUMPTION_CURRENT));
160 public void testFinishStateChannelIsSetToOnWhenProgramHasFinished() throws Exception {
162 setUpBridgeAndThing();
164 DeviceState deviceStateBefore = mock(DeviceState.class);
165 when(deviceStateBefore.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
166 when(deviceStateBefore.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
167 when(deviceStateBefore.isInState(any())).thenCallRealMethod();
169 getBridgeHandler().onDeviceStateUpdated(deviceStateBefore);
171 DeviceState deviceStateAfter = mock(DeviceState.class);
172 when(deviceStateAfter.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
173 when(deviceStateAfter.getStateType()).thenReturn(Optional.of(StateType.END_PROGRAMMED));
174 when(deviceStateAfter.isInState(any())).thenCallRealMethod();
177 getBridgeHandler().onDeviceStateUpdated(deviceStateAfter);
180 waitForAssert(() -> {
181 assertEquals(OnOffType.ON, getChannelState(FINISH_STATE));
186 public void testTransitionChannelUpdatesForNullValues() throws Exception {
188 setUpBridgeAndThing();
190 DeviceState deviceStateBefore = mock(DeviceState.class);
191 when(deviceStateBefore.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
192 when(deviceStateBefore.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
193 when(deviceStateBefore.isInState(any())).thenCallRealMethod();
194 when(deviceStateBefore.getRemainingTime()).thenReturn(Optional.empty());
195 when(deviceStateBefore.getProgress()).thenReturn(Optional.empty());
197 getThingHandler().onDeviceStateUpdated(deviceStateBefore);
199 DeviceState deviceStateAfter = mock(DeviceState.class);
200 when(deviceStateAfter.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
201 when(deviceStateAfter.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
202 when(deviceStateAfter.isInState(any())).thenCallRealMethod();
203 when(deviceStateAfter.getRemainingTime()).thenReturn(Optional.empty());
204 when(deviceStateAfter.getProgress()).thenReturn(Optional.empty());
207 getThingHandler().onDeviceStateUpdated(deviceStateAfter);
209 waitForAssert(() -> {
210 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_REMAINING_TIME));
211 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_PROGRESS));
216 public void testTransitionChannelUpdatesForValidValues() throws Exception {
218 setUpBridgeAndThing();
220 DeviceState deviceStateBefore = mock(DeviceState.class);
221 when(deviceStateBefore.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
222 when(deviceStateBefore.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
223 when(deviceStateBefore.isInState(any())).thenCallRealMethod();
224 when(deviceStateBefore.getRemainingTime()).thenReturn(Optional.of(10));
225 when(deviceStateBefore.getProgress()).thenReturn(Optional.of(80));
227 getThingHandler().onDeviceStateUpdated(deviceStateBefore);
229 DeviceState deviceStateAfter = mock(DeviceState.class);
230 when(deviceStateAfter.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
231 when(deviceStateAfter.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
232 when(deviceStateAfter.isInState(any())).thenCallRealMethod();
233 when(deviceStateAfter.getRemainingTime()).thenReturn(Optional.of(10));
234 when(deviceStateAfter.getProgress()).thenReturn(Optional.of(80));
237 getThingHandler().onDeviceStateUpdated(deviceStateAfter);
239 waitForAssert(() -> {
240 assertEquals(new DecimalType(10), getChannelState(PROGRAM_REMAINING_TIME));
241 assertEquals(new DecimalType(80), getChannelState(PROGRAM_PROGRESS));
246 public void testActionsChannelUpdatesForValidValues() throws Exception {
248 setUpBridgeAndThing();
250 ActionsState actionsState = mock(ActionsState.class);
251 when(actionsState.getDeviceIdentifier()).thenReturn(WASHING_MACHINE_THING_UID.getId());
252 when(actionsState.canBeStarted()).thenReturn(true);
253 when(actionsState.canBeStopped()).thenReturn(false);
254 when(actionsState.canBeSwitchedOn()).thenReturn(true);
255 when(actionsState.canBeSwitchedOff()).thenReturn(false);
256 when(actionsState.canControlLight()).thenReturn(false);
259 getBridgeHandler().onProcessActionUpdated(actionsState);
262 waitForAssert(() -> {
263 assertEquals(OnOffType.ON, getChannelState(REMOTE_CONTROL_CAN_BE_STARTED));
264 assertEquals(OnOffType.OFF, getChannelState(REMOTE_CONTROL_CAN_BE_STOPPED));
265 assertEquals(OnOffType.ON, getChannelState(REMOTE_CONTROL_CAN_BE_SWITCHED_ON));
266 assertEquals(OnOffType.OFF, getChannelState(REMOTE_CONTROL_CAN_BE_SWITCHED_OFF));
267 assertEquals(OnOffType.OFF, getChannelState(LIGHT_CAN_BE_CONTROLLED));