Helpers for testing a periodic job.
See the "Testing" section in Periodic documentation for details.
Summary
Functions
Waits for the given telemetry event.
Subscribes to telemetry events of the given scheduler.
Asserts that the given telemetry event won't be emitted.
Sends a tick signal to the given scheduler and waits for the job to finish.
Sends a tick signal to the given scheduler.
Functions
Waits for the given telemetry event.
@spec observe(any()) :: :ok
Subscribes to telemetry events of the given scheduler.
Asserts that the given telemetry event won't be emitted.
@spec sync_tick(GenServer.server(), non_neg_integer() | :infinity) :: {:ok, job_exit_reason :: any()} | {:error, :job_not_started | :not_in_manual_mode}
Sends a tick signal to the given scheduler and waits for the job to finish.
The function returns the job exit reason, or error if the job hasn't been started.
If the scheduler was not started with :mode set to :manual, this function returns
{:error, :not_in_manual_mode}.
@spec tick(GenServer.server()) :: :ok | {:error, :not_in_manual_mode}
Sends a tick signal to the given scheduler.
This function returns after the tick signal has been sent, and the job has been started.
However, the function doesn't wait for the job to finish. If you want complete synchronism, use
sync_tick/2.
If the scheduler was not started with :mode set to :manual, this function returns
{:error, :not_in_manual_mode}.