/
ResolveRangesMojo.java
300 lines (259 loc) · 11.4 KB
/
ResolveRangesMojo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
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 java.util.Collection;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.xml.stream.XMLStreamException;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.codehaus.mojo.versions.api.PomHelper;
import org.codehaus.mojo.versions.api.PropertyVersions;
import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
/**
* Attempts to resolve dependency version ranges to the specific version being used in the build. For example a version
* range of "[1.0, 1.2)" would be resolved to the specific version currently in use "1.1".
*
* @author Paul Gier
* @since 1.0-alpha-3
*/
@Mojo( name = "resolve-ranges", requiresProject = true, requiresDirectInvocation = true, threadSafe = true )
public class ResolveRangesMojo
extends AbstractVersionsDependencyUpdaterMojo
{
/**
* Whether to process the properties section of the project.
*
* @since 1.3
*/
@Parameter( property = "processProperties", defaultValue = "true" )
private boolean processProperties;
/**
* A comma separated list of properties to update if they contain version-ranges.
*
* @parameter property="includeProperties"
* @since 1.3
*/
@Parameter( property = "includeProperties" )
private String includeProperties = null;
/**
* A comma separated list of properties to not update even if they contain version-ranges.
*
* @since 1.3
*/
@Parameter( property = "excludeProperties" )
private String excludeProperties = null;
/**
* 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.
*
* @since 2.5
*/
@Parameter( property = "allowMinorUpdates", defaultValue = "true" )
private boolean allowMinorUpdates;
/**
* Whether to allow the incremental version number to be changed.
*
* @since 2.5
*/
@Parameter( property = "allowIncrementalUpdates", defaultValue = "true" )
private boolean allowIncrementalUpdates;
// ------------------------------ FIELDS ------------------------------
/**
* Pattern to match a version range. For example 1.0-20090128.202731-1
*/
public final Pattern matchRangeRegex = Pattern.compile( "," );
// ------------------------------ METHODS --------------------------
/**
* @param pom the pom to update.
* @throws MojoExecutionException when things go wrong
* @throws MojoFailureException when things go wrong in a very bad way
* @throws XMLStreamException when things go wrong with XML streaming
* @see AbstractVersionsUpdaterMojo#update(ModifiedPomXMLEventReader)
*/
protected void update( ModifiedPomXMLEventReader pom )
throws MojoExecutionException, MojoFailureException, XMLStreamException, ArtifactMetadataRetrievalException
{
// Note we have to get the dependencies from the model because the dependencies in the
// project may have already had their range resolved [MNG-4138]
if ( hasDependencyManagement() && hasDependenciesInDependencyManagement()
&& isProcessingDependencyManagement() )
{
getLog().debug( "processing dependencyManagement of " + getProject().getId() );
resolveRanges( pom, getProject().getModel().getDependencyManagement().getDependencies() );
}
if ( getProject().getDependencies() != null && isProcessingDependencies() )
{
getLog().debug( "processing dependencies of " + getProject().getId() );
resolveRanges( pom, getProject().getModel().getDependencies() );
}
if ( hasParent() && isProcessingParent() )
{
getLog().debug( "processing parent " + getProject().getId() );
resolveRangesInParent( pom );
}
if ( processProperties )
{
getLog().debug( "processing properties of " + getProject().getId() );
resolvePropertyRanges( pom );
}
}
private boolean hasParent()
{
return getProject().getModel().getParent() != null;
}
private boolean hasDependenciesInDependencyManagement()
{
return getProject().getModel().getDependencyManagement().getDependencies() != null;
}
private boolean hasDependencyManagement()
{
return getProject().getModel().getDependencyManagement() != null;
}
private void resolveRangesInParent( ModifiedPomXMLEventReader pom )
throws MojoExecutionException, ArtifactMetadataRetrievalException, XMLStreamException
{
Matcher versionMatcher = matchRangeRegex.matcher( getProject().getModel().getParent().getVersion() );
if ( versionMatcher.find() )
{
Artifact artifact = this.toArtifact( getProject().getModel().getParent() );
if ( artifact != null && isIncluded( artifact ) )
{
getLog().debug( "Resolving version range for parent: " + artifact );
String artifactVersion = artifact.getVersion();
if ( artifactVersion == null )
{
ArtifactVersion latestVersion =
findLatestVersion( artifact, artifact.getVersionRange(), allowSnapshots, false );
if ( latestVersion != null )
{
artifactVersion = latestVersion.toString();
}
else
{
getLog().warn( "Not updating version " + artifact + " : could not resolve any versions" );
}
}
if ( artifactVersion != null )
{
if ( PomHelper.setProjectParentVersion( pom, artifactVersion ) )
{
getLog().debug( "Version set to " + artifactVersion + " for parent: " + artifact );
}
else
{
getLog().warn( "Could not find the version tag for parent " + artifact + " in project "
+ getProject().getId() + " so unable to set version to " + artifactVersion );
}
}
}
}
}
private void resolveRanges( ModifiedPomXMLEventReader pom, Collection<Dependency> dependencies )
throws XMLStreamException, MojoExecutionException, ArtifactMetadataRetrievalException
{
for ( Dependency dep : dependencies )
{
if ( isExcludeReactor() && isProducedByReactor( dep ) )
{
continue;
}
if ( StringUtils.isBlank( dep.getVersion() ) )
{
throw new MojoExecutionException( "Found invalid managed dependency " + toString( dep ) + " without a version");
}
if ( isHandledByProperty( dep ) )
{
getLog().debug( "Ignoring dependency with property as version: " + toString( dep ) );
continue;
}
Matcher versionMatcher = matchRangeRegex.matcher( dep.getVersion() );
if ( versionMatcher.find() )
{
Artifact artifact = this.toArtifact( dep );
if ( artifact != null && isIncluded( artifact ) )
{
getLog().debug( "Resolving version range for dependency: " + artifact );
String artifactVersion = artifact.getVersion();
if ( artifactVersion == null )
{
ArtifactVersion latestVersion =
findLatestVersion( artifact, artifact.getVersionRange(), allowSnapshots, false );
if ( latestVersion != null )
{
artifactVersion = latestVersion.toString();
}
else
{
getLog().warn( "Not updating version " + artifact + " : could not resolve any versions" );
}
}
if ( artifactVersion != null )
{
if ( PomHelper.setDependencyVersion( pom, artifact.getGroupId(), artifact.getArtifactId(),
dep.getVersion(), artifactVersion,
getProject().getModel() ) )
{
getLog().debug( "Version set to " + artifactVersion + " for dependency: " + artifact );
}
else
{
getLog().debug( "Could not find the version tag for dependency " + artifact + " in project "
+ getProject().getId() + " so unable to set version to " + artifactVersion );
}
}
}
}
}
}
private void resolvePropertyRanges( ModifiedPomXMLEventReader pom )
throws XMLStreamException, MojoExecutionException
{
Map<Property, PropertyVersions> propertyVersions =
this.getHelper().getVersionPropertiesMap( getProject(), null, includeProperties, excludeProperties, true );
for ( Map.Entry<Property, PropertyVersions> entry : propertyVersions.entrySet() )
{
Property property = entry.getKey();
PropertyVersions version = entry.getValue();
final String currentVersion = getProject().getProperties().getProperty( property.getName() );
if ( currentVersion == null || !matchRangeRegex.matcher( currentVersion ).find() )
{
continue;
}
property.setVersion( currentVersion );
int segment = determineUnchangedSegment( allowMajorUpdates, allowMinorUpdates, allowIncrementalUpdates );
// TODO: Check if we could add allowDowngrade ?
updatePropertyToNewestVersion( pom, property, version, currentVersion, false, segment );
}
}
}