capistrano-data_plane_api 0.1.4 → 0.2.0

data/lib/capistrano/data_plane_api/deploy/server_stats.rb

@@ -1,3 +1,4 @@
+# typed: strict
 # frozen_string_literal: true
 
 module Capistrano
@@ -5,69 +6,79 @@ module Capistrano
     module Deploy
       # Represents the stats of a deployment to a particular server
       class ServerStats
-        # @return [Boolean, nil] `nil` when the deployment hasn't begun
-        #   `true` when it has finished successfully, `false` when it has failed
-        attr_accessor :success
+        # `nil` when the deployment hasn't begun
+        #  `true` when it has finished successfully, `false` when it has failed
+        #
+        #: Symbol
+        attr_accessor :state
 
-        # @return [Time, nil]
+        #: Time?
         attr_accessor :start_time
 
-        # @return [Time, nil]
+        #: Time?
         attr_accessor :end_time
 
-        # @return [String]
+        #: String
         attr_accessor :server_name
 
-        # @return [String]
+        #: String
         attr_accessor :backend_name
 
-        # @return [String, nil]
+        #: String
         attr_accessor :admin_state
 
-        # @return [String, nil]
+        #: String
         attr_accessor :operational_state
 
-        # @param server_name [String]
-        # @param backend_name [String]
-        def initialize(server_name, backend_name)
+        #: (String, String, Symbol, String, String) -> void
+        def initialize(
+          server_name,
+          backend_name,
+          state: :pending,
+          admin_state: 'unknown',
+          operational_state: 'unknown'
+        )
           @server_name = server_name
           @backend_name = backend_name
-          @success = nil
-          @seconds = nil
-          @admin_state = 'unknown'
-          @operational_state = 'unknown'
+          @state = state
+          @admin_state = admin_state
+          @operational_state = operational_state
+          @seconds = T.let(nil, T.nilable(Integer))
         end
 
-        # @return [String]
+        #: -> String
         def to_s
           time_string =
-            case @success
-            when nil    then 'skipped'
-            when false  then "failed after #{Helper.humanize_time(seconds)}"
-            when true   then "took #{Helper.humanize_time(seconds)}"
+            case @state
+            when :pending then 'skipped'
+            when :failed  then "failed after #{Helper.humanize_time(T.must(seconds))}"
+            when :success then "took #{Helper.humanize_time(T.must(seconds))}"
+            when :info    then "at #{Time.now}"
             end
 
           "  #{state_emoji} #{server_title} #{time_string}#{haproxy_states}"
         end
 
-        # @return [Integer, nil] How much time has the deployment taken
+        # How much time has the deployment taken
+        #
+        #: -> Integer?
         def seconds
-          @seconds ||= Helper.seconds_since(@start_time, to: @end_time)
+          @seconds ||= Helper.seconds_since(T.must(@start_time), to: T.must(@end_time))
         end
 
         private
 
-        # @return [String, nil]
+        #: -> String?
         def humanize_admin_state
           ::Capistrano::DataPlaneApi.humanize_admin_state(@admin_state)
         end
 
-        # @return [String, nil]
+        #: -> String?
         def humanize_operational_state
           ::Capistrano::DataPlaneApi.humanize_operational_state(@operational_state)
         end
 
-        # @return [String, nil]
+        #: -> String?
         def haproxy_states
           <<-HAPROXY
 
@@ -76,35 +87,41 @@ module Capistrano
           HAPROXY
         end
 
-        # @return [Hash{String => Symbol}]
-        SERVER_TITLE_COLORS = {
-          nil => :yellow,
-          false => :red,
-          true => :green
-        }.freeze
+        SERVER_TITLE_COLORS = T.let(
+          {
+            pending: :yellow,
+            failed:  :red,
+            success: :green,
+            info:    :blue,
+          }.freeze,
+          T::Hash[Symbol, Symbol],
+        )
         private_constant :SERVER_TITLE_COLORS
 
-        # @return [String]
+        #: -> String
         def server_title
-          COLORS.decorate(server_id, :bold, SERVER_TITLE_COLORS[@success])
+          COLORS.decorate(server_id, :bold, SERVER_TITLE_COLORS.fetch(@state))
         end
 
-        # @return [String]
+        #: -> String
         def server_id
           "#{@backend_name}:#{@server_name}"
         end
 
-        # @return [Hash{Boolean, nil => Symbol}]
-        STATE_EMOJIS = {
-          nil => '🟡',
-          false => '❌',
-          true => '✅'
-        }.freeze
+        STATE_EMOJIS = T.let(
+          {
+            pending: '🟡',
+            failed:  '❌',
+            success: '✅',
+            info:    'ℹ️',
+          }.freeze,
+          T::Hash[Symbol, String],
+        )
         private_constant :STATE_EMOJIS
 
-        # @return [String]
+        #: -> String
         def state_emoji
-          STATE_EMOJIS[@success]
+          STATE_EMOJIS.fetch(@state)
         end
       end
     end

data/lib/capistrano/data_plane_api/deploy.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require_relative '../data_plane_api'
@@ -7,13 +8,13 @@ module Capistrano
     # Contains code used in the deployment script.
     module Deploy
       class << self
-        # @return [void]
+        #: -> void
         def call
           args = Args.parse
           puts COLORS.bold.blue('Running the deployment script')
 
           result = Group.call(args)
-          abort if result == false
+          abort if result == :failed
         end
       end
     end

data/lib/capistrano/data_plane_api/diggable.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Capistrano
@@ -5,13 +6,15 @@ module Capistrano
     # Include in a class to grant it the `#dig` method.
     # It's implemented so that it calls public methods.
     module Diggable
+      include Kernel
+
       # Extracts the nested value specified by the sequence of key objects by calling `dig` at each step,
       # returning `nil` if any intermediate step is `nil`.
       #
       # This implementation of `dig` uses `public_send` under the hood.
       #
       # @raise [TypeError] value has no #dig method
-      # @return [Object]
+      #: (untyped) -> untyped
       def dig(*args)
         return unless args.size.positive?
 
@@ -19,7 +22,7 @@ module Capistrano
 
         value = public_send(key)
         return if value.nil?
-        return value if args.size.zero?
+        return value if args.empty?
         raise ::TypeError, "#{value.class} does not have #dig method" unless value.respond_to?(:dig)
 
         value.dig(*args)

data/lib/capistrano/data_plane_api/equatable.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 module Capistrano
@@ -6,8 +7,9 @@ module Capistrano
     # of comparing themselves with other objects of the same class
     # by calling `==` on their instance variables.
     module Equatable
-      # @param other [Object]
-      # @return [Boolean]
+      include Kernel
+
+      #: (Object) -> bool
       def eql?(other)
         return true if equal?(other)
         return false unless other.is_a?(self.class) || is_a?(other.class)

data/lib/capistrano/data_plane_api/helper.rb

@@ -1,37 +1,43 @@
+# typed: true
 # frozen_string_literal: true
 
 module Capistrano
   module DataPlaneApi
     # Provides helper methods
     module Helper
-      # @return [Hash{String => Symbol}]
-      ADMIN_STATE_COLORS = {
-        'unknown' => :on_red,
-        'drain' => :on_blue,
-        'ready' => :on_green,
-        'maint' => :on_yellow
-      }.freeze
-
-      # @return [Hash{String => Symbol}]
-      OPERATIONAL_STATE_COLORS = {
-        'unknown' => :on_red,
-        'up' => :on_green,
-        'down' => :on_red,
-        'stopping' => :on_yellow
-      }.freeze
-
-      # @return [Boolean]
+      ADMIN_STATE_COLORS = T.let(
+        {
+          'unknown' => :on_red,
+          'drain'   => :on_blue,
+          'ready'   => :on_green,
+          'maint'   => :on_yellow,
+        }.freeze,
+        T::Hash[String, Symbol],
+      )
+
+      OPERATIONAL_STATE_COLORS = T.let(
+        {
+          'unknown'  => :on_red,
+          'up'       => :on_green,
+          'down'     => :on_red,
+          'stopping' => :on_yellow,
+        }.freeze,
+        T::Hash[String, Symbol],
+      )
+
+      #: -> bool
       def no_haproxy?
-        !::ENV['NO_HAPROXY'].nil? && !::ENV['NO_HAPROXY'].empty?
+        no_haproxy = ::ENV['NO_HAPROXY']
+        !no_haproxy.nil? && !no_haproxy.empty?
       end
 
-      # @return [Boolean]
+      #: -> bool
       def force_haproxy?
-        !::ENV['FORCE_HAPROXY'].nil? && !::ENV['FORCE_HAPROXY'].empty?
+        force_haproxy = ::ENV['FORCE_HAPROXY']
+        !force_haproxy.nil? && !force_haproxy.empty?
       end
 
-      # @param state [String, Symbol, nil]
-      # @return [String, nil]
+      #: (String | Symbol | nil) -> String?
       def humanize_admin_state(state)
         return unless state
 
@@ -39,8 +45,7 @@ module Capistrano
         COLORS.decorate(" #{state.upcase} ", :bold, ADMIN_STATE_COLORS[state.downcase])
       end
 
-      # @param state [String, Symbol, nil]
-      # @return [String, nil]
+      #: (String | Symbol | nil) -> String?
       def humanize_operational_state(state)
         return unless state
 
@@ -48,10 +53,9 @@ module Capistrano
         COLORS.decorate(" #{state.upcase} ", :bold, OPERATIONAL_STATE_COLORS[state.downcase])
       end
 
-      # @param backend [Capistrano::DataPlaneApi::Configuration::Backend]
-      # @return [String]
+      #: (Configuration::Backend) -> String
       def humanize_backend_name(backend)
-        COLORS.decorate(" #{backend.name} ", *backend.styles)
+        T.unsafe(COLORS).decorate(" #{backend.name} ", *backend.styles) # rubocop:disable Sorbet/ForbidTUnsafe
       end
     end
   end

data/lib/capistrano/data_plane_api/hooks.rb

@@ -5,3 +5,4 @@ require_relative '../data_plane_api'
 after 'deploy:started', 'data_plane_api:server:set_drain'
 before 'deploy:publishing', 'data_plane_api:server:set_maint'
 after 'deploy:finished', 'data_plane_api:server:set_ready'
+before 'deploy:check', 'data_plane_api:server:check'

data/lib/capistrano/data_plane_api/show_state.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'pastel'
@@ -10,8 +11,8 @@ module Capistrano
     # HAProxy backends and servers to stdout.
     module ShowState
       class << self
-        # @return [String]
-        def call # rubocop:disable Metrics/MethodLength
+        #: -> String
+        def call
           pastel = ::Pastel.new
           result = ::String.new
 
@@ -25,10 +26,15 @@ module Capistrano
             c.timeout = 2
           end
 
-          ::Capistrano::DataPlaneApi.configuration.backends.each do |backend|
+          ::Capistrano::DataPlaneApi.configuration.backends&.each do |backend|
             result << ::TTY::Box.frame(title: { top_left: backend_name(backend) }) do
               b = ::String.new
-              servers = ::Capistrano::DataPlaneApi.get_backend_servers_settings(backend.name, config: config).body
+              servers =
+                ::Capistrano::DataPlaneApi.get_backend_servers_settings(
+                  T.must(backend.name),
+                  config: config,
+                ).body
+
               servers.each do |server|
                 operational_state = operational_state(server)
                 admin_state = admin_state(server)
@@ -42,6 +48,7 @@ module Capistrano
               b
 
             rescue Error, ::Faraday::ConnectionFailed, ::Faraday::TimeoutError
+              b = T.must(b)
               b << pastel.bold.bright_red('Unavailable!')
               b << "\n"
               b
@@ -53,27 +60,23 @@ module Capistrano
 
         private
 
-        # @param server [Hash{String => Object}]
-        # @return [String]
+        #: (Hash[String, untyped]) -> String?
         def operational_state(server)
           ::Capistrano::DataPlaneApi.humanize_operational_state(server['operational_state'])
         end
 
-        # @param server [Hash{String => Object}]
-        # @return [String]
+        #: (Hash[String, untyped]) -> String?
         def admin_state(server)
           ::Capistrano::DataPlaneApi.humanize_admin_state(server['admin_state'])
         end
 
-        # @param server [Hash{String => Object}]
-        # @return [String]
+        #: (Hash[String, untyped]) -> String?
         def server_name(server)
           pastel = ::Pastel.new
           pastel.bold server['name']
         end
 
-        # @param backend [Capistrano::DataPlaneApi::Configuration::Backend]
-        # @return [String]
+        #: (Configuration::Backend) -> String
         def backend_name(backend)
           pastel = ::Pastel.new
           pastel.decorate(" #{backend.name} ", *backend.styles)

data/lib/capistrano/data_plane_api/tasks.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 require 'rake'
+require 'capistrano/data_plane_api/deploy'
 
-namespace :data_plane_api do
-  namespace :server do
+namespace :data_plane_api do # rubocop:disable Metrics/BlockLength
+  namespace :server do # rubocop:disable Metrics/BlockLength
     desc "Set the server's admin state to DRAIN through the HAProxy Data Plane API"
     task :set_drain do
       on roles :web do
@@ -32,5 +33,28 @@ namespace :data_plane_api do
         ::Capistrano::DataPlaneApi.server_set_maint fetch(:stage), force: true
       end
     end
+
+    desc 'Check the state of the HaProxy server'
+    task :check do
+      on roles :web do
+        next if ::Capistrano::DataPlaneApi.no_haproxy?
+
+        c = ::Capistrano::DataPlaneApi::COLORS
+        server, backend = ::Capistrano::DataPlaneApi.find_server_and_backend(fetch(:stage))
+
+        state = ::Capistrano::DataPlaneApi.server_get_state(fetch(:stage))
+
+        stats = ::Capistrano::DataPlaneApi::Deploy::ServerStats.new(
+          server.name,
+          backend.name,
+          state:             :info,
+          admin_state:       state['admin_state'],
+          operational_state: state['operational_state'],
+        )
+
+        human_name = c.decorate(" #{backend.name}:#{server.name} ", *backend.styles)
+        puts "\nUpdates HaProxy state for #{human_name}\n#{stats}\n\n"
+      end
+    end
   end
 end

data/lib/capistrano/data_plane_api/terminal_print_loop.rb

@@ -1,9 +1,12 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'tty/cursor'
 
 module Capistrano
   module DataPlaneApi
+    # Provides a method that renders
+    # strings in a terminal with the given interval.
     module TerminalPrintLoop
       class << self
         # Calls the passed block in an endless loop with a given interval
@@ -11,9 +14,9 @@ module Capistrano
         # It prints the `String` returned from the block and clears it
         # before another frame is printed.
         #
-        # @yieldparam content [String]
-        # @param interval [Integer] Number of seconds between each screen refresh
-        def call(interval: 2)
+        # @param interval: Number of seconds between each screen refresh
+        #: (Integer) { (String) -> Object } -> void
+        def call(interval: 2, &_block)
           previous_line_count = 0
           previous_max_line_length = 0
           loop do
@@ -22,7 +25,7 @@ module Capistrano
 
             print ::TTY::Cursor.clear_lines(previous_line_count + 1)
 
-            content = yielded if yielded.is_a?(::String) && content.length.zero?
+            content = yielded if yielded.is_a?(::String) && content.empty?
             line_count = 0
             max_line_length = 0
             content.each_line do |line|

data/lib/capistrano/data_plane_api/type.rb

@@ -1,3 +1,4 @@
+# typed: true
 # frozen_string_literal: true
 
 require 'shale'
@@ -7,20 +8,23 @@ require_relative 'equatable'
 
 module Capistrano
   module DataPlaneApi
+    # A Base class for all types of the Data Plane API request and response bodies
     class Type < ::Shale::Mapper
+      extend T::Helpers
+
+      abstract!
+
       include Diggable
       include Equatable
 
-      alias to_h to_hash
+      def to_h = to_hash
 
-      # @param key [Symbol, String]
-      # @return [Object, nil]
+      #: (Symbol | String) -> Object?
       def [](key)
         public_send(key) if respond_to?(key)
       end
 
-      # @param key [Symbol, String]
-      # @param val [Object]
+      #: (Symbol | String, Object) -> void
       def []=(key, val)
         public_send(:"#{key}=", val)
       end

data/lib/capistrano/data_plane_api/version.rb

@@ -1,8 +1,8 @@
+# typed: true
 # frozen_string_literal: true
 
 module Capistrano
   module DataPlaneApi
-    # @return [String]
-    VERSION = '0.1.4'
+    VERSION = '0.2.0'
   end
 end