captive-cli 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f79f7992c692e80419a6da77317d0e3d50d72ee4b48d41ea6001fa3e8a968400
-  data.tar.gz: 43220b3bb3e0b9cdaae4bf96de10d80eb3145af3f52584bff1c73fb45d4e7349
+  metadata.gz: 377f77798282f817bcd1632482c5075ca10f8c65f1b5ce9abc4e7d3f1aeae2ee
+  data.tar.gz: ef1dc980b18c772c703a7b94ee35a3c35049b22d84ffeca742ee5ce569a32f7e
 SHA512:
-  metadata.gz: cec86c2467edb73bb4c46c520c2fb793c1c4b67800213d5ef68348aa2ddae4c91b25e85d82fe73e599fc7cb188aee96b63feb5674b10885e7aa7100027f240ac
-  data.tar.gz: a69f88f24623b2329515daff60be1df8d3092046c51cd20b995cb6a0ba58a176dc29898640a07cdc6d9904315b10a321b7d7f6cc9cb7c301e768e991d55a3980
+  metadata.gz: e058db4108f3da4be9dd9c6e5699f1cdb5419463cfe93300cd96dbd8bf612894f23bf97fab095480edc22e70a9c98f4e172e56edb78e8c1108bac3c66b1918be
+  data.tar.gz: 8f199adf232216645878442735570e5ee04a70dd4a8f43031bd0e24d67c12f7af7f5ab8ba7e4de2accfb6143a5801f09fa5b173cf80ed88a9e43ceff5d31a3f2

data/lib/captive/cli/dependencies.rb

@@ -24,6 +24,7 @@ module Captive
     def apps_api  = @apps_api  ||= Dashboard::AppsResource.new(api: dashboard)
     def env_api   = @env_api   ||= Dashboard::EnvVarsResource.new(api: dashboard)
     def crons_api = @crons_api ||= Dashboard::ScheduledTasksResource.new(api: dashboard)
+    def domains_api = @domains_api ||= Dashboard::DomainsResource.new(api: dashboard)
 
     def active_kubeconfig
       env_kc = ENV["KUBECONFIG"]

data/lib/captive/cli.rb

@@ -6,6 +6,7 @@ require_relative "cli/dependencies"
 require_relative "commands/apps_commands"
 require_relative "commands/env_commands"
 require_relative "commands/crons_commands"
+require_relative "commands/domains_commands"
 require_relative "commands/db_commands"
 require_relative "commands/user_login"
 require_relative "commands/auth_commands"
@@ -62,6 +63,9 @@ module Captive
     desc "crons SUBCOMMAND", "Tâches planifiées d'une app"
     subcommand "crons", Commands::CronsCommands
 
+    desc "domains SUBCOMMAND", "Domaines d'une app"
+    subcommand "domains", Commands::DomainsCommands
+
     desc "auth SUBCOMMAND", "Jeton pour kubectl", hide: true
     subcommand "auth", Commands::AuthCommands
 

data/lib/captive/commands/domain_announcer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "../errors"
+
+module Captive
+  module Commands
+    # Dit ce qu'est devenu un geste sur un Domaine. Sans attente, la demande est seulement
+    # acceptée ; avec une attente, le bloc la reçoit et rend le Domaine appliqué.
+    class DomainAnnouncer
+      def initialize(paint:, presenter:, waiter: nil)
+        @paint     = paint
+        @presenter = presenter
+        @waiter    = waiter
+      end
+
+      def call(message)
+        return puts(@paint.green("  ✓ #{message} : #{CLIDependencies::ASYNC_NOTICE}")) unless @waiter
+
+        applied(message, yield(@waiter))
+      rescue PollTimeout => timeout
+        abort @paint.red("✗ Timeout : #{timeout.message}")
+      end
+
+      private
+
+      def applied(message, entry)
+        puts @paint.green("  ✓ #{message} : appliqué")
+        puts "  #{@presenter.line(entry)}" if entry
+      end
+    end
+  end
+end

data/lib/captive/commands/domain_wait.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "../poller"
+require_relative "../errors"
+
+module Captive
+  module Commands
+    # Attend que le cluster reflète un geste sur un Domaine : ni en attente ni échoué, et
+    # présent (absent après une suppression). Le DNS n'entre pas en compte : il dépend du
+    # propriétaire du Domaine, pas de Captive.
+    class DomainWait
+      def initialize(domains:, poller: nil, timeout: 600)
+        @domains = domains
+        @poller  = poller || Poller.new(interval: 10, timeout: timeout)
+      end
+
+      # Rend le Domaine tel que le cluster le montre une fois le geste appliqué.
+      def until_applied(app, hostname)
+        entry = nil
+        poll(app, hostname) { |found| (entry = found) && !found["pending"] }
+        entry
+      end
+
+      def until_gone(app, hostname)
+        poll(app, hostname, &:nil?)
+        nil
+      end
+
+      private
+
+      def poll(app, hostname)
+        @poller.poll_until(context: "#{hostname} sur #{app}") do
+          yield check(hostname, @domains.find(app, hostname))
+        end
+      end
+
+      def check(hostname, entry)
+        return entry unless entry&.fetch("failed", false)
+
+        raise DomainChangeFailed, "#{hostname} : #{entry["failure_reason"] || "échec"}"
+      end
+    end
+  end
+end

data/lib/captive/commands/domains_commands.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Captive
+  module Commands
+    # Les Domaines d'une app via le dashboard. Chaque geste est appliqué plus tard par
+    # captive-platform ; --wait attend que le cluster le reflète.
+    class DomainsCommands < Thor
+      include CLIDependencies
+
+      def self.exit_on_failure? = true
+
+      WAIT_OPTIONS = {
+        wait:    { type: :boolean, desc: "Attend que le changement soit appliqué" },
+        timeout: { type: :numeric, default: 600, desc: "Attente max en secondes avec --wait" },
+      }.freeze
+
+      def self.wait_options
+        WAIT_OPTIONS.each { |name, settings| method_option(name, **settings) }
+      end
+
+      desc "list APP", "Liste les domaines de l'app et l'état de leur DNS"
+      long_desc <<~DESC
+        \x05Exemple :
+        \x05  captive domains list my-app
+        \x05  captive domains list my-app --refresh
+      DESC
+      method_option :refresh, type: :boolean, desc: "Vérifie à nouveau le DNS sans attendre le cache"
+      def list(app)
+        entries = options[:refresh] ? domains_api.recheck(app) : domains_api.list(app)
+        return puts(paint.dim("Aucun domaine.")) if entries.empty?
+
+        entries.each { |entry| puts presenter.line(entry) }
+      end
+
+      desc "add APP DOMAINE", "Ajoute un domaine à l'app"
+      long_desc <<~DESC
+        L'enregistrement DNS à créer s'affiche ensuite dans `captive domains list`.
+
+        \x05Exemple :
+        \x05  captive domains add my-app www.example.fr --wait
+      DESC
+      wait_options
+      def add(app, hostname)
+        domains_api.add(app, hostname)
+        announcer.call("#{hostname} ajouté") { |wait| wait.until_applied(app, hostname) }
+        puts paint.dim("  DNS à créer : captive domains list #{app}") unless options[:wait]
+      end
+
+      desc "rm APP DOMAINE", "Supprime un domaine de l'app"
+      long_desc <<~DESC
+        Le domaine cesse aussitôt de servir l'app : il faut le retaper pour confirmer.
+
+        \x05Exemple :
+        \x05  captive domains rm my-app www.example.fr
+        \x05  captive domains rm my-app www.example.fr --yes
+      DESC
+      method_option :yes, type: :boolean, desc: "Supprime sans demander de confirmation"
+      wait_options
+      def rm(app, hostname)
+        confirm_removal(hostname)
+        domains_api.remove(app, hostname)
+        announcer.call("#{hostname} supprimé") { |wait| wait.until_gone(app, hostname) }
+      end
+
+      desc "redirect APP DOMAINE", "Redirige un domaine vers un autre domaine de l'app"
+      long_desc <<~DESC
+        \x05Exemple :
+        \x05  captive domains redirect my-app example.fr --to www.example.fr
+      DESC
+      method_option :to, type: :string, required: true, desc: "Domaine servi vers lequel rediriger"
+      method_option :status, type: :numeric, default: 301, enum: [ 301, 302 ], desc: "Code HTTP de redirection"
+      wait_options
+      def redirect(app, hostname)
+        target = options[:to]
+        domains_api.redirect(app, hostname, { to: target, status: options[:status] })
+        announcer.call("#{hostname} redirigé vers #{target}") { |wait| wait.until_applied(app, hostname) }
+      end
+
+      desc "serve APP DOMAINE", "Repasse un domaine redirigé en domaine servi"
+      long_desc <<~DESC
+        \x05Exemple :
+        \x05  captive domains serve my-app example.fr
+      DESC
+      wait_options
+      def serve(app, hostname)
+        domains_api.serve(app, hostname)
+        announcer.call("#{hostname} servi") { |wait| wait.until_applied(app, hostname) }
+      end
+
+      private
+
+      def presenter = Presenter::Domain.new(paint: paint)
+      def domain_wait = DomainWait.new(domains: domains_api, timeout: options[:timeout])
+
+      def announcer
+        DomainAnnouncer.new(paint: paint, presenter: presenter, waiter: (domain_wait if options[:wait]))
+      end
+
+      def confirm_removal(hostname)
+        return if options[:yes]
+        return if ask("Retape #{hostname} pour confirmer la suppression :").to_s.strip == hostname
+
+        warn paint.red("Abandon : rien n'a été supprimé.")
+        exit 1
+      end
+    end
+  end
+end

data/lib/captive/dashboard/app_path.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Captive
+  module Dashboard
+    # Le chemin d'une collection rattachée à une app (`/apps/:app/<collection>`), et d'un de
+    # ses éléments, chaque segment encodé.
+    AppPath = Data.define(:collection) do
+      def call(app, key = nil)
+        base = "/apps/#{DashboardApi.segment(app)}/#{collection}"
+        key ? "#{base}/#{DashboardApi.segment(key)}" : base
+      end
+    end
+  end
+end

data/lib/captive/dashboard/domains_resource.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Captive
+  module Dashboard
+    # Les Domaines d'une app : lus du cluster, modifiés via captive-platform (réponse 202).
+    # `recheck` relit le DNS sans attendre le cache ; une redirection est `{ to:, status: }`.
+    class DomainsResource
+      PATH = AppPath.new("domains")
+
+      def initialize(api:)
+        @api = api
+      end
+
+      def list(app)                 = @api.get(path(app))
+      def recheck(app)              = @api.get("#{path(app)}?refresh=1")
+      def find(app, hostname)       = list(app).find { |domain| domain["hostname"] == hostname }
+      def add(app, hostname)        = @api.post(path(app), { hostname: hostname })
+      def remove(app, hostname)     = @api.delete(path(app, hostname))
+      def serve(app, hostname)      = @api.patch(path(app, hostname), { mode: "serve" })
+      def redirect(app, hostname, rule) = @api.patch(path(app, hostname), rule)
+
+      private
+
+      def path(...) = PATH.call(...)
+    end
+  end
+end

data/lib/captive/dashboard/env_vars_resource.rb

@@ -4,6 +4,8 @@ module Captive
   module Dashboard
     # Les variables d'environnement d'une app : lues du Secret, écrites par set-env.
     class EnvVarsResource
+      PATH = AppPath.new("env_vars")
+
       def initialize(api:)
         @api = api
       end
@@ -18,10 +20,7 @@ module Captive
 
       private
 
-      def path(app, key = nil)
-        base = "/apps/#{DashboardApi.segment(app)}/env_vars"
-        key ? "#{base}/#{DashboardApi.segment(key)}" : base
-      end
+      def path(...) = PATH.call(...)
     end
   end
 end

data/lib/captive/dashboard/scheduled_tasks_resource.rb

@@ -4,6 +4,8 @@ module Captive
   module Dashboard
     # Les tâches planifiées d'une app : lues du cluster, déclarées via captive-platform.
     class ScheduledTasksResource
+      PATH = AppPath.new("scheduled_tasks")
+
       def initialize(api:)
         @api = api
       end
@@ -23,10 +25,7 @@ module Captive
 
       private
 
-      def path(app, name = nil)
-        base = "/apps/#{DashboardApi.segment(app)}/scheduled_tasks"
-        name ? "#{base}/#{DashboardApi.segment(name)}" : base
-      end
+      def path(...) = PATH.call(...)
     end
   end
 end

data/lib/captive/errors.rb

@@ -24,4 +24,5 @@ module Captive
   class NotFoundError < DashboardError; end
   class ValidationError < DashboardError; end
   class ServiceUnavailableError < DashboardError; end
+  class DomainChangeFailed < DashboardError; end
 end

data/lib/captive/loader.rb

@@ -13,11 +13,14 @@ require_relative "one_off_spec"
 require_relative "session_id"
 require_relative "poller"
 require_relative "dashboard_api"
+require_relative "dashboard/app_path"
 require_relative "dashboard/apps_resource"
 require_relative "dashboard/env_vars_resource"
 require_relative "dashboard/scheduled_tasks_resource"
+require_relative "dashboard/domains_resource"
 require_relative "presenter/app_info"
 require_relative "presenter/scheduled_task"
+require_relative "presenter/domain"
 require_relative "activity_trail"
 require_relative "errors"
 require_relative "ui/spinner"
@@ -28,6 +31,8 @@ require_relative "commands/one_off_session"
 require_relative "commands/run"
 require_relative "commands/logs"
 require_relative "commands/apps_restart"
+require_relative "commands/domain_wait"
+require_relative "commands/domain_announcer"
 require_relative "commands/db_dump"
 require_relative "commands/db_restore"
 

data/lib/captive/presenter/domain.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Captive
+  module Presenter
+    # Une ligne par Domaine : son nom, son état (servi, redirigé, en attente, échoué) et ce que
+    # dit le DNS. Un geste en cours masque le diagnostic, qui ne vaut que pour l'état atteint.
+    class Domain
+      HEALTH = { "certificate_pending" => "certificat en cours", "invalid" => "route refusée" }.freeze
+
+      def initialize(paint:)
+        @paint = paint
+      end
+
+      def line(entry)
+        change = change(entry)
+        [ entry["hostname"], change || reached(entry), (health(entry) unless change) ].compact.join("  ")
+      end
+
+      private
+
+      # Un geste en attente ou échoué ; nil quand le Domaine est dans l'état demandé.
+      def change(entry)
+        return failure(entry) if entry["failed"]
+
+        @paint.yellow("en attente (#{entry["pending_change"]})") if entry["pending"]
+      end
+
+      def reached(entry)
+        redirect = entry["redirect"]
+        return "→ #{redirect["to"]} (#{redirect["status"]})" if redirect
+
+        entry["primary"] ? "servi, principal" : "servi"
+      end
+
+      def failure(entry)
+        reason = entry["failure_reason"]
+        @paint.red(reason ? "échoué : #{reason}" : "échoué")
+      end
+
+      def health(entry)
+        status = entry["health"]
+        return @paint.green("✓") if status == "valid"
+
+        expected = entry.dig("dns", "expected")
+        return @paint.red("DNS à créer : #{expected.values_at("type", "name").join(" ")} → #{expected["value"]}") if expected
+
+        @paint.yellow(HEALTH.fetch(status, status.to_s))
+      end
+    end
+  end
+end

data/lib/captive/shell_completions.rb

@@ -2,12 +2,13 @@
 
 module Captive
   module ShellCompletions
-    ROOT_COMMANDS = %w[apps env crons db login whoami console run logs version completions].freeze
+    ROOT_COMMANDS = %w[apps env crons domains db login whoami console run logs version completions].freeze
 
     SUBCOMMANDS = {
       "apps" => %w[list info restart rebuild],
       "env"  => %w[list set unset],
       "crons" => %w[list add edit rm suspend resume trigger runs],
+      "domains" => %w[list add rm redirect serve],
       "db"   => %w[restore],
     }.freeze
 
@@ -23,6 +24,7 @@ module Captive
             apps)  COMPREPLY=($(compgen -W "#{SUBCOMMANDS["apps"].join(" ")}" -- "$cur")); return ;;
             env)   COMPREPLY=($(compgen -W "#{SUBCOMMANDS["env"].join(" ")}" -- "$cur")); return ;;
             crons) COMPREPLY=($(compgen -W "#{SUBCOMMANDS["crons"].join(" ")}" -- "$cur")); return ;;
+            domains) COMPREPLY=($(compgen -W "#{SUBCOMMANDS["domains"].join(" ")}" -- "$cur")); return ;;
             db)    COMPREPLY=($(compgen -W "#{SUBCOMMANDS["db"].join(" ")}" -- "$cur")); return ;;
           esac
 

data/lib/captive/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Captive
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: captive-cli
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Captive Studio
@@ -120,6 +120,9 @@ files:
 - lib/captive/commands/db_psql.rb
 - lib/captive/commands/db_restore.rb
 - lib/captive/commands/db_target.rb
+- lib/captive/commands/domain_announcer.rb
+- lib/captive/commands/domain_wait.rb
+- lib/captive/commands/domains_commands.rb
 - lib/captive/commands/env_commands.rb
 - lib/captive/commands/env_set.rb
 - lib/captive/commands/logs.rb
@@ -128,7 +131,9 @@ files:
 - lib/captive/commands/user_login.rb
 - lib/captive/credentials.rb
 - lib/captive/credentials_store.rb
+- lib/captive/dashboard/app_path.rb
 - lib/captive/dashboard/apps_resource.rb
+- lib/captive/dashboard/domains_resource.rb
 - lib/captive/dashboard/env_vars_resource.rb
 - lib/captive/dashboard/scheduled_tasks_resource.rb
 - lib/captive/dashboard_api.rb
@@ -146,6 +151,7 @@ files:
 - lib/captive/poller.rb
 - lib/captive/presenter/ansi_stripper.rb
 - lib/captive/presenter/app_info.rb
+- lib/captive/presenter/domain.rb
 - lib/captive/presenter/log_colorizer.rb
 - lib/captive/presenter/log_line.rb
 - lib/captive/presenter/scheduled_task.rb