2 * Copyright (c) 2010-2022 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.onewire.test;
15 import static org.junit.jupiter.api.Assertions.fail;
16 import static org.mockito.ArgumentMatchers.any;
17 import static org.openhab.binding.onewire.internal.OwBindingConstants.THING_TYPE_OWSERVER;
19 import java.util.ArrayList;
20 import java.util.BitSet;
21 import java.util.HashMap;
22 import java.util.List;
25 import org.eclipse.jdt.annotation.NonNullByDefault;
26 import org.eclipse.jdt.annotation.Nullable;
27 import org.junit.jupiter.api.AfterEach;
28 import org.junit.jupiter.api.extension.ExtendWith;
29 import org.mockito.InOrder;
30 import org.mockito.Mock;
31 import org.mockito.Mockito;
32 import org.mockito.junit.jupiter.MockitoExtension;
33 import org.mockito.junit.jupiter.MockitoSettings;
34 import org.mockito.quality.Strictness;
35 import org.openhab.binding.onewire.internal.OwDynamicStateDescriptionProvider;
36 import org.openhab.binding.onewire.internal.OwException;
37 import org.openhab.binding.onewire.internal.handler.OwBaseThingHandler;
38 import org.openhab.binding.onewire.internal.handler.OwserverBridgeHandler;
39 import org.openhab.core.config.core.Configuration;
40 import org.openhab.core.library.types.DecimalType;
41 import org.openhab.core.library.types.OnOffType;
42 import org.openhab.core.test.java.JavaTest;
43 import org.openhab.core.thing.Bridge;
44 import org.openhab.core.thing.Channel;
45 import org.openhab.core.thing.Thing;
46 import org.openhab.core.thing.binding.ThingHandler;
47 import org.openhab.core.thing.binding.ThingHandlerCallback;
48 import org.openhab.core.thing.binding.builder.BridgeBuilder;
51 * Base class for thing handler tests.
53 * @author Jan N. Klug - Initial contribution
55 @ExtendWith(MockitoExtension.class)
56 @MockitoSettings(strictness = Strictness.LENIENT)
58 public abstract class AbstractThingHandlerTest extends JavaTest {
60 protected Map<String, Object> bridgeProperties = new HashMap<>();
61 protected Map<String, String> thingProperties = new HashMap<>();
62 protected Map<String, Object> thingConfiguration = new HashMap<>();
63 protected Map<String, Object> channelProperties = new HashMap<>();
65 protected @Mock @NonNullByDefault({}) ThingHandlerCallback thingHandlerCallback;
66 protected @Mock @NonNullByDefault({}) OwDynamicStateDescriptionProvider stateProvider;
67 protected @Mock @NonNullByDefault({}) ThingHandlerCallback bridgeHandlerCallback;
68 protected @Mock @NonNullByDefault({}) OwserverBridgeHandler bridgeHandler;
69 protected @Mock @NonNullByDefault({}) OwserverBridgeHandler secondBridgeHandler;
71 protected List<Channel> channels = new ArrayList<>();
73 protected @Nullable Bridge bridge;
74 protected @Nullable Thing thing;
75 protected @Nullable OwBaseThingHandler thingHandler;
77 protected @Nullable InOrder inOrder;
80 public void tearDown() {
81 final ThingHandler thingHandler = this.thingHandler;
82 if (thingHandler != null) {
83 thingHandler.dispose();
87 protected void initializeHandlerMocks() {
88 final ThingHandler thingHandler = this.thingHandler;
89 if (thingHandler == null) {
90 fail("thingHandler is null");
94 thingHandler.getThing().setHandler(thingHandler);
95 thingHandler.setCallback(thingHandlerCallback);
97 Mockito.doAnswer(answer -> {
98 ((Thing) answer.getArgument(0)).setStatusInfo(answer.getArgument(1));
100 }).when(thingHandlerCallback).statusUpdated(any(), any());
102 inOrder = Mockito.inOrder(bridgeHandler);
105 public void initializeBridge() throws OwException {
106 bridgeProperties = new HashMap<>();
107 final Bridge bridge = BridgeBuilder.create(THING_TYPE_OWSERVER, "testbridge").withLabel("Test Bridge")
108 .withConfiguration(new Configuration(bridgeProperties)).build();
109 bridge.setHandler(bridgeHandler);
110 this.bridge = bridge;
112 Mockito.doAnswer(answer -> {
113 ((Thing) answer.getArgument(0)).setStatusInfo(answer.getArgument(1));
115 }).when(bridgeHandlerCallback).statusUpdated(any(), any());
117 Mockito.doAnswer(answer -> OnOffType.ON).when(bridgeHandler).checkPresence(any());
119 Mockito.doAnswer(answer -> new DecimalType(10)).when(bridgeHandler).readDecimalType(any(), any());
121 Mockito.doAnswer(answer -> new BitSet(8)).when(bridgeHandler).readBitSet(any(), any());
123 Mockito.doAnswer(answer -> {
124 final OwBaseThingHandler thingHandler = this.thingHandler;
125 if (thingHandler == null) {
126 fail("thingHandler is null");
130 thingHandler.updateSensorProperties(secondBridgeHandler);
131 thingHandler.initialize();
133 }).when(bridgeHandler).scheduleForPropertiesUpdate(any());