Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add docs for non-selenium tests

  • Loading branch information...
commit 7c96142e42836d50ffd0e98e0cc6a4ae6065edde 1 parent 62a2fc1
@jamezpolley jamezpolley authored
Showing with 36 additions and 5 deletions.
  1. +36 −5 doc/tests.rst
View
41 doc/tests.rst
@@ -1,8 +1,19 @@
Tests -- How we know that stuff ain't done broke.
-------------------------------------------------
-:mod:`base` - Base classes and common code for tests
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Selenium tests -- Test client-side behaviour
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+:mod:`base` - Base classes and common code for selenium tests
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. tip:: While it's very cool, testing with Selenium is slow due to the need to
+ fire up a Firefox process and wait for page rendering. Selenium should only be
+ used when testing client-side behaviours.
+
+.. warning:: If your computer doesn't have a working internet connection,
+ Firefox will switch to offline mode and not even try connecting to localhost.
+ This breaks the tests. Good job, Firefox!
.. automodule:: usergroup.selenium_tests.base
:members:
@@ -10,7 +21,7 @@ Tests -- How we know that stuff ain't done broke.
:show-inheritance:
:mod:`create_and_manipulate_meetings_test`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+""""""""""""""""""""""""""""""""""""""""""
.. automodule:: usergroup.selenium_tests.create_and_manipulate_meetings_test
:members:
@@ -18,7 +29,7 @@ Tests -- How we know that stuff ain't done broke.
:show-inheritance:
:mod:`login_test` - Walking through the login process
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+"""""""""""""""""""""""""""""""""""""""""""""""""""""
.. automodule:: usergroup.selenium_tests.login_test
:members:
@@ -26,10 +37,30 @@ Tests -- How we know that stuff ain't done broke.
:show-inheritance:
:mod:`register_and_respond_test` - New user registration and handling
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
.. automodule:: usergroup.selenium_tests.register_and_respond_test
:members:
:undoc-members:
:show-inheritance:
+Django tests -- Test views and backend functionality only
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+:mod:`email_test` -- Test that emails get sent appropriately
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. note:: Currently very incomplete
+
+.. automodule:: usergroup.django_tests.email_test
+ :members:
+ :undoc-members:
+ :show-inheritance:
+
+:mod:`login_test` -- Test that logins work as expected
+""""""""""""""""""""""""""""""""""""""""""""""""""""""
+
+.. automodule:: usergroup.django_tests.login_test
+ :members:
+ :undoc-members:
+ :show-inheritance:
Please sign in to comment.
Something went wrong with that request. Please try again.