about summary refs log tree commit diff
path: root/test/support/channel_case.ex
diff options
context:
space:
mode:
Diffstat (limited to 'test/support/channel_case.ex')
-rw-r--r--test/support/channel_case.ex34
1 files changed, 34 insertions, 0 deletions
diff --git a/test/support/channel_case.ex b/test/support/channel_case.ex
new file mode 100644
index 0000000..14e1c62
--- /dev/null
+++ b/test/support/channel_case.ex
@@ -0,0 +1,34 @@
+defmodule RookWeb.ChannelCase do
+  @moduledoc """
+  This module defines the test case to be used by
+  channel tests.
+
+  Such tests rely on `Phoenix.ChannelTest` and also
+  import other functionality to make it easier
+  to build common data structures and query the data layer.
+
+  Finally, if the test case interacts with the database,
+  we enable the SQL sandbox, so changes done to the database
+  are reverted at the end of every test. If you are using
+  PostgreSQL, you can even run database tests asynchronously
+  by setting `use RookWeb.ChannelCase, async: true`, although
+  this option is not recommended for other databases.
+  """
+
+  use ExUnit.CaseTemplate
+
+  using do
+    quote do
+      # Import conveniences for testing with channels
+      import Phoenix.ChannelTest
+      import RookWeb.ChannelCase
+
+      # The default endpoint for testing
+      @endpoint RookWeb.Endpoint
+    end
+  end
+
+  setup _tags do
+    :ok
+  end
+end