src/test/java/org/apache/maven/plugin/dependency/TestAnalyzeDepMgt.java

package org.apache.maven.plugin.dependency;

import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;

import junit.framework.TestCase;

import org.apache.maven.artifact.Artifact;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.dependency.testUtils.ArtifactStubFactory;
import org.apache.maven.plugin.dependency.testUtils.stubs.DependencyProjectStub;
import org.apache.maven.project.MavenProject;

/*
 * 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.
 */


public class TestAnalyzeDepMgt
    extends TestCase
{

    AnalyzeDepMgt mojo;
    ArtifactStubFactory stubFactory;
    Dependency exclusion;
    Artifact exclusionArtifact;

    protected void setUp()
        throws Exception
    {
        
        stubFactory = new ArtifactStubFactory( new File(""), false );
        
        Set allArtifacts = stubFactory.getMixedArtifacts();
        Set directArtifacts = stubFactory.getClassifiedArtifacts();
        
        exclusionArtifact = stubFactory.getReleaseArtifact();
        exclusion = new Dependency();
        exclusion.setArtifactId( exclusionArtifact.getArtifactId() );
        exclusion.setGroupId( exclusionArtifact.getGroupId() );
        exclusion.setType( exclusionArtifact.getType() );
        exclusion.setClassifier( "" );
        exclusion.setVersion( "3.0" );
        
        mojo = new AnalyzeDepMgt();
        MavenProject project = new DependencyProjectStub();
        project.setArtifacts( allArtifacts );
        project.setDependencyArtifacts( directArtifacts );
        
        mojo.setProject( project );
        
    }

    public void testGetManagementKey() throws IOException
    {
        Dependency dep = new Dependency();
        dep.setArtifactId( "artifact" );
        dep.setClassifier( "class" );
        dep.setGroupId( "group" );
        dep.setType( "type" );
        
        //version isn't used in the key, it can be different
        dep.setVersion( "1.1" );
        
        Artifact artifact = stubFactory.createArtifact( "group", "artifact", "1.0",Artifact.SCOPE_COMPILE,"type","class" );

        //basic case ok
        assertEquals( dep.getManagementKey(), mojo.getArtifactManagementKey( artifact ) );
        
        //now change each one and make sure it fails, then set it back and make sure it's ok before
        //testing the next one
        dep.setType( "t" );
        assertFalse ( dep.getManagementKey().equals(mojo.getArtifactManagementKey( artifact ) ));
        
        dep.setType( "type" );
        assertEquals( dep.getManagementKey(), mojo.getArtifactManagementKey( artifact ) );
        
        dep.setArtifactId( "a" );
        assertFalse ( dep.getManagementKey().equals(mojo.getArtifactManagementKey( artifact ) ));
        
        dep.setArtifactId( "artifact" );
        assertEquals( dep.getManagementKey(), mojo.getArtifactManagementKey( artifact ) );
        
        dep.setClassifier( "c" );
        assertFalse ( dep.getManagementKey().equals(mojo.getArtifactManagementKey( artifact ) ));
        
        dep.setClassifier( "class" );
        assertEquals( dep.getManagementKey(), mojo.getArtifactManagementKey( artifact ) );
                
        dep.setGroupId( "g" );
        assertFalse ( dep.getManagementKey().equals(mojo.getArtifactManagementKey( artifact ) ));
        
        dep.setGroupId( "group" );
        dep.setClassifier( null );
        artifact = stubFactory.createArtifact( "group", "artifact", "1.0",Artifact.SCOPE_COMPILE,"type",null );
        assertEquals( dep.getManagementKey(), mojo.getArtifactManagementKey( artifact ) );
        
        dep.setClassifier( "" );
        artifact = stubFactory.createArtifact( "group", "artifact", "1.0",Artifact.SCOPE_COMPILE,"type","" );
        assertEquals( dep.getManagementKey(), mojo.getArtifactManagementKey( artifact ) );
    }
    
    public void testAddExclusions()
    {
        Dependency dep = new Dependency();
        dep.setArtifactId( "artifact" );
        dep.setClassifier( "class" );
        dep.setGroupId( "group" );
        dep.setType( "type" );
        
        assertEquals( 0, mojo.addExclusions( null ).size() );
       
        ArrayList list = new ArrayList();
        assertEquals( 0, mojo.addExclusions( null ).size() );
        
        list.add( dep );
        Map map = mojo.addExclusions( list );
        
        assertTrue(map.containsKey( dep.getManagementKey() ));
        assertSame( dep, map.get( dep.getManagementKey() ) );
    }
    
    public void testGetExclusionErrors()
    {
        ArrayList list = new ArrayList();
        list.add( exclusion );
        
        //already tested this method so I can trust it.
        Map map = mojo.addExclusions( list );
        
        List l = mojo.getExclusionErrors( map, mojo.getProject().getArtifacts() );
        
        assertEquals( 1, l.size() );
        
        assertEquals( exclusion.getManagementKey(), mojo.getArtifactManagementKey( (Artifact) l.get( 0 ) ));
    }

    public void testGetMismatch() throws IOException
    {
        Map depMgtMap = new HashMap();

        depMgtMap.put( exclusion.getManagementKey(), exclusion );
        
        Map results = mojo.getMismatch( depMgtMap, mojo.getProject().getArtifacts() );
        
        assertEquals( 1, results.size() );
        //the release artifact is used to create the exclusion
        assertTrue( results.containsKey( stubFactory.getReleaseArtifact()));
        assertSame( exclusion,results.get( stubFactory.getReleaseArtifact()));
    }
    
    public void testMojo()
    {
        try
        {
            mojo.execute();
        }
        catch ( Exception e )
        {
            fail("Caught Unexpected Exception:"+e.getLocalizedMessage());
        }
    }
}