-
Notifications
You must be signed in to change notification settings - Fork 265
/
SetPropertyMojo.java
187 lines (169 loc) · 7.45 KB
/
SetPropertyMojo.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
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 javax.xml.stream.XMLStreamException;
import java.io.IOException;
import java.util.Arrays;
import java.util.Map;
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.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProjectBuilder;
import org.apache.maven.repository.RepositorySystem;
import org.codehaus.mojo.versions.api.PomHelper;
import org.codehaus.mojo.versions.api.PropertyVersions;
import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
import org.codehaus.mojo.versions.utils.PropertiesVersionsFileReader;
import static org.apache.commons.lang3.StringUtils.defaultString;
import static org.apache.commons.lang3.StringUtils.isEmpty;
import static org.apache.commons.lang3.StringUtils.split;
/**
* Set a property to a given version without any sanity checks. Please be careful this can lead to changes which might
* not build anymore. The sanity checks are done by other goals like <code>update-properties</code> or
* <code>update-property</code> etc. they are not done here. So use this goal with care.
*
* @author Karl Heinz Marbaise
* @since 2.5
*/
@Mojo( name = "set-property", threadSafe = true )
public class SetPropertyMojo
extends AbstractVersionsUpdaterMojo
{
// ------------------------------ FIELDS ------------------------------
/**
* A property to update.
* You can also specify multiple property names separated by "," which are all set to the same new version.
*/
@Parameter( property = "property" )
private String property = null;
/**
* The new version to set the property.
*/
@Parameter( property = "newVersion" )
private String newVersion = null;
/**
* Whether properties linking versions should be auto-detected or not.
*/
@Parameter( property = "autoLinkItems", defaultValue = "true" )
private boolean autoLinkItems;
/**
* A property file name containing: property=value, to update several properties at the same time.
* If 'property' and 'newVersion' are also used, they will be ignored.
*
* @since 2.9
*/
@Parameter( property = "propertiesVersionsFile" )
private String propertiesVersionsFile;
@Inject
public SetPropertyMojo( RepositorySystem repositorySystem,
MavenProjectBuilder projectBuilder,
ArtifactMetadataSource artifactMetadataSource,
WagonManager wagonManager,
ArtifactResolver artifactResolver )
{
super( repositorySystem, projectBuilder, artifactMetadataSource, wagonManager, artifactResolver );
}
/**
* @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
{
Property[] propertiesConfig;
String properties;
if ( !isEmpty( propertiesVersionsFile ) )
{
logWrongConfigWarning();
getLog().debug( "Reading properties and versions to update from file: " + propertiesVersionsFile );
PropertiesVersionsFileReader reader = new PropertiesVersionsFileReader( propertiesVersionsFile );
try
{
reader.read();
}
catch ( IOException e )
{
getLog().error( "Unable to read property file " + propertiesVersionsFile
+ ". re-run with -X option for more details." );
getLog().debug( "Error while reading property file " + propertiesVersionsFile, e );
throw new MojoFailureException( "Unable to read property file " + propertiesVersionsFile );
}
propertiesConfig = reader.getPropertiesConfig();
properties = reader.getProperties();
}
else if ( !isEmpty( property ) )
{
getLog().debug( "Reading properties and versions to update from property and newVersion " );
propertiesConfig = Arrays.stream( split( property, "," ) ).map(
prp ->
{
Property propertyConfig = new Property( prp );
propertyConfig.setVersion( newVersion );
return propertyConfig;
} )
.toArray( Property[]::new );
properties = property;
}
else
{
throw new MojoExecutionException(
"Please provide either 'property' or 'propertiesVersionsFile' parameter." );
}
update( pom, propertiesConfig, properties );
}
private void update( ModifiedPomXMLEventReader pom, Property[] propertiesConfig, String properties )
throws MojoExecutionException, XMLStreamException
{
Map<Property, PropertyVersions> propertyVersions =
this.getHelper().getVersionPropertiesMap( getProject(), propertiesConfig, properties, "",
true, autoLinkItems );
for ( Map.Entry<Property, PropertyVersions> entry : propertyVersions.entrySet() )
{
Property currentProperty = entry.getKey();
PropertyVersions version = entry.getValue();
String newVersionGiven = currentProperty.getVersion();
final String currentVersion = getProject().getProperties().getProperty( currentProperty.getName() );
if ( currentVersion == null )
{
continue;
}
PomHelper.setPropertyVersion( pom, version.getProfileId(), currentProperty.getName(),
defaultString( newVersionGiven ) );
}
}
private void logWrongConfigWarning()
{
if ( !isEmpty( property ) )
{
getLog().warn( "-Dproperty provided but will be ignored as -DpropertiesVersionsFile is used" );
}
if ( !isEmpty( newVersion ) )
{
getLog().warn( "-DnewVersion provided but will be ignored as -DpropertiesVersionsFile is used" );
}
}
}