Add module skeletons

- Remove `suite` and `case` which seems redundant at the moment
- Rename `qtip.spec` to `qtip.loader` since the class loads spec
- Add driver `sample` which will generate random performance data
- Add collector `logfile` which will collect result from log files
- Add reporter `console` which will print report to console
- Add exception classes

See updated class diagram in https://wiki.opnfv.org/display/qtip/Design

JIRA: QTIP-148
JIRA: QTIP-193
Change-Id: Idf751d33428176a26224e4443100a142feda6f32
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>

3 files changed, 73 insertions, 95 deletions

diff --git a/qtip/base/benchmark.py b/qtip/base/benchmark.py
deleted file mode 100644
index b38e6016..00000000
--- a/qtip/base/benchmark.py
+++ /dev/null
@@ -1,95 +0,0 @@
-##############################################################################
-# Copyright (c) 2016 ZTE Corp and others.
-#
-# All rights reserved. This program and the accompanying materials
-# are made available under the terms of the Apache License, Version 2.0
-# which accompanies this distribution, and is available at
-# http://www.apache.org/licenses/LICENSE-2.0
-##############################################################################
-
-from itertools import chain
-from os import listdir
-from os import path
-import yaml
-
-
-class Property(object):
-    # list
-    NAME = 'name'
-    CONTENT = 'content'
-    ABSPATH = 'abspath'
-    # content
-    TITLE = 'title'
-    DESCRIPTION = 'description'
-    # spec
-    ALGORITHM = 'algorithm'
-    SECTIONS = 'sections'
-    WEIGHT = 'weight'
-    METRICS = 'metrics'
-    SPEC = 'spec'
-    WORKLOADS = 'workloads'
-    # plan
-    INFO = 'info'
-    FACILITY = 'facility'
-    ENGINEER = 'engineer'
-    SUITES = 'suites'
-    # suite
-    QPI_SPEC = 'QPI_spec'
-    CONDITION = 'condition'
-    CASES = 'cases'
-    # case
-    METRIC_SPEC = 'metric_spec'
-    CONFIG = 'config'
-
-
-class QtipError(Exception):
-    pass
-
-
-class Algorithm(object):
-    ARITHMETIC_MEAN = 'arithmetic mean'
-    WEIGHTED_ARITHMETIC_MEAN = 'weighted arithmetic mean'
-    GEOMETRIC_MEAN = 'geometric mean'
-    WEIGHTED_GEOMETRIC_MEAN = 'weighted geometric mean'
-
-
-ROOT_DIR = 'benchmarks'
-
-
-class Benchmark(object):
-    """Abstract class of QTIP benchmarks"""
-    DEFAULT_DIR = '.'
-    _paths = [path.join(path.dirname(__file__), path.pardir, path.pardir,
-                        ROOT_DIR)]
-
-    def __init__(self, name, paths=None):
-        self._file = name
-        self._abspath = self._find(name, paths)
-        self.name = path.splitext(name)[0]
-
-    def _find(self, name, paths):
-        """find a benchmark in searching paths"""
-        paths = self._paths if paths is None else paths
-        name = path.join(self.DEFAULT_DIR, name)
-        for p in paths:
-            abspath = path.join(p, name)
-            if path.exists(abspath):
-                return abspath
-        raise QtipError("'{}' not found in paths: {}".format(name, paths))
-
-    @classmethod
-    def list_all(cls, paths=None):
-        """list all available benchmarks"""
-        paths = cls._paths if paths is None else paths
-        names = chain.from_iterable([listdir(path.join(p, cls.DEFAULT_DIR))
-                                     for p in paths])
-        for name in names:
-            item = cls(name, paths=paths)
-            yield {
-                Property.NAME: name,
-                Property.ABSPATH: item._abspath,
-                Property.CONTENT: item.content()}
-
-    def content(self):
-        """description of benchmark"""
-        return yaml.safe_load(file(self._abspath))
diff --git a/qtip/base/constant.py b/qtip/base/constant.py
new file mode 100644
index 00000000..187f0706
--- /dev/null
+++ b/qtip/base/constant.py
@@ -0,0 +1,50 @@
+##############################################################################
+# Copyright (c) 2016 ZTE Corp and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+
+class AlgoName(object):
+    """algorithm names"""
+    ARITHMETIC_MEAN = 'arithmetic mean'
+    WEIGHTED_ARITHMETIC_MEAN = 'weighted arithmetic mean'
+    GEOMETRIC_MEAN = 'geometric mean'
+    WEIGHTED_GEOMETRIC_MEAN = 'weighted geometric mean'
+
+
+class PkgName(object):
+    """QTIP package names"""
+    COLLECTOR = 'collector'
+    DRIVER = 'driver'
+    REPORTER = 'reporter'
+    RUNNER = 'runner'
+    SPEC = 'spec'
+
+
+class PropName(object):
+    """property names"""
+    # list
+    NAME = 'name'
+    CONTENT = 'content'
+    ABSPATH = 'abspath'
+    # content
+    name = 'name'
+    DESCRIPTION = 'description'
+    # spec
+    SECTIONS = 'sections'
+    WEIGHT = 'weight'
+    ALGORITHM = 'algorithm'
+    METRICS = 'metrics'
+    WORKLOADS = 'workloads'
+    # plan
+    CONFIG = 'config'
+    FACILITY = 'facility'
+    ENGINEER = 'engineer'
+    DRIVER = 'driver'
+    COLLECTOR = 'collector'
+    REPORTER = 'reporter'
+    QPIS = 'QPIs'
diff --git a/qtip/base/error.py b/qtip/base/error.py
new file mode 100644
index 00000000..d364c532
--- /dev/null
+++ b/qtip/base/error.py
@@ -0,0 +1,23 @@
+##############################################################################
+# Copyright (c) 2016 ZTE Corp and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+##############################################################################
+
+
+class QtipError(Exception):
+    pass
+
+
+class InvalidFormat(QtipError):
+    def __init__(self, filename):
+        self.filename = filename
+
+
+class NotFound(QtipError):
+    def __init__(self, module, package='qtip'):
+        self.package = package
+        self.module = module