Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[automation] ActionInputsHelper: Enhance ZonedDateTime & Instant support #4440

Merged
merged 1 commit into from
Nov 8, 2024
Merged

[automation] ActionInputsHelper: Enhance ZonedDateTime & Instant support #4440

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 11 additions & 9 deletions ...ab.core.automation/src/main/java/org/openhab/core/automation/util/ActionInputsHelper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.time.Duration;
import java.time.Instant;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.ZonedDateTime;
import java.time.format.DateTimeParseException;
import java.util.ArrayList;
import java.util.HashMap;
Expand All @@ -38,6 +36,7 @@
import org.openhab.core.automation.type.Input;
import org.openhab.core.config.core.ConfigDescriptionParameter;
import org.openhab.core.config.core.ConfigDescriptionParameterBuilder;
import org.openhab.core.i18n.TimeZoneProvider;
import org.openhab.core.i18n.UnitProvider;
import org.openhab.core.library.types.DecimalType;
import org.openhab.core.library.types.QuantityType;
Expand All @@ -63,10 +62,13 @@ public class ActionInputsHelper {

private final Logger logger = LoggerFactory.getLogger(ActionInputsHelper.class);

private final TimeZoneProvider timeZoneProvider;
private final UnitProvider unitProvider;

@Activate
public ActionInputsHelper(final @Reference UnitProvider unitProvider) {
public ActionInputsHelper(final @Reference TimeZoneProvider timeZoneProvider,
final @Reference UnitProvider unitProvider) {
this.timeZoneProvider = timeZoneProvider;
this.unitProvider = unitProvider;
}

Expand Down Expand Up @@ -155,11 +157,11 @@ public ConfigDescriptionParameter mapActionInputToConfigDescriptionParameter(Inp
break;
case "java.time.LocalDateTime":
case "java.util.Date":
case "java.time.ZonedDateTime":
case "java.time.Instant":
context = "datetime";
step = BigDecimal.ONE;
break;
case "java.time.ZonedDateTime":
case "java.time.Instant":
case "java.time.Duration":
// There is no available configuration parameter context for these types.
// A text parameter is used. The expected value must respect a particular format specific
Expand Down Expand Up @@ -290,11 +292,11 @@ public Object mapSerializedInputToActionInput(Input input, Object argument) thro
// Accepted format is: 2007-12-03T10:15:30
new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss").parse(valueString);
case "java.time.ZonedDateTime" ->
// Accepted format is: 2007-12-03T10:15:30+01:00[Europe/Paris]
ZonedDateTime.parse(valueString);
// Accepted format is: 2007-12-03T10:15:30
LocalDateTime.parse(valueString).atZone(timeZoneProvider.getTimeZone());
case "java.time.Instant" ->
// Accepted format is: 2007-12-03T10:15:30.00Z
Instant.parse(valueString);
// Accepted format is: 2007-12-03T10:15:30
LocalDateTime.parse(valueString).atZone(timeZoneProvider.getTimeZone()).toInstant();
case "java.time.Duration" ->
// Accepted format is: P2DT17H25M30.5S
Duration.parse(valueString);
Expand Down
25 changes: 18 additions & 7 deletions ...core.automation/src/test/java/org/openhab/core/automation/util/ActionInputHelperTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.ZoneId;
import java.time.ZonedDateTime;
import java.util.Collection;
import java.util.Date;
Expand All @@ -43,6 +44,7 @@
import org.openhab.core.automation.type.ActionType;
import org.openhab.core.automation.type.Input;
import org.openhab.core.config.core.ConfigDescriptionParameter;
import org.openhab.core.i18n.TimeZoneProvider;
import org.openhab.core.i18n.UnitProvider;
import org.openhab.core.internal.i18n.I18nProviderImpl;
import org.openhab.core.library.types.DecimalType;
Expand All @@ -58,8 +60,9 @@ public class ActionInputHelperTest {
private static final String PARAM_LABEL = "Label Parameter";
private static final String PARAM_DESCRIPTION = "Description parameter";

private TimeZoneProvider timeZoneProvider = new TestTimeZoneProvider();
private UnitProvider unitProvider = new TestUnitProvider();
private ActionInputsHelper helper = new ActionInputsHelper(unitProvider);
private ActionInputsHelper helper = new ActionInputsHelper(timeZoneProvider, unitProvider);

@Test
public void testMapActionInputToConfigDescriptionParameterWhenBoolean() {
Expand Down Expand Up @@ -170,13 +173,13 @@ public void testMapActionInputToConfigDescriptionParameterWhenDate() {
@Test
public void testMapActionInputToConfigDescriptionParameterWhenZonedDateTime() {
checkParameter(helper.mapActionInputToConfigDescriptionParameter(buildInput("java.time.ZonedDateTime")),
ConfigDescriptionParameter.Type.TEXT, false, null, null, null, null);
ConfigDescriptionParameter.Type.TEXT, false, null, "datetime", null, BigDecimal.ONE);
}

@Test
public void testMapActionInputToConfigDescriptionParameterWhenInstant() {
checkParameter(helper.mapActionInputToConfigDescriptionParameter(buildInput("java.time.Instant")),
ConfigDescriptionParameter.Type.TEXT, false, null, null, null, null);
ConfigDescriptionParameter.Type.TEXT, false, null, "datetime", null, BigDecimal.ONE);
}

@Test
Expand Down Expand Up @@ -422,8 +425,8 @@ public void testMapSerializedInputToActionInputWhenLocalDateTime() {

@Test
public void testMapSerializedInputToActionInputWhenZonedDateTime() {
String valAsString = "2007-12-03T10:15:30+01:00[Europe/Paris]";
ZonedDateTime val = ZonedDateTime.parse(valAsString);
String valAsString = "2007-12-03T10:15:30";
ZonedDateTime val = LocalDateTime.parse(valAsString).atZone(timeZoneProvider.getTimeZone());
Input input = buildInput("java.time.ZonedDateTime");
assertThat(helper.mapSerializedInputToActionInput(input, val), is(val));
assertThat(helper.mapSerializedInputToActionInput(input, valAsString), is(val));
Expand All @@ -450,8 +453,8 @@ public void testMapSerializedInputToActionInputWhenDate() {

@Test
public void testMapSerializedInputToActionInputWhenInstant() {
String valAsString = "2017-12-09T20:15:30.00Z";
Instant val = Instant.parse(valAsString);
String valAsString = "2017-12-09T20:15:30.00";
Instant val = LocalDateTime.parse(valAsString).atZone(timeZoneProvider.getTimeZone()).toInstant();
Input input = buildInput("java.time.Instant");
assertThat(helper.mapSerializedInputToActionInput(input, val), is(val));
assertThat(helper.mapSerializedInputToActionInput(input, valAsString), is(val));
Expand Down Expand Up @@ -561,6 +564,14 @@ private void checkParameter(ConfigDescriptionParameter param, String name, Confi
}
}

public class TestTimeZoneProvider implements TimeZoneProvider {

@Override
public ZoneId getTimeZone() {
return ZoneId.of("Europe/Paris");
}
}

public class TestUnitProvider implements UnitProvider {

private final Map<Class<? extends Quantity<?>>, Map<SystemOfUnits, Unit<? extends Quantity<?>>>> dimensionMap = I18nProviderImpl
Expand Down