mirror of
https://github.com/ash-project/ash.git
synced 2024-09-21 05:53:06 +12:00
37755a870b
* Allow field policies to hide private fields * Create option for how to handle private fields * Improve docs
379 lines
13 KiB
Elixir
379 lines
13 KiB
Elixir
defmodule Ash.Test.Policy.FieldPolicyTest do
|
|
@doc false
|
|
use ExUnit.Case
|
|
|
|
require Ash.Query
|
|
|
|
alias Ash.Test.Support.PolicyField.{Post, Ticket, User}
|
|
|
|
setup do
|
|
rep =
|
|
Ash.create!(Ash.Changeset.for_create(User, :create, %{role: :representative, points: 4}),
|
|
authorize?: false
|
|
)
|
|
|
|
user =
|
|
Ash.create!(Ash.Changeset.for_create(User, :create, %{role: :user, points: 3}),
|
|
authorize?: false
|
|
)
|
|
|
|
admin =
|
|
Ash.create!(Ash.Changeset.for_create(User, :create, %{role: :admin, points: 2}),
|
|
authorize?: false
|
|
)
|
|
|
|
other_user =
|
|
Ash.create!(Ash.Changeset.for_create(User, :create, %{role: :user, points: 1}),
|
|
authorize?: false
|
|
)
|
|
|
|
[
|
|
user: user,
|
|
admin: admin,
|
|
representative: rep,
|
|
ticket:
|
|
Ash.create!(
|
|
Ash.Changeset.for_create(Ticket, :create, %{
|
|
representative_id: rep.id,
|
|
reporter_id: user.id
|
|
})
|
|
),
|
|
other_ticket:
|
|
Ash.create!(
|
|
Ash.Changeset.for_create(Ticket, :create, %{
|
|
representative_id: rep.id,
|
|
reporter_id: other_user.id
|
|
})
|
|
),
|
|
post:
|
|
Ash.create!(
|
|
Ash.Changeset.for_create(Post, :create, %{
|
|
representative_id: rep.id,
|
|
reporter_id: user.id
|
|
})
|
|
)
|
|
]
|
|
end
|
|
|
|
describe "introspection" do
|
|
test "introspection returns field policies" do
|
|
assert [
|
|
%Ash.Policy.FieldPolicy{bypass?: true},
|
|
%Ash.Policy.FieldPolicy{bypass?: false},
|
|
%Ash.Policy.FieldPolicy{bypass?: false},
|
|
%Ash.Policy.FieldPolicy{bypass?: false},
|
|
%Ash.Policy.FieldPolicy{bypass?: false}
|
|
] =
|
|
Ash.Policy.Info.field_policies(User)
|
|
end
|
|
end
|
|
|
|
describe "rendering fields" do
|
|
test "when creating as a user that cannot see the field, its value is not displayed", %{
|
|
representative: rep,
|
|
user: user
|
|
} do
|
|
assert %Ash.ForbiddenField{field: :internal_status, type: :attribute} ==
|
|
Ticket
|
|
|> Ash.Changeset.for_create(
|
|
:create,
|
|
%{representative_id: rep.id, reporter_id: user.id, internal_status: :new},
|
|
authorize?: true,
|
|
actor: user
|
|
)
|
|
|> Ash.create!(authorize?: true, actor: user)
|
|
|> Map.get(:internal_status)
|
|
end
|
|
|
|
test "when destroying as a user that cannot see the field, its value is not displayed", %{
|
|
representative: rep,
|
|
user: user
|
|
} do
|
|
assert %Ash.ForbiddenField{field: :internal_status, type: :attribute} ==
|
|
Ticket
|
|
|> Ash.Changeset.for_create(
|
|
:create,
|
|
%{representative_id: rep.id, reporter_id: user.id, internal_status: :new},
|
|
authorize?: true,
|
|
actor: user
|
|
)
|
|
|> Ash.create!(authorize?: false)
|
|
|> Ash.destroy!(authorize?: true, actor: user, return_destroyed?: true)
|
|
|> Map.get(:internal_status)
|
|
end
|
|
|
|
test "when reading as a user that can see the field, its value is displayed", %{
|
|
representative: representative
|
|
} do
|
|
assert :representative ==
|
|
User
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: representative)
|
|
|> Ash.Query.filter(id == ^representative.id)
|
|
|> Ash.read_one!(authorize?: true, actor: representative)
|
|
|> Map.get(:role)
|
|
end
|
|
|
|
test "bypasses take priority over subsequent policies", %{
|
|
representative: representative,
|
|
admin: admin
|
|
} do
|
|
assert :representative ==
|
|
User
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: admin)
|
|
|> Ash.Query.filter(id == ^representative.id)
|
|
|> Ash.read_one!(authorize?: true, actor: admin)
|
|
|> Map.get(:role)
|
|
end
|
|
|
|
test "can load a resource with a forbidden aggregate", %{
|
|
representative: representative
|
|
} do
|
|
assert %Ash.ForbiddenField{field: :ticket_count, type: :aggregate} ==
|
|
User
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: representative)
|
|
|> Ash.Query.filter(id == ^representative.id)
|
|
|> Ash.Query.load([:ticket_count])
|
|
|> Ash.read_one!(authorize?: true, actor: representative)
|
|
|> Map.get(:ticket_count)
|
|
end
|
|
|
|
test "when reading as a user that cant see the field, its value is not displayed", %{
|
|
representative: representative,
|
|
user: user
|
|
} do
|
|
assert %Ash.ForbiddenField{field: :role, type: :attribute} ==
|
|
User
|
|
|> Ash.Query.for_read(:read, %{})
|
|
|> Ash.Query.filter(id == ^representative.id)
|
|
|> Ash.read_one!(authorize?: true, actor: user)
|
|
|> Map.get(:role)
|
|
end
|
|
|
|
test "when loading as a user that cant see the field, its value is not displayed", %{
|
|
representative: representative,
|
|
user: user
|
|
} do
|
|
assert %Ash.ForbiddenField{field: :role, type: :attribute} ==
|
|
User
|
|
|> Ash.Query.select([])
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: representative)
|
|
|> Ash.Query.filter(id == ^representative.id)
|
|
|> Ash.read_one!(authorize?: true, actor: user)
|
|
|> Ash.load!(:role, authorize?: true)
|
|
|> Map.get(:role)
|
|
end
|
|
|
|
test "when reading as a user that cant see the field with a `relates_to_actor_via` check, the value is not displayed",
|
|
%{
|
|
user: user,
|
|
ticket: ticket,
|
|
other_ticket: other_ticket
|
|
} do
|
|
assert nil ==
|
|
Ticket
|
|
|> Ash.Query.select(:status)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.Query.filter(id == ^ticket.id)
|
|
|> Ash.read_one!()
|
|
|> Map.get(:status)
|
|
|
|
assert %Ash.ForbiddenField{} =
|
|
Ticket
|
|
|> Ash.Query.select(:status)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.Query.filter(id == ^other_ticket.id)
|
|
|> Ash.read_one!()
|
|
|> Map.get(:status)
|
|
end
|
|
|
|
test "reading is allowed through a relationship",
|
|
%{representative: representative} do
|
|
# someone who is allowed because it's accessed through the ticket
|
|
assert [ticket] =
|
|
Ticket
|
|
|> Ash.Query.select([])
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: representative)
|
|
|> Ash.Query.filter(reporter.ticket_count > 0)
|
|
|> Ash.Query.load(reporter: [:ticket_count])
|
|
|> Ash.Query.limit(1)
|
|
|> Ash.read!(authorize?: true)
|
|
|
|
assert is_number(ticket.reporter.ticket_count)
|
|
assert ticket.reporter.ticket_count > 0
|
|
|
|
# can't read the value when reading the resource directly
|
|
assert [user] =
|
|
User
|
|
|> Ash.Query.select([])
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: representative)
|
|
|> Ash.Query.load([:ticket_count])
|
|
|> Ash.Query.limit(1)
|
|
|> Ash.read!(authorize?: true)
|
|
|
|
assert user.ticket_count == %Ash.ForbiddenField{
|
|
field: :ticket_count,
|
|
type: :aggregate
|
|
}
|
|
end
|
|
|
|
test "reading is allowed through a multi level relationship",
|
|
%{user: user} do
|
|
assert [ticket] =
|
|
Ticket
|
|
|> Ash.Query.select([:internal_status])
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.Query.filter(reporter_id == ^user.id)
|
|
|> Ash.Query.load(reporter: [:tickets])
|
|
|> Ash.read!(authorize?: true)
|
|
|
|
assert ticket.internal_status == %Ash.ForbiddenField{
|
|
field: :internal_status,
|
|
type: :attribute
|
|
}
|
|
|
|
nested_ticket = ticket.reporter.tickets |> List.first()
|
|
|
|
assert nested_ticket.internal_status == nil
|
|
end
|
|
end
|
|
|
|
describe "private_fields" do
|
|
test "when reading a private value and private_fields_policy is :hide, its value is not displayed",
|
|
%{
|
|
user: user,
|
|
ticket: ticket
|
|
} do
|
|
assert %Ash.ForbiddenField{field: :top_secret, type: :attribute} ==
|
|
Ticket
|
|
|> Ash.Query.select(:top_secret)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.Query.filter(id == ^ticket.id)
|
|
|> Ash.read_one!()
|
|
|> Map.get(:top_secret)
|
|
end
|
|
|
|
test "when reading a private value and private_fields_policy is :show, its value is displayed",
|
|
%{
|
|
user: user
|
|
} do
|
|
assert nil ==
|
|
User
|
|
|> Ash.Query.select(:top_secret)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.Query.filter(id == ^user.id)
|
|
|> Ash.read_one!()
|
|
|> Map.get(:top_secret)
|
|
end
|
|
|
|
test "when reading a private value, covered by field policy the user is not supposed to see,
|
|
it's value is not displayed",
|
|
%{
|
|
post: post
|
|
} do
|
|
assert %Ash.ForbiddenField{field: :internal_status, type: :attribute} ==
|
|
Post
|
|
|> Ash.Query.select(:internal_status)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true)
|
|
|> Ash.Query.filter(id == ^post.id)
|
|
|> Ash.read_one!()
|
|
|> Map.get(:internal_status)
|
|
end
|
|
|
|
test "when reading a private value, covered by field policy the user is can see, its value is displayed",
|
|
%{
|
|
user: user,
|
|
post: post
|
|
} do
|
|
assert nil ==
|
|
Post
|
|
|> Ash.Query.select(:internal_status)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.Query.filter(id == ^post.id)
|
|
|> Ash.read_one!()
|
|
|> Map.get(:internal_status)
|
|
end
|
|
end
|
|
|
|
describe "filters" do
|
|
test "filters are replaced with the appropriate field policies", %{
|
|
representative: representative,
|
|
user: user
|
|
} do
|
|
assert [] =
|
|
User
|
|
|> Ash.Query.select([])
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.Query.filter_input(role: :representative)
|
|
|> Ash.read!(authorize?: true)
|
|
|
|
assert [_] =
|
|
User
|
|
|> Ash.Query.select([])
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: representative)
|
|
|> Ash.Query.filter_input(role: :representative)
|
|
|> Ash.read!(authorize?: true)
|
|
end
|
|
|
|
test "it's possible to filter on values that are only allowed to be accessed from a parent",
|
|
%{
|
|
representative: representative,
|
|
user: user
|
|
} do
|
|
# someone who is allowed because it's accessed through the ticket
|
|
|
|
assert [ticket] =
|
|
Ticket
|
|
|> Ash.Query.select([])
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: representative)
|
|
|> Ash.Query.filter(reporter.ticket_count > 0)
|
|
|> Ash.Query.load(reporter: [:ticket_count])
|
|
|> Ash.Query.limit(1)
|
|
|> Ash.read!()
|
|
|
|
assert is_number(ticket.reporter.ticket_count)
|
|
assert ticket.reporter.ticket_count > 0
|
|
|
|
# someone who isn't allowed to see the field
|
|
assert [ticket] =
|
|
Ticket
|
|
|> Ash.Query.select([])
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.Query.filter(reporter.ticket_count > 0)
|
|
|> Ash.Query.load(reporter: [:ticket_count])
|
|
|> Ash.Query.limit(1)
|
|
|> Ash.read!(authorize?: true)
|
|
|
|
assert ticket.reporter.ticket_count == %Ash.ForbiddenField{
|
|
field: :ticket_count,
|
|
type: :aggregate
|
|
}
|
|
end
|
|
end
|
|
|
|
describe "sorts" do
|
|
test "sorts are replaced with the appropriate field policies", %{
|
|
user: %{id: user_id} = user
|
|
} do
|
|
assert [%{id: ^user_id} | _] =
|
|
User
|
|
|> Ash.Query.select([:points])
|
|
|> Ash.Query.sort_input(points: :asc_nils_last)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.read!()
|
|
|
|
assert [_, _, _, %{id: ^user_id}] =
|
|
User
|
|
|> Ash.Query.select([:points])
|
|
|> Ash.Query.sort_input(points: :asc_nils_first)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.read!()
|
|
|
|
assert [_, _, %{id: ^user_id}, _] =
|
|
User
|
|
|> Ash.Query.select([:points])
|
|
|> Ash.Query.sort(points: :asc_nils_first)
|
|
|> Ash.Query.for_read(:read, %{}, authorize?: true, actor: user)
|
|
|> Ash.read!()
|
|
end
|
|
end
|
|
end
|