Skip to content
Snippets Groups Projects
Commit 7a657845 authored by Brandon Rodriguez's avatar Brandon Rodriguez
Browse files

Update documentation

parent 6dc25e76
Branches
Tags
No related merge requests found
...@@ -64,11 +64,10 @@ Example:: ...@@ -64,11 +64,10 @@ Example::
SELENIUM_TEST_BROWSER SELENIUM_TEST_BROWSER
===================== =====================
When using the :doc:`../test_cases/live_server_test_case` class for When using the :doc:`../test_cases/live_server_test_case` classes
`Selenium <https://www.selenium.dev/>`_ tests, this setting specify which browser for `Selenium <https://www.selenium.dev/>`_ tests, this setting specifies which browser to use.
type you wish to use.
Supported test browsers are as follows: Currently, supported test browsers are as follows:
* chrome * chrome
* chromium * chromium
* firefox * firefox
......
...@@ -32,14 +32,46 @@ definition: ...@@ -32,14 +32,46 @@ definition:
'django.contrib.sessions', 'django.contrib.sessions',
) )
Optional Packages
-----------------
Finally, for colorized debug output, also install the ``colorama`` package. Django ETC comes with support for the following optional packages.
For colorized debug output, install the ``colorama`` package.
.. code:: python .. code:: python
pip install colorama pip install colorama
For basic `selenium <https://www.selenium.dev/>`_ support, install the ``selenium`` and ``webdriver-manager`` packages.
.. code:: python
pip install selenium webdriver-manager
.. note::
As of Chrome version 115 and higher, the official chromedriver API has been modified, and the traditional release
repository is no longer supported. Chromedriver releases can now only be discovered programmatically. To support
that, ``selenium`` package version 4.11.2 or higher is now required.
See https://bonigarcia.dev/webdrivermanager/#support-for-chromedriver-115 and
https://chromedriver.chromium.org/downloads/version-selection for more information.
For full `Django Channels <https://github.com/django/channels>`_ selenium support, install the `channels` and `daphne`
packages.
.. code:: python
pip install channels daphne
Or alternatively see the
`official channels installation guide <https://channels.readthedocs.io/en/latest/installation.html>`_ for additional
methods.
Testing Environments Testing Environments
==================== ====================
......
...@@ -14,7 +14,7 @@ Below is the minimum viable state for each version release. ...@@ -14,7 +14,7 @@ Below is the minimum viable state for each version release.
* At least some documentation exists for BaseTestCase and IntegrationTestCase. * At least some documentation exists for BaseTestCase and IntegrationTestCase.
* v 0.5.x * v 0.6.x
* Project is in a viable state to test both basic responses and selenium * Project is in a viable state to test both basic responses and selenium
browser responses. browser responses.
...@@ -27,7 +27,7 @@ Below is the minimum viable state for each version release. ...@@ -27,7 +27,7 @@ Below is the minimum viable state for each version release.
if not complete. if not complete.
* At least some documentation exists for LiveServerTestCase. * At least some documentation exists for LiveServerTestCase.
* v 0.6.x * v 0.7.x
* Project is in a viable state to test basic responses, selenium browser * Project is in a viable state to test basic responses, selenium browser
responses, and CSV file downloads. responses, and CSV file downloads.
......
...@@ -2,12 +2,13 @@ LiveServerTestCase ...@@ -2,12 +2,13 @@ LiveServerTestCase
****************** ******************
The **LiveServerTestCase** class provides additional wrapper functionality for The **LiveServerTestCase** and **ChannelsLiveServerTestCase** classes provide
writing tests that directly check a browser window instance, such as additional wrapper functionality for writing tests that directly check a
browser window instance, such as when using
`Selenium <https://www.selenium.dev/documentation/>`_. `Selenium <https://www.selenium.dev/documentation/>`_.
This class can be very helpful in testing logic that requires live browser These classes can be very helpful in testing logic that requires live browser
manipulation, such as any logic that uses JavaScript to function. manipulation, such as any logic that uses JavaScript to function.
...@@ -23,6 +24,6 @@ manipulation, such as any logic that uses JavaScript to function. ...@@ -23,6 +24,6 @@ manipulation, such as any logic that uses JavaScript to function.
.. attention:: .. attention::
This TestCase is not yet implemented. This TestCase is not yet fully implemented.
See :doc:`../roadmap`. See :doc:`../roadmap`.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment