org.apache.derbyTesting.junit

Class SupportFilesSetup

java.lang.Object

junit.framework.Assert

junit.extensions.TestDecorator

junit.extensions.TestSetup

org.apache.derbyTesting.junit.SupportFilesSetup

All Implemented Interfaces:

junit.framework.Test

public class SupportFilesSetup
extends junit.extensions.TestSetup

A decorator that copies test resources from the classpath into the file system at setUp time. Resources are named relative to org/apache/derbyTesting/, e.g. the name passed into the constructor should be something like funtionTests/test/lang/mytest.sql
Read only resources are placed into ${user.dir}/extin/name Read-write resources are placed into ${user.dir}/extinout/name write only output files can be created in ${user.dir}/extout These locations map to entries in the test policy file that have restricted permissions granted. All the three folders are created even if no files are copied into them. In each case the name of a file is the base name of the resource, no package structure is retained. A test may access such a resource using either files or URLs. The static utility methods must be used to obtain the location of any resource. In the future this decorator may create sub-folders to ensure that tests run in paralled do not interfere with each other. tearDown removes the three folders and their contents.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTIN
static java.lang.String	EXTINOUT
static java.lang.String	EXTOUT
private java.lang.String[]	readOnly
private java.lang.String[]	readOnlyTargetFileNames
private java.lang.String[]	readWrite
private java.lang.String[]	readWriteTargetFileNames

Fields inherited from class junit.extensions.TestDecorator

fTest

Constructor Summary

Constructors

Constructor and Description
SupportFilesSetup(junit.framework.Test test) Create all the folders but don't copy any resources.
SupportFilesSetup(junit.framework.Test test, java.lang.String[] readOnly) Create all the folders and copy a set of resources into the read only folder.
SupportFilesSetup(junit.framework.Test test, java.lang.String[] readOnly, java.lang.String[] readWrite) Create all the folders, copy a set of resources into the read only folder and copy a set of resources into the read write folder.
SupportFilesSetup(junit.framework.Test test, java.lang.String[] readOnly, java.lang.String[] readWrite, java.lang.String[] readOnlyTargetFileNames, java.lang.String[] readWriteTargetFileNames) Create all the folders, copy a set of resources into the read only folder and copy a set of resources into the read write folder.

Method Summary

Modifier and Type	Method and Description
private static void	copyFiles(java.lang.String dirName, java.lang.String[] resources, java.lang.String[] targetNames)
static void	deleteFile(java.lang.String fileName)
private static java.io.File	getFile(java.lang.String dirName, java.lang.String name)
static java.io.File	getReadOnly(java.lang.String name) Obtain a File for the local copy of a read-only resource.
static java.lang.String	getReadOnlyFileName(java.lang.String name) Get the full name of the file.
static java.net.URL	getReadOnlyURL(java.lang.String name) Obtain the URL to the local copy of a read-only resource.
static java.io.File	getReadWrite(java.lang.String name) Obtain a File for the local copy of a read-write resource.
static java.lang.String	getReadWriteFileName(java.lang.String name) Get the full name of the file.
static java.net.URL	getReadWriteURL(java.lang.String name) Obtain the URL to the local copy of a read-write resource.
private static java.net.URL	getURL(java.io.File file)
static java.io.File	getWriteOnly(java.lang.String name) Obtain a File for the local copy of a write-only resource.
static java.net.URL	getWriteOnlyURL(java.lang.String name) Obtain the URL to the local copy of a write-only resource.
static void	privCopyFiles(java.lang.String dirName, java.lang.String[] resources, java.lang.String[] targetNames)
protected void	setUp()
protected void	tearDown()

Methods inherited from class junit.extensions.TestSetup

run

Methods inherited from class junit.extensions.TestDecorator

basicRun, countTestCases, getTest, toString

Methods inherited from class junit.framework.Assert

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, fail, fail, failNotEquals, failNotSame, failSame, format

Methods inherited from class java.lang.Object

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

Field Detail

EXTIN

public static final java.lang.String EXTIN

See Also:

Constant Field Values

EXTINOUT

public static final java.lang.String EXTINOUT

See Also:

Constant Field Values

EXTOUT

public static final java.lang.String EXTOUT

See Also:

Constant Field Values

readOnly

private java.lang.String[] readOnly

readWrite

private java.lang.String[] readWrite

readOnlyTargetFileNames

private java.lang.String[] readOnlyTargetFileNames

readWriteTargetFileNames

private java.lang.String[] readWriteTargetFileNames

Constructor Detail

SupportFilesSetup

public SupportFilesSetup(junit.framework.Test test)

Create all the folders but don't copy any resources.

SupportFilesSetup

public SupportFilesSetup(junit.framework.Test test,
                         java.lang.String[] readOnly)

Create all the folders and copy a set of resources into the read only folder.

SupportFilesSetup

public SupportFilesSetup(junit.framework.Test test,
                         java.lang.String[] readOnly,
                         java.lang.String[] readWrite)

Create all the folders, copy a set of resources into the read only folder and copy a set of resources into the read write folder.

SupportFilesSetup

public SupportFilesSetup(junit.framework.Test test,
                         java.lang.String[] readOnly,
                         java.lang.String[] readWrite,
                         java.lang.String[] readOnlyTargetFileNames,
                         java.lang.String[] readWriteTargetFileNames)

Create all the folders, copy a set of resources into the read only folder and copy a set of resources into the read write folder. If specified, use the specific target file supplied by the caller.

Method Detail

setUp

protected void setUp()
              throws java.security.PrivilegedActionException,
                     java.io.IOException

Overrides:

setUp in class junit.extensions.TestSetup

Throws:

java.security.PrivilegedActionException

java.io.IOException

tearDown

protected void tearDown()

Overrides:

tearDown in class junit.extensions.TestSetup

privCopyFiles

public static void privCopyFiles(java.lang.String dirName,
                                 java.lang.String[] resources,
                                 java.lang.String[] targetNames)
                          throws java.security.PrivilegedActionException

Throws:

java.security.PrivilegedActionException

copyFiles

private static void copyFiles(java.lang.String dirName,
                              java.lang.String[] resources,
                              java.lang.String[] targetNames)
                       throws java.security.PrivilegedActionException,
                              java.io.IOException

Throws:

java.security.PrivilegedActionException

java.io.IOException

getReadOnlyURL

public static java.net.URL getReadOnlyURL(java.lang.String name)
                                   throws java.net.MalformedURLException

Obtain the URL to the local copy of a read-only resource.

Parameters:

name - Base name for the resouce.

Throws:

java.net.MalformedURLException

getReadWriteURL

public static java.net.URL getReadWriteURL(java.lang.String name)
                                    throws java.net.MalformedURLException

Obtain the URL to the local copy of a read-write resource.

Parameters:

name - Base name for the resouce.

Throws:

java.net.MalformedURLException

getWriteOnlyURL

public static java.net.URL getWriteOnlyURL(java.lang.String name)
                                    throws java.net.MalformedURLException

Obtain the URL to the local copy of a write-only resource.

Parameters:

name - Base name for the resouce.

Throws:

java.net.MalformedURLException

getReadOnly

public static java.io.File getReadOnly(java.lang.String name)

Obtain a File for the local copy of a read-only resource.

Parameters:

name - Base name for the resouce.

getReadOnlyFileName

public static java.lang.String getReadOnlyFileName(java.lang.String name)
                                            throws java.lang.Exception

Get the full name of the file.

Parameters:

name - Base name for the resouce.

Throws:

java.lang.Exception

getReadWriteFileName

public static java.lang.String getReadWriteFileName(java.lang.String name)

Get the full name of the file.

Parameters:

name - short name of file

Returns:

absolute path of file in EXTINOUT

getReadWrite

public static java.io.File getReadWrite(java.lang.String name)

Obtain a File for the local copy of a read-write resource.

Parameters:

name - Base name for the resouce.

getWriteOnly

public static java.io.File getWriteOnly(java.lang.String name)

Obtain a File for the local copy of a write-only resource.

Parameters:

name - Base name for the resouce.

getFile

private static java.io.File getFile(java.lang.String dirName,
                                    java.lang.String name)

getURL

private static java.net.URL getURL(java.io.File file)
                            throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

deleteFile

public static void deleteFile(java.lang.String fileName)