1 | |
package org.apache.maven.shared.release.phase; |
2 | |
|
3 | |
|
4 | |
|
5 | |
|
6 | |
|
7 | |
|
8 | |
|
9 | |
|
10 | |
|
11 | |
|
12 | |
|
13 | |
|
14 | |
|
15 | |
|
16 | |
|
17 | |
|
18 | |
|
19 | |
|
20 | |
|
21 | |
|
22 | |
import java.io.File; |
23 | |
import java.io.IOException; |
24 | |
import java.util.List; |
25 | |
|
26 | |
import org.apache.maven.project.MavenProject; |
27 | |
import org.apache.maven.scm.ScmException; |
28 | |
import org.apache.maven.scm.ScmFileSet; |
29 | |
import org.apache.maven.scm.ScmTag; |
30 | |
import org.apache.maven.scm.command.checkout.CheckOutScmResult; |
31 | |
import org.apache.maven.scm.manager.NoSuchScmProviderException; |
32 | |
import org.apache.maven.scm.provider.ScmProvider; |
33 | |
import org.apache.maven.scm.repository.ScmRepository; |
34 | |
import org.apache.maven.scm.repository.ScmRepositoryException; |
35 | |
import org.apache.maven.shared.release.ReleaseExecutionException; |
36 | |
import org.apache.maven.shared.release.ReleaseFailureException; |
37 | |
import org.apache.maven.shared.release.ReleaseResult; |
38 | |
import org.apache.maven.shared.release.config.ReleaseDescriptor; |
39 | |
import org.apache.maven.shared.release.env.ReleaseEnvironment; |
40 | |
import org.apache.maven.shared.release.scm.ReleaseScmCommandException; |
41 | |
import org.apache.maven.shared.release.scm.ReleaseScmRepositoryException; |
42 | |
import org.apache.maven.shared.release.scm.ScmRepositoryConfigurator; |
43 | |
import org.apache.maven.shared.release.util.ReleaseUtil; |
44 | |
import org.codehaus.plexus.util.FileUtils; |
45 | |
import org.codehaus.plexus.util.StringUtils; |
46 | |
|
47 | |
|
48 | |
|
49 | |
|
50 | |
|
51 | |
|
52 | 64 | public class CheckoutProjectFromScm |
53 | |
extends AbstractReleasePhase |
54 | |
{ |
55 | |
|
56 | |
|
57 | |
|
58 | |
|
59 | |
|
60 | |
private ScmRepositoryConfigurator scmRepositoryConfigurator; |
61 | |
|
62 | |
|
63 | |
public ReleaseResult execute( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, |
64 | |
List<MavenProject> reactorProjects ) |
65 | |
throws ReleaseExecutionException, ReleaseFailureException |
66 | |
{ |
67 | 26 | ReleaseResult releaseResult = null; |
68 | |
|
69 | 26 | if ( releaseDescriptor.isLocalCheckout() ) |
70 | |
{ |
71 | |
|
72 | |
|
73 | |
|
74 | |
|
75 | |
|
76 | 0 | String providerPart = releaseDescriptor.getScmSourceUrl() |
77 | |
.substring( 0, releaseDescriptor.getScmSourceUrl().indexOf( ':', 4 ) ); |
78 | |
|
79 | 0 | String scmPath = releaseDescriptor.getWorkingDirectory(); |
80 | |
|
81 | |
|
82 | |
|
83 | |
|
84 | |
do |
85 | |
{ |
86 | |
try |
87 | |
{ |
88 | 0 | if ( scmPath.startsWith( "/" ) ) |
89 | |
{ |
90 | |
|
91 | 0 | scmPath = scmPath.substring( 1 ); |
92 | |
} |
93 | |
|
94 | 0 | String scmUrl = providerPart + ":file:///" + scmPath; |
95 | 0 | releaseDescriptor.setScmSourceUrl( scmUrl ); |
96 | 0 | getLogger().info( "Performing a LOCAL checkout from " + releaseDescriptor.getScmSourceUrl() ); |
97 | |
|
98 | 0 | releaseResult = performCheckout( releaseDescriptor, releaseEnvironment, reactorProjects ); |
99 | |
} |
100 | 0 | catch ( ScmException scmEx ) |
101 | |
{ |
102 | |
|
103 | 0 | releaseResult = null; |
104 | 0 | } |
105 | |
|
106 | 0 | if ( releaseResult == null || releaseResult.getResultCode() == ReleaseResult.ERROR ) |
107 | |
{ |
108 | |
|
109 | |
|
110 | 0 | releaseResult = null; |
111 | |
|
112 | |
|
113 | 0 | int lastSlashPos = scmPath.lastIndexOf( File.separator ); |
114 | 0 | if ( lastSlashPos > 0 ) |
115 | |
{ |
116 | 0 | scmPath = scmPath.substring( 0, lastSlashPos ); |
117 | |
} |
118 | |
else |
119 | |
{ |
120 | 0 | throw new ReleaseExecutionException( "could not perform a local checkout" ); |
121 | |
} |
122 | |
} |
123 | |
} |
124 | 0 | while ( releaseResult == null ); |
125 | 0 | } |
126 | |
else |
127 | |
{ |
128 | |
|
129 | |
try |
130 | |
{ |
131 | 26 | releaseResult = performCheckout( releaseDescriptor, releaseEnvironment, reactorProjects ); |
132 | |
} |
133 | 2 | catch ( ScmException e ) |
134 | |
{ |
135 | 2 | releaseResult = new ReleaseResult(); |
136 | 2 | releaseResult.setResultCode( ReleaseResult.ERROR ); |
137 | 2 | logError( releaseResult, e.getMessage() ); |
138 | |
|
139 | 2 | throw new ReleaseExecutionException( "An error is occurred in the checkout process: " |
140 | |
+ e.getMessage(), e ); |
141 | 18 | } |
142 | |
|
143 | |
} |
144 | |
|
145 | 18 | return releaseResult; |
146 | |
} |
147 | |
|
148 | |
|
149 | |
private ReleaseResult performCheckout( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, |
150 | |
List<MavenProject> reactorProjects ) |
151 | |
throws ReleaseExecutionException, ReleaseFailureException, ScmException |
152 | |
{ |
153 | 26 | ReleaseResult result = new ReleaseResult(); |
154 | |
|
155 | 26 | logInfo( result, "Checking out the project to perform the release ..." ); |
156 | |
|
157 | |
ScmRepository repository; |
158 | |
ScmProvider provider; |
159 | |
|
160 | |
try |
161 | |
{ |
162 | 26 | repository = scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, |
163 | |
releaseEnvironment.getSettings() ); |
164 | |
|
165 | 22 | provider = scmRepositoryConfigurator.getRepositoryProvider( repository ); |
166 | |
} |
167 | 2 | catch ( ScmRepositoryException e ) |
168 | |
{ |
169 | 2 | result.setResultCode( ReleaseResult.ERROR ); |
170 | 2 | logError( result, e.getMessage() ); |
171 | |
|
172 | 2 | throw new ReleaseScmRepositoryException( e.getMessage(), e.getValidationMessages() ); |
173 | |
} |
174 | 2 | catch ( NoSuchScmProviderException e ) |
175 | |
{ |
176 | 2 | result.setResultCode( ReleaseResult.ERROR ); |
177 | 2 | logError( result, e.getMessage() ); |
178 | |
|
179 | 2 | throw new ReleaseExecutionException( "Unable to configure SCM repository: " + e.getMessage(), e ); |
180 | 22 | } |
181 | |
|
182 | 22 | MavenProject rootProject = ReleaseUtil.getRootProject( reactorProjects ); |
183 | |
|
184 | |
File checkoutDirectory; |
185 | 22 | if ( StringUtils.isEmpty( releaseDescriptor.getCheckoutDirectory() ) ) |
186 | |
{ |
187 | 0 | checkoutDirectory = new File( rootProject.getFile().getParentFile(), "target/checkout" ); |
188 | 0 | releaseDescriptor.setCheckoutDirectory( checkoutDirectory.getAbsolutePath() ); |
189 | |
} |
190 | |
else |
191 | |
{ |
192 | 22 | checkoutDirectory = new File( releaseDescriptor.getCheckoutDirectory() ); |
193 | |
} |
194 | |
|
195 | 22 | if ( checkoutDirectory.exists() ) |
196 | |
{ |
197 | |
try |
198 | |
{ |
199 | 22 | FileUtils.deleteDirectory( checkoutDirectory ); |
200 | |
} |
201 | 0 | catch ( IOException e ) |
202 | |
{ |
203 | 0 | result.setResultCode( ReleaseResult.ERROR ); |
204 | 0 | logError( result, e.getMessage() ); |
205 | |
|
206 | 0 | throw new ReleaseExecutionException( "Unable to remove old checkout directory: " + e.getMessage(), e ); |
207 | 22 | } |
208 | |
} |
209 | |
|
210 | 22 | checkoutDirectory.mkdirs(); |
211 | |
|
212 | |
CheckOutScmResult scmResult; |
213 | |
|
214 | 22 | scmResult = provider.checkOut( repository, new ScmFileSet( checkoutDirectory ), |
215 | |
new ScmTag( releaseDescriptor.getScmReleaseLabel() ) ); |
216 | |
|
217 | 20 | if ( releaseDescriptor.isLocalCheckout() && !scmResult.isSuccess() ) |
218 | |
{ |
219 | |
|
220 | |
|
221 | 0 | return null; |
222 | |
} |
223 | |
|
224 | 20 | String scmRelativePathProjectDirectory = scmResult.getRelativePathProjectDirectory(); |
225 | 20 | if ( StringUtils.isEmpty( scmRelativePathProjectDirectory ) ) |
226 | |
{ |
227 | |
String basedir; |
228 | |
try |
229 | |
{ |
230 | 20 | basedir = ReleaseUtil.getCommonBasedir( reactorProjects ); |
231 | |
} |
232 | 0 | catch ( IOException e ) |
233 | |
{ |
234 | 0 | throw new ReleaseExecutionException( "Exception occurred while calculating common basedir: " |
235 | |
+ e.getMessage(), e ); |
236 | 20 | } |
237 | |
|
238 | 20 | String rootProjectBasedir = rootProject.getBasedir().getAbsolutePath(); |
239 | |
try |
240 | |
{ |
241 | 20 | if ( ReleaseUtil.isSymlink( rootProject.getBasedir() ) ) |
242 | |
{ |
243 | 0 | rootProjectBasedir = rootProject.getBasedir().getCanonicalPath(); |
244 | |
} |
245 | |
} |
246 | 0 | catch ( IOException e ) |
247 | |
{ |
248 | 0 | throw new ReleaseExecutionException( e.getMessage(), e ); |
249 | 20 | } |
250 | 20 | if ( rootProjectBasedir.length() > basedir.length() ) |
251 | |
{ |
252 | 2 | scmRelativePathProjectDirectory = rootProjectBasedir.substring( basedir.length() + 1 ); |
253 | |
} |
254 | |
} |
255 | 20 | releaseDescriptor.setScmRelativePathProjectDirectory( scmRelativePathProjectDirectory ); |
256 | |
|
257 | 20 | if ( !scmResult.isSuccess() ) |
258 | |
{ |
259 | 2 | result.setResultCode( ReleaseResult.ERROR ); |
260 | 2 | logError( result, scmResult.getProviderMessage() ); |
261 | |
|
262 | 2 | throw new ReleaseScmCommandException( "Unable to checkout from SCM", scmResult ); |
263 | |
} |
264 | |
|
265 | 18 | result.setResultCode( ReleaseResult.SUCCESS ); |
266 | |
|
267 | 18 | return result; |
268 | |
} |
269 | |
|
270 | |
|
271 | |
public ReleaseResult simulate( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment, |
272 | |
List<MavenProject> reactorProjects ) |
273 | |
throws ReleaseExecutionException, ReleaseFailureException |
274 | |
{ |
275 | 2 | ReleaseResult result = new ReleaseResult(); |
276 | |
|
277 | 2 | logInfo( result, "The project would be checked out to perform the release ..." ); |
278 | |
|
279 | 2 | result.setResultCode( ReleaseResult.SUCCESS ); |
280 | 2 | return result; |
281 | |
} |
282 | |
} |