eac_tools 0.93.0 → 0.94.0

data/sub/avm-git/spec/lib/avm/git/scms/git/commit/deploy_spec.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'avm/git/scms/git'
+require 'eac_ruby_utils/fs/temp'
+
+RSpec.describe Avm::Git::Scms::Git::Commit::Deploy, :git do
+  class << self
+    FROM_DEPLOY = %w[a.txt b.txt c.txt appended].freeze # rubocop:disable RSpec/LeakyConstantDeclaration
+    NOT_FROM_DEPLOY = %w[to_be_removed].freeze # rubocop:disable RSpec/LeakyConstantDeclaration
+
+    def check_files(from_deploy_exist)
+      if from_deploy_exist
+        check_files_exist(FROM_DEPLOY)
+        check_files_not_exist(NOT_FROM_DEPLOY)
+      else
+        check_files_not_exist(FROM_DEPLOY)
+        check_files_exist(NOT_FROM_DEPLOY)
+      end
+    end
+
+    def check_file_exist(basename)
+      it("expect \"#{basename}\" to exist") { expect(target_dir.join(basename)).to exist }
+    end
+
+    def check_file_not_exist(basename)
+      it("expect \"#{basename}\" to not exist") { expect(target_dir.join(basename)).not_to exist }
+    end
+
+    def check_files_exist(basenames)
+      basenames.each { |basename| check_file_exist(basename) }
+    end
+
+    def check_files_not_exist(basenames)
+      basenames.each { |basename| check_file_not_exist(basename) }
+    end
+  end
+
+  let(:git) { stubbed_git_local_repo }
+
+  let(:commit_sha1) do
+    git.file('a.txt').write('AAA')
+    git.file('b.txt').write('BBB')
+    git.command('add', '.').execute!
+    git.command('commit', '-m', 'First commit.').execute!
+    git.rev_parse('HEAD')
+  end
+
+  let(:appended_dir) do
+    r = EacRubyUtils::Fs::Temp.directory
+    r.join('appended.template').write('Needs a %%ABC%% value.')
+    r
+  end
+
+  let(:target_dir) do
+    r = EacRubyUtils::Fs::Temp.directory
+    FileUtils.touch(r.join('to_be_removed').to_path)
+    r
+  end
+
+  let(:commit) { Avm::Git::Scms::Git.new(git.root_path).commit(commit_sha1) }
+  let(:variables_source_class) do
+    Class.new do
+      attr_reader :abc
+
+      def initialize(abc)
+        @abc = abc
+      end
+    end
+  end
+  let(:variables_source) { variables_source_class.new('Any value') }
+  let(:target_env) { EacRubyUtils::Envs.local }
+  let(:instance) do
+    described_class.new(commit, target_env, target_dir).append_templatized_directory(appended_dir)
+      .append_file_content('c.txt', 'Any content')
+      .variables_source_set(variables_source)
+  end
+
+  after do
+    appended_dir.remove
+    target_dir.remove
+  end
+
+  context 'without run' do # rubocop:disable RSpec/EmptyExampleGroup
+    check_files(false)
+  end
+
+  context 'with run' do # rubocop:disable RSpec/EmptyExampleGroup
+    before { instance.run }
+
+    check_files(true)
+  end
+end

data/sub/avm-git/spec/lib/avm/git/scms/git_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+require 'avm/git/scms/git'
+
+RSpec.describe Avm::Git::Scms::Git do
+  include_examples 'in_avm_registry', 'scms'
+end

data/sub/avm-git/spec/lib/avm/git/scms/git_subrepo_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+require 'avm/git/scms/git_subrepo'
+
+RSpec.describe Avm::Git::Scms::GitSubrepo do
+  include_examples 'in_avm_registry', 'scms'
+end

data/sub/avm-git/spec/lib/avm/git/vendor/github_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'avm/git/vendor/github'
+
+RSpec.describe Avm::Git::Vendor::Github do
+  describe '#to_ssh_url' do
+    SSH_URL = 'git@github.com:esquilo-azul/eac_launcher.git' # rubocop:disable RSpec/LeakyConstantDeclaration, Lint/ConstantDefinitionInBlock
+    NO_SSH_URL = 'https://otherhost.com/esquilo-azul/eac_launcher' # rubocop:disable RSpec/LeakyConstantDeclaration, Lint/ConstantDefinitionInBlock
+
+    {
+      nil => nil,
+      '   ' => nil,
+      'https://github.com/esquilo-azul/eac_launcher' => SSH_URL,
+      'https://github.com/esquilo-azul/eac_launcher.git' => SSH_URL,
+      SSH_URL => SSH_URL,
+      NO_SSH_URL => NO_SSH_URL
+    }.each do |input, expected|
+      it "converts \"#{input}\" to \"#{expected}\"" do
+        expect(described_class.to_ssh_url(input)).to eq(expected)
+      end
+    end
+  end
+end

data/sub/avm-tools/README.textile

@@ -0,0 +1,28 @@
+h1. AVM Tools
+
+h2. Instance's entries suffixes
+
+|_. Name |_. Description |_. Default value |
+| admin.email | Admin's e-mail address | @host_id->admin.email@ |
+| admin.name | Admin's name | @host_id->admin.name@ |
+| access | *@local@* or *@ssh@* | @self->ssh.url ? 'ssh' : 'local'@ |
+| data_fs_path | path to instance's data root directory | @host_id->data_fs_path + '/' + self->id@ |
+| database.id | ID of instance to fetch database parameters | @nil@ |
+| database.limit | Limit of open database connections | @database.id->database.limit or 5 |
+| database.system | *@postgres@* or *@mysql@* or *@oracle@* | @nil@ |
+| database.hostname | hostname of database server | @database.id->database.hostname or host_id->database.hostname or '127.0.0.1'@ |
+| database.name | name of database | @database.id->database.name or self->id@ |
+| database.password | password to login in database | @database.id->database.password or host_id->database.password@ |
+| database.port | port of database server | @database.system->default_port@ |
+| database.timeout | Database connection timeout (In miliseconds) | @database.id->database.timeout or 5000 |
+| database.username | username to login in database | @database.id->database.username or host_id->database.username@ |
+| fs_path | path to instance's installation  | @host_id->fs_path + '/' + self->id@ |
+| host_id | ID of instace to fetch host parameters | @nil@ |
+| ssh.url | SSH URL to access instance's host | @host_id->ssh.url or self->ssh.username + '@' self->ssh.hostname@ |
+| ssh.hostname | SSH hostname to access instance's host | @host_id->ssh.hostname@ |
+| ssh.port | SSH port to access instance's host | '22' |
+| ssh.username | SSH username to access instance's host | @host_id->ssh.username@ |
+| system.group | Group of user that runs instance | @host_id->system.groupname or self->system.username@ |
+| system.username | Name of user that runs instance | @host_id->system.username or self->ssh.username@ |
+| web.url | Root URL to web interface | @nil@ |
+| web.hostname | Hostname of web interface | @web.url->hostname@ |

data/sub/avm-tools/avm-tools.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'avm/tools/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'avm-tools'
+  s.version     = Avm::Tools::VERSION
+  s.authors     = ['Esquilo Azul Company']
+  s.summary     = 'Tools for AVM.'
+
+  s.files = Dir['{exe,lib}/**/*', 'Gemfile']
+  s.bindir = 'exe'
+  s.executables = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+
+  s.required_ruby_version = '>= 2.7.0'
+
+  s.add_dependency 'avm', '~> 0.94'
+  s.add_dependency 'clipboard', '~> 1.4', '>= 1.4.1'
+  s.add_dependency 'eac_ruby_base0', '~> 0.19'
+
+  s.add_development_dependency 'avm-git', '~> 0.17'
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.8.1'
+end

data/sub/avm-tools/exe/avm

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+require 'avm/tools/runner'
+Avm::Tools::Runner.run

data/sub/avm-tools/lib/avm/tools/core_ext.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_base0/core_ext'

data/sub/avm-tools/lib/avm/tools/rspec/helpers/runner.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Avm
+  module Tools
+    module Rspec
+      module Helpers
+        module Runner
+          def avm_tools_runner_args_prefix
+            []
+          end
+
+          def avm_tools_runner_run(*argv)
+            require 'avm/tools/runner'
+            Avm::Tools::Runner.run(argv: avm_tools_runner_args_prefix + argv)
+          end
+        end
+      end
+    end
+  end
+end

data/sub/{avm-eac_php_base0/lib/avm/eac_php_base0/source_generators.rb → avm-tools/lib/avm/tools/rspec/helpers.rb}

@@ -3,9 +3,11 @@
 require 'eac_ruby_utils/core_ext'
 
 module Avm
-  module EacPhpBase0
-    module SourceGenerators
-      require_sub __FILE__
+  module Tools
+    module Rspec
+      module Helpers
+        require_sub __FILE__
+      end
     end
   end
 end

data/sub/avm-tools/lib/avm/tools/rspec/setup.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'avm/tools/rspec/helpers/runner'
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Tools
+    module Rspec
+      module Setup
+        extend ::ActiveSupport::Concern
+
+        SETUPS = %w[helpers].freeze
+
+        def self.extended(setup_obj)
+          SETUPS.each { |s| setup_obj.send("setup_#{s}") }
+        end
+
+        def setup_helpers
+          rspec_config.include ::Avm::Tools::Rspec::Helpers::Runner
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/rspec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module Avm
+  module Tools
+    module Rspec
+      require_sub __FILE__
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/application/info.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'avm/tools/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Application
+        class Info
+          APPLICATION_PROPERTIES = {
+            id: 'ID',
+            name: 'Name',
+            organization: 'Organization',
+            scm: 'SCM',
+            stereotype: 'Stereotype'
+          }.freeze
+
+          runner_with :help, :output_item do
+            desc 'Show information about application.'
+          end
+
+          def run
+            run_output
+          end
+
+          # @return [Hash]
+          def item_hash
+            APPLICATION_PROPERTIES.inject({}) do |a, e|
+              a.merge(e.last => application.send(e.first).to_s)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/application.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'avm/registry'
+require 'eac_ruby_base0/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Application
+        runner_with :help, :subcommands do
+          pos_arg :application_id
+          subcommands
+        end
+        for_context :application
+
+        private
+
+        def application_uncached
+          ::Avm::Registry.applications.detect(parsed.application_id)
+        end
+
+        require_sub __FILE__
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/application_stereotypes/list.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'avm/tools/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class ApplicationStereotypes
+        class List
+          runner_with :help, :output
+
+          def run
+            infov 'Found', stereotypes.count
+            run_output
+          end
+
+          def output_content
+            stereotypes.map { |s| "#{s}\n" }.join
+          end
+
+          private
+
+          def stereotypes
+            ::Avm::Registry.application_stereotypes.available
+              .sort_by { |s| [s.name, s.namespace_module] }
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/application_stereotypes.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class ApplicationStereotypes
+        require_sub __FILE__
+        runner_with :help, :subcommands do
+          subcommands
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/applications/list.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'avm/tools/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Applications
+        class List
+          runner_with :help, :output
+
+          def run
+            infov 'Found', applications.count
+            run_output
+          end
+
+          def output_content
+            applications.map { |s| "#{s}\n" }.join
+          end
+
+          private
+
+          def applications_uncached
+            ::Avm::Registry.applications.available
+              .sort_by { |s| [s.id] }
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/applications.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Applications
+        require_sub __FILE__
+        runner_with :help, :subcommands do
+          subcommands
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/config/load_path.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'avm/tools/core_ext'
+require 'eac_config/node'
+require 'eac_ruby_utils/recursive_builder'
+
+module Avm
+  module Tools
+    class Runner
+      class Config
+        class LoadPath
+          runner_with :help do
+            desc 'Manipulate include path.'
+            arg_opt '-p', '--push', 'Add a path.'
+          end
+
+          def run
+            config_nodes.each { |config_node| run_show(config_node) }
+            run_add
+          end
+
+          private
+
+          # @return [[EacCli::Config]]
+          def root_config_node
+            ::EacConfig::Node.context.current
+          end
+
+          def config_nodes
+            ::EacRubyUtils::RecursiveBuilder.new(root_config_node, &:self_loaded_nodes).result
+          end
+
+          def run_add
+            parsed.push.if_present do |v|
+              infov 'Path to add', v
+              root_config_node.write_node.load_path.push(v)
+              success 'Path included'
+            end
+          end
+
+          def run_show(config_node)
+            infov 'Configuration path', config_node.url
+            infov 'Paths included', config_node.self_loaded_nodes.count
+            config_node.self_loaded_nodes.each do |loaded_node|
+              infov '  * ', loaded_node.url
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/config.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'avm/tools/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Config
+        require_sub __FILE__
+        runner_with :help, :subcommands do
+          desc 'Configuration utilities.'
+          subcommands
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/files/format.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'avm/file_formats/search_formatter'
+require 'avm/registry'
+require 'eac_cli/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Files
+        class Format
+          runner_with :help do
+            desc 'Format files.'
+            bool_opt '-a', '--apply', 'Confirm changes.'
+            bool_opt '-n', '--no-recursive', 'No recursive.'
+            bool_opt '-q', '--quiet', 'Do not output messages.'
+            bool_opt '-d', '--dirty', 'Select modified files to format.'
+            pos_arg :paths, repeat: true, optional: true
+          end
+
+          def run
+            ::Avm::FileFormats::SearchFormatter.new(source_paths, formatter_options).run
+          end
+
+          def formatter_options
+            { ::Avm::FileFormats::SearchFormatter::OPTION_APPLY => parsed.apply?,
+              ::Avm::FileFormats::SearchFormatter::OPTION_RECURSIVE => !parsed.no_recursive?,
+              ::Avm::FileFormats::SearchFormatter::OPTION_VERBOSE => !parsed.quiet? }
+          end
+
+          def scm
+            @scm ||= ::Avm::Registry.scms.detect('.')
+          end
+
+          def dirty_files
+            scm.changed_files.map(&:absolute_path).select(&:exist?).map(&:to_path)
+          end
+
+          def source_paths
+            if parsed.dirty?
+              parsed.paths + dirty_files
+            else
+              parsed.paths.if_present(%w[.])
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/files/rotate.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'avm/data/rotate'
+require 'eac_cli/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Files
+        class Rotate
+          runner_with :help do
+            desc 'Rotates a file (Like a backup).'
+            arg_opt '-L', '--space-limit', 'Limit by <space> the space used by rotated files.'
+            pos_arg :path
+          end
+          def run
+            error_message = rotate.run
+            fatal_error(error_message) if error_message
+          end
+
+          def rotate
+            @rotate ||= ::Avm::Data::Rotate.new(
+              parsed.path,
+              space_limit: parsed.space_limit
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/files.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'eac_cli/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Files
+        require_sub __FILE__
+        runner_with :help, :subcommands do
+          desc 'Files utilities for AVM.'
+          subcommands
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/instance/data/clear.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'avm/instances/runner'
+require 'eac_cli/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Instance < ::Avm::Instances::Runner
+        class Data
+          class Clear
+            runner_with :help, :include_exclude, :instance_data_clear
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/instance/data/dump.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'avm/instances/runner'
+require 'eac_cli/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Instance < ::Avm::Instances::Runner
+        class Data
+          class Dump
+            runner_with :help, :include_exclude, :instance_data_dump do
+              desc 'Dump utility for instance.'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/lib/avm/tools/runner/instance/data/load.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'avm/instances/runner'
+require 'eac_cli/core_ext'
+
+module Avm
+  module Tools
+    class Runner
+      class Instance < ::Avm::Instances::Runner
+        class Data
+          class Load
+            runner_with :help, :include_exclude, :instance_data_load do
+              desc 'Load utility for instance.'
+            end
+
+            # @return [Avm::Instances::Data::Package]
+            def source_instance_data_owner
+              source_instance.data_package
+            end
+          end
+        end
+      end
+    end
+  end
+end