From 935244989730e69e6372f00c6455378ffd6ba4d1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Christoph=20L=C3=A4ubrich?= Date: Fri, 5 Jan 2024 15:34:11 +0100 Subject: [PATCH] Only use ci-friendly version if there is such property defined Currently it can happen that one uses one of the "trigger properties" that enable Tycho pomless feature to assume that a cifriendly version is to be used even though ci-friendly versions are actually not used at all. This tries to differentiate the two cases by checking if there is actually a property defined that could be used in a ci-friendly way. --- .../tycho/build/TychoGraphBuilder.java | 2 +- .../tycho/build/bnd/BndWorkspaceMapping.java | 4 +- .../tycho/pomless/AbstractTychoMapping.java | 59 +++++++++++++------ .../eclipse/tycho/pomless/ParentModel.java | 20 +++++++ .../tycho/pomless/TychoBundleMapping.java | 2 +- .../tycho/pomless/TychoFeatureMapping.java | 2 +- .../tycho/pomless/TychoRepositoryMapping.java | 2 +- 7 files changed, 67 insertions(+), 24 deletions(-) create mode 100644 tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/ParentModel.java diff --git a/tycho-build/src/main/java/org/eclipse/tycho/build/TychoGraphBuilder.java b/tycho-build/src/main/java/org/eclipse/tycho/build/TychoGraphBuilder.java index 8607af5846..e654bd9805 100644 --- a/tycho-build/src/main/java/org/eclipse/tycho/build/TychoGraphBuilder.java +++ b/tycho-build/src/main/java/org/eclipse/tycho/build/TychoGraphBuilder.java @@ -84,7 +84,7 @@ public Result build(MavenSession session) { if (properties.getProperty(TychoCiFriendlyVersions.PROPERTY_BUILDQUALIFIER_FORMAT) != null || properties.getProperty(TychoCiFriendlyVersions.PROPERTY_FORCE_QUALIFIER) != null || properties.getProperty(TychoCiFriendlyVersions.BUILD_QUALIFIER) != null) { - tychoMapping.setSnapshotFormat("${" + TychoCiFriendlyVersions.BUILD_QUALIFIER + "}"); + tychoMapping.setSnapshotProperty(TychoCiFriendlyVersions.BUILD_QUALIFIER); } } } diff --git a/tycho-build/src/main/java/org/eclipse/tycho/build/bnd/BndWorkspaceMapping.java b/tycho-build/src/main/java/org/eclipse/tycho/build/bnd/BndWorkspaceMapping.java index 7b6716fc8c..baee93c6f2 100644 --- a/tycho-build/src/main/java/org/eclipse/tycho/build/bnd/BndWorkspaceMapping.java +++ b/tycho-build/src/main/java/org/eclipse/tycho/build/bnd/BndWorkspaceMapping.java @@ -23,11 +23,11 @@ import java.util.stream.Stream; import org.apache.maven.model.Model; -import org.apache.maven.model.Parent; import org.codehaus.plexus.component.annotations.Component; import org.eclipse.tycho.TychoConstants; import org.eclipse.tycho.pomless.AbstractTychoMapping; import org.eclipse.tycho.pomless.NoParentPomFound; +import org.eclipse.tycho.pomless.ParentModel; import org.sonatype.maven.polyglot.mapping.Mapping; import aQute.bnd.build.Project; @@ -123,7 +123,7 @@ protected void initModel(Model model, Reader artifactReader, Path cnfFolder) thr } @Override - protected Parent findParent(Path projectRoot, Map projectOptions) throws IOException { + protected ParentModel findParent(Path projectRoot, Map projectOptions) throws IOException { try { return super.findParent(projectRoot, projectOptions); } catch (NoParentPomFound e) { diff --git a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/AbstractTychoMapping.java b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/AbstractTychoMapping.java index 551022463f..c640a11e76 100644 --- a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/AbstractTychoMapping.java +++ b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/AbstractTychoMapping.java @@ -67,7 +67,8 @@ public abstract class AbstractTychoMapping implements Mapping, ModelReader { private static final String PARENT_POM_DEFAULT_VALUE = System.getProperty(TYCHO_POMLESS_PARENT_PROPERTY, ".."); private static final String QUALIFIER_SUFFIX = ".qualifier"; - private static final String MODEL_PARENT = "TychoMapping.model.parent"; + + private Map parentModelCache = new HashMap(); @Requirement protected PlexusContainer container; @@ -79,7 +80,7 @@ public abstract class AbstractTychoMapping implements Mapping, ModelReader { private boolean extensionMode; @SuppressWarnings("unused") private File multiModuleProjectDirectory; - private String snapshotFormat; + private String snapshotProperty; @Override public File locatePom(File dir) { @@ -155,7 +156,7 @@ private Model read(Reader artifactReader, Path artifactFile, Map opti model.setPackaging(getPackaging()); initModel(model, artifactReader, artifactFile); if (model.getParent() == null) { - model.setParent(findParent(artifactFile.getParent(), options)); + model.setParent(findParent(artifactFile.getParent(), options).parentReference()); } if (model.getVersion() == null && model.getParent() != null) { //inherit version from parent if not given @@ -172,11 +173,10 @@ protected Path getRealArtifactFile(Path polyglotArtifactFile) { return polyglotArtifactFile; } - protected Parent findParent(Path projectRoot, Map projectOptions) throws IOException { - Parent parent = (Parent) projectOptions.get(MODEL_PARENT); - if (parent != null) { - //if the parent is given by the options we don't need to search it! - return parent; + protected synchronized ParentModel findParent(Path projectRoot, Map projectOptions) throws IOException { + ParentModel cached = parentModelCache.get(projectRoot); + if (cached != null) { + return cached; } Properties buildProperties = getBuildProperties(projectRoot); // assumption parent pom must be physically located in parent directory if not given by build.properties @@ -198,16 +198,17 @@ protected Parent findParent(Path projectRoot, Map projectOptions) thr Model parentModel = parentPom.getReader().read(parentPom.getPomFile(), options); Parent parentReference = new Parent(); String groupId = parentModel.getGroupId(); - if (groupId == null) { + Parent grandParent = parentModel.getParent(); + if (groupId == null && grandParent != null) { // must be inherited from grandparent - groupId = parentModel.getParent().getGroupId(); + groupId = grandParent.getGroupId(); } parentReference.setGroupId(groupId); parentReference.setArtifactId(parentModel.getArtifactId()); String version = parentModel.getVersion(); - if (version == null) { + if (version == null && grandParent != null) { // must be inherited from grandparent - version = parentModel.getParent().getVersion(); + version = grandParent.getVersion(); } parentReference.setVersion(version); parentReference @@ -215,7 +216,9 @@ protected Parent findParent(Path projectRoot, Map projectOptions) thr logger.debug("Derived parent for path " + projectRoot + " is groupId: " + parentReference.getGroupId() + ", artifactId: " + parentReference.getArtifactId() + ", relativePath: " + parentReference.getRelativePath()); - return parentReference; + ParentModel model = new ParentModel(parentReference, parentModel); + parentModelCache.put(projectRoot, model); + return model; } /** @@ -342,18 +345,38 @@ private static void setLocation(Model model, Path modelSource) { model.setLocation("", new InputLocation(0, 0, inputSource)); } - protected String getPomVersion(String pdeVersion) { + protected String getPomVersion(String pdeVersion, Model model, Path projectRoot) { String pomVersion = pdeVersion; if (pdeVersion.endsWith(QUALIFIER_SUFFIX)) { String unqualifiedVersion = pdeVersion.substring(0, pdeVersion.length() - QUALIFIER_SUFFIX.length()); - if (isExtensionMode() && snapshotFormat != null) { - return unqualifiedVersion + snapshotFormat; + //we need to check that this property is actually defined! + if (isExtensionMode() && modelHasProperty(snapshotProperty, model, projectRoot)) { + return unqualifiedVersion + "${" + snapshotProperty + "}"; } return unqualifiedVersion + "-SNAPSHOT"; } return pomVersion; } + private boolean modelHasProperty(String property, Model model, Path projectRoot) { + if (property == null) { + //nothing we can check assume it is NOT present... + return false; + } + Properties properties = model.getProperties(); + String string = properties.getProperty(property); + if (string != null) { + return true; + } + try { + ParentModel parent = findParent(projectRoot.getParent(), Map.of()); + return modelHasProperty(property, parent.parentModel(), + projectRoot.resolve(parent.parentReference().getRelativePath())); + } catch (IOException e) { + return false; + } + } + public boolean isExtensionMode() { return extensionMode; } @@ -367,8 +390,8 @@ public void setMultiModuleProjectDirectory(File multiModuleProjectDirectory) { this.multiModuleProjectDirectory = multiModuleProjectDirectory; } - public void setSnapshotFormat(String snapshotFormat) { - this.snapshotFormat = snapshotFormat; + public void setSnapshotProperty(String snapshotFormat) { + this.snapshotProperty = snapshotFormat; } static Optional getLocation(Map options) { diff --git a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/ParentModel.java b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/ParentModel.java new file mode 100644 index 0000000000..cadc6d26a5 --- /dev/null +++ b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/ParentModel.java @@ -0,0 +1,20 @@ +/******************************************************************************* + * Copyright (c) 2024 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.pomless; + +import org.apache.maven.model.Model; +import org.apache.maven.model.Parent; + +public record ParentModel(Parent parentReference, Model parentModel) { + +} diff --git a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoBundleMapping.java b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoBundleMapping.java index efdd849e49..a0f921eb03 100644 --- a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoBundleMapping.java +++ b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoBundleMapping.java @@ -95,7 +95,7 @@ protected void initModel(Model model, Reader artifactReader, Path artifactFile) // groupId is inherited from parent pom model.setArtifactId(bundleSymbolicName); String bundleVersion = getRequiredHeaderValue("Bundle-Version", manifestHeaders, manifestFile); - model.setVersion(getPomVersion(bundleVersion)); + model.setVersion(getPomVersion(bundleVersion, model, artifactFile)); String prefix; if (isTestBundle(bundleSymbolicName, bundleRoot)) { model.setPackaging(PACKAGING_TEST); diff --git a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoFeatureMapping.java b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoFeatureMapping.java index 6423015f8a..e0f0862589 100644 --- a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoFeatureMapping.java +++ b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoFeatureMapping.java @@ -47,7 +47,7 @@ public float getPriority() { @Override protected void initModelFromXML(Model model, Element xml, Path artifactFile) throws IOException { model.setArtifactId(getRequiredXMLAttributeValue(xml, "id")); - model.setVersion(getPomVersion(getRequiredXMLAttributeValue(xml, "version"))); + model.setVersion(getPomVersion(getRequiredXMLAttributeValue(xml, "version"), model, artifactFile)); Path featureProperties = artifactFile.getParent().resolve("feature.properties"); Supplier properties = getPropertiesSupplier(featureProperties); diff --git a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoRepositoryMapping.java b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoRepositoryMapping.java index 5f000e3ab3..005654d01b 100644 --- a/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoRepositoryMapping.java +++ b/tycho-extras/tycho-pomless/src/main/java/org/eclipse/tycho/pomless/TychoRepositoryMapping.java @@ -99,7 +99,7 @@ protected void initModelFromXML(Model model, Element xml, Path artifactFile) thr model.setArtifactId(getRequiredXMLAttributeValue(xml, PRODUCT_UID_ATTRIBUTE)); String version = getXMLAttributeValue(xml, PRODUCT_VERSION_ATTRIBUTE); if (version != null) { - model.setVersion(getPomVersion(version)); + model.setVersion(getPomVersion(version, model, artifactFile)); } String name = getXMLAttributeValue(xml, PRODUCT_NAME_ATTRIBUTE); model.setName(PRODUCT_NAME_PREFIX + (name != null ? name : model.getArtifactId()));