avm-tools 0.68.0 → 0.70.0

data/lib/avm/eac_webapp_base0/deploy/appended_directories.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'avm/path_string'
+
+module Avm
+  module EacWebappBase0
+    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[:appended_directories] || []
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/deploy/file_unit.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    class Deploy
+      class FileUnit < ::SimpleDelegator
+        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 run
+          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.read_entry(:data_fs_path), data_key.to_s)
+        end
+
+        def target_path
+          ::File.join(instance.read_entry(::Avm::Instances::EntryKeys::FS_PATH),
+                      fs_path_subpath.to_s)
+        end
+
+        def link_source_target
+          infom "Linking \"#{data_key}\" directory..."
+          instance.host_env.command('rm', '-rf', target_path).execute!
+          instance.host_env.command('ln', '-s', source_path, target_path).execute!
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/deploy/git_info.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    class Deploy
+      module GitInfo
+        def commit_sha1_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_reference
+          options[: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
+          git.remote_hashs(git_remote_name)
+        end
+
+        def git_remote_name
+          ::Avm::Git::DEFAULT_REMOTE_NAME
+        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
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/deploy/version.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacWebappBase0
+    class Deploy
+      module Version
+        VERSION_TARGET_PATH = 'VERSION'
+
+        def version
+          ([::Time.now, commit_sha1] + version_git_refs).join('|')
+        end
+
+        def version_git_refs
+          git_remote_hashs.select { |_name, sha1| sha1 == commit_sha1 }.keys
+                          .map { |ref| ref.gsub(%r{\Arefs/}, '') }.reject { |ref| ref == 'HEAD' }
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/instance.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'avm/instances/base'
+require 'avm/stereotypes/postgresql/instance_with'
+require 'avm/data/instance/files_unit'
+require 'avm/data/instance/package'
+require 'avm/eac_webapp_base0/deploy/file_unit'
+
+module Avm
+  module EacWebappBase0
+    class Instance < ::Avm::Instances::Base
+      include ::Avm::Stereotypes::Postgresql::InstanceWith
+
+      def stereotype_name
+        self.class.name.desconstantize.demodulize
+      end
+
+      def data_dump(argv = [])
+        run_subcommand(::Avm::Tools::Runner::EacWordpressBase0::Data::Dump, argv)
+      end
+
+      def data_dump_runner_class
+        "::Avm::Tools::Runner::#{stereotype_name}::Data::Dump".constantize
+      end
+
+      def run_subcommand(subcommand_class, argv)
+        parent = ::OpenStruct.new(instance: self)
+        subcommand_class.new(argv: argv, parent: parent).run
+      end
+
+      def data_package
+        @data_package ||= ::Avm::Data::Instance::Package.new(
+          self, units: { database: database_unit }.merge(files_units)
+        )
+      end
+
+      def database_unit
+        pg.data_unit
+      end
+
+      private
+
+      def files_units
+        self.class.const_get('FILES_UNITS').transform_values do |fs_path_subpath|
+          ::Avm::Data::Instance::FilesUnit.new(self, fs_path_subpath)
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/runner/apache_host.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'eac_cli/default_runner'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module EacWebappBase0
+    module Runner
+      class ApacheHost < ::EacRubyUtils::Console::DocoptRunner
+        include ::EacCli::DefaultRunner
+
+        stereotype_name = name.deconstantize.demodulize
+        runner_definition do
+          desc "Configure Apache virtual host for #{stereotype_name} instance."
+          bool_opt '-c', '--certbot', 'Install certbot.'
+        end
+
+        def run
+          options
+          result = stereotype_apache_host_class.new(context(: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
+          "#{context(:instance).class.name.deconstantize}::ApacheHost".constantize
+        end
+
+        def stereotype_apache_host_options
+          { certbot: options.fetch('--certbot') }
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/runner/data.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/console/docopt_runner'
+require 'eac_ruby_utils/require_sub'
+
+module Avm
+  module EacWebappBase0
+    module Runner
+      class Data < ::EacRubyUtils::Console::DocoptRunner
+        ::EacRubyUtils.require_sub(__FILE__)
+
+        DOC = <<~DOCOPT
+          Data utilities for EacRailsBase0 instances.
+
+          Usage:
+            __PROGRAM__ __SUBCOMMANDS__
+            __PROGRAM__ -h | --help
+
+          Options:
+            -h --help             Show this screen.
+        DOCOPT
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/runner/data/dump.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/numeric/time'
+require 'eac_ruby_utils/console/speaker'
+require 'eac_ruby_utils/simple_cache'
+require 'avm/data/package/dump'
+
+module Avm
+  module EacWebappBase0
+    module Runner
+      class Data < ::EacRubyUtils::Console::DocoptRunner
+        class Dump < ::EacRubyUtils::Console::DocoptRunner
+          include ::EacRubyUtils::SimpleCache
+          include ::EacRubyUtils::Console::Speaker
+
+          DUMP_EXPIRE_TIME = 1.day
+          DEFAULT_DUMP_PATH_ENTRY_SUFFIX = 'data.default_dump_path'
+          NO_DUMP_MESSAGE = 'Dump "%s" already exist and rewrite options was no setted nor ' \
+            'dump was expired.'
+
+          DOC = <<~DOCUMENT
+            Dump utility for EacRailsBase instance.
+
+                Usage:
+                __PROGRAM__ [options]
+
+              Options:
+                -h --help               Show this screen.
+                --rewrite               Forces dump overwrite.
+                --dump-path=<dump_path> Set DUMP_PATH variable.
+          DOCUMENT
+
+          def run
+            infov 'Instance to dump', "#{context(:instance)} (#{context(:instance).class})"
+            if package_dump.runnable?
+              package_dump.run
+            else
+              warn(package_dump.cannot_run_reason)
+            end
+            success("Dump path: \"#{dump_path}\"")
+            dump_path
+          end
+
+          private
+
+          def package_dump_uncached
+            context(:instance).data_package.dump(dump_path, existing: package_dump_existing)
+          end
+
+          def dump_path
+            options.fetch('--dump-path') || default_dump_path
+          end
+
+          def default_dump_path
+            context(:instance).read_entry(DEFAULT_DUMP_PATH_ENTRY_SUFFIX)
+          end
+
+          def package_dump_existing
+            if options.fetch('--rewrite')
+              ::Avm::Data::Package::Dump::EXISTING_ROTATE
+            else
+              ::Avm::Data::Package::Dump::EXISTING_ROTATE_EXPIRED
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/runner/data/load.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/numeric/time'
+require 'eac_ruby_utils/console/speaker'
+require 'eac_ruby_utils/simple_cache'
+
+module Avm
+  module EacWebappBase0
+    module Runner
+      class Data < ::EacRubyUtils::Console::DocoptRunner
+        class Load < ::EacRubyUtils::Console::DocoptRunner
+          include ::EacRubyUtils::SimpleCache
+          include ::EacRubyUtils::Console::Speaker
+
+          DOC = <<~DOCUMENT
+            Load utility for EacRailsBase instance.
+
+            Usage:
+              __PROGRAM__ (<dump-path>|--source-instance=<source-instance>)
+              __PROGRAM__ -h | --help
+
+            Options:
+              -h --help                               Show this screen.
+              -S --source-instance=<source-instance>  Informa a instância a ser extraída o dump.
+          DOCUMENT
+
+          def run
+            return ::Dev::Result.error("Dump \"#{dump_path}\" does not exist") unless
+            ::File.exist?(dump_path)
+
+            load_dump
+            success("Dump loaded from \"#{dump_path}\"")
+          end
+
+          def dump_path_uncached
+            return options.fetch('<dump-path>').to_s if options.fetch('<dump-path>').present?
+            return source_instance_dump_path if options.fetch('--source-instance').present?
+
+            raise "Dump path unknown (Options: #{options})"
+          end
+
+          def source_instance_dump_path
+            context(:instance).class.by_id(
+              options.fetch('--source-instance')
+            ).data_dump
+          end
+
+          def load_dump
+            info "Loading dump \"#{dump_path}\"..."
+            package_load.run
+          end
+
+          def dump_instance_method
+            :dump_database
+          end
+
+          private
+
+          def package_load_uncached
+            context(:instance).data_package.load(dump_path)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/eac_webapp_base0/runner/deploy.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'avm/path_string'
+require 'eac_ruby_utils/console/docopt_runner'
+require 'eac_ruby_utils/console/speaker'
+
+module Avm
+  module EacWebappBase0
+    module Runner
+      class Deploy < ::EacRubyUtils::Console::DocoptRunner
+        include ::EacRubyUtils::Console::Speaker
+
+        DOC = <<~DOCOPT
+          Deploy for %%STEREOTYPE_NAME%% instance.
+
+          Usage:
+            __PROGRAM__ [options]
+            __PROGRAM__ -h | --help
+
+          Options:
+            -h --help                       Show this screen.
+            -r --reference=<git-reference>  Git reference to deploy.
+            -a --append-dirs=<append-dirs>  Append directories to deploy (List separated by ":").
+        DOCOPT
+        def initialize(settings = {})
+          super settings.merge(doc: DOC.gsub('%%STEREOTYPE_NAME%%', stereotype_name))
+        end
+
+        def deploy_class
+          stereotype_module.const_get('Deploy')
+        end
+
+        def stereotype_module
+          ::Avm::Stereotypes.const_get(stereotype_name)
+        rescue ::NameError
+          ::Avm.const_get(stereotype_name)
+        end
+
+        def stereotype_name
+          self.class.name.deconstantize.demodulize
+        end
+
+        def run
+          result = deploy_class.new(context(:instance), deploy_options).run
+          if result.error?
+            fatal_error result.to_s
+          else
+            infov 'Result', result.label
+          end
+        end
+
+        def deploy_options
+          { reference: options.fetch('--reference'),
+            appended_directories: ::Avm::PathString.paths(options.fetch('--append-dirs')) }
+        end
+      end
+    end
+  end
+end