From 8fdf2685745497d5996cbab5eaf4c5e562e1eed3 Mon Sep 17 00:00:00 2001
From: Andrew Godwin <andrew@aeracode.org>
Date: Wed, 6 Apr 2016 11:06:02 -0700
Subject: [PATCH] Add testing documentation

---
 docs/index.rst   |  1 +
 docs/testing.rst | 74 ++++++++++++++++++++++++++++++++++++++++++++++++
 patchinator.py   |  3 ++
 3 files changed, 78 insertions(+)
 create mode 100644 docs/testing.rst

diff --git a/docs/index.rst b/docs/index.rst
index 9a74541..9e36be1 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -32,6 +32,7 @@ Contents:
    integration-changes
    scaling
    backends
+   testing
    reference
    integration-plan
    faqs
diff --git a/docs/testing.rst b/docs/testing.rst
new file mode 100644
index 0000000..55476ba
--- /dev/null
+++ b/docs/testing.rst
@@ -0,0 +1,74 @@
+Testing Consumers
+=================
+
+When you want to write unit tests for your new Channels consumers, you'll
+realise that you can't use the standard Django test client to submit fake HTTP
+requests - instead, you'll need to submit fake Messages to your consumers,
+and inspect what Messages they send themselves.
+
+Channels comes with a ``TestCase`` subclass that sets all of this up for you,
+however, so you can easily write tests and check what your consumers are sending.
+
+
+ChannelTestCase
+---------------
+
+If your tests inherit from the ``channels.tests.ChannelTestCase`` base class,
+whenever you run tests your channel layer will be swapped out for a captive
+in-memory layer, meaning you don't need an exernal server running to run tests.
+
+Moreover, you can inject messages onto this layer and inspect ones sent to it
+to help test your consumers.
+
+To inject a message onto the layer, simply call ``Channel.send()`` inside
+any test method on a ``ChannelTestCase`` subclass, like so::
+
+    from channels import Channel
+    from channels.tests import ChannelTestCase
+
+    class MyTests(ChannelTestCase):
+        def test_a_thing(self):
+            # This goes onto an in-memory channel, not the real backend.
+            Channel("some-channel-name").send({"foo": "bar"})
+
+To receive a message from the layer, you can use ``self.get_next_message(channel)``,
+which handles receiving the message and converting it into a Message object for
+you (if you want, you can call ``receive_many`` on the underlying channel layer,
+but you'll get back a raw dict and channel name, which is not what consumers want).
+
+You can use this both to get Messages to send to consumers as their primary
+argument, as well as to get Messages from channels that consumers are supposed
+to send on to verify that they did.
+
+You can even pass ``require=True`` to ``get_next_message`` to make the test
+fail if there is no message on the channel (by default, it will return you
+``None`` instead).
+
+Here's an extended example testing a consumer that's supposed to take a value
+and post the square of it to the ``"result"`` channel::
+
+
+    from channels import Channel
+    from channels.tests import ChannelTestCase
+
+    class MyTests(ChannelTestCase):
+        def test_a_thing(self):
+            # Inject a message onto the channel to use in a consumer
+            Channel("input").send({"value": 33})
+            # Run the consumer with the new Message object
+            my_consumer(self.get_next_message("input", require=True))
+            # Verify there's a result and that it's accurate
+            result = self.get_next_message("result", require=True)
+            self.assertEqual(result['value'], 1089)
+
+
+Multiple Channel Layers
+-----------------------
+
+If you want to test code that uses multiple channel layers, specify the alias
+of the layers you want to mock as the ``test_channel_aliases`` attribute on
+the ``ChannelTestCase`` subclass; by default, only the ``default`` layer is
+mocked.
+
+You can pass an ``alias`` argument to ``get_next_message`` and ``Channel``
+to use a different layer too.
diff --git a/patchinator.py b/patchinator.py
index 04b500e..df99705 100644
--- a/patchinator.py
+++ b/patchinator.py
@@ -228,6 +228,9 @@ class Patchinator(object):
         FileMap(
             "docs/scaling.rst", "docs/topics/channels/scaling.txt", docs_transforms,
         ),
+        FileMap(
+            "docs/testing.rst", "docs/topics/channels/testing.txt", docs_transforms,
+        ),
     ]
 
     def __init__(self, source, destination):