ash/test/api/diagram_test.exs

defmodule Ash.Test.Api.Info.DiagramTest do
  @moduledoc false
  use ExUnit.Case, async: true

  test "generate a mermaid entity relationship diagram from an Api" do
    assert Ash.Api.Info.Diagram.mermaid_er_diagram(Ash.Test.Flow.Api) == """
           erDiagram
               User {
                   UUID id
                   String first_name
                   String last_name
                   String email
               }
               Org {
                   UUID id
                   String name
               }

               Org ||--|| User : ""
           """
  end

  test "generate a mermaid class diagram from an Api" do
    assert Ash.Api.Info.Diagram.mermaid_class_diagram(Ash.Test.Flow.Api) == """
           classDiagram
               class User {
                   UUID id
                   String first_name
                   String last_name
                   String email
                   Org org
                   destroy()
                   read()
                   for_org(UUID org)
                   by_name(String name)
                   create(UUID org, UUID id, String first_name, String last_name, ...)
                   update(UUID id, String first_name, String last_name, String email)
                   approve()
                   unapprove()
               }
               class Org {
                   UUID id
                   String name
                   User[] users
                   destroy()
                   update(UUID id, String name)
                   read()
                   create(UUID id, String name)
                   by_name(String name)
               }

               Org -- User
           """
  end

  test "include private fields in a mermaid entity relationship diagram from an Api if specified" do
    assert Ash.Api.Info.Diagram.mermaid_er_diagram(Ash.Test.Flow.Api, show_private?: true) ==
             """
             erDiagram
                 User {
                     UUID id
                     String first_name
                     String last_name
                     String email
                     Boolean approved
                     UUID org_id
                 }
                 Org {
                     UUID id
                     String name
                 }

                 Org ||--|| User : ""
             """
  end

  test "include private fields in a mermaid class diagram from an Api if specified" do
    assert Ash.Api.Info.Diagram.mermaid_class_diagram(Ash.Test.Flow.Api,
             show_private?: true
           ) == """
           classDiagram
               class User {
                   UUID id
                   String first_name
                   String last_name
                   String email
                   Boolean approved
                   UUID org_id
                   Org org
                   destroy()
                   read()
                   for_org(UUID org)
                   by_name(String name)
                   create(UUID org, UUID id, String first_name, String last_name, ...)
                   update(UUID id, String first_name, String last_name, String email)
                   approve()
                   unapprove()
               }
               class Org {
                   UUID id
                   String name
                   User[] users
                   destroy()
                   update(UUID id, String name)
                   read()
                   create(UUID id, String name)
                   by_name(String name)
               }

               Org -- User
           """
  end
end