org.opencms.test.OpenCmsTestProperties Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.test;
import org.opencms.configuration.CmsParameterConfiguration;
import org.opencms.file.CmsResource;
import org.opencms.main.CmsLog;
import org.opencms.util.CmsFileUtil;
import org.opencms.util.CmsStringUtil;
import java.io.File;
import java.io.IOException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Arrays;
import org.apache.commons.logging.Log;
/**
* Reads and manages the test.properties file.
*
* @since 6.0.0
*/
public final class OpenCmsTestProperties {
/** The log object for this class. */
public static final Log LOG = CmsLog.getLog(OpenCmsTestProperties.class);
/** Property / Environment name for "db.product". */
public static final String PROP_DB_PRODUCT = "db.product";
/** Property / Environment name for "test.build.folder". */
public static final String PROP_TEST_BUILD_FOLDER = "test.build.folder";
/** Property / Environment name for "test.data.path". */
public static final String PROP_TEST_DATA_PATH = "test.data.path";
/** Property / Environment name for "test.webapp.path". */
public static final String PROP_TEST_WEBAPP_PATH = "test.webapp.path";
/** The configuration from opencms.properties. */
private static CmsParameterConfiguration m_configuration;
/** The singleton instance. */
private static OpenCmsTestProperties m_testSingleton;
/** The path to the test.properties file. */
private String m_basePath;
/** The database to use. */
private String m_dbProduct;
/** The path to the build folder of the test classes. */
private String m_testBuildFolder;
/** The path to the data test folder. */
private String m_testDataPath;
/** The path to the webapp test folder. */
private String m_testWebappPath;
/**
* Private default constructor.
*/
private OpenCmsTestProperties() {
// noop
}
/**
* @return the singleton instance
*/
public static OpenCmsTestProperties getInstance() {
if (m_testSingleton == null) {
throw new RuntimeException("You have to initialize the test properties.");
}
return m_testSingleton;
}
/**
* Returns the absolute path name for the given relative
* path name if it was found by the context Classloader of the
* current Thread.
*
* The argument has to denote a resource within the Classloaders
* scope. A {@link java.net.URLClassLoader} implementation for example would
* try to match a given path name to some resource under it's URL
* entries.
*
* As the result is internally obtained as an URL it is reduced to
* a file path by the call to {@link java.net.URL#getFile()}. Therefore
* the returned String will start with a '/' (no problem for java.io).
*
* @param fileName the filename to return the path from the Classloader for
*
* @return the absolute path name for the given relative
* path name if it was found by the context Classloader of the
* current Thread or an empty String if it was not found
*
* @see Thread#getContextClassLoader()
*/
public static String getResourcePathFromClassloader(String fileName) {
boolean isFolder = CmsResource.isFolder(fileName);
String result = "";
URL inputUrl = Thread.currentThread().getContextClassLoader().getResource(fileName);
if (inputUrl != null) {
// decode name here to avoid url encodings in path name
result = CmsFileUtil.normalizePath(inputUrl);
if (isFolder && !CmsResource.isFolder(result)) {
result = result + '/';
}
} else {
try {
URLClassLoader cl = (URLClassLoader)Thread.currentThread().getContextClassLoader();
URL[] paths = cl.getURLs();
LOG.error(
Messages.get().getBundle().key(
Messages.ERR_MISSING_CLASSLOADER_RESOURCE_2,
fileName,
Arrays.asList(paths)));
} catch (Throwable t) {
LOG.error(Messages.get().getBundle().key(Messages.ERR_MISSING_CLASSLOADER_RESOURCE_1, fileName));
}
}
return result;
}
/**
* Reads property file test.properties and fills singleton members.
*
* @param basePath the path where to find the test.properties file
*/
public static void initialize(String basePath) {
if (m_testSingleton != null) {
return;
}
m_testSingleton = new OpenCmsTestProperties();
m_testSingleton.m_basePath = basePath;
if (!m_testSingleton.m_basePath.endsWith("/")) {
m_testSingleton.m_basePath += "/";
}
try {
String testPropPath = null;
String propertiesFileName = "test.properties";
if (basePath != null) {
testPropPath = CmsFileUtil.addTrailingSeparator(basePath) + propertiesFileName;
File propFile = new File(testPropPath);
if (!propFile.exists()) {
testPropPath = OpenCmsTestProperties.getResourcePathFromClassloader(propertiesFileName);
}
}
if (testPropPath == null) {
throw new RuntimeException(
"Test property file ('test.properties') could not be found by context Classloader.");
}
File f = new File(testPropPath);
if (!f.exists()) {
throw new RuntimeException(
"Test property file ('test.properties') could not be found. Context Classloader suggested location: "
+ testPropPath);
}
m_configuration = new CmsParameterConfiguration(testPropPath);
} catch (IOException e) {
e.printStackTrace(System.out);
throw new RuntimeException(e);
}
try {
// for java 1.4, getenv is deprecated and raises an error,
// so prefer properties set with "-D"
// read environment and update configuration if required
boolean allowGetEnv = true;
try {
System.getenv(PROP_TEST_DATA_PATH);
} catch (Throwable getEnvNotSupported) {
// have to catch Throwable as an Error is thrown!
allowGetEnv = false;
}
if (System.getProperty(PROP_TEST_DATA_PATH) != null) {
m_configuration.put(PROP_TEST_DATA_PATH, System.getProperty(PROP_TEST_DATA_PATH));
} else if (allowGetEnv && (System.getenv(PROP_TEST_DATA_PATH) != null)) {
m_configuration.put(PROP_TEST_DATA_PATH, System.getenv(PROP_TEST_DATA_PATH));
}
if (System.getProperty(PROP_TEST_WEBAPP_PATH) != null) {
m_configuration.put(PROP_TEST_WEBAPP_PATH, System.getProperty(PROP_TEST_WEBAPP_PATH));
} else if (allowGetEnv && (System.getenv(PROP_TEST_WEBAPP_PATH) != null)) {
m_configuration.put(PROP_TEST_WEBAPP_PATH, System.getenv(PROP_TEST_WEBAPP_PATH));
}
if (System.getProperty(PROP_DB_PRODUCT) != null) {
m_configuration.put(PROP_DB_PRODUCT, System.getProperty(PROP_DB_PRODUCT));
} else if (allowGetEnv && (System.getenv(PROP_DB_PRODUCT) != null)) {
m_configuration.put(PROP_DB_PRODUCT, System.getenv(PROP_DB_PRODUCT));
}
} catch (SecurityException e) {
// unable to read environment, use only properties from file
e.printStackTrace(System.out);
}
m_testSingleton.m_testWebappPath = System.getProperty(PROP_TEST_WEBAPP_PATH);
if (CmsStringUtil.isEmptyOrWhitespaceOnly(m_testSingleton.m_testWebappPath)) {
m_testSingleton.m_testWebappPath = m_configuration.get(PROP_TEST_WEBAPP_PATH);
}
m_testSingleton.m_testDataPath = System.getProperty(PROP_TEST_DATA_PATH);
if (CmsStringUtil.isEmptyOrWhitespaceOnly(m_testSingleton.m_testDataPath)) {
m_testSingleton.m_testDataPath = m_configuration.get(PROP_TEST_DATA_PATH);
}
m_testSingleton.m_testBuildFolder = System.getProperty(PROP_TEST_BUILD_FOLDER);
if (CmsStringUtil.isEmptyOrWhitespaceOnly(m_testSingleton.m_testBuildFolder)) {
m_testSingleton.m_testBuildFolder = m_configuration.get(PROP_TEST_BUILD_FOLDER);
}
m_testSingleton.m_dbProduct = m_configuration.get(PROP_DB_PRODUCT);
}
/**
* @return Returns the path to the test.properties file
*/
public String getBasePath() {
return m_basePath;
}
/**
* @return the parsed configuration file ('test.properties')
*/
public CmsParameterConfiguration getConfiguration() {
return m_configuration;
}
/**
* @return the name of the db product used
*/
public String getDbProduct() {
return m_dbProduct;
}
/**
* Returns the path to the build folder of the test classes.
*
* @return the path to the build folder of the test classes
*/
public String getTestBuildFolder() {
LOG.info("Using build folder: " + m_testBuildFolder);
return m_testBuildFolder;
}
/**
* @return the path to the data test directory
*/
public String getTestDataPath() {
return m_testDataPath;
}
/**
* @return the path to the webapp test directory
*/
public String getTestWebappPath() {
return m_testWebappPath;
}
}