Packages

testcontainers

0.9.1
2.3.1 2.3.0 2.2.0 2.1.0 2.1.0-rc1 2.0.0 2.0.0-rc3 2.0.0-rc2 2.0.0-rc 1.14.1 1.14.0 1.13.5 1.13.4 1.13.3 1.13.2 1.13.1 1.13.0 1.12.0 1.11.8 1.11.7 1.11.6 1.11.5 1.11.4 1.11.3 1.11.2 1.11.1 1.11.0 1.10.5 1.10.4 1.10.3 1.10.2 1.10.1 1.10.0 1.9.0 1.8.4 1.8.3 1.8.2 1.8.1 1.8.0 1.7.0 1.6.0 1.5.1 1.5.0 1.4.2 1.4.1 1.4.0 1.3.1 1.3.0 1.2.11 1.2.10 1.2.9 1.2.8 1.2.7 1.2.6 1.2.5 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0 1.1.3 1.1.2 1.1.1 1.1.0 1.0.1 1.0.0 1.0.0-beta.1 1.0.0-beta 0.9.3 0.9.2 0.9.1 0.9.0

Testcontainers is an Elixir library that supports ExUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.

HexDocs

Current section

Files

Jump to
Readme
72 Versions
1 Dependency
3 Dependants
Files
Activity
testcontainers README.md
Raw

README.md 

# Testcontainers



[![Hex.pm](https://img.shields.io/hexpm/v/testcontainers.svg)]()



> Testcontainers is an Elixir library that supports ExUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.



## Usage



For automatic cleanup of docker containers created in tests, for example if testcontainers fails to stop and remove the container, its suggested to register a reaper genserver in test_helper.exs like this:



test/test_helper.exs

```elixir

{:ok, _} = Testcontainers.Reaper.start_link()

ExUnit.start()

```



test/mysql_container_test.exs

```elixir

defmodule MySqlContainerTest do

  use ExUnit.Case, async: true



  import Testcontainers.ExUnit



  alias Testcontainers.Container.MySqlContainer



  describe "with default configuration" do

    container(:mysql, MySqlContainer.new())



    test "provides a ready-to-use mysql container", %{mysql: mysql} do

      assert true



      # if you want to test like below, add 

      # {:myxql, "~> 0.6.0", only: [:dev, :test]},

      # to mix.exs and run mix deps.get



      #{:ok, pid} = MyXQL.start_link(MySqlContainer.connection_parameters(mysql))

      #assert %{num_rows: 1} = MyXQL.query!(pid, "SELECT 1", [])

    end

  end

```



## Contribution



Do you want to contribute? Find spots to improve on, fire up an issue and get the discussion going.