git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2024 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.mqtt.generic.values;
  14
  15 import static org.hamcrest.CoreMatchers.is;
  16 import static org.hamcrest.MatcherAssert.assertThat;
  17 import static org.junit.jupiter.api.Assertions.*;
  18
  19 import java.math.BigDecimal;
  20 import java.util.Objects;
  21
  22 import org.eclipse.jdt.annotation.NonNullByDefault;
  23 import org.junit.jupiter.api.Test;
  24 import org.openhab.binding.mqtt.generic.mapping.ColorMode;
  25 import org.openhab.core.library.types.DecimalType;
  26 import org.openhab.core.library.types.HSBType;
  27 import org.openhab.core.library.types.IncreaseDecreaseType;
  28 import org.openhab.core.library.types.OnOffType;
  29 import org.openhab.core.library.types.OpenClosedType;
  30 import org.openhab.core.library.types.PercentType;
  31 import org.openhab.core.library.types.QuantityType;
  32 import org.openhab.core.library.types.StopMoveType;
  33 import org.openhab.core.library.types.StringType;
  34 import org.openhab.core.library.types.UpDownType;
  35 import org.openhab.core.library.unit.MetricPrefix;
  36 import org.openhab.core.library.unit.Units;
  37 import org.openhab.core.types.Command;
  38 import org.openhab.core.types.State;
  39 import org.openhab.core.types.TypeParser;
  40 import org.openhab.core.types.UnDefType;
  41
  42 /**
  43  * Test cases for the value classes. They should throw exceptions if the wrong command type is used
  44  * for an update. The percent value class should raise an exception if the value is out of range.
  45  *
  46  * The on/off value class should accept a multitude of values including the custom defined ones.
  47  *
  48  * The string value class states are tested.
  49  *
  50  * @author David Graeff - Initial contribution
  51  */
  52 @NonNullByDefault
  53 public class ValueTests {
  54     private Command p(Value v, String str) {
  55         return Objects.requireNonNull(TypeParser.parseCommand(v.getSupportedCommandTypes(), str));
  56     }
  57
  58     @Test
  59     public void illegalTextStateUpdate() {
  60         TextValue v = new TextValue("one,two".split(","));
  61         assertThrows(IllegalArgumentException.class, () -> v.parseCommand(p(v, "three")));
  62     }
  63
  64     @Test
  65     public void textStateUpdate() {
  66         TextValue v = new TextValue("one,two".split(","));
  67         v.parseCommand(p(v, "one"));
  68     }
  69
  70     @Test
  71     public void colorUpdate() {
  72         ColorValue v = new ColorValue(ColorMode.RGB, "fancyON", "fancyOFF", 77);
  73         v.update((State) v.parseCommand(p(v, "255,255,255")));
  74
  75         HSBType hsb = (HSBType) v.parseCommand(p(v, "OFF"));
  76         assertThat(hsb.getBrightness().intValue(), is(0));
  77         v.update(hsb);
  78         hsb = (HSBType) v.parseCommand(p(v, "ON"));
  79         assertThat(hsb.getBrightness().intValue(), is(77));
  80
  81         hsb = (HSBType) v.parseCommand(p(v, "0"));
  82         assertThat(hsb.getBrightness().intValue(), is(0));
  83         hsb = (HSBType) v.parseCommand(p(v, "1"));
  84         assertThat(hsb.getBrightness().intValue(), is(1));
  85     }
  86
  87     @Test
  88     public void illegalColorUpdate() {
  89         ColorValue v = new ColorValue(ColorMode.RGB, null, null, 10);
  90         assertThrows(IllegalArgumentException.class, () -> v.parseCommand(p(v, "255,255,abc")));
  91     }
  92
  93     @Test
  94     public void illegalNumberCommand() {
  95         NumberValue v = new NumberValue(null, null, null, null);
  96         assertThrows(IllegalArgumentException.class, () -> v.parseCommand(OnOffType.OFF));
  97     }
  98
  99     @Test
 100     public void illegalPercentCommand() {
 101         PercentageValue v = new PercentageValue(null, null, null, null, null);
 102         assertThrows(IllegalStateException.class, () -> v.parseCommand(new StringType("demo")));
 103     }
 104
 105     @Test
 106     public void illegalOnOffCommand() {
 107         OnOffValue v = new OnOffValue(null, null);
 108         assertThrows(IllegalArgumentException.class, () -> v.parseCommand(new DecimalType(101.0)));
 109     }
 110
 111     @Test
 112     public void illegalPercentUpdate() {
 113         PercentageValue v = new PercentageValue(null, null, null, null, null);
 114         assertThrows(IllegalArgumentException.class, () -> v.parseCommand(new DecimalType(101.0)));
 115     }
 116
 117     @Test
 118     public void onoffUpdate() {
 119         OnOffValue v = new OnOffValue("fancyON", "fancyOff");
 120
 121         // Test with command
 122         assertThat(v.parseCommand(OnOffType.OFF), is(OnOffType.OFF));
 123         assertThat(v.parseCommand(OnOffType.ON), is(OnOffType.ON));
 124
 125         // Test with string, representing the command
 126         assertThat(v.parseCommand(new StringType("OFF")), is(OnOffType.OFF));
 127         assertThat(v.parseCommand(new StringType("ON")), is(OnOffType.ON));
 128
 129         // Test with custom string, setup in the constructor
 130         assertThat(v.parseCommand(new StringType("fancyOff")), is(OnOffType.OFF));
 131         assertThat(v.parseCommand(new StringType("fancyON")), is(OnOffType.ON));
 132
 133         // Test basic formatting
 134         assertThat(v.getMQTTpublishValue(OnOffType.ON, null), is("fancyON"));
 135         assertThat(v.getMQTTpublishValue(OnOffType.OFF, null), is("fancyOff"));
 136
 137         // Test custom formatting
 138         assertThat(v.getMQTTpublishValue(OnOffType.OFF, "=%s"), is("=fancyOff"));
 139         assertThat(v.getMQTTpublishValue(OnOffType.ON, "=%s"), is("=fancyON"));
 140     }
 141
 142     @Test
 143     public void onoffMultiStates() {
 144         OnOffValue v = new OnOffValue(new String[] { "LOCKED" }, new String[] { "UNLOCKED", "JAMMED" }, "LOCK",
 145                 "UNLOCK");
 146
 147         assertThat(v.parseCommand(new StringType("LOCKED")), is(OnOffType.ON));
 148         assertThat(v.parseCommand(new StringType("UNLOCKED")), is(OnOffType.OFF));
 149         assertThat(v.parseCommand(new StringType("JAMMED")), is(OnOffType.OFF));
 150     }
 151
 152     @Test
 153     public void openCloseUpdate() {
 154         OpenCloseValue v = new OpenCloseValue("fancyON", "fancyOff");
 155
 156         // Test with command
 157         assertThat(v.parseCommand(OpenClosedType.CLOSED), is(OpenClosedType.CLOSED));
 158         assertThat(v.parseCommand(OpenClosedType.OPEN), is(OpenClosedType.OPEN));
 159
 160         // Test with string, representing the command
 161         assertThat(v.parseCommand(new StringType("CLOSED")), is(OpenClosedType.CLOSED));
 162         assertThat(v.parseCommand(new StringType("OPEN")), is(OpenClosedType.OPEN));
 163
 164         // Test with custom string, setup in the constructor
 165         assertThat(v.parseCommand(new StringType("fancyOff")), is(OpenClosedType.CLOSED));
 166         assertThat(v.parseCommand(new StringType("fancyON")), is(OpenClosedType.OPEN));
 167
 168         // Test basic formatting
 169         assertThat(v.getMQTTpublishValue(OpenClosedType.CLOSED, null), is("fancyOff"));
 170         assertThat(v.getMQTTpublishValue(OpenClosedType.OPEN, null), is("fancyON"));
 171     }
 172
 173     @Test
 174     public void numberUpdate() {
 175         NumberValue v = new NumberValue(null, null, new BigDecimal(10), Units.WATT);
 176
 177         // Test with command with units
 178         Command command = v.parseCommand(new QuantityType<>(20, Units.WATT));
 179         assertThat(command, is(new QuantityType<>(20, Units.WATT)));
 180         assertThat(v.getMQTTpublishValue(command, null), is("20"));
 181         command = v.parseCommand(new QuantityType<>(20, MetricPrefix.KILO(Units.WATT)));
 182         assertThat(command, is(new QuantityType<>(20, MetricPrefix.KILO(Units.WATT))));
 183         assertThat(v.getMQTTpublishValue(command, null), is("20000"));
 184
 185         // Test with command without units
 186         command = v.parseCommand(new QuantityType<>("20"));
 187         assertThat(command, is(new QuantityType<>(20, Units.WATT)));
 188         assertThat(v.getMQTTpublishValue(command, null), is("20"));
 189
 190         assertThat(v.parseMessage(new StringType("NaN")), is(UnDefType.UNDEF));
 191         assertThat(v.parseMessage(new StringType("nan")), is(UnDefType.UNDEF));
 192     }
 193
 194     @Test
 195     public void numberUpdateMireds() {
 196         NumberValue v = new NumberValue(null, null, new BigDecimal(10), Units.MIRED);
 197
 198         Command command = v.parseCommand(new QuantityType<>(2700, Units.KELVIN));
 199         assertThat(v.getMQTTpublishValue(command, "%.0f"), is("370"));
 200     }
 201
 202     @Test
 203     public void numberPercentageUpdate() {
 204         NumberValue v = new NumberValue(null, null, new BigDecimal(10), Units.PERCENT);
 205
 206         // Test with command with units
 207         Command command = v.parseCommand(new QuantityType<>(20, Units.PERCENT));
 208         assertThat(command, is(new QuantityType<>(20, Units.PERCENT)));
 209         assertThat(v.getMQTTpublishValue(command, null), is("20"));
 210
 211         // Test with command without units
 212         command = v.parseCommand(new QuantityType<>("20"));
 213         assertThat(command, is(new QuantityType<>(20, Units.PERCENT)));
 214         assertThat(v.getMQTTpublishValue(command, null), is("20"));
 215     }
 216
 217     @Test
 218     public void rollershutterUpdateWithStrings() {
 219         RollershutterValue v = new RollershutterValue("fancyON", "fancyOff", "fancyStop");
 220         // Test with UP/DOWN/STOP command
 221         assertThat(v.parseCommand(UpDownType.UP), is(UpDownType.UP));
 222         assertThat(v.getMQTTpublishValue(UpDownType.UP, null), is("fancyON"));
 223         assertThat(v.parseCommand(UpDownType.DOWN), is(UpDownType.DOWN));
 224         assertThat(v.getMQTTpublishValue(UpDownType.DOWN, null), is("fancyOff"));
 225         assertThat(v.parseCommand(StopMoveType.STOP), is(StopMoveType.STOP));
 226         assertThat(v.getMQTTpublishValue(StopMoveType.STOP, null), is("fancyStop"));
 227
 228         // Test with custom string
 229         assertThat(v.parseCommand(new StringType("fancyON")), is(UpDownType.UP));
 230         assertThat(v.parseCommand(new StringType("fancyOff")), is(UpDownType.DOWN));
 231
 232         // Test with exact percent
 233         Command command = new PercentType(27);
 234         assertThat(v.parseCommand((Command) command), is(command));
 235         assertThat(v.getMQTTpublishValue(command, null), is("27"));
 236
 237         // Test formatting 0/100
 238         assertThat(v.getMQTTpublishValue(PercentType.ZERO, null), is("fancyON"));
 239         assertThat(v.getMQTTpublishValue(PercentType.HUNDRED, null), is("fancyOff"));
 240
 241         // Test parsing from MQTT
 242         assertThat(v.parseMessage(new StringType("fancyON")), is(UpDownType.UP));
 243         assertThat(v.parseMessage(new StringType("fancyOff")), is(UpDownType.DOWN));
 244     }
 245
 246     @Test
 247     public void rollershutterUpdateWithDiscreteCommandAndStateStrings() {
 248         RollershutterValue v = new RollershutterValue("OPEN", "CLOSE", "STOP", "open", "closed", false, true);
 249         // Test with UP/DOWN/STOP command
 250         assertThat(v.parseCommand(UpDownType.UP), is(UpDownType.UP));
 251         assertThat(v.getMQTTpublishValue(UpDownType.UP, null), is("OPEN"));
 252         assertThat(v.parseCommand(UpDownType.DOWN), is(UpDownType.DOWN));
 253         assertThat(v.getMQTTpublishValue(UpDownType.DOWN, null), is("CLOSE"));
 254         assertThat(v.parseCommand(StopMoveType.STOP), is(StopMoveType.STOP));
 255         assertThat(v.getMQTTpublishValue(StopMoveType.STOP, null), is("STOP"));
 256
 257         // Test with custom string
 258         assertThat(v.parseCommand(new StringType("OPEN")), is(UpDownType.UP));
 259         assertThat(v.parseCommand(new StringType("CLOSE")), is(UpDownType.DOWN));
 260
 261         // Test with exact percent
 262         Command command = new PercentType(27);
 263         assertThat(v.parseCommand((Command) command), is(command));
 264         assertThat(v.getMQTTpublishValue(command, null), is("27"));
 265
 266         // Test formatting 0/100
 267         assertThat(v.getMQTTpublishValue(PercentType.ZERO, null), is("OPEN"));
 268         assertThat(v.getMQTTpublishValue(PercentType.HUNDRED, null), is("CLOSE"));
 269
 270         // Test parsing from MQTT
 271         assertThat(v.parseMessage(new StringType("open")), is(UpDownType.UP));
 272         assertThat(v.parseMessage(new StringType("closed")), is(UpDownType.DOWN));
 273     }
 274
 275     @Test
 276     public void rollershutterUpdateWithOutStrings() {
 277         RollershutterValue v = new RollershutterValue(null, null, "fancyStop");
 278         // Test with command
 279         assertThat(v.parseCommand(UpDownType.UP), is(PercentType.ZERO));
 280         assertThat(v.parseCommand(UpDownType.DOWN), is(PercentType.HUNDRED));
 281
 282         // Test with custom string
 283         // Test formatting 0/100
 284         assertThat(v.getMQTTpublishValue(PercentType.ZERO, null), is("0"));
 285         assertThat(v.getMQTTpublishValue(PercentType.HUNDRED, null), is("100"));
 286     }
 287
 288     @Test
 289     public void percentCalc() {
 290         PercentageValue v = new PercentageValue(new BigDecimal(10.0), new BigDecimal(110.0), new BigDecimal(1.0), null,
 291                 null);
 292         assertThat(v.parseCommand(new DecimalType("110.0")), is(PercentType.HUNDRED));
 293         assertThat(v.getMQTTpublishValue(PercentType.HUNDRED, null), is("110"));
 294         assertThat(v.parseCommand(new DecimalType(10.0)), is(PercentType.ZERO));
 295         assertThat(v.getMQTTpublishValue(PercentType.ZERO, null), is("10"));
 296
 297         assertThat(v.parseCommand(OnOffType.ON), is(PercentType.HUNDRED));
 298         assertThat(v.parseCommand(OnOffType.OFF), is(PercentType.ZERO));
 299     }
 300
 301     @Test
 302     public void percentMQTTValue() {
 303         PercentageValue v = new PercentageValue(null, null, null, null, null);
 304         assertThat(v.parseCommand(new DecimalType("10.10000")), is(new PercentType("10.1")));
 305         assertThat(v.getMQTTpublishValue(new PercentType("10.1"), null), is("10.1"));
 306         Command command;
 307         for (int i = 0; i <= 100; i++) {
 308             command = v.parseCommand(new DecimalType(i));
 309             assertThat(v.getMQTTpublishValue(command, null), is("" + i));
 310         }
 311     }
 312
 313     @Test
 314     public void percentCustomOnOff() {
 315         PercentageValue v = new PercentageValue(new BigDecimal("0.0"), new BigDecimal("100.0"), new BigDecimal("1.0"),
 316                 "on", "off");
 317         assertThat(v.parseCommand(new StringType("on")), is(PercentType.HUNDRED));
 318         assertThat(v.parseCommand(new StringType("off")), is(PercentType.ZERO));
 319     }
 320
 321     @Test
 322     public void decimalCalc() {
 323         PercentageValue v = new PercentageValue(new BigDecimal("0.1"), new BigDecimal("1.0"), new BigDecimal("0.1"),
 324                 null, null);
 325         assertThat(v.parseCommand(new DecimalType(1.0)), is(PercentType.HUNDRED));
 326         assertThat(v.parseCommand(new DecimalType(0.1)), is(PercentType.ZERO));
 327         PercentType command = (PercentType) v.parseCommand(new DecimalType(0.2));
 328         assertEquals(command.floatValue(), 11.11f, 0.01f);
 329     }
 330
 331     @Test
 332     public void increaseDecreaseCalc() {
 333         PercentageValue v = new PercentageValue(new BigDecimal("1.0"), new BigDecimal("11.0"), new BigDecimal("0.5"),
 334                 null, null);
 335
 336         // Normal operation.
 337         PercentType command = (PercentType) v.parseCommand(new DecimalType("6.0"));
 338         assertEquals(command.floatValue(), 50.0f, 0.01f);
 339         v.update(command);
 340         command = (PercentType) v.parseCommand(IncreaseDecreaseType.INCREASE);
 341         assertEquals(command.floatValue(), 55.0f, 0.01f);
 342         command = (PercentType) v.parseCommand(IncreaseDecreaseType.DECREASE);
 343         assertEquals(command.floatValue(), 45.0f, 0.01f);
 344
 345         // Lower limit.
 346         command = (PercentType) v.parseCommand(new DecimalType("1.1"));
 347         assertEquals(command.floatValue(), 1.0f, 0.01f);
 348         v.update(command);
 349         command = (PercentType) v.parseCommand(IncreaseDecreaseType.DECREASE);
 350         assertEquals(command.floatValue(), 0.0f, 0.01f);
 351
 352         // Upper limit.
 353         command = (PercentType) v.parseCommand(new DecimalType("10.8"));
 354         assertEquals(command.floatValue(), 98.0f, 0.01f);
 355         v.update(command);
 356         command = (PercentType) v.parseCommand(IncreaseDecreaseType.INCREASE);
 357         assertEquals(command.floatValue(), 100.0f, 0.01f);
 358     }
 359
 360     @Test
 361     public void upDownCalc() {
 362         PercentageValue v = new PercentageValue(new BigDecimal("1.0"), new BigDecimal("11.0"), new BigDecimal("0.5"),
 363                 null, null);
 364
 365         // Normal operation.
 366         PercentType command = (PercentType) v.parseCommand(new DecimalType("6.0"));
 367         assertEquals(command.floatValue(), 50.0f, 0.01f);
 368         v.update(command);
 369         command = (PercentType) v.parseCommand(UpDownType.UP);
 370         assertEquals(command.floatValue(), 55.0f, 0.01f);
 371         command = (PercentType) v.parseCommand(UpDownType.DOWN);
 372         assertEquals(command.floatValue(), 45.0f, 0.01f);
 373
 374         // Lower limit.
 375         command = (PercentType) v.parseCommand(new DecimalType("1.1"));
 376         assertEquals(command.floatValue(), 1.0f, 0.01f);
 377         v.update(command);
 378         command = (PercentType) v.parseCommand(UpDownType.DOWN);
 379         assertEquals(command.floatValue(), 0.0f, 0.01f);
 380
 381         // Upper limit.
 382         command = (PercentType) v.parseCommand(new DecimalType("10.8"));
 383         assertEquals(command.floatValue(), 98.0f, 0.01f);
 384         v.update(command);
 385         command = (PercentType) v.parseCommand(UpDownType.UP);
 386         assertEquals(command.floatValue(), 100.0f, 0.01f);
 387     }
 388
 389     @Test
 390     public void percentCalcInvalid() {
 391         PercentageValue v = new PercentageValue(new BigDecimal(10.0), new BigDecimal(110.0), new BigDecimal(1.0), null,
 392                 null);
 393         assertThrows(IllegalArgumentException.class, () -> v.parseCommand(new DecimalType(9.0)));
 394     }
 395 }