README.unittests.rst 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. =====================
  2. SQLALCHEMY UNIT TESTS
  3. =====================
  4. Updated for 1.1, 1.2
  5. Basic Test Running
  6. ==================
  7. A test target exists within the setup.py script. For basic test runs::
  8. python setup.py test
  9. Running with Tox
  10. ================
  11. For more elaborate CI-style test running, the tox script provided will
  12. run against various Python / database targets. For a basic run against
  13. Python 2.7 using an in-memory SQLite database::
  14. tox -e py27-sqlite
  15. The tox runner contains a series of target combinations that can run
  16. against various combinations of databases. The test suite can be
  17. run against SQLite with "backend" tests also running against a Postgresql
  18. database::
  19. tox -e py36-sqlite-postgresql
  20. Or to run just "backend" tests against a MySQL database::
  21. tox -e py36-mysql-backendonly
  22. Running against backends other than SQLite requires that a database of that
  23. vendor be available at a specific URL. See "Setting Up Databases" below
  24. for details.
  25. The py.test Engine
  26. ==================
  27. Both the tox runner and the setup.py runner are using py.test to invoke
  28. the test suite. Within the realm of py.test, SQLAlchemy itself is adding
  29. a large series of option and customizations to the py.test runner using
  30. plugin points, to allow for SQLAlchemy's multiple database support,
  31. database setup/teardown and connectivity, multi process support, as well as
  32. lots of skip / database selection rules.
  33. Running tests with py.test directly grants more immediate control over
  34. database options and test selection.
  35. A generic py.test run looks like::
  36. py.test -n4
  37. Above, the full test suite will run against SQLite, using four processes.
  38. If the "-n" flag is not used, the pytest-xdist is skipped and the tests will
  39. run linearly, which will take a pretty long time.
  40. The py.test command line is more handy for running subsets of tests and to
  41. quickly allow for custom database connections. Example::
  42. py.test --dburi=postgresql+psycopg2://scott:tiger@localhost/test test/sql/test_query.py
  43. Above will run the tests in the test/sql/test_query.py file (a pretty good
  44. file for basic "does this database work at all?" to start with) against a
  45. running Postgresql database at the given URL.
  46. The py.test frontend can also run tests against multiple kinds of databases
  47. at once - a large subset of tests are marked as "backend" tests, which will
  48. be run against each available backend, and additionally lots of tests are targeted
  49. at specific backends only, which only run if a matching backend is made available.
  50. For example, to run the test suite against both Postgresql and MySQL at the same time::
  51. py.test -n4 --db postgresql --db mysql
  52. Setting Up Databases
  53. ====================
  54. The test suite identifies several built-in database tags that run against
  55. a pre-set URL. These can be seen using --dbs::
  56. $ py.test --dbs=.
  57. Available --db options (use --dburi to override)
  58. default sqlite:///:memory:
  59. firebird firebird://sysdba:masterkey@localhost//Users/classic/foo.fdb
  60. mssql mssql+pyodbc://scott:tiger@ms_2008
  61. mssql_pymssql mssql+pymssql://scott:tiger@ms_2008
  62. mysql mysql://scott:tiger@127.0.0.1:3306/test?charset=utf8
  63. oracle oracle://scott:tiger@127.0.0.1:1521
  64. oracle8 oracle://scott:tiger@127.0.0.1:1521/?use_ansi=0
  65. pg8000 postgresql+pg8000://scott:tiger@127.0.0.1:5432/test
  66. postgresql postgresql://scott:tiger@127.0.0.1:5432/test
  67. postgresql_psycopg2cffi postgresql+psycopg2cffi://scott:tiger@127.0.0.1:5432/test
  68. pymysql mysql+pymysql://scott:tiger@127.0.0.1:3306/test?charset=utf8
  69. sqlite sqlite:///:memory:
  70. sqlite_file sqlite:///querytest.db
  71. What those mean is that if you have a database running that can be accessed
  72. by the above URL, you can run the test suite against it using ``--db <name>``.
  73. The URLs are present in the ``setup.cfg`` file. You can make your own URLs by
  74. creating a new file called ``test.cfg`` and adding your own ``[db]`` section::
  75. # test.cfg file
  76. [db]
  77. my_postgresql=postgresql://username:pass@hostname/dbname
  78. Above, we can now run the tests with ``my_postgresql``::
  79. py.test --db my_postgresql
  80. We can also override the existing names in our ``test.cfg`` file, so that we can run
  81. with the tox runner also::
  82. # test.cfg file
  83. [db]
  84. postgresql=postgresql://username:pass@hostname/dbname
  85. Now when we run ``tox -e py27-postgresql``, it will use our custom URL instead
  86. of the fixed one in setup.cfg.
  87. Database Configuration
  88. ======================
  89. The test runner will by default create and drop tables within the default
  90. database that's in the database URL, *unless* the multiprocessing option
  91. is in use via the py.test "-n" flag, which invokes pytest-xdist. The
  92. multiprocessing option is **enabled by default** for both the tox runner
  93. and the setup.py frontend. When multiprocessing is used, the SQLAlchemy
  94. testing framework will create a new database for each process, and then
  95. tear it down after the test run is complete. So it will be necessary
  96. for the database user to have access to CREATE DATABASE in order for this
  97. to work.
  98. Several tests require alternate usernames or schemas to be present, which
  99. are used to test dotted-name access scenarios. On some databases such
  100. as Oracle or Sybase, these are usernames, and others such as PostgreSQL
  101. and MySQL they are schemas. The requirement applies to all backends
  102. except SQLite and Firebird. The names are::
  103. test_schema
  104. test_schema_2 (only used on PostgreSQL)
  105. Please refer to your vendor documentation for the proper syntax to create
  106. these namespaces - the database user must have permission to create and drop
  107. tables within these schemas. Its perfectly fine to run the test suite
  108. without these namespaces present, it only means that a handful of tests which
  109. expect them to be present will fail.
  110. Additional steps specific to individual databases are as follows::
  111. POSTGRESQL: To enable unicode testing with JSONB, create the
  112. database with UTF8 encoding::
  113. postgres=# create database test with owner=scott encoding='utf8' template=template0;
  114. To include tests for HSTORE, create the HSTORE type engine::
  115. postgres=# \c test;
  116. You are now connected to database "test" as user "postgresql".
  117. test=# create extension hstore;
  118. CREATE EXTENSION
  119. Full-text search configuration should be set to English, else
  120. several tests of ``.match()`` will fail. This can be set (if it isn't so
  121. already) with:
  122. ALTER DATABASE test SET default_text_search_config = 'pg_catalog.english'
  123. ORACLE: a user named "test_schema" is created in addition to the default
  124. user.
  125. The primary database user needs to be able to create and drop tables,
  126. synonyms, and constraints within the "test_schema" user. For this
  127. to work fully, including that the user has the "REFERENCES" role
  128. in a remote schema for tables not yet defined (REFERENCES is per-table),
  129. it is required that the test the user be present in the "DBA" role:
  130. grant dba to scott;
  131. MSSQL: Tests that involve multiple connections require Snapshot Isolation
  132. ability implemented on the test database in order to prevent deadlocks that
  133. will occur with record locking isolation. This feature is only available
  134. with MSSQL 2005 and greater. You must enable snapshot isolation at the
  135. database level and set the default cursor isolation with two SQL commands:
  136. ALTER DATABASE MyDatabase SET ALLOW_SNAPSHOT_ISOLATION ON
  137. ALTER DATABASE MyDatabase SET READ_COMMITTED_SNAPSHOT ON
  138. CONFIGURING LOGGING
  139. -------------------
  140. SQLAlchemy logs its activity and debugging through Python's logging package.
  141. Any log target can be directed to the console with command line options, such
  142. as::
  143. $ ./py.test test/orm/test_unitofwork.py -s \
  144. --log-debug=sqlalchemy.pool --log-info=sqlalchemy.engine
  145. Above we add the py.test "-s" flag so that standard out is not suppressed.
  146. DEVELOPING AND TESTING NEW DIALECTS
  147. -----------------------------------
  148. See the file README.dialects.rst for detail on dialects.