org.apache.maven.scm.plugin.ValidateMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of maven-scm-plugin Show documentation
Maven Plugin that allows accessing different SCMs.
There is a newer version: 2.1.0
package org.apache.maven.scm.plugin;

/*
 * 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.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Execute;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;

import java.util.Iterator;
import java.util.List;

/**
 * Validate scm connection string.
 *
 * @author Emmanuel Venisse
 * @author Olivier Lamy
 */
@Mojo( name = "validate", requiresProject = false )
@Execute( phase = LifecyclePhase.VALIDATE )
public class ValidateMojo
    extends AbstractScmMojo
{
    /**
     * The scm connection url.
     */
    @Parameter( property = "scmConnection", defaultValue = "${project.scm.connection}" )
    private String scmConnection;

    @Parameter( defaultValue = "${project}", readonly = true )
    private MavenProject project;

    /**
     * The scm connection url for developers.
     */
    @Parameter( property = "scmDeveloperConnection", defaultValue = "${project.scm.developerConnection}" )
    private String scmDeveloperConnection;

    /**
     * (Subversion specific) Enables checking that "URL" field returned by svn info matches what is specified
     * under the scm tag.
     */
    @Parameter( property = "scmCheckWorkingDirectoryUrl", defaultValue = "false" )
    // Actually unused in the code here. Present for doc purpose,
    // see org.apache.maven.scm.provider.svn.AbstractSvnScmProvider.CHECK_WORKING_DIRECTORY_URL
    private boolean scmCheckWorkingDirectoryUrl;

    /**
     * {@inheritDoc}
     */
    public void execute()
        throws MojoExecutionException
    {
        super.execute();

        //check connectionUrl provided with cli
        try
        {
            validateConnection( getConnectionUrl(), "connectionUrl" );
        }
        catch ( NullPointerException e )
        {
            // nothing to do. connectionUrl isn't defined
        }

        //check scm connection
        if ( scmConnection != null )
        {
            validateConnection( scmConnection, "project.scm.connection" );
        }

        // Check scm developerConnection
        if ( scmDeveloperConnection != null )
        {
            validateConnection( scmDeveloperConnection, "project.scm.developerConnection" );
        }

    }

    private void validateConnection( String connectionString, String type )
        throws MojoExecutionException
    {
        if ( scmCheckWorkingDirectoryUrl )
        {
            System.setProperty( "scmCheckWorkingDirectoryUrl.currentWorkingDirectory",
                                project.getFile().getParentFile().getAbsolutePath() );
        }
        List messages = getScmManager().validateScmRepository( connectionString );

        if ( !messages.isEmpty() )
        {
            getLog().error( "Validation of scm url connection (" + type + ") failed :" );

            Iterator iter = messages.iterator();

            while ( iter.hasNext() )
            {
                getLog().error( iter.next().toString() );
            }

            getLog().error( "The invalid scm url connection: '" + connectionString + "'." );

            throw new MojoExecutionException( "Command failed. Bad Scm URL." );
        }
        else
        {
            getLog().info( type + " scm connection string is valid." );
        }
    }
}