avm-tools 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7f76082f43aec3689eed38273c83e24a6307cd8e9dbb582fc0eda7d82aaaefe
-  data.tar.gz: 39a41b349999c89af1ab6b8fdfa904382366914df067e4d48ba3d47d737b07c7
+  metadata.gz: 0e358cd10846dd42a33702ee9bcc47ac075d2c2df7e4019aff7876055d3e98d3
+  data.tar.gz: 198439929cad2eeeea336efff95b90c1a19fd83d187ba49e33f7ba9d77f49b84
 SHA512:
-  metadata.gz: c474810c867a6aab1c11ad6229e005a79253ec4e6a36f28f3b8d7a0599627fbc73c1050bf21ea0c65cf70a29fc01dbe7a52cb6c69f88acc3d4bf3edf03e8d1f5
-  data.tar.gz: ebc3c3801f3d050f41039e71eb1358a26918ce4d3ed89c7afd92d340c9b67d783564105eec6a2657b7f218e7816270378618556eed2b4dde913ee6907b21fe30
+  metadata.gz: e158e9238bb5283e8797dc7be877f1c76a76c64f2cfe43ac360a28d378555abcff90ce55b07f0bb145f17e9c7af43a3456c66e12ae1a22d8c2bf6fa92ab8c01a
+  data.tar.gz: f86650bedb0fff3104e595dfb69ceb42bf60209a66af36e8ff96e500a7ee8720f8151071d6d6d6ff36bd4272f755a7818ad90f401288f441223907f889304311

data/lib/avm.rb

@@ -2,6 +2,7 @@
 
 module Avm
   require 'avm/configs'
+  require 'avm/data'
   require 'avm/git'
   require 'avm/instances'
   require 'avm/patches'

data/lib/avm/data.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub(__FILE__)
+
+module Avm
+  module Data
+  end
+end

data/lib/avm/data/instance.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub(__FILE__)
+
+module Avm
+  module Data
+    module Instance
+    end
+  end
+end

data/lib/avm/data/instance/package.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'avm/data/package'
+
+module Avm
+  module Data
+    module Instance
+      class Package < ::Avm::Data::Package
+        attr_reader :instance
+
+        def initialize(instance, options = {})
+          @instance = instance
+          super options
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/instance/unit.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'avm/data/unit'
+
+module Avm
+  module Data
+    module Instance
+      class Unit < ::Avm::Data::Unit
+        attr_reader :instance
+
+        def initialize(instance)
+          @instance = instance
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/package.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'avm/data/package/dump'
+require 'avm/data/package/load'
+
+module Avm
+  module Data
+    class Package
+      attr_reader :units
+
+      def initialize(options)
+        @units = {}
+        options = options.to_options_consumer
+        units = options.consume(:units)
+        options.validate
+        units.if_present do |v|
+          v.each { |identifier, unit| add_unit(identifier, unit) }
+        end
+      end
+
+      def add_unit(identifier, unit)
+        @units[identifier.to_sym] = unit
+      end
+
+      def dump(data_path, options = {})
+        ::Avm::Data::Package::Dump.new(self, data_path, options)
+      end
+
+      def load(data_path)
+        ::Avm::Data::Package::Load.new(self, data_path)
+      end
+
+      def dump_units_to_directory(directory)
+        @units.each { |identifier, unit| unit.dump_to_directory(directory, identifier) }
+      end
+
+      def load_units_from_directory(directory)
+        @units.each { |identifier, unit| unit.load_from_directory(directory, identifier) }
+      end
+    end
+  end
+end

data/lib/avm/data/package/dump.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'minitar'
+
+module Avm
+  module Data
+    class Package
+      class Dump
+        enable_console_speaker
+        enable_listable
+
+        DEFAULT_EXPIRE_TIME = 1.days
+
+        attr_reader :package, :data_file_path, :existing
+
+        lists.add_string :existing, :denied, :overwrite, :rotate, :rotate_expired
+
+        def initialize(package, data_file_path, options = {})
+          @package = package
+          @data_file_path = data_file_path
+          options = options.to_options_consumer
+          @existing, @expire_time = options.consume(:existing, :expire_time)
+          options.validate
+          self.class.lists.existing.value_validate!(@existing)
+        end
+
+        def runnable?
+          cannot_run_reason.blank?
+        end
+
+        def cannot_run_reason
+          return nil if !data_file_exist? ||
+                        [EXISTING_OVERWRITE, EXISTING_ROTATE].include?(existing)
+
+          if existing == EXISTING_DENIED
+            'Data exist and overwriting is denied'
+          elsif existing == EXISTING_ROTATE_EXPIRED && !data_file_expired?
+            'Data exist and yet is not expired'
+          end
+        end
+
+        def run
+          raise "Cannot run: #{cannot_run_reason}" unless runnable?
+
+          build_dir = dump_units_to_build_directory
+          package_file = create_package_file(build_dir)
+          rotate
+          move_download_to_final_dest(package_file)
+        end
+
+        def data_file_exist?
+          ::File.exist?(data_file_path)
+        end
+
+        def data_file_time
+          data_file_exist? ? ::Time.now - ::File.mtime(data_file_path) : nil
+        end
+
+        def data_file_expired?
+          data_file_time.if_present(false) { |v| v >= expire_time }
+        end
+
+        def expire_time
+          @expire_time || DEFAULT_EXPIRE_TIME
+        end
+
+        private
+
+        def download
+          infom 'Downloading dump...'
+          download_path = find_download_path
+          dump_command.system!(output_file: download_path)
+          fatal_error "File \"#{download_path}\" not saved" unless ::File.exist?(download_path)
+          fatal_error "File \"#{download_path}\" is empty" if ::File.zero?(download_path)
+          download_path
+        end
+
+        def move_download_to_final_dest(download_path)
+          ::FileUtils.mv(download_path, data_file_path)
+        end
+
+        def rotate
+          return unless data_file_exist?
+          return unless existing == EXISTING_ROTATE
+
+          infom "Rotating \"#{data_file_path}\"..."
+          ::Avm::Files::Rotate.new(data_file_path).run
+        end
+
+        def new_build_path
+          f = ::Tempfile.new(self.class.name.parameterize + '-download')
+          path = f.path
+          f.close
+          f.unlink
+          path
+        end
+
+        def dump_units_to_build_directory
+          dir = ::Dir.mktmpdir
+          package.dump_units_to_directory(dir)
+          dir
+        end
+
+        def create_package_file(build_dir)
+          package_path = new_build_path
+          infom "Creating package \"#{package_path}\" from \"#{build_dir}\"..."
+          Dir.chdir(build_dir) do
+            ::Minitar.pack('.', File.open(::File.expand_path(package_path), 'wb'))
+          end
+          package_path
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/package/load.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'minitar'
+
+module Avm
+  module Data
+    class Package
+      class Load
+        enable_console_speaker
+
+        attr_reader :package, :data_file_path
+
+        def initialize(package, data_file_path)
+          @package = package
+          @data_file_path = data_file_path
+        end
+
+        def runnable?
+          cannot_run_reason.blank?
+        end
+
+        def cannot_run_reason
+          return nil if data_file_exist?
+
+          "Data file \"#{data_file_path}\" does not exist"
+        end
+
+        def run
+          raise "Cannot run: #{cannot_run_reason}" unless runnable?
+
+          build_dir = extract_packages_to_build_directory
+          package.load_units_from_directory(build_dir)
+        end
+
+        def data_file_exist?
+          ::File.exist?(data_file_path)
+        end
+
+        def extract_packages_to_build_directory
+          dir = ::Dir.mktmpdir
+          ::Minitar.unpack(data_file_path, dir)
+          dir
+        end
+      end
+    end
+  end
+end

data/lib/avm/data/unit.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'active_support/callbacks'
+
+module Avm
+  module Data
+    class Unit
+      include ::ActiveSupport::Callbacks
+
+      define_callbacks :dump, :load
+      enable_console_speaker
+
+      %w[dump load].each do |action|
+        class_eval <<~CODE, __FILE__, __LINE__ + 1
+          # Should be overrided.
+          # @return [EacRubyUtils::Envs::Command]
+          def #{action}_command
+            fail "Abstract method. Override in #{singleton_class}."
+          end
+        CODE
+
+        # Callbacks
+        %w[before after].each do |callback|
+          method = "#{callback}_#{action}"
+          class_eval <<~CODE, __FILE__, __LINE__ + 1
+            def self.#{method}(callback_method = nil, &block)
+              if callback_method
+                set_callback :#{action}, :#{callback}, callback_method
+              else
+                set_callback :#{action}, :#{callback}, &block
+              end
+              self
+            end
+
+            def #{method}(callback_method = nil, &block)
+              singleton_class.#{method}(callback_method, &block)
+              self
+            end
+          CODE
+        end
+      end
+
+      def extension
+        singleton_class.const_get('EXTENSION')
+      rescue NameError
+        ''
+      end
+
+      def name
+        self.class
+      end
+
+      def load_from_directory(directory, identifier)
+        load(unit_on_directory_path(directory, identifier))
+      end
+
+      def dump_to_directory(directory, identifier)
+        dump(unit_on_directory_path(directory, identifier))
+      end
+
+      def dump(data_path)
+        run_callbacks :dump do
+          infom "Dumping unit \"#{name}\" to \"#{data_path}\"..."
+          dump_command.execute!(output_file: data_path)
+        end
+      end
+
+      def load(data_path)
+        run_callbacks :load do
+          infom "Loading unit \"#{name}\" from \"#{data_path}\"..."
+          load_command.execute!(input_file: data_path)
+        end
+      end
+
+      private
+
+      def unit_on_directory_path(directory, identifier)
+        ::File.join(directory, "#{identifier}#{extension}")
+      end
+    end
+  end
+end

data/lib/avm/stereotypes/eac_wordpress_base0/instance.rb

@@ -2,6 +2,8 @@
 
 require 'avm/instances/base'
 require 'avm/stereotypes/postgresql/instance_with'
+require 'avm/data/instance/package'
+require 'avm/stereotypes/eac_wordpress_base0/uploads_data_unit'
 
 module Avm
   module Stereotypes
@@ -17,6 +19,24 @@ module Avm
           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, uploads: UploadsDataUnit.new(self) }
+          )
+        end
+
+        def database_unit
+          self_instance = self
+          pg.data_unit.after_load do
+            info 'Fixing web addresses...'
+            run_sql(<<~SQL)
+              update wp_options
+              set option_value = '#{self_instance.read_entry('url')}'
+              where option_name in ('siteurl', 'home')
+            SQL
+          end
+        end
       end
     end
   end

data/lib/avm/stereotypes/eac_wordpress_base0/uploads_data_unit.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'minitar'
+require 'zlib'
+require 'avm/data/instance/unit'
+
+module Avm
+  module Stereotypes
+    module EacWordpressBase0
+      class Instance < ::Avm::Instances::Base
+        class UploadsDataUnit < ::Avm::Data::Instance::Unit
+          EXTENSION = '.tar.gz'
+
+          before_load :clear_uploads
+
+          def uploads_path
+            ::File.join(instance.read_entry(:fs_path), 'wp-content', 'uploads')
+          end
+
+          def dump_command
+            instance.host_env.command('tar', '-czf', '-', '-C', uploads_path, '.')
+          end
+
+          def load_command
+            instance.host_env.command('tar', '-xzf', '-', '-C', uploads_path)
+          end
+
+          def clear_uploads
+            infom "Removing all files under #{uploads_path}..."
+            instance.host_env.command('find', uploads_path, '-mindepth', 1, '-delete').execute!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/stereotypes/postgresql/instance.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'avm/stereotypes/postgresql/instance/data_unit'
+
 module Avm
   module Stereotypes
     module Postgresql
@@ -9,6 +11,10 @@ module Avm
           @connection_params = connection_params.with_indifferent_access
         end
 
+        def data_unit
+          ::Avm::Stereotypes::Postgresql::Instance::DataUnit.new(self)
+        end
+
         def dump_command
           env.command('pg_dump', '--no-privileges', '--clean', '--no-owner', *common_command_args)
              .envvar('PGPASSWORD', password)

data/lib/avm/stereotypes/postgresql/instance/data_unit.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'avm/data/instance/unit'
+
+module Avm
+  module Stereotypes
+    module Postgresql
+      class Instance
+        class DataUnit < ::Avm::Data::Instance::Unit
+          EXTENSION = '.pgdump.gz'
+
+          before_load :clear_database
+
+          def dump_command
+            instance.dump_gzip_command
+          end
+
+          def load_command
+            instance.psql_command.prepend(['gzip', '-d', '@ESC_|'])
+          end
+
+          private
+
+          def clear_database
+            info 'Clearing database (Dropping all tables)...'
+            run_sql(drop_all_tables_sql).if_present { |v| run_sql(v) }
+          end
+
+          def drop_all_tables_sql
+            "select 'drop table \"' || tablename || '\" cascade;' from pg_tables " \
+              "where schemaname = 'public';"
+          end
+
+          def run_sql(sql)
+            instance.psql_command_command(sql).execute!
+          end
+        end
+      end
+    end
+  end
+end

data/lib/avm/tools/runner/eac_wordpress_base0/data/dump.rb

@@ -3,6 +3,7 @@
 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 Tools
@@ -31,10 +32,10 @@ module Avm
             DOCUMENT
 
             def run
-              if run_dump?
-                run_dump
+              if package_dump.runnable?
+                package_dump.run
               else
-                warn(format(NO_DUMP_MESSAGE, dump_path))
+                warn(package_dump.cannot_run_reason)
               end
               success("Dump path: \"#{dump_path}\"")
               dump_path
@@ -42,6 +43,10 @@ module Avm
 
             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
@@ -50,58 +55,12 @@ module Avm
               context(:instance).read_entry(DEFAULT_DUMP_PATH_ENTRY_SUFFIX)
             end
 
-            def dump_exist?
-              ::File.exist?(dump_path)
-            end
-
-            def dump_time_uncached
-              dump_exist? ? ::Time.now - ::File.mtime(dump_path) : nil
-            end
-
-            def dump_expired?
-              return false unless dump_time.present?
-
-              dump_time >= DUMP_EXPIRE_TIME
-            end
-
-            def run_dump
-              download_dump
-              rotate_dump
-              move_download_to_final_dest
-            end
-
-            def download_dump
-              infom 'Downloading dump...'
-              dump_command.system!(output_file: download_path)
-              fatal_error "File \"#{download_path}\" not saved" unless ::File.exist?(download_path)
-              fatal_error "File \"#{download_path}\" is empty" if ::File.zero?(download_path)
-            end
-
-            def move_download_to_final_dest
-              ::FileUtils.mv(download_path, dump_path)
-            end
-
-            def rotate_dump
-              return unless dump_exist?
-
-              info "Rotating \"#{dump_path}\"..."
-              ::Avm::Files::Rotate.new(dump_path).run
-            end
-
-            def download_path_uncached
-              f = ::Tempfile.new('eac_rails_base0_data_dump')
-              path = f.path
-              f.close
-              f.unlink
-              path
-            end
-
-            def run_dump?
-              !dump_exist? || options.fetch('--rewrite') || dump_expired?
-            end
-
-            def dump_command
-              context(:instance).pg.dump_gzip_command
+            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

data/lib/avm/tools/runner/eac_wordpress_base0/data/load.rb

@@ -29,9 +29,7 @@ module Avm
               return ::Dev::Result.error("Dump \"#{dump_path}\" does not exist") unless
               ::File.exist?(dump_path)
 
-              before_load
               load_dump
-              fix_web_addresses
               success("Dump loaded from \"#{dump_path}\"")
             end
 
@@ -50,39 +48,18 @@ module Avm
 
             def load_dump
               info "Loading dump \"#{dump_path}\"..."
-              ::EacRubyUtils::Envs.local.command('cat', dump_path).pipe(load_command).execute!
+              package_load.run
+              #::EacRubyUtils::Envs.local.command('cat', dump_path).pipe(load_command).execute!
             end
 
             def dump_instance_method
               :dump_database
             end
 
-            def before_load
-              info 'Clearing database (Dropping all tables)...'
-              sql = run_sql(drop_all_tables_sql)
-              run_sql(sql) if sql.present?
-            end
-
-            def drop_all_tables_sql
-              "select 'drop table \"' || tablename || '\" cascade;' from pg_tables " \
-                "where schemaname = 'public';"
-            end
-
-            def run_sql(sql)
-              context(:instance).pg.psql_command_command(sql).execute!
-            end
-
-            def load_command
-              context(:instance).pg.psql_command.prepend(['gzip', '-d', '@ESC_|'])
-            end
+            private
 
-            def fix_web_addresses
-              info 'Fixing web addresses...'
-              run_sql(<<~SQL)
-                update wp_options
-                set option_value = '#{context(:instance).read_entry('url')}'
-                where option_name in ('siteurl', 'home')
-              SQL
+            def package_load_uncached
+              context(:instance).data_package.load(dump_path)
             end
           end
         end

data/lib/avm/tools/version.rb

@@ -2,6 +2,6 @@
 
 module Avm
   module Tools
-    VERSION = '0.12.0'
+    VERSION = '0.13.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avm-tools
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-26 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aranha-parsers
@@ -76,14 +76,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: filesize
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -157,6 +171,14 @@ files:
 - exe/avm
 - lib/avm.rb
 - lib/avm/configs.rb
+- lib/avm/data.rb
+- lib/avm/data/instance.rb
+- lib/avm/data/instance/package.rb
+- lib/avm/data/instance/unit.rb
+- lib/avm/data/package.rb
+- lib/avm/data/package/dump.rb
+- lib/avm/data/package/load.rb
+- lib/avm/data/unit.rb
 - lib/avm/files.rb
 - lib/avm/files/rotate.rb
 - lib/avm/git.rb
@@ -181,8 +203,10 @@ files:
 - lib/avm/result.rb
 - lib/avm/stereotypes.rb
 - lib/avm/stereotypes/eac_wordpress_base0/instance.rb
+- lib/avm/stereotypes/eac_wordpress_base0/uploads_data_unit.rb
 - lib/avm/stereotypes/postgresql.rb
 - lib/avm/stereotypes/postgresql/instance.rb
+- lib/avm/stereotypes/postgresql/instance/data_unit.rb
 - lib/avm/stereotypes/postgresql/instance_with.rb
 - lib/avm/tools.rb
 - lib/avm/tools/git.rb