diff options
| -rw-r--r-- | docs/testing/developer/devguide/framework.rst | 81 | ||||
| -rw-r--r-- | docs/testing/developer/devguide/index.rst | 1 |
2 files changed, 82 insertions, 0 deletions
diff --git a/docs/testing/developer/devguide/framework.rst b/docs/testing/developer/devguide/framework.rst new file mode 100644 index 00000000..eaeaaf90 --- /dev/null +++ b/docs/testing/developer/devguide/framework.rst @@ -0,0 +1,81 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2017 ZTE Corp. + + +********* +Framework +********* + +QTIP is built upon `Ansible`_ by extending `modules`_, `playbook roles`_ and `plugins`_. + +.. _Ansible: https://www.ansible.com/ +.. _modules: http://docs.ansible.com/ansible/modules.html +.. _playbook roles: http://docs.ansible.com/ansible/playbooks_roles.html +.. _plugins: http://docs.ansible.com/ansible/dev_guide/developing_plugins.html + +Modules +======= + +QTIP creates dedicated modules to gather slave node list and information from installer master. See embedded document +in ``qtip/ansible_library/modules`` for details + +Plugins +======= + +Stored in ``qtip/ansible_library/plugins`` + +Action plugins +-------------- + +Several action plugins have been created for test data post processing + +* collect - parse and collect metrics from raw test results like log files +* calculate - calculate score according to specification +* aggregate - aggregate calculated results from all hosts under test + +Playbook roles +============== + +QTIP roles +---------- + +* qtip - main qtip tasks +* qtip-common - common tasks required in QTIP +* qtip-workspace - generate a workspace for running benchmarks + +``qtip`` roles should be included with a specified ``action`` and ``output`` directory, e.g.:: + + - { role: inxi, output: "{{ qtip_results }}/sysinfo", tags: [run, inxi, sysinfo] } + +testing roles +------------- + +Testing roles are organized by testing tools + +* inxi - system information tool +* nDPI +* openssl +* ramspeed +* unixbench + +supporting roles + +* opnfv-testapi - report result to testapi + +Tags +==== + +Tags are used to categorize the test tasks from different aspects. + +* stages like ``run``, ``collect``, ``calculate``, ``aggregate``, ``report`` +* test tools like ``inxi``, ``ndpi`` and etc +* information or metrics like ``sysinfo``, ``dpi``, ``ssl`` + +Use + +* ``ansible-playbook run.yml --list-tags`` to list all tags +* ``ansible-playbook run.yml --list-tasks`` to list all tasks + +During development of post processing, you may skip ``run`` stage to save time, e.g. +``ansible-playbook run.yml --tags collect,calculate,aggregate`` diff --git a/docs/testing/developer/devguide/index.rst b/docs/testing/developer/devguide/index.rst index a4dd072c..bd25a5b7 100644 --- a/docs/testing/developer/devguide/index.rst +++ b/docs/testing/developer/devguide/index.rst @@ -12,6 +12,7 @@ QTIP Developer Guide overview.rst arch.rst + framework.rst cli.rst api.rst compute-qpi.rst |