Ticket #2879: 2879.selenium-support.3.diff

django/conf/global_settings.py

@@ -560 +560 @@
 # The name of the class to use to run the test suite
 TEST_RUNNER = 'django.test.simple.DjangoTestSuiteRunner'
 
+# For the live test server (e.g. used for running Selenium tests)
+LIVE_TEST_SERVER_ADDRESS = 'localhost'
+LIVE_TEST_SERVER_PORT = 8080
+
+# For Selenium
+SELENIUM_SERVER_ADDRESS = 'localhost'
+SELENIUM_SERVER_PORT = 4444
+SELENIUM_BROWSER = '*firefox'
+
 ############
 # FIXTURES #
 ############

django/test/testcases.py

@@ -1 +1 @@
 from __future__ import with_statement
 
+import httplib
 import re
 import sys
 from functools import wraps
 from urlparse import urlsplit, urlunsplit
 from xml.dom.minidom import parseString, Node
+import select
+import socket
+import threading
 
 from django.conf import settings
+from django.contrib.staticfiles.handlers import StaticFilesHandler
 from django.core import mail
 from django.core.exceptions import ValidationError
+from django.core.handlers.wsgi import WSGIHandler
 from django.core.management import call_command
 from django.core.signals import request_started
+from django.core.servers.basehttp import (WSGIRequestHandler, WSGIServer,
+    WSGIServerException)
 from django.core.urlresolvers import clear_url_caches
 from django.core.validators import EMPTY_VALUES
 from django.db import (transaction, connection, connections, DEFAULT_DB_ALIAS,
@@ -23 +31 @@
     override_settings)
 from django.utils import simplejson, unittest as ut2
 from django.utils.encoding import smart_str
+from django.utils.unittest import skipUnless
 
 __all__ = ('DocTestRunner', 'OutputChecker', 'TestCase', 'TransactionTestCase',
            'SimpleTestCase', 'skipIfDBFeature', 'skipUnlessDBFeature')
@@ -732 +741 @@
     """
     return _deferredSkip(lambda: not getattr(connection.features, feature),
                          "Database doesn't support feature %s" % feature)
+
+class QuietWSGIRequestHandler(WSGIRequestHandler):
+    """
+    Just a regular WSGIRequestHandler except it doesn't log to the standard
+    output any of the requests received, so as to not clutter the output for
+    the tests' results.
+    """
+    def log_message(*args):
+        pass
+
+class StoppableWSGIServer(WSGIServer):
+    """
+    The code in this class is borrowed from the `SocketServer.BaseServer` class
+    in Python 2.6. The important functionality here is that the server is non-
+    blocking and that it can be shut down at any moment. This is made possible
+    by the server regularly polling the socket and checking if it has been
+    asked to stop.
+    Note for the future: Once Django stops supporting Python 2.5, this class
+    can be removed as `WSGIServer` will have this ability to shutdown on
+    demand.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super(StoppableWSGIServer, self).__init__(*args, **kwargs)
+        self.__is_shut_down = threading.Event()
+        self.__serving = False
+
+    def serve_forever(self, poll_interval=0.5):
+        """Handle one request at a time until shutdown.
+
+        Polls for shutdown every poll_interval seconds.
+        """
+        self.__serving = True
+        self.__is_shut_down.clear()
+        while self.__serving:
+            r, w, e = select.select([self], [], [], poll_interval)
+            if r:
+                self._handle_request_noblock()
+        self.__is_shut_down.set()
+
+    def shutdown(self):
+        """Stops the serve_forever loop.
+
+        Blocks until the loop has finished. This must be called while
+        serve_forever() is running in another thread, or it will
+        deadlock.
+        """
+        self.__serving = False
+        self.__is_shut_down.wait()
+
+    def handle_request(self):
+        """Handle one request, possibly blocking.
+        """
+        fd_sets = select.select([self], [], [], None)
+        if not fd_sets[0]:
+            return
+        self._handle_request_noblock()
+
+    def _handle_request_noblock(self):
+        """Handle one request, without blocking.
+
+        I assume that select.select has returned that the socket is
+        readable before this function was called, so there should be
+        no risk of blocking in get_request().
+        """
+        try:
+            request, client_address = self.get_request()
+        except socket.error:
+            return
+        if self.verify_request(request, client_address):
+            try:
+                self.process_request(request, client_address)
+            except Exception:
+                self.handle_error(request, client_address)
+                self.close_request(request)
+
+class LiveServerThread(threading.Thread):
+    """
+    Thread for running a live http server while the tests are running.
+    """
+
+    def __init__(self, address, port, fixtures):
+        self.address = address
+        self.port = port
+        self.fixtures = fixtures
+        self.is_ready = threading.Event()
+        self.error = None
+        super(LiveServerThread, self).__init__()
+
+    def run(self):
+        """
+        Sets up live server and database and loops over handling http requests.
+        """
+        try:
+            # Instantiate and start the server
+            self.httpd = StoppableWSGIServer(
+                (self.address, self.port), QuietWSGIRequestHandler)
+            handler = StaticFilesHandler(WSGIHandler())
+            self.httpd.set_app(handler)
+
+            # If the database is in memory we must reload the data in this new
+            # thread.
+            if (settings.DATABASES['default']['ENGINE'] == 'django.db.backends.sqlite3' or
+                settings.DATABASES['default']['TEST_NAME']):
+                connection.creation.create_test_db(0)
+                # Import the fixtures into the test database
+                if hasattr(self, 'fixtures'):
+                    call_command('loaddata', *self.fixtures,
+                        **{'verbosity': 0})
+            self.is_ready.set()
+            self.httpd.serve_forever()
+        except WSGIServerException, e:
+            self.error = e
+            self.is_ready.set()
+
+    def join(self, timeout=None):
+        self.httpd.shutdown()
+        self.httpd.server_close()
+        super(LiveServerThread, self).join(timeout)
+
+class LiveServerTestCase(TestCase):
+    """
+    Does basically the same as TestCase but also launches a live http server in
+    a separate thread so that the tests may use another testing framework, such
+    as Selenium for example, instead of the built-in dummy client.
+    """
+
+    fixtures = []
+
+    def setUp(self):
+        # Launch the Django live server's thread
+        self.server_thread = LiveServerThread(
+            settings.LIVE_TEST_SERVER_ADDRESS,
+            int(settings.LIVE_TEST_SERVER_PORT),
+            fixtures=self.fixtures)
+        self.server_thread.start()
+        super(LiveServerTestCase, self).setUp()
+
+    def tearDown(self):
+        # Terminate the Django server's thread
+        self.server_thread.join()
+        super(LiveServerTestCase, self).tearDown()
+
+try:
+    # Check if the 'selenium' package is installed
+    from selenium import selenium
+    selenium_installed = True
+except ImportError:
+    selenium_installed = False
+
+# Check if the Selenium server is running
+try:
+    conn = httplib.HTTPConnection(settings.SELENIUM_SERVER_ADDRESS,
+        settings.SELENIUM_SERVER_PORT)
+    try:
+        conn.request("GET", "/selenium-server/driver/", '', {})
+    finally:
+        conn.close()
+    selenium_server_running = True
+except socket.error:
+    selenium_server_running = False
+
+class SeleniumTestCase(LiveServerTestCase):
+    """
+    Does basically the same as TestServerTestCase but also connects to the
+    Selenium server. The selenium client is then available with
+    'self.selenium'. The requirements are to have the 'selenium' installed in
+    the python path and to have the Selenium server running. If those
+    requirements are not filled then the tests will be skipped.
+    """
+
+    def setUp(self):
+        super(SeleniumTestCase, self).setUp()
+        # Launch the Selenium server
+        selenium_browser_url = 'http://%s:%s' % (
+            settings.LIVE_TEST_SERVER_ADDRESS, settings.LIVE_TEST_SERVER_PORT)
+        self.selenium = selenium(
+            settings.SELENIUM_SERVER_ADDRESS,
+            int(settings.SELENIUM_SERVER_PORT),
+            settings.SELENIUM_BROWSER,
+            selenium_browser_url)
+        self.selenium.start()
+        # Wait for the Django server to be ready
+        self.server_thread.is_ready.wait()
+        if self.server_thread.error:
+            raise self.server_thread.error
+
+    def tearDown(self):
+        super(SeleniumTestCase, self).tearDown()
+        self.selenium.stop()
+
+SeleniumTestCase = skipUnless(selenium_installed,
+    'The \'selenium\' package isn\'t installed')(SeleniumTestCase)
+SeleniumTestCase = skipUnless(selenium_server_running,
+    'Can\'t connect to the Selenium server using address %s and port %s' % (
+    settings.SELENIUM_SERVER_ADDRESS, settings.SELENIUM_SERVER_PORT)
+)(SeleniumTestCase)
+ No newline at end of file

docs/internals/contributing/writing-code/unit-tests.txt

@@ -122 +122 @@
 
     ./runtests.py --settings=path.to.settings i18n.TranslationTests.test_lazy_objects
 
+Running the Selenium tests
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Some admin tests require Selenium to work via a real Web browser. To allow
+those tests to run and not be skipped, you must install the selenium_ package
+into the Python path and download the `Selenium server (>2.12.0)`_. The
+Selenium server must then be started with the following command:
+
+.. code-block:: bash
+
+    java -jar selenium-server-standalone-2.12.0.jar
+
+You may also run the tests headless (i.e. with a virtual display). On Linux:
+
+    Xvfb :99 -ac & && DISPLAY=:99 java -jar selenium-server-standalone-2.12.0.jar
+
+*TODO: Running headless on the Mac and Windows...*
+
+Then, run the tests normally, for example:
+
+.. code-block:: bash
+
+    ./runtests.py --settings=test_sqlite admin_inlines
+
 Running all the tests
 ~~~~~~~~~~~~~~~~~~~~~
 
@@ -135 +159 @@
 *  setuptools_
 *  memcached_, plus a :ref:`supported Python binding <memcached>`
 *  gettext_ (:ref:`gettext_on_windows`)
+*  selenium_ plus the `Selenium server (>2.12.0)`_
 
 If you want to test the memcached cache backend, you'll also need to define
 a :setting:`CACHES` setting that points at your memcached instance.
@@ -149 +174 @@
 .. _setuptools: http://pypi.python.org/pypi/setuptools/
 .. _memcached: http://www.danga.com/memcached/
 .. _gettext: http://www.gnu.org/software/gettext/manual/gettext.html
+.. _selenium: http://pypi.python.org/pypi/selenium
+.. _Selenium server (>2.12.0): http://seleniumhq.org/download/
 
 .. _contrib-apps:
 

docs/ref/settings.txt

@@ -195 +195 @@
 
 See the :ref:`cache documentation <cache_key_prefixing>` for more information.
 
+LIVE_TEST_SERVER_ADDRESS
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Default: ``'localhost'``
+
+TODO: Description...
+
+LIVE_TEST_SERVER_PORT
+~~~~~~~~~~~~~~~~~~~~~
+
+Default: ``8080``
+
+TODO: Description...
+
 .. setting:: CACHES-LOCATION
 
 LOCATION
@@ -498 +512 @@
 
 .. setting:: USER
 
+SELENIUM_SERVER_ADDRESS
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Default: ``localhost``
+
+Address where the Selenium server can be accessed.
+
+SELENIUM_SERVER_PORT
+~~~~~~~~~~~~~~~~~~~~
+
+Default: ``4444``
+
+Port where the Selenium server can be accessed.
+
+SELENIUM_BROWSER
+~~~~~~~~~~~~~~~~
+
+Default: ``'*firefox'``
+
+Browser to be used when running Selenium tests. Note that the prefixing star
+('``*``') is required. Possible values include:
+
+*  ``'*firefox'``
+*  ``'*googlechrome'``
+*  ``'*safari'``
+*  ``'*mock'``
+*  ``'*firefoxproxy'``
+*  ``'*pifirefox'``
+*  ``'*chrome'``
+*  ``'*iexploreproxy'``
+*  ``'*iexplore'``
+*  ``'*safariproxy'``
+*  ``'*konqueror'``
+*  ``'*firefox2'``
+*  ``'*firefox3'``
+*  ``'*firefoxchrome'``
+*  ``'*piiexplore'``
+*  ``'*opera'``
+*  ``'*iehta'``
+*  ``'*custom'``
+
 USER
 ~~~~
 

docs/topics/testing.txt

@@ -580 +580 @@
 * Test that a given request is rendered by a given Django template, with
   a template context that contains certain values.
 
-Note that the test client is not intended to be a replacement for Twill_,
+Note that the test client is not intended to be a replacement for Windmill_,
 Selenium_, or other "in-browser" frameworks. Django's test client has
 a different focus. In short:
 
 * Use Django's test client to establish that the correct view is being
   called and that the view is collecting the correct context data.
 
-* Use in-browser frameworks such as Twill and Selenium to test *rendered*
-  HTML and the *behavior* of Web pages, namely JavaScript functionality.
+* Use in-browser frameworks such as Windmill_ and Selenium_ to test *rendered*
+  HTML and the *behavior* of Web pages, namely JavaScript functionality. Django
+  also provides special support for those frameworks; see the sections on
+  :class:`~django.test.testcases.LiveServerTestCase` and
+  :class:`~django.test.testcases.SeleniumTestCase`.
 
 A comprehensive test suite should use a combination of both test types.
 
-.. _Twill: http://twill.idyll.org/
-.. _Selenium: http://seleniumhq.org/
-
 Overview and a quick example
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -1828 +1828 @@
     those options will be added to the list of command-line options that
     the :djadmin:`test` command can use.
 
+Live test server
+----------------
+
+.. currentmodule:: django.test.testcases
+
+.. versionadded::1.4
+
+.. class:: LiveServerTestCase()
+
+**This is a stub**
+
+``LiveServerTestCase`` does basically the same as ``TestCase`` but also
+launches a live http server in a separate thread so that the tests may use
+another testing framework, such as Selenium_ or Windmill_ for example, instead
+of the built-in :ref:`dummy client <test-client>`.
+
+Selenium
+--------
+
+.. versionadded::1.4
+
+.. class:: SeleniumTestCase()
+
+**This is a stub**
+
+Django provides out-of-the box support for Selenium_, as Django itself uses it
+in its own test suite for the admin.
+
+TODO:
+
+*  settings
+*  requirements
+*  code sample
+
+.. _Windmill: http://www.getwindmill.com/
+.. _Selenium: http://seleniumhq.org/
 
 Attributes
 ~~~~~~~~~~

tests/regressiontests/admin_inlines/tests.py

@@ -7 +7 @@
 
 # local test models
 from .admin import InnerInline
+from django.test.testcases import SeleniumTestCase
 from .models import (Holder, Inner, Holder2, Inner2, Holder3, Inner3, Person,
     OutfitItem, Fashionista, Teacher, Parent, Child, Author, Book)
 
@@ -380 +381 @@
         self.assertContains(response, 'value="4" id="id_inner2_set-TOTAL_FORMS"')
         self.assertContains(response, '<input type="hidden" name="inner2_set-0-id" value="%i"' % self.inner2_id)
         self.assertContains(response, 'id="id_inner2_set-0-DELETE"')
+
+
+class SeleniumTests(SeleniumTestCase):
+    fixtures = ['admin-views-users.xml']
+    urls = "regressiontests.admin_inlines.urls"
+
+    def admin_login(self, username, password):
+        """
+        Helper function to log into the admin.
+        """
+        self.selenium.open('/admin/')
+        self.selenium.type('username', username)
+        self.selenium.type('password', password)
+        self.selenium.click("//input[@value='Log in']")
+        self.selenium.wait_for_page_to_load(3000)
+
+    def test_add_inlines(self):
+        """
+        Ensure that the "Add another XXX" link correctly adds items to the
+        inline form.
+        """
+        self.admin_login(username='super', password='secret')
+        self.selenium.open('/admin/admin_inlines/titlecollection/add/')
+
+        # Check that there's only one inline to start with and that it has the
+        # correct ID.
+        self.failUnlessEqual(self.selenium.get_css_count(
+            'css=#title_set-group table tr.dynamic-title_set'), 1)
+        self.failUnless(self.selenium.get_attribute(
+            'css=.dynamic-title_set:nth-of-type(1)@id'), 'title_set-0')
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-0 input[name=title_set-0-title1]'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-0 input[name=title_set-0-title2]'))
+
+        # Add an inline
+        self.selenium.click("link=Add another Title")
+
+        # Check that the inline has been added, that it has the right id, and
+        # that it contains the right fields.
+        self.failUnlessEqual(self.selenium.get_css_count(
+            'css=#title_set-group table tr.dynamic-title_set'), 2)
+        self.failUnless(self.selenium.get_attribute(
+            'css=.dynamic-title_set:nth-of-type(2)@id'), 'title_set-1')
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-1 input[name=title_set-1-title1]'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-1 input[name=title_set-1-title2]'))
+
+        # Let's add another one to be sure
+        self.selenium.click("link=Add another Title")
+        self.failUnlessEqual(self.selenium.get_css_count(
+            'css=#title_set-group table tr.dynamic-title_set'), 3)
+        self.failUnless(self.selenium.get_attribute(
+            'css=.dynamic-title_set:nth-of-type(3)@id'), 'title_set-2')
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-2 input[name=title_set-2-title1]'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-2 input[name=title_set-2-title2]'))
+
+    def test_delete_inlines(self):
+        self.admin_login(username='super', password='secret')
+        self.selenium.open('/admin/admin_inlines/titlecollection/add/')
+
+        # Add a few inlines
+        self.selenium.click("link=Add another Title")
+        self.selenium.click("link=Add another Title")
+        self.selenium.click("link=Add another Title")
+        self.selenium.click("link=Add another Title")
+        self.failUnlessEqual(self.selenium.get_css_count(
+            'css=#title_set-group table tr.dynamic-title_set'), 5)
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-0'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-1'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-2'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-3'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-4'))
+
+        # Click on a few delete buttons
+        self.selenium.click(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-1 td.delete a')
+        self.selenium.click(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-2 td.delete a')
+        # Verify that they're gone and that the IDs have been re-sequenced
+        self.failUnlessEqual(self.selenium.get_css_count(
+            'css=#title_set-group table tr.dynamic-title_set'), 3)
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-0'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-1'))
+        self.failUnless(self.selenium.is_element_present(
+            'css=form#titlecollection_form tr.dynamic-title_set#title_set-2'))
+ No newline at end of file

tests/regressiontests/admin_widgets/tests.py

@@ -11 +11 @@
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.db.models import DateField
 from django.test import TestCase as DjangoTestCase
+from django.test.testcases import SeleniumTestCase
 from django.utils import translation
 from django.utils.html import conditional_escape
 from django.utils.unittest import TestCase
@@ -372 +373 @@
         # Used to fail with a name error.
         w = widgets.RelatedFieldWidgetWrapper(w, rel, widget_admin_site)
         self.assertFalse(w.can_add_related)
+
+
+class SeleniumTests(SeleniumTestCase):
+    fixtures = ['admin-widgets-users.xml']
+    urls = "regressiontests.admin_widgets.urls"
+
+    def admin_login(self, username, password):
+        """
+        Helper function to log into the admin.
+        """
+        self.selenium.open('/')
+        self.selenium.type('username', username)
+        self.selenium.type('password', password)
+        self.selenium.click("//input[@value='Log in']")
+        self.selenium.wait_for_page_to_load(3000)
+
+    def get_css_value(self, selector, attribute):
+        """
+        Helper function that returns the value for the CSS attribute of an
+        DOM element specified by the given selector.
+        """
+        return self.selenium.get_eval(
+            'selenium.browserbot.getCurrentWindow().django'
+            '.jQuery("%s").css("%s")' % (selector, attribute))
+
+    def test_show_hide_date_time_picker_widgets(self):
+        """
+        Ensure that pressing the ESC key closes the date and time picker
+        widgets.
+        Refs #17064.
+        """
+        self.admin_login(username='super', password='secret')
+        # Open a page that has a date and time picker widgets
+        self.selenium.open('/admin_widgets/member/add/')
+
+        # First, with the date picker widget ---------------------------------
+        # Check that the date picker is hidden
+        self.assertEqual(
+            self.get_css_value('#calendarbox0', 'display'), 'none')
+        # Click the calendar icon
+        self.selenium.click('id=calendarlink0')
+        # Check that the date picker is visible
+        self.assertEqual(
+            self.get_css_value('#calendarbox0', 'display'), 'block')
+        # Press the ESC key
+        self.selenium.key_up('css=html', '27')
+        # Check that the date picker is hidden again
+        self.assertEqual(
+            self.get_css_value('#calendarbox0', 'display'), 'none')
+
+        # Then, with the time picker widget ----------------------------------
+        # Check that the time picker is hidden
+        self.assertEqual(
+            self.get_css_value('#clockbox0', 'display'), 'none')
+        # Click the time icon
+        self.selenium.click('id=clocklink0')
+        # Check that the time picker is visible
+        self.assertEqual(
+            self.get_css_value('#clockbox0', 'display'), 'block')
+        # Press the ESC key
+        self.selenium.key_up('css=html', '27')
+        # Check that the time picker is hidden again
+        self.assertEqual(
+            self.get_css_value('#clockbox0', 'display'), 'none')
+ No newline at end of file