Package org.apache.maven.scm

Class ScmTckTestCase

java.lang.Object

org.apache.maven.scm.PlexusJUnit4TestCase

org.apache.maven.scm.ScmTestCase

org.apache.maven.scm.ScmTckTestCase

Direct Known Subclasses:

AbstractRemoteInfoCommandTckTest, BlameCommandTckTest, BranchCommandTckTest, ChangeLogCommandTckTest, CheckInCommandTckTest, CheckOutCommandTckTest, DiffCommandTckTest, InfoCommandTckTest, ListCommandTckTest, MkdirCommandTckTest, RemoveCommandTckTest, StatusCommandTckTest, TagCommandTckTest, UntagCommandTckTest, UpdateCommandTckTest

public abstract class ScmTckTestCase
extends ScmTestCase

Base class for all TcK tests.

Basically all it does is to set up a default test enviroment common for all tck tests. The default setup includes:

1. Delete all default locations (working copy, updating copy etc)
2. Initialize the repository
3. Check out the repository to the working copy

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.List<java.lang.String>	scmFileNames
private ScmRepository	scmRepository

Fields inherited from class org.apache.maven.scm.ScmTestCase

GMT_TIME_ZONE

Fields inherited from class org.apache.maven.scm.PlexusJUnit4TestCase

testName

Constructor Summary

Constructors

Constructor	Description
ScmTckTestCase()

Method Summary

Modifier and Type	Method	Description
protected void	addToWorkingTree(java.io.File workingDirectory, java.io.File file, ScmRepository repository)	Convenience method to add a file to the working tree at the working directory.
protected CheckInScmResult	checkIn(java.io.File workingDirectory, ScmRepository repository)	Convenience method to check in files to the repository.
protected CheckOutScmResult	checkOut(java.io.File workingDirectory, ScmRepository repository)	Convenience method to check out files from the repository.
void	checkScmPresence()
protected EditScmResult	edit(java.io.File basedir, java.lang.String includes, java.lang.String excludes, ScmRepository repository)
protected java.util.List<java.lang.String>	getScmFileNames()	Get the list of file names that is supposed to be in the test repo.
java.lang.String	getScmProviderCommand()	Some tests can only run if the appropriate application has been installed.
protected ScmRepository	getScmRepository()	Convenience method to get the ScmRepository for this provider.
abstract java.lang.String	getScmUrl()
abstract void	initRepo()	Initialize repository at the getScmUrl() location with the files in getScmFileNames()
protected java.util.Map<java.lang.String,ScmFile>	mapFilesByPath(java.util.List<ScmFile> files)	Take the files of the given list, add them to a TreeMap and use the pathName String as key for the Map.
protected RemoveScmResult	remove(java.io.File workingDirectory, ScmRepository repository)	Convenience method to remove files from the repository.
void	removeRepo()	This method is available to those SCM clients that need to perform a cleanup at the end of the tests.
void	setUp()
void	tearDown()	Provided to allow removeRepo() to be called.

Methods inherited from class org.apache.maven.scm.ScmTestCase

assertCommandLine, assertFile, assertPath, assertResultIsSuccess, checkSystemCmdPresence, customizeContainerConfiguration, deleteDirectory, execute, getAssertionCopy, getDate, getDate, getDate, getRepository, getRepositoryRoot, getScmFileSet, getScmManager, getUpdatingCopy, getWorkingCopy, getWorkingDirectory, isSystemCmd, makeDirectory, makeFile, makeFile, makeScmRepository, printOutputError, setDebugExecute

Methods inherited from class org.apache.maven.scm.PlexusJUnit4TestCase

customizeComponentConfiguration, customizeContext, getBasedir, getClassLoader, getConfiguration, getConfiguration, getConfigurationName, getContainer, getCustomConfigurationName, getCustomModules, getName, getResourceAsStream, getTestConfiguration, getTestConfiguration, getTestFile, getTestFile, getTestPath, getTestPath, lookup, lookup, lookup, lookup, lookupMap, release, setupContainer

Methods inherited from class java.lang.Object

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

Field Detail

scmRepository

private ScmRepository scmRepository

scmFileNames

private java.util.List<java.lang.String> scmFileNames

Constructor Detail

ScmTckTestCase

public ScmTckTestCase()

Method Detail

getScmProviderCommand

public java.lang.String getScmProviderCommand()

Some tests can only run if the appropriate application has been installed. If the provided name is not a runnable application all tests in the class are skipped.

Returns:

the commandline command for the specific scm provider. Or null if none is needed.

getScmUrl

public abstract java.lang.String getScmUrl()
                                    throws java.lang.Exception

Returns:

a provider specific and valid url for the repository

Throws:

java.lang.Exception - if any

getScmFileNames

protected java.util.List<java.lang.String> getScmFileNames()

Get the list of file names that is supposed to be in the test repo.

• /pom.xml
• /readme.txt
• /src/main/java/Application.java
• /src/test/java/Test.java

Returns:

List of String objects

initRepo

public abstract void initRepo()
                       throws java.lang.Exception

Initialize repository at the getScmUrl() location with the files in getScmFileNames()

The setup is also asserting on the existence of these files.
This should only be used by this class (thus do not call this method from derived classes)

Note: 'svnadmin' should be a system command.

Throws:

java.lang.Exception - if any

checkScmPresence

public void checkScmPresence()

setUp

public void setUp()
           throws java.lang.Exception

Overrides:

setUp in class ScmTestCase

Throws:

java.lang.Exception

removeRepo

public void removeRepo()
                throws java.lang.Exception

This method is available to those SCM clients that need to perform a cleanup at the end of the tests. It is needed when server side operations are performed, or the check out dirs are outside of the normal target directory.

Throws:

java.lang.Exception

tearDown

public void tearDown()
              throws java.lang.Exception

Provided to allow removeRepo() to be called.

Overrides:

tearDown in class PlexusJUnit4TestCase

Throws:

java.lang.Exception

getScmRepository

protected ScmRepository getScmRepository()
                                  throws java.lang.Exception

Convenience method to get the ScmRepository for this provider.

Throws:

java.lang.Exception

checkOut

protected CheckOutScmResult checkOut(java.io.File workingDirectory,
                                     ScmRepository repository)
                              throws java.lang.Exception

Convenience method to check out files from the repository.

Throws:

java.lang.Exception

checkIn

protected CheckInScmResult checkIn(java.io.File workingDirectory,
                                   ScmRepository repository)
                            throws java.lang.Exception

Convenience method to check in files to the repository.

Throws:

java.lang.Exception

remove

protected RemoveScmResult remove(java.io.File workingDirectory,
                                 ScmRepository repository)
                          throws java.lang.Exception

Convenience method to remove files from the repository.

Throws:

java.lang.Exception

addToWorkingTree

protected void addToWorkingTree(java.io.File workingDirectory,
                                java.io.File file,
                                ScmRepository repository)
                         throws java.lang.Exception

Convenience method to add a file to the working tree at the working directory.

Throws:

java.lang.Exception

mapFilesByPath

protected java.util.Map<java.lang.String,ScmFile> mapFilesByPath(java.util.List<ScmFile> files)

Take the files of the given list, add them to a TreeMap and use the pathName String as key for the Map. This function is useful for every TCK which has to check for the existence of more than 1 file of the returned ScmResult, regardless of their order in the list. All backslashes in the path will be replaced by forward slashes for Windows compatibility.

Parameters:

files - list with ScmFiles

Returns:

map key=pathName, value=ScmFile

edit

protected EditScmResult edit(java.io.File basedir,
                             java.lang.String includes,
                             java.lang.String excludes,
                             ScmRepository repository)
                      throws java.lang.Exception

Throws:

java.lang.Exception