Add more comments to clarify runner prototype

Change-Id: I25540985f425ee4ebd209c1708b5d25be582e746
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>

diff --git a/qtip/runner/perftest.py b/qtip/runner/perftest.py
index c6d5839..a9b5471 100644 (file)
--- 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 4179af6..0086a20 100644 (file)
--- 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 57f3c97..f48a714 100644 (file)
--- 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]