org.apache.derbyTesting.junit

Class JDBCPerfTestCase

java.lang.Object

junit.framework.Assert

junit.framework.TestCase

org.apache.derbyTesting.junit.BaseTestCase

org.apache.derbyTesting.junit.BaseJDBCTestCase

org.apache.derbyTesting.junit.JDBCPerfTestCase

All Implemented Interfaces:

junit.framework.Test

Direct Known Subclasses:

BlobAccessTest, Checks, ClobAccessTest, CountTest, HeapScan, IndexScanTest, Populate, Schema, SelectDistinctTest, SortTest, ValuesTest

public class JDBCPerfTestCase
extends BaseJDBCTestCase

Base Class for performance tests. It is useful for a performance test framework to have ability to run a test for I iterations , and repeat the test R times. This class provides this functionality of timing the test for I iterations and repeating the test in the same jvm for R number of times. For JDBCPerfTestCase with R repeats and I iterations This cycle is repeated R times { setUp run once fixture method is run I times(and timed) tearDown is run once } Results are printed out to System.out currently. For each repeat of the test, the elapsed time is printed out and after R repeats of the test, the average elapsed time is also printed. If a test has R repeats and (R>1), then the average elapsed time of the (R-1) runs is printed out and the timing info collected as part of the first testrun is ignored. If R=1, then the average elapsed time prints time for that only run. To see the current output that is printed out, see methods runBare() and runTest() To write a performance test, extend the JDBCPerfTestCase In the example below, ScanCoveredIdxTest is a performance test that extends JDBCPerfTestCase. See below code snippet on how these tests will be added/used. // Add a test fixture 'scanAllRows' in ScanCoveredIdxTest // and to run this test for 100 iterations and to // repeat the test 4 times. int iterations = 100; int repeats = 4; TestSuite suite = new TestSuite(); suite.addTest(new ScanCoveredIdxTest("scanAllRows",iterations,repeats)); // To add client tests. TestSuite client = new TestSuite("Client"); client.addTest(new ScanCoveredIdxTest("scanAllRows",iterations,repeats)); client.addTest(new ScanCoveredIdxTest("scanAndRetrieveAllRows",iterations,repeats)); // This will add the server decorator that will start the // server on setUp of the suite and stop server on tearDown // of the suite. suite.addTest(TestConfiguration.clientServerDecorator(client)); Some improvement areas/ideas: -- Can we use TestResult ,and our own TestRunner to improve on how the results are reported. -- write the perf results to a file that can be easily consumed for reporting purposes and further analysis against different builds. -- Maybe even write the results out in xml format,and then using xsl the results could be rendered into html reports

Field Summary

Fields

Modifier and Type	Field and Description
private long	endTime store timing information
private int	iterations Store info on how many times the test fixture should be run also see runTest() on how iterations is used
private int	repeats Store info on how many times should the test be repeated default value is 1
private long[]	runs store the elapsed time info for the test runs.
private long	startTime store timing information
private int	testRunNum Hold the elapsedtime info for the testRun given by testRunNum

Fields inherited from class org.apache.derbyTesting.junit.BaseTestCase

DEFAULT_DB_DIR, DERBY_LOG, ERRORSTACKTRACEFILE

Constructor Summary

Constructors

Constructor and Description
JDBCPerfTestCase(java.lang.String name)
JDBCPerfTestCase(java.lang.String name, int iterations, int repeats)

Method Summary

Modifier and Type	Method and Description
protected void	runBareOverridable() runBare, do the whole thing - setup, runTest, cleanup 'repeats' times.
protected void	runTest() Overrides runTest from TestCase, in order to gather elapsed time information.

Methods inherited from class org.apache.derbyTesting.junit.BaseJDBCTestCase

assertCallError, assertCheckTable, assertCompileError, assertEquals, assertEquals, assertEquals, assertEquivalentDataType, assertErrorCode, assertGetIntError, assertNextError, assertPreparedStatementError, assertSQLExceptionEquals, assertSQLState, assertSQLState, assertStatementError, assertStatementError, assertStatementError, assertStatementError, assertStatementErrorUnordered, assertTableRowCount, assertUpdateCount, assertUpdateCount, assertWarning, checkAllConsistency, checkEstimatedRowCount, closeStatement, commit, createStatement, createStatement, createStatement, dropTable, dropTable, dropView, dropView, emptyStatementCache, getClientTransactionID, getConnection, getDatabaseProperty, getLastSQLException, initializeConnection, openConnection, openDefaultConnection, openDefaultConnection, openDefaultConnection, openUserConnection, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, rollback, runBare, runScript, runScript, runSQLCommands, setAutoCommit, tearDown, usingDB2Client, usingDerbyNetClient, usingEmbedded

Methods inherited from class org.apache.derbyTesting.junit.BaseTestCase

alarm, assertDirectoryDeleted, assertEquals, assertEquals, assertEquals, assertEquals, assertEquals, assertExecJavaCmdAsExpected, assertLaunchedJUnitTestMethod, assertLaunchedJUnitTestMethod, assertSecurityManager, assertThrowableEquals, currentDirectory, execJavaCmd, execJavaCmd, fail, getClassVersionMajor, getEmmaJar, getFailureFolder, getFilesWith, getJavaExecutableName, getSystemProperty, getTestConfiguration, getTestResource, hasInterruptibleIO, isCVM, isIBMJVM, isJ9Platform, isJava5, isJava7, isJava8, isPhoneME, isPlatform, isSunJVM, isWindowsPlatform, openTestResource, println, printStackTrace, readProcessOutput, removeDirectory, removeDirectory, removeFiles, removeSystemProperty, runsWithEmma, runsWithJaCoCo, setSystemProperty, sleep, sleepAtLeastOneTick, traceit

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

Methods inherited from class java.lang.Object

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

Field Detail

startTime

private long startTime

store timing information

endTime

private long endTime

store timing information

iterations

private int iterations

Store info on how many times the test fixture should be run also see runTest() on how iterations is used

repeats

private int repeats

Store info on how many times should the test be repeated default value is 1

testRunNum

private int testRunNum

Hold the elapsedtime info for the testRun given by testRunNum

runs

private long[] runs

store the elapsed time info for the test runs.

Constructor Detail

JDBCPerfTestCase

public JDBCPerfTestCase(java.lang.String name)

JDBCPerfTestCase

public JDBCPerfTestCase(java.lang.String name,
                        int iterations,
                        int repeats)

Parameters:

name - testname

iterations - iterations of the test to measure at one shot.

repeats - is the number of times the entire test be repeated

See Also:

class level comments

Method Detail

runBareOverridable

protected void runBareOverridable()
                           throws java.lang.Throwable

runBare, do the whole thing - setup, runTest, cleanup 'repeats' times. If test was run for more than one time, then ignore the first testrun results and print the average elapsed time for the remaining runs.

Overrides:

runBareOverridable in class BaseJDBCTestCase

Throws:

java.lang.Throwable

runTest

protected void runTest()
                throws java.lang.Throwable

Overrides runTest from TestCase, in order to gather elapsed time information. Run the testfixture for 'iterations' times and store the time taken for the particular testrun and print it to System.out Note: this method will NOT time the setUp or tearDown methods

Overrides:

runTest in class junit.framework.TestCase

Throws:

java.lang.Throwable