entrouvert
/
debian-django-filter
17
0
Fork 0
Code Issues Pull Requests Releases Activity
debian-django-filter/docs/dev/tests.txt

68 lines
1.4 KiB
Plaintext
Raw Normal View History

Rename some sections, some normalization
2016-11-08 03:12:25 +01:00
======================
Running the Test Suite
======================
added info on testing to the docs
2009-08-19 21:59:46 +02:00
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
The easiest way to run the django-filter tests is to check out the source
Modernize testing docs
2016-11-08 17:16:08 +01:00
code and create a virtualenv where you can install the test dependencies.
Django-filter uses a custom test runner to configure the environment, so a
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
wrapper script is available to set up and run the test suite.
.. note::
The following assumes you have `virtualenv`__ and `git`__ installed.
Modernize testing docs
2016-11-08 17:16:08 +01:00
__ https://virtualenv.pypa.io/en/stable/
__ https://git-scm.com
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
Clone the repository
--------------------
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
Get the source code using the following command:
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Add bash code blocks
2016-09-04 06:14:06 +02:00
.. code-block:: bash
Modernize testing docs
2016-11-08 17:16:08 +01:00
$ git clone https://github.com/carltongibson/django-filter.git
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
Switch to the django-filter directory:
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Add bash code blocks
2016-09-04 06:14:06 +02:00
.. code-block:: bash
Modernize testing docs
2016-11-08 17:16:08 +01:00
$ cd django-filter
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
Set up the virtualenv
---------------------
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
Create a new virtualenv to run the test suite in:
Add bash code blocks
2016-09-04 06:14:06 +02:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
.. code-block:: bash
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
$ virtualenv venv
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
Then activate the virtualenv and install the test requirements:
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Add bash code blocks
2016-09-04 06:14:06 +02:00
.. code-block:: bash
Modernize testing docs
2016-11-08 17:16:08 +01:00
$ source venv/bin/activate
$ pip install -r requirements/test.txt
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
Execute the test runner
-----------------------
Run the tests with the runner script:
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Add bash code blocks
2016-09-04 06:14:06 +02:00
.. code-block:: bash
Modernize testing docs
2016-11-08 17:16:08 +01:00
$ python runtests.py
major refactor of the tests: * moves tests package to root of project and renames it to test_django_filters * splits tests.py into multiple files * removes fixture need by creating instances on the fly ** attempted to use factory_boy instead, but it isn't py3k compatible yet * uses django-discover-runner to find the test cases while primarily focused on test refactoring, it also: * updates runtests.py to allow more flexibility when running tests * adds a runshell.py which configures django, runs syncdb and loads the test environment shell (in-memory sqlite db) * adds pip requirements files for new test dependencies * updates MANIFEST.in for test package split * uses py3k compatible relative imports when possible * removes XMLField handling, since we only support Django >= 1.4 * removes unnecessary code to get length on MultipleChoiceField's choices when filtering * updates code for pep8 and pyflakes adherence
2013-02-19 02:07:28 +01:00
Add note about using tox Closes #258
2015-07-18 21:47:20 +02:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
Test all supported versions
---------------------------
Add note about using tox Closes #258
2015-07-18 21:47:20 +02:00
Modernize testing docs
2016-11-08 17:16:08 +01:00
You can also use the excellent tox testing tool to run the tests against all
supported versions of Python and Django. Install tox, and then simply run:
Add note about using tox Closes #258
2015-07-18 21:47:20 +02:00
Add bash code blocks
2016-09-04 06:14:06 +02:00
.. code-block:: bash
Modernize testing docs
2016-11-08 17:16:08 +01:00
$ pip install tox
$ tox