org.hibernate.testing.util.TestPathHelper Maven / Gradle / Ivy

Go to download
/*
 * SPDX-License-Identifier: LGPL-2.1-or-later
 * Copyright Red Hat Inc. and Hibernate Authors
 */
package org.hibernate.testing.util;

import java.io.File;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;

import static java.io.File.separatorChar;

/**
 * @author Steve Ebersole
 */
public class TestPathHelper {
	/**
	 * Useful in cases where we need to deal with files/resources in the test compilation output dir of the
	 * project.  This gets a reference to the compilation output directory into which the given class was compiled.
	 *
	 * @param knownClass Reference to a Class known to be in the compilation output dir.
	 *
	 * @return The root URL
	 */
	public static URL resolveRootUrl(Class knownClass) {
		final String knownClassFileName = '/' + knownClass.getName().replace( '.', separatorChar ) + ".class";
		final URL knownClassFileUrl = knownClass.getResource( knownClassFileName );
		final String knownClassFileUrlString = knownClassFileUrl.toExternalForm();

		// to start, strip off the class file name
		String rootUrlString = knownClassFileUrlString.substring( 0, knownClassFileUrlString.lastIndexOf( separatorChar ) );

		// then strip off each package dir
		final String packageName = knownClass.getPackage().getName();
		for ( String packageNamePart : packageName.split( "\\." ) ) {
			rootUrlString = rootUrlString.substring( 0, rootUrlString.lastIndexOf( separatorChar ) );
		}

		try {
			return new URL( rootUrlString );
		}
		catch (MalformedURLException e) {
			throw new RuntimeException( "Could not convert class base url as string to URL ref", e );
		}
	}

	/**
	 * Essentially the same as {@link #resolveRootUrl(Class)}, but here we convert the root URL to a File
	 * (directory) reference.  In fact we delegate to {@link #resolveRootUrl(Class)} and simply convert its
	 * return into a File reference.
	 *
	 * @param knownClass Reference to a Class known to be in the compilation output dir.
	 *
	 * @return The root directory
	 */
	public static File resolveRootDirectory(Class knownClass) {
		try {
			return new File( resolveRootUrl( knownClass ).toURI() );
		}
		catch (URISyntaxException e) {
			throw new RuntimeException( "Could not convert class root URL to a URI", e );
		}
	}

	/**
	 * Essentially the same as {@link #resolveRootUrl(Class)}, but here we convert the root URL to a File
	 * (directory) reference.  In fact we delegate to {@link #resolveRootUrl(Class)} and simply convert its
	 * return into a File reference.
	 *
	 * @param knownClass Reference to a Class known to be in the compilation output dir.
	 *
	 * @return The root directory
	 */
	public static File resolveClassFile(Class knownClass) {
		final String knownClassFileName = '/' + knownClass.getName().replace( '.', separatorChar ) + ".class";
		final URL knownClassFileUrl = knownClass.getResource( knownClassFileName );

		try {
			return new File( knownClassFileUrl.toURI() );
		}
		catch (URISyntaxException e) {
			throw new RuntimeException( "Could not convert class root URL to a URI", e );
		}
	}

	private TestPathHelper() {
	}
}