openstack/rally-openstack

History

Sergey Skripnick 1f1e8fe5b3 Remove unnecessary shell=True in subprocess calls All calls was using shell=True, but there are no shell features used. Also use tox instead of setup.py in install tempest. Change-Id: I2eb35fb8899c528d4e141d3a447eac53ce5d1a39		2015-11-27 10:59:31 +00:00
..
ci	[verify] add ability to turn off compare in job	2015-11-26 16:45:53 +02:00
functional	Remove unnecessary shell=True in subprocess calls	2015-11-27 10:59:31 +00:00
hacking	Rename "endpoint" to "credential" (part 1)	2015-11-24 01:18:13 -05:00
unit	Remove old random name generator	2015-11-26 15:43:50 +00:00
__init__.py	Move tests to root dirrectory and fix tox	2013-08-28 19:08:07 +04:00
README.rst	Fix six typos and grammar inaccuracies in Rally Readme Files	2015-08-14 16:18:40 +05:30

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 directory 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 automatically generated file path and name if you need. You can use it to publish html reports, generated during tests. Reports root can be passed through 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.