View Javadoc
1   package org.apache.maven.shared.release.phase;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.apache.maven.artifact.ArtifactUtils;
23  import org.apache.maven.project.MavenProject;
24  import org.apache.maven.scm.manager.NoSuchScmProviderException;
25  import org.apache.maven.scm.repository.ScmRepositoryException;
26  import org.apache.maven.shared.release.ReleaseExecutionException;
27  import org.apache.maven.shared.release.ReleaseFailureException;
28  import org.apache.maven.shared.release.ReleaseResult;
29  import org.apache.maven.shared.release.config.ReleaseDescriptor;
30  import org.apache.maven.shared.release.env.ReleaseEnvironment;
31  import org.apache.maven.shared.release.scm.ReleaseScmRepositoryException;
32  import org.apache.maven.shared.release.scm.ScmRepositoryConfigurator;
33  import org.apache.maven.shared.release.util.ReleaseUtil;
34  import org.codehaus.plexus.util.StringUtils;
35  
36  import java.util.List;
37  
38  /**
39   * Phase that checks the validity of the POM before release.
40   *
41   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
42   */
43  public class CheckPomPhase
44      extends AbstractReleasePhase
45  {
46      
47      /**
48       * @since 2.4
49       */
50      private boolean scmRequired = true;
51      
52      /**
53       * @since 2.5.2
54       */
55      private boolean snapshotsRequired = true;
56  
57      private ScmRepositoryConfigurator scmRepositoryConfigurator;
58  
59      public ReleaseResult execute( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
60                                    List<MavenProject> reactorProjects )
61          throws ReleaseExecutionException, ReleaseFailureException
62      {
63          ReleaseResult result = new ReleaseResult();
64  
65          // Currently, we don't deal with multiple SCM locations in a multiproject
66          if ( scmRequired && StringUtils.isEmpty( releaseDescriptor.getScmSourceUrl() ) )
67          {
68              MavenProject rootProject = ReleaseUtil.getRootProject( reactorProjects );
69              if ( rootProject != null && rootProject.getScm() != null )
70              {
71                  if ( rootProject.getScm().getDeveloperConnection() != null )
72                  {
73                      releaseDescriptor.setScmSourceUrl( rootProject.getScm().getDeveloperConnection() );
74                  }
75                  else if ( rootProject.getScm().getConnection() != null )
76                  {
77                      releaseDescriptor.setScmSourceUrl( rootProject.getScm().getConnection() );
78                  }
79              }
80  
81              if ( StringUtils.isEmpty( releaseDescriptor.getScmSourceUrl() ) )
82              {
83                  throw new ReleaseFailureException(
84                      "Missing required setting: scm connection or developerConnection must be specified." );
85              }
86  
87              // As long as Scm.getId() does not exist, read it as a property
88              releaseDescriptor.setScmId( rootProject.getProperties().getProperty( "project.scm.id" ) );
89  
90              try
91              {
92                  scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor,
93                                                                     releaseEnvironment.getSettings() );
94              }
95              catch ( ScmRepositoryException e )
96              {
97                  throw new ReleaseScmRepositoryException( e.getMessage(), e.getValidationMessages() );
98              }
99              catch ( NoSuchScmProviderException e )
100             {
101                 throw new ReleaseFailureException(
102                     "The provider given in the SCM URL could not be found: " + e.getMessage() );
103             }
104         }
105 
106         boolean containsSnapshotProjects = false;
107 
108         for ( MavenProject project : reactorProjects )
109         {
110             if ( ArtifactUtils.isSnapshot( project.getVersion() ) )
111             {
112                 containsSnapshotProjects = true;
113 
114                 break;
115             }
116         }
117 
118         if ( snapshotsRequired && !containsSnapshotProjects && !releaseDescriptor.isBranchCreation() )
119         {
120             throw new ReleaseFailureException( "You don't have a SNAPSHOT project in the reactor projects list." );
121         }
122 
123         result.setResultCode( ReleaseResult.SUCCESS );
124 
125         return result;
126     }
127 
128     public ReleaseResult simulate( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
129                                    List<MavenProject> reactorProjects )
130         throws ReleaseExecutionException, ReleaseFailureException
131     {
132         // It makes no modifications, so simulate is the same as execute
133         return execute( releaseDescriptor, releaseEnvironment, reactorProjects );
134     }
135 }