maven-release-manager/src/test/java/org/apache/maven/shared/release/util/ReleaseUtilTest.java

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

/*
 * 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 static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import static org.junit.Assume.*;

import java.io.File;
import java.util.Arrays;
import java.util.Collections;

import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.util.Os;
import org.junit.Test;

/**
 * Tests for ReleaseUtil methods
 */
public class ReleaseUtilTest
{
    /**
     * MRELEASE-273 : Tests if there no pom passed as parameter
     */
    @Test
    public void testProjectIsNull()
    {
        assertNull( ReleaseUtil.getReleasePom( null ) );
        assertNull( ReleaseUtil.getStandardPom( null ) );
    }

    @Test
    public void testGetCommonBasedirSingleProject() throws Exception
    {
        assertEquals( "/working/directory/flat-multi-module/project", ReleaseUtil.getCommonBasedir(
            Collections.singletonList( createProject( "/working/directory/flat-multi-module/project" ) ), "/" ) );
    }

    @Test
    public void testGetCommonBasedirSingleProjectWindows() throws Exception
    {
        assertEquals( "C:\\working\\directory\\flat-multi-module\\project", ReleaseUtil.getCommonBasedir(
            Collections.singletonList( createProject( "C:\\working\\directory\\flat-multi-module\\project" ) ),
            "\\" ) );
    }

    @Test
    public void testGetCommonBasedirOfFlatMultiModule()
        throws Exception
    {
        assertEquals( "/working/directory/flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{createProject( "/working/directory/flat-multi-module/root-project" ),
                createProject( "/working/directory/flat-multi-module/core" ),
                createProject( "/working/directory/flat-multi-module/webapp" )} ), "/" ) );
    }

    @Test
    public void testGetCommonBasedirOfFlatMultiModuleWindows()
        throws Exception
    {
        assertEquals( "C:\\working\\directory\\flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{createProject( "C:\\working\\directory\\flat-multi-module\\root-project" ),
                createProject( "C:\\working\\directory\\flat-multi-module\\core" ),
                createProject( "C:\\working\\directory\\flat-multi-module\\webapp" )} ), "\\" ) );
    }

    @Test
    public void testGetCommonBasedirUppercaseLowerCaseWindows()
        throws Exception
    {
        assertEquals( "C:\\WORKING\\root", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{createProject( "c:\\WORKING\\root", "C:\\WORKING\\root" ),
                createProject( "c:\\working\\root\\project1", "C:\\WORKING\\root\\project1" ),
                createProject( "C:\\WORKING\\root\\project2", "C:\\WORKING\\root\\project2" )} ), "\\" ) );
    }

    @Test
    public void testGetCommonBasedirOfFlatMultiModuleSimilarArtifactIds()
        throws Exception
    {
        assertEquals( "/working/directory/flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{createProject( "/working/directory/flat-multi-module/release-parent" ),
                createProject( "/working/directory/flat-multi-module/release-module1" ),
                createProject( "/working/directory/flat-multi-module/release-module2" )} ), "/" ) );
    }

    @Test
    public void testGetCommonBasedirOfFlatMultiModuleSimilarArtifactIdsWindows()
        throws Exception
    {
        assertEquals( "c:\\working\\directory\\flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{createProject( "c:\\working\\directory\\flat-multi-module\\release-parent" ),
                createProject( "c:\\working\\directory\\flat-multi-module\\release-module1" ),
                createProject( "c:\\working\\directory\\flat-multi-module\\release-module2" )} ), "\\" ) );
    }

    @Test
    public void testGetCommonBasedirOfRegularMultiModule()
        throws Exception
    {
        assertEquals( "/working/directory/flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{createProject( "/working/directory/flat-multi-module" ),
                createProject( "/working/directory/flat-multi-module/core" ),
                createProject( "/working/directory/flat-multi-module/webapp" )} ), "/" ) );
    }

    @Test
    public void testGetCommonBasedirOfRegularMultiModuleParentNotBeeingFirstInReactor()
        throws Exception
    {
        assertEquals( "/working/directory/flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{
                createProject( "/working/directory/flat-multi-module/core" ),
                createProject( "/working/directory/flat-multi-module" ),
                createProject( "/working/directory/flat-multi-module/webapp" )} ), "/" ) );
    }

    @Test
    public void testGetCommonBasedirOfRegularMultiModuleWindowsPath()
        throws Exception
    {
        assertEquals( "c:\\working\\directory\\flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{
                createProject( "c:\\working\\directory\\flat-multi-module\\core" ),
                createProject( "c:\\working\\directory\\flat-multi-module" ),
                createProject( "c:\\working\\directory\\flat-multi-module\\webapp" )} ), "\\" ) );
    }

    @Test
    public void testGetCommonBasedirOfFlatMultiModuleWithMultipleLevels()
        throws Exception
    {
        assertEquals( "/working/directory/flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{createProject( "/working/directory/flat-multi-module/root-project" ),
                createProject( "/working/directory/flat-multi-module/core" ),
                createProject( "/working/directory/flat-multi-module/common/utils" ),
                createProject( "/working/directory/flat-multi-module/common/xml" ),
                createProject( "/working/directory/flat-multi-module/webapp" )} ), "/" ) );
    }

    @Test
    public void testGetCommonBasedirOfFlatMultiModuleWithDescendingHierarchy()
        throws Exception
    {
        assertEquals( "/working/directory/flat-multi-module", ReleaseUtil.getCommonBasedir( Arrays.asList(
            new MavenProject[]{createProject( "/working/directory/flat-multi-module/level/1/2/3" ),
                createProject( "/working/directory/flat-multi-module/level/1/2" ),
                createProject( "/working/directory/flat-multi-module/level/1" ),
                createProject( "/working/directory/flat-multi-module/level" ),
                createProject( "/working/directory/flat-multi-module/other" )} ), "/" ) );
    }

    @Test
    public void testGetBaseScmUrlSingleLevel()
        throws Exception
    {
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk",
                      ReleaseUtil.realignScmUrl( 0, "scm:svn:http://svn.repo.com/flat-multi-module/trunk" ) );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk/",
                      ReleaseUtil.realignScmUrl( 0, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/" ) );
    }

    @Test
    public void testGetBaseScmUrlSingleLevelDotCharacter()
            throws Exception
    {
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk",
                      ReleaseUtil.realignScmUrl( 0, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/." ) );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk/",
                      ReleaseUtil.realignScmUrl( 0, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/./" ) );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk/project",
                      ReleaseUtil.realignScmUrl( 0, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/./project" ) );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module",
                      ReleaseUtil.realignScmUrl( 0, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/.." ) );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/",
                      ReleaseUtil.realignScmUrl( 0, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/../" ) );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/branches",
                      ReleaseUtil.realignScmUrl( 0, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/../branches" ) );
    }

    @Test
    public void testGetBaseScmUrlReturnOriginal()
        throws Exception
    {
        assertEquals( "no-path-elements", ReleaseUtil.realignScmUrl( 1, "no-path-elements" ) );
        assertEquals( "no-path-elements", ReleaseUtil.realignScmUrl( 15, "no-path-elements" ) );
    }

    @Test
    public void testGetBaseScmUrlOfFlatMultiModule()
        throws Exception
    {
        String actual =
            ReleaseUtil.realignScmUrl( 1, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/root-project" );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk", actual );

        actual = ReleaseUtil.realignScmUrl( 1, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/root-project/" );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk/", actual );
    }

    @Test
    public void testGetBaseScmUrlOfFlatMultiModuleMultipleLevels()
        throws Exception
    {
        String actual =
            ReleaseUtil.realignScmUrl( 3, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/root-project/1/2" );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk", actual );

        actual =
            ReleaseUtil.realignScmUrl( 3, "scm:svn:http://svn.repo.com/flat-multi-module/trunk/root-project/1/2/" );
        assertEquals( "scm:svn:http://svn.repo.com/flat-multi-module/trunk/", actual );
    }

    @Test
    public void testGetBaseWorkingDirectoryParentCountSameDirectory()
    {
        String workingDirectory = "/working/directory/maven/release";
        String basedir = "/working/directory/maven/release";
        assertEquals( 0, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );
    }

    @Test
    public void testGetBaseWorkingDirectoryParentCountSameDirectoryDotCharacter()
    {
        String workingDirectory = new File( "/working/directory/maven/release/." ).getAbsolutePath();
        assertTrue( workingDirectory.contains( "." ) );
        String basedir = new File( "/working/directory/maven/release" ).getAbsolutePath();
        assertEquals( 0, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );

        // finish with slash
        workingDirectory = new File( "/working/directory/maven/release/./" ).getAbsolutePath();
        assertTrue( workingDirectory.contains( "." ) );
        basedir = new File( "/working/directory/maven/release" ).getAbsolutePath();
        assertEquals( 0, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );
    }

    @Test
    public void testGetBaseWorkingDirectoryParentCountSubdirectory()
    {
        String workingDirectory = new File( "/working/directory/maven/release" ).getAbsolutePath();
        String basedir = new File( "/working/directory/maven/release/maven-release-manager" ).getAbsolutePath();
        assertEquals( 0, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );
    }

    @Test
    public void testGetBaseWorkingDirectoryParentCountParentDirectory()
    {
        String workingDirectory =
            new File( "/working/directory/maven/release/maven-release-manager" ).getAbsolutePath();
        String basedir = new File( "/working/directory/maven/release" ).getAbsolutePath();
        assertEquals( 1, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );
    }

    @Test
    public void testGetBaseWorkingDirectoryParentCountParentDirectoryDotCharacter()
    {
        String workingDirectory =
            new File( "/working/directory/maven/release/maven-release-manager/." ).getAbsolutePath();
        assertTrue( workingDirectory.contains( "." ) );
        String basedir = new File( "/working/directory/maven/release" ).getAbsolutePath();
        assertEquals( 1, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );

        // finish with slash
        workingDirectory = new File( "/working/directory/maven/release/maven-release-manager/./" ).getAbsolutePath();
        assertTrue( workingDirectory.contains( "." ) );
        basedir = new File( "/working/directory/maven/release" ).getAbsolutePath();
        assertEquals( 1, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );
    }

    @Test
    public void testGetBaseWorkingDirectoryParentCountParentDirectoryMultiple()
    {
        String workingDirectory =
            new File( "/working/directory/maven/release/maven-release-manager" ).getAbsolutePath();
        String basedir = new File( "/working/directory" ).getAbsolutePath();
        assertEquals( 3, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );
    }

    @Test
    public void testGetBaseWorkingDirectoryParentCountParentDirectoryMultipleDotCharacter()
    {
        String workingDirectory =
            new File( "/working/directory/maven/release/maven-release-manager/./." ).getAbsolutePath();
        assertTrue( workingDirectory.contains( "." ) );
        String basedir = new File( "/working/directory" ).getAbsolutePath();
        assertEquals( 3, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );

        // finish with slash
        workingDirectory = new File( "/working/directory/maven/release/maven-release-manager/././" ).getAbsolutePath();
        assertTrue( workingDirectory.contains( "." ) );
        basedir = new File( "/working/directory" ).getAbsolutePath();
        assertEquals( 3, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );
    }

    @Test
    public void testGetBaseWorkingDirectoryParentCountDifferentCase()
    {
        String workingDirectory =
            new File( "/Working/Directory/maven/release/maven-release-manager" ).getAbsolutePath();
        String basedir = new File( "/working/directory" ).getAbsolutePath();
        assertEquals( 3, ReleaseUtil.getBaseWorkingDirectoryParentCount( basedir, workingDirectory ) );
    }

    /**
     * MRELEASE-663
     */
    @Test
    public void testGetWindowsRootBaseWorkingDirectoryParentCountDifferentCase()
    {
        assumeTrue( Os.isFamily( Os.FAMILY_WINDOWS ) );

        assertEquals( 2, ReleaseUtil.getBaseWorkingDirectoryParentCount( "C:", "C:\\working\\directory" ) );
        assertEquals( 2, ReleaseUtil.getBaseWorkingDirectoryParentCount( "C:", "C:\\working\\directory\\" ) );
        assertEquals( 2, ReleaseUtil.getBaseWorkingDirectoryParentCount( "C:\\", "C:\\working\\directory" ) );
        assertEquals( 2, ReleaseUtil.getBaseWorkingDirectoryParentCount( "C:\\", "C:\\working\\directory\\" ) );
    }

    private static MavenProject createProject( String basedir )
    {
    	return createProject( basedir, basedir );
    }

    private static MavenProject createProject( final String basedirPath, final String basedirCanonicalPath )
    {
        return new MavenProject()
        {
            @Override
            public File getBasedir()
            {
                return new File( basedirPath )
                {
                	@Override
                    public String getCanonicalPath()
                	{
                		return basedirCanonicalPath;
                	}
                };
            }
        };
    }
}