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.onewire.test;
  14
  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;
  18
  19 import java.util.ArrayList;
  20 import java.util.BitSet;
  21 import java.util.HashMap;
  22 import java.util.List;
  23 import java.util.Map;
  24
  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.ChannelUID;
  46 import org.openhab.core.thing.Thing;
  47 import org.openhab.core.thing.binding.ThingHandler;
  48 import org.openhab.core.thing.binding.ThingHandlerCallback;
  49 import org.openhab.core.thing.binding.builder.BridgeBuilder;
  50 import org.openhab.core.thing.binding.builder.ChannelBuilder;
  51 import org.openhab.core.thing.type.ChannelTypeUID;
  52
  53 /**
  54  * Base class for thing handler tests.
  55  *
  56  * @author Jan N. Klug - Initial contribution
  57  */
  58 @ExtendWith(MockitoExtension.class)
  59 @MockitoSettings(strictness = Strictness.LENIENT)
  60 @NonNullByDefault
  61 public abstract class AbstractThingHandlerTest extends JavaTest {
  62
  63     protected Map<String, Object> bridgeProperties = new HashMap<>();
  64     protected Map<String, String> thingProperties = new HashMap<>();
  65     protected Map<String, Object> thingConfiguration = new HashMap<>();
  66     protected Map<String, Object> channelProperties = new HashMap<>();
  67
  68     protected @Mock @NonNullByDefault({}) ThingHandlerCallback thingHandlerCallback;
  69     protected @Mock @NonNullByDefault({}) OwDynamicStateDescriptionProvider stateProvider;
  70     protected @Mock @NonNullByDefault({}) ThingHandlerCallback bridgeHandlerCallback;
  71     protected @Mock @NonNullByDefault({}) OwserverBridgeHandler bridgeHandler;
  72     protected @Mock @NonNullByDefault({}) OwserverBridgeHandler secondBridgeHandler;
  73
  74     protected List<Channel> channels = new ArrayList<>();
  75
  76     protected @Nullable Bridge bridge;
  77     protected @Nullable Thing thing;
  78     protected @Nullable OwBaseThingHandler thingHandler;
  79
  80     protected @Nullable InOrder inOrder;
  81
  82     @AfterEach
  83     public void tearDown() {
  84         final ThingHandler thingHandler = this.thingHandler;
  85         if (thingHandler != null) {
  86             thingHandler.dispose();
  87         }
  88     }
  89
  90     protected void initializeHandlerMocks() {
  91         final ThingHandler thingHandler = this.thingHandler;
  92         if (thingHandler == null) {
  93             fail("thingHandler is null");
  94             return;
  95         }
  96
  97         thingHandler.getThing().setHandler(thingHandler);
  98         thingHandler.setCallback(thingHandlerCallback);
  99
 100         Mockito.doAnswer(answer -> {
 101             ((Thing) answer.getArgument(0)).setStatusInfo(answer.getArgument(1));
 102             return null;
 103         }).when(thingHandlerCallback).statusUpdated(any(), any());
 104
 105         Mockito.when(thingHandlerCallback.createChannelBuilder(any(), any())).thenAnswer(invocation -> {
 106             ChannelUID channelUID = (ChannelUID) invocation.getArguments()[0];
 107             ChannelTypeUID channelTypeUID = (ChannelTypeUID) invocation.getArguments()[1];
 108
 109             return ChannelBuilder.create(channelUID).withType(channelTypeUID);
 110         });
 111
 112         inOrder = Mockito.inOrder(bridgeHandler);
 113     }
 114
 115     public void initializeBridge() throws OwException {
 116         bridgeProperties = new HashMap<>();
 117         final Bridge bridge = BridgeBuilder.create(THING_TYPE_OWSERVER, "testbridge").withLabel("Test Bridge")
 118                 .withConfiguration(new Configuration(bridgeProperties)).build();
 119         bridge.setHandler(bridgeHandler);
 120         this.bridge = bridge;
 121
 122         Mockito.doAnswer(answer -> {
 123             ((Thing) answer.getArgument(0)).setStatusInfo(answer.getArgument(1));
 124             return null;
 125         }).when(bridgeHandlerCallback).statusUpdated(any(), any());
 126
 127         Mockito.doAnswer(answer -> OnOffType.ON).when(bridgeHandler).checkPresence(any());
 128
 129         Mockito.doAnswer(answer -> new DecimalType(10)).when(bridgeHandler).readDecimalType(any(), any());
 130
 131         Mockito.doAnswer(answer -> new BitSet(8)).when(bridgeHandler).readBitSet(any(), any());
 132
 133         Mockito.doAnswer(answer -> {
 134             final OwBaseThingHandler thingHandler = this.thingHandler;
 135             if (thingHandler == null) {
 136                 fail("thingHandler is null");
 137                 return null;
 138             }
 139
 140             thingHandler.updateSensorProperties(secondBridgeHandler);
 141             thingHandler.initialize();
 142             return null;
 143         }).when(bridgeHandler).scheduleForPropertiesUpdate(any());
 144     }
 145 }