ch.qos.logback.core.rolling.testUtil

Class ScaffoldingForRollingTests

java.lang.Object

ch.qos.logback.core.rolling.testUtil.ScaffoldingForRollingTests

Direct Known Subclasses:

JVMExitBeforeCompressionISDoneTest, SizeAndTimeBasedFNATP_Test, SizeBasedRollingTest, TimeBasedRollingTest, TimeBasedRollingWithArchiveRemoval_Test, TimeBasedRollingWithConfigFileTest

public class ScaffoldingForRollingTests
extends Object

Scaffolding for various rolling tests. Some assumptions are made: - rollover periodicity is 1 second (without precluding size based roll-over)

Author:

Ceki Gülcü

Field Summary

Fields

Modifier and Type	Field and Description
protected Context	context
protected long	currentTime
static String	DATE_PATTERN_BY_DAY
static String	DATE_PATTERN_WITH_SECONDS
protected EchoEncoder<Object>	encoder
protected List<String>	expectedFilenameList
protected List<Future<?>>	futureList
protected long	nextRolloverThreshold
protected String	randomOutputDir
static SimpleDateFormat	SDF

Constructor Summary

Constructors

Constructor and Description
ScaffoldingForRollingTests()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	add(Future<?> future)
protected void	addExpectedFileName_ByDate(String patternStr, long millis)
protected void	addExpectedFileName_ByDate(String outputDir, String testId, Date date, boolean gzExtension)
protected void	addExpectedFileName_ByFileIndexCounter(String randomOutputDir, String testId, long millis, int fileIndexCounter, String compressionSuffix)
protected void	addExpectedFileNamedIfItsTime_ByDate(String fileNamePatternStr)
protected void	addExpectedFileNamedIfItsTime_ByDate(String outputDir, String testId, boolean gzExtension)
protected void	checkZipEntryMatchesZipFilename(List<String> expectedFilenameList)
static void	existenceCheck(List<String> filenameList)
static void	existenceCheck(String filename)
static int	existenceCount(List<String> filenameList)
static void	fileContentCheck(File[] fileArray, int runLength, String prefix)
static void	fileContentCheck(File[] fileArray, int runLength, String prefix, int runStart)
protected List<String>	filterElementsInListBySuffix(String suffix)
protected Date	getDateOfCurrentPeriodsStart()
protected Date	getDateOfPreviousPeriodsStart()
static File[]	getFilesInDirectory(String outputDirStr)
protected long	getMillisOfCurrentPeriodsStart()
protected void	incCurrentTime(long increment)
protected void	massageExpectedFilesToCorresponToCurrentTarget(String fileName, boolean fileOptionIsSet)
protected boolean	passThresholdTime(long nextRolloverThreshold)
protected void	recomputeRolloverThreshold(long ct)
static void	reverseSortedContentCheck(String outputDirStr, int runLength, String prefix)
void	setUp()
static void	sortedContentCheck(String outputDirStr, int runLength, String prefix)
static void	sortedContentCheck(String outputDirStr, int runLength, String prefix, int runStart)
protected String	testId2FileName(String testId)
protected void	waitForJobsToComplete()
protected void	zipEntryNameCheck(List<String> expectedFilenameList, String pattern)

Methods inherited from class java.lang.Object

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

Field Detail

DATE_PATTERN_WITH_SECONDS

public static final String DATE_PATTERN_WITH_SECONDS

See Also:

Constant Field Values

DATE_PATTERN_BY_DAY

public static final String DATE_PATTERN_BY_DAY

See Also:

Constant Field Values

SDF

public static final SimpleDateFormat SDF

randomOutputDir

protected String randomOutputDir

encoder

protected EchoEncoder<Object> encoder

context

protected Context context

expectedFilenameList

protected List<String> expectedFilenameList

nextRolloverThreshold

protected long nextRolloverThreshold

currentTime

protected long currentTime

futureList

protected List<Future<?>> futureList

Constructor Detail

ScaffoldingForRollingTests

public ScaffoldingForRollingTests()

Method Detail

setUp

public void setUp()

existenceCheck

public static void existenceCheck(String filename)

getFilesInDirectory

public static File[] getFilesInDirectory(String outputDirStr)

fileContentCheck

public static void fileContentCheck(File[] fileArray,
                    int runLength,
                    String prefix)
                             throws IOException

Throws:

IOException

fileContentCheck

public static void fileContentCheck(File[] fileArray,
                    int runLength,
                    String prefix,
                    int runStart)
                             throws IOException

Throws:

IOException

sortedContentCheck

public static void sortedContentCheck(String outputDirStr,
                      int runLength,
                      String prefix)
                               throws IOException

Throws:

IOException

sortedContentCheck

public static void sortedContentCheck(String outputDirStr,
                      int runLength,
                      String prefix,
                      int runStart)
                               throws IOException

Throws:

IOException

reverseSortedContentCheck

public static void reverseSortedContentCheck(String outputDirStr,
                             int runLength,
                             String prefix)
                                      throws IOException

Throws:

IOException

existenceCheck

public static void existenceCheck(List<String> filenameList)

existenceCount

public static int existenceCount(List<String> filenameList)

testId2FileName

protected String testId2FileName(String testId)

recomputeRolloverThreshold

protected void recomputeRolloverThreshold(long ct)

passThresholdTime

protected boolean passThresholdTime(long nextRolloverThreshold)

incCurrentTime

protected void incCurrentTime(long increment)

getDateOfCurrentPeriodsStart

protected Date getDateOfCurrentPeriodsStart()

getDateOfPreviousPeriodsStart

protected Date getDateOfPreviousPeriodsStart()

getMillisOfCurrentPeriodsStart

protected long getMillisOfCurrentPeriodsStart()

addExpectedFileName_ByDate

protected void addExpectedFileName_ByDate(String patternStr,
                              long millis)

addExpectedFileNamedIfItsTime_ByDate

protected void addExpectedFileNamedIfItsTime_ByDate(String fileNamePatternStr)

addExpectedFileName_ByDate

protected void addExpectedFileName_ByDate(String outputDir,
                              String testId,
                              Date date,
                              boolean gzExtension)

addExpectedFileName_ByFileIndexCounter

protected void addExpectedFileName_ByFileIndexCounter(String randomOutputDir,
                                          String testId,
                                          long millis,
                                          int fileIndexCounter,
                                          String compressionSuffix)

filterElementsInListBySuffix

protected List<String> filterElementsInListBySuffix(String suffix)

addExpectedFileNamedIfItsTime_ByDate

protected void addExpectedFileNamedIfItsTime_ByDate(String outputDir,
                                        String testId,
                                        boolean gzExtension)

massageExpectedFilesToCorresponToCurrentTarget

protected void massageExpectedFilesToCorresponToCurrentTarget(String fileName,
                                                  boolean fileOptionIsSet)

zipEntryNameCheck

protected void zipEntryNameCheck(List<String> expectedFilenameList,
                     String pattern)
                          throws IOException

Throws:

IOException

checkZipEntryMatchesZipFilename

protected void checkZipEntryMatchesZipFilename(List<String> expectedFilenameList)
                                        throws IOException

Throws:

IOException

add

protected void add(Future<?> future)

waitForJobsToComplete

protected void waitForJobsToComplete()