git.squeep.com Git - akkoma/blob - test/support/conn_case.ex

   1 # Pleroma: A lightweight social networking server
   2 # Copyright © 2017-2020 Pleroma Authors <https://pleroma.social/>
   3 # SPDX-License-Identifier: AGPL-3.0-only
   4
   5 defmodule Pleroma.Web.ConnCase do
   6   @moduledoc """
   7   This module defines the test case to be used by
   8   tests that require setting up a connection.
   9
  10   Such tests rely on `Phoenix.ConnTest` and also
  11   import other functionality to make it easier
  12   to build common datastructures and query the data layer.
  13
  14   Finally, if the test case interacts with the database,
  15   it cannot be async. For this reason, every test runs
  16   inside a transaction which is reset at the beginning
  17   of the test unless the test case is marked as async.
  18   """
  19
  20   use ExUnit.CaseTemplate
  21
  22   using do
  23     quote do
  24       # Import conveniences for testing with connections
  25       use Phoenix.ConnTest
  26       use Pleroma.Tests.Helpers
  27       import Pleroma.Web.Router.Helpers
  28
  29       alias Pleroma.Config
  30
  31       # The default endpoint for testing
  32       @endpoint Pleroma.Web.Endpoint
  33
  34       # Sets up OAuth access with specified scopes
  35       defp oauth_access(scopes, opts \\ []) do
  36         user =
  37           Keyword.get_lazy(opts, :user, fn ->
  38             Pleroma.Factory.insert(:user)
  39           end)
  40
  41         token =
  42           Keyword.get_lazy(opts, :oauth_token, fn ->
  43             Pleroma.Factory.insert(:oauth_token, user: user, scopes: scopes)
  44           end)
  45
  46         conn =
  47           build_conn()
  48           |> assign(:user, user)
  49           |> assign(:token, token)
  50
  51         %{user: user, token: token, conn: conn}
  52       end
  53
  54       defp request_content_type(%{conn: conn}) do
  55         conn = put_req_header(conn, "content-type", "multipart/form-data")
  56         [conn: conn]
  57       end
  58
  59       defp ensure_federating_or_authenticated(conn, url, user) do
  60         initial_setting = Config.get([:instance, :federating])
  61         on_exit(fn -> Config.put([:instance, :federating], initial_setting) end)
  62
  63         Config.put([:instance, :federating], false)
  64
  65         conn
  66         |> get(url)
  67         |> response(403)
  68
  69         conn
  70         |> assign(:user, user)
  71         |> get(url)
  72         |> response(200)
  73
  74         Config.put([:instance, :federating], true)
  75
  76         conn
  77         |> get(url)
  78         |> response(200)
  79       end
  80     end
  81   end
  82
  83   setup tags do
  84     Cachex.clear(:user_cache)
  85     Cachex.clear(:object_cache)
  86     :ok = Ecto.Adapters.SQL.Sandbox.checkout(Pleroma.Repo)
  87
  88     unless tags[:async] do
  89       Ecto.Adapters.SQL.Sandbox.mode(Pleroma.Repo, {:shared, self()})
  90     end
  91
  92     if tags[:needs_streamer] do
  93       start_supervised(Pleroma.Web.Streamer.supervisor())
  94     end
  95
  96     {:ok, conn: Phoenix.ConnTest.build_conn()}
  97   end
  98 end