eac_tools 0.2.0 → 0.3.0

data/sub/avm-tools/sub/eac_config/lib/eac_config/paths_hash.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacConfig
+  class PathsHash
+    require_sub __FILE__
+
+    class << self
+      def parse_entry_key(entry_key)
+        r = entry_key.to_s.strip
+        raise ::EacConfig::PathsHash::EntryKeyError, 'Entry key cannot start or end with dot' if
+        r.start_with?('.') || r.end_with?('.')
+
+        r = r.split('.').map(&:strip)
+        if r.empty?
+          raise ::EacConfig::PathsHash::EntryKeyError, "Entry key \"#{entry_key}\" is empty"
+        end
+        return r.map(&:to_sym) unless r.any?(&:blank?)
+
+        raise ::EacConfig::PathsHash::EntryKeyError,
+              "Entry key \"#{entry_key}\" has at least one blank part"
+      end
+    end
+
+    attr_reader :root
+
+    def initialize(source_hash = {})
+      @root = Node.new(source_hash)
+    end
+
+    def [](entry_key)
+      root.read_entry(::EacConfig::PathsHash::PathSearch.parse_entry_key(entry_key))
+    end
+
+    def []=(entry_key, entry_value)
+      root.write_entry(
+        ::EacConfig::PathsHash::PathSearch.parse_entry_key(entry_key), entry_value
+      )
+    end
+
+    def fetch(entry_key)
+      root.fetch(::EacConfig::PathsHash::PathSearch.parse_entry_key(entry_key))
+    end
+
+    def key?(entry_key)
+      root.entry?(::EacConfig::PathsHash::PathSearch.parse_entry_key(entry_key))
+    end
+
+    delegate :to_h, to: :root
+
+    # @return [EacConfig::PathsHash
+    def write(entry_key, entry_value)
+      self[entry_key] = entry_value
+
+      self
+    end
+
+    private
+
+    attr_reader :data
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/fs/temp'
+require 'eac_config/envvars_node'
+require 'eac_config/node'
+require 'eac_config/yaml_file_node'
+
+module EacConfig
+  module Rspec
+    module Setup
+      def self.extended(obj)
+        obj.rspec_config.around do |example|
+          obj.on_envvars_load_path_clean(example)
+        end
+      end
+
+      def on_envvars_load_path_clean(example)
+        old_value = envvars_load_path_entry.value
+        begin
+          envvars_load_path_entry.value = old_value = []
+          example.run
+        ensure
+          envvars_load_path_entry.value = old_value
+        end
+      end
+
+      def envvars_load_path_entry
+        ::EacConfig::EnvvarsNode.new.load_path.entry
+      end
+
+      # Wraps a RSpec example in a EacConfig node using a alternative file.
+      #
+      # @param target_example [RSpec::Core::ExampleGroup] The example to wrap. If not provided,
+      #   it is applied to all examples.
+      # @param target_file [Pathname] The file used by the EacConfig node. If not provided, a
+      #   temporary file is used.
+      # @param node_builder [Proc] Should return the desired EacConfig node. If not provided, a
+      #   EacConfig::YamlFileNode is created.
+      def stub_eac_config_node(target_example = nil, target_file = nil, &node_builder)
+        parent_self = self
+        (target_example || rspec_config).around do |example|
+          parent_self.stub_eac_config_node_on_file(target_file) do |file|
+            ::EacConfig::Node
+              .context.on(parent_self.stub_eac_config_node_build(file, &node_builder)) do
+              example.run
+            end
+          end
+        end
+      end
+
+      def stub_eac_config_node_build(file, &node_builder)
+        node_builder.present? ? node_builder.call(file) : ::EacConfig::YamlFileNode.new(file)
+      end
+
+      def stub_eac_config_node_on_file(target_file)
+        if target_file
+          yield(target_file.to_pathname)
+        else
+          ::EacRubyUtils::Fs::Temp.on_file { |file| yield(file) }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_exts'
+
+module EacConfig
+  module Rspec
+    require_sub __FILE__
+  end
+end

data/sub/avm-tools/sub/eac_config/lib/eac_config/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EacConfig
+  VERSION = '0.8.1'
+end

data/sub/avm-tools/sub/eac_config/lib/eac_config/yaml_file_node/entry.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'eac_config/entry_path'
+require 'eac_config/node_entry'
+require 'eac_ruby_utils/core_ext'
+
+module EacConfig
+  class YamlFileNode
+    class Entry < ::EacConfig::NodeEntry
+      enable_simple_cache
+
+      def found?
+        paths_hash.key?(to_paths_hash_key)
+      end
+
+      def value
+        paths_hash[to_paths_hash_key]
+      end
+
+      def value=(a_value)
+        node.persist_data(paths_hash.write(to_paths_hash_key, a_value).root.to_h)
+      end
+
+      private
+
+      # @return [EacConfig::PathsHash]
+      def paths_hash
+        ::EacConfig::PathsHash.new(node.data)
+      end
+
+      def to_paths_hash_key
+        path.parts.join('.')
+      end
+    end
+  end
+end

data/sub/avm-tools/sub/eac_config/lib/eac_config/yaml_file_node.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'addressable'
+require 'eac_config/node'
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/yaml'
+
+module EacConfig
+  class YamlFileNode
+    require_sub __FILE__
+    include ::EacConfig::Node
+    enable_simple_cache
+
+    class << self
+      def from_uri(uri)
+        return new(uri.to_addressable.path) if uri.to_addressable.scheme == 'file'
+      end
+    end
+
+    common_constructor :path do
+      self.path = path.to_pathname
+    end
+
+    def persist_data(new_data)
+      path.parent.mkpath
+      ::EacRubyUtils::Yaml.dump_file(path, new_data)
+      reset_cache(:data)
+    end
+
+    def url
+      ::Addressable::URI.parse("file://#{path.expand_path}")
+    end
+
+    private
+
+    def data_uncached
+      r = nil
+      if path.file?
+        r = ::EacRubyUtils::Yaml.load_file(path)
+      elsif path.exist?
+        raise("\"#{path}\" is a not a file")
+      end
+
+      r.is_a?(::Hash) ? r : {}
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacConfig
+  require_sub __FILE__
+end

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/entry_path_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'eac_config/entry_path'
+
+RSpec.describe ::EacConfig::EntryPath do
+  describe '#assert' do
+    {
+      ['a.b.c'] => %w[a b c],
+      [['a', 1], 'b', []] => %w[a 1 b],
+      ['a', 'b', ['c', 1.2], 'd', 'e.f'] => %w[a b c 1 2 d e f]
+    }.each do |data|
+      source = data[0]
+      expected_parts = data[1]
+
+      context "when source is #{source}" do
+        let(:instance) { described_class.assert(source) }
+
+        it { expect(instance.parts).to eq(expected_parts) }
+      end
+    end
+
+    [['a..c'], ['a', ' ']].each do |source|
+      context "when invalid source is #{source}" do
+        it do
+          expect { described_class.assert(source) }.to raise_error(::ArgumentError)
+        end
+      end
+    end
+  end
+end

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/envvars_node/entry_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eac_config/envvars_node/entry'
+
+RSpec.describe ::EacConfig::EnvvarsNode::Entry do
+  describe '#entry_key_to_envvar_name' do
+    {
+      'a.entry.value' => 'A_ENTRY_VALUE',
+      'appli-cation_0.var_one' => 'APPLICATION_0_VAR_ONE'
+    }.each do |input, expected_result|
+      it { expect(described_class.entry_path_to_envvar_name(input)).to eq(expected_result) }
+    end
+  end
+end

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/envvars_node_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'eac_config/envvars_node'
+
+RSpec.describe ::EacConfig::EnvvarsNode do
+  let(:instance) { described_class.new }
+
+  before do
+    ENV['COMMON'] = 'AAA'
+    ENV['BLANK'] = ''
+    ENV.delete('NO_EXIST')
+  end
+
+  context 'with common entry' do
+    let(:entry) { instance.entry('common') }
+
+    it { expect(entry).to be_a(::EacConfig::Entry) }
+    it { expect(entry.value).to eq('AAA') }
+    it { expect(entry.found_node).to eq(instance) }
+    it { expect(entry).to be_found }
+  end
+
+  context 'with blank entry' do
+    let(:entry) { instance.entry('blank') }
+
+    it { expect(entry).to be_a(::EacConfig::Entry) }
+    it { expect(entry.value).to eq('') }
+    it { expect(entry.found_node).to eq(instance) }
+    it { expect(entry).to be_found }
+  end
+
+  context 'with not existing entry' do
+    let(:entry) { instance.entry('no.exist') }
+
+    it { expect(entry).to be_a(::EacConfig::Entry) }
+    it { expect(entry.value).to eq(nil) }
+    it { expect(entry.found_node).to eq(nil) }
+    it { expect(entry).not_to be_found }
+  end
+end

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/old_configs_spec.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'eac_config/old_configs'
+
+RSpec.describe ::EacConfig::OldConfigs do
+  let(:configs_key) { 'configsspec' }
+  let(:storage_path) do
+    file = ::Tempfile.new(configs_key)
+    path = file.path
+    file.close
+    file.unlink
+    path
+  end
+  let(:instance) { described_class.new(configs_key, storage_path: storage_path) }
+
+  describe '#storage_path' do
+    it { expect(instance.storage_path).to eq(storage_path) }
+  end
+
+  describe '#write' do
+    let(:entry_key) { 'parent.child' }
+
+    before do
+      instance[entry_key] = 'value1'
+      instance.save
+    end
+
+    it { expect(::YAML.load_file(storage_path)).to eq(parent: { child: 'value1' }) }
+  end
+
+  describe '#read' do
+    let(:present_key) { 'a.present.key' }
+    let(:blank_key) { 'a.blank.key' }
+
+    before do
+      instance[present_key] = 'A value'
+      instance[blank_key] = ''
+      instance.save
+      instance.load
+    end
+
+    it { expect(instance[present_key]).to be_present }
+    it { expect(instance[blank_key]).to be_present }
+  end
+end

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/paths_hash_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'eac_config/paths_hash'
+
+RSpec.describe ::EacConfig::PathsHash do
+  let(:source_hash) do
+    {
+      parent: {
+        child1: {
+          child1_1: 'v1_1',
+          child1_2: 'v1_2'
+        },
+        child2: 'v2'
+      }
+    }
+  end
+  let(:instance) { described_class.new(source_hash) }
+
+  describe '#[]' do
+    {
+      'parent.child1.child1_1' => 'v1_1',
+      'parent.child1.child1_2' => 'v1_2',
+      'parent.child2' => 'v2',
+      'no_exist' => nil,
+      'parent.child1' => {
+        child1_1: 'v1_1',
+        child1_2: 'v1_2'
+      }
+    }.each do |entry_key, expected_value|
+      it { expect(instance[entry_key]).to eq(expected_value) }
+    end
+
+    ['.only_suffix', '', '.', 'only_prefx.', 'empty..part'].each do |entry_key|
+      it "invalid entry key \"#{entry_key}\" raises EntryKeyError" do
+        expect { instance[entry_key] }.to raise_error(::EacConfig::PathsHash::EntryKeyError)
+      end
+    end
+  end
+
+  describe '#[]=' do
+    let(:source_hash) { {} }
+
+    before do
+      instance['a.b.c'] = '123'
+    end
+
+    it { expect(instance.to_h).to eq(a: { b: { c: '123' } }) }
+  end
+
+  describe '#fetch' do
+    {
+      'parent.child1.child1_1' => 'v1_1',
+      'parent.child1.child1_2' => 'v1_2',
+      'parent.child1.child1_2.no_exist' => ::EacConfig::PathsHash::EntryKeyError,
+      'parent.child1.child1_3' => ::EacConfig::PathsHash::EntryKeyError,
+      'parent.child2' => 'v2',
+      'no_exist' => ::EacConfig::PathsHash::EntryKeyError,
+      'parent.child1' => {
+        child1_1: 'v1_1',
+        child1_2: 'v1_2'
+      }
+    }.each do |entry_key, expected_value|
+      if expected_value.is_a?(::Class) && expected_value < ::Exception
+        it "raise error #{expected_value}" do
+          expect { instance.fetch(entry_key) }.to raise_error(expected_value)
+        end
+      else
+        it "\#fetch return \"#{expected_value}\"" do
+          expect(instance.fetch(entry_key)).to eq(expected_value)
+        end
+      end
+    end
+  end
+
+  describe '#key?' do
+    {
+      'parent.child1.child1_1' => true,
+      'parent.child1.child1_2' => true,
+      'parent.child1.child1_2.no_exist' => false,
+      'parent.child1.child1_3' => false,
+      'parent.child2' => true,
+      'no_exist' => false,
+      'parent.child1' => true
+    }.each do |entry_key, expected_value|
+      it { expect(instance.key?(entry_key)).to eq(expected_value) }
+    end
+  end
+end

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/struct'
+require 'eac_config/yaml_file_node'
+
+RSpec.describe ::EacConfig::YamlFileNode do
+  storages = %w[1 1_1 1_2 1_2_1].map do |suffix|
+    key = "storage#{suffix}"
+    subpath = "#{key}.yaml"
+    subpath = "storage1_2/#{subpath}" if suffix == '1_2_1'
+    ::EacRubyUtils::Struct.new(suffix: suffix, key: key, subpath: subpath.to_pathname)
+  end
+
+  let(:fixtures_dir) { ::Pathname.new(__dir__).join('yaml_file_node_spec_files') }
+  let(:target_dir) { temp_copy(fixtures_dir) }
+  let(:yaml_file_path) do
+    r = target_dir.join('storage1.yaml')
+    r.write(r.read.gsub('%%STORAGE1_2_ABSOLUTE_PATH%%',
+                        target_dir.join('storage1_2.yaml').expand_path.to_path))
+    r
+  end
+  let(:instance) { described_class.new(yaml_file_path) }
+
+  context 'with common entry' do
+    let(:entry) { instance.entry('common') }
+
+    it { expect(entry.value).to eq('AAA') }
+    it { expect(entry.found_node).to eq(instance) }
+    it { expect(entry).to be_found }
+  end
+
+  storages.each do |storage|
+    context "with entry in loaded path \"#{storage.subpath}\"" do
+      let(:entry) { instance.entry(storage.key) }
+      let(:storage_node) { described_class.new(target_dir.join(storage.subpath)) }
+
+      it { expect(entry).to be_a(::EacConfig::Entry) }
+      it { expect(entry).to be_found }
+      it { expect(entry.value).to eq(storage.key) }
+      it { expect(entry.found_node.url).to eq(storage_node.url) }
+    end
+  end
+
+  context 'with not existing entry' do
+    let(:entry) { instance.entry('no_exist') }
+
+    it { expect(entry).to be_a(::EacConfig::Entry) }
+    it { expect(entry.value).to eq(nil) }
+    it { expect(entry.found_node).to eq(nil) }
+    it { expect(entry).not_to be_found }
+  end
+end

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1.yaml

@@ -0,0 +1,6 @@
+---
+common: AAA
+load_path:
+  - storage1_1.yaml
+  - %%STORAGE1_2_ABSOLUTE_PATH%%
+storage1: storage1

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_1.yaml

@@ -0,0 +1,2 @@
+---
+storage1_1: storage1_1

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_2/storage1_2_1.yaml

@@ -0,0 +1,2 @@
+---
+storage1_2_1: storage1_2_1

data/sub/avm-tools/sub/eac_config/spec/lib/eac_config/yaml_file_node_spec_files/storage1_2.yaml

@@ -0,0 +1,4 @@
+---
+load_path:
+  - ./storage1_2/storage1_2_1.yaml
+storage1_2: storage1_2

data/sub/avm-tools/sub/eac_config/spec/rubocop_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+::EacRubyUtils::Rspec.default_setup.describe_rubocop

data/sub/avm-tools/sub/eac_config/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/rspec/default_setup'
+::EacRubyUtils::Rspec.default_setup_create(::File.expand_path('..', __dir__))

data/sub/avm-tools/sub/eac_docker/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+
+require 'eac_docker/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'eac_docker'
+  s.version     = EacDocker::VERSION
+  s.authors     = ['Put here the authors']
+  s.summary     = 'Put here de description.'
+
+  s.files = Dir['{lib}/**/*']
+
+  s.add_dependency 'eac_ruby_utils', '~> 0.74'
+  s.add_dependency 'eac_templates', '~> 0.1'
+
+  s.add_development_dependency 'eac_ruby_gem_support', '~> 0.3', '>= 0.3.3'
+end

data/sub/avm-tools/sub/eac_docker/lib/eac_docker/container.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacDocker
+  class Container
+    enable_immutable
+    immutable_accessor :interactive, :temporary, :tty, type: :boolean
+    immutable_accessor :env, type: :hash
+    immutable_accessor :capability, :command_arg, :volume, type: :array
+    attr_reader :id
+    common_constructor :image
+
+    def immutable_constructor_args
+      [image]
+    end
+
+    alias immutable_volume volume
+
+    def hostname
+      ::EacDocker::Executables.docker.command(
+        'inspect', '--format={{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}',
+        id
+      ).execute!.strip
+    end
+
+    def on_detached
+      command = ::EacDocker::Executables.docker.command(*(%w[run --detach] + run_command_args))
+      self.id = command.execute!.strip
+      begin
+        yield(self)
+      ensure
+        stop
+      end
+    end
+
+    def volume(left_part, right_part = null)
+      immutable_volume(right_part.if_present(left_part) { |v| "#{left_part}:#{v}" })
+    end
+
+    def run_command
+      ::EacDocker::Executables.docker.command('run', *run_command_args)
+    end
+
+    def run_command_args
+      run_command_boolean_args + run_command_capabilities_args + run_command_envs_args +
+        run_command_volumes_args + [image.provide.id] + command_args
+    end
+
+    def stop
+      ::EacDocker::Executables.docker.command('stop', id).execute!
+    end
+
+    private
+
+    attr_writer :id
+
+    def run_command_boolean_args
+      r = []
+      r << '--interactive' if interactive?
+      r << '--tty' if tty?
+      r << '--rm' if temporary?
+      r
+    end
+
+    def run_command_capabilities_args
+      capabilities.flat_map { |capability| ['--cap-add', capability] }
+    end
+
+    def run_command_volumes_args
+      volumes.flat_map { |volume| ['--volume', volume] }
+    end
+
+    def run_command_envs_args
+      envs.flat_map { |name, value| ['--env', "#{name}=#{value}"] }
+    end
+  end
+end

data/sub/avm-tools/sub/eac_docker/lib/eac_docker/debug.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/boolean'
+
+module EacDocker
+  module Debug
+    class << self
+      ENABLE_ENVVAR = 'EAC_DOCKER_DEBUG'
+
+      def enabled?
+        ::EacRubyUtils::Boolean.parse(ENV[ENABLE_ENVVAR])
+      end
+    end
+  end
+end

data/sub/avm-tools/sub/eac_docker/lib/eac_docker/executables.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/envs'
+
+module EacDocker
+  module Executables
+    class << self
+      def env
+        ::EacRubyUtils::Envs.local
+      end
+
+      def docker
+        @docker ||= env.executable('docker', '--version')
+      end
+    end
+  end
+end