/
DisplayDependencyUpdatesMojo.java
508 lines (459 loc) · 18.5 KB
/
DisplayDependencyUpdatesMojo.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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
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 org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
import org.apache.maven.model.Build;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Plugin;
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.ArtifactVersions;
import org.codehaus.mojo.versions.api.UpdateScope;
import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
import org.codehaus.mojo.versions.utils.DependencyComparator;
import org.codehaus.plexus.util.StringUtils;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.TreeSet;
import javax.xml.stream.XMLStreamException;
/**
* Displays all dependencies that have newer versions available.
* It will also display dependencies which are used by a plugin or
* defined in the plugin within a pluginManagement.
*
* @author Stephen Connolly
* @since 1.0-alpha-1
*/
@Mojo( name = "display-dependency-updates", requiresProject = true, requiresDirectInvocation = false, threadSafe = true )
public class DisplayDependencyUpdatesMojo
extends AbstractVersionsDisplayMojo
{
// ------------------------------ FIELDS ------------------------------
/**
* The width to pad info messages.
*
* @since 1.0-alpha-1
*/
private static final int INFO_PAD_SIZE = 72;
/**
* Whether to process the dependencyManagement section of the project.
*
* @since 1.2
*/
@Parameter( property = "processDependencyManagement", defaultValue = "true" )
private boolean processDependencyManagement;
/**
* Whether to process the dependencies section of the project.
*
* @since 1.2
*/
@Parameter( property = "processDependencies", defaultValue = "true" )
private boolean processDependencies;
/**
* Whether to process the dependencies sections of plugins.
*
* @since 2.5
*/
@Parameter( property = "processPluginDependencies", defaultValue = "true" )
private boolean processPluginDependencies;
/**
* Whether to process the dependencies sections of plugins which are defined in pluginManagement.
*
* @since 2.5
*/
@Parameter( property = "processPluginDependenciesInPluginManagement", defaultValue = "true" )
private boolean processPluginDependenciesInPluginManagement;
/**
* Whether to allow the major version number to be changed.
* You need to set {@link #allowAnyUpdates} to <code>false</code> to
* get this configuration gets control.
* @since 2.5
*/
@Parameter(property = "allowMajorUpdates", defaultValue = "true")
private boolean allowMajorUpdates;
/**
* Whether to allow the minor version number to be changed.
* You need to set {@link #allowMajorUpdates} to <code>false</code> to
* get this configuration gets control.
*
* @since 2.5
*/
@Parameter(property = "allowMinorUpdates", defaultValue = "true")
private boolean allowMinorUpdates;
/**
* Whether to allow the incremental version number to be changed.
* You need to set {@link #allowMinorUpdates} to <code>false</code> to
* get this configuration gets control.
*
* @since 2.5
*/
@Parameter(property = "allowIncrementalUpdates", defaultValue = "true")
private boolean allowIncrementalUpdates;
/**
* Whether to allow any version change to be allowed. This keeps
* compatibility with previous versions of the plugin.
* If you set this to false you can control changes in version
* number by {@link #allowMajorUpdates}, {@link #allowMinorUpdates} or
* {@link #allowIncrementalUpdates}.
* @deprecated This will be removed with version 3.0.0
* @since 2.5
*/
@Parameter(property = "allowAnyUpdates", defaultValue = "true")
private boolean allowAnyUpdates;
/**
* Whether to show additional information such as dependencies that do not need updating. Defaults to false.
*
* @since 2.1
*/
@Parameter( property = "verbose", defaultValue = "false" )
private boolean verbose;
// --------------------- GETTER / SETTER METHODS ---------------------
private static Set<Dependency> extractPluginDependenciesFromPluginsInPluginManagement( Build build )
{
Set<Dependency> result = new TreeSet<>( new DependencyComparator() );
if ( build.getPluginManagement() != null )
{
for ( Plugin plugin : build.getPluginManagement().getPlugins() )
{
if ( plugin.getDependencies() != null && !plugin.getDependencies().isEmpty() )
{
result.addAll( plugin.getDependencies() );
}
}
}
return result;
}
private static Set<Dependency> extractDependenciesFromPlugins( List<Plugin> plugins )
{
Set<Dependency> result = new TreeSet<>( new DependencyComparator() );
for ( Plugin plugin : plugins )
{
if ( plugin.getDependencies() != null && !plugin.getDependencies().isEmpty() )
{
result.addAll( plugin.getDependencies() );
}
}
return result;
}
/**
* Returns a set of dependencies where the dependencies which are defined in the dependency management section have
* been filtered out.
*
* @param dependencies The set of dependencies.
* @param dependencyManagement The set of dependencies from the dependency management section.
* @return A new set of dependencies which are from the set of dependencies but not from the set of dependency
* management dependencies.
* @since 1.0-beta-1
*/
private static Set<Dependency> removeDependencyManagment( Set<Dependency> dependencies, Set<Dependency> dependencyManagement )
{
Set<Dependency> result = new TreeSet<>( new DependencyComparator() );
for ( Dependency dependency : dependencies )
{
boolean matched = false;
for ( Dependency managedDependency : dependencyManagement )
{
if ( dependenciesMatch( dependency, managedDependency ) )
{
matched = true;
break;
}
}
if ( !matched )
{
result.add( dependency );
}
}
return result;
}
// open for tests
protected static boolean dependenciesMatch( Dependency dependency, Dependency managedDependency )
{
if ( ! managedDependency.getGroupId().equals( dependency.getGroupId() ) )
{
return false;
}
if ( ! managedDependency.getArtifactId().equals( dependency.getArtifactId() ) )
{
return false;
}
if ( managedDependency.getScope() == null
|| Objects.equals( managedDependency.getScope(), dependency.getScope() ) )
{
return false;
}
if ( managedDependency.getClassifier() == null
|| Objects.equals( managedDependency.getClassifier(), dependency.getClassifier() ) )
{
return false;
}
return dependency.getVersion() == null
|| managedDependency.getVersion() == null
|| Objects.equals( managedDependency.getVersion(), dependency.getVersion() );
}
public boolean isProcessingDependencyManagement()
{
return processDependencyManagement;
}
public boolean isProcessingDependencies()
{
return processDependencies;
}
public boolean isProcessingPluginDependencies()
{
return processPluginDependencies;
}
public boolean isProcessPluginDependenciesInDependencyManagement()
{
return processPluginDependenciesInPluginManagement;
}
public boolean isVerbose()
{
return verbose;
}
// ------------------------ INTERFACE METHODS ------------------------
// --------------------- Interface Mojo ---------------------
/**
* @throws org.apache.maven.plugin.MojoExecutionException when things go wrong
* @throws org.apache.maven.plugin.MojoFailureException when things go wrong in a very bad way
* @see org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo#execute()
* @since 1.0-alpha-1
*/
public void execute()
throws MojoExecutionException, MojoFailureException
{
logInit();
Set<Dependency> dependencyManagement = new TreeSet<>( new DependencyComparator() );
if ( getProject().getDependencyManagement() != null )
{
List<Dependency> dependenciesFromPom = getProject().getDependencyManagement().getDependencies();
for ( Dependency dependency : dependenciesFromPom )
{
getLog().debug( "dependency from pom: " + dependency.getGroupId() + ":" + dependency.getArtifactId()
+ ":" + dependency.getVersion() );
if ( dependency.getVersion() == null )
{
// get parent and get the information from there.
if ( getProject().hasParent() )
{
getLog().debug( "Reading parent dependencyManagement information" );
if ( getProject().getParent().getDependencyManagement() != null )
{
List<Dependency> parentDeps =
getProject().getParent().getDependencyManagement().getDependencies();
for ( Dependency parentDep : parentDeps )
{
// only groupId && artifactId needed cause version is null
if ( dependency.getGroupId().equals( parentDep.getGroupId() )
&& dependency.getArtifactId().equals( parentDep.getArtifactId() )
&& dependency.getType().equals( parentDep.getType() ) )
{
dependencyManagement.add( parentDep );
}
}
}
}
else
{
String message = "We can't get the version for the dependency " + dependency.getGroupId() + ":"
+ dependency.getArtifactId() + " cause there does not exist a parent.";
getLog().error( message );
// Throw error cause we will not able to get a version for a dependency.
throw new MojoExecutionException( message );
}
}
else
{
dependencyManagement.add( dependency );
}
}
}
Set<Dependency> dependencies = new TreeSet<>( new DependencyComparator() );
dependencies.addAll( getProject().getDependencies() );
if ( isProcessingDependencyManagement() )
{
dependencies = removeDependencyManagment( dependencies, dependencyManagement );
}
Set<Dependency> pluginDependencies = new TreeSet<>( new DependencyComparator() );
if ( isProcessingPluginDependencies() )
{
pluginDependencies = extractDependenciesFromPlugins( getProject().getBuildPlugins() );
}
Set<Dependency> pluginDependenciesInPluginManagement = new TreeSet<>( new DependencyComparator() );
if ( isProcessPluginDependenciesInDependencyManagement() )
{
pluginDependenciesInPluginManagement =
extractPluginDependenciesFromPluginsInPluginManagement( getProject().getBuild() );
}
try
{
if ( isProcessingDependencyManagement() )
{
logUpdates( getHelper().lookupDependenciesUpdates( dependencyManagement, false ),
"Dependency Management" );
}
if ( isProcessingDependencies() )
{
logUpdates( getHelper().lookupDependenciesUpdates( dependencies, false ), "Dependencies" );
}
if ( isProcessPluginDependenciesInDependencyManagement() )
{
logUpdates( getHelper().lookupDependenciesUpdates( pluginDependenciesInPluginManagement, false ),
"pluginManagement of plugins" );
}
if ( isProcessingPluginDependencies() )
{
logUpdates( getHelper().lookupDependenciesUpdates( pluginDependencies, false ), "Plugin Dependencies" );
}
}
catch ( InvalidVersionSpecificationException | ArtifactMetadataRetrievalException e )
{
throw new MojoExecutionException( e.getMessage(), e );
}
}
private UpdateScope calculateUpdateScope()
{
UpdateScope result = UpdateScope.ANY;
if ( !allowAnyUpdates )
{
if ( allowMajorUpdates )
{
result = UpdateScope.MAJOR;
}
else
{
if ( allowMinorUpdates )
{
result = UpdateScope.MINOR;
}
else
{
if ( allowIncrementalUpdates )
{
result = UpdateScope.INCREMENTAL;
}
}
}
}
return result;
}
private void logUpdates( Map<Dependency, ArtifactVersions> updates, String section )
{
List<String> withUpdates = new ArrayList<>();
List<String> usingCurrent = new ArrayList<>();
Iterator i = updates.values().iterator();
while ( i.hasNext() )
{
ArtifactVersions versions = (ArtifactVersions) i.next();
String left = " " + ArtifactUtils.versionlessKey( versions.getArtifact() ) + " ";
final String current;
ArtifactVersion latest;
if ( versions.isCurrentVersionDefined() )
{
current = versions.getCurrentVersion().toString();
latest = versions.getNewestUpdate( calculateUpdateScope(), allowSnapshots );
}
else
{
ArtifactVersion newestVersion =
versions.getNewestVersion( versions.getArtifact().getVersionRange(), allowSnapshots );
current = versions.getArtifact().getVersionRange().toString();
latest = newestVersion == null ? null
: versions.getNewestUpdate( newestVersion, calculateUpdateScope(), allowSnapshots );
if ( latest != null
&& ArtifactVersions.isVersionInRange( latest, versions.getArtifact().getVersionRange() ) )
{
latest = null;
}
}
String right = " " + ( latest == null ? current : current + " -> " + latest.toString() );
List<String> t = latest == null ? usingCurrent : withUpdates;
if ( right.length() + left.length() + 3 > INFO_PAD_SIZE )
{
t.add( left + "..." );
t.add( StringUtils.leftPad( right, INFO_PAD_SIZE ) );
}
else
{
t.add( StringUtils.rightPad( left, INFO_PAD_SIZE - right.length(), "." ) + right );
}
}
if ( isVerbose() )
{
if ( usingCurrent.isEmpty() )
{
if ( !withUpdates.isEmpty() )
{
logLine( false, "No dependencies in " + section + " are using the newest version." );
logLine( false, "" );
}
}
else
{
logLine( false, "The following dependencies in " + section + " are using the newest version:" );
i = usingCurrent.iterator();
while ( i.hasNext() )
{
logLine( false, (String) i.next() );
}
logLine( false, "" );
}
}
if ( withUpdates.isEmpty() )
{
if ( !usingCurrent.isEmpty() )
{
logLine( false, "No dependencies in " + section + " have newer versions." );
logLine( false, "" );
}
}
else
{
logLine( false, "The following dependencies in " + section + " have newer versions:" );
i = withUpdates.iterator();
while ( i.hasNext() )
{
logLine( false, (String) i.next() );
}
logLine( false, "" );
}
}
/**
* @param pom the pom to update.
* @throws org.apache.maven.plugin.MojoExecutionException when things go wrong
* @throws org.apache.maven.plugin.MojoFailureException when things go wrong in a very bad way
* @throws javax.xml.stream.XMLStreamException when things go wrong with XML streaming
* @see org.codehaus.mojo.versions.AbstractVersionsUpdaterMojo#update(org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader)
* @since 1.0-alpha-1
*/
protected void update( ModifiedPomXMLEventReader pom )
throws MojoExecutionException, MojoFailureException, XMLStreamException
{
// do nothing
}
}