Packages
phoenix
1.7.13
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.8.0-rc.4
1.8.0-rc.3
1.8.0-rc.2
1.8.0-rc.1
1.8.0-rc.0
1.7.24
1.7.23
1.7.22
1.7.21
1.7.20
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.7.0-rc.3
1.7.0-rc.2
1.7.0-rc.1
1.7.0-rc.0
1.6.17
1.6.16
1.6.15
1.6.14
1.6.13
1.6.12
1.6.11
1.6.10
1.6.9
1.6.8
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.0
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-rc.3
1.4.0-rc.2
1.4.0-rc.1
1.4.0-rc.0
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-rc.3
1.3.0-rc.2
1.3.0-rc.1
1.3.0-rc.0
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc.1
1.2.0-rc.0
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.17.1
0.17.0
0.16.1
0.16.0
0.15.0
0.14.0
0.13.1
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.2
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.11
0.2.10
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
Productive. Reliable. Fast. A productive web framework that does not compromise speed or maintainability.
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
priv/templates/phx.gen.auth/auth_test.exs
defmodule <%= inspect auth_module %>Test do
use <%= inspect context.web_module %>.ConnCase<%= test_case_options %>
alias Phoenix.LiveView
alias <%= inspect context.module %>
alias <%= inspect context.web_module %>.<%= inspect Module.concat(schema.web_namespace, schema.alias) %>Auth
import <%= inspect context.module %>Fixtures
@remember_me_cookie "_<%= web_app_name %>_<%= schema.singular %>_remember_me"
setup %{conn: conn} do
conn =
conn
|> Map.replace!(:secret_key_base, <%= inspect endpoint_module %>.config(:secret_key_base))
|> init_test_session(%{})
%{<%= schema.singular %>: <%= schema.singular %>_fixture(), conn: conn}
end
describe "log_in_<%= schema.singular %>/3" do
test "stores the <%= schema.singular %> token in the session", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
conn = <%= inspect schema.alias %>Auth.log_in_<%= schema.singular %>(conn, <%= schema.singular %>)
assert token = get_session(conn, :<%= schema.singular %>_token)
assert get_session(conn, :live_socket_id) == "<%= schema.plural %>_sessions:#{Base.url_encode64(token)}"
assert redirected_to(conn) == ~p"/"
assert <%= inspect context.alias %>.get_<%= schema.singular %>_by_session_token(token)
end
test "clears everything previously stored in the session", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
conn = conn |> put_session(:to_be_removed, "value") |> <%= inspect schema.alias %>Auth.log_in_<%= schema.singular %>(<%= schema.singular %>)
refute get_session(conn, :to_be_removed)
end
test "redirects to the configured path", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
conn = conn |> put_session(:<%= schema.singular %>_return_to, "/hello") |> <%= inspect schema.alias %>Auth.log_in_<%= schema.singular %>(<%= schema.singular %>)
assert redirected_to(conn) == "/hello"
end
test "writes a cookie if remember_me is configured", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
conn = conn |> fetch_cookies() |> <%= inspect schema.alias %>Auth.log_in_<%= schema.singular %>(<%= schema.singular %>, %{"remember_me" => "true"})
assert get_session(conn, :<%= schema.singular %>_token) == conn.cookies[@remember_me_cookie]
assert %{value: signed_token, max_age: max_age} = conn.resp_cookies[@remember_me_cookie]
assert signed_token != get_session(conn, :<%= schema.singular %>_token)
assert max_age == 5_184_000
end
end
describe "logout_<%= schema.singular %>/1" do
test "erases session and cookies", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
<%= schema.singular %>_token = <%= inspect context.alias %>.generate_<%= schema.singular %>_session_token(<%= schema.singular %>)
conn =
conn
|> put_session(:<%= schema.singular %>_token, <%= schema.singular %>_token)
|> put_req_cookie(@remember_me_cookie, <%= schema.singular %>_token)
|> fetch_cookies()
|> <%= inspect schema.alias %>Auth.log_out_<%= schema.singular %>()
refute get_session(conn, :<%= schema.singular %>_token)
refute conn.cookies[@remember_me_cookie]
assert %{max_age: 0} = conn.resp_cookies[@remember_me_cookie]
assert redirected_to(conn) == ~p"/"
refute <%= inspect context.alias %>.get_<%= schema.singular %>_by_session_token(<%= schema.singular %>_token)
end
test "broadcasts to the given live_socket_id", %{conn: conn} do
live_socket_id = "<%= schema.plural %>_sessions:abcdef-token"
<%= inspect(endpoint_module) %>.subscribe(live_socket_id)
conn
|> put_session(:live_socket_id, live_socket_id)
|> <%= inspect(schema.alias) %>Auth.log_out_<%= schema.singular %>()
assert_receive %Phoenix.Socket.Broadcast{event: "disconnect", topic: ^live_socket_id}
end
test "works even if <%= schema.singular %> is already logged out", %{conn: conn} do
conn = conn |> fetch_cookies() |> <%= inspect schema.alias %>Auth.log_out_<%= schema.singular %>()
refute get_session(conn, :<%= schema.singular %>_token)
assert %{max_age: 0} = conn.resp_cookies[@remember_me_cookie]
assert redirected_to(conn) == ~p"/"
end
end
describe "fetch_current_<%= schema.singular %>/2" do
test "authenticates <%= schema.singular %> from session", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
<%= schema.singular %>_token = <%= inspect context.alias %>.generate_<%= schema.singular %>_session_token(<%= schema.singular %>)
conn = conn |> put_session(:<%= schema.singular %>_token, <%= schema.singular %>_token) |> <%= inspect schema.alias %>Auth.fetch_current_<%= schema.singular %>([])
assert conn.assigns.current_<%= schema.singular %>.id == <%= schema.singular %>.id
end
test "authenticates <%= schema.singular %> from cookies", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
logged_in_conn =
conn |> fetch_cookies() |> <%= inspect schema.alias %>Auth.log_in_<%= schema.singular %>(<%= schema.singular %>, %{"remember_me" => "true"})
<%= schema.singular %>_token = logged_in_conn.cookies[@remember_me_cookie]
%{value: signed_token} = logged_in_conn.resp_cookies[@remember_me_cookie]
conn =
conn
|> put_req_cookie(@remember_me_cookie, signed_token)
|> <%= inspect schema.alias %>Auth.fetch_current_<%= schema.singular %>([])
assert conn.assigns.current_<%= schema.singular %>.id == <%= schema.singular %>.id
assert get_session(conn, :<%= schema.singular %>_token) == <%= schema.singular %>_token
assert get_session(conn, :live_socket_id) ==
"<%= schema.plural %>_sessions:#{Base.url_encode64(<%= schema.singular %>_token)}"
end
test "does not authenticate if data is missing", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
_ = <%= inspect context.alias %>.generate_<%= schema.singular %>_session_token(<%= schema.singular %>)
conn = <%= inspect schema.alias %>Auth.fetch_current_<%= schema.singular %>(conn, [])
refute get_session(conn, :<%= schema.singular %>_token)
refute conn.assigns.current_<%= schema.singular %>
end
end
describe "on_mount :mount_current_<%= schema.singular %>" do
test "assigns current_<%= schema.singular %> based on a valid <%= schema.singular %>_token", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
<%= schema.singular %>_token = <%= inspect context.alias %>.generate_<%= schema.singular %>_session_token(<%= schema.singular %>)
session = conn |> put_session(:<%= schema.singular %>_token, <%= schema.singular %>_token) |> get_session()
{:cont, updated_socket} =
<%= inspect schema.alias %>Auth.on_mount(:mount_current_<%= schema.singular %>, %{}, session, %LiveView.Socket{})
assert updated_socket.assigns.current_<%= schema.singular %>.id == <%= schema.singular %>.id
end
test "assigns nil to current_<%= schema.singular %> assign if there isn't a valid <%= schema.singular %>_token", %{conn: conn} do
<%= schema.singular %>_token = "invalid_token"
session = conn |> put_session(:<%= schema.singular %>_token, <%= schema.singular %>_token) |> get_session()
{:cont, updated_socket} =
<%= inspect schema.alias %>Auth.on_mount(:mount_current_<%= schema.singular %>, %{}, session, %LiveView.Socket{})
assert updated_socket.assigns.current_<%= schema.singular %> == nil
end
test "assigns nil to current_<%= schema.singular %> assign if there isn't a <%= schema.singular %>_token", %{conn: conn} do
session = conn |> get_session()
{:cont, updated_socket} =
<%= inspect schema.alias %>Auth.on_mount(:mount_current_<%= schema.singular %>, %{}, session, %LiveView.Socket{})
assert updated_socket.assigns.current_<%= schema.singular %> == nil
end
end
describe "on_mount :ensure_authenticated" do
test "authenticates current_<%= schema.singular %> based on a valid <%= schema.singular %>_token", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
<%= schema.singular %>_token = <%= inspect context.alias %>.generate_<%= schema.singular %>_session_token(<%= schema.singular %>)
session = conn |> put_session(:<%= schema.singular %>_token, <%= schema.singular %>_token) |> get_session()
{:cont, updated_socket} =
<%= inspect schema.alias %>Auth.on_mount(:ensure_authenticated, %{}, session, %LiveView.Socket{})
assert updated_socket.assigns.current_<%= schema.singular %>.id == <%= schema.singular %>.id
end
test "redirects to login page if there isn't a valid <%= schema.singular %>_token", %{conn: conn} do
<%= schema.singular %>_token = "invalid_token"
session = conn |> put_session(:<%= schema.singular %>_token, <%= schema.singular %>_token) |> get_session()
socket = %LiveView.Socket{
endpoint: <%= inspect context.web_module %>.Endpoint,
assigns: %{__changed__: %{}, flash: %{}}
}
{:halt, updated_socket} = <%= inspect schema.alias %>Auth.on_mount(:ensure_authenticated, %{}, session, socket)
assert updated_socket.assigns.current_<%= schema.singular %> == nil
end
test "redirects to login page if there isn't a <%= schema.singular %>_token", %{conn: conn} do
session = conn |> get_session()
socket = %LiveView.Socket{
endpoint: <%= inspect context.web_module %>.Endpoint,
assigns: %{__changed__: %{}, flash: %{}}
}
{:halt, updated_socket} = <%= inspect schema.alias %>Auth.on_mount(:ensure_authenticated, %{}, session, socket)
assert updated_socket.assigns.current_<%= schema.singular %> == nil
end
end
describe "on_mount :redirect_if_<%= schema.singular %>_is_authenticated" do
test "redirects if there is an authenticated <%= schema.singular %> ", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
<%= schema.singular %>_token = <%= inspect context.alias %>.generate_<%= schema.singular %>_session_token(<%= schema.singular %>)
session = conn |> put_session(:<%= schema.singular %>_token, <%= schema.singular %>_token) |> get_session()
assert {:halt, _updated_socket} =
<%= inspect schema.alias %>Auth.on_mount(
:redirect_if_<%= schema.singular %>_is_authenticated,
%{},
session,
%LiveView.Socket{}
)
end
test "doesn't redirect if there is no authenticated <%= schema.singular %>", %{conn: conn} do
session = conn |> get_session()
assert {:cont, _updated_socket} =
<%= inspect schema.alias %>Auth.on_mount(
:redirect_if_<%= schema.singular %>_is_authenticated,
%{},
session,
%LiveView.Socket{}
)
end
end
describe "redirect_if_<%= schema.singular %>_is_authenticated/2" do
test "redirects if <%= schema.singular %> is authenticated", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
conn = conn |> assign(:current_<%= schema.singular %>, <%= schema.singular %>) |> <%= inspect schema.alias %>Auth.redirect_if_<%= schema.singular %>_is_authenticated([])
assert conn.halted
assert redirected_to(conn) == ~p"/"
end
test "does not redirect if <%= schema.singular %> is not authenticated", %{conn: conn} do
conn = <%= inspect schema.alias %>Auth.redirect_if_<%= schema.singular %>_is_authenticated(conn, [])
refute conn.halted
refute conn.status
end
end
describe "require_authenticated_<%= schema.singular %>/2" do
test "redirects if <%= schema.singular %> is not authenticated", %{conn: conn} do
conn = conn |> fetch_flash() |> <%= inspect schema.alias %>Auth.require_authenticated_<%= schema.singular %>([])
assert conn.halted
assert redirected_to(conn) == ~p"<%= schema.route_prefix %>/log_in"
assert Phoenix.Flash.get(conn.assigns.flash, :error) ==
"You must log in to access this page."
end
test "stores the path to redirect to on GET", %{conn: conn} do
halted_conn =
%{conn | path_info: ["foo"], query_string: ""}
|> fetch_flash()
|> <%= inspect schema.alias %>Auth.require_authenticated_<%= schema.singular %>([])
assert halted_conn.halted
assert get_session(halted_conn, :<%= schema.singular %>_return_to) == "/foo"
halted_conn =
%{conn | path_info: ["foo"], query_string: "bar=baz"}
|> fetch_flash()
|> <%= inspect schema.alias %>Auth.require_authenticated_<%= schema.singular %>([])
assert halted_conn.halted
assert get_session(halted_conn, :<%= schema.singular %>_return_to) == "/foo?bar=baz"
halted_conn =
%{conn | path_info: ["foo"], query_string: "bar", method: "POST"}
|> fetch_flash()
|> <%= inspect schema.alias %>Auth.require_authenticated_<%= schema.singular %>([])
assert halted_conn.halted
refute get_session(halted_conn, :<%= schema.singular %>_return_to)
end
test "does not redirect if <%= schema.singular %> is authenticated", %{conn: conn, <%= schema.singular %>: <%= schema.singular %>} do
conn = conn |> assign(:current_<%= schema.singular %>, <%= schema.singular %>) |> <%= inspect schema.alias %>Auth.require_authenticated_<%= schema.singular %>([])
refute conn.halted
refute conn.status
end
end
end