Packages
testcontainer_formulas

1.0.0
Ready-to-use, fully customizable Testcontainer formulas for Gleam (postgres, redis, …).
HexDocs
Current section
Files
Jump to
Readme 1 Version 3 Dependencies Dependants Files Activity
testcontainer_formulas src testcontainer_formulas@mysql.erl
Raw
src/testcontainer_formulas@mysql.erl

-module(testcontainer_formulas@mysql).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/testcontainer_formulas/mysql.gleam").
-export([new/0, with_image/2, with_version/2, with_database/2, with_username/2, with_password/2, with_secret_password/2, with_root_password/2, with_secret_root_password/2, with_extra_wait/2, on_network/2, on_network_name/2, with_name/2, formula/1]).
-export_type([mysql_container/0, mysql_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(
    " MySQL formula. Defaults to `mysql:8.4` with app credentials.\n"
    "\n"
    "     use db <- testcontainer.with_formula(\n"
    "       mysql.new()\n"
    "       |> mysql.with_database(\"app_test\")\n"
    "       |> mysql.with_username(\"app\")\n"
    "       |> mysql.with_password(\"secret\")\n"
    "       |> mysql.formula(),\n"
    "     )\n"
    "\n"
    "     // db.connection_url, db.host, db.port, db.database, db.username\n"
).

-type mysql_container() :: {mysql_container,
        testcontainer@container:container(),
        binary(),
        binary(),
        integer(),
        binary(),
        binary()}.

-opaque mysql_config() :: {mysql_config,
        binary(),
        binary(),
        binary(),
        cowl:secret(binary()),
        cowl:secret(binary()),
        gleam@option:option(testcontainer@wait:wait_strategy()),
        gleam@option:option(binary()),
        gleam@option:option(binary())}.

-file("src/testcontainer_formulas/mysql.gleam", 52).
?DOC(" Sensible defaults: `mysql:8.4` / `app` / `app` / `root`.\n").
-spec new() -> mysql_config().
new() ->
    {mysql_config,
        <<"mysql:8.4"/utf8>>,
        <<"app"/utf8>>,
        <<"app"/utf8>>,
        cowl:secret(<<"app"/utf8>>),
        cowl:secret(<<"root"/utf8>>),
        none,
        none,
        none}.

-file("src/testcontainer_formulas/mysql.gleam", 66).
?DOC(" Replaces the image entirely.\n").
-spec with_image(mysql_config(), binary()) -> mysql_config().
with_image(C, Image) ->
    {mysql_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),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 71).
?DOC(" Shorthand: keep `mysql:` prefix, override only the tag.\n").
-spec with_version(mysql_config(), binary()) -> mysql_config().
with_version(C, Version) ->
    {mysql_config,
        <<"mysql:"/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),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 75).
-spec with_database(mysql_config(), binary()) -> mysql_config().
with_database(C, Db) ->
    {mysql_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),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 79).
-spec with_username(mysql_config(), binary()) -> mysql_config().
with_username(C, User) ->
    {mysql_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),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 83).
-spec with_password(mysql_config(), binary()) -> mysql_config().
with_password(C, Pass) ->
    {mysql_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),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 87).
-spec with_secret_password(mysql_config(), cowl:secret(binary())) -> mysql_config().
with_secret_password(C, Pass) ->
    {mysql_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),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 95).
?DOC(" Root password used by the MySQL image bootstrap.\n").
-spec with_root_password(mysql_config(), binary()) -> mysql_config().
with_root_password(C, Pass) ->
    {mysql_config,
        erlang:element(2, C),
        erlang:element(3, C),
        erlang:element(4, C),
        erlang:element(5, C),
        cowl:secret(Pass),
        erlang:element(7, C),
        erlang:element(8, C),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 100).
?DOC(" Same as `with_root_password/2` when the value is already a `cowl.Secret`.\n").
-spec with_secret_root_password(mysql_config(), cowl:secret(binary())) -> mysql_config().
with_secret_root_password(C, Pass) ->
    {mysql_config,
        erlang:element(2, C),
        erlang:element(3, C),
        erlang:element(4, C),
        erlang:element(5, C),
        Pass,
        erlang:element(7, C),
        erlang:element(8, C),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 112).
?DOC(
    " Adds an extra wait strategy on top of the default\n"
    " `log_times(\"MY-010931\", 2)`. `MY-010931` is the mysqld \"Server ready\"\n"
    " message id, emitted once by the temporary bootstrap server and again\n"
    " by the final TCP server — matching the second occurrence guarantees\n"
    " `MYSQL_USER` exists and the server is reachable on port 3306.\n"
).
-spec with_extra_wait(mysql_config(), testcontainer@wait:wait_strategy()) -> mysql_config().
with_extra_wait(C, S) ->
    {mysql_config,
        erlang:element(2, C),
        erlang:element(3, C),
        erlang:element(4, C),
        erlang:element(5, C),
        erlang:element(6, C),
        {some, S},
        erlang:element(8, C),
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 116).
-spec on_network(mysql_config(), testcontainer@network:network()) -> mysql_config().
on_network(C, Net) ->
    {mysql_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, testcontainer@network:name(Net)},
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 121).
?DOC(" Same as `on_network/2` when you already have the Docker network name.\n").
-spec on_network_name(mysql_config(), binary()) -> mysql_config().
on_network_name(C, Net) ->
    {mysql_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, Net},
        erlang:element(9, C)}.

-file("src/testcontainer_formulas/mysql.gleam", 125).
-spec with_name(mysql_config(), binary()) -> mysql_config().
with_name(C, N) ->
    {mysql_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),
        erlang:element(8, C),
        {some, N}}.

-file("src/testcontainer_formulas/mysql.gleam", 131).
?DOC(
    " Builds the `Formula(MysqlContainer)` ready to pass to\n"
    " `testcontainer.with_formula/2`.\n"
).
-spec formula(mysql_config()) -> testcontainer@formula:formula(mysql_container()).
formula(C) ->
    Mysql_port = testcontainer@port:tcp(3306),
    Base_wait = testcontainer@wait:log_times(<<"MY-010931"/utf8>>, 2),
    Wait_strategy = case erlang:element(7, 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, Mysql_port),
        _pipe@2 = testcontainer@container:with_env(
            _pipe@1,
            <<"MYSQL_DATABASE"/utf8>>,
            erlang:element(3, C)
        ),
        _pipe@3 = testcontainer@container:with_env(
            _pipe@2,
            <<"MYSQL_USER"/utf8>>,
            erlang:element(4, C)
        ),
        _pipe@4 = testcontainer@container:with_secret_env(
            _pipe@3,
            <<"MYSQL_PASSWORD"/utf8>>,
            erlang:element(5, C)
        ),
        _pipe@5 = testcontainer@container:with_secret_env(
            _pipe@4,
            <<"MYSQL_ROOT_PASSWORD"/utf8>>,
            erlang:element(6, C)
        ),
        testcontainer@container:wait_for(_pipe@5, Wait_strategy)
    end,
    With_net = case erlang:element(8, C) of
        none ->
            With_creds;

        {some, N} ->
            _pipe@6 = With_creds,
            testcontainer@container:on_network(_pipe@6, N)
    end,
    Final_spec = case erlang:element(9, C) of
        none ->
            With_net;

        {some, N@1} ->
            _pipe@7 = With_net,
            testcontainer@container:with_name(_pipe@7, N@1)
    end,
    testcontainer@formula:new(
        Final_spec,
        fun(Running) ->
            gleam@result:'try'(
                testcontainer@container:host_port(Running, Mysql_port),
                fun(Mapped_port) ->
                    Host = testcontainer@container:host(Running),
                    Pass = cowl:reveal(erlang:element(5, C)),
                    {ok,
                        {mysql_container,
                            Running,
                            <<<<<<<<<<<<<<<<<<"mysql://"/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
    ).
Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT