org.eclipse.tycho.test.AbstractTychoIntegrationTest Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2008, 2011 Sonatype Inc. and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Sonatype Inc. - initial API and implementation
*******************************************************************************/
package org.eclipse.tycho.test;
import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.StringWriter;
import org.apache.maven.it.Verifier;
import org.apache.maven.it.util.DirectoryScanner;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.IOUtil;
import org.eclipse.tycho.test.util.EnvironmentUtil;
import org.junit.Assert;
import org.junit.Rule;
import org.junit.rules.TestName;
import org.osgi.framework.Version;
public abstract class AbstractTychoIntegrationTest {
/**
* Location of m2e.tycho workspace state location.
*
* Value must match among tycho-insitu, DevelopmentWorkspaceState and
* AbstractTychoIntegrationTest.
*/
private static final String SYSPROP_STATELOCATION = "tychodev.workspace.state";
@Rule
public TestName name = new TestName();
protected File getBasedir(String test) throws IOException {
File src = new File("projects", test).getAbsoluteFile();
File dst = new File("target/projects", getClass().getSimpleName() + "/" + name.getMethodName() + "/" + test)
.getAbsoluteFile();
if (dst.isDirectory()) {
FileUtils.deleteDirectory(dst);
} else if (dst.isFile()) {
if (!dst.delete()) {
throw new IOException("Can't delete file " + dst.toString());
}
}
FileUtils.copyDirectoryStructure(src, dst);
return dst;
}
protected Verifier getVerifier(String test, boolean setTargetPlatform) throws Exception {
return getVerifier(test, setTargetPlatform, getSettings());
}
protected Verifier getVerifier(String test, boolean setTargetPlatform, boolean ignoreLocalArtifacts)
throws Exception {
return getVerifier(test, setTargetPlatform, getSettings(), ignoreLocalArtifacts);
}
protected Verifier getVerifier(String test, boolean setTargetPlatform, File userSettings) throws Exception {
return getVerifier(test, setTargetPlatform, userSettings, true);
}
@SuppressWarnings("unchecked")
protected Verifier getVerifier(String test, boolean setTargetPlatform, File userSettings,
boolean ignoreLocalArtifacts) throws Exception {
/*
* Test JVM can be started in debug mode by passing the following env to execute(...)
* methods.
*
* java.util.Map env = new java.util.HashMap();
* env.put("MAVEN_OPTS",
* "-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000");
*/
// oddly enough, Verifier uses this system property to locate maven install
System.setProperty("maven.home", getMavenHome());
File testDir = getBasedir(test);
Verifier verifier = new Verifier(testDir.getAbsolutePath());
verifier.getCliOptions().add("-Dmaven.home=" + getMavenHome());
verifier.getCliOptions().add("-Dtycho-version=" + getTychoVersion());
// bug 447397: use temp dir in target/ folder to make sure we don't leave garbage behind
// when using maven < 3.1
File tmpDir = new File("target/tmp");
tmpDir.mkdirs();
verifier.getCliOptions().add("-Djava.io.tmpdir=" + tmpDir.getAbsolutePath());
if (setTargetPlatform) {
verifier.getCliOptions().add("-Dtycho.targetPlatform=" + getTargetPlatform());
}
if (ignoreLocalArtifacts) {
verifier.getCliOptions().add("-Dtycho.localArtifacts=ignore");
}
verifier.getCliOptions().add("-X");
verifier.getCliOptions().add("-s " + userSettings.getAbsolutePath());
verifier.getVerifierProperties().put("use.mavenRepoLocal", "true");
verifier.setLocalRepo(EnvironmentUtil.getLocalRepo());
String customOptions = System.getProperty("it.cliOptions");
if (customOptions != null && customOptions.trim().length() > 0) {
verifier.getCliOptions().add(customOptions);
}
if (System.getProperty(SYSPROP_STATELOCATION) != null) {
verifier.setForkJvm(false);
String m2eresolver = System.getProperty("tychodev-maven.ext.class.path"); // XXX
if (m2eresolver != null) {
verifier.addCliOption("-Dmaven.ext.class.path=" + m2eresolver);
}
}
return verifier;
}
protected Verifier getVerifier(String test) throws Exception {
return getVerifier(test, true);
}
protected String getTargetPlatform() {
return EnvironmentUtil.getTargetPlatform();
}
private static File getSettings() {
// alternative settings.xml, e.g. outside the source code repository
// - read from Eclipse launch configuration
String systemValue = System.getProperty("tycho.testSettings");
if (systemValue != null) {
return new File(systemValue);
}
// - read from command line
String commandLineValue = EnvironmentUtil.getTestSettings();
if (commandLineValue != null) {
return new File(commandLineValue);
}
// default: settings.xml in the root of the integration test project (e.g. tycho-its/settings.xml)
return new File("settings.xml");
}
protected String getMavenHome() {
String mavenHome = EnvironmentUtil.getMavenHome();
if (mavenHome == null) {
throw new IllegalStateException(
"Generated test data for the integration tests is missing. Run the launch configuration 'tycho-its - prepare test resources' first.");
}
return mavenHome;
}
protected String getTychoVersion() {
return EnvironmentUtil.getTychoVersion();
}
protected void assertFileExists(File targetdir, String pattern) {
DirectoryScanner ds = new DirectoryScanner();
ds.setBasedir(targetdir);
ds.setIncludes(new String[] { pattern });
ds.scan();
Assert.assertEquals(targetdir.getAbsolutePath() + "/" + pattern, 1, ds.getIncludedFiles().length);
Assert.assertTrue(targetdir.getAbsolutePath() + "/" + pattern,
new File(targetdir, ds.getIncludedFiles()[0]).canRead());
}
protected void assertDirectoryExists(File targetdir, String pattern) {
DirectoryScanner ds = new DirectoryScanner();
ds.setBasedir(targetdir);
ds.setIncludes(new String[] { pattern });
ds.scan();
Assert.assertEquals(targetdir.getAbsolutePath() + "/" + pattern, 1, ds.getIncludedDirectories().length);
Assert.assertTrue(targetdir.getAbsolutePath() + "/" + pattern, new File(targetdir,
ds.getIncludedDirectories()[0]).exists());
}
protected void assertFileDoesNotExist(File targetdir, String pattern) {
DirectoryScanner ds = new DirectoryScanner();
ds.setBasedir(targetdir);
ds.setIncludes(new String[] { pattern });
ds.scan();
Assert.assertEquals(targetdir.getAbsolutePath() + "/" + pattern, 0, ds.getIncludedFiles().length);
}
protected String toURI(File file) throws IOException {
return file.getCanonicalFile().toURI().normalize().toString();
}
protected void writeStringToFile(File iniFile, String string) throws IOException {
OutputStream os = new BufferedOutputStream(new FileOutputStream(iniFile));
try {
IOUtil.copy(string, os);
} finally {
IOUtil.close(os);
}
}
protected StringBuffer readFileToString(File iniFile) throws IOException {
InputStream is = new BufferedInputStream(new FileInputStream(iniFile));
try {
StringWriter buffer = new StringWriter();
IOUtil.copy(is, buffer, "UTF-8");
return buffer.getBuffer();
} finally {
IOUtil.close(is);
}
}
/**
* Returns approximate target platform version.
*/
public static Version getEclipseVersion() {
String location = EnvironmentUtil.getTargetPlatform();
DirectoryScanner ds = new DirectoryScanner();
ds.setBasedir(new File(location, "plugins"));
ds.setIncludes(new String[] { "org.eclipse.osgi_*.jar" });
ds.scan();
String[] files = ds.getIncludedFiles();
if (files == null || files.length < 1) {
throw new IllegalStateException("Unable to determine version of the test target platform " + location);
}
String version = files[0].substring("org.eclipse.osgi_".length(), files[0].length() - ".jar".length());
return Version.parseVersion(version);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy