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>

4 files changed, 96 insertions, 0 deletions

diff --git a/qtip/loader/__init__.py b/qtip/loader/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/qtip/loader/__init__.py
diff --git a/qtip/loader/base.py b/qtip/loader/base.py
new file mode 100644
index 00000000..f7fcb669
--- /dev/null
+++ b/qtip/loader/base.py
@@ -0,0 +1,62 @@
+##############################################################################
+# 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
+
+from qtip.base.error import InvalidFormat, NotFound
+from qtip.base.constant import PropName
+
+ROOT_DIR = 'benchmarks'
+
+
+class BaseLoader(object):
+    """Abstract class of QTIP benchmark loader"""
+    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)
+
+        try:
+            content = yaml.safe_load(file(self._abspath))
+        except yaml.YAMLError:
+            # TODO(yujunz) log yaml error
+            raise InvalidFormat(self._abspath)
+
+        self.name = content[PropName.NAME] if PropName.NAME in content \
+            else path.splitext(name)[0]
+        self.content = content
+
+    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 NotFound(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 {
+                PropName.NAME: name,
+                PropName.ABSPATH: item._abspath,
+                PropName.CONTENT: item.content}
diff --git a/qtip/loader/metric.py b/qtip/loader/metric.py
new file mode 100644
index 00000000..d6174e8f
--- /dev/null
+++ b/qtip/loader/metric.py
@@ -0,0 +1,16 @@
+##############################################################################
+# 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 base import BaseLoader
+
+
+class MetricSpec(BaseLoader):
+    """metrics in QTIP are categorized by performance test tools, such as
+    dhrystone, whetstone and etc"""
+    DEFAULT_DIR = 'metric'
diff --git a/qtip/loader/qpi.py b/qtip/loader/qpi.py
new file mode 100644
index 00000000..2972cbd7
--- /dev/null
+++ b/qtip/loader/qpi.py
@@ -0,0 +1,18 @@
+##############################################################################
+# 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 base import BaseLoader
+
+
+class QPISpec(BaseLoader):
+    """
+    a QPI specification defines how to calculate a performance index from
+     collected metrics.
+    """
+    DEFAULT_DIR = 'QPI'