diff --git a/docs/source/configuration/general.rst b/docs/source/configuration/general.rst index fc87bac7e0a473dfcedac72873fc945d21e7ab13..985ca9403a39dd7d13f96dbc830784545b7b0a00 100644 --- a/docs/source/configuration/general.rst +++ b/docs/source/configuration/general.rst @@ -64,11 +64,10 @@ Example:: SELENIUM_TEST_BROWSER ===================== -When using the :doc:`../test_cases/live_server_test_case` class for -`Selenium <https://www.selenium.dev/>`_ tests, this setting specify which browser -type you wish to use. +When using the :doc:`../test_cases/live_server_test_case` classes +for `Selenium <https://www.selenium.dev/>`_ tests, this setting specifies which browser to use. -Supported test browsers are as follows: +Currently, supported test browsers are as follows: * chrome * chromium * firefox diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst index b5719be57640fc10a4603fb8151e5ad3db70d8cc..fa6af77a6d1198f0c5813f56cbd0c3fd287840f7 100644 --- a/docs/source/quickstart.rst +++ b/docs/source/quickstart.rst @@ -32,14 +32,46 @@ definition: '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 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 ==================== diff --git a/docs/source/roadmap.rst b/docs/source/roadmap.rst index 5364606547c19a7dc68bdd844aefdc92d0a59d95..f15392040db91f46d2e9033d3641445f78d5f1ed 100644 --- a/docs/source/roadmap.rst +++ b/docs/source/roadmap.rst @@ -14,7 +14,7 @@ Below is the minimum viable state for each version release. * 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 browser responses. @@ -27,7 +27,7 @@ Below is the minimum viable state for each version release. if not complete. * 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 responses, and CSV file downloads. diff --git a/docs/source/test_cases/live_server_test_case.rst b/docs/source/test_cases/live_server_test_case.rst index 62a616bfd8737ecdd1483c75b356876a05a02b81..92c4abc0ee0baa2347655b445944c8109de37d9b 100644 --- a/docs/source/test_cases/live_server_test_case.rst +++ b/docs/source/test_cases/live_server_test_case.rst @@ -2,12 +2,13 @@ LiveServerTestCase ****************** -The **LiveServerTestCase** class provides additional wrapper functionality for -writing tests that directly check a browser window instance, such as +The **LiveServerTestCase** and **ChannelsLiveServerTestCase** classes provide +additional wrapper functionality for writing tests that directly check a +browser window instance, such as when using `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. @@ -23,6 +24,6 @@ manipulation, such as any logic that uses JavaScript to function. .. attention:: - This TestCase is not yet implemented. + This TestCase is not yet fully implemented. See :doc:`../roadmap`.