eac_tools 0.117.3 → 0.117.4

data/sub/avm-eac_latex_base0/template/avm/eac_latex_base0/sources/build/commons/source_code.tex

@@ -0,0 +1,21 @@
+\usepackage[dvipsnames]{xcolor}
+\usepackage{listings}
+\usepackage{courier}
+\usepackage[T1]{fontenc}
+\usepackage{textcomp}
+\definecolor{code_background}{rgb}{0.95,0.95,0.95}
+\lstset{
+  backgroundcolor=\color{code_background},
+  breakatwhitespace=false,
+  breaklines=true,
+  basicstyle=\ttfamily\color{black},
+  commentstyle = \ttfamily\color{gray},
+  keywordstyle=\ttfamily\color{blue},
+  stringstyle=\color{orange},
+  showstringspaces=false,
+  frame=single,
+  basicstyle=\ttfamily\tiny,
+  columns=flexible,
+  upquote=true,
+}
+\input{commons/source_code/java}

data/sub/avm-eac_latex_base0/template/avm/eac_latex_base0/sources/build/commons/utils.tex

@@ -0,0 +1,6 @@
+\newcommand{\todo}[0] {
+  \textcolor{red}{\textbf{TO-DO}}
+}
+\newcommand{\dq}[1] {
+  ``#1''
+}

data/sub/avm-eac_rails_base1/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.local
+Gemfile.lock

data/sub/avm-eac_rails_base1/.gitrepo

@@ -0,0 +1,7 @@
+[subrepo]
+  cmdver = 0.4.9
+  commit = 74a3df0e09901c83bb688792bc60e15a664b4e5f
+  method = merge
+  parent = 2d7b629470216206c8e84136f32a0a30d4883a93
+  branch = master
+  remote = https://github.com/esquilo-azul/avm-eac_rails_base1.git

data/sub/avm-eac_rails_base1/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/sub/avm-eac_rails_base1/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+inherit_gem:
+  eac_ruby_gem_support: ".rubocop.yml"

data/sub/avm-eac_rails_base1/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+local_gemfile = File.join(File.dirname(__FILE__), 'Gemfile.local')
+eval_gemfile local_gemfile if File.exist?(local_gemfile)

data/sub/avm-eac_rails_base1/avm-eac_rails_base1.gemspec

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'avm/eac_rails_base1/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'avm-eac_rails_base1'
+  s.version     = Avm::EacRailsBase1::VERSION
+  s.authors     = ['Put here the authors']
+  s.summary     = 'Put here de description.'
+
+  s.files = Dir['{lib,template}/**/*']
+  s.required_ruby_version = '>= 3.2'
+
+  s.add_dependency 'avm', '~> 0.102', '>= 0.102.3'
+  s.add_dependency 'avm-eac_ruby_base1', '~> 0.43', '>= 0.43.2'
+  s.add_dependency 'avm-eac_webapp_base0', '~> 0.22', '>= 0.22.3'
+  s.add_dependency 'eac_ruby_base1', '~> 0.1', '>= 0.1.1'
+
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.14'
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/apache_base.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module ApacheBase
+        # @return [String]
+        def document_root
+          ::File.join(super, 'public')
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/apache_host.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      class ApacheHost < ::Avm::EacWebappBase0::Instances::ApacheHost
+        prepend ::Avm::EacRailsBase1::Instances::ApacheBase
+
+        def extra_content
+          'PassengerEnabled On'
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/apache_path.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      class ApachePath < ::Avm::EacWebappBase0::Instances::ApachePath
+        prepend ::Avm::EacRailsBase1::Instances::ApacheBase
+
+        # @return [String]
+        def extra_content
+          ::Avm::EacRailsBase1::Instances::ApachePath.eac_template.child('extra_content.conf')
+            .apply(variables_source)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      class Base < ::Avm::EacWebappBase0::Instances::Base
+        module Install
+          DEFAULT_INSTALL_PASSENGER_START_TIMEOUT = 300
+
+          common_concern do
+            uri_components_entries_values 'install', %w[passenger_start_timeout]
+          end
+
+          def install_passenger_start_timeout_default_value
+            DEFAULT_INSTALL_PASSENGER_START_TIMEOUT
+          end
+
+          def install_request_test_timeout_default_value
+            install_passenger_start_timeout
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      class Base < ::Avm::EacWebappBase0::Instances::Base
+        include ::Avm::EacRubyBase1::Instances::Mixin
+
+        DEFAULT_RAILS_ENVIRONMENT = 'production'
+
+        def bundle(*)
+          the_gem.bundle(*).chdir_root.envvar('RAILS_ENV', DEFAULT_RAILS_ENVIRONMENT)
+        end
+
+        # @return [Avm::Instances::Data::Package]
+        def data_package_create
+          super.add_unit('database', database_unit)
+        end
+
+        # @return [Addressable::URI]
+        def gemfile_source
+          application.local_source.gemfile_source
+        end
+
+        # @return [Array<Avm::Instances::Process>]
+        def processes
+          super + [::Avm::EacRailsBase1::Instances::Processes::TasksScheduler.new(self)]
+        end
+
+        def rake(*)
+          bundle('exec', 'rake', *)
+        end
+
+        def the_gem
+          @the_gem ||= ::Avm::EacRubyBase1::Sources::Base.new(
+            ::File.join(read_entry('install.path'))
+          ).env_set(host_env)
+        end
+
+        require_sub __FILE__, include_modules: :prepend
+      end
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      class Deploy < ::Avm::EacWebappBase0::Instances::Deploy
+        set_callback :write_on_target, :before do
+          check_rubygems_access
+        end
+
+        # @return [void]
+        # @raise [EacEnvs::Http::Error]
+        def check_rubygems_access
+          infom "Checkin access to gems provider (\"#{instance.gemfile_source}\")..."
+          ::EacEnvs::Http::Request.new.url(instance.gemfile_source).response.body_data_or_raise
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/processes/daemon.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Processes
+        class Daemon < ::Avm::Instances::Process
+          acts_as_abstract :command_name, :gem_name
+
+          # @return [Boolean]
+          def available?
+            instance.application.local_source.gemfile_lock_gem_version(gem_name).present?
+          end
+
+          def disable
+            daemon_command(:stop).system!
+          end
+
+          def enable
+            daemon_command(:start).system!
+          end
+
+          def enabled?
+            daemon_command(:status).execute.fetch(:exit_code).zero?
+          end
+
+          private
+
+          def daemon_command(action)
+            instance.bundle('exec', command_name, action)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/processes/tasks_scheduler.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Processes
+        class TasksScheduler < ::Avm::EacRailsBase1::Instances::Processes::Daemon
+          GEM_NAME = 'tasks_scheduler'
+          COMMAND_NAME = 'tasks_scheduler'
+
+          # @return [String]
+          def command_name
+            COMMAND_NAME
+          end
+
+          # @return [String]
+          def gem_name
+            GEM_NAME
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/runners/bundle.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Runners
+        class Bundle
+          runner_with ::Avm::EacRailsBase1::RunnerWith::Bundle, :help do
+            desc 'Runs "bundle ...".'
+            pos_arg :'bundle-args', repeat: true, optional: true
+          end
+
+          def run
+            bundle_run
+          end
+
+          def bundle_args
+            parsed.bundle_args.reject { |arg| arg == '--' }
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/runners/code_runner.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Runners
+        class CodeRunner
+          runner_with :help, ::Avm::EacRailsBase1::RunnerWith::Bundle do
+            desc 'Runs a Ruby code with "rails runner".'
+            pos_arg :code
+          end
+
+          def run
+            infov 'Environment', runner_context.call(:instance).host_env
+            bundle_run
+          end
+
+          def bundle_args
+            %w[exec rails runner] + [parsed.code]
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/runners/log.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Runners
+        class Log
+          runner_with :help, ::Avm::EacRailsBase1::RunnerWith::RailsEnvironment do
+            desc 'Read application\'s log.'
+            bool_opt '-f', '--follow', 'Output appended data as the log grows.'
+          end
+
+          def run
+            start_banner
+            tail_command.system
+          end
+
+          private
+
+          def log_path
+            ::File.join(rails_instance.read_entry('install.path'), 'log',
+                        "#{rails_environment}.log")
+          end
+
+          def start_banner
+            infov 'Environment', rails_environment
+            infov 'Log path', log_path
+          end
+
+          def tail_command
+            rails_instance.host_env.command(*tail_command_args)
+          end
+
+          def tail_command_args
+            r = %w[tail]
+            r << '--follow' if parsed.follow?
+            r + [log_path]
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/runners/logs/clear.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Runners
+        class Logs
+          class Clear
+            runner_with :help, ::Avm::EacRailsBase1::RunnerWith::Bundle do
+              desc 'Clear logs.'
+            end
+
+            def run
+              bundle_run
+            end
+
+            def bundle_args
+              %w[exec rake log:clear]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/runners/logs.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Runners
+        class Logs
+          runner_with :help, :subcommands do
+            desc 'Manipule multiple application\'s logs.'
+            subcommands
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/runners/rails_server.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'shellwords'
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Runners
+        class RailsServer
+          DEFAULT_RAILS_ENVIRONMENT = 'development'
+          runner_with :help, ::Avm::EacRailsBase1::RunnerWith::Bundle do
+            desc 'Run the embbeded Rails web server.'
+          end
+
+          def run
+            infov 'Environment', rails_environment
+            infov 'Bundle args', ::Shellwords.join(bundle_args)
+            infov 'Result', bundle_command.system
+          end
+
+          protected
+
+          def bundle_args
+            ['exec', 'rails', 'server', '--port',
+             runner_context.call(:instance).read_entry(::Avm::Instances::EntryKeys::WEB_PORT)]
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/runners/tasks_scheduler/systemd_unit.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Runners
+        class TasksScheduler
+          class SystemdUnit
+            DEFAULT_RESTART = 'on-failure'
+
+            runner_with :help do
+              desc 'Configure Systemd unit for instace\'s tasks scheduler daemon (Reference: ' \
+                   'https://www.freedesktop.org/software/systemd/man/systemd.service.html).'
+              bool_opt '-e', '--exec-run', 'Run daemon with "run" instead of "start"/"stop".'
+              arg_opt '-r', '--restart', 'Value for systemd.service, Restart=.',
+                      default: DEFAULT_RESTART
+            end
+
+            delegate :restart, to: :parsed
+
+            def run
+              if result.error?
+                fatal_error result.to_s
+              else
+                infov 'Result', result.label
+              end
+            end
+
+            private
+
+            def systemd_unit_uncached
+              ::Avm::EacRailsBase1::Instances::SystemdUnit.new(runner_context.call(:instance),
+                                                               restart: parsed.restart,
+                                                               exec_run: parsed.exec_run?)
+            end
+
+            def result_uncached
+              systemd_unit.run
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/runners/tasks_scheduler.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      module Runners
+        class TasksScheduler
+          runner_with :help, :subcommands do
+            subcommands
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/systemd_unit/service.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      class SystemdUnit
+        module Service
+          def service_content
+            eac_template.child('tasks_scheduler.service').apply(variables_source)
+          end
+
+          def service_exec_lines
+            service_exec_operations
+              .map { |k, v| "#{k}=#{tasks_scheduler_command_path} #{v}" }
+              .join("\n")
+          end
+
+          def service_path
+            ::Pathname.new('/etc/systemd/system').join(unit_name)
+          end
+
+          def service_link_path
+            ::Pathname.new('/etc/systemd/system/multi-user.target.wants').join(unit_name)
+          end
+
+          def verify_service
+            sudo_system!('systemd-analyze', 'verify', service_path)
+          end
+
+          private
+
+          def enable_service
+            systemctl('enable', unit_name)
+          end
+
+          def link_service
+            sudo_execute!('rm', '-f', service_link_path)
+            sudo_execute!('ln', '-s', service_path, service_link_path)
+          end
+
+          def reload_systemd
+            systemctl('daemon-reload')
+          end
+
+          # @return [Hash<String, String>]
+          def service_exec_operations
+            if exec_run?
+              { 'ExecStart' => 'run' }
+            else
+              { 'ExecStart' => 'start', 'ExecStop' => 'stop' }
+            end
+          end
+
+          def start_service
+            systemctl('start', unit_name)
+          end
+
+          def systemctl(*)
+            sudo_system!('systemctl', *)
+          end
+
+          def write_service
+            infom 'Writing service\'s unit file...'
+            platform_instance.file_sudo_write(service_path, service_content)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/systemd_unit/tasks_scheduler_command.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      class SystemdUnit
+        module TasksSchedulerCommand
+          def tasks_scheduler_command_content
+            eac_template.child('tasks_scheduler_command.sh').apply(variables_source)
+          end
+
+          def tasks_scheduler_command_path
+            "/opt/aux/#{instance.id}/tasks_scheduler.sh"
+          end
+
+          private
+
+          def write_tasks_scheduler_command
+            infom 'Writing tasks scheduler\'s command...'
+            sudo_execute!('mkdir', '-p', ::File.dirname(tasks_scheduler_command_path))
+            platform_instance.file_sudo_write(tasks_scheduler_command_path,
+                                              tasks_scheduler_command_content)
+            sudo_execute!('chmod', '+x', tasks_scheduler_command_path)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-eac_rails_base1/lib/avm/eac_rails_base1/instances/systemd_unit.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Avm
+  module EacRailsBase1
+    module Instances
+      class SystemdUnit
+        JOBS = %w[write_tasks_scheduler_command write_service link_service verify_service
+                  reload_systemd enable_service start_service].freeze
+
+        include ::Avm::Entries::Jobs::Base
+
+        require_sub __FILE__, include_modules: true
+        delegate :platform_instance, to: :instance
+
+        enable_listable
+        lists.add_symbol :option, :exec_run, :restart
+
+        def description
+          "#{instance.id} Tasks Scheduler"
+        end
+
+        def exec_run?
+          options[OPTION_EXEC_RUN]
+        end
+
+        def option_list
+          self.class.lists.option
+        end
+
+        def restart
+          options[OPTION_RESTART]
+        end
+
+        def unit_name
+          "#{instance.id}_tasks_scheduler.service"
+        end
+
+        def user
+          instance.install_username
+        end
+
+        private
+
+        def sudo_execute!(*args)
+          platform_instance.host_env.command(['sudo'] + args).execute!
+        end
+
+        def sudo_system!(*args)
+          command_args = ['sudo'] + args
+          infom "Running \"#{::Shellwords.join(command_args)}\"..."
+          platform_instance.host_env.command(command_args).system!
+        end
+      end
+    end
+  end
+end