org.prorefactor.core.unittest
Class UnitTestBase2

java.lang.Object
  TestCase
      org.prorefactor.core.unittest.UnitTestBase2

Direct Known Subclasses:

AliasesT, AppendProgramT, BubbleDecsT, ExtractMethodT, HandleCollectionT, MoveDataMemberT, NamesT, NoUndoT, PstringT, PUBTest, QualifyFieldsTest, RefactorT, RenameT, SourceProcessorT, TP01FramesTest, TP01Test01, TP01Test02, TP01Test03, UtilT, WrapProcT

public class UnitTestBase2
extends TestCase

Base class for unit tests. Does no tests itself, but does import the basics, implements common functions.

Field Summary

java.io.FileFilter

testCompareDirectoriesFilter The filter used for testCompareDirectories and testCompareFiles.

Constructor Summary

UnitTestBase2(java.lang.String s)

Method Summary

java.lang.String	testCompareDirectories(java.io.File dir1, java.io.File dir2) Recursively compare two directories (ex: "out" and "expect").
java.lang.String	testCompareDirectories2(java.io.File dir1, java.io.File dir2, ICallback fileTest) Recursively compare two directories.
java.lang.String	testCompareFiles(java.io.File dir1, java.io.File dir2) Recursively compare files in two directories (ex: "out" and "expect").
java.lang.String	testCompareSingle(java.io.File first, java.io.File second) Compare two files.

Methods inherited from class java.lang.Object

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

Field Detail

testCompareDirectoriesFilter

public java.io.FileFilter testCompareDirectoriesFilter

The filter used for testCompareDirectories and testCompareFiles. The default is to ignore directories named "CVS" and ".svn".

Constructor Detail

UnitTestBase2

public UnitTestBase2(java.lang.String s)

Method Detail

testCompareDirectories

public java.lang.String testCompareDirectories(java.io.File dir1,
                                               java.io.File dir2)

Recursively compare two directories (ex: "out" and "expect"). Does not compare file contents. Descends directories recursively. By default, ignores "CVS" directories. Tests that all files in dir1 exist in dir2, and also tests the reverse.

Returns:

String error message on first missing file, null if no differences found.

testCompareDirectories2

public java.lang.String testCompareDirectories2(java.io.File dir1,
                                                java.io.File dir2,
                                                ICallback fileTest)

Recursively compare two directories. It recursively looks at the files list from dir2, and checks that each of those files exists in dir1. By default, ignores "CVS" directories. This does not do the reverse test - does not test that files in dir1 exist in dir2. To do that, call this function a second time with the directories reversed.

Parameters:

dir1 - All files in dir2 are tested for existence in dir1.

dir2 - All files in dir2 are tested for existence in dir1.

fileTest - A callback to a test. It will receive a Pair (the two File objects), and is expected to return null if no difference, or a String error message otherwise. Not called for directories.

Returns:

String error message on the first missing file or file difference, null if no differences found.

testCompareFiles

public java.lang.String testCompareFiles(java.io.File dir1,
                                         java.io.File dir2)

Recursively compare files in two directories (ex: "out" and "expect"). Descends directories recursively. By default, ignores "CVS" directories. Tests that all files in dir1 exist in dir2, and also tests the reverse.

Returns:

String error message on first difference or missing file, null if no differences found.

testCompareSingle

public java.lang.String testCompareSingle(java.io.File first,
                                          java.io.File second)

Compare two files.

Returns:

String error message on first difference or missing file, null if no differences found.