surefire-booter/src/test/java/org/apache/maven/surefire/booter/ClasspathTest.java

package org.apache.maven.surefire.booter;

/*
 * 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 java.io.File;
import java.net.URL;
import java.util.Iterator;
import java.util.List;

import junit.framework.TestCase;
import org.apache.maven.plugin.surefire.log.api.ConsoleLogger;

import static org.apache.maven.surefire.booter.Classpath.emptyClasspath;

/**
 * @author Kristian Rosenvold
 */
public class ClasspathTest
    extends TestCase
{
    private static final String DUMMY_PROPERTY_NAME = "dummyProperty";

    private static final String DUMMY_URL_1 = "foo.jar";

    private static final String DUMMY_URL_2 = "bar.jar";

    public void testShouldWriteEmptyPropertyForEmptyClasspath()
    {
        Classpath classpath = Classpath.emptyClasspath();
        classpath.writeToSystemProperty( DUMMY_PROPERTY_NAME );
        assertEquals( "", System.getProperty( DUMMY_PROPERTY_NAME ) );
    }

    public void testShouldWriteSeparatedElementsAsSystemProperty()
    {
        Classpath classpath = Classpath.emptyClasspath()
                .addClassPathElementUrl( DUMMY_URL_1 )
                .addClassPathElementUrl( DUMMY_URL_2 );
        classpath.writeToSystemProperty( DUMMY_PROPERTY_NAME );
        assertEquals( DUMMY_URL_1 + File.pathSeparatorChar + DUMMY_URL_2 + File.pathSeparatorChar,
                      System.getProperty( DUMMY_PROPERTY_NAME ) );
    }

    public void testShouldAddNoDuplicateElements()
    {
        Classpath classpath = emptyClasspath()
                .addClassPathElementUrl( DUMMY_URL_1 )
                .addClassPathElementUrl( DUMMY_URL_1 );
        assertClasspathConsistsOfElements( classpath, new String[]{ DUMMY_URL_1 } );
    }

    public void testShouldJoinTwoNullClasspaths()
    {
        Classpath joinedClasspath = Classpath.join( null, null );
        assertEmptyClasspath( joinedClasspath );
    }

    public void testShouldHaveAllElementsAfterJoiningTwoDifferentClasspaths()
    {
        Classpath firstClasspath = Classpath.emptyClasspath();
        Classpath secondClasspath = firstClasspath.addClassPathElementUrl( DUMMY_URL_1 )
                .addClassPathElementUrl( DUMMY_URL_2 );
        Classpath joinedClasspath = Classpath.join( firstClasspath, secondClasspath );
        assertClasspathConsistsOfElements( joinedClasspath, new String[]{ DUMMY_URL_1, DUMMY_URL_2 } );
    }

    public void testShouldNotHaveDuplicatesAfterJoiningTowClasspathsWithEqualElements()
    {
        Classpath firstClasspath = Classpath.emptyClasspath().addClassPathElementUrl( DUMMY_URL_1 );
        Classpath secondClasspath = Classpath.emptyClasspath().addClassPathElementUrl( DUMMY_URL_1 );
        Classpath joinedClasspath = Classpath.join( firstClasspath, secondClasspath );
        assertClasspathConsistsOfElements( joinedClasspath, new String[]{ DUMMY_URL_1 } );
    }

    public void testShouldNotBeAbleToRemoveElement()
    {
        try
        {
            Classpath classpath = createClasspathWithTwoElements();
            classpath.getClassPath().remove( 0 );
        }
        catch ( java.lang.UnsupportedOperationException ignore )
        {

        }
    }

    private void assertClasspathConsistsOfElements( Classpath classpath, String[] elements )
    {
        List<String> classpathElements = classpath.getClassPath();
        for ( String element : elements )
        {
            assertTrue( "The element '" + element + " is missing.", classpathElements.contains( element ) );
        }
        assertEquals( "Wrong number of classpath elements.", elements.length, classpathElements.size() );
    }

    private void assertEmptyClasspath( Classpath classpath )
    {
        List<String> classpathElements = classpath.getClassPath();
        assertEquals( "Wrong number of classpath elements.", 0, classpathElements.size() );
    }

    private Classpath createClasspathWithTwoElements()
    {
        Classpath classpath = Classpath.emptyClasspath();
        return classpath.addClassPathElementUrl( DUMMY_URL_1 ).addClassPathElementUrl( DUMMY_URL_2 );
    }

    public void testShouldThrowIllegalArgumentExceptionWhenNullIsAddedAsClassPathElementUrl()
    {
        Classpath classpath = Classpath.emptyClasspath();
        try
        {
            classpath.addClassPathElementUrl( null );
            fail( "IllegalArgumentException not thrown." );
        }
        catch ( IllegalArgumentException expected )
        {
        }
    }

    public void testShouldNotAddNullAsClassPathElementUrl()
    {
        Classpath classpath = Classpath.emptyClasspath();
        try
        {
            classpath.addClassPathElementUrl( null );
        }
        catch ( IllegalArgumentException ignored )
        {
        }
        assertEmptyClasspath( classpath );
    }

    public void testCloneShouldBeEqual()
    {
        Classpath classpath = Classpath.emptyClasspath()
            .addClassPathElementUrl( DUMMY_URL_1 )
            .addClassPathElementUrl( DUMMY_URL_2 );

        assertEquals( classpath, classpath );
        assertFalse( classpath.equals( null ) );

        assertEquals( 2, classpath.getClassPath().size() );
        assertEquals( classpath, classpath.clone() );
        assertEquals( classpath.hashCode(), classpath.clone().hashCode() );
    }

    public void testIterator()
    {
        Classpath classpath = Classpath.emptyClasspath()
            .addClassPathElementUrl( DUMMY_URL_1 )
            .addClassPathElementUrl( DUMMY_URL_2 );
        Iterator<String> it = classpath.iterator();
        String url1 = it.hasNext() ? it.next() : null;
        String url2 = it.hasNext() ? it.next() : null;
        assertEquals( DUMMY_URL_1, url1 );
        assertEquals( DUMMY_URL_2, url2 );
    }

    public void testLog()
    {
        Classpath classpath = Classpath.emptyClasspath()
            .addClassPathElementUrl( DUMMY_URL_1 )
            .addClassPathElementUrl( DUMMY_URL_2 );
        String log = classpath.getLogMessage( "classpath:" );
        assertEquals( "classpath:  " + DUMMY_URL_1 + "  " + DUMMY_URL_2, log );
    }

    public void testCompactLog()
    {
        Classpath classpath = Classpath.emptyClasspath()
            .addClassPathElementUrl( "root" + File.separatorChar + DUMMY_URL_1 )
            .addClassPathElementUrl( "root" + File.separatorChar + DUMMY_URL_2 );
        String log = classpath.getCompactLogMessage( "classpath:" );
        assertEquals( "classpath:  " + DUMMY_URL_1 + "  " + DUMMY_URL_2, log );
    }

    public void testLoadInNewClassLoader() throws Exception
    {
        Class<?> target = ConsoleLogger.class;
        String thisPath = "/" + target.getName().replace( '.', '/' ) + ".class";
        URL url = target.getResource( thisPath );
        assertTrue( url.toString().endsWith( thisPath ) );
        String s = url.toString().replace( thisPath, "" ).replace( "!", "" ).replace( "jar:file:", "file:" );
        String oneClasspath = new URL( s ).getFile();
        assertTrue( new File( oneClasspath ).exists() );
        Classpath classpath = Classpath.emptyClasspath();
        ClassLoader classLoader = classpath.addClassPathElementUrl( new File( oneClasspath ).getCanonicalPath() )
            .createClassLoader( false, true, "" );
        Class<?> cls = classLoader.loadClass( target.getName() );
        assertNotNull( cls );
        assertEquals( cls.getName(), target.getName() );
        assertNotSame( cls, target );
    }

    public void testDontLoadInNewClassLoader()
    {
        Class<?> target = ConsoleLogger.class;
        String thisPath = "/" + target.getName().replace( '.', '/' ) + ".class";
        URL url = target.getResource( thisPath );
        assertTrue( url.toString().endsWith( thisPath ) );
        try
        {
            Classpath.emptyClasspath()
                .addClassPathElementUrl( "\u0000" )
                .createClassLoader( false, true, "" );
            fail();
        }
        catch ( SurefireExecutionException e )
        {
            // expected
        }
    }
}