/
LockSnapshotsMojo.java
211 lines (185 loc) · 7.9 KB
/
LockSnapshotsMojo.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
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.regex.Matcher;
import java.util.regex.Pattern;
import javax.xml.stream.XMLStreamException;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.versioning.VersionRange;
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.project.MavenProject;
import org.codehaus.mojo.versions.api.PomHelper;
import org.codehaus.mojo.versions.rewriting.ModifiedPomXMLEventReader;
/**
* Attempts to resolve unlocked snapshot dependency versions to the locked timestamp versions used in the build. For
* example, an unlocked snapshot version like "1.0-SNAPSHOT" could be resolved to "1.0-20090128.202731-1". If a
* timestamped snapshot is not available, then the version will remained unchanged. This would be the case if the
* dependency is only available in the local repository and not in a remote snapshot repository.
*
* @author Paul Gier
* @since 1.0-alpha-3
*/
@Mojo( name = "lock-snapshots", requiresProject = true, requiresDirectInvocation = true, threadSafe = true )
public class LockSnapshotsMojo
extends AbstractVersionsDependencyUpdaterMojo
{
// ------------------------------ FIELDS ------------------------------
/**
* Pattern to match a timestamped snapshot version. For example 1.0-20090128.202731-1
*/
public final Pattern matchSnapshotRegex = Pattern.compile( "-" + Artifact.SNAPSHOT_VERSION );
// ------------------------------ 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
{
if ( getProject().getDependencyManagement() != null && isProcessingDependencyManagement() )
{
lockSnapshots( pom, getProject().getDependencyManagement().getDependencies() );
}
if ( getProject().getDependencies() != null && isProcessingDependencies() )
{
lockSnapshots( pom, getProject().getDependencies() );
}
if ( getProject().getParent() != null && isProcessingParent() )
{
lockParentSnapshot( pom, getProject().getParent() );
}
}
private void lockSnapshots( ModifiedPomXMLEventReader pom, Collection<Dependency> dependencies )
throws XMLStreamException, MojoExecutionException
{
for ( Dependency dep : dependencies )
{
if ( isExcludeReactor() && isProducedByReactor( dep ) )
{
getLog().info( "Ignoring reactor dependency: " + toString( dep ) );
continue;
}
if ( isHandledByProperty( dep ) )
{
getLog().debug( "Ignoring dependency with property as version: " + toString( dep ) );
continue;
}
if ( !isIncluded( this.toArtifact( dep ) ) )
{
continue;
}
String version = dep.getVersion();
Matcher versionMatcher = matchSnapshotRegex.matcher( version );
if ( versionMatcher.find() && versionMatcher.end() == version.length() )
{
String lockedVersion = resolveSnapshotVersion( dep );
if ( !version.equals( lockedVersion ) )
{
if ( PomHelper.setDependencyVersion( pom, dep.getGroupId(), dep.getArtifactId(), version,
lockedVersion, getProject().getModel() ) )
{
getLog().info( "Locked " + toString( dep ) + " to version " + lockedVersion );
}
}
}
}
}
private void lockParentSnapshot( ModifiedPomXMLEventReader pom, MavenProject parent )
throws XMLStreamException, MojoExecutionException
{
if ( parent == null )
{
getLog().info( "Project does not have a parent" );
return;
}
if ( reactorProjects.contains( parent ) )
{
getLog().info( "Project's parent is part of the reactor" );
return;
}
Artifact parentArtifact = parent.getArtifact();
String parentVersion = parentArtifact.getVersion();
Matcher versionMatcher = matchSnapshotRegex.matcher( parentVersion );
if ( versionMatcher.find() && versionMatcher.end() == parentVersion.length() )
{
String lockedParentVersion = resolveSnapshotVersion( parentArtifact );
if ( !parentVersion.equals( lockedParentVersion ) )
{
if ( PomHelper.setProjectParentVersion( pom, lockedParentVersion ) )
{
getLog().info( "Locked parent " + parentArtifact + " to version "
+ lockedParentVersion );
}
}
}
}
/**
* Determine the timestamp version of the snapshot artifact used in the build.
*
* @param artifact
* @return The timestamp version if exists, otherwise the original snapshot artifact version is returned.
*/
private String resolveSnapshotVersion( Artifact artifact )
{
getLog().debug( "Resolving snapshot version for artifact: " + artifact );
String lockedVersion = artifact.getVersion();
try
{
resolver.resolve( artifact, getProject().getRemoteArtifactRepositories(), localRepository );
lockedVersion = artifact.getVersion();
}
catch ( Exception e )
{
getLog().error( e );
}
return lockedVersion;
}
/**
* Determine the timestamp version of the snapshot dependency used in the build.
*
* @param dep
* @return The timestamp version if exists, otherwise the original snapshot dependency version is returned.
*/
private String resolveSnapshotVersion( Dependency dep )
{
getLog().debug( "Resolving snapshot version for dependency: " + dep );
String lockedVersion = dep.getVersion();
try
{
Artifact depArtifact =
artifactFactory.createDependencyArtifact( dep.getGroupId(), dep.getArtifactId(),
VersionRange.createFromVersionSpec( dep.getVersion() ),
dep.getType(), dep.getClassifier(), dep.getScope() );
resolver.resolve( depArtifact, getProject().getRemoteArtifactRepositories(), localRepository );
lockedVersion = depArtifact.getVersion();
}
catch ( Exception e )
{
getLog().error( e );
}
return lockedVersion;
}
}