[jbosscache-commits] JBoss Cache SVN: r5162 - in benchmarks/benchmark-fwk/trunk: doc and 2 other directories.

jbosscache-commits at lists.jboss.org jbosscache-commits at lists.jboss.org
Thu Jan 17 19:08:00 EST 2008


Author: mircea.markus
Date: 2008-01-17 19:07:59 -0500 (Thu, 17 Jan 2008)
New Revision: 5162

Removed:
   benchmarks/benchmark-fwk/trunk/doc/CacheReport.txt
   benchmarks/benchmark-fwk/trunk/doc/ExceptionHandling.txt
   benchmarks/benchmark-fwk/trunk/doc/TestTypes.txt
Modified:
   benchmarks/benchmark-fwk/trunk/conf/cachebench.xml
   benchmarks/benchmark-fwk/trunk/doc/Documentation.txt
   benchmarks/benchmark-fwk/trunk/doc/TODO.txt
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/SessionSimulatorTest.java
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/AssociationsTest.java
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/CustomClassTest.java
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/PrimitiveTest.java
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/SimpleTest.java
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/StaticsTest.java
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/StringTest.java
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/SubclassTest.java
   benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/TransientTest.java
Log:
commented and cleaned up

Modified: benchmarks/benchmark-fwk/trunk/conf/cachebench.xml
===================================================================
--- benchmarks/benchmark-fwk/trunk/conf/cachebench.xml	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/conf/cachebench.xml	2008-01-18 00:07:59 UTC (rev 5162)
@@ -1,7 +1,7 @@
 <!--
 	Configures and controls the behaviour of the cache benchmarking framework.
 
-   TODO - sample size is test specific, moove it to the test that use it rather than having it here
+   TODO - sample size is test specific, move it to the test that uses it rather than having it here
 	sampleSize -  this is the number of putsgets to be performed, an average is used in metrics.
 	gcBetweenTestsEnabled - if true, the framework pauses between each test and requests System.gc() - use this if you find yourself running out of mem!
 	sleepBetweenTests - ms to sleep between tests.  useful to allow the JVM some time to do a gc
@@ -14,9 +14,7 @@
    <!--
          There are various steps we want to start executing at once: e.g. all the tests should start at the same time,
       otherwise (part of) cluster operations do not replicate on all instances. We configure here one socket addresses
-      on each tested node, so that the framework can communicate with all the nodes and sync whenever needed.
-         - bindAddress can be used on a multi-homed host for a ServerSocket that will only accept connect requests to one
-         of its addresses
+      on each cluster node, so that the framework can communicate with all the nodes and barrier whenever needed.
          - for each node instance socket address is specified. You can make sure that addresses are available by using
          checkClusterAddresses ant target 
    -->
@@ -32,9 +30,10 @@
       <member host="cluster09" port="17900"/> 
    </cluster>
 
-   <!-- Each testcase represents either a single configuration or a cacheing product.
-   For example, WhirlyCache would be one test case. JBossCache-standalone could be another, JBossCache-replicated could be yet another
-      testcase::stopOnFailure if set to true and one test in this testcase fails then the process will exit
+   <!--
+     Locagically groups multiple tests.
+     param stopOnFailre : if true and one of the tests fails unexpectedly then the fwk will not run any other tests in
+                          testcase. By default set to true.
    -->
 
     <testcase name="WebSessionReplicationTest" stopOnFailure="true">
@@ -61,7 +60,7 @@
       -->
        <!--<test name="Strings" testClass="org.cachebench.tests.simpletests.StringTest" weight="2.0" />-->
        
-       <test name="Strings" testClass="org.cachebench.tests.SessionSimulatorTest" weight="2.0" >
+       <test name="SessionSimulator" testClass="org.cachebench.tests.SessionSimulatorTest" weight="2.0" >
           <param name="numberOfRequest" value="100000"/>
           <param name="numberOfAttributes" value="100"/>
           <param name="writePercentage" value="20"/>

Deleted: benchmarks/benchmark-fwk/trunk/doc/CacheReport.txt
===================================================================
--- benchmarks/benchmark-fwk/trunk/doc/CacheReport.txt	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/doc/CacheReport.txt	2008-01-18 00:07:59 UTC (rev 5162)
@@ -1,50 +0,0 @@
-This document describes the report generated by the Bech marker.
-
-The Release 1 of the tool only supports a CSV report with the following fields.
-
-TEST NAME
-The name of the cache product that has been tested. This maps to the testcase/name of the cachebench.xml (The cach bechmarker configuration file).
-
-TEST DATE
-The time stamp of a test that has been executed.
-
-TEST TYPE
-The test that has been executed. This maps to the testcase/test/name of the cachebench.xml (The cach bechmarker configuration file).
-
-MEAN PUT TIME
-The statistical average on the PUT time on specified test. The average is based on the number of tests specified in the cachebench/sampleSize of the cachebench.xml (The cach bechmarker configuration file).
-This statistic would help you identify the average time a prodcut takes to perform a specific action for a given number of iterations and an anticipated load.
-
-MEAN GET TIME
-The statistical average on the GET time on specified test. The average is based on the number of tests specified in the cachebench/sampleSize of the cachebench.xml (The cach bechmarker configuration file).
-This statistic would help you identify the average time a prodcut takes to perform a specific action for a given number of iterations and an anticipated load.
-
-MEDIAN PUT TIME
-The mid point of the PUT actions done on a specific test. The number of puts are based on the number specified in the cachebench/sampleSize of the cachebench.xml (The cach bechmarker configuration file).
-This statistic would give a sense of the mid point of the series of times a particular action took on a specific test.
-
-MEDIAN GET TIME
-The mid point of the GET actions done on a specific test. The number of puts are based on the number specified in the cachebench/sampleSize of the cachebench.xml (The cach bechmarker configuration file).
-This statistic would give a sense of the mid point of the series of times a particular action took on a specific test.
-
-STANDARD DEVIATION PUT TIME
-This is the stadard deviation of the times taken to perform the PUT operation for a specific test.
-This statistic helps understand the variability of the diffrent times taken to perform the PUT operations for the test.
-With a high standard deviation it shows that the the variability between the times are high, and by that gives a sense of how well the test has performed with growing data.
-
-STANDARD DEVIATION GET TIME
-This is the stadard deviation of the times taken to perform the GET operation for a specific test.
-This statistic helps understand the variability of the diffrent times taken to perform the GET operations for the test.
-With a high standard deviation it shows that the the variability between the times are high, and by that gives a sense of how well the test has performed with growing data.
-
-MAX PUT TIME
-This is the maximum PUT time that a test has taken during its iteration of actions. The iterations depend on the cachebench/sampleSize specifed in the cachebench.xml (The cach bechmarker configuration file).
-
-MAX GET TIME
-This is the maximum GET time that a test has taken during its iteration of actions. The iterations depend on the cachebench/sampleSize specifed in the cachebench.xml (The cach bechmarker configuration file).
-
-MIN PUT TIME
-This is the minimum PUT time that a test has taken during its iteration of actions. The iterations depend on the cachebench/sampleSize specifed in the cachebench.xml (The cach bechmarker configuration file).
-
-MAX GET TIME
-This is the minimum GET time that a test has taken during its iteration of actions. The iterations depend on the cachebench/sampleSize specifed in the cachebench.xml (The cach bechmarker configuration file).

Modified: benchmarks/benchmark-fwk/trunk/doc/Documentation.txt
===================================================================
--- benchmarks/benchmark-fwk/trunk/doc/Documentation.txt	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/doc/Documentation.txt	2008-01-18 00:07:59 UTC (rev 5162)
@@ -1,101 +1 @@
-Wrappers:
-=========
-The goal of the CacheBenchFwk is to provide a harness which can test individual caching products in a repeatable way and
-provide statistics to bechmark different caching products
-
-The framework is a simple set of wrappers around each cache product, each wrapper implementing the org.cachebench.
-CacheWrapper interface, to provide the framework with a standard way of accessing the cache's functionality.
-Some wrappers are in the org.cachebench.cachewrappers package.  We expect to have more wrappers here for specific
-caching products, and expect end users to create their own cache wrappers if necessary.
-
-A wrapper could be implemented in two ways:
- - Serializable
- - Non-serializable
-
-Serializable:
-Certain cache products, provide only serializable values to be processed in cache. Thus, implementing
-a wrapper for such cache product, the SerializableCacheWrapper needs to be implemented.
-
-Non-serializable:
-For Cache products that allow values which are non-serializable to be processed in cache, the CacheWrapper
-should be implemented.
-
-The cachebench.xml (The configuration file for the framework)
-=============================================================
-The CacheBenchFwk is configured, entirely on the cachebench.xml. The xml provides the means to handle:
- - The tests that needs to be performed, and what product should be tested.
- - Provides additional information for the framework such as periodic breaks in the cache operations, cache size etc.
- - Provides the means in configurating the report
-
-Following are the details of the different nodes and attributes of the cachebench.xml:
-<cachebench>
-This is the root node of the xml.
-:sampleSize
-  - Integer value
-  - This indicates the maximum size of the cahce to be tested.
-:gcBetweenTestsEnabled
-
-:sleepBetweenTests
-
-:emptyCacheBetweenTests
-
-<testcase>
-This node holds the information about the tests that needs to be executed. It would contain a collection of <test> nodes
-(which would explained further) and general test information that would describe the type of test that should be executed.
-:name
-  - String value
-  - This holds the name of the product under test
-:cacheWrapper
-  - String value
-  - This holds the fully qualified class name of the wrapper of the product under test (Ref: Documentation on wrappers)
-<test>
-This node defines the individual test to be executed. The name and class of the test would be indicated here, for the
-framework to execute them.
-:name
-  - String value
-  - The name of the test to be executed.
-:testClass
-  - String value
-  - The fully qualified class name of the test class which will be executed by the framework. (Ref: Documentation on Test types)
-:weight
-  - Double value
-  - This is the importance each test would be given by the framework. This is yet to be implemented TODO.
-<test>
-<param>
-This node gives the means in adding any configurable attributes that might be needed by different cache products.
-:name
-  - String value
-  - The name of the configurable parameter
-:value
-  - String value
-  - The value of the configurable parameter
-</param>
-</testcase>
-
-<report>
-This node defines the report that would be generated by the framework once the tests are executed.
-:outputFile
-  - String value
-  - The file name of the report to be generated. The full path needs to be indicated here.
-:generator
-  - String value
-  - The fully qualified class name of the report warpper used for the report generation purpose (Ref: Documentation on Reports)
-</report>
-</cachebench>
-
-Running clustered tests
-=======================
-
-There is some rudimentary support for clustered tests at the moment, with some limitations:
-
-1.  Only master/slave type tests are supported, where one node performs all the cache puts and gets and performance is
-measured on this master node.  The other nodes just act as dummies which participate in the cluster by acting as recipients
-for network traffic.
-
-2.  Only one <testcase> element at a time is supported if using this setup.  Slaves will barf if configured to deal with
-more than one test case.
-
-3.  Slaves need to be started manually on each host using the runSlave.sh script.
-
-4.  Master nodes have no "intelligence" to wait for a specified number of slaves.  This needs to be done manually, by
-starting the required number of slaves before starting the master.
+http://wiki.jboss.org/wiki/Wiki.jsp?page=CacheBenchmarkFramework
\ No newline at end of file

Deleted: benchmarks/benchmark-fwk/trunk/doc/ExceptionHandling.txt
===================================================================
--- benchmarks/benchmark-fwk/trunk/doc/ExceptionHandling.txt	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/doc/ExceptionHandling.txt	2008-01-18 00:07:59 UTC (rev 5162)
@@ -1,15 +0,0 @@
-Exception Handling in the CacheBenchMarking Framework:
-
-This piece of documentation captures the exception handling mechanism in the framework.
-In shows whats in the respective release. Unless otherwise the current release of the framework doesn't have any specific
-notes in this documentation, the notes for previous release is applicable to the current.
-
-Release 1:
-The only exception dealt with within the framework is the java.lang.Exception.
-Given the avaible functionality and features there hasn't been any need to add framework specific exceptions. We'd get to framework
-specific exception only if the needs arises.
-All Exceptions are handled at only one level to avoid catching-rethrowing complexities. Thus, the CacheBenchMarker, which is the entry
-point to the framework hanldes all expcetions and logs them in the relevant log files and appends them to the report as required.
-All exceptions with their detailed stack trace are logged in the application's log file defined in the log4j configuration file.
-However, the exceptions occured while executing tests, are tracked separately as test results and added to the report. Also the exceptions
-that are generated by the external tasks that take place during the test execution are reported as foot notes to the report.

Modified: benchmarks/benchmark-fwk/trunk/doc/TODO.txt
===================================================================
--- benchmarks/benchmark-fwk/trunk/doc/TODO.txt	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/doc/TODO.txt	2008-01-18 00:07:59 UTC (rev 5162)
@@ -1,22 +1,4 @@
-$Id: TODO.txt,v 1.1 2007/03/13 16:25:15 msurtani Exp $
-The following lists out the featues in their order of priority (High priority --> Low)
-
-1. Add the cache size to the report. Cache size would be measured as the number of objects in the cache initially.
-This would give a method of comparing the put and get times respective to the number of objects in the cache. The number
-of objects would be hard-coded when this feature is completed.
-
-2. Add object count in to the configuration file
-This would give the user a method of configuring the number of objects that he/she wishes to see going into the cache.
-
-3. A way to customize a complex object that coule be used as the object that goes in and out to the cache.
-This is to give the user a method of creating his/her own complex object declared in XML, which he could use to be used
-in the above load test. The user can indicate the number of attributes and type of the attributes for the field.
-Thus giving the user define the test objects apart from the default test objects we have.
-
-4. Tag the gcBetweenTestsEnabled with a object count, so that different VM parameters coule be tried out when
-benchmarking the chaching systems.
-
-5. Add a feature in the report that shows the object size in bytes.
-This would need some work.
-
-6.  Proper agent-based replicated tests where each node in the cluster is stressed.
+1) delegate the build of specific products to the cache-products/specific-product. Also
+2) make the replication test to run BEFORE warmup
+3) conf/config.xml sample size is test specific, move it to the test that uses it rather than having it in the cachebench element
+4) add a target for generating javadoc

Deleted: benchmarks/benchmark-fwk/trunk/doc/TestTypes.txt
===================================================================
--- benchmarks/benchmark-fwk/trunk/doc/TestTypes.txt	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/doc/TestTypes.txt	2008-01-18 00:07:59 UTC (rev 5162)
@@ -1,46 +0,0 @@
-Test Types:
-===========
-The framework provides some simple tests, in org.cachewrapper.tests.  Again, we expect users to write their own tests 
-such as to mimic their cache usage scenarios to provide a useful benchmark of cache products, based on their usage scenarios.
-
-Following is a list of Tests provided by the Cache Benchmark Framework:
-
-- String Test
-This is a simple test of adding and getting java.lang.String objects in and out of the cache.
-
-- Primitive Test
-This is a simple test of adding and getting java.lang.Integer objects in and out of the cache.
-
-- Custom Class Test
-This is a test on the time taken to add and get a custom object to and from the cache.
-There are two differnet custom objects that could be used based on the wrapper in use. If the wrapper is a serializable
-wrapper, then the SerializableCustomType object would be used. If the wrapper is not a serializable wrapper, then
-CustomType object would be used.
-Refer JavaDocs for SerializableCustomType and CustomType class structures.
-
-- Associations Test
-This is a test on the time taken to add and get a custom object to and from the cache with aggregated objects within it.
-There are two differnet custom objects that could be used based on the wrapper in use. If the wrapper is a serializable
-wrapper, then the SerializableCustomTypeWithAssocs object would be used. If the wrapper is not a serializable wrapper, then
-CustomTypeWithAssocs object would be used.
-Refer JavaDocs for SerializableCustomTypeWithAssocs and CustomTypeWithAssocs class structures.
-
-- Statics Test
-This is a test on the time taken to add and get a custom object to and from the cache with aggregated static objects within it.
-There are two differnet custom objects that could be used based on the wrapper in use. If the wrapper is a serializable
-wrapper, then the SerializableCustomTypeWithStatics object would be used. If the wrapper is not a serializable wrapper, then
-CustomTypeWithStatics object would be used.
-Refer JavaDocs for SerializableCustomTypeWithStatics and CustomTypeWithStatics class structures.
-
-- Subclass Test
-This is a test on the time taken to add and get a object to and from the cache with. The object under test in this instance,
-would be a sub class. Which means it would be inheriting from a parent and would have a additional attributes which will go in the Cache.
-There two different sub class tests that would be done based on the wrapper in use. If the wrapper is a Serializable,
-then the SerializableCustomTypeSubclassOfAbstract object would be used. If the wrapper is not serializable, then
-the CustomTypeSubclassOfAbstract object would be used.
-
-- Transient Test
-This is a test on the time taken to add and get a object to and from the cache with Transient objects. The object under test
-in this instance would be a Object which consists of transient objects. The type of object under test would also differ based
-on the wrapper in use. Thus if the wrapper in use is Serializable, the SerializableCustomTypeWithTransient object would be used.
-Else if the wrapper is not serializable, the CustomTypeWithTransient object would be used.

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/SessionSimulatorTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/SessionSimulatorTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/SessionSimulatorTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -12,6 +12,8 @@
 import java.util.Date;
 
 /**
+ * Simulates work with a web session.
+ * 
  * @author Mircea.Markus at jboss.com
  * @since 2.2
  */

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/AssociationsTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/AssociationsTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/AssociationsTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -8,6 +8,12 @@
 
 
 /**
+ * This is a test on the time taken to add and get a custom object to and from the cache with aggregated objects within it.
+ * There are two differnet custom objects that could be used based on the wrapper in use. If the wrapper is a serializable
+ * wrapper, then the SerializableCustomTypeWithAssocs object would be used. If the wrapper is not a serializable wrapper, then
+ * CustomTypeWithAssocs object would be used.
+ * Refer JavaDocs for SerializableCustomTypeWithAssocs and CustomTypeWithAssocs class structures.
+ *
  * @author Manik Surtani (manik at surtani.org)
  *         (C) Manik Surtani, 2004
  */

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/CustomClassTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/CustomClassTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/CustomClassTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -8,6 +8,11 @@
 
 
 /**
+ * This is a test on the time taken to add and get a custom object to and from the cache.
+ * There are two differnet custom objects that could be used based on the wrapper in use. If the wrapper is a serializable
+ * wrapper, then the SerializableCustomType object would be used. If the wrapper is not a serializable wrapper, then
+ * CustomType object would be used.
+ *
  * @author Manik Surtani (manik at surtani.org)
  *         (C) Manik Surtani, 2004
  */

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/PrimitiveTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/PrimitiveTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/PrimitiveTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -5,6 +5,8 @@
 
 
 /**
+ * This is a simple test of adding and getting java.lang.Integer objects in and out of the cache.
+ * 
  * @author Manik Surtani (manik at surtani.org)
  *         (C) Manik Surtani, 2004
  */

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/SimpleTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/SimpleTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/SimpleTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -20,6 +20,8 @@
 
 
 /**
+ *
+ *
  * @author Manik Surtani (manik at surtani.org)
  *         (C) Manik Surtani, 2004
  */

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/StaticsTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/StaticsTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/StaticsTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -8,6 +8,12 @@
 
 
 /**
+ * This is a test on the time taken to add and get a custom object to and from the cache with aggregated static objects within it.
+ * There are two differnet custom objects that could be used based on the wrapper in use. If the wrapper is a serializable
+ * wrapper, then the SerializableCustomTypeWithStatics object would be used. If the wrapper is not a serializable wrapper, then
+ * CustomTypeWithStatics object would be used.
+ * Refer JavaDocs for SerializableCustomTypeWithStatics and CustomTypeWithStatics class structures.
+ *
  * @author Manik Surtani (manik at surtani.org)
  *         (C) Manik Surtani, 2004
  */

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/StringTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/StringTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/StringTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -5,6 +5,8 @@
 
 
 /**
+ * This is a simple test of adding and getting java.lang.String objects in and out of the cache.
+ *
  * @author Manik Surtani (manik at surtani.org)
  *         (C) Manik Surtani, 2004
  */

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/SubclassTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/SubclassTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/SubclassTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -8,6 +8,12 @@
 
 
 /**
+ * This is a test on the time taken to add and get a object to and from the cache with. The object under test in this instance,
+ * would be a sub class. Which means it would be inheriting from a parent and would have a additional attributes which will go in the Cache.
+ * There two different sub class tests that would be done based on the wrapper in use. If the wrapper is a Serializable,
+ * then the SerializableCustomTypeSubclassOfAbstract object would be used. If the wrapper is not serializable, then
+ * the CustomTypeSubclassOfAbstract object would be used.
+ *
  * @author Manik Surtani (manik at surtani.org)
  *         (C) Manik Surtani, 2004
  */

Modified: benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/TransientTest.java
===================================================================
--- benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/TransientTest.java	2008-01-17 22:34:36 UTC (rev 5161)
+++ benchmarks/benchmark-fwk/trunk/src/org/cachebench/tests/simpletests/TransientTest.java	2008-01-18 00:07:59 UTC (rev 5162)
@@ -8,6 +8,11 @@
 
 
 /**
+ * This is a test on the time taken to add and get a object to and from the cache with Transient objects. The object under test
+ * in this instance would be a Object which consists of transient objects. The type of object under test would also differ based
+ * on the wrapper in use. Thus if the wrapper in use is Serializable, the SerializableCustomTypeWithTransient object would be used.
+ * Else if the wrapper is not serializable, the CustomTypeWithTransient object would be used.
+ *
  * @author Manik Surtani (manik at surtani.org)
  *         (C) Manik Surtani, 2004
  */
@@ -22,5 +27,4 @@
       return performTestWithObjectType(testName, cache, cache instanceof SerializableCacheWrapper ? SerializableCustomTypeWithTransient.class : CustomTypeWithTransient.class, testCaseName, sampleSize, numThreads);
 
    }
-
 }




More information about the jbosscache-commits mailing list