You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@accumulo.apache.org by el...@apache.org on 2015/07/07 20:13:39 UTC
accumulo git commit: ACCUMULO-3936 First pass of documentation
improvements for performance tests.
Repository: accumulo
Updated Branches:
refs/heads/master dd99cbff2 -> b411fe319
ACCUMULO-3936 First pass of documentation improvements for performance tests.
Project: http://git-wip-us.apache.org/repos/asf/accumulo/repo
Commit: http://git-wip-us.apache.org/repos/asf/accumulo/commit/b411fe31
Tree: http://git-wip-us.apache.org/repos/asf/accumulo/tree/b411fe31
Diff: http://git-wip-us.apache.org/repos/asf/accumulo/diff/b411fe31
Branch: refs/heads/master
Commit: b411fe319d5a803a17f3cccf2afa1779b3a09835
Parents: dd99cbf
Author: Josh Elser <el...@apache.org>
Authored: Tue Jul 7 14:12:28 2015 -0400
Committer: Josh Elser <el...@apache.org>
Committed: Tue Jul 7 14:13:22 2015 -0400
----------------------------------------------------------------------
TESTING.md | 16 ++++++++++++++++
.../org/apache/accumulo/test/PerformanceTest.java | 3 +++
2 files changed, 19 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/accumulo/blob/b411fe31/TESTING.md
----------------------------------------------------------------------
diff --git a/TESTING.md b/TESTING.md
index de484ee..03ee687 100644
--- a/TESTING.md
+++ b/TESTING.md
@@ -47,6 +47,22 @@ but are checking for regressions that were previously seen in the codebase. Thes
resources, at least another gigabyte of memory over what Maven itself requires. As such, it's recommended to have at
least 3-4GB of free memory and 10GB of free disk space.
+## Performance tests
+
+Performance tests refer to a small subset of integration tests which are not activated by default. These tests allow
+developers to write tests which specifically exercise expected performance which may be dependent on the available
+resources of the host machine. Normal integration tests should be capable of running anywhere with a lower-bound on
+available memory.
+
+These tests are designated using the JUnit Category annotation with the `PerformanceTest` interface in the
+accumulo-test module. See the `PerformanceTest` interface for more information on how to use this to write your
+own performance test.
+
+To invoke the performance tests, activate the `performanceTests` Maven profile in addition to the integration-test
+or verify Maven lifecycle. For example `mvn verify -PperformanceTests` would invoke all of the integration tests:
+both normal integration tests and the performance tests. There is presently no way to invoke only the performance
+tests without the rest of the integration tests.
+
## Accumulo for testing
The primary reason these tests take so much longer than the unit tests is that most are using an Accumulo instance to
http://git-wip-us.apache.org/repos/asf/accumulo/blob/b411fe31/test/src/main/java/org/apache/accumulo/test/PerformanceTest.java
----------------------------------------------------------------------
diff --git a/test/src/main/java/org/apache/accumulo/test/PerformanceTest.java b/test/src/main/java/org/apache/accumulo/test/PerformanceTest.java
index 22fc889..70cc906 100644
--- a/test/src/main/java/org/apache/accumulo/test/PerformanceTest.java
+++ b/test/src/main/java/org/apache/accumulo/test/PerformanceTest.java
@@ -18,6 +18,9 @@ package org.apache.accumulo.test;
/**
* Annotate integration tests which test performance-related aspects of Accumulo or are sensitive to timings and hardware capabilities.
+ * <p>
+ * Intended to be used with the JUnit Category annotation on integration test classes. The Category annotation should be
+ * placed at the class-level. Test class names should still be suffixed with 'IT' as the rest of the integration tests.
*/
public interface PerformanceTest {