/*
* JBoss, Home of Professional Open Source.
* Copyright 2013, Red Hat, Inc., and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This 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 software 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.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.as.test.integration.domain.management.util;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.FAILED;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.FAILURE_DESCRIPTION;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.OUTCOME;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.RESULT;
import static org.jboss.as.controller.descriptions.ModelDescriptionConstants.SUCCESS;
import java.io.Closeable;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import org.jboss.as.protocol.StreamUtils;
import org.jboss.as.test.shared.FileUtils;
import org.jboss.dmr.ModelNode;
import org.jboss.logging.Logger;
import org.jboss.shrinkwrap.api.exporter.StreamExporter;
import org.junit.Assert;
/**
* Utilities for running tests of domain mode.
*
* @author Brian Stansberry (c) 2011 Red Hat Inc.
*/
public class DomainTestSupport {
private static final Logger log = Logger.getLogger("org.jboss.as.test.integration.domain");
public static final String masterAddress = System.getProperty("jboss.test.host.master.address", "127.0.0.1");
public static final String slaveAddress = System.getProperty("jboss.test.host.slave.address", "127.0.0.1");
public static final long domainBootTimeout = Long.valueOf(System.getProperty("jboss.test.domain.boot.timeout", "60000"));
public static final long domainShutdownTimeout = Long.valueOf(System.getProperty("jboss.test.domain.shutdown.timeout", "20000"));
public static final String masterJvmHome = System.getProperty("jboss.test.host.master.jvmhome");
public static final String slaveJvmHome = System.getProperty("jboss.test.host.slave.jvmhome");
public static final String masterControllerJvmHome = System.getProperty("jboss.test.host.master.controller.jvmhome");
public static final String slaveControllerJvmHome = System.getProperty("jboss.test.host.slave.controller.jvmhome");
/**
* Create and start a default configuration for the domain tests.
*
* @param testName the test name
* @return a started domain test support
*/
public static DomainTestSupport createAndStartDefaultSupport(final String testName) {
try {
final Configuration configuration = DomainTestSupport.Configuration.create(testName,
"domain-configs/domain-standard.xml", "host-configs/host-master.xml", "host-configs/host-slave.xml");
final DomainTestSupport testSupport = DomainTestSupport.create(configuration);
// Start!
testSupport.start();
return testSupport;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
* Create and start a configuration for the domain tests
*
* @param configuration the configuration specification
* @return a started domain test support
*/
public static DomainTestSupport createAndStartSupport(Configuration configuration) {
try {
final DomainTestSupport testSupport = DomainTestSupport.create(configuration);
// Start!
testSupport.start();
return testSupport;
} catch (Exception e) {
throw new RuntimeException(e);
}
}
public static WildFlyManagedConfiguration getMasterConfiguration(String domainConfigPath, String hostConfigPath,
String testName, boolean readOnlyDomain, boolean readOnlyHost) {
return getMasterConfiguration(domainConfigPath, hostConfigPath, testName, null, readOnlyDomain, readOnlyHost);
}
public static WildFlyManagedConfiguration getMasterConfiguration(String domainConfigPath, String hostConfigPath,
String testName, WildFlyManagedConfiguration baseConfig,
boolean readOnlyDomain, boolean readOnlyHost) {
return getMasterConfiguration(domainConfigPath, hostConfigPath, testName, baseConfig, readOnlyDomain, readOnlyHost, false);
}
public static WildFlyManagedConfiguration getMasterConfiguration(String domainConfigPath, String hostConfigPath,
String testName, WildFlyManagedConfiguration baseConfig,
boolean readOnlyDomain, boolean readOnlyHost, boolean debug) {
return Configuration.getMasterConfiguration(domainConfigPath, hostConfigPath, testName, baseConfig, readOnlyDomain, readOnlyHost, debug);
}
public static WildFlyManagedConfiguration getSlaveConfiguration(String hostConfigPath, String testName,
boolean readOnlyHost) {
return getSlaveConfiguration("slave", hostConfigPath, testName, new WildFlyManagedConfiguration(), readOnlyHost);
}
public static WildFlyManagedConfiguration getSlaveConfiguration(String hostName, String hostConfigPath, String testName,
boolean readOnlyHost) {
return getSlaveConfiguration(hostName, hostConfigPath, testName, new WildFlyManagedConfiguration(), readOnlyHost);
}
public static WildFlyManagedConfiguration getSlaveConfiguration(String hostConfigPath, String testName,
WildFlyManagedConfiguration baseConfig,
boolean readOnlyHost) {
return getSlaveConfiguration("slave", hostConfigPath, testName, baseConfig, readOnlyHost);
}
public static WildFlyManagedConfiguration getSlaveConfiguration(String hostName, String hostConfigPath, String testName,
WildFlyManagedConfiguration baseConfig,
boolean readOnlyHost) {
return getSlaveConfiguration(hostName, hostConfigPath, testName, baseConfig, readOnlyHost, false);
}
public static WildFlyManagedConfiguration getSlaveConfiguration(String hostName, String hostConfigPath, String testName,
WildFlyManagedConfiguration baseConfig,
boolean readOnlyHost, boolean debug) {
return Configuration.getSlaveConfiguration(hostConfigPath, testName, hostName, baseConfig, readOnlyHost, debug);
}
private static URI toURI(URL url) {
try {
return url.toURI();
} catch (URISyntaxException e) {
throw new RuntimeException(e);
}
}
public static void startHosts(long timeout, DomainLifecycleUtil... hosts) throws Exception {
Future<?>[] futures = new Future<?>[hosts.length];
for (int i = 0; i < hosts.length; i++) {
futures[i] = hosts[i].startAsync();
}
processFutures(futures, timeout);
}
public static void stopHosts(long timeout, DomainLifecycleUtil... hosts) throws Exception {
Future<?>[] futures = new Future<?>[hosts.length];
for (int i = 0; i < hosts.length; i++) {
futures[i] = hosts[i].stopAsync();
}
processFutures(futures, timeout);
}
public static File getBaseDir(String testName) {
return new File("target" + File.separator + "domains" + File.separator + testName);
}
public static File getHostDir(String testName, String hostName) {
return new File(getBaseDir(testName), hostName);
}
public static File getAddedModulesDir(String testName) {
File f = new File(getBaseDir(testName), "added-modules");
f.mkdirs();
return f;
}
public static File getHostOverrideModulesDir(String testName, String hostName) {
final File f = new File(getHostDir(testName, hostName), "added-modules");
f.mkdirs();
return f;
}
public static ModelNode createOperationNode(String address, String operation) {
ModelNode op = new ModelNode();
// set address
ModelNode list = op.get("address").setEmptyList();
if (address != null) {
String [] pathSegments = address.split("/");
for (String segment : pathSegments) {
String[] elements = segment.split("=");
list.add(elements[0], elements[1]);
}
}
op.get("operation").set(operation);
return op;
}
public static ModelNode validateResponse(ModelNode response) {
return validateResponse(response, true);
}
public static ModelNode validateResponse(ModelNode response, boolean getResult) {
if(! SUCCESS.equals(response.get(OUTCOME).asString())) {
System.out.println("Failed response:");
System.out.println(response);
Assert.fail(response.get(FAILURE_DESCRIPTION).toString());
}
if (getResult) {
Assert.assertTrue("result exists", response.has(RESULT));
return response.get(RESULT);
}
return null;
}
public static ModelNode validateFailedResponse(ModelNode response) {
if(! FAILED.equals(response.get(OUTCOME).asString())) {
System.out.println("Response succeeded:");
System.out.println(response);
Assert.fail(response.get(OUTCOME).toString());
}
Assert.assertTrue("failure description exists", response.has(FAILURE_DESCRIPTION));
return response.get(FAILURE_DESCRIPTION);
}
public static void cleanFile(File file) {
if (file != null && file.exists()) {
if (file.isDirectory()) {
for (File child : file.listFiles()) {
cleanFile(child);
}
}
if (!file.delete()) {
file.deleteOnExit();
}
}
}
public static void safeClose(final Closeable closeable) {
if (closeable != null) try {
closeable.close();
} catch (Throwable t) {
log.errorf(t, "Failed to close resource %s", closeable);
}
}
private static void processFutures(Future<?>[] futures, long timeout) throws Exception {
try {
for (int i = 0; i < futures.length; i++) {
try {
futures[i].get(timeout, TimeUnit.MILLISECONDS);
} catch (ExecutionException e){
throw e.getCause();
}
}
} catch (Exception e) {
throw e;
} catch (Error e) {
throw e;
} catch (Throwable t) {
throw new RuntimeException(t);
}
}
private static void configureModulePath(WildFlyManagedConfiguration config, File... extraModules) {
String basePath = config.getModulePath();
if (basePath == null || basePath.isEmpty()) {
basePath = config.getJbossHome() + File.separatorChar + "modules";
}
final StringBuilder path = new StringBuilder();
for(final File extraModule : extraModules) {
path.append(extraModule.getAbsolutePath()).append(File.pathSeparatorChar);
}
path.append(basePath);
config.setModulePath(path.toString());
}
private final WildFlyManagedConfiguration masterConfiguration;
private final WildFlyManagedConfiguration slaveConfiguration;
private final DomainLifecycleUtil domainMasterLifecycleUtil;
private final DomainLifecycleUtil domainSlaveLifecycleUtil;
private final DomainControllerClientConfig sharedClientConfig;
private final String testClass;
protected DomainTestSupport(final String testClass, final String domainConfig, final String masterConfig,
final String slaveConfig, WildFlyManagedConfiguration masterBase,
final WildFlyManagedConfiguration slaveBase) throws Exception {
this(testClass, domainConfig, masterConfig, slaveConfig, masterBase, slaveBase, false, false, false);
}
protected DomainTestSupport(final String testClass, final String domainConfig, final String masterConfig,
final String slaveConfig, WildFlyManagedConfiguration masterBase,
final WildFlyManagedConfiguration slaveBase, final boolean readOnlyDomainConfig,
final boolean readOnlyMasterHostConfig, final boolean readOnlySlaveHostConfig) throws Exception {
this(testClass, getMasterConfiguration(domainConfig, masterConfig, testClass, masterBase, readOnlyDomainConfig, readOnlyMasterHostConfig),
slaveConfig == null ? null : getSlaveConfiguration(slaveConfig, testClass, slaveBase, readOnlySlaveHostConfig));
}
protected DomainTestSupport(final String testClass, final WildFlyManagedConfiguration masterConfiguration,
final WildFlyManagedConfiguration slaveConfiguration) throws Exception {
this.testClass = testClass;
this.sharedClientConfig = DomainControllerClientConfig.create();
this.masterConfiguration = masterConfiguration;
this.domainMasterLifecycleUtil = new DomainLifecycleUtil(masterConfiguration, sharedClientConfig);
this.slaveConfiguration = slaveConfiguration;
if (slaveConfiguration != null) {
this.domainSlaveLifecycleUtil = new DomainLifecycleUtil(slaveConfiguration, sharedClientConfig);
} else {
this.domainSlaveLifecycleUtil = null;
}
}
public static DomainTestSupport create(final Configuration configuration) throws Exception {
return new DomainTestSupport(configuration.getTestName(), configuration.getMasterConfiguration(), configuration.getSlaveConfiguration());
}
public static DomainTestSupport create(final String testClass, final Configuration configuration) throws Exception {
return new DomainTestSupport(testClass, configuration.getMasterConfiguration(), configuration.getSlaveConfiguration());
}
public static DomainTestSupport create(final String testClass, final WildFlyManagedConfiguration masterConfiguration,
final WildFlyManagedConfiguration slaveConfiguration) throws Exception {
return new DomainTestSupport(testClass, masterConfiguration, slaveConfiguration);
}
public WildFlyManagedConfiguration getDomainMasterConfiguration() {
return masterConfiguration;
}
public DomainLifecycleUtil getDomainMasterLifecycleUtil() {
return domainMasterLifecycleUtil;
}
public WildFlyManagedConfiguration getDomainSlaveConfiguration() {
return slaveConfiguration;
}
public DomainLifecycleUtil getDomainSlaveLifecycleUtil() {
return domainSlaveLifecycleUtil;
}
public DomainControllerClientConfig getSharedClientConfiguration() {
return sharedClientConfig;
}
public void start() {
domainMasterLifecycleUtil.start();
if (domainSlaveLifecycleUtil != null) {
try {
domainSlaveLifecycleUtil.start();
} catch (RuntimeException e) {
try {
//Clean up after ourselves if slave failed to start
domainMasterLifecycleUtil.stop();
} catch (RuntimeException ignore) {
}
throw e;
}
}
}
public void addTestModule(String moduleName, InputStream moduleXml, Map<String, StreamExporter> contents) throws IOException {
File modulesDir = getAddedModulesDir(testClass);
addModule(modulesDir, moduleName, moduleXml, contents);
}
public void addOverrideModule(String hostName, String moduleName, InputStream moduleXml, Map<String, StreamExporter> contents) throws IOException {
File modulesDir = getHostOverrideModulesDir(testClass, hostName);
addModule(modulesDir, moduleName, moduleXml, contents);
}
static void addModule(final File modulesDir, String moduleName, InputStream moduleXml, Map<String, StreamExporter> resources) throws IOException {
String modulePath = moduleName.replace('.', File.separatorChar) + File.separatorChar + "main";
File moduleDir = new File(modulesDir, modulePath);
moduleDir.mkdirs();
FileUtils.copyFile(moduleXml, new File(moduleDir, "module.xml"));
for (Map.Entry<String, StreamExporter> entry : resources.entrySet()) {
entry.getValue().exportTo(new File(moduleDir, entry.getKey()), true);
}
}
public void stop() {
try {
try {
if (domainSlaveLifecycleUtil != null) {
domainSlaveLifecycleUtil.stop();
}
} finally {
domainMasterLifecycleUtil.stop();
}
} finally {
StreamUtils.safeClose(sharedClientConfig);
}
}
public static class Configuration {
private final String testName;
private final WildFlyManagedConfiguration masterConfiguration;
private final WildFlyManagedConfiguration slaveConfiguration;
protected Configuration(final String testName, WildFlyManagedConfiguration masterConfiguration,
WildFlyManagedConfiguration slaveConfiguration) {
this.testName = testName;
this.masterConfiguration = masterConfiguration;
this.slaveConfiguration = slaveConfiguration;
}
public String getTestName() {
return testName;
}
public WildFlyManagedConfiguration getMasterConfiguration() {
return masterConfiguration;
}
public WildFlyManagedConfiguration getSlaveConfiguration() {
return slaveConfiguration;
}
public static Configuration create(final String testName, final String domainConfig, final String masterConfig, final String slaveConfig) {
return create(testName, domainConfig, masterConfig, slaveConfig, false, false, false);
}
public static Configuration create(final String testName, final String domainConfig, final String masterConfig,
final String slaveConfig, boolean readOnlyMasterDomain, boolean readOnlyMasterHost, boolean readOnlySlaveHost) {
return create(testName, domainConfig, masterConfig, slaveConfig, readOnlyMasterDomain, readOnlyMasterHost, false, readOnlySlaveHost, false);
}
public static Configuration create(final String testName, final String domainConfig, final String masterConfig,
final String slaveConfig,
boolean readOnlyMasterDomain, boolean readOnlyMasterHost, boolean masterDebug,
boolean readOnlySlaveHost, boolean slaveDebug) {
WildFlyManagedConfiguration masterConfiguration = getMasterConfiguration(domainConfig, masterConfig, testName, null, readOnlyMasterDomain, readOnlyMasterHost, masterDebug);
WildFlyManagedConfiguration slaveConfiguration = slaveConfig == null ? null : getSlaveConfiguration(slaveConfig, testName, "slave", null, readOnlySlaveHost, slaveDebug);
return new Configuration(testName, masterConfiguration, slaveConfiguration);
}
private static WildFlyManagedConfiguration getMasterConfiguration(String domainConfigPath, String hostConfigPath,
String testName, WildFlyManagedConfiguration baseConfig,
boolean readOnlyDomain, boolean readOnlyHost, boolean debug) {
final String hostName = "master";
File domains = getBaseDir(testName);
File extraModules = getAddedModulesDir(testName);
File overrideModules = getHostOverrideModulesDir(testName, hostName);
ClassLoader tccl = Thread.currentThread().getContextClassLoader();
final WildFlyManagedConfiguration masterConfig = baseConfig == null ? new WildFlyManagedConfiguration() : baseConfig;
configureModulePath(masterConfig, overrideModules, extraModules);
masterConfig.setHostControllerManagementAddress(masterAddress);
masterConfig.setHostCommandLineProperties("-Djboss.test.host.master.address=" + masterAddress);
if(debug) {
masterConfig.setHostCommandLineProperties("-agentlib:jdwp=transport=dt_socket,address=8787,server=y,suspend=y " +
masterConfig.getHostCommandLineProperties());
}
masterConfig.setReadOnlyDomain(readOnlyDomain);
masterConfig.setReadOnlyHost(readOnlyHost);
URL url = tccl.getResource(domainConfigPath);
assert url != null : "cannot find domainConfigPath";
masterConfig.setDomainConfigFile(new File(toURI(url)).getAbsolutePath());
url = tccl.getResource(hostConfigPath);
assert url != null : "cannot find hostConfigPath";
masterConfig.setHostConfigFile(new File(toURI(url)).getAbsolutePath());
File masterDir = new File(domains, hostName);
// TODO this should not be necessary
new File(masterDir, "configuration").mkdirs();
masterConfig.setDomainDirectory(masterDir.getAbsolutePath());
if (masterJvmHome != null) masterConfig.setJavaHome(masterJvmHome);
if (masterControllerJvmHome != null) masterConfig.setControllerJavaHome(masterControllerJvmHome);
return masterConfig;
}
private static WildFlyManagedConfiguration getSlaveConfiguration(String hostConfigPath, String testName,
String hostName, WildFlyManagedConfiguration baseConfig,
boolean readOnlyHost, boolean debug) {
File domains = getBaseDir(testName);
File extraModules = getAddedModulesDir(testName);
File overrideModules = getHostOverrideModulesDir(testName, hostName);
ClassLoader tccl = Thread.currentThread().getContextClassLoader();
final WildFlyManagedConfiguration slaveConfig = baseConfig == null ? new WildFlyManagedConfiguration() : baseConfig;
configureModulePath(slaveConfig, overrideModules, extraModules);
slaveConfig.setHostName(hostName);
slaveConfig.setHostControllerManagementAddress(slaveAddress);
slaveConfig.setHostControllerManagementPort(19999);
slaveConfig.setHostCommandLineProperties("-Djboss.test.host.master.address=" + masterAddress +
" -Djboss.test.host.slave.address=" + slaveAddress);
if(debug) {
slaveConfig.setHostCommandLineProperties("-agentlib:jdwp=transport=dt_socket,address=8788,server=y,suspend=y " +
slaveConfig.getHostCommandLineProperties());
}
slaveConfig.setReadOnlyHost(readOnlyHost);
URL url = tccl.getResource(hostConfigPath);
slaveConfig.setHostConfigFile(new File(toURI(url)).getAbsolutePath());
File slaveDir = new File(domains, hostName);
// TODO this should not be necessary
new File(slaveDir, "configuration").mkdirs();
slaveConfig.setDomainDirectory(slaveDir.getAbsolutePath());
if (slaveJvmHome != null) slaveConfig.setJavaHome(slaveJvmHome);
if (slaveControllerJvmHome != null) slaveConfig.setControllerJavaHome(slaveControllerJvmHome);
return slaveConfig;
}
}
}