org.andromda.maven.plugin.cartridge

Class FileComparator

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.andromda.maven.plugin.cartridge.FileComparator

All Implemented Interfaces:

junit.framework.Test

public class FileComparator
extends junit.framework.TestCase

Compares two files. It checks if both file do exist and if the contents of both files are equal.

Author:

Chad Brandon, Bob Fields

Constructor Summary

Constructors

Constructor and Description
FileComparator(String testName, File expectedFile, File actualFile, boolean binary) Constructs a new instance of the FileComparator.
FileComparator(String testName, File expectedFile, File actualFile, boolean binary, boolean ignoreWhitespace, boolean ignoreLineEndings, List<String> ignoreLinesWithStrings) Constructs a new instance of the FileComparator.

Method Summary

Methods

Modifier and Type	Method and Description
File	getActualFile() Gets the actual file being compared.
File	getExpectedFile() Gets the file expected file (i.e.
String	removeLinesWithStrings(String input, List<String> patternList)
protected void	testContentsEqual() Loads both the actual and expected files and tests the contents for equality.
void	testEquals() Test if actual and expected file contents are equal.

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, setUp, tearDown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileComparator

public FileComparator(String testName,
              File expectedFile,
              File actualFile,
              boolean binary)

Constructs a new instance of the FileComparator.

Parameters:

testName - the name of the test to run

expectedFile - the location of the expected file

actualFile - the location of the actual file.

binary - whether or not the file is binary, if it is binary contents of the binary are not compared as Strings but as binary files.

FileComparator

public FileComparator(String testName,
              File expectedFile,
              File actualFile,
              boolean binary,
              boolean ignoreWhitespace,
              boolean ignoreLineEndings,
              List<String> ignoreLinesWithStrings)

Constructs a new instance of the FileComparator.

Parameters:

testName - the name of the test to run

expectedFile - the location of the expected file

actualFile - the location of the actual file.

binary - whether or not the file is binary, if it is binary contents of the binary are not compared as Strings but as binary files.

ignoreWhitespace - Ignore whitespace in the comparison

ignoreLineEndings - Ignore Unix/Windows line ending differences \r vs \r\n

ignoreLinesWithStrings - Ignore lines containing the strings in the comparison

Method Detail

testEquals

public void testEquals()

Test if actual and expected file contents are equal.

testContentsEqual

protected void testContentsEqual()

Loads both the actual and expected files and tests the contents for equality.

removeLinesWithStrings

public String removeLinesWithStrings(String input,
                            List<String> patternList)

Parameters:

input -

patternList -

Returns:

String input with the lines containing the string removed

getActualFile

public File getActualFile()

Gets the actual file being compared.

Returns:

the file being compared.

getExpectedFile

public File getExpectedFile()

Gets the file expected file (i.e. the file that the actual file is compared against).

Returns:

the expected file.