You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm-commits@maven.apache.org by br...@apache.org on 2005/01/10 12:56:23 UTC

cvs commit: maven-scm/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/diff DiffCommandTckTest.java

brett       2005/01/10 03:56:23

  Added:       maven-scm-providers/maven-scm-provider-svn/src/main/java/org/apache/maven/scm/provider/svn/command/diff
                        SvnDiffCommand.java SvnDiffConsumer.java
               maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/diff
                        DiffCommandTckTest.java
  Log:
  add diff skeleton
  
  Revision  Changes    Path
  1.1                  maven-scm/maven-scm-providers/maven-scm-provider-svn/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffCommand.java
  
  Index: SvnDiffCommand.java
  ===================================================================
  package org.apache.maven.scm.provider.svn.command.diff;
  
  /*
   * Copyright 2003-2004 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 org.apache.maven.scm.ScmException;
  import org.apache.maven.scm.ScmFileSet;
  import org.apache.maven.scm.command.diff.AbstractDiffCommand;
  import org.apache.maven.scm.command.diff.DiffScmResult;
  import org.apache.maven.scm.provider.ScmProviderRepository;
  import org.apache.maven.scm.provider.svn.command.SvnCommand;
  import org.apache.maven.scm.provider.svn.repository.SvnScmProviderRepository;
  import org.codehaus.plexus.util.cli.CommandLineException;
  import org.codehaus.plexus.util.cli.CommandLineUtils;
  import org.codehaus.plexus.util.cli.Commandline;
  
  import java.io.File;
  
  /**
   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
   * @version $Id: SvnDiffCommand.java,v 1.1 2005/01/10 11:56:23 brett Exp $
   */
  public class SvnDiffCommand
      extends AbstractDiffCommand
      implements SvnCommand
  {
      protected DiffScmResult executeDiffCommand( ScmProviderRepository repo, ScmFileSet fileSet, String startRevision, String endRevision )
          throws ScmException
      {
          Commandline cl = createCommandLine( (SvnScmProviderRepository) repo, fileSet.getBasedir(), startRevision, endRevision );
  
          SvnDiffConsumer consumer = new SvnDiffConsumer( getLogger(), fileSet.getBasedir() );
  
          CommandLineUtils.StringStreamConsumer stderr = new CommandLineUtils.StringStreamConsumer();
  
          getLogger().info( "Executing: " + cl );
          getLogger().info( "Working directory: " + cl.getWorkingDirectory().getAbsolutePath() );
  
          int exitCode;
  
          try
          {
              exitCode = CommandLineUtils.executeCommandLine( cl, consumer, stderr );
          }
          catch ( CommandLineException ex )
          {
              throw new ScmException( "Error while executing command.", ex );
          }
  
          if ( exitCode != 0 )
          {
              return new DiffScmResult( "The svn command failed.", stderr.getOutput(), false );
          }
  
          // TODO: pass back files
          return new DiffScmResult( "out", "err", true );
      }
  
      // ----------------------------------------------------------------------
      //
      // ----------------------------------------------------------------------
  
      public static Commandline createCommandLine( SvnScmProviderRepository repository, File workingDirectory, String startRevision, String endRevision )
      {
          Commandline cl = new Commandline();
  
          cl.setExecutable( "svn" );
  
          cl.setWorkingDirectory( workingDirectory.getAbsolutePath() );
  
          cl.createArgument().setValue( "diff" );
  
          cl.createArgument().setValue( "--non-interactive" );
  
          // TODO: revisions
  
          if ( repository.getUser() != null )
          {
              cl.createArgument().setValue( "--username" );
  
              cl.createArgument().setValue( repository.getUser() );
          }
  
          if ( repository.getPassword() != null )
          {
              cl.createArgument().setValue( "--password" );
  
              cl.createArgument().setValue( repository.getPassword() );
          }
  
          return cl;
      }
  }
  
  
  
  1.1                  maven-scm/maven-scm-providers/maven-scm-provider-svn/src/main/java/org/apache/maven/scm/provider/svn/command/diff/SvnDiffConsumer.java
  
  Index: SvnDiffConsumer.java
  ===================================================================
  package org.apache.maven.scm.provider.svn.command.diff;
  
  /*
   * Copyright 2003-2004 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 org.apache.maven.scm.ScmFile;
  import org.apache.maven.scm.ScmFileStatus;
  import org.codehaus.plexus.logging.Logger;
  import org.codehaus.plexus.util.cli.StreamConsumer;
  
  import java.io.File;
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
   * @version $Id: SvnDiffConsumer.java,v 1.1 2005/01/10 11:56:23 brett Exp $
   */
  public class SvnDiffConsumer
      implements StreamConsumer
  {
      private final static String UPDATED_TO_REVISION_TOKEN = "Updated to revision";
  
      private final static String AT_REVISION_TOKEN = "At revision";
  
      private Logger logger;
  
      private File workingDirectory;
  
      // ----------------------------------------------------------------------
      //
      // ----------------------------------------------------------------------
  
      public SvnDiffConsumer( Logger logger, File workingDirectory )
      {
          this.logger = logger;
  
          this.workingDirectory = workingDirectory;
      }
  
      // ----------------------------------------------------------------------
      // StreamConsumer Implementation
      // ----------------------------------------------------------------------
  
      public void consumeLine( String line )
      {
          if ( line.length() <= 3 )
          {
              logger.warn( "Unexpected input, the line must be at least three characters long. Line: '" + line + "'." );
  
              return;
          }
  
          // TODO: implement
      }
  
      // ----------------------------------------------------------------------
      //
      // ----------------------------------------------------------------------
  
      private int parseInt( String revisionString )
      {
          try
          {
              return Integer.parseInt( revisionString );
          }
          catch ( NumberFormatException ex )
          {
              return 0;
          }
      }
  }
  
  
  
  1.1                  maven-scm/maven-scm-test/src/main/java/org/apache/maven/scm/tck/command/diff/DiffCommandTckTest.java
  
  Index: DiffCommandTckTest.java
  ===================================================================
  package org.apache.maven.scm.tck.command.diff;
  
  /*
   * Copyright 2001-2004 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 org.apache.maven.scm.ScmFile;
  import org.apache.maven.scm.ScmFileSet;
  import org.apache.maven.scm.ScmFileStatus;
  import org.apache.maven.scm.ScmTestCase;
  import org.apache.maven.scm.manager.ScmManager;
  import org.apache.maven.scm.repository.ScmRepository;
  import org.codehaus.plexus.PlexusTestCase;
  import org.codehaus.plexus.util.FileUtils;
  
  import java.io.File;
  import java.util.Iterator;
  import java.util.List;
  import java.util.TreeSet;
  
  /**
   * This test tests the diff command.
   *
   * @author <a href="mailto:brett@apache.org">Brett Porter</a>
   * @version $Id: DiffCommandTckTest.java,v 1.1 2005/01/10 11:56:23 brett Exp $
   */
  public abstract class DiffCommandTckTest
  	extends ScmTestCase
  {
      // ----------------------------------------------------------------------
      // Methods the test has to implement
      // ----------------------------------------------------------------------
  
      public abstract String getScmUrl()
      	throws Exception;
  
      /**
       * Copy the existing checked in repository to the working directory.
       *
       * (src/test/repository/my-cvs-repository)
       *
       * @throws Exception
       */
      public abstract void initRepo()
  		throws Exception;
  
  /* TODO: implement
      private void checkOut( File workingDirectory, ScmRepository repository )
          throws Exception
      {
          CheckOutScmResult result = getScmManager().checkOut( repository, new ScmFileSet( workingDirectory ), null );
          assertTrue( "Check result was successful, output: " + result.getCommandOutput(), result.isSuccess() );
      }
  
      private void addToRepository( File workingDirectory, File file, ScmRepository repository )
          throws Exception
      {
          AddScmResult result = getScmManager().add( repository, new ScmFileSet( workingDirectory, file ) );
          assertTrue( "Check result was successful, output: " + result.getCommandOutput(), result.isSuccess() );
  
          List addedFiles = result.getAddedFiles();
  
          assertEquals( "Expected 1 files in the added files list " + addedFiles, 1, addedFiles.size() );
      }
  
      private void commit( File workingDirectory, ScmRepository repository )
  		throws Exception
      {
          CheckInScmResult result = getScmManager().checkIn( repository, new ScmFileSet( workingDirectory ), null, "No msg" );
          assertTrue( "Check result was successful, output: " + result.getCommandOutput(), result.isSuccess() );
  
          List committedFiles = result.getCheckedInFiles();
  
          assertEquals( "Expected 3 files in the committed files list " + committedFiles, 3, committedFiles.size() );
      }
  
      // ----------------------------------------------------------------------
      // Directories the test must use
      // ----------------------------------------------------------------------
  
      protected File getRepositoryRoot()
      {
          return PlexusTestCase.getTestFile( "target/scm-test/repository" );
      }
  
      protected File getWorkingCopy()
      {
          return PlexusTestCase.getTestFile( "target/scm-test/working-copy" );
      }
  
      protected File getUpdatingCopy()
      {
          return PlexusTestCase.getTestFile( "target/scm-test/updating-copy" );
      }
  
      // ----------------------------------------------------------------------
      // The test implementation
      // ----------------------------------------------------------------------
  
      public void setUp()
      	throws Exception
      {
          super.setUp();
  
          FileUtils.deleteDirectory( getRepositoryRoot() );
  
          FileUtils.deleteDirectory( getWorkingCopy() );
  
          FileUtils.deleteDirectory( getUpdatingCopy() );
  
          initRepo();
      }
  
      public void testUpdateCommand()
      	throws Exception
      {
          ScmRepository repository = makeScmRepository( getScmUrl() );
  
          checkOut( getWorkingCopy(), repository );
  
          checkOut( getUpdatingCopy(), repository );
  
          // ----------------------------------------------------------------------
          // Assert that the required files is there
          // ----------------------------------------------------------------------
  
          assertFile( getWorkingCopy(), "/pom.xml" );
  
          assertFile( getWorkingCopy(), "/readme.txt" );
  
          assertFile( getWorkingCopy(), "/src/main/java/Application.java" );
  
          assertFile( getWorkingCopy(), "/src/test/java/Test.java" );
  
          // ----------------------------------------------------------------------
          // Change the files
          // ----------------------------------------------------------------------
  
          //
          // readme.txt is changed (changed file in the root directory)
          // project.xml is added (added file in the root directory)
          // src/test/resources is untouched (a empty directory is left untouched)
          // src/test/java is untouched (a non empty directory is left untouched)
          // src/test/java/org (a empty directory is added)
          // src/main/java/org/Foo.java (a non empty directory is added)
          //
  
          // /readme.txt
          ScmTestCase.makeFile( getWorkingCopy(), "/readme.txt", "changed readme.txt" );
  
          // /project.xml
          ScmTestCase.makeFile( getWorkingCopy(), "/project.xml", "changed project.xml" );
  
          addToRepository( getWorkingCopy(), new File( "project.xml" ), repository );
  
          // /src/test/java/org
          ScmTestCase.makeDirectory( getWorkingCopy(), "/src/test/java/org" );
  
          addToRepository( getWorkingCopy(), new File( "src/test/java/org" ), repository );
  
          // /src/main/java/org/Foo.java
          ScmTestCase.makeFile( getWorkingCopy(), "/src/main/java/org/Foo.java" );
  
          addToRepository( getWorkingCopy(), new File( "src/main/java/org" ), repository );
  
          // src/main/java/org/Foo.java
          addToRepository( getWorkingCopy(), new File( "src/main/java/org/Foo.java" ), repository );
  
          ScmManager scmManager = getScmManager();
  
          commit( getWorkingCopy(), repository );
  
          // ----------------------------------------------------------------------
          // Update the project
          // ----------------------------------------------------------------------
  
          UpdateScmResult result = scmManager.update( repository, new ScmFileSet( getUpdatingCopy() ), null );
  
          assertNotNull( "The command returned a null result.", result );
  
          assertResultIsSuccess( result );
  
          assertNull( "The provider message wasn't null", result.getProviderMessage() );
  
          assertNull( "The command output wasn't null", result.getCommandOutput() );
  
          List updatedFiles = result.getUpdatedFiles();
  
          assertEquals( "Expected 3 files in the updated files list " + updatedFiles, 3, updatedFiles.size() );
  
          // ----------------------------------------------------------------------
          // Assert the files in the updated files list
          // ----------------------------------------------------------------------
  
          Iterator files = new TreeSet( updatedFiles ).iterator();
  
          ScmFile file = (ScmFile) files.next();
  
          assertPath( "/src/main/java/org/Foo.java", file.getPath() );
  
          // Need to accommodate CVS' weirdness. TODO: Should the API hide this somehow?
          //assertEquals( ScmFileStatus.ADDED, file.getStatus() );
          assertTrue( ScmFileStatus.ADDED.equals( file.getStatus() ) || ScmFileStatus.UPDATED.equals( file.getStatus() ) );
  
          file = (ScmFile) files.next();
  
          assertPath( "/readme.txt", file.getPath() );
  
          //assertEquals( ScmFileStatus.UPDATED, file.getStatus() );
          assertTrue( ScmFileStatus.PATCHED.equals( file.getStatus() ) || ScmFileStatus.UPDATED.equals( file.getStatus() ) );
  
          file = (ScmFile) files.next();
  
          assertPath( "/project.xml", file.getPath() );
  
          //assertEquals( ScmFileStatus.ADDED, file.getStatus() );
          assertTrue( ScmFileStatus.ADDED.equals( file.getStatus() ) || ScmFileStatus.UPDATED.equals( file.getStatus() ) );
      }
  
      // ----------------------------------------------------------------------
      // Assertions
      // ----------------------------------------------------------------------
  
      private void assertFile( File root, String fileName )
      	throws Exception
      {
          File file = new File( root, fileName );
  
          assertTrue( "Missing file: '" + file.getAbsolutePath() + "'.", file.exists() );
  
          assertTrue( "File isn't a file: '" + file.getAbsolutePath() + "'.", file.isFile() );
  
          String expected = fileName;
  
          String actual = FileUtils.fileRead( file );
  
          assertEquals( "The file doesn't contain the expected contents. File: " + file.getAbsolutePath(), expected, actual );
      }
  */
  }