org.apache.maven.wagon

Class WagonTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.codehaus.plexus.PlexusTestCase

org.apache.maven.wagon.WagonTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

StreamingWagonTestCase

public abstract class WagonTestCase
extends org.codehaus.plexus.PlexusTestCase

Author:

Jason van Zyl

Field Summary

Fields

Modifier and Type	Field and Description
protected File	artifactDestFile
protected File	artifactSourceFile
protected ChecksumObserver	checksumObserver
protected File	destFile
protected Repository	localRepository
protected String	localRepositoryPath
protected static org.slf4j.Logger	logger
protected TransferListener	mockTransferListener
protected static String	POM
protected String	resource
protected File	sourceFile
protected static String	TEST_CKSUM
protected static String	TEST_CONTENT
protected Repository	testRepository
protected boolean	testSkipped

Constructor Summary

Constructors

Constructor and Description
WagonTestCase()

Method Summary

Modifier and Type	Method and Description
protected void	assertGetIfNewerTest(org.apache.maven.wagon.WagonTestCase.ProgressAnswer progressAnswer, boolean expectedResult, int expectedSize)
protected void	assertNotExists(Wagon wagon, String resourceName) Assert that a resource does not exist in the remote wagon system
protected boolean	assertOnTransferProgress() some test (mock on transfertprogress call) relies on the fact that InputStream #read(byte[] b, int off, int len) read all bytes.
protected void	assertResourcesAreInRemoteSide(Wagon wagon, List<String> resourceNames)
protected static String	cksum(String content)
protected void	connectWagon(Wagon wagon)
protected void	createDirectory(Wagon wagon, String resourceToCreate, String dirName) Create a directory with a resource and check that the other ones don't exist
protected Repository	createFileRepository(String url)
protected TransferEvent	createTransferEvent(Wagon wagon, Resource resource, int eventType, int requestType, File file)
protected void	customizeContext()
protected void	disconnectWagon(Wagon wagon)
protected void	fileRoundTripTesting()
protected AuthenticationInfo	getAuthInfo()
protected int	getExpectedContentLengthOnGet(int expectedSize)
protected long	getExpectedLastModifiedOnGet(Repository repository, Resource resource)
protected void	getFile(int expectedSize)
protected RepositoryPermissions	getPermissions()
protected abstract String	getProtocol() Protocol id of the Wagon to use, eg.
protected abstract String	getTestRepositoryUrl() URL of the repository.
protected Wagon	getWagon()
static boolean	isSystemCmd(String cmd)
protected void	message(String message)
protected int	putFile()
protected void	putFile(String resourceName, String testFileName, String content)
protected org.apache.maven.wagon.WagonTestCase.ProgressAnswer	replaceMockForGet(Wagon wagon, int expectedSize)
protected org.apache.maven.wagon.WagonTestCase.ProgressAnswer	replayMockForPut(String resourceName, String content, Wagon wagon)
protected void	runTest()
protected void	setUp()
protected org.apache.maven.wagon.WagonTestCase.ProgressAnswer	setupGetIfNewerTest(Wagon wagon, boolean expectedResult, int expectedSize)
protected void	setupRepositories()
protected void	setupWagonTestingFixtures()
protected boolean	supportsGetIfNewer()
protected void	tearDownWagonTestingFixtures()
void	testFailedGet()
void	testFailedGetIfNewer()
void	testWagon()
void	testWagonGetFileList() Test Wagon.getFileList(String).
void	testWagonGetFileListWhenDirectoryDoesNotExist() Test Wagon.getFileList(String) when the directory does not exist.
void	testWagonGetIfNewerIsNewer()
void	testWagonGetIfNewerIsOlder()
void	testWagonGetIfNewerIsSame()
void	testWagonPutDirectory()
void	testWagonPutDirectoryDeepDestination() Test for putting a directory with a destination that multiple directories deep, all of which haven't been created.
void	testWagonPutDirectoryForDot() Test that when putting a directory that already exists new files get also copied and destination is "."
void	testWagonPutDirectoryWhenDirectoryAlreadyExists() Test that when putting a directory that already exists new files get also copied
void	testWagonResourceExists() Test for an existing resource.
void	testWagonResourceNotExists() Test for an invalid resource.
protected void	verifyMock(org.apache.maven.wagon.WagonTestCase.ProgressAnswer progressAnswer, int length)

Methods inherited from class org.codehaus.plexus.PlexusTestCase

customizeComponentConfiguration, customizeContainerConfiguration, customizeContext, getBasedir, getClassLoader, getConfiguration, getConfiguration, getConfigurationName, getContainer, getCustomConfigurationName, getResourceAsStream, getTestConfiguration, getTestConfiguration, getTestFile, getTestFile, getTestPath, getTestPath, lookup, lookup, lookup, lookup, release, setupContainer, tearDown

Methods inherited from class junit.framework.TestCase

assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertFalse, assertFalse, assertNotNull, assertNotNull, assertNotSame, assertNotSame, assertNull, assertNull, assertSame, assertSame, assertTrue, assertTrue, countTestCases, createResult, fail, fail, failNotEquals, failNotSame, failSame, format, getName, run, run, runBare, setName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

logger

protected static org.slf4j.Logger logger

TEST_CONTENT

protected static final String TEST_CONTENT

See Also:

Constant Field Values

TEST_CKSUM

protected static final String TEST_CKSUM

POM

protected static final String POM

See Also:

Constant Field Values

localRepository

protected Repository localRepository

testRepository

protected Repository testRepository

localRepositoryPath

protected String localRepositoryPath

sourceFile

protected File sourceFile

destFile

protected File destFile

resource

protected String resource

testSkipped

protected boolean testSkipped

artifactSourceFile

protected File artifactSourceFile

artifactDestFile

protected File artifactDestFile

checksumObserver

protected ChecksumObserver checksumObserver

mockTransferListener

protected TransferListener mockTransferListener

Constructor Detail

WagonTestCase

public WagonTestCase()

Method Detail

setUp

protected void setUp()
              throws Exception

Overrides:

setUp in class org.codehaus.plexus.PlexusTestCase

Throws:

Exception

getTestRepositoryUrl

protected abstract String getTestRepositoryUrl()
                                        throws IOException

URL of the repository. For a complete test it should point to a non existing folder so we also check for the creation of new folders in the remote site.

return the URL of the repository as specified by Wagon syntax

Throws:

IOException

getProtocol

protected abstract String getProtocol()

Protocol id of the Wagon to use, eg. scp, ftp

Returns:

the protocol id

setupRepositories

protected void setupRepositories()
                          throws Exception

Throws:

Exception

customizeContext

protected void customizeContext()
                         throws Exception

Throws:

Exception

setupWagonTestingFixtures

protected void setupWagonTestingFixtures()
                                  throws Exception

Throws:

Exception

tearDownWagonTestingFixtures

protected void tearDownWagonTestingFixtures()
                                     throws Exception

Throws:

Exception

getAuthInfo

protected AuthenticationInfo getAuthInfo()

getPermissions

protected RepositoryPermissions getPermissions()

getWagon

protected Wagon getWagon()
                  throws Exception

Throws:

Exception

isSystemCmd

public static boolean isSystemCmd(String cmd)

Parameters:

cmd - the executable to run, not null.

Returns:

true

message

protected void message(String message)

testWagon

public void testWagon()
               throws Exception

Throws:

Exception

testWagonGetIfNewerIsNewer

public void testWagonGetIfNewerIsNewer()
                                throws Exception

Throws:

Exception

runTest

protected void runTest()
                throws Throwable

Overrides:

runTest in class junit.framework.TestCase

Throws:

Throwable

supportsGetIfNewer

protected boolean supportsGetIfNewer()

testWagonGetIfNewerIsSame

public void testWagonGetIfNewerIsSame()
                               throws Exception

Throws:

Exception

testWagonGetIfNewerIsOlder

public void testWagonGetIfNewerIsOlder()
                                throws Exception

Throws:

Exception

setupGetIfNewerTest

protected org.apache.maven.wagon.WagonTestCase.ProgressAnswer setupGetIfNewerTest(Wagon wagon,
                                                                                  boolean expectedResult,
                                                                                  int expectedSize)
                                                                           throws NoSuchAlgorithmException,
                                                                                  IOException

Throws:

NoSuchAlgorithmException

IOException

assertGetIfNewerTest

protected void assertGetIfNewerTest(org.apache.maven.wagon.WagonTestCase.ProgressAnswer progressAnswer,
                                    boolean expectedResult,
                                    int expectedSize)
                             throws IOException

Throws:

IOException

testWagonPutDirectory

public void testWagonPutDirectory()
                           throws Exception

Throws:

Exception

testWagonPutDirectoryDeepDestination

public void testWagonPutDirectoryDeepDestination()
                                          throws Exception

Test for putting a directory with a destination that multiple directories deep, all of which haven't been created.

Throws:

Exception

Since:

1.0-beta-2

testWagonPutDirectoryWhenDirectoryAlreadyExists

public void testWagonPutDirectoryWhenDirectoryAlreadyExists()
                                                     throws Exception

Test that when putting a directory that already exists new files get also copied

Throws:

Exception

Since:

1.0-beta-1

testWagonPutDirectoryForDot

public void testWagonPutDirectoryForDot()
                                 throws Exception

Test that when putting a directory that already exists new files get also copied and destination is "."

Throws:

Exception

Since:

1.0-beta-1

createDirectory

protected void createDirectory(Wagon wagon,
                               String resourceToCreate,
                               String dirName)
                        throws Exception

Create a directory with a resource and check that the other ones don't exist

Parameters:

wagon -

resourceToCreate - name of the resource to be created

dirName - directory name to create

Throws:

Exception

assertResourcesAreInRemoteSide

protected void assertResourcesAreInRemoteSide(Wagon wagon,
                                              List<String> resourceNames)
                                       throws IOException,
                                              TransferFailedException,
                                              ResourceDoesNotExistException,
                                              AuthorizationException

Throws:

IOException

TransferFailedException

ResourceDoesNotExistException

AuthorizationException

assertNotExists

protected void assertNotExists(Wagon wagon,
                               String resourceName)
                        throws IOException,
                               TransferFailedException,
                               AuthorizationException

Assert that a resource does not exist in the remote wagon system

Parameters:

wagon - wagon to get the resource from

resourceName - name of the resource

Throws:

IOException - if a temp file can't be created

AuthorizationException

TransferFailedException

Since:

1.0-beta-1

testFailedGet

public void testFailedGet()
                   throws Exception

Throws:

Exception

testFailedGetIfNewer

public void testFailedGetIfNewer()
                          throws Exception

Throws:

Exception

testWagonGetFileList

public void testWagonGetFileList()
                          throws Exception

Test Wagon.getFileList(String).

Throws:

Exception

Since:

1.0-beta-2

testWagonGetFileListWhenDirectoryDoesNotExist

public void testWagonGetFileListWhenDirectoryDoesNotExist()
                                                   throws Exception

Test Wagon.getFileList(String) when the directory does not exist.

Throws:

Exception

Since:

1.0-beta-2

testWagonResourceExists

public void testWagonResourceExists()
                             throws Exception

Test for an existing resource.

Throws:

Exception

Since:

1.0-beta-2

testWagonResourceNotExists

public void testWagonResourceNotExists()
                                throws Exception

Test for an invalid resource.

Throws:

Exception

Since:

1.0-beta-2

putFile

protected void putFile(String resourceName,
                       String testFileName,
                       String content)
                throws Exception

Throws:

Exception

replayMockForPut

protected org.apache.maven.wagon.WagonTestCase.ProgressAnswer replayMockForPut(String resourceName,
                                                                               String content,
                                                                               Wagon wagon)

createTransferEvent

protected TransferEvent createTransferEvent(Wagon wagon,
                                            Resource resource,
                                            int eventType,
                                            int requestType,
                                            File file)

putFile

protected int putFile()
               throws Exception

Throws:

Exception

getFile

protected void getFile(int expectedSize)
                throws Exception

Throws:

Exception

verifyMock

protected void verifyMock(org.apache.maven.wagon.WagonTestCase.ProgressAnswer progressAnswer,
                          int length)

disconnectWagon

protected void disconnectWagon(Wagon wagon)
                        throws ConnectionException

Throws:

ConnectionException

connectWagon

protected void connectWagon(Wagon wagon)
                     throws ConnectionException,
                            AuthenticationException

Throws:

ConnectionException

AuthenticationException

assertOnTransferProgress

protected boolean assertOnTransferProgress()

some test (mock on transfertprogress call) relies on the fact that InputStream #read(byte[] b, int off, int len) read all bytes. But javadoc says: ""

replaceMockForGet

protected org.apache.maven.wagon.WagonTestCase.ProgressAnswer replaceMockForGet(Wagon wagon,
                                                                                int expectedSize)

getExpectedContentLengthOnGet

protected int getExpectedContentLengthOnGet(int expectedSize)

getExpectedLastModifiedOnGet

protected long getExpectedLastModifiedOnGet(Repository repository,
                                            Resource resource)

fileRoundTripTesting

protected void fileRoundTripTesting()
                             throws Exception

Throws:

Exception

createFileRepository

protected Repository createFileRepository(String url)

cksum

protected static String cksum(String content)