avm 0.4.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a5a8832847c76afcae4e76ef3e8f7d1391d7cfb0b13788c3dc7273f9ef879f1
-  data.tar.gz: 0b89bd147edb92e0e3e4d158d16f0995ef41f0544a680beb053f9fa55b96a282
+  metadata.gz: 3be29c02f4be9deec23c40452cf17ad0ce0478c6ae32508690d0a54bc9c4987a
+  data.tar.gz: e63f5d086715190a1803f4289a48f9e25e56094d570d62f6ed5c22b0ceeb6084
 SHA512:
-  metadata.gz: a70af189af9aee66a693706ba031e5eb7c6d4c8533144099f325dfe2b88b9ef08daae16de8d2f09857f194816d653d3669527d6bc9c07d173566c9ab9121c3f6
-  data.tar.gz: d66a1741ec6295f54166a2007a4d168eddd4e7de30f538f87329067b580faf2572514d99302bb467e0b408dfe1a44dd54a9e4e2abaaed0292b3a7ba69bb02b95
+  metadata.gz: 372b53edca7fe1187fa0faa39e145437779a3608b7ce7d248b2d5fe753520079c0542dda99a80b4936f09438f6bda1fceebdb78ce1b741e14854f10160468085
+  data.tar.gz: 02bd6cdb0cdb4f02e7a202d69de40ca2c5f1c981af6198e8ce1e93b36380b0d39a436d36a358e58856675df9e040080ad6879367e013228cd6bfa3efb3e66735

data/lib/avm/data/instance/files_unit.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'avm/data/instance/unit'
+
+module Avm
+  module Data
+    module Instance
+      class FilesUnit < ::Avm::Data::Instance::Unit
+        EXTENSION = '.tar.gz'
+
+        attr_reader :fs_path_subpath
+
+        def initialize(instance, fs_path_subpath)
+          super(instance)
+          @fs_path_subpath = fs_path_subpath
+        end
+
+        before_load :clear_files
+
+        def files_path
+          ::File.join(instance.read_entry(::Avm::Instances::EntryKeys::FS_PATH), fs_path_subpath)
+        end
+
+        def dump_command
+          instance.host_env.command('tar', '-czf', '-', '-C', files_path, '.')
+        end
+
+        def load_command
+          instance.host_env.command('tar', '-xzf', '-', '-C', files_path)
+        end
+
+        def clear_files
+          infom "Removing all files under #{files_path}..."
+          instance.host_env.command('mkdir', '-p', files_path).execute!
+          instance.host_env.command('find', files_path, '-mindepth', 1, '-delete').execute!
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/instance/package.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'avm/data/package'
+
+module Avm
+  module Data
+    module Instance
+      class Package < ::Avm::Data::Package
+        attr_reader :instance
+
+        def initialize(instance, options = {})
+          @instance = instance
+          super options
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/instance/unit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'avm/data/unit'
+
+module Avm
+  module Data
+    module Instance
+      class Unit < ::Avm::Data::Unit
+        attr_reader :instance
+
+        def initialize(instance)
+          @instance = instance
+        end
+      end
+    end
+  end
+end

data/lib/avm/{git/issue.rb → data/instance.rb}

@@ -4,8 +4,8 @@ require 'eac_ruby_utils/require_sub'
 ::EacRubyUtils.require_sub(__FILE__)
 
 module Avm
-  module Git
-    module Issue
+  module Data
+    module Instance
     end
   end
 end

data/lib/avm/data/package/dump.rb

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require 'avm/data/rotate'
+require 'eac_ruby_utils/core_ext'
+require 'minitar'
+
+module Avm
+  module Data
+    class Package
+      class Dump
+        enable_speaker
+        enable_listable
+
+        DEFAULT_EXPIRE_TIME = 1.day
+        DEFAULT_FILE_EXTENSION = '.tar'
+
+        attr_reader :package, :data_file_path, :existing
+
+        lists.add_string :existing, :denied, :overwrite, :rotate, :rotate_expired
+
+        def initialize(package, data_file_path, options = {})
+          @package = package
+          @data_file_path = data_file_path
+          options = options.to_options_consumer
+          @existing, @expire_time = options.consume(:existing, :expire_time)
+          options.validate
+          self.class.lists.existing.value_validate!(@existing)
+        end
+
+        def runnable?
+          cannot_run_reason.blank?
+        end
+
+        def cannot_run_reason
+          return nil if !data_file_exist? ||
+                        [EXISTING_OVERWRITE, EXISTING_ROTATE].include?(existing)
+
+          if existing == EXISTING_DENIED
+            'Data exist and overwriting is denied'
+          elsif existing == EXISTING_ROTATE_EXPIRED && !data_file_expired?
+            'Data exist and yet is not expired'
+          end
+        end
+
+        def run
+          raise "Cannot run: #{cannot_run_reason}" unless runnable?
+
+          build_dir = dump_units_to_build_directory
+          package_file = create_package_file(build_dir)
+          rotate
+          move_download_to_final_dest(package_file)
+        end
+
+        def data_file_exist?
+          ::File.exist?(data_file_path)
+        end
+
+        def data_file_time
+          data_file_exist? ? ::Time.now - ::File.mtime(data_file_path) : nil
+        end
+
+        def data_file_expired?
+          data_file_time.if_present(false) { |v| v >= expire_time }
+        end
+
+        def expire_time
+          @expire_time || DEFAULT_EXPIRE_TIME
+        end
+
+        private
+
+        def download
+          infom 'Downloading dump...'
+          download_path = find_download_path
+          dump_command.system!(output_file: download_path)
+          fatal_error "File \"#{download_path}\" not saved" unless ::File.exist?(download_path)
+          fatal_error "File \"#{download_path}\" is empty" if ::File.zero?(download_path)
+          download_path
+        end
+
+        def move_download_to_final_dest(download_path)
+          ::FileUtils.mkdir_p(::File.dirname(data_file_path))
+          ::FileUtils.mv(download_path, data_file_path)
+        end
+
+        def rotate
+          return unless data_file_exist?
+          return unless existing == EXISTING_ROTATE
+
+          infom "Rotating \"#{data_file_path}\"..."
+          ::Avm::Data::Rotate.new(data_file_path).run
+        end
+
+        def new_build_path
+          f = ::Tempfile.new(self.class.name.parameterize + '-download')
+          path = f.path
+          f.close
+          f.unlink
+          path
+        end
+
+        def dump_units_to_build_directory
+          dir = ::Dir.mktmpdir
+          package.dump_units_to_directory(dir)
+          dir
+        end
+
+        def create_package_file(build_dir)
+          package_path = new_build_path
+          infom "Creating package \"#{package_path}\" from \"#{build_dir}\"..."
+          Dir.chdir(build_dir) do
+            ::Minitar.pack('.', File.open(::File.expand_path(package_path), 'wb'))
+          end
+          package_path
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/package/load.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'minitar'
+
+module Avm
+  module Data
+    class Package
+      class Load
+        enable_speaker
+
+        attr_reader :package, :data_file_path
+
+        def initialize(package, data_file_path)
+          @package = package
+          @data_file_path = data_file_path
+        end
+
+        def runnable?
+          cannot_run_reason.blank?
+        end
+
+        def cannot_run_reason
+          return nil if data_file_exist?
+
+          "Data file \"#{data_file_path}\" does not exist"
+        end
+
+        def run
+          raise "Cannot run: #{cannot_run_reason}" unless runnable?
+
+          build_dir = extract_packages_to_build_directory
+          package.load_units_from_directory(build_dir)
+        end
+
+        def data_file_exist?
+          ::File.exist?(data_file_path)
+        end
+
+        def extract_packages_to_build_directory
+          dir = ::Dir.mktmpdir
+          ::Minitar.unpack(data_file_path, dir)
+          dir
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/package.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'avm/data/package/dump'
+require 'avm/data/package/load'
+
+module Avm
+  module Data
+    class Package
+      attr_reader :units
+
+      def initialize(options)
+        @units = {}
+        options = options.to_options_consumer
+        units = options.consume(:units)
+        options.validate
+        units.if_present do |v|
+          v.each { |identifier, unit| add_unit(identifier, unit) }
+        end
+      end
+
+      def add_unit(identifier, unit)
+        @units[identifier.to_sym] = unit
+      end
+
+      def dump(data_path, options = {})
+        ::Avm::Data::Package::Dump.new(self, data_path, options)
+      end
+
+      def load(data_path)
+        ::Avm::Data::Package::Load.new(self, data_path)
+      end
+
+      def dump_units_to_directory(directory)
+        @units.each { |identifier, unit| unit.dump_to_directory(directory, identifier) }
+      end
+
+      def load_units_from_directory(directory)
+        @units.each { |identifier, unit| unit.load_from_directory(directory, identifier) }
+      end
+    end
+  end
+end

data/lib/avm/{files → data}/rotate.rb

@@ -4,7 +4,7 @@ require 'active_support/core_ext/object/blank'
 require 'eac_ruby_utils/simple_cache'
 
 module Avm
-  module Files
+  module Data
     class Rotate
       include ::EacRubyUtils::SimpleCache
 

data/lib/avm/data/unit.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'active_support/callbacks'
+
+module Avm
+  module Data
+    class Unit
+      include ::ActiveSupport::Callbacks
+
+      define_callbacks :dump, :load
+      enable_speaker
+
+      %w[dump load].each do |action|
+        method_name = "#{action}_command"
+        class_eval <<~CODE, __FILE__, __LINE__ + 1
+          # Should be overrided.
+          # @return [EacRubyUtils::Envs::Command]
+          def #{method_name}
+            fail "\\"#{method_name}\\" is a abstract method. Override in #{singleton_class}."
+          end
+        CODE
+
+        # Callbacks
+        %w[before after].each do |callback|
+          method = "#{callback}_#{action}"
+          class_eval <<~CODE, __FILE__, __LINE__ + 1
+            def self.#{method}(callback_method = nil, &block)
+              if callback_method
+                set_callback :#{action}, :#{callback}, callback_method
+              else
+                set_callback :#{action}, :#{callback}, &block
+              end
+              self
+            end
+
+            def #{method}(callback_method = nil, &block)
+              singleton_class.#{method}(callback_method, &block)
+              self
+            end
+          CODE
+        end
+      end
+
+      def extension
+        singleton_class.const_get('EXTENSION')
+      rescue NameError
+        ''
+      end
+
+      def name
+        self.class
+      end
+
+      def load_from_directory(directory, identifier)
+        load(unit_on_directory_path(directory, identifier))
+      end
+
+      def dump_to_directory(directory, identifier)
+        dump(unit_on_directory_path(directory, identifier))
+      end
+
+      def dump(data_path)
+        run_callbacks :dump do
+          infom "Dumping unit \"#{name}\" to \"#{data_path}\"..."
+          do_dump(data_path)
+        end
+      end
+
+      def load(data_path)
+        run_callbacks :load do
+          infom "Loading unit \"#{name}\" from \"#{data_path}\"..."
+          do_load(data_path)
+        end
+      end
+
+      protected
+
+      def do_dump(data_path)
+        dump_command.execute!(output_file: data_path)
+      end
+
+      def do_load(data_path)
+        load_command.execute!(input_file: data_path)
+      end
+
+      private
+
+      def unit_on_directory_path(directory, identifier)
+        ::File.join(directory, "#{identifier}#{extension}")
+      end
+    end
+  end
+end

data/lib/avm/docker/runner.rb

@@ -13,6 +13,7 @@ module Avm
 
       runner_with :help do
         desc 'Manipulate Docker images.'
+        bool_opt '-I', '--image-name', 'Output image name.'
         arg_opt '-n', '--registry-name', 'Docker registry\'s name.'
         bool_opt '-p', '--push', 'Push the image to Docker registry.'
         bool_opt '-r', '--run', 'Run or start a container with builded image.'
@@ -27,6 +28,7 @@ module Avm
         setup
         banner
         build
+        output_image_name
         push
         container_run
       end
@@ -84,6 +86,12 @@ module Avm
         )
       end
 
+      def output_image_name
+        return unless parsed.image_name
+
+        out(docker_image.tag.to_s.strip + "\n")
+      end
+
       def registry_uncached
         registry_from_option || registry_from_instance || registry_from_default ||
           fatal_error('No registry defined')

data/lib/avm/instances/application.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'avm/instances/entries'
+
+module Avm
+  module Instances
+    class Application
+      include ::Avm::Instances::Entries
+
+      attr_reader :id
+
+      def initialize(id)
+        @id = id.to_s
+      end
+
+      def to_s
+        id
+      end
+
+      def instance(suffix)
+        ::Avm::Instances::Base.new(self, suffix)
+      end
+    end
+  end
+end

data/lib/avm/instances/base/auto_values/access.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Avm
+  module Instances
+    class Base
+      module AutoValues
+        module Access
+          def auto_access
+            read_entry_optional('ssh.url').present? ? 'ssh' : 'local'
+          end
+
+          def auto_ssh_hostname
+            inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, 'ssh.hostname')
+          end
+
+          def auto_ssh_port
+            inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, 'ssh.port') || 22
+          end
+
+          def auto_ssh_username
+            inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, 'ssh.username')
+          end
+
+          def auto_ssh_url
+            inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, 'ssh.url') ||
+              auto_ssh_url_by_parts
+          end
+
+          def auto_ssh_url_by_parts
+            read_entry_optional('ssh.hostname').if_present do |a|
+              a = read_entry_optional('ssh.username').if_present(a) { |v| "#{v}@#{a}" }
+              a = read_entry_optional('ssh.port').if_present(a) { |v| "#{a}:#{v}" }
+              "ssh://#{a}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/instances/base/auto_values/admin.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Avm
+  module Instances
+    class Base
+      module AutoValues
+        module Admin
+          def auto_admin_email
+            inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, 'admin.email')
+          end
+
+          def auto_admin_name
+            inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, 'admin.name')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'avm/data/package/dump'
+require 'avm/self/instance'
+
+module Avm
+  module Instances
+    class Base
+      module AutoValues
+        module Data
+          def auto_data_default_dump_path
+            ::Avm::Self
+              .instance
+              .read_entry_optional(::Avm::Self::Instance::EntryKeys::DATA_DEFAULT_PATH)
+              .if_present do |v|
+              ::File.join(
+                v,
+                "#{id}#{::Avm::Data::Instance::Package::Dump::DEFAULT_FILE_EXTENSION}"
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/instances/base/auto_values/database.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'avm/instances/entry_keys'
+
+module Avm
+  module Instances
+    class Base
+      module AutoValues
+        module Database
+          DEFAULT_HOSTNAME = '127.0.0.1'
+          DEFAULT_LIMIT = 5
+          DEFAULT_PORTS = {
+            'postgresql' => 5432,
+            'mysql' => 3306,
+            'oracle' => 1521,
+            'sqlserver' => 1433
+          }.freeze
+          DEFAULT_SYSTEM = 'postgresql'
+          DEFAULT_TIMEOUT = 5000
+
+          def auto_database_name
+            inherited_entry_value(::Avm::Instances::EntryKeys::DATABASE_ID,
+                                  ::Avm::Instances::EntryKeys::DATABASE_NAME) || id
+          end
+
+          def auto_database_hostname
+            database_auto_common('hostname') || DEFAULT_HOSTNAME
+          end
+
+          def auto_database_limit
+            database_auto_common('limit') || DEFAULT_LIMIT
+          end
+
+          def auto_database_password
+            database_auto_common('password')
+          end
+
+          def auto_database_port
+            database_auto_common('port') || database_port_by_system
+          end
+
+          def auto_database_username
+            database_auto_common('username')
+          end
+
+          def auto_database_system
+            database_auto_common('system') || DEFAULT_SYSTEM
+          end
+
+          def auto_database_timeout
+            database_auto_common('timeout') || DEFAULT_TIMEOUT
+          end
+
+          private
+
+          def database_auto_common(suffix)
+            database_key = ::Avm::Instances::EntryKeys.const_get("database_#{suffix}".upcase)
+            inherited_entry_value(::Avm::Instances::EntryKeys::DATABASE_ID, database_key) ||
+              inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, database_key)
+          end
+
+          def database_port_by_system
+            read_entry_optional(::Avm::Instances::EntryKeys::DATABASE_SYSTEM).if_present do |v|
+              DEFAULT_PORTS.fetch(v)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/instances/base/auto_values/filesystem.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Avm
+  module Instances
+    class Base
+      module AutoValues
+        module Filesystem
+          FS_PATH_KEY = :fs_path
+
+          def auto_fs_path
+            inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, FS_PATH_KEY) do |v|
+              v + '/' + id
+            end
+          end
+
+          def auto_data_fs_path
+            inherited_entry_value(::Avm::Instances::EntryKeys::HOST_ID, :data_fs_path) do |v|
+              v + '/' + id
+            end
+          end
+
+          def auto_fs_url
+            auto_fs_url_with_ssh || auto_fs_url_without_ssh
+          end
+
+          def auto_fs_url_with_ssh
+            read_entry_optional('ssh.url').if_present do |ssh_url|
+              read_entry_optional('fs_path').if_present do |fs_path|
+                "#{ssh_url}#{fs_path}"
+              end
+            end
+          end
+
+          def auto_fs_url_without_ssh
+            return nil if read_entry_optional('ssh.url').present?
+
+            read_entry_optional('fs_path').if_present do |fs_path|
+              "file://#{fs_path}"
+            end
+          end
+        end
+      end
+    end
+  end
+end