Accept private docker registries

Author: pmarino90

.formatter.exs

@@ -5,12 +5,14 @@ locals_without_parens = [
   standalone: 1,
   app: 2,
   from_docker_image: 1,
+  docker_registry: 1,
   volume: 2,
+  env: 2,
   expose_port: 2
 ]
 
 [
-  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"],
+  inputs: ["{mix,.formatter,Makinafile}.exs", "{config,lib,test}/**/*.{ex,exs}"],
   locals_without_parens: locals_without_parens,
   export: [
     locals_without_parens: locals_without_parens

lib/makina/applications.ex

@@ -42,18 +42,33 @@ defmodule Makina.Applications do
   defp deploy_application_on_server(%Server{} = server, %Application{} = app) do
     IO.puts("Deploying \"#{app.name}\"...")
 
-    case Docker.inspect(server, app) |> SSH.execute() do
-      {:ok, nil} ->
-        Logger.debug("No current instances of #{app.name} running, deploying")
-
-        Docker.run(server, app) |> SSH.execute()
+    with {:ok, _} <- maybe_login_to_registry(server, app),
+         {:ok, nil} <- ensure_app_not_running(server, app) do
+      Logger.debug("No current instances of #{app.name} running, deploying")
 
+      Docker.run(server, app) |> SSH.execute()
+    else
       {:ok, _container} ->
         Logger.debug("A version of #{app.name} is already running, skipping.")
         {:ok, :skipping}
 
       {:error, reason} ->
         {:error, reason}
+
+      err ->
+        err
+    end
+  end
+
+  defp ensure_app_not_running(server, app) do
+    Docker.inspect(server, app) |> SSH.execute()
+  end
+
+  defp maybe_login_to_registry(server, app) do
+    if Application.private_docker_registry?(app) do
+      Docker.login(server, app) |> SSH.execute()
+    else
+      {:ok, :no_login}
     end
   end
 end

lib/makina/docker.ex

@@ -1,5 +1,5 @@
 defmodule Makina.Docker do
-  @doc """
+  @moduledoc """
   Module that contains all docker-related cli command building functions.
   On their own these do not do anything except returning a correctly formatted
   command that should then be executed over SSH.
@@ -8,6 +8,9 @@ defmodule Makina.Docker do
   alias Makina.Models.Server
   alias Makina.Models.Application
 
+  @doc """
+  Prepares `docker run` command based on the application being deployed
+  """
   def run(%Server{} = server, %Application{} = app) do
     docker(server, "run", [
       "-d",
@@ -26,6 +29,9 @@ defmodule Makina.Docker do
     ])
   end
 
+  @doc """
+  Prepares the `docker inspect` command for a give container
+  """
   def inspect(%Server{} = server, %Application{} = app) do
     docker(server, "inspect", [app_name(app)], fn
       {:ok, result} ->
@@ -41,6 +47,16 @@ defmodule Makina.Docker do
     end)
   end
 
+  def login(%Server{} = server, %Application{} = app) do
+    docker(server, "login", [
+      app.docker_registry.host,
+      "-u",
+      app.docker_registry.user,
+      "-p",
+      app.docker_registry.password
+    ])
+  end
+
   defp app_name(%Application{__scope__: []} = app) do
     app.name
   end
@@ -96,7 +112,7 @@ defmodule Makina.Docker do
   defp ports(%Application{} = app) do
     app.exposed_ports
     |> Enum.flat_map(fn p ->
-      ["-p", "#{p.internal}:#{p.external}"]
+      ["-p", "#{p.external}:#{p.internal}"]
     end)
   end
 

lib/makina/dsl/app.ex

@@ -35,6 +35,32 @@ defmodule Makina.DSL.App do
     end
   end
 
+  @docker_registry_opts [
+    host: [type: :string, required: true],
+    user: [type: :string, required: true],
+    password: [type: :string, required: true]
+  ]
+
+  defmacro docker_registry(opts) do
+    schema = @docker_registry_opts
+
+    quote do
+      validation = NimbleOptions.validate(unquote(opts), unquote(schema))
+
+      case validation do
+        {:ok, opts} ->
+          @current_application Application.set_docker_registry(@current_application, opts)
+
+        {:error, error} ->
+          raise """
+            The parameters provided to the `docker_registry` statement are not correct:
+
+            #{Exception.message(error)}
+          """
+      end
+    end
+  end
+
   @doc """
   Mounts a volume to the given app.
 
@@ -73,13 +99,35 @@ defmodule Makina.DSL.App do
   end
   ```
   """
-  defmacro expose_port(internal, external)
-           when is_number(internal) and is_number(external) do
+  defmacro expose_port(external, internal) do
     quote bind_quoted: [internal: internal, external: external] do
       @current_application Application.put_exposed_port(@current_application,
                              internal: internal,
                              external: external
                            )
     end
   end
+
+  @doc """
+    Adds an environment variable to the running application
+
+  ## Usage
+  ```elixir
+  makina "example" do
+    app name: "foo" do
+
+    env "FOO", "BAR"
+
+    end
+  end
+  ```
+  """
+  defmacro env(key, value) do
+    quote bind_quoted: [key: key, value: value] do
+      @current_application Application.put_environment(@current_application,
+                             key: key,
+                             value: value
+                           )
+    end
+  end
 end

lib/makina/dsl/secrets.ex

@@ -9,7 +9,7 @@ defmodule Makina.DSL.Secrets do
       Note: This refers to the environment in which the `makina` command is run.
       """
     ],
-    "1password": [
+    one_password: [
       type: :non_empty_keyword_list,
       keys: [
         vault: [type: :string],

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 exposed_ports]a
+  @hashable_keys ~w[name docker_image docker_registry env_vars volumes exposed_ports]a
 
   @derive {JSON.Encoder, []}
   defstruct __hash__: nil,
@@ -43,6 +43,7 @@ defmodule Makina.Models.Application do
             __scope__: [],
             name: nil,
             docker_image: nil,
+            docker_registry: nil,
             volumes: [],
             env_vars: [],
             exposed_ports: []
@@ -77,12 +78,27 @@ defmodule Makina.Models.Application do
   end
 
   def set_docker_image(%__MODULE__{} = app, image) when is_list(image) do
-    image = Enum.into(image, %{})
+    image = image |> Enum.into(%{})
     app = %__MODULE__{app | docker_image: image}
 
     set_private(app, :__hash__, hash(app))
   end
 
+  def set_docker_registry(%__MODULE__{} = app, registry) when is_list(registry) do
+    registry = registry |> Enum.into(%{})
+    app = %__MODULE__{app | docker_registry: registry}
+
+    set_private(app, :__hash__, hash(app))
+  end
+
+  def private_docker_registry?(%__MODULE__{docker_registry: nil}) do
+    false
+  end
+
+  def private_docker_registry?(%__MODULE__{docker_registry: docker_registry}) do
+    not (is_nil(docker_registry.user) and is_nil(docker_registry.password))
+  end
+
   def set_private(%__MODULE{} = app, key, value) do
     app |> Map.put(key, value)
   end

lib/makina/secret_provider.ex

@@ -11,7 +11,7 @@ defmodule Makina.SecretProvider do
 
   @providers %{
     environment: Makina.SecretProvider.Environment,
-    "1password": Makina.SecretProvider.OnePassword
+    one_password: Makina.SecretProvider.OnePassword
   }
 
   @doc """

test/makina/dsl_test.exs

@@ -146,7 +146,7 @@ defmodule Makina.DSLTest do
 
       port = List.first(app.exposed_ports)
 
-      assert port == %{internal: 8080, external: 80}
+      assert port == %{internal: 80, external: 8080}
     end
 
     test "raises if app block is not invoked correctly" do

test/makina/models/application_test.exs

@@ -48,6 +48,29 @@ defmodule Makina.Models.ApplicationTest do
     end
   end
 
+  describe "set_docker_registry/2" do
+    test "sets the docker registry with credentials" do
+      params = [name: "foo"]
+
+      app = Application.new(params)
+      init_hash = app.__hash__
+
+      assert app.docker_image == nil
+
+      app =
+        app
+        |> Application.set_docker_registry(host: "ghcr.io", user: "foo", password: "bar")
+
+      assert app.docker_registry == %{
+               host: "ghcr.io",
+               user: "foo",
+               password: "bar"
+             }
+
+      assert app.__hash__ != init_hash
+    end
+  end
+
   describe "put_environment/2" do
     test "adds environment variables to the application" do
       params = [name: "foo"]

test/makina/models/docker_test.exs

@@ -113,12 +113,31 @@ defmodule Makina.Models.DockerTest do
       app =
         Application.new(name: "foo")
         |> Application.set_docker_image(name: "nginx", tag: "1.16")
-        |> Application.put_exposed_port(internal: 80, external: 80)
+        |> Application.put_exposed_port(internal: 80, external: 8080)
 
       cmd = Docker.run(server, app)
 
       assert cmd.cmd ==
-               "docker run -d --restart unless-stopped --name foo --label org.makina.app.hash=#{app.__hash__} -p 80:80 nginx:1.16"
+               "docker run -d --restart unless-stopped --name foo --label org.makina.app.hash=#{app.__hash__} -p 8080:80 nginx:1.16"
+    end
+  end
+
+  describe "login/2" do
+    test "returns a command to login into a private registry" do
+      server =
+        Server.new(host: "example.com")
+        |> Server.put_private(:conn_ref, self())
+
+      app =
+        Application.new(name: "foo")
+        |> Application.set_docker_registry(host: "ghcr.io", user: "user", password: "password")
+        |> Application.set_docker_image(name: "nginx", tag: "1.16")
+
+      cmd = Docker.login(server, app)
+
+      assert is_struct(cmd, Makina.Command)
+
+      assert cmd.cmd == "docker login ghcr.io -u user -p password"
     end
   end
 end