Wallabidi (wallabidi v0.4.0-rc.11)

A concurrent feature testing library.

Configuration

Wallabidi supports the following options:

:otp_app - The name of your OTP application. This is used to check out your Ecto repos into the SQL Sandbox.
:screenshot_dir - The directory to store screenshots.
:screenshot_on_failure - if Wallabidi should take screenshots on test failures (defaults to false).
:max_wait_time - The amount of time that Wallabidi should wait to find an element on the page. (defaults to 3_000)
:js_errors - if Wallabidi should re-throw JavaScript errors in elixir (defaults to true).
:js_logger - IO device where JavaScript console logs are written to. Defaults to :stdio. This option can also be set to a file or any other io device. You can disable JavaScript console logging by setting this to nil.

Summary

Types

reason()

start_session_opts()

Functions

driver_for(atom)

Resolves a driver for a capability tier, applying wallabidi's default ladder so the sensible path needs no configuration

end_session(session)

Ends a browser session.

pinned_driver()

The driver pinned via WALLABIDI_DRIVER / WALLABIDI_BROWSER, or nil.

primary_driver()

The driver untagged tests / the app supervisor use as primary.

resolve_driver(opts \\ [])

Resolves the driver for an untagged/default session.

start_session(opts \\ [])

Starts a browser session.

Types

reason()

@type reason() :: any()

start_session_opts()

@type start_session_opts() :: {atom(), any()}

Functions

driver_for(atom)

Resolves a driver for a capability tier, applying wallabidi's default ladder so the sensible path needs no configuration:

:default — untagged tests / bare sessions. config :driver, else :live_view (in-process, fastest).
:headless — @tag :headless. config :headless, else Lightpanda when its package is available, else the :browser driver (so a Chrome-only project still runs headless tests).
:browser — @tag :browser. config :browser, else :chrome_cdp.

Each config :wallabidi, <key>: <driver> entry is purely an override.

end_session(session)

@spec end_session(Wallabidi.Session.t()) :: :ok | {:error, reason()}

Ends a browser session.

pinned_driver()

The driver pinned via WALLABIDI_DRIVER / WALLABIDI_BROWSER, or nil.

Raises if the env var holds an unknown driver name (loud beats a stray atom / silent wrong-driver run).

primary_driver()

The driver untagged tests / the app supervisor use as primary.

A WALLABIDI_DRIVER / WALLABIDI_BROWSER env pin wins (so a pinned CI lane boots the right supervisor and routes every test there); otherwise the configured/default :driver.

resolve_driver(opts \\ [])

Resolves the driver for an untagged/default session.

Explicit opts[:driver] wins; otherwise the configured default (driver_for(:default)). This is what a bare Wallabidi.start_session/1 and untagged feature tests use.

start_session(opts \\ [])

@spec start_session([start_session_opts()]) ::
  {:ok, Wallabidi.Session.t()} | {:error, reason()}

Starts a browser session.

Multiple sessions

Each session runs in its own browser so that each test runs in isolation. Because of this isolation multiple sessions can be created for a test:

@message_field Query.text_field("Share Message")
@share_button Query.button("Share")
@message_list Query.css(".messages")

test "That multiple sessions work" do
  {:ok, user1} = Wallabidi.start_session
  user1
  |> visit("/page.html")
  |> fill_in(@message_field, with: "Hello there!")
  |> click(@share_button)

  {:ok, user2} = Wallabidi.start_session
  user2
  |> visit("/page.html")
  |> fill_in(@message_field, with: "Hello yourself")
  |> click(@share_button)

  assert user1 |> find(@message_list) |> List.last |> text == "Hello yourself"
  assert user2 |> find(@message_list) |> List.first |> text == "Hello there"
end