summaryrefslogtreecommitdiffstats
path: root/utils
diff options
context:
space:
mode:
Diffstat (limited to 'utils')
-rw-r--r--utils/test/testapi/.gitignore1
-rw-r--r--utils/test/testapi/README.rst101
-rw-r--r--utils/test/testapi/opnfv_testapi/common/check.py8
-rw-r--r--utils/test/testapi/opnfv_testapi/tests/unit/fake_pymongo.py12
-rw-r--r--utils/test/testapi/opnfv_testapi/tests/unit/resources/test_pod.py7
5 files changed, 89 insertions, 40 deletions
diff --git a/utils/test/testapi/.gitignore b/utils/test/testapi/.gitignore
index 86ec0d2d5..a3d6e01ec 100644
--- a/utils/test/testapi/.gitignore
+++ b/utils/test/testapi/.gitignore
@@ -5,3 +5,4 @@ opnfv_testapi/static
build
*.egg-info
3rd_party/static/static
+*.pyc
diff --git a/utils/test/testapi/README.rst b/utils/test/testapi/README.rst
index 44ab2a475..0d18b7e93 100644
--- a/utils/test/testapi/README.rst
+++ b/utils/test/testapi/README.rst
@@ -2,63 +2,92 @@
opnfv-testapi
=============
-Test Results Collector of OPNFV Test Projects
+**Test Results Collector of OPNFV Test Projects**:
-Start Server
-==============
+This project aims to provide a common way of gathering all the test results for OPNFV
+testing projects into a single place, and a unified way of getting those results for
+testing analysis projects, such as Reporting/Bitergia Dashboard/Qtip. It exposes
+Restful APIs for collecting results and pushing them into a MongoDB database.
+
+If you are interested in how TestAPI looks like, please visit OPNFV's official `TestAPI Server`__
+
+.. __: http://testresults.opnfv.org/test
+
+Pre-requsites
+=============
-Getting setup
-^^^^^^^^^^^^^
+TestAPI leverages MongoDB as the data warehouse, in order to let it work
+successfully, a MongoDB must be provided, the official MongoDB version in OPNFV
+TestAPI is 3.2.6. And the database is **test_results_collection**, the five
+collections are *users/pods/projects/testcases/scenarioes/results*. And thanks to
+MongoDB's very user-friendly property, they don't need to be created in advance.
-Requirements for opnfv-testapi:
+Running locally
+===============
-* tornado
-* epydoc
+Requirements
+^^^^^^^^^^^^
-These requirements are expressed in the requirements.txt file and may be
-installed by running the following (from within a virtual environment)::
+All requirements are listed in requirements.txt and should be
+installed by 'pip install':
- pip install -r requirements.txt
+ *pip install -r requirements.txt*
+
+Installation
+^^^^^^^^^^^^
+
+ *python setup.py install*
+
+After installation, configuration file etc/config.ini will be put under
+/etc/opnfv_testapi/. And all the web relevant files under 3rd_party/static
+will be in /user/local/share/opnfv_testapi as a totality.
+
+Start Server
+^^^^^^^^^^^^
-How to install
-^^^^^^^^^^^^^^
+ *opnfv-testapi [--config-file <config.ini>]*
-From within your environment, just run:
+If --config-file is provided, the specified configuration file will be employed
+when starting the server, or else /etc/opnfv_testapi/config.ini will be utilized
+by default.
- ./install.sh
+After executing the command successfully, a TestAPI server will be started on
+port 8000, to visit web portal, please access http://hostname:8000
-How to run
-^^^^^^^^^^
+Regarding swagger-ui website, please visit http://hostname:8000/swagger/spec.html
-From within your environment, just run:
+Running with container
+======================
- opnfv-testapi
+TestAPI has already containerized, the docker image is opnfv/testapi:latest.
-This will start a server on port 8000. Just visit http://localhost:8000
+**Running the container not behind nginx:**
-For swagger website, just visit http://localhost:8000/swagger/spec.html
+.. code-block:: shell
-Unittest
-=====================
+ docker run -dti --name testapi -p expose_port:8000
+ -e "mongodb_url=mongodb://mongodb_ip:27017/"
+ -e "base_url=http://host_name:expose_port"
+ opnfv/testapi:latest
-Getting setup
-^^^^^^^^^^^^^
+**Running the container behind nginx:**
-Requirements for unittest:
+.. code-block:: shell
-* testtools
-* discover
-* futures
+ docker run -dti --name testapi -p expose_port:8000
+ -e "mongodb_url=mongodb://mongodb_ip:27017/"
+ -e "base_url=http://nginx_url"
+ opnfv/testapi:latest
-These requirements are expressed in the test-requirements.txt file and may be
-installed by running the following (from within a virtual environment)::
+Unittest & pep8
+===============
- pip install -r test-requirements.txt
+All requirements for unit tests are outlined in test-requirements.txt, and in TestAPI project, tox is leveraged to drive the executing of unit tests and pep8 check
-How to run
-^^^^^^^^^^
+**Running unit tests**
-From within your environment, just run::
+ *tox -e py27*
- bash run_test.sh
+**Running pep8 check**
+ *tox -e pep8*
diff --git a/utils/test/testapi/opnfv_testapi/common/check.py b/utils/test/testapi/opnfv_testapi/common/check.py
index 24ba876a9..acd331784 100644
--- a/utils/test/testapi/opnfv_testapi/common/check.py
+++ b/utils/test/testapi/opnfv_testapi/common/check.py
@@ -7,6 +7,7 @@
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
import functools
+import re
from tornado import gen
from tornado import web
@@ -92,7 +93,12 @@ def new_not_exists(xstep):
def wrap(self, *args, **kwargs):
query = kwargs.get('query')
if query:
- to_data = yield dbapi.db_find_one(self.table, query())
+ query_data = query()
+ if self.table == 'pods':
+ if query_data.get('name') is not None:
+ query_data['name'] = re.compile(query_data.get('name'),
+ re.IGNORECASE)
+ to_data = yield dbapi.db_find_one(self.table, query_data)
if to_data:
raises.Forbidden(message.exist(self.table, query()))
ret = yield gen.coroutine(xstep)(self, *args, **kwargs)
diff --git a/utils/test/testapi/opnfv_testapi/tests/unit/fake_pymongo.py b/utils/test/testapi/opnfv_testapi/tests/unit/fake_pymongo.py
index 0ca83df62..3320a866a 100644
--- a/utils/test/testapi/opnfv_testapi/tests/unit/fake_pymongo.py
+++ b/utils/test/testapi/opnfv_testapi/tests/unit/fake_pymongo.py
@@ -6,6 +6,8 @@
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
+import re
+
from operator import itemgetter
from bson.objectid import ObjectId
@@ -190,8 +192,13 @@ class MemDb(object):
elif k == 'trust_indicator.current':
if content.get('trust_indicator').get('current') != v:
return False
- elif not isinstance(v, dict) and content.get(k, None) != v:
- return False
+ elif not isinstance(v, dict):
+ if isinstance(v, re._pattern_type):
+ if v.match(content.get(k, None)) is None:
+ return False
+ else:
+ if content.get(k, None) != v:
+ return False
return True
def _find(self, *args):
@@ -199,7 +206,6 @@ class MemDb(object):
for content in self.contents:
if self._in(content, *args):
res.append(content)
-
return res
def find(self, *args):
diff --git a/utils/test/testapi/opnfv_testapi/tests/unit/resources/test_pod.py b/utils/test/testapi/opnfv_testapi/tests/unit/resources/test_pod.py
index cb4f1d92c..d1a19f7f0 100644
--- a/utils/test/testapi/opnfv_testapi/tests/unit/resources/test_pod.py
+++ b/utils/test/testapi/opnfv_testapi/tests/unit/resources/test_pod.py
@@ -21,6 +21,8 @@ class TestPodBase(base.TestBase):
self.req_d = pod_models.PodCreateRequest('zte-1', 'virtual',
'zte pod 1', 'ci-pod')
self.req_e = pod_models.PodCreateRequest('zte-2', 'metal', 'zte pod 2')
+ self.req_f = pod_models.PodCreateRequest('Zte-1', 'virtual',
+ 'zte pod 1', 'ci-pod')
self.get_res = pod_models.Pod
self.list_res = pod_models.Pods
self.basePath = '/api/v1/pods'
@@ -58,6 +60,11 @@ class TestPodCreate(TestPodBase):
self.create_d()
return self.req_d
+ @executor.create(httplib.FORBIDDEN, message.exist_base)
+ def test_alreadyExistCaseInsensitive(self):
+ self.create(self.req_f)
+ return self.req_d
+
class TestPodGet(TestPodBase):
def setUp(self):