You are viewing a plain text version of this content. The canonical link for it is here.
Posted to wagon-commits@maven.apache.org by br...@apache.org on 2005/10/10 09:18:29 UTC
svn commit: r312572 - in /maven/wagon/trunk: ./
wagon-provider-api/src/main/java/org/apache/maven/wagon/
wagon-provider-api/src/main/java/org/apache/maven/wagon/resource/
wagon-provider-test/
wagon-provider-test/src/main/java/org/apache/maven/wagon/ wa...
Author: brett
Date: Mon Oct 10 00:17:58 2005
New Revision: 312572
URL: http://svn.apache.org/viewcvs?rev=312572&view=rev
Log:
big wagon update:
- rewrite the ssh/scp wagons to do proper error handling and be more accurate in following protocol
- add a test for "file not found" style exceptions
- update to latest plexus-utils
- restore original names of SSH tests, but exclude from POM
Added:
maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/CommandExecutionException.java (with props)
maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTest.java
- copied, changed from r312529, maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTestDisabled.java
maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTest.java
- copied, changed from r312529, maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTestDisabled.java
maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTest.java
- copied, changed from r312529, maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTestDisabled.java
maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutorTest.java (with props)
Removed:
maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTestDisabled.java
maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTestDisabled.java
maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTestDisabled.java
Modified:
maven/wagon/trunk/pom.xml
maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/AbstractWagon.java
maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/resource/Resource.java
maven/wagon/trunk/wagon-provider-test/pom.xml
maven/wagon/trunk/wagon-provider-test/src/main/java/org/apache/maven/wagon/WagonTestCase.java
maven/wagon/trunk/wagon-providers/wagon-ftp/src/main/java/org/apache/maven/wagon/providers/ftp/FtpWagon.java
maven/wagon/trunk/wagon-providers/wagon-scm/pom.xml
maven/wagon/trunk/wagon-providers/wagon-ssh-external/pom.xml
maven/wagon/trunk/wagon-providers/wagon-ssh/pom.xml
maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/AbstractSshWagon.java
maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/ScpWagon.java
maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutor.java
maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/TestData.java
Modified: maven/wagon/trunk/pom.xml
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/pom.xml?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/pom.xml (original)
+++ maven/wagon/trunk/pom.xml Mon Oct 10 00:17:58 2005
@@ -14,6 +14,10 @@
<url>http://www.apache.org/</url>
</organization>
<distributionManagement>
+ <snapshotRepository>
+ <id>snapshots</id>
+ <url>scp://beaver.codehaus.org/home/projects/maven/repository-staging/snapshots/maven2</url>
+ </snapshotRepository>
<repository>
<id>repo1</id>
<url>scp://beaver.codehaus.org/home/projects/maven/repository-staging/to-ibiblio/maven2</url>
@@ -107,14 +111,14 @@
<version>3.8.1</version>
</dependency>
<dependency>
- <groupId>plexus</groupId>
+ <groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-container-default</artifactId>
- <version>1.0-alpha-3</version>
+ <version>1.0-alpha-8-SNAPSHOT</version>
</dependency>
<dependency>
- <groupId>plexus</groupId>
+ <groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
- <version>1.0.2-SNAPSHOT</version>
+ <version>1.0.4-SNAPSHOT</version>
</dependency>
</dependencies>
</dependencyManagement>
Modified: maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/AbstractWagon.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/AbstractWagon.java?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/AbstractWagon.java (original)
+++ maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/AbstractWagon.java Mon Oct 10 00:17:58 2005
@@ -168,7 +168,14 @@
protected void getTransfer( Resource resource, File destination, InputStream input )
throws TransferFailedException
{
- // ensure that the destination is created only when we are ready to transfer
+ getTransfer( resource, destination, input, true, Integer.MAX_VALUE );
+ }
+
+ protected void getTransfer( Resource resource, File destination, InputStream input, boolean closeInput,
+ int maxSize )
+ throws TransferFailedException
+ {
+ // ensure that the destination is created only when we are ready to transfer
fireTransferDebug( "attempting to create parent directories for destination: " + destination.getName() );
createParentDirectories( destination );
@@ -178,7 +185,7 @@
try
{
- transfer( resource, input, output, TransferEvent.REQUEST_GET );
+ transfer( resource, input, output, TransferEvent.REQUEST_GET, maxSize );
}
catch ( IOException e )
{
@@ -201,10 +208,12 @@
}
finally
{
- IoUtils.close( input );
+ if ( closeInput )
+ {
+ IoUtils.close( input );
+ }
IoUtils.close( output );
-
}
fireGetCompleted( resource, destination );
@@ -254,13 +263,20 @@
protected void transfer( Resource resource, InputStream input, OutputStream output, int requestType )
throws IOException
{
+ transfer( resource, input, output, requestType, Integer.MAX_VALUE );
+ }
+
+ protected void transfer( Resource resource, InputStream input, OutputStream output, int requestType, int maxSize )
+ throws IOException
+ {
byte[] buffer = new byte[DEFAULT_BUFFER_SIZE];
TransferEvent transferEvent = new TransferEvent( this, resource, TransferEvent.TRANSFER_PROGRESS, requestType );
- while ( true )
+ int remaining = maxSize;
+ while ( remaining > 0 )
{
- int n = input.read( buffer );
+ int n = input.read( buffer, 0, Math.min( buffer.length, remaining ) );
if ( n == -1 )
{
@@ -270,6 +286,8 @@
fireTransferProgress( transferEvent, buffer, n );
output.write( buffer, 0, n );
+
+ remaining -= n;
}
}
Modified: maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/resource/Resource.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/resource/Resource.java?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/resource/Resource.java (original)
+++ maven/wagon/trunk/wagon-provider-api/src/main/java/org/apache/maven/wagon/resource/Resource.java Mon Oct 10 00:17:58 2005
@@ -83,4 +83,9 @@
{
this.contentLength = contentLength;
}
+
+ public String toString()
+ {
+ return name;
+ }
}
Modified: maven/wagon/trunk/wagon-provider-test/pom.xml
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-provider-test/pom.xml?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-provider-test/pom.xml (original)
+++ maven/wagon/trunk/wagon-provider-test/pom.xml Mon Oct 10 00:17:58 2005
@@ -19,7 +19,7 @@
<artifactId>junit</artifactId>
</dependency>
<dependency>
- <groupId>plexus</groupId>
+ <groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-container-default</artifactId>
</dependency>
</dependencies>
Modified: maven/wagon/trunk/wagon-provider-test/src/main/java/org/apache/maven/wagon/WagonTestCase.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-provider-test/src/main/java/org/apache/maven/wagon/WagonTestCase.java?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-provider-test/src/main/java/org/apache/maven/wagon/WagonTestCase.java (original)
+++ maven/wagon/trunk/wagon-provider-test/src/main/java/org/apache/maven/wagon/WagonTestCase.java Mon Oct 10 00:17:58 2005
@@ -181,6 +181,45 @@
tearDownWagonTestingFixtures();
}
+ public void testFailedGet()
+ throws Exception
+ {
+ setupRepositories();
+
+ setupWagonTestingFixtures();
+
+ message( "Getting test artifact from test repository " + testRepository );
+
+ Wagon wagon = getWagon();
+
+ wagon.addTransferListener( checksumObserver );
+
+ wagon.connect( testRepository, getAuthInfo() );
+
+ destFile = FileTestUtils.createUniqueFile( getName(), getName() );
+
+ destFile.deleteOnExit();
+
+ try
+ {
+ wagon.get( "fubar.txt", destFile );
+ fail( "File was found when it sohuldn't have been" );
+ }
+ catch ( ResourceDoesNotExistException e )
+ {
+ // expected
+ assertTrue( true );
+ }
+ finally
+ {
+ wagon.removeTransferListener( checksumObserver );
+
+ wagon.disconnect();
+
+ tearDownWagonTestingFixtures();
+ }
+ }
+
// ----------------------------------------------------------------------
// File <--> File round trip testing
// ----------------------------------------------------------------------
@@ -243,7 +282,7 @@
assertEquals( "compare checksums", "6b144b7285ffd6b0bc8300da162120b9", checksumObserver.getActualChecksum() );
checksumObserver = new ChecksumObserver();
-
+
getFile();
assertNotNull( "check checksum is not null", checksumObserver.getActualChecksum() );
Modified: maven/wagon/trunk/wagon-providers/wagon-ftp/src/main/java/org/apache/maven/wagon/providers/ftp/FtpWagon.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ftp/src/main/java/org/apache/maven/wagon/providers/ftp/FtpWagon.java?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ftp/src/main/java/org/apache/maven/wagon/providers/ftp/FtpWagon.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ftp/src/main/java/org/apache/maven/wagon/providers/ftp/FtpWagon.java Mon Oct 10 00:17:58 2005
@@ -323,20 +323,26 @@
}
}
- FTPFile[] ftpFiles = ftp.listFiles( "" );
+ String filename = PathUtils.filename( resource.getName() );
+ FTPFile[] ftpFiles = ftp.listFiles( filename );
- long contenetLength = ftpFiles[0].getSize();
+ if ( ftpFiles == null )
+ {
+ throw new ResourceDoesNotExistException( "Could not find file: '" + resource + "'" );
+ }
+
+ long contentLength = ftpFiles[0].getSize();
//@todo check how it works! javadoc of common login says:
// Returns the file timestamp. This usually the last modification time.
//
long lastModified = ftpFiles[0].getTimestamp().getTimeInMillis();
- resource.setContentLength( contenetLength );
+ resource.setContentLength( contentLength );
resource.setLastModified( lastModified );
- is = ftp.retrieveFileStream( PathUtils.filename( resource.getName() ) );
+ is = ftp.retrieveFileStream( filename );
for ( int i = 0; i < dirs.length; i++ )
{
Modified: maven/wagon/trunk/wagon-providers/wagon-scm/pom.xml
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-scm/pom.xml?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-scm/pom.xml (original)
+++ maven/wagon/trunk/wagon-providers/wagon-scm/pom.xml Mon Oct 10 00:17:58 2005
@@ -14,6 +14,16 @@
<groupId>org.apache.maven.scm</groupId>
<artifactId>maven-scm-api</artifactId>
<version>1.0-alpha-1</version>
+ <exclusions>
+ <exclusion>
+ <groupId>plexus</groupId>
+ <artifactId>plexus-container-default</artifactId>
+ </exclusion>
+ <exclusion>
+ <groupId>plexus</groupId>
+ <artifactId>plexus-utils</artifactId>
+ </exclusion>
+ </exclusions>
</dependency>
<!-- TODO: should be dynamically registered? -->
<dependency>
Modified: maven/wagon/trunk/wagon-providers/wagon-ssh-external/pom.xml
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh-external/pom.xml?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh-external/pom.xml (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh-external/pom.xml Mon Oct 10 00:17:58 2005
@@ -11,7 +11,7 @@
<name>Maven Wagon SSH External Provider</name>
<dependencies>
<dependency>
- <groupId>plexus</groupId>
+ <groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
</dependency>
</dependencies>
Modified: maven/wagon/trunk/wagon-providers/wagon-ssh/pom.xml
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/pom.xml?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/pom.xml (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/pom.xml Mon Oct 10 00:17:58 2005
@@ -11,7 +11,7 @@
<name>Maven Wagon SSH Provider</name>
<dependencies>
<dependency>
- <groupId>plexus</groupId>
+ <groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
</dependency>
<dependency>
@@ -20,4 +20,19 @@
<version>0.1.21</version>
</dependency>
</dependencies>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-surefire-plugin</artifactId>
+ <configuration>
+ <excludes>
+ <exclude>**/ScpWagon*Test.*</exclude>
+ <exclude>**/SftpWagonTest.*</exclude>
+ <exclude>**/SshCommandExecutorTest.*</exclude>
+ </excludes>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
</project>
Modified: maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/AbstractSshWagon.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/AbstractSshWagon.java?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/AbstractSshWagon.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/AbstractSshWagon.java Mon Oct 10 00:17:58 2005
@@ -28,12 +28,17 @@
import org.apache.maven.wagon.ResourceDoesNotExistException;
import org.apache.maven.wagon.TransferFailedException;
import org.apache.maven.wagon.WagonConstants;
+import org.apache.maven.wagon.util.IoUtils;
import org.apache.maven.wagon.authentication.AuthenticationException;
import org.apache.maven.wagon.authentication.AuthenticationInfo;
import org.apache.maven.wagon.events.TransferEvent;
import org.apache.maven.wagon.resource.Resource;
import java.io.File;
+import java.io.InputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.io.EOFException;
/**
* Common SSH operations.
@@ -53,6 +58,10 @@
public static final String EXEC_CHANNEL = "exec";
+ private static final int LINE_BUFFER_SIZE = 256;
+
+ private static final byte LF = '\n';
+
public void openConnection()
throws AuthenticationException
{
@@ -157,7 +166,7 @@
}
// username and password will be given via UserInfo interface.
- UserInfo ui = new ScpWagon.WagonUserInfo( authenticationInfo );
+ UserInfo ui = new WagonUserInfo( authenticationInfo );
session.setUserInfo( ui );
@@ -193,26 +202,51 @@
}
public void executeCommand( String command )
- throws TransferFailedException
+ throws CommandExecutionException
{
ChannelExec channel = null;
+ InputStream in = null;
+ InputStream err = null;
+ OutputStream out = null;
try
{
fireTransferDebug( "Executing command: " + command );
channel = (ChannelExec) session.openChannel( EXEC_CHANNEL );
- channel.setCommand( command );
+ channel.setCommand( command + "\n" );
+
+ out = channel.getOutputStream();
+
+ in = channel.getInputStream();
+
+ err = channel.getErrStream();
channel.connect();
+
+ sendEom( out );
+
+ String line = readLine( err );
+
+ if ( line != null )
+ {
+ throw new CommandExecutionException( line );
+ }
}
catch ( JSchException e )
{
- throw new TransferFailedException( "Cannot execute remote command: " + command, e );
+ throw new CommandExecutionException( "Cannot execute remote command: " + command, e );
+ }
+ catch ( IOException e )
+ {
+ throw new CommandExecutionException( "Cannot execute remote command: " + command, e );
}
finally
{
+ IoUtils.close( out );
+ IoUtils.close( in );
+ IoUtils.close( err );
if ( channel != null )
{
channel.disconnect();
@@ -220,6 +254,35 @@
}
}
+ protected String readLine( InputStream in )
+ throws IOException
+ {
+ byte[] buf = new byte[LINE_BUFFER_SIZE];
+
+ String result = null;
+ for ( int i = 0; result == null; i++ )
+ {
+ if ( in.read( buf, i, 1 ) != 1 )
+ {
+ return null;
+ }
+
+ if ( buf[i] == LF )
+ {
+ result = new String( buf, 0, i );
+ }
+ }
+ return result;
+ }
+
+ protected static void sendEom( OutputStream out )
+ throws IOException
+ {
+ out.write( 0 );
+
+ out.flush();
+ }
+
public void closeConnection()
{
if ( session != null )
@@ -245,8 +308,7 @@
String msg = "Error occured while downloading from the remote repository:" + getRepository();
- // TODO: this might be too hokey?
- if ( "No such file".equals( e.getMessage() ) )
+ if ( "No such file".equals( e.toString() ) )
{
// SFTP only
throw new ResourceDoesNotExistException( msg, e );
Added: maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/CommandExecutionException.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/CommandExecutionException.java?rev=312572&view=auto
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/CommandExecutionException.java (added)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/CommandExecutionException.java Mon Oct 10 00:17:58 2005
@@ -0,0 +1,47 @@
+package org.apache.maven.wagon.providers.ssh;
+
+/*
+ * Copyright 2001-2005 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.wagon.WagonException;
+
+/**
+ * Exception which should be thrown when a command fails to execute on the repository.
+ *
+ * @author <a href="brett@apache.org">Brett Porter</a>
+ * @version $Id$
+ */
+public class CommandExecutionException
+ extends WagonException
+{
+
+ /**
+ * @see org.apache.maven.wagon.WagonException
+ */
+ public CommandExecutionException( String message )
+ {
+ super( message );
+ }
+
+ /**
+ * @see org.apache.maven.wagon.WagonException
+ */
+ public CommandExecutionException( String message, Throwable cause )
+ {
+ super( message, cause );
+ }
+
+}
Propchange: maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/CommandExecutionException.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/CommandExecutionException.java
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/ScpWagon.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/ScpWagon.java?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/ScpWagon.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/ScpWagon.java Mon Oct 10 00:17:58 2005
@@ -18,12 +18,10 @@
import com.jcraft.jsch.ChannelExec;
import com.jcraft.jsch.JSchException;
-import org.apache.maven.wagon.LazyFileOutputStream;
import org.apache.maven.wagon.PathUtils;
import org.apache.maven.wagon.ResourceDoesNotExistException;
import org.apache.maven.wagon.TransferFailedException;
import org.apache.maven.wagon.authorization.AuthorizationException;
-import org.apache.maven.wagon.events.TransferEvent;
import org.apache.maven.wagon.repository.RepositoryPermissions;
import org.apache.maven.wagon.resource.Resource;
import org.apache.maven.wagon.util.IoUtils;
@@ -33,6 +31,7 @@
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
+import java.io.EOFException;
/**
* A base class for deployers and fetchers using protocols from SSH2 family and
@@ -49,18 +48,12 @@
public class ScpWagon
extends AbstractSshWagon
{
- private static final byte LF = '\n';
-
private static final char PATH_SEPARATOR = '/';
- private static final int BUFFER_SIZE = 1024;
-
- private static final char ACK_CHAR = 'C';
+ private static final char COPY_START_CHAR = 'C';
private static final char ACK_SEPARATOR = ' ';
- private static final char ZERO_CHAR = '0';
-
public void put( File source, String resourceName )
throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
{
@@ -74,41 +67,33 @@
firePutInitiated( resource, source );
- String umaskCmd = "";
-
- if ( getRepository().getPermissions() != null )
+ try
{
- String dirPerms = getRepository().getPermissions().getDirectoryMode();
-
- if ( dirPerms != null )
+ if ( getRepository().getPermissions() != null )
{
- umaskCmd = "umask " + PermissionModeUtils.getUserMaskFor( dirPerms ) + "\n";
+ String dirPerms = getRepository().getPermissions().getDirectoryMode();
+
+ if ( dirPerms != null )
+ {
+ String umaskCmd = "umask " + PermissionModeUtils.getUserMaskFor( dirPerms );
+ executeCommand( umaskCmd );
+ }
}
- }
- String path = basedir;
- if ( !basedir.endsWith( "/" ) && !dir.startsWith( "/" ) )
+ String mkdirCmd = "mkdir -p " + getPath( basedir, dir );
+
+ executeCommand( mkdirCmd );
+ }
+ catch ( CommandExecutionException e )
{
- path += "/";
+ throw new TransferFailedException( "Error performing commands for file transfer", e );
}
- path += dir;
- String mkdirCmd = umaskCmd + "mkdir -p " + path + "\n";
-
- executeCommand( mkdirCmd );
ChannelExec channel = null;
- //I/O streams for remote scp
OutputStream out = null;
- InputStream in;
-
- path = basedir;
- if ( !basedir.endsWith( "/" ) && !resourceName.startsWith( "/" ) )
- {
- path += "/";
- }
- path += resourceName;
+ String path = getPath( basedir, resourceName );
try
{
@@ -124,14 +109,11 @@
// get I/O streams for remote scp
out = channel.getOutputStream();
- in = channel.getInputStream();
+ InputStream in = channel.getInputStream();
channel.connect();
- if ( checkAck( in, false ) != 0 )
- {
- throw new TransferFailedException( "ACK check failed" );
- }
+ checkAck( in );
// send "C0644 filesize filename", where filename should not include '/'
long filesize = source.length();
@@ -153,26 +135,13 @@
out.flush();
- if ( checkAck( in, false ) != 0 )
- {
- throw new TransferFailedException( "ACK check failed" );
- }
+ checkAck( in );
putTransfer( resource, source, out, false );
- byte[] buf = new byte[BUFFER_SIZE];
+ sendEom( out );
- // send '\0'
- buf[0] = 0;
-
- out.write( buf, 0, 1 );
-
- out.flush();
-
- if ( checkAck( in, false ) != 0 )
- {
- throw new TransferFailedException( "ACK check failed" );
- }
+ checkAck( in );
}
catch ( IOException e )
{
@@ -198,17 +167,51 @@
}
}
- RepositoryPermissions permissions = getRepository().getPermissions();
+ try
+ {
+ RepositoryPermissions permissions = getRepository().getPermissions();
+
+ if ( permissions != null && permissions.getGroup() != null )
+ {
+ executeCommand( "chgrp -f " + permissions.getGroup() + " " + path );
+ }
+
+ // TODO: could avoid this by replacing 0644 above
+ if ( permissions != null && permissions.getFileMode() != null )
+ {
+ executeCommand( "chmod -f " + permissions.getFileMode() + " " + path );
+ }
+ }
+ catch ( CommandExecutionException e )
+ {
+ throw new TransferFailedException( "Error performing commands for file transfer", e );
+ }
+ }
- if ( permissions != null && permissions.getGroup() != null )
+ private static void checkAck( InputStream in )
+ throws IOException, TransferFailedException
+ {
+ int code = in.read();
+ if ( code == -1 )
+ {
+ throw new TransferFailedException( "Unexpected end of data" );
+ }
+ else if ( code != 0 )
{
- executeCommand( "chgrp -f " + permissions.getGroup() + " " + path + "\n" );
+ throw new TransferFailedException( "Did receive proper ACK: '" + code + "'" );
}
+ }
- if ( permissions != null && permissions.getFileMode() != null )
+ private static String getPath( String basedir, String dir )
+ {
+ String path;
+ path = basedir;
+ if ( !basedir.endsWith( "/" ) && !dir.startsWith( "/" ) )
{
- executeCommand( "chmod -f " + permissions.getFileMode() + " " + path + "\n" );
+ path += "/";
}
+ path += dir;
+ return path;
}
public void get( String resourceName, File destination )
@@ -225,17 +228,12 @@
InputStream in;
- createParentDirectories( destination );
-
- LazyFileOutputStream outputStream = new LazyFileOutputStream( destination );
-
String basedir = getRepository().getBasedir();
- //@todo get content lenght and last modified
-
try
{
- String cmd = "scp -f " + basedir + "/" + resourceName;
+ String path = getPath( basedir, resourceName );
+ String cmd = "scp -f " + path;
fireTransferDebug( "Executing command: " + cmd );
@@ -250,138 +248,71 @@
channel.connect();
- byte[] buf = new byte[BUFFER_SIZE];
+ sendEom( out );
- // send '\0'
- buf[0] = 0;
+ int exitCode = in.read();
- out.write( buf, 0, 1 );
+ String line = readLine( in );
- out.flush();
-
- while ( true )
+ if ( exitCode != COPY_START_CHAR )
{
- // TODO: is this really an ACK, or just an in.read()? If the latter, change checkAck method to not return a value, but throw an exception on non-zero result
- int c = checkAck( in, true );
-
- if ( c != ACK_CHAR )
+ if ( exitCode == 1 && line.endsWith( "No such file or directory" ) )
{
- break;
+ throw new ResourceDoesNotExistException( line );
}
-
- // read '0644 '
- if ( in.read( buf, 0, 5 ) != 5 )
- {
- throw new TransferFailedException( "Unexpected end of data." );
- }
-
- int filesize = 0;
-
- // get file size
- while ( true )
- {
- if ( in.read( buf, 0, 1 ) != 1 )
- {
- throw new TransferFailedException( "Unexpected end of data." );
- }
-
- if ( buf[0] == ACK_SEPARATOR )
- {
- break;
- }
-
- filesize = filesize * 10 + ( buf[0] - ZERO_CHAR );
- }
-
- resource.setContentLength( filesize );
-
- for ( int i = 0; ; i++ )
+ else
{
- if ( in.read( buf, i, 1 ) != 1 )
- {
- throw new TransferFailedException( "Unexpected end of data." );
- }
-
- if ( buf[i] == LF )
- {
- break;
- }
+ throw new TransferFailedException( "Exit code: " + exitCode + " - " + line );
}
+ }
- // send '\0'
- buf[0] = 0;
-
- out.write( buf, 0, 1 );
-
- out.flush();
-
- fireGetStarted( resource, destination );
+ if ( line == null )
+ {
+ throw new EOFException( "Unexpected end of data" );
+ }
- TransferEvent transferEvent = new TransferEvent( this, resource, TransferEvent.TRANSFER_PROGRESS,
- TransferEvent.REQUEST_GET );
+ String perms = line.substring( 0, 4 );
+ fireTransferDebug( "Remote file permissions: " + perms );
- try
- {
- while ( true )
- {
- int len = Math.min( buf.length, filesize );
-
- if ( in.read( buf, 0, len ) != len )
- {
- throw new TransferFailedException( "Unexpected end of data." );
- }
-
- outputStream.write( buf, 0, len );
-
- fireTransferProgress( transferEvent, buf, len );
-
- filesize -= len;
-
- if ( filesize == 0 )
- {
- break;
- }
- }
- }
- catch ( IOException e )
- {
- fireTransferError( resource, e, TransferEvent.REQUEST_GET );
+ if ( line.charAt( 4 ) != ACK_SEPARATOR )
+ {
+ throw new TransferFailedException( "Invalid transfer header: " + line );
+ }
- IoUtils.close( outputStream );
+ int index = line.indexOf( ACK_SEPARATOR, 5 );
+ if ( index < 0 )
+ {
+ throw new TransferFailedException( "Invalid transfer header: " + line );
+ }
- if ( destination.exists() )
- {
- boolean deleted = destination.delete();
+ int filesize = Integer.valueOf( line.substring( 5, index ) ).intValue();
+ fireTransferDebug( "Remote file size: " + filesize );
- if ( !deleted )
- {
- destination.deleteOnExit();
- }
- }
+ resource.setContentLength( filesize );
- String msg = "GET request of: " + resource + " from " + repository.getName() + "failed";
+ String filename = line.substring( index + 1 );
+ fireTransferDebug( "Remote filename: " + filename );
- throw new TransferFailedException( msg, e );
+ sendEom( out );
- }
+ getTransfer( resource, destination, in, false, filesize );
- fireGetCompleted( resource, destination );
+ if ( destination.length() != filesize )
+ {
+ throw new TransferFailedException(
+ "Expected file length: " + filesize + "; received = " + destination.length() );
+ }
- if ( checkAck( in, true ) != 0 )
- {
- throw new TransferFailedException( "Wrong ACK" );
- }
- else
- {
- fireTransferDebug( "ACK check: OK" );
- }
+ // TODO: we could possibly have received additional files here
- // send '\0'
- buf[0] = 0;
+ checkAck( in );
- out.write( buf, 0, 1 );
+ sendEom( out );
- out.flush();
+ if ( in.read() != -1 )
+ {
+ throw new TransferFailedException(
+ "End of stream not encountered - server possibly attempted to send multiple files" );
}
}
catch ( JSchException e )
@@ -400,8 +331,6 @@
{
channel.disconnect();
}
-
- IoUtils.close( outputStream );
}
}
@@ -409,57 +338,5 @@
throws TransferFailedException, ResourceDoesNotExistException, AuthorizationException
{
throw new UnsupportedOperationException( "getIfNewer is scp wagon must be still implemented" );
- }
-
- static int checkAck( InputStream in, boolean isGet )
- throws IOException, ResourceDoesNotExistException, TransferFailedException
- {
- int b = in.read();
- // b may be 0 for success,
- // 1 for error,
- // 2 for fatal error,
- // -1
-
- if ( b == 0 || b == -1 )
- {
- return b;
- }
-
- if ( b == 1 || b == 2 )
- {
- StringBuffer sb = new StringBuffer();
-
- int c;
-
- do
- {
- c = in.read();
-
- sb.append( (char) c );
- }
- while ( c != LF );
-
- String message = sb.toString();
- if ( b == 1 )
- {
- // error
- if ( message.endsWith( "No such file or directory\n" ) && isGet )
- {
- // TODO: this might be too hokey?
- throw new ResourceDoesNotExistException( message );
- }
- else
- {
- throw new TransferFailedException( message );
- }
- }
- else
- {
- // fatal error
- throw new TransferFailedException( message );
- }
- }
-
- return b;
}
}
Modified: maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutor.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutor.java?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutor.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/main/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutor.java Mon Oct 10 00:17:58 2005
@@ -26,6 +26,8 @@
public interface SshCommandExecutor
extends Wagon
{
+ String ROLE = SshCommandExecutor.class.getName();
+
void executeCommand( String command )
- throws TransferFailedException;
+ throws CommandExecutionException;
}
Copied: maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTest.java (from r312529, maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTestDisabled.java)
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTest.java?p2=maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTest.java&p1=maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTestDisabled.java&r1=312529&r2=312572&rev=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTestDisabled.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonTest.java Mon Oct 10 00:17:58 2005
@@ -25,7 +25,7 @@
* @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
* @version $Id$
*/
-public class ScpWagonTestDisabled
+public class ScpWagonTest
extends WagonTestCase
{
protected String getProtocol()
@@ -38,14 +38,11 @@
return TestData.getTestRepositoryUrl();
}
-
protected AuthenticationInfo getAuthInfo()
{
- AuthenticationInfo authInfo = new AuthenticationInfo();
-
- String userName = TestData.getUserName();
+ AuthenticationInfo authInfo = super.getAuthInfo();
- authInfo.setUserName( userName );
+ authInfo.setUserName( TestData.getUserName() );
File privateKey = TestData.getPrivateKey();
Copied: maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTest.java (from r312529, maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTestDisabled.java)
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTest.java?p2=maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTest.java&p1=maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTestDisabled.java&r1=312529&r2=312572&rev=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTestDisabled.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/ScpWagonWithSshPrivateKeySearchTest.java Mon Oct 10 00:17:58 2005
@@ -23,7 +23,7 @@
* @author <a href="michal.maczka@dimatics.com">Michal Maczka</a>
* @version $Id$
*/
-public class ScpWagonWithSshPrivateKeySearchTestDisabled
+public class ScpWagonWithSshPrivateKeySearchTest
extends WagonTestCase
{
protected String getProtocol()
@@ -39,11 +39,9 @@
protected AuthenticationInfo getAuthInfo()
{
- AuthenticationInfo authInfo = new AuthenticationInfo();
+ AuthenticationInfo authInfo = super.getAuthInfo();
- String userName = TestData.getUserName();
-
- authInfo.setUserName( userName );
+ authInfo.setUserName( TestData.getUserName() );
authInfo.setPassphrase( "" );
Copied: maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTest.java (from r312529, maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTestDisabled.java)
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTest.java?p2=maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTest.java&p1=maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTestDisabled.java&r1=312529&r2=312572&rev=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTestDisabled.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SftpWagonTest.java Mon Oct 10 00:17:58 2005
@@ -25,7 +25,7 @@
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @version $Id$
*/
-public class SftpWagonTestDisabled
+public class SftpWagonTest
extends WagonTestCase
{
protected String getProtocol()
@@ -38,23 +38,11 @@
return TestData.getTestRepositoryUrl();
}
-
protected AuthenticationInfo getAuthInfo()
{
- AuthenticationInfo authInfo = new AuthenticationInfo();
-
- String userName = TestData.getUserName();
-
- authInfo.setUserName( userName );
-
- File privateKey = TestData.getPrivateKey();
-
- if ( privateKey.exists() )
- {
- authInfo.setPrivateKey( privateKey.getAbsolutePath() );
+ AuthenticationInfo authInfo = super.getAuthInfo();
- authInfo.setPassphrase( "" );
- }
+ authInfo.setUserName( TestData.getUserName() );
return authInfo;
}
Added: maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutorTest.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutorTest.java?rev=312572&view=auto
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutorTest.java (added)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutorTest.java Mon Oct 10 00:17:58 2005
@@ -0,0 +1,80 @@
+package org.apache.maven.wagon.providers.ssh;
+
+/*
+ * Copyright 2001-2005 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.wagon.authentication.AuthenticationInfo;
+import org.apache.maven.wagon.repository.Repository;
+import org.codehaus.plexus.PlexusTestCase;
+
+/**
+ * Test the command executor.
+ *
+ * @author <a href="mailto:brett@apache.org">Brett Porter</a>
+ * @version $Id$
+ */
+public class SshCommandExecutorTest
+ extends PlexusTestCase
+{
+ public void testErrorInCommandExecuted()
+ throws Exception
+ {
+ SshCommandExecutor exec = (SshCommandExecutor) lookup( SshCommandExecutor.ROLE );
+
+ Repository repository = new Repository( "test", "scp://localhost/" );
+
+ AuthenticationInfo authenticationInfo = new AuthenticationInfo();
+ authenticationInfo.setUserName( System.getProperty( "user.name" ) );
+
+ exec.connect( repository, authenticationInfo );
+
+ try
+ {
+ exec.executeCommand( "fail" );
+ fail( "Command should have failed" );
+ }
+ catch ( CommandExecutionException e )
+ {
+ assertTrue( e.getMessage().endsWith( "fail: command not found" ) );
+ }
+ finally
+ {
+ exec.disconnect();
+ }
+ }
+
+ public void testExecuteSuccessfulCommand()
+ throws Exception
+ {
+ SshCommandExecutor exec = (SshCommandExecutor) lookup( SshCommandExecutor.ROLE );
+
+ Repository repository = new Repository( "test", "scp://localhost/" );
+
+ AuthenticationInfo authenticationInfo = new AuthenticationInfo();
+ authenticationInfo.setUserName( System.getProperty( "user.name" ) );
+
+ exec.connect( repository, authenticationInfo );
+
+ try
+ {
+ exec.executeCommand( "ls" );
+ }
+ finally
+ {
+ exec.disconnect();
+ }
+ }
+}
Propchange: maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutorTest.java
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/SshCommandExecutorTest.java
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
Modified: maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/TestData.java
URL: http://svn.apache.org/viewcvs/maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/TestData.java?rev=312572&r1=312571&r2=312572&view=diff
==============================================================================
--- maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/TestData.java (original)
+++ maven/wagon/trunk/wagon-providers/wagon-ssh/src/test/java/org/apache/maven/wagon/providers/ssh/TestData.java Mon Oct 10 00:17:58 2005
@@ -26,26 +26,16 @@
{
public static String getTestRepositoryUrl()
{
- return "scp://beaver.codehaus.org/home/projects/" + getUserName() + "/public_html";
+ return "scp://localhost/tmp/home/projects/" + getUserName() + "/public_html";
}
public static String getUserName()
{
-
- String retValue = System.getProperty( "testuser.name" );
-
- if ( retValue == null )
- {
- retValue = System.getProperty( "user.name" );
- }
-
- return retValue;
+ return System.getProperty( "user.name" );
}
public static File getPrivateKey()
{
- File retValue = new File( System.getProperty( "user.home" ), "/.ssh/id_dsa" );
-
- return retValue;
+ return new File( System.getProperty( "user.home" ), "/.ssh/id_dsa" );
}
}
---------------------------------------------------------------------
To unsubscribe, e-mail: wagon-commits-unsubscribe@maven.apache.org
For additional commands, e-mail: wagon-commits-help@maven.apache.org