summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorJeremy Stanley <fungi@yuggoth.org>2015-05-20 01:04:01 +0000
committerVictor Sergeyev <vsergeyev@mirantis.com>2015-06-18 15:42:23 +0300
commit9b552046f55e56d45a9e7274e62ebb372c112c36 (patch)
treec63bb59d025b07e0abec72876374672135412379 /CONTRIBUTING.rst
parent910d40aa399874fcb36576de4d7d06d38f61cd50 (diff)
downloadoslo-db-9b552046f55e56d45a9e7274e62ebb372c112c36.tar.gz
Switch from MySQL-python to PyMySQL
As discussed in the Liberty Design Summit "Moving apps to Python 3" cross-project workshop, the way forward in the near future is to switch to the pure-python PyMySQL library as a default. Added a special test environment to keep MySQL-python support. Documentation modified. https://etherpad.openstack.org/p/liberty-cross-project-python3 Change-Id: I12b32dc097a121bd43991bc38dd4d289b65e86c1
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst15
1 files changed, 9 insertions, 6 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index fdacbf4..78528ec 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -26,12 +26,15 @@ How to run unit tests
oslo.db (as all OpenStack projects) uses tox to run unit tests. You can find
general information about OpenStack unit tests and testing with tox in wiki_.
-oslo.db tests use MySQL-python as the default MySQL DB API driver (which is
-true for OpenStack), and psycopg2 for PostgreSQL. pip will build these libs in
-your venv, so you must ensure that you have the required system packages
-installed. For Ubuntu/Debian they are python-dev, libmysqlclient-dev and
-libpq-dev. For Fedora/CentOS - gcc, python-devel, postgresql-devel and
-mysql-devel.
+oslo.db tests use PyMySQL as the default MySQL DB API driver (which is true for
+OpenStack), and psycopg2 for PostgreSQL. pip will build these libs in your
+venv, so you must ensure that you have the required system packages installed
+for psycopg2 (PyMySQL is a pure-Python implementation and so needs no
+additional system packages). For Ubuntu/Debian they are python-dev, and
+libpq-dev. For Fedora/CentOS - gcc, python-devel and postgresql-devel.
+There is also a separate env for testing with MySQL-python. If you are suppose
+to run these tests as well, you need to install libmysqlclient-dev on Ubuntu/Debian
+or mysql-devel for Fedora/CentOS.
The oslo.db unit tests system allows to run unittests on real databases. At the
moment it supports MySQL, PostgreSQL and SQLite.