maven-scm-providers/maven-scm-providers-git/maven-scm-provider-gitexe/src/test/java/org/apache/maven/scm/provider/git/gitexe/command/blame/GitBlameConsumerTest.java

package org.apache.maven.scm.provider.git.gitexe.command.blame;

/*
 * 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 junit.framework.Assert;
import org.apache.maven.scm.command.blame.BlameLine;
import org.apache.maven.scm.log.DefaultLog;
import org.apache.maven.scm.util.ConsumerUtils;
import org.codehaus.plexus.PlexusTestCase;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Iterator;
import java.util.List;
import java.util.TimeZone;

/**
 * Test the {@link GitBlameConsumer} in various different situations.
 * Depending on the underlying operating system we might get
 * slightly different output from a <pre>git blame</pre> commandline invocation.
 */
public class GitBlameConsumerTest
    extends PlexusTestCase
{
    public void testConsumerEasy()
        throws Exception
    {
        GitBlameConsumer consumer = consumeFile( "/src/test/resources/git/blame/git-blame-3.out" );

        Assert.assertEquals( 36, consumer.getLines().size() );

        BlameLine blameLine = consumer.getLines().get( 11 );
        Assert.assertEquals( "e670863b2b03e158c59f34af1fee20f91b2bd852", blameLine.getRevision() );
        Assert.assertEquals( "Mark Struberg", blameLine.getAuthor() );
        Assert.assertNotNull( blameLine.getDate() );
    }

    public void testConsumer()
        throws Exception
    {
        GitBlameConsumer consumer = consumeFile( "/src/test/resources/git/blame/git-blame.out" );

        Assert.assertEquals( 187, consumer.getLines().size() );

        BlameLine blameLine = consumer.getLines().get( 11 );
        Assert.assertEquals( "e670863b2b03e158c59f34af1fee20f91b2bd852", blameLine.getRevision() );
        Assert.assertEquals( "Mark Struberg", blameLine.getAuthor() );
        Assert.assertNotNull( blameLine.getDate() );
    }

    /**
     * Test what happens if a git-blame command got invoked on a
     * file which has no content.
     */
    public void testConsumerEmptyFile()
        throws Exception
    {
        GitBlameConsumer consumer = consumeFile( "/src/test/resources/git/blame/git-blame-empty.out" );

        Assert.assertEquals( 0, consumer.getLines().size() );
    }

    /**
     * Test what happens if a git-blame command got invoked on a
     * file which didn't got added to the git repo yet.
     */
    public void testConsumerOnNewFile()
        throws Exception
    {
        GitBlameConsumer consumer = consumeFile( "/src/test/resources/git/blame/git-blame-new-file.out" );

        Assert.assertEquals( 3, consumer.getLines().size() );
        BlameLine blameLine = consumer.getLines().get( 0 );
        Assert.assertNotNull( blameLine );
        Assert.assertEquals( "0000000000000000000000000000000000000000", blameLine.getRevision() );
        Assert.assertEquals( "Not Committed Yet", blameLine.getAuthor() );
    }

    /**
     * Test a case where the committer and author are different persons
     */
    public void testConsumerWithDifferentAuthor()
        throws Exception
    {
        GitBlameConsumer consumer = consumeFile( "/src/test/resources/git/blame/git-blame-different-author.out" );

        Assert.assertEquals( 93, consumer.getLines().size() );
        BlameLine blameLine = consumer.getLines().get( 0 );
        Assert.assertNotNull( blameLine );
        Assert.assertEquals( "39574726d20f62023d39311e6032c7ab0a9d3cdb", blameLine.getRevision() );
        Assert.assertEquals( "Mark Struberg", blameLine.getAuthor() );
        Assert.assertEquals( "Mark Struberg", blameLine.getCommitter() );

        blameLine = consumer.getLines().get( 12 );
        Assert.assertNotNull( blameLine );
        Assert.assertEquals( "41e5bc05953781a5702f597a1a36c55371b517d3", blameLine.getRevision() );
        Assert.assertEquals( "Another User", blameLine.getAuthor() );
        Assert.assertEquals( "Mark Struberg", blameLine.getCommitter() );
    }

    /**
     * This unit test compares the output of our new parsing with a
     * simplified git blame output.
     */
    public void testConsumerCompareWithOriginal() throws Exception
    {
        GitBlameConsumer consumer = consumeFile( "/src/test/resources/git/blame/git-blame-2.out" );
        Assert.assertNotNull( consumer );

        List<BlameLine> consumerLines = consumer.getLines();
        Iterator<BlameLine> consumerLineIt = consumerLines.iterator();

        File compareWithFile = getTestFile( "/src/test/resources/git/blame/git-blame-2.orig" );
        Assert.assertNotNull( compareWithFile );

        try ( BufferedReader r = new BufferedReader( new FileReader( compareWithFile ) ) )
        {
            String line;
            SimpleDateFormat blameDateFormat = new SimpleDateFormat( "yyyy-MM-dd HH:mm:ss" );
            blameDateFormat.setTimeZone( TimeZone.getTimeZone( "GMT" ) );
    
            int lineNr = 0;
    
            while ( ( line = r.readLine() ) != null && line.trim().length() > 0 )
            {
                if ( !consumerLineIt.hasNext() )
                {
                    fail( "GitBlameConsumer lines do not match the original output!" );
                }
                BlameLine blameLine = consumerLineIt.next();
                Assert.assertNotNull( blameLine );
    
                String[] parts = line.split( "\t" );
                Assert.assertEquals( 3, parts.length );
    
                Assert.assertEquals( "error in line " + lineNr, parts[0], blameLine.getRevision() );
                Assert.assertEquals( "error in line " + lineNr, parts[1], blameLine.getAuthor() );
                Assert.assertEquals( "error in line " + lineNr, parts[2],
                                     blameDateFormat.format( blameLine.getDate() ) );
    
                lineNr++;
            }
        }

        if ( consumerLineIt.hasNext() )
        {
            fail( "GitBlameConsumer found more lines than in the original output!" );
        }

    }

    /**
     * Consume all lines in the given file with a fresh {@link GitBlameConsumer}.
     *
     * @param fileName
     * @return the resulting {@link GitBlameConsumer}
     * @throws IOException
     */
    private GitBlameConsumer consumeFile( String fileName ) throws IOException
    {
        GitBlameConsumer consumer = new GitBlameConsumer( new DefaultLog() );

        File f = getTestFile( fileName );

        ConsumerUtils.consumeFile( f, consumer );

        return consumer;
    }

}