ScmTestCase (Maven SCM 1.10.0 API)

java.lang.Object
- junit.framework.Assert
- - junit.framework.TestCase
  - - org.codehaus.plexus.PlexusTestCase
    - - org.apache.maven.scm.ScmTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

AbstractCvsScmTest, ScmTckTestCase
```
public abstract class ScmTestCase
extends org.codehaus.plexus.PlexusTestCase
```
Base class for all scm tests. Consumers will typically extend this class while tck test would extend ScmTckTestCase.
This class basically defines default locations for the test environment and implements convenience methods.

Author:

Jason van Zyl

Field Summary

Fields
Modifier and Type Field and Description

protected static TimeZone GMT_TIME_ZONE
- Fields inherited from class org.codehaus.plexus.PlexusTestCase
  basedir, container

Fields
Modifier and Type	Field and Description
`protected static TimeZone`	`GMT_TIME_ZONE`

Constructor Summary

Constructors
Constructor and Description

ScmTestCase()

Constructors
Constructor and Description
`ScmTestCase()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`assertCommandLine(String expectedCommand, File expectedWorkingDirectory, Commandline actualCommand)`
`protected void`	`assertFile(File root, String fileName)`
`void`	`assertPath(String expectedPath, String actualPath)` TODO This method is bogus.
`protected void`	`assertResultIsSuccess(ScmResult result)`
`protected void`	`deleteDirectory(File directory)`
`static void`	`execute(File workingDirectory, String executable, String arguments)` Execute the command line
`protected File`	`getAssertionCopy()`
`static Date`	`getDate(int year, int month, int day)`
`protected static Date`	`getDate(int year, int month, int day, int hourOfDay, int minute, int second, TimeZone tz)`
`protected static Date`	`getDate(int year, int month, int day, TimeZone tz)`
`protected String`	`getModule()`
`protected File`	`getRepository()`
`protected File`	`getRepositoryRoot()`
`protected ScmFileSet`	`getScmFileSet()`
`protected ScmManager`	`getScmManager()`
`org.sonatype.plexus.components.sec.dispatcher.SecDispatcher`	`getSecDispatcher()` If you wish to use this component, make sure to configure your TCK implementation to include plexus component configuration as doc at https://issues.apache.org/jira/browse/MNG-4384
`protected File`	`getUpdatingCopy()`
`protected File`	`getWorkingCopy()`
`protected File`	`getWorkingDirectory()` Legacy method - same as getWorkingCopy()
`static boolean`	`isSystemCmd(String cmd)`
`protected static void`	`makeDirectory(File basedir, String fileName)`
`protected static void`	`makeFile(File basedir, String fileName)`
`static void`	`makeFile(File basedir, String fileName, String contents)`
`protected ScmRepository`	`makeScmRepository(String scmUrl)`
`protected void`	`printOutputError(ScmResult result)`
`protected static void`	`setDebugExecute(boolean debugExecute)`
`protected void`	`setUp()`

Methods inherited from class org.codehaus.plexus.PlexusTestCase
createContainerInstance, customizeContext, customizeContext, getBasedir, getClassLoader, getConfiguration, getConfiguration, getContainer, getCustomConfiguration, getResourceAsStream, getTestFile, getTestFile, getTestPath, getTestPath, lookup, lookup, release, 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, runTest, setName, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

GMT_TIME_ZONE

protected static final TimeZone GMT_TIME_ZONE

Constructor Detail
- ScmTestCase
```
public ScmTestCase()
```

Method Detail

setUp
```
protected void setUp()
              throws Exception
```
Overrides:

setUp in class org.codehaus.plexus.PlexusTestCase

Throws:

Exception

getModule
```
protected String getModule()
```

getRepositoryRoot
```
protected File getRepositoryRoot()
```
Returns:
default location of the test read/write repository

getRepository
```
protected File getRepository()
```
Returns:
Location of the revisioned (read only) repository

getWorkingCopy
```
protected File getWorkingCopy()
```
Returns:
location of the working copy (always checkout)

getWorkingDirectory
```
protected File getWorkingDirectory()
```
Legacy method - same as getWorkingCopy()

Returns:
location of the working copy (always checkout)

getAssertionCopy
```
protected File getAssertionCopy()
```
Returns:
default location for doing assertions on a working tree

getUpdatingCopy
```
protected File getUpdatingCopy()
```
Returns:
default location for doing update operations on a working tree

getScmManager

protected ScmManager getScmManager()
                            throws Exception

Throws:: Exception

getSecDispatcher
```
public org.sonatype.plexus.components.sec.dispatcher.SecDispatcher getSecDispatcher()
                                                                             throws Exception
```
If you wish to use this component, make sure to configure your TCK implementation to include plexus component configuration as doc at https://issues.apache.org/jira/browse/MNG-4384

Returns:
SecDispatcher

Throws:

Exception

makeScmRepository

protected ScmRepository makeScmRepository(String scmUrl)
                                   throws Exception

Throws:: Exception

assertPath

public void assertPath(String expectedPath,
              String actualPath)
                throws Exception

TODO This method is bogus. ActualPatch is not used and if used, it breaks some unit tests.

Throws:: Exception

assertFile

protected void assertFile(File root,
              String fileName)
                   throws Exception

Throws:: Exception

assertResultIsSuccess

protected void assertResultIsSuccess(ScmResult result)

printOutputError

protected void printOutputError(ScmResult result)

getScmFileSet
```
protected ScmFileSet getScmFileSet()
```

setDebugExecute

protected static void setDebugExecute(boolean debugExecute)

execute
```
public static void execute(File workingDirectory,
           String executable,
           String arguments)
                    throws Exception
```
Execute the command line

Parameters:
workingDirectory - not null
executable - not null, should be a system command
arguments - not null

Throws:

Exception - if any
See Also:
CommandLineUtils.executeCommandLine(Commandline, org.codehaus.plexus.util.cli.StreamConsumer, org.codehaus.plexus.util.cli.StreamConsumer)

makeDirectory

protected static void makeDirectory(File basedir,
                 String fileName)

makeFile

protected static void makeFile(File basedir,
            String fileName)
                        throws IOException

Throws:: IOException

makeFile

public static void makeFile(File basedir,
            String fileName,
            String contents)
                     throws IOException

Throws:: IOException

deleteDirectory

protected void deleteDirectory(File directory)
                        throws IOException

Throws:: IOException

getDate

public static Date getDate(int year,
           int month,
           int day)

getDate

protected static Date getDate(int year,
           int month,
           int day,
           TimeZone tz)

getDate

protected static Date getDate(int year,
           int month,
           int day,
           int hourOfDay,
           int minute,
           int second,
           TimeZone tz)

assertCommandLine

public void assertCommandLine(String expectedCommand,
                     File expectedWorkingDirectory,
                     Commandline actualCommand)
                       throws IOException

Throws:: IOException

isSystemCmd
```
public static boolean isSystemCmd(String cmd)
```
Parameters:
cmd - the executable to run, not null.

Returns:
true

Class ScmTestCase

Field Summary

Fields inherited from class org.codehaus.plexus.PlexusTestCase

Constructor Summary

Method Summary

Methods inherited from class org.codehaus.plexus.PlexusTestCase

Methods inherited from class junit.framework.TestCase

Methods inherited from class java.lang.Object

Field Detail

GMT_TIME_ZONE

Constructor Detail

ScmTestCase

Method Detail

setUp

getModule

getRepositoryRoot

getRepository

getWorkingCopy

getWorkingDirectory

getAssertionCopy

getUpdatingCopy

getScmManager

getSecDispatcher

makeScmRepository

assertPath

assertFile

assertResultIsSuccess

printOutputError

getScmFileSet

setDebugExecute

execute

makeDirectory

makeFile

makeFile

deleteDirectory

getDate

getDate

getDate

assertCommandLine

isSystemCmd