aboutsummaryrefslogtreecommitdiffstats
path: root/docs/testing/developer/devguide/overview.rst
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-30 10:14:04 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2017-03-30 22:21:39 +0800
commit0c8fdfafa8a85dd6e25497a9f9af9694e75ee4a1 (patch)
tree3d17ef62ada3fb9c756d9880fa4471c49fa320fd /docs/testing/developer/devguide/overview.rst
parent88f69a8d9977228a225333f084dc95adc2312f13 (diff)
Normalize all section headers
- folder with `index.rst` for parts, using # with overline for heading - `*.rst` file for chapter, using * with overline for heading In each *.rst file, use the following token for heading - =, for sections - -, for subsections - ^, for subsubsections - ", for paragraphs Change-Id: I6c247c1f1e27e891d0dade099195ef521f7dbb72 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/testing/developer/devguide/overview.rst')
-rw-r--r--docs/testing/developer/devguide/overview.rst31
1 files changed, 15 insertions, 16 deletions
diff --git a/docs/testing/developer/devguide/overview.rst b/docs/testing/developer/devguide/overview.rst
index d394574e..1d7e22fe 100644
--- a/docs/testing/developer/devguide/overview.rst
+++ b/docs/testing/developer/devguide/overview.rst
@@ -3,9 +3,9 @@
.. (c) 2017 ZTE Corporation
-########
+********
Overview
-########
+********
QTIP uses Python as primary programming language and build the framework from the following packages
@@ -19,16 +19,15 @@ docs `sphinx`_ - a tool that makes it easy to create intelligent and beautif
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`_
+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
@@ -38,11 +37,11 @@ Path Content
``./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.
@@ -52,19 +51,19 @@ Specially, it is recommended to link each patch set with a JIRA issue. Put::
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