svn commit: r1596128 - in /jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability: ScalabilityAbstractSuite.java ScalabilityBenchmark.java ScalabilitySuite.java

[md...@apache.org]

Author: mduerig
Date: Tue May 20 07:53:38 2014
New Revision: 1596128

URL: http://svn.apache.org/r1596128
Log:
OAK-1806: Benchmark for blob upload and search longevity
Javadoc. Credits to Amit for the patch

Modified:
    jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityAbstractSuite.java
    jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityBenchmark.java
    jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilitySuite.java

Modified: jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityAbstractSuite.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityAbstractSuite.java?rev=1596128&r1=1596127&r2=1596128&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityAbstractSuite.java (original)
+++ jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityAbstractSuite.java Tue May 20 07:53:38 2014
@@ -47,7 +47,23 @@ import org.apache.jackrabbit.oak.benchma
 import org.apache.jackrabbit.oak.fixture.RepositoryFixture;
 
 /**
- * Longevity suite to load test.
+ * Abstract class which defines a lot of the boiler-plate code needed to run the suite of tests.
+ * 
+ * Any test suite extending from this class has the following entry points
+ * <p>
+ * {@link #beforeSuite()} - To configure the whole suite before the tests are started.
+ * <p>
+ * {@link #afterSuite()} - To shutdown the whole suite after all tests are finished.
+ * <p>
+ * {@link #beforeIteration(ExecutionContext)} - Any initialization to be performed before each of
+ * the test run. Typically, this can be configured to create additional loads for each iteration.
+ * This method will be called before each test iteration begins.
+ * <p>
+ * {@link #afterIteration()} - To configure any post test steps to be executed after each iteration
+ * of the test. This method will be called after each test iteration completes.
+ * <p>
+ * {@link #executeBenchmark(ScalabilityBenchmark, ExecutionContext)} - Actual benchmark/test to be
+ * executed. This method will be called in each iteration of the test run.
  * 
  */
 public abstract class ScalabilityAbstractSuite implements ScalabilitySuite, CSVResultGenerator {

Modified: jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityBenchmark.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityBenchmark.java?rev=1596128&r1=1596127&r2=1596128&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityBenchmark.java (original)
+++ jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilityBenchmark.java Tue May 20 07:53:38 2014
@@ -25,7 +25,12 @@ import org.apache.jackrabbit.oak.scalabi
 
 
 /**
- * Abstract class for all the Scalability/Longevity benchmarks.
+ * Base class for all the Scalability/Longevity benchmarks/tests.
+ * 
+ * The implementations should implement the method
+ * {@link ScalabilityBenchmark#execute(Repository, Credentials, ExecutionContext)}.
+ * 
+ * This method will then be called from the {@link ScalabilitySuite} where configured.
  * 
  */
 public abstract class ScalabilityBenchmark {

Modified: jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilitySuite.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilitySuite.java?rev=1596128&r1=1596127&r2=1596128&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilitySuite.java (original)
+++ jackrabbit/oak/trunk/oak-run/src/main/java/org/apache/jackrabbit/oak/scalability/ScalabilitySuite.java Tue May 20 07:53:38 2014
@@ -23,7 +23,13 @@ import java.util.Map;
 import org.apache.jackrabbit.oak.fixture.RepositoryFixture;
 
 /**
- * Interface for longevity suite for load testing.
+ * Interface for scalability suite for load testing.
+ * 
+ * {@link ScalabilitySuite} implementations would configure different {@link ScalabilityBenchmark}
+ * implementations for executing performance tests and measuring the execution times on those tests.
+ * 
+ * The entry method for the starting the tests is {@link #run(Iterable)}.
+ * 
  */
 public interface ScalabilitySuite {
     /**