-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add project configurator for tycho packagings (#967)
This closes #605
- Loading branch information
Showing
6 changed files
with
185 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
133 changes: 133 additions & 0 deletions
133
...ipse.m2e.pde.connector/src/org/eclipse/m2e/pde/connector/TychoPackagingsConfigurator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2022 Konrad Windszus | ||
| * | ||
| * 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: | ||
| * Konrad Windszus | ||
| *******************************************************************************/ | ||
| package org.eclipse.m2e.pde.connector; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.apache.maven.plugin.MojoExecution; | ||
| import org.apache.maven.project.MavenProject; | ||
| import org.codehaus.plexus.util.xml.Xpp3Dom; | ||
| import org.eclipse.core.resources.IProject; | ||
| import org.eclipse.core.resources.ProjectScope; | ||
| import org.eclipse.core.runtime.CoreException; | ||
| import org.eclipse.core.runtime.IProgressMonitor; | ||
| import org.eclipse.core.runtime.preferences.IEclipsePreferences; | ||
| import org.eclipse.m2e.core.internal.markers.SourceLocationHelper; | ||
| import org.eclipse.m2e.core.project.configurator.AbstractProjectConfigurator; | ||
| import org.eclipse.m2e.core.project.configurator.ProjectConfigurationRequest; | ||
| import org.eclipse.pde.ds.internal.annotations.DSAnnotationVersion; | ||
| import org.eclipse.pde.internal.core.natures.PDE; | ||
| import org.osgi.framework.Version; | ||
|
|
||
| @SuppressWarnings("restriction") | ||
| public class TychoPackagingsConfigurator extends AbstractProjectConfigurator { | ||
|
|
||
| private static final String TYCHO_GROUP_ID = "org.eclipse.tycho"; | ||
| private static final String TYCHO_DS_PLUGIN_ARTIFACT_ID = "tycho-ds-plugin"; | ||
| private static final String GOAL_DECLARATIVE_SERVICES = "declarative-services"; | ||
|
|
||
| @Override | ||
| public void configure(ProjectConfigurationRequest request, IProgressMonitor monitor) throws CoreException { | ||
| MavenProject mavenProject = request.mavenProject(); | ||
| IProject project = request.mavenProjectFacade().getProject(); | ||
| String packaging = mavenProject.getPackaging(); | ||
| if ("eclipse-plugin".equals(packaging) || "eclipse-test-plugin".equals(packaging)) { | ||
| PDEProjectHelper.configurePDEBundleProject(project, mavenProject, monitor); | ||
| applyDsConfiguration(request, monitor); | ||
| } else if ("eclipse-feature".equals(packaging)) { | ||
| // see | ||
| // org.eclipse.pde.internal.ui.wizards.feature.AbstractCreateFeatureOperation | ||
| if (!project.hasNature(PDE.FEATURE_NATURE)) { | ||
| addNature(project, PDE.FEATURE_NATURE, monitor); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void applyDsConfiguration(ProjectConfigurationRequest request, IProgressMonitor monitor) | ||
| throws CoreException { | ||
| List<MojoExecution> mojoExecutions = getTychoDsPluginMojoExecutions(request, monitor); | ||
| if (mojoExecutions.isEmpty()) { | ||
| return; | ||
| } | ||
| if (mojoExecutions.size() > 1) { | ||
| String message = String.format( | ||
| "Found more than one execution for plugin %s:%s and goal %s, only consider configuration of this one", | ||
| TYCHO_GROUP_ID, TYCHO_DS_PLUGIN_ARTIFACT_ID, GOAL_DECLARATIVE_SERVICES); | ||
| createWarningMarker(request, mojoExecutions.get(0), "executions", message); | ||
| } | ||
| // first mojo execution is relevant | ||
| Xpp3Dom dom = mojoExecutions.get(0).getConfiguration(); | ||
| // apply PDE configuration for DS | ||
| IEclipsePreferences prefs = new ProjectScope(request.mavenProjectFacade().getProject()) | ||
| .getNode(org.eclipse.pde.ds.internal.annotations.Activator.PLUGIN_ID); | ||
| Xpp3Dom dsEnabled = dom.getChild("enabled"); | ||
| boolean isDsEnabled = false; | ||
| if (dsEnabled != null && !dsEnabled.getValue().isEmpty()) { | ||
| isDsEnabled = Boolean.valueOf(dsEnabled.getValue()); | ||
| prefs.putBoolean(org.eclipse.pde.ds.internal.annotations.Activator.PREF_ENABLED, isDsEnabled); | ||
| } | ||
| if (isDsEnabled) { | ||
| Xpp3Dom dsVersion = dom.getChild("dsVersion"); | ||
| if (containsExplicitConfigurationValue(dsVersion)) { | ||
| String versionValue = dsVersion.getValue(); | ||
| DSAnnotationVersion version = parseVersion(versionValue); | ||
| if (version != null) { | ||
| prefs.put(org.eclipse.pde.ds.internal.annotations.Activator.PREF_SPEC_VERSION, version.name()); | ||
| } else { | ||
| String message = "Unsupported DS spec version " + versionValue + " found, using default instead"; | ||
| createWarningMarker(request, mojoExecutions.get(0), SourceLocationHelper.CONFIGURATION, message); | ||
| } | ||
| } | ||
| Xpp3Dom path = dom.getChild("path"); | ||
| if (containsExplicitConfigurationValue(path)) { | ||
| prefs.put(org.eclipse.pde.ds.internal.annotations.Activator.PREF_PATH, path.getValue()); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private boolean containsExplicitConfigurationValue(Xpp3Dom config) { | ||
| // check if value is a property name | ||
| return config != null && !config.getValue().startsWith("${"); | ||
| } | ||
|
|
||
| private DSAnnotationVersion parseVersion(String version) { | ||
| if (version.startsWith("V")) { | ||
| version = version.substring(1).replace('_', '.'); | ||
| } | ||
| try { | ||
| Version osgiVersion = Version.parseVersion(version); | ||
| if (osgiVersion.getMajor() == 1 && osgiVersion.getMinor() == 1) { | ||
| return DSAnnotationVersion.V1_1; | ||
| } else if (osgiVersion.getMajor() == 1 && osgiVersion.getMinor() == 2) { | ||
| return DSAnnotationVersion.V1_2; | ||
| } else if (osgiVersion.getMajor() == 1 && osgiVersion.getMinor() == 3) { | ||
| return DSAnnotationVersion.V1_3; | ||
| } | ||
| } catch (IllegalArgumentException e) { // assume no match | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private List<MojoExecution> getTychoDsPluginMojoExecutions(ProjectConfigurationRequest request, | ||
| IProgressMonitor monitor) throws CoreException { | ||
| return request.mavenProjectFacade().getMojoExecutions(TYCHO_GROUP_ID, TYCHO_DS_PLUGIN_ARTIFACT_ID, monitor, | ||
| GOAL_DECLARATIVE_SERVICES); | ||
| } | ||
|
|
||
| private void createWarningMarker(ProjectConfigurationRequest request, MojoExecution execution, String attribute, | ||
| String message) { | ||
| PDEMavenBundlePluginConfigurator.createWarningMarker(projectManager, markerManager, request, execution, | ||
| attribute, message); | ||
| } | ||
| } |