|
| 1 | +defmodule Testcontainers.Compose.Cli do |
| 2 | + @moduledoc """ |
| 3 | + Subprocess wrapper for Docker Compose CLI interaction. |
| 4 | + """ |
| 5 | + |
| 6 | + require Logger |
| 7 | + |
| 8 | + alias Testcontainers.DockerCompose |
| 9 | + |
| 10 | + @doc """ |
| 11 | + Runs `docker compose up -d --wait` with the given compose configuration. |
| 12 | + """ |
| 13 | + def up(%DockerCompose{} = compose) do |
| 14 | + args = build_up_args(compose) |
| 15 | + |
| 16 | + case execute(compose, args) do |
| 17 | + {_output, 0} -> :ok |
| 18 | + {output, exit_code} -> {:error, {:compose_up_failed, exit_code, output}} |
| 19 | + end |
| 20 | + end |
| 21 | + |
| 22 | + @doc """ |
| 23 | + Runs `docker compose down` with the given compose configuration. |
| 24 | + """ |
| 25 | + def down(%DockerCompose{} = compose) do |
| 26 | + args = build_down_args(compose) |
| 27 | + |
| 28 | + case execute(compose, args) do |
| 29 | + {_output, 0} -> :ok |
| 30 | + {output, exit_code} -> {:error, {:compose_down_failed, exit_code, output}} |
| 31 | + end |
| 32 | + end |
| 33 | + |
| 34 | + @doc """ |
| 35 | + Runs `docker compose ps --format=json` and parses the output into a list of maps. |
| 36 | + """ |
| 37 | + def ps(%DockerCompose{} = compose) do |
| 38 | + args = build_ps_args(compose) |
| 39 | + |
| 40 | + case execute(compose, args) do |
| 41 | + {output, 0} -> {:ok, parse_ps_output(output)} |
| 42 | + {output, exit_code} -> {:error, {:compose_ps_failed, exit_code, output}} |
| 43 | + end |
| 44 | + end |
| 45 | + |
| 46 | + @doc """ |
| 47 | + Runs `docker compose pull` with the given compose configuration. |
| 48 | + """ |
| 49 | + def pull(%DockerCompose{} = compose) do |
| 50 | + args = build_pull_args(compose) |
| 51 | + |
| 52 | + case execute(compose, args) do |
| 53 | + {_output, 0} -> :ok |
| 54 | + {output, exit_code} -> {:error, {:compose_pull_failed, exit_code, output}} |
| 55 | + end |
| 56 | + end |
| 57 | + |
| 58 | + @doc """ |
| 59 | + Runs `docker compose logs <service>` and returns the output. |
| 60 | + """ |
| 61 | + def logs(%DockerCompose{} = compose, service_name) when is_binary(service_name) do |
| 62 | + args = build_logs_args(compose, service_name) |
| 63 | + |
| 64 | + case execute(compose, args) do |
| 65 | + {output, 0} -> {:ok, output} |
| 66 | + {output, exit_code} -> {:error, {:compose_logs_failed, exit_code, output}} |
| 67 | + end |
| 68 | + end |
| 69 | + |
| 70 | + # Command building functions - public for testability |
| 71 | + |
| 72 | + @doc """ |
| 73 | + Builds the argument list for `docker compose up`. |
| 74 | + """ |
| 75 | + def build_up_args(%DockerCompose{} = compose) do |
| 76 | + base_args(compose) ++ ["up", "-d", "--wait"] ++ build_args(compose) ++ compose.services |
| 77 | + end |
| 78 | + |
| 79 | + @doc """ |
| 80 | + Builds the argument list for `docker compose down`. |
| 81 | + """ |
| 82 | + def build_down_args(%DockerCompose{} = compose) do |
| 83 | + args = base_args(compose) ++ ["down"] |
| 84 | + |
| 85 | + if compose.remove_volumes do |
| 86 | + args ++ ["-v"] |
| 87 | + else |
| 88 | + args |
| 89 | + end |
| 90 | + end |
| 91 | + |
| 92 | + @doc """ |
| 93 | + Builds the argument list for `docker compose ps`. |
| 94 | + """ |
| 95 | + def build_ps_args(%DockerCompose{} = compose) do |
| 96 | + base_args(compose) ++ ["ps", "--format=json"] |
| 97 | + end |
| 98 | + |
| 99 | + @doc """ |
| 100 | + Builds the argument list for `docker compose pull`. |
| 101 | + """ |
| 102 | + def build_pull_args(%DockerCompose{} = compose) do |
| 103 | + base_args(compose) ++ ["pull"] |
| 104 | + end |
| 105 | + |
| 106 | + @doc """ |
| 107 | + Builds the argument list for `docker compose logs`. |
| 108 | + """ |
| 109 | + def build_logs_args(%DockerCompose{} = compose, service_name) do |
| 110 | + base_args(compose) ++ ["logs", service_name] |
| 111 | + end |
| 112 | + |
| 113 | + @doc """ |
| 114 | + Parses the JSON output from `docker compose ps`. |
| 115 | +
|
| 116 | + Each line is a separate JSON object with fields like Service, ID, State, Publishers. |
| 117 | + """ |
| 118 | + def parse_ps_output(output) when is_binary(output) do |
| 119 | + output |
| 120 | + |> String.trim() |
| 121 | + |> String.split("\n", trim: true) |
| 122 | + |> Enum.flat_map(fn line -> |
| 123 | + case Jason.decode(line) do |
| 124 | + {:ok, %{} = parsed} -> |
| 125 | + [parsed] |
| 126 | + |
| 127 | + {:ok, list} when is_list(list) -> |
| 128 | + list |
| 129 | + |
| 130 | + {:error, _} -> |
| 131 | + [] |
| 132 | + end |
| 133 | + end) |
| 134 | + end |
| 135 | + |
| 136 | + @doc """ |
| 137 | + Parses the Publishers field from a `docker compose ps` JSON entry |
| 138 | + into a list of `{container_port, host_port}` tuples. |
| 139 | + """ |
| 140 | + def parse_publishers(nil), do: [] |
| 141 | + def parse_publishers([]), do: [] |
| 142 | + |
| 143 | + def parse_publishers(publishers) when is_list(publishers) do |
| 144 | + publishers |
| 145 | + |> Enum.filter(fn pub -> |
| 146 | + published = Map.get(pub, "PublishedPort", 0) |
| 147 | + published != 0 |
| 148 | + end) |
| 149 | + |> Enum.map(fn pub -> |
| 150 | + target = Map.get(pub, "TargetPort", 0) |
| 151 | + published = Map.get(pub, "PublishedPort", 0) |
| 152 | + {target, published} |
| 153 | + end) |
| 154 | + |> Enum.uniq() |
| 155 | + end |
| 156 | + |
| 157 | + # Private functions |
| 158 | + |
| 159 | + defp base_args(%DockerCompose{} = compose) do |
| 160 | + args = ["compose"] |
| 161 | + |
| 162 | + args = |
| 163 | + if compose.project_name do |
| 164 | + args ++ ["-p", compose.project_name] |
| 165 | + else |
| 166 | + args |
| 167 | + end |
| 168 | + |
| 169 | + args = |
| 170 | + Enum.reduce(compose.compose_files, args, fn file, acc -> |
| 171 | + acc ++ ["-f", file] |
| 172 | + end) |
| 173 | + |
| 174 | + Enum.reduce(compose.profiles, args, fn profile, acc -> |
| 175 | + acc ++ ["--profile", profile] |
| 176 | + end) |
| 177 | + end |
| 178 | + |
| 179 | + defp build_args(%DockerCompose{} = compose) do |
| 180 | + args = [] |
| 181 | + |
| 182 | + args = |
| 183 | + if compose.build do |
| 184 | + args ++ ["--build"] |
| 185 | + else |
| 186 | + args |
| 187 | + end |
| 188 | + |
| 189 | + case compose.pull do |
| 190 | + :always -> args ++ ["--pull", "always"] |
| 191 | + :never -> args ++ ["--pull", "never"] |
| 192 | + :missing -> args |
| 193 | + end |
| 194 | + end |
| 195 | + |
| 196 | + defp execute(%DockerCompose{} = compose, args) do |
| 197 | + dir = resolve_directory(compose.filepath) |
| 198 | + env_vars = Enum.map(compose.env, fn {k, v} -> {to_string(k), to_string(v)} end) |
| 199 | + |
| 200 | + Logger.debug("Running: docker #{Enum.join(args, " ")} in #{dir}") |
| 201 | + |
| 202 | + System.cmd("docker", args, cd: dir, env: env_vars, stderr_to_stdout: true) |
| 203 | + end |
| 204 | + |
| 205 | + defp resolve_directory(filepath) do |
| 206 | + if File.dir?(filepath) do |
| 207 | + filepath |
| 208 | + else |
| 209 | + Path.dirname(filepath) |
| 210 | + end |
| 211 | + end |
| 212 | +end |
0 commit comments