Azurite¶

Since testcontainers-go v0.32.0

Introduction¶

The Testcontainers module for Azurite.

Adding this module to your project dependencies¶

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

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

Usage example¶

Creating a Azurite container

ctx := context.Background()

azuriteContainer, err := azurite.Run(
    ctx,
    "mcr.microsoft.com/azure-storage/azurite:3.28.0",
)
defer func() {
    if err := testcontainers.TerminateContainer(azuriteContainer); 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¶

Since testcontainers-go v0.32.0

Info

The RunContainer(ctx, opts...) function is deprecated and will be removed in the next major release of Testcontainers for Go.

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

func Run(ctx context.Context, img string, opts ...testcontainers.ContainerCustomizer) (*AzuriteContainer, error)

context.Context, the Go context.
string, the Docker image to use.
testcontainers.ContainerCustomizer, a variadic argument for passing options.

Default Credentials¶

The Azurite container uses the following default credentials:

Default Credencials

// AccountName is the default testing account name used by Azurite
AccountName string = "devstoreaccount1"

// AccountKey is the default testing account key used by Azurite
AccountKey string = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="

Container Options¶

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

Image¶

If you need to set a different Azurite Docker image, you can set a valid Docker image as the second argument in the Run function. E.g. Run(context.Background(), "mcr.microsoft.com/azure-storage/azurite:3.28.0").

Image Substitutions¶

Since testcontainers-go v0.26.0

In more locked down / secured environments, it can be problematic to pull images from Docker Hub and run them without additional precautions.

An image name substitutor converts a Docker image name, as may be specified in code, to an alternative name. This is intended to provide a way to override image names, for example to enforce pulling of images from a private registry.

Testcontainers for Go exposes an interface to perform this operations: ImageSubstitutor, and a No-operation implementation to be used as reference for custom implementations:

Image Substitutor InterfaceNoop Image Substitutor

// ImageSubstitutor represents a way to substitute container image names
type ImageSubstitutor interface {
    // Description returns the name of the type and a short description of how it modifies the image.
    // Useful to be printed in logs
    Description() string
    Substitute(image string) (string, error)
}

type NoopImageSubstitutor struct{}

// Description returns a description of what is expected from this Substitutor,
// which is used in logs.
func (s NoopImageSubstitutor) Description() string {
    return "NoopImageSubstitutor (noop)"
}

// Substitute returns the original image, without any change
func (s NoopImageSubstitutor) Substitute(image string) (string, error) {
    return image, nil
}

Using the WithImageSubstitutors options, you could define your own substitutions to the container images. E.g. adding a prefix to the images so that they can be pulled from a Docker registry other than Docker Hub. This is the usual mechanism for using Docker image proxies, caches, etc.

WithEnv¶

Since testcontainers-go v0.29.0

If you need to either pass additional environment variables to a container or override them, you can use testcontainers.WithEnv for example:

postgres, err = postgresModule.Run(ctx, "postgres:15-alpine", testcontainers.WithEnv(map[string]string{"POSTGRES_INITDB_ARGS": "--no-sync"}))

WithHostPortAccess¶

Since testcontainers-go v0.31.0

If you need to access a port that is already running in the host, you can use testcontainers.WithHostPortAccess for example:

postgres, err = postgresModule.Run(ctx, "postgres:15-alpine", testcontainers.WithHostPortAccess(8080))

To understand more about this feature, please read the Exposing host ports to the container documentation.

WithLogConsumers¶

Since testcontainers-go v0.28.0

If you need to consume the logs of the container, you can use testcontainers.WithLogConsumers with a valid log consumer. An example of a log consumer is the following:

type TestLogConsumer struct {
    Msgs []string
}

func (g *TestLogConsumer) Accept(l Log) {
    g.Msgs = append(g.Msgs, string(l.Content))
}

WithLogger¶

Since testcontainers-go v0.29.0

If you need to either pass logger to a container, you can use testcontainers.WithLogger.

Info

Consider calling this before other "With" functions as these may generate logs.

In this example we also use TestLogger which writes to the passed in testing.TB using Logf. The result is that we capture all logging from the container into the test context meaning its hidden behind go test -v and is associated with the relevant test, providing the user with useful context instead of appearing out of band.

func TestHandler(t *testing.T) {
    logger := TestLogger(t)
    ctr, err := postgresModule.Run(ctx, "postgres:15-alpine", testcontainers.WithLogger(logger))
    CleanupContainer(t, ctr)
    require.NoError(t, err)
    // Do something with container.
}

Please read the Following Container Logs documentation for more information about creating log consumers.

Wait Strategies¶

If you need to set a different wait strategy for the container, you can use testcontainers.WithWaitStrategy with a valid wait strategy.

Info

The default deadline for the wait strategy is 60 seconds.

At the same time, it's possible to set a wait strategy and a custom deadline with testcontainers.WithWaitStrategyAndDeadline.

Startup Commands¶

Since testcontainers-go v0.25.0

Testcontainers exposes the WithStartupCommand(e ...Executable) option to run arbitrary commands in the container right after it's started.

Info

To better understand how this feature works, please read the Create containers: Lifecycle Hooks documentation.

It also exports an Executable interface, defining the following methods:

AsCommand(), which returns a slice of strings to represent the command and positional arguments to be executed in the container;
Options(), which returns the slice of functional options with the Docker's ExecConfigs used to create the command in the container (the working directory, environment variables, user executing the command, etc) and the possible output format (Multiplexed).

You could use this feature to run a custom script, or to run a command that is not supported by the module right after the container is started.

Ready Commands¶

Since testcontainers-go v0.28.0

Testcontainers exposes the WithAfterReadyCommand(e ...Executable) option to run arbitrary commands in the container right after it's ready, which happens when the defined wait strategies have finished with success.

Info

To better understand how this feature works, please read the Create containers: Lifecycle Hooks documentation.

It leverages the Executable interface to represent the command and positional arguments to be executed in the container.

You could use this feature to run a custom script, or to run a command that is not supported by the module right after the container is ready.

WithNetwork¶

Since testcontainers-go v0.27.0

By default, the container is started in the default Docker network. If you want to use an already existing Docker network you created in your code, you can use the network.WithNetwork(aliases []string, nw *testcontainers.DockerNetwork) option, which receives an alias as parameter and your network, attaching the container to it, and setting the network alias for that network.

In the case you need to retrieve the network name, you can simply read it from the struct's Name field. E.g. nw.Name.

Warning

This option is not checking whether the network exists or not. If you use a network that doesn't exist, the container will start in the default Docker network, as in the default behavior.

WithNewNetwork¶

Since testcontainers-go v0.27.0

If you want to attach your containers to a throw-away network, you can use the network.WithNewNetwork(ctx context.Context, aliases []string, opts ...network.NetworkCustomizer) option, which receives an alias as parameter, creating the new network with a random name, attaching the container to it, and setting the network alias for that network.

In the case you need to retrieve the network name, you can use the Networks(ctx) method of the Container interface, right after it's running, which returns a slice of strings with the names of the networks where the container is attached.

Docker type modifiers¶

If you need an advanced configuration for the container, you can leverage the following Docker type modifiers:

testcontainers.WithConfigModifier
testcontainers.WithHostConfigModifier
testcontainers.WithEndpointSettingsModifier

Please read the Create containers: Advanced Settings documentation for more information.

Customising the ContainerRequest¶

This option will merge the customized request into the module's own ContainerRequest.

container, err := Run(ctx, "postgres:13-alpine",
    /* Other module options */
    testcontainers.CustomizeRequest(testcontainers.GenericContainerRequest{
        ContainerRequest: testcontainers.ContainerRequest{
            Cmd: []string{"-c", "log_statement=all"},
        },
    }),
)

The above example is updating the predefined command of the image, appending them to the module's command.

Info

This can't be used to replace the command, only to append options.

WithInMemoryPersistence¶

Since testcontainers-go v0.32.0

If you want to use in-memory persistence, you can use WithInMemoryPersistence(megabytes float64). E.g. azurite.WithInMemoryPersistence(64.0).

Please read the Azurite documentation for more information.

Warning

This option is only available in Azurite versions 3.28.0 and later.

Container Methods¶

The Azurite container exposes the following methods:

ServiceURL¶

Since testcontainers-go v0.32.0

Returns the service URL to connect to the Azurite container and an error, passing the Go context and the service name as parameters.

MustServiceURL¶

Since testcontainers-go v0.32.0

Returns the service URL to connect to the Azurite container, passing the Go context and the service name as parameters. If an error occurs, it will panic.

Examples¶

Blob Operations¶

In the following example, we will create a container with Azurite and perform some blob operations. For that, using the default credentials, we will create an Azurite container, upload a blob to it, list the blobs, and download the blob. Finally, we will remove the created blob and container.

Performing blob operations

// blobOperations {
ctx := context.Background()

azuriteContainer, err := azurite.Run(
    ctx,
    "mcr.microsoft.com/azure-storage/azurite:3.28.0",
    azurite.WithInMemoryPersistence(64),
)
defer func() {
    if err := testcontainers.TerminateContainer(azuriteContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

// using the built-in shared key credential type
cred, err := azblob.NewSharedKeyCredential(azurite.AccountName, azurite.AccountKey)
if err != nil {
    log.Printf("failed to create shared key credential: %s", err)
    return
}

// create an azblob.Client for the specified storage account that uses the above credentials
blobServiceURL := fmt.Sprintf("%s/%s", azuriteContainer.MustServiceURL(ctx, azurite.BlobService), azurite.AccountName)

client, err := azblob.NewClientWithSharedKeyCredential(blobServiceURL, cred, nil)
if err != nil {
    log.Printf("failed to create client: %s", err)
    return
}

// ===== 1. Create a container =====
containerName := "testcontainer"
_, err = client.CreateContainer(context.TODO(), containerName, nil)
if err != nil {
    log.Printf("failed to create container: %s", err)
    return
}

// ===== 2. Upload and Download a block blob =====
blobData := "Hello world!"
blobName := "HelloWorld.txt"

_, err = client.UploadStream(context.TODO(),
    containerName,
    blobName,
    strings.NewReader(blobData),
    &azblob.UploadStreamOptions{
        Metadata: map[string]*string{"Foo": to.Ptr("Bar")},
        Tags:     map[string]string{"Year": "2022"},
    })
if err != nil {
    log.Printf("failed to upload blob: %s", err)
    return
}

// Download the blob's contents and ensure that the download worked properly
blobDownloadResponse, err := client.DownloadStream(context.TODO(), containerName, blobName, nil)
if err != nil {
    log.Printf("failed to download blob: %s", err)
    return
}

// Use the bytes.Buffer object to read the downloaded data.
// RetryReaderOptions has a lot of in-depth tuning abilities, but for the sake of simplicity, we'll omit those here.
reader := blobDownloadResponse.Body
downloadData, err := io.ReadAll(reader)
if err != nil {
    log.Printf("failed to read downloaded data: %s", err)
    return
}

fmt.Println(string(downloadData))

err = reader.Close()
if err != nil {
    return
}

// ===== 3. List blobs =====
// List methods returns a pager object which can be used to iterate over the results of a paging operation.
// To iterate over a page use the NextPage(context.Context) to fetch the next page of results.
// PageResponse() can be used to iterate over the results of the specific page.
pager := client.NewListBlobsFlatPager(containerName, nil)
for pager.More() {
    resp, err := pager.NextPage(context.TODO())
    if err != nil {
        log.Printf("failed to list blobs: %s", err)
        return
    }

    fmt.Println(len(resp.Segment.BlobItems))
}

// Delete the blob.
_, err = client.DeleteBlob(context.TODO(), containerName, blobName, nil)
if err != nil {
    log.Printf("failed to delete blob: %s", err)
    return
}

// Delete the container.
_, err = client.DeleteContainer(context.TODO(), containerName, nil)
if err != nil {
    log.Printf("failed to delete container: %s", err)
    return
}

// }

// Output:
// Hello world!
// 1

Queue Operations¶

In the following example, we will create an Azurite container and perform some queue operations. For that, using the default credentials, we will create a queue, list the queues, and finally we will remove the created queue.

Performing queue operations

// queueOperations {
ctx := context.Background()

azuriteContainer, err := azurite.Run(
    ctx,
    "mcr.microsoft.com/azure-storage/azurite:3.28.0",
    azurite.WithInMemoryPersistence(64),
)
defer func() {
    if err := testcontainers.TerminateContainer(azuriteContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

// using the built-in shared key credential type
cred, err := azqueue.NewSharedKeyCredential(azurite.AccountName, azurite.AccountKey)
if err != nil {
    log.Printf("failed to create shared key credential: %s", err)
    return
}

// create an azqueue.Client for the specified storage account that uses the above credentials
queueServiceURL := fmt.Sprintf("%s/%s", azuriteContainer.MustServiceURL(ctx, azurite.QueueService), azurite.AccountName)

client, err := azqueue.NewServiceClientWithSharedKeyCredential(queueServiceURL, cred, nil)
if err != nil {
    log.Printf("failed to create client: %s", err)
    return
}

queueName := "testqueue"

_, err = client.CreateQueue(context.TODO(), queueName, &azqueue.CreateOptions{
    Metadata: map[string]*string{"hello": to.Ptr("world")},
})
if err != nil {
    log.Printf("failed to create queue: %s", err)
    return
}

pager := client.NewListQueuesPager(&azqueue.ListQueuesOptions{
    Include: azqueue.ListQueuesInclude{Metadata: true},
})

// list pre-existing queues
for pager.More() {
    resp, err := pager.NextPage(context.Background())
    if err != nil {
        log.Printf("failed to list queues: %s", err)
        return
    }

    fmt.Println(len(resp.Queues))
    fmt.Println(*resp.Queues[0].Name)
}

// delete the queue
_, err = client.DeleteQueue(context.TODO(), queueName, &azqueue.DeleteOptions{})
if err != nil {
    log.Printf("failed to delete queue: %s", err)
    return
}

// }

// Output:
// 1
// testqueue

Table Operations¶

In the following example, we will create an Azurite container and perform some table operations. For that, using the default credentials, we will create a table, list the tables, and finally we will remove the created table.

Performing table operations

// tableOperations {
ctx := context.Background()

azuriteContainer, err := azurite.Run(
    ctx,
    "mcr.microsoft.com/azure-storage/azurite:3.28.0",
    azurite.WithInMemoryPersistence(64),
)
defer func() {
    if err := testcontainers.TerminateContainer(azuriteContainer); err != nil {
        log.Printf("failed to terminate container: %s", err)
    }
}()
if err != nil {
    log.Printf("failed to start container: %s", err)
    return
}

// using the built-in shared key credential type
cred, err := aztables.NewSharedKeyCredential(azurite.AccountName, azurite.AccountKey)
if err != nil {
    log.Printf("failed to create shared key credential: %s", err)
    return
}

// create an aztables.Client for the specified storage account that uses the above credentials
tablesServiceURL := fmt.Sprintf("%s/%s", azuriteContainer.MustServiceURL(ctx, azurite.TableService), azurite.AccountName)

client, err := aztables.NewServiceClientWithSharedKey(tablesServiceURL, cred, nil)
if err != nil {
    log.Printf("failed to create client: %s", err)
    return
}

tableName := "fromServiceClient"
// Create a table
_, err = client.CreateTable(context.TODO(), tableName, nil)
if err != nil {
    log.Printf("failed to create table: %s", err)
    return
}

// List tables
pager := client.NewListTablesPager(nil)
for pager.More() {
    resp, err := pager.NextPage(context.Background())
    if err != nil {
        log.Printf("failed to list tables: %s", err)
        return
    }

    fmt.Println(len(resp.Tables))
    fmt.Println(*resp.Tables[0].Name)
}

// Delete a table
_, err = client.DeleteTable(context.TODO(), tableName, nil)
if err != nil {
    fmt.Println(err)
    return
}

// }

// Output:
// 1
// fromServiceClient