Expose ports

Author: pmarino90

.formatter.exs

@@ -5,7 +5,8 @@ locals_without_parens = [
   standalone: 1,
   app: 2,
   from_docker_image: 1,
-  volume: 2
+  volume: 2,
+  expose_port: 2
 ]
 
 [

lib/makina/docker.ex

@@ -12,11 +12,12 @@ defmodule Makina.Docker do
     docker(server, "run", [
       "-d",
       "--restart",
-      "always",
+      "unless-stopped",
       name(app),
       labels(app),
       volumes(app),
       envs(app),
+      ports(app),
       image(app),
 
       # should always be the last one as it provides additional parameters
@@ -92,6 +93,13 @@ defmodule Makina.Docker do
     end)
   end
 
+  defp ports(%Application{} = app) do
+    app.exposed_ports
+    |> Enum.flat_map(fn p ->
+      ["--port", "#{p.internal}:#{p.external}"]
+    end)
+  end
+
   defp command(%Application{} = app) do
     app.__docker__.command
   end

lib/makina/dsl/app.ex

@@ -35,6 +35,20 @@ defmodule Makina.DSL.App do
     end
   end
 
+  @doc """
+  Mounts a volume to the given app.
+
+  ## Usage
+  ```elixir
+  makina "example" do
+    app name: "foo" do
+
+    volume "source", "destination"
+
+    end
+  end
+  ```
+  """
   defmacro volume(source, destination) when is_binary(source) and is_binary(destination) do
     quote bind_quoted: [source: source, destination: destination] do
       @current_application Application.put_volume(@current_application,
@@ -43,4 +57,29 @@ defmodule Makina.DSL.App do
                            )
     end
   end
+
+  @doc """
+  Exposes a port on the given app
+
+  ## Usage
+  ```elixir
+  makina "example" do
+    app name: "foo" do
+
+    # expose_port <internal port>, <external port>
+    expose_port 8080, 80
+
+    end
+  end
+  ```
+  """
+  defmacro expose_port(internal, external)
+           when is_number(internal) and is_number(external) do
+    quote bind_quoted: [internal: internal, external: external] do
+      @current_application Application.put_exposed_port(@current_application,
+                             internal: internal,
+                             external: external
+                           )
+    end
+  end
 end

lib/makina/models/application.ex

@@ -32,7 +32,7 @@ defmodule Makina.Models.Application do
 
   alias Makina.Models.Internal
 
-  @hashable_keys ~w[name docker_image env_vars volumes]a
+  @hashable_keys ~w[name docker_image env_vars volumes exposed_ports]a
 
   @derive {JSON.Encoder, []}
   defstruct __hash__: nil,
@@ -44,7 +44,8 @@ defmodule Makina.Models.Application do
             name: nil,
             docker_image: nil,
             volumes: [],
-            env_vars: []
+            env_vars: [],
+            exposed_ports: []
 
   def new(opts) do
     app = struct(__MODULE__, opts)
@@ -68,6 +69,13 @@ defmodule Makina.Models.Application do
     set_private(app, :__hash__, hash(app))
   end
 
+  def put_exposed_port(%__MODULE__{} = app, port) when is_list(port) do
+    port = Enum.into(port, %{})
+    app = %__MODULE__{app | exposed_ports: [port | app.exposed_ports]}
+
+    set_private(app, :__hash__, hash(app))
+  end
+
   def set_docker_image(%__MODULE__{} = app, image) when is_list(image) do
     image = Enum.into(image, %{})
     app = %__MODULE__{app | docker_image: image}

test/makina/dsl_test.exs

@@ -125,6 +125,30 @@ defmodule Makina.DSLTest do
       assert volume == %{source: "foo", destination: "/app/data"}
     end
 
+    test "allow exposed port to be specified" do
+      import DSL
+
+      term =
+        makina "app-test-specify-port" do
+          standalone do
+            app name: "test" do
+              expose_port 8080, 80
+            end
+          end
+        end
+
+      module = elem(term, 1)
+      context = module.collect_context()
+
+      app = List.first(context.standalone_applications)
+
+      assert is_list(app.exposed_ports)
+
+      port = List.first(app.exposed_ports)
+
+      assert port == %{internal: 8080, external: 80}
+    end
+
     test "raises if app block is not invoked correctly" do
       import DSL
 

test/makina/models/application_test.exs

@@ -64,6 +64,22 @@ defmodule Makina.Models.ApplicationTest do
     end
   end
 
+  describe "put_exposed_port/2" do
+    test "adds an exposed port pair to the list" do
+      params = [name: "foo"]
+
+      app = Application.new(params)
+      init_hash = app.__hash__
+
+      assert app.env_vars == []
+
+      app = app |> Application.put_exposed_port(internal: 80, external: 8080)
+
+      assert app.exposed_ports == [%{internal: 80, external: 8080}]
+      assert app.__hash__ != init_hash
+    end
+  end
+
   describe "set_private/3" do
     test "sets private fields" do
       params = [name: "foo"]

test/makina/models/docker_test.exs

@@ -41,7 +41,7 @@ defmodule Makina.Models.DockerTest do
       assert cmd.server == server
 
       assert cmd.cmd ==
-               "docker run -d --restart always --name foo --label org.makina.app.hash=#{app.__hash__} nginx:1.16"
+               "docker run -d --restart unless-stopped --name foo --label org.makina.app.hash=#{app.__hash__} nginx:1.16"
     end
 
     test "contains volumes" do
@@ -57,7 +57,7 @@ defmodule Makina.Models.DockerTest do
       cmd = Docker.run(server, app)
 
       assert cmd.cmd ==
-               "docker run -d --restart always --name foo --label org.makina.app.hash=#{app.__hash__} --volume foo:/app/data nginx:1.16"
+               "docker run -d --restart unless-stopped --name foo --label org.makina.app.hash=#{app.__hash__} --volume foo:/app/data nginx:1.16"
     end
 
     test "contains environment variables" do
@@ -73,36 +73,52 @@ defmodule Makina.Models.DockerTest do
       cmd = Docker.run(server, app)
 
       assert cmd.cmd ==
-               "docker run -d --restart always --name foo --label org.makina.app.hash=#{app.__hash__} --env ENV=prod nginx:1.16"
+               "docker run -d --restart unless-stopped --name foo --label org.makina.app.hash=#{app.__hash__} --env ENV=prod nginx:1.16"
     end
-  end
 
-  test "contains command arguments" do
-    server =
-      Server.new(host: "example.com")
-      |> Server.put_private(:conn_ref, self())
-
-    app =
-      Application.new(name: "foo")
-      |> Application.set_docker_image(name: "traefik", tag: "v3.3")
-      |> Application.put_volume(
-        source: "/var/run/docker.sock",
-        destination: "/var/run/docker.sock"
-      )
-
-    app =
-      app
-      |> Application.set_private(:__docker__, %{
-        app.__docker__
-        | command: [
-            "--api.insecure=true",
-            "--providers.docker"
-          ]
-      })
-
-    cmd = Docker.run(server, app)
-
-    assert cmd.cmd ==
-             "docker run -d --restart always --name foo --label org.makina.app.hash=#{app.__hash__} --volume /var/run/docker.sock:/var/run/docker.sock traefik:v3.3 --api.insecure=true --providers.docker"
+    test "contains command arguments" do
+      server =
+        Server.new(host: "example.com")
+        |> Server.put_private(:conn_ref, self())
+
+      app =
+        Application.new(name: "foo")
+        |> Application.set_docker_image(name: "traefik", tag: "v3.3")
+        |> Application.put_volume(
+          source: "/var/run/docker.sock",
+          destination: "/var/run/docker.sock"
+        )
+
+      app =
+        app
+        |> Application.set_private(:__docker__, %{
+          app.__docker__
+          | command: [
+              "--api.insecure=true",
+              "--providers.docker"
+            ]
+        })
+
+      cmd = Docker.run(server, app)
+
+      assert cmd.cmd ==
+               "docker run -d --restart unless-stopped --name foo --label org.makina.app.hash=#{app.__hash__} --volume /var/run/docker.sock:/var/run/docker.sock traefik:v3.3 --api.insecure=true --providers.docker"
+    end
+
+    test "contains exposed ports" do
+      server =
+        Server.new(host: "example.com")
+        |> Server.put_private(:conn_ref, self())
+
+      app =
+        Application.new(name: "foo")
+        |> Application.set_docker_image(name: "nginx", tag: "1.16")
+        |> Application.put_exposed_port(internal: 80, external: 80)
+
+      cmd = Docker.run(server, app)
+
+      assert cmd.cmd ==
+               "docker run -d --restart unless-stopped --name foo --label org.makina.app.hash=#{app.__hash__} --port 80:80 nginx:1.16"
+    end
   end
 end