vagrant-docker-hosts-manager 0.2.0

data/lib/vagrant-docker-hosts-manager/config.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module VagrantDockerHostsManager
+  class Config < Vagrant.plugin("2", :config)
+    attr_accessor :domains
+
+    attr_accessor :domain
+
+    attr_accessor :container_name
+
+    attr_accessor :ip
+
+    attr_accessor :verbose
+
+    def initialize
+      @domains        = {}
+      @domain         = nil
+      @container_name = nil
+      @ip             = nil
+      @verbose        = false
+    end
+
+    def finalize!; end
+
+    def validate(_machine)
+      errors = []
+      if (@domains.nil? || @domains.empty?) && (@domain.nil? || @domain.strip.empty?)
+        errors << "You must configure at least one domain: " \
+                  "`config.docker_hosts.domain = \"example.test\"` or set " \
+                  "`config.docker_hosts.domains = {\"example.test\" => \"172.28.0.10\"}`"
+      end
+
+      unless @domains.is_a?(Hash)
+        errors << "`domains` must be a Hash of { \\\"domain\\\" => \\\"ip\\\" }"
+      end
+
+      if @ip && !@ip.to_s.match?(/\A\d{1,3}(\.\d{1,3}){3}\z/)
+        errors << "`ip` must be IPv4 like 172.28.0.10"
+      end
+
+      { "vagrant-docker-hosts-manager" => errors }
+    end
+  end
+end

data/lib/vagrant-docker-hosts-manager/helpers.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "i18n"
+
+module VagrantDockerHostsManager
+  module UiHelpers
+    EMOJI = {
+      success:  "✅",
+      info:     "🔍",
+      ongoing:  "🔁",
+      warning:  "⚠️",
+      error:    "❌",
+      version:  "💾",
+      broom:    "🧹",
+      question: "❓",
+      bug:      "🐛"
+    }.freeze
+
+    module_function
+
+    def e(key, no_emoji: false)
+      return "" if no_emoji || ENV["VDHM_NO_EMOJI"] == "1"
+      EMOJI[key] || ""
+    end
+
+    def debug_enabled?
+      ENV["VDHM_DEBUG"].to_s == "1"
+    end
+
+    def t(key, **opts)  = ::I18n.t(key, **opts)
+    def exists?(key)    = ::I18n.exists?(key, ::I18n.locale)
+
+    def say(ui, msg)    = (ui&.info(msg)  || puts(msg))
+    def warn(ui, msg)   = (ui&.warn(msg)  || puts(msg))
+    def error(ui, msg)  = (ui&.error(msg) || warn(ui, msg))
+
+    def debug(ui, msg)
+      return unless debug_enabled?
+      say(ui, "#{e(:bug)} #{msg}")
+    end
+  end
+end

data/lib/vagrant-docker-hosts-manager/plugin.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require "vagrant"
+require "i18n"
+
+require_relative "version"
+require_relative "config"
+require_relative "command"
+require_relative "helpers"
+require_relative "util/hosts_file"
+require_relative "util/docker"
+require_relative "util/json"
+require_relative "util/i18n"
+
+begin
+  I18n.enforce_available_locales = false
+  gem_root = File.expand_path("../..", __dir__)
+  I18n.load_path |= Dir[File.join(gem_root, "locales", "*.yml")]
+  I18n.backend.load_translations
+rescue StandardError
+end
+
+module VagrantDockerHostsManager
+  class Plugin < Vagrant.plugin("2")
+    name "vagrant-docker-hosts-manager"
+
+    description <<~DESC
+      Manage /etc/hosts (or Windows hosts) entries for Docker/Vagrant projects safely,
+      with ownership markers, CLI, JSON output, and lifecycle hooks.
+    DESC
+
+    config(:docker_hosts) do
+      Config
+    end
+
+    command("hosts") do
+      Command
+    end
+
+    [:machine_action_up, :machine_action_provision, :machine_action_reload].each do |hook_name|
+      action_hook(:vdhm_apply, hook_name) do |hook|
+        hook.after(Vagrant::Action::Builtin::Provision, Action::Apply)
+        hook.append(Action::Apply)
+      end
+    end
+
+    action_hook(:vdhm_cleanup, :machine_action_destroy) do |hook|
+      hook.prepend(Action::Cleanup)
+    end
+  end
+
+  module Action
+    class Apply
+      def initialize(app, env) = (@app = app)
+
+      def call(env)
+        Util::I18n.setup!(env)
+        cfg    = env[:machine].config.docker_hosts
+        mid    = env[:machine].id || "unknown"
+        dry    = Util::I18n.env_flag("VDHM_DRY_RUN")
+        ui     = env[:ui]
+        hoster = Util::HostsFile.new(env, owner_id: mid)
+
+        entries = compute_entries(env, cfg, ui)
+        if entries.empty?
+          ui.info(::I18n.t("messages.no_entries"))
+          return @app.call(env)
+        end
+
+        if dry
+          Util::Json.emit(action: "apply", status: "dry-run", data: { owner: mid, entries: entries })
+          return @app.call(env)
+        end
+
+        hoster.apply(entries)
+        Util::Json.emit(action: "apply", status: "success", data: { owner: mid, entries: entries })
+      rescue => e
+        Util::Json.emit(action: "apply", status: "error", error: e.message, backtrace: e.backtrace&.first(3))
+        ui&.error("VDHM: #{e.message}") || puts("VDHM: #{e.message}")
+      ensure
+        @app.call(env)
+      end
+
+      private
+
+      def compute_entries(env, cfg, ui)
+        entries = {}
+
+        cfg.domains.each do |domain, ip|
+          next if domain.to_s.strip.empty?
+          if ip.nil? || ip.to_s.strip.empty?
+            ui&.warn(::I18n.t("messages.missing_ip_for", domain: domain))
+            next
+          end
+          entries[domain] = ip
+        end
+
+        if cfg.domain && !cfg.domain.strip.empty?
+          ip = cfg.ip || begin
+            if cfg.container_name && !cfg.container_name.strip.empty?
+              Util::Docker.ip_for_container(cfg.container_name)
+            end
+          end
+          if ip && !ip.strip.empty?
+            ui&.info(::I18n.t("messages.detected_ip", domain: cfg.domain, ip: ip))
+            entries[cfg.domain] = ip
+          else
+            ui&.warn(::I18n.t("messages.no_ip_found", domain: cfg.domain, container: cfg.container_name))
+          end
+        end
+
+        entries
+      end
+    end
+
+    class Cleanup
+      def initialize(app, env) = (@app = app)
+
+      def call(env)
+        Util::I18n.setup!(env)
+        mid    = env[:machine].id || "unknown"
+        dry    = Util::I18n.env_flag("VDHM_DRY_RUN")
+        ui     = env[:ui]
+        hoster = Util::HostsFile.new(env, owner_id: mid)
+
+        if dry
+          Util::Json.emit(action: "cleanup", status: "dry-run", data: { owner: mid })
+          return @app.call(env)
+        end
+
+        removed = hoster.remove!
+        Util::Json.emit(action: "cleanup", status: "success", data: { owner: mid, removed: removed })
+        ui.info(::I18n.t("messages.cleaned"))
+      rescue => e
+        Util::Json.emit(action: "cleanup", status: "error", error: e.message)
+        ui.error("VDHM: #{e.message}")
+      ensure
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/vagrant-docker-hosts-manager/util/docker.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "open3"
+
+module VagrantDockerHostsManager
+  module Util
+    module Docker
+      module_function
+
+      def ip_for_container(name)
+        return nil if name.to_s.strip.empty?
+        cmd = %(docker inspect -f "{{range .NetworkSettings.Networks}}{{.IPAddress}} {{end}}" #{shell_escape(name)})
+        out, _err, status = Open3.capture3(cmd)
+        return nil unless status.success?
+        out.split(/\s+/).find { |ip| ip =~ /\A\d{1,3}(\.\d{1,3}){3}\z/ }
+      rescue
+        nil
+      end
+
+      def shell_escape(str)
+        if Gem.win_platform?
+          %("#{str.gsub('"', '\"')}")
+        else
+          %('#{str.gsub("'", "'\\\\''")}')
+        end
+      end
+    end
+  end
+end