python-tempestconf
==================

Overview
--------

python-tempestconf will automatically generate the tempest configuration
based on your cloud.

-  Free software: Apache license
-  Documentation:
   http://git.openstack.org/cgit/openstack/python-tempestconf/tree/README.rst
-  Source: https://git.openstack.org/openstack/python-tempestconf
-  Bugs: https://storyboard.openstack.org/#!/project/912

Usage
-----

Git
~~~

1. Clone and change to the directory:

.. code-block:: shell-session

    $ git clone https://git.openstack.org/openstack/python-tempestconf
    $ cd python-tempestconf

2. Create virtual environment using virtualenv:

.. code-block:: shell-session

    $ virtualenv .venv
    $ source .venv/bin/activate

3. Source the newly created virtual environment and install
   requirements:

.. code-block:: shell-session

    (.venv) $ pip install -r requirements.txt
    (.venv) $ pip install -r test-requirements.txt

4. Source cloud credentials, for example:

.. code-block:: shell-session

    (py27) $ source cloudrc

5. Run python-tempestconf to generate tempest configuration file:

.. code-block:: shell-session

    (py27) $ python config_tempest/config_tempest.py --debug identity.uri $OS_AUTH_URL \
                identity.admin_password  $OS_PASSWORD --create

After this, ``./etc/tempest.conf`` is generated.

RPM Installation (RDO)
~~~~~~~~~~~~~~~~~~~~~~

1. python-tempestconf is installed together with openstack-tempest, as
   a new dependency (starting from the Ocata release)

.. code-block:: shell-session

    # yum install openstack-tempest

2. Source cloud credentials, initialize tempest and run the discovery
   tool:

.. code-block:: shell-session

    $ source cloudrc
    $ tempest init testingdir
    $ cd testingdir
    $ discover-tempest-config --debug identity.uri $OS_AUTH_URL \
          identity.admin_password  $OS_PASSWORD --create

.. note::
   In Ocata release new features were presented.
   ``discover-tempest-config`` is the new name of the **old**
   ``config_tempest.py`` script and it **accepts the same parameters.**
   More about new features can be found
   `here <https://blogs.rdoproject.org/2017/02/testing-rdo-with-tempest-new-features-in-ocata/>`__


os-client-config support
~~~~~~~~~~~~~~~~~~~~~~~~

python-tempestconf supports `os-client-config <https://git.openstack.org/openstack/os-client-config>`__
so instead of sourcing openstackrc files you can use clouds.yml files. Location where
these files should be stored and syntax which is used to specify cloud.yaml files
can be found `here <https://docs.openstack.org/os-client-config/latest/user/configuration.html#config-files>`__

In case of git usage:

.. code-block:: shell-session

    (py27) $ python config_tempest/config_tempest.py --debug --create --os-cloud <name of cloud>

In case of RPM:

.. code-block:: shell-session

    $ tempest init testingdir
    $ cd testingdir
    $ discover-tempest-config --debug --create --os-cloud <name of cloud>