Mime4jMboxParserImplStreamingTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.sling.mailarchiveserver.impl;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.fail;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;

import org.apache.sling.mailarchiveserver.impl.Mime4jMboxParserImpl.Mime4jParserIterator;
import org.apache.sling.mailarchiveserver.util.TU;
import org.junit.Ignore;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * In this class there is a test that parses big file. It will take a while to execute.
 */
public class Mime4jMboxParserImplStreamingTest {

	private Mime4jMboxParserImpl parser = new Mime4jMboxParserImpl();
	private final Logger log = LoggerFactory.getLogger(getClass());

	private static final String TEST_FILE_NAME = "mbox/tomcat-dev-201204.mbox";
	private static final double TEST_FILE_RATIO = 1.2;

	@Ignore("TODO - fails if running tests with lots of memory")
	@Test
	public void testParserIsStreaming() throws IOException {
		File tempf = null;
		FileInputStream fis = null;
		FileOutputStream fos = null;
		try {
            final long maxMem = Runtime.getRuntime().maxMemory();
		    log.info("Max memory={}, reading from {}, might take a while...", maxMem, TEST_FILE_NAME);
		    log.info("TODO: this test fails with 'Size exceeds Integer.MAX_VALUE' if maxMem is over a certain limit");
			final File fileToSample = new File(TU.TEST_FOLDER, TEST_FILE_NAME);
			final int count = (int) (maxMem * TEST_FILE_RATIO / fileToSample.length()) + 1;

			fis = new FileInputStream(fileToSample);
			final byte[] sample = new byte[(int) fileToSample.length()];
			assertEquals("Expecting the correct number of bytes read", fis.read(sample), fileToSample.length()); 

			tempf = File.createTempFile("MAS_", ".mbox");
			fos = new FileOutputStream(tempf);
			for (int i = 0; i < count; i++) {
				fos.write(sample);
			}
            fos.flush();
            fos.close();
			fos = null;

			parser.parse(new FileInputStream(tempf));

		} catch(OutOfMemoryError e) {
			fail("Got OutOfMemoryError, looks like the Parser is not streaming");
		} finally {
			if (tempf != null) {
				tempf.delete();
			}
			if (fis != null) {
				fis.close();
			}
			if (fos != null) {
				fos.close();
			}
		}
	}

	@Test
	public void testTempFileIsDeleted() throws IOException {
		File testFile = new File(TU.TEST_FOLDER, TEST_FILE_NAME);
		Mime4jParserIterator iter = (Mime4jParserIterator) parser.parse(new FileInputStream(testFile));
		assertFalse("Expecting temp file to be deleted", new File(iter.tempFileAbsPath).exists());
	}	

}