org.apache.maven.shared.release.phase.InputVariablesPhase Maven / Gradle / Ivy
package org.apache.maven.shared.release.phase;
/*
* 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 org.apache.maven.artifact.ArtifactUtils;
import org.apache.maven.project.MavenProject;
import org.apache.maven.scm.manager.NoSuchScmProviderException;
import org.apache.maven.scm.provider.ScmProvider;
import org.apache.maven.scm.repository.ScmRepository;
import org.apache.maven.scm.repository.ScmRepositoryException;
import org.apache.maven.shared.release.ReleaseExecutionException;
import org.apache.maven.shared.release.ReleaseResult;
import org.apache.maven.shared.release.config.ReleaseDescriptor;
import org.apache.maven.shared.release.env.ReleaseEnvironment;
import org.apache.maven.shared.release.scm.ReleaseScmRepositoryException;
import org.apache.maven.shared.release.scm.ScmRepositoryConfigurator;
import org.apache.maven.shared.release.util.ReleaseUtil;
import org.codehaus.plexus.components.interactivity.Prompter;
import org.codehaus.plexus.components.interactivity.PrompterException;
import org.codehaus.plexus.interpolation.InterpolationException;
import org.codehaus.plexus.interpolation.Interpolator;
import org.codehaus.plexus.interpolation.PrefixAwareRecursionInterceptor;
import org.codehaus.plexus.interpolation.PrefixedPropertiesValueSource;
import org.codehaus.plexus.interpolation.RecursionInterceptor;
import org.codehaus.plexus.interpolation.StringSearchInterpolator;
import java.util.List;
import java.util.Properties;
/**
* Input any variables that were not yet configured.
*
* @author Brett Porter
* @plexus.component role="org.apache.maven.shared.release.phase.ReleasePhase" role-hint="input-variables"
*/
public class InputVariablesPhase
extends AbstractReleasePhase
{
/**
* Component used to prompt for input.
*
* @plexus.requirement
*/
private Prompter prompter;
/**
* Tool that gets a configured SCM repository from release configuration.
*
* @plexus.requirement
*/
private ScmRepositoryConfigurator scmRepositoryConfigurator;
void setPrompter( Prompter prompter )
{
this.prompter = prompter;
}
protected ScmProvider getScmProvider( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment )
throws ReleaseScmRepositoryException, ReleaseExecutionException
{
try
{
ScmRepository repository =
scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, releaseEnvironment.getSettings() );
return scmRepositoryConfigurator.getRepositoryProvider( repository );
}
catch ( ScmRepositoryException e )
{
throw new ReleaseScmRepositoryException(
e.getMessage() + " for URL: " + releaseDescriptor.getScmSourceUrl(), e.getValidationMessages() );
}
catch ( NoSuchScmProviderException e )
{
throw new ReleaseExecutionException( "Unable to configure SCM repository: " + e.getMessage(), e );
}
}
public ReleaseResult execute( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
List reactorProjects )
throws ReleaseExecutionException
{
ReleaseResult result = new ReleaseResult();
// get the root project
MavenProject project = ReleaseUtil.getRootProject( reactorProjects );
String tag = releaseDescriptor.getScmReleaseLabel();
if ( tag == null )
{
// Must get default version from mapped versions, as the project will be the incorrect snapshot
String key = ArtifactUtils.versionlessKey( project.getGroupId(), project.getArtifactId() );
String releaseVersion = (String) releaseDescriptor.getReleaseVersions().get( key );
if ( releaseVersion == null )
{
throw new ReleaseExecutionException( "Project tag cannot be selected if version is not yet mapped" );
}
String defaultTag;
String scmTagNameFormat = releaseDescriptor.getScmTagNameFormat();
if ( scmTagNameFormat != null )
{
Interpolator interpolator = new StringSearchInterpolator( "@{", "}" );
List possiblePrefixes = java.util.Arrays.asList( "project", "pom" );
Properties values = new Properties();
values.setProperty( "artifactId", project.getArtifactId() );
values.setProperty( "groupId", project.getGroupId() );
values.setProperty( "version", releaseVersion );
interpolator.addValueSource( new PrefixedPropertiesValueSource( possiblePrefixes, values, true ) );
RecursionInterceptor recursionInterceptor = new PrefixAwareRecursionInterceptor( possiblePrefixes );
try
{
defaultTag = interpolator.interpolate( scmTagNameFormat, recursionInterceptor );
}
catch ( InterpolationException e )
{
throw new ReleaseExecutionException(
"Could not interpolate specified tag name format: " + scmTagNameFormat, e );
}
}
else
{
defaultTag = project.getArtifactId() + "-" + releaseVersion;
}
ScmProvider provider = null;
try
{
provider = getScmProvider( releaseDescriptor, releaseEnvironment );
}
catch ( ReleaseScmRepositoryException e )
{
throw new ReleaseExecutionException(
"No scm provider can be found for url: " + releaseDescriptor.getScmSourceUrl(), e );
}
defaultTag = provider.sanitizeTagName( defaultTag );
if ( releaseDescriptor.isInteractive() )
{
try
{
tag =
prompter.prompt( "What is SCM release tag or label for \"" + project.getName() + "\"? ("
+ project.getGroupId() + ":" + project.getArtifactId() + ")", defaultTag );
}
catch ( PrompterException e )
{
throw new ReleaseExecutionException( "Error reading version from input handler: " + e.getMessage(),
e );
}
}
else
{
tag = defaultTag;
}
releaseDescriptor.setScmReleaseLabel( tag );
}
result.setResultCode( ReleaseResult.SUCCESS );
return result;
}
public ReleaseResult simulate( ReleaseDescriptor releaseDescriptor, ReleaseEnvironment releaseEnvironment,
List reactorProjects )
throws ReleaseExecutionException
{
ReleaseResult result = new ReleaseResult();
// It makes no modifications, so simulate is the same as execute
execute( releaseDescriptor, releaseEnvironment, reactorProjects );
result.setResultCode( ReleaseResult.SUCCESS );
return result;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy