openstack/rally-openstack

History

Boris Pavlovic d3773cbfbe Optimize Rally imports to reduce start time * Load plugins only if they are required This reduce a lot starting time of Rally and will allows us to do online bash completition As well it cleans up project structure a lot, e.g. all plugins are loaded in single place + we don't have strange code in cliutils * Replace rally.ui.utils to not import mako and remove all code on module level * Make Rally DB lazy inited * Import plugins during test run ---- The best way to test changes in start up time is to compare "time rally version" e.g.: before this patch: $ time rally version 0.0.5 real 0m0.397s user 0m0.299s sys 0m0.089s after this patch: 0.0.5 real 0m0.281s user 0m0.200s sys 0m0.077s Change-Id: Ibec2e6da66a1304730e801de307df7a1da68d51f		2015-07-06 21:55:33 -07:00
..
ci	Restore coverage test functionality	2015-06-29 18:26:17 -07:00
functional	Rename rally/benchmark to rally/task	2015-07-01 23:38:48 +03:00
hacking	Replace 'unicode()' function with 'six.text_type'	2015-07-02 03:44:26 +03:00
unit	Optimize Rally imports to reduce start time	2015-07-06 21:55:33 -07: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.