openstack
/
monasca-log-api
Code Issues Proposed changes
monasca-log-api/monasca_log_api_tempest/README.md

7.7 KiB
Raw Blame History

Introduction

Monasca-Log-Api requires following components set up in the environment:

  • monasca-log-transformer - component receiving data from monasca-log-api, config
  • monasca-log-persister - component saves data to ElasticSearch, config
  • ElasticSearch - database that stores logs, config

Those three components are all part of devstack.

  • Logstash - it is a prerequisite for monasca-log-transformer and monasca-log-persister components

Monasca-Log-Api can be installed using following Github repo. In order to setup schema (kafka topics) please see this.

Installation next to monasca-api

Monasca-Api and Monasca-Log-Api can be installed next to each other. Each one has been designed to work with different aspects of monitoring. Therefore it is possible to proceed with installation as described here.

Configuration

  1. Clone the OpenStack Tempest repo, and cd to it.
    git clone https://git.openstack.org/openstack/tempest.git
    cd tempest
  1. Create a virtualenv for running the Tempest tests and activate it. For example in the Tempest root dir
    virtualenv .venv
    source .venv/bin/activate
  1. Install the Tempest requirements in the virtualenv.
    pip install \
        -c https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt \
        -r requirements.txt \
        -r test-requirements.txt
  1. Create etc/tempest.conf in the Tempest root dir by running the following command:
    oslo-config-generator --config-file tempest/cmd/config-generator.tempest.conf --output-file etc/tempest.conf

Add the following sections to tempest.conf for testing using the monasca-vagrant environment.

    [identity]
    region = RegionOne
    auth_version = v3
    uri = http://10.36.99.238/identity_admin/v2.0
    uri_v3 = http://10.36.99.238/identity_admin/v3
    user_lockout_failure_attempts = 2
    user_locakout_duration = 5
    user_unique_last_password_count = 2
    admin_domain_scope = True

    [auth]
    tempest_roles = monasca-user
    admin_project_name = admin
    admin_domain_name = default
    admin_password = secretadmin
    admin_username = admin
    use_dynamic_credentials = True

    [monitoring]
    kibana_version = 4.6.3
    api_version = v2.0 # or v3.0

Edit the variable values in the identity section to match your particular monasca-vagrant environment. Best way to do this might be

    source devstack/openrc {username} {password}

and collect all relevant values using

    env | grep OS_

An output will be similar to this one

    OS_PROJECT_DOMAIN_ID=default
    OS_REGION_NAME=RegionOne
    OS_USER_DOMAIN_ID=default
    OS_PROJECT_NAME=admin
    OS_IDENTITY_API_VERSION=3
    OS_PASSWORD=secretadmin
    OS_AUTH_TYPE=password
    OS_AUTH_URL=http://10.36.99.238/identity_admin
    OS_USERNAME=admin
    OS_TENANT_NAME=admin
    OS_VOLUME_API_VERSION=2
    OS_NO_CACHE=True

  1. Create etc/logging.conf in the Tempest root dir by making a copying logging.conf.sample.

  2. Clone the monasca-log-api repo in a directory somewhere outside of the Tempest root dir.

  3. Install the monasca-log-api in your venv, which will also register the Monasca Log Api Tempest Plugin as, monasca_log_api_tempest.

    cd into the monasca-log-api root directory. Making sure that the tempest virtual env is still active, run the following command.

    pip install \
        -c https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt \
        -r requirements.txt \
        -r test-requirements.txt
    python setup.py install

See the OpenStack Tempest Plugin Interface, for more details on Tempest Plugins and the plugin registration process.

Running the Monasca Log Api Tempest

The Monasca Tempest Tests can be run using a variety of methods including:

  1. Testr
  2. Os-testr
  3. PyCharm
  4. Tempest Scripts in Devstack

Run the tests from the CLI using testr

Testr is a test runner that can be used to run the Tempest tests.

  1. In the Tempest root dir, create a list of the Monasca Tempest Tests in a file.
testr list-tests monasca_log_api_tempest > monasca_log_api_tempest
  1. Run the tests using testr
testr run --load-list=monasca_log_api_tempest

You can also use testr to create a list of specific tests for your needs.

Run the tests from the CLI using os-testr (no file necessary)

Os-testr is a test wrapper that can be used to run the Monasca Tempest tests.

  1. In the Tempest root dir:
ostestr --serial --regex monasca_log_api_tempest

--serial option is necessary here. Monasca Log Api tempest tests can't be run in parallel (default option in ostestr) because some tests depend on the same data and will randomly fail.

Running/Debugging the Monasca Tempest Tests in PyCharm

Assuming that you have already created a PyCharm project for the monasca-log-api do the following:

  1. In PyCharm, Edit Configurations and add a new Python tests configuration by selecting Python tests->Nosetests.
  2. Name the test. For example TestSingleLog.
  3. Set the path to the script with the tests to run. For example, ~/repos/monasca-log-api/monasca_log_api_tempest/tests/test_single.py
  4. Set the name of the Class to test. For example TestVersions.
  5. Set the working directory to your local root Tempest repo. For example, ~/repos/tempest.
  6. Select the Python interpreter for your project to be the same as the one virtualenv created above. For example, ~/repos/tempest/.venv
  7. Run the tests. You should also be able to debug them.
  8. Step and repeat for other tests.

Run the tests from the CLI using tempest scripts in devstack

  1. In /opt/stack/tempest, run ./run_tempest.sh monasca_log_api_tempest
  2. If asked to create a new virtual environment, select yes
  3. Activate the virtual environment source .venv/bin/activate
  4. In your monasca-log-api directory, run python setup.py install
  5. In /opt/stack/tempest, run ./run_tempest.sh monasca_log_api_tempest

References

This section provides a few additional references that might be useful:

In addition to the above references, another source of information is the following OpenStack projects:

Issues

  • Update documentation for testing using Devstack when available.
  • Consider changing from monasca_tempest_tests to monasca_api_tempest_tests.