chaperon v0.3.1 Chaperon.Scenario View Source

Helper module to be used by scenario definition modules.

Imports Chaperon.Session and other helper modules for easy scenario definitions.

Example

defmodule MyScenario do
  use Chaperon.Scenario

  def init(session) do
    # Possibly do something with session before running scenario
    delay = :rand.uniform
    if delay > 0.5 do
      {:ok, session |> with_delay(delay |> seconds)}
    else
      {:ok, session}
    end
  end

  def run(session) do
    session
    |> post("/api/messages", json: %{message: "what's up?"})
    |> get("/api/messages")
  end

  def with_delay(session, delay) do
    put_in session.config[:delay], delay
  end
end

Link to this section Summary

Runs a given scenario module with a given config and returns the scenario's session annotated with histogram metrics via the Chaperon.Scenario.Metrics module. The returned Chaperon.Session will include histogram data for all performed Chaperon.Actionables, including for all run actions run asynchronously as part of the scenario.

execute_nested(scenario, session, config)

init(scenario_mod, session)

Initializes a Chaperon.Scenario for a given session.

initial_delay(session)

name(mod)

Returns the name of a Chaperon.Scenario based on the module its referring to.

nested_session(scenario, session, config)

new_session(scenario, config)

run(scenario, session)

session_name(scenario, arg2)

teardown(scenario, session)

Cleans up any resources after the Scenario was run (if needed). Can be overriden.

Link to this section Types

t()

t() :: %Chaperon.Scenario{module: module()}

Link to this section Functions

execute(scenario_mod, config)

execute(module(), map()) :: Chaperon.Session.t()