2 * Copyright (c) 2010-2021 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.OVEN_DEVICE_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.json.StateType;
32 import org.openhab.core.library.types.DecimalType;
33 import org.openhab.core.library.types.OnOffType;
34 import org.openhab.core.library.types.QuantityType;
35 import org.openhab.core.library.types.StringType;
36 import org.openhab.core.library.unit.SIUnits;
39 * @author Björn Lange - Initial contribution
40 * @author Benjamin Bolte - Add pre-heat finished channel
41 * @author Benjamin Bolte - Add info state channel and map signal flags from API tests
42 * @author Björn Lange - Add elapsed time channel
45 public class OvenDeviceThingHandlerTest extends AbstractMieleThingHandlerTest {
47 protected AbstractMieleThingHandler setUpThingHandler() {
48 return createThingHandler(MieleCloudBindingConstants.THING_TYPE_OVEN, OVEN_DEVICE_THING_UID,
49 OvenDeviceThingHandler.class, MieleCloudBindingIntegrationTestConstants.SERIAL_NUMBER);
53 public void testChannelUpdatesForNullValues() {
55 DeviceState deviceState = mock(DeviceState.class);
56 when(deviceState.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
57 when(deviceState.getStateType()).thenReturn(Optional.empty());
58 when(deviceState.isRemoteControlEnabled()).thenReturn(Optional.empty());
59 when(deviceState.getSelectedProgram()).thenReturn(Optional.empty());
60 when(deviceState.getSelectedProgramId()).thenReturn(Optional.empty());
61 when(deviceState.getProgramPhase()).thenReturn(Optional.empty());
62 when(deviceState.getProgramPhaseRaw()).thenReturn(Optional.empty());
63 when(deviceState.getStatus()).thenReturn(Optional.empty());
64 when(deviceState.getStatusRaw()).thenReturn(Optional.empty());
65 when(deviceState.getStartTime()).thenReturn(Optional.empty());
66 when(deviceState.getElapsedTime()).thenReturn(Optional.empty());
67 when(deviceState.hasPreHeatFinished()).thenReturn(Optional.empty());
68 when(deviceState.getTargetTemperature(0)).thenReturn(Optional.empty());
69 when(deviceState.getTemperature(0)).thenReturn(Optional.empty());
70 when(deviceState.getLightState()).thenReturn(Optional.empty());
71 when(deviceState.getDoorState()).thenReturn(Optional.empty());
74 getBridgeHandler().onDeviceStateUpdated(deviceState);
78 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_ACTIVE));
79 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_ACTIVE_RAW));
80 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_PHASE));
81 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_PHASE_RAW));
82 assertEquals(NULL_VALUE_STATE, getChannelState(OPERATION_STATE));
83 assertEquals(NULL_VALUE_STATE, getChannelState(OPERATION_STATE_RAW));
84 assertEquals(new StringType(ProgramStatus.PROGRAM_STOPPED.getState()), getChannelState(PROGRAM_START_STOP));
85 assertEquals(new StringType(PowerStatus.POWER_ON.getState()), getChannelState(POWER_ON_OFF));
86 assertEquals(NULL_VALUE_STATE, getChannelState(DELAYED_START_TIME));
87 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_ELAPSED_TIME));
88 assertEquals(NULL_VALUE_STATE, getChannelState(PRE_HEAT_FINISHED));
89 assertEquals(NULL_VALUE_STATE, getChannelState(TEMPERATURE_TARGET));
90 assertEquals(NULL_VALUE_STATE, getChannelState(TEMPERATURE_CURRENT));
91 assertEquals(NULL_VALUE_STATE, getChannelState(LIGHT_SWITCH));
92 assertEquals(NULL_VALUE_STATE, getChannelState(DOOR_STATE));
97 public void testChannelUpdatesForValidValues() {
99 DeviceState deviceState = mock(DeviceState.class);
100 when(deviceState.isInState(any())).thenCallRealMethod();
101 when(deviceState.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
102 when(deviceState.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
103 when(deviceState.isRemoteControlEnabled()).thenReturn(Optional.of(false));
104 when(deviceState.getSelectedProgram()).thenReturn(Optional.of("Grill"));
105 when(deviceState.getSelectedProgramId()).thenReturn(Optional.of(6L));
106 when(deviceState.getProgramPhase()).thenReturn(Optional.of("Heat"));
107 when(deviceState.getProgramPhaseRaw()).thenReturn(Optional.of(6));
108 when(deviceState.getStatus()).thenReturn(Optional.of("Running"));
109 when(deviceState.getStatusRaw()).thenReturn(Optional.of(StateType.RUNNING.getCode()));
110 when(deviceState.getStartTime()).thenReturn(Optional.of(3600));
111 when(deviceState.getElapsedTime()).thenReturn(Optional.of(62));
112 when(deviceState.hasPreHeatFinished()).thenReturn(Optional.of(true));
113 when(deviceState.getTargetTemperature(0)).thenReturn(Optional.of(180));
114 when(deviceState.getTemperature(0)).thenReturn(Optional.of(181));
115 when(deviceState.hasError()).thenReturn(false);
116 when(deviceState.hasInfo()).thenReturn(true);
117 when(deviceState.getLightState()).thenReturn(Optional.of(false));
118 when(deviceState.getDoorState()).thenReturn(Optional.of(false));
121 getBridgeHandler().onDeviceStateUpdated(deviceState);
124 waitForAssert(() -> {
125 assertEquals(new StringType("Grill"), getChannelState(PROGRAM_ACTIVE));
126 assertEquals(new DecimalType(6), getChannelState(PROGRAM_ACTIVE_RAW));
127 assertEquals(new StringType("Heat"), getChannelState(PROGRAM_PHASE));
128 assertEquals(new DecimalType(6), getChannelState(PROGRAM_PHASE_RAW));
129 assertEquals(new StringType("Running"), getChannelState(OPERATION_STATE));
130 assertEquals(new DecimalType(StateType.RUNNING.getCode()), getChannelState(OPERATION_STATE_RAW));
131 assertEquals(new StringType(ProgramStatus.PROGRAM_STARTED.getState()), getChannelState(PROGRAM_START_STOP));
132 assertEquals(new StringType(PowerStatus.POWER_ON.getState()), getChannelState(POWER_ON_OFF));
133 assertEquals(new DecimalType(3600), getChannelState(DELAYED_START_TIME));
134 assertEquals(new DecimalType(62), getChannelState(PROGRAM_ELAPSED_TIME));
135 assertEquals(OnOffType.ON, getChannelState(PRE_HEAT_FINISHED));
136 assertEquals(new QuantityType<>(180, SIUnits.CELSIUS), getChannelState(TEMPERATURE_TARGET));
137 assertEquals(new QuantityType<>(181, SIUnits.CELSIUS), getChannelState(TEMPERATURE_CURRENT));
138 assertEquals(OnOffType.OFF, getChannelState(ERROR_STATE));
139 assertEquals(OnOffType.ON, getChannelState(INFO_STATE));
140 assertEquals(OnOffType.OFF, getChannelState(LIGHT_SWITCH));
141 assertEquals(OnOffType.OFF, getChannelState(DOOR_STATE));
146 public void testFinishStateChannelIsSetToOnWhenProgramHasFinished() {
148 DeviceState deviceStateBefore = mock(DeviceState.class);
149 when(deviceStateBefore.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
150 when(deviceStateBefore.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
151 when(deviceStateBefore.isInState(any())).thenCallRealMethod();
153 getBridgeHandler().onDeviceStateUpdated(deviceStateBefore);
155 DeviceState deviceStateAfter = mock(DeviceState.class);
156 when(deviceStateAfter.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
157 when(deviceStateAfter.getStateType()).thenReturn(Optional.of(StateType.END_PROGRAMMED));
158 when(deviceStateAfter.isInState(any())).thenCallRealMethod();
161 getBridgeHandler().onDeviceStateUpdated(deviceStateAfter);
164 waitForAssert(() -> {
165 assertEquals(OnOffType.ON, getChannelState(FINISH_STATE));
170 public void testTransitionChannelUpdatesForNullValues() {
172 DeviceState deviceStateBefore = mock(DeviceState.class);
173 when(deviceStateBefore.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
174 when(deviceStateBefore.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
175 when(deviceStateBefore.isInState(any())).thenCallRealMethod();
176 when(deviceStateBefore.getRemainingTime()).thenReturn(Optional.empty());
177 when(deviceStateBefore.getProgress()).thenReturn(Optional.empty());
179 getThingHandler().onDeviceStateUpdated(deviceStateBefore);
181 DeviceState deviceStateAfter = mock(DeviceState.class);
182 when(deviceStateAfter.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
183 when(deviceStateAfter.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
184 when(deviceStateAfter.isInState(any())).thenCallRealMethod();
185 when(deviceStateAfter.getRemainingTime()).thenReturn(Optional.empty());
186 when(deviceStateAfter.getProgress()).thenReturn(Optional.empty());
189 getThingHandler().onDeviceStateUpdated(deviceStateAfter);
191 waitForAssert(() -> {
192 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_REMAINING_TIME));
193 assertEquals(NULL_VALUE_STATE, getChannelState(PROGRAM_PROGRESS));
198 public void testTransitionChannelUpdatesForValidValues() {
200 DeviceState deviceStateBefore = mock(DeviceState.class);
201 when(deviceStateBefore.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
202 when(deviceStateBefore.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
203 when(deviceStateBefore.isInState(any())).thenCallRealMethod();
204 when(deviceStateBefore.getRemainingTime()).thenReturn(Optional.of(10));
205 when(deviceStateBefore.getProgress()).thenReturn(Optional.of(80));
207 getThingHandler().onDeviceStateUpdated(deviceStateBefore);
209 DeviceState deviceStateAfter = mock(DeviceState.class);
210 when(deviceStateAfter.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
211 when(deviceStateAfter.getStateType()).thenReturn(Optional.of(StateType.RUNNING));
212 when(deviceStateAfter.isInState(any())).thenCallRealMethod();
213 when(deviceStateAfter.getRemainingTime()).thenReturn(Optional.of(10));
214 when(deviceStateAfter.getProgress()).thenReturn(Optional.of(80));
217 getThingHandler().onDeviceStateUpdated(deviceStateAfter);
219 waitForAssert(() -> {
220 assertEquals(new DecimalType(10), getChannelState(PROGRAM_REMAINING_TIME));
221 assertEquals(new DecimalType(80), getChannelState(PROGRAM_PROGRESS));
226 public void testActionsChannelUpdatesForValidValues() {
228 ActionsState actionsState = mock(ActionsState.class);
229 when(actionsState.getDeviceIdentifier()).thenReturn(OVEN_DEVICE_THING_UID.getId());
230 when(actionsState.canBeStarted()).thenReturn(true);
231 when(actionsState.canBeStopped()).thenReturn(false);
232 when(actionsState.canBeSwitchedOn()).thenReturn(true);
233 when(actionsState.canBeSwitchedOff()).thenReturn(false);
234 when(actionsState.canControlLight()).thenReturn(true);
237 getBridgeHandler().onProcessActionUpdated(actionsState);
240 waitForAssert(() -> {
241 assertEquals(OnOffType.ON, getChannelState(REMOTE_CONTROL_CAN_BE_STARTED));
242 assertEquals(OnOffType.OFF, getChannelState(REMOTE_CONTROL_CAN_BE_STOPPED));
243 assertEquals(OnOffType.ON, getChannelState(REMOTE_CONTROL_CAN_BE_SWITCHED_ON));
244 assertEquals(OnOffType.OFF, getChannelState(REMOTE_CONTROL_CAN_BE_SWITCHED_OFF));
245 assertEquals(OnOffType.ON, getChannelState(LIGHT_CAN_BE_CONTROLLED));