ParseDateTest

/*
 * Copyright 2007 Kasper B. Graversen
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.supercsv.cellprocessor;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import static org.supercsv.SuperCsvTestUtils.ANONYMOUS_CSVCONTEXT;
import static org.supercsv.SuperCsvTestUtils.date;

import java.text.SimpleDateFormat;
import java.util.Arrays;
import java.util.Date;
import java.util.Locale;

import org.junit.Before;
import org.junit.Test;
import org.supercsv.cellprocessor.ift.CellProcessor;
import org.supercsv.exception.SuperCsvCellProcessorException;
import org.supercsv.mock.IdentityTransform;

/**
 * Tests the ParseDate processor. As ParseDate uses the default locale, this test must be written in a locale
 * independent way (so the test will pass). The test can be run in a different local by specifying the
 * <tt>user.language</tt> and <tt>user.country</tt> JVM properties (i.e. <tt>-Duser.language=de -Duser.country=DE</tt>).
 *
 * @author Kasper B. Graversen
 * @author James Bassett
 */
public class ParseDateTest {

	private static final Date DATE = date(2011, 12, 25);
	private static final String DATE_FORMAT = "dd/MM/yyyy";
	private static final String FORMATTED_DATE = "25/12/2011";
	private static final String DATE_FORMAT2 = "EEE, MMM d, ''yy";

	// locale-independent ("Sun, Dec 25, '11" in en)
	private static final String FORMATTED_DATE2 = new SimpleDateFormat(DATE_FORMAT2).format(DATE);

	private static final String GERMAN_DATE = new SimpleDateFormat(DATE_FORMAT2, Locale.GERMAN).format(DATE);

	private CellProcessor processor;
	private CellProcessor processor2;
	private CellProcessor processor3;
	private CellProcessor processorChain;
	private CellProcessor processorChain2;
	private CellProcessor processorChain3;

	/**
	 * Sets up the processors for the test using all constructor combinations.
	 */
	@Before
	public void setUp() {
		processor = new ParseDate(DATE_FORMAT);
		processor2 = new ParseDate(DATE_FORMAT, true);
		processor3 = new ParseDate(DATE_FORMAT, false);
		processorChain = new ParseDate(DATE_FORMAT, new IdentityTransform());
		processorChain2 = new ParseDate(DATE_FORMAT, true, new IdentityTransform());
		processorChain3 = new ParseDate(DATE_FORMAT, false, new IdentityTransform());
	}

	/**
	 * Tests unchained/chained execution with various date formats.
	 */
	@Test
	public void testValidDate() {
		// first date format
		assertEquals(DATE, processor.execute(FORMATTED_DATE, ANONYMOUS_CSVCONTEXT));
		assertEquals(DATE, processor2.execute(FORMATTED_DATE, ANONYMOUS_CSVCONTEXT));
		assertEquals(DATE, processor3.execute(FORMATTED_DATE, ANONYMOUS_CSVCONTEXT));
		assertEquals(DATE, processorChain.execute(FORMATTED_DATE, ANONYMOUS_CSVCONTEXT));
		assertEquals(DATE, processorChain2.execute(FORMATTED_DATE, ANONYMOUS_CSVCONTEXT));
		assertEquals(DATE, processorChain3.execute(FORMATTED_DATE, ANONYMOUS_CSVCONTEXT));

	}

	/**
	 * Tests unchained/chained execution with a different date format.
	 */
	@Test
	public void testValidDateDifferentFormat() {

		final CellProcessor differentFormat = new ParseDate(DATE_FORMAT2);
		final CellProcessor differentFormatChain = new ParseDate(DATE_FORMAT2, new IdentityTransform());

		// try a different date format
		assertEquals(DATE, differentFormat.execute(FORMATTED_DATE2, ANONYMOUS_CSVCONTEXT));
		assertEquals(DATE, differentFormatChain.execute(FORMATTED_DATE2, ANONYMOUS_CSVCONTEXT));
	}

	/**
	 * Tests parsing a Date formatted in a different locale.
	 */
	@Test
	public void testDifferentLocale() {
		final CellProcessor germanProcessor = new ParseDate(DATE_FORMAT2, false, Locale.GERMAN);
		assertEquals(DATE, germanProcessor.execute(GERMAN_DATE, ANONYMOUS_CSVCONTEXT));

		final CellProcessor germanProcessorChain = new ParseDate(DATE_FORMAT2, false, Locale.GERMAN,
			new IdentityTransform());
		assertEquals(DATE, germanProcessorChain.execute(GERMAN_DATE, ANONYMOUS_CSVCONTEXT));
	}

	/**
	 * Tests execution with an invalid date (doesn't match format), should throw an exception.
	 */
	@Test(expected = SuperCsvCellProcessorException.class)
	public void testBadlyFormattedDate() {
		processor.execute("2011-12-25", ANONYMOUS_CSVCONTEXT);
	}

	/**
	 * Tests execution with an invalid date (matches format, but data invalid) and non-lenient processors (should throw
	 * an exception).
	 */
	@Test
	public void testInvalidDateWithNonLenient() {
		final String dodgyDate = "30/02/2012";
		for( final CellProcessor cp : Arrays.asList(processor, processor3, processorChain, processorChain3) ) {
			try {
				cp.execute(dodgyDate, ANONYMOUS_CSVCONTEXT);
				fail("should have thrown a SuperCsvCellProcessorException");
			}
			catch(SuperCsvCellProcessorException e) {}
		}
	}

	/**
	 * Tests execution with an invalid date (matches format, but data invalid) and lenient processors (should work!).
	 */
	@Test
	public void testInvalidDateWithLenient() {
		final String dodgyDate = "30/02/2012";
		final Date expectedDate = date(2012, 3, 1);
		assertEquals(expectedDate, processor2.execute(dodgyDate, ANONYMOUS_CSVCONTEXT));
		assertEquals(expectedDate, processorChain2.execute(dodgyDate, ANONYMOUS_CSVCONTEXT));
	}

	/**
	 * Tests execution with a non String input (should throw an exception).
	 */
	@Test(expected = SuperCsvCellProcessorException.class)
	public void testWithNonCharInput() {
		processor.execute(1, ANONYMOUS_CSVCONTEXT);
	}

	/**
	 * Tests execution with a null input (should throw an Exception).
	 */
	@Test(expected = SuperCsvCellProcessorException.class)
	public void testWithNull() {
		processor.execute(null, ANONYMOUS_CSVCONTEXT);
	}

	/**
	 * Tests construction with a null date format (should throw an Exception).
	 */
	@Test(expected = NullPointerException.class)
	public void testConstructorWithNullDateFormat() {
		new ParseDate(null);
	}

	/**
	 * Tests construction (using the Locale constructor) with a null date format (should throw an Exception).
	 */
	@Test(expected = NullPointerException.class)
	public void testLocaleConstructorWithNullDateFormat() {
		new ParseDate(null, false, Locale.GERMAN);
	}

	/**
	 * Tests construction (using the Locale constructor) with a null locale (should throw an Exception).
	 */
	@Test(expected = NullPointerException.class)
	public void testLocaleConstructorWithNullLocale() {
		new ParseDate(DATE_FORMAT, false, (Locale) null);
	}

}