modules/core/src/test/java/org/apache/ignite/testframework/config/GridTestProperties.java - ignite - Git at Google

 /*
  * 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.ignite.testframework.config;

 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.URI;
 import java.net.URL;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Properties;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import org.apache.ignite.binary.BinaryBasicNameMapper;
 import org.apache.ignite.binary.BinaryTypeConfiguration;
 import org.apache.ignite.testframework.GridTestUtils;
 import org.apache.logging.log4j.core.config.Configurator;
 import org.apache.logging.log4j.core.config.LoggerConfig;
 import org.jetbrains.annotations.Nullable;

 import static org.apache.ignite.testframework.GridTestUtils.initTestProjectHome;

 /**
  * Loads test properties from {@code config} folder under tests.
  * The property structure is as follows:
  * <ul>
  * <li>
  *     Default properties and log4j.xml configuration is loaded directly from
  *     {@code ${IGNITE_HOME}/modules/tests/config} folder. Default properties can be
  *     accessed via {@link #getDefaultProperties()} and {@link #getDefaultProperty(String)} methods.
  *   </li>
  * <li>
  *     User is able to override any default property and log4j configuration in
  *     {@code ${IGNITE_HOME}/modules/tests/config/${username}} folder, where {@code username}
  *     is the system user name. User properties can be accessed via {@link #getProperties()} and
  *     {@link #getProperties(String)} methods.
  *   </li>
  * <li>
  *     Any test may utilize its own sub-folder. To access configuration specific to some sub-folder
  *     use {@link #getProperties(String)} and {@link #getProperty(String, String)} methods.
  *   </li>
  * </ul>
  */
 public final class GridTestProperties {
     /** */
     public static final String DEFAULT_LOG4J_FILE = "log4j2-test.xml";

     /** */
     public static final String TESTS_PROP_FILE = "tests.properties";

     /** */
     private static final String TEST_CONFIG_DIR = "/test/config/";

     /** */
     private static final String TESTS_CFG_PATH = "modules/core/src" + TEST_CONFIG_DIR;

     /** */
     private static final Pattern PROP_REGEX = Pattern.compile("[@$]\\{[^@${}]+\\}");

     /** */
     private static final Map<String, String> dfltProps;

     /** */
     private static final Map<String, Map<String, String>> pathProps = new HashMap<>();

     /** */
     public static final String ENTRY_PROCESSOR_CLASS_NAME = "entry.processor.class";

     /** Binary marshaller compact footers property. */
     public static final String BINARY_COMPACT_FOOTERS = "binary.marshaller.compact.footers";

     /** "True value" enables {@link BinaryBasicNameMapper} in {@link BinaryTypeConfiguration#getNameMapper()}  */
     public static final String BINARY_MARSHALLER_USE_SIMPLE_NAME_MAPPER = "binary.marshaller.use.simple.name.mapper";

     /**
      * Name of class which provides static method preprocessConfiguration(IgniteConfiguration cfg) to
      * alter {@link org.apache.ignite.configuration.IgniteConfiguration} before node is started.
      * <p>
      * Note: this pre-preprocessor is started only if test starts node using one of GridAbstractTest's startGrid
      * method.
      */
     public static final String IGNITE_CFG_PREPROCESSOR_CLS = "ignite.cfg.preprocessor.class";

     /** */
     static {
         initTestProjectHome();

         // Load default properties.
         URI cfgFile = getTestConfigurationFile(null, TESTS_PROP_FILE);

         assert cfgFile != null;

         dfltProps = Collections.unmodifiableMap(loadFromResource(new HashMap<>(), cfgFile));

         if ("false".equals(System.getProperty("IGNITE_TEST_PROP_DISABLE_LOG4J", "false"))) {
             String user = System.getProperty("user.name");

             assert user != null;

             // Configure log4j logger.
             configureLog4j(user);
         }
     }

     /**
      * Ensure singleton.
      */
     private GridTestProperties() {
         // No-op.
     }

     /**
      * @param user User name.
      */
     private static void configureLog4j(String user) {
         String cfgFile = System.getProperty("IGNITE_TEST_PROP_LOG4J_FILE");

         if (cfgFile == null)
             cfgFile = DEFAULT_LOG4J_FILE;

         URI log4jFile = getTestConfigurationFile(user, cfgFile);

         if (log4jFile == null)
             log4jFile = getTestConfigurationFile(null, cfgFile);

         Configurator.initialize(LoggerConfig.ROOT, GridTestProperties.class.getClassLoader(), log4jFile);

         System.out.println("Configured log4j2 from: " + log4jFile);
     }

     /** */
     public static void init() {
         // No-op.
     }

     /** */
     public static URI findTestResource(String res) {
         URL resUrl = GridTestProperties.class.getResource(TEST_CONFIG_DIR + res);

         if (resUrl == null)
             return null;

         return URI.create(resUrl.toExternalForm());
     }

     /**
      * @return Default properties.
      */
     public static synchronized Map<String, String> getDefaultProperties() {
         return dfltProps;
     }

     /**
      * @param name Default property name.
      * @return Default property value.
      */
     public static synchronized String getDefaultProperty(String name) {
         return dfltProps.get(name);
     }

     /**
      * @return Properties.
      */
     public static synchronized Map<String, String> getProperties() {
         String user = System.getProperty("user.name");

         assert user != null;

         return getProperties(user);
     }

     /**
      * @param name Property name.
      * @return Property value.
      */
     public static synchronized String getProperty(String name) {
         return getProperties().get(name);
     }

     /**
      * @param name Property name.
      * @param val Property value.
      */
     public static synchronized void setProperty(String name, String val) {
         getProperties().put(name, val);
     }

     /**
      * @param dir Directory path.
      * @return Properties.
      */
     public static synchronized Map<String, String> getProperties(String dir) {
         Map<String, String> props = pathProps.get(dir);

         if (props == null) {
             props = new HashMap<>();

             // Load default properties.
             props.putAll(dfltProps);

             // Load properties from specified folder
             // potentially overriding defaults.
             loadProperties(props, dir);

             pathProps.put(dir, props);
         }

         return props;
     }

     /**
      * @param name Property name.
      * @param dir Directory path.
      * @return Property value.
      */
     public static synchronized String getProperty(String name, String dir) {
         return getProperties(dir).get(name);
     }

     /**
      * Substitutes environmental or system properties in the given string.
      *
      * @param str String to make substitution in.
      * @return Substituted string.
      */
     private static String substituteProperties(String str) {
         str = str.trim();

         Matcher matcher = PROP_REGEX.matcher(str);

         StringBuffer buf = new StringBuffer();

         while (matcher.find()) {
             String match = matcher.group();

             if (match.length() >= 4) {
                 String key = match.substring(2, match.length() - 1);

                 String val = System.getenv(key);

                 if (val == null)
                     val = System.getProperty(key);

                 if (val != null) {
                     // Take care of back slashes.
                     match = val.replaceAll("\\\\", "\\\\\\\\");
                 }
                 else if (match.startsWith("$"))
                     match = match.replace("$", "\\$");
             }

             matcher.appendReplacement(buf, match);
         }

         matcher.appendTail(buf);

         return buf.toString();
     }

     /**
      * @param props Initial properties.
      * @param dir Directory path.
      * @return Loaded properties.
      */
     private static Map<String, String> loadProperties(Map<String, String> props, String dir) {
         URI cfg = getTestConfigurationFile(dir, TESTS_PROP_FILE);

         if (cfg != null)
             loadFromResource(props, cfg);

         return props;
     }

     /**
      * @param user User name.
      * @param fileName File name.
      * @return Configuration file for given user.
      */
     @Nullable private static URI getTestConfigurationFile(@Nullable String user, String fileName) {
         String path = TESTS_CFG_PATH;

         if (user != null)
             path += File.separatorChar + user;

         path += File.separatorChar + fileName;

         File file = GridTestUtils.resolveIgnitePath(path);

         if (file != null && file.exists()) {
             assert !file.isDirectory();

             return file.toURI();
         }

         return user == null ? findTestResource(fileName) : null;
     }

     /**
      * @param props Initial properties.
      * @param resource File resource location.
      * @return Loaded properties.
      */
     private static Map<String, String> loadFromResource(Map<String, String> props, URI resource) {
         try (InputStream in = resource.toURL().openStream()) {
             Properties fileProps = new Properties();

             fileProps.load(in);

             for (Entry<Object, Object> prop : fileProps.entrySet())
                 props.put((String)prop.getKey(), (String)prop.getValue());

             for (Entry<String, String> prop : props.entrySet())
                 prop.setValue(substituteProperties(prop.getValue()));
         }
         catch (IOException e) {
             e.printStackTrace();

             assert false : "Failed to load test configuration properties: " + resource;
         }

         return props;
     }
 }
	/*
	* 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.ignite.testframework.config;

	import java.io.File;
	import java.io.IOException;
	import java.io.InputStream;
	import java.net.URI;
	import java.net.URL;
	import java.util.Collections;
	import java.util.HashMap;
	import java.util.Map;
	import java.util.Map.Entry;
	import java.util.Properties;
	import java.util.regex.Matcher;
	import java.util.regex.Pattern;
	import org.apache.ignite.binary.BinaryBasicNameMapper;
	import org.apache.ignite.binary.BinaryTypeConfiguration;
	import org.apache.ignite.testframework.GridTestUtils;
	import org.apache.logging.log4j.core.config.Configurator;
	import org.apache.logging.log4j.core.config.LoggerConfig;
	import org.jetbrains.annotations.Nullable;

	import static org.apache.ignite.testframework.GridTestUtils.initTestProjectHome;

	/**
	* Loads test properties from {@code config} folder under tests.
	* The property structure is as follows:
	* <ul>
	* <li>
	* Default properties and log4j.xml configuration is loaded directly from
	* {@code ${IGNITE_HOME}/modules/tests/config} folder. Default properties can be
	* accessed via {@link #getDefaultProperties()} and {@link #getDefaultProperty(String)} methods.
	* </li>
	* <li>
	* User is able to override any default property and log4j configuration in
	* {@code ${IGNITE_HOME}/modules/tests/config/${username}} folder, where {@code username}
	* is the system user name. User properties can be accessed via {@link #getProperties()} and
	* {@link #getProperties(String)} methods.
	* </li>
	* <li>
	* Any test may utilize its own sub-folder. To access configuration specific to some sub-folder
	* use {@link #getProperties(String)} and {@link #getProperty(String, String)} methods.
	* </li>
	* </ul>
	*/
	public final class GridTestProperties {
	/** */
	public static final String DEFAULT_LOG4J_FILE = "log4j2-test.xml";

	/** */
	public static final String TESTS_PROP_FILE = "tests.properties";

	/** */
	private static final String TEST_CONFIG_DIR = "/test/config/";

	/** */
	private static final String TESTS_CFG_PATH = "modules/core/src" + TEST_CONFIG_DIR;

	/** */
	private static final Pattern PROP_REGEX = Pattern.compile("[@$]\\{[^@${}]+\\}");

	/** */
	private static final Map<String, String> dfltProps;

	/** */
	private static final Map<String, Map<String, String>> pathProps = new HashMap<>();

	/** */
	public static final String ENTRY_PROCESSOR_CLASS_NAME = "entry.processor.class";

	/** Binary marshaller compact footers property. */
	public static final String BINARY_COMPACT_FOOTERS = "binary.marshaller.compact.footers";

	/** "True value" enables {@link BinaryBasicNameMapper} in {@link BinaryTypeConfiguration#getNameMapper()} */
	public static final String BINARY_MARSHALLER_USE_SIMPLE_NAME_MAPPER = "binary.marshaller.use.simple.name.mapper";

	/**
	* Name of class which provides static method preprocessConfiguration(IgniteConfiguration cfg) to
	* alter {@link org.apache.ignite.configuration.IgniteConfiguration} before node is started.
	* <p>
	* Note: this pre-preprocessor is started only if test starts node using one of GridAbstractTest's startGrid
	* method.
	*/
	public static final String IGNITE_CFG_PREPROCESSOR_CLS = "ignite.cfg.preprocessor.class";

	/** */
	static {
	initTestProjectHome();

	// Load default properties.
	URI cfgFile = getTestConfigurationFile(null, TESTS_PROP_FILE);

	assert cfgFile != null;

	dfltProps = Collections.unmodifiableMap(loadFromResource(new HashMap<>(), cfgFile));

	if ("false".equals(System.getProperty("IGNITE_TEST_PROP_DISABLE_LOG4J", "false"))) {
	String user = System.getProperty("user.name");

	assert user != null;

	// Configure log4j logger.
	configureLog4j(user);
	}
	}

	/**
	* Ensure singleton.
	*/
	private GridTestProperties() {
	// No-op.
	}

	/**
	* @param user User name.
	*/
	private static void configureLog4j(String user) {
	String cfgFile = System.getProperty("IGNITE_TEST_PROP_LOG4J_FILE");

	if (cfgFile == null)
	cfgFile = DEFAULT_LOG4J_FILE;

	URI log4jFile = getTestConfigurationFile(user, cfgFile);

	if (log4jFile == null)
	log4jFile = getTestConfigurationFile(null, cfgFile);

	Configurator.initialize(LoggerConfig.ROOT, GridTestProperties.class.getClassLoader(), log4jFile);

	System.out.println("Configured log4j2 from: " + log4jFile);
	}

	/** */
	public static void init() {
	// No-op.
	}

	/** */
	public static URI findTestResource(String res) {
	URL resUrl = GridTestProperties.class.getResource(TEST_CONFIG_DIR + res);

	if (resUrl == null)
	return null;

	return URI.create(resUrl.toExternalForm());
	}

	/**
	* @return Default properties.
	*/
	public static synchronized Map<String, String> getDefaultProperties() {
	return dfltProps;
	}

	/**
	* @param name Default property name.
	* @return Default property value.
	*/
	public static synchronized String getDefaultProperty(String name) {
	return dfltProps.get(name);
	}

	/**
	* @return Properties.
	*/
	public static synchronized Map<String, String> getProperties() {
	String user = System.getProperty("user.name");

	assert user != null;

	return getProperties(user);
	}

	/**
	* @param name Property name.
	* @return Property value.
	*/
	public static synchronized String getProperty(String name) {
	return getProperties().get(name);
	}

	/**
	* @param name Property name.
	* @param val Property value.
	*/
	public static synchronized void setProperty(String name, String val) {
	getProperties().put(name, val);
	}

	/**
	* @param dir Directory path.
	* @return Properties.
	*/
	public static synchronized Map<String, String> getProperties(String dir) {
	Map<String, String> props = pathProps.get(dir);

	if (props == null) {
	props = new HashMap<>();

	// Load default properties.
	props.putAll(dfltProps);

	// Load properties from specified folder
	// potentially overriding defaults.
	loadProperties(props, dir);

	pathProps.put(dir, props);
	}

	return props;
	}

	/**
	* @param name Property name.
	* @param dir Directory path.
	* @return Property value.
	*/
	public static synchronized String getProperty(String name, String dir) {
	return getProperties(dir).get(name);
	}

	/**
	* Substitutes environmental or system properties in the given string.
	*
	* @param str String to make substitution in.
	* @return Substituted string.
	*/
	private static String substituteProperties(String str) {
	str = str.trim();

	Matcher matcher = PROP_REGEX.matcher(str);

	StringBuffer buf = new StringBuffer();

	while (matcher.find()) {
	String match = matcher.group();

	if (match.length() >= 4) {
	String key = match.substring(2, match.length() - 1);

	String val = System.getenv(key);

	if (val == null)
	val = System.getProperty(key);

	if (val != null) {
	// Take care of back slashes.
	match = val.replaceAll("\\\\", "\\\\\\\\");
	}
	else if (match.startsWith("$"))
	match = match.replace("$", "\\$");
	}

	matcher.appendReplacement(buf, match);
	}

	matcher.appendTail(buf);

	return buf.toString();
	}

	/**
	* @param props Initial properties.
	* @param dir Directory path.
	* @return Loaded properties.
	*/
	private static Map<String, String> loadProperties(Map<String, String> props, String dir) {
	URI cfg = getTestConfigurationFile(dir, TESTS_PROP_FILE);

	if (cfg != null)
	loadFromResource(props, cfg);

	return props;
	}

	/**
	* @param user User name.
	* @param fileName File name.
	* @return Configuration file for given user.
	*/
	@Nullable private static URI getTestConfigurationFile(@Nullable String user, String fileName) {
	String path = TESTS_CFG_PATH;

	if (user != null)
	path += File.separatorChar + user;

	path += File.separatorChar + fileName;

	File file = GridTestUtils.resolveIgnitePath(path);

	if (file != null && file.exists()) {
	assert !file.isDirectory();

	return file.toURI();
	}

	return user == null ? findTestResource(fileName) : null;
	}

	/**
	* @param props Initial properties.
	* @param resource File resource location.
	* @return Loaded properties.
	*/
	private static Map<String, String> loadFromResource(Map<String, String> props, URI resource) {
	try (InputStream in = resource.toURL().openStream()) {
	Properties fileProps = new Properties();

	fileProps.load(in);

	for (Entry<Object, Object> prop : fileProps.entrySet())
	props.put((String)prop.getKey(), (String)prop.getValue());

	for (Entry<String, String> prop : props.entrySet())
	prop.setValue(substituteProperties(prop.getValue()));
	}
	catch (IOException e) {
	e.printStackTrace();

	assert false : "Failed to load test configuration properties: " + resource;
	}

	return props;
	}
	}