maven-release-manager/src/test/java/org/apache/maven/shared/release/scm/DefaultScmRepositoryConfiguratorTest.java

package org.apache.maven.shared.release.scm;

/*
 * 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.scm.manager.NoSuchScmProviderException;
import org.apache.maven.scm.provider.ScmProvider;
import org.apache.maven.scm.provider.ScmProviderRepositoryWithHost;
import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;
import org.apache.maven.scm.repository.ScmRepository;
import org.apache.maven.scm.repository.ScmRepositoryException;
import org.apache.maven.settings.Server;
import org.apache.maven.settings.Settings;
import org.apache.maven.shared.release.config.ReleaseDescriptor;
import org.codehaus.plexus.PlexusTestCase;

/**
 * Test the default SCM repository configurator.
 *
 * @author <a href="mailto:brett@apache.org">Brett Porter</a>
 */
public class DefaultScmRepositoryConfiguratorTest
    extends PlexusTestCase
{
    private ScmRepositoryConfigurator scmRepositoryConfigurator;

    private static final int CVS_PORT = 2401;

    @Override
    protected void setUp()
        throws Exception
    {
        super.setUp();

        scmRepositoryConfigurator = (ScmRepositoryConfigurator) lookup( ScmRepositoryConfigurator.class );
    }

    public void testGetConfiguredRepository()
        throws ScmRepositoryException, NoSuchScmProviderException
    {
        ReleaseDescriptor releaseDescriptor = createReleaseDescriptor();

        ScmRepository repository = scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, null );

        assertEquals( "check provider", "cvs", repository.getProvider() );
        assertEquals( "check username", "anoncvs", repository.getProviderRepository().getUser() );
        assertNull( "check password", repository.getProviderRepository().getPassword() );
    }

    public void testGetConfiguredRepositoryWithUsernameAndPassword()
        throws ScmRepositoryException, NoSuchScmProviderException
    {
        ReleaseDescriptor releaseDescriptor = createReleaseDescriptor( "username", "password" );

        ScmRepository repository = scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, null );

        assertEquals( "check username", "username", repository.getProviderRepository().getUser() );
        assertEquals( "check password", "password", repository.getProviderRepository().getPassword() );
    }

    public void testGetConfiguredRepositoryWithTagBase()
        throws ScmRepositoryException, NoSuchScmProviderException
    {
        ReleaseDescriptor releaseDescriptor = new ReleaseDescriptor();
        releaseDescriptor.setScmSourceUrl( "scm:svn:http://localhost/home/svn/module/trunk" );
        releaseDescriptor.setScmTagBase( "http://localhost/home/svn/module/tags" );

        ScmRepository repository = scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, null );

        SvnScmProviderRepository providerRepository = (SvnScmProviderRepository) repository.getProviderRepository();
        assertEquals( "check tag base", "http://localhost/home/svn/module/tags", providerRepository.getTagBase() );
    }

    public void testGetConfiguredRepositoryWithHost()
        throws ScmRepositoryException, NoSuchScmProviderException
    {
        Settings settings = new Settings();
        Server server = new Server();
        server.setId( "localhost:" + CVS_PORT );
        server.setUsername( "settings-username" );
        server.setPassword( "settings-password" );
        server.setPrivateKey( "settings-private-key" );
        server.setPassphrase( "settings-passphrase" );
        settings.addServer( server );

        ReleaseDescriptor releaseDescriptor = new ReleaseDescriptor();
        releaseDescriptor.setScmSourceUrl( "scm:cvs:pserver:anoncvs@localhost:/home/cvs:module" );

        ScmRepository repository = scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, settings );

        ScmProviderRepositoryWithHost providerRepository =
            (ScmProviderRepositoryWithHost) repository.getProviderRepository();
        assertEquals( "check host", "localhost", providerRepository.getHost() );
        assertEquals( "check port", CVS_PORT, providerRepository.getPort() );
        assertEquals( "check username", "settings-username", providerRepository.getUser() );
        assertEquals( "check password", "settings-password", providerRepository.getPassword() );
        assertEquals( "check private key", "settings-private-key", providerRepository.getPrivateKey() );
        assertEquals( "check passphrase", "settings-passphrase", providerRepository.getPassphrase() );
    }

    public void testGetConfiguredRepositoryWithEncryptedPasswords()
        throws ScmRepositoryException, NoSuchScmProviderException
    {
        Settings settings = new Settings();
        Server server = new Server();
        server.setId( "localhost" );
        server.setUsername( "testuser" );
        server.setPassword( "{Ael0S2tnXv8H3X+gHKpZAvAA25D8+gmU2w2RrGaf5v8=}" );
        server.setPassphrase( "{7zK9P8hNVeUHbTsjiA/vnOs0zUXbND+9MBNPvdvl+x4=}" );
        settings.addServer( server );

        ReleaseDescriptor releaseDescriptor = new ReleaseDescriptor();
        releaseDescriptor.setScmSourceUrl( "scm:svn:svn://localhost/repo" );

        ScmRepository repository = scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, settings );

        ScmProviderRepositoryWithHost providerRepository =
            (ScmProviderRepositoryWithHost) repository.getProviderRepository();
        assertEquals( "check host", "localhost", providerRepository.getHost() );
        assertEquals( "check username", "testuser", providerRepository.getUser() );
        assertEquals( "check password", "testpass", providerRepository.getPassword() );
        assertEquals( "check passphrase", "testphrase", providerRepository.getPassphrase() );
    }

    public void testGetConfiguredRepositoryInvalidScmUrl()
        throws Exception
    {
        ReleaseDescriptor releaseDescriptor = new ReleaseDescriptor();
        releaseDescriptor.setScmSourceUrl( "scm-url" );

        try
        {
            scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, null );

            fail( "Expected failure to get a repository with an invalid SCM URL" );
        }
        catch ( IllegalArgumentException e )
        {
            // expected
        }
    }

    public void testGetConfiguredRepositoryInvalidScmProvider()
        throws ScmRepositoryException
    {
        ReleaseDescriptor releaseDescriptor = new ReleaseDescriptor();
        releaseDescriptor.setScmSourceUrl( "scm:url:" );

        try
        {
            scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, null );

            fail( "Expected failure to get a repository with an invalid SCM URL" );
        }
        catch ( NoSuchScmProviderException e )
        {
            // expected
        }
    }

    public void testGetConfiguredRepositoryInvalidScmUrlParameters()
        throws NoSuchScmProviderException
    {
        ReleaseDescriptor releaseDescriptor = new ReleaseDescriptor();
        releaseDescriptor.setScmSourceUrl( "scm:cvs:" );

        try
        {
            scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, null );

            fail( "Expected failure to get a repository with an invalid SCM URL" );
        }
        catch ( ScmRepositoryException e )
        {
            // expected
        }
    }

    public void testGetRepositoryProvider()
        throws ScmRepositoryException, NoSuchScmProviderException
    {
        ReleaseDescriptor releaseDescriptor = createReleaseDescriptor();

        ScmRepository repository = scmRepositoryConfigurator.getConfiguredRepository( releaseDescriptor, null );

        ScmProvider provider = scmRepositoryConfigurator.getRepositoryProvider( repository );
        assertEquals( "Check SCM provider", "cvs", provider.getScmType() );
    }

    private static ReleaseDescriptor createReleaseDescriptor()
    {
        ReleaseDescriptor releaseDescriptor = new ReleaseDescriptor();
        releaseDescriptor.setScmSourceUrl( "scm:cvs:pserver:anoncvs@localhost:/home/cvs:module" );
        return releaseDescriptor;
    }

    private static ReleaseDescriptor createReleaseDescriptor( String username, String password )
    {
        ReleaseDescriptor releaseDescriptor = createReleaseDescriptor();
        releaseDescriptor.setScmUsername( username );
        releaseDescriptor.setScmPassword( password );
        return releaseDescriptor;
    }
}