View Source Testcontainers.EmqxContainer (testcontainers v1.11.6)

Provides functionality for creating and managing EMQX container configurations.

Summary

Functions

default_image()

Retrieves the default Docker image for the Emqx container.

host()

Returns the address on the host machine where the Emqx container is listening.

mqtt_port(container)

Returns the port on the host machine where the Emqx container is listening.

new()

Creates a new EmqxContainer struct with default configurations.

with_check_image(config, check_image)

Set the regular expression to check the image validity.

with_image(config, image)

Overrides the default image used for the Emqx container.

with_ports(config, mqtt_port \\ 1883, mqtts_port \\ 8883, mqtt_over_ws_port \\ 8083, mqtt_over_wss_port \\ 8084, dashboard_port \\ 18083)

with_reuse(config, reuse)

Set the reuse flag to reuse the container if it is already running.

Functions

default_image()

Retrieves the default Docker image for the Emqx container.

host()

Returns the address on the host machine where the Emqx container is listening.

mqtt_port(container)

Returns the port on the host machine where the Emqx container is listening.

new()

Creates a new EmqxContainer struct with default configurations.

with_check_image(config, check_image)

Set the regular expression to check the image validity.

with_image(config, image)

Overrides the default image used for the Emqx container.

Examples

iex> config = EmqxContainer.new()
iex> new_config = EmqxContainer.with_image(config, "emqx:xyz")
iex> new_config.image
"emqx:xyz"

with_ports(config, mqtt_port \\ 1883, mqtts_port \\ 8883, mqtt_over_ws_port \\ 8083, mqtt_over_wss_port \\ 8084, dashboard_port \\ 18083)

with_reuse(config, reuse)

Set the reuse flag to reuse the container if it is already running.