You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/04/15 19:47:38 UTC
[16/50] incubator-tinkerpop git commit: Update javadoc in all test
suites.
Update javadoc in all test suites.
Tried to make the text a bit more friendly for vendors who are trying to figure out what they are and if they need to be implemented.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/cc0b8488
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/cc0b8488
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/cc0b8488
Branch: refs/heads/variables
Commit: cc0b8488638b22ba6adb858083559d47ea084381
Parents: 982780e
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Tue Apr 14 08:26:08 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Tue Apr 14 08:26:08 2015 -0400
----------------------------------------------------------------------
.../groovy/GroovyEnvironmentIntegrateSuite.java | 11 ++++++++
.../GroovyEnvironmentPerformanceSuite.java | 12 ++++++++
.../gremlin/groovy/GroovyEnvironmentSuite.java | 9 ++++++
.../process/GroovyProcessComputerSuite.java | 11 ++++++++
.../process/GroovyProcessStandardSuite.java | 8 +++++-
.../gremlin/process/ProcessComputerSuite.java | 29 +++++++-------------
.../process/ProcessPerformanceSuite.java | 25 +++++------------
.../gremlin/process/ProcessStandardSuite.java | 26 ++++--------------
.../structure/StructurePerformanceSuite.java | 23 +++-------------
.../structure/StructureStandardSuite.java | 27 +++++++++---------
10 files changed, 91 insertions(+), 90 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentIntegrateSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentIntegrateSuite.java b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentIntegrateSuite.java
index c0d3ea7..7f1daf3 100644
--- a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentIntegrateSuite.java
+++ b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentIntegrateSuite.java
@@ -24,6 +24,8 @@ import org.apache.tinkerpop.gremlin.GraphManager;
import org.apache.tinkerpop.gremlin.groovy.jsr223.GremlinGroovyScriptEngineIntegrateTest;
import org.apache.tinkerpop.gremlin.groovy.loaders.SugarLoader;
import org.apache.tinkerpop.gremlin.groovy.util.SugarTestHelper;
+import org.apache.tinkerpop.gremlin.structure.Graph;
+import org.apache.tinkerpop.gremlin.structure.StructureStandardSuite;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerBuilder;
@@ -33,6 +35,15 @@ import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
+ * The {@code GroovyEnvironmentIntegrateSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
+ * {@link Graph} implementation. This test suite covers ensures that a vendor implementation is compliant with
+ * the Groovy "environment" which will typically ensure that the {@link Graph} will work as expected in the Gremlin
+ * Console, Gremlin Server, and other Groovy environments.
+ * <br/>
+ * Note that this suite contains "long-run" tests. At this time, this suite can be considered optional to vendors.
+ * <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
+ *
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
public class GroovyEnvironmentIntegrateSuite extends AbstractGremlinSuite {
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentPerformanceSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentPerformanceSuite.java b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentPerformanceSuite.java
index 5934cbb..70439a3 100644
--- a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentPerformanceSuite.java
+++ b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentPerformanceSuite.java
@@ -25,6 +25,8 @@ import org.apache.tinkerpop.gremlin.groovy.engine.GremlinExecutorPerformanceTest
import org.apache.tinkerpop.gremlin.groovy.loaders.SugarLoader;
import org.apache.tinkerpop.gremlin.groovy.loaders.SugarLoaderPerformanceTest;
import org.apache.tinkerpop.gremlin.groovy.util.SugarTestHelper;
+import org.apache.tinkerpop.gremlin.structure.Graph;
+import org.apache.tinkerpop.gremlin.structure.StructureStandardSuite;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerBuilder;
@@ -34,6 +36,16 @@ import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
+ * The {@code GroovyEnvironmentPerformanceSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
+ * {@link Graph} implementation. This test suite covers ensures that a vendor implementation is compliant with
+ * the Groovy "environment" which will typically ensure that the {@link Graph} will work as expected in the Gremlin
+ * Console, Gremlin Server, and other Groovy environments.
+ * <br/>
+ * Note that this suite contains "long-run" tests. At this time, this suite can be considered optional to vendors
+ * as the functionality that it provides is generally covered elsewhere.
+ * <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
+ *
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
public class GroovyEnvironmentPerformanceSuite extends AbstractGremlinSuite {
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentSuite.java b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentSuite.java
index 2e0a114..b1b4d1c 100644
--- a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentSuite.java
+++ b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/groovy/GroovyEnvironmentSuite.java
@@ -27,6 +27,8 @@ import org.apache.tinkerpop.gremlin.groovy.loaders.GremlinLoaderTest;
import org.apache.tinkerpop.gremlin.groovy.loaders.SugarLoader;
import org.apache.tinkerpop.gremlin.groovy.loaders.SugarLoaderTest;
import org.apache.tinkerpop.gremlin.groovy.util.SugarTestHelper;
+import org.apache.tinkerpop.gremlin.structure.Graph;
+import org.apache.tinkerpop.gremlin.structure.StructureStandardSuite;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerBuilder;
@@ -36,6 +38,13 @@ import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
+ * The {@code GroovyEnvironmentSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
+ * {@link Graph} implementation. This test suite covers ensures that a vendor implementation is compliant with
+ * the Groovy "environment" which will typically ensure that the {@link Graph} will work as expected in the Gremlin
+ * Console, Gremlin Server, and other Groovy environments.
+ * <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
+ *
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
public class GroovyEnvironmentSuite extends AbstractGremlinSuite {
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessComputerSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessComputerSuite.java b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessComputerSuite.java
index 6fbf70c..b5d49a5 100644
--- a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessComputerSuite.java
+++ b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessComputerSuite.java
@@ -22,6 +22,7 @@ import org.apache.tinkerpop.gremlin.AbstractGremlinTest;
import org.apache.tinkerpop.gremlin.GraphManager;
import org.apache.tinkerpop.gremlin.groovy.loaders.SugarLoader;
import org.apache.tinkerpop.gremlin.groovy.util.SugarTestHelper;
+import org.apache.tinkerpop.gremlin.process.computer.GraphComputer;
import org.apache.tinkerpop.gremlin.process.computer.ranking.PageRankVertexProgramTest;
import org.apache.tinkerpop.gremlin.process.traversal.step.branch.GroovyBranchTest;
import org.apache.tinkerpop.gremlin.process.traversal.step.branch.GroovyChooseTest;
@@ -65,10 +66,20 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroovySack
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroovySideEffectCapTest;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroovyStoreTest;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroovyTreeTest;
+import org.apache.tinkerpop.gremlin.structure.Graph;
+import org.apache.tinkerpop.gremlin.structure.StructureStandardSuite;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerBuilder;
/**
+ * The {@code GroovyProcessComputerSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
+ * {@link Graph} implementation. This test suite covers traversal operations around {@link GraphComputer} and should
+ * be implemented by vendors to validate that their implementations are compliant with the Groovy flavor of the
+ * Gremlin language. Implementations that use this test suite should return {@code true} for
+ * {@link Graph.Features.GraphFeatures#supportsComputer()}.
+ * <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
+ *
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
public class GroovyProcessComputerSuite extends ProcessComputerSuite {
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessStandardSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessStandardSuite.java b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessStandardSuite.java
index 67bd21b..71e1a7b 100644
--- a/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessStandardSuite.java
+++ b/gremlin-groovy-test/src/main/java/org/apache/tinkerpop/gremlin/process/GroovyProcessStandardSuite.java
@@ -73,11 +73,17 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroovySide
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroovyStoreTest;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroovySubgraphTest;
import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.GroovyTreeTest;
+import org.apache.tinkerpop.gremlin.structure.Graph;
+import org.apache.tinkerpop.gremlin.structure.StructureStandardSuite;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerBuilder;
/**
- * The test suite for the Groovy implementation of Gremlin Process.
+ * The {@code GroovyProcessStandardSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
+ * {@link Graph} implementation. This test suite covers traversal operations and should be implemented by vendors
+ * to validate that their implementations are compliant with the Groovy flavor of the Gremlin language.
+ * <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessComputerSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessComputerSuite.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessComputerSuite.java
index 9e693dc..498d8b0 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessComputerSuite.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessComputerSuite.java
@@ -20,6 +20,7 @@ package org.apache.tinkerpop.gremlin.process;
import org.apache.tinkerpop.gremlin.AbstractGremlinSuite;
import org.apache.tinkerpop.gremlin.AbstractGremlinTest;
+import org.apache.tinkerpop.gremlin.process.computer.GraphComputer;
import org.apache.tinkerpop.gremlin.process.computer.GraphComputerTest;
import org.apache.tinkerpop.gremlin.process.computer.ranking.PageRankVertexProgramTest;
import org.apache.tinkerpop.gremlin.process.computer.util.ComputerGraphTest;
@@ -70,6 +71,8 @@ import org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.TreeTest;
import org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.SubgraphStrategyProcessTest;
import org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.ReadOnlyStrategyProcessTest;
import org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.TraversalVerificationStrategyTest;
+import org.apache.tinkerpop.gremlin.structure.Graph;
+import org.apache.tinkerpop.gremlin.structure.StructureStandardSuite;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerBuilder;
@@ -79,27 +82,15 @@ import java.util.stream.Collectors;
import java.util.stream.Stream;
/**
- * The {@code ProcessComputerStandardSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
- * {@link org.apache.tinkerpop.gremlin.structure.Graph} implementation. This specialized test suite and runner is for use
- * by Gremlin implementers to test their {@link org.apache.tinkerpop.gremlin.structure.Graph} implementations. The
- * {@code ProcessComputerStandardSuite} ensures consistency and validity of the implementations that they test.
- * <p/>
- * To use the {@code ProcessComputerStandardSuite} define a class in a test module. Simple naming would expect the
- * name of the implementation followed by "ProcessComputerStandardSuite". This class should be annotated as follows
- * (note that the "Suite" implements ProcessComputerStandardSuite.GraphProvider as a convenience only. It could be
- * implemented in a separate class file):
- * <code>
+ * The {@code ProcessComputerSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
+ * {@link Graph} implementation. This test suite covers traversal operations around {@link GraphComputer} and should
+ * be implemented by vendors to validate that their implementations are compliant with that Gremlin language.
+ * Implementations that use this test suite should return {@code true} for
+ * {@link Graph.Features.GraphFeatures#supportsComputer()}.
+ * <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
- * @RunWith(ProcessComputerSuite.class)
- * @ProcessComputerSuite.GraphProviderClass(TinkerGraphProcessComputerTest.class) public class TinkerGraphProcessComputerTest implements GraphProvider {
- * }
- * </code>
- * Implementing {@link org.apache.tinkerpop.gremlin.GraphProvider} provides a way for the {@code ProcessComputerStandardSuite}
- * to instantiate {@link org.apache.tinkerpop.gremlin.structure.Graph} instances from the implementation being tested to
- * inject into tests in the suite. The {@code ProcessComputerStandardSuite} will utilized Features defined in the
- * suite to determine which tests will be executed.
- * <br/>
*/
public class ProcessComputerSuite extends AbstractGremlinSuite {
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessPerformanceSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessPerformanceSuite.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessPerformanceSuite.java
index 0bd8b20..be6a3f5 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessPerformanceSuite.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessPerformanceSuite.java
@@ -19,31 +19,20 @@
package org.apache.tinkerpop.gremlin.process;
import org.apache.tinkerpop.gremlin.AbstractGremlinSuite;
+import org.apache.tinkerpop.gremlin.structure.Graph;
import org.apache.tinkerpop.gremlin.structure.GraphReadPerformanceTest;
import org.apache.tinkerpop.gremlin.structure.GraphWritePerformanceTest;
+import org.apache.tinkerpop.gremlin.structure.StructureStandardSuite;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerBuilder;
/**
* The {@code ProcessPerformanceSuite} is a JUnit test runner that executes the Gremlin Test Suite over a Graph
- * implementation. This specialized test suite and runner is for use by Gremlin implementers to test their
- * Graph implementations traversal speeds.
- * <p/>
- * To use the {@code ProcessPerformanceSuite} define a class in a test module. Simple naming would expect the name of
- * the implementation followed by "ProcessPerformanceTest". This class should be annotated as follows (note that
- * the "Suite" implements {@link org.apache.tinkerpop.gremlin.GraphProvider} as a convenience only. It could be implemented in
- * a separate class file):
- * <code>
- * @RunWith(ProcessPerformanceSuite.class)
- * @SProcessPerformanceSuite.GraphProviderClass(TinkerGraphProcessPerformanceTest.class)
- * public class TinkerGraphProcessPerformanceTest implements GraphProvider {
- * }
- * </code>
- * Implementing {@link org.apache.tinkerpop.gremlin.GraphProvider} provides a way for the {@code ProcessPerformanceSuite} to
- * instantiate {@link org.apache.tinkerpop.gremlin.structure.Graph} instances from the implementation being tested to inject
- * into tests in the suite. The {@code ProcessPerformanceSuite} will utilized
- * {@link org.apache.tinkerpop.gremlin.structure.Graph.Features} defined in the suite to determine which tests will be
- * executed.
+ * implementation. This suite contains "long-run" tests that produce reports on the traversal execution
+ * performance of a vendor implementation {@link Graph}. Its usage is optional to vendors as the tests are
+ * somewhat redundant to those found elsewhere in other required test suites.
+ * <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessStandardSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessStandardSuite.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessStandardSuite.java
index 518273c..2bed41d 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessStandardSuite.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/process/ProcessStandardSuite.java
@@ -79,6 +79,8 @@ import org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.Partit
import org.apache.tinkerpop.gremlin.process.traversal.strategy.decoration.SubgraphStrategyProcessTest;
import org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.ReadOnlyStrategyProcessTest;
import org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.TraversalVerificationStrategyTest;
+import org.apache.tinkerpop.gremlin.structure.Graph;
+import org.apache.tinkerpop.gremlin.structure.StructureStandardSuite;
import org.junit.runners.model.InitializationError;
import org.junit.runners.model.RunnerBuilder;
@@ -89,28 +91,12 @@ import java.util.stream.Stream;
/**
* The {@code ProcessStandardSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
- * {@link org.apache.tinkerpop.gremlin.structure.Graph} implementation. This specialized test suite and runner is for use
- * by Gremlin implementers to test their {@link org.apache.tinkerpop.gremlin.structure.Graph} implementations. The
- * {@code ProcessStandardSuite} ensures consistency and validity of the implementations that they test.
- * <p/>
- * To use the {@code ProcessStandardSuite} define a class in a test module. Simple naming would expect the name of the
- * implementation followed by "ProcessStandardSuite". This class should be annotated as follows (note that the "Suite"
- * implements {@link org.apache.tinkerpop.gremlin.GraphProvider} as a convenience only. It could be implemented in a
- * separate class file):
- * <p/>
- * <code>
+ * {@link Graph} implementation. This test suite covers traversal operations and should be implemented by vendors
+ * to validate that their implementations are compliant with the Gremlin language.
+ * <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
- * @RunWith(ProcessStandardSuite.class)
- * @ProcessStandardSuite.GraphProviderClass(TinkerGraphProcessStandardTest.class) public class TinkerGraphProcessStandardTest implements GraphProvider {
- * }
- * </code>
- * <p/>
- * Implementing {@link org.apache.tinkerpop.gremlin.GraphProvider} provides a way for the {@code ProcessStandardSuite} to
- * instantiate {@link org.apache.tinkerpop.gremlin.structure.Graph} instances from the implementation being tested to inject
- * into tests in the suite. The ProcessStandardSuite will utilized
- * {@link org.apache.tinkerpop.gremlin.structure.Graph.Features} defined in the suite to determine which tests will be executed.
- * <br/>
*/
public class ProcessStandardSuite extends AbstractGremlinSuite {
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructurePerformanceSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructurePerformanceSuite.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructurePerformanceSuite.java
index 360b829..4280c6b 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructurePerformanceSuite.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructurePerformanceSuite.java
@@ -24,26 +24,11 @@ import org.junit.runners.model.RunnerBuilder;
/**
* The {@code StructurePerformanceSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
- * {@link org.apache.tinkerpop.gremlin.structure.Graph} implementation. This specialized test suite and runner is for use
- * by Gremlin Structure implementers to test their {@link org.apache.tinkerpop.gremlin.structure.Graph}implementations.
- * The {@code StructurePerformanceSuite} runs more complex testing scenarios over
- * {@link org.apache.tinkerpop.gremlin.structure.Graph} implementations than the standard {@code StructurePerformanceSuite}.
- * <p/>
- * To use the {@code StructurePerformanceSuite} define a class in a test module. Simple naming would expect the name
- * of the implementation followed by "StructurePerformanceTest". This class should be annotated as follows (note that
- * the "Suite" implements {@link org.apache.tinkerpop.gremlin.GraphProvider} as a convenience only. It could be implemented
- * in a separate class file):
- * <code>
- * @RunWith(StructurePerformanceSuite.class)
- * @StructurePerformanceSuite.GraphProviderClass(TinkerGraphStructurePerformanceTest.class) public class TinkerGraphStructurePerformanceTest implements GraphProvider {
- * }
- * </code>
- * Implementing {@link org.apache.tinkerpop.gremlin.GraphProvider} provides a way for the {@code StructurePerformanceSuite}
- * to instantiate {@link org.apache.tinkerpop.gremlin.structure.Graph} instances from the implementation being tested to
- * inject into tests in the suite. The {@code StructurePerformanceSuite} will utilized
- * {@link org.apache.tinkerpop.gremlin.structure.Graph.Features} defined in the suite to determine which tests will be
- * executed.
+ * {@link Graph} implementation. This suite contains "long-run" tests that produce reports on the read/write
+ * performance of a vendor implementation {@link Graph}. Its usage is optional to vendors as the tests are
+ * somewhat redundant to those found elsewhere in other required test suites.
* <br/>
+ * For more information on the usage of this suite, please see {@link StructureStandardSuite}.
*
* @author Stephen Mallette (http://stephen.genoprime.com)
*/
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/cc0b8488/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructureStandardSuite.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructureStandardSuite.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructureStandardSuite.java
index 3211f6b..b6e7f73 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructureStandardSuite.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/StructureStandardSuite.java
@@ -19,6 +19,7 @@
package org.apache.tinkerpop.gremlin.structure;
import org.apache.tinkerpop.gremlin.AbstractGremlinSuite;
+import org.apache.tinkerpop.gremlin.GraphProvider;
import org.apache.tinkerpop.gremlin.algorithm.generator.CommunityGeneratorTest;
import org.apache.tinkerpop.gremlin.algorithm.generator.DistributionGeneratorTest;
import org.apache.tinkerpop.gremlin.structure.util.detached.DetachedEdgeTest;
@@ -39,29 +40,29 @@ import java.util.stream.Stream;
/**
* The {@code StructureStandardSuite} is a JUnit test runner that executes the Gremlin Test Suite over a
- * {@link org.apache.tinkerpop.gremlin.structure.Graph} implementation. This specialized test suite and runner is for use by
- * Gremlin implementers to test their {@link org.apache.tinkerpop.gremlin.structure.Graph} implementations. The
- * {@code StructureStandardSuite} ensures consistency and validity of the implementations that they test.
+ * {@link Graph} implementation. This specialized test suite and runner is for use by
+ * vendors to test their {@link Graph} implementations. The {@code StructureStandardSuite} ensures consistency and
+ * validity of the implementations that they test. Successful execution of this test suite is critical to proper
+ * operations of a vendor implementation.
* <p/>
* To use the {@code StructureStandardSuite} define a class in a test module. Simple naming would expect the name of
* the implementation followed by "StructureStandardSuite". This class should be annotated as follows (note that the
- * "Suite" implements {@link org.apache.tinkerpop.gremlin.GraphProvider} as a convenience only. It could be implemented in a
+ * "Suite" implements {@link GraphProvider} as a convenience only. It could be implemented in a
* separate class file):
* <code>
- *
- * @author Stephen Mallette (http://stephen.genoprime.com)
* @RunWith(StructureStandardSuite.class)
- * @StructureStandardSuite.GraphProviderClass(TinkerGraphStructureStandardTest.class) public class TinkerGraphStructureStandardTest implements GraphProvider {
+ * @StructureStandardSuite.GraphProviderClass(TinkerGraphStructureStandardTest.class)
+ * public class TinkerGraphStructureStandardTest implements GraphProvider {
* }
* </code>
- * Implementing {@link org.apache.tinkerpop.gremlin.GraphProvider} provides a way for the {@code StructureStandardSuite} to
- * instantiate {@link org.apache.tinkerpop.gremlin.structure.Graph} instances from the implementation being tested to inject
- * into tests in the suite. The {@code StructureStandardSuite} will utilized Features defined in the suite to
- * determine which tests will be executed.
+ * Implementing {@link GraphProvider} provides a way for the {@code StructureStandardSuite} to instantiate
+ * {@link Graph} instances from the implementation being tested to inject into tests in the suite. The
+ * {@code StructureStandardSuite} will utilized Features defined in the suite to determine which tests will be executed.
* <br/>
- * Set the {@code gremlin.structure.tests} environment variable to a comma separated list of test classes to execute.
+ * Set the {@code gremlin.tests} environment variable to a comma separated list of test classes to execute.
* This setting can be helpful to restrict execution of tests to specific ones being focused on during development.
- * <br/>
+
+ * @author Stephen Mallette (http://stephen.genoprime.com)
*/
public class StructureStandardSuite extends AbstractGremlinSuite {