Add Mojos to replace "The Eclipse Test Framework"

The Eclipse Test Framework is a way to specifically run a test inside an
eclipse installation itself against a prebuild SDK.

This implements the framework on top of maven to make it much easier to
run and setup than with the several (ant) prerequsites of the original
description provided here:

- https://wiki.eclipse.org/Platform-releng/Eclipse_Test_Framework
- https://wiki.eclipse.org/Platform-releng/Automated_Testing

as well as offer much more flexibility e.g. to run tests in a local mode
where not the SDK but a local build is used as the test base.

tycho-core/src/main/java/org/eclipse/tycho/osgi/framework/EclipseFramework.java

@@ -14,6 +14,8 @@
 
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.io.FileInputStream;
 import java.io.IOException;
 import java.io.ObjectOutputStream;
 import java.io.Serializable;
@@ -191,4 +193,10 @@ public boolean hasBundle(String bsn) {
         return false;
     }
 
+    public Bundle install(File file) throws IOException, BundleException {
+        try (FileInputStream stream = new FileInputStream(file)) {
+            return framework.getBundleContext().installBundle(file.getAbsolutePath(), stream);
+        }
+    }
+
 }

tycho-eclipse-plugin/src/main/java/org/eclipse/tycho/eclipsetest/AbstractEclipseTestMojo.java

@@ -0,0 +1,153 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Christoph Läubrich and others.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Christoph Läubrich - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.tycho.eclipsetest;
+
+import java.io.File;
+import java.nio.file.Path;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+
+import org.apache.maven.model.Repository;
+import org.apache.maven.plugin.AbstractMojo;
+import org.apache.maven.plugin.MojoExecutionException;
+import org.apache.maven.plugin.MojoFailureException;
+import org.apache.maven.plugins.annotations.Component;
+import org.apache.maven.plugins.annotations.Parameter;
+import org.apache.maven.project.MavenProject;
+import org.eclipse.core.runtime.CoreException;
+import org.eclipse.tycho.TargetPlatform;
+import org.eclipse.tycho.core.TychoProjectManager;
+import org.eclipse.tycho.osgi.framework.Bundles;
+import org.eclipse.tycho.osgi.framework.EclipseApplication;
+import org.eclipse.tycho.osgi.framework.EclipseApplicationManager;
+import org.eclipse.tycho.osgi.framework.EclipseFramework;
+import org.eclipse.tycho.osgi.framework.EclipseWorkspaceManager;
+import org.eclipse.tycho.osgi.framework.Features;
+import org.osgi.framework.BundleException;
+
+public abstract class AbstractEclipseTestMojo extends AbstractMojo {
+
+	private static final String PARAMETER_JUNIT_REPORT_OUTPUT = "junitReportOutput";
+
+	private static final String PARAMETER_CLASSNAME = "classname";
+
+	private static final String PARAMETER_TESTPLUGINNAME = "testpluginname";
+
+	static final String PARAMETER_LOCAL = "local";
+
+	private static final String NAME = "Eclipse Test";
+
+	@Parameter()
+	private Repository eclipseRepository;
+
+	@Parameter(defaultValue = "false", property = "tycho.eclipsetest.skip")
+	private boolean skip;
+
+	@Parameter(defaultValue = "false", property = "tycho.eclipsetest.debug")
+	private boolean debug;
+
+	@Parameter(name = PARAMETER_CLASSNAME, alias = "test-classname", required = true)
+	private String classname;
+
+	@Parameter(name = PARAMETER_JUNIT_REPORT_OUTPUT)
+	private String junitReportOutput;
+
+	@Parameter(defaultValue = "${project.build.directory}/eclipse-test-reports/${project.artifactId}.xml")
+	private File resultFile;
+
+	/**
+	 * Controls if the local target platform of the project should be used to
+	 * resolve the eclipse application
+	 */
+	@Parameter(defaultValue = "false", property = "tycho.eclipsebuild.local", name = PARAMETER_LOCAL)
+	private boolean local;
+
+	@Parameter(property = "project", readonly = true)
+	private MavenProject project;
+
+	@Component
+	private EclipseWorkspaceManager workspaceManager;
+
+	@Component
+	private EclipseApplicationManager eclipseApplicationManager;
+
+	@Component
+	private TychoProjectManager projectManager;
+
+
+	@Override
+	public void execute() throws MojoExecutionException, MojoFailureException {
+		Collection<Path> projectDependencies;
+		try {
+			projectDependencies = projectManager.getProjectDependencies(project);
+		} catch (Exception e) {
+			throw new MojoFailureException("Can't resolve project dependencies", e);
+		}
+		EclipseApplication application;
+		Bundles bundles = new Bundles(getBundles());
+		Features features = new Features(Set.of());
+		if (local) {
+			TargetPlatform targetPlatform = projectManager.getTargetPlatform(project).orElseThrow(
+					() -> new MojoFailureException("Can't get target platform for project " + project.getId()));
+			application = eclipseApplicationManager.getApplication(targetPlatform, bundles, features, NAME);
+		} else {
+			application = eclipseApplicationManager.getApplication(eclipseRepository, bundles, features, NAME);
+		}
+		List<String> arguments = new ArrayList<>();
+		arguments.add(EclipseApplication.ARG_APPLICATION);
+		arguments.add(getApplication());
+		arguments.add(toParam(PARAMETER_TESTPLUGINNAME));
+		arguments.add(projectManager.getArtifactKey(project).get().getId());
+		arguments.add(toParam(PARAMETER_CLASSNAME));
+		arguments.add(classname);
+		if (junitReportOutput != null) {
+			arguments.add(toParam(PARAMETER_JUNIT_REPORT_OUTPUT));
+			arguments.add(junitReportOutput);
+		}
+		arguments.add("formatter=org.apache.tools.ant.taskdefs.optional.junit.XMLJUnitResultFormatter,"
+				+ resultFile.getAbsolutePath());
+		try (EclipseFramework framework = application.startFramework(workspaceManager
+				.getWorkspace(EclipseApplicationManager.getRepository(eclipseRepository).getURL(), this), arguments)) {
+			if (debug) {
+				framework.printState();
+			}
+			framework.install(project.getArtifact().getFile()).start();
+			framework.start();
+		} catch (BundleException e) {
+			throw new MojoFailureException("Can't start framework!", e);
+		} catch (Exception e) {
+			Throwable cause = e.getCause();
+			if (cause.getClass().getName().equals(CoreException.class.getName())) {
+				throw new MojoFailureException(cause.getMessage(), cause);
+			}
+			throw new MojoExecutionException(cause);
+		}
+	}
+
+
+
+	private Set<String> getBundles() {
+		Set<String> bundles = new HashSet<String>();
+		bundles.add("org.eclipse.test");
+		return bundles;
+	}
+
+	protected abstract String getApplication();
+
+	private static String toParam(String name) {
+		return "-" + name;
+	}
+}

tycho-eclipse-plugin/src/main/java/org/eclipse/tycho/eclipsetest/EclipseCoreTestMojo.java

@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Christoph Läubrich and others.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Christoph Läubrich - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.tycho.eclipsetest;
+
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+
+/**
+ * This Mojo provides the <a href=
+ * "https://wiki.eclipse.org/Platform-releng/Eclipse_Test_Framework">Eclipse
+ * Test Framework</a> to maven and is a replacement for the <a href=
+ * "https://wiki.eclipse.org/Platform-releng/Eclipse_Test_Framework#Headless_Testing_vs._UI_testing"><code>core-test</code></a>
+ * ant target.
+ */
+@Mojo(name = "eclipse-core-test", defaultPhase = LifecyclePhase.INTEGRATION_TEST, threadSafe = true, requiresDependencyCollection = ResolutionScope.COMPILE_PLUS_RUNTIME)
+public class EclipseCoreTestMojo extends AbstractEclipseTestMojo {
+
+	@Override
+	protected String getApplication() {
+		return "org.eclipse.test.coretestapplication";
+	}
+
+}

tycho-eclipse-plugin/src/main/java/org/eclipse/tycho/eclipsetest/EclipseUITestMojo.java

@@ -0,0 +1,34 @@
+/*******************************************************************************
+ * Copyright (c) 2023 Christoph Läubrich and others.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Christoph Läubrich - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.tycho.eclipsetest;
+
+import org.apache.maven.plugins.annotations.LifecyclePhase;
+import org.apache.maven.plugins.annotations.Mojo;
+import org.apache.maven.plugins.annotations.ResolutionScope;
+
+/**
+ * This Mojo provides the <a href=
+ * "https://wiki.eclipse.org/Platform-releng/Eclipse_Test_Framework">Eclipse
+ * Test Framework</a> to maven and is a replacement for the <a href=
+ * "https://wiki.eclipse.org/Platform-releng/Eclipse_Test_Framework#Headless_Testing_vs._UI_testing"><code>ui-test</code></a>
+ * ant target.
+ */
+@Mojo(name = "eclipse-ui-test", defaultPhase = LifecyclePhase.INTEGRATION_TEST, threadSafe = true, requiresDependencyCollection = ResolutionScope.COMPILE_PLUS_RUNTIME)
+public class EclipseUITestMojo extends AbstractEclipseTestMojo {
+
+	@Override
+	protected String getApplication() {
+		return "org.eclipse.test.uitestapplication";
+	}
+
+}