org.apache.calcite.test

类 DiffTestCase

java.lang.Object

org.apache.calcite.test.DiffTestCase

public abstract class DiffTestCase
extends Object

DiffTestCase is an abstract base for JUnit tests which produce multi-line output to be verified by diffing against a pre-existing reference file.

字段概要

字段

限定符和类型	字段和说明
protected File	logFile Name of current .log file.
protected OutputStream	logOutputStream OutputStream for current test log.
protected File	refFile Name of current .ref file.

构造器概要

构造器

限定符	构造器和说明
protected	DiffTestCase(String testCaseName) Initializes a new DiffTestCase.

方法概要

限定符和类型	方法和说明
protected void	addDiffMask(String mask) Adds a diff mask.
protected void	addIgnorePattern(String javaPattern)
static String	diff(File file1, File file2) Returns a string containing the difference between the contents of two files.
protected void	diffFile(File logFile, File refFile) Compares a log file with its reference log.
static String	diffLines(List<String> lines1, List<String> lines2) Returns a string containing the difference between the two sets of lines.
protected void	diffTestLog() Finishes a diff-based test.
protected static String	fileContents(File file) Returns the contents of a file as a string.
protected abstract File	getTestlogRoot() Returns the root directory under which testlogs should be written.
protected Writer	openTestLog() Initializes a diff-based test.
protected OutputStream	openTestLogOutputStream(File testFileSansExt) Initializes a diff-based test, overriding the default log file naming scheme altogether.
protected void	setRefFileDiffMasks() Sets the diff masks that are common to .REF files
protected void	setUp()
protected void	setVerbose(boolean verbose) Sets whether to give verbose message if diff fails.
protected void	tearDown()

从类继承的方法 java.lang.Object

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

字段详细资料

logFile

protected File logFile

Name of current .log file.

refFile

protected File refFile

Name of current .ref file.

logOutputStream

protected OutputStream logOutputStream

OutputStream for current test log.

构造器详细资料

DiffTestCase

protected DiffTestCase(String testCaseName)
                throws Exception

Initializes a new DiffTestCase.

参数:

testCaseName - Test case name

抛出:

Exception

方法详细资料

setUp

@BeforeEach
protected void setUp()

tearDown

@AfterEach
protected void tearDown()
                            throws IOException

抛出:

IOException

openTestLog

protected Writer openTestLog()
                      throws Exception

Initializes a diff-based test. Any existing .log and .dif files corresponding to this test case are deleted, and a new, empty .log file is created. The default log file location is a subdirectory under the result getTestlogRoot(), where the subdirectory name is based on the unqualified name of the test class. The generated log file name will be testMethodName.log, and the expected reference file will be testMethodName.ref.

返回:

Writer for log file, which caller should use as a destination for test output to be diffed

抛出:

Exception

getTestlogRoot

protected abstract File getTestlogRoot()
                                throws Exception

Returns the root directory under which testlogs should be written.

抛出:

Exception

openTestLogOutputStream

protected OutputStream openTestLogOutputStream(File testFileSansExt)
                                        throws IOException

Initializes a diff-based test, overriding the default log file naming scheme altogether.

参数:

testFileSansExt - full path to log filename, without .log/.ref extension

抛出:

IOException

diffTestLog

protected void diffTestLog()
                    throws IOException

Finishes a diff-based test. Output that was written to the Writer returned by openTestLog is diffed against a .ref file, and if any differences are detected, the test case fails. Note that the diff used is just a boolean test, and does not create any .dif ouput.

NOTE: if you wrap the Writer returned by openTestLog() (e.g. with a PrintWriter), be sure to flush the wrapping Writer before calling this method.

抛出:

IOException

另请参阅:

diffFile(File, File)

diffFile

protected void diffFile(File logFile,
                        File refFile)
                 throws IOException

Compares a log file with its reference log.

Usually, the log file and the reference log are in the same directory, one ending with '.log' and the other with '.ref'.

If the files are identical, removes logFile.

参数:

logFile - Log file

refFile - Reference log

抛出:

IOException

addDiffMask

protected void addDiffMask(String mask)

Adds a diff mask. Strings matching the given regular expression will be masked before diffing. This can be used to suppress spurious diffs on a case-by-case basis.

参数:

mask - a regular expression, as per String.replaceAll

addIgnorePattern

protected void addIgnorePattern(String javaPattern)

diff

public static String diff(File file1,
                          File file2)

Returns a string containing the difference between the contents of two files. The string has a similar format to the UNIX 'diff' utility.

diffLines

public static String diffLines(List<String> lines1,
                               List<String> lines2)

Returns a string containing the difference between the two sets of lines.

fileContents

protected static String fileContents(File file)

Returns the contents of a file as a string.

参数:

file - File

返回:

Contents of the file

setVerbose

protected void setVerbose(boolean verbose)

Sets whether to give verbose message if diff fails.

setRefFileDiffMasks

protected void setRefFileDiffMasks()

Sets the diff masks that are common to .REF files