KnowForge/Testcontainers for Go
Quickstart

Mosquitto

qianmoQqianmoQ· 更新于 2026-10-14· 阅读 26 分钟· 0 次阅读
登录后可跨设备保存划线和私人笔记登录

Mosquitto

Since v0.44.0

Introduction

The Testcontainers module for Eclipse Mosquitto, a lightweight open-source MQTT broker that implements the MQTT protocol versions 5, 3.1.1, and 3.1. Commonly used for IoT and messaging workloads.

Adding this module to your project dependencies

Please run the following command to add the Mosquitto module to your Go dependencies:

go get github.com/testcontainers/testcontainers-go/modules/mosquitto

Usage example

Creating a Mosquitto container

ctx := context.Background()

mosquittoContainer, err := mosquitto.Run(ctx, "eclipse-mosquitto:2")
defer func() {
    if err := testcontainers.TerminateContainer(mosquittoContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

Module Reference

Run function

The Mosquitto module exposes one entrypoint function to create the Mosquitto container, and this function receives three parameters:

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*Container, error)
  • context.Context, the Go context.
  • string, the Docker image to use.
  • testcontainers.ContainerCustomizer, a variadic argument for passing options.

Image

Use the second argument in the Run function to set a valid Docker image. In example: Run(context.Background(), "eclipse-mosquitto:2").

Info

The eclipse-mosquitto image requires a configuration file with at least a listener 1883 directive to accept connections. The module automatically injects a minimal default configuration that enables anonymous connections on port 1883 when no custom configuration is provided.

Container Options

When starting the Mosquitto container, you can pass options in a variadic way to configure it.

WithConfigFile

Mounts a custom mosquitto.conf file, replacing the module's default embedded configuration. The provided file must contain at least a listener 1883 directive.

mosquittoContainer, err := mosquitto.Run(ctx, "eclipse-mosquitto:2",
    mosquitto.WithConfigFile("/path/to/mosquitto.conf"),
)

The following options are exposed by the testcontainers package.

Basic Options

Lifecycle Options

Files & Mounts Options

Build Options

Logging Options

Image Options

Networking Options

Advanced Options

Experimental Options

Container Methods

The Mosquitto container exposes the following methods:

BrokerURL

Returns the MQTT broker URL (mqtt://host:port) for connecting MQTT clients to the broker.

brokerURL, err := mosquittoContainer.BrokerURL(ctx)

评论

登录后参与评论

正在加载评论…