openstack/rally

History

Chris St. Pierre 42b7e74ae8 Keystone get_entities scenario backwards compat This lets the user supply a service name to the Keystone get_entities scenario in order to fetch a service other than 'keystone,' which makes that scenario work for older OpenStack. The user can also supply None, which will cause the scenario to create a new service, just like it does for tenant, role, and user. As a side-effect, this fixes the unit test for get_entities. Change-Id: I3393c9bdbbab37b6d37c24b0bd7701c0dbbbfe75		2015-06-22 16:19:45 -05:00
..
ci	Merge "Install data files in proper path"	2015-06-16 16:45:45 +00:00
functional	Don't change global environment in functionaltests	2015-06-18 18:26:12 +03:00
hacking	Eliminated string formatting with single mapping key	2015-06-10 09:51:27 -05:00
unit	Keystone get_entities scenario backwards compat	2015-06-22 16:19:45 -05:00
__init__.py	Move tests to root dirrectory and fix tox	2013-08-28 19:08:07 +04:00
README.rst	Publishing functional tests reports	2015-02-10 06:49:46 +02:00

README.rst

Testing

Please, don't hesitate to write tests ;)

Unit tests

Files: /tests/unit/*

The goal of unit tests is to ensure that internal parts of the code work properly. All internal methods should be fully covered by unit tests with a reasonable mocks usage.

About Rally unit tests:

All unit tests are located inside /tests/unit/*
Tests are written on top of: testtools, fixtures and mock libs
Tox is used to run unit tests

To run unit tests locally:

$ pip install tox
$ tox

To run py26, py27 or pep8 only:

$ tox -e <name>

#NOTE: <name> is one of py26, py27 or pep8

To run py26, py27 against mysql or psql

$ export RALLY_UNITTEST_DB_URL="mysql://user:secret@localhost/rally" $ tox -epy27

To get test coverage:

$ tox -e cover

#NOTE: Results will be in /cover/index.html

To generate docs:

$ tox -e docs

#NOTE: Documentation will be in doc/source/_build/html/index.html

Functional tests

Files: /tests/functional/*

The goal of functional tests is to check that everything works well together. Fuctional tests use Rally API only and check responses without touching internal parts.

To run functional tests locally:

$ source openrc
$ rally deployment create --fromenv --name testing
$ tox -e cli

#NOTE: openrc file with OpenStack admin credentials

Output of every Rally execution will be collected under some reports root in directiry structure like: reports_root/ClassName/MethodName_suffix.extension This functionality implemented in tests.functional.utils.Rally.__call__ method. Use 'gen_report_path' method of 'Rally' class to get automaticaly generated file path and name if you need. You can use it to publish html reports, generated during tests. Reports root can be passed throw environment variable 'REPORTS_ROOT'. Default is 'rally-cli-output-files'.

Rally CI scripts

Files: /tests/ci/*

This directory contains scripts and files related to the Rally CI system.

Rally Style Commandments

File: /tests/hacking/checks.py

This module contains Rally specific hacking rules for checking commandments.