Skip to content

Commit

Permalink
Extract common code to AbstractEclipseBuildMojo so it can be reused
Browse files Browse the repository at this point in the history
Currently EclipseBuildMojo performs the boilerplate to perform an
eclipse like build inside tycho build, but this can be useful for other
scenarios as well.

This now extracts the common code into an AbstractEclipseBuildMojo so it
can be reused.
  • Loading branch information
laeubi committed Jan 19, 2025
1 parent d20eae1 commit 75c30e8
Show file tree
Hide file tree
Showing 4 changed files with 259 additions and 209 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,198 @@
/*******************************************************************************
* Copyright (c) 2025 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.eclipsebuild;

import java.io.Serializable;
import java.lang.reflect.InvocationTargetException;
import java.nio.file.Path;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.concurrent.Callable;
import java.util.function.Consumer;

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.plugin.logging.Log;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.eclipse.core.resources.IMarker;
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;

/**
* An abstract mojo baseclass that can be used to perform actions on an eclipse
* project that requires the build infrastructure.
*
* @param <Result> the rsult type
*/
public abstract class AbstractEclipseBuildMojo<Result extends EclipseBuildResult> extends AbstractMojo {

static final String PARAMETER_LOCAL = "local";

@Parameter()
private Repository eclipseRepository;

@Parameter(defaultValue = "false", property = "tycho.eclipsebuild.skip")
private boolean skip;

@Parameter(defaultValue = "false", property = "tycho.eclipsebuild.debug")
protected boolean debug;

/**
* 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(defaultValue = "true", property = "tycho.eclipsebuild.printMarker")
private boolean printMarker;

@Parameter
private List<String> bundles;

@Parameter
private List<String> features;

@Parameter(property = "project", readonly = true)
protected MavenProject project;

@Component
private EclipseWorkspaceManager workspaceManager;

@Component
private EclipseApplicationManager eclipseApplicationManager;

@Component
private TychoProjectManager projectManager;

@Override
public final 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(getFeatures());
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, getName());
} else {
application = eclipseApplicationManager.getApplication(eclipseRepository, bundles, features, getName());
}
try (EclipseFramework framework = application.startFramework(workspaceManager
.getWorkspace(EclipseApplicationManager.getRepository(eclipseRepository).getURL(), this), List.of())) {
if (debug) {
framework.printState();
}
if (framework.hasBundle(Bundles.BUNDLE_PDE_CORE)) {
framework.execute(new SetTargetPlatform(projectDependencies, debug));
} else {
getLog().info("Skip set Target Platform because " + Bundles.BUNDLE_PDE_CORE
+ " is not part of the framework...");
}
Result result = framework.execute(createExecutable());
if (printMarker) {
Log log = getLog();
result.markers().filter(marker -> marker.getAttribute(IMarker.SEVERITY, -1) == IMarker.SEVERITY_INFO)
.forEach(info -> printMarker(info, result, log::info));
result.markers().filter(marker -> marker.getAttribute(IMarker.SEVERITY, -1) == IMarker.SEVERITY_WARNING)
.forEach(warn -> printMarker(warn, result, log::warn));
result.markers().filter(marker -> marker.getAttribute(IMarker.SEVERITY, -1) == IMarker.SEVERITY_ERROR)
.forEach(error -> printMarker(error, result, log::error));
}
handleResult(result);
} catch (BundleException e) {
throw new MojoFailureException("Can't start framework!", e);
} catch (InvocationTargetException e) {
Throwable cause = e.getCause();
if (cause.getClass().getName().equals(CoreException.class.getName())) {
throw new MojoFailureException(cause.getMessage(), cause);
}
throw new MojoExecutionException(cause);
}
}

protected abstract void handleResult(Result result) throws MojoFailureException;

protected abstract <X extends Callable<R> & Serializable, R extends Serializable> R createExecutable();

protected Set<String> getFeatures() {
Set<String> set = new HashSet<>();
if (features != null) {
set.addAll(features);
}
return set;
}

protected Set<String> getBundles() {
Set<String> set = new HashSet<>();
set.add("org.eclipse.core.resources");
set.add("org.eclipse.core.runtime");
set.add("org.eclipse.core.jobs");
if (bundles != null) {
set.addAll(bundles);
}
return set;
}

private static void printMarker(IMarker marker, EclipseBuildResult result, Consumer<CharSequence> consumer) {
consumer.accept(asString(marker, result).toString().trim());
}

protected static StringBuilder asString(IMarker marker, EclipseBuildResult result) {
StringBuilder sb = new StringBuilder();
String path = result.getMarkerPath(marker);
if (path != null) {
sb.append(path);
int line = marker.getAttribute("lineNumber", -1);
if (line > -1) {
sb.append(":");
sb.append(line);
}
sb.append(" ");
}
String message = marker.getAttribute("message", "");
if (!message.isBlank()) {
sb.append(message);
sb.append(" ");
}
String sourceId = marker.getAttribute("sourceId", "");
if (!sourceId.isBlank()) {
sb.append(sourceId);
sb.append(" ");
}
return sb;
}

protected abstract String getName();

}
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ public class EclipseBuildInstallableUnitProvider implements InstallableUnitProvi
@Override
public Collection<IInstallableUnit> getInstallableUnits(MavenProject project, MavenSession session)
throws CoreException {
Configuration configuration = configurationHelper.getConfiguration(EclipseBuildMojo.class, project, session);
Optional<Boolean> local = configuration.getBoolean(EclipseBuildMojo.PARAMETER_LOCAL);
Configuration configuration = configurationHelper.getConfiguration(EclipseBuildProjectMojo.class, project, session);
Optional<Boolean> local = configuration.getBoolean(EclipseBuildProjectMojo.PARAMETER_LOCAL);
if (local.isPresent() && local.get()) {
// for local target resolution the bundles become requirements...
Optional<List<String>> list = configuration.getStringList("bundles");
Expand Down
Loading

0 comments on commit 75c30e8

Please sign in to comment.