Packages
testcontainer_formulas
1.0.0
Ready-to-use, fully customizable Testcontainer formulas for Gleam (postgres, redis, …).
Current section
Files
Jump to
Current section
Files
src/testcontainer_formulas@postgres.erl
-module(testcontainer_formulas@postgres).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/testcontainer_formulas/postgres.gleam").
-export([new/0, with_image/2, with_version/2, with_database/2, with_username/2, with_password/2, with_secret_password/2, with_extra_wait/2, on_network/2, on_network_name/2, with_name/2, formula/1]).
-export_type([postgres_container/0, postgres_config/0]).
-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.
?MODULEDOC(
" Postgres formula. Defaults to `postgres:16-alpine`, database `postgres`,\n"
" user `postgres`, password `postgres`.\n"
"\n"
" use pg <- testcontainer.with_formula(\n"
" postgres.new()\n"
" |> postgres.with_database(\"myapp_test\")\n"
" |> postgres.with_password(\"secret\")\n"
" |> postgres.formula(),\n"
" )\n"
"\n"
" // pg.connection_url, pg.host, pg.port, pg.database, pg.username\n"
).
-type postgres_container() :: {postgres_container,
testcontainer@container:container(),
binary(),
binary(),
integer(),
binary(),
binary()}.
-opaque postgres_config() :: {postgres_config,
binary(),
binary(),
binary(),
cowl:secret(binary()),
gleam@option:option(testcontainer@wait:wait_strategy()),
gleam@option:option(binary()),
gleam@option:option(binary())}.
-file("src/testcontainer_formulas/postgres.gleam", 51).
?DOC(" Sensible defaults: `postgres:16-alpine` / `postgres` / `postgres` / `postgres`.\n").
-spec new() -> postgres_config().
new() ->
{postgres_config,
<<"postgres:16-alpine"/utf8>>,
<<"postgres"/utf8>>,
<<"postgres"/utf8>>,
cowl:secret(<<"postgres"/utf8>>),
none,
none,
none}.
-file("src/testcontainer_formulas/postgres.gleam", 64).
?DOC(" Replaces the image entirely (e.g. for hardened images or different bases).\n").
-spec with_image(postgres_config(), binary()) -> postgres_config().
with_image(C, Image) ->
{postgres_config,
Image,
erlang:element(3, C),
erlang:element(4, C),
erlang:element(5, C),
erlang:element(6, C),
erlang:element(7, C),
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 69).
?DOC(" Shorthand: keep `postgres:` prefix, override only the tag.\n").
-spec with_version(postgres_config(), binary()) -> postgres_config().
with_version(C, Version) ->
{postgres_config,
<<"postgres:"/utf8, Version/binary>>,
erlang:element(3, C),
erlang:element(4, C),
erlang:element(5, C),
erlang:element(6, C),
erlang:element(7, C),
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 73).
-spec with_database(postgres_config(), binary()) -> postgres_config().
with_database(C, Db) ->
{postgres_config,
erlang:element(2, C),
Db,
erlang:element(4, C),
erlang:element(5, C),
erlang:element(6, C),
erlang:element(7, C),
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 77).
-spec with_username(postgres_config(), binary()) -> postgres_config().
with_username(C, User) ->
{postgres_config,
erlang:element(2, C),
erlang:element(3, C),
User,
erlang:element(5, C),
erlang:element(6, C),
erlang:element(7, C),
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 81).
-spec with_password(postgres_config(), binary()) -> postgres_config().
with_password(C, Pass) ->
{postgres_config,
erlang:element(2, C),
erlang:element(3, C),
erlang:element(4, C),
cowl:secret(Pass),
erlang:element(6, C),
erlang:element(7, C),
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 85).
-spec with_secret_password(postgres_config(), cowl:secret(binary())) -> postgres_config().
with_secret_password(C, Pass) ->
{postgres_config,
erlang:element(2, C),
erlang:element(3, C),
erlang:element(4, C),
Pass,
erlang:element(6, C),
erlang:element(7, C),
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 94).
?DOC(
" Adds an extra wait strategy on top of the default\n"
" `log(\"database system is ready to accept connections\")`.\n"
).
-spec with_extra_wait(postgres_config(), testcontainer@wait:wait_strategy()) -> postgres_config().
with_extra_wait(C, S) ->
{postgres_config,
erlang:element(2, C),
erlang:element(3, C),
erlang:element(4, C),
erlang:element(5, C),
{some, S},
erlang:element(7, C),
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 103).
?DOC(
" Attaches the container to the given network (typically built by\n"
" `testcontainer.with_network/2` or `testcontainer.with_stack/2`).\n"
).
-spec on_network(postgres_config(), testcontainer@network:network()) -> postgres_config().
on_network(C, Net) ->
{postgres_config,
erlang:element(2, C),
erlang:element(3, C),
erlang:element(4, C),
erlang:element(5, C),
erlang:element(6, C),
{some, testcontainer@network:name(Net)},
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 108).
?DOC(" Same as `on_network/2` when you already have the Docker network name.\n").
-spec on_network_name(postgres_config(), binary()) -> postgres_config().
on_network_name(C, Net) ->
{postgres_config,
erlang:element(2, C),
erlang:element(3, C),
erlang:element(4, C),
erlang:element(5, C),
erlang:element(6, C),
{some, Net},
erlang:element(8, C)}.
-file("src/testcontainer_formulas/postgres.gleam", 114).
?DOC(
" Names the container so other containers on the same network can reach\n"
" it (e.g. `\"db\"` → `db:5432`).\n"
).
-spec with_name(postgres_config(), binary()) -> postgres_config().
with_name(C, N) ->
{postgres_config,
erlang:element(2, C),
erlang:element(3, C),
erlang:element(4, C),
erlang:element(5, C),
erlang:element(6, C),
erlang:element(7, C),
{some, N}}.
-file("src/testcontainer_formulas/postgres.gleam", 120).
?DOC(
" Builds the `Formula(PostgresContainer)` ready to pass to\n"
" `testcontainer.with_formula/2`.\n"
).
-spec formula(postgres_config()) -> testcontainer@formula:formula(postgres_container()).
formula(C) ->
Pg_port = testcontainer@port:tcp(5432),
Base_wait = testcontainer@wait:log(
<<"database system is ready to accept connections"/utf8>>
),
Wait_strategy = case erlang:element(6, C) of
none ->
Base_wait;
{some, Extra} ->
testcontainer@wait:all_of([Base_wait, Extra])
end,
With_creds = begin
_pipe = testcontainer@container:new(erlang:element(2, C)),
_pipe@1 = testcontainer@container:expose_port(_pipe, Pg_port),
_pipe@2 = testcontainer@container:with_env(
_pipe@1,
<<"POSTGRES_DB"/utf8>>,
erlang:element(3, C)
),
_pipe@3 = testcontainer@container:with_env(
_pipe@2,
<<"POSTGRES_USER"/utf8>>,
erlang:element(4, C)
),
_pipe@4 = testcontainer@container:with_secret_env(
_pipe@3,
<<"POSTGRES_PASSWORD"/utf8>>,
erlang:element(5, C)
),
testcontainer@container:wait_for(_pipe@4, Wait_strategy)
end,
With_net = case erlang:element(7, C) of
none ->
With_creds;
{some, N} ->
_pipe@5 = With_creds,
testcontainer@container:on_network(_pipe@5, N)
end,
Final_spec = case erlang:element(8, C) of
none ->
With_net;
{some, N@1} ->
_pipe@6 = With_net,
testcontainer@container:with_name(_pipe@6, N@1)
end,
testcontainer@formula:new(
Final_spec,
fun(Running) ->
gleam@result:'try'(
testcontainer@container:host_port(Running, Pg_port),
fun(Mapped_port) ->
Host = testcontainer@container:host(Running),
Pass = cowl:reveal(erlang:element(5, C)),
{ok,
{postgres_container,
Running,
<<<<<<<<<<<<<<<<<<"postgresql://"/utf8,
(gleam_stdlib:percent_encode(
erlang:element(
4,
C
)
))/binary>>/binary,
":"/utf8>>/binary,
(gleam_stdlib:percent_encode(
Pass
))/binary>>/binary,
"@"/utf8>>/binary,
Host/binary>>/binary,
":"/utf8>>/binary,
(erlang:integer_to_binary(Mapped_port))/binary>>/binary,
"/"/utf8>>/binary,
(gleam_stdlib:percent_encode(
erlang:element(3, C)
))/binary>>,
Host,
Mapped_port,
erlang:element(3, C),
erlang:element(4, C)}}
end
)
end
).