avm 0.5.0 → 0.8.0

data/lib/avm/instances/entry.rb

@@ -0,0 +1,54 @@
+# 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
+        read(required: false, noinput: true) || auto_value
+      end
+
+      def read(extra_options = {})
+        ::EacConfig::Node.context.current.entry(full_path, options.merge(extra_options)).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)
+        ::EacConfig::Node.context.current.entry(full_path).value = value
+      end
+    end
+  end
+end

data/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[fs_path host_id 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/lib/avm/instances/runner.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module Instances
+    class Runner
+      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/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/lib/avm/jobs/base.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'avm/jobs/variables_source'
+require 'avm/result'
 require 'eac_cli/core_ext'
 
 module Avm

data/lib/avm/registry/base.rb

@@ -0,0 +1,65 @@
+# 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})")
+      end
+
+      def detect_optional(*registered_initialize_args)
+        registered_modules.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
+        (single_registered_modules + provider_registered_modules)
+          .select { |v| valid_registered_module?(v) }.uniq.sort_by { |s| [s.name] }
+      end
+
+      def single_registered_modules
+        single_instance_registry.registered.map(&:registered_module)
+      end
+
+      def provider_registered_modules
+        provider_registry.registered.map(&:registered_module).flat_map do |provider_class|
+          provider_class.new.all
+        end
+      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/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, :source_stereotypes
+
+    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/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

data/lib/avm/rspec/shared_examples/in_avm_registry.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+
+::RSpec.shared_examples 'in_avm_registry' do |registry_method|
+  let(:avm_registry) { ::Avm::Registry.send(registry_method) }
+
+  it 'is in the avm registry' do
+    expect(avm_registry.registered_modules).to include(described_class)
+  end
+end

data/lib/avm/rspec/shared_examples/not_in_avm_registry.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+
+::RSpec.shared_examples 'not_in_avm_registry' do |registry_method = nil|
+  registry_method.if_present(::Avm::Registry.registries) { |v| [::Avm::Registry.send(v)] }
+                 .each do |registry|
+    context "when registry is #{registry}" do
+      it 'is not in the avm registry' do
+        expect(registry.registered_modules).not_to include(described_class)
+      end
+    end
+  end
+end

data/lib/avm/{git/organize.rb → rspec.rb}

@@ -3,9 +3,7 @@
 require 'eac_ruby_utils/core_ext'
 
 module Avm
-  module Git
-    module Organize
-      require_sub __FILE__
-    end
+  module Rspec
+    require_sub __FILE__
   end
 end

data/lib/avm/runners/base.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module Runners
+    class Base
+      enable_abstract_methods
+
+      class << self
+        def command_argument
+          stereotype_name.underscore.dasherize
+        end
+
+        def stereotype_name
+          name.split('::')[-3]
+        end
+      end
+
+      delegate :command_argument, :stereotype_name, to: :class
+
+      runner_with :help, :subcommands do
+        subcommands
+      end
+
+      def to_s
+        stereotype_name
+      end
+    end
+  end
+end

data/lib/avm/scms/base.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Scms
+    class Base
+      enable_abstract_methods
+      abstract_methods :update, :valid?
+      common_constructor :path do
+        self.path = path.to_pathname
+      end
+
+      # @return [Avm::Scms::Commit,NilClass]
+      def commit_if_change(_message = nil)
+        raise_abstract_method __method__
+      end
+
+      def name
+        self.class.name.demodulize
+      end
+
+      def to_s
+        name
+      end
+    end
+  end
+end

data/lib/avm/scms/commit.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Scms
+    class Commit
+      enable_abstract_methods
+
+      # @return [Array<Pathname>]
+      def changed_files
+        raise_abstract_method __method__
+      end
+
+      # @param other [Avm::Scms::Commit]
+      # @return [Avm::Scms::Commit]
+      def merge_with(_other)
+        raise_abstract_method __method__
+      end
+
+      # @return [Array<Pathname>]
+      def no_scm_changed_files
+        changed_files.reject { |path| scm_file?(path) }
+      end
+
+      # @param new_message [String]
+      def reword(_new_message)
+        raise_abstract_method __method__
+      end
+
+      # @return [Array<Pathname>]
+      def scm_changed_files
+        changed_files.select { |path| scm_file?(path) }
+      end
+
+      # @param path [Pathname]
+      # @return [TrueClass,FalseClass]
+      def scm_file?(_path)
+        raise_abstract_method __method__
+      end
+    end
+  end
+end

data/lib/avm/self/docker_image.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'avm/docker/image'
+
+module Avm
+  module Self
+    class DockerImage < ::Avm::Docker::Image
+      def stereotype_tag
+        nil
+      end
+    end
+  end
+end

data/lib/avm/self/instance/entry_keys.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Avm
+  module Self
+    class Instance < ::Avm::Instances::Base
+      module EntryKeys
+        DATA_DEFAULT_PATH = 'data.default_path'
+        DOCKER_REGISTRY_NAME = 'docker.registry.name'
+      end
+    end
+  end
+end

data/lib/avm/self/instance.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'avm/instances/base'
+require 'avm/self/docker_image'
+require 'avm/self/instance/entry_keys'
+require 'avm/eac_ubuntu_base0/docker_image'
+
+module Avm
+  module Self
+    class Instance < ::Avm::Instances::Base
+      def docker_image_class
+        ::Avm::Self::DockerImage
+      end
+
+      def docker_registry
+        read_entry(::Avm::Self::Instance::EntryKeys::DOCKER_REGISTRY_NAME)
+      end
+
+      def docker_run_arguments
+        ['-e', "LOCAL_USER_ID=#{::Process.uid}"]
+      end
+    end
+  end
+end

data/lib/avm/source_stereotypes/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module SourceStereotypes
+    class Base
+      enable_abstract_methods
+      abstract_methods :valid?
+      common_constructor :source
+
+      def name
+        self.class.name
+      end
+
+      def to_s
+        name
+      end
+    end
+  end
+end

data/lib/avm/sources/base.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
+require 'avm/registry'
 require 'eac_git'
 require 'eac_ruby_utils/core_ext'
 
 module Avm
   module Sources
     class Base
+      require_sub __FILE__
       enable_simple_cache
       enable_listable
       lists.add_symbol :option, :parent
@@ -14,6 +16,7 @@ module Avm
         self.options = self.class.lists.option.hash_keys_validate!(options)
       end
 
+      delegate :locale, to: :configuration
       delegate :to_s, to: :path
 
       # @return [Avm::Sources::Base]
@@ -34,12 +37,31 @@ module Avm
                 .map { |subrepo| self.class.new(subrepo.subpath.expand_path(path), parent: self) }
       end
 
+      def update
+        stereotype.update_source(self)
+      end
+
       private
 
+      # @return [Avm::Sources::Configuration]
+      def configuration_uncached
+        ::Avm::Sources::Configuration.find_in_path(path) || ::Avm::Sources::Configuration.new
+      end
+
       # @return [EacGit::Local]
       def git_repo_uncached
         ::EacGit::Local.new(path)
       end
+
+      # @return [Avm::Scms::Base]
+      def scm_uncached
+        ::Avm::Registry.scms.detect(path)
+      end
+
+      # @return [Avm::SourceStereotypes::Base]
+      def stereotype_uncached
+        ::Avm::Registry.source_stereotypes.detect(self)
+      end
     end
   end
 end

data/lib/avm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Avm
-  VERSION = '0.5.0'
+  VERSION = '0.8.0'
 end