aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--qtip/runner/perftest.py4
-rw-r--r--qtip/runner/suite.py5
-rw-r--r--qtip/runner/testplan.py4
3 files changed, 10 insertions, 3 deletions
diff --git a/qtip/runner/perftest.py b/qtip/runner/perftest.py
index c6d58397..a9b54716 100644
--- a/qtip/runner/perftest.py
+++ b/qtip/runner/perftest.py
@@ -13,7 +13,9 @@ from benchmark import Benchmark
class PerfTest(Benchmark):
- """PerfTest is the driver of external performance test tools"""
+ """WIP(yujunz):
+ a perftest is the driver of external performance test tools
+ It is usually referred in a suite to collect performance metric"""
# paths to search for perftest
_paths = [path.join(p, 'perftest') for p in Benchmark._paths]
diff --git a/qtip/runner/suite.py b/qtip/runner/suite.py
index 4179af64..0086a20e 100644
--- a/qtip/runner/suite.py
+++ b/qtip/runner/suite.py
@@ -13,7 +13,10 @@ from benchmark import Benchmark
class Suite(Benchmark):
- """A suite is consist of one or several perf tests and produces one QPI"""
+ """WIP(yujunz):
+ a suite is consist of one or several perf tests and produces one QPI.
+ It must be executed as part of testplan
+ """
# paths to search for suites
_paths = [path.join(p, 'suite') for p in Benchmark._paths]
diff --git a/qtip/runner/testplan.py b/qtip/runner/testplan.py
index 57f3c978..f48a7147 100644
--- a/qtip/runner/testplan.py
+++ b/qtip/runner/testplan.py
@@ -13,7 +13,9 @@ from benchmark import Benchmark
class TestPlan(Benchmark):
- """A suite is consist of one or several perf tests and produces one QPI"""
+ """WIP(yujunz):
+ a test plan is consist of test condition and several suites which can be
+ executed by user"""
# paths to search for suites
_paths = [path.join(p, 'testplan') for p in Benchmark._paths]