@spec on_exit(term(), (-> term())) :: :ok

註冊一個在測試結束後執行的回呼。

callback 是不接收任何引數且在與呼叫者不同的程序中執行的函式。其傳回值不相關，且會被捨棄。

on_exit/2 通常會從 setup/1 和 setup_all/1 回呼中呼叫，通常用於取消在設定期間執行的動作。

不過，on_exit/2 也可能動態呼叫。「ID」（name_or_ref 引數）可用於保證回呼只會被呼叫一次。ExUnit 使用此術語來識別 on_exit/2 處理常式：例如，如果您想要覆寫先前的處理常式，請在多個 on_exit/2 呼叫中使用相同的 name_or_ref。

如果在 on_exit/2 或測試內部呼叫 setup/1，它會在測試結束後以封鎖方式執行，並在執行下一個測試之前。這表示在 on_exit/2 回呼執行前一個測試時，不會執行相同測試案例中的任何其他測試。 on_exit/2 會在與測試程序不同的程序中執行。另一方面，如果在 setup_all/1 回呼內部呼叫 on_exit/2，則 callback 會在執行所有測試後執行（有關更多資訊，請參閱 setup_all/1）。

範例

setup do
  File.write!("fixture.json", "{}")
  on_exit(fn -> File.rm!("fixture.json") end)
end

您可以在多個 on_exit/2 呼叫中使用相同的 name_or_ref 來「覆寫」已註冊的處理常式

setup do
  on_exit(:drop_table, fn ->
    Database.drop_table()
  end)
end

test "a test that shouldn't drop the table" do
  on_exit(:drop_table, fn -> :ok end)
end

過度依賴覆寫此類回呼可能會導致難以理解的測試案例，並產生過多層間接。不過，在某些情況下或例如對於函式庫作者來說，這可能會很有用。

定義一個在案例中每個測試之前執行的回呼。

接受下列其中一項

• 區塊
• 命名為區域函式的原子
• {module, function} 組合
• 原子和 {module, function} 組合的清單

可以傳回要合併至內容的值，以設定測試的狀態。有關更多詳細資訊，請參閱上方顯示的「內容」區段。

setup/1 回呼會在與測試程序相同的程序中執行。

範例

defp clean_up_tmp_directory(context) do
  # perform setup
  :ok
end

setup :clean_up_tmp_directory

setup [:clean_up_tmp_directory, :another_setup]

setup do
  [conn: Plug.Conn.build_conn()]
end

setup {MyModule, :my_setup_function}

定義一個在案例中每個測試之前執行的回呼。

這類似於 setup/1，但第一個參數是內容。 block 參數只能是區塊。

如需更多詳細資訊，請參閱上方所示的「內容」區段。

範例

setup context do
  [conn: Plug.Conn.build_conn()]
end

定義一個在案例中所有測試之前執行的回呼。

接受下列其中一項

• 區塊
• 命名為區域函式的原子
• {module, function} 組合
• 原子和 {module, function} 組合的清單

可以傳回要併入 context 的值，以設定測試的狀態。如需更多詳細資訊，請參閱上方所示的「內容」區段。

setup_all/1 回呼會在與測試不同的處理序中執行。所有 setup_all/1 回呼會在同一個處理序中依序執行。

結束處理常式

您在 setup_all/1 回呼中註冊的結束處理常式會在模組中的所有測試執行完畢後一次執行。它們會全部在同一個處理序中執行，而這個處理序是專門用來執行這些處理常式的。這些處理常式會依據其各自的 setup_all/1 回呼的相反順序執行。

範例

# One-arity function name
setup_all :clean_up_tmp_directory

# A module and function
setup_all {MyModule, :my_setup_function}

# A list of one-arity functions and module/function tuples
setup_all [:clean_up_tmp_directory, {MyModule, :my_setup_function}]

defp clean_up_tmp_directory(_context) do
  # perform setup
  :ok
end

# A block
setup_all do
  [conn: Plug.Conn.build_conn()]
end

setup_all/1 傳回的內容會在所有後續的 setup_all、setup 和 test 中提供。例如，可以存取前一個範例中的 conn，方法如下

test "fetches current users", %{conn: conn} do
  # ...
end

處理常式

您可以在 setup_all/1 回呼中定義「全域」結束處理常式

setup_all do
  Database.create_table_for(__MODULE__)

  on_exit(fn ->
    Database.drop_table_for(__MODULE__)
  end)

  :ok
end

上述範例中的處理常式只會在執行模組中的所有測試後執行一次。

定義一個在案例中所有測試之前執行的回呼。

與 setup_all/1 相似，但也會採用一個內容。第二個參數必須是一個區塊。請參閱模組文件中的「內容」區段。

範例

setup_all _context do
  [conn: Plug.Conn.build_conn()]
end

@spec start_link_supervised!(
  Supervisor.child_spec() | module() | {module(), term()},
  keyword()
) :: pid()

與 start_supervised!/2 相同，但將啟動的程序連結到測試程序。

如果啟動的程序發生崩潰，崩潰會傳播到測試程序，導致測試失敗並印出崩潰原因。

請注意，如果啟動的程序在連結到測試程序之前終止，此函式會以 :noproc 原因結束。

@spec start_supervised(
  Supervisor.child_spec() | module() | {module(), term()},
  keyword()
) :: Supervisor.on_start_child()

在測試監督下啟動子程序。

它預期一個子程序規格或模組，類似於提供給 Supervisor.start_link/2 的規格。例如，如果您的應用程式透過執行來啟動一個監控樹

Supervisor.start_link([MyServer, {OtherSupervisor, ...}], ...)

您可以透過執行來獨立啟動那些測試中的程序

start_supervised(MyServer)
start_supervised({OtherSupervisor, :initial_value})

如果需要變更給定子程序的子程序規格，也可以提供一個關鍵字清單

start_supervised({MyServer, :initial_value}, restart: :temporary)

請參閱 Supervisor 模組，以了解子程序規格和可用的規格金鑰。

在測試監控程式下啟動程序的優點是，它保證在下一項測試開始之前結束。因此，您不需要透過 stop_supervised/1 在測試結束時移除程序。您只需要在測試中程中想要從監控樹移除程序時使用 stop_supervised/1，因為僅關閉程序會讓它根據其 :restart 值重新啟動。

啟動的程序未連結到測試程序，而崩潰也不一定會導致測試失敗。若要啟動並連結程序以確保任何崩潰也會導致測試失敗，請使用 start_link_supervised!/2。

此函數在成功時傳回 {:ok, pid}，否則傳回 {:error, reason}。

@spec start_supervised!(
  Supervisor.child_spec() | module() | {module(), term()},
  keyword()
) :: pid()

與 start_supervised/2 相同，但如果啟動成功，則傳回 PID，如果未正確啟動，則引發例外。

@spec stop_supervised(id :: term()) :: :ok | {:error, :not_found}

停止透過 start_supervised/2 啟動的子程序。

此函數預期子項規格中的 id。例如

{:ok, _} = start_supervised(MyServer)
:ok = stop_supervised(MyServer)

如果存在具有此類 id 的受監督程序，則傳回 :ok，否則傳回 {:error, :not_found}。

@spec stop_supervised!(id :: term()) :: :ok

與 stop_supervised/1 相同，但如果無法停止，則引發例外。