Basic copy_to implementation (#242)

* Basic copy_to implementation

* fix hash

* remove deprecation in running cli tests

* use inotify tools for phoenix

* inotify tools for all jobs

* refactor create and start container to guarantee correct runs

* extract pulling image from create_and_start_container

* with ip?

* what about no wait strategy?

* address rebase

* fix hash

* with waiting strategy

* revert inotify install

* revert create container API

Author: gossi

lib/container.ex

@@ -20,6 +20,7 @@ defmodule Testcontainers.Container do
     privileged: false,
     bind_mounts: [],
     bind_volumes: [],
+    copy_to: [],
     labels: %{},
     auto_remove: false,
     container_id: nil,
@@ -281,6 +282,14 @@ defmodule Testcontainers.Container do
     %__MODULE__{config | hostname: hostname}
   end
 
+  def with_copy_to(%__MODULE__{} = config, target, source)
+      when is_binary(target) and is_binary(source) do
+    %__MODULE__{
+      config
+      | copy_to: [%{"target" => target, "contents" => source} | config.copy_to]
+    }
+  end
+
   @doc """
   Gets the host port on the container for the given exposed port.
   """

lib/copy_to.ex

@@ -0,0 +1,16 @@
+defmodule Testcontainers.CopyTo do
+  alias Testcontainers.Docker
+
+  @doc """
+  Copy a string of contents into a file at target
+  """
+  def copy_to(conn, id, %{"target" => target, "contents" => contents})
+      when is_binary(target) and is_binary(contents) do
+    Docker.Api.put_file(id, conn, Path.dirname(target), Path.basename(target), contents)
+  end
+
+  # add more implementation for copy_to as you need them, eg.
+  # - copy a dir into a dir
+  # - copy a file into a file
+  # - copy an archive into a file
+end

lib/testcontainers.ex

@@ -9,6 +9,7 @@ defmodule Testcontainers do
 
   require Logger
 
+  alias Testcontainers.CopyTo
   alias Testcontainers.Constants
   alias Testcontainers.WaitStrategy
   alias Testcontainers.Docker.Api
@@ -389,7 +390,10 @@ defmodule Testcontainers do
         {:ok, connected}
 
       {:error, reason} ->
-        Logger.info("Connection failed with #{inspect(reason)}. Retrying... Attempt #{reattempt_count + 1}/5")
+        Logger.info(
+          "Connection failed with #{inspect(reason)}. Retrying... Attempt #{reattempt_count + 1}/5"
+        )
+
         :timer.sleep(1000)
         create_ryuk_socket(container, docker_hostname, reattempt_count + 1)
     end
@@ -454,7 +458,8 @@ defmodule Testcontainers do
     config = resolve_pull_policy(config, state.properties)
 
     with :ok <- maybe_pull_image(config, state.conn),
-         {:ok, id} <- Api.create_container(config, state.conn) do
+         {:ok, id} <- Api.create_container(config, state.conn),
+         :ok <- copy_to_container(id, config, state.conn) do
       start_and_wait_container(id, config, config_builder, state)
     end
   end
@@ -515,6 +520,16 @@ defmodule Testcontainers do
     :ok
   end
 
+  defp copy_to_container(id, config, conn) do
+    Enum.reduce(config.copy_to, :ok, fn
+      copy_to, :ok ->
+        CopyTo.copy_to(conn, id, copy_to)
+
+      _, error ->
+        error
+    end)
+  end
+
   defp wait_for_container(container, wait_strategies, conn) do
     Enum.reduce(wait_strategies, :ok, fn
       wait_strategy, :ok ->

mix.exs

@@ -23,11 +23,6 @@ defmodule TestcontainersElixir.MixProject do
         links: %{"GitHub" => @source_url},
         licenses: ["MIT"]
       ],
-      preferred_cli_env: [
-        test: :test,
-        citest: :test,
-        "testcontainers.test": :test
-      ],
       test_coverage: [
         summary: [threshold: 50],
         ignore_modules: [
@@ -39,6 +34,10 @@ defmodule TestcontainersElixir.MixProject do
     ]
   end
 
+  def cli do
+    [preferred_envs: [test: :test, citest: :test, "testcontainers.test": :test]]
+  end
+
   defp elixirc_paths(:test), do: ["lib", "test/support", "docker_engine_api"]
   defp elixirc_paths(_), do: ["lib", "docker_engine_api"]
 

test/container_test.exs

@@ -21,10 +21,10 @@ defmodule Testcontainers.ContainerTest do
       container2 = ContainerBuilder.build(Testcontainers.PostgresContainer.new())
 
       assert Testcontainers.Util.Hash.struct_to_hash(container1) ==
-               "aa66f22d5fbd75eca0328915af3fa749c624e53475988cdfcecd2b931a8a4d28"
+               "a0b9a403e485c224323eabc27b2b8e94a6353c785cdc27f9ac2b8a9b67a47cb1"
 
       assert Testcontainers.Util.Hash.struct_to_hash(container2) ==
-               "aa66f22d5fbd75eca0328915af3fa749c624e53475988cdfcecd2b931a8a4d28"
+               "a0b9a403e485c224323eabc27b2b8e94a6353c785cdc27f9ac2b8a9b67a47cb1"
     end
   end
 

test/copy_to_test.exs

@@ -0,0 +1,23 @@
+defmodule CopyToTest do
+  alias Testcontainers.HttpWaitStrategy
+  use ExUnit.Case, async: true
+
+  test "copy contents to target" do
+    port = 80
+    contents = "Hello there"
+
+    config =
+      %Testcontainers.Container{image: "nginx:alpine"}
+      |> Testcontainers.Container.with_exposed_port(port)
+      |> Testcontainers.Container.with_waiting_strategy(HttpWaitStrategy.new("/hello.txt", port))
+      |> Testcontainers.Container.with_copy_to("/usr/share/nginx/html/hello.txt", contents)
+
+    assert {:ok, container} = Testcontainers.start_container(config)
+
+    mapped_port = Testcontainers.Container.mapped_port(container, port)
+    {:ok, %{body: body}} = Tesla.get("http://127.0.0.1:#{mapped_port}/hello.txt")
+
+    assert contents == body
+    assert :ok = Testcontainers.stop_container(container.container_id)
+  end
+end