package org.apache.maven.wagon.providers.webdav;
/*
* 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 it.could.webdav.DAVServlet;
import org.apache.commons.httpclient.HttpException;
import org.apache.commons.httpclient.HttpMethod;
import org.apache.maven.wagon.ResourceDoesNotExistException;
import org.apache.maven.wagon.StreamingWagon;
import org.apache.maven.wagon.TransferFailedException;
import org.apache.maven.wagon.Wagon;
import org.apache.maven.wagon.http.HttpWagonTestCase;
import org.apache.maven.wagon.repository.Repository;
import org.apache.maven.wagon.resource.Resource;
import org.mortbay.jetty.Server;
import org.mortbay.jetty.servlet.Context;
import org.mortbay.jetty.servlet.ServletHolder;
import java.io.File;
import java.io.IOException;
import java.net.SocketTimeoutException;
import java.util.List;
import java.util.Properties;
/*
* WebDAV Wagon Test
*
* @author <a href="mailto:joakim@erdfelt.com">Joakim Erdfelt</a>
*
* @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
*/
public class WebDavWagonTest
extends HttpWagonTestCase
{
protected String getTestRepositoryUrl()
throws IOException
{
return getProtocol() + "://localhost:" + getTestRepositoryPort() + "/newfolder/folder2/";
}
protected String getProtocol()
{
return "dav";
}
protected void createContext( Server server, File repositoryDirectory )
throws IOException
{
Context dav = new Context( server, "/", Context.SESSIONS );
ServletHolder davServletHolder = new ServletHolder( new DAVServlet() );
davServletHolder.setInitParameter( "rootPath", repositoryDirectory.getAbsolutePath() );
davServletHolder.setInitParameter( "xmlOnly", "false" );
dav.addServlet( davServletHolder, "/*" );
}
protected long getExpectedLastModifiedOnGet( Repository repository, Resource resource )
{
File file = new File( getDavRepository(), resource.getName() );
return ( file.lastModified() / 1000 ) * 1000;
}
private File getDavRepository()
{
return getTestFile( "target/test-output/http-repository/newfolder/folder2" );
}
private void assertURL( String userUrl, String expectedUrl )
{
Repository repo = new Repository( "test-geturl", userUrl );
String actualUrl = ( new WebDavWagon() ).getURL( repo );
assertEquals( "WebDavWagon.getURL(" + userUrl + ")", expectedUrl, actualUrl );
}
/**
* Tests the maven 2.0.x way to define a webdav URL without SSL.
*/
public void testGetURLDavHttp()
{
assertURL( "dav:http://localhost:" + getTestRepositoryPort() + "/dav/",
"http://localhost:" + getTestRepositoryPort() + "/dav/" );
}
/**
* Tests the maven 2.0.x way to define a webdav URL with SSL.
*/
public void testGetURLDavHttps()
{
assertURL( "dav:https://localhost:" + getTestRepositoryPort() + "/dav/",
"https://localhost:" + getTestRepositoryPort() + "/dav/" );
}
/**
* Tests the URI spec way of defining a webdav URL without SSL.
*/
public void testGetURLDavUri()
{
assertURL( "dav://localhost:" + getTestRepositoryPort() + "/dav/",
"http://localhost:" + getTestRepositoryPort() + "/dav/" );
}
/**
* Tests the URI spec way of defining a webdav URL with SSL.
*/
public void testGetURLDavUriWithSsl()
{
assertURL( "davs://localhost:" + getTestRepositoryPort() + "/dav/",
"https://localhost:" + getTestRepositoryPort() + "/dav/" );
}
/**
* Tests the URI spec way of defining a webdav URL without SSL.
*/
public void testGetURLDavPlusHttp()
{
assertURL( "dav+https://localhost:" + getTestRepositoryPort() + "/dav/",
"https://localhost:" + getTestRepositoryPort() + "/dav/" );
}
/**
* Tests the URI spec way of defining a webdav URL with SSL.
*/
public void testGetURLDavPlusHttps()
{
assertURL( "dav+https://localhost:" + getTestRepositoryPort() + "/dav/",
"https://localhost:" + getTestRepositoryPort() + "/dav/" );
}
public void testMkdirs()
throws Exception
{
setupRepositories();
setupWagonTestingFixtures();
WebDavWagon wagon = (WebDavWagon) getWagon();
wagon.connect( testRepository, getAuthInfo() );
try
{
File dir = getRepositoryDirectory();
// check basedir also doesn't exist and will need to be created
dir = new File( dir, testRepository.getBasedir() );
assertFalse( dir.exists() );
// test leading /
assertFalse( new File( dir, "foo" ).exists() );
wagon.mkdirs( "/foo" );
assertTrue( new File( dir, "foo" ).exists() );
// test trailing /
assertFalse( new File( dir, "bar" ).exists() );
wagon.mkdirs( "bar/" );
assertTrue( new File( dir, "bar" ).exists() );
// test when already exists
wagon.mkdirs( "bar" );
// test several parts
assertFalse( new File( dir, "1/2/3/4" ).exists() );
wagon.mkdirs( "1/2/3/4" );
assertTrue( new File( dir, "1/2/3/4" ).exists() );
// test additional part and trailing /
assertFalse( new File( dir, "1/2/3/4/5" ).exists() );
wagon.mkdirs( "1/2/3/4/5/" );
assertTrue( new File( dir, "1/2/3/4" ).exists() );
}
finally
{
wagon.disconnect();
tearDownWagonTestingFixtures();
}
}
public void testMkdirsWithNoBasedir()
throws Exception
{
// WAGON-244
setupRepositories();
setupWagonTestingFixtures();
// reconstruct with no basedir
testRepository.setUrl(
testRepository.getProtocol() + "://" + testRepository.getHost() + ":" + testRepository.getPort() );
WebDavWagon wagon = (WebDavWagon) getWagon();
wagon.connect( testRepository, getAuthInfo() );
try
{
File dir = getRepositoryDirectory();
// check basedir also doesn't exist and will need to be created
dir = new File( dir, testRepository.getBasedir() );
assertTrue( dir.exists() );
// test leading /
assertFalse( new File( dir, "foo" ).exists() );
wagon.mkdirs( "/foo" );
assertTrue( new File( dir, "foo" ).exists() );
}
finally
{
wagon.disconnect();
tearDownWagonTestingFixtures();
}
}
protected void setHttpHeaders( StreamingWagon wagon, Properties properties )
{
( (WebDavWagon) wagon ).setHttpHeaders( properties );
}
/**
* Make sure wagon webdav can detect remote directory
*
* @throws Exception
*/
public void testWagonWebDavGetFileList()
throws Exception
{
setupRepositories();
setupWagonTestingFixtures();
String dirName = "file-list";
String filenames[] =
new String[]{ "test-resource.txt", "test-resource.pom", "test-resource b.txt", "more-resources.dat" };
for ( int i = 0; i < filenames.length; i++ )
{
putFile( dirName + "/" + filenames[i], dirName + "/" + filenames[i], filenames[i] + "\n" );
}
String dirnames[] = new String[]{ "test-dir1", "test-dir2" };
for ( int i = 0; i < dirnames.length; i++ )
{
new File( getDavRepository(), dirName + "/" + dirnames[i] ).mkdirs();
}
Wagon wagon = getWagon();
wagon.connect( testRepository, getAuthInfo() );
List<String> list = wagon.getFileList( dirName );
assertNotNull( "file list should not be null.", list );
assertEquals( "file list should contain 6 items", 6, list.size() );
for ( int i = 0; i < filenames.length; i++ )
{
assertTrue( "Filename '" + filenames[i] + "' should be in list.", list.contains( filenames[i] ) );
}
for ( int i = 0; i < dirnames.length; i++ )
{
assertTrue( "Directory '" + dirnames[i] + "' should be in list.", list.contains( dirnames[i] + "/" ) );
}
///////////////////////////////////////////////////////////////////////////
list = wagon.getFileList( "" );
assertNotNull( "file list should not be null.", list );
assertEquals( "file list should contain 1 items", 1, list.size() );
///////////////////////////////////////////////////////////////////////////
list = wagon.getFileList( dirName + "/test-dir1" );
assertNotNull( "file list should not be null.", list );
assertEquals( "file list should contain 0 items", 0, list.size() );
/////////////////////////////////////////////////////////////////////////////
try
{
list = wagon.getFileList( dirName + "/test-dir-bogus" );
fail( "Exception expected" );
}
catch ( ResourceDoesNotExistException e )
{
}
wagon.disconnect();
tearDownWagonTestingFixtures();
}
@Override
protected boolean supportPreemptiveAuthentication()
{
return true;
}
protected void testPreemptiveAuthentication( TestSecurityHandler sh )
{
if ( supportPreemptiveAuthentication() )
{
assertEquals( "not 2 security handler use " + sh.securityHandlerRequestReponses, 2,
sh.securityHandlerRequestReponses.size() );
assertEquals( 200, sh.securityHandlerRequestReponses.get( 0 ).responseCode );
}
else
{
assertEquals( "not 4 security handler use " + sh.securityHandlerRequestReponses, 4,
sh.securityHandlerRequestReponses.size() );
assertEquals( 401, sh.securityHandlerRequestReponses.get( 0 ).responseCode );
assertEquals( 200, sh.securityHandlerRequestReponses.get( 1 ).responseCode );
assertEquals( 401, sh.securityHandlerRequestReponses.get( 2 ).responseCode );
assertEquals( 200, sh.securityHandlerRequestReponses.get( 3 ).responseCode );
}
}
public void testWagonFailsOnPutFailureByDefault()
throws Exception
{
setupRepositories();
setupWagonTestingFixtures();
File testFile = getTempFile();
System.clearProperty( WebDavWagon.CONTINUE_ON_FAILURE_PROPERTY );
WebDavWagon wagon = new TimeoutSimulatingWagon();
wagon.connect( testRepository, getAuthInfo() );
try
{
String filename = TimeoutSimulatingWagon.TIMEOUT_TRIGGER + ".txt";
try
{
wagon.put( testFile, filename );
fail( "Exception expected" );
}
catch ( TransferFailedException e )
{
}
}
finally
{
wagon.disconnect();
tearDownWagonTestingFixtures();
}
}
private File getTempFile()
throws IOException
{
File inputFile = File.createTempFile( "test-resource", ".txt" );
inputFile.deleteOnExit();
return inputFile;
}
private static class TimeoutSimulatingWagon
extends WebDavWagon
{
private static final String TIMEOUT_TRIGGER = "timeout";
protected int execute( HttpMethod httpMethod )
throws HttpException, IOException
{
if ( httpMethod.getPath().contains( TIMEOUT_TRIGGER ) )
{
throw new SocketTimeoutException( "Timeout triggered by request for '" + httpMethod.getPath() + "'" );
}
else
{
return super.execute( httpMethod );
}
}
}
public void testWagonContinuesOnPutFailureIfPropertySet()
throws Exception
{
setupRepositories();
setupWagonTestingFixtures();
File testFile = getTempFile();
String continueOnFailureProperty = WebDavWagon.CONTINUE_ON_FAILURE_PROPERTY;
System.setProperty( continueOnFailureProperty, "true" );
WebDavWagon wagon = new TimeoutSimulatingWagon();
wagon.connect( testRepository, getAuthInfo() );
try
{
String filename = TimeoutSimulatingWagon.TIMEOUT_TRIGGER + ".txt";
wagon.put( testFile, filename );
}
finally
{
wagon.disconnect();
System.clearProperty( continueOnFailureProperty );
tearDownWagonTestingFixtures();
}
}
protected boolean supportProxyPreemptiveAuthentication()
{
return true;
}
}