aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-30 01:22:17 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-03-30 01:22:17 +0000
commit14e9c620366b46481aef204edcf892bbaa4ef6be (patch)
treeeec08e8ee7aa27403a5dd766cf2231fdd7c6a01e
parent187b7b7843d4d5071311abd3c001df91b6f469be (diff)
parent540f711b71976c587417b0a3a04a89b79cf465d4 (diff)
Merge "Add more content to developer overview"
-rw-r--r--docs/testing/developer/devguide/overview.rst93
1 files changed, 78 insertions, 15 deletions
diff --git a/docs/testing/developer/devguide/overview.rst b/docs/testing/developer/devguide/overview.rst
index 4ccaae20..d394574e 100644
--- a/docs/testing/developer/devguide/overview.rst
+++ b/docs/testing/developer/devguide/overview.rst
@@ -1,27 +1,90 @@
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. (c) 2017 ZTE Corp.
+.. (c) 2017 ZTE Corporation
########
Overview
########
-QTIP uses Python as primary programming language. The structure of repository is based on the recommended sample in
+QTIP uses Python as primary programming language and build the framework from the following packages
+
+======== ===============================================================================================================
+Module Package
+======== ===============================================================================================================
+api `Connexion`_ - API first applications with OpenAPI/Swagger and Flask
+cli `Click`_ - the “Command Line Interface Creation Kit”
+template `Jinja2`_ - a full featured template engine for Python
+docs `sphinx`_ - a tool that makes it easy to create intelligent and beautiful documentation
+testing `pytest`_ - a mature full-featured Python testing tool that helps you write better programs
+======== ===============================================================================================================
+
+***********
+Source Code
+***********
+
+ The structure of repository is based on the recommended sample in
`The Hitchhiker's Guide to Python`_
-============== ==========================================================================
-Path Content
-============== ==========================================================================
-./benchmarks/ builtin benchmark assets including plan, QPI and metrics
-./contrib/ independent project/plugin/code contributed to QTIP
-./docker/ configuration for building Docker image for QTIP deployment
-./docs/ release notes, user and developer documentation, design proposals
-./legacy/ legacy obsoleted code that is unmaintained but kept for reference
-./opt/ optional component, e.g. scripts to setup infrastructure services for QTIP
-./qtip/ the actual package
-./tests/ package functional and unit tests
-./third-party/ third part included in QTIP project
-============== ==========================================================================
+================== ========================================================================================================
+Path Content
+================== ========================================================================================================
+``./benchmarks/`` builtin benchmark assets including plan, QPI and metrics
+``./contrib/`` independent project/plugin/code contributed to QTIP
+``./docker/`` configuration for building Docker image for QTIP deployment
+``./docs/`` release notes, user and developer documentation, design proposals
+``./legacy/`` legacy obsoleted code that is unmaintained but kept for reference
+``./opt/`` optional component, e.g. scripts to setup infrastructure services for QTIP
+``./qtip/`` the actual package
+``./tests/`` package functional and unit tests
+``./third-party/`` third part included in QTIP project
+================== ========================================================================================================
+
+************
+Coding Style
+************
+
+QTIP follows `OpenStack Style Guidelines`_ for source code and commit message.
+
+Specially, it is recommended to link each patch set with a JIRA issue. Put::
+
+ JIRA: QTIP-n
+
+in commit message to create an automatic link.
+
+*******
+Testing
+*******
+
+All testing related code are stored in ``./tests/``
+
+================== ========================================================================================================
+Path Content
+================== ========================================================================================================
+``./tests/data/`` data fixtures for testing
+``./tests/unit/`` unit test for each module, follow the same layout as ./qtip/
+``./conftest.py`` pytest configuration in project scope
+================== ========================================================================================================
+
+`tox`_ is used to automate the testing tasks
+
+.. code-block:: shell
+
+ cd <project_root>
+ pip install tox
+ tox
+
+The test cases are written in `pytest`_. You may run it selectively with
+
+.. code-block:: shell
+
+ pytest tests/unit/reporter
+.. _Connexion: https://pypi.python.org/pypi/connexion/
+.. _Click: http://click.pocoo.org/
+.. _Jinja2: http://jinja.pocoo.org/
+.. _OpenStack Style Guidelines: http://docs.openstack.org/developer/hacking/
+.. _pytest: http://doc.pytest.org/
+.. _sphinx: http://www.sphinx-doc.org/en/stable/
.. _The Hitchhiker's Guide to Python: http://python-guide-pt-br.readthedocs.io/en/latest/writing/structure/
+.. _tox: https://tox.readthedocs.io/