AbstractRoutinesTest.java

/*******************************************************************************
 * Copyright 2016 Univocity Software Pty Ltd
 *
 * 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 com.univocity.parsers.common.routine;

import com.univocity.parsers.*;
import com.univocity.parsers.common.processor.*;
import com.univocity.parsers.conversions.*;
import com.univocity.parsers.csv.*;
import com.univocity.parsers.examples.*;
import com.univocity.parsers.fixed.*;
import com.univocity.parsers.tsv.*;
import org.testng.annotations.*;

import java.io.*;
import java.sql.*;
import java.util.*;

import static org.testng.Assert.*;

public class AbstractRoutinesTest {

	private CsvParserSettings getParserSettings() {
		CsvParserSettings out = new CsvParserSettings();
		out.getFormat().setLineSeparator("\n");
		return out;
	}

	private CsvWriterSettings getWriterSettings() {
		CsvWriterSettings out = new CsvWriterSettings();
		out.getFormat().setLineSeparator("\n");
		return out;
	}

	static class ResultSetTest {
		AbstractRoutines routineImpl;
		String result;

		ResultSetTest(AbstractRoutines routineImpl) {
			this.routineImpl = routineImpl;
		}

		void run(ResultSet rs) throws Exception {
			StringWriter output = new StringWriter();

			routineImpl.setKeepResourcesOpen(true);

			routineImpl.write(rs, output);

			output.write("A random line");
			assertFalse(rs.isClosed());

			output.close();

			result = output.toString();

			rs.close();
		}

	}

	@Test
	public void testWriteResultSet() throws Exception {
		ObjectRowWriterProcessor processor = new ObjectRowWriterProcessor();
		processor.convertType(java.sql.Timestamp.class, Conversions.toDate("dd/MM/yyyy HH:mm"));

		CsvRoutines csvRoutine = new CsvRoutines();
		csvRoutine.setWriterSettings(getWriterSettings());
		csvRoutine.getWriterSettings().setRowWriterProcessor(processor);
		ResultSetTest csvTest = new ResultSetTest(csvRoutine);

		TsvRoutines tsvRoutine = new TsvRoutines();
		tsvRoutine.setWriterSettings(new TsvWriterSettings());
		tsvRoutine.getWriterSettings().getFormat().setLineSeparator("\n");
		tsvRoutine.getWriterSettings().setRowWriterProcessor(processor);
		ResultSetTest tsvTest = new ResultSetTest(tsvRoutine);

		FixedWidthRoutines fixedWidthRoutine = new FixedWidthRoutines();
		fixedWidthRoutine.setWriterSettings(new FixedWidthWriterSettings());
		fixedWidthRoutine.getWriterSettings().getFormat().setLineSeparator("\n");
		fixedWidthRoutine.getWriterSettings().getFormat().setPadding('.');
		fixedWidthRoutine.getWriterSettings().setRowWriterProcessor(processor);
		ResultSetTest fixedWidthTest = new ResultSetTest(fixedWidthRoutine);

		testWriteResultSet(csvTest, tsvTest, fixedWidthTest);
		String randomLine = "A random line";

		String expectedCsv = "" +
				"1234,Description 1,02/12/2015 10:35\n" +
				"2345,Description 2,25/11/2016 11:05\n" +
				"39,Description 3,31/05/2017 09:24\n";

		String expectedTsv = "" +
				"1234\tDescription 1\t02/12/2015 10:35\n" +
				"2345\tDescription 2\t25/11/2016 11:05\n" +
				"39\tDescription 3\t31/05/2017 09:24\n";

		String expectedFixedWidth = "" +
				"1234Description 1...................02/12/2015 10:35..................\n" +
				"2345Description 2...................25/11/2016 11:05..................\n" +
				"39..Description 3...................31/05/2017 09:24..................\n";

		assertEquals(csvTest.result, expectedCsv + randomLine);
		assertEquals(tsvTest.result, expectedTsv + randomLine);
		assertEquals(fixedWidthTest.result, expectedFixedWidth + randomLine);
	}


	private void testWriteResultSet(ResultSetTest... tests) throws Exception {
		String createTable = "CREATE TABLE test(" +
				"	id char(4) primary key," +
				"	desc varchar(32) not null," +
				"	some_date datetime not null" +
				")";

		Class.forName("org.hsqldb.jdbcDriver");
		Connection connection = DriverManager.getConnection("jdbc:hsqldb:mem:run");
		try {
			Statement statement = connection.createStatement();
			try {
				try {
					statement.execute(createTable);
					statement.executeUpdate("INSERT INTO test (id, desc, some_date) VALUES ('1234', 'Description 1', '2015-12-02 10:35:12')");
					statement.executeUpdate("INSERT INTO test (id, desc, some_date) VALUES ('2345', 'Description 2', '2016-11-25 11:05:32')");
					statement.executeUpdate("INSERT INTO test (id, desc, some_date) VALUES ('39' , 'Description 3', '2017-05-31 09:24:45')");
				} catch(Exception ex){
					//ignore. Table exists already.
				}

				for (ResultSetTest test : tests) {
					ResultSet rs = statement.executeQuery("SELECT id, desc, some_date FROM test ORDER BY id");
					try {
						test.run(rs);
					} finally {
						rs.close();
					}
				}

			} finally {
				statement.close();
			}
		} finally {
			connection.close();
		}
	}

	@Test
	public void testParseAndWrite() throws Exception {
		CsvRoutines csvRoutines = new CsvRoutines();
		CsvParserSettings parser = getParserSettings();
		parser.setNumberOfRowsToSkip(2);
		parser.setHeaderExtractionEnabled(true);

		parser.selectFields("Description");
		csvRoutines.setParserSettings(parser);

		CsvWriterSettings writer = new CsvWriterSettings();
		writer.getFormat().setDelimiter('|');
		writer.getFormat().setLineSeparator("\r\n");
		writer.getFormat().setQuoteEscape('$');
		writer.getFormat().setQuote('$');
		writer.setSkipEmptyLines(true);
		csvRoutines.setWriterSettings(writer);

		StringWriter output = new StringWriter();

		csvRoutines.parseAndWrite(ParserTestCase.newReader("/csv/essential.csv"), output);

		String expected = "ac, abs, moon\r\n" +
				"$MUST SELL!\r\n" +
				"air, moon roof, loaded$\r\n" +
				"ac, abs, moon\r\n" +
				"ac, abs, moon\r\n" +
				"ac, abs, moon\r\n" +
				"ac, abs, moon\r\n" +
				"\" ac, abs, moon \"\r\n" +
				"\" ac, abs, moon \"\r\n";

		assertEquals(output.toString(), expected);


	}

	@Test
	public void testParseAllJavaBeans() throws Exception {
		List<TestBean> beans = new CsvRoutines(getParserSettings()).parseAll(TestBean.class, CsvParserTest.newReader("/examples/bean_test.csv"));
		assertNotNull(beans);
		assertFalse(beans.isEmpty());
	}

	@Test
	public void testWriteAllJavaBeans() throws Exception {
		List<TestBean> beans = new CsvRoutines(getParserSettings()).parseAll(TestBean.class, CsvParserTest.newReader("/examples/bean_test.csv"));

		StringWriter output = new StringWriter();
		CsvWriterSettings settings = getWriterSettings();
		new CsvRoutines(settings).writeAll(beans, TestBean.class, output);
		assertEquals(output.toString(), "1,555.999,yes,,?\n0,,no,,\"\"\" something \"\"\"\n");

		output = new StringWriter();
		new CsvRoutines(settings).writeAll(beans, TestBean.class, output, "pending", "amount");
		assertEquals(output.toString(), "pending,amount\nyes,555.999\nno,\n");
	}


	@Test
	public void testIterateJavaBeans() throws Exception {
		List<TestBean> beans = new ArrayList<TestBean>();
		for (TestBean bean : new CsvRoutines(getParserSettings()).iterate(TestBean.class, CsvParserTest.newReader("/examples/bean_test.csv"))) {
			beans.add(bean);
		}
		assertEquals(beans.size(), 2);
		assertEquals(beans.get(0).getQuantity(), Integer.valueOf(1));
		assertEquals(beans.get(1).getComments(), "\" something \"");
	}

	@Test
	public void testResourcesOpenFlagWithOutputStream() throws Exception {
		final File tmp = File.createTempFile("test", ".csv");

		testWriteResultSet(new ResultSetTest(null) {
			public void run(ResultSet rs) {
				CsvWriterSettings settings = new CsvWriterSettings();
				CsvRoutines csvRoutines = new CsvRoutines(settings);
				csvRoutines.setKeepResourcesOpen(true);

				FileOutputStream fout = null;
				try {
					try {
						fout = new FileOutputStream(tmp);
						csvRoutines.write(rs, fout);
					} finally {
						fout.close();
					}
				} catch (Exception e) {
					throw new IllegalStateException(e);
				}
			}
		});

		List<String[]> rows = new CsvParser(new CsvParserSettings()).parseAll(tmp);
		assertEquals(rows.size(), 3);
	}

	@Test
	public void testInputDimensionRoutine() {
		CsvParserSettings csvParserSettings = new CsvParserSettings();
		csvParserSettings.getFormat().setLineSeparator("\n");
		csvParserSettings.setHeaderExtractionEnabled(true);
		CsvRoutines csvRoutines = new CsvRoutines(csvParserSettings);
		InputDimension d = csvRoutines.getInputDimension(new StringReader("a\nb\nc\n"));
		assertEquals(d.rowCount(), 3L);
		assertEquals(d.columnCount(), 1);
	}
}