org.codehaus.cargo.sample.java.CargoTestSuite Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cargo-sample-java Show documentation
Show all versions of cargo-sample-java Show documentation
Sample application that exercises the Cargo Java API
The newest version!
/*
* ========================================================================
*
* Codehaus Cargo, copyright 2004-2011 Vincent Massol, 2012-2024 Ali Tokmen.
*
* 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.
*
* ========================================================================
*/
package org.codehaus.cargo.sample.java;
import java.io.File;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.codehaus.cargo.container.ContainerType;
import org.codehaus.cargo.generic.DefaultContainerFactory;
import org.codehaus.cargo.sample.java.validator.Validator;
/**
* Cargo test suite.
*/
public class CargoTestSuite extends TestSuite
{
/**
* The system property for the container identifiers to run tests on.
*/
public static final String SYSTEM_PROPERTY_CONTAINER_IDS = "cargo.containers";
/**
* Registered containers.
*/
private Map> registeredContainers;
/**
* Container identifiers on which to run tests.
*/
private List containerIds;
/**
* Initialize with the given suite name.
* @param suiteName Suite name.
*/
public CargoTestSuite(String suiteName)
{
super(suiteName);
initialize();
}
/**
* Parse the list of containers.
*/
private void initialize()
{
this.registeredContainers = new DefaultContainerFactory().getContainerIds();
this.containerIds = new ArrayList();
if (System.getProperty(SYSTEM_PROPERTY_CONTAINER_IDS) == null)
{
throw new RuntimeException("System property \"" + SYSTEM_PROPERTY_CONTAINER_IDS
+ "\" must be defined.");
}
StringTokenizer tokens =
new StringTokenizer(System.getProperty(SYSTEM_PROPERTY_CONTAINER_IDS), ", ");
while (tokens.hasMoreTokens())
{
String token = tokens.nextToken();
this.containerIds.add(token);
}
}
/**
* Add a given test suite.
* @param testClass Test class.
* @param validators List of validators, to check if tests should be run on a given container.
*/
public void addTestSuite(Class testClass, Validator[] validators)
{
addTestSuite(testClass, validators, null);
}
/**
* Add a given test suite.
* @param testClass Test class.
* @param validators List of validators, to check if tests should be run on a given container.
* @param excludedContainerIds Containers to exclude.
*/
public void addTestSuite(Class testClass, Validator[] validators,
Set excludedContainerIds)
{
for (String containerId : this.containerIds)
{
// Skip container ids that are excluded by the user, as some containers don't support
// everything. for example, OSGi containers cannot support shared class loaders.
if (excludedContainerIds != null && excludedContainerIds.contains(containerId))
{
continue;
}
// Find out all registered container types for this container id and for each of them
// verify if the couple (containerId, type) should be added as a container identity
// that can run tests in this suite.
Set registeredTypes = this.registeredContainers.get(containerId);
if (registeredTypes == null)
{
throw new RuntimeException("Invalid container id [" + containerId + "]");
}
for (ContainerType type : registeredTypes)
{
if (type.equals(ContainerType.EMBEDDED))
{
String containerJavaHome =
System.getProperty("cargo." + containerId + ".java.home");
String currentJavaHome = System.getProperty("java.home");
if (containerJavaHome != null && !containerJavaHome.isEmpty()
&& currentJavaHome != null && !currentJavaHome.isEmpty())
{
File containerJavaHomeDirectory =
new File(containerJavaHome).getAbsoluteFile();
File currentJavaHomeDirectory =
new File(currentJavaHome).getAbsoluteFile();
if (!currentJavaHomeDirectory.equals(containerJavaHomeDirectory))
{
// Container JAVA_HOME has been set to a different folder than the
// JAVA_HOME used by the build / testing process.
// Do not run embedded tests.
break;
}
}
}
// Verify that the test passes all validators
boolean shouldAddTest = true;
for (Validator validator : validators)
{
if (!validator.validate(containerId, type))
{
shouldAddTest = false;
break;
}
}
// If so, adds the tests to the suite
if (shouldAddTest)
{
try
{
addContainerToSuite(containerId, type, testClass);
}
catch (Exception e)
{
throw new RuntimeException("Failed to add container [" + containerId
+ "] for test case class [" + testClass.getName() + "]", e);
}
}
}
}
}
/**
* Add a container to a test suite.
* @param containerId Container identifier.
* @param type Container type.
* @param testClass Test class.
* @throws Exception If anything goes wrong.
*/
private void addContainerToSuite(String containerId, ContainerType type,
Class testClass) throws Exception
{
// Find all methods starting with "test" and add them
Method[] methods = testClass.getMethods();
for (Method method : methods)
{
if (method.getName().startsWith("test"))
{
addContainerToTest(containerId, type, method.getName(), testClass);
}
}
}
/**
* Add a container to a test of a test suite.
* @param containerId Container identifier.
* @param type Container type.
* @param testName Test name.
* @param testClass Test class.
* @throws Exception If anything goes wrong.
*/
private void addContainerToTest(String containerId, ContainerType type, String testName,
Class testClass) throws Exception
{
String testClassName =
testClass.getName().substring(testClass.getName().lastIndexOf('.') + 1);
// Compute a unique directory for the test data based on the container id, the container
// type and the test name.
String targetDir = containerId + "/" + type.getType() + "/" + testClassName + "/"
+ testName + "/container";
EnvironmentTestData testData = new EnvironmentTestData(containerId, type, targetDir);
Constructor constructor =
testClass.getConstructor(String.class, EnvironmentTestData.class);
Test test = constructor.newInstance(testName, testData);
addTest(test);
}
}