/
PropertyUpdatesReportMojo.java
150 lines (134 loc) · 4.9 KB
/
PropertyUpdatesReportMojo.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
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.Locale;
import java.util.Map;
import java.util.TreeMap;
import org.apache.maven.artifact.manager.WagonManager;
import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
import org.apache.maven.artifact.resolver.ArtifactResolver;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.reporting.MavenReportException;
import org.apache.maven.repository.RepositorySystem;
import org.codehaus.mojo.versions.api.PropertyVersions;
import org.codehaus.mojo.versions.reporting.ReportRendererFactory;
import org.codehaus.mojo.versions.reporting.model.PropertyUpdatesModel;
import org.codehaus.mojo.versions.utils.PropertyComparator;
import org.codehaus.plexus.i18n.I18N;
/**
* Generates a report of available updates for properties of a project which are linked to the dependencies and/or
* plugins of a project.
*
* @author Stephen Connolly
* @since 1.0-beta-1
*/
@Mojo( name = "property-updates-report", requiresDependencyResolution = ResolutionScope.RUNTIME,
threadSafe = true )
public class PropertyUpdatesReportMojo extends AbstractVersionsReport<PropertyUpdatesModel>
{
/**
* Any restrictions that apply to specific properties.
*
* @since 1.0-beta-1
*/
@Parameter
private Property[] properties;
/**
* A comma separated list of properties to include in the report.
*
* @since 1.0-beta-1
*/
@Parameter( property = "includeProperties" )
private String includeProperties = null;
/**
* A comma separated list of properties to not include in the report.
*
* @since 1.0-beta-1
*/
@Parameter( property = "excludeProperties" )
private String excludeProperties = null;
/**
* Whether properties linking versions should be auto-detected or not.
*
* @since 1.0-beta-1
*/
@Parameter( property = "autoLinkItems", defaultValue = "true" )
private boolean autoLinkItems;
/**
* <p>Whether to include property updates from parent.</p>
*
* @since 2.14.0
*/
@Parameter( property = "includeParent", defaultValue = "true" )
private boolean includeParent = true;
@Inject
protected PropertyUpdatesReportMojo( I18N i18n, RepositorySystem repositorySystem,
ArtifactResolver artifactResolver,
ArtifactMetadataSource artifactMetadataSource, WagonManager wagonManager,
ReportRendererFactory rendererFactory )
{
super( i18n, repositorySystem, artifactResolver, artifactMetadataSource, wagonManager, rendererFactory );
}
/**
* {@inheritDoc}
*/
public boolean isExternalReport()
{
return false;
}
/**
* {@inheritDoc}
*/
public boolean canGenerateReport()
{
return haveBuildProperties();
}
private boolean haveBuildProperties()
{
return getProject().getProperties() != null && !getProject().getProperties().isEmpty();
}
protected void doGenerateReport( Locale locale, Sink sink )
throws MavenReportException
{
final Map<Property, PropertyVersions> updateSet = new TreeMap<>( PropertyComparator.INSTANCE );
try
{
updateSet.putAll( getHelper().getVersionPropertiesMap( getProject(), properties, includeProperties,
excludeProperties, includeParent, autoLinkItems ) );
}
catch ( MojoExecutionException e )
{
throw new MavenReportException( e.getMessage(), e );
}
rendererFactory.createReportRenderer( getOutputName(), getSink(), locale,
new PropertyUpdatesModel( updateSet ) ).render();
}
/**
* {@inheritDoc}
*/
public String getOutputName()
{
return "property-updates-report";
}
}