avm-tools 0.113.1 → 0.113.5

data/sub/avm/lib/avm/instances/base/dockerizable.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'eac_docker/executables'
+require 'eac_ruby_utils/core_ext'
+require 'avm/docker/container'
+
+module Avm
+  module Instances
+    class Base
+      module Dockerizable
+        enable_simple_cache
+        attr_reader :docker_image_options
+
+        def docker_image_options=(options)
+          @docker_image_options = ::ActiveSupport::HashWithIndifferentAccess.new(options)
+          reset_cache
+        end
+
+        def docker_container_exist?
+          ::EacDocker::Executables.docker.command.append(
+            ['ps', '-qaf', "name=#{docker_container_name}"]
+          ).execute!.present?
+        end
+
+        def docker_container_name
+          id
+        end
+
+        private
+
+        def docker_container_uncached
+          ::Avm::Docker::Container.new(self)
+        end
+
+        def docker_image_uncached
+          r = docker_image_class.new(docker_image_options.fetch(:registry))
+          r.instance = self if r.respond_to?(:instance)
+          r.version = docker_image_options[:version] if docker_image_options.key?(:version)
+          r.snapshot = docker_image_options[:snapshot] if docker_image_options.key?(:snapshot)
+          r
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/instances/base/entry_keys.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'avm/instances/entry_keys'
+
+module Avm
+  module Instances
+    class Base
+      module EntryKeys
+        ::Avm::Instances::EntryKeys.all.each do |key|
+          method_name = key.to_s.variableize
+          define_method method_name do
+            read_entry(key)
+          end
+
+          define_method "#{method_name}_optional" do
+            read_entry(key, required: false)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/instances/base.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+require 'eac_ruby_utils/simple_cache'
+require 'avm/instances/entries'
+
+module Avm
+  module Instances
+    class Base
+      enable_listable
+      enable_simple_cache
+      require_sub __FILE__, include_modules: true
+      include ::Avm::Instances::Entries
+
+      lists.add_string :access, :local, :ssh
+
+      ID_PATTERN = /\A([a-z0-9]+(?:\-[a-z0-9]+)*)_(.+)\z/.freeze
+
+      class << self
+        def by_id(id)
+          application_id, suffix = parse_id(id)
+          require 'avm/instances/application'
+          new(::Avm::Instances::Application.new(application_id), suffix)
+        end
+
+        private
+
+        def parse_id(id)
+          m = ID_PATTERN.match(id)
+          return [m[1], m[2]] if m
+
+          raise "ID Pattern no matched: \"#{id}\""
+        end
+      end
+
+      common_constructor :application, :suffix do
+        self.suffix = suffix.to_s
+      end
+
+      def id
+        "#{application.id}_#{suffix}"
+      end
+
+      def to_s
+        id
+      end
+
+      def host_env_uncached
+        access = read_entry(:access, list: ::Avm::Instances::Base.lists.access.values)
+        case access
+        when 'local' then ::EacRubyUtils::Envs.local
+        when 'ssh' then ::EacRubyUtils::Envs.ssh(read_entry('ssh.url'))
+        else raise("Unmapped access value: \"#{access}\"")
+        end
+      end
+
+      private
+
+      def source_instance_uncached
+        ::Avm::Instances::Base.by_id(source_instance_id)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/instances/docker_image.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'avm/docker/image'
+
+module Avm
+  module Instances
+    class DockerImage < ::Avm::Docker::Image
+      attr_accessor :instance
+
+      def stereotype_tag
+        instance.id
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/instances/entries.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'avm/instances/entry'
+
+module Avm
+  module Instances
+    module Entries
+      def entry(suffix, options = {})
+        ::Avm::Instances::Entry.new(self, suffix, options)
+      end
+
+      def path_prefix
+        @path_prefix ||= [id].freeze
+      end
+
+      def read_entry(entry_suffix, options = {})
+        entry(entry_suffix, options).value
+      end
+
+      def read_entry_optional(entry_suffix, options = {})
+        entry(entry_suffix, options).optional_value
+      end
+
+      def full_entry_path(entry_suffix)
+        unless entry_suffix.is_a?(::Array)
+          entry_suffix = ::EacConfig::PathsHash.parse_entry_key(entry_suffix.to_s)
+        end
+        (path_prefix + entry_suffix).join('.')
+      end
+
+      def inherited_entry_value(source_entry_suffix, target_entry_suffix, &block)
+        read_entry_optional(source_entry_suffix).if_present do |instance_id|
+          other_entry_value(instance_id, target_entry_suffix).if_present(&block)
+        end
+      end
+
+      def other_entry_value(instance_id, entry_suffix)
+        ::Avm::Instances::Base.by_id(instance_id).read_entry_optional(entry_suffix)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/instances/entry.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'eac_config/node'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Instances
+    class Entry
+      class << self
+        def auto_value_method_name(suffix)
+          "auto_#{suffix.to_s.gsub('.', '_')}"
+        end
+      end
+
+      common_constructor :parent, :suffix, :options
+
+      def auto_value
+        parent.respond_to?(auto_value_method, true) ? parent.send(auto_value_method) : nil
+      end
+
+      def auto_value_method
+        self.class.auto_value_method_name(suffix)
+      end
+
+      def full_path
+        (parent.path_prefix + suffix_as_array).join('.')
+      end
+
+      def optional_value
+        context_entry.found? ? context_entry.value : auto_value
+      end
+
+      def read
+        context_entry.value
+      end
+
+      def suffix_as_array
+        if suffix.is_a?(::Array)
+          suffix.dup
+        else
+          ::EacConfig::PathsHash.parse_entry_key(suffix.to_s)
+        end
+      end
+
+      def value
+        optional_value || read
+      end
+
+      def write(value)
+        context_entry.value = value
+      end
+
+      private
+
+      def context_entry
+        ::EacConfig::Node.context.current.entry(full_path)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/instances/entry_keys.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Instances
+    module EntryKeys
+      class << self
+        def all
+          all_keys.to_a
+        end
+
+        def keys_consts_set(prefix, suffixes)
+          if suffixes.is_a?(::Hash)
+            keys_consts_set_from_hash(prefix, suffixes)
+          elsif suffixes.is_a?(::Enumerable)
+            keys_consts_set_from_enum(prefix, suffixes)
+          else
+            raise "Unmapped suffixes class: #{suffixes.class}"
+          end
+        end
+
+        def key_const_set(prefix, suffix)
+          key = [prefix, suffix].reject(&:blank?).join('.')
+          const_set(key.gsub('.', '_').upcase, key)
+          all_keys << key
+        end
+
+        private
+
+        def all_keys
+          @all_keys ||= ::Set.new
+        end
+
+        def keys_consts_set_from_enum(prefix, suffixes)
+          suffixes.each { |suffix| key_const_set(prefix, suffix) }
+        end
+
+        def keys_consts_set_from_hash(prefix, suffixes)
+          suffixes.each { |k, v| keys_consts_set(prefix.to_s + (k.blank? ? '' : ".#{k}"), v) }
+        end
+      end
+
+      {
+        '' => %w[data_fs_path fs_path host_id name source_instance_id],
+        database: %w[id hostname limit name password port system timeout username extra],
+        docker: %w[registry],
+        mailer: {
+          '' => %w[id from reply_to],
+          smtp: %w[address port domain username password authentication starttls_auto]
+        },
+        ssh: %w[hostname port url username],
+        web: %w[authority hostname path port scheme url userinfo]
+      }.each { |prefix, suffixes| keys_consts_set(prefix, suffixes) }
+    end
+  end
+end

data/sub/avm/lib/avm/instances/runner.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'avm/runners/base'
+require 'eac_cli/core_ext'
+
+module Avm
+  module Instances
+    class Runner < ::Avm::Runners::Base
+      class << self
+        def instance_class
+          ::Avm.const_get(stereotype_name).const_get('Instance')
+        end
+
+        def stereotype_module
+          ::Avm.const_get(stereotype_name)
+        end
+
+        def stereotype_name
+          name.demodulize
+        end
+      end
+
+      description = "Utilities for #{stereotype_name} instances."
+      runner_with :help, :subcommands do
+        desc description
+        pos_arg 'instance-id'
+        subcommands
+      end
+
+      delegate :instance_class, :stereotype_module, :stereotype_name, to: :class
+
+      private
+
+      def instance_uncached
+        self.class.instance_class.by_id(parsed.instance_id)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/instances.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Avm
+  module Instances
+    require 'avm/instances/application'
+    require 'avm/instances/entries'
+  end
+end

data/sub/avm/lib/avm/jobs/base.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'avm/jobs/variables_source'
+require 'avm/result'
+require 'eac_cli/core_ext'
+
+module Avm
+  module Jobs
+    module Base
+      common_concern do
+        include ::ActiveSupport::Callbacks
+
+        enable_speaker
+        enable_simple_cache
+        enable_listable
+        common_constructor :instance, :options, default: [{}] do
+          if option_list.present?
+            self.options = option_list.hash_keys_validate!(options.symbolize_keys)
+          end
+        end
+        define_callbacks(*jobs)
+      end
+
+      module ClassMethods
+        def jobs
+          const_get('JOBS').dup
+        end
+      end
+
+      module InstanceMethods
+        def option_list
+          nil
+        end
+
+        def run
+          start_banner if respond_to?(:start_banner)
+          run_jobs
+          ::Avm::Result.success('Done!')
+        rescue ::Avm::Result::Error => e
+          e.to_result
+        end
+
+        def variables_source
+          ::Avm::Jobs::VariablesSource.new(self, instance)
+        end
+
+        protected
+
+        def run_jobs
+          jobs.each do |job|
+            run_callbacks job do
+              send(job)
+            end
+          end
+        end
+
+        def jobs
+          self.class.jobs
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/jobs/variables_source.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Jobs
+    class VariablesSource
+      common_constructor :job, :instance
+
+      def read_entry(path, options = {})
+        entry_from_job(path) || instance.read_entry(path, options)
+      end
+
+      private
+
+      def entry_from_job(path)
+        method = path.gsub('.', '_').underscore
+        return job.send(method) if job.respond_to?(method, true)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/jobs.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Jobs
+    require_sub __FILE__
+  end
+end

data/sub/avm/lib/avm/path_string.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+module Avm
+  # String with paths like PATH variable.
+  # Note: the separator is not system dependent.
+  class PathString < String
+    SEPARATOR = ':'
+
+    class << self
+      # Shortcut for [Avm::Paths.new(string).paths].
+      def paths(string)
+        new(string).paths
+      end
+    end
+
+    def initialize(string = nil)
+      super(string.to_s)
+    end
+
+    # @return [Array] List of paths. Blank paths are rejected.
+    def paths
+      split(SEPARATOR).reject(&:blank?)
+    end
+  end
+end

data/sub/avm/lib/avm/registry/base.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/gems_registry'
+
+module Avm
+  module Registry
+    class Base
+      enable_simple_cache
+      common_constructor :module_suffix
+
+      def detect(*registered_initialize_args)
+        detect_optional(*registered_initialize_args) ||
+          raise("No registered module valid for #{registered_initialize_args}" \
+            " (Module suffix: #{module_suffix}, Available: #{registered_modules.join(', ')})")
+      end
+
+      def detect_optional(*registered_initialize_args)
+        registered_modules.reverse.lazy.map { |klass| klass.new(*registered_initialize_args) }
+                          .find(&:valid?)
+      end
+
+      def provider_module_suffix
+        "#{module_suffix}::Provider"
+      end
+
+      def single_module_suffix
+        "#{module_suffix}::Base"
+      end
+
+      def to_s
+        "#{self.class}[#{module_suffix}]"
+      end
+
+      def valid_registered_module?(a_module)
+        a_module.is_a?(::Class) && !a_module.abstract?
+      end
+
+      private
+
+      def registered_modules_uncached
+        registered_gems.flat_map { |registry| modules_from_registry(registry) }
+                       .select { |v| valid_registered_module?(v) }.uniq
+      end
+
+      def modules_from_registry(registry)
+        if registry.registry.module_suffix == provider_module_suffix
+          registry.registered_module.new.all
+        else
+          [registry.registered_module]
+        end
+      end
+
+      def registered_gems
+        (single_instance_registry.registered + provider_registry.registered).sort
+      end
+
+      def single_instance_registry_uncached
+        ::EacRubyUtils::GemsRegistry.new(single_module_suffix)
+      end
+
+      def provider_registry_uncached
+        ::EacRubyUtils::GemsRegistry.new(provider_module_suffix)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/registry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/gems_registry'
+
+module Avm
+  module Registry
+    require_sub __FILE__
+    enable_listable
+    lists.add_symbol :category, :instance_stereotypes, :runners, :scms, :sources
+
+    class << self
+      enable_simple_cache
+
+      # @return [Array<Avm::Registry::Base>]
+      def registries
+        lists.category.values.map { |c| send(c) }
+      end
+
+      private
+
+      ::Avm::Registry.lists.category.each_value do |category|
+        define_method "#{category}_uncached" do
+          ::Avm::Registry::Base.new(category.to_s.camelize)
+        end
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/result.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'colorized_string'
+require 'eac_ruby_utils/listable'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  class Result < ::SimpleDelegator
+    include ::EacRubyUtils::Listable
+
+    lists.add_string :type, :success, :error, :neutral, :pending, :outdated
+
+    lists.type.values.each do |type| # rubocop:disable Style/HashEachMethods
+      class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def self.#{type}(value)
+          new(value, TYPE_#{type.upcase})
+        end
+      RUBY_EVAL
+    end
+
+    TYPE_SUCCESS_COLOR = 'green'
+    TYPE_ERROR_COLOR = 'red'
+    TYPE_NEUTRAL_COLOR = 'light_black'
+    TYPE_PENDING_COLOR = 'yellow'
+    TYPE_OUTDATED_COLOR = 'blue'
+
+    class << self
+      # Return Avm::Result.success(success_value) if +success+ is truthy.
+      # Return Avm::Result.error(error_value || success_value) if +success+ is falsely.
+      # @return [Avm::Result]
+      def success_or_error(success, success_value, error_value = nil)
+        if success
+          self.success(success_value)
+        else
+          error(error_value.presence || success_value)
+        end
+      end
+    end
+
+    attr_reader :type
+
+    def initialize(value, type)
+      super(value)
+      validate_type(type)
+      @type = type
+    end
+
+    def label
+      label_fg
+    end
+
+    def label_fg
+      ColorizedString.new(to_s).send(type_color)
+    end
+
+    def label_bg
+      ColorizedString.new(to_s).light_white.send("on_#{type_color}")
+    end
+
+    def type_color
+      self.class.const_get("type_#{type}_color".upcase)
+    end
+
+    lists.type.values.each do |type| # rubocop:disable Style/HashEachMethods
+      class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def #{type}?
+          @type == '#{type}'
+        end
+      RUBY_EVAL
+    end
+
+    private
+
+    def validate_type(type)
+      return if self.class.lists.type.values.include?(type)
+
+      raise "Tipo desconhecido: \"#{type}\" (Válido: #{self.class.lists.type.values.join(', ')})"
+    end
+
+    class Error < StandardError
+      def to_result
+        ::Avm::Result.error(message)
+      end
+    end
+  end
+end

data/sub/avm/lib/avm/rspec/setup.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Rspec
+    module Setup
+      def self.extended(obj)
+        obj.setup_in_avm_registry_example
+        obj.setup_not_in_avm_registry_example
+      end
+
+      def setup_in_avm_registry_example
+        require 'avm/rspec/shared_examples/in_avm_registry'
+      end
+
+      def setup_not_in_avm_registry_example
+        require 'avm/rspec/shared_examples/not_in_avm_registry'
+      end
+    end
+  end
+end