Skip to content
This repository
Browse code

Add docs for non-selenium tests

  • Loading branch information...
commit 7c96142e42836d50ffd0e98e0cc6a4ae6065edde 1 parent 62a2fc1
James Polley jamezpolley authored

Showing 1 changed file with 36 additions and 5 deletions. Show diff stats Hide diff stats

  1. +36 5 doc/tests.rst
41 doc/tests.rst
Source Rendered
... ... @@ -1,8 +1,19 @@
1 1 Tests -- How we know that stuff ain't done broke.
2 2 -------------------------------------------------
3 3
4   -:mod:`base` - Base classes and common code for tests
5   -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  4 +Selenium tests -- Test client-side behaviour
  5 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  6 +
  7 +:mod:`base` - Base classes and common code for selenium tests
  8 +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  9 +
  10 +.. tip:: While it's very cool, testing with Selenium is slow due to the need to
  11 + fire up a Firefox process and wait for page rendering. Selenium should only be
  12 + used when testing client-side behaviours.
  13 +
  14 +.. warning:: If your computer doesn't have a working internet connection,
  15 + Firefox will switch to offline mode and not even try connecting to localhost.
  16 + This breaks the tests. Good job, Firefox!
6 17
7 18 .. automodule:: usergroup.selenium_tests.base
8 19 :members:
@@ -10,7 +21,7 @@ Tests -- How we know that stuff ain't done broke.
10 21 :show-inheritance:
11 22
12 23 :mod:`create_and_manipulate_meetings_test`
13   -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  24 +""""""""""""""""""""""""""""""""""""""""""
14 25
15 26 .. automodule:: usergroup.selenium_tests.create_and_manipulate_meetings_test
16 27 :members:
@@ -18,7 +29,7 @@ Tests -- How we know that stuff ain't done broke.
18 29 :show-inheritance:
19 30
20 31 :mod:`login_test` - Walking through the login process
21   -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  32 +"""""""""""""""""""""""""""""""""""""""""""""""""""""
22 33
23 34 .. automodule:: usergroup.selenium_tests.login_test
24 35 :members:
@@ -26,10 +37,30 @@ Tests -- How we know that stuff ain't done broke.
26 37 :show-inheritance:
27 38
28 39 :mod:`register_and_respond_test` - New user registration and handling
29   -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  40 +"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
30 41
31 42 .. automodule:: usergroup.selenium_tests.register_and_respond_test
32 43 :members:
33 44 :undoc-members:
34 45 :show-inheritance:
35 46
  47 +Django tests -- Test views and backend functionality only
  48 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  49 +
  50 +:mod:`email_test` -- Test that emails get sent appropriately
  51 +""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
  52 +
  53 +.. note:: Currently very incomplete
  54 +
  55 +.. automodule:: usergroup.django_tests.email_test
  56 + :members:
  57 + :undoc-members:
  58 + :show-inheritance:
  59 +
  60 +:mod:`login_test` -- Test that logins work as expected
  61 +""""""""""""""""""""""""""""""""""""""""""""""""""""""
  62 +
  63 +.. automodule:: usergroup.django_tests.login_test
  64 + :members:
  65 + :undoc-members:
  66 + :show-inheritance:

0 comments on commit 7c96142

Please sign in to comment.
Something went wrong with that request. Please try again.