Run subtasks with Mix.Task.run (#190)

Remove watch option

Author: jarlah

.github/workflows/elixir.yml

@@ -72,7 +72,7 @@ jobs:
       run: |
        cd examples/phoenix_project
        mix deps.get
-       mix testcontainers.test
+       MIX_ENV=test mix testcontainers.test
        MIX_ENV=prod mix release
     - name: Run example mix project tests
       run: |

README.md

@@ -100,7 +100,7 @@ container(:redis, Testcontainers.RedisContainer.new())
 
 To run/wrap testcontainers around a project use the testcontainers.run task.
 
-`mix testcontainers.run [sub_task] [--database postgres|mysql] [--watch dir ...] [--db-volume VOLUME]`
+`mix testcontainers.run [sub_task] [--database postgres|mysql] [--db-volume VOLUME]`
 
 to use postgres you can just run
 
@@ -110,19 +110,19 @@ to use postgres you can just run
 
 ```bash
 # Run tests with PostgreSQL (default)
-mix testcontainers.run test
+MIX_ENV=test mix testcontainers.run test
 
 # Run tests with MySQL
-mix testcontainers.run test --database mysql
+MIX_ENV=test mix testcontainers.run test --database mysql
 
 # Run Phoenix server with PostgreSQL and persistent volume
 mix testcontainers.run phx.server --database postgres --db-volume my_postgres_data
 
 # Run tests with MySQL and persistent volume
-mix testcontainers.run test --database mysql --db-volume my_mysql_data
+MIX_ENV=test mix testcontainers.run test --database mysql --db-volume my_mysql_data
 
-# Run tests with file watching
-mix testcontainers.run test --watch lib --watch test
+# Start Phoenix server with containerized DB (will keep running until stopped)
+mix testcontainers.run phx.server --database postgres --db-volume my_dev_data
 ```
 
 #### Persistent Volumes
@@ -134,38 +134,25 @@ The `--db-volume` parameter allows you to specify a persistent volume for databa
 
 This is particularly useful when you want to maintain database state across test runs or development sessions.
 
-#### Configuration
-
-**For testing (config/test.exs):**
-
-```elixir
-config :my_app, MyApp.Repo,
-  username: System.get_env("DB_USER") || "postgres",
-  password: System.get_env("DB_PASSWORD") || "postgres",
-  hostname: System.get_env("DB_HOST") || "localhost",
-  port: System.get_env("DB_PORT") || "5432",
-  database: "my_app_test#{System.get_env("MIX_TEST_PARTITION")}",
-  pool: Ecto.Adapters.SQL.Sandbox,
-  pool_size: System.schedulers_online() * 2
-```
-
-**For development (config/dev.exs):**
+#### Configuration (runtime.exs)
 
-If you want to use `mix testcontainers.run phx.server` or other development tasks with a containerized database, you can configure your `config/dev.exs` similarly:
+Instead of editing dev.exs or test.exs, you can let testcontainers set `DATABASE_URL` and use it from `config/runtime.exs` for dev and test:
 
 ```elixir
-config :my_app, MyApp.Repo,
-  username: System.get_env("DB_USER") || "postgres",
-  password: System.get_env("DB_PASSWORD") || "postgres",
-  hostname: System.get_env("DB_HOST") || "localhost",
-  port: System.get_env("DB_PORT") || "5432",
-  database: "my_app_dev",
-  stacktrace: true,
-  show_sensitive_data_on_connection_error: true,
-  pool_size: 10
+# config/runtime.exs
+
+if config_env() in [:dev, :test] do
+  if url = System.get_env("DATABASE_URL") do
+    config :my_app, MyApp.Repo,
+      url: url,
+      pool: Ecto.Adapters.SQL.Sandbox,
+      show_sensitive_data_on_connection_error: true,
+      pool_size: 10
+  end
+end
 ```
 
-This allows you to run your Phoenix server with a containerized database:
+This allows you to run your Phoenix server or tests with a containerized database without changing dev.exs or test.exs (remember to set MIX_ENV when running tests):
 
 ```bash
 # Start Phoenix server with PostgreSQL container
@@ -180,12 +167,16 @@ mix testcontainers.run phx.server --database postgres --db-volume my_dev_data
 
 Activate reuse of database containers started by mix task with adding `testcontainers.reuse.enable=true` in `~/.testcontainers.properties`. This is experimental.
 
-You can pass arguments to the sub-task by appending them after the sub-task name. For example, to pass arguments to mix test:
+You can pass arguments to the sub-task by appending them after `--`. For example, to pass arguments to mix test:
 
-`mix testcontainers.run test --exclude flaky --stale`
+`MIX_ENV=test mix testcontainers.run test -- --exclude flaky --stale`
 
 In the example above we are running tests while excluding flaky tests and using the --stale option.
 
+Note: MIX_ENV is not overridden by the run task. For tests, set it explicitly in the shell:
+
+`MIX_ENV=test mix testcontainers.run test`
+
 #### Backward Compatibility
 
 For backward compatibility, the old `mix testcontainers.test` task is still available and works exactly as before. It automatically delegates to `mix testcontainers.run test`, so existing scripts and workflows will continue to work without modification:

lib/mix/tasks/testcontainers/run.ex

@@ -6,14 +6,14 @@ defmodule Mix.Tasks.Testcontainers.Run do
   @shortdoc "Runs a Mix sub-task (test, phx.server, etc) with a database container"
   @moduledoc """
   Usage:
-    mix testcontainers.run [sub_task] [--database DB] [--watch folder] [--db-volume VOLUME] [sub_task_args...]
+    mix testcontainers.run [sub_task] [--database DB] [--db-volume VOLUME] [sub_task_args...]
 
   Examples:
     mix testcontainers.run test --database postgres
     mix testcontainers.run phx.server --database mysql
-    mix testcontainers.run test --watch lib --watch test
     mix testcontainers.run test --database postgres --db-volume my_postgres_data
-    mix testcontainers.run test --database mysql --db-volume my_mysql_data
+    mix testcontainers.run phx.server --db-volume my_postgres_data
+    mix testcontainers.run some.custom.server
   """
 
   def run(args) do
@@ -27,13 +27,11 @@ defmodule Mix.Tasks.Testcontainers.Run do
       OptionParser.parse(args,
         switches: [
           database: :string,
-          watch: [:string, :keep],
           db_volume: :string
         ]
       )
 
     database = opts[:database] || "postgres"
-    folder_to_watch = Keyword.get_values(opts, :watch)
     db_volume = opts[:db_volume]
 
     # Determine sub_task and its args
@@ -43,41 +41,25 @@ defmodule Mix.Tasks.Testcontainers.Run do
         [] -> {"test", []}
       end
 
-    if Enum.empty?(folder_to_watch) do
-      IO.puts("No folders specified. Only running subtask '#{sub_task}'.")
-      run_sub_task_and_exit(database, sub_task, sub_task_args, db_volume)
-    else
-      check_folders_exist(folder_to_watch)
-      run_sub_task_and_watch(database, sub_task, sub_task_args, folder_to_watch, db_volume)
-    end
-  end
-
-  defp check_folders_exist(folders) do
-    Enum.each(folders, fn folder ->
-      unless File.dir?(folder) do
-        raise("Folder does not exist: #{folder}")
-      end
-    end)
+    run_sub_task_and_exit(database, sub_task, sub_task_args, db_volume)
   end
 
   @spec run_sub_task_and_exit(String.t(), String.t(), list(String.t()), String.t() | nil) :: no_return()
   defp run_sub_task_and_exit(database, sub_task, sub_task_args, db_volume) do
     {container, env} = setup_container(database, db_volume)
-    exit_code = run_mix_task(env, sub_task, sub_task_args)
-    Testcontainers.stop_container(container.container_id)
-    System.halt(exit_code)
-  end
 
-  defp run_sub_task_and_watch(database, sub_task, sub_task_args, folders, db_volume) do
-    {container, env} = setup_container(database, db_volume)
+    IO.puts("Starting in-process mix task: #{sub_task} #{Enum.join(sub_task_args, " ")}")
 
-    Enum.each(folders, fn folder ->
-      :fs.start_link(String.to_atom("watcher_" <> folder), Path.absname(folder))
-      :fs.subscribe(String.to_atom("watcher_" <> folder))
+    System.at_exit(fn _ ->
+      try do
+        Testcontainers.stop_container(container.container_id)
+      catch
+        _, _ -> :ok
+      end
     end)
 
-    run_mix_task(env, sub_task, sub_task_args)
-    loop(env, sub_task, sub_task_args, container)
+    Enum.each(env, fn {k, v} -> System.put_env(k, v) end)
+    Mix.Task.run(sub_task, sub_task_args)
   end
 
   defp setup_container(database, db_volume) do
@@ -88,13 +70,7 @@ defmodule Mix.Tasks.Testcontainers.Run do
           |> PostgresContainer.with_user("test")
           |> PostgresContainer.with_password("test")
           |> PostgresContainer.with_reuse(true)
-          |> (fn config ->
-                if db_volume do
-                  PostgresContainer.with_persistent_volume(config, db_volume)
-                else
-                  config
-                end
-              end).()
+          |> maybe_with_persistent_volume(db_volume, PostgresContainer)
 
         {:ok, container} = Testcontainers.start_container(container_def)
         port = PostgresContainer.port(container)
@@ -106,13 +82,7 @@ defmodule Mix.Tasks.Testcontainers.Run do
           |> MySqlContainer.with_user("test")
           |> MySqlContainer.with_password("test")
           |> MySqlContainer.with_reuse(true)
-          |> (fn config ->
-                if db_volume do
-                  MySqlContainer.with_persistent_volume(config, db_volume)
-                else
-                  config
-                end
-              end).()
+          |> maybe_with_persistent_volume(db_volume, MySqlContainer)
 
         {:ok, container} = Testcontainers.start_container(container_def)
         port = MySqlContainer.port(container)
@@ -123,52 +93,17 @@ defmodule Mix.Tasks.Testcontainers.Run do
     end
   end
 
-  defp create_env(port) do
-    [
-      {"DB_USER", "test"},
-      {"DB_PASSWORD", "test"},
-      {"DB_HOST", Testcontainers.get_host()},
-      {"DB_PORT", Integer.to_string(port)}
-    ]
-  end
-
-  defp run_mix_task(env, sub_task, sub_task_args) do
-    case System.cmd("mix", [sub_task] ++ sub_task_args,
-           env: env,
-           into: IO.stream(),
-           stderr_to_stdout: false
-         ) do
-      {_, exit_code} ->
-        if exit_code == 0 do
-          IO.puts("Task '#{sub_task}' completed successfully")
-        else
-          IO.puts(:stderr, "Mix task '#{sub_task}' failed with exit code: #{exit_code}")
-        end
-        exit_code
-    end
-  end
-
-  defp loop(env, sub_task, sub_task_args, container) do
-    receive do
-      {_watcher_process, {:fs, :file_event}, {changed_file, _type}} ->
-        IO.puts("#{changed_file} was updated, waiting for more changes...")
-        wait_for_changes(env, sub_task, sub_task_args, container)
-    after
-      5000 ->
-        loop(env, sub_task, sub_task_args, container)
+  defp maybe_with_persistent_volume(config, db_volume, module) do
+    if db_volume do
+      module.with_persistent_volume(config, db_volume)
+    else
+      config
     end
   end
 
-  defp wait_for_changes(env, sub_task, sub_task_args, container) do
-    receive do
-      {_watcher_process, {:fs, :file_event}, {changed_file, _type}} ->
-        IO.puts("#{changed_file} was updated, waiting for more changes...")
-        wait_for_changes(env, sub_task, sub_task_args, container)
-    after
-      1000 ->
-        IO.ANSI.clear()
-        run_mix_task(env, sub_task, sub_task_args)
-        loop(env, sub_task, sub_task_args, container)
-    end
+  defp create_env(port) do
+    [
+      {"DATABASE_URL", "ecto://test:test@#{Testcontainers.get_host()}:#{port}/test"}
+    ]
   end
 end

lib/util/constants.ex

@@ -2,7 +2,7 @@ defmodule Testcontainers.Constants do
   @moduledoc false
 
   def library_name, do: :testcontainers
-  def library_version, do: "1.13.0"
+  def library_version, do: "1.13.1"
   def ryuk_version, do: "0.11.0"
   def container_label, do: "org.testcontainers"
   def container_lang_label, do: "org.testcontainers.lang"

mix.exs

@@ -2,7 +2,7 @@ defmodule TestcontainersElixir.MixProject do
   use Mix.Project
 
   @app :testcontainers
-  @version "1.13.0"
+  @version "1.13.1"
   @source_url "https://github.com/testcontainers/testcontainers-elixir"
 
   def project do