core-integration-tests/src/test/java/org/apache/maven/integrationtests/MavenIT0108SnapshotUpdateTest.java

package org.apache.maven.integrationtests;

/*
 * Copyright 2004-2006 The Apache Software Foundation.
 *
 * Licensed 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.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.Locale;

import org.apache.maven.it.IntegrationTestRunner;
import org.codehaus.plexus.util.FileUtils;

/**
 * Downloads a snapshot dependency that was deployed with uniqueVersion = false, and checks it can be
 * updated. See MNG-1908.
 */
public class MavenIT0108SnapshotUpdateTest
    extends AbstractMavenIntegrationTestCase
{
    private IntegrationTestRunner itr;

    private File artifact;

    private File repository;

    private File localRepoFile;

    private static final int TIME_OFFSET = 50000;

    protected void setUp()
        throws Exception
    {
        super.setUp();

        File testDir = extractTestResources( getClass(), "/it0108-snapshotUpdate" );
        itr = new IntegrationTestRunner( testDir.getAbsolutePath() );
        localRepoFile = getLocalRepoFile( itr );
        deleteLocalArtifact( itr, localRepoFile );

        repository = new File( testDir, "repository" );
        recreateRemoteRepository( repository );

        // create artifact in repository (TODO: into itr)
        artifact = new File( repository,
                             "org/apache/maven/maven-core-it-support/1.0-SNAPSHOT/maven-core-it-support-1.0-SNAPSHOT.jar" );
        artifact.getParentFile().mkdirs();
        FileUtils.fileWrite( artifact.getAbsolutePath(), "originalArtifact" );

        itr.assertArtifactNotPresent( "org.apache.maven", "maven-core-it-support", "1.0-SNAPSHOT", "jar" );
    }

    public void testSnapshotUpdated()
        throws Exception
    {
        itr.executeGoal( "package" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();

        assertArtifactContents( "originalArtifact" );

        // set in the past to ensure it is downloaded
        localRepoFile.setLastModified( System.currentTimeMillis() - TIME_OFFSET );

        FileUtils.fileWrite( artifact.getAbsolutePath(), "updatedArtifact" );

        itr.executeGoal( "package" );

        assertArtifactContents( "updatedArtifact" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();
    }

    public void testSnapshotUpdatedWithMetadata()
        throws Exception
    {
        File metadata =
            new File( repository, "org/apache/maven/maven-core-it-support/1.0-SNAPSHOT/maven-metadata.xml" );
        FileUtils.fileWrite( metadata.getAbsolutePath(),
                             constructMetadata( "1", System.currentTimeMillis() - TIME_OFFSET, true ) );

        itr.executeGoal( "package" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();

        assertArtifactContents( "originalArtifact" );

        FileUtils.fileWrite( artifact.getAbsolutePath(), "updatedArtifact" );
        metadata = new File( repository, "org/apache/maven/maven-core-it-support/1.0-SNAPSHOT/maven-metadata.xml" );
        FileUtils.fileWrite( metadata.getAbsolutePath(), constructMetadata( "2", System.currentTimeMillis(), true ) );

        itr.executeGoal( "package" );

        assertArtifactContents( "updatedArtifact" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();
    }

    public void testSnapshotUpdatedWithLocalMetadata()
        throws Exception
    {
        File localMetadata = getMetadataFile( "org/apache/maven", "maven-core-it-support", "1.0-SNAPSHOT" );

        FileUtils.deleteDirectory( localMetadata.getParentFile() );
        assertFalse( localMetadata.getParentFile().exists() );
        localMetadata.getParentFile().mkdirs();

        File metadata =
            new File( repository, "org/apache/maven/maven-core-it-support/1.0-SNAPSHOT/maven-metadata.xml" );
        FileUtils.fileWrite( metadata.getAbsolutePath(),
                             constructMetadata( "1", System.currentTimeMillis() - TIME_OFFSET, true ) );

        itr.executeGoal( "package" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();

        assertArtifactContents( "originalArtifact" );
        assertFalse( localMetadata.exists() );

        FileUtils.fileWrite( localRepoFile.getAbsolutePath(), "localArtifact" );
        FileUtils.fileWrite( localMetadata.getAbsolutePath(), constructLocalMetadata( "org.apache.maven",
                                                                                      "maven-core-it-support",
                                                                                      System.currentTimeMillis(),
                                                                                      true ) );
        // update the remote file, but we shouldn't be looking
        artifact.setLastModified( System.currentTimeMillis() );

        itr.executeGoal( "package" );

        assertArtifactContents( "localArtifact" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();

        Calendar cal = Calendar.getInstance();
        cal.add( Calendar.YEAR, -1 );
        FileUtils.fileWrite( localMetadata.getAbsolutePath(), constructLocalMetadata( "org.apache.maven",
                                                                                      "maven-core-it-support",
                                                                                      cal.getTimeInMillis(), true ) );
        FileUtils.fileWrite( metadata.getAbsolutePath(),
                             constructMetadata( "2", System.currentTimeMillis() - 2000, true ) );
        artifact.setLastModified( System.currentTimeMillis() );

        itr.executeGoal( "package" );

        assertArtifactContents( "originalArtifact" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();
    }

    public void testSnapshotUpdatedWithMetadataUsingFileTimestamp()
        throws Exception
    {
        File metadata =
            new File( repository, "org/apache/maven/maven-core-it-support/1.0-SNAPSHOT/maven-metadata.xml" );
        FileUtils.fileWrite( metadata.getAbsolutePath(),
                             constructMetadata( "1", System.currentTimeMillis() - TIME_OFFSET, false ) );
        metadata.setLastModified( System.currentTimeMillis() - TIME_OFFSET );

        itr.executeGoal( "package" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();

        assertArtifactContents( "originalArtifact" );

        FileUtils.fileWrite( artifact.getAbsolutePath(), "updatedArtifact" );
        metadata = new File( repository, "org/apache/maven/maven-core-it-support/1.0-SNAPSHOT/maven-metadata.xml" );
        FileUtils.fileWrite( metadata.getAbsolutePath(), constructMetadata( "2", System.currentTimeMillis(), false ) );

        itr.executeGoal( "package" );

        assertArtifactContents( "updatedArtifact" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();
    }

    public void testSnapshotLocalMetadataUpdatedOnInstall()
        throws Exception
    {
        File localMetadata =
            getMetadataFile( "org/apache/maven/its/snapshotUpdate", "maven-it-snapshot-update", "1.0-SNAPSHOT" );

        localMetadata.delete();
        assertFalse( localMetadata.exists() );

        itr.executeGoal( "install" );

        itr.verifyErrorFreeLog();
        itr.resetStreams();

        assertLocalMetadataIsToday( localMetadata );

        Calendar cal = Calendar.getInstance();
        cal.add( Calendar.YEAR, -1 );
        FileUtils.fileWrite( localMetadata.getAbsolutePath(), constructLocalMetadata(
            "org.apache.maven.its.snapshotUpdate", "maven-it-snapshot-update", cal.getTimeInMillis(), true ) );

        itr.executeGoal( "install" );

        assertLocalMetadataIsToday( localMetadata );

        itr.verifyErrorFreeLog();
        itr.resetStreams();
    }

    private File getMetadataFile( String groupId, String artifactId, String version )
    {
        return new File( itr.localRepo, groupId + "/" + artifactId + "/" + version + "/maven-metadata-local.xml" );
    }

    private void assertLocalMetadataIsToday( File localMetadata )
        throws IOException
    {
        String actual = stripTime( FileUtils.fileRead( localMetadata ) );
        String expected = stripTime( constructLocalMetadata( "org.apache.maven.its.snapshotUpdate",
                                                             "maven-it-snapshot-update", System.currentTimeMillis(),
                                                             true ) );

        assertEquals( expected, actual );
    }

    private static String stripTime( String s )
    {
        return s.replaceAll( "(.*)[0-9]{6}(</lastUpdated>.*)", "$1$2" );
    }

    private void assertArtifactContents( String s )
        throws IOException
    {
        itr.assertArtifactPresent( "org.apache.maven", "maven-core-it-support", "1.0-SNAPSHOT", "jar" );
        itr.assertArtifactContents( "org.apache.maven", "maven-core-it-support", "1.0-SNAPSHOT", "jar", s );
    }

    private static File deleteLocalArtifact( IntegrationTestRunner itr, File localRepoFile )
        throws IOException
    {
        itr.deleteArtifact( "org.apache.maven", "maven-core-it-support", "1.0-SNAPSHOT", "jar" );
        // this is to delete metadata - TODO: incorporate into deleteArtifact in itr
        FileUtils.deleteDirectory( localRepoFile.getParentFile() );
        return localRepoFile;
    }

    private static File getLocalRepoFile( IntegrationTestRunner itr )
    {
        return new File(
            itr.getArtifactPath( "org.apache.maven", "maven-core-it-support", "1.0-SNAPSHOT", "jar" ) );
    }

    private static void recreateRemoteRepository( File repository )
        throws IOException
    {
        // create a repository (TODO: into itr)
        FileUtils.deleteDirectory( repository );
        assertFalse( repository.exists() );
        repository.mkdirs();
    }

    private String constructMetadata( String buildNumber, long timestamp, boolean writeLastUpdated )
    {
        String ts = new SimpleDateFormat( "yyyyMMddHHmmss", Locale.US ).format( new Date( timestamp ) );

        return "<?xml version=\"1.0\" encoding=\"UTF-8\"?><metadata>\n" + "<groupId>org.apache.maven</groupId>\n" +
            "<artifactId>maven-core-it-support</artifactId>\n" + "<version>1.0-SNAPSHOT</version>\n" +
            "<versioning>\n" + "<snapshot>\n" + "<buildNumber>" + buildNumber + "</buildNumber>\n" + "</snapshot>\n" +
            ( writeLastUpdated ? "<lastUpdated>" + ts + "</lastUpdated>\n" : "" ) + "</versioning>\n" + "</metadata>";
    }

    private String constructLocalMetadata( String groupId, String artifactId, long timestamp, boolean writeLastUpdated )
    {
        String ts = new SimpleDateFormat( "yyyyMMddHHmmss", Locale.US ).format( new Date( timestamp ) );

        return "<?xml version=\"1.0\" encoding=\"UTF-8\"?><metadata>\n" + "  <groupId>" + groupId + "</groupId>\n" +
            "  <artifactId>" + artifactId + "</artifactId>\n" + "  <version>1.0-SNAPSHOT</version>\n" +
            "  <versioning>\n" + "    <snapshot>\n" + "      <localCopy>true</localCopy>\n" + "    </snapshot>\n" +
            ( writeLastUpdated ? "    <lastUpdated>" + ts + "</lastUpdated>\n" : "" ) + "  </versioning>\n" +
            "</metadata>";
    }
}