DateToolsTest.java example

Explorer
bioformats-master
- components
- docs
  - sphinx
    - developers
/*
 * #%L
 * Common package for I/O and related utilities
 * %%
 * Copyright (C) 2015 Open Microscopy Environment:
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 *   - University of Dundee
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

package loci.common.utests;

import static org.testng.AssertJUnit.assertEquals;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;

import loci.common.DateTools;

/**
 * Unit tests for {@link loci.common.DateTools}.
 */
public class DateToolsTest {

  String DATE_FORMAT = "yyyy-MM-dd HH:mm:ss";
  String DATE_FORMAT_AA = "yyyy-MM-dd hh:mm:ss aa";
  String DATE_FORMAT_MS = "yyyy-MM-dd HH:mm:ss:SSS";
  String DATE_FORMAT_MS_AA = "yyyy-MM-dd hh:mm:ss:SSS aa";
  String REFERENCE_DATE = "1970-01-01 00:00:00";
  String REFERENCE_ISO8601 = "1970-01-01T00:00:00";

  String[] DATE_FORMATS = {
    "yyyy:MM:dd HH:mm:ss",
    "yyyy-MM-dd HH:mm:ss",
    "yyyy-MM-dd hh:mm:ss aa"
  };

  String[] DATE_FORMATS_MS = {
    "yyyy:MM:dd HH:mm:ss:SSS",
    "yyyy-MM-dd HH:mm:ss:SSS",
    "yyyy-MM-dd hh:mm:ss:SSS aa"
  };

  @DataProvider(name = "times_no_ms")
  public Object[][] createTimes() {
    return new Object[][] {
      {"1970-01-01 00:00:01", 1000L, "1970-01-01T00:00:01"},
      {"1970-01-01 00:01:00", 60000L, "1970-01-01T00:01:00"},
      {"1970-01-01 01:00:00", 3600000L, "1970-01-01T01:00:00"},
      {"1970-01-02 00:00:00", 86400000L, "1970-01-02T00:00:00"},
    };
  }

  @DataProvider(name = "times_ms_1")
  public Object[][] createTimesMs1() {
    return new Object[][] {
      {"1970-01-01 00:00:00:1", 100L, "1970-01-01T00:00:00.100"},
      {"1970-01-01 00:00:00:10", 100L, "1970-01-01T00:00:00.100"},
      {"1970-01-01 00:00:00:100", 100L,  "1970-01-01T00:00:00.100"},
      {"1970-01-01 00:00:00:010", 10L, "1970-01-01T00:00:00.010"},
      {"1970-01-01 00:00:00:001", 1L, "1970-01-01T00:00:00.001"},
    };
  }

  @DataProvider(name = "times_ms_2")
  public Object[][] createTimesMs2() {
    return new Object[][] {
      {"1970-01-01 00:00:00:1", 1L, "1970-01-01T00:00:00.001"},
      {"1970-01-01 00:00:00:10", 10L, "1970-01-01T00:00:00.010"},
      {"1970-01-01 00:00:00:100", 100L,  "1970-01-01T00:00:00.100"},
      {"1970-01-01 00:00:00:010", 10L, "1970-01-01T00:00:00.010"},
      {"1970-01-01 00:00:00:001", 1L, "1970-01-01T00:00:00.001"},
    };
  }

  @DataProvider(name = "times_aa")
  public Object[][] createTimesAA() {
    return new Object[][] {
      {"1970-01-01 01:00:00 AM", 3600000L, "1970-01-01T01:00:00"},
      {"1970-01-01 01:00:00 PM", 46800000L, "1970-01-01T13:00:00"},
    };
  }

  @DataProvider(name = "times_ms_aa_1")
  public Object[][] createTimesMsAA1() {
    return new Object[][] {
      {"1970-01-01 01:00:00:10 AM", 3600100L, "1970-01-01T01:00:00.100"},
      {"1970-01-01 01:00:00:10 PM", 46800100L, "1970-01-01T13:00:00.100"},
    };
  }

  @DataProvider(name = "times_ms_aa_2")
  public Object[][] createTimesMsAA2() {
    return new Object[][] {
      {"1970-01-01 01:00:00:10 AM", 3600010L,  "1970-01-01T01:00:00.010"},
      {"1970-01-01 01:00:00:10 PM", 46800010L,  "1970-01-01T13:00:00.010"},
    };
  }

  @DataProvider(name = "times_ms_separators")
  public Object[][] createTimesSeparators() {
    return new Object[][] {
      {"1970-01-01 00:00:00:10", 10L, ":", "1970-01-01T00:00:00.010"},
      {"1970-01-01 00:00:00.10", 10L, ".", "1970-01-01T00:00:00.010"},
      {"1970-01-01 00:00:00-10", 10L, "-", "1970-01-01T00:00:00.010"},
    };
  }

  @Test(dataProvider = "times_no_ms")
  public void testNoMilliseconds(String date, long ms, String date2) {
    // Test without separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, false));
    // Test with null separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, false, null));
    // Test with unfound separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, false, "."));
    // Test with multiple date formats
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, false));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, false, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, false, "."));
  }

  @Test()
  public void testInvalidTime() {
    assertEquals(-1, DateTools.getTime("wrongdate", DATE_FORMAT));
    assertEquals(-1, DateTools.getTime("wrongdate", DATE_FORMAT, "."));
    assertEquals(-1, DateTools.getTime("wrongdate", DATE_FORMAT, null));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMAT));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMAT, false));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMAT, "."));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMAT, null));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMATS));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMATS, false));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMATS, null));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMATS, "."));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMATS, false, null));
    assertEquals(null, DateTools.formatDate("wrongdate", DATE_FORMATS, false, "."));
  }

  @Test(dataProvider = "times_ms_1")
  public void testTimeMsNoSeparator(String date, long ms, String date2) {
    // Test without separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_MS));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS, false));
    // Test with null separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_MS, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS, false, null));
    // Test with unfound separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_MS, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS, false, "."));
    // Test with multiple date formats
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, false));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, false, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, false, "."));
  }

  @Test(dataProvider = "times_ms_2")
  public void testTimeMsSeparator(String date, long ms, String date2) {
    // Test with correct separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT, ":"));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, ":"));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, false, ":"));
    // Test with null separator argument
    assertEquals(-1, DateTools.getTime(date, DATE_FORMAT, null));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMAT, null));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMAT, false, null));
    // Test with unfound separator argument
    assertEquals(-1, DateTools.getTime(date, DATE_FORMAT, "."));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMAT, "."));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMAT, false, "."));
    // Test with multiple date formats
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, false));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, ":"));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, "."));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, false, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, false, ":"));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, false, "."));
  }

  @Test(dataProvider = "times_aa")
  public void testTimeAa(String date, long ms, String date2) {
    // Test without separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_AA));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_AA));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_AA, false));
    // Test with null separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_AA, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_AA, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_AA, false, null));
    // Test with unfound separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_AA, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_AA, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_AA, false, "."));
    // Test with multiple date formats
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, false));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, false, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, false, "."));
  }

  @Test(dataProvider = "times_ms_aa_1")
  public void testTimeMsAaNoSeparator(String date, long ms, String date2) {
    // Test without separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_MS_AA));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS_AA));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS_AA, false));
    // Test with null separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_MS_AA, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS_AA, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS_AA, false, null));
    // Test with unfound separator argument
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_MS_AA, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS_AA, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_MS_AA, false, "."));
    // Test with multiple date formats
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, false));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, "."));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, false, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS_MS, false, "."));
  }

  @Test(dataProvider = "times_ms_aa_2")
  public void testTimeMsAaSeparator(String date, long ms, String date2) {
    // Test with correct milliseconds separator
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT_AA, ":"));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_AA, ":"));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT_AA, false, ":"));
    // Test with null separator argument
    assertEquals(-1, DateTools.getTime(date, DATE_FORMAT_AA, null));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMAT_AA, null));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMAT_AA, false, null));
    // Test with unfound milliseconds separator
    assertEquals(-1, DateTools.getTime(date, DATE_FORMAT_AA, "."));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMAT_AA, "."));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMAT_AA, false, "."));
    // Test with multiple date formats
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, false));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, ":"));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, "."));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, false, null));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMATS, false, ":"));
    assertEquals(null, DateTools.formatDate(date, DATE_FORMATS, false, "."));
  }

  @Test(dataProvider = "times_ms_separators")
  public void testTimeMsSeparators(String date, long ms, String separator, String date2) {
    assertEquals(ms, DateTools.getTime(date, DATE_FORMAT, separator));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, separator));
    assertEquals(date2, DateTools.formatDate(date, DATE_FORMAT, false, separator));
  }

  @Test
  public void testDateNoMsWithSeparator() {
    // Test that parsing times with no milliseconds with a separator passes
    assertEquals(0L, DateTools.getTime(REFERENCE_DATE, DATE_FORMAT, "."));
    assertEquals(REFERENCE_ISO8601, DateTools.formatDate(REFERENCE_DATE, DATE_FORMAT, "."));
    assertEquals(REFERENCE_ISO8601, DateTools.formatDate(REFERENCE_DATE, DATE_FORMAT, false, "."));
  }

  @Test
  public void testGetTimeConflictingSeparator() {
    assertEquals(-1, DateTools.getTime(REFERENCE_DATE, DATE_FORMAT, ":"));
    assertEquals(null, DateTools.formatDate(REFERENCE_DATE, DATE_FORMAT, ":"));
  }

  @Test
  public void testUnrecognizedTrailingPattern() {
    // Date parsing should fail but the method should still return
    String date1 = REFERENCE_DATE + ".000 AM";  // space separated
    assertEquals(-1, DateTools.getTime(date1, DATE_FORMAT, "."));
    assertEquals(null, DateTools.formatDate(date1, DATE_FORMAT, "."));
    assertEquals(null, DateTools.formatDate(date1, DATE_FORMAT, false, "."));
    String date2 = REFERENCE_DATE + ".000Z";  // non-digit character
    assertEquals(-1, DateTools.getTime(date2, DATE_FORMAT, "."));
    assertEquals(null, DateTools.formatDate(date2, DATE_FORMAT, "."));
    assertEquals(null, DateTools.formatDate(date2, DATE_FORMAT, false, "."));
  }

  @Test
  public void testParseLongException() {
    // NumberFormatException should be catched internally when parsing
    // milliseconds but the method should still return 
    String date1 = REFERENCE_DATE + ".a11";
    assertEquals(0L, DateTools.getTime(date1, DATE_FORMAT, "."));
    assertEquals(REFERENCE_ISO8601, DateTools.formatDate(date1, DATE_FORMAT, "."));
    assertEquals(REFERENCE_ISO8601, DateTools.formatDate(date1, DATE_FORMAT, false, "."));
    String date2 = REFERENCE_DATE + ".a11 aa";
    assertEquals(0L, DateTools.getTime(date2, DATE_FORMAT, "."));
    assertEquals(REFERENCE_ISO8601, DateTools.formatDate(date2, DATE_FORMAT, "."));
    assertEquals(REFERENCE_ISO8601, DateTools.formatDate(date2, DATE_FORMAT, false, "."));
  }

  @Test
  public void testTrim() {
    String date1 = " " + REFERENCE_DATE;
    assertEquals(0L, DateTools.getTime(date1, DATE_FORMAT));
    assertEquals(REFERENCE_ISO8601, DateTools.formatDate(date1, DATE_FORMAT));

    String date2 = REFERENCE_DATE + " ";
    assertEquals(0L, DateTools.getTime(date2, DATE_FORMAT));
    assertEquals(REFERENCE_ISO8601, DateTools.formatDate(date2, DATE_FORMAT));
  }
}