org.semanticweb.elk.testing.TestUtils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of elk-util-testing Show documentation
ELK Utilities for Testing
The newest version!
/*
 * #%L
 * ELK Utilities for Testing
 * 
 * $Id$
 * $HeadURL$
 * %%
 * Copyright (C) 2011 - 2012 Department of Computer Science, University of Oxford
 * %%
 * 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.
 * #L%
 */
/**
 * 
 */
package org.semanticweb.elk.testing;

import java.io.File;
import java.io.IOException;
import java.util.Arrays;

import org.semanticweb.elk.io.FileUtils;

/**
 * A collection of test utilities, e.g., for creating and destroying the test
 * environment
 * 
 * @author Pavel Klinov
 * 
 *         [email protected]
 */
public class TestUtils {

	public static final String TEST_ROOT = ".test-home";

	public static void createTestEnvironment(File baseDir) {
		File root = new File(baseDir.getAbsolutePath() + "/" + TEST_ROOT);

		if (root.exists()) {
			try {
				FileUtils.deleteRecursively(root);
			} catch (IOException e) {
				throw new RuntimeException(
						"Initialization of test environment failed, unable to delete the root test folder");
			}
		}

		if (!root.mkdirs()) {
			throw new RuntimeException(
					"Initialization of test environment failed, unable to create the root test folder");
		}
	}

	public static void cleanUp(File baseDir) {
		try {
			File root = new File(baseDir.getAbsolutePath() + "/" + TEST_ROOT);

			if (root.exists()) {
				FileUtils.deleteRecursively(root);
			}
		} catch (IOException e) {
			throw new RuntimeException(
					"Clean-up of test environment failed, unable to delete the root test folder");
		}
	}

	public static void cleanUpOnExit(File baseDir) {
		File root = new File(baseDir.getAbsolutePath() + "/" + TEST_ROOT);

		if (root.exists()) {
			try {
				FileUtils.deleteRecursively(root, true);
			} catch (IOException e) {
				// TODO shouldn't throw any exceptions if
				// deleting on exit
			}
		}
	}

	/**
	 * @param input
	 * @param inputDataLocation
	 * @param sortedIgnoredPaths
	 * @return Whether the suffix of the path of the input URL starting at the
	 *         last occurrence of the input data location is in sorted ignored
	 *         paths.
	 */
	public static boolean ignore(final UrlTestInput input,
			final String inputDataLocation, final String[] sortedIgnoredPaths) {
		final String path = input.getUrl().getPath();
		final int index = path.lastIndexOf(inputDataLocation);
		if (index < 0) {
			throw new IllegalArgumentException("\"" + inputDataLocation
					+ "\" does not occur in \"" + path + "\"");
		}
		final String relativePath = path.substring(index);
		return Arrays.binarySearch(sortedIgnoredPaths, relativePath) >= 0;
	}

}