alterity 1.2.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6283968b3d028f736da1517832ee5ebf8410aa4281aea4a2fa7af9e868a7ef89
-  data.tar.gz: c4e6ae366bea0f1065aa303824c0f64f7dc684f7566e600ede7ece16c4e58b60
+  metadata.gz: 20a0079693908430f136c8f85839cdfa2a39872a4ec021a9014b5fd8bf27c493
+  data.tar.gz: 388fcc530f490f858e344eaf2a24e1287b275cae3b33739ced28b7a1a8a42d9f
 SHA512:
-  metadata.gz: 1bf501f5c7f2ce204f995341c7ee2bf73a0c3d8fc16ed9b32ea710ff4b77251e464891df9866a6847b7740ae9472f1c639cae7b7ac31bb82381616b84d5ea66b
-  data.tar.gz: 58fb3f6708f0b610d4129c960f1765e5073d74e0170f46456d549cf3f65ecf8e34da7b139efee3afbb5575d0f0c01d5630170590d51ffba2b6de9ef8d52e4a1c
+  metadata.gz: '095a935c8a09050ddfe41c0b149c167a9264d9f343260c06501717fe54fabd31cdb134634db009db13468efbe7f88ccff120889095e854edf2295f9523d15bc1'
+  data.tar.gz: 701b4b23a3478f4b8c3302371b41f5b70acbea0410e2dc5b5430ad88dd97f80926d211ea11f821cb43f4f33d6e66a14163e14fe7e94d85a3f9825d294b9b1fc1

data/lib/alterity.rb

@@ -8,12 +8,14 @@ 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]
         updates = $~[:updates]
-        if updates.split(",").all? { |s| s =~ /^\s*drop\s+foreign\s+key\s+\w+\s*$/i } ||
-           updates.split(",").all? { |s| s =~ /^\s*add\s+constraint\s+`?\w+`?\s+foreign\s+key\s+\(`?\w+`?\)\s+references\s+`?\w+`?\s+\(`?\w+`?\)\s*$/i }
+        if updates.split(",").all? { |s| s =~ /^\s*drop\s+foreign\s+key/i } ||
+           updates.split(",").all? { |s| s =~ /^\s*add\s+constraint/i }
           block.call
         elsif updates =~ /drop\s+foreign\s+key/i || updates =~ /add\s+constraint/i
           # ADD CONSTRAINT / DROP FOREIGN KEY have to go to the original table,
@@ -35,6 +37,7 @@ class Alterity
 
     # hooks
     def before_running_migrations
+      require "open3"
       state.migrating = true
       set_database_config
       prepare_replicas_dsns_table
@@ -51,7 +54,21 @@ class Alterity
       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")
+      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 set_database_config

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.2.0"
+  VERSION = "1.4.1"
 end

data/spec/alterity_spec.rb

@@ -10,7 +10,7 @@ RSpec.describe Alterity do
         ["CREATE UNIQUE INDEX `idx_users_on_col` ON `users` (col)", "`users`", "ADD UNIQUE INDEX `idx_users_on_col` (col)"],
         ["DROP INDEX `idx_users_on_col` ON `users`", "`users`", "DROP INDEX `idx_users_on_col`"],
         ["alter table users drop col", "users", "drop col"],
-        ["  ALTER TABLE\n   users\n   DROP col", "users", "DROP col"]
+        ["  ALTER TABLE\n   users\n   DROP col", "users", "DROP col"],
       ].each do |(query, expected_table, expected_updates)|
         puts query.inspect
         expected_block = proc {}
@@ -32,7 +32,8 @@ RSpec.describe Alterity do
         "SHOW FULL FIELDS FROM `users`",
         "ALTER TABLE `installment_events` DROP FOREIGN KEY _fk_rails_0123456789",
         "ALTER TABLE `installment_events` DROP FOREIGN KEY _fk_rails_0123456789, DROP FOREIGN KEY _fk_rails_9876543210",
-        "ALTER TABLE `installment_events` ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)"
+        "ALTER TABLE `installment_events` ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`)",
+        "ALTER TABLE `installment_events` ADD CONSTRAINT `fk_rails_0cb5590091` FOREIGN KEY (`user_id`) REFERENCES `users` (`id`) ON DELETE CASCADE",
       ].each do |query|
         expected_block = proc {}
         expect(expected_block).to receive(:call)

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.2.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Chris Maximin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-05 00:00:00.000000000 Z
+date: 2021-07-28 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