eac_tools 0.126.0 → 0.126.1

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/base/deploy.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        module Deploy
+          common_concern
+
+          # @param options [Class<Avm::EacWebappBase0::Instances::Deploy>]
+          def deploy_class
+            application.stereotype.namespace_module.const_get('Instances').const_get('Deploy')
+          end
+
+          # @param options [Hash]
+          # return [Avm::EacWebappBase0::Instances::Deploy]
+          def deploy_instance(**options)
+            deploy_class.new(self, options)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/base/deploy_info.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        module DeployInfo
+          common_concern
+
+          DEPLOY_INFO_SUBPATH = '.deploy.yaml'
+
+          # @return [Avm::EacWebappBase0::Instances::DeployInfo]
+          def deploy_info
+            ::Avm::EacWebappBase0::Instances::DeployInfo.from_string(
+              host_env.command('cat', deploy_info_path).execute!
+            )
+          end
+
+          # @return [Pathname]
+          def deploy_info_path
+            install_path.to_pathname.join(DEPLOY_INFO_SUBPATH)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/base/install.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        module Install
+          common_concern do
+            uri_components_entries_values 'install', %w[apache_resource_name request_test_timeout]
+          end
+
+          def install_apache_resource_name_default_value
+            id
+          end
+
+          # @return [Integer]
+          def install_request_test_timeout_default_value
+            ::EacEnvs::Http::Request::FaradayConnection::DEFAULT_TIMEOUT.in_seconds
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Base < ::Avm::Instances::Base
+        require_sub __FILE__, include_modules: true
+        include ::Avm::EacPostgresqlBase0::InstanceWith
+
+        enable_simple_cache
+
+        def run_subcommand(subcommand_class, argv)
+          subcommand_class.create(
+            argv: argv,
+            parent: ::Avm::Instances::Base::SubcommandParent.new(self)
+          ).run
+        end
+
+        def database_unit
+          pg_data_unit
+        end
+
+        # @return [Array<Avm::Instances::Process>]
+        def processes
+          super + [::Avm::EacWebappBase0::Instances::Processes::WebServer.new(self)]
+        end
+
+        private
+
+        # @return [Avm::EacUbuntuBase0::Instances::Base]
+        def platform_instance_uncached
+          ::Avm::EacUbuntuBase0::Instances::Base.by_id(id)
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/appended_directories.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        module AppendedDirectories
+          APPENDED_DIRECTORIES_ENTRY_KEY = 'deploy.appended_directories'
+
+          def appended_directories
+            appended_directories_from_instance_entry + appended_directories_from_options
+          end
+
+          def appended_directories_from_instance_entry
+            ::Avm::PathString.paths(instance.read_entry_optional(APPENDED_DIRECTORIES_ENTRY_KEY))
+          end
+
+          def appended_directories_from_options
+            options[OPTION_APPENDED_DIRECTORIES] || []
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/build.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        module Build
+          enable_memoized
+
+          private
+
+          attr_accessor :build_dir, :source_dir
+
+          def append_instance_content
+            ::Avm::Files::Appender
+              .new
+              .variables_source_set(variables_source)
+              .append_templatized_directory(eac_template)
+              .append_templatized_directories(appended_directories)
+              .append_file_content(version_target_path, version)
+              .write_appended_on(build_dir)
+          end
+
+          def build_dir_env
+            ::EacRubyUtils::Envs.local
+          end
+
+          def create_build_dir
+            self.build_dir = ::EacRubyUtils::Fs::Temp.directory
+          end
+
+          def create_source_dir
+            self.source_dir = ::EacRubyUtils::Fs::Temp.directory
+            infom 'Writing Git source code...'
+            scm.commit(commit_reference).deploy_to_env_path(
+              build_dir_env,
+              source_dir
+            ).variables_source_set(variables_source).run
+          end
+
+          def remove_build_dir
+            build_dir&.remove
+          end
+
+          def remove_source_dir
+            source_dir&.remove
+          end
+
+          # @return [Avm::Sources::Base]
+          memoize def source
+            instance.application.local_source.class.new(source_dir)
+          end
+
+          def build_content
+            ::FileUtils.copy_entry(source_dir.to_path, build_dir.to_path)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/info.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        module Info
+          # @return [Hash]
+          def deploy_info
+            ::Avm::EacWebappBase0::Instances::DeployInfo.from_hash(
+              {
+                instance_id: instance.id,
+                time: ::Time.now,
+                commit_id: commit_reference,
+                commit_refs: version_git_refs,
+                version: version_number
+              }
+            )
+          end
+
+          # @return [String]
+          def version
+            deploy_info.to_yaml
+          end
+
+          def version_git_refs
+            git_remote_hashs.select { |_name, sha1| sha1 == commit_reference }.keys
+              .map { |ref| ref.gsub(%r{\Arefs/}, '') }.reject { |ref| ref == 'HEAD' }
+          end
+
+          # @return [String, nil]
+          def version_number
+            instance.application.local_source.version.if_present(&:to_s)
+          end
+
+          # @return [String]
+          def version_target_path
+            ::Avm::EacWebappBase0::Instances::Base::DeployInfo::DEPLOY_INFO_SUBPATH
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/scm.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        module Scm
+          DEFAULT_REMOTE_NAME = 'origin'
+          DEFAULT_REMOTE_READ = true
+          DEFAULT_REMOTE_WRITE = true
+
+          def commit_reference_uncached
+            git_fetch
+            r = git.rev_parse(git_reference_found)
+            return r if r
+
+            raise ::Avm::Result::Error, "No commit SHA1 found for \"#{git_reference_found}\""
+          end
+
+          def git_fetch_uncached
+            return unless remote_read?
+
+            infom "Fetching remote \"#{git_remote_name}\" from \"#{git_repository_path}\"..."
+            git.remote(git_remote_name).fetch
+          end
+
+          def git_reference
+            options[OPTION_REFERENCE] || DEFAULT_REFERENCE
+          end
+
+          def git_reference_found_uncached
+            %w[git_reference instance_branch master_branch].map { |b| send(b) }.find(&:present?) ||
+              raise(
+                ::Avm::Result::Error,
+                'No git reference found (Searched for option, instance and master)'
+              )
+          end
+
+          def git_remote_hashs_uncached
+            return {} unless remote_read?
+
+            git.remote(git_remote_name).ls.hashes
+          end
+
+          def git_remote_name
+            DEFAULT_REMOTE_NAME
+          end
+
+          def git_repository_path
+            instance.source_instance.read_entry(::Avm::Instances::EntryKeys::INSTALL_PATH)
+          end
+
+          # @return [EacGit::Local]
+          def git_uncached
+            scm.git_repo
+          end
+
+          def instance_branch
+            remote_branch(instance.id)
+          end
+
+          def remote_branch(name)
+            git_remote_hashs.key?("refs/heads/#{name}") ? "#{git_remote_name}/#{name}" : nil
+          end
+
+          def master_branch
+            remote_branch('master')
+          end
+
+          # @return [Boolean]
+          def remote_read?
+            options.if_key(OPTION_REMOTE_READ, DEFAULT_REMOTE_READ).to_bool
+          end
+
+          # @return [Boolean]
+          def remote_write?
+            options.if_key(OPTION_REMOTE_WRITE, DEFAULT_REMOTE_WRITE).to_bool
+          end
+
+          # @return [Avm::Scms::Base]
+          def scm
+            instance.application.local_source.scm
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/setup_files_unit.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        class SetupFilesUnit < ::SimpleDelegator
+          enable_method_class
+          attr_reader :data_key, :fs_path_subpath
+
+          def initialize(deploy, data_key, fs_path_subpath)
+            super(deploy)
+            @data_key = data_key
+            @fs_path_subpath = fs_path_subpath
+          end
+
+          def result
+            assert_source_directory
+            link_source_target
+          end
+
+          def assert_source_directory
+            infom "Asserting \"#{data_key}\" source directory..."
+            instance.host_env.command('mkdir', '-p', source_path).execute!
+          end
+
+          def source_path
+            ::File.join(instance.install_data_path, data_key.to_s)
+          end
+
+          def target_path
+            ::File.join(instance.read_entry(::Avm::Instances::EntryKeys::INSTALL_PATH),
+                        fs_path_subpath.to_s)
+          end
+
+          def link_source_target
+            infom "Linking \"#{data_key}\" directory..."
+            return unless remove_target
+
+            instance.host_env.command('ln', '-s', source_path, target_path).execute!
+          end
+
+          private
+
+          # @return [Boolean]
+          def remove_target # rubocop:disable Naming/PredicateMethod
+            instance.host_env.command('rm', '-rf', target_path).execute.fetch(:exit_code).zero?
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy/write_on_target.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        module WriteOnTarget
+          def write_on_target
+            ::Avm::Files::Deploy.new(
+              instance.host_env,
+              instance.read_entry(::Avm::Instances::EntryKeys::INSTALL_PATH)
+            ).append_plain_directory(build_dir).run
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'net/http'
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class Deploy
+        require_sub __FILE__, include_modules: true, require_mode: :kernel
+
+        DEFAULT_REFERENCE = 'HEAD'
+
+        REQUEST_TEST_JOB = 'request_test'
+        JOBS = (%w[create_build_dir create_source_dir build_content append_instance_content
+                   write_on_target setup_files_units assert_instance_branch] +
+                [REQUEST_TEST_JOB]).freeze
+
+        include ::Avm::Entries::Jobs::Base
+
+        lists.add_symbol :option, :appended_directories, :no_request_test, :reference,
+                         :remote_read, :remote_write
+
+        def option_list
+          ::Avm::EacWebappBase0::Instances::Deploy.lists.option
+        end
+
+        def run
+          super
+        ensure
+          remove_build_dir
+          remove_source_dir
+        end
+
+        def start_banner
+          infov 'Instance', instance
+          infov 'Git reference (User)', git_reference.if_present('- BLANK -')
+          infov 'Git remote name', git_remote_name
+          infov 'Git reference (Found)', git_reference_found
+          infov 'Git commit SHA1', commit_reference
+          infov 'Appended directories', appended_directories
+        end
+
+        def setup_files_units
+          instance.data_package.units.values.map(&:installation_files_data).select(&:present?) # rubocop:disable Rails/CompactBlank
+            .each { |unit_install| setup_files_unit(unit_install.key, unit_install.subpath) }
+        end
+
+        def assert_instance_branch
+          return unless remote_write?
+
+          infom 'Setting instance branch...'
+          git.command('push', git_remote_name, "#{commit_reference}:refs/heads/#{instance.id}",
+                      '-f').execute!
+        end
+
+        def request_test
+          infom 'Requesting web interface...'
+          ::EacEnvs::Http::Request.new.url(instance.read_entry('web.url'))
+            .timeout(instance.install_request_test_timeout).response.raise_unless_200
+        end
+
+        protected
+
+        def jobs
+          r = super
+          r.delete(REQUEST_TEST_JOB) if options[OPTION_NO_REQUEST_TEST]
+          r
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/deploy_info.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      class DeployInfo
+        class << self
+          # @param hash [Hash]
+          # @return [Avm::EacWebappBase0::Instances::DeployInfo]
+          def from_hash(hash)
+            new(hash)
+          end
+
+          # @return string [String]
+          # @return [Avm::EacWebappBase0::Instances::DeployInfo]
+          def from_string(string)
+            from_hash(::EacRubyUtils::Yaml.load(string))
+          end
+        end
+
+        common_constructor :data do
+          self.data = data.with_indifferent_access
+        end
+
+        # @return [Hash]
+        delegate :to_h, to: :data
+
+        # @return [String]
+        def to_yaml
+          ::EacRubyUtils::Yaml.dump(to_h)
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/processes/web_server.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      module Processes
+        class WebServer < ::Avm::Instances::Process
+          def available?
+            instance.apache_resource.present?
+          end
+
+          def enable
+            apache_resource_change(__method__)
+          end
+
+          def enabled?
+            instance.apache_resource.enabled?
+          end
+
+          def disable
+            apache_resource_change(__method__)
+          end
+
+          private
+
+          def apache_resource_change(action)
+            instance.apache_resource.send(action)
+            instance.platform_instance.apache.service(:reload)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/runners/apache_host.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      module Runners
+        class ApacheHost
+          runner_with :help do
+            desc 'Configure Apache virtual host for instance.'
+            bool_opt '-c', '--certbot', 'Install certbot.'
+          end
+
+          def run
+            result = stereotype_apache_host_class.new(runner_context.call(:instance),
+                                                      stereotype_apache_host_options).run
+            if result.error?
+              fatal_error result.to_s
+            else
+              infov 'Result', result.label
+            end
+          end
+
+          def stereotype_apache_host_class
+            "#{runner_context.call(:instance).class.name.deconstantize}::ApacheHost".constantize
+          end
+
+          def stereotype_apache_host_options
+            { certbot: parsed.certbot? }
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/runners/apache_path.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      module Runners
+        class ApachePath
+          runner_with :help do
+            desc 'Configure Apache path configuration for instance.'
+          end
+
+          def run
+            infov 'ApachePath class', stereotype_apache_path_class
+            if result.error?
+              fatal_error result.to_s
+            else
+              infov 'Result', result.label
+            end
+          end
+
+          private
+
+          def apache_path_uncached
+            stereotype_apache_path_class.new(runner_context.call(:instance))
+          end
+
+          def result_uncached
+            apache_path.run
+          end
+
+          def stereotype_apache_path_class
+            runner_context.call(:instance).apache_path_class
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_webapp_base0/lib/avm/eac_webapp_base0/instances/runners/deploy.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    module Instances
+      module Runners
+        class Deploy
+          runner_with :help do
+            desc 'Deploy for instance.'
+            arg_opt '-r', '--reference', 'Git reference to deploy.'
+            arg_opt '-a', '--append-dirs', 'Append directories to deploy (List separated by ":").'
+            bool_opt '-T', '--no-request-test', 'Do not test web interface after deploy.'
+            bool_opt '--no-remote', 'Shortcut to "--no-remote-read --no-remote-write"'
+            bool_opt '--no-remote-read', 'Do not attempt to read on remote repository.'
+            bool_opt '--no-remote-write', 'Do not attempt to write on remote repository.'
+          end
+
+          def run
+            result = runner_context.call(:instance).deploy_instance(**deploy_options).run
+            if result.error?
+              fatal_error result.to_s
+            else
+              infov 'Result', result.label
+            end
+          end
+
+          def deploy_options
+            { reference: parsed.reference,
+              appended_directories: ::Avm::PathString.paths(parsed.append_dirs),
+              no_request_test: parsed.no_request_test?, remote_read: remote_read?,
+              remote_write: remote_write? }
+          end
+
+          # @return [Boolean]
+          def remote_read?
+            !(parsed.no_remote_read? || parsed.no_remote?)
+          end
+
+          # @return [Boolean]
+          def remote_write?
+            !(parsed.no_remote_write? || parsed.no_remote?)
+          end
+        end
+      end
+    end
+  end
+end