From ace02e02d935286cf10bef32d5378201334e88d8 Mon Sep 17 00:00:00 2001 From: mzerone Date: Thu, 21 Nov 2024 12:08:10 +0200 Subject: [PATCH] deprecate `use Plug.Test` --- README.md | 5 +++-- lib/plug/test.ex | 6 +++++- test/plug/basic_auth_test.exs | 3 ++- test/plug/builder_test.exs | 3 ++- test/plug/conn/wrapper_error_test.exs | 2 +- test/plug/conn_test.exs | 3 ++- test/plug/csrf_protection_test.exs | 3 ++- test/plug/debugger_test.exs | 3 ++- test/plug/error_handler_test.exs | 3 ++- test/plug/head_test.exs | 3 ++- test/plug/logger_test.exs | 3 ++- test/plug/method_override_test.exs | 3 ++- test/plug/parsers/json_test.exs | 3 ++- test/plug/parsers_test.exs | 3 ++- test/plug/request_id_test.exs | 3 ++- test/plug/rewrite_on_test.exs | 3 ++- test/plug/router_test.exs | 3 ++- test/plug/session/cookie_test.exs | 3 ++- test/plug/session_test.exs | 3 ++- test/plug/ssl_test.exs | 3 ++- test/plug/static_test.exs | 3 ++- test/plug/telemetry_test.exs | 2 +- test/plug_test.exs | 3 ++- 23 files changed, 48 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index d23765f36..fc7cd7437 100644 --- a/README.md +++ b/README.md @@ -284,8 +284,9 @@ Plug ships with a `Plug.Test` module that makes testing your plugs easy. Here is ```elixir defmodule MyPlugTest do use ExUnit.Case, async: true - use Plug.Test - + import Plug.Test + import Plug.Conn + @opts MyRouter.init([]) test "returns hello world" do diff --git a/lib/plug/test.ex b/lib/plug/test.ex index de486ceea..0abed7514 100644 --- a/lib/plug/test.ex +++ b/lib/plug/test.ex @@ -5,7 +5,8 @@ defmodule Plug.Test do This module can be used in your test cases, like this: use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn Using this module will: @@ -22,6 +23,9 @@ defmodule Plug.Test do """ @doc false + @deprecated """ + Please use `import Plug.Test` and `import Plug.Conn` directly instead. + """ defmacro __using__(_) do quote do import Plug.Test diff --git a/test/plug/basic_auth_test.exs b/test/plug/basic_auth_test.exs index 7e9fda0ca..09170a275 100644 --- a/test/plug/basic_auth_test.exs +++ b/test/plug/basic_auth_test.exs @@ -1,6 +1,7 @@ defmodule Plug.BasicAuthTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn import Plug.BasicAuth diff --git a/test/plug/builder_test.exs b/test/plug/builder_test.exs index 7ecda97af..d40fa83cd 100644 --- a/test/plug/builder_test.exs +++ b/test/plug/builder_test.exs @@ -82,7 +82,8 @@ defmodule Plug.BuilderTest do end use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn test "exports the init/1 function" do assert Sample.init(:ok) == :ok diff --git a/test/plug/conn/wrapper_error_test.exs b/test/plug/conn/wrapper_error_test.exs index 417044e7f..a037ba0ac 100644 --- a/test/plug/conn/wrapper_error_test.exs +++ b/test/plug/conn/wrapper_error_test.exs @@ -1,6 +1,6 @@ defmodule Plug.Conn.WrapperErrorTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test test "reraise/3" do conn = conn(:get, "/") diff --git a/test/plug/conn_test.exs b/test/plug/conn_test.exs index 91db7c694..371021ed4 100644 --- a/test/plug/conn_test.exs +++ b/test/plug/conn_test.exs @@ -1,6 +1,7 @@ defmodule Plug.ConnTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn alias Plug.Conn alias Plug.ProcessStore diff --git a/test/plug/csrf_protection_test.exs b/test/plug/csrf_protection_test.exs index 1a37e4bbf..e751f0e68 100644 --- a/test/plug/csrf_protection_test.exs +++ b/test/plug/csrf_protection_test.exs @@ -1,6 +1,7 @@ defmodule Plug.CSRFProtectionTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn alias Plug.CSRFProtection alias Plug.CSRFProtection.InvalidCSRFTokenError diff --git a/test/plug/debugger_test.exs b/test/plug/debugger_test.exs index 09cafb4fe..81a9fafe0 100644 --- a/test/plug/debugger_test.exs +++ b/test/plug/debugger_test.exs @@ -1,6 +1,7 @@ defmodule Plug.DebuggerTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn import ExUnit.CaptureLog diff --git a/test/plug/error_handler_test.exs b/test/plug/error_handler_test.exs index d9d1dfe8b..c95bde678 100644 --- a/test/plug/error_handler_test.exs +++ b/test/plug/error_handler_test.exs @@ -1,6 +1,7 @@ defmodule Plug.ErrorHandlerTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn defmodule ForbiddenError do defexception plug_status: 403, message: "oops" diff --git a/test/plug/head_test.exs b/test/plug/head_test.exs index b8cd83007..efff7135d 100644 --- a/test/plug/head_test.exs +++ b/test/plug/head_test.exs @@ -1,6 +1,7 @@ defmodule Plug.HeadTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn @opts Plug.Head.init([]) diff --git a/test/plug/logger_test.exs b/test/plug/logger_test.exs index 72eaf042f..ad938be82 100644 --- a/test/plug/logger_test.exs +++ b/test/plug/logger_test.exs @@ -1,6 +1,7 @@ defmodule Plug.LoggerTest do use ExUnit.Case - use Plug.Test + import Plug.Test + import Plug.Conn import ExUnit.CaptureLog diff --git a/test/plug/method_override_test.exs b/test/plug/method_override_test.exs index 347c76411..481f990c4 100644 --- a/test/plug/method_override_test.exs +++ b/test/plug/method_override_test.exs @@ -1,6 +1,7 @@ defmodule Plug.MethodOverrideTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn def urlencoded_conn(method, body) do method diff --git a/test/plug/parsers/json_test.exs b/test/plug/parsers/json_test.exs index 6247e934e..0adcca94a 100644 --- a/test/plug/parsers/json_test.exs +++ b/test/plug/parsers/json_test.exs @@ -1,6 +1,7 @@ defmodule Plug.Parsers.JSONTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn defmodule JSON do def decode!("[1, 2, 3]") do diff --git a/test/plug/parsers_test.exs b/test/plug/parsers_test.exs index 69f006c85..4c17d4ace 100644 --- a/test/plug/parsers_test.exs +++ b/test/plug/parsers_test.exs @@ -1,7 +1,8 @@ defmodule Plug.ParsersTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn defmodule BodyReader do def read_body(conn, opts) do diff --git a/test/plug/request_id_test.exs b/test/plug/request_id_test.exs index d7cc97004..6c6bbaa73 100644 --- a/test/plug/request_id_test.exs +++ b/test/plug/request_id_test.exs @@ -1,6 +1,7 @@ defmodule Plug.RequestIdTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn defp call(conn, opts) do Plug.RequestId.call(conn, Plug.RequestId.init(opts)) diff --git a/test/plug/rewrite_on_test.exs b/test/plug/rewrite_on_test.exs index 81efd0b0c..7677308c8 100644 --- a/test/plug/rewrite_on_test.exs +++ b/test/plug/rewrite_on_test.exs @@ -1,6 +1,7 @@ defmodule Plug.RewriteOnTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn defp call(conn, rewrite) do Plug.RewriteOn.call(conn, Plug.RewriteOn.init(rewrite)) diff --git a/test/plug/router_test.exs b/test/plug/router_test.exs index b6fed1e3c..97d4c962d 100644 --- a/test/plug/router_test.exs +++ b/test/plug/router_test.exs @@ -226,7 +226,8 @@ defmodule Plug.RouterTest do end use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn test "dispatch root" do conn = call(Sample, conn(:get, "/")) diff --git a/test/plug/session/cookie_test.exs b/test/plug/session/cookie_test.exs index 32eb9d22b..64f0c0090 100644 --- a/test/plug/session/cookie_test.exs +++ b/test/plug/session/cookie_test.exs @@ -1,6 +1,7 @@ defmodule Plug.Session.CookieTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn alias Plug.Session.COOKIE, as: CookieStore diff --git a/test/plug/session_test.exs b/test/plug/session_test.exs index 6ed6d1814..b87e33f1b 100644 --- a/test/plug/session_test.exs +++ b/test/plug/session_test.exs @@ -1,6 +1,7 @@ defmodule Plug.SessionTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn alias Plug.ProcessStore doctest Plug.Session.Store diff --git a/test/plug/ssl_test.exs b/test/plug/ssl_test.exs index 1c5de61a0..f86e379e9 100644 --- a/test/plug/ssl_test.exs +++ b/test/plug/ssl_test.exs @@ -1,6 +1,7 @@ defmodule Plug.SSLTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn describe "configure" do import Plug.SSL, only: [configure: 1] diff --git a/test/plug/static_test.exs b/test/plug/static_test.exs index 1c658ad98..d4595a27e 100644 --- a/test/plug/static_test.exs +++ b/test/plug/static_test.exs @@ -1,6 +1,7 @@ defmodule Plug.StaticTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn @default_opts [ at: "/public", diff --git a/test/plug/telemetry_test.exs b/test/plug/telemetry_test.exs index 79810a68a..69a514d6f 100644 --- a/test/plug/telemetry_test.exs +++ b/test/plug/telemetry_test.exs @@ -2,7 +2,7 @@ Application.ensure_all_started(:telemetry) defmodule Plug.TelemetryTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test defmodule MyPlug do use Plug.Builder diff --git a/test/plug_test.exs b/test/plug_test.exs index 58657888c..5820049f0 100644 --- a/test/plug_test.exs +++ b/test/plug_test.exs @@ -1,6 +1,7 @@ defmodule PlugTest do use ExUnit.Case, async: true - use Plug.Test + import Plug.Test + import Plug.Conn import ExUnit.CaptureLog