6e5593f11b
Add simple script to setup mysql and postgresql databases, this script can be run by users during testing and will be run by CI systems for specific setup before running unit tests. This is exactly what is currently done by OpenStack CI in project-config. This allows to change in project-config the python-db jobs to python-jobs since python-jobs will call this script initially. See also http://lists.openstack.org/pipermail/openstack-dev/2016-November/107784.html Update HACKING for this. Needed-By: I98c1b799e520cad102b9e47cf51477f54b07e732 Change-Id: Id5e3b67190866acdebee2b89f4393d5c407a5b96
56 lines
2.2 KiB
ReStructuredText
56 lines
2.2 KiB
ReStructuredText
Heat style commandments
|
|
=======================
|
|
|
|
- Step 1: Read the OpenStack style commandments
|
|
http://docs.openstack.org/developer/hacking/
|
|
- Step 2: Read on
|
|
|
|
Heat specific commandments
|
|
--------------------------
|
|
|
|
None so far
|
|
|
|
Creating unit tests
|
|
-------------------
|
|
For every new feature, unit tests should be created that both test and
|
|
(implicitly) document the usage of said features. If submitting a patch for a
|
|
bug that had no unit test, a new passing unit test should be added. If a
|
|
submitted bug fix does have a unit test, be sure to add a new one that fails
|
|
without the patch and passes with the patch.
|
|
|
|
For more information on creating unit tests and utilizing the testing
|
|
infrastructure in OpenStack Heat, please read heat/tests/testing-overview.txt.
|
|
|
|
|
|
Running tests
|
|
-------------
|
|
The testing system is based on a combination of tox and testr. The canonical
|
|
approach to running tests is to simply run the command `tox`. This will
|
|
create virtual environments, populate them with dependencies and run all of
|
|
the tests that OpenStack CI systems run. Behind the scenes, tox is running
|
|
`testr run --parallel`, but is set up such that you can supply any additional
|
|
testr arguments that are needed to tox. For example, you can run:
|
|
`tox -- --analyze-isolation` to cause tox to tell testr to add
|
|
--analyze-isolation to its argument list.
|
|
|
|
It is also possible to run the tests inside of a virtual environment
|
|
you have created, or it is possible that you have all of the dependencies
|
|
installed locally already. In this case, you can interact with the testr
|
|
command directly. Running `testr run` will run the entire test suite. `testr
|
|
run --parallel` will run it in parallel (this is the default incantation tox
|
|
uses.) More information about testr can be found at:
|
|
http://wiki.openstack.org/testr
|
|
|
|
Note that unit tests use a database if available. See
|
|
``tools/test-setup.sh`` on how to set up the databases the same way as
|
|
done in the OpenStack CI systems.
|
|
|
|
Heat Specific Commandments
|
|
--------------------------
|
|
|
|
- [Heat301] Use LOG.warning() rather than LOG.warn().
|
|
- [Heat302] Python 3: do not use dict.iteritems.
|
|
- [Heat303] Python 3: do not use dict.iterkeys.
|
|
- [Heat304] Python 3: do not use dict.itervalues.
|
|
|