summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMorgan Aubert <morgan.aubert@impakfinance.com>2018-04-27 17:18:15 -0400
committerTim Graham <timograham@gmail.com>2018-05-09 11:40:28 -0400
commit704443acacf0dfbcb1c52df4b260585055754ce7 (patch)
tree600147bf6114d7b490fcd253ff9797b7e7531c09 /docs
parent7ba040de7703fd06b9b35ddd31da40103d911c30 (diff)
Fixed #29363 -- Added SimpleTestCase.assertWarnsMessage().
Diffstat (limited to 'docs')
-rw-r--r--docs/internals/contributing/writing-code/coding-style.txt12
-rw-r--r--docs/releases/2.1.txt3
-rw-r--r--docs/topics/testing/tools.txt11
3 files changed, 22 insertions, 4 deletions
diff --git a/docs/internals/contributing/writing-code/coding-style.txt b/docs/internals/contributing/writing-code/coding-style.txt
index 5721c969cf..b34be61bc4 100644
--- a/docs/internals/contributing/writing-code/coding-style.txt
+++ b/docs/internals/contributing/writing-code/coding-style.txt
@@ -62,10 +62,14 @@ Python style
* In docstrings, follow the style of existing docstrings and :pep:`257`.
-* In tests, use :meth:`~django.test.SimpleTestCase.assertRaisesMessage` instead
- of :meth:`~unittest.TestCase.assertRaises` so you can check the exception
- message. Use :meth:`~unittest.TestCase.assertRaisesRegex` only if you need
- regular expression matching.
+* In tests, use
+ :meth:`~django.test.SimpleTestCase.assertRaisesMessage` and
+ :meth:`~django.test.SimpleTestCase.assertWarnsMessage`
+ instead of :meth:`~unittest.TestCase.assertRaises` and
+ :meth:`~unittest.TestCase.assertWarns` so you can check the
+ exception or warning message. Use :meth:`~unittest.TestCase.assertRaisesRegex`
+ and :meth:`~unittest.TestCase.assertWarnsRegex` only if you need regular
+ expression matching.
* In test docstrings, state the expected behavior that each test demonstrates.
Don't include preambles such as "Tests that" or "Ensures that".
diff --git a/docs/releases/2.1.txt b/docs/releases/2.1.txt
index e6b8b29a64..3152a42d76 100644
--- a/docs/releases/2.1.txt
+++ b/docs/releases/2.1.txt
@@ -277,6 +277,9 @@ Tests
dictionary as JSON if ``content_type='application/json'``. You can customize
the JSON encoder with test client's ``json_encoder`` parameter.
+* The new :meth:`.SimpleTestCase.assertWarnsMessage` method is a simpler
+ version of :meth:`~unittest.TestCase.assertWarnsRegex`.
+
URLs
~~~~
diff --git a/docs/topics/testing/tools.txt b/docs/topics/testing/tools.txt
index ef818f1bb8..6e83bbc6a9 100644
--- a/docs/topics/testing/tools.txt
+++ b/docs/topics/testing/tools.txt
@@ -692,6 +692,8 @@ A subclass of :class:`unittest.TestCase` that adds this functionality:
* Checking that a callable :meth:`raises a certain exception
<SimpleTestCase.assertRaisesMessage>`.
+ * Checking that a callable :meth:`triggers a certain warning
+ <SimpleTestCase.assertWarnsMessage>`.
* Testing form field :meth:`rendering and error treatment
<SimpleTestCase.assertFieldOutput>`.
* Testing :meth:`HTML responses for the presence/lack of a given fragment
@@ -1362,6 +1364,15 @@ your test suite.
with self.assertRaisesMessage(ValueError, 'invalid literal for int()'):
int('a')
+.. method:: SimpleTestCase.assertWarnsMessage(expected_warning, expected_message, callable, *args, **kwargs)
+ SimpleTestCase.assertWarnsMessage(expected_warning, expected_message)
+
+ .. versionadded:: 2.1
+
+ Analogous to :meth:`SimpleTestCase.assertRaisesMessage` but for
+ :meth:`~unittest.TestCase.assertWarnsRegex` instead of
+ :meth:`~unittest.TestCase.assertRaisesRegex`.
+
.. method:: SimpleTestCase.assertFieldOutput(fieldclass, valid, invalid, field_args=None, field_kwargs=None, empty_value='')
Asserts that a form field behaves correctly with various inputs.