Skip to content

Commit

Permalink
Retain timezone if date pattern contains TZ (#4279)
Browse files Browse the repository at this point in the history 
The date converter should retain the timezone contained in the timestamp
even if the users provided another (default) timezone in the configuration
of the date converter.
  • Loading branch information
@joschi @kmerz
joschi authored and kmerz committed Apr 27, 2018
1 parent 3474091 commit 0ef2e31
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 51 deletions.
26 changes: 17 additions & 9 deletions graylog2-server/src/main/java/org/graylog2/inputs/converters/DateConverter.java
View file
Expand Up @@ -18,7 +18,6 @@

import org.graylog2.ConfigurationException;
import org.joda.time.DateTime;
import org.joda.time.DateTimeZone;
import org.joda.time.YearMonth;
import org.joda.time.format.DateTimeFormat;
import org.joda.time.format.DateTimeFormatter;
Expand All @@ -29,8 +28,6 @@
import java.util.Locale;
import java.util.Map;

import static com.google.common.base.MoreObjects.firstNonNull;
import static com.google.common.base.Strings.emptyToNull;
import static com.google.common.base.Strings.isNullOrEmpty;

public class DateConverter extends AbstractDateConverter {
Expand All @@ -39,6 +36,7 @@ public class DateConverter extends AbstractDateConverter {

private final String dateFormat;
private final Locale locale;
private final boolean containsTimeZone;

public DateConverter(Map<String, Object> config) throws ConfigurationException {
super(Type.DATE, config);
Expand All @@ -49,6 +47,7 @@ public DateConverter(Map<String, Object> config) throws ConfigurationException {

this.dateFormat = ((String) config.get("date_format")).trim();
this.locale = buildLocale(config.get("locale"));
this.containsTimeZone = dateFormat.contains("Z") || dateFormat.contains("z");
}

private static Locale buildLocale(Object languageTag) {
Expand All @@ -70,12 +69,21 @@ public Object convert(@Nullable String value) {
return null;
}

LOG.debug("Trying to parse date <{}> with pattern <{}> and timezone <{}>.", value, dateFormat, timeZone);
final DateTimeFormatter formatter = DateTimeFormat
.forPattern(dateFormat)
.withLocale(locale)
.withDefaultYear(YearMonth.now(timeZone).getYear())
.withZone(timeZone);
LOG.debug("Trying to parse date <{}> with pattern <{}>, locale <{}>, and timezone <{}>.", value, dateFormat, locale, timeZone);
final DateTimeFormatter formatter;
if (containsTimeZone) {
formatter = DateTimeFormat
.forPattern(dateFormat)
.withDefaultYear(YearMonth.now(timeZone).getYear())
.withLocale(locale);
} else {
formatter = DateTimeFormat
.forPattern(dateFormat)
.withDefaultYear(YearMonth.now(timeZone).getYear())
.withLocale(locale)
.withZone(timeZone);
}

return DateTime.parse(value, formatter);
}
}
105 changes: 63 additions & 42 deletions graylog2-server/src/test/java/org/graylog2/inputs/converters/DateConverterTest.java
View file
Expand Up @@ -16,57 +16,80 @@
*/
package org.graylog2.inputs.converters;

import org.assertj.jodatime.api.Assertions;
import org.graylog2.ConfigurationException;
import org.graylog2.plugin.inputs.Converter;
import org.joda.time.DateTime;
import org.joda.time.DateTimeUtils;
import org.joda.time.DateTimeZone;
import org.joda.time.Duration;
import org.joda.time.YearMonth;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

import java.util.HashMap;
import java.util.Locale;
import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.jodatime.api.Assertions.assertThat;

public class DateConverterTest {
@Before
public void setUp() {
DateTimeUtils.setCurrentMillisFixed(DateTime.parse("2017-01-01T00:00:00.000Z").getMillis());
}

@After
public void tearDown() {
DateTimeUtils.setCurrentMillisSystem();
}

@Test
public void testBasicConvert() throws Exception {
// .startsWith() because of possibly different timezones per test environment.
final DateConverter converter = new DateConverter(config("YYYY MMM dd HH:mm:ss", null, null));
final Object result = converter.convert("2013 Aug 15 23:15:16");
assertThat(result).isNotNull();
assertThat(String.valueOf(result)).startsWith("2013-08-15T23:15:16.000");
final DateTime result = (DateTime) converter.convert("2013 Aug 15 23:15:16");
assertThat(result)
.isNotNull()
.isEqualTo("2013-08-15T23:15:16.000Z");
}

@Test
public void testAnotherBasicConvert() throws Exception {
final DateConverter converter = new DateConverter(config("yyyy-MM-dd'T'HH:mm:ss.SSSSSSZZ", "Etc/UTC", null));
final DateTime date = (DateTime) converter.convert("2014-05-19T00:30:43.116+00:00");
assertThat(date).isNotNull();
Assertions.assertThat(date).isEqualTo(new DateTime(2014, 5, 19, 0, 30, 43, 116, DateTimeZone.UTC));
assertThat(date)
.isNotNull()
.isEqualTo("2014-05-19T00:30:43.116Z");
}

@Test
public void testNullInput() throws Exception {
final DateConverter converter = new DateConverter(config("yyyy-MM-dd'T'HH:mm:ss.SSSZ", null, null));
assertThat((DateTime) converter.convert(null)).isNull();
}

@Test
public void testEmptyInput() throws Exception {
final DateConverter converter = new DateConverter(config("yyyy-MM-dd'T'HH:mm:ss.SSSZ", null, null));
assertThat((DateTime) converter.convert("")).isNull();
}

@Test
public void testConvertWithoutYear() throws Exception {
final int year = YearMonth.now(DateTimeZone.UTC).getYear();
final DateConverter converter = new DateConverter(config("dd-MM HH:mm:ss", "Etc/UTC", null));
final DateTime date = (DateTime) converter.convert("19-05 10:20:30");
assertThat(date).isNotNull();
Assertions.assertThat(date).isEqualTo(new DateTime(year, 5, 19, 10, 20, 30, DateTimeZone.UTC));
assertThat(date)
.isNotNull()
.isEqualTo("2017-05-19T10:20:30.000Z");
}

@Test(expected = ConfigurationException.class)
public void testWithEmptyDateFormat() throws Exception {
assertThat(new DateConverter(config("", null, null)).convert("foo")).isNull();
final DateConverter converter = new DateConverter(config("", null, null));
assertThat((DateTime) converter.convert("foo")).isNull();
}

@Test(expected = ConfigurationException.class)
public void testWithNullDateFormat() throws Exception {
assertThat(new DateConverter(config(null, null, null)).convert("foo")).isNull();
final DateConverter dateConverter = new DateConverter(config(null, null, null));
assertThat((DateTime) dateConverter.convert("foo")).isNull();
}

@Test
Expand All @@ -75,58 +98,59 @@ public void convertObeysTimeZone() throws Exception {
final Converter c = new DateConverter(config("YYYY-MM-dd HH:mm:ss", timeZone.toString(), null));

final DateTime dateOnly = (DateTime) c.convert("2014-03-12 10:00:00");
assertThat(dateOnly.getZone()).isEqualTo(timeZone);

Assertions.assertThat(dateOnly)
.isEqualTo(new DateTime(2014, 3, 12, 10, 0, 0, timeZone))
.isBefore(new DateTime(2014, 3, 13, 10, 0, 0, timeZone));
assertThat(dateOnly).isEqualTo("2014-03-12T10:00:00.000+12:00");

final DateTime dateTime = (DateTime) c.convert("2014-03-12 12:34:00");
assertThat(dateTime.getZone()).isEqualTo(timeZone);
Assertions.assertThat(dateTime)
.isEqualTo(new DateTime(2014, 3, 12, 12, 34, 0, timeZone));
assertThat(dateTime).isEqualTo("2014-03-12T12:34:00.000+12:00");
}

@Test
public void convertUsesEtcUTCIfTimeZoneSettingIsEmpty() throws Exception {
final Converter c = new DateConverter(config("YYYY-MM-dd HH:mm:ss", "", null));
final DateTime dateOnly = (DateTime) c.convert("2014-03-12 10:00:00");
assertThat(dateOnly.getZone()).isEqualTo(DateTimeZone.forID("Etc/UTC"));
final DateTime dateTime = (DateTime) c.convert("2014-03-12 10:00:00");
assertThat(dateTime).isEqualTo("2014-03-12T10:00:00.000Z");
}

@Test
public void convertUsesEtcUTCIfTimeZoneSettingIsBlank() throws Exception {
final Converter c = new DateConverter(config("YYYY-MM-dd HH:mm:ss", " ", null));
final DateTime dateOnly = (DateTime) c.convert("2014-03-12 10:00:00");
assertThat(dateOnly.getZone()).isEqualTo(DateTimeZone.forID("Etc/UTC"));
final DateTime dateTime = (DateTime) c.convert("2014-03-12 10:00:00");
assertThat(dateTime).isEqualTo("2014-03-12T10:00:00.000Z");
}

@Test
public void convertUsesEtcUTCIfTimeZoneSettingIsInvalid() throws Exception {
final Converter c = new DateConverter(config("YYYY-MM-dd HH:mm:ss", "TEST", null));
final DateTime dateOnly = (DateTime) c.convert("2014-03-12 10:00:00");
assertThat(dateOnly.getZone()).isEqualTo(DateTimeZone.forID("Etc/UTC"));
final DateTime dateTime = (DateTime) c.convert("2014-03-12 10:00:00");
assertThat(dateTime).isEqualTo("2014-03-12T10:00:00.000Z");
}

@Test
public void convertIgnoresTZIfDatePatternContainsTZ() throws Exception {
final Converter c = new DateConverter(config("YYYY-MM-dd'T'HH:mm:ss.SSSZ", "Etc/UTC", null));
final DateTime actual = (DateTime) c.convert("2014-03-12T10:00:00.000+06:00");
assertThat(actual).isEqualTo("2014-03-12T10:00:00.000+06:00");
}

@Test
public void convertUsesEnglishIfLocaleIsNull() throws Exception {
final Converter c = new DateConverter(config("dd/MMM/YYYY HH:mm:ss Z", null, null));
final DateTime dateOnly = (DateTime) c.convert("11/May/2017 15:10:48 +0200");
Assertions.assertThat(dateOnly).isEqualTo(new DateTime(2017, 5, 11, 13, 10, 48, DateTimeZone.UTC));
final DateTime dateTime = (DateTime) c.convert("11/May/2017 15:10:48 +0200");
assertThat(dateTime).isEqualTo("2017-05-11T13:10:48.000Z");
}

@Test
public void convertUsesEnglishIfLocaleIsInvalid() throws Exception {
final Converter c = new DateConverter(config("dd/MMM/YYYY HH:mm:ss Z", null, "Wurstweck"));
final DateTime dateOnly = (DateTime) c.convert("11/May/2017 15:10:48 +0200");
Assertions.assertThat(dateOnly).isEqualTo(new DateTime(2017, 5, 11, 13, 10, 48, DateTimeZone.UTC));
final DateTime dateTime = (DateTime) c.convert("11/May/2017 15:10:48 +0200");
assertThat(dateTime).isEqualTo("2017-05-11T13:10:48.000Z");
}

@Test
public void convertUsesCustomLocale() throws Exception {
final Converter c = new DateConverter(config("dd/MMM/YYYY HH:mm:ss Z", null, "de-DE"));
final DateTime dateOnly = (DateTime) c.convert("11/März/2017 15:10:48 +0200");
Assertions.assertThat(dateOnly).isEqualTo(new DateTime(2017, 3, 11, 13, 10, 48, DateTimeZone.UTC));
final DateTime dateTime = (DateTime) c.convert("11/März/2017 15:10:48 +0200");
assertThat(dateTime).isEqualTo("2017-03-11T13:10:48.000Z");
}

/**
Expand All @@ -136,18 +160,15 @@ public void convertUsesCustomLocale() throws Exception {
public void issue2648() throws Exception {
final Converter utc = new DateConverter(config("YYYY-MM-dd HH:mm:ss", "UTC", null));
final DateTime utcDate = (DateTime) utc.convert("2016-08-10 12:00:00");
assertThat(utcDate.getZone()).isEqualTo(DateTimeZone.UTC);
assertThat(utcDate.getZone().getOffsetFromLocal(0L)).isEqualTo(0);
assertThat(utcDate).isEqualTo("2016-08-10T12:00:00.000Z");

final Converter cet = new DateConverter(config("YYYY-MM-dd HH:mm:ss", "CET", null));
final DateTime cetDate = (DateTime) cet.convert("2016-08-10 12:00:00");
assertThat(cetDate.getZone()).isEqualTo(DateTimeZone.forID("CET"));
assertThat(cetDate.getZone().getOffsetFromLocal(0L)).isEqualTo((int) Duration.standardHours(1L).getMillis());
assertThat(cetDate).isEqualTo(new DateTime("2016-08-10T12:00:00.000", DateTimeZone.forID("CET")));

final Converter berlin = new DateConverter(config("YYYY-MM-dd HH:mm:ss", "Europe/Berlin", null));
final DateTime berlinDate = (DateTime) berlin.convert("2016-08-10 12:00:00");
assertThat(berlinDate.getZone()).isEqualTo(DateTimeZone.forID("Europe/Berlin"));
assertThat(berlinDate.getZone().getOffsetFromLocal(0L)).isEqualTo((int) Duration.standardHours(1L).getMillis());
assertThat(berlinDate).isEqualTo(new DateTime("2016-08-10T12:00:00.000", DateTimeZone.forID("Europe/Berlin")));
}

private Map<String, Object> config(final String dateFormat, final String timeZone, final String locale) {
Expand Down

0 comments on commit 0ef2e31

Please sign in to comment.