core-it-suite/src/test/java/org/apache/maven/it/MavenITmng1895ScopeConflictResolutionTest.java

package org.apache.maven.it;

/*
 * 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.it.Verifier;
import org.apache.maven.it.util.ResourceExtractor;

import java.io.File;
import java.util.List;
import java.util.Properties;

/**
 * This is a test set for <a href="https://issues.apache.org/jira/browse/MNG-1895">MNG-1895</a>.
 *
 * @author Benjamin Bentmann
 */
public class MavenITmng1895ScopeConflictResolutionTest
    extends AbstractMavenIntegrationTestCase
{

    public MavenITmng1895ScopeConflictResolutionTest()
    {
        super( "[2.0.3,)" );
    }

    /**
     * Verify that for a dependency being referenced in two different scopes, the scope given directly in the POM
     * always wins, even if weaker than the scope of the transitive dependency.
     */
    public void testitDirectVsIndirect()
        throws Exception
    {
        File testDir = ResourceExtractor.simpleExtractResources( getClass(), "/mng-1895/direct-vs-indirect" );

        Verifier verifier = newVerifier( testDir.getAbsolutePath() );
        verifier.setAutoclean( false );
        verifier.deleteArtifacts( "org.apache.maven.its.mng1895" );
        verifier.deleteDirectory( "target" );
        verifier.addCliOption( "-s" );
        verifier.addCliOption( "settings.xml" );
        verifier.filterFile( "settings-template.xml", "settings.xml", "UTF-8", verifier.newDefaultFilterProperties() );
        verifier.executeGoal( "validate" );
        verifier.verifyErrorFreeLog();
        verifier.resetStreams();

        List<String> compile = verifier.loadLines( "target/compile.txt", "UTF-8" );
        assertTrue( compile.toString(), compile.contains( "a-0.1.jar" ) );
        assertFalse( compile.toString(), compile.contains( "b-0.1.jar" ) );
        assertFalse( compile.toString(), compile.contains( "c-0.1.jar" ) );
        assertTrue( compile.toString(), compile.contains( "d-0.1.jar" ) );

        List<String> runtime = verifier.loadLines( "target/runtime.txt", "UTF-8" );
        assertFalse( runtime.toString(), runtime.contains( "a-0.1.jar" ) );
        assertTrue( runtime.toString(), runtime.contains( "b-0.1.jar" ) );
        assertFalse( runtime.toString(), runtime.contains( "c-0.1.jar" ) );
        assertTrue( runtime.toString(), runtime.contains( "d-0.1.jar" ) );

        List<String> test = verifier.loadLines( "target/test.txt", "UTF-8" );
        assertTrue( test.toString(), test.contains( "a-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "b-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "c-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "d-0.1.jar" ) );
    }

    /**
     * Verify that for a dependency being referenced in compile and in runtime scope, compile scope wins.
     */
    public void testitCompileVsRuntime()
        throws Exception
    {
        Verifier verifier = run( "compile", "runtime" );

        List<String> compile = verifier.loadLines( "target/compile.txt", "UTF-8" );
        assertTrue( compile.toString(), compile.contains( "x-0.1.jar" ) );
        assertFalse( compile.toString(), compile.contains( "a-0.1.jar" ) );

        List<String> runtime = verifier.loadLines( "target/runtime.txt", "UTF-8" );
        assertTrue( runtime.toString(), runtime.contains( "x-0.1.jar" ) );
        assertTrue( runtime.toString(), runtime.contains( "a-0.1.jar" ) );

        List<String> test = verifier.loadLines( "target/test.txt", "UTF-8" );
        assertTrue( test.toString(), test.contains( "x-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "a-0.1.jar" ) );
    }

    /**
     * Verify that for a dependency being referenced in compile and in test scope, compile scope wins.
     */
    public void testitCompileVsTest()
        throws Exception
    {
        Verifier verifier = run( "compile", "test" );

        List<String> compile = verifier.loadLines( "target/compile.txt", "UTF-8" );
        assertTrue( compile.toString(), compile.contains( "x-0.1.jar" ) );
        assertFalse( compile.toString(), compile.contains( "a-0.1.jar" ) );

        List<String> runtime = verifier.loadLines( "target/runtime.txt", "UTF-8" );
        assertTrue( runtime.toString(), runtime.contains( "x-0.1.jar" ) );
        assertFalse( runtime.toString(), runtime.contains( "a-0.1.jar" ) );

        List<String> test = verifier.loadLines( "target/test.txt", "UTF-8" );
        assertTrue( test.toString(), test.contains( "x-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "a-0.1.jar" ) );
    }

    /**
     * Verify that for a dependency being referenced in compile and in provided scope, compile scope wins.
     */
    public void testitCompileVsProvided()
        throws Exception
    {
        Verifier verifier = run( "compile", "provided" );

        List<String> compile = verifier.loadLines( "target/compile.txt", "UTF-8" );
        assertTrue( compile.toString(), compile.contains( "x-0.1.jar" ) );
        assertTrue( compile.toString(), compile.contains( "a-0.1.jar" ) );

        List<String> runtime = verifier.loadLines( "target/runtime.txt", "UTF-8" );
        assertTrue( runtime.toString(), runtime.contains( "x-0.1.jar" ) );
        assertFalse( runtime.toString(), runtime.contains( "a-0.1.jar" ) );

        List<String> test = verifier.loadLines( "target/test.txt", "UTF-8" );
        assertTrue( test.toString(), test.contains( "x-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "a-0.1.jar" ) );
    }

    /**
     * Verify that for a dependency being referenced in runtime and in test scope, runtime scope wins.
     */
    public void testitRuntimeVsTest()
        throws Exception
    {
        Verifier verifier = run( "runtime", "test" );

        List<String> compile = verifier.loadLines( "target/compile.txt", "UTF-8" );
        assertFalse( compile.toString(), compile.contains( "x-0.1.jar" ) );
        assertFalse( compile.toString(), compile.contains( "a-0.1.jar" ) );

        List<String> runtime = verifier.loadLines( "target/runtime.txt", "UTF-8" );
        assertTrue( runtime.toString(), runtime.contains( "x-0.1.jar" ) );
        assertFalse( runtime.toString(), runtime.contains( "a-0.1.jar" ) );

        List<String> test = verifier.loadLines( "target/test.txt", "UTF-8" );
        assertTrue( test.toString(), test.contains( "x-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "a-0.1.jar" ) );
    }

    /**
     * Verify that for a dependency being referenced in runtime and in provided scope, runtime scope wins.
     */
    public void testitRuntimeVsProvided()
        throws Exception
    {
        Verifier verifier = run( "runtime", "provided" );

        List<String> compile = verifier.loadLines( "target/compile.txt", "UTF-8" );
        assertFalse( compile.toString(), compile.contains( "x-0.1.jar" ) );
        assertTrue( compile.toString(), compile.contains( "a-0.1.jar" ) );

        List<String> runtime = verifier.loadLines( "target/runtime.txt", "UTF-8" );
        assertTrue( runtime.toString(), runtime.contains( "x-0.1.jar" ) );
        assertFalse( runtime.toString(), runtime.contains( "a-0.1.jar" ) );

        List<String> test = verifier.loadLines( "target/test.txt", "UTF-8" );
        assertTrue( test.toString(), test.contains( "x-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "a-0.1.jar" ) );
    }

    /**
     * Verify that for a dependency being referenced in provided and in test scope, provided scope wins.
     */
    public void testitProvidedVsTest()
        throws Exception
    {
        requiresMavenVersion( "[3.0-beta-3,)" ); // MNG-2686

        Verifier verifier = run( "provided", "test" );

        List<String> compile = verifier.loadLines( "target/compile.txt", "UTF-8" );
        assertTrue( compile.toString(), compile.contains( "x-0.1.jar" ) );
        assertFalse( compile.toString(), compile.contains( "a-0.1.jar" ) );

        List<String> runtime = verifier.loadLines( "target/runtime.txt", "UTF-8" );
        assertFalse( runtime.toString(), runtime.contains( "x-0.1.jar" ) );
        assertFalse( runtime.toString(), runtime.contains( "a-0.1.jar" ) );

        List<String> test = verifier.loadLines( "target/test.txt", "UTF-8" );
        assertTrue( test.toString(), test.contains( "x-0.1.jar" ) );
        assertTrue( test.toString(), test.contains( "a-0.1.jar" ) );
    }

    private Verifier run( String scopeB, String scopeA )
        throws Exception
    {
        File testDir = ResourceExtractor.simpleExtractResources( getClass(), "/mng-1895/strong-vs-weak" );

        Verifier verifier = newVerifier( testDir.getAbsolutePath() );
        verifier.setAutoclean( false );
        verifier.deleteArtifacts( "org.apache.maven.its.mng1895" );
        verifier.deleteDirectory( "target" );
        verifier.addCliOption( "-s" );
        verifier.addCliOption( "settings.xml" );
        Properties props = verifier.newDefaultFilterProperties();
        props.setProperty( "@scope.a@", scopeA );
        props.setProperty( "@scope.b@", scopeB );
        verifier.filterFile( "settings-template.xml", "settings.xml", "UTF-8", props );
        verifier.filterFile( "pom-template.xml", "pom.xml", "UTF-8", props );
        verifier.setLogFileName( "log-" + scopeB + "-vs-" + scopeA + ".txt" );
        verifier.executeGoal( "validate" );
        verifier.verifyErrorFreeLog();
        verifier.resetStreams();

        return verifier;
    }

}