001package org.apache.maven.scm.tck.command.update;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.File;
023import java.util.Date;
024import java.util.Iterator;
025import java.util.List;
026import java.util.TreeSet;
027
028import org.apache.maven.scm.ChangeSet;
029import org.apache.maven.scm.ScmFile;
030import org.apache.maven.scm.ScmFileSet;
031import org.apache.maven.scm.ScmFileStatus;
032import org.apache.maven.scm.ScmTckTestCase;
033import org.apache.maven.scm.ScmTestCase;
034import org.apache.maven.scm.command.checkin.CheckInScmResult;
035import org.apache.maven.scm.command.update.UpdateScmResult;
036import org.apache.maven.scm.manager.ScmManager;
037import org.apache.maven.scm.repository.ScmRepository;
038import org.codehaus.plexus.util.StringUtils;
039
040/**
041 * This test tests the update command.
042 * <p/>
043 * It works like this:
044 * <p/>
045 * <ol>
046 * <li>Check out the files to directory getWorkingCopy().
047 * <li>Check out the files to directory getUpdatingCopy().
048 * <li>Change the files in getWorkingCopy().
049 * <li>Commit the files in getWorkingCopy(). Note that the provider <b>must</b> not
050 * use the check in command as it can be guaranteed to work as it's not yet tested.
051 * <li>Use the update command in getUpdatingCopy() to assert that the files
052 * that was supposed to be updated actually was updated.
053 * </ol>
054 *
055 * @author <a href="mailto:trygvis@inamo.no">Trygve Laugst&oslash;l</a>
056 *
057 */
058public abstract class UpdateCommandTckTest
059    extends ScmTckTestCase
060{
061
062    private void commit( File workingDirectory, ScmRepository repository )
063        throws Exception
064    {
065        CheckInScmResult result = getScmManager().checkIn( repository, new ScmFileSet( workingDirectory ), "No msg" );
066
067        assertTrue( "Check result was successful, output: " + result.getCommandOutput(), result.isSuccess() );
068
069        List<ScmFile> committedFiles = result.getCheckedInFiles();
070
071        assertEquals(
072            "Expected 3 files in the committed files list:\n  " + StringUtils.join( committedFiles.iterator(), "\n  " ),
073            3, committedFiles.size() );
074    }
075
076    public void testUpdateCommand()
077        throws Exception
078    {
079        
080        deleteDirectory( getUpdatingCopy() );
081        
082        assertFalse( getUpdatingCopy().exists() );    
083        
084        //deleteDirectory( getWorkingCopy() );
085        
086        //assertFalse( getUpdatingCopy().exists() );
087        
088        ScmRepository repository = makeScmRepository( getScmUrl() );
089
090        checkOut( getUpdatingCopy(), repository );
091
092        // ----------------------------------------------------------------------
093        // Change the files
094        // ----------------------------------------------------------------------
095
096        /*
097         * readme.txt is changed (changed file in the root directory)
098         * project.xml is added (added file in the root directory)
099         * src/test/resources is untouched (a empty directory is left untouched)
100         * src/test/java is untouched (a non empty directory is left untouched)
101         * src/test/java/org (a empty directory is added)
102         * src/main/java/org/Foo.java (a non empty directory is added)
103         */
104
105        // /readme.txt
106        ScmTestCase.makeFile( getWorkingCopy(), "/readme.txt", "changed readme.txt" );
107
108        // /project.xml
109        ScmTestCase.makeFile( getWorkingCopy(), "/project.xml", "changed project.xml" );
110
111        addToWorkingTree( getWorkingCopy(), new File( "project.xml" ), repository );
112
113        // /src/test/java/org
114        ScmTestCase.makeDirectory( getWorkingCopy(), "/src/test/java/org" );
115
116        addToWorkingTree( getWorkingCopy(), new File( "src/test/java/org" ), repository );
117
118        // /src/main/java/org/Foo.java
119        ScmTestCase.makeFile( getWorkingCopy(), "/src/main/java/org/Foo.java" );
120
121        addToWorkingTree( getWorkingCopy(), new File( "src/main/java/org" ), repository );
122
123        // src/main/java/org/Foo.java
124        addToWorkingTree( getWorkingCopy(), new File( "src/main/java/org/Foo.java" ), repository );
125
126        ScmManager scmManager = getScmManager();
127
128        Date lastUpdate = new Date( System.currentTimeMillis() - 1000000 );
129
130        commit( getWorkingCopy(), repository );
131
132        Thread.sleep( 5000 );
133        
134        // ----------------------------------------------------------------------
135        // Update the project
136        // ----------------------------------------------------------------------
137       
138        UpdateScmResult result = scmManager.update( repository, new ScmFileSet( getUpdatingCopy() ), lastUpdate );
139
140        assertNotNull( "The command returned a null result.", result );
141
142        assertResultIsSuccess( result );
143
144        List<ScmFile> updatedFiles = result.getUpdatedFiles();
145
146        List<ChangeSet> changedSets = result.getChanges();
147
148        assertEquals( "Expected 3 files in the updated files list " + updatedFiles, 3, updatedFiles.size() );
149
150        assertNotNull( "The changed files list is null", changedSets );
151
152        assertFalse( "The changed files list is empty ", changedSets.isEmpty() );
153
154        for ( ChangeSet changeSet : changedSets )
155        {
156            System.out.println( changeSet.toXML() );
157        }
158
159        // ----------------------------------------------------------------------
160        // Assert the files in the updated files list
161        // ----------------------------------------------------------------------
162
163        Iterator<ScmFile> files = new TreeSet<ScmFile>( updatedFiles ).iterator();
164
165        //Foo.java
166        ScmFile file = files.next();
167        assertPath( "/src/main/java/org/Foo.java", file.getPath() );
168        //TODO : Consolidate file status so that we can remove "|| ADDED" term
169        assertTrue( file.getStatus().isUpdate() || file.getStatus() == ScmFileStatus.ADDED );
170
171        //readme.txt
172        file = files.next();
173        assertPath( "/readme.txt", file.getPath() );
174        assertTrue( file.getStatus().isUpdate() );
175
176        //project.xml
177        file = files.next();
178        assertPath( "/project.xml", file.getPath() );
179        //TODO : Consolidate file status so that we can remove "|| ADDED" term
180        assertTrue( file.getStatus().isUpdate() || file.getStatus() == ScmFileStatus.ADDED );
181    }
182    
183}