org.codehaus.mojo.versions.DisplayPropertyUpdatesMojo Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of versions-maven-plugin Show documentation
Show all versions of versions-maven-plugin Show documentation
The Versions Maven Plugin is used when you want to manage the versions of artifacts in a project's POM.
The newest version!
package org.codehaus.mojo.versions;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.inject.Inject;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.TreeSet;
import org.apache.maven.artifact.handler.manager.ArtifactHandlerManager;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
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.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.wagon.Wagon;
import org.codehaus.mojo.versions.api.Property;
import org.codehaus.mojo.versions.api.PropertyVersions;
import org.codehaus.mojo.versions.api.Segment;
import org.codehaus.mojo.versions.api.VersionsHelper;
import org.codehaus.mojo.versions.api.recording.ChangeRecorder;
import org.codehaus.mojo.versions.ordering.InvalidSegmentException;
import org.codehaus.mojo.versions.rewriting.MutableXMLStreamReader;
import org.eclipse.aether.RepositorySystem;
import static java.util.Optional.empty;
import static java.util.Optional.of;
import static org.codehaus.mojo.versions.api.Segment.INCREMENTAL;
import static org.codehaus.mojo.versions.api.Segment.MAJOR;
import static org.codehaus.mojo.versions.api.Segment.MINOR;
/**
* Displays properties that are linked to artifact versions and have updates available.
*
* @author Stephen Connolly
* @since 1.0-beta-1
*/
@Mojo(name = "display-property-updates", threadSafe = true)
public class DisplayPropertyUpdatesMojo extends AbstractVersionsDisplayMojo {
/**
* The width to pad info messages.
*
* @since 1.0-alpha-1
*/
private static final int INFO_PAD_SIZE = 68;
// ------------------------------ FIELDS ------------------------------
/**
* Any restrictions that apply to specific properties.
*
* @since 1.0-alpha-3
*/
@Parameter
private Property[] properties;
/**
* A comma separated list of properties to update.
*
* @since 1.0-alpha-1
*/
@Parameter(property = "includeProperties")
private String includeProperties = null;
/**
* A comma separated list of properties to not update.
*
* @parameter property="excludeProperties"
* @since 1.0-alpha-1
*/
@Parameter(property = "excludeProperties")
private String excludeProperties = null;
/**
* Whether properties linking versions should be auto-detected or not.
*
* @since 1.0-alpha-2
*/
@Parameter(property = "autoLinkItems", defaultValue = "true")
private boolean autoLinkItems;
/**
* Whether to allow the major version number to be changed.
*
* @since 2.5
*/
@Parameter(property = "allowMajorUpdates", defaultValue = "true")
private boolean allowMajorUpdates;
/**
* Whether to allow the minor version number to be changed.
*
* Note: {@code false} also implies {@linkplain #allowMajorUpdates} {@code false}
*
* @since 2.5
*/
@Parameter(property = "allowMinorUpdates", defaultValue = "true")
private boolean allowMinorUpdates;
/**
* Whether to allow the incremental version number to be changed.
*
* Note: {@code false} also implies {@linkplain #allowMajorUpdates}
* and {@linkplain #allowMinorUpdates} {@code false}
*
* @since 2.5
*/
@Parameter(property = "allowIncrementalUpdates", defaultValue = "true")
private boolean allowIncrementalUpdates;
/**
* Whether to include property updates from parent. Default: {@code false}
*
* @since 2.14.0
*/
@Parameter(property = "includeParent", defaultValue = "false")
protected boolean includeParent;
// -------------------------- STATIC METHODS --------------------------
// -------------------------- OTHER METHODS --------------------------
@Inject
public DisplayPropertyUpdatesMojo(
ArtifactHandlerManager artifactHandlerManager,
RepositorySystem repositorySystem,
Map wagonMap,
Map changeRecorders) {
super(artifactHandlerManager, repositorySystem, wagonMap, changeRecorders);
}
public void execute() throws MojoExecutionException, MojoFailureException {
logInit();
List current = new ArrayList<>();
List updates = new ArrayList<>();
Map propertyVersions = this.getHelper()
.getVersionPropertiesMap(VersionsHelper.VersionPropertiesMapRequest.builder()
.withMavenProject(getProject())
.withPropertyDefinitions(properties)
.withIncludeProperties(includeProperties)
.withExcludeProperties(excludeProperties)
.withIncludeParent(includeParent)
.withAutoLinkItems(autoLinkItems)
.build());
for (Map.Entry entry : propertyVersions.entrySet()) {
Property property = entry.getKey();
PropertyVersions version = entry.getValue();
final String currentVersion = getProject().getProperties().getProperty(property.getName());
if (currentVersion == null) {
continue;
}
Log log = getLog();
if (log != null && !allowIncrementalUpdates) {
log.info("Assuming allowMinorUpdates false because allowIncrementalUpdates is false.");
}
if (log != null && !allowMinorUpdates) {
log.info("Assuming allowMajorUpdates false because allowMinorUpdates is false.");
}
Optional unchangedSegment1 = allowMajorUpdates && allowMinorUpdates && allowIncrementalUpdates
? empty()
: allowMinorUpdates && allowIncrementalUpdates
? of(MAJOR)
: allowIncrementalUpdates ? of(MINOR) : of(INCREMENTAL);
if (log != null && log.isDebugEnabled()) {
log.debug(unchangedSegment1
.map(Segment::minorTo)
.map(Segment::toString)
.orElse("ALL") + " version changes allowed");
}
Optional unchangedSegment = unchangedSegment1;
try {
ArtifactVersion winner = version.getNewestVersion(
currentVersion,
property,
this.allowSnapshots,
this.reactorProjects,
this.getHelper(),
false,
unchangedSegment);
if (winner != null && !currentVersion.equals(winner.toString())) {
StringBuilder buf = new StringBuilder();
buf.append("${");
buf.append(property.getName());
buf.append("} ");
final String newVersion = winner.toString();
int padding = INFO_PAD_SIZE
- currentVersion.length()
- newVersion.length()
- 4
+ getOutputLineWidthOffset();
while (buf.length() < padding) {
buf.append('.');
}
buf.append(' ');
buf.append(currentVersion);
buf.append(" -> ");
buf.append(newVersion);
updates.add(buf.toString());
} else {
StringBuilder buf = new StringBuilder();
buf.append("${");
buf.append(property.getName());
buf.append("} ");
int padding = INFO_PAD_SIZE - currentVersion.length() + getOutputLineWidthOffset();
while (buf.length() < padding) {
buf.append('.');
}
buf.append(' ');
buf.append(currentVersion);
current.add(buf.toString());
}
} catch (InvalidSegmentException | InvalidVersionSpecificationException e) {
getLog().warn(String.format(
"Skipping the processing of %s:%s due to: %s",
property.getName(), property.getVersion(), e.getMessage()));
}
}
logLine(false, "");
if (!current.isEmpty()) {
logLine(false, "The following version properties are referencing the newest available version:");
for (String s : new TreeSet<>(current)) {
logLine(false, " " + s);
}
}
if (updates.isEmpty() && current.isEmpty()) {
logLine(false, "This project does not have any properties associated with versions.");
} else if (updates.isEmpty()) {
logLine(false, "All version properties are referencing the newest version available.");
}
if (!updates.isEmpty()) {
logLine(false, "The following version property updates are available:");
for (String update : new TreeSet<>(updates)) {
logLine(false, " " + update);
}
}
logLine(false, "");
}
@Override
protected void update(MutableXMLStreamReader pom) {}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy