api/index.rst

   1 Welcome to Xtesting's documentation!
   2 ====================================
   3
   4 Xtesting have leveraged on Functest efforts to provide a reference testing
   5 framework:
   6
   7   * `Requirements Management
   8     <https://wiki.opnfv.org/display/functest/Requirements+management>`_
   9   * `Docker Slicing <http://testresults.opnfv.org/functest/dockerslicing/>`_
  10   * `Functest Framework <http://testresults.opnfv.org/functest/framework/>`_
  11
  12 Xtesting aims at allowing a smooth integration of new Functest Kubernetes
  13 testcases.
  14
  15 But, more generally, it eases building any CI/CD toolchain for other
  16 domains than testing Virtualized Infrastructure Managers (VIM) such as
  17 `OpenStack <https://www.openstack.org/>`_.
  18
  19 It now offers a possible reuse of our framework in other OpenSource projects
  20 such as ONAP: `integration_demo_E2E_chain.pdf`_
  21
  22 .. _`integration_demo_E2E_chain.pdf`: https://wiki.onap.org/pages/viewpage.action?pageId=6593670&preview=%2F6593670%2F25433913%2Fintegration_demo_E2E_chain.pdf
  23
  24 Technical guidelines
  25 --------------------
  26
  27 * to support both python2 and python3
  28 * to be fully covered by unit tests
  29 * to be well rated by pylint (only local exceptions are accepted on purpose)
  30 * to be released as a  `python package`_ and then to be unlinked to OPNFV
  31   Milestones
  32 * to provide `Docker containers`_ and manifests for both architectures
  33   supported by OPNFV: amd64 and arm64
  34 * to publish the API documentation online
  35
  36 .. _`python package`: https://pypi.python.org/pypi/xtesting/
  37 .. _`Docker containers`: https://hub.docker.com/r/opnfv/xtesting/
  38
  39 Try it!
  40 -------
  41
  42 * run xtesting container::
  43
  44   $ sudo docker run opnfv/xtesting
  45
  46 * run xtesting via package (python2)::
  47
  48   $ virtualenv xtesting-py2
  49   $ . xtesting-py2/bin/activate
  50   $ pip install xtesting
  51   $ sudo xtesting-py2/bin/run_tests -t all
  52   $ deactivate
  53
  54 * run xtesting via package (python3)::
  55
  56   $ virtualenv xtesting-py3 -p python3
  57   $ . xtesting-py3/bin/activate
  58   $ pip install xtesting
  59   $ sudo xtesting-py3/bin/run_tests -t all
  60   $ deactivate
  61
  62 Contents:
  63 ---------
  64
  65 .. toctree::
  66    :maxdepth: 2
  67
  68    apidoc/modules
  69
  70
  71 Indices and tables
  72 ------------------
  73
  74 * :ref:`genindex`
  75 * :ref:`modindex`
  76 * :ref:`search`