defmodule Ash.Test.Actions.ReadTest do use ExUnit.Case, async: true defmodule Author do use Ash.Resource, name: "posts", type: "post" use Ash.DataLayer.Ets, private?: true actions do read :default create :default end attributes do attribute :name, :string end relationships do has_many :posts, Ash.Test.Actions.ReadTest.Post end end defmodule Post do use Ash.Resource, name: "posts", type: "post" use Ash.DataLayer.Ets, private?: true actions do read :default create :default end attributes do attribute :title, :string attribute :contents, :string end relationships do belongs_to :author1, Ash.Test.Actions.ReadTest.Author belongs_to :author2, Ash.Test.Actions.ReadTest.Author end end defmodule Api do use Ash.Api resources [Post, Author] end describe "api.get/3" do setup do {:ok, post} = Api.create(Post, attributes: %{title: "test", contents: "yeet"}) %{post: post} end test "it returns a matching record", %{post: post} do assert {:ok, fetched_post} = Api.get(Post, post.id) assert fetched_post == post end test "it returns nil when there is no matching record" do assert {:ok, nil} = Api.get(Post, Ecto.UUID.generate()) end end describe "api.get!/3" do setup do {:ok, post} = Api.create(Post, attributes: %{title: "test", contents: "yeet"}) %{post: post} end test "it returns a matching record", %{post: post} do assert ^post = Api.get!(Post, post.id) end test "it raises on an error", %{post: post} do assert_raise(Ash.Error.FrameworkError, "no such resource Elixir.Something", fn -> Api.get!(Something, post.id) end) end end describe "api.read/2 with no records" do test "returns an empty result" do assert {:ok, %{results: []}} = Api.read(Post) end end describe "Ash.read!/2 with no records" do test "returns an empty result" do assert %{results: []} = Api.read!(Post) end end describe "api.read/2" do setup do {:ok, post1} = Api.create(Post, attributes: %{title: "test", contents: "yeet"}) {:ok, post2} = Api.create(Post, attributes: %{title: "test1", contents: "yeet2"}) %{post1: post1, post2: post2} end test "with page size of 1, returns only 1 record" do assert {:ok, %{results: [_post]}} = Api.read(Post, page: %{limit: 1}) end test "with page size of 2, returns 2 records" do assert {:ok, %{results: [_, _]}} = Api.read(Post, page: %{limit: 2}) end test "with page size of 1 and an offset of 1, it returns 1 record" do assert {:ok, %{results: [_]}} = Api.read(Post, page: %{limit: 1, offset: 1}) end end describe "api.read!/2" do setup do {:ok, post1} = Api.create(Post, attributes: %{title: "test", contents: "yeet"}) {:ok, post2} = Api.create(Post, attributes: %{title: "test1", contents: "yeet2"}) %{post1: post1, post2: post2} end test "it returns the records not in a tuple" do assert %{results: [_, _]} = Api.read!(Post) end test "it raises on an error" do assert_raise(Ash.Error.FrameworkError, "Invalid value 10 for type `== :string`", fn -> Api.read!(Post, filter: [title: 10]) end) end end describe "filters" do setup do {:ok, post1} = Api.create(Post, attributes: %{title: "test", contents: "yeet"}) {:ok, post2} = Api.create(Post, attributes: %{title: "test1", contents: "yeet"}) %{post1: post1, post2: post2} end test "a filter that matches nothing returns no results" do assert {:ok, %{results: []}} = Api.read(Post, filter: [contents: "not_yeet"]) end test "a filter returns only matching records", %{post1: post1} do assert {:ok, %{results: [^post1]}} = Api.read(Post, filter: [title: post1.title]) end test "a filter returns multiple records if they match", %{post1: post1, post2: post2} do assert {:ok, %{results: [_, _] = results}} = Api.read(Post, filter: [contents: "yeet"]) assert post1 in results assert post2 in results end end describe "relationship filters" do setup do author1 = Api.create!(Author, attributes: %{name: "bruh"}) author2 = Api.create!(Author, attributes: %{name: "bruh"}) {:ok, post} = Api.create(Post, attributes: %{title: "test", contents: "yeet"}, relationships: %{author1: author1.id, author2: author2.id} ) %{post: post, author1: author1, author2: author2} end test "you can filter on a related value", %{author1: author1} do assert %{results: [_] = results} = Api.read!(Post, filter: [author1: author1.id]) end test "you can filter on multiple related values", %{author1: author1, author2: author2} do assert %{results: [_] = results} = Api.read!(Post, filter: [author1: author1.id, author2: author2.id]) end end describe "sort" do setup do {:ok, post1} = Api.create(Post, attributes: %{title: "abc", contents: "abc"}) {:ok, post2} = Api.create(Post, attributes: %{title: "xyz", contents: "abc"}) %{post1: post1, post2: post2} end test "a sort will sort the rows accordingly when ascending", %{ post1: post1, post2: post2 } do assert {:ok, %{results: [^post1, ^post2]}} = Api.read(Post, sort: [asc: :title]) end test "a sort will sor rows accordingly when descending", %{ post1: post1, post2: post2 } do assert {:ok, %{results: [^post2, ^post1]}} = Api.read(Post, sort: [desc: :title]) end test "a nested sort sorts accordingly", %{post1: post1, post2: post2} do {:ok, middle_post} = Api.create(Post, attributes: %{title: "abc", contents: "xyz"}) assert {:ok, %{results: [^post1, ^middle_post, ^post2]}} = Api.read(Post, sort: [asc: :title, asc: :contents]) end end end