alterity 1.3.0 → 1.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af06f20537df45280990abc9fd8c2235741b6aa22de270bbcb06684f80994d46
-  data.tar.gz: b345349594c6408775596e9189ca494671168f9b2acfecaeb9352aaa52d1b4b8
+  metadata.gz: 17e41112c9c2dbf07aa9115bbe62ead1666d8802f0ce67a57bb5c9390ff85ecf
+  data.tar.gz: 815373d5f3832cea20695a067c2e7ecaf7823bddb5ca7769a5de2f42e371cc01
 SHA512:
-  metadata.gz: 6d012764dfd32b2002ce51f6c94b9d8cc83836e947211bb7271166c674f19ba8f61f6683fcab6a8d30cd9668103d2abc4a73477105a35004a1af662aa13612b9
-  data.tar.gz: a094fff01bebad3fee84a8391918105f5f5f0c0b0707d8b935ef05b378b27f667751b601addfe77657b14ac48c428230d9cda4e76a34ad0e206b4d961d7812b2
+  metadata.gz: 7ea71bf4f05a6413e864dce3f781dd3231a7832022bc21b890bdafeb4ca3e522222118929723f35495655a97863d60db1619f973c6f3b5d970c7c5cb63fcfe6b
+  data.tar.gz: ace1c68c92fe85b4704034be10f166b66e392777de6ebf1aafdc151fa6eb1e0ccb0e61fb636754507853fe6a33fbe5431bf38f347d915486435a58af6f432a47

data/lib/alterity/configuration.rb

@@ -4,7 +4,10 @@ class Alterity
   Configuration = Struct.new(
     :command,
     :host, :port, :database, :username, :password,
-    :replicas_dsns_database, :replicas_dsns_table, :replicas_dsns
+    :replicas_dsns_database, :replicas_dsns_table, :replicas_dsns,
+    :before_command,
+    :on_command_output,
+    :after_command
   )
   CurrentState = Struct.new(:migrating, :disabled)
   cattr_accessor :state
@@ -36,10 +39,6 @@ class Alterity
       yield config
     end
 
-    def command=(new_command)
-      config.command = new_command
-    end
-
     def disable
       state.disabled = true
       yield

data/lib/alterity/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Alterity
-  VERSION = "1.3.0"
+  VERSION = "1.4.2"
 end

data/lib/alterity.rb

@@ -8,6 +8,8 @@ require "alterity/railtie"
 class Alterity
   class << self
     def process_sql_query(sql, &block)
+      return block.call if state.disabled
+
       case sql.tr("\n", " ").strip
       when /^alter\s+table\s+(?<table>.+?)\s+(?<updates>.+)/i
         table = $~[:table]
@@ -35,6 +37,7 @@ class Alterity
 
     # hooks
     def before_running_migrations
+      require "open3"
       state.migrating = true
       set_database_config
       prepare_replicas_dsns_table
@@ -50,8 +53,27 @@ class Alterity
       altered_table = table.delete("`")
       alter_argument = %("#{updates.gsub('"', '\\"').gsub('`', '\\\`')}")
       prepared_command = config.command.call(altered_table, alter_argument).to_s.gsub(/\n/, "\\\n")
-      puts "[Alterity] Will execute: #{prepared_command}"
-      system(prepared_command) || raise("[Alterity] Command failed")
+      puts "[Alterity] Will execute: #{sanitize(prepared_command)}"
+      config.before_command&.call(prepared_command)
+
+      result_str = +""
+      exit_status = nil
+      Open3.popen2e(prepared_command) do |_stdin, stdout_and_stderr, wait_thr|
+        stdout_and_stderr.each do |line|
+          puts line
+          result_str << line
+          config.on_command_output&.call(line)
+        end
+        exit_status = wait_thr.value
+        config.after_command&.call(wait_thr.value.to_i)
+      end
+
+      raise("[Alterity] Command failed. Full output: #{result_str}") unless exit_status.success?
+    end
+
+    def sanitize(command)
+      return command unless config.password.present?
+      command.gsub(config.password, '[filtered]')
     end
 
     def set_database_config

data/spec/bin/custom_config.rb

@@ -8,6 +8,7 @@ Alterity.configure do |config|
     system("echo '#{string}' > /tmp/custom_command_result.txt")
     system("echo '#{altered_table}' >> /tmp/custom_command_result.txt")
     system("echo '#{alter_argument}' >> /tmp/custom_command_result.txt")
+    "ls /"
   }
 
   config.replicas(
@@ -23,4 +24,16 @@ Alterity.configure do |config|
       "h=#{ENV['MYSQL_HOST']}"
     ]
   )
+
+  config.before_command = lambda do |command|
+    File.new("/tmp/before_command.txt", "w").syswrite(command)
+  end
+
+  config.on_command_output = lambda do |output|
+    File.new("/tmp/on_command_output.txt", "w+").syswrite(output)
+  end
+
+  config.after_command = lambda do |exit_status|
+    File.new("/tmp/after_command.txt", "w").syswrite(exit_status)
+  end
 end

data/spec/bin/disabled_migration.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddYetAnotherColorToShirts < ActiveRecord::Migration[6.1]
+  def up
+    Alterity.disable do
+      add_column :shirts, :color3, :string
+    end
+  end
+end

data/spec/bin/rails_app_migration_test.sh

@@ -69,3 +69,9 @@ ruby ../spec/bin/test_custom_config_result.rb
 
 # Also testing what's in replicas_dsns, also checking that master was detected and removed.
 bundle e rails runner 'res=ActiveRecord::Base.connection.execute("select dsn from percona.replicas_dsns").to_a.flatten;p(res); res == ["h=host1,P=3306", "h=host2,P=3306"] || exit(1)'
+
+rm /tmp/custom_command_result.txt
+cp ../spec/bin/disabled_migration.rb db/migrate/20210728182628_add_yet_another_color_to_shirts.rb
+bundle e rails db:migrate --trace
+bundle e rails runner 'Shirt.columns.map(&:name).include?("color3") || exit(1)'
+ruby ../spec/bin/test_disabled_state.rb

data/spec/bin/test_custom_config_result.rb

@@ -15,6 +15,25 @@ puts result
 p result.chars.map(&:hex)
 
 if result != expected_result
-  puts "=> mismatch"
+  puts "=> mismatched result"
+  exit(1)
+end
+
+
+result = File.read("/tmp/before_command.txt")
+if result != "ls /"
+  puts "=> mismatched before_command"
+  exit(1)
+end
+
+result = File.read("/tmp/on_command_output.txt")
+if !result.include?("var")
+  puts "=> mismatched on_command_output"
+  exit(1)
+end
+
+result = File.read("/tmp/after_command.txt")
+if result.strip != "0"
+  puts "=> mismatched after_command"
   exit(1)
 end

data/spec/bin/test_disabled_state.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+if File.exist?("/tmp/custom_command_result.txt")
+  puts "=> disabled state does not work"
+  exit(1)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alterity
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.2
 platform: ruby
 authors:
 - Chris Maximin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mysql2
@@ -53,8 +53,10 @@ files:
 - lib/alterity/version.rb
 - spec/alterity_spec.rb
 - spec/bin/custom_config.rb
+- spec/bin/disabled_migration.rb
 - spec/bin/rails_app_migration_test.sh
 - spec/bin/test_custom_config_result.rb
+- spec/bin/test_disabled_state.rb
 - spec/spec_helper.rb
 homepage: https://github.com/gumroad/alterity
 licenses:
@@ -85,6 +87,8 @@ summary: Execute your ActiveRecord migrations with Percona's pt-online-schema-ch
 test_files:
 - spec/alterity_spec.rb
 - spec/bin/custom_config.rb
+- spec/bin/disabled_migration.rb
 - spec/bin/rails_app_migration_test.sh
 - spec/bin/test_custom_config_result.rb
+- spec/bin/test_disabled_state.rb
 - spec/spec_helper.rb